@regulaforensics/idv-capture-web 2.5.183-nightly → 2.5.185-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

@@ -86,11 +86,23 @@ declare class BaseTokenInitializationError extends BaseError {
     });
 }
 
-declare type ConfigureCompletion = {
+export declare type ConfigureCompletion = {
     error?: BaseInitializationError;
 };
 
-declare type ConnectionConfig = {
+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 = {
     host: string;
     httpRetryCount?: number;
     httpTimeoutMs?: number;
@@ -99,6 +111,9 @@ declare type ConnectionConfig = {
     port?: number;
     schema?: string;
     userName: string;
+    deviceDescriptor?: {
+        ttl?: number;
+    } & Record<string, unknown>;
 };
 
 export declare enum ConnectionError {
@@ -127,7 +142,7 @@ export declare class IdvIntegrationService {
     initialize(config: InitConfig): Promise<{
         error?: BaseInitializationError;
     }>;
-    configure(config: ConnectionConfig | UrlConnectionConfig): Promise<ConfigureCompletion | UrlConfigureCompletion>;
+    configure(config: ConnectionConfig | UrlConnectionConfig | ConnectionByApiKeyConfig): Promise<ConfigureCompletion | UrlConfigureCompletion>;
     getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>;
     prepareWorkflow({ workflowId }: {
         workflowId: string;
@@ -171,14 +186,14 @@ export declare class IdvWebComponent extends HTMLElement {
     disconnectedCallback(): void;
 }
 
-declare type InitConfig = {
+export declare type InitConfig = {
     modulesConfig?: {
         docreader?: {
             devLicense: string;
         };
         face?: Record<string, any>;
     };
-    includedModules: IdvModulesType[];
+    includedModules: any[];
 };
 
 export declare type InitializeCompletion = {
@@ -239,7 +254,7 @@ export declare enum StartSessionError {
     TOKEN_ERROR = 3
 }
 
-declare type StartWorkflowConfig = {
+export declare type StartWorkflowConfig = {
     metadata?: Record<string, unknown>;
     locale?: string;
 };
@@ -249,12 +264,14 @@ declare enum TokenInitializeError {
     WORKFLOW_ISSUE = 1
 }
 
-declare type UrlConfigureCompletion = {
+export declare type UrlConfigureCompletion = {
     workflows: string[];
     error?: BaseTokenInitializationError;
 };
 
-declare type UrlConnectionConfig = string;
+export declare type UrlConnectionConfig = {
+    url: string;
+};
 
 declare type Workflow = {
     id: string;
@@ -265,11 +282,6 @@ declare type Workflow = {
     };
 } & Record<string, any>;
 
-/**
- * @deprecated Use `WorkflowCompletion` instead.
- */
-export declare type WorkflowCompetion = WorkflowCompletion;
-
 export declare type WorkflowCompletion = {
     results?: ScenarioResults;
     error?: BaseScenarioError;
@@ -286,7 +298,7 @@ export declare type WorkflowListCompletion = {
     error?: BasePrepareWorkflowError;
 };
 
-declare type WorkflowListRequest = {
+export declare type WorkflowListRequest = {
     limit: number;
     skip: number;
 };