@capgo/capacitor-nfc 7.0.0

package/dist/docs.json

@@ -0,0 +1,499 @@
+{
+  "api": {
+    "name": "CapacitorNfcPlugin",
+    "slug": "capacitornfcplugin",
+    "docs": "Public API surface for the Capacitor NFC plugin.\n\nThe interface intentionally mirrors the behaviour of the reference PhoneGap\nimplementation to ease migration while embracing idiomatic Capacitor APIs.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "startScanning",
+        "signature": "(options?: StartScanningOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartScanningOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Starts listening for NFC tags.",
+        "complexTypes": [
+          "StartScanningOptions"
+        ],
+        "slug": "startscanning"
+      },
+      {
+        "name": "stopScanning",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Stops the ongoing NFC scanning session.",
+        "complexTypes": [],
+        "slug": "stopscanning"
+      },
+      {
+        "name": "write",
+        "signature": "(options: WriteTagOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "WriteTagOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Writes the provided NDEF records to the last discovered tag.",
+        "complexTypes": [
+          "WriteTagOptions"
+        ],
+        "slug": "write"
+      },
+      {
+        "name": "erase",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Attempts to erase the last discovered tag by writing an empty NDEF message.",
+        "complexTypes": [],
+        "slug": "erase"
+      },
+      {
+        "name": "makeReadOnly",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Attempts to make the last discovered tag read-only.",
+        "complexTypes": [],
+        "slug": "makereadonly"
+      },
+      {
+        "name": "share",
+        "signature": "(options: ShareTagOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShareTagOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Shares an NDEF message with another device via peer-to-peer (Android only).",
+        "complexTypes": [
+          "ShareTagOptions"
+        ],
+        "slug": "share"
+      },
+      {
+        "name": "unshare",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Stops sharing previously provided NDEF message (Android only).",
+        "complexTypes": [],
+        "slug": "unshare"
+      },
+      {
+        "name": "getStatus",
+        "signature": "() => Promise<{ status: NfcStatus; }>",
+        "parameters": [],
+        "returns": "Promise<{ status: NfcStatus; }>",
+        "tags": [],
+        "docs": "Returns the current NFC adapter status.",
+        "complexTypes": [
+          "NfcStatus"
+        ],
+        "slug": "getstatus"
+      },
+      {
+        "name": "showSettings",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Opens the system settings page where the user can enable NFC.",
+        "complexTypes": [],
+        "slug": "showsettings"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [],
+        "docs": "Returns the version string baked into the native plugin.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'nfcEvent', listenerFunc: (event: NfcEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'nfcEvent'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: NfcEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NfcEvent"
+        ],
+        "slug": "addlistenernfcevent-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'tagDiscovered' | 'ndefDiscovered' | 'ndefMimeDiscovered' | 'ndefFormatableDiscovered', listenerFunc: (event: NfcEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'tagDiscovered' | 'ndefDiscovered' | 'ndefMimeDiscovered' | 'ndefFormatableDiscovered'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: NfcEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NfcEvent"
+        ],
+        "slug": "addlistenertagdiscovered--ndefdiscovered--ndefmimediscovered--ndefformatablediscovered-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'nfcStateChange', listenerFunc: (event: NfcStateChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'nfcStateChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: NfcStateChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NfcStateChangeEvent"
+        ],
+        "slug": "addlistenernfcstatechange-"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "StartScanningOptions",
+      "slug": "startscanningoptions",
+      "docs": "Options controlling the behaviour of {@link CapacitorNfcPlugin.startScanning}.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "invalidateAfterFirstRead",
+          "tags": [],
+          "docs": "iOS-only: closes the NFC session automatically after the first successful tag read.\nDefaults to `true`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "alertMessage",
+          "tags": [],
+          "docs": "iOS-only: custom message displayed in the NFC system sheet while scanning.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "androidReaderModeFlags",
+          "tags": [],
+          "docs": "Android-only: raw flags passed to `NfcAdapter.enableReaderMode`.\nDefaults to enabling all tag types with skipping NDEF checks.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "WriteTagOptions",
+      "slug": "writetagoptions",
+      "docs": "Options used when writing an NDEF message on the current tag.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "records",
+          "tags": [],
+          "docs": "Array of records that compose the NDEF message to be written.",
+          "complexTypes": [
+            "NdefRecord"
+          ],
+          "type": "NdefRecord[]"
+        },
+        {
+          "name": "allowFormat",
+          "tags": [],
+          "docs": "When `true`, the plugin attempts to format NDEF-formattable tags before writing.\nDefaults to `true`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "NdefRecord",
+      "slug": "ndefrecord",
+      "docs": "JSON structure representing a single NDEF record.\n\nMirrors the data format returned by the legacy Cordova implementation and\nuses integer arrays instead of strings to preserve the original payload\nbytes.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "tnf",
+          "tags": [],
+          "docs": "Type Name Format identifier.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Type field expressed as an array of byte values.",
+          "complexTypes": [],
+          "type": "number[]"
+        },
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Record identifier expressed as an array of byte values.",
+          "complexTypes": [],
+          "type": "number[]"
+        },
+        {
+          "name": "payload",
+          "tags": [],
+          "docs": "Raw payload expressed as an array of byte values.",
+          "complexTypes": [],
+          "type": "number[]"
+        }
+      ]
+    },
+    {
+      "name": "ShareTagOptions",
+      "slug": "sharetagoptions",
+      "docs": "Options used when sharing an NDEF message with another device using Android Beam / P2P mode.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "records",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "NdefRecord"
+          ],
+          "type": "NdefRecord[]"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "NfcEvent",
+      "slug": "nfcevent",
+      "docs": "Generic NFC discovery event dispatched by the plugin.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "NfcEventType"
+          ],
+          "type": "NfcEventType"
+        },
+        {
+          "name": "tag",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "NfcTag"
+          ],
+          "type": "NfcTag"
+        }
+      ]
+    },
+    {
+      "name": "NfcTag",
+      "slug": "nfctag",
+      "docs": "Representation of the full tag information returned by the native layers.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Raw identifier bytes for the tag.",
+          "complexTypes": [],
+          "type": "number[] | undefined"
+        },
+        {
+          "name": "techTypes",
+          "tags": [],
+          "docs": "List of Android tech strings (e.g. `android.nfc.tech.Ndef`).",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Human readable tag type when available (e.g. `NFC Forum Type 2`).",
+          "complexTypes": [],
+          "type": "string | null | undefined"
+        },
+        {
+          "name": "maxSize",
+          "tags": [],
+          "docs": "Maximum writable size in bytes for tags that expose NDEF information.",
+          "complexTypes": [],
+          "type": "number | null | undefined"
+        },
+        {
+          "name": "isWritable",
+          "tags": [],
+          "docs": "Indicates whether the tag can be written to.",
+          "complexTypes": [],
+          "type": "boolean | null | undefined"
+        },
+        {
+          "name": "canMakeReadOnly",
+          "tags": [],
+          "docs": "Indicates whether the tag can be permanently locked.",
+          "complexTypes": [],
+          "type": "boolean | null | undefined"
+        },
+        {
+          "name": "ndefMessage",
+          "tags": [],
+          "docs": "Array of NDEF records discovered on the tag.",
+          "complexTypes": [
+            "NdefRecord"
+          ],
+          "type": "NdefRecord[] | null | undefined"
+        }
+      ]
+    },
+    {
+      "name": "NfcStateChangeEvent",
+      "slug": "nfcstatechangeevent",
+      "docs": "Event emitted whenever the NFC adapter availability changes.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "NfcStatus"
+          ],
+          "type": "NfcStatus"
+        },
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "NfcStatus",
+      "slug": "nfcstatus",
+      "docs": "Possible NFC adapter states returned by {@link CapacitorNfcPlugin.getStatus}.\n\nMatches the constants provided by the original PhoneGap NFC plugin for\ncompatibility with existing applications.",
+      "types": [
+        {
+          "text": "'NFC_OK'",
+          "complexTypes": []
+        },
+        {
+          "text": "'NO_NFC'",
+          "complexTypes": []
+        },
+        {
+          "text": "'NFC_DISABLED'",
+          "complexTypes": []
+        },
+        {
+          "text": "'NDEF_PUSH_DISABLED'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "NfcEventType",
+      "slug": "nfceventtype",
+      "docs": "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.",
+      "types": [
+        {
+          "text": "'tag'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ndef'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ndef-mime'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ndef-formatable'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

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

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +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"]}