@idscan/idvc2 2.2.2 → 2.3.0

package/README.md

@@ -1,156 +1,160 @@
-## Overview
-
-Upon being switched on, the library integrates the component of capturing the documents and faces from a video to your page.
-
-## Use cases
-
-- Capture and determination of the document type
-- Capture of pdf417
-- Capture of MRZ
-- Capture of faces
-- Capture of QR code
-- Capture of VIN
-
-## 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 93) and in phones with the operating system iOS (minimum version 14) in the browser Safari
-
-## Installation
-
-```
-$ npm install @idscan/idvc2
-```
-
-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`.*
-
-*copy-webpack-plugin v.5 and below*
-```javascript
-const CopyWebpackPlugin = require('copy-webpack-plugin');
-
-new CopyWebpackPlugin ([{
-  from: 'node_modules/@idscan/idvc2/dist/networks/*',
-  to: 'networks/[name].[ext]',
-  toType: 'template',
-}]);
-```
-*copy-webpack-plugin v.6 and above*
-```javascript
-const CopyWebpackPlugin = require('copy-webpack-plugin');
-
-new CopyWebpackPlugin({
-  patterns: [
-    {
-      from: 'node_modules/@idscan/idvc2/dist/networks/*',
-      to: 'networks/[name][ext]',
-      toType: 'template',
-    },
-  ],
-});
-```
-
-1.3. Import the library and css to your project.
-
-```javascript
-import IDVC from '@idscan/idvc2'
-import '@idscan/idvc2/dist/css/idvc.css'
-
-```
-
-## Configuration
- Configuration documentation you can find on our [site](https://docs.idscan.net/dvs/dvs-web-api/web-library-v2.html).
-
-
-*Note: Request a license key for the library by emailing
- [sales@idscan.net](mailto:sales@idscan.net) or [support@idscan.net](mailto:support@idscan.net)*
-
-## Version history
-- **2.2.2**
-  - fixed: spinner module
-- **2.2.1**
-  - fixed: spinner on manual upload
-- **2.2.0**
-  - fixed: video container
-  - fixed: force image capture button
-  - feature: check for blur
-  - feature: reduced loading time
-  - feature: reduced image capturing time
-  - feature: new liveness checks
-  - updated: pdf and mrz modules
-  - feature: lazy async loading
-  - fixed: flashlight state on step change
-  - updated: neuron networks
-  - feature: new hook updateDocumentTypes
-- **2.1.6**
-  - Fixed css variable
-- **2.1.5**
-  - Added limitations check
-- **2.1.4**
-  - fixed event listeners behavior on restart component
-- **2.1.3**
-  - fixed reload component method
-- **2.1.2**
-  - fixed change document type
-- **2.1.1**
-  - updated camera module
-  - improved camera errors handling
-- **2.1.0**
-  - removed additional fonts
-  - added step swiping if an image is uploaded
-  - changed front document capturing method
-  - improved mrz parsing
-  - fixed bubbling if an image is mirrored 
-  - reduced library size
-  - added new css variable for library's font family
-  - reduced css
-  - added blur detector to front step
-  - improved MRZ location and MRZ decode speed.
-  - moved HEIC supports to distinct module and added additional config option for it.
-  - reduced first loading time.
-  - removed "parsePDF" option.
-  - added "mrzImg" field to mrz step. It's cut mrz for better MRZ recognition on DVS side.
-- **2.0.2**
-  - fix: manual upload.
-- **2.0.1**
-  - deprecated: isShowManualSwitchButton. Now the decision is made on a step config
-  - deprecated: enableFlash. Now it shows only if device/browser supports flashlight.
-  - deprecated: showSubmitBtn. The submit button is always turned on.
-  - deprecated: isShowVersion. The Library version is always showing.
-  - deprecated: tapOnVideo.
-  - deprecated: tapBackSide.
-  - deprecated: tapFace.
-  - deprecated: showForceCapturingBtn.
-  - deprecated: minPDFframes.
-  - deprecated: capturingMode.
-  - deprecated: showPreviewForOneStep.
-  - deprecated: priority. Now the priority is selected by camera availability.
-  - deprecated: parseMRZ.
-  - deprecated: enableGeolocation.
-  - deprecated: enableLimitation. Now limitation shows only if the system not supports needed features.
-  - deprecated: steps.
-  - deprecated: types.
-  - deprecated: displayParsedData.
-  - changed behavior: autoContinue.
-  - feat: documentTypes. Now the "documentTypes" option is a union of steps and types.
-  - feat: add translation.
+## Overview
+
+Upon being switched on, the library integrates the component of capturing the documents and faces from a video to your page.
+
+## Use cases
+
+- Capture and determination of the document type
+- Capture of pdf417
+- Capture of MRZ
+- Capture of faces
+- Capture of QR code
+- Capture of VIN
+
+## 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 93) and in phones with the operating system iOS (minimum version 14) in the browser Safari
+
+## Installation
+
+```
+$ npm install @idscan/idvc2
+```
+
+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`.*
+
+*copy-webpack-plugin v.5 and below*
+```javascript
+const CopyWebpackPlugin = require('copy-webpack-plugin');
+
+new CopyWebpackPlugin ([{
+  from: 'node_modules/@idscan/idvc2/dist/networks/*',
+  to: 'networks/[name].[ext]',
+  toType: 'template',
+}]);
+```
+*copy-webpack-plugin v.6 and above*
+```javascript
+const CopyWebpackPlugin = require('copy-webpack-plugin');
+
+new CopyWebpackPlugin({
+  patterns: [
+    {
+      from: 'node_modules/@idscan/idvc2/dist/networks/*',
+      to: 'networks/[name][ext]',
+      toType: 'template',
+    },
+  ],
+});
+```
+
+1.3. Import the library and css to your project.
+
+```javascript
+import IDVC from '@idscan/idvc2'
+import '@idscan/idvc2/dist/css/idvc.css'
+
+```
+
+## Configuration
+ Configuration documentation you can find on our [site](https://docs.idscan.net/dvs/dvs-web-api/web-library-v2.html).
+
+
+*Note: Request a license key for the library by emailing
+ [sales@idscan.net](mailto:sales@idscan.net) or [support@idscan.net](mailto:support@idscan.net)*
+
+## Version history
+- **2.3.0**
+  - added: new option in config "chunkPublicPath"
+- **2.2.3**
+  - fixed: switch manual upload button
+- **2.2.2**
+  - fixed: spinner module
+- **2.2.1**
+  - fixed: spinner on manual upload
+- **2.2.0**
+  - fixed: video container
+  - fixed: force image capture button
+  - feature: check for blur
+  - feature: reduced loading time
+  - feature: reduced image capturing time
+  - feature: new liveness checks
+  - updated: pdf and mrz modules
+  - feature: lazy async loading
+  - fixed: flashlight state on step change
+  - updated: neuron networks
+  - feature: new hook updateDocumentTypes
+- **2.1.6**
+  - Fixed css variable
+- **2.1.5**
+  - Added limitations check
+- **2.1.4**
+  - fixed event listeners behavior on restart component
+- **2.1.3**
+  - fixed reload component method
+- **2.1.2**
+  - fixed change document type
+- **2.1.1**
+  - updated camera module
+  - improved camera errors handling
+- **2.1.0**
+  - removed additional fonts
+  - added step swiping if an image is uploaded
+  - changed front document capturing method
+  - improved mrz parsing
+  - fixed bubbling if an image is mirrored 
+  - reduced library size
+  - added new css variable for library's font family
+  - reduced css
+  - added blur detector to front step
+  - improved MRZ location and MRZ decode speed.
+  - moved HEIC supports to distinct module and added additional config option for it.
+  - reduced first loading time.
+  - removed "parsePDF" option.
+  - added "mrzImg" field to mrz step. It's cut mrz for better MRZ recognition on DVS side.
+- **2.0.2**
+  - fix: manual upload.
+- **2.0.1**
+  - deprecated: isShowManualSwitchButton. Now the decision is made on a step config
+  - deprecated: enableFlash. Now it shows only if device/browser supports flashlight.
+  - deprecated: showSubmitBtn. The submit button is always turned on.
+  - deprecated: isShowVersion. The Library version is always showing.
+  - deprecated: tapOnVideo.
+  - deprecated: tapBackSide.
+  - deprecated: tapFace.
+  - deprecated: showForceCapturingBtn.
+  - deprecated: minPDFframes.
+  - deprecated: capturingMode.
+  - deprecated: showPreviewForOneStep.
+  - deprecated: priority. Now the priority is selected by camera availability.
+  - deprecated: parseMRZ.
+  - deprecated: enableGeolocation.
+  - deprecated: enableLimitation. Now limitation shows only if the system not supports needed features.
+  - deprecated: steps.
+  - deprecated: types.
+  - deprecated: displayParsedData.
+  - changed behavior: autoContinue.
+  - feat: documentTypes. Now the "documentTypes" option is a union of steps and types.
+  - feat: add translation.