@regulaforensics/idv-capture-web 0.1.87-nightly → 0.1.89-nightly

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { IdvMessageEvent as IdvMessageEvent_2 } from '../../dist';
+
 declare class BaseDeinitializationError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
@@ -74,13 +76,41 @@ declare class BaseScenarioError extends BaseError {
     });
 }
 
+declare class BaseTokenInitializationError extends BaseError {
+    private static readonly MODULE;
+    private static readonly ERROR_ENUM_NAME;
+    private static readonly SHORT_CODE;
+    constructor({ errorCode, message, underlyingError, underlyingBaseError, }: {
+        errorCode: TokenInitializeError;
+        message?: string;
+        underlyingError?: string;
+        underlyingBaseError?: BaseError;
+    });
+}
+
+declare type ConfigureCompletion = {
+    error?: BaseInitializationError;
+};
+
+declare type ConnectionConfig = {
+    host: string;
+    httpRetryCount?: number;
+    httpTimeoutMs?: number;
+    isSecure?: boolean;
+    password: string;
+    port?: number;
+    schema?: string;
+    userName: string;
+};
+
 export declare enum ConnectionError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1
 }
 
 export declare enum DeinitializationError {
-    SERVICE_NOT_CONNECTED = 0
+    INITIALIZATION_REQUIRED = 0,
+    SCENARIO_IN_PROGRESS = 3
 }
 
 export declare type DeinitializeCompletion = {
@@ -98,18 +128,22 @@ declare enum IdvEventTypes {
 }
 
 export declare class IdvIntegrationService {
-    initialize(config: IIdvConfig): Promise<{
+    /** main commands */
+    initialize(config: InitConfig): Promise<{
         error?: BaseInitializationError;
     }>;
-    setNonce(id: string): void;
-    setSessionRestoreMode(isEnabled: boolean): void;
-    get currentSessionId(): string | null;
+    configure(config: ConnectionConfig | UrlConnectionConfig): Promise<ConfigureCompletion | UrlConfigureCompelition>;
     getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>;
     prepareWorkflow({ workfowId }: {
         workfowId: string;
     }): Promise<PrepareWorkflowCompletion>;
     startWorkflow(): Promise<WorkflowCompetion>;
     deinitialize(): Promise<DeinitializeCompletion>;
+    /** service commands */
+    setNonce(id: string): void;
+    set eventListener(callback: (message: IdvMessageEvent_2) => void);
+    set sessionRestoreMode(isEnabled: boolean);
+    get currentSessionId(): string | null;
 }
 
 export declare type IdvMessageEvent = {
@@ -121,6 +155,11 @@ export declare type IdvMessageEvent = {
     details?: any;
 };
 
+export declare enum IdvModules {
+    LIVENESS = "LIVENESS",
+    DOC_READER = "DOC_READER"
+}
+
 export declare enum IdvServiceErrors {
     CONNECT_TO_IDV_ERROR = "CONNECT_TO_IDV_ERROR",
     PLAY_WORKFLOW_ERROR = "PLAY_WORKFLOW_ERROR",
@@ -155,23 +194,14 @@ export declare class IdvWebComponent extends HTMLElement {
     disconnectedCallback(): void;
 }
 
-export declare type IIdvConfig = {
-    connectionConfig: IIdvOptions;
-    modulesConfig?: Record<string, any>;
+declare type InitConfig = {
+    modulesConfig?: {
+        docreader?: {
+            devLicense: string;
+        };
+        face?: Record<string, any>;
+    };
     includedModules: any[];
-    licenseConfig?: Record<string, any>;
-    listener?: (message: IdvMessageEvent) => void;
-};
-
-export declare type IIdvOptions = {
-    host: string;
-    httpRetryCount?: number;
-    httpTimeoutMs?: number;
-    isSecure?: boolean;
-    password: string;
-    port?: number;
-    schema?: string;
-    userName: string;
 };
 
 export declare type InitializeCompletion = {
@@ -227,6 +257,18 @@ export declare enum StartSessionError {
     DECODING_FAILED = 2
 }
 
+declare enum TokenInitializeError {
+    CONNECTION_ISSUE = 0,
+    WORKFLOW_ISSUE = 1
+}
+
+declare type UrlConfigureCompelition = {
+    workflows: string[];
+    error?: BaseTokenInitializationError;
+};
+
+declare type UrlConnectionConfig = string;
+
 declare type Workflow = {
     id: string;
     steps: Array<WorkflowStep>;