{"id":13880617,"url":"https://github.com/danielsogl/capacitor-face-id","last_synced_at":"2025-04-04T14:10:10.746Z","repository":{"id":35114990,"uuid":"208571809","full_name":"danielsogl/capacitor-face-id","owner":"danielsogl","description":"Allow users to authenticate with Face ID or Touch ID on iOS devices","archived":false,"fork":false,"pushed_at":"2025-03-20T06:25:14.000Z","size":4045,"stargazers_count":104,"open_issues_count":16,"forks_count":12,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T13:06:11.332Z","etag":null,"topics":["capacitor","capacitor-plugin","face-id","ionic","ios","touch-id"],"latest_commit_sha":null,"homepage":"https://danielsogl.github.io/capacitor-face-id/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielsogl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-15T09:39:21.000Z","updated_at":"2025-03-09T08:25:12.000Z","dependencies_parsed_at":"2023-09-22T07:25:42.868Z","dependency_job_id":"851dbd9a-0a03-4f74-8be2-f838b28e2ea5","html_url":"https://github.com/danielsogl/capacitor-face-id","commit_stats":{"total_commits":214,"total_committers":9,"mean_commits":23.77777777777778,"dds":0.6728971962616823,"last_synced_commit":"cf6e06b0c8f0810b73ed9a63f4177db0cdc298ac"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielsogl%2Fcapacitor-face-id","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielsogl%2Fcapacitor-face-id/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielsogl%2Fcapacitor-face-id/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielsogl%2Fcapacitor-face-id/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielsogl","download_url":"https://codeload.github.com/danielsogl/capacitor-face-id/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247190162,"owners_count":20898697,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capacitor","capacitor-plugin","face-id","ionic","ios","touch-id"],"created_at":"2024-08-06T08:03:17.826Z","updated_at":"2025-04-04T14:10:10.722Z","avatar_url":"https://github.com/danielsogl.png","language":"Swift","funding_links":[],"categories":["Swift"],"sub_categories":[],"readme":"# Capacitor Face ID Plugin\n\n[![npm version](https://badge.fury.io/js/capacitor-face-id.svg)](https://badge.fury.io/js/capacitor-face-id)\n![Build](https://github.com/danielsogl/capacitor-face-id/workflows/Build/badge.svg)\n\nAllow users to authenticate with Face ID or Touch ID on iOS devices\n\n![Logo](https://www.intego.com/mac-security-blog/wp-content/uploads/2017/10/Touch-ID-vs-Face-ID.png)\n\n## Installation\n\n```sh\nnpm install capacitor-face-id\n```\n\n## iOS Notes\n\niOS requires the following usage description be added and filled out for your app in `Info.plist`:\n\nName: `Privacy - Face ID Usage Description`\n\u003cbr\u003e\nKey: `NSFaceIDUsageDescription`\n\n## Example\n\n```ts\nimport { Plugins, PluginResultError } from '@capacitor/core';\n\nconst { FaceId } = Plugins;\n\n...\n// check if device supports Face ID or Touch ID\nFaceId.isAvailable().then(checkResult =\u003e {\n  if(checkResult.value) {\n    FaceId.auth().then(() =\u003e {\n      console.log('authenticated');\n    }).catch((error: PluginResultError) =\u003e {\n      // handle rejection errors\n      console.error(error.message);\n    });\n  } else {\n    // use custom fallback authentication here\n  }\n});\n\n```\n\n## API\n\n| Method                            | Default                                             | Type                         | Description                                                         |\n| --------------------------------- | --------------------------------------------------- | ---------------------------- | ------------------------------------------------------------------- |\n| isAvailable()                     |                                                     | `Promise\u003c{ value: string }\u003e` | Checks if Face ID or Touch ID is available, and returns type if so. |\n| auth(options?: {reason?: string}) | options: {reason: \"Access requires authentication\"} | `Promise\u003cvoid\u003e`              | Displays the Face ID or Touch ID screen                             |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielsogl%2Fcapacitor-face-id","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielsogl%2Fcapacitor-face-id","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielsogl%2Fcapacitor-face-id/lists"}