@daboss2003/liveness-web 1.0.0

package/dist/engine.d.ts

@@ -0,0 +1,98 @@
+export type LivenessCallbacks = {
+    onChallengeChanged?: (stepIndex: number, stepLabel: string) => void;
+    onFailure?: (reason: string) => void;
+    onSuccess?: (imageBase64: string) => void;
+    onFaceInOval?: (inside: boolean, reason?: string) => void;
+    onDebugFrame?: (info: {
+        hasFace: boolean;
+        metrics: Metrics | null;
+        step: string;
+    }) => void;
+};
+export type LivenessSoundOptions = {
+    baseUrl?: string;
+    left?: string;
+    blink?: string;
+    right?: string;
+    nod?: string;
+    mouth?: string;
+    good?: string;
+    capture?: string;
+};
+export type LivenessOptions = {
+    videoElement: HTMLVideoElement;
+    canvasElement: HTMLCanvasElement;
+    modelUrl?: string;
+    wasmUrl?: string;
+    callbacks?: LivenessCallbacks;
+    sounds?: LivenessSoundOptions;
+};
+export declare const DEFAULT_MODEL_URL = "https://storage.googleapis.com/mediapipe-models/face_landmarker/face_landmarker/float16/1/face_landmarker.task";
+export declare const DEFAULT_WASM_URL = "https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@latest/wasm";
+/** Error code when CDN/assets are unavailable after retries (internet confirmed). */
+export declare const LIVENESS_ERROR_CDN_NOT_AVAILABLE: "cdnNotAvailable";
+/** Error code when the user has no internet connection. */
+export declare const LIVENESS_ERROR_OFFLINE: "offline";
+export declare function isCdnNotAvailableError(reason: string): boolean;
+export declare function isOfflineError(reason: string): boolean;
+export declare class LivenessError extends Error {
+    readonly code: typeof LIVENESS_ERROR_CDN_NOT_AVAILABLE | typeof LIVENESS_ERROR_OFFLINE;
+    constructor(code: typeof LIVENESS_ERROR_CDN_NOT_AVAILABLE | typeof LIVENESS_ERROR_OFFLINE, message: string);
+}
+export type Metrics = {
+    yaw: number;
+    pitch: number;
+    ear: number;
+    mar: number;
+    blinkScore: number;
+    mouthScore: number;
+    faceCx: number;
+    faceCy: number;
+    faceSize: number;
+};
+export declare const LIVENESS_STEP_COUNT: number;
+export declare class LivenessEngine {
+    private opts;
+    private landmarker;
+    private running;
+    private rafId;
+    private stream;
+    private stepIndex;
+    private stepStart;
+    private baselineYaw;
+    private baselinePitch;
+    private baselineSamples;
+    private blinkState;
+    private blinkCloseTs;
+    private nodState;
+    private holdStart;
+    private latestMetrics;
+    private nodPeakDPitch;
+    private lastDetectTs;
+    private lastOvalState;
+    private stepSoundPlayedForCurrentStep;
+    private currentStepAudio;
+    private currentStepAudioCleanup;
+    private sessionTimeoutId;
+    constructor(opts: LivenessOptions);
+    private playSound;
+    private getSoundUrl;
+    private playStepSound;
+    private stopStepSound;
+    private clearSessionTimeout;
+    private playGoodSound;
+    private playCaptureSound;
+    start(): Promise<void>;
+    stop(): void;
+    private stopDetectionOnly;
+    private ensureVideo;
+    private createLandmarker;
+    private loop;
+    private checkFaceInOval;
+    private resetStepState;
+    private updateState;
+    private advanceStep;
+    private fail;
+    private scheduleCapture;
+    private captureImage;
+}