@regulaforensics/idv-capture-web 2.5.191-nightly → 2.5.194-rc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -22
- package/dist/index-0QTthvzN.js +23138 -0
- package/dist/index-DK971U5K.js +16434 -0
- package/dist/index-_djGM_-z.js +23544 -0
- package/dist/index.d.ts +17 -31
- package/dist/main.iife.js +226 -55
- package/dist/main.js +14 -20684
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -52,12 +52,6 @@ Install idv-capture-web:
|
|
|
52
52
|
|
|
53
53
|
```
|
|
54
54
|
npm i @regulaforensics/idv-capture-web
|
|
55
|
-
npm i @regulaforensics/idv-gui
|
|
56
|
-
|
|
57
|
-
#optionally
|
|
58
|
-
|
|
59
|
-
npm i @regulaforensics/idv-face
|
|
60
|
-
npm i @regulaforensics/idv-document
|
|
61
55
|
```
|
|
62
56
|
|
|
63
57
|
Create `index.html` and `index.js` files in the root directory of the project.
|
|
@@ -66,7 +60,6 @@ Import `@regulaforensics/idv-capture-web` into your `index.js`:
|
|
|
66
60
|
|
|
67
61
|
```javascript
|
|
68
62
|
import './node_modules/@regulaforensics/idv-capture-web/dist/main.js';
|
|
69
|
-
import './node_modules/@regulaforensics/idv-gui/dist/main.js';
|
|
70
63
|
```
|
|
71
64
|
|
|
72
65
|
In `index.html` connect `index.js` and add the name of the component you want to use. Available components:
|
|
@@ -97,11 +90,6 @@ For example:
|
|
|
97
90
|
|
|
98
91
|
```html
|
|
99
92
|
<script src="https://unpkg.com/@regulaforensics/idv-capture-web@latest/dist/main.iife.js"></script>
|
|
100
|
-
<script src="https://unpkg.com/@regulaforensics/idv-gui@latest/dist/main.iife.js"></script>
|
|
101
|
-
|
|
102
|
-
<script src="https://unpkg.com/@regulaforensics/idv-face@latest/dist/main.iife.js"></script>
|
|
103
|
-
<script src="https://unpkg.com/@regulaforensics/idv-document@latest/dist/main.iife.js"></script>
|
|
104
|
-
|
|
105
93
|
```
|
|
106
94
|
|
|
107
95
|
Add the name of the component to the html, as in the example above.
|
|
@@ -113,14 +101,6 @@ Use `IdvIntegrationService` to setup idv flow.
|
|
|
113
101
|
General example of the integration step by step
|
|
114
102
|
|
|
115
103
|
```javascript
|
|
116
|
-
/** import necessary service & packages */
|
|
117
|
-
import { IdvIntegrationService } from '@regulaforensics/idv-capture-web';
|
|
118
|
-
import { GuiIdv } from "@regulaforensics/idv-gui";
|
|
119
|
-
/** depends of your workflow */
|
|
120
|
-
import { FaceIdv } from "@regulaforensics/idv-face";
|
|
121
|
-
import { DocumentIdv } from "@regulaforensics/idv-document";
|
|
122
|
-
|
|
123
|
-
|
|
124
104
|
/** create service */
|
|
125
105
|
const service = new IdvIntegrationService();
|
|
126
106
|
|
|
@@ -138,7 +118,7 @@ service.eventListener = idvEventListener;
|
|
|
138
118
|
/** set modules */
|
|
139
119
|
const initResult = await service.initialize({
|
|
140
120
|
modulesConfig: { docreader: { devLicense: 'yourBase64license' } },
|
|
141
|
-
includedModules: [
|
|
121
|
+
includedModules: [IdvModules.LIVENESS, IdvModules.DOC_READER], //import IdvModules from @regulaforensics/idv-capture-web
|
|
142
122
|
});
|
|
143
123
|
/** if something goes wrong, the command error will contain an error field. */
|
|
144
124
|
if (initResult.error) {
|
|
@@ -226,7 +206,7 @@ Check types in the `index.d.ts`
|
|
|
226
206
|
|
|
227
207
|
|
|
228
208
|
`async configure(
|
|
229
|
-
config: ConnectionConfig | UrlConnectionConfig
|
|
209
|
+
config: ConnectionConfig | UrlConnectionConfig
|
|
230
210
|
): Promise<ConfigureCompletion | UrlConfigureCompletion>` - configures the service. accepts input parameters for connecting to the platform
|
|
231
211
|
|
|
232
212
|
`async getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>` - returns list of available workflows
|