@voltom.io/sdk 0.0.0-stage → 1.0.2

package/dist/sdk/facekey/global.d.ts

@@ -0,0 +1,7 @@
+import type { VoltomFaceKey as VoltomFaceKeyType } from "../facekey.js";
+
+declare global {
+  var VoltomFaceKey: typeof VoltomFaceKeyType;
+}
+
+export {};

package/dist/sdk/facekey.d.ts

@@ -0,0 +1,72 @@
+export type FaceKeyOperation = "enroll" | "unlock" | "forget";
+
+export type FaceKeyPose = "faceStraight" | "faceUp" | "faceLeft" | "faceRight" | "faceSmile";
+
+export type FaceKeyInput = { token: string; userId?: string };
+
+export type FaceKeyUnlock = {
+  userId: string;
+  matched: boolean;
+  matches: { pose: FaceKeyPose; matched: boolean; score: number }[];
+  reason: string | null;
+};
+
+export type FaceKeyCapability = "enroll" | "unlock" | "forget";
+
+export type FaceKeyOperationOptions = { signal?: AbortSignal; debug?: boolean };
+
+export type VoltomFaceKeyOptions = {
+  clientKey: string;
+  apiUrl?: string;
+  debug?: boolean;
+  language?: "ar" | "ch" | "de" | "en" | "es" | "fr" | "it" | "ja" | "pt" | "zh";
+  capabilities?: FaceKeyCapability[];
+  ui?: boolean;
+  video?: HTMLVideoElement;
+};
+
+export type FaceKeyIdentity = { userId: string };
+
+export type FaceKeyInstruction = {
+  pose: FaceKeyPose;
+  rejection:
+    | "FACEKEY_LOWER_HEAD"
+    | "FACEKEY_LOWER_HEAD_LESS"
+    | "FACEKEY_RAISE_HEAD"
+    | "FACEKEY_RAISE_HEAD_LESS"
+    | "FACEKEY_TILT_HEAD_LEFT"
+    | "FACEKEY_TILT_HEAD_LESS"
+    | "FACEKEY_TILT_HEAD_RIGHT"
+    | "FACEKEY_TURN_HEAD_LEFT"
+    | "FACEKEY_TURN_HEAD_LESS"
+    | "FACEKEY_TURN_HEAD_RIGHT"
+    | "FACEKEY_SMILE_REQUIRED"
+    | "FACEKEY_WINK_LEFT_REQUIRED"
+    | null;
+  retry: string | null;
+};
+
+export type VoltomFaceKeyState = {
+  operation: FaceKeyOperation;
+  phase: "loading" | "capturing" | "checking" | "processing" | "success" | "failure";
+  instruction: FaceKeyInstruction | null;
+  progress: { completed: number; total: number };
+  feedback: { matched: boolean; animating: boolean } | null;
+  error: unknown | null;
+  match: { accepted: boolean; reason: string | null; reference?: boolean; score: number | null } | null;
+  debug: { label: string; valid?: boolean; value: string }[];
+};
+
+export declare class VoltomFaceKey {
+  constructor(options: VoltomFaceKeyOptions);
+  prepare(): Promise<void>;
+  faceEnroll(input: FaceKeyInput, options?: FaceKeyOperationOptions): Promise<FaceKeyIdentity>;
+  faceUnlock(input: FaceKeyInput & { userId: string }, options?: FaceKeyOperationOptions): Promise<FaceKeyUnlock>;
+  faceForget(input: FaceKeyInput & { userId: string }, options?: FaceKeyOperationOptions): Promise<FaceKeyIdentity>;
+  stop(): void;
+  dispose(): void;
+  getState(): VoltomFaceKeyState;
+  subscribe(listener: (state: VoltomFaceKeyState) => void): () => void;
+}
+
+export default VoltomFaceKey;