@powercred/liveness-web 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,283 @@
-# Temporary Holding Version
+# PowerCred Liveness for the web
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@powercred/liveness-web` adds PowerCred's liveness check to your web page. The person centres
+their face, performs a few simple moves (turn, nod, smile), and holds still while the screen shows
+a few colours. The SDK records the check, sends it to PowerCred, and tells you the result.
+
+**PowerCred decides.** The browser follows each move to guide the person and catch mistakes early.
+The verdict always comes from the PowerCred API, and your backend should read it from there before
+acting on it.
+
+For how the check works and its options, see the overview. For the backend calls, see
+the API reference.
+
+## Contents
+
+- [Requirements](#requirements)
+- [Install](#install)
+- [Quick start](#quick-start)
+- [Hosting the assets folder](#hosting-the-assets-folder)
+- [Options](#options)
+- [The result](#the-result)
+- [Events](#events)
+- [Customising the look and text](#customising-the-look-and-text)
+- [Content security policy](#content-security-policy)
+- [Iframes and single-page apps](#iframes-and-single-page-apps)
+
+## Requirements
+
+- **HTTPS.** Browsers only give camera access to secure pages (`http://localhost` also works for
+  development).
+- **A supported browser:** Chrome or Edge 110+, Safari 15.4+ (iOS included), or Firefox 115+.
+  In-app browsers that block the camera are not supported.
+- **A front camera.** Desktop webcams work too.
+- **A backend** that can call the PowerCred API with your API key. The API key must never be put
+  in a web page.
+
+## Install
+
+**With npm** (for bundlers such as Vite, webpack or Next.js):
+
+```bash
+npm install @powercred/liveness-web
+```
+
+**With a script tag:** host the contents of the package's `dist` folder on your site, including
+the `assets` folder, and load the script build. It defines `window.PowerCredLiveness`.
+
+```html
+<script src="/vendor/powercred/liveness.iife.js"></script>
+```
+
+## Quick start
+
+### 1. Create a session on your server
+
+This is the only step on your side that isn't in the browser: one call from your own server to the
+PowerCred API, which returns a session for this check. It stays on your server because it uses
+your API key, which must never be put in a web page. The SDK does everything else: the camera,
+the moves, the recording and the upload.
+
+```js
+// Your server (Node.js shown; any language works)
+app.post('/api/liveness-session', async (req, res) => {
+  const r = await fetch(`https://<api-host>/kyc/id/liveness/sessions?apikey=${process.env.POWERCRED_API_KEY}`, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({ user_id: req.user.id, platform: 'web' }),
+  })
+  const session = await r.json()
+  // Store session.liveness_session_id with the user, then hand the whole session to the page.
+  res.status(r.status).json(session)
+})
+```
+
+### 2. Run the check in your page
+
+```html
+<div id="liveness"></div>
+```
+
+```ts
+import { PowerCredLiveness } from '@powercred/liveness-web'
+
+const check = new PowerCredLiveness({
+  baseUrl: 'https://<api-host>/kyc',
+  sessionProvider: () => fetch('/api/liveness-session', { method: 'POST' }).then(r => r.json()),
+})
+
+const result = await check.start(document.getElementById('liveness')!)
+
+if (result.status === 'passed') {
+  // Tell your backend, which confirms it with PowerCred (step 3).
+}
+```
+
+With the script tag, the code is the same except that the class comes from
+`window.PowerCredLiveness`:
+
+```html
+<script>
+  const check = new PowerCredLiveness.PowerCredLiveness({ baseUrl, sessionProvider })
+</script>
+```
+
+### 3. Confirm the result from your backend
+
+```bash
+curl "https://<api-host>/kyc/id/liveness/sessions/<liveness_session_id>?apikey=$API_KEY"
+```
+
+Approve the person only if this returns `"status": "passed"`. See the
+API reference.
+
+## Hosting the assets folder
+
+For live feedback, the SDK loads a few files from its `assets` folder: a small runtime and a face
+model, about 13 MB in total. Serve them with a long cache lifetime so that browsers download them
+only once.
+
+- **Script tag:** keep `assets` next to `liveness.iife.js`. The SDK finds it by itself.
+- **npm with a bundler:** bundlers don't copy the folder, so copy
+  `node_modules/@powercred/liveness-web/dist/assets` to your public folder as part of your build,
+  and tell the SDK where it is:
+
+  ```ts
+  new PowerCredLiveness({ baseUrl, sessionProvider, assetsUrl: '/powercred-assets/' })
+  ```
+
+If the files cannot be loaded, the check still works: the SDK switches to timed prompts and
+reports this through the `mode` event, with `fallbackReason: "model_unavailable"`.
+
+Serve `.wasm` files as `application/wasm` (most servers and CDNs already do).
+
+## Options
+
+```ts
+new PowerCredLiveness(options)
+```
+
+| Option | Default | Description |
+|---|---|---|
+| `baseUrl` | required | The PowerCred API base, for example `https://<api-host>/kyc` |
+| `session` | | The session your backend created, if you already have it |
+| `sessionProvider` | | An async function that returns a session from your backend. One of `session` or `sessionProvider` is required. |
+| `waitForServer` | `true` | `true`: `start()` resolves with PowerCred's verdict. `false`: it resolves as soon as the recording is finished (`status: "submitted"`) while the upload continues in the background. Keep the page open, and don't call `destroy()`, until `onServerResult` is called. The verdict also reaches your backend. |
+| `flash` | `true` | `false` skips the colour sequence even if the session asks for it |
+| `assetsUrl` | `assets/` next to the SDK | Where the [assets folder](#hosting-the-assets-folder) is served from |
+| `timedWindowSeconds` | `3.5` | Seconds per move when the browser shows timed prompts |
+| `maxLocalRetries` | `2` | How many times the person may restart after a problem the browser catches (wrong way, face lost, too slow). These restarts don't use up attempts. Leaving the page mid-check (another tab or app) also restarts the attempt, but never counts towards this limit. |
+| `showResult` | `true` | Show the built-in final screen (passed, failed or error). Set `false` to show your own when `start()` resolves. The prompts, and "Try again" between attempts, still appear. |
+| `strings` | English | Replace any on-screen text. See [Customising](#customising-the-look-and-text). |
+| `theme` | | `{ primaryColor, fontFamily }` |
+| `onEvent` | | Called with [progress events](#events) |
+| `onServerResult` | | Called with PowerCred's verdict for each uploaded attempt |
+
+The session your backend creates decides the moves, the colour sequence, and whether the browser
+follows the moves live (`client_checks: "device"`, the default) or shows timed prompts
+(`client_checks: "none"`). See Choosing how the check runs.
+
+### Methods
+
+| Method | Description |
+|---|---|
+| `start(container)` | Shows the check inside `container` and resolves with the [result](#the-result) once it is finished. It never rejects for problems the person can see. Those resolve with `status: "error"`. |
+| `cancel()` | Stops a running check. `start()` then resolves with `status: "cancelled"`. |
+| `destroy()` | Cancels, switches off the camera and removes the UI |
+
+## The result
+
+```ts
+{
+  status: 'passed' | 'failed' | 'inconclusive' | 'submitted' | 'cancelled' | 'error',
+  livenessSessionId: string | null,
+  attempt?: number,            // the attempt the verdict belongs to
+  retryAllowed?: boolean,
+  device: { mode: 'device' | 'none', fallbackReason: string | null, passedChallenges: string[] } | null,
+  server?: {                   // PowerCred's verdict (see the API reference)
+    status, attempt, retry_allowed,
+    server_result: { passed, score, reasons, checks },
+  },
+  selfie?: Blob,               // a JPEG photo facing the camera, for your own face match
+  reason?: string,             // why: see below
+}
+```
+
+| `status` | Meaning |
+|---|---|
+| `passed` | PowerCred confirmed the person is live |
+| `failed` | Not confirmed, and no attempts are left, or the person could not complete the moves |
+| `inconclusive` | PowerCred could not decide. Start a new check. |
+| `submitted` | Only with `waitForServer: false`: the recording was sent, and the verdict follows |
+| `cancelled` | Your page called `cancel()` or `destroy()` |
+| `error` | The check could not run. See `reason`. |
+
+**`reason` values:**
+
+| With `status` | `reason` |
+|---|---|
+| `error` | `camera_denied`, `camera_unavailable`, `unsupported_browser`, `insecure_context`, `capture_failed`, `network`, `session_expired`, `session_invalid`, `attempts_exhausted`, `already_passed`, `recording_too_large`, `recording_rejected`, `service_unavailable`, `server_error`, `unexpected` |
+| `failed`, when the person ran out of restarts | The last problem: `wrong_direction`, `face_lost`, `multiple_faces`, `too_slow` or `challenge_timeout:<move>` (for example `challenge_timeout:nod`) |
+| `cancelled` | `cancelled` |
+
+When PowerCred's verdict is `failed` or `inconclusive` with no attempts left, `reason` is not set.
+The verdict's own reasons are in `server.server_result.reasons`.
+
+When an attempt fails on the server and attempts remain, the SDK offers "Try again" by itself.
+`start()` resolves only when the check is finished.
+
+## Events
+
+`onEvent` receives progress events. Use them for analytics, or to drive your own UI around the
+check.
+
+| Event | When |
+|---|---|
+| `{ type: 'camera_ready' }` | The camera is on |
+| `{ type: 'mode', mode, fallbackReason }` | Whether the browser follows moves live (`device`) or shows timed prompts (`none`). `fallbackReason` (`slow_device` or `model_unavailable`) says why it switched. |
+| `{ type: 'recording_started' }` | Recording began |
+| `{ type: 'challenge_started', challenge }` | A move was asked for |
+| `{ type: 'challenge_passed', challenge }` | The browser saw the move |
+| `{ type: 'attempt_aborted', reason }` | The browser stopped the attempt: `wrong_direction`, `face_lost`, `multiple_faces`, `too_slow`, `challenge_timeout:<move>`, or `interrupted` (the person switched to another tab or app mid-check). Nothing is uploaded, and the person is offered a restart. |
+| `{ type: 'flash_started' }`, `{ type: 'flash_ended' }` | The colour sequence |
+| `{ type: 'uploading', bytes }` | The recording is being sent |
+| `{ type: 'server_result', result }` | PowerCred's verdict for an attempt |
+| `{ type: 'error', code, message }` | Something went wrong. `code` matches the `reason` values above. |
+
+## Customising the look and text
+
+**Text:** every on-screen text can be replaced, for example to translate it. The keys and English
+defaults are exported as `defaultStrings`:
+
+```ts
+import { PowerCredLiveness, defaultStrings } from '@powercred/liveness-web'
+
+new PowerCredLiveness({
+  baseUrl, sessionProvider,
+  strings: {
+    center: 'Posisikan wajah Anda di dalam oval',
+    turnLeft: 'Tolehkan kepala ke KIRI',
+    turnRight: 'Tolehkan kepala ke KANAN',
+    // …any keys you leave out stay in English
+  },
+})
+```
+
+**Colours and font:** `theme: { primaryColor: '#0B5FFF', fontFamily: 'Inter, sans-serif' }`.
+
+**Your own result screen:** set `showResult: false` and show your own screen when `start()`
+resolves.
+
+The camera preview is mirrored, as people expect from a front camera. *Left* and *right* in the
+prompts always mean the person's own left and right.
+
+## Content security policy
+
+If your site sets a `Content-Security-Policy`, allow:
+
+| Directive | Add |
+|---|---|
+| `script-src` | The origin serving the SDK and its `assets` folder, and `'wasm-unsafe-eval'` |
+| `connect-src` | Your PowerCred API host, and the origin serving the `assets` folder |
+| `style-src` | `'unsafe-inline'`: the SDK styles its own UI, isolated from your page's styles |
+
+## Iframes and single-page apps
+
+- **Iframes:** the iframe needs camera permission: `<iframe src="…" allow="camera">`.
+- **Single-page apps:** call `destroy()` when the user navigates away, so that the camera is
+  switched off. Use one `PowerCredLiveness` instance per check: `destroy()` the old one and create
+  a new one for the next check.
+- **Several attempts:** within one session, the SDK handles retries by itself. For a fresh start
+  after `failed` or `inconclusive`, create a new session from your backend.
+
+## Privacy
+
+- The camera is only on while the check runs.
+- The recording and photos go only to the PowerCred API, authorised by the session token. Your page
+  never holds your API key.
+- The colour sequence is skipped when the person's device asks for reduced motion.
+
+## Licences
+
+Open-source components included in this package and their licences are listed in
+`THIRD_PARTY_NOTICES.txt`.

package/THIRD_PARTY_NOTICES.txt

@@ -0,0 +1,216 @@
+Third-party software in @powercred/liveness-web
+================================================
+
+The on-device face tracking in this package (the device chunk of the JavaScript
+build and the files in assets/) is built from:
+
+  MediaPipe Tasks Vision 0.10.21, including its face landmark model
+  Copyright The MediaPipe Authors
+  Licensed under the Apache License, Version 2.0 (below)
+
+The files in assets/ are renamed copies; their contents are unmodified.
+
+--------------------------------------------------------------------------------
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.