@regulaforensics/idv-capture-web 2.5.192-nightly → 2.5.194-rc

package/dist/index.d.ts

@@ -86,23 +86,11 @@ declare class BaseTokenInitializationError extends BaseError {
     });
 }
 
-export declare type ConfigureCompletion = {
+declare type ConfigureCompletion = {
     error?: BaseInitializationError;
 };
 
-export declare type ConnectionByApiKeyConfig = {
-    host: string;
-    apiKey: string;
-    isSecure?: boolean;
-    port?: number;
-    deviceDescriptor: {
-        ttl: number;
-    } & Record<string, unknown>;
-    httpRetryCount?: number;
-    httpTimeoutMs?: number;
-};
-
-export declare type ConnectionConfig = {
+declare type ConnectionConfig = {
     host: string;
     httpRetryCount?: number;
     httpTimeoutMs?: number;
@@ -111,9 +99,6 @@ export declare type ConnectionConfig = {
     port?: number;
     schema?: string;
     userName: string;
-    deviceDescriptor?: {
-        ttl?: number;
-    } & Record<string, unknown>;
 };
 
 export declare enum ConnectionError {
@@ -142,7 +127,7 @@ export declare class IdvIntegrationService {
     initialize(config: InitConfig): Promise<{
         error?: BaseInitializationError;
     }>;
-    configure(config: ConnectionConfig | UrlConnectionConfig | ConnectionByApiKeyConfig): Promise<ConfigureCompletion | UrlConfigureCompletion>;
+    configure(config: ConnectionConfig | UrlConnectionConfig): Promise<ConfigureCompletion | UrlConfigureCompletion>;
     getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>;
     prepareWorkflow({ workflowId }: {
         workflowId: string;
@@ -172,8 +157,7 @@ export declare type IdvModulesType = (typeof IdvModules)[keyof typeof IdvModules
 export declare enum IdvServiceMessages {
     DID_START_SESSION = "DID_START_SESSION",
     DID_END_SESSION = "DID_END_SESSION",
-    DID_START_RESTORE_SESSION = "DID_START_RESTORE_SESSION",
-    DID_CONTINUE_REMOTE_SESSION = "DID_CONTINUE_REMOTE_SESSION"
+    DID_START_RESTORE_SESSION = "DID_START_RESTORE_SESSION"
 }
 
 export declare class IdvWebComponent extends HTMLElement {
@@ -187,14 +171,14 @@ export declare class IdvWebComponent extends HTMLElement {
     disconnectedCallback(): void;
 }
 
-export declare type InitConfig = {
+declare type InitConfig = {
     modulesConfig?: {
         docreader?: {
             devLicense: string;
         };
         face?: Record<string, any>;
     };
-    includedModules: any[];
+    includedModules: IdvModulesType[];
 };
 
 export declare type InitializeCompletion = {
@@ -223,7 +207,7 @@ export declare enum PrepareWorkflowError {
 export declare enum ScenarioError {
     INITIALIZATION_REQUIRED = 0,
     PREPARED_REQUIRED = 1,
-    START_SESSION_FAILED = 2,
+    START_SESSION_ERROR = 2,
     UNKNOWN_STEP = 3,
     MODULES_ISSUE = 4,
     ALREADY_STARTED = 5,
@@ -252,11 +236,10 @@ export declare enum StartSessionError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1,
     DECODING_FAILED = 2,
-    TOKEN_ERROR = 3,
-    CONNECTION_ISSUE = 4
+    TOKEN_ERROR = 3
 }
 
-export declare type StartWorkflowConfig = {
+declare type StartWorkflowConfig = {
     metadata?: Record<string, unknown>;
     locale?: string;
 };
@@ -266,14 +249,12 @@ declare enum TokenInitializeError {
     WORKFLOW_ISSUE = 1
 }
 
-export declare type UrlConfigureCompletion = {
+declare type UrlConfigureCompletion = {
     workflows: string[];
     error?: BaseTokenInitializationError;
 };
 
-export declare type UrlConnectionConfig = {
-    url: string;
-};
+declare type UrlConnectionConfig = string;
 
 declare type Workflow = {
     id: string;
@@ -284,6 +265,11 @@ declare type Workflow = {
     };
 } & Record<string, any>;
 
+/**
+ * @deprecated Use `WorkflowCompletion` instead.
+ */
+export declare type WorkflowCompetion = WorkflowCompletion;
+
 export declare type WorkflowCompletion = {
     results?: ScenarioResults;
     error?: BaseScenarioError;
@@ -300,7 +286,7 @@ export declare type WorkflowListCompletion = {
     error?: BasePrepareWorkflowError;
 };
 
-export declare type WorkflowListRequest = {
+declare type WorkflowListRequest = {
     limit: number;
     skip: number;
 };