@regulaforensics/idv-capture-web 0.1.82-nightly → 0.1.84-nightly

package/dist/index.d.ts

@@ -1,63 +1,56 @@
-export declare enum ErrorTypes {
-    WASM_ERROR = "WASM_ERROR"
-}
-
-declare type GetWorkFlowsRequest = {
-    limit: number;
-    skip: number;
-};
-
-declare type GetWorkFlowsResult = {
-    count: number;
-    items: unknown[];
-};
-
-declare enum IDV_TEMPLATES {
-    FACE_LIVENESS = "LIVENESS",
-    INFO = "INFO",
-    INFO_DETAILS = "INFO_DETAILS",
-    DOC_READER = "DOC_READER",
-    STATUS = "STATUS",
-    PROGRESS = "PROGRESS"
-}
-
 export declare enum IdvEventTargets {
     WEB_COMPONENT = "WEB_COMPONENT",
     SERVICE = "SERVICE"
 }
 
+declare enum IdvEventTypes {
+    MESSAGE = "MESSAGE",
+    ERROR = "ERROR"
+}
+
 export declare class IdvIntegrationService {
-    constructor(options: IIdvOptions);
-    getWorkFlows(params?: GetWorkFlowsRequest): Promise<GetWorkFlowsResult>;
+    initialize(config: IIdvConfig): Promise<{
+        error?: string;
+    }>;
     setNonce(id: string): void;
-    prepareWorkflow(id: string): void;
-    playWorkflow(): void;
-    isIdvServiceRunning(): boolean | undefined;
-    shutdownService(): void;
+    getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>;
+    prepareWorkflow({ workfowId }: {
+        workfowId: string;
+    }): Promise<PrepareWorkflowCompletion>;
+    startWorkflow(): Promise<WorkflowCompetion>;
+    deinitialize(): Promise<void>;
 }
 
 export declare type IdvMessageEvent = {
-    target: 'SERVICE' | 'WEB_COMPONENT';
-    eventType: 'ERROR' | 'MESSAGE';
-    module?: IDV_TEMPLATES | 'IDV';
-    message: any;
+    target: IdvEventTargets;
+    eventType: IdvEventTypes;
+    module?: string | 'IDV';
+    message?: IdvServiceMessages;
+    error?: IdvServiceErrors;
     details?: any;
 };
 
+declare enum IdvServiceErrors {
+    CONNECT_TO_IDV_ERROR = "CONNECT_TO_IDV_ERROR",
+    PLAY_WORKFLOW_ERROR = "PLAY_WORKFLOW_ERROR",
+    SERVICE_NOT_RUNNING_ERROR = "SERVICE_NOT_RUNNING_ERROR",
+    WASM_ERROR = "WASM_ERROR",
+    GET_SESSION_STATE_ERROR = "GET_SESSION_STATE_ERROR",
+    PUSH_DATA_ERROR = "PUSH_DATA_ERROR",
+    SET_MODULES_ERROR = "SET_MODULES_ERROR"
+}
+
 export declare enum IdvServiceMessages {
+    INITIALIZED = "INITIALIZED",
     READY_TO_PLAY = "READY_TO_PLAY",
     CONNECT_TO_IDV = "CONNECT_TO_IDV",
     START_SESSION = "START_SESSION",
     SHUT_DOWN = "SHUT_DOWN",
-    WASM_ERROR = "WASM_ERROR",
-    PLAY_WORKFLOW_ERROR = "PLAY_WORKFLOW_ERROR",
-    SERVICE_NOT_RUNNING_ERROR = "SERVICE_NOT_RUNNING_ERROR",
     CURRENT_STEP = "CURRENT_STEP",
-    GET_SESSION_STATE_ERROR = "GET_SESSION_STATE_ERROR",
-    PUSH_DATA_ERROR = "PUSH_DATA_ERROR"
+    FINAL = "FINAL"
 }
 
-export declare class IdvWebComponent extends HTMLElement implements IdvWebComponent_2 {
+export declare class IdvWebComponent extends HTMLElement {
     private _root;
     private _mounted;
     private _nonce?;
@@ -70,18 +63,15 @@ export declare class IdvWebComponent extends HTMLElement implements IdvWebCompon
     disconnectedCallback(): void;
 }
 
-declare class IdvWebComponent_2 extends HTMLElement {
-}
-
-export declare enum IdvWebComponentMessages {
-    ELEMENT_VISIBLE = "IDV_VISIBLE",
-    DOC_READER = "DOC_READER",
-    LIVENESS = "LIVENESS",
-    CLOSE_BUTTON_CLICKED = "CLOSE_BUTTON_WAS_CLICKED"
-}
+declare type IIdvConfig = {
+    connectionConfig: IIdvOptions;
+    modulesConfig: Record<string, any>;
+    includedModules: any[];
+    licenseConfig?: Record<string, any>;
+    listener?: (message: IdvMessageEvent) => void;
+};
 
 declare type IIdvOptions = {
-    workflowId?: string;
     host: string;
     httpRetryCount?: number;
     httpTimeoutMs?: number;
@@ -90,7 +80,61 @@ declare type IIdvOptions = {
     port?: number;
     schema?: string;
     userName: string;
-    listener: (message: IdvMessageEvent) => void;
+};
+
+declare type PrepareWorkflowCompletion = {
+    workflow?: Workflow;
+    error?: PrepareWorkflowError;
+};
+
+declare enum PrepareWorkflowError {
+    CONNECTION_ISSUE = "CONNECTION_ISSUE",
+    WORKFLOW_ISSUE = "WORKFLOW_ISSUE",
+    INTERNAL_ISSUE = "INTERNAL_ISSUE"
+}
+
+declare enum ScenarioError {
+    SESSION_ISSUE = "SESSION_ISSUE",
+    ALREADY_STARTED = "ALREADY_STARTED",
+    NOT_PREPARED = "NOT_PREPARED",
+    STEP_ISSUE = "STEP_ISSUE",
+    INTERNAL_ISSUE = "INTERNAL_ISSUE"
+}
+
+declare type ScenarioResults = {
+    status: ScenarioStatus;
+    results?: Record<string, any>;
+};
+
+declare enum ScenarioStatus {
+    FINISHED = "FINISHED",
+    CANCELLED = "CANCELLED",
+    ERROR = "ERROR"
+}
+
+declare type Workflow = {
+    id: string;
+    currentStep: string;
+    steps: Array<any>;
+    client: {
+        layout: Record<string, any>;
+        steps: Array<any>;
+    };
+} & Record<string, any>;
+
+declare type WorkflowCompetion = {
+    results?: ScenarioResults;
+    error?: ScenarioError;
+};
+
+declare type WorkflowListCompletion = {
+    results?: Workflow[];
+    error?: PrepareWorkflowError;
+};
+
+declare type WorkflowListRequest = {
+    limit: number;
+    skip: number;
 };
 
 export { }