@regulaforensics/idv-capture-web 2.5.218-nightly → 2.5.223-nightly

package/README.md

@@ -5,7 +5,11 @@
 - [Compatibility](#compatibility)
 - [Install via NPM](#install-via-npm)
 - [Install via CDN](#install-via-cdn)
+- [Setup](#setup)
 - [Events](#events)
+- [Setters](#setters)
+- [Getters](#getters)
+- [Methods](#methods)
 
 ---
 
@@ -52,7 +56,6 @@ Install idv-capture-web:
 
 ```
 npm i @regulaforensics/idv-capture-web
-npm i @regulaforensics/idv-gui
 
 #optionally
 
@@ -66,7 +69,6 @@ Import `@regulaforensics/idv-capture-web` into your `index.js`:
 
 ```javascript
 import './node_modules/@regulaforensics/idv-capture-web/dist/main.js';
-import './node_modules/@regulaforensics/idv-gui/dist/main.js';
 ```
 
 In `index.html` connect `index.js` and add the name of the component you want to use. Available components:
@@ -97,14 +99,13 @@ For example:
 
 ```html
 <script src="https://unpkg.com/@regulaforensics/idv-capture-web@latest/dist/main.iife.js"></script>
-<script src="https://unpkg.com/@regulaforensics/idv-gui@latest/dist/main.iife.js"></script>
 
 <script src="https://unpkg.com/@regulaforensics/idv-face@latest/dist/main.iife.js"></script>
 <script src="https://unpkg.com/@regulaforensics/idv-document@latest/dist/main.iife.js"></script>
 
 ```
 
-Add the name of the component to the html, as in the example above.
+Add the component tag to your HTML, as shown in the example above.
 
 ## Setup
 
@@ -113,10 +114,9 @@ Use `IdvIntegrationService` to setup idv flow.
 General example of the integration step by step
 
 ```javascript
-/** import necessary service & packages  */
+/** import necessary service */
 import { IdvIntegrationService } from '@regulaforensics/idv-capture-web';
-import { GuiIdv } from "@regulaforensics/idv-gui";
-/** depends of your workflow */
+/** and packages depends of your workflow */
 import { FaceIdv } from "@regulaforensics/idv-face";
 import { DocumentIdv } from "@regulaforensics/idv-document";
 
@@ -133,12 +133,12 @@ const idvEventListener = (event) => {
 service.sessionRestoreMode = true;
 service.eventListener = idvEventListener;
 
-/** for convenience, we will use an asynchronous function. You also can use Promises */
+/** for convenience, we will use an asynchronous function. You can also use Promises */
 (async function () {
     /** set modules */
     const initResult = await service.initialize({
         modulesConfig: { docreader: { devLicense: 'yourBase64license' } },
-        includedModules: [GuiIdv, FaceIdv, DocumentIdv],
+        includedModules: [FaceIdv, DocumentIdv],
     });
     /** if something goes wrong, the command error will contain an error field.  */
     if (initResult.error) {
@@ -147,7 +147,7 @@ service.eventListener = idvEventListener;
     }
 
     const configureResult = await service.configure({
-        host: 'https://your.host.com',
+        baseUrl: 'https://your.host.com',
         userName: '',
         password: '',
     });
@@ -179,6 +179,26 @@ service.eventListener = idvEventListener;
 })();
 ```
 
+**Alternative configure options:**
+
+Using **apiKey**:
+
+```javascript
+const configureResult = await service.configure({
+    baseUrl: 'https://your.host.com',
+    apiKey: 'your apiKey',
+    ttl: 86400,
+});
+```
+
+Using **url**:
+
+```javascript
+const configureResult = await service.configure({
+    url: 'your url with token',
+});
+```
+
 ## Events
 
 You can subscribe to the component events.
@@ -194,9 +214,10 @@ For example:
     const service = new IdvIntegrationService();
     service.eventListener = idvEventListener;
 ```
+
 ## Setters
 
-`nonce` - set CSP nonce id to the style tag 
+`nonce` - set CSP nonce id to the style tag
 
 ```javascript
     const service = new IdvIntegrationService();
@@ -226,8 +247,8 @@ Check types in the `index.d.ts`
 
 
 `async configure(
-        config: ConnectionConfig | UrlConnectionConfig | ConnectionByApiKeyConfig,
-    ): Promise<ConfigureCompletion | UrlConfigureCompletion>` - configures the service. accepts input parameters for connecting to the platform
+        config: CredentialConnectionConfig | TokenConnectionConfig | ApiKeyConnectionConfig,
+    ): Promise<ConfigureCompletion | TokenConfigureCompletion>` - configures the service. accepts input parameters for connecting to the platform
 
 `async getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>` - returns list of available workflows
 

package/dist/index.d.ts

@@ -1,3 +1,21 @@
+export declare type ApiKeyConnectionConfig = {
+    baseUrl: string;
+    apiKey: string;
+    ttl?: number;
+};
+
+declare class BaseConfigureError extends BaseError {
+    private static readonly MODULE;
+    private static readonly ERROR_ENUM_NAME;
+    private static readonly SHORT_CODE;
+    constructor({ errorCode, message, underlyingError, underlyingBaseError, }: {
+        errorCode: ConfigureError;
+        message?: string;
+        underlyingError?: string;
+        underlyingBaseError?: BaseError;
+    });
+}
+
 declare class BaseDeinitializationError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
@@ -62,24 +80,24 @@ declare class BasePrepareWorkflowError extends BaseError {
     });
 }
 
-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: ScenarioError;
+        errorCode: TokenInitializeError;
         message?: string;
         underlyingError?: string;
         underlyingBaseError?: BaseError;
     });
 }
 
-declare class BaseTokenInitializationError extends BaseError {
+declare class BaseWorkflowError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
     constructor({ errorCode, message, underlyingError, underlyingBaseError, }: {
-        errorCode: TokenInitializeError;
+        errorCode: WorkflowError;
         message?: string;
         underlyingError?: string;
         underlyingBaseError?: BaseError;
@@ -87,38 +105,27 @@ declare class BaseTokenInitializationError extends BaseError {
 }
 
 export declare type ConfigureCompletion = {
-    error?: BaseInitializationError;
-};
-
-export declare type ConnectionByApiKeyConfig = {
-    host: string;
-    apiKey: string;
-    isSecure?: boolean;
-    port?: number;
-    deviceDescriptor?: Record<string, unknown>;
-    httpRetryCount?: number;
-    httpTimeoutMs?: number;
+    error?: BaseConfigureError;
 };
 
-export declare type ConnectionConfig = {
-    host: string;
-    httpRetryCount?: number;
-    httpTimeoutMs?: number;
-    isSecure?: boolean;
-    password: string;
-    port?: number;
-    schema?: string;
-    userName: string;
-    deviceDescriptor?: {
-        ttl?: number;
-    } & Record<string, unknown>;
-};
+declare enum ConfigureError {
+    CONNECTION_ISSUE = 0,
+    CONFIG_MISSED_OR_INVALID = 1,
+    INITIALIZATION_REQUIRED = 2,
+    SCENARIO_IN_PROGRESS = 3
+}
 
 export declare enum ConnectionError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1
 }
 
+export declare type CredentialConnectionConfig = {
+    baseUrl: string;
+    password: string;
+    userName: string;
+};
+
 export declare enum DeinitializationError {
     INITIALIZATION_REQUIRED = 0,
     SCENARIO_IN_PROGRESS = 3
@@ -140,7 +147,7 @@ export declare class IdvIntegrationService {
     initialize(config: InitConfig): Promise<{
         error?: BaseInitializationError;
     }>;
-    configure(config: ConnectionConfig | UrlConnectionConfig | ConnectionByApiKeyConfig): Promise<ConfigureCompletion | UrlConfigureCompletion>;
+    configure(config: CredentialConnectionConfig | TokenConnectionConfig | ApiKeyConnectionConfig): Promise<ConfigureCompletion | TokenConfigureCompletion>;
     getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>;
     prepareWorkflow({ workflowId }: {
         workflowId: string;
@@ -160,13 +167,6 @@ export declare type IdvMessageEvent = {
     message?: IdvServiceMessages;
 };
 
-export declare const IdvModules: {
-    readonly LIVENESS: "LIVENESS";
-    readonly DOC_READER: "DOC_READER";
-};
-
-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",
@@ -218,25 +218,6 @@ export declare enum PrepareWorkflowError {
     SCENARIO_IN_PROGRESS = 4
 }
 
-export declare enum ScenarioError {
-    INITIALIZATION_REQUIRED = 0,
-    PREPARED_REQUIRED = 1,
-    START_SESSION_FAILED = 2,
-    UNKNOWN_STEP = 3,
-    MODULES_ISSUE = 4,
-    ALREADY_STARTED = 5,
-    INTERNAL_ISSUE = 6
-}
-
-declare type ScenarioResults = {
-    sessionId?: string;
-    finalStep?: {
-        id: string;
-        name: string;
-        final: boolean;
-    };
-} & Record<string, any>;
-
 export declare enum SessionError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1,
@@ -259,20 +240,20 @@ export declare type StartWorkflowConfig = {
     locale?: string;
 };
 
-declare enum TokenInitializeError {
-    CONNECTION_ISSUE = 0,
-    WORKFLOW_ISSUE = 1
-}
-
-export declare type UrlConfigureCompletion = {
+export declare type TokenConfigureCompletion = {
     workflows: string[];
     error?: BaseTokenInitializationError;
 };
 
-export declare type UrlConnectionConfig = {
+export declare type TokenConnectionConfig = {
     url: string;
 };
 
+declare enum TokenInitializeError {
+    CONNECTION_ISSUE = 0,
+    WORKFLOW_ISSUE = 1
+}
+
 declare type Workflow = {
     id: string;
     steps: Array<WorkflowStep>;
@@ -283,14 +264,18 @@ declare type Workflow = {
 } & Record<string, any>;
 
 export declare type WorkflowCompletion = {
-    results?: ScenarioResults;
-    error?: BaseScenarioError;
+    results?: WorkflowResult;
+    error?: BaseWorkflowError;
 };
 
 export declare enum WorkflowError {
-    HTTP_ISSUE = 0,
-    PROVIDER_ERROR = 1,
-    DECODING_FAILED = 2
+    INITIALIZATION_REQUIRED = 0,
+    PREPARED_REQUIRED = 1,
+    START_SESSION_FAILED = 2,
+    UNKNOWN_STEP = 3,
+    MODULES_ISSUE = 4,
+    ALREADY_STARTED = 5,
+    INTERNAL_ISSUE = 6
 }
 
 export declare type WorkflowListCompletion = {
@@ -303,6 +288,21 @@ export declare type WorkflowListRequest = {
     skip: number;
 };
 
+export declare enum WorkflowPlatformError {
+    HTTP_ISSUE = 0,
+    PROVIDER_ERROR = 1,
+    DECODING_FAILED = 2
+}
+
+declare type WorkflowResult = {
+    sessionId?: string;
+    finalStep?: {
+        id: string;
+        name: string;
+        final: boolean;
+    };
+} & Record<string, any>;
+
 declare type WorkflowStep = {
     id: string;
     name: string;