@regulaforensics/idv-capture-web 2.3.154-nightly → 2.4.156-rc

package/README.md

@@ -118,7 +118,7 @@ service.eventListener = idvEventListener;
     /** set modules */
     const initResult = await service.initialize({
         modulesConfig: { docreader: { devLicense: 'yourBase64license' } },
-        includedModules: [IdvModules.LIVENESS, IdvModules.DOC_READER],
+        includedModules: [IdvModules.LIVENESS, IdvModules.DOC_READER], //import IdvModules from @regulaforensics/idv-capture-web 
     });
     /** if something goes wrong, the command error will contain an error field.  */
     if (initResult.error) {
@@ -173,4 +173,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
+    ): 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.