@incodetech/welcome 1.90.0 → 1.91.0-20260619153720.0

package/dist/onBoarding.d.ts

@@ -12,7 +12,7 @@ import { ReactNode } from 'react';
 import { RefAttributes } from 'react';
 import { SetStateAction } from 'react';
 
-declare function addAddressStatement({ token, file, image, docType, format, onProgress, }: AddAddressStatementParams): Promise<any>;
+declare function addAddressStatement({ token, file, image, docType, format, title, processingMethod, onProgress, }: AddAddressStatementParams): Promise<AddDocumentResponse>;
 
 declare type AddAddressStatementParams = {
     token: string;
@@ -20,6 +20,8 @@ declare type AddAddressStatementParams = {
     image?: string;
     docType?: string;
     format?: string;
+    title?: string;
+    processingMethod?: ProcessingMethod;
     onProgress?: (progress: number) => void;
 };
 
@@ -85,15 +87,33 @@ declare type AddCustomFieldsParams = {
     token: string;
 };
 
-export declare function addDocument({ token, type, image, onProgress, }: AddDocumentParams): Promise<any>;
+export declare function addDocument({ token, type, image, title, processingMethod, onProgress, }: AddDocumentParams): Promise<AddDocumentResponse | {
+    success: boolean;
+    sessionStatus: string;
+    additionalInformation: {
+        contractId: string;
+        url: string;
+    };
+}>;
 
 declare type AddDocumentParams = {
     token: LooseSession['token'];
     type: 'contract' | string;
     image: string;
+    /** Optional document title forwarded to /omni/add/document/v3?title= */
+    title?: string;
+    /** Optional processing method for v3 (sync|async). Sync is the default for v3-supported types. */
+    processingMethod?: ProcessingMethod;
     onProgress?: (progress: number) => void;
 };
 
+export declare type AddDocumentResponse = {
+    status?: AddDocumentStatus;
+    success?: boolean;
+};
+
+export declare type AddDocumentStatus = 'SUCCESS' | 'PROCESS_DOC_ERROR' | 'SESSION_ERROR' | 'ADD_NEXT_PAGE' | 'OPTIONAL_PAGE_CAPTURE' | 'CLASSIFICATION_ERROR' | 'MULTI_PAGE_CLASSIFICATION_ERROR' | 'V5C_REGISTRATION_NUMBER_MISMATCH' | 'V5C_REFERENCE_NUMBER_MISMATCH' | 'V5C_NUMBER_MISMATCH' | 'FSL_AGREEMENT_REFERENCE_MISMATCH' | 'FSL_NAME_MISMATCH' | 'MANDATORY_FIELD_MISSING' | 'UNSUPPORTED_PAGE_NUMBERS' | 'VALIDATION_ERROR' | 'UNEXPECTED_ERROR' | 'FINALIZE_ERROR_NO_PAGES' | 'UNSUPPORTED_MP_DOCUMENT_TYPE';
+
 export declare function addEvent(event: Event_2): Promise<void | WebClientResponse<any>>;
 
 declare function addFrontSecondId({ token, image, onProgress }: {
@@ -325,13 +345,26 @@ declare type CaptureConfig = {
     onlyBack: boolean;
     manualUploadIdCapture: boolean;
     digitalIdsUpload: boolean;
+    /** @deprecated [ENG-46418] superseded by `digitalIds`; kept for backward compat. */
     deviceWallet?: boolean;
+    /** @deprecated [ENG-46418] superseded by `digitalIds`; kept for backward compat. */
+    appleWallet?: boolean;
+    /** @deprecated [ENG-46418] superseded by `digitalIds`; kept for backward compat. */
+    googleWallet?: boolean;
+    /** [ENG-46418] Per-flow Apple/Google Wallet config (flat, enriched). */
+    digitalIds?: DigitalIdsConfig;
     idDetectionTimeout: number;
     isDeepsightEnabled?: boolean;
     usSmartCapture: boolean;
     alwaysCaptureBackOfId?: boolean;
     showCaptureButtonInAuto?: boolean;
     digiLocker?: boolean;
+    /** [ENG-44176] When `false`, the SDK forwards `extractIdFace=false` to
+     *  `POST /omni/add/front-id` (v1 + v2), so the backend skips biometric face
+     *  extraction. Default behavior (omitted / `true`) is unchanged. Use this in
+     *  jurisdictions with biometric-consent restrictions (e.g. Quebec, Law 25);
+     *  downstream face-match will not be available for the resulting session. */
+    extractIdFace?: boolean;
 };
 
 declare type CaptureConfig_2 = {
@@ -424,6 +457,9 @@ declare type CaptureIdResponse = UploadFrontIdResponse & {
     skipProcessId?: boolean;
 };
 
+/** Whether the attempt started in (or switched to) manual fallback. */
+declare type CaptureMode = 'auto' | 'manual';
+
 declare type CaptureOnlyResponse = {
     frontImage: CapturedImageData;
     backImage: CapturedImageData | undefined;
@@ -451,6 +487,10 @@ declare type CaptureParams = {
     metadata?: string;
     authHint?: string;
     mdlData?: any;
+    /** [ENG-44176] When `false`, instructs the backend `add/front-id` (v1 + v2)
+     *  to skip biometric face extraction. Omitted/`true` preserves current
+     *  behavior. Forwarded only as a query param, only for the `front` type. */
+    extractIdFace?: boolean;
 };
 
 export declare const CaptureSelfie: (props: any) => JSX_2.Element;
@@ -658,7 +698,7 @@ export declare function create({ apiKey, apiURL, lang, encrypt, translations, th
     }) => Promise<{
         redirectionUrl: string;
         action: "none" | "approved" | "rejected";
-        scoreStatus: "UNKNOWN" | "OK" | "FAIL" | "WARN" | "MANUAL_OK" | "MANUAL_FAIL";
+        scoreStatus: TotalScore;
     }>;
     renderLogin: typeof renderLogin;
     renderLoginIncodeID: typeof renderLoginIncodeID;
@@ -953,6 +993,7 @@ export declare function create({ apiKey, apiURL, lang, encrypt, translations, th
         token: string;
         screen?: string;
         code?: string;
+        includeAppLogs?: boolean;
     } & {
         shouldOpen: boolean;
         sardineScreen?: string;
@@ -1236,6 +1277,31 @@ declare type DigilockerCallbackProps = {
     }) => void;
 };
 
+declare type DigitalIdConfig = {
+    enabledMethods: EnabledDigitalIdMethod[];
+};
+
+/**
+ * [ENG-46418] Per-flow Digital IDs (Apple/Google Wallet) configuration as it
+ * appears inside the ID capture module configuration (flat shape, enriched by
+ * the backend with catalog metadata). Method ids use UPPER_SNAKE
+ * (`APPLE_WALLET`, `GOOGLE_WALLET`).
+ */
+declare type DigitalIdMethod = {
+    method: string;
+    enabled: boolean;
+    requestedFields?: string[];
+    displayName?: string;
+    type?: string;
+    countries?: string[];
+    logoUrl?: string;
+};
+
+declare type DigitalIdsConfig = {
+    enabled: boolean;
+    methods: DigitalIdMethod[];
+};
+
 export declare const DocumentCapture: FC<DocumentCaptureProps>;
 
 declare type DocumentCaptureError = {
@@ -1330,6 +1396,24 @@ declare type EmptyConfig = Record<string, never>;
 
 declare function emptyFunc(...props: unknown[]): void;
 
+/**
+ * [ENG-46418] Enriched, cross-platform Digital IDs config exposed at the top
+ * level of the flow response (`FlowDto.digitalIdConfig`). Method ids use
+ * lower_snake (`apple_wallet`, `google_wallet`). This supersedes the deprecated
+ * `appleWallet`/`googleWallet`/`deviceWallet` booleans.
+ */
+declare type EnabledDigitalIdMethod = {
+    id: string;
+    displayName?: string;
+    type?: string;
+    countries?: string[];
+    logoUrl?: string;
+    requestedDocuments?: {
+        type: string;
+        requestedFields: string[];
+    }[];
+};
+
 export declare const enableDeviceRiskModule: ({ token, isSandbox, interviewId, }: EnableDeviceRiskModuleParams) => Promise<SardineContext>;
 
 declare type EnableDeviceRiskModuleParams = {
@@ -1449,7 +1533,7 @@ declare type FaceMatchProps = {
 
 export declare type FaceSuccess = SendFaceImageResponse;
 
-declare const FEATURE_FLAGS: readonly ["id_text_barcode_readability", "selfie_local_lenses_check_web", "id_model_hebrew_back_id", "id_face_readability", "id_face_detector", "new_id_capture_ux_least_risky_clients", "enable_sentry_web", "id_test_aa", "id_iou_check", "iad_checks", "iad_c_checks", "new_fingerprint", "mp_test_hashed_id", "darwinium_profiling", "id_quality_backend_validation", "id_blur_threshold_03", "enable_fps_limit", "id_v2_reduced_aggregation_interval", "id_video_recording_enabled", "barcode_shadow_capture"];
+declare const FEATURE_FLAGS: readonly ["id_text_barcode_readability", "selfie_local_lenses_check_web", "id_model_hebrew_back_id", "id_face_readability", "id_face_detector", "new_id_capture_ux_least_risky_clients", "enable_sentry_web", "id_test_aa", "id_iou_check", "iad_checks", "iad_c_checks", "new_fingerprint", "mp_test_hashed_id", "darwinium_profiling", "id_quality_backend_validation", "id_v2_reduced_aggregation_interval", "id_video_recording_enabled", "barcode_shadow_capture", "enable_app_logs"];
 
 declare type FeatureConfig = {
     enabled: boolean;
@@ -1485,6 +1569,8 @@ declare function fetchProcessingStatus({ token }: {
 declare type FingerprintResult = {
     visitorId: string;
     ip: string;
+    algorithmName?: string;
+    algorithmVersion?: string;
 };
 
 export declare interface FinishedMessagePayload {
@@ -1522,6 +1608,8 @@ export declare type Flow = {
     ds?: boolean;
     oauth2Secured?: boolean;
     alwaysCaptureBackOfId?: boolean;
+    /** [ENG-46418] Top-level enriched Digital IDs config (supersedes wallet booleans). */
+    digitalIdConfig?: DigitalIdConfig;
 };
 
 declare type FlowConfig = {
@@ -1629,7 +1717,7 @@ declare type FlowModuleConfig = {
         directorsSource: 'userInput';
     };
     EXTERNAL_VERIFICATION: {
-        source: 'US_DRIVERS_LICENSE_1' | 'US_TELCO_1' | 'US_TELCO_2' | 'US_CONSUMER_1' | 'US_CREDIT_BUREAU_1' | 'MX_CONSUMER_1' | 'BR_GOVT_1' | 'CA_RES_CREDIT' | 'UK_CREDIT_BUREAU_1' | 'ES_PHONE_REGISTER_2' | 'CL_1' | 'AR_1' | 'GR_1' | 'GT_1' | 'BR_CPF_1' | 'NG_MONO_BVN' | 'NG_MONO_NIN';
+        source: 'US_DRIVERS_LICENSE_1' | 'US_TELCO_1' | 'US_TELCO_2' | 'US_CONSUMER_1' | 'US_CREDIT_BUREAU_1' | 'MX_CONSUMER_1' | 'BR_GOVT_1' | 'CA_RES_CREDIT' | 'UK_CREDIT_BUREAU_1' | 'ES_PHONE_REGISTER_2' | 'CL_1' | 'AR_1' | 'GR_1' | 'GT_1' | 'BR_CPF_1' | 'NG_MONO_BVN' | 'NG_MONO_NIN' | 'PH_RES_CREDIT';
         checkName: boolean;
         nameSource: 'userInput' | 'document' | 'poa' | 'phoneModuleInput' | 'emailModuleInput';
         checkEmail: boolean;
@@ -1967,7 +2055,7 @@ export declare const getFinishStatus: (flowId: string | undefined | null, { toke
 }) => Promise<{
     redirectionUrl: string;
     action: 'approved' | 'rejected' | 'none';
-    scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | 'UNKNOWN' | 'MANUAL_FAIL';
+    scoreStatus: TotalScore;
 }>;
 
 export declare function getFlow(token: string): Promise<Flow>;
@@ -2100,6 +2188,17 @@ declare type HEX = `#${string}`;
 
 export declare const i18n: i18n_2;
 
+/** Per-attempt context consumed by the `captureAttemptFinished` enrichment
+ *  helper (ENG-41821). */
+declare type IdAttemptSummary = {
+    initialCaptureMode: CaptureMode;
+    captureMode: CaptureMode;
+    autoCaptureTimeoutReached: boolean;
+    idDetectedTimeoutReached: boolean;
+    manualCaptureReason: ManualCaptureReason;
+    timeToManualFallbackMs: number | null;
+};
+
 export declare const IdCapture: FC<CaptureIdProps>;
 
 export declare const IdCaptureV2: FC<CaptureIdProps>;
@@ -2452,6 +2551,14 @@ declare type MainStatusRowProps = {
     small?: boolean;
 };
 
+/** Why we fell back to manual capture for the current attempt:
+ *  - `'needHelp'` — user pressed a help/manual button.
+ *  - `'idleTimeout'` — no ID detected within `idDetectedTimeout`.
+ *  - `'bestFrameTimeout'` — ID detected but no acceptable best frame within
+ *    `autocaptureTimeout`.
+ *  Null when capture stayed in auto mode. */
+declare type ManualCaptureReason = 'needHelp' | 'idleTimeout' | 'bestFrameTimeout' | null;
+
 declare function manualIdUpload(element: any, { token, onSuccess, type, onlyFront, isSecondId, }: {
     token: any;
     onSuccess: () => void;
@@ -2712,7 +2819,7 @@ declare type PhoneProps = {
     otpVerification?: boolean;
 };
 
-declare function postFingerprint({ hash, ip, deviceType, token, data, osVersion, deviceModel, browser, sdkVersion, hasLiedBrowser, hostingApp, ipLocation, }: PostFingerprintParams): Promise<{
+declare function postFingerprint({ hash, ip, deviceType, token, data, osVersion, deviceModel, browser, sdkVersion, hasLiedBrowser, hostingApp, algorithmName, algorithmVersion, ipLocation, }: PostFingerprintParams): Promise<{
     success: boolean;
     sessionStatus: string;
     showMandatoryConsent?: boolean;
@@ -2731,6 +2838,8 @@ declare type PostFingerprintParams = {
     sdkVersion: string;
     hasLiedBrowser: boolean;
     hostingApp: string;
+    algorithmName?: string;
+    algorithmVersion?: string;
     ipLocation?: {
         ipCountry: string;
         ipRegion: string;
@@ -2849,6 +2958,8 @@ export declare function processImss({ token, curp }: {
     curp?: string;
 }): Promise<WebClientResponse<any>>;
 
+declare type ProcessingMethod = 'sync' | 'async';
+
 declare type ProcessInstantVerifyProps = {
     token: string;
 };
@@ -2942,10 +3053,11 @@ export declare namespace recorderRepository {
 
 export declare function Redirect({ session, onSuccess, url, showSms, assets, smsText, skipDesktopRedirect, allowSkipRedirect, externalId, expired, allowReEnrollment, authHint, qrPhishingResistance, uiConfig, flowId, oauth2Secured, }: RedirectProps): JSX_2.Element;
 
-export declare function RedirectedCallFinished({ title, subtitle, displayOnboardingResultOnDesktop, token, }: {
+export declare function RedirectedCallFinished({ title, subtitle, displayOnboardingResultOnDesktop, showFinishScreenBySessionStatus, token, }: {
     title: any;
     subtitle: any;
     displayOnboardingResultOnDesktop: any;
+    showFinishScreenBySessionStatus: any;
     token: any;
 }): JSX_2.Element;
 
@@ -3011,7 +3123,7 @@ declare function renderBiometricConsent(element: any, { token, onSuccess, onCanc
 
 declare function renderBiometricConsent_2(element: any, { token, onSuccess, consentId }: CombinedConsentProps): void;
 
-export declare function renderCamera(type: string, element: Element, { onSuccess, onError, numberOfTries, onLog, permissionMessage, permissionBackgroundColor, token, timeout, sendBase64, documentType, showPreview, stream, nativeCamera, hideRetake, showTutorial, showPaperDLTutorial, onlyCapture, scanPdf417, videoTutorialSrc, showCustomCameraPermissionScreen, isSecondId, fullScreen, assistedOnboarding, isRecordingEnabled, onRestartOnboarding, showDoublePermissionsRequest, onlyAllowCapture, onlyUpload, onlyPdf, disableFullScreen, onStreamReady, showAutoCaptureIDOverlay, showManualCaptureIDOverlay, skipProcessFace, defaultHorizontalMask, isFixedMask, blurrinessStrictMode, isKiosk, ageAssurance, publishAudio, zoomLevel, idDetectedTimeout, flipVerticallyImage, disableZoomCheck, hatCheckEnabled, lensesCheckEnabled, maskCheckEnabled, eyesClosedCheckEnabled, isDeepsightEnabled, tutorialText, allowSkipDocumentCapture, }: RenderCameraProps): {
+export declare function renderCamera(type: string, element: Element, { onSuccess, onError, numberOfTries, onLog, permissionMessage, permissionBackgroundColor, token, timeout, sendBase64, documentType, showPreview, stream, nativeCamera, hideRetake, showTutorial, showPaperDLTutorial, onlyCapture, scanPdf417, videoTutorialSrc, showCustomCameraPermissionScreen, isSecondId, fullScreen, assistedOnboarding, isRecordingEnabled, onRestartOnboarding, showDoublePermissionsRequest, onlyAllowCapture, onlyUpload, onlyPdf, disableFullScreen, onStreamReady, showAutoCaptureIDOverlay, showManualCaptureIDOverlay, skipProcessFace, defaultHorizontalMask, isFixedMask, blurrinessStrictMode, isKiosk, ageAssurance, publishAudio, zoomLevel, idDetectedTimeout, flipVerticallyImage, disableZoomCheck, hatCheckEnabled, lensesCheckEnabled, maskCheckEnabled, eyesClosedCheckEnabled, isDeepsightEnabled, tutorialText, allowSkipDocumentCapture, extractIdFace, }: RenderCameraProps): {
     close: typeof emptyFunc;
 };
 
@@ -3071,6 +3183,11 @@ declare type RenderCameraProps = {
     eyesClosedCheckEnabled?: boolean;
     isDeepsightEnabled?: boolean;
     allowSkipDocumentCapture?: boolean;
+    /** [ENG-44176] When `false`, the SDK forwards `extractIdFace=false` to
+     *  `POST /omni/add/front-id` (v1 + v2), so the backend skips biometric face
+     *  extraction. Omitted / `true` preserves current behavior. Only applied to
+     *  the front-id upload — back-id is unaffected. */
+    extractIdFace?: boolean;
     tutorialText?: {
         [key: `step${number}`]: {
             title: string;
@@ -4547,6 +4664,17 @@ declare const tokens: {
     };
 };
 
+declare enum TotalScore {
+    OK = "OK",
+    WARN = "WARN",
+    FAIL = "FAIL",
+    UNKNOWN = "UNKNOWN",
+    MANUAL = "MANUAL",
+    MANUAL_OK = "MANUAL_OK",
+    MANUAL_FAIL = "MANUAL_FAIL",
+    MANUAL_PENDING = "MANUAL_PENDING"
+}
+
 declare type Translations = {
     [key: string]: string | Translations;
 };
@@ -4565,12 +4693,23 @@ declare type TutorialIdConfig = {
     captureAttempts: number;
     manualUploadIdCapture: boolean;
     digitalIdsUpload: boolean;
+    /** @deprecated [ENG-46418] superseded by `digitalIds`; kept for backward compat. */
     deviceWallet: boolean;
+    /** @deprecated [ENG-46418] superseded by `digitalIds`; kept for backward compat. */
+    appleWallet?: boolean;
+    /** @deprecated [ENG-46418] superseded by `digitalIds`; kept for backward compat. */
+    googleWallet?: boolean;
+    /** [ENG-46418] Per-flow Apple/Google Wallet config (flat, enriched). */
+    digitalIds?: DigitalIdsConfig;
     showDocumentChooserScreen: boolean;
     enableIdRecording: boolean;
     usSmartCapture: boolean;
     digiLocker?: boolean;
     alwaysCaptureBackOfId?: boolean;
+    /** [ENG-44176] Backend-driven counterpart to `CaptureConfig.extractIdFace`.
+     *  When `false`, the SDK forwards `extractIdFace=false` to `add/front-id`
+     *  so the backend skips biometric face extraction (e.g. Quebec / Law 25). */
+    extractIdFace?: boolean;
     perCountryPerDocOverrides: Record<string, Record<string, {
         onlyFront: boolean;
         onlyBack: boolean;
@@ -4668,7 +4807,7 @@ declare type UseFlowRedirectOptions = {
     forceSkipRedirect?: boolean;
 };
 
-export declare function useIdDetection({ getCanvas, onCapture, mode }: UseIdDetectionProps): {
+export declare function useIdDetection({ getCanvas, onCapture, onBestFrame, mode, }: UseIdDetectionProps): {
     startDetection: () => void;
     stopDetection: () => void;
     detectionState: string;
@@ -4687,11 +4826,16 @@ export declare function useIdDetection({ getCanvas, onCapture, mode }: UseIdDete
     counterValue: number;
     switchToManualCapture: () => void;
     onManualCapture: () => void;
+    /** Snapshot of the manager's per-attempt summary fields. Consumed by
+     *  the V2 `captureAttemptFinished` enrichment (ENG-41821). Returns null
+     *  if the manager hasn't initialized yet (transient pre-mount window). */
+    getAttemptSummary: () => IdAttemptSummary | null;
 };
 
 declare type UseIdDetectionProps = {
     getCanvas: GetCanvas_2;
     onCapture: OnCapture;
+    onBestFrame?: () => void;
     mode: Mode;
 };
 
@@ -4703,9 +4847,10 @@ declare type UseModuleEvent = {
     token: string;
     screen?: string;
     code?: string;
+    includeAppLogs?: boolean;
 };
 
-export declare function useModuleEvents({ module, payload, token, screen, }: UseModuleEvent): void;
+export declare function useModuleEvents({ module, payload, token, screen, includeAppLogs, }: UseModuleEvent): void;
 
 export declare const UserData: ({ goNext, isSecondId, token }: UserDataProps) => JSX_2.Element;
 
@@ -4814,6 +4959,13 @@ declare type WebcamProps = {
     poster?: string;
     isV2?: boolean;
     captureOnly?: boolean;
+    /** [ENG-47514] Suppress the full-screen camera "loading" overlay (the black
+     *  spinner Modal). The capture result/preview screen (`CapturePreview`) sets
+     *  this while it is open so a stuck `isLoadingCamera` (observed on iOS after a
+     *  retake `resetWebcam`, where camera frames don't resume) can't render the
+     *  Loader (overlay z-index 9999) on top of the preview (z-index 1000) and
+     *  hide the Try Again / Continue button. */
+    suppressLoadingOverlay?: boolean;
 };
 
 declare type WebcamRef = {
@@ -4858,6 +5010,7 @@ declare type WorkflowConfig_2 = {
     disableUnsupportedBrowserScreen?: boolean;
     oauth2Secured?: boolean;
     enableUxV2?: boolean;
+    showFinishScreenBySessionStatus?: boolean;
 };
 
 declare interface WorkflowPropsWithoutToken extends BaseWorkflowProps {