@regulaforensics/idv-capture-web 0.1.118-rc → 0.1.206-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();
 
@@ -116,13 +136,13 @@ service.eventListener = idvEventListener;
 /** for convenience, we will use an asynchronous function. You also can use Promises */
 (async function () {
     /** set modules */
-    const initResilt = await service.initialize({
+    const initResult = await service.initialize({
         modulesConfig: { docreader: { devLicense: 'yourBase64license' } },
-        includedModules: [IdvModules.LIVENESS, IdvModules.DOC_READER],
+        includedModules: [GuiIdv, FaceIdv, DocumentIdv],
     });
     /** if something goes wrong, the command error will contain an error field.  */
-    if (initResilt.error) {
-        console.log(initResilt.error);
+    if (initResult.error) {
+        console.log(initResult.error);
         return;
     }
 
@@ -147,7 +167,8 @@ service.eventListener = idvEventListener;
     }
 
     const metadata = { anyMetadata: 'Any Metadata' };
-    const startWorkflowResult = await service?.startWorkflow(metadata);
+    const locale = 'en-us'; // 'en-us' for example. Should be the language of your workflow
+    const startWorkflowResult = await service?.startWorkflow({ locale: locale, metadata: metadata });
 
     if (startWorkflowResult.error) {
         console.log(startWorkflowResult.error);
@@ -172,4 +193,46 @@ For example:
 
     const service = new IdvIntegrationService();
     service.eventListener = idvEventListener;
-```
+```
+## Setters
+
+`nonce` - set CSP nonce id to the style tag 
+
+```javascript
+    const service = new IdvIntegrationService();
+    service.nonce = nonceId;
+```
+
+`sessionRestoreMode` - set restore mode to the **idv-capture-web** . restores the session from the current step (for example, if the page was accidentally reloaded)
+
+```javascript
+    const service = new IdvIntegrationService();
+    service.sessionRestoreMode = true;
+```
+
+## Getters
+
+`version` - returns the version of the component
+```javascript
+    const service = new IdvIntegrationService();
+    console.log(service.version);
+```
+
+## Methods
+
+Check types in the `index.d.ts`
+
+`async initialize(config: InitConfig): Promise<{ error?: BaseInitializationError }>` - initialize the idv-web-capture worker. 
+
+
+`async configure(
+        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
+
+`async prepareWorkflow({ workflowId }: { workflowId: string }): Promise<PrepareWorkflowCompletion>` - prepared service with workflowId. In this method, the component checks the compatibility of modules and steps in the workflow.
+
+`async startWorkflow(config?: StartWorkflowConfig): Promise<WorkflowCompletion>` - this method starts workflow. We recommend showing the web component immediately before executing this method and deleting the web component after the promise of this method resolves.
+
+`async deinitialize(): Promise<DeinitializeCompletion>` - deinitialize the service. After this command you should run `initialize` method if you want to continue working with the service. We recommend executing this command when you have completed the necessary work on the page.

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 {
@@ -106,12 +121,6 @@ export declare enum ConnectionError {
     PROVIDER_ERROR = 1
 }
 
-declare type CurrentScreenConfig = {
-    templateId: string;
-    sessionId?: string;
-    serviceToken?: string;
-} & Record<string, any>;
-
 export declare enum DeinitializationError {
     INITIALIZATION_REQUIRED = 0,
     SCENARIO_IN_PROGRESS = 3
@@ -133,18 +142,18 @@ export declare class IdvIntegrationService {
     initialize(config: InitConfig): Promise<{
         error?: BaseInitializationError;
     }>;
-    configure(config: ConnectionConfig | UrlConnectionConfig): Promise<ConfigureCompletion | UrlConfigureCompelition>;
+    configure(config: ConnectionConfig | UrlConnectionConfig | ConnectionByApiKeyConfig): Promise<ConfigureCompletion | UrlConfigureCompletion>;
     getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>;
     prepareWorkflow({ workflowId }: {
         workflowId: string;
     }): Promise<PrepareWorkflowCompletion>;
-    startWorkflow(metadata?: Record<string, unknown>): Promise<WorkflowCompetion>;
+    startWorkflow(config?: StartWorkflowConfig): Promise<WorkflowCompletion>;
     deinitialize(): Promise<DeinitializeCompletion>;
     /** service commands */
-    setNonce(id: string): void;
+    get version(): string;
+    set nonce(id: string);
     set eventListener(callback: (message: IdvMessageEvent) => void);
     set sessionRestoreMode(isEnabled: boolean);
-    get currentSessionId(): string | null;
 }
 
 export declare type IdvMessageEvent = {
@@ -163,7 +172,8 @@ 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_START_RESTORE_SESSION = "DID_START_RESTORE_SESSION",
+    DID_CONTINUE_REMOTE_SESSION = "DID_CONTINUE_REMOTE_SESSION"
 }
 
 export declare class IdvWebComponent extends HTMLElement {
@@ -177,14 +187,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 = {
@@ -213,7 +223,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,
@@ -222,7 +232,11 @@ export declare enum ScenarioError {
 
 declare type ScenarioResults = {
     sessionId?: string;
-    finalStep?: WorkflowStep;
+    finalStep?: {
+        id: string;
+        name: string;
+        final: boolean;
+    };
 } & Record<string, any>;
 
 export declare enum SessionError {
@@ -238,31 +252,39 @@ 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 = {
+    metadata?: Record<string, unknown>;
+    locale?: string;
+};
+
 declare enum TokenInitializeError {
     CONNECTION_ISSUE = 0,
     WORKFLOW_ISSUE = 1
 }
 
-declare type UrlConfigureCompelition = {
+export declare type UrlConfigureCompletion = {
     workflows: string[];
     error?: BaseTokenInitializationError;
 };
 
-declare type UrlConnectionConfig = string;
+export declare type UrlConnectionConfig = {
+    url: string;
+};
 
 declare type Workflow = {
     id: string;
     steps: Array<WorkflowStep>;
     client: {
         layout: Record<string, any>;
-        steps: Array<CurrentScreenConfig>;
+        steps: Array<WorkflowStepClientGui>;
     };
 } & Record<string, any>;
 
-export declare type WorkflowCompetion = {
+export declare type WorkflowCompletion = {
     results?: ScenarioResults;
     error?: BaseScenarioError;
 };
@@ -278,7 +300,7 @@ export declare type WorkflowListCompletion = {
     error?: BasePrepareWorkflowError;
 };
 
-declare type WorkflowListRequest = {
+export declare type WorkflowListRequest = {
     limit: number;
     skip: number;
 };
@@ -287,6 +309,13 @@ declare type WorkflowStep = {
     id: string;
     name: string;
     final: boolean;
+    client?: Record<string, unknown> | WorkflowStepClientGui;
+    dataSource: Record<string, unknown> | null;
 } & Record<string, any>;
 
+declare type WorkflowStepClientGui = {
+    templateId: string;
+    templateLayout: Record<string, unknown>;
+};
+
 export { }