Merge pull request #224 from nfcim/develop

Release 3.6.1

Author: Harry-Chen

.github/workflows/example-app.yml

@@ -8,53 +8,57 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
     if: ${{ !contains(github.event.head_commit.message, 'ci skip') }}
 
     strategy:
       fail-fast: false
       matrix:
         variant: [debug, release]
+        target: [apk, ios]
+        include:
+          - target: apk
+            os: ubuntu-latest
+            pre-build-script: ""
+            build-args: ""
+            debug-artifact-path: example/build/app/outputs/flutter-apk/app-debug.apk
+            release-artifact-path: example/build/app/outputs/flutter-apk/app-release.apk
+          - target: ios
+            os: macos-latest
+            pre-build-script: ""
+            build-args: "--no-codesign"
+            artifact-path: |
+              example/build/ios/iphoneos/Runner.app
+
+    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.target }}-${{ matrix.variant }}
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-java@v4
+    - uses: actions/checkout@v6
+    - uses: actions/setup-java@v5
+      if: ${{ matrix.target == 'apk' }}
       with:
         distribution: 'temurin'
         java-version: '21'
     - uses: subosito/flutter-action@v2
       with:
         channel: 'stable'
         cache: true
-    - run: dart pub get
-    - run: dart format --output=none --set-exit-if-changed .
-    - run: dart analyze
-    - run: flutter pub get
-      working-directory: example/
-    #- run: flutter test
-    - run: flutter build apk --${{ matrix.variant }} --verbose
-      working-directory: example/
-    - uses: actions/upload-artifact@v4
-      with:
-        name: example-apk-${{ matrix.variant }}
-        path: |
-          example/build/app/outputs/flutter-apk/app-${{ matrix.variant }}.apk
-          example/build/reports/*
 
-  build-ios:
-    runs-on: macos-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        variant: [debug, release]
+    - name: pre-build-script for ${{ matrix.target }}
+      run: ${{ matrix.pre-build-script }}
+      if: ${{ matrix.pre-build-script != '' }}
 
-    steps:
-    - uses: actions/checkout@v4
-    - uses: subosito/flutter-action@v2
-      with:
-        channel: 'stable'
-        cache: true
     - run: flutter pub get
       working-directory: example/
-    - run: flutter build ios --${{ matrix.variant }} --verbose --no-codesign
+
+    - name: Run flutter ${{ matrix.variant }} build on ${{ matrix.target }}
+      run: flutter build ${{ matrix.target }} --${{ matrix.variant }} ${{ matrix.build-args }} --verbose
       working-directory: example/
+
+    - uses: actions/upload-artifact@v5
+      with:
+        name: example-${{ matrix.target }}-${{ matrix.variant }}
+        path: |
+          ${{ matrix.debug-artifact-path }}
+          ${{ matrix.release-artifact-path }}
+          ${{ matrix.artifact-path }}

.github/workflows/publish.yaml

@@ -1,8 +1,5 @@
 name: Publish to pub.dev
 
-env:
-  FLUTTER_VERSION: 3.24.5
-
 on:
   push:
     tags:
@@ -15,13 +12,12 @@ jobs:
       id-token: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: dart-lang/setup-dart@v1
       - name: Setup Flutter SDK
-        uses: flutter-actions/setup-flutter@v3
+        uses: flutter-actions/setup-flutter@v4
         with:
           channel: stable
-          version: ${{ env.FLUTTER_VERSION }}
           cache: true
       - name: Install dependencies
         run: flutter pub get

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Test
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: ${{ !contains(github.event.head_commit.message, 'ci skip') }}
+    strategy:
+      matrix:
+        channel: [stable, beta]
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: subosito/flutter-action@v2
+        with:
+          channel: ${{ matrix.channel }}
+          cache: true
+      - run: dart pub get
+      - run: dart format --output=none --set-exit-if-changed lib/
+      - run: dart analyze
+    #   - run: dart test
+      - run: dart doc
+      - name: Upload generated dartdoc
+        uses: actions/upload-artifact@v5
+        with:
+          name: docs-${{ matrix.channel }}
+          path: doc/
+      - name: Evaluate score with pana
+        run: |
+          dart pub global activate pana
+          dart pub global run pana .

CHANGELOG.md

@@ -191,3 +191,15 @@
 * Add Swift package manager support for iOS plugin, bump dependencies
 * Fix WebUSB interop on Web, add onDisconnect callback
 * Add support for foreground polling on Android (#16, #179)
+
+## 3.6.1
+
+* Refactor with new `dart:js_interop` APIs to fix build with WASM (#223)
+* Support `readBlock` / `writeBlock` on Mifare tags on iOS (#205 by @rushank-shah)
+* More robust logic on Android
+  * ensure NFC Handler is always alive (#219)
+  * prevent an NPE due to wrong API typing (#220)
+  * add comment on `poll` related to Samsung API bug (#190, #200)
+* Add more detailed error message in iOS APIs
+* Bump tools to Gradle 9.2.1, AGP 8.13.0, Kotlin 2.2.21
+  * Now `minSdkVersion` is lowered to 24 (#212)

README.md

@@ -1,7 +1,8 @@
 # Flutter NFC Kit
 
 [![pub version](https://img.shields.io/pub/v/flutter_nfc_kit)](https://pub.dev/packages/flutter_nfc_kit)
-![Build Example App](https://github.com/nfcim/flutter_nfc_kit/workflows/Build%20Example%20App/badge.svg)
+[![Test](https://github.com/nfcim/flutter_nfc_kit/actions/workflows/test.yml/badge.svg)](https://github.com/nfcim/flutter_nfc_kit/actions/workflows/test.yml)
+[![Build Example App](https://github.com/nfcim/flutter_nfc_kit/actions/workflows/example-app.yml/badge.svg)](https://github.com/nfcim/flutter_nfc_kit/actions/workflows/example-app.yml)
 
 Yet another plugin to provide NFC functionality on Android, iOS and browsers (by WebUSB, see below).
 
@@ -10,9 +11,9 @@ This plugin's functionalities include:
 * read metadata and read & write NDEF records of tags / cards complying with:
   * ISO 14443 Type A & Type B (NFC-A / NFC-B / MIFARE Classic / MIFARE Plus / MIFARE Ultralight / MIFARE DESFire)
   * ISO 18092 (NFC-F / FeliCa)
-  * ISO 15963 (NFC-V)
+  * ISO 15693 (NFC-V)
 * R/W block / page / sector level data of tags complying with:
-  * MIFARE Classic / Ultralight (Android only)
+  * MIFARE Classic / Ultralight (Android only, MIFARE Classic Read & Write block for iOS)
   * ISO 15693 (iOS only)
 * transceive raw commands with tags / cards complying with:
   * ISO 7816 Smart Cards (layer 4, in APDUs)
@@ -35,7 +36,7 @@ We have the following minimum version requirements for Android plugin:
 
 * Java 17
 * Gradle 8.9
-* Android SDK 26 (you must set corresponding `jvmTarget` in you app's `build.gradle`)
+* Android SDK 24 (you must set corresponding `jvmTarget` in you app's `build.gradle`)
 * Android Gradle Plugin 8.7
 
 To use this plugin on Android, you also need to:

android/build.gradle

@@ -34,7 +34,7 @@ android {
         main.java.srcDirs += 'src/main/kotlin'
     }
     defaultConfig {
-        minSdkVersion 26
+        minSdkVersion 24
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
     lintOptions {

android/gradle.properties

@@ -1,4 +1,4 @@
-org.gradle.jvmargs=-Xmx1536M
+org.gradle.jvmargs=-Xmx4G -XX:MaxMetaspaceSize=2G -XX:+HeapDumpOnOutOfMemoryError
 android.enableJetifier=true
-AGPVersion=8.7.3
-KotlinVersion=2.1.0
+AGPVersion=8.13.0
+KotlinVersion=2.2.21

android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Fri Sep 08 22:01:14 CST 2023
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

android/src/main/kotlin/im/nfc/flutter_nfc_kit/FlutterNfcKitPlugin.kt

@@ -71,6 +71,13 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
             return transceiveMethod.invoke(this, data) as ByteArray
         }
 
+        private fun ensureNfcHandler() {
+            if (!::nfcHandlerThread.isInitialized || !nfcHandlerThread.isAlive) {
+                nfcHandlerThread = HandlerThread("FlutterNfcKit-NfcHandlerThread").apply { start() }
+                nfcHandler = Handler(nfcHandlerThread.looper)
+            }
+        }
+
         private fun runOnNfcThread(result: Result, desc: String, fn: () -> Unit) {
             val handledFn = Runnable {
                 try {
@@ -89,6 +96,7 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
                     }
                 }
             }
+            ensureNfcHandler()
             if (!nfcHandler.post(handledFn)) {
                 result.error("500", "Failed to post job to NFC Handler thread.", null)
             }
@@ -131,7 +139,9 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
                         type = "iso7816"
                         val isoDep = IsoDep.get(tag)
                         tagTechnology = isoDep
-                        historicalBytes = isoDep.historicalBytes.toHexString()
+                        // historicalBytes() may return null but is wrongly typed as ByteArray!
+                        // https://developer.android.com/reference/kotlin/android/nfc/tech/IsoDep#gethistoricalbytes
+                        historicalBytes = (isoDep.historicalBytes as ByteArray?)?.toHexString() ?: ""
                     }
                     tag.techList.contains(MifareClassic::class.java.name) -> {
                         standard = "ISO 14443-3 (Type A)"
@@ -241,9 +251,7 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     }
 
     override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
-        nfcHandlerThread = HandlerThread("NfcHandlerThread")
-        nfcHandlerThread.start()
-        nfcHandler = Handler(nfcHandlerThread.looper)
+        ensureNfcHandler()
 
         methodChannel = MethodChannel(flutterPluginBinding.binaryMessenger, "flutter_nfc_kit/method")
         methodChannel.setMethodCallHandler(this)

example/android/app/build.gradle

@@ -45,7 +45,7 @@ android {
 
     defaultConfig {
         applicationId "im.nfc.flutter_nfc_kit_example"
-        minSdkVersion 26
+        minSdkVersion 24
         targetSdkVersion flutter.targetSdkVersion
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName