@idscan/onboarding 2.0.19 → 2.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idscan/onboarding",
-  "version": "2.0.19",
+  "version": "2.0.21",
   "description": "Wrapper of the IDVC library for DVS Online.",
   "main": "dist/js/wrapper.js",
   "files": [
@@ -11,7 +11,8 @@
     "build": "webpack build --mode development --progress --stats-children",
     "prod": "webpack build --mode production --progress --stats-children",
     "pack": "npm pack",
-    "patch": "npm version patch"
+    "patch": "npm version patch",
+    "minor": "npm version minor"
   },
   "dependencies": {
     "@idscan/idvc2": "2.3.0",

package/readme.md

@@ -0,0 +1,264 @@
+## Overview
+
+Wrapper of the IDVC library for DVS Online.
+
+## Use cases
+
+- Capture and determination of the document type
+- Capture of pdf417
+- Capture of MRZ
+- Capture of faces
+
+## Recommendations
+
+Use a modern phone with a good camera having the definition of not less than 8 megapixels.
+The capture must be made in a well-lighted room. A document must be located at the uniform background.
+
+## Limitations
+
+This component works in phones with the operating system Android in the browser Chrome (minimum version 52) and in phones with the operating system iOS (minimum version 11) in the browser Safari
+
+## Installation
+
+```
+$ npm install @idscan/onboarding
+```
+
+This component contains JS, CSS files which require the mandatory import into your project.
+
+1. Before importing it is necessary to set the webpack-configuration.
+
+*Note: The project must use the webpack 4 and later versions.*
+
+1.1. Add the following rules of loading to the field rules
+```javascript
+{
+	test: /\.css$/,
+	use: ["style-loader", "css-loader"]
+}
+```
+
+1.2. If you prefer to use neural networks from your domain, you should add the 'CopyWebpackPlugin' into the section 'plugins' which will copy the files, which are necessary for the work of the neural network, from the folder to another folder that should be selected by you.
+
+*Note: The structure inside the folder of the component 'networks' must be saved on the server with due regard to the nesting.
+There are binary files in the folder which do not have the extension. These files must be provided by the server with the header `Content-Type: application/octet-stream`.*
+```javascript
+new CopyWebpackPlugin ([
+  {
+    from: 'node_modules/@idscan/onboarding/dist/networks/**/*',
+    to: 'networks/[folder]/[name].[ext]',
+    toType: 'template'
+  }
+])
+```
+
+1.3. Import the library and css to your project.
+
+```javascript
+import DVSOIDVC from '@idscan/onboarding';
+import '@idscan/onboarding/dist/css/onboarding.css';
+```
+## Initialization
+
+Create an instance of the object 'DVS Online IDVC library wrapper'. The object takes one object of the component configuration as a parameter.
+
+All configurations of @idscan/IDVC will be fetched from DVS Online by domainId.
+
+Available fields:
+
+**el** (string) - id of an element on the page where the component will be integrated. Required.
+
+**applicantId** (string) - id of applicant. Required
+
+**domainId** (string) - domain id where from will get configs and styles. Required
+
+**publicKey** (string) - DVS Web API Public Key. Required
+
+**chunkPublicPath** (string) - Path to the folder with chunks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.
+
+**callbacks** (object) - object with callback hooks. Available next hooks:
+
+- **onChange** - callback-function which will be called after change one step. The returnable value is the object with the type and the image
+
+- **onCameraError** - The function that is invoked in case if the camera is not available. The response value is the object with the error code and the message
+
+- **onReset** - callback-function which will be called after reset all the steps. The returnable value is the object with the steps
+
+- **onRetakeHook** - the function that will be called before reset the current step. The returnable value is the object with the current step
+
+- **onValidate** - the function that will be called after validation response received. The returnable value is the object with validation information
+
+- **onError** - the function that will be called on error. The response value is the object with the error code and the message
+
+- **onMounted** - the function that will be called on the component mounted. This function doesn't return a value.
+
+- **submit** - callback-function which will be called after completing all the steps. The returnable value is the object with the following content:
+```javascript
+documentTypes: [
+  {
+    type: "ID",
+    steps:[
+      { type: 'front', name: 'Document Front', mode: { uploader: true, video: true } },
+      { type: 'pdf', name: 'Document PDF417 Barcode' , mode: { uploader: true, video: true } },
+      { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
+    ]},
+  {
+    type: "Passport",
+    steps:[
+      { type: 'mrz', name: 'Passport Front' , mode: { uploader: true, video: true } },
+      { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
+    ]},
+]
+```
+
+steps – steps with the type and the image in the format 'base64'.
+
+Also, if you use automatic capture, in the "back" step **trackstring** will be returned (raw PDF417 data from Barcode encoded in base64)
+
+
+*Note: Request an license key for the library by emailing
+[sales@idscan.net](mailto:sales@idscan.net) or [support@idscan.net](mailto:support@idscan.net)*
+
+## Methods
+
+**setApplicant** (string) - the method that reinitialize wrapper for new applicant. Parameter is an applicant id of string type.
+```javascript
+import DVSOIDVC from './Wrapper';
+
+const lib = new DVSOIDVC({
+  applicantId: '...',
+  domainId: '...',
+  publicKey: '...',
+  chunkPublicPath: '/customPath/',
+});
+
+const btn = document.getElementById('btn');
+btn.addEventListener('click', () => {
+  const applicantId = 'new applicant id';
+  lib.setApplicant(applicantId);
+});
+```
+
+**updateConfig** (string) - the method that reinitialize wrapper with new config. Parameter is an JSON encoded IDVC config. Works only in demo mode.
+
+## Version history
+- **2.1.0**
+  - Added: new option in config "chunkPublicPath" 
+
+- **2.0.19**
+  - Updated IDVC component
+
+- **2.0.18**
+  - Updated IDVC component
+
+- **2.0.17**
+  - Some improvements
+
+- **2.0.16**
+  - Some improvements
+
+- **2.0.15**
+  - Some improvements
+
+- **2.0.14**
+  - Some improvements
+
+- **2.0.13**
+  - Updated IDVC component
+
+- **2.0.12**
+  - Updated IDVC component
+
+- **2.0.11**
+  - Updated IDVC component
+
+- **2.0.10**
+  - Updated IDVC component
+
+- **2.0.9**
+  - Updated IDVC component
+
+- **2.0.8**
+  - Some improvements
+
+- **2.0.7**
+  - Fixed background
+
+- **2.0.6**
+  - Added version 1 config support
+
+- **2.0.5**
+  - Updated IDVC component
+  - Fixed submit method
+
+- **2.0.4**
+  - Updated IDVC component
+
+- **2.0.3**
+  - Some improvements
+
+- **2.0.2**
+  - Updated IDVC component
+
+- **2.0.1**
+  - Added consent form
+
+- **2.0.0**
+  - Migrate to the IDVC version 2
+
+- **1.0.18**
+  - Fixed spinner
+
+- **1.0.17**
+  - Fixed license key
+
+- **1.0.16**
+  - Added sign for forced closing of the request 
+  
+- **1.0.15**
+  - updated IDVC component
+
+- **1.0.14**
+  - updated IDVC component
+
+- **1.0.13**
+  - added ids for style tags
+
+- **1.0.12**
+  - updated IDVC component 
+
+- **1.0.11**
+  - updated using DVS Online API 
+
+- **1.0.10**
+  - added: onMounted callback
+
+- **1.0.9**
+  - @idscan/idvc dependency updated
+
+- **1.0.8**
+  - added: reload component with new configs in demo mode
+
+- **1.0.7**
+  - updated using DVS Online API
+
+- **1.0.6**
+  - updated using DVS Online API
+
+- **1.0.5**
+  - updated IDVC component
+  - updated using DVS Online API
+
+- **1.0.4**
+  - use CDN
+
+- **1.0.3**
+  - Changed readme
+
+- **1.0.2**
+  - Some improvements
+
+- **1.0.1**
+  - Changed readme
+
+- **1.0.0**