@idscan/onboarding 2.2.11 → 2.2.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idscan/onboarding",
-  "version": "2.2.11",
+  "version": "2.2.13",
   "description": "Wrapper of the IDVC library for DVS Online.",
   "main": "dist/js/wrapper.js",
   "types": "dist/@types/src/Wrapper.d.ts",
@@ -20,7 +20,7 @@
     "minor": "npm version minor"
   },
   "dependencies": {
-    "@idscan/idvc2": "^2.5.6",
+    "@idscan/idvc2": "^2.5.9",
     "core-js": "^3.30.0",
     "qrcode": "^1.5.1",
     "regenerator-runtime": "^0.13.11"

package/readme.md

@@ -46,7 +46,7 @@ There are binary files in the folder which do not have the extension. These file
 new CopyWebpackPlugin ([
   {
     from: 'node_modules/@idscan/onboarding/dist/networks/**/*',
-    to: 'networks/[folder]/[name].[ext]',
+    to: `${networkUrl}/[folder]/[name].[ext]`,
     toType: 'template'
   }
 ])
@@ -68,33 +68,39 @@ Available fields:
 
 **el** (string) - id of an element on the page where the component will be integrated. Required.
 
-**applicantId** (string) - id of applicant. Required
+**applicantId** (string) - id of applicant. Required.
 
-**domainId** (string) - domain id where from will get configs and styles. Required
+**domainId** (string) - domain id where from will get configs and styles. Required.
 
-**domainApi** (string) - URL address of onboarding API
+**domainApi** (string) - URL address of onboarding API. Required.
 
-**publicKey** (string) - DVS Web API Public Key. Required
+**publicKey** (string) - DVS Web API Public Key. Required.
 
-**isAuth** (boolean) - Flag indicating that only face authentication is required
+**isAuth** (boolean) - Flag indicating that only face authentication is required.
 
-**faceOnly** (boolean) - Flag indicating that only face registration is required
+**faceOnly** (boolean) - Flag indicating that only face registration is 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\'.
 
+**networkUrl** (boolean) - Path to the folder with neural networks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.'
+
+**useCDN** (boolean) - Flag indicating that you want to load networks from cdn instead of your domain.
+
+**preferApiConfig** (boolean) - Flag indicating that you prefer to use IDVC library configuration, that was sent from the DVS Online API, instead of the configuration used when initializing the wrapper.
+
 **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
+- **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
+- **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
+- **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
+- **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
+- **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
+- **onError** - the function that will be called on error. The response value is the object with the error code and the message.
 
 - **onReloaded** - the function that will be called after the component finishes reloading. This function doesn't return a value.
 
@@ -138,6 +144,7 @@ const lib = new DVSOIDVC({
   domainId: '...',
   publicKey: '...',
   chunkPublicPath: '/customPath/',
+  domainApi: '...',
 });
 
 const btn = document.getElementById('btn');
@@ -150,6 +157,16 @@ btn.addEventListener('click', () => {
 **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.2.13**
+  - Added: new config options 'networkUrl', 'useCDN', 'preferApiConfig'
+
+- **2.2.12**
+  - Updated IDVC component
+  - Updated readme
+
+- **2.2.11**
+  - Feat: some minor fixes
+
 - **2.2.10**
   - Feat: face only mode