{"_id":"@drefrajo/capacitor-biometric-keychain","_rev":"11-0559f9596723f703c70c9c3deed85565","name":"@drefrajo/capacitor-biometric-keychain","dist-tags":{"latest":"5.0.0"},"versions":{"2.0.4":{"name":"@drefrajo/capacitor-biometric-keychain","version":"2.0.4","keywords":["capacitor","plugin","native"],"author":{"name":"Charlie Jacques"},"license":"MIT","_id":"@drefrajo/capacitor-biometric-keychain@2.0.4","maintainers":[{"name":"drefrajo","email":"franz.drexler@youproof.at"}],"contributors":[{"name":"Charlie Jacques"},{"name":"Franz Josef Drexler"}],"homepage":"https://github.com/drefrajo/capacitor-biometric-keychain#readme","bugs":{"url":"https://github.com/drefrajo/capacitor-biometric-keychain/issues"},"dist":{"shasum":"ba653ad95e225353f9279c179c1b00d9693ec457","tarball":"https://registry.npmjs.org/@drefrajo/capacitor-biometric-keychain/-/capacitor-biometric-keychain-2.0.4.tgz","fileCount":32,"integrity":"sha512-3v3NEuroWmwbDRvx633QuHCv/ZftDytyyn/WMDmGzfDojCZv6MUePeA8wbDb3dLO4RGBIgRCmsSFH56GUQdyew==","signatures":[{"sig":"MEUCIAVwI5eYFy9zx36laHmXMLaicR6tJCiKQaY5fmQFQIsqAiEAirlfLKp6Mt51oNJmQ9Xp0eYOde4LyJUAApJZDfJqfEM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44496},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"bd057fb42c447fc2f8cec7a3387b2a062e389358","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api BiometricNativePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"drefrajo","email":"franz.drexler@youproof.at"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/drefrajo/capacitor-biometric-keychain.git","type":"git"},"_npmVersion":"10.8.1","description":"Uses Keychain and Keystore on ios and android respectively to give a secure localStorage like API that uses a biometric lock for read and update operations","directories":{},"_nodeVersion":"22.4.1","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^7.11.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.3.0","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/ios":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.0.18","@capacitor/android":"^5.0.0","@ionic/eslint-config":"^0.3.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-biometric-keychain_2.0.4_1724670911756_0.6683821955403348","host":"s3://npm-registry-packages"}},"3.0.0":{"name":"@drefrajo/capacitor-biometric-keychain","version":"3.0.0","keywords":["capacitor","plugin","native"],"author":{"name":"Charlie Jacques"},"license":"MIT","_id":"@drefrajo/capacitor-biometric-keychain@3.0.0","maintainers":[{"name":"drefrajo","email":"franz.drexler@youproof.at"}],"contributors":[{"name":"Charlie Jacques"},{"name":"Franz Josef Drexler"}],"homepage":"https://github.com/drefrajo/capacitor-biometric-keychain#readme","bugs":{"url":"https://github.com/drefrajo/capacitor-biometric-keychain/issues"},"dist":{"shasum":"48d646939f3b2e070fc5630af1fd951cc62eb547","tarball":"https://registry.npmjs.org/@drefrajo/capacitor-biometric-keychain/-/capacitor-biometric-keychain-3.0.0.tgz","fileCount":32,"integrity":"sha512-E67MtLs+v2bkOIUbbeV481CnuAOQh3+I5CwMqsVzkjXVwBfHtfP419vSc50sj22D/JjKgxJdxxdvTnxfjHxfCg==","signatures":[{"sig":"MEUCIBzBOvz0JnpTY19pycnLf6OLsjDSXLfa3lVVgctKAHX/AiEAioeVkhKcxECooP/YIOLaMKKvnNggmBWBEGvJCE4Qf34=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44554},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"98ec7c040da37bbcd13a7f366fe49f925476addf","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api BiometricNativePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"drefrajo","email":"franz.drexler@youproof.at"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/drefrajo/capacitor-biometric-keychain.git","type":"git"},"_npmVersion":"10.8.1","description":"Uses Keychain and Keystore on ios and android respectively to give a secure localStorage like API that uses a biometric lock for read and update operations","directories":{},"_nodeVersion":"22.4.1","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.3.0","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/ios":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.0.18","@capacitor/android":"^6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-biometric-keychain_3.0.0_1725468173880_0.1744815421405168","host":"s3://npm-registry-packages"}},"4.0.0":{"name":"@drefrajo/capacitor-biometric-keychain","version":"4.0.0","keywords":["capacitor","plugin","native"],"author":{"name":"Charlie Jacques"},"license":"MIT","_id":"@drefrajo/capacitor-biometric-keychain@4.0.0","maintainers":[{"name":"drefrajo","email":"fj@drefrajo.dev"}],"contributors":[{"name":"Charlie Jacques"},{"name":"Franz Josef Drexler"}],"homepage":"https://github.com/drefrajo/capacitor-biometric-keychain#readme","bugs":{"url":"https://github.com/drefrajo/capacitor-biometric-keychain/issues"},"dist":{"shasum":"e7cdb072c3e1aac478803445aacf11e8ef81fdcc","tarball":"https://registry.npmjs.org/@drefrajo/capacitor-biometric-keychain/-/capacitor-biometric-keychain-4.0.0.tgz","fileCount":32,"integrity":"sha512-AeK2a3ebOihsEMljbtBbD8nLe+f8FuntCJxf2rNTzRvIt1UXacXpSy4xzzK92/MUdJLqcVGIZUW33jsXpSd5Yw==","signatures":[{"sig":"MEUCIQCWI9I0fwzFppDGjLSVSvwVRzQzcbeoRajZ/T128rS1qQIgYoRB1DXaFVikq2adCZCSxKb6mgUve3mHVutck9iJRl8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44470},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"712e7de8b7f549e2b13ed176d548fffe9ea6449b","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api BiometricNativePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"drefrajo","email":"fj@drefrajo.dev"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/drefrajo/capacitor-biometric-keychain.git","type":"git"},"_npmVersion":"10.9.2","description":"Uses Keychain and Keystore on ios and android respectively to give a secure localStorage like API that uses a biometric lock for read and update operations","directories":{},"_nodeVersion":"23.10.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^6.0.1","rollup":"^4.30.1","prettier":"^3.4.2","swiftlint":"^2.0.0","typescript":"~4.1.5","@capacitor/ios":"^7.0.0","@capacitor/core":"^7.0.0","@capacitor/docgen":"^0.3.0","@capacitor/android":"^7.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"^2.6.6","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-biometric-keychain_4.0.0_1761256232007_0.25534508977764103","host":"s3://npm-registry-packages-npm-production"}},"5.0.0":{"name":"@drefrajo/capacitor-biometric-keychain","version":"5.0.0","description":"Uses Keychain and Keystore on ios and android respectively to give a secure localStorage like API that uses a biometric lock for read and update operations","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Charlie Jacques"},"contributors":[{"name":"Charlie Jacques"},{"name":"Franz Josef Drexler"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/drefrajo/capacitor-biometric-keychain.git"},"bugs":{"url":"https://github.com/drefrajo/capacitor-biometric-keychain/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","docgen":"docgen --api BiometricNativePlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"^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","eslint":"^8.57.1","prettier":"^3.6.2","prettier-plugin-java":"^2.7.7","rimraf":"^6.1.0","rollup":"^4.53.2","swiftlint":"^2.0.0","typescript":"^5.9.3"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"gitHead":"59a4c63e8384295fe98eb5a8aa6299dc9fc553fc","_id":"@drefrajo/capacitor-biometric-keychain@5.0.0","homepage":"https://github.com/drefrajo/capacitor-biometric-keychain#readme","_nodeVersion":"25.2.1","_npmVersion":"11.6.2","dist":{"integrity":"sha512-8IBJS9gZS5ugYJk75qv7jbCPgxl6fktqXI8W+IydjYygLIyxocx7NI8ElHRdy3wCNyfA0T28pMDjIr1BJqtwRg==","shasum":"c7f0f5c868ca525e5eb17a763e86100581366969","tarball":"https://registry.npmjs.org/@drefrajo/capacitor-biometric-keychain/-/capacitor-biometric-keychain-5.0.0.tgz","fileCount":32,"unpackedSize":44554,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDF0pn+W5NWZvA5nto4hST1bZdMvYpd1D63FKTuVOcS7gIgDZQ3nnovHrNvduE6gCFnd6OCATJpFcfi9AKwVzxoFIw="}]},"_npmUser":{"name":"drefrajo","email":"fj@drefrajo.dev"},"directories":{},"maintainers":[{"name":"drefrajo","email":"fj@drefrajo.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-biometric-keychain_5.0.0_1771320522797_0.936457921779577"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-26T10:28:37.614Z","modified":"2026-02-17T09:28:43.062Z","2.0.1":"2024-08-26T07:34:48.979Z","2.0.2":"2024-08-26T10:28:37.871Z","2.0.3":"2024-08-26T11:12:17.404Z","2.0.4":"2024-08-26T11:15:11.904Z","3.0.0":"2024-09-04T16:42:54.023Z","4.0.0":"2025-10-23T21:50:32.263Z","5.0.0":"2026-02-17T09:28:42.934Z"},"bugs":{"url":"https://github.com/drefrajo/capacitor-biometric-keychain/issues"},"author":{"name":"Charlie Jacques"},"license":"MIT","homepage":"https://github.com/drefrajo/capacitor-biometric-keychain#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/drefrajo/capacitor-biometric-keychain.git"},"description":"Uses Keychain and Keystore on ios and android respectively to give a secure localStorage like API that uses a biometric lock for read and update operations","contributors":[{"name":"Charlie Jacques"},{"name":"Franz Josef Drexler"}],"maintainers":[{"name":"drefrajo","email":"fj@drefrajo.dev"}],"readme":"# capacitor-biometric-keychain\n\nUses Keychain and Keystore on ios and android respectively to give a secure localStorage like API that uses a biometric lock for read and update operations\n\nThis is a fork of [@flowmoco/capacitor-biometric-keychain](https://github.com/flowmoco/capacitor-biometric-keychain), this way I can maintain it more easily.\n\nCapacitor v8\nAndroid minSdkVersion 24\niOS min version 15.0\nAndroid builds require Java 21.\n\nFor Capacitor v7, use version 4.0.0 of this plugin.\nFor Capacitor v6, use version 3.0.0 of this plugin.\nFor Capacitor v5, use version 2.0.4 of this plugin.\n\n## Install\n\n```bash\nnpm install @drefrajo/capacitor-biometric-keychain\nnpx cap sync\n```\n\n## iOS\nTo enable FaceID, you must set the the NSFaceIDUsageDescription key.\n\n```\n<key>NSFaceIDUsageDescription</key>\n<string>[Reason why your app needs FaceID]</string>\n```\n\n## Import\n```typescript\nimport { BiometricNative } from \"@drefrajo/capacitor-biometric-keychain\";\n```\n\n## API\n\n<docgen-index>\n\n* [`getItem(...)`](#getitem)\n* [`setItem(...)`](#setitem)\n* [`removeItem(...)`](#removeitem)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### getItem(...)\n\n```typescript\ngetItem(options: { key: string; }) => Promise<{ value: string; error?: any; }>\n```\n\nAsync get an item from the secure storage. Will invoke device biometric authentication.\n\n| Param         | Type                          |\n| ------------- | ----------------------------- |\n| **`options`** | <code>{ key: string; }</code> |\n\n**Returns:** <code>Promise&lt;{ value: string; error?: any; }&gt;</code>\n\n--------------------\n\n\n### setItem(...)\n\n```typescript\nsetItem(options: { key: string; value: string; }) => Promise<{ error?: any; }>\n```\n\nAsync set an item in secure storage. Will invoke device biometric authentication on Android and only on iOS if overwriting an existing key.\n\n| Param         | Type                                         |\n| ------------- | -------------------------------------------- |\n| **`options`** | <code>{ key: string; value: string; }</code> |\n\n**Returns:** <code>Promise&lt;{ error?: any; }&gt;</code>\n\n--------------------\n\n\n### removeItem(...)\n\n```typescript\nremoveItem(options: { key: string; }) => Promise<{ error?: any; }>\n```\n\nAsync remove an item from the secure storage. Will not invoke device biometric authentication either platform.\n\n| Param         | Type                          |\n| ------------- | ----------------------------- |\n| **`options`** | <code>{ key: string; }</code> |\n\n**Returns:** <code>Promise&lt;{ error?: any; }&gt;</code>\n\n--------------------\n\n</docgen-api>\n","readmeFilename":"README.md"}