@regulaforensics/idv-capture-web 2.5.184-nightly → 2.5.186-nightly

package/README.md

@@ -52,6 +52,12 @@ Install idv-capture-web:
 
 ```
 npm i @regulaforensics/idv-capture-web
+npm i @regulaforensics/idv-gui
+
+#optionally
+
+npm i @regulaforensics/idv-face
+npm i @regulaforensics/idv-document
 ```
 
 Create `index.html` and `index.js` files in the root directory of the project.
@@ -60,6 +66,7 @@ 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:
@@ -90,6 +97,11 @@ 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.
@@ -101,6 +113,14 @@ Use `IdvIntegrationService` to setup idv flow.
 General example of the integration step by step
 
 ```javascript
+/** import necessary service & packages  */
+import { IdvIntegrationService } from '@regulaforensics/idv-capture-web';
+import { GuiIdv } from "@regulaforensics/idv-gui";
+/** depends of your workflow */
+import { FaceIdv } from "@regulaforensics/idv-face";
+import { DocumentIdv } from "@regulaforensics/idv-document";
+
+
 /** create service */
 const service = new IdvIntegrationService();
 
@@ -118,7 +138,7 @@ service.eventListener = idvEventListener;
     /** set modules */
     const initResult = await service.initialize({
         modulesConfig: { docreader: { devLicense: 'yourBase64license' } },
-        includedModules: [IdvModules.LIVENESS, IdvModules.DOC_READER], //import IdvModules from @regulaforensics/idv-capture-web 
+        includedModules: [GuiIdv, FaceIdv, DocumentIdv],
     });
     /** if something goes wrong, the command error will contain an error field.  */
     if (initResult.error) {
@@ -206,7 +226,7 @@ Check types in the `index.d.ts`
 
 
 `async configure(
-        config: ConnectionConfig | UrlConnectionConfig
+        config: ConnectionConfig | UrlConnectionConfig | ConnectionByApiKeyConfig,
     ): Promise<ConfigureCompletion | UrlConfigureCompletion>` - 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

@@ -193,7 +193,7 @@ export declare type InitConfig = {
         };
         face?: Record<string, any>;
     };
-    includedModules: IdvModulesType[];
+    includedModules: any[];
 };
 
 export declare type InitializeCompletion = {
@@ -222,7 +222,7 @@ export declare enum PrepareWorkflowError {
 export declare enum ScenarioError {
     INITIALIZATION_REQUIRED = 0,
     PREPARED_REQUIRED = 1,
-    START_SESSION_ERROR = 2,
+    START_SESSION_FAILED = 2,
     UNKNOWN_STEP = 3,
     MODULES_ISSUE = 4,
     ALREADY_STARTED = 5,
@@ -251,7 +251,8 @@ export declare enum StartSessionError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1,
     DECODING_FAILED = 2,
-    TOKEN_ERROR = 3
+    TOKEN_ERROR = 3,
+    CONNECTION_ISSUE = 4
 }
 
 export declare type StartWorkflowConfig = {