vite-uni-dev-tool 1.0.0 → 1.1.0

package/dist/v3/hooks/useNFC/typing.d.ts

@@ -1,396 +1,396 @@
-declare namespace NFC {
-  type Listener = (data: NFC.Result) => void;
-  type NfcOption = {
-    /**
-     * 轮询检验连接状态间隔
-     * 目前只有 android 有效
-     */
-    checkConnectedDelay?: number;
-  };
-
-  type NfcResult = {
-    /**
-     * 读取到的数据
-     */
-    data: Ref<Result>;
-    /**
-     * 读取卡是否未 ndef
-     */
-    isNdef: Ref<boolean>;
-    /**
-     * 是否支持 nfc
-     */
-    isSupportNFC: Ref<boolean>;
-    /**
-     * 监听状态
-     */
-    isListening: Ref<boolean>;
-    /**
-     * 连接状态
-     */
-    isConnected: Ref<boolean>;
-    /**
-     * 实例，方便外界调用
-     */
-    nfcInstance: any;
-    /**
-     * 启用
-     *
-     */
-    startHCE: () => Promise<{ errMsg: string }>;
-
-    /**
-     * 停止
-     *
-     */
-    stopHCE: () => Promise<{ errMsg: string }>;
-    /**
-     * 连接
-     *
-     */
-    connect: () => Promise<{ errMsg: string }>;
-    /**
-     * 断开连接
-     * @returns
-     */
-    close: () => Promise<{ errMsg: string }>;
-    /**
-     * 非 ndef 数据写入
-     * TODO: 暂时无法提供通用的写入方法
-     * @deprecated
-     */
-    write: (data: ArrayBuffer) => Promise<{ errMsg: string; data?: any }>;
-    /**
-     * 通用的 ndef 写入方法
-     *
-     */
-    writeNdef: (data: NdefRecord[]) => Promise<{ errMsg: string; data?: any }>;
-    /**
-     * 写入 NDEF 文本数据
-     *
-     * https://developer.android.google.cn/reference/kotlin/android/nfc/NdefRecord?hl=en#createtextrecord
-     *
-     *
-     */
-    writeNdefText: (
-      text: string,
-      /** 微信小程序不支持该属性 */
-      language?: string,
-    ) => Promise<{ errMsg: string; data?: any }>;
-    /**
-     * 写入 NDEF URI 数据
-     *
-     * 会自动根据
-     * https://
-     * tel:
-     * ...
-     * 进行区分
-     *
-     */
-    writeNdefUri: (uri: string) => Promise<{ errMsg: string; data?: any }>;
-    /**
-     * Android 应用包名 写入
-     *
-     */
-    writeNdefAndroidApp: (
-      packageName: string,
-    ) => Promise<{ errMsg: string; data?: any }>;
-    /**
-     * 写入 WiFi 配置到 NFC 标签
-     *
-     */
-    writeNdefWifi: (data: WSCConfig) => Promise<{ errMsg: string; data?: any }>;
-    /**
-     * 写入 vCard 数据到 NFC 标签
-     *
-     */
-    writeNdefVcard: (
-      data: VCardContactInfo,
-    ) => Promise<{ errMsg: string; data?: any }>;
-  };
-
-  interface WSCConfig {
-    ssid: string;
-    password: string;
-    authType: string;
-    encryptionType?: 'AES' | 'TKIP' | 'WEP' | 'NONE';
-    networkKeyIndex?: number; // 1-4 for WEP
-  }
-  /**
-   * 0: TNF_EMPTY
-   * 1: TNF_WELL_KNOWN
-   * 2: TNF_MIME_MEDIA
-   * 3: TNF_ABSOLUTE_URI
-   * 4: TNF_EXTERNAL_TYPE
-   * 5: TNF_UNKNOWN
-   * 6: TNF_UNCHANGED
-   * 7: TNF_RESERVED
-   */
-  type Tnf = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7';
-
-  /**
-   * 这是只是列举了常用的格式
-   * T: 文本记录
-   * U: URI
-   * Sp: Smart Poster记录
-   * Sig: 签名记录
-   * application/vnd.wfa.wsc : Wi-Fi Setup Configuration
-   * android.com:pkg: Android 包名记录
-   * text/vcard: 名片
-   */
-  type NdefMessageType =
-    | 'T'
-    | 'U'
-    | 'Sp'
-    | 'Sig'
-    | 'application/vnd.wfa.wsc'
-    | 'android.com:pkg'
-    | 'text/vcard';
-
-  type NfcType =
-    | 'ISO-DEP'
-    | 'MIFARE Classic'
-    | 'MIFARE Ultralight'
-    | 'NFC-A'
-    | 'NFC-B'
-    | 'NFC-F'
-    | 'NFC-V'
-    | 'Ndef'
-    | 'NDEF'
-    | 'Ndef Formatable'
-    | '';
-  type Message = {
-    records: {
-      id?: any;
-      tnf: Tnf;
-      tnfDescription: string;
-      type: string;
-      typeDescription: string;
-      /** ndef 解析内容 */
-      payload: any;
-    }[];
-  };
-
-  interface VCardContactInfo {
-    // 核心字段（对应 vCard 3.0 标准）
-    fullName: string; // FN：全名
-    version: string; // VERSION：vCard 版本
-    organization: string; // ORG：组织/公司
-    telephone: string; // TEL：电话号码
-    address: string; // ADR：地址
-    url: string; // URL：网址/个人链接
-    // 可扩展字段（如 EMAIL、BDAY 等）
-    [key: string]: string;
-  }
-  type Data = {
-    id: ArrayBuffer;
-    /**
-     * (
-      | 'ISO-DEP'
-      | 'MIFARE Classic'
-      | 'MIFARE Ultralight'
-      | 'NFC-A'
-      | 'NFC-B'
-      | 'NFC-F'
-      | 'NFC-V'
-    )
-     */
-    techs: NfcType[];
-
-    /**
-     * ndef 数据
-     */
-    messages?: Message[];
-    /** SAK */
-    sak?: number;
-    /** SAK 类型 */
-    sakType?: string;
-    sakHex?: string;
-
-    /** 最大数据传输长度 */
-    maxTransceiveLength?: number;
-    /** 卡类型 */
-    nfcType?: NfcType;
-    /** 读写标准 */
-    readWriteStandard?: string[];
-    /** 扇区数 仅安卓 */
-    sectorCount?: number;
-    /** 块数 仅安卓 */
-    blockCount?: number;
-    /** 其他数据 */
-    [key: string]: any;
-  };
-
-  type TransformId = {
-    /** 卡片id 10进制字符串 */
-    byteArray: number[];
-    /** 卡片id 16进制字符串 */
-    hexArray: string[];
-    /** 卡片id 16进制字符串 */
-    hexString: string;
-  };
-
-  type Result = Data & TransformId;
-
-  type Atqa = {
-    atqa: ArrayBuffer;
-    errMsg: string;
-  };
-
-  type Sak = {
-    /**
-     * SAK 是 NFC 终端设备（如手机）与 NFC 标签通信时返回的一个字节数据
-     *
-     * 0x00	未指定类型
-     * 0x08	Mifare Classic 1K
-     * 0x09	Mifare Classic Mini
-     * 0x10	Mifare Plus
-     * 0x11	Mifare Classic 4K
-     * 0x18	Mifare Ultralight / Ultralight C
-     * 0x20	DESFire
-     */
-    sak: number;
-    errno: number;
-    errMsg: string;
-  };
-
-  type MaxTransceiveLength = {
-    /** 最大传输长度 */
-    length: number;
-    errno: number;
-    errMsg: string;
-  };
-
-  type Connected = {
-    /** 标签是否连接 */
-    connected: boolean;
-    errno: number;
-    errMsg: string;
-  };
-
-  type FnOption<R = any, E = any> = {
-    success?: (result: R) => void;
-    fail?: (error: E) => void;
-    complete?: (res: R | E) => void;
-  };
-
-  type NdefData = {
-    /** uri 数组 */
-    uris?: any[];
-    /** text 数组 */
-    texts?: any[];
-    /** 二进制对象数组, 需要指明 id, type 以及 payload (均为 ArrayBuffer 类型) */
-    records?: {
-      /**
-       * 写入的 tnf 类型
-       * 参考 NFC.Tnf 类型
-       * '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' 转成的buffer
-       *
-       */
-      tnf: string | number;
-      /**
-       * 将会转为 buffer
-       */
-      id?: ArrayBuffer | null;
-      /**
-       * 写入的数据格式
-       *
-       */
-      type: ArrayBuffer;
-      /**
-       * 需要写入的数据
-       *
-       * 不同的数据有不同的转换方式，这里需要自定义转换成buffer
-       *
-       * 例如：application/vnd.wfa.wsc 格式 采用了 utils 中的 generateWSCBytesForAndroid 方法进行转换
-       *
-       */
-      payload: ArrayBuffer;
-    }[];
-  };
-
-  type NdefRecord = {
-    tnf: string | number;
-    id?: string;
-    type: string;
-    payload: ArrayBuffer;
-  };
-
-  type Instance = {
-    /** 连接 NFC 标签 */
-    connect: (options?: FnOption) => void;
-    /** 断开连接 */
-    close: (options?: FnOption) => void;
-    /** 设置超时时间 */
-    setTimeout: (options: ?(FnOption & { timeout: number })) => void;
-    /** 获取最大传输长度 */
-    getMaxTransceiveLength: (options?: FnOption<MaxTransceiveLength>) => void;
-    getMaxSize?: (options?: FnOption) => void;
-    /**
-     * 写入数据
-     * 支持以以下类型
-     * ISO-DEP
-     * MIFARE Classic
-     * MIFARE Ultralight
-     * NFC-A
-     * NFC-B
-     * NFC-F
-     * NFC-V
-     */
-    transceive?: (options: ?(FnOption & { data: ArrayBuffer })) => void;
-    /**
-     * 写入数据
-     * 支持以以下类型
-     * Ndef
-     *
-     */
-    writeNdefMessage?: (options: ?(FnOption & NdefData)) => void;
-    /** 获取ATQA信息 */
-    getAtqa?: (options?: FnOption<Atqa>) => void;
-    /** 获取SAK信息 */
-    getSak?: (options?: FnOption<Sak>) => void;
-    /** 检测标签是否连接 */
-    isConnected?: (options?: FnOption<Connected>) => void;
-  };
-
-  type Adapter = {
-    /** 获取IsoDep实例，实例支持ISO-DEP (ISO 14443-4)标准的读写 */
-    getIsoDep: () => any;
-    /** 获取MifareClassic实例，实例支持MIFARE Classic标签的读写 */
-    getMifareClassic: () => any;
-    /** 获取MifareUltralight实例，实例支持MIFARE Ultralight标签的读写 */
-    getMifareUltralight: () => any;
-    /** 获取Ndef实例，实例支持对NDEF格式的NFC标签上的NDEF数据的读写 */
-    getNdef: (options?: FnOption) => NfcA;
-    /** 获取NfcA实例，实例支持NFC-A (ISO 14443-3A)标准的读写 */
-    getNfcA: (options?: FnOption) => any;
-    /** 获取NfcB实例，实例支持NFC-B (ISO 14443-3B)标准的读写 */
-    getNfcB: (options?: FnOption) => any;
-    /** 获取NfcF实例，实例支持NFC-F (JIS 6319-4)标准的读写 */
-    getNfcF: (options?: FnOption) => any;
-    /** 获取NfcV实例，实例支持NFC-V (ISO 15693)标准的读写 */
-    getNfcV: (options?: FnOption) => any;
-    /** 启用 nfc 模块  */
-    startDiscovery: (options?: FnOption) => void;
-    /** 停用 nfc 模块 */
-    stopDiscovery: () => void;
-    /** nfc 读取监听 */
-    onDiscovered: (callback: (res: NFC.Data) => void) => void;
-    /** nfc 移除监听 */
-    offDiscovered: (callback: (res: NFC.Data) => void) => void;
-
-    /** 安卓环境 判断适配器是否可用 */
-    isEnabled: () => boolean;
-
-    /** 安卓环境 停用前台调度 */
-    disableForegroundDispatch: (main: any) => void;
-
-    /** 安卓环境 启用前台调度 */
-    enableForegroundDispatch: (
-      main: any,
-      pendingIntent: any,
-      intentFiltersArray: any[],
-      techListsArray: any[] | null,
-    ) => void;
-  };
-}
+declare namespace NFC {
+  type Listener = (data: NFC.Result) => void;
+  type NfcOption = {
+    /**
+     * 轮询检验连接状态间隔
+     * 目前只有 android 有效
+     */
+    checkConnectedDelay?: number;
+  };
+
+  type NfcResult = {
+    /**
+     * 读取到的数据
+     */
+    data: Ref<Result>;
+    /**
+     * 读取卡是否未 ndef
+     */
+    isNdef: Ref<boolean>;
+    /**
+     * 是否支持 nfc
+     */
+    isSupportNFC: Ref<boolean>;
+    /**
+     * 监听状态
+     */
+    isListening: Ref<boolean>;
+    /**
+     * 连接状态
+     */
+    isConnected: Ref<boolean>;
+    /**
+     * 实例，方便外界调用
+     */
+    nfcInstance: any;
+    /**
+     * 启用
+     *
+     */
+    startHCE: () => Promise<{ errMsg: string }>;
+
+    /**
+     * 停止
+     *
+     */
+    stopHCE: () => Promise<{ errMsg: string }>;
+    /**
+     * 连接
+     *
+     */
+    connect: () => Promise<{ errMsg: string }>;
+    /**
+     * 断开连接
+     * @returns
+     */
+    close: () => Promise<{ errMsg: string }>;
+    /**
+     * 非 ndef 数据写入
+     * TODO: 暂时无法提供通用的写入方法
+     * @deprecated
+     */
+    write: (data: ArrayBuffer) => Promise<{ errMsg: string; data?: any }>;
+    /**
+     * 通用的 ndef 写入方法
+     *
+     */
+    writeNdef: (data: NdefRecord[]) => Promise<{ errMsg: string; data?: any }>;
+    /**
+     * 写入 NDEF 文本数据
+     *
+     * https://developer.android.google.cn/reference/kotlin/android/nfc/NdefRecord?hl=en#createtextrecord
+     *
+     *
+     */
+    writeNdefText: (
+      text: string,
+      /** 微信小程序不支持该属性 */
+      language?: string,
+    ) => Promise<{ errMsg: string; data?: any }>;
+    /**
+     * 写入 NDEF URI 数据
+     *
+     * 会自动根据
+     * https://
+     * tel:
+     * ...
+     * 进行区分
+     *
+     */
+    writeNdefUri: (uri: string) => Promise<{ errMsg: string; data?: any }>;
+    /**
+     * Android 应用包名 写入
+     *
+     */
+    writeNdefAndroidApp: (
+      packageName: string,
+    ) => Promise<{ errMsg: string; data?: any }>;
+    /**
+     * 写入 WiFi 配置到 NFC 标签
+     *
+     */
+    writeNdefWifi: (data: WSCConfig) => Promise<{ errMsg: string; data?: any }>;
+    /**
+     * 写入 vCard 数据到 NFC 标签
+     *
+     */
+    writeNdefVcard: (
+      data: VCardContactInfo,
+    ) => Promise<{ errMsg: string; data?: any }>;
+  };
+
+  interface WSCConfig {
+    ssid: string;
+    password: string;
+    authType: string;
+    encryptionType?: 'AES' | 'TKIP' | 'WEP' | 'NONE';
+    networkKeyIndex?: number; // 1-4 for WEP
+  }
+  /**
+   * 0: TNF_EMPTY
+   * 1: TNF_WELL_KNOWN
+   * 2: TNF_MIME_MEDIA
+   * 3: TNF_ABSOLUTE_URI
+   * 4: TNF_EXTERNAL_TYPE
+   * 5: TNF_UNKNOWN
+   * 6: TNF_UNCHANGED
+   * 7: TNF_RESERVED
+   */
+  type Tnf = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7';
+
+  /**
+   * 这是只是列举了常用的格式
+   * T: 文本记录
+   * U: URI
+   * Sp: Smart Poster记录
+   * Sig: 签名记录
+   * application/vnd.wfa.wsc : Wi-Fi Setup Configuration
+   * android.com:pkg: Android 包名记录
+   * text/vcard: 名片
+   */
+  type NdefMessageType =
+    | 'T'
+    | 'U'
+    | 'Sp'
+    | 'Sig'
+    | 'application/vnd.wfa.wsc'
+    | 'android.com:pkg'
+    | 'text/vcard';
+
+  type NfcType =
+    | 'ISO-DEP'
+    | 'MIFARE Classic'
+    | 'MIFARE Ultralight'
+    | 'NFC-A'
+    | 'NFC-B'
+    | 'NFC-F'
+    | 'NFC-V'
+    | 'Ndef'
+    | 'NDEF'
+    | 'Ndef Formatable'
+    | '';
+  type Message = {
+    records: {
+      id?: any;
+      tnf: Tnf;
+      tnfDescription: string;
+      type: string;
+      typeDescription: string;
+      /** ndef 解析内容 */
+      payload: any;
+    }[];
+  };
+
+  interface VCardContactInfo {
+    // 核心字段（对应 vCard 3.0 标准）
+    fullName: string; // FN：全名
+    version: string; // VERSION：vCard 版本
+    organization: string; // ORG：组织/公司
+    telephone: string; // TEL：电话号码
+    address: string; // ADR：地址
+    url: string; // URL：网址/个人链接
+    // 可扩展字段（如 EMAIL、BDAY 等）
+    [key: string]: string;
+  }
+  type Data = {
+    id: ArrayBuffer;
+    /**
+     * (
+      | 'ISO-DEP'
+      | 'MIFARE Classic'
+      | 'MIFARE Ultralight'
+      | 'NFC-A'
+      | 'NFC-B'
+      | 'NFC-F'
+      | 'NFC-V'
+    )
+     */
+    techs: NfcType[];
+
+    /**
+     * ndef 数据
+     */
+    messages?: Message[];
+    /** SAK */
+    sak?: number;
+    /** SAK 类型 */
+    sakType?: string;
+    sakHex?: string;
+
+    /** 最大数据传输长度 */
+    maxTransceiveLength?: number;
+    /** 卡类型 */
+    nfcType?: NfcType;
+    /** 读写标准 */
+    readWriteStandard?: string[];
+    /** 扇区数 仅安卓 */
+    sectorCount?: number;
+    /** 块数 仅安卓 */
+    blockCount?: number;
+    /** 其他数据 */
+    [key: string]: any;
+  };
+
+  type TransformId = {
+    /** 卡片id 10进制字符串 */
+    byteArray: number[];
+    /** 卡片id 16进制字符串 */
+    hexArray: string[];
+    /** 卡片id 16进制字符串 */
+    hexString: string;
+  };
+
+  type Result = Data & TransformId;
+
+  type Atqa = {
+    atqa: ArrayBuffer;
+    errMsg: string;
+  };
+
+  type Sak = {
+    /**
+     * SAK 是 NFC 终端设备（如手机）与 NFC 标签通信时返回的一个字节数据
+     *
+     * 0x00	未指定类型
+     * 0x08	Mifare Classic 1K
+     * 0x09	Mifare Classic Mini
+     * 0x10	Mifare Plus
+     * 0x11	Mifare Classic 4K
+     * 0x18	Mifare Ultralight / Ultralight C
+     * 0x20	DESFire
+     */
+    sak: number;
+    errno: number;
+    errMsg: string;
+  };
+
+  type MaxTransceiveLength = {
+    /** 最大传输长度 */
+    length: number;
+    errno: number;
+    errMsg: string;
+  };
+
+  type Connected = {
+    /** 标签是否连接 */
+    connected: boolean;
+    errno: number;
+    errMsg: string;
+  };
+
+  type FnOption<R = any, E = any> = {
+    success?: (result: R) => void;
+    fail?: (error: E) => void;
+    complete?: (res: R | E) => void;
+  };
+
+  type NdefData = {
+    /** uri 数组 */
+    uris?: any[];
+    /** text 数组 */
+    texts?: any[];
+    /** 二进制对象数组, 需要指明 id, type 以及 payload (均为 ArrayBuffer 类型) */
+    records?: {
+      /**
+       * 写入的 tnf 类型
+       * 参考 NFC.Tnf 类型
+       * '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' 转成的buffer
+       *
+       */
+      tnf: string | number;
+      /**
+       * 将会转为 buffer
+       */
+      id?: ArrayBuffer | null;
+      /**
+       * 写入的数据格式
+       *
+       */
+      type: ArrayBuffer;
+      /**
+       * 需要写入的数据
+       *
+       * 不同的数据有不同的转换方式，这里需要自定义转换成buffer
+       *
+       * 例如：application/vnd.wfa.wsc 格式 采用了 utils 中的 generateWSCBytesForAndroid 方法进行转换
+       *
+       */
+      payload: ArrayBuffer;
+    }[];
+  };
+
+  type NdefRecord = {
+    tnf: string | number;
+    id?: string;
+    type: string;
+    payload: ArrayBuffer;
+  };
+
+  type Instance = {
+    /** 连接 NFC 标签 */
+    connect: (options?: FnOption) => void;
+    /** 断开连接 */
+    close: (options?: FnOption) => void;
+    /** 设置超时时间 */
+    setTimeout: (options: ?(FnOption & { timeout: number })) => void;
+    /** 获取最大传输长度 */
+    getMaxTransceiveLength: (options?: FnOption<MaxTransceiveLength>) => void;
+    getMaxSize?: (options?: FnOption) => void;
+    /**
+     * 写入数据
+     * 支持以以下类型
+     * ISO-DEP
+     * MIFARE Classic
+     * MIFARE Ultralight
+     * NFC-A
+     * NFC-B
+     * NFC-F
+     * NFC-V
+     */
+    transceive?: (options: ?(FnOption & { data: ArrayBuffer })) => void;
+    /**
+     * 写入数据
+     * 支持以以下类型
+     * Ndef
+     *
+     */
+    writeNdefMessage?: (options: ?(FnOption & NdefData)) => void;
+    /** 获取ATQA信息 */
+    getAtqa?: (options?: FnOption<Atqa>) => void;
+    /** 获取SAK信息 */
+    getSak?: (options?: FnOption<Sak>) => void;
+    /** 检测标签是否连接 */
+    isConnected?: (options?: FnOption<Connected>) => void;
+  };
+
+  type Adapter = {
+    /** 获取IsoDep实例，实例支持ISO-DEP (ISO 14443-4)标准的读写 */
+    getIsoDep: () => any;
+    /** 获取MifareClassic实例，实例支持MIFARE Classic标签的读写 */
+    getMifareClassic: () => any;
+    /** 获取MifareUltralight实例，实例支持MIFARE Ultralight标签的读写 */
+    getMifareUltralight: () => any;
+    /** 获取Ndef实例，实例支持对NDEF格式的NFC标签上的NDEF数据的读写 */
+    getNdef: (options?: FnOption) => NfcA;
+    /** 获取NfcA实例，实例支持NFC-A (ISO 14443-3A)标准的读写 */
+    getNfcA: (options?: FnOption) => any;
+    /** 获取NfcB实例，实例支持NFC-B (ISO 14443-3B)标准的读写 */
+    getNfcB: (options?: FnOption) => any;
+    /** 获取NfcF实例，实例支持NFC-F (JIS 6319-4)标准的读写 */
+    getNfcF: (options?: FnOption) => any;
+    /** 获取NfcV实例，实例支持NFC-V (ISO 15693)标准的读写 */
+    getNfcV: (options?: FnOption) => any;
+    /** 启用 nfc 模块  */
+    startDiscovery: (options?: FnOption) => void;
+    /** 停用 nfc 模块 */
+    stopDiscovery: () => void;
+    /** nfc 读取监听 */
+    onDiscovered: (callback: (res: NFC.Data) => void) => void;
+    /** nfc 移除监听 */
+    offDiscovered: (callback: (res: NFC.Data) => void) => void;
+
+    /** 安卓环境 判断适配器是否可用 */
+    isEnabled: () => boolean;
+
+    /** 安卓环境 停用前台调度 */
+    disableForegroundDispatch: (main: any) => void;
+
+    /** 安卓环境 启用前台调度 */
+    enableForegroundDispatch: (
+      main: any,
+      pendingIntent: any,
+      intentFiltersArray: any[],
+      techListsArray: any[] | null,
+    ) => void;
+  };
+}