@regulaforensics/idv-capture-web 3.4.316 → 3.5.317-nightly

package/dist/index.d.ts

@@ -190,6 +190,11 @@ declare type CurrentScreenConfig = {
     failedAssets?: FailedAssets;
 } & Record<string, any>;
 
+declare type DataOrError<T extends object, E = BaseWorkflowError> = T | {
+    error?: E;
+    shouldRetry?: boolean;
+};
+
 export declare enum DeinitializationError {
     INITIALIZATION_REQUIRED = 0,
     SCENARIO_IN_PROGRESS = 3
@@ -229,12 +234,6 @@ declare type GeoCoords = {
     lon: number;
 };
 
-declare type GetSessionStateNextStepConditionResult = {
-    data?: SessionData;
-    error?: BaseWorkflowError;
-    shouldRetry?: boolean;
-};
-
 declare type IdvBusinessLogicControllerProps = {
     connectByUserPass: (config: ConnectionConfigCore) => Promise<{
         error?: BaseConnectionError;
@@ -253,21 +252,21 @@ declare type IdvBusinessLogicControllerProps = {
     loadModules: (modulesFromProps: any[]) => Promise<{
         error?: BaseInitializationError;
     }>;
-    getProcessingTemplate: () => WorkflowStepClientGui | null;
+    getProcessingTemplate: () => WorkflowStepClient | null;
     isProcessing: boolean;
     setIsProcessing: (isProcessing: boolean) => void;
     _pushStep: (stepId: string, data: Record<string, any>, type?: PerformType) => Promise<{
         error?: BaseWorkflowError;
     }>;
     _waitingForNextStep: () => Promise<{
-        sessionData: SessionData;
+        sessionData: SessionModel;
         error?: undefined;
     } | {
         error: BaseWorkflowError;
         sessionData?: undefined;
     }>;
     _stepSocketListenerWhenStepIsRunning: (isStepRunning: boolean) => void;
-    _getSessionStateNextStepConditionResult: () => Promise<GetSessionStateNextStepConditionResult>;
+    _getSessionStateNextStepConditionResult: () => Promise<DataOrError<SessionModel>>;
     _findStepById: (stepId: string) => WorkflowStep | null;
     pushStepWaitNextStepAndSet: (data: Record<string, any>, type?: PerformType) => void;
     setNextStep: (props: {
@@ -405,14 +404,6 @@ declare type IdvIntegrationControllerProps = {
     _sessionIdFromUrl: null | string;
     _ttl: number;
     _continueSession: (locale: string, forceSessionId: string | null) => Promise<ContinueSessionResults>;
-    _checkIsSessionDataValid: (sessionData: SessionData | {
-        httpCode: number;
-        method: string;
-        url: string;
-        what?: string;
-    }) => SessionData | {
-        error?: BaseWorkflowError;
-    };
     _checkAndSetApiTokenToLs: (sessionId: string) => void;
     _runSocketConnection: (token: string) => Promise<{
         error?: BaseWorkflowError;
@@ -543,7 +534,7 @@ export declare class IdvWebComponent extends LitElement {
     static styles: CSSResult[];
     store: IdvStoreProps & IdvIntegrationControllerProps & IdvBusinessLogicControllerProps;
     currentScreenConfig: CurrentScreenConfig | null;
-    processingScreenFromWorkflow: WorkflowStepClientGui | null;
+    processingScreenFromWorkflow: WorkflowStepClient | null;
     isProcessing: boolean;
     loadedModules: [] | LoadedModule[];
     modulesConfig: Record<string, any>;
@@ -609,6 +600,22 @@ export declare enum PrepareWorkflowError {
     SCENARIO_IN_PROGRESS = 4
 }
 
+declare class PropertyModel implements SessionPropertiesItem {
+    id: string;
+    name: string;
+    createdAt?: string;
+    updatedAt?: string;
+    string: string;
+    createdBy?: unknown;
+    updatedBy?: unknown;
+    step: string | null;
+    action?: unknown;
+    path?: unknown;
+    integer?: unknown;
+    decimal?: unknown;
+    object?: unknown;
+}
+
 declare type PushSessionLogsParams = {
     body: {
         log: string;
@@ -637,22 +644,40 @@ export declare enum SessionError {
     NOT_DATA_TYPE = 5
 }
 
+declare class SessionModel implements SessionData {
+    id: string;
+    currentStep: string;
+    workflow: WorkflowModel;
+    properties: PropertyModel[];
+    isErrorFiles: boolean;
+    isProcessingFiles: boolean;
+    locale: string;
+    shortId: string;
+    deviceId?: string;
+    deviceMetadata?: object;
+    metadata?: object;
+    static isSessionModel(value: unknown): value is SessionModel;
+    static fromPlain: (input: SessionData) => SessionModel | {
+        validationErrorMessage: string;
+    };
+}
+
 /** sync with gui module */
 declare type SessionPropertiesItem = {
     id: string;
-    createdAt: string;
-    updatedAt: string;
-    createdBy: unknown;
-    updatedBy: unknown;
-    action: unknown;
-    step: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: unknown;
+    updatedBy?: unknown;
+    action?: unknown;
+    step: string | null;
     name: string;
-    path: unknown;
+    path?: unknown;
     string: string;
     array?: string[];
-    integer: unknown;
-    decimal: unknown;
-    object: unknown;
+    integer?: unknown;
+    decimal?: unknown;
+    object?: unknown;
 };
 
 declare type StartConfig = {
@@ -692,13 +717,22 @@ declare enum TokenInitializeError {
 declare type Workflow = {
     id: string;
     steps: Array<WorkflowStep>;
-    client: {
-        layout: Record<string, any>;
-        steps: Array<WorkflowStepClientGui>;
-    };
+    client: WorkflowClient;
     trackLocation?: boolean;
+    error: string | null;
+    name: string;
 } & Record<string, any>;
 
+declare type WorkflowClient = {
+    layout: Record<string, any>;
+    steps: Array<WorkflowStepClient>;
+};
+
+declare class WorkflowClientModel implements WorkflowClient {
+    layout: Record<string, any>;
+    steps: Array<WorkflowStepClientModel>;
+}
+
 export declare type WorkflowCompletion = {
     results?: WorkflowResult;
     error?: BaseWorkflowError;
@@ -724,6 +758,23 @@ export declare type WorkflowListRequest = {
     skip: number;
 };
 
+declare class WorkflowModel implements Workflow {
+    id: string;
+    name: string;
+    steps: WorkflowStepModel[];
+    client: WorkflowClientModel;
+    error: string | null;
+    defaultLocale?: string;
+    config?: Record<any, any>;
+    metadata?: Record<any, any>;
+    sessionUpdateTimeout?: number;
+    trackLocation?: boolean;
+    static isWorkflowModel(value: unknown): value is WorkflowModel;
+    static fromPlain: (input: Workflow) => WorkflowModel | {
+        validationErrorMessage: string;
+    };
+}
+
 export declare enum WorkflowPlatformError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1,
@@ -745,13 +796,28 @@ declare type WorkflowStep = {
     name: string;
     final: boolean;
     releaseClientApp: boolean;
-    client?: Record<string, unknown> | WorkflowStepClientGui;
+    client?: Record<string, unknown> | WorkflowStepClient;
     dataSource: Record<string, unknown> | null;
 } & Record<string, any>;
 
-declare type WorkflowStepClientGui = {
+declare type WorkflowStepClient = {
     templateId: string;
-    templateLayout: Record<string, unknown>;
+    templateLayout?: Record<string, unknown>;
 };
 
+declare class WorkflowStepClientModel implements WorkflowStepClient {
+    templateId: string;
+    templateLayout?: Record<string, unknown>;
+}
+
+declare class WorkflowStepModel implements WorkflowStep {
+    id: string;
+    name: string;
+    type: string;
+    final: boolean;
+    releaseClientApp: boolean;
+    dataSource: Record<string, unknown> | null;
+    client?: WorkflowStepClientModel;
+}
+
 export { }