faceliveness 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/LICENSE +176 -0
  2. package/README.md +144 -2
  3. package/index.d.ts +225 -0
  4. package/index.js +709 -0
  5. package/package.json +102 -3
package/LICENSE ADDED
@@ -0,0 +1,176 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
package/README.md CHANGED
@@ -1,3 +1,145 @@
1
- # Temporary Holding Version
1
+ # faceliveness
2
2
 
3
- 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.
3
+ On-device face liveness checks for Node.js. The user is asked to do a few random actions
4
+ (blink, turn left, turn right, open mouth) in front of the camera, and the check passes only
5
+ if they do them in order. Face detection and landmarks run inside the package (MediaPipe's
6
+ face models on a Rust core): no native dependencies to install and no cloud service.
7
+
8
+ ```bash
9
+ npm install faceliveness
10
+ ```
11
+
12
+ Node.js 22+, prebuilt for Linux (x64, arm64), macOS (Intel, Apple Silicon) and Windows x64.
13
+ Fully typed.
14
+
15
+ ## Quick start
16
+
17
+ ```ts
18
+ import { Engine } from 'faceliveness'
19
+
20
+ const engine = Engine.random(3) // e.g. ['turn_left', 'blink', 'open_mouth']
21
+
22
+ // For each camera frame (raw RGB bytes, e.g. from ffmpeg or a decoded WebRTC frame):
23
+ const result = await engine.processAsync(frame, { width: 640, height: 480, timestampMs })
24
+
25
+ if (result.done) {
26
+ console.log('liveness:', result.status, result.failReason ?? '')
27
+ } else {
28
+ console.log('please:', result.currentChallenge)
29
+ }
30
+ ```
31
+
32
+ `processAsync` runs on Node's worker pool so your server stays responsive; await each call
33
+ before sending the next frame. `process` is the synchronous version.
34
+
35
+ ## API
36
+
37
+ ### `new Engine(challenges, options?)` / `Engine.random(count, options?)`
38
+
39
+ One liveness attempt. Challenges are `'blink' | 'turn_left' | 'turn_right' | 'open_mouth'`.
40
+ `Engine.random` picks them in an unpredictable order (from OS randomness), which is what you
41
+ want in production so attempts can't be pre-recorded.
42
+
43
+ Options: `totalTimeoutMs` (30000), `stepTimeoutMs` (10000), `faceLostMs` (1000),
44
+ `minRealScore` (fail a completed session whose mean `realScore` is below it; off by default,
45
+ calibrate first) and `seed` (a `bigint`, for tests only).
46
+
47
+ ### `engine.process(frame, options)` / `engine.processAsync(frame, options)`
48
+
49
+ - `frame`: `Buffer` or `Uint8Array` of pixels.
50
+ - `options`: `{ width, height, timestampMs, format?, stride?, rotation?, mirrored? }`
51
+ - `format`: `'rgb'` (default), `'bgr'`, `'rgba'`, `'bgra'` or `'nv21'`
52
+ - `rotation`: clockwise degrees (0/90/180/270) that turn the frame upright
53
+ - `mirrored`: `true` for selfie-preview frames, so "left" still means the user's left
54
+
55
+ ### `FrameResult`
56
+
57
+ | Field | |
58
+ |---|---|
59
+ | `status` | `'in_progress'`, `'passed'` or `'failed'` |
60
+ | `done` | `true` once passed or failed (it won't change after that) |
61
+ | `currentChallenge`, `remaining` | what to ask the user for now, and how many are left |
62
+ | `failReason` | `'timeout'`, `'step_timeout'`, `'face_lost'`, `'multiple_faces'` or `'spoof_suspected'` |
63
+ | `actions` | actions recognised in this frame |
64
+ | `faceCount`, `faces` | faces in view and their boxes |
65
+ | `signals` | `ear` (eye openness), `mouth` (mouth openness), `yaw` (head turn) |
66
+ | `landmarks` | 478 face-mesh points `[x, y]` of the main face |
67
+ | `realScore` | passive anti-spoofing: 0-1 probability the face is real, not a photo or screen (measured on every 3rd frame with a face, otherwise empty) |
68
+
69
+ ### `new Session(challenges, options?)` and `session.update(timestampMs, { faceCount?, ear?, mouth?, yaw? })`
70
+
71
+ The same challenge logic without image processing, for when you already compute face
72
+ measurements yourself (for example with MediaPipe in the browser).
73
+
74
+ ## Server-side tickets and receipts
75
+
76
+ A result computed on the user's device can't be trusted. Run the engine on your server and let
77
+ other services check a signed receipt:
78
+
79
+ ```ts
80
+ import { Engine, SigningKey, verifyReceipt } from 'faceliveness'
81
+
82
+ const key = SigningKey.generate() // once; store key.toBytes() as a secret
83
+ const ticket = key.issueTicket({ count: 3 }) // signed JWT: random challenges, 2 min expiry
84
+
85
+ const engine = Engine.fromTicket(ticket, key.publicKey)
86
+ // ... await engine.processAsync(frame, ...) for each frame the client streams, until done ...
87
+ const receipt = engine.receipt(key) // signed JWT with the outcome and a frame hash
88
+
89
+ // Any other service, with only the public key:
90
+ const r = verifyReceipt(receipt, key.publicKey)
91
+ if (r.passed && !alreadyUsed(r.nonce)) {
92
+ // accept each nonce once
93
+ }
94
+ ```
95
+
96
+ Tickets and receipts are standard Ed25519 (`EdDSA`) JWTs, so any JWT library can verify them.
97
+
98
+ ## Face record for matching
99
+
100
+ Each session keeps its best face: the frame that is most frontal, eyes open, mouth closed,
101
+ sharp, well lit and large enough, aligned to the standard 112x112 template most
102
+ face-recognition models expect (ArcFace, SFace, MobileFaceNet...). Pass `captureSize` in the
103
+ options for another size.
104
+
105
+ ```ts
106
+ const c = engine.capture() // FaceCapture | null
107
+ c.png // aligned face as a PNG Buffer: store/send these exact bytes
108
+ c.quality // 0-1; below ~0.3 matching will be unreliable
109
+ c.rgb // raw RGB pixels, c.size x c.size x 3
110
+ ```
111
+
112
+ The signed receipt records `faceSha256` (the PNG's hash) and `faceQuality`, so liveness and the
113
+ face record are one signed fact. In your face-matching service, accept a face only like this:
114
+
115
+ ```ts
116
+ const r = verifyFaceRecord(receipt, publicKey, facePng)
117
+ // throws unless: genuine and unexpired receipt, session passed, and facePng is the exact image
118
+ // the receipt vouches for. Then also reject a nonce you've seen before.
119
+ ```
120
+
121
+ This stops someone from passing liveness with their own face and then submitting a photo of
122
+ someone else for matching.
123
+
124
+ ## Security notes
125
+
126
+ - Challenge-response stops printed photos (they can't blink, and tilting one doesn't count as a
127
+ head turn) and makes pre-recorded video unlikely to match. It does not stop a live deepfake
128
+ or an injected virtual camera.
129
+ - `realScore` is uncalibrated for your cameras, so it is only reported by default. Record
130
+ genuine and attack videos and run `tools/calibrate_spoof.py` before setting `minRealScore`.
131
+ - Full details: [threat model](https://github.com/wiseman-umanah/Face-Liveness/blob/master/docs/threat-model.md).
132
+
133
+ ## Develop
134
+
135
+ ```bash
136
+ pnpm install
137
+ pnpm build # native addon (faceliveness.<platform>.node) + index.d.ts
138
+ pnpm test
139
+ pnpm bench
140
+ ```
141
+
142
+ ## License
143
+
144
+ Apache-2.0. Bundles MediaPipe face models (Apache-2.0); see
145
+ [models/README.md](https://github.com/wiseman-umanah/Face-Liveness/blob/master/crates/liveness-core/models/README.md).
package/index.d.ts ADDED
@@ -0,0 +1,225 @@
1
+ /* auto-generated by NAPI-RS; edit src/lib.rs or types-header.d.ts instead */
2
+ /* eslint-disable */
3
+
4
+ export type Challenge = 'blink' | 'turn_left' | 'turn_right' | 'open_mouth'
5
+ export type PixelFormat = 'rgb' | 'bgr' | 'rgba' | 'bgra' | 'nv21'
6
+ export type LivenessStatus = 'in_progress' | 'passed' | 'failed'
7
+ export type FailReason = 'timeout' | 'step_timeout' | 'face_lost' | 'multiple_faces' | 'spoof_suspected'
8
+ /**
9
+ * Frames in, liveness verdict out: face detection, landmarks and the challenge flow.
10
+ * One engine is one liveness attempt; create a new one per attempt.
11
+ */
12
+ export declare class Engine {
13
+ constructor(challenges: Challenge[], options?: SessionOptions | undefined | null)
14
+ /** `count` challenges in random order. */
15
+ static random(count: number, options?: SessionOptions | undefined | null): Engine
16
+ /**
17
+ * A session for a ticket from `SigningKey.issueTicket`. Throws if the ticket is forged,
18
+ * signed by another key, or expired. Every frame is hashed into the receipt.
19
+ */
20
+ static fromTicket(token: string, publicKey: Uint8Array, options?: SessionOptions | undefined | null): Engine
21
+ /**
22
+ * Signed receipt (JWT) for a finished ticketed session, for other services to check with
23
+ * `verifyReceipt`. Throws if the session isn't finished or the ticket has expired.
24
+ */
25
+ receipt(signingKey: SigningKey, options?: ReceiptOptions | undefined | null): string
26
+ /**
27
+ * The best face of the session so far, aligned for face matching, or null if no single
28
+ * face was seen. Send `png` with the receipt to your matching service, which checks both
29
+ * with `verifyFaceRecord`.
30
+ */
31
+ capture(): FaceCapture | null
32
+ get challenges(): Challenge[]
33
+ /** Processes one frame on the calling thread (blocks for the inference time). */
34
+ process(frame: Uint8Array, options: FrameOptions): FrameResult
35
+ /**
36
+ * Processes one frame on Node's worker pool, keeping the event loop free.
37
+ * Await each call before sending the next frame.
38
+ */
39
+ processAsync(frame: Uint8Array, options: FrameOptions): Promise<FrameResult>
40
+ }
41
+
42
+ /** Liveness decisions from measurements you compute yourself (no image processing). */
43
+ export declare class Session {
44
+ constructor(challenges: Challenge[], options?: SessionOptions | undefined | null)
45
+ static random(count: number, options?: SessionOptions | undefined | null): Session
46
+ get challenges(): Challenge[]
47
+ /** One frame: how many faces are visible, and the main face's measurements if known. */
48
+ update(timestampMs: number, observation?: Observation | undefined | null): FrameResult
49
+ }
50
+
51
+ /** Ed25519 key for issuing tickets and signing receipts. Keep it on your server. */
52
+ export declare class SigningKey {
53
+ /** A new random key. */
54
+ static generate(): SigningKey
55
+ /** Loads a key saved with `toBytes()` (32 bytes). */
56
+ static fromBytes(secret: Uint8Array): SigningKey
57
+ /** The 32-byte secret: store it like a password. */
58
+ toBytes(): Buffer
59
+ /** The 32-byte public key, for verifying tickets and receipts. */
60
+ get publicKey(): Buffer
61
+ /** A signed ticket (JWT). */
62
+ issueTicket(options?: TicketOptions | undefined | null): string
63
+ }
64
+
65
+ /** A detected face in upright pixel coordinates. */
66
+ export interface FaceBox {
67
+ x: number
68
+ y: number
69
+ width: number
70
+ height: number
71
+ score: number
72
+ }
73
+
74
+ /** The best face of a liveness session, aligned for face matching. */
75
+ export interface FaceCapture {
76
+ /** The aligned face as PNG: store and send these exact bytes. */
77
+ png: Buffer
78
+ /** The same image as raw RGB bytes (size * size * 3). */
79
+ rgb: Buffer
80
+ size: number
81
+ /** 0-1 suitability for matching (frontal, eyes open, mouth closed, sharp, well lit). */
82
+ quality: number
83
+ timestampMs: number
84
+ /** Hex SHA-256 of `png`, as recorded in the receipt. */
85
+ sha256: string
86
+ }
87
+
88
+ export interface FrameOptions {
89
+ width: number
90
+ height: number
91
+ /** Capture time in milliseconds; drives every timeout. */
92
+ timestampMs: number
93
+ /** Default 'rgb' (3 bytes per pixel). */
94
+ format?: PixelFormat
95
+ /** Bytes per row; defaults to width x bytes per pixel. */
96
+ stride?: number
97
+ /** Clockwise degrees (0, 90, 180, 270) that turn the frame upright. */
98
+ rotation?: number
99
+ /** True for selfie-style mirrored frames. */
100
+ mirrored?: boolean
101
+ }
102
+
103
+ export interface FrameResult {
104
+ status: LivenessStatus
105
+ /** True once passed or failed; later frames won't change the outcome. */
106
+ done: boolean
107
+ /** What the user should do now, while in progress. */
108
+ currentChallenge?: Challenge
109
+ /** Challenges left including the current one, while in progress. */
110
+ remaining: number
111
+ failReason?: FailReason
112
+ /** Actions recognised in this frame. */
113
+ actions: Challenge[]
114
+ faceCount: number
115
+ signals?: Signals
116
+ /** Empty for `Session.update`. */
117
+ faces: Array<FaceBox>
118
+ /** 478 face-mesh landmarks [x, y] of the primary face, in upright pixels. */
119
+ landmarks?: Array<[number, number]>
120
+ /**
121
+ * Passive anti-spoofing: probability (0-1) that the face is real rather than a photo or
122
+ * screen. Measured on every 3rd frame with a face (absent otherwise); uncalibrated for
123
+ * your cameras.
124
+ */
125
+ realScore?: number
126
+ }
127
+
128
+ export interface Observation {
129
+ /** Faces in view (default 1). */
130
+ faceCount?: number
131
+ ear?: number
132
+ mouth?: number
133
+ yaw?: number
134
+ }
135
+
136
+ /** A verified liveness receipt. */
137
+ export interface Receipt {
138
+ /** The ticket's nonce: accept each nonce only once. */
139
+ nonce: string
140
+ challenges: Challenge[]
141
+ passed: boolean
142
+ failReason?: FailReason
143
+ frames: number
144
+ framesSha256: string
145
+ realScore?: number
146
+ /** Hex SHA-256 of the session's face record PNG, if a face was captured. */
147
+ faceSha256?: string
148
+ faceQuality?: number
149
+ issuedAt: number
150
+ expiresAt: number
151
+ }
152
+
153
+ export interface ReceiptOptions {
154
+ /** How long the receipt stays valid (default 300). */
155
+ ttlSecs?: number
156
+ /** Current Unix time in seconds (default: the system clock). */
157
+ now?: number
158
+ }
159
+
160
+ export interface SessionOptions {
161
+ /** Fail if the whole check takes longer than this (default 30000). */
162
+ totalTimeoutMs?: number
163
+ /** Fail if one challenge takes longer than this (default 10000). */
164
+ stepTimeoutMs?: number
165
+ /** Fail if the face is out of view longer than this (default 1000). */
166
+ faceLostMs?: number
167
+ /**
168
+ * If set, a session that completes its challenges still fails with 'spoof_suspected'
169
+ * when the mean anti-spoofing score is below it. Off by default: calibrate on your own
170
+ * cameras first (see `FrameResult.realScore`).
171
+ */
172
+ minRealScore?: number
173
+ /** For `Engine.fromTicket`: current Unix time in seconds (default: the system clock). */
174
+ now?: number
175
+ /** Side of the face record crop, `engine.capture()` (default 112; 32-512). */
176
+ captureSize?: number
177
+ /**
178
+ * Only for `random`: fixes the challenge order. Leave unset in production so the
179
+ * order comes from the OS and can't be predicted (and pre-recorded).
180
+ */
181
+ seed?: bigint
182
+ }
183
+
184
+ export interface Signals {
185
+ /** Eye aspect ratio: ~0.25-0.35 open, drops sharply during a blink. */
186
+ ear: number
187
+ /** Inner-lip height / width: ~0.05 closed, >0.4 wide open. */
188
+ mouth: number
189
+ /** Nose position between the face edges: ~0.5 facing the camera. */
190
+ yaw: number
191
+ }
192
+
193
+ /** A verified challenge ticket. */
194
+ export interface Ticket {
195
+ nonce: string
196
+ challenges: Challenge[]
197
+ issuedAt: number
198
+ expiresAt: number
199
+ }
200
+
201
+ export interface TicketOptions {
202
+ /** Challenges to ask for; default: `count` random ones. */
203
+ challenges?: Challenge[]
204
+ /** Number of random challenges when `challenges` is not given (default 3). */
205
+ count?: number
206
+ /** How long the ticket stays valid (default 120). */
207
+ ttlSecs?: number
208
+ /** Current Unix time in seconds (default: the system clock). */
209
+ now?: number
210
+ }
211
+
212
+ /**
213
+ * For the face-matching service: checks the receipt (signature, expiry), that the session
214
+ * passed, and that `facePng` is exactly the face record it vouches for; throws otherwise.
215
+ * Accept each nonce only once.
216
+ */
217
+ export declare function verifyFaceRecord(token: string, publicKey: Uint8Array, facePng: Uint8Array, now?: number | undefined | null): Receipt
218
+
219
+ /** Checks a receipt's signature and expiry; throws if invalid. `now` is Unix seconds. */
220
+ export declare function verifyReceipt(token: string, publicKey: Uint8Array, now?: number | undefined | null): Receipt
221
+
222
+ /** Checks a ticket's signature and expiry; throws if invalid. `now` is Unix seconds. */
223
+ export declare function verifyTicket(token: string, publicKey: Uint8Array, now?: number | undefined | null): Ticket
224
+
225
+ export declare function version(): string
package/index.js ADDED
@@ -0,0 +1,709 @@
1
+ // prettier-ignore
2
+ /* eslint-disable */
3
+ // @ts-nocheck
4
+ /* auto-generated by NAPI-RS */
5
+
6
+ const { readFileSync } = require('fs')
7
+ let nativeBinding = null
8
+ const loadErrors = []
9
+
10
+ const isMusl = () => {
11
+ let musl = false
12
+ if (process.platform === 'linux') {
13
+ musl = isMuslFromFilesystem()
14
+ if (musl === null) {
15
+ musl = isMuslFromReport()
16
+ }
17
+ if (musl === null) {
18
+ musl = isMuslFromChildProcess()
19
+ }
20
+ }
21
+ return musl
22
+ }
23
+
24
+ const isFileMusl = (f) => f.includes('libc.musl-') || f.includes('ld-musl-')
25
+
26
+ const isMuslFromFilesystem = () => {
27
+ try {
28
+ return readFileSync('/usr/bin/ldd', 'utf-8').includes('musl')
29
+ } catch {
30
+ return null
31
+ }
32
+ }
33
+
34
+ const isMuslFromReport = () => {
35
+ let report = null
36
+ if (process.report && typeof process.report.getReport === 'function') {
37
+ process.report.excludeNetwork = true
38
+ report = process.report.getReport()
39
+ }
40
+ if (!report) {
41
+ return null
42
+ }
43
+ if (report.header && report.header.glibcVersionRuntime) {
44
+ return false
45
+ }
46
+ if (Array.isArray(report.sharedObjects)) {
47
+ if (report.sharedObjects.some(isFileMusl)) {
48
+ return true
49
+ }
50
+ }
51
+ return false
52
+ }
53
+
54
+ const isMuslFromChildProcess = () => {
55
+ try {
56
+ return require('child_process').execSync('ldd --version', { encoding: 'utf8' }).includes('musl')
57
+ } catch (e) {
58
+ // If we reach this case, we don't know if the system is musl or not, so is better to just fallback to false
59
+ return false
60
+ }
61
+ }
62
+
63
+ function requireNative() {
64
+ if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
65
+ try {
66
+ return require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
67
+ } catch (err) {
68
+ loadErrors.push(err)
69
+ }
70
+ } else if (process.platform === 'android') {
71
+ if (process.arch === 'arm64') {
72
+ try {
73
+ return require('./faceliveness.android-arm64.node')
74
+ } catch (e) {
75
+ loadErrors.push(e)
76
+ }
77
+ try {
78
+ const binding = require('faceliveness-android-arm64')
79
+ const bindingPackageVersion = require('faceliveness-android-arm64/package.json').version
80
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
81
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
82
+ }
83
+ return binding
84
+ } catch (e) {
85
+ loadErrors.push(e)
86
+ }
87
+ } else if (process.arch === 'arm') {
88
+ try {
89
+ return require('./faceliveness.android-arm-eabi.node')
90
+ } catch (e) {
91
+ loadErrors.push(e)
92
+ }
93
+ try {
94
+ const binding = require('faceliveness-android-arm-eabi')
95
+ const bindingPackageVersion = require('faceliveness-android-arm-eabi/package.json').version
96
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
97
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
98
+ }
99
+ return binding
100
+ } catch (e) {
101
+ loadErrors.push(e)
102
+ }
103
+ } else {
104
+ loadErrors.push(new Error(`Unsupported architecture on Android ${process.arch}`))
105
+ }
106
+ } else if (process.platform === 'win32') {
107
+ if (process.arch === 'x64') {
108
+ if ((process.config && process.config.variables && process.config.variables.shlib_suffix === 'dll.a') || (process.config && process.config.variables && process.config.variables.node_target_type === 'shared_library')) {
109
+ try {
110
+ return require('./faceliveness.win32-x64-gnu.node')
111
+ } catch (e) {
112
+ loadErrors.push(e)
113
+ }
114
+ try {
115
+ const binding = require('faceliveness-win32-x64-gnu')
116
+ const bindingPackageVersion = require('faceliveness-win32-x64-gnu/package.json').version
117
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
118
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
119
+ }
120
+ return binding
121
+ } catch (e) {
122
+ loadErrors.push(e)
123
+ }
124
+ } else {
125
+ try {
126
+ return require('./faceliveness.win32-x64-msvc.node')
127
+ } catch (e) {
128
+ loadErrors.push(e)
129
+ }
130
+ try {
131
+ const binding = require('faceliveness-win32-x64-msvc')
132
+ const bindingPackageVersion = require('faceliveness-win32-x64-msvc/package.json').version
133
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
134
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
135
+ }
136
+ return binding
137
+ } catch (e) {
138
+ loadErrors.push(e)
139
+ }
140
+ }
141
+ } else if (process.arch === 'ia32') {
142
+ try {
143
+ return require('./faceliveness.win32-ia32-msvc.node')
144
+ } catch (e) {
145
+ loadErrors.push(e)
146
+ }
147
+ try {
148
+ const binding = require('faceliveness-win32-ia32-msvc')
149
+ const bindingPackageVersion = require('faceliveness-win32-ia32-msvc/package.json').version
150
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
151
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
152
+ }
153
+ return binding
154
+ } catch (e) {
155
+ loadErrors.push(e)
156
+ }
157
+ } else if (process.arch === 'arm64') {
158
+ try {
159
+ return require('./faceliveness.win32-arm64-msvc.node')
160
+ } catch (e) {
161
+ loadErrors.push(e)
162
+ }
163
+ try {
164
+ const binding = require('faceliveness-win32-arm64-msvc')
165
+ const bindingPackageVersion = require('faceliveness-win32-arm64-msvc/package.json').version
166
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
167
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
168
+ }
169
+ return binding
170
+ } catch (e) {
171
+ loadErrors.push(e)
172
+ }
173
+ } else {
174
+ loadErrors.push(new Error(`Unsupported architecture on Windows: ${process.arch}`))
175
+ }
176
+ } else if (process.platform === 'darwin') {
177
+ try {
178
+ return require('./faceliveness.darwin-universal.node')
179
+ } catch (e) {
180
+ loadErrors.push(e)
181
+ }
182
+ try {
183
+ const binding = require('faceliveness-darwin-universal')
184
+ const bindingPackageVersion = require('faceliveness-darwin-universal/package.json').version
185
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
186
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
187
+ }
188
+ return binding
189
+ } catch (e) {
190
+ loadErrors.push(e)
191
+ }
192
+ if (process.arch === 'x64') {
193
+ try {
194
+ return require('./faceliveness.darwin-x64.node')
195
+ } catch (e) {
196
+ loadErrors.push(e)
197
+ }
198
+ try {
199
+ const binding = require('faceliveness-darwin-x64')
200
+ const bindingPackageVersion = require('faceliveness-darwin-x64/package.json').version
201
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
202
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
203
+ }
204
+ return binding
205
+ } catch (e) {
206
+ loadErrors.push(e)
207
+ }
208
+ } else if (process.arch === 'arm64') {
209
+ try {
210
+ return require('./faceliveness.darwin-arm64.node')
211
+ } catch (e) {
212
+ loadErrors.push(e)
213
+ }
214
+ try {
215
+ const binding = require('faceliveness-darwin-arm64')
216
+ const bindingPackageVersion = require('faceliveness-darwin-arm64/package.json').version
217
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
218
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
219
+ }
220
+ return binding
221
+ } catch (e) {
222
+ loadErrors.push(e)
223
+ }
224
+ } else {
225
+ loadErrors.push(new Error(`Unsupported architecture on macOS: ${process.arch}`))
226
+ }
227
+ } else if (process.platform === 'freebsd') {
228
+ if (process.arch === 'x64') {
229
+ try {
230
+ return require('./faceliveness.freebsd-x64.node')
231
+ } catch (e) {
232
+ loadErrors.push(e)
233
+ }
234
+ try {
235
+ const binding = require('faceliveness-freebsd-x64')
236
+ const bindingPackageVersion = require('faceliveness-freebsd-x64/package.json').version
237
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
238
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
239
+ }
240
+ return binding
241
+ } catch (e) {
242
+ loadErrors.push(e)
243
+ }
244
+ } else if (process.arch === 'arm64') {
245
+ try {
246
+ return require('./faceliveness.freebsd-arm64.node')
247
+ } catch (e) {
248
+ loadErrors.push(e)
249
+ }
250
+ try {
251
+ const binding = require('faceliveness-freebsd-arm64')
252
+ const bindingPackageVersion = require('faceliveness-freebsd-arm64/package.json').version
253
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
254
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
255
+ }
256
+ return binding
257
+ } catch (e) {
258
+ loadErrors.push(e)
259
+ }
260
+ } else {
261
+ loadErrors.push(new Error(`Unsupported architecture on FreeBSD: ${process.arch}`))
262
+ }
263
+ } else if (process.platform === 'linux') {
264
+ if (process.arch === 'x64') {
265
+ if (isMusl()) {
266
+ try {
267
+ return require('./faceliveness.linux-x64-musl.node')
268
+ } catch (e) {
269
+ loadErrors.push(e)
270
+ }
271
+ try {
272
+ const binding = require('faceliveness-linux-x64-musl')
273
+ const bindingPackageVersion = require('faceliveness-linux-x64-musl/package.json').version
274
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
275
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
276
+ }
277
+ return binding
278
+ } catch (e) {
279
+ loadErrors.push(e)
280
+ }
281
+ } else {
282
+ try {
283
+ return require('./faceliveness.linux-x64-gnu.node')
284
+ } catch (e) {
285
+ loadErrors.push(e)
286
+ }
287
+ try {
288
+ const binding = require('faceliveness-linux-x64-gnu')
289
+ const bindingPackageVersion = require('faceliveness-linux-x64-gnu/package.json').version
290
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
291
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
292
+ }
293
+ return binding
294
+ } catch (e) {
295
+ loadErrors.push(e)
296
+ }
297
+ }
298
+ } else if (process.arch === 'arm64') {
299
+ if (isMusl()) {
300
+ try {
301
+ return require('./faceliveness.linux-arm64-musl.node')
302
+ } catch (e) {
303
+ loadErrors.push(e)
304
+ }
305
+ try {
306
+ const binding = require('faceliveness-linux-arm64-musl')
307
+ const bindingPackageVersion = require('faceliveness-linux-arm64-musl/package.json').version
308
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
309
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
310
+ }
311
+ return binding
312
+ } catch (e) {
313
+ loadErrors.push(e)
314
+ }
315
+ } else {
316
+ try {
317
+ return require('./faceliveness.linux-arm64-gnu.node')
318
+ } catch (e) {
319
+ loadErrors.push(e)
320
+ }
321
+ try {
322
+ const binding = require('faceliveness-linux-arm64-gnu')
323
+ const bindingPackageVersion = require('faceliveness-linux-arm64-gnu/package.json').version
324
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
325
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
326
+ }
327
+ return binding
328
+ } catch (e) {
329
+ loadErrors.push(e)
330
+ }
331
+ }
332
+ } else if (process.arch === 'arm') {
333
+ if (isMusl()) {
334
+ try {
335
+ return require('./faceliveness.linux-arm-musleabihf.node')
336
+ } catch (e) {
337
+ loadErrors.push(e)
338
+ }
339
+ try {
340
+ const binding = require('faceliveness-linux-arm-musleabihf')
341
+ const bindingPackageVersion = require('faceliveness-linux-arm-musleabihf/package.json').version
342
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
343
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
344
+ }
345
+ return binding
346
+ } catch (e) {
347
+ loadErrors.push(e)
348
+ }
349
+ } else {
350
+ try {
351
+ return require('./faceliveness.linux-arm-gnueabihf.node')
352
+ } catch (e) {
353
+ loadErrors.push(e)
354
+ }
355
+ try {
356
+ const binding = require('faceliveness-linux-arm-gnueabihf')
357
+ const bindingPackageVersion = require('faceliveness-linux-arm-gnueabihf/package.json').version
358
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
359
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
360
+ }
361
+ return binding
362
+ } catch (e) {
363
+ loadErrors.push(e)
364
+ }
365
+ }
366
+ } else if (process.arch === 'loong64') {
367
+ if (isMusl()) {
368
+ try {
369
+ return require('./faceliveness.linux-loong64-musl.node')
370
+ } catch (e) {
371
+ loadErrors.push(e)
372
+ }
373
+ try {
374
+ const binding = require('faceliveness-linux-loong64-musl')
375
+ const bindingPackageVersion = require('faceliveness-linux-loong64-musl/package.json').version
376
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
377
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
378
+ }
379
+ return binding
380
+ } catch (e) {
381
+ loadErrors.push(e)
382
+ }
383
+ } else {
384
+ try {
385
+ return require('./faceliveness.linux-loong64-gnu.node')
386
+ } catch (e) {
387
+ loadErrors.push(e)
388
+ }
389
+ try {
390
+ const binding = require('faceliveness-linux-loong64-gnu')
391
+ const bindingPackageVersion = require('faceliveness-linux-loong64-gnu/package.json').version
392
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
393
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
394
+ }
395
+ return binding
396
+ } catch (e) {
397
+ loadErrors.push(e)
398
+ }
399
+ }
400
+ } else if (process.arch === 'riscv64') {
401
+ if (isMusl()) {
402
+ try {
403
+ return require('./faceliveness.linux-riscv64-musl.node')
404
+ } catch (e) {
405
+ loadErrors.push(e)
406
+ }
407
+ try {
408
+ const binding = require('faceliveness-linux-riscv64-musl')
409
+ const bindingPackageVersion = require('faceliveness-linux-riscv64-musl/package.json').version
410
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
411
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
412
+ }
413
+ return binding
414
+ } catch (e) {
415
+ loadErrors.push(e)
416
+ }
417
+ } else {
418
+ try {
419
+ return require('./faceliveness.linux-riscv64-gnu.node')
420
+ } catch (e) {
421
+ loadErrors.push(e)
422
+ }
423
+ try {
424
+ const binding = require('faceliveness-linux-riscv64-gnu')
425
+ const bindingPackageVersion = require('faceliveness-linux-riscv64-gnu/package.json').version
426
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
427
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
428
+ }
429
+ return binding
430
+ } catch (e) {
431
+ loadErrors.push(e)
432
+ }
433
+ }
434
+ } else if (process.arch === 'ppc64') {
435
+ try {
436
+ return require('./faceliveness.linux-ppc64-gnu.node')
437
+ } catch (e) {
438
+ loadErrors.push(e)
439
+ }
440
+ try {
441
+ const binding = require('faceliveness-linux-ppc64-gnu')
442
+ const bindingPackageVersion = require('faceliveness-linux-ppc64-gnu/package.json').version
443
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
444
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
445
+ }
446
+ return binding
447
+ } catch (e) {
448
+ loadErrors.push(e)
449
+ }
450
+ } else if (process.arch === 's390x') {
451
+ try {
452
+ return require('./faceliveness.linux-s390x-gnu.node')
453
+ } catch (e) {
454
+ loadErrors.push(e)
455
+ }
456
+ try {
457
+ const binding = require('faceliveness-linux-s390x-gnu')
458
+ const bindingPackageVersion = require('faceliveness-linux-s390x-gnu/package.json').version
459
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
460
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
461
+ }
462
+ return binding
463
+ } catch (e) {
464
+ loadErrors.push(e)
465
+ }
466
+ } else {
467
+ loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
468
+ }
469
+ } else if (process.platform === 'openharmony') {
470
+ if (process.arch === 'arm64') {
471
+ try {
472
+ return require('./faceliveness.openharmony-arm64.node')
473
+ } catch (e) {
474
+ loadErrors.push(e)
475
+ }
476
+ try {
477
+ const binding = require('faceliveness-openharmony-arm64')
478
+ const bindingPackageVersion = require('faceliveness-openharmony-arm64/package.json').version
479
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
480
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
481
+ }
482
+ return binding
483
+ } catch (e) {
484
+ loadErrors.push(e)
485
+ }
486
+ } else if (process.arch === 'x64') {
487
+ try {
488
+ return require('./faceliveness.openharmony-x64.node')
489
+ } catch (e) {
490
+ loadErrors.push(e)
491
+ }
492
+ try {
493
+ const binding = require('faceliveness-openharmony-x64')
494
+ const bindingPackageVersion = require('faceliveness-openharmony-x64/package.json').version
495
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
496
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
497
+ }
498
+ return binding
499
+ } catch (e) {
500
+ loadErrors.push(e)
501
+ }
502
+ } else if (process.arch === 'arm') {
503
+ try {
504
+ return require('./faceliveness.openharmony-arm.node')
505
+ } catch (e) {
506
+ loadErrors.push(e)
507
+ }
508
+ try {
509
+ const binding = require('faceliveness-openharmony-arm')
510
+ const bindingPackageVersion = require('faceliveness-openharmony-arm/package.json').version
511
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
512
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
513
+ }
514
+ return binding
515
+ } catch (e) {
516
+ loadErrors.push(e)
517
+ }
518
+ } else {
519
+ loadErrors.push(new Error(`Unsupported architecture on OpenHarmony: ${process.arch}`))
520
+ }
521
+ } else {
522
+ loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
523
+ }
524
+ }
525
+
526
+ function createLoadErrorChain(errors) {
527
+ return errors.reduce((previous, current) => {
528
+ let message
529
+ try {
530
+ message =
531
+ current && typeof current.message === 'string'
532
+ ? current.message
533
+ : String(current)
534
+ } catch {
535
+ message = 'Unknown error'
536
+ }
537
+ const error = new Error(message)
538
+ error.cause = previous
539
+ return error
540
+ }, null)
541
+ }
542
+
543
+ // NAPI_RS_FORCE_WASI is a tri-state flag:
544
+ // unset / any other value → native binding preferred, WASI is only a fallback
545
+ // 'true' → prefer WASI, but retain native as a lazy fallback
546
+ // 'error' → require WASI without initializing a native fallback
547
+ // Treating any non-empty string as truthy (the historical behavior) meant
548
+ // NAPI_RS_FORCE_WASI=false, NAPI_RS_FORCE_WASI=0, etc. inadvertently triggered
549
+ // the WASI path, causing ENOENT for packages shipped without a .wasi.cjs file.
550
+ //
551
+ // NAPI_RS_WASI_FLAVOR selects one exact generated flavor and implies strict
552
+ // WASI loading. It never crosses into another flavor or falls back to native.
553
+ const __napiWasiFlavors = ["wasm32-wasi"]
554
+ const __napiWasiFlavor = process.env.NAPI_RS_WASI_FLAVOR
555
+ const __napiWasiFlavorRequested =
556
+ typeof __napiWasiFlavor === 'string' && __napiWasiFlavor.length > 0
557
+ if (
558
+ __napiWasiFlavorRequested &&
559
+ __napiWasiFlavors.indexOf(__napiWasiFlavor) === -1
560
+ ) {
561
+ throw new Error(
562
+ 'Unsupported WASI flavor "' +
563
+ __napiWasiFlavor +
564
+ '". Available flavors: ' +
565
+ __napiWasiFlavors.join(', '),
566
+ )
567
+ }
568
+ const forceWasiError = process.env.NAPI_RS_FORCE_WASI === 'error'
569
+ const forceWasi =
570
+ process.env.NAPI_RS_FORCE_WASI === 'true' ||
571
+ forceWasiError ||
572
+ __napiWasiFlavorRequested
573
+
574
+ if (!forceWasi) {
575
+ nativeBinding = requireNative()
576
+ }
577
+
578
+ if (!nativeBinding || forceWasi) {
579
+ let wasiBinding = null
580
+ let wasiBindingLoaded = false
581
+ const wasiBindingErrors = []
582
+ const __napiWasiResolveCandidate = (specifier, isPackage, localArtifacts) => {
583
+ try {
584
+ require.resolve(specifier)
585
+ } catch (resolveError) {
586
+ if (!resolveError || resolveError.code !== 'MODULE_NOT_FOUND') {
587
+ throw resolveError
588
+ }
589
+ if (isPackage) {
590
+ try {
591
+ require.resolve(specifier + '/package.json')
592
+ } catch (packageError) {
593
+ if (packageError && packageError.code === 'MODULE_NOT_FOUND') {
594
+ return resolveError
595
+ }
596
+ // An exports restriction proves the package exists even when its
597
+ // package.json is not public. Preserve the root resolution failure.
598
+ throw resolveError
599
+ }
600
+ // The package exists but its main/export target is broken.
601
+ throw resolveError
602
+ }
603
+ return resolveError
604
+ }
605
+ if (localArtifacts) {
606
+ let artifactError = null
607
+ for (let i = 0; i < localArtifacts.length; i++) {
608
+ try {
609
+ require.resolve(localArtifacts[i])
610
+ return null
611
+ } catch (resolveError) {
612
+ if (!resolveError || resolveError.code !== 'MODULE_NOT_FOUND') {
613
+ throw resolveError
614
+ }
615
+ artifactError = resolveError
616
+ }
617
+ }
618
+ return artifactError
619
+ }
620
+ return null
621
+ }
622
+ if (!wasiBindingLoaded && (!__napiWasiFlavorRequested || __napiWasiFlavor === "wasm32-wasi")) {
623
+ let candidateError = null
624
+ let candidateFailed = false
625
+ try {
626
+ candidateError = __napiWasiResolveCandidate('./faceliveness.wasi.cjs', false, ["./faceliveness.wasm32-wasi.debug.wasm","./faceliveness.wasm32-wasi.wasm"])
627
+ candidateFailed = candidateError !== null
628
+ if (!candidateFailed) {
629
+ wasiBinding = require('./faceliveness.wasi.cjs')
630
+ nativeBinding = wasiBinding
631
+ wasiBindingLoaded = true
632
+ }
633
+ } catch (err) {
634
+ candidateError = err
635
+ candidateFailed = true
636
+ }
637
+ if (candidateFailed) {
638
+ wasiBindingErrors.push(candidateError)
639
+ loadErrors.push(candidateError)
640
+ }
641
+ }
642
+ if (!wasiBindingLoaded && (!__napiWasiFlavorRequested || __napiWasiFlavor === "wasm32-wasi")) {
643
+ let candidateError = null
644
+ let candidateFailed = false
645
+ try {
646
+ candidateError = __napiWasiResolveCandidate('faceliveness-wasm32-wasi', true, undefined)
647
+ candidateFailed = candidateError !== null
648
+ if (!candidateFailed) {
649
+ if (process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
650
+ const bindingPackageVersion = require('faceliveness-wasm32-wasi/package.json').version
651
+ if (bindingPackageVersion !== '0.1.0') {
652
+ throw new Error(`WASI binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
653
+ }
654
+ }
655
+ wasiBinding = require('faceliveness-wasm32-wasi')
656
+ nativeBinding = wasiBinding
657
+ wasiBindingLoaded = true
658
+ }
659
+ } catch (err) {
660
+ candidateError = err
661
+ candidateFailed = true
662
+ }
663
+ if (candidateFailed) {
664
+ wasiBindingErrors.push(candidateError)
665
+ loadErrors.push(candidateError)
666
+ }
667
+ }
668
+ if (
669
+ !wasiBindingLoaded &&
670
+ forceWasi &&
671
+ !forceWasiError &&
672
+ !__napiWasiFlavorRequested
673
+ ) {
674
+ nativeBinding = requireNative()
675
+ }
676
+ if ((forceWasiError || __napiWasiFlavorRequested) && !wasiBindingLoaded) {
677
+ const error = new Error(
678
+ __napiWasiFlavorRequested
679
+ ? 'WASI binding for flavor "' + __napiWasiFlavor + '" not found'
680
+ : 'WASI binding not found and NAPI_RS_FORCE_WASI is set to error',
681
+ )
682
+ error.cause = createLoadErrorChain(wasiBindingErrors)
683
+ throw error
684
+ }
685
+ }
686
+
687
+ if (!nativeBinding) {
688
+ if (loadErrors.length > 0) {
689
+ const error = new Error(
690
+ `Cannot find native binding. ` +
691
+ `npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). ` +
692
+ 'Please try `npm i` again after removing both package-lock.json and node_modules directory.',
693
+ )
694
+ // assign instead of the `new Error(message, { cause })` options form,
695
+ // which Node < 16.9 silently ignores
696
+ error.cause = createLoadErrorChain(loadErrors)
697
+ throw error
698
+ }
699
+ throw new Error(`Failed to load native binding`)
700
+ }
701
+
702
+ module.exports = nativeBinding
703
+ module.exports.Engine = nativeBinding.Engine
704
+ module.exports.Session = nativeBinding.Session
705
+ module.exports.SigningKey = nativeBinding.SigningKey
706
+ module.exports.verifyFaceRecord = nativeBinding.verifyFaceRecord
707
+ module.exports.verifyReceipt = nativeBinding.verifyReceipt
708
+ module.exports.verifyTicket = nativeBinding.verifyTicket
709
+ module.exports.version = nativeBinding.version
package/package.json CHANGED
@@ -1,6 +1,105 @@
1
1
  {
2
2
  "name": "faceliveness",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "0.1.0",
4
+ "description": "On-device face liveness checks (blink, head turn, mouth open) powered by a Rust core",
5
+ "main": "index.js",
6
+ "types": "index.d.ts",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/wiseman-umanah/Face-Liveness.git",
10
+ "directory": "crates/liveness-node"
11
+ },
12
+ "license": "Apache-2.0",
13
+ "keywords": [
14
+ "face",
15
+ "liveness",
16
+ "anti-spoofing",
17
+ "biometrics",
18
+ "kyc",
19
+ "napi-rs",
20
+ "rust"
21
+ ],
22
+ "files": [
23
+ "index.d.ts",
24
+ "index.js"
25
+ ],
26
+ "napi": {
27
+ "binaryName": "faceliveness",
28
+ "targets": [
29
+ "x86_64-unknown-linux-gnu",
30
+ "aarch64-unknown-linux-gnu",
31
+ "x86_64-apple-darwin",
32
+ "aarch64-apple-darwin",
33
+ "x86_64-pc-windows-msvc"
34
+ ],
35
+ "dtsHeaderFile": "types-header.d.ts"
36
+ },
37
+ "engines": {
38
+ "node": ">= 22.14.0 < 23 || >= 23.6.0"
39
+ },
40
+ "publishConfig": {
41
+ "registry": "https://registry.npmjs.org/",
42
+ "access": "public"
43
+ },
44
+ "scripts": {
45
+ "artifacts": "napi artifacts",
46
+ "bench": "node --import @oxc-node/core/register benchmark/bench.ts",
47
+ "build": "napi build --platform --release",
48
+ "build:debug": "napi build --platform",
49
+ "format": "run-p format:oxfmt format:rs",
50
+ "format:oxfmt": "oxfmt",
51
+ "format:rs": "cargo fmt",
52
+ "lint": "oxlint",
53
+ "prepublishOnly": "napi prepublish -t npm",
54
+ "test": "ava",
55
+ "version": "napi version"
56
+ },
57
+ "devDependencies": {
58
+ "@emnapi/core": "^2.0.0-alpha.4",
59
+ "@emnapi/runtime": "^2.0.0-alpha.4",
60
+ "@napi-rs/cli": "^3.8.6",
61
+ "@napi-rs/wasm-runtime": "^1.2.3",
62
+ "@oxc-node/core": "^0.1.0",
63
+ "ava": "^8.0.1",
64
+ "chalk": "^6.0.0",
65
+ "emnapi": "^2.0.0-alpha.4",
66
+ "husky": "^9.1.7",
67
+ "lint-staged": "^17.3.0",
68
+ "npm-run-all2": "^9.0.3",
69
+ "oxfmt": "^0.74.0",
70
+ "oxlint": "^1.79.0",
71
+ "prettier": "^3.9.6",
72
+ "tinybench": "^6.1.3",
73
+ "typescript": "^7.0.2"
74
+ },
75
+ "lint-staged": {
76
+ "*.@(js|ts|tsx)": [
77
+ "oxlint --fix"
78
+ ],
79
+ "*.@(js|ts|tsx|yml|yaml|md|json|toml)": [
80
+ "oxfmt --write"
81
+ ]
82
+ },
83
+ "ava": {
84
+ "extensions": [
85
+ "ts"
86
+ ],
87
+ "timeout": "2m",
88
+ "workerThreads": false,
89
+ "environmentVariables": {
90
+ "TS_NODE_PROJECT": "./tsconfig.json"
91
+ },
92
+ "nodeArguments": [
93
+ "--import",
94
+ "@oxc-node/core/register"
95
+ ]
96
+ },
97
+ "packageManager": "pnpm@12.15.0",
98
+ "optionalDependencies": {
99
+ "faceliveness-linux-x64-gnu": "0.1.0",
100
+ "faceliveness-linux-arm64-gnu": "0.1.0",
101
+ "faceliveness-darwin-x64": "0.1.0",
102
+ "faceliveness-darwin-arm64": "0.1.0",
103
+ "faceliveness-win32-x64-msvc": "0.1.0"
104
+ }
6
105
  }