@powercred/liveness-web 0.0.0-stage → 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,138 @@
+/** Public types of @powercred/liveness-web. */
+export type ChallengeType = 'turn_head' | 'nod' | 'smile' | 'blink' | 'open_mouth';
+export type Direction = 'left' | 'right' | 'up' | 'down' | null;
+export interface IssuedChallenge {
+    order: number;
+    type: ChallengeType;
+    direction: Direction;
+    timeout_ms: number;
+}
+export interface FlashSegment {
+    color: string;
+    duration_ms: number;
+}
+/**
+ * What your backend receives from `POST /id/liveness/sessions` and hands to the SDK.
+ * The SDK never needs an API key: the token authorizes uploads for this session only.
+ */
+export interface LivenessSession {
+    liveness_session_id: string;
+    token: string;
+    expires_at: string;
+    mode: 'active' | 'passive';
+    client_checks?: 'device' | 'none';
+    challenges: IssuedChallenge[];
+    flash: {
+        enabled: boolean;
+        segments: FlashSegment[];
+        max_hz?: number;
+    };
+    limits: {
+        max_video_seconds: number;
+        max_video_bytes: number;
+        max_stills: number;
+        max_still_bytes: number;
+        max_attempts: number;
+        accepted_video_types?: string[];
+    };
+    /** Path of the upload endpoint, relative to `baseUrl`. */
+    upload_url: string;
+}
+export interface LivenessConfig {
+    /** Base URL of the PowerCred API, e.g. "https://<api-host>/kyc". */
+    baseUrl: string;
+    /** The session your backend created, or a function that fetches it from your backend. */
+    session?: LivenessSession;
+    sessionProvider?: () => Promise<LivenessSession>;
+    /**
+     * true (default): start() resolves with the server's verdict.
+     * false: start() resolves as soon as the recording is done ("submitted"); the server verdict
+     * arrives through onServerResult while the page stays open, and your backend can read it.
+     */
+    waitForServer?: boolean;
+    /** Set false to skip the colour flash even when the session asks for it. */
+    flash?: boolean;
+    /**
+     * The folder holding the SDK's face-tracking files (the package's dist/assets). Default: the
+     * assets/ folder next to the SDK script. Set it when a bundler moves the SDK away from that folder.
+     */
+    assetsUrl?: string;
+    /** Seconds per challenge when the device does not check moves itself (default 3.5). */
+    timedWindowSeconds?: number;
+    /** Attempts the device may restart on its own before giving up (default 2). */
+    maxLocalRetries?: number;
+    /** Show the built-in result screen (default true). */
+    showResult?: boolean;
+    strings?: Partial<import('./ui/strings').Strings>;
+    theme?: {
+        primaryColor?: string;
+        fontFamily?: string;
+    };
+    onEvent?: (event: LivenessEvent) => void;
+    onServerResult?: (result: ServerOutcome) => void;
+}
+export type DeviceMode = 'device' | 'none';
+export interface DeviceOutcome {
+    mode: DeviceMode;
+    fallbackReason: string | null;
+    /** Challenges the device saw completed, in order (empty in "none" mode). */
+    passedChallenges: ChallengeType[];
+}
+export interface ServerOutcome {
+    liveness_session_id: string;
+    attempt: number;
+    status: 'passed' | 'failed' | 'inconclusive';
+    retry_allowed: boolean;
+    server_result: {
+        passed: boolean;
+        score: number;
+        reasons: string[];
+        checks: Record<string, unknown>;
+        processing_ms?: number;
+    };
+}
+export type LivenessStatus = 'passed' | 'failed' | 'inconclusive' | 'submitted' | 'cancelled' | 'error';
+export interface LivenessResult {
+    status: LivenessStatus;
+    livenessSessionId: string | null;
+    attempt?: number;
+    device: DeviceOutcome | null;
+    server?: ServerOutcome;
+    retryAllowed?: boolean;
+    /** A front-facing photo from the check (eyes open), for your own face-match calls. */
+    selfie?: Blob;
+    /** Machine-readable reason for failed / error / cancelled. */
+    reason?: string;
+}
+export type LivenessEvent = {
+    type: 'camera_ready';
+} | {
+    type: 'mode';
+    mode: DeviceMode;
+    fallbackReason: string | null;
+} | {
+    type: 'recording_started';
+} | {
+    type: 'challenge_started';
+    challenge: IssuedChallenge;
+} | {
+    type: 'challenge_passed';
+    challenge: IssuedChallenge;
+} | {
+    type: 'attempt_aborted';
+    reason: string;
+} | {
+    type: 'flash_started';
+} | {
+    type: 'flash_ended';
+} | {
+    type: 'uploading';
+    bytes: number;
+} | {
+    type: 'server_result';
+    result: ServerOutcome;
+} | {
+    type: 'error';
+    code: string;
+    message: string;
+};

package/dist/ui/strings.d.ts

@@ -0,0 +1,42 @@
+/** Every user-visible text. Override any of them with `config.strings`. */
+export interface Strings {
+    gettingReady: string;
+    center: string;
+    moveCloser: string;
+    moveBack: string;
+    lookStraight: string;
+    noFace: string;
+    multipleFaces: string;
+    turnLeft: string;
+    turnRight: string;
+    lookUp: string;
+    lookDown: string;
+    smile: string;
+    blink: string;
+    openMouth: string;
+    holdStill: string;
+    great: string;
+    wrongDirection: string;
+    faceLost: string;
+    interrupted: string;
+    timeUp: string;
+    tooSlow: string;
+    flashIntro: string;
+    checking: string;
+    passedTitle: string;
+    passedDetail: string;
+    submittedTitle: string;
+    failedTitle: string;
+    failedDetail: string;
+    noAttemptsDetail: string;
+    tryAgain: string;
+    cameraDenied: string;
+    cameraUnavailable: string;
+    unsupportedBrowser: string;
+    insecureContext: string;
+    network: string;
+    sessionExpired: string;
+    serviceUnavailable: string;
+    genericError: string;
+}
+export declare const EN: Strings;

package/package.json

@@ -1,6 +1,18 @@
 {
   "name": "@powercred/liveness-web",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "PowerCred Liveness for the web: guided liveness challenges, recorded and verified by the PowerCred backend.",
+  "type": "module",
+  "module": "./dist/liveness.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/liveness.js"
+    }
+  },
+  "files": [
+    "dist",
+    "THIRD_PARTY_NOTICES.txt"
+  ]
+}