truescene-face-id-capture-sdk 1.0.0 → 1.0.1

package/dist/sdk/react/index.js

@@ -1,5 +1,5 @@
 import { createElement, useEffect, useRef } from 'react';
-const TrueSceneCapture = ({ sessionToken, compareUrl, tokenHeader, tokenPrefix, tokenField, autoStart, initialShowDebug, showDebugToggle, className, style, onReadyChange, onStepChange, onMetricsChange, onCapture, onCompareResult, onCompareError, onError, }) => {
+const TrueSceneCapture = ({ sessionToken, region, compareTimeoutMs, autoStart, className, style, showHeader, showInstructions, showStatus, headerEyebrow, headerTitle, headerSubtitle, instructions, onReadyChange, onStepChange, onMetricsChange, onCapture, onVerificationCode, onVerificationError, onError, }) => {
     const elementRef = useRef(null);
     useEffect(() => {
         if (typeof window === 'undefined') {
@@ -21,44 +21,74 @@ const TrueSceneCapture = ({ sessionToken, compareUrl, tokenHeader, tokenPrefix,
         const element = elementRef.current;
         if (!element)
             return;
-        element.compareUrl = compareUrl ?? '';
-    }, [compareUrl]);
+        element.region = region ?? undefined;
+    }, [region]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
             return;
-        element.tokenHeader = tokenHeader ?? '';
-    }, [tokenHeader]);
+        element.compareTimeoutMs = compareTimeoutMs;
+    }, [compareTimeoutMs]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
             return;
-        element.tokenPrefix = tokenPrefix ?? '';
-    }, [tokenPrefix]);
+        element.autoStart = Boolean(autoStart);
+    }, [autoStart]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
             return;
-        element.tokenField = tokenField ?? '';
-    }, [tokenField]);
+        if (showHeader === undefined) {
+            element.removeAttribute('show-header');
+            return;
+        }
+        element.showHeader = Boolean(showHeader);
+    }, [showHeader]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
             return;
-        element.autoStart = Boolean(autoStart);
-    }, [autoStart]);
+        if (showInstructions === undefined) {
+            element.removeAttribute('show-instructions');
+            return;
+        }
+        element.showInstructions = Boolean(showInstructions);
+    }, [showInstructions]);
+    useEffect(() => {
+        const element = elementRef.current;
+        if (!element)
+            return;
+        if (showStatus === undefined) {
+            element.removeAttribute('show-status');
+            return;
+        }
+        element.showStatus = Boolean(showStatus);
+    }, [showStatus]);
+    useEffect(() => {
+        const element = elementRef.current;
+        if (!element)
+            return;
+        element.headerEyebrow = headerEyebrow ?? undefined;
+    }, [headerEyebrow]);
+    useEffect(() => {
+        const element = elementRef.current;
+        if (!element)
+            return;
+        element.headerTitle = headerTitle ?? undefined;
+    }, [headerTitle]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
             return;
-        element.initialShowDebug = Boolean(initialShowDebug);
-    }, [initialShowDebug]);
+        element.headerSubtitle = headerSubtitle ?? undefined;
+    }, [headerSubtitle]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
             return;
-        element.showDebugToggle = Boolean(showDebugToggle);
-    }, [showDebugToggle]);
+        element.instructions = instructions ?? undefined;
+    }, [instructions]);
     useEffect(() => {
         const element = elementRef.current;
         if (!element)
@@ -79,13 +109,13 @@ const TrueSceneCapture = ({ sessionToken, compareUrl, tokenHeader, tokenPrefix,
             const detail = event.detail;
             onCapture?.(detail);
         };
-        const compareResultHandler = (event) => {
+        const verificationCodeHandler = (event) => {
             const detail = event.detail;
-            onCompareResult?.(detail);
+            onVerificationCode?.(detail);
         };
-        const compareErrorHandler = (event) => {
+        const verificationErrorHandler = (event) => {
             const detail = event.detail;
-            onCompareError?.(detail);
+            onVerificationError?.(detail);
         };
         const errorHandler = (event) => {
             const detail = event.detail;
@@ -95,16 +125,16 @@ const TrueSceneCapture = ({ sessionToken, compareUrl, tokenHeader, tokenPrefix,
         element.addEventListener('step-change', stepHandler);
         element.addEventListener('metrics-change', metricsHandler);
         element.addEventListener('capture', captureHandler);
-        element.addEventListener('compare-result', compareResultHandler);
-        element.addEventListener('compare-error', compareErrorHandler);
+        element.addEventListener('verification-code', verificationCodeHandler);
+        element.addEventListener('verification-error', verificationErrorHandler);
         element.addEventListener('error', errorHandler);
         return () => {
             element.removeEventListener('ready-change', readyHandler);
             element.removeEventListener('step-change', stepHandler);
             element.removeEventListener('metrics-change', metricsHandler);
             element.removeEventListener('capture', captureHandler);
-            element.removeEventListener('compare-result', compareResultHandler);
-            element.removeEventListener('compare-error', compareErrorHandler);
+            element.removeEventListener('verification-code', verificationCodeHandler);
+            element.removeEventListener('verification-error', verificationErrorHandler);
             element.removeEventListener('error', errorHandler);
         };
     }, [
@@ -112,8 +142,8 @@ const TrueSceneCapture = ({ sessionToken, compareUrl, tokenHeader, tokenPrefix,
         onStepChange,
         onMetricsChange,
         onCapture,
-        onCompareResult,
-        onCompareError,
+        onVerificationCode,
+        onVerificationError,
         onError,
     ]);
     return createElement('truescene-capture', {

package/dist/types/internal/regions.d.ts

@@ -0,0 +1,2 @@
+export type Region = 'eu' | 'us' | 'sandbox';
+export declare const REGION_URLS: Record<Region, string>;

package/dist/types/sdk/CaptureExperience.d.ts

@@ -1,26 +1,30 @@
 import { type CaptureStep, type FaceAndIdCaptureMetrics } from '../components/FaceAndIdCapture';
-import type { CaptureImages, CompareResult } from './types';
+import { type Region } from '../internal/regions';
+import type { CaptureImages, VerificationCodeResponse, VerificationError } from './types';
 type ReadyState = {
     faceReady: boolean;
     idReady: boolean;
 };
 export type CaptureExperienceProps = {
     sessionToken: string;
-    compareUrl?: string;
-    tokenHeader?: string;
-    tokenPrefix?: string;
-    tokenField?: string | null;
+    region?: Region;
     autoStart?: boolean;
-    initialShowDebug?: boolean;
-    showDebugToggle?: boolean;
+    compareTimeoutMs?: number;
     className?: string;
+    showHeader?: boolean;
+    showInstructions?: boolean;
+    showStatus?: boolean;
+    headerEyebrow?: string;
+    headerTitle?: string;
+    headerSubtitle?: string;
+    instructions?: string;
     onReadyChange?: (ready: ReadyState) => void;
     onStepChange?: (step: CaptureStep) => void;
     onMetricsChange?: (metrics: FaceAndIdCaptureMetrics) => void;
     onCapture?: (images: CaptureImages) => void;
-    onCompareResult?: (result: CompareResult | null) => void;
-    onCompareError?: (message: string | null) => void;
+    onVerificationCode?: (result: VerificationCodeResponse | null) => void;
+    onVerificationError?: (error: VerificationError | null) => void;
     onError?: (message: string) => void;
 };
-declare const CaptureExperience: ({ sessionToken, compareUrl, tokenHeader, tokenPrefix, tokenField, autoStart, initialShowDebug, showDebugToggle, className, onReadyChange, onStepChange, onMetricsChange, onCapture, onCompareResult, onCompareError, onError, }: CaptureExperienceProps) => import("react/jsx-runtime").JSX.Element;
+declare const CaptureExperience: ({ sessionToken, region, autoStart, compareTimeoutMs, className, showHeader, showInstructions, showStatus, headerEyebrow, headerTitle, headerSubtitle, instructions, onReadyChange, onStepChange, onMetricsChange, onCapture, onVerificationCode, onVerificationError, onError, }: CaptureExperienceProps) => import("react/jsx-runtime").JSX.Element;
 export default CaptureExperience;

package/dist/types/sdk/element.d.ts

@@ -1,3 +1,5 @@
+import { REGION_URLS } from '../internal/regions';
+type Region = keyof typeof REGION_URLS;
 export declare class TrueSceneCaptureElement extends HTMLElement {
     static observedAttributes: string[];
     private root;
@@ -8,20 +10,27 @@ export declare class TrueSceneCaptureElement extends HTMLElement {
     attributeChangedCallback(): void;
     set sessionToken(value: string);
     get sessionToken(): string;
-    set compareUrl(value: string | undefined);
-    get compareUrl(): string | undefined;
-    set tokenHeader(value: string | undefined);
-    get tokenHeader(): string | undefined;
-    set tokenPrefix(value: string | undefined);
-    get tokenPrefix(): string | undefined;
-    set tokenField(value: string | null | undefined);
-    get tokenField(): string | null | undefined;
+    set region(value: Region | undefined);
+    get region(): Region | undefined;
+    set compareTimeoutMs(value: number | undefined);
+    get compareTimeoutMs(): number | undefined;
     set autoStart(value: boolean);
     get autoStart(): boolean;
-    set initialShowDebug(value: boolean);
-    get initialShowDebug(): boolean;
-    set showDebugToggle(value: boolean);
-    get showDebugToggle(): boolean;
+    set showHeader(value: boolean);
+    get showHeader(): boolean;
+    set showInstructions(value: boolean);
+    get showInstructions(): boolean;
+    set showStatus(value: boolean);
+    get showStatus(): boolean;
+    set headerEyebrow(value: string | undefined | null);
+    get headerEyebrow(): string | undefined;
+    set headerTitle(value: string | undefined | null);
+    get headerTitle(): string | undefined;
+    set headerSubtitle(value: string | undefined | null);
+    get headerSubtitle(): string | undefined;
+    set instructions(value: string | undefined | null);
+    get instructions(): string | undefined;
     private renderReact;
 }
 export declare const defineTrueSceneCapture: (tagName?: string) => void;
+export {};

package/dist/types/sdk/index.d.ts

@@ -1,4 +1,4 @@
 export { defineTrueSceneCapture, TrueSceneCaptureElement } from './element';
 export type { CaptureExperienceProps } from './CaptureExperience';
-export type { CaptureImages, CompareResult } from './types';
+export type { CaptureImages, ExtractedIdentity, FaceMatchResult, VerificationCodeResponse, VerificationError, VerificationErrorCode, VerificationDocument, VerificationStatusResponse, } from './types';
 export type { CaptureStep, FaceAndIdCaptureMetrics, } from '../components/FaceAndIdCapture';

package/dist/types/sdk/react/index.d.ts

@@ -1,5 +1,5 @@
 import type { CSSProperties } from 'react';
-import type { CaptureImages, CompareResult } from '../types';
+import type { CaptureImages, VerificationCodeResponse, VerificationError } from '../types';
 import type { CaptureStep, FaceAndIdCaptureMetrics } from '../../components/FaceAndIdCapture';
 type ReadyState = {
     faceReady: boolean;
@@ -7,34 +7,40 @@ type ReadyState = {
 };
 type TrueSceneCaptureElement = HTMLElement & {
     sessionToken: string;
-    compareUrl?: string;
-    tokenHeader?: string;
-    tokenPrefix?: string;
-    tokenField?: string | null;
+    region?: 'eu' | 'us' | 'sandbox';
+    compareTimeoutMs?: number;
     autoStart: boolean;
-    initialShowDebug: boolean;
-    showDebugToggle: boolean;
+    showHeader: boolean;
+    showInstructions: boolean;
+    showStatus: boolean;
+    headerEyebrow?: string;
+    headerTitle?: string;
+    headerSubtitle?: string;
+    instructions?: string;
 };
 export type TrueSceneCaptureProps = {
     sessionToken: string;
-    compareUrl?: string;
-    tokenHeader?: string;
-    tokenPrefix?: string;
-    tokenField?: string | null;
+    region: 'eu' | 'us' | 'sandbox';
+    compareTimeoutMs?: number;
     autoStart?: boolean;
-    initialShowDebug?: boolean;
-    showDebugToggle?: boolean;
     className?: string;
     style?: CSSProperties;
+    showHeader?: boolean;
+    showInstructions?: boolean;
+    showStatus?: boolean;
+    headerEyebrow?: string;
+    headerTitle?: string;
+    headerSubtitle?: string;
+    instructions?: string;
     onReadyChange?: (ready: ReadyState) => void;
     onStepChange?: (step: CaptureStep) => void;
     onMetricsChange?: (metrics: FaceAndIdCaptureMetrics) => void;
     onCapture?: (images: CaptureImages) => void;
-    onCompareResult?: (result: CompareResult | null) => void;
-    onCompareError?: (message: string | null) => void;
+    onVerificationCode?: (result: VerificationCodeResponse | null) => void;
+    onVerificationError?: (message: VerificationError | null) => void;
     onError?: (message: string) => void;
 };
-declare const TrueSceneCapture: ({ sessionToken, compareUrl, tokenHeader, tokenPrefix, tokenField, autoStart, initialShowDebug, showDebugToggle, className, style, onReadyChange, onStepChange, onMetricsChange, onCapture, onCompareResult, onCompareError, onError, }: TrueSceneCaptureProps) => import("react").ReactElement<{
+declare const TrueSceneCapture: ({ sessionToken, region, compareTimeoutMs, autoStart, className, style, showHeader, showInstructions, showStatus, headerEyebrow, headerTitle, headerSubtitle, instructions, onReadyChange, onStepChange, onMetricsChange, onCapture, onVerificationCode, onVerificationError, onError, }: TrueSceneCaptureProps) => import("react").ReactElement<{
     ref: import("react").RefObject<TrueSceneCaptureElement | null>;
     className: string | undefined;
     style: CSSProperties | undefined;

package/dist/types/sdk/types.d.ts

@@ -3,11 +3,50 @@ export type CaptureImages = {
     idImage: string | null;
     fullImage: string | null;
 };
-export type CompareResult = {
+export type VerificationCodeResponse = {
+    verification_code: string;
+    expires_at: string;
+};
+export type VerificationErrorCode = 'MISSING_TOKEN' | 'MISSING_REGION' | 'HTTP_ERROR' | 'NETWORK_ERROR' | 'INVALID_RESPONSE' | 'REQUEST_TIMEOUT';
+export type VerificationError = {
+    code: VerificationErrorCode;
+    message: string;
+    status?: number;
+};
+export type VerificationDocument = {
+    type: string;
+    number: string;
+    issuingCountry: string;
+    issuingAuthority: string;
+    issue_date: string;
+    expiry_date: string;
+    is_expired: boolean;
+};
+export type ExtractedIdentity = {
+    first_name: string;
+    last_name: string;
+    full_name: string;
+    dob: string;
+    place_of_birth: string;
+    gender: string;
+    nationality: string;
+};
+export type FaceMatchResult = {
     match: boolean;
-    match_percentage: number;
+    confidence: number;
     cosine_distance: number;
     cosine_similarity: number;
-    timestamp: number;
-    error?: string;
+};
+export type VerificationStatusResponse = {
+    verification_id: string;
+    status: string;
+    decision?: string;
+    reason_codes?: string[];
+    document?: VerificationDocument;
+    extracted_identity?: ExtractedIdentity;
+    face_match?: FaceMatchResult;
+    liveness?: {
+        passed: boolean;
+    };
+    completed_at?: string;
 };

package/dist/utils/config.js

@@ -37,7 +37,7 @@ export const DEFAULT_CAPTURE_CONFIG = {
             expandBelowRatio: 3,
             minFaceHeightRatio: 0.18,
             minFaceAreaRatio: 0.03,
-            meanLum: { min: 70, max: 190 },
+            meanLum: { min: 10, max: 190 },
             blurScoreMin: 90,
         },
     },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "truescene-face-id-capture-sdk",
   "private": false,
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "scripts": {
     "dev": "vite",