@capgo/capacitor-nfc 7.1.0 → 8.0.1

package/CapgoCapacitorNfc.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.author = package['author']
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
   s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
-  s.ios.deployment_target = '14.0'
+  s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
 end

package/Package.swift

@@ -3,14 +3,14 @@ import PackageDescription
 
 let package = Package(
     name: "CapgoCapacitorNfc",
-    platforms: [.iOS(.v14)],
+    platforms: [.iOS(.v15)],
     products: [
         .library(
             name: "CapgoCapacitorNfc",
             targets: ["NfcPlugin"])
     ],
     dependencies: [
-        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0")
     ],
     targets: [
         .target(

package/README.md

@@ -10,6 +10,11 @@ Native NFC tag detection, reading, and writing for Capacitor apps on iOS and And
 
 Modern Capacitor port of the battle-tested [phonegap-nfc](https://github.com/chariotsolutions/phonegap-nfc) plugin, aligned with Capgo conventions and tooling.
 
+## Supported Tag Types
+
+- **Standard NFC Forum Tags** (Type 1-4)
+- **MIFARE Ultralight** - Full support for reading NDEF data from MIFARE Ultralight tags, including EV1 and NTAG variants. The plugin automatically detects MIFARE Ultralight cards and extracts NDEF messages in addition to standard NFC tags.
+
 ## Documentation
 
 The most complete documentation will live on the Capgo docs portal. Until then, explore the TypeScript definitions (`src/definitions.ts`) and run the included example app for a tour of the API.
@@ -337,15 +342,19 @@ Generic NFC discovery event dispatched by the plugin.
 
 Representation of the full tag information returned by the native layers.
 
-| Prop                  | Type                              | Description                                                           |
-| --------------------- | --------------------------------- | --------------------------------------------------------------------- |
-| **`id`**              | <code>number[]</code>             | Raw identifier bytes for the tag.                                     |
-| **`techTypes`**       | <code>string[]</code>             | List of Android tech strings (e.g. `android.nfc.tech.Ndef`).          |
-| **`type`**            | <code>string \| null</code>       | Human readable tag type when available (e.g. `NFC Forum Type 2`).     |
-| **`maxSize`**         | <code>number \| null</code>       | Maximum writable size in bytes for tags that expose NDEF information. |
-| **`isWritable`**      | <code>boolean \| null</code>      | Indicates whether the tag can be written to.                          |
-| **`canMakeReadOnly`** | <code>boolean \| null</code>      | Indicates whether the tag can be permanently locked.                  |
-| **`ndefMessage`**     | <code>NdefRecord[] \| null</code> | Array of NDEF records discovered on the tag.                          |
+Supports standard NFC Forum tags as well as MIFARE Ultralight cards (including
+EV1 and NTAG variants). NDEF data is automatically extracted from MIFARE Ultralight
+tags when available.
+
+| Prop                  | Type                              | Description                                                                            |
+| --------------------- | --------------------------------- | -------------------------------------------------------------------------------------- |
+| **`id`**              | <code>number[]</code>             | Raw identifier bytes for the tag.                                                      |
+| **`techTypes`**       | <code>string[]</code>             | List of Android tech strings (e.g. `android.nfc.tech.Ndef`).                           |
+| **`type`**            | <code>string \| null</code>       | Human readable tag type when available (e.g. `NFC Forum Type 2`, `MIFARE Ultralight`). |
+| **`maxSize`**         | <code>number \| null</code>       | Maximum writable size in bytes for tags that expose NDEF information.                  |
+| **`isWritable`**      | <code>boolean \| null</code>      | Indicates whether the tag can be written to.                                           |
+| **`canMakeReadOnly`** | <code>boolean \| null</code>      | Indicates whether the tag can be permanently locked.                                   |
+| **`ndefMessage`**     | <code>NdefRecord[] \| null</code> | Array of NDEF records discovered on the tag.                                           |
 
 
 #### NfcStateChangeEvent

package/android/build.gradle

@@ -1,8 +1,8 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
 }
 
 buildscript {
@@ -11,18 +11,18 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.7.2'
+        classpath 'com.android.tools.build:gradle:8.13.0'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
-    namespace "app.capgo.nfc"
-    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    namespace = "app.capgo.nfc"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
     defaultConfig {
-        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -34,7 +34,7 @@ android {
         }
     }
     lintOptions {
-        abortOnError false
+        abortOnError = false
     }
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_21

package/dist/docs.json

@@ -363,7 +363,7 @@
     {
       "name": "NfcTag",
       "slug": "nfctag",
-      "docs": "Representation of the full tag information returned by the native layers.",
+      "docs": "Representation of the full tag information returned by the native layers.\n\nSupports standard NFC Forum tags as well as MIFARE Ultralight cards (including\nEV1 and NTAG variants). NDEF data is automatically extracted from MIFARE Ultralight\ntags when available.",
       "tags": [],
       "methods": [],
       "properties": [
@@ -384,7 +384,7 @@
         {
           "name": "type",
           "tags": [],
-          "docs": "Human readable tag type when available (e.g. `NFC Forum Type 2`).",
+          "docs": "Human readable tag type when available (e.g. `NFC Forum Type 2`, `MIFARE Ultralight`).",
           "complexTypes": [],
           "type": "string | null | undefined"
         },

package/dist/esm/definitions.d.ts

@@ -42,6 +42,10 @@ export interface NdefRecord {
 }
 /**
  * Representation of the full tag information returned by the native layers.
+ *
+ * Supports standard NFC Forum tags as well as MIFARE Ultralight cards (including
+ * EV1 and NTAG variants). NDEF data is automatically extracted from MIFARE Ultralight
+ * tags when available.
  */
 export interface NfcTag {
     /**
@@ -53,7 +57,7 @@ export interface NfcTag {
      */
     techTypes?: string[];
     /**
-     * Human readable tag type when available (e.g. `NFC Forum Type 2`).
+     * Human readable tag type when available (e.g. `NFC Forum Type 2`, `MIFARE Ultralight`).
      */
     type?: string | null;
     /**

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Possible NFC adapter states returned by {@link CapacitorNfcPlugin.getStatus}.\n *\n * Matches the constants provided by the original PhoneGap NFC plugin for\n * compatibility with existing applications.\n */\nexport type NfcStatus = 'NFC_OK' | 'NO_NFC' | 'NFC_DISABLED' | 'NDEF_PUSH_DISABLED';\n\n/**\n * Event type describing the kind of NFC discovery that happened.\n *\n * - `tag`: A generic NFC tag (no NDEF payload).\n * - `ndef`: A tag exposing an NDEF payload.\n * - `ndef-mime`: An NDEF tag that matched one of the MIME type filters.\n * - `ndef-formatable`: A tag that can be formatted to NDEF.\n */\nexport type NfcEventType = 'tag' | 'ndef' | 'ndef-mime' | 'ndef-formatable';\n\n/**\n * JSON structure representing a single NDEF record.\n *\n * Mirrors the data format returned by the legacy Cordova implementation and\n * uses integer arrays instead of strings to preserve the original payload\n * bytes.\n */\nexport interface NdefRecord {\n  /**\n   * Type Name Format identifier.\n   */\n  tnf: number;\n  /**\n   * Type field expressed as an array of byte values.\n   */\n  type: number[];\n  /**\n   * Record identifier expressed as an array of byte values.\n   */\n  id: number[];\n  /**\n   * Raw payload expressed as an array of byte values.\n   */\n  payload: number[];\n}\n\n/**\n * Representation of the full tag information returned by the native layers.\n */\nexport interface NfcTag {\n  /**\n   * Raw identifier bytes for the tag.\n   */\n  id?: number[];\n  /**\n   * List of Android tech strings (e.g. `android.nfc.tech.Ndef`).\n   */\n  techTypes?: string[];\n  /**\n   * Human readable tag type when available (e.g. `NFC Forum Type 2`).\n   */\n  type?: string | null;\n  /**\n   * Maximum writable size in bytes for tags that expose NDEF information.\n   */\n  maxSize?: number | null;\n  /**\n   * Indicates whether the tag can be written to.\n   */\n  isWritable?: boolean | null;\n  /**\n   * Indicates whether the tag can be permanently locked.\n   */\n  canMakeReadOnly?: boolean | null;\n  /**\n   * Array of NDEF records discovered on the tag.\n   */\n  ndefMessage?: NdefRecord[] | null;\n}\n\n/**\n * Generic NFC discovery event dispatched by the plugin.\n */\nexport interface NfcEvent {\n  type: NfcEventType;\n  tag: NfcTag;\n}\n\n/**\n * Options controlling the behaviour of {@link CapacitorNfcPlugin.startScanning}.\n */\nexport interface StartScanningOptions {\n  /**\n   * iOS-only: closes the NFC session automatically after the first successful tag read.\n   * Defaults to `true`.\n   */\n  invalidateAfterFirstRead?: boolean;\n  /**\n   * iOS-only: custom message displayed in the NFC system sheet while scanning.\n   */\n  alertMessage?: string;\n  /**\n   * Android-only: raw flags passed to `NfcAdapter.enableReaderMode`.\n   * Defaults to enabling all tag types with skipping NDEF checks.\n   */\n  androidReaderModeFlags?: number;\n}\n\n/**\n * Options used when writing an NDEF message on the current tag.\n */\nexport interface WriteTagOptions {\n  /**\n   * Array of records that compose the NDEF message to be written.\n   */\n  records: NdefRecord[];\n  /**\n   * When `true`, the plugin attempts to format NDEF-formattable tags before writing.\n   * Defaults to `true`.\n   */\n  allowFormat?: boolean;\n}\n\n/**\n * Options used when sharing an NDEF message with another device using Android Beam / P2P mode.\n */\nexport interface ShareTagOptions {\n  records: NdefRecord[];\n}\n\n/**\n * Event emitted whenever the NFC adapter availability changes.\n */\nexport interface NfcStateChangeEvent {\n  status: NfcStatus;\n  enabled: boolean;\n}\n\n/**\n * Public API surface for the Capacitor NFC plugin.\n *\n * The interface intentionally mirrors the behaviour of the reference PhoneGap\n * implementation to ease migration while embracing idiomatic Capacitor APIs.\n */\nexport interface CapacitorNfcPlugin {\n  /**\n   * Starts listening for NFC tags.\n   */\n  startScanning(options?: StartScanningOptions): Promise<void>;\n  /**\n   * Stops the ongoing NFC scanning session.\n   */\n  stopScanning(): Promise<void>;\n  /**\n   * Writes the provided NDEF records to the last discovered tag.\n   */\n  write(options: WriteTagOptions): Promise<void>;\n  /**\n   * Attempts to erase the last discovered tag by writing an empty NDEF message.\n   */\n  erase(): Promise<void>;\n  /**\n   * Attempts to make the last discovered tag read-only.\n   */\n  makeReadOnly(): Promise<void>;\n  /**\n   * Shares an NDEF message with another device via peer-to-peer (Android only).\n   */\n  share(options: ShareTagOptions): Promise<void>;\n  /**\n   * Stops sharing previously provided NDEF message (Android only).\n   */\n  unshare(): Promise<void>;\n  /**\n   * Returns the current NFC adapter status.\n   */\n  getStatus(): Promise<{ status: NfcStatus }>;\n  /**\n   * Opens the system settings page where the user can enable NFC.\n   */\n  showSettings(): Promise<void>;\n  /**\n   * Returns the version string baked into the native plugin.\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n\n  addListener(eventName: 'nfcEvent', listenerFunc: (event: NfcEvent) => void): Promise<PluginListenerHandle>;\n  addListener(\n    eventName: 'tagDiscovered' | 'ndefDiscovered' | 'ndefMimeDiscovered' | 'ndefFormatableDiscovered',\n    listenerFunc: (event: NfcEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  addListener(\n    eventName: 'nfcStateChange',\n    listenerFunc: (event: NfcStateChangeEvent) => void,\n  ): Promise<PluginListenerHandle>;\n}\n\nexport type { PluginListenerHandle } from '@capacitor/core';\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Possible NFC adapter states returned by {@link CapacitorNfcPlugin.getStatus}.\n *\n * Matches the constants provided by the original PhoneGap NFC plugin for\n * compatibility with existing applications.\n */\nexport type NfcStatus = 'NFC_OK' | 'NO_NFC' | 'NFC_DISABLED' | 'NDEF_PUSH_DISABLED';\n\n/**\n * Event type describing the kind of NFC discovery that happened.\n *\n * - `tag`: A generic NFC tag (no NDEF payload).\n * - `ndef`: A tag exposing an NDEF payload.\n * - `ndef-mime`: An NDEF tag that matched one of the MIME type filters.\n * - `ndef-formatable`: A tag that can be formatted to NDEF.\n */\nexport type NfcEventType = 'tag' | 'ndef' | 'ndef-mime' | 'ndef-formatable';\n\n/**\n * JSON structure representing a single NDEF record.\n *\n * Mirrors the data format returned by the legacy Cordova implementation and\n * uses integer arrays instead of strings to preserve the original payload\n * bytes.\n */\nexport interface NdefRecord {\n  /**\n   * Type Name Format identifier.\n   */\n  tnf: number;\n  /**\n   * Type field expressed as an array of byte values.\n   */\n  type: number[];\n  /**\n   * Record identifier expressed as an array of byte values.\n   */\n  id: number[];\n  /**\n   * Raw payload expressed as an array of byte values.\n   */\n  payload: number[];\n}\n\n/**\n * Representation of the full tag information returned by the native layers.\n *\n * Supports standard NFC Forum tags as well as MIFARE Ultralight cards (including\n * EV1 and NTAG variants). NDEF data is automatically extracted from MIFARE Ultralight\n * tags when available.\n */\nexport interface NfcTag {\n  /**\n   * Raw identifier bytes for the tag.\n   */\n  id?: number[];\n  /**\n   * List of Android tech strings (e.g. `android.nfc.tech.Ndef`).\n   */\n  techTypes?: string[];\n  /**\n   * Human readable tag type when available (e.g. `NFC Forum Type 2`, `MIFARE Ultralight`).\n   */\n  type?: string | null;\n  /**\n   * Maximum writable size in bytes for tags that expose NDEF information.\n   */\n  maxSize?: number | null;\n  /**\n   * Indicates whether the tag can be written to.\n   */\n  isWritable?: boolean | null;\n  /**\n   * Indicates whether the tag can be permanently locked.\n   */\n  canMakeReadOnly?: boolean | null;\n  /**\n   * Array of NDEF records discovered on the tag.\n   */\n  ndefMessage?: NdefRecord[] | null;\n}\n\n/**\n * Generic NFC discovery event dispatched by the plugin.\n */\nexport interface NfcEvent {\n  type: NfcEventType;\n  tag: NfcTag;\n}\n\n/**\n * Options controlling the behaviour of {@link CapacitorNfcPlugin.startScanning}.\n */\nexport interface StartScanningOptions {\n  /**\n   * iOS-only: closes the NFC session automatically after the first successful tag read.\n   * Defaults to `true`.\n   */\n  invalidateAfterFirstRead?: boolean;\n  /**\n   * iOS-only: custom message displayed in the NFC system sheet while scanning.\n   */\n  alertMessage?: string;\n  /**\n   * Android-only: raw flags passed to `NfcAdapter.enableReaderMode`.\n   * Defaults to enabling all tag types with skipping NDEF checks.\n   */\n  androidReaderModeFlags?: number;\n}\n\n/**\n * Options used when writing an NDEF message on the current tag.\n */\nexport interface WriteTagOptions {\n  /**\n   * Array of records that compose the NDEF message to be written.\n   */\n  records: NdefRecord[];\n  /**\n   * When `true`, the plugin attempts to format NDEF-formattable tags before writing.\n   * Defaults to `true`.\n   */\n  allowFormat?: boolean;\n}\n\n/**\n * Options used when sharing an NDEF message with another device using Android Beam / P2P mode.\n */\nexport interface ShareTagOptions {\n  records: NdefRecord[];\n}\n\n/**\n * Event emitted whenever the NFC adapter availability changes.\n */\nexport interface NfcStateChangeEvent {\n  status: NfcStatus;\n  enabled: boolean;\n}\n\n/**\n * Public API surface for the Capacitor NFC plugin.\n *\n * The interface intentionally mirrors the behaviour of the reference PhoneGap\n * implementation to ease migration while embracing idiomatic Capacitor APIs.\n */\nexport interface CapacitorNfcPlugin {\n  /**\n   * Starts listening for NFC tags.\n   */\n  startScanning(options?: StartScanningOptions): Promise<void>;\n  /**\n   * Stops the ongoing NFC scanning session.\n   */\n  stopScanning(): Promise<void>;\n  /**\n   * Writes the provided NDEF records to the last discovered tag.\n   */\n  write(options: WriteTagOptions): Promise<void>;\n  /**\n   * Attempts to erase the last discovered tag by writing an empty NDEF message.\n   */\n  erase(): Promise<void>;\n  /**\n   * Attempts to make the last discovered tag read-only.\n   */\n  makeReadOnly(): Promise<void>;\n  /**\n   * Shares an NDEF message with another device via peer-to-peer (Android only).\n   */\n  share(options: ShareTagOptions): Promise<void>;\n  /**\n   * Stops sharing previously provided NDEF message (Android only).\n   */\n  unshare(): Promise<void>;\n  /**\n   * Returns the current NFC adapter status.\n   */\n  getStatus(): Promise<{ status: NfcStatus }>;\n  /**\n   * Opens the system settings page where the user can enable NFC.\n   */\n  showSettings(): Promise<void>;\n  /**\n   * Returns the version string baked into the native plugin.\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n\n  addListener(eventName: 'nfcEvent', listenerFunc: (event: NfcEvent) => void): Promise<PluginListenerHandle>;\n  addListener(\n    eventName: 'tagDiscovered' | 'ndefDiscovered' | 'ndefMimeDiscovered' | 'ndefFormatableDiscovered',\n    listenerFunc: (event: NfcEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  addListener(\n    eventName: 'nfcStateChange',\n    listenerFunc: (event: NfcStateChangeEvent) => void,\n  ): Promise<PluginListenerHandle>;\n}\n\nexport type { PluginListenerHandle } from '@capacitor/core';\n"]}

package/ios/Sources/NfcPlugin/NfcPlugin.swift

@@ -4,7 +4,7 @@ import UIKit
 
 @objc(NfcPlugin)
 public class NfcPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let pluginVersion: String = "7.1.0"
+    private let pluginVersion: String = "8.0.1"
 
     public let identifier = "NfcPlugin"
     public let jsName = "CapacitorNfc"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-nfc",
-  "version": "7.1.0",
+  "version": "8.0.1",
   "description": "Native NFC tag discovery, reading and writing for Capacitor apps on iOS and Android.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -49,27 +49,27 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@capacitor/android": "^7.0.0",
-    "@capacitor/cli": "^7.0.0",
-    "@capacitor/core": "^7.0.0",
-    "@capacitor/docgen": "^0.3.0",
-    "@capacitor/ios": "^7.0.0",
+    "@capacitor/android": "^8.0.0",
+    "@capacitor/cli": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/docgen": "^0.3.1",
+    "@capacitor/ios": "^8.0.0",
     "@ionic/eslint-config": "^0.4.0",
     "@ionic/prettier-config": "^4.0.0",
     "@ionic/swiftlint-config": "^2.0.0",
-    "@types/node": "^22.13.1",
-    "eslint": "^8.57.0",
+    "@types/node": "^24.10.1",
+    "eslint": "^8.57.1",
     "eslint-plugin-import": "^2.31.0",
     "husky": "^9.1.7",
-    "prettier": "^3.4.2",
-    "prettier-plugin-java": "^2.6.7",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.34.6",
+    "prettier": "^3.6.2",
+    "prettier-plugin-java": "^2.7.7",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.53.2",
     "swiftlint": "^2.0.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@capacitor/core": ">=7.0.0"
+    "@capacitor/core": ">=8.0.0"
   },
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended"