{"_id":"@dshark95/cordova-plugin-pvt-fingerprint-aio","name":"@dshark95/cordova-plugin-pvt-fingerprint-aio","dist-tags":{"latest":"3.0.7"},"versions":{"3.0.7":{"name":"@dshark95/cordova-plugin-pvt-fingerprint-aio","version":"3.0.7","description":"Cordova plugin to use fingerprint authentication on Android and iOS","cordova":{"id":"cordova-plugin-pvt-fingerprint-aio","platforms":["android","ios"]},"repository":{"type":"git","url":"git+https://github.com/HeB-Mobile/cordova-plugin-fingerprint-aio.git"},"keywords":["cordova","plugin","android","fingerprint","authentication","ecosystem:cordova","cordova-android","cordova-ios","ios"],"author":{"name":"Niklas Merz"},"license":"MIT","bugs":{"url":"https://github.com/HeB-Mobile/cordova-plugin-fingerprint-aio/issues"},"homepage":"https://github.com/HeB-Mobile/cordova-plugin-fingerprint-aio#readme","dependencies":{"cordova-plugin-add-swift-support":"^2.0.2"},"devDependencies":{"cordova-paramedic":"git+https://github.com/apache/cordova-paramedic.git","cordova-plugin-xml":"^0.1.2","eslint":"^6.5.1","jasmine":"^3.2.0"},"scripts":{"test":"npm run eslint","eslint":"npx eslint www","test-travis":"npm run test-ios","test-appveyor":"npm run test-browser","test-local":"npm run test-browser && npm run test-android && npm run test-ios","test-android":"npx cordova-paramedic --platform android --plugin $(pwd) --verbose","test-ios":"npx cordova-paramedic --platform ios --plugin $(pwd) --verbose","test-windows":"npx cordova-paramedic --platform windows --plugin $(pwd)","test-browser":"npx cordova-paramedic --platform browser --plugin $(pwd)","test-saucelabs":"npm run test-saucelabs-ios && npm run test-saucelabs-android","test-saucelabs-ios":"npx cordova-paramedic --config ./pr/ios-10.0 --plugin $(pwd) --shouldUseSauce","test-saucelabs-android":"npx cordova-paramedic --config ./pr/android-7.0 --plugin $(pwd) --shouldUseSauce","plugin-version":"cordova-plugin-xml setVersion"},"engines":{"cordovaDependencies":{">=3.0.0":{"cordova-android":">=8.0.0"}}},"gitHead":"625b976869f4944851631bb6621d9d9bb98eddeb","_id":"@dshark95/cordova-plugin-pvt-fingerprint-aio@3.0.7","_nodeVersion":"14.17.0","_npmVersion":"6.14.13","dist":{"integrity":"sha512-iPhdktv2gzNp6bW3//hFnYkjydkUg5y15BYgsjq2A0heQZ1fK+Opus0+vaHm/n/KrC1py/6IXezfaGn5hXcs1w==","shasum":"a7c25fc1c0adbfe0f27560c7fdc2404496d1b5b8","tarball":"https://registry.npmjs.org/@dshark95/cordova-plugin-pvt-fingerprint-aio/-/cordova-plugin-pvt-fingerprint-aio-3.0.7.tgz","fileCount":36,"unpackedSize":76208,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIQDvwkKrcmdooDrxq+3Xx2VXmHudrTpBF+uURtDdiTgHTwIfE4ejTEAU2mc76I0N2UOZ1gliBao50IUnN2kDzPsgsQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi0OfSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpWjA/+Jxe4jenH46f/vKVB3PUJbCNvSx3Eo1IUduQhILu+1mItvfB/\r\nfmqXivD3s9OldtWntBGqvOehJFQ/wa+m6E4s5qS3GCCnbgDFaCbrPOdR0Cfs\r\ntivB0EegzAVRJtZRVhtBPlJfY3GQY9l2RUGqa2J/EaDIOovOnvBxVFx6B/xZ\r\nFrLyiTgVdiGwlRWjq0uzPmFuJz7/3tbDJBrWKcIEHUH0r+H4GvS2UXXIZxA8\r\nJuFYrgcrc62rW5dO5brZdUEFUCufXmTLe3Y+qXRZnl46J+6m5Mx8zdnu4qRA\r\nuwYTOMuskn5TzbmS/NL7Wrn8ChU6FxFzVntL5l/1DbT58tWzEGbR2i12x4So\r\nBNZOJcLEVAfKVOoRkxZB/EG4398OriTUn0b2q3YEYSCpsg3fT7B49kj8AIYj\r\nqSbw9O1dvOAAnWiU6ooofaakCRWBdnaU2qGPpmKbfU0kfta2vlwI011yC1wL\r\nKCUwjbD6m2pbv+l+/cDZkYwR1duXbWyd8bbnYPktphsYJuR/6k7e4TUs3L9I\r\nyranMbDw7fFfjlT8A8KxD/AdjedYgHUxp+P8Ze5X8ts5hJ5jLvospUmi4iAO\r\nqtRghDde1k85DhQQZ9e/mZufCBqrXPr+PxloRb0oaX6ioW25YJ3AwP5KvemG\r\nH18lbIz340yt9L0AdzVDVye4U5/OXSlUuk8=\r\n=bv5s\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dshark95","email":"leetatyi@hotmail.com"},"directories":{},"maintainers":[{"name":"dshark95","email":"leetatyi@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cordova-plugin-pvt-fingerprint-aio_3.0.7_1657858001992_0.43228633042930564"},"_hasShrinkwrap":false}},"time":{"created":"2022-07-15T04:06:41.894Z","3.0.7":"2022-07-15T04:06:42.186Z","modified":"2022-07-15T04:06:42.319Z"},"maintainers":[{"name":"dshark95","email":"leetatyi@hotmail.com"}],"description":"Cordova plugin to use fingerprint authentication on Android and iOS","homepage":"https://github.com/HeB-Mobile/cordova-plugin-fingerprint-aio#readme","keywords":["cordova","plugin","android","fingerprint","authentication","ecosystem:cordova","cordova-android","cordova-ios","ios"],"repository":{"type":"git","url":"git+https://github.com/HeB-Mobile/cordova-plugin-fingerprint-aio.git"},"author":{"name":"Niklas Merz"},"bugs":{"url":"https://github.com/HeB-Mobile/cordova-plugin-fingerprint-aio/issues"},"license":"MIT","readme":"# Cordova Plugin Fingerprint All-In-One\n## For **Android** and **iOS**\n\n[](https://gitter.im/cordova-plugin-fingerprint-aio)\n[](https://raw.githubusercontent.com/NiklasMerz/cordova-plugin-fingerprint-aio/master/LICENSE)\n[](https://travis-ci.org/NiklasMerz/cordova-plugin-fingerprint-aio)\n[](https://codeclimate.com/github/NiklasMerz/cordova-plugin-fingerprint-aio)\n\n[](https://nodei.co/npm/cordova-plugin-fingerprint-aio/)\n\n\n**This plugin provides a single and simple interface for accessing fingerprint APIs on both Android 6+ and iOS.**\n\n## Features\n\n* Check if a fingerprint scanner is available\n* Fingerprint authentication\n* Ionic Native support\n* ngCordova support\n* Fallback options\n* Now with **FaceID** on iPhone X\n* **⚡️ Works with [Capacitor](https://capacitor.ionicframework.com/). [Try it out](https://github.com/NiklasMerz/capacitor-fingerprint-app) ⚡️**\n\n### Platforms\n\n* Android - Minimum SDK 23\n* iOS - **XCode 9.2 or higher** required\n * _Please set `` in your config.xml_\n\n\n## How to use\n\n**[Tutorial about using this plugin with Ionic](https://www.youtube.com/watch?v=tQDChMJ6er8)** thanks to Paul Halliday\n\n[Examples](https://github.com/NiklasMerz/fingerprint-aio-demo)\n\n[ngCordova Example](https://github.com/NiklasMerz/fingerprint-aio-demo/tree/ng-cordova)\n\n[Ionic Native Example](https://github.com/NiklasMerz/fingerprint-aio-demo/tree/ionic-native)\n\n---\n\n### Install\n\n**Install from NPM**\n\n```\ncordova plugin add cordova-plugin-fingerprint-aio --save\n```\n\nIf you want to set a FaceID description use:\n\n```\ncordova plugin add cordova-plugin-fingerprint-aio --variable FACEID_USAGE_DESCRIPTION=\"Login now....\"\n```\n\n**Use the release candidate for testing the latest fixes**\n\nYou can use preview versions with the `rc` tag on npm.\n\n```\ncordova plugin add cordova-plugin-fingerprint-aio@rc\n```\n\n**Use this Github repo**\n\nGet the latest development version. *Not recommended!*\n\n```\ncordova plugin add https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio.git\n```\n\n### Check if fingerprint authentication is available\n```javascript\nFingerprint.isAvailable(isAvailableSuccess, isAvailableError);\n\n function isAvailableSuccess(result) {\n /*\n result depends on device and os. \n iPhone X will return 'face' other Android or iOS devices will return 'finger' Android P+ will return 'biometric'\n */\n alert(\"Fingerprint available\");\n }\n\n function isAvailableError(error) {\n // 'error' will be an object with an error code and message\n alert(error.message);\n }\n```\n\n### Show authentication dialogue\n```javascript\nFingerprint.show({\n description: \"Some biometric description\"\n }, successCallback, errorCallback);\n\n function successCallback(){\n alert(\"Authentication successful\");\n }\n\n function errorCallback(error){\n alert(\"Authentication invalid \" + error.message);\n }\n```\n### Optional parameters\n\n* __title__: Title in authentication dialogue. Default: `\" Biometric Sign On\"`\n* __subtitle__: Subtitle in authentication dialogue. Default: `null`\n* __description__: Description in authentication dialogue. Defaults:\n * iOS: `\"Authenticate\"` (iOS' [evaluatePolicy()](https://developer.apple.com/documentation/localauthentication/lacontext/1514176-evaluatepolicy?language=objc) requires this field)\n * Android: `null`\n* __fallbackButtonTitle__: Title of fallback button. Defaults:\n * When **disableBackup** is true\n * `\"Cancel\"`\n * When **disableBackup** is false\n * iOS: `\"Use PIN\"`\n * Android: `\"Use Backup\"` (Because backup could be anything pin/pattern/password ..haven't figured out a reliable way to determine lock type yet [source](https://stackoverflow.com/questions/7768879/check-whether-lock-was-enabled-or-not/18720287))\n* __disableBackup__: If `true` remove backup option on authentication dialogue. Default: `false`. This is useful if you want to implement your own fallback.\n* __cancelButtonTitle__: For cancel button on Android\n* __secret__: String secret to encrypt and save\n* __loadSecret__: If `true` previously saved secret will be loaded as a result of successful authentication.\n* __invalidateOnEnrollment__: If `true` secret will be deleted when biometry items are deleted or enrolled \n\n### Constants\n- **BIOMETRIC_UNKNOWN_ERROR** = `-100`;\n- **BIOMETRIC_UNAVAILABLE** = `-101`;\n- **BIOMETRIC_AUTHENTICATION_FAILED** = `-102`;\n- **BIOMETRIC_SDK_NOT_SUPPORTED** = `-103`;\n- **BIOMETRIC_HARDWARE_NOT_SUPPORTED** = `-104`;\n- **BIOMETRIC_PERMISSION_NOT_GRANTED** = `-105`;\n- **BIOMETRIC_NOT_ENROLLED** = `-106`;\n- **BIOMETRIC_INTERNAL_PLUGIN_ERROR** = `-107`;\n- **BIOMETRIC_DISMISSED** = `-108`;\n- **BIOMETRIC_PIN_OR_PATTERN_DISMISSED** = `-109`;\n- **BIOMETRIC_SCREEN_GUARD_UNSECURED** = `-110`;\n- **BIOMETRIC_LOCKED_OUT** = `-111`;\n- **BIOMETRIC_LOCKED_OUT_PERMANENT** = `-112`;\n- **BIOMETRIC_SECRET_NOT_FOUND** = `-113`;\n***\n\nThanks to the authors of the original fingerprint plugins\n\nSome code is refactored from their projects and I learned how to make Cordova plugins from their great plugins:\n\n@EddyVerbruggen and @mjwheatley\n\n[Android](https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth)\n\n[iOS](https://github.com/EddyVerbruggen/cordova-plugin-touch-id)\n\nStarting with version 3.0.0 the iOS and Android parts are written from scratch.\n\n## License\n\nThe project is MIT licensed: [MIT](https://opensource.org/licenses/MIT).\n\n","readmeFilename":"README.md"}