Merge pull request #148 from BlinkID/jenkins/stable-build

CHANGELOG.md

@@ -1,5 +1,134 @@
 # Release notes
 
+## 6.11.0
+
+### Expanded Document Coverage
+
+#### New Documents Support
+
+-   Armenia - Paper Passport
+-   Bahamas - Temporary Residence Permit
+-   Bahamas - Work Permit
+-   Bangladesh - Polycarbonate Passport
+-   Comoros - Paper Passport
+-   Dominican Republic - Non Voter ID
+-   Greece - Polycarbonate Passport
+-   Jamaica - Voter ID
+-   Kazakhstan - Paper Passport
+-   Kyrgyzstan - Paper Passport
+-   Kyrgyzstan - Polycarbonate Passport
+-   Lebanon - Driver's License
+-   Tajikistan - Identity Card
+-   Turkmenistan - Polycarbonate Passport
+-   Uzbekistan - Identity Card
+
+#### New Document Versions for Supported Documents
+
+-   Argentina - Alien ID
+-   Bulgaria - Identity Card
+-   Canada, British Columbia - Identity Card
+-   Canada, British Columbia - Minors Public Services Card
+-   Croatia - Driver's License
+-   Jamaica - Paper Passport
+-   Malaysia - i-Kad
+-   Mexico, Coahuila - Driver's License
+-   Montenegro - Driver's License
+-   Namibia - Identity Card
+-   Norway - Driver's License
+-   Pakistan - Proof of Registration
+-   Panama - Identity Card
+-   Panama - Residence Permit
+-   Peru - Minors ID
+-   Portugal - Identity Card
+-   Romania - Identity Card
+-   Trinidad and Tobago - Driver's License
+-   Turkey - Identity Card
+-   USA, Arizona - Identity Card
+-   USA, Colorado - Identity Card
+-   USA, Michigan - Identity Card
+-   USA, Mississippi - Driver's License
+-   USA, Mississippi - Identity Card
+-   USA, Montana - Identity Card
+-   USA, North Carolina - Identity Card
+-   USA, North Carolina - Driver's License
+-   USA, North Dakota - Driver's License
+-   USA, Vermont - Identity Card
+-   USA, Virginia - Identity Card
+-   USA, Wyoming - Driver's License
+-   USA, Wyoming - Identity Card
+-   Uzbekistan - Paper Passport
+
+#### New Beta Documents Support
+
+-   Andorra - Paper Passport
+-   Andorra - Polycarbonate Passport
+-   Philippines - Driver's License
+-   Armenia - Work Permit
+-   Australia - Asic Card
+-   Azerbaijan - Driver's License
+-   Bahamas - Paper Passport
+-   Bahamas - Polycarbonate Passport
+-   Cayman Islands - Paper Passport
+-   Cayman Islands - Polycarbonate Passport
+-   Cayman Islands - Voter ID
+-   Gibraltar - Driver's License
+-   Gibraltar - Identity Card
+-   Gibraltar - Paper Passport
+-   Gibraltar - Polycarbonate Passport
+-   Guyana - Paper Passport
+-   Kuwait - Bidoon Card
+-   Kyrgyzstan - Driver's License
+-   Monaco - Paper Passport
+-   Pakistan - Afghan Citizen Card
+-   Philippines, Bangsamoro - Driver's License
+-   Saint Lucia - Driver's License
+-   Saint Lucia - Paper Passport
+-   San Marino - Polycarbonate Passport
+-   Turks and Caicos Islands - Driver's License
+-   Turks and Caicos Islands - Identity Card
+-   Turks and Caicos Islands - Paper Passport
+-   Australia - Interim Health Insurance Card
+-   Australia - Reciprocal Health Insurance Card
+-   UAE - Vehicle Registration
+
+#### New Document Versions for Beta-Supported Documents
+
+-   Barbados - Identity Card
+-   Brazil - Paper Passport
+-   Dominican Republic - Driver's License
+-   India, Gujarat - Driver's License
+-   Mexico, Puebla - Driver's License
+-   Philippines - Tax ID
+-   Philippines - Health Insurance Card
+-   Australia - Health Insurance Card
+
+#### New Segments Supported on Documents
+
+-   USA - Green Card - `eligibilityCategory`
+-   USA - Work Permit - `eligibilityCategory`
+-   Greece - Driver's License - `placeOfBirth` (greek and latin)
+-   Saudi Arabia - Resident ID - `nationality` (arabic)
+-   Bahrain - `dateOfExpiry`
+-   USA - Driver's license & ID card - `specificDocumentValidity`
+-   Pakistan - Proof of Registration - `DependentDateOfBirth`, `DependentSex`, `DependentDocumentNumber` & `DependentFullName`
+
+### Renamed segments
+
+-   Barbados - Identity Card - `personalIdNumber` -> `documentNumber`
+-   Panama - Identity Card - `personalIdNumber` -> `documentNumber`
+-   Panama - Residence Permit - `personalIdNumber` -> `documentNumber`
+
+### New Features
+
+-   **Greek Alphabet Support**
+    -   We’ve added support for extracting `Place of Birth` in both Greek and Latin scripts.
+-   API changes in `BlinkIdSingleSideRecognizer` and `BlinkIdMultiSideRecognizer`:
+    -   new fields in result: `manufacturingYear`, `vehicleType`, `eligibilityCategory`, `specificDocumentValidity`, `dependentsInfo`
+    -   new values in `ClassInfo` enums:
+        -   Region: `BANGSAMORO`
+        -   Type: `ASIC_CARD`, `BIDOON_CARD`, `INTERIM_HEALTH_INSURANCE_CARD`, `NON_VOTER_ID`, `RECIPROCAL_HEALTH_INSURANCE_CARD`, `VEHICLE_REGISTRATION`
+    -   new values in `FieldType` enum: `ManufacturingYear`, `VehicleType`, `DependentDateOfBirth`, `DependentSex`, `DependentDocumentNumber`, `DependentFullName`, `EligibilityCategory`, `SpecificDocumentValidity`
+
 ## 6.10.1
 
 -   Barcode scanning is now optional for Paraguay ID documents.

README.md

@@ -1,25 +1,37 @@
 # BlinkID In-browser SDK
 
+## How to run this repo?
+
+Test this repo quickly on your machine (assuming you have Node and Git installed) by doing the following steps:
+
+- clone [this](https://github.com/BlinkID/blinkid-in-browser) repo by running `git clone https://github.com/BlinkID/blinkid-in-browser` in your Terminal
+- run `cd blinkid-in-browser/examples/getting-started && npm install && npm run dev`
+- get the license at [Microblink DevHub](https://developer.microblink.com/) and add it to the `LICENSE` variable in the `main.js` file in the `examples/getting-started` folder
+- open [http://localhost:5173/](http://localhost:5173/)
+  - port may be different in your case, check the output of the `npm run dev` command noted above
+- point your ID towards the camera
+
+If you prefer a short, 3 minute, video for running this project, feel free to check it out [here](https://www.youtube.com/watch?v=c0ZA8af9oBc).
+
+If you want to recreate this project from scratch, step by step, please check out this tutorial: [Integrating ID Scanning and Extraction In Web Apps With BlinkID SDK](examples/getting-started/).
+
+---
+
 [![Build Status](https://travis-ci.org/BlinkID/blinkid-in-browser.svg?branch=master)](https://travis-ci.org/BlinkID/blinkid-in-browser) [![npm version](https://badge.fury.io/js/%40microblink%2Fblinkid-in-browser-sdk.svg)](https://badge.fury.io/js/%40microblink%2Fblinkid-in-browser-sdk)
 
+
 BlinkID In-browser SDK enables scanning of various identity documents, including driving licenses, national identity cards, passports and others. The SDK provides real-time in-browser data extraction, without any need for sending images to servers for processing.
 
 For more information on how to integrate BlinkID SDK into your web app, read the [instructions](#integration) below. Make sure you read the latest [CHANGELOG.md](CHANGELOG.md) file to see the most recent changes and improvements.
 
 Check out the [official demo app](https://demo.microblink.com/in-browser-sdk/blinkid/) or live examples of BlinkID SDK in action:
 
 1. [BlinkID SDK with built-in UI](https://blinkid.github.io/blinkid-in-browser/ui/demo.html)
-    * See what the bare UI looks like at [Codepen](https://codepen.io/microblink/pen/GRZGQab)
 2. [Scan the front side of an identity document with a web camera](https://blinkid.github.io/blinkid-in-browser/examples/blinkid-camera/javascript/index.html)
-    * See example at [Codepen](https://codepen.io/microblink/pen/gOPJoRp)
 3. [Scan the front side of an identity document by uploading its image](https://blinkid.github.io/blinkid-in-browser/examples/blinkid-file/javascript/index.html)
-    * See example at [Codepen](https://codepen.io/microblink/pen/ExPzzda)
 4. [Scan both sides of an identity document with a web camera](https://blinkid.github.io/blinkid-in-browser/examples/multi-side/javascript/index.html)
-    * See example at [Codepen](https://codepen.io/microblink/pen/BajeeMx)
 5. [Scan both sides of an identity document by uploading its image](https://blinkid.github.io/blinkid-in-browser/examples/multi-side-file/javascript/index.html)
-    * See example at [Codepen](https://codepen.io/microblink/pen/MWboMrr)
 6. [Scan barcode from an identity document from web camera](https://blinkid.github.io/blinkid-in-browser/examples/idbarcode/javascript/index.html)
-    * See example at [Codepen](https://codepen.io/microblink/pen/NWxVVJO)
 
 To see the source code of the above examples, check out the [examples directory](examples). If you'd like to run examples of the UI component, either through the browser or locally, see the [ui/examples](ui/examples) directory.
 
@@ -28,6 +40,7 @@ Please keep in mind that BlinkID In-browser SDK is meant to be used natively in
 ## Table of contents
 
 - [BlinkID In-browser SDK](#blinkid-in-browser-sdk)
+  - [How to run this repo?](#how-to-run-this-repo)
   - [Table of contents](#table-of-contents)
   - [ Components of SDK](#-components-of-sdk)
   - [ Integration instructions](#-integration-instructions)

examples/blinkid-camera/javascript/app.js

@@ -34,11 +34,11 @@ function main()
   }
 
   // 1. It's possible to obtain a free trial license key on microblink.com
-  let licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWKAs7Z4NIs/iGpU6wQaDlfio2nkr2dEiYqg91p4reekxEYOhlMyWHMOVcpvdIKMMBU8HHuwcUMjhdkvTwX4RXmVLkOEELJC6doX8UbN2jZ+XGUWe3JJCXtWEC+G77IVLjwx4qy6goHAEauCQKP9IH/tttDvv+FbnL0nJe2W/qewGJIyQpc3jmXEQoMC8paRomxjNu+8OIsVHttJLjyjz6DlZEsYyST6MnOmEvc0iyl1VlW4DdJe/gkHvurpcUWlBbITezOoFVqRl0Q90Yw14jw7NC2UWlYYOVITy1McNcR3dfxnFvWjrYw9X0afRsClQ=";
+  let licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWLEs7Z/qbNS0Lv5S3LqXJYzeYizBDKYF9b5XOl6glXcFZ5hHh8eSSwlNO1U5gTfj1RR4+jDMhXh+uQXHrPtAT/hHO8l/aSlX/r6I5jdUONJ4p2k9I2lPHRYIRDn452bSkniyuTcDR83oL9ps9dbNXMmaQ25+tla5+wZ8Ubw2HMfEh+eZ8ROP/4j9y4AtK49cN4KxOI0ge6DqBG1YrfMP4BGu/YcDfwPRIMVeT0jecrPkd8Q191+PNJDUgWw2MroMCtX4R8MzA1A1+qmzCA4+1CQKgQhRY8JPV4WhtK2cEe/hnuk5n5eU/pvbwX6bHkyo=";
 
   if (window.location.hostname === "blinkid.github.io")
   {
-    licenseKey = "sRwAAAYRYmxpbmtpZC5naXRodWIuaW+qBF9hPYYlTvZbRmaHBoPhixO6WCKIsUIZmGXNRYHpYC7rnoyHIpJEp25RajmjY0vxVjFbZNa00x0A16w/Hir6e18gfSDKmiZ95cEMiwkafve6nB/+et7uV248XpztK61b+WBjg5xD5Zhl3pena+qSm0dHNZakWJLPVbwHurdNhz8Yu939FM2DFeTZR4bie8fHxLueThPXO2UZFEQ/ZtoO7eu6DjjdRAe5I9H4CmXvS6uHVXjOFw0f/DyzgKwDpfF/zx76W/I+kP+dKo5lLpIM42Pz132Ozz5Evtola9mk4qTgwav7Nfdcn0sFpoqRR10RpDjLGNI88TO3UQ==";
+    licenseKey = "sRwAAAYRYmxpbmtpZC5naXRodWIuaW+qBF9hPYYlTvZbRmaDRoPhJOp2oExtMeLQkQgJgE+eDVhY3OTfpJcsDgROo8DnQUZ8RhkCGPZlokHeQgvTSPm6yRvotnaQV8AQP7HYR9IbHfodldfqlCGAWw+LtG0MMV9E/H4i0knaJZ9CfX6Ty2+dvqw8xPM1JWSrk/COOS34jJ57aovNd18+9qimphvJJlFSX2cnjnI41J0rlpG2vtX7+j/NlLuzxElSybEy5+480HFgus/RmUkSm2t1MM4m1WVMjOPQNqA4IP6gTUkNZ4NmV7IOuIMm6K2xEyJRx6Rtq2V2MW1pbHaA1fLtbwCzQIHXcaqAni8fx+TF/g==";
   }
 
   // 2. Create instance of SDK load settings with your license key

examples/blinkid-camera/javascript/index.html

@@ -24,6 +24,6 @@ <h1 id="msg">Loading...</h1>
     </body>
 
     <!-- Keep in mind that the jsDelivr CDN is used for demonstration, it's not intended to be used in production! -->
-    <script src="https://cdn.jsdelivr.net/npm/@microblink/blinkid-in-browser-sdk@6.10.1/dist/blinkid-sdk.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/@microblink/blinkid-in-browser-sdk@6.11.0/dist/blinkid-sdk.js"></script>
     <script src="app.js"></script>
 </html>

examples/blinkid-camera/typescript/package.json

@@ -19,6 +19,6 @@
     "typescript": "^3.9.5"
   },
   "dependencies": {
-    "@microblink/blinkid-in-browser-sdk": "~6.10.1"
+    "@microblink/blinkid-in-browser-sdk": "~6.11.0"
   }
 }

examples/blinkid-camera/typescript/src/app.ts

@@ -33,7 +33,7 @@ function main() {
     }
 
     // 1. It's possible to obtain a free trial license key on microblink.com
-    const licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWKAs7Z4NIs/iGpU6wQaDlfio2nkr2dEiYqg91p4reekxEYOhlMyWHMOVcpvdIKMMBU8HHuwcUMjhdkvTwX4RXmVLkOEELJC6doX8UbN2jZ+XGUWe3JJCXtWEC+G77IVLjwx4qy6goHAEauCQKP9IH/tttDvv+FbnL0nJe2W/qewGJIyQpc3jmXEQoMC8paRomxjNu+8OIsVHttJLjyjz6DlZEsYyST6MnOmEvc0iyl1VlW4DdJe/gkHvurpcUWlBbITezOoFVqRl0Q90Yw14jw7NC2UWlYYOVITy1McNcR3dfxnFvWjrYw9X0afRsClQ=";
+    const licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWLEs7Z/qbNS0Lv5S3LqXJYzeYizBDKYF9b5XOl6glXcFZ5hHh8eSSwlNO1U5gTfj1RR4+jDMhXh+uQXHrPtAT/hHO8l/aSlX/r6I5jdUONJ4p2k9I2lPHRYIRDn452bSkniyuTcDR83oL9ps9dbNXMmaQ25+tla5+wZ8Ubw2HMfEh+eZ8ROP/4j9y4AtK49cN4KxOI0ge6DqBG1YrfMP4BGu/YcDfwPRIMVeT0jecrPkd8Q191+PNJDUgWw2MroMCtX4R8MzA1A1+qmzCA4+1CQKgQhRY8JPV4WhtK2cEe/hnuk5n5eU/pvbwX6bHkyo=";
 
     // 2. Create instance of SDK load settings with your license key
     const loadSettings = new BlinkIDSDK.WasmSDKLoadSettings(licenseKey);

examples/blinkid-file/javascript/app.js

@@ -30,11 +30,11 @@ function main()
   }
 
   // 1. It's possible to obtain a free trial license key on microblink.com
-  let licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWKAs7Z4NIs/iGpU6wQaDlfio2nkr2dEiYqg91p4reekxEYOhlMyWHMOVcpvdIKMMBU8HHuwcUMjhdkvTwX4RXmVLkOEELJC6doX8UbN2jZ+XGUWe3JJCXtWEC+G77IVLjwx4qy6goHAEauCQKP9IH/tttDvv+FbnL0nJe2W/qewGJIyQpc3jmXEQoMC8paRomxjNu+8OIsVHttJLjyjz6DlZEsYyST6MnOmEvc0iyl1VlW4DdJe/gkHvurpcUWlBbITezOoFVqRl0Q90Yw14jw7NC2UWlYYOVITy1McNcR3dfxnFvWjrYw9X0afRsClQ=";
+  let licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWLEs7Z/qbNS0Lv5S3LqXJYzeYizBDKYF9b5XOl6glXcFZ5hHh8eSSwlNO1U5gTfj1RR4+jDMhXh+uQXHrPtAT/hHO8l/aSlX/r6I5jdUONJ4p2k9I2lPHRYIRDn452bSkniyuTcDR83oL9ps9dbNXMmaQ25+tla5+wZ8Ubw2HMfEh+eZ8ROP/4j9y4AtK49cN4KxOI0ge6DqBG1YrfMP4BGu/YcDfwPRIMVeT0jecrPkd8Q191+PNJDUgWw2MroMCtX4R8MzA1A1+qmzCA4+1CQKgQhRY8JPV4WhtK2cEe/hnuk5n5eU/pvbwX6bHkyo=";
 
   if (window.location.hostname === "blinkid.github.io")
   {
-    licenseKey = "sRwAAAYRYmxpbmtpZC5naXRodWIuaW+qBF9hPYYlTvZbRmaHBoPhixO6WCKIsUIZmGXNRYHpYC7rnoyHIpJEp25RajmjY0vxVjFbZNa00x0A16w/Hir6e18gfSDKmiZ95cEMiwkafve6nB/+et7uV248XpztK61b+WBjg5xD5Zhl3pena+qSm0dHNZakWJLPVbwHurdNhz8Yu939FM2DFeTZR4bie8fHxLueThPXO2UZFEQ/ZtoO7eu6DjjdRAe5I9H4CmXvS6uHVXjOFw0f/DyzgKwDpfF/zx76W/I+kP+dKo5lLpIM42Pz132Ozz5Evtola9mk4qTgwav7Nfdcn0sFpoqRR10RpDjLGNI88TO3UQ==";
+    licenseKey = "sRwAAAYRYmxpbmtpZC5naXRodWIuaW+qBF9hPYYlTvZbRmaDRoPhJOp2oExtMeLQkQgJgE+eDVhY3OTfpJcsDgROo8DnQUZ8RhkCGPZlokHeQgvTSPm6yRvotnaQV8AQP7HYR9IbHfodldfqlCGAWw+LtG0MMV9E/H4i0knaJZ9CfX6Ty2+dvqw8xPM1JWSrk/COOS34jJ57aovNd18+9qimphvJJlFSX2cnjnI41J0rlpG2vtX7+j/NlLuzxElSybEy5+480HFgus/RmUkSm2t1MM4m1WVMjOPQNqA4IP6gTUkNZ4NmV7IOuIMm6K2xEyJRx6Rtq2V2MW1pbHaA1fLtbwCzQIHXcaqAni8fx+TF/g==";
   }
 
   // 2. Create instance of SDK load settings with your license key

examples/blinkid-file/javascript/index.html

@@ -23,6 +23,6 @@ <h1>Processing...</h1>
     </body>
 
     <!-- Keep in mind that the jsDelivr CDN is used for demonstration, it's not intended to be used in production! -->
-    <script src="https://cdn.jsdelivr.net/npm/@microblink/blinkid-in-browser-sdk@6.10.1/dist/blinkid-sdk.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/@microblink/blinkid-in-browser-sdk@6.11.0/dist/blinkid-sdk.js"></script>
     <script src="app.js"></script>
 </html>

examples/blinkid-file/typescript/package.json

@@ -19,6 +19,6 @@
     "typescript": "^3.9.5"
   },
   "dependencies": {
-    "@microblink/blinkid-in-browser-sdk": "~6.10.1"
+    "@microblink/blinkid-in-browser-sdk": "~6.11.0"
   }
 }

examples/blinkid-file/typescript/src/app.ts

@@ -29,7 +29,7 @@ function main() {
     }
 
     // 1. It's possible to obtain a free trial license key on microblink.com
-    const licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWKAs7Z4NIs/iGpU6wQaDlfio2nkr2dEiYqg91p4reekxEYOhlMyWHMOVcpvdIKMMBU8HHuwcUMjhdkvTwX4RXmVLkOEELJC6doX8UbN2jZ+XGUWe3JJCXtWEC+G77IVLjwx4qy6goHAEauCQKP9IH/tttDvv+FbnL0nJe2W/qewGJIyQpc3jmXEQoMC8paRomxjNu+8OIsVHttJLjyjz6DlZEsYyST6MnOmEvc0iyl1VlW4DdJe/gkHvurpcUWlBbITezOoFVqRl0Q90Yw14jw7NC2UWlYYOVITy1McNcR3dfxnFvWjrYw9X0afRsClQ=";
+    const licenseKey = "sRwAAAYJbG9jYWxob3N0r/lOPk4/w35CpJlWLEs7Z/qbNS0Lv5S3LqXJYzeYizBDKYF9b5XOl6glXcFZ5hHh8eSSwlNO1U5gTfj1RR4+jDMhXh+uQXHrPtAT/hHO8l/aSlX/r6I5jdUONJ4p2k9I2lPHRYIRDn452bSkniyuTcDR83oL9ps9dbNXMmaQ25+tla5+wZ8Ubw2HMfEh+eZ8ROP/4j9y4AtK49cN4KxOI0ge6DqBG1YrfMP4BGu/YcDfwPRIMVeT0jecrPkd8Q191+PNJDUgWw2MroMCtX4R8MzA1A1+qmzCA4+1CQKgQhRY8JPV4WhtK2cEe/hnuk5n5eU/pvbwX6bHkyo=";
 
     // 2. Create instance of SDK load settings with your license key
     const loadSettings = new BlinkIDSDK.WasmSDKLoadSettings(licenseKey);