@regulaforensics/idv-document 3.2.262-nightly → 3.2.265-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 +55 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,57 @@
|
|
|
1
|
-
# Document
|
|
1
|
+
# Document Reader IDV Module
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The **idv-document** module is an npm package plugin designed to work with **DocreaderSDK** via a Web Component:
|
|
4
|
+
https://www.npmjs.com/package/@regulaforensics/vp-frontend-document-components
|
|
5
|
+
|
|
6
|
+
It is delivered as part of the **IDV Capturing** solution and has a version synchronized with **idv-capture-web**. Currently, compatibility is guaranteed at the **major.minor** version level.
|
|
7
|
+
|
|
8
|
+
## What the Module Is
|
|
9
|
+
|
|
10
|
+
The module is an **npm package** that **exports a Web Component**, inside which the **Lit** framework (LitJS) is used for rendering and component logic.
|
|
11
|
+
|
|
12
|
+
## DocreaderSDK Versioning
|
|
13
|
+
|
|
14
|
+
This module declares a **peerDependency** on:
|
|
15
|
+
https://www.npmjs.com/package/@regulaforensics/vp-frontend-document-components
|
|
16
|
+
to ensure compatibility with specific versions of DocreaderSDK.
|
|
17
|
+
|
|
18
|
+
- If the root project already has a version of `vp-frontend-document-components` installed and it matches the allowed versions in `peerDependencies`, that version will be used.
|
|
19
|
+
- If the installed version does **not** match, then starting from **npm v7+**, npm will automatically install a suitable version.
|
|
20
|
+
- In earlier versions of npm, the application developer must manually install the required compatible version.
|
|
21
|
+
|
|
22
|
+
## How It Works
|
|
23
|
+
|
|
24
|
+
The module receives typed configuration data following the unified interface used by all **idv-capture-web** modules.
|
|
25
|
+
The type definitions for the Docreader IDV module configuration are located inside this package.
|
|
26
|
+
|
|
27
|
+
The Web Component then interacts with `vp-frontend-document-components`, which communicates with the **DocreaderSDK service**.
|
|
28
|
+
|
|
29
|
+
## Module Output
|
|
30
|
+
|
|
31
|
+
The result of execution can be either:
|
|
32
|
+
|
|
33
|
+
- **Data** for submission to the platform, or
|
|
34
|
+
- A typed **BaseError**, which contains detailed information explaining why the module failed.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## Important Note: Licensing
|
|
38
|
+
|
|
39
|
+
Licensing for this module is **domain-based**.
|
|
40
|
+
However, you may also provide a **development license (`devLicense`)**, encoded in **Base64**.
|
|
41
|
+
|
|
42
|
+
### Providing a devLicense in Ready for Production mode
|
|
43
|
+
|
|
44
|
+
When running in a production environment, you can pass a development license to the module via `moduleProps` in the parent component service of **idv-capture-web**.
|
|
45
|
+
|
|
46
|
+
### Providing a devLicense for Development
|
|
47
|
+
|
|
48
|
+
If the module is used **for development purposes**, the license can be supplied using:
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
modulesConfig: {
|
|
52
|
+
docreader: {
|
|
53
|
+
devLicense: string;
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
```
|
|
4
57
|
|
|
5
|
-
Exports React component which can be used in Idv-capture-web-components and IDV Platform
|
package/package.json
CHANGED