{"_id":"@bingtang-rn/react-native-simple-biometrics","_rev":"2-d60810f4e8fa65287d6341dfb4397086","name":"@bingtang-rn/react-native-simple-biometrics","dist-tags":{"latest":"3.0.3"},"versions":{"3.0.2":{"name":"@bingtang-rn/react-native-simple-biometrics","version":"3.0.2","keywords":["react-native","harmony","harmonyos","react-native-simple-biometrics"],"license":"MIT","_id":"@bingtang-rn/react-native-simple-biometrics@3.0.2","maintainers":[{"name":"luyizouyuan","email":"189605613@qq.com"}],"homepage":"https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics","dist":{"shasum":"6960ecffac09f02ec1c79ddc3e1bccfb14e80c18","tarball":"https://registry.npmjs.org/@bingtang-rn/react-native-simple-biometrics/-/react-native-simple-biometrics-3.0.2.tgz","fileCount":32,"integrity":"sha512-opJPNCkpemZtKyFgLgMMN35Tt35n7Ff88owQbyHC1plt7hTM6eTo+LIQ/lePXvIvrbAResfIZyweijjIGEPr6w==","signatures":[{"sig":"MEUCIQChOtuEoJRiFFzW4UZtUKWWRHqAhAsqEWM+2sOHyafGowIgeSSV89+sa9owvygJFd3Dve9DAgVB/6fIsu6iiGYb0pw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44378},"main":"./src/index.tsx","module":"./src/index.tsx","engines":{"node":">=18"},"gitHead":"972fa47f51c6a92367787729687110e74b3d7df2","harmony":{"alias":"react-native-simple-biometrics","autolinking":{"ohPackageName":"@oh-rn/react-native-simple-biometrics","cppPackageClassName":"SimpleBiometricsPackage","etsPackageClassName":"SimpleBiometricsPackage","cmakeLibraryTargetName":"simple_biometrics"},"codegenConfig":[{"version":1,"specPaths":["./src"]}]},"private":false,"scripts":{"prepare":"echo skip","codegen-lib":"react-native codegen-harmony --cpp-output-path ./harmony/simple_biometrics/src/main/cpp/generated --ets-output-path ./harmony/simple_biometrics/src/main/ets/generated"},"_npmUser":{"name":"luyizouyuan","email":"189605613@qq.com"},"repository":{"url":"https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics","type":"git"},"_npmVersion":"11.12.1","description":"适配鸿蒙版本，提供react_native_simple_biometrics组件。","directories":{},"_nodeVersion":"24.15.0","react-native":"./src/index.tsx","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.6.3","metro":"^0.81.0","react":"18.2.0","typescript":"5.0.4","@types/react":"18.2.79","react-native":"0.72.5","@react-native/typescript-config":"0.79.5","@react-native-oh/react-native-harmony-cli":"^0.77.50"},"peerDependencies":{"react-native":">=0.72"},"_npmOperationalInternal":{"tmp":"tmp/react-native-simple-biometrics_3.0.2_1785417490971_0.031818283385991464","host":"s3://npm-registry-packages-npm-production"}},"3.0.3":{"_id":"@bingtang-rn/react-native-simple-biometrics@3.0.3","dist":{"shasum":"ce9628c93f134a85b1df38f72cf6ac4b13f71067","tarball":"https://registry.npmjs.org/@bingtang-rn/react-native-simple-biometrics/-/react-native-simple-biometrics-3.0.3.tgz","fileCount":32,"integrity":"sha512-h0EfDp1azguVAkivEtcMTNU/qGWSp0w0w89hTT4xY5498NbhaGLwAiH6/wJBwVuD5Ute7LsyfbSt/7JuTC1qPA==","signatures":[{"sig":"MEQCIDkhaAdLWKxbDlW6IKwT29xX05SEo8Y+MeBNmJbi9ceeAiAbY8mgzuKSaoyH4zejvMOp8/UvIGEQunHLXb6KUdOdcA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD5U6HghW+w8DGOL9qwXwWupDyNhUsP7IUWfO27QzXxPwIgXZvTep4S7XinrlPOokIqkdZgaNjH/eOUqDOXPoLhMsQ="}],"unpackedSize":44692},"main":"./src/index.tsx","name":"@bingtang-rn/react-native-simple-biometrics","_from":"file:bingtang-rn-react-native-simple-biometrics-3.0.3.tgz","module":"./src/index.tsx","engines":{"node":">=18"},"harmony":{"alias":"react-native-simple-biometrics","autolinking":{"ohPackageName":"@bingtang-rn/react-native-simple-biometrics","cppPackageClassName":"SimpleBiometricsPackage","etsPackageClassName":"SimpleBiometricsPackage","cmakeLibraryTargetName":"simple_biometrics"},"codegenConfig":[{"version":1,"specPaths":["./src"]}]},"license":"MIT","private":false,"scripts":{"prepare":"echo skip","codegen-lib":"react-native codegen-harmony --cpp-output-path ./harmony/simple_biometrics/src/main/cpp/generated --ets-output-path ./harmony/simple_biometrics/src/main/ets/generated"},"version":"3.0.3","_npmUser":{"name":"luyizouyuan","email":"189605613@qq.com"},"homepage":"https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics","keywords":["react-native","harmony","harmonyos","react-native-simple-biometrics"],"_resolved":"D:\\code\\rn\\npm\\batch\\react_native_simple_biometrics\\bingtang-rn-react-native-simple-biometrics-3.0.3.tgz","_integrity":"sha512-h0EfDp1azguVAkivEtcMTNU/qGWSp0w0w89hTT4xY5498NbhaGLwAiH6/wJBwVuD5Ute7LsyfbSt/7JuTC1qPA==","repository":{"url":"https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics","type":"git"},"_npmVersion":"11.12.1","description":"适配鸿蒙版本，提供react_native_simple_biometrics组件。","directories":{},"maintainers":[{"name":"luyizouyuan","email":"189605613@qq.com"}],"_nodeVersion":"24.15.0","react-native":"./src/index.tsx","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.6.3","metro":"^0.81.0","react":"18.2.0","typescript":"5.0.4","@types/react":"18.2.79","react-native":"0.72.5","@react-native/typescript-config":"0.79.5","@react-native-oh/react-native-harmony-cli":"^0.77.50"},"peerDependencies":{"react-native":">=0.72"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/react-native-simple-biometrics_3.0.3_1790569692211_0.07467239379530755"}}},"time":{"created":"2026-07-30T13:18:10.375Z","modified":"2026-09-28T04:28:12.481Z","3.0.2":"2026-07-30T13:18:11.133Z","3.0.3":"2026-09-28T04:28:12.301Z"},"license":"MIT","homepage":"https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics","keywords":["react-native","harmony","harmonyos","react-native-simple-biometrics"],"repository":{"url":"https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics","type":"git"},"description":"适配鸿蒙版本，提供react_native_simple_biometrics组件。","maintainers":[{"name":"luyizouyuan","email":"189605613@qq.com"}],"readme":"# @bingtang-rn/react-native-simple-biometrics for HarmonyOS\r\n\r\n本项目基于 [react-native-simple-biometrics](https://github.com/smallcase/react-native-simple-biometrics) 开发，为 React Native 鸿蒙（OpenHarmony）适配版本。如果在使用过程中有任何问题，可以在GitCode提Issue，会及时跟进。issue地址：[issues](https://gitcode.com/rn_ohos_plugin/react_native_simple_biometrics/issues)。\r\n\r\n## 版本对应关系\r\n\r\n| 鸿蒙适配包版本 | 原始库版本 | 支持 RN 版本 | Autolink | 编译 API 版本 |\r\n| ------------ | ---------- | ------------ | -------- | ------------- |\r\n| 见发布记录 | 3.0.2 | 0.72+ | 否 | API17+ |\r\n\r\n## 安装\r\n\r\n```bash\r\nnpm install @bingtang-rn/react-native-simple-biometrics\r\n```\r\n\r\n## 使用\r\n\r\n```tsx\r\nimport RNBiometrics from 'react-native-simple-biometrics';\r\n\r\n// 检查设备是否支持生物识别\r\nconst canAuth = await RNBiometrics.canAuthenticate();\r\n\r\n// 发起生物识别认证\r\ntry {\r\n  const success = await RNBiometrics.requestBioAuth('Security', 'Authenticate to View');\r\n  // success === true 认证成功\r\n} catch (err) {\r\n  // 认证失败或取消\r\n}\r\n```\r\n\r\n> import 时使用原库名 `'react-native-simple-biometrics'`，而非鸿蒙包名。\r\n\r\n**平台差异**：\r\n- `promptMessage` 参数在 HarmonyOS 认证界面中作为导航按钮文本（`navigationButtonText`）展示，而非副标题。这是因为鸿蒙 `WidgetParam` 只有 `title` 和 `navigationButtonText` 两个字段，无 `subtitle`/`message` 字段。\r\n\r\n**权限要求**：\r\n- 需在 `module.json5` 声明 `ohos.permission.ACCESS_BIOMETRIC`（system_grant 级别，安装时自动授权）\r\n\r\n## Link\r\n\r\n| 版本 | 是否支持 Autolink |\r\n|------|------------------|\r\n| 当前版本 | 否（需手动注册） |\r\n\r\n如使用版本支持 Autolink 且工程已接入，可跳过手动配置。\r\n\r\n<details>\r\n<summary>Manual Link 配置</summary>\r\n\r\n> **说明**：本模块需要同时在 C++ 侧和 ETS 侧注册 Package。\r\n\r\n### 1. Overrides RN SDK\r\n\r\n在工程根目录 `oh-package.json5` 添加：\r\n\r\n```json\r\n{\r\n  \"overrides\": {\r\n    \"@rnoh/react-native-openharmony\": \"./react_native_openharmony\"\r\n  }\r\n}\r\n```\r\n\r\n### 2. 引入原生端依赖\r\n\r\n打开 `entry/oh-package.json5`，添加：\r\n\r\n```json\r\n\"dependencies\": {\r\n  \"@bingtang-rn/react-native-simple-biometrics\": \"file:../../node_modules/@bingtang-rn/react-native-simple-biometrics/harmony/simple_biometrics.har\"\r\n}\r\n```\r\n\r\n执行 `ohpm install`。\r\n\r\n### 3. 配置 CMakeLists\r\n\r\n打开 `entry/src/main/cpp/CMakeLists.txt`，添加：\r\n\r\n```cmake\r\nset(OH_MODULES \"${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules\")\r\n\r\nadd_subdirectory(\"${OH_MODULES}/@bingtang-rn/react-native-simple-biometrics/src/main/cpp\" ./simple_biometrics)\r\n\r\ntarget_link_libraries(rnoh_app PUBLIC simple_biometrics)\r\n```\r\n\r\n### 4. 注册 Package（C++ 侧）\r\n\r\n打开 `entry/src/main/cpp/PackageProvider.cpp`，添加：\r\n\r\n```cpp\r\n#include \"SimpleBiometricsPackage.h\"\r\n\r\nstd::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {\r\n    return {\r\n        std::make_shared<SimpleBiometricsPackage>(ctx),\r\n    };\r\n}\r\n```\r\n\r\n### 5. 注册 Package（ETS 侧）\r\n\r\n打开 `entry/src/main/ets/RNPackagesFactory.ets`，添加：\r\n\r\n```typescript\r\nimport { SimpleBiometricsPackage } from '@bingtang-rn/react-native-simple-biometrics/ts';\r\n\r\nexport function createRNPackages(ctx: RNPackageContext): RNPackage[] {\r\n  return [\r\n    new SimpleBiometricsPackage(ctx),\r\n  ];\r\n}\r\n```\r\n\r\n</details>\r\n\r\n## 属性 / API\r\n\r\n| API | 描述 | 参数 | 返回值 | HarmonyOS 支持 |\r\n|-----|------|------|--------|----------------|\r\n| canAuthenticate | 检查设备是否支持生物识别认证 | allowDeviceCredentials?: boolean（默认 true） | Promise<boolean> | ✅ 完全支持 |\r\n| requestBioAuth | 发起生物识别认证弹窗 | promptTitle: string, promptMessage: string, allowDeviceCredentials?: boolean（默认 true） | Promise<boolean> | ⚠️ 部分支持 |\r\n\r\n### 平台差异\r\n- `promptMessage` 参数：Android/iOS 作为认证弹窗副标题展示；HarmonyOS 上作为导航按钮文本（`navigationButtonText`）展示，因为鸿蒙 `WidgetParam` 只有 `title` 和 `navigationButtonText` 两个字段，无 `subtitle`/`message` 字段\r\n\r\n### 使用限制\r\n- 需在 `module.json5` 声明 `ohos.permission.ACCESS_BIOMETRIC`（system_grant 级别，安装时自动授权）\r\n- `canAuthenticate` 实现为逐一尝试 `getAvailableStatus(authType, ATL2)`，任一可用即返回 true；鸿蒙 API 失败时抛异常而非返回布尔值，已用 try-catch 包装\r\n\r\n## 快速验证（运行 Example）\r\n\r\n### 前置条件\r\n\r\n| 依赖 | 版本要求 |\r\n|------|----------|\r\n| Node.js | >= 18 |\r\n| DevEco Studio | 5.0+ / 6.0+ |\r\n| HarmonyOS SDK | API 17+ |\r\n\r\n### 运行步骤\r\n\r\n**1. 克隆仓库**\r\n\r\n```bash\r\ngit clone <仓库地址>\r\ncd <仓库目录>\r\n```\r\n\r\n**2. 安装依赖并构建**\r\n\r\n```bash\r\nnpm install --legacy-peer-deps\r\nnpm pack           # 生成 tgz 包（会自动触发 prepare 构建 JS 产物）\r\n```\r\n\r\n**3. 进入 example 目录，安装依赖**\r\n\r\n```bash\r\ncd example\r\nnpm install --legacy-peer-deps\r\n```\r\n\r\n**4. 生成 JS Bundle**\r\n\r\n```bash\r\nnpm run dev\r\n```\r\n\r\n产物：`harmony/entry/src/main/resources/rawfile/bundle.harmony.js`\r\n\r\n**5. 用 DevEco Studio 打开鸿蒙工程**\r\n\r\n- 打开 DevEco Studio\r\n- 选择 `example/harmony` 目录\r\n- 等待 Sync 完成\r\n\r\n**6. 编译并运行 HAP**\r\n\r\n在 DevEco Studio 中点击运行按钮，将 HAP 安装到设备/模拟器。\r\n\r\n> **注意**：Example 中已预置插件依赖和 Package 注册，无需手动配置 Link。\r\n\r\n## 约束与限制\r\n\r\n### 兼容性\r\n\r\n- RNOH: 0.72+\r\n- HarmonyOS SDK: API 17+\r\n- DevEco Studio: 5.0+\r\n\r\n## 遗留问题\r\n\r\n无\r\n\r\n## 开源协议\r\n\r\n本项目基于 [MIT License](https://github.com/smallcase/react-native-simple-biometrics/blob/master/LICENSE)，详见 [LICENSE](./LICENSE) 文件。\r\n","readmeFilename":"README.md"}