@regulaforensics/idv-capture-web 3.1.221-rc → 3.1.224-rc

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