@regulaforensics/idv-capture-web 3.6.416-nightly → 3.6.418-nightly

package/dist/index.d.ts

@@ -165,7 +165,8 @@ declare type ConnectionConfigCore = {
 
 export declare enum ConnectionError {
     HTTP_ISSUE = 0,
-    PROVIDER_ERROR = 1
+    PROVIDER_ERROR = 1,
+    DECODING_FAILED = 2
 }
 
 declare type ContinueSessionResults = SessionData | WorkflowResult | {
@@ -276,13 +277,29 @@ declare type IdvBusinessLogicControllerProps = {
     _pushStep: (stepId: string, data: Record<string, any>, type?: PerformType) => Promise<{
         error?: BaseWorkflowError;
     }>;
-    _waitingForNextStep: () => Promise<{
+    waitForStartSession: (params: {
+        workflowId: string;
+        locale: string;
+        metadata?: Record<string, unknown>;
+        location?: GeoCoords | null;
+    }) => Promise<{
         sessionData: SessionModel;
         error?: undefined;
     } | {
+        sessionData?: undefined;
         error: BaseWorkflowError;
+    }>;
+    waitForContinueSession: (params: {
+        sessionId: string;
+        locale: string;
+    }) => Promise<{
+        sessionData: SessionModel;
+        error?: undefined;
+    } | {
         sessionData?: undefined;
+        error: BaseWorkflowError;
     }>;
+    _waitForNextStep: () => Promise<void>;
     _stepSocketListenerWhenStepIsRunning: (isStepRunning: boolean) => void;
     _getSessionStateNextStepConditionResult: () => Promise<DataOrError<SessionModel>>;
     _findStepById: (stepId: string) => WorkflowStep | null;
@@ -293,7 +310,7 @@ declare type IdvBusinessLogicControllerProps = {
         nextStepId: string;
         locale?: string;
     }) => Promise<void>;
-    prepareScreenConfigAndShowStep: (stepId: string | null) => Promise<void>;
+    _prepareScreenConfigAndShowStep: (stepId: string | null) => Promise<void>;
     deinitializationIdv: () => Promise<{
         error?: any;
     }>;
@@ -304,6 +321,10 @@ declare type IdvBusinessLogicControllerProps = {
     setFinalStepAndStopProcess: (stepId?: string) => void;
     resetSession: () => void;
     resetFetchService: () => void;
+    _decodeMessageFromWebSocket: (eventData: MessageEvent['data']) => WebSocketDecodedSessionMessage | null;
+    _validateSession: (session?: SessionData) => SessionModel | {
+        validationErrorMessage: string;
+    };
 };
 
 export declare type IdvEventTypes = (typeof IdvEventTypesEnum)[keyof typeof IdvEventTypesEnum];
@@ -316,14 +337,11 @@ export declare const IdvEventTypesEnum: {
 declare class IdvFetchService {
     private _connectionTokenExpirationBufferMs;
     private _origin;
-    private _workflowId;
-    private _session;
     private _apiKeyAuthToken;
     private _connectionToken;
     private _connect;
     private abortController;
     constructor();
-    private _getErrorTextFromError;
     private _setApiKeyAuthToken;
     private _setConnectionToken;
     private _getOriginFromConfig;
@@ -389,7 +407,10 @@ declare class IdvFetchService {
         code: FetchResultCode.SUCCESS;
         data: SessionData;
     } | FetchErrorResult>;
-    continueSession(sessionId: string, locale: string): Promise<{
+    continueSession({ sessionId, locale, }: {
+        sessionId: string;
+        locale: string;
+    }): Promise<{
         code: FetchResultCode.SUCCESS;
         data: SessionData;
     } | FetchErrorResult>;
@@ -403,19 +424,24 @@ declare class IdvFetchService {
             items: Workflow[];
         };
     } | FetchErrorResult>;
-    getWorkflow(workflowId: string, sessionIdFromUrl?: string | null): Promise<{
+    getWorkflow(workflowId: string, sessionIdFromUrl?: string | null, locale?: string): Promise<{
         code: FetchResultCode.SUCCESS;
         data: Workflow;
     } | FetchErrorResult>;
-    pushData(stepId: string, data: any, type?: PerformType): Promise<{
+    pushData({ sessionId, stepId, data, type, }: {
+        sessionId: string;
+        stepId: string;
+        data: any;
+        type?: PerformType;
+    }): Promise<{
         code: FetchResultCode.SUCCESS;
         data: Record<string, unknown>;
     } | FetchErrorResult>;
-    getSessionState(): Promise<{
+    getSessionState(sessionId: string, locale?: string): Promise<{
         code: FetchResultCode.SUCCESS;
         data: SessionData;
     } | FetchErrorResult>;
-    pushLogs(pushLogsParams: PushLogsParams): Promise<Record<string, unknown>>;
+    pushLogs(sessionId: string, pushLogsParams: PushLogsParams): Promise<Record<string, unknown>>;
     private _postStartUpload;
     private _postFileChunk;
     private _uploadFileInChunks;
@@ -434,8 +460,7 @@ declare type IdvIntegrationControllerProps = {
     _initializationInProgress: boolean;
     _sessionIdFromUrl: null | string;
     _ttl: number;
-    _continueSession: (locale: string, forceSessionId: string | null) => Promise<ContinueSessionResults>;
-    _checkAndSetApiTokenToLs: (sessionId: string) => void;
+    _continueSession: (locale: string) => Promise<ContinueSessionResults>;
     _runSocketConnection: (token: string) => Promise<{
         error?: BaseWorkflowError;
     }>;
@@ -533,10 +558,13 @@ declare type IdvStoreProps = {
     currentSessionData: {
         sessionId: string;
         workflowId: string;
+        locale?: string;
     } | null;
     setCurrentSessionDataLsAndStore: (data: {
+        isApiKeyConnection: boolean;
         sessionId: string;
         workflowId: string;
+        locale?: string;
     }) => void;
     removeCurrentSessionDataLsAndStore: () => void;
     getCurrentSessionDataLs: () => {
@@ -560,7 +588,7 @@ declare type IdvStoreProps = {
     currentScreenConfig: CurrentScreenConfig | null;
     externalModules: LoadedModule[] | [];
     serviceToken?: string;
-    apiKeyAuthTokenCollection: AuthTokenStoreData | Record<string, unknown>;
+    apiKeyAuthTokenCollection: Partial<AuthTokenStoreData>;
     setApiKeyAuthTokenCollection: (apiKey: string, authToken: string, tokenExpiresAt: number) => void;
     setServiceSessionToken: (token: string) => void;
     resetProps: () => void;
@@ -704,7 +732,7 @@ declare class SessionModel implements SessionData {
     deviceMetadata?: Record<string, unknown>;
     metadata?: Record<string, unknown>;
     static isSessionModel(value: unknown): value is SessionModel;
-    static fromPlain: (input: SessionData) => SessionModel | {
+    static fromPlain: (input?: SessionData) => SessionModel | {
         validationErrorMessage: string;
     };
 }
@@ -761,6 +789,17 @@ declare enum TokenInitializeError {
     WORKFLOW_ISSUE = 1
 }
 
+declare type WebSocketDecodedSessionMessage = {
+    eventType: string;
+    options?: {
+        session?: SessionData;
+    };
+    error?: {
+        code: number;
+        message: string;
+    };
+};
+
 declare type Workflow = {
     id: string;
     logging?: WorkflowLogging | null;