blinkid-react-native
Advanced tools
Comparing version 5.7.2 to 5.8.0
@@ -41,4 +41,2 @@ 'use strict'; | ||
try { | ||
var bla = NativeModules; | ||
console.log(bla); | ||
var licenseObject = license; | ||
@@ -45,0 +43,0 @@ if (typeof license === 'string' || license instanceof String) { |
@@ -91,2 +91,9 @@ import { OverlaySettings } from '../overlaySettings' | ||
/** | ||
* Defines whether glare warning will be displayed when user turn on a flashlight | ||
* | ||
* Default: true | ||
*/ | ||
this.showFlashlightWarning = true; | ||
/** | ||
* Option to configure back side scanning timeout. | ||
@@ -120,3 +127,3 @@ * | ||
super('DocumentVerificationOverlaySettings'); | ||
/** | ||
/** | ||
* String: splash message that is shown before scanning the first side of the document, while starting camera. | ||
@@ -126,3 +133,3 @@ * If null, default value will be used. | ||
this.firstSideSplashMessage = null; | ||
/** | ||
/** | ||
* String: splash message that is shown before scanning the second side of the document, while starting camera. | ||
@@ -132,3 +139,3 @@ * If null, default value will be used. | ||
this.secondSideSplashMessage = null; | ||
/** | ||
/** | ||
* String: splash message that is shown after scanning the document. | ||
@@ -138,3 +145,3 @@ * If null, default value will be used. | ||
this.scanningDoneSplashMessage = null; | ||
/** | ||
/** | ||
* String: user instructions that are shown above camera preview while the first side of the | ||
@@ -145,3 +152,3 @@ * document is being scanned. | ||
this.firstSideInstructions = null; | ||
/** | ||
/** | ||
* String: user instructions that are shown above camera preview while the second side of the | ||
@@ -158,2 +165,2 @@ * document is being scanned. | ||
} | ||
} | ||
} |
{ | ||
"name": "blinkid-react-native", | ||
"version": "5.7.2", | ||
"version": "5.8.0", | ||
"description": "A small and powerful ID card scanning library. Powered by Microblink (www.microblink.com).", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
# BlinkID SDK wrapper for React Native | ||
This repository contains example wrapper for BlinkID native SDK for [Android](https://github.com/BlinkID/blinkid-android) and [iOS](https://github.com/BlinkID/blinkid-ios). For 100% of features and maximum control, consider using native SDK. | ||
Best-in-class ID scanning software for cross-platform apps built with React Native. | ||
Below, you’ll find a quick guide on starting your own demo project as well as complete guidance on installing and linking BlinkID library with your iOS and Android apps ⬇️ | ||
### Licensing | ||
For a full access to all features and functionalities, please consider using our native SDKs (for [iOS](https://github.com/BlinkID/blinkid-ios) or [Android](https://github.com/BlinkID/blinkid-android)) | ||
## Licensing | ||
- [Generate](https://microblink.com/login?url=/customer/generatedemolicence) a **free trial license key** to start using the SDK in your app (registration required) | ||
@@ -14,3 +18,3 @@ | ||
BlinkID React Native was built and tested with [React Native v0.62.2](https://github.com/facebook/react-native/releases/tag/v0.62.2) | ||
BlinkID React Native was built and tested with [React Native v0.63.2](https://github.com/facebook/react-native/releases/tag/v0.63.2) | ||
@@ -22,3 +26,3 @@ ## Installation | ||
```shell | ||
react-native init --version="0.61.5" NameOfYourProject | ||
react-native init --version="0.63.2" NameOfYourProject | ||
``` | ||
@@ -86,7 +90,7 @@ | ||
## Demo | ||
## Sample | ||
This repository contains **initReactNativeDemoApp.sh** script that will create React Native project and download all of its dependencies. You can run this script with following command: | ||
This repository contains **initReactNativeSampleApp.sh** script that will create React Native project and download all of its dependencies. You can run this script with following command: | ||
```shell | ||
./initReactNativeDemoApp.sh | ||
./initReactNativeSampleApp.sh | ||
``` | ||
@@ -96,3 +100,3 @@ | ||
Step by step guide how to start blinkid-reactnative demo app. A tutorial flows from cloning repository via git clone to successfully deployed demo application on Android and iOS device with real-time screen mirroring. Application demo contains the simple use of USDL recognizer with Ontario drivers license card. | ||
Step by step guide how to start blinkid-reactnative sample app. A tutorial flows from cloning repository via git clone to successfully deployed sample application on Android and iOS device with real-time screen mirroring. Application sample contains the simple use of USDL recognizer with Ontario drivers license card. | ||
@@ -120,3 +124,3 @@ <p align="center" > | ||
To use the module you call it in your index.android.js or index.ios.js file like in the [example app](demoApp/index.js). Available recognizers and API documentation is available in [JS API files](BlinkID). | ||
To use the module you call it in your index.android.js or index.ios.js file like in the [sample app](SampleFiles/index.js). Available recognizers and API documentation is available in [JS API files](BlinkID). | ||
@@ -123,0 +127,0 @@ ## FAQ |
@@ -256,2 +256,7 @@ import { Recognizer, RecognizerResult } from '../recognizer' | ||
/** | ||
* image of the signature if enabled with returnSignatureImage property. | ||
*/ | ||
this.signatureImage = nativeResult.signatureImage; | ||
} | ||
@@ -352,2 +357,9 @@ } | ||
/** | ||
* Sets whether signature image from ID card should be extracted. | ||
* | ||
* | ||
*/ | ||
this.returnSignatureImage = false; | ||
/** | ||
* Whether or not recognition result should be signed. | ||
@@ -360,2 +372,10 @@ * | ||
/** | ||
* Property for setting DPI for signature images | ||
* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception | ||
* | ||
* | ||
*/ | ||
this.signatureImageDpi = 250; | ||
/** | ||
* Skip back side capture and processing step when back side of the document is not supported | ||
@@ -362,0 +382,0 @@ * |
@@ -213,2 +213,7 @@ import { Recognizer, RecognizerResult } from '../recognizer' | ||
/** | ||
* image of the signature if enabled with returnSignatureImage property. | ||
*/ | ||
this.signatureImage = nativeResult.signatureImage; | ||
/** | ||
* Defines the data extracted from the visual inspection zone | ||
@@ -313,2 +318,17 @@ */ | ||
/** | ||
* Sets whether signature image from ID card should be extracted. | ||
* | ||
* | ||
*/ | ||
this.returnSignatureImage = false; | ||
/** | ||
* Property for setting DPI for signature images | ||
* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception | ||
* | ||
* | ||
*/ | ||
this.signatureImageDpi = 250; | ||
/** | ||
* Defines whether result characters validatation is performed. | ||
@@ -315,0 +335,0 @@ * If a result member contains invalid character, the result state cannot be valid |
@@ -142,2 +142,7 @@ import { Recognizer, RecognizerResult } from '../recognizer' | ||
/** | ||
* The middle name of the document owner. | ||
*/ | ||
this.middleName = nativeResult.middleName; | ||
/** | ||
* The nationality of the documet owner. | ||
@@ -144,0 +149,0 @@ */ |
@@ -13,46 +13,46 @@ import { Recognizer, RecognizerResult } from '../recognizer' | ||
super(nativeResult.resultState); | ||
/** | ||
* Digital signature of the recognition result. Available only if enabled with signResult property. | ||
/** | ||
* Digital signature of the recognition result. Available only if enabled with signResult property. | ||
*/ | ||
this.digitalSignature = nativeResult.digitalSignature; | ||
/** | ||
* Version of the digital signature. Available only if enabled with signResult property. | ||
/** | ||
* Version of the digital signature. Available only if enabled with signResult property. | ||
*/ | ||
this.digitalSignatureVersion = nativeResult.digitalSignatureVersion; | ||
/** | ||
/** | ||
* Returns true if data from scanned parts/sides of the document match, | ||
* false otherwise. For example if date of expiry is scanned from the front and back side | ||
* of the document and values do not match, this method will return false. Result will | ||
* be true only if scanned values for all fields that are compared are the same. | ||
* be true only if scanned values for all fields that are compared are the same. | ||
*/ | ||
this.documentDataMatch = nativeResult.documentDataMatch; | ||
/** | ||
* face image from the document if enabled with returnFaceImage property. | ||
/** | ||
* face image from the document if enabled with returnFaceImage property. | ||
*/ | ||
this.faceImage = nativeResult.faceImage; | ||
/** | ||
* full document image if enabled with returnFullDocumentImage property. | ||
/** | ||
* full document image if enabled with returnFullDocumentImage property. | ||
*/ | ||
this.fullDocumentImage = nativeResult.fullDocumentImage; | ||
/** | ||
/** | ||
* Returns true if recognizer has finished scanning first side and is now scanning back side, | ||
* false if it's still scanning first side. | ||
* false if it's still scanning first side. | ||
*/ | ||
this.scanningFirstSideDone = nativeResult.scanningFirstSideDone; | ||
/** Array of elements that are not part of AAMVA standard and are specific to each US state. */ | ||
this.optionalElements = nativeResult.optionalElements; | ||
/** The raw bytes contained inside 2D barcode. */ | ||
this.rawData = nativeResult.rawData; | ||
/** Raw string inside 2D barcode. */ | ||
this.rawStringData = nativeResult.rawStringData; | ||
/** True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. */ | ||
@@ -67,2 +67,5 @@ this.uncertain = nativeResult.uncertain; | ||
/** The middle name of the United States driver license owner. */ | ||
this.middleName = nativeResult.middleName; | ||
/** The last name of the United States driver license owner. */ | ||
@@ -74,2 +77,5 @@ this.lastName = nativeResult.lastName; | ||
/** The name suffix of the United States driver license owner. */ | ||
this.nameSuffix = nativeResult.nameSuffix; | ||
/** The full address of the United States driver license owner. */ | ||
@@ -113,3 +119,3 @@ this.address = nativeResult.address; | ||
* USDL Combined Recognizer. | ||
* | ||
* | ||
* USDL Combined recognizer is used for scanning both front and back side of US Driver's License. | ||
@@ -120,52 +126,52 @@ */ | ||
super('UsdlCombinedRecognizer'); | ||
/** | ||
/** | ||
* Property for setting DPI for face images | ||
* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception | ||
* | ||
* | ||
* | ||
* | ||
*/ | ||
this.faceImageDpi = 250; | ||
/** | ||
/** | ||
* Property for setting DPI for full document images | ||
* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception | ||
* | ||
* | ||
* | ||
* | ||
*/ | ||
this.fullDocumentImageDpi = 250; | ||
/** | ||
/** | ||
* Sets whether face image from ID card should be extracted | ||
* | ||
* | ||
* | ||
* | ||
*/ | ||
this.returnFaceImage = false; | ||
/** | ||
/** | ||
* Sets whether full document image of ID card should be extracted. | ||
* | ||
* | ||
* | ||
* | ||
*/ | ||
this.returnFullDocumentImage = false; | ||
/** | ||
* The extension factors for full document image. | ||
/** | ||
* The extension factors for full document image. | ||
*/ | ||
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors(); | ||
/** | ||
* Minimum number of stable detections required for detection to be successful. | ||
/** | ||
* Minimum number of stable detections required for detection to be successful. | ||
*/ | ||
this.numStableDetectionsThreshold = 6; | ||
/** | ||
/** | ||
* Whether or not recognition result should be signed. | ||
* | ||
* | ||
* | ||
* | ||
*/ | ||
this.signResult = false; | ||
this.createResultFromNative = function (nativeResult) { return new UsdlCombinedRecognizerResult(nativeResult); } | ||
} | ||
} | ||
} |
@@ -12,12 +12,12 @@ import { Recognizer, RecognizerResult } from '../recognizer' | ||
super(nativeResult.resultState); | ||
/** Array of elements that are not part of AAMVA standard and are specific to each US state. */ | ||
this.optionalElements = nativeResult.optionalElements; | ||
/** The raw bytes contained inside 2D barcode. */ | ||
this.rawData = nativeResult.rawData; | ||
/** Raw string inside 2D barcode. */ | ||
this.rawStringData = nativeResult.rawStringData; | ||
/** True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. */ | ||
@@ -32,2 +32,5 @@ this.uncertain = nativeResult.uncertain; | ||
/** The middle name of the United States driver license owner. */ | ||
this.middleName = nativeResult.middleName; | ||
/** The last name of the United States driver license owner. */ | ||
@@ -39,2 +42,5 @@ this.lastName = nativeResult.lastName; | ||
/** The name suffix of the United States driver license owner. */ | ||
this.nameSuffix = nativeResult.nameSuffix; | ||
/** The full address of the United States driver license owner. */ | ||
@@ -73,3 +79,3 @@ this.address = nativeResult.address; | ||
this.age = nativeResult.age; | ||
/** The street address portion of the United States driver license owner. */ | ||
@@ -95,6 +101,6 @@ this.street = nativeResult.street; | ||
super('UsdlRecognizer'); | ||
/** Allow scanning PDF417 barcodes which don't have quiet zone */ | ||
this.nullQuietZoneAllowed = true; | ||
/** Enable decoding of non-standard PDF417 barcodes, but without */ | ||
@@ -105,3 +111,3 @@ this.uncertainDecoding = true; | ||
this.enableCompactParser = false; | ||
this.createResultFromNative = function (nativeResult) { return new UsdlRecognizerResult(nativeResult); } | ||
@@ -1010,2 +1016,2 @@ } | ||
} | ||
); | ||
); |
31
types.js
@@ -307,3 +307,5 @@ /** | ||
ElSalvador: 89, | ||
SriLanka: 90 | ||
SriLanka: 90, | ||
Peru: 91, | ||
Uruguay: 92 | ||
} | ||
@@ -385,3 +387,7 @@ ); | ||
Wyoming: 68, | ||
Yukon: 69 | ||
Yukon: 69, | ||
CiudadDeMexico: 70, | ||
Jalisco: 71, | ||
NewfoundlandAndLabrador: 72, | ||
NuevoLeon: 73 | ||
} | ||
@@ -399,9 +405,9 @@ ); | ||
DlPublicServicesCard: 4, | ||
FinCard: 5, | ||
EmploymentPass: 6, | ||
GreenCard: 7, | ||
Id: 8, | ||
MultipurposeId: 9, | ||
MyKad: 10, | ||
MyKid: 11, | ||
EmploymentPass: 5, | ||
FinCard: 6, | ||
Id: 7, | ||
MultipurposeId: 8, | ||
MyKad: 9, | ||
MyKid: 10, | ||
MyPr: 11, | ||
MyTentera: 12, | ||
@@ -420,3 +426,5 @@ PanCard: 13, | ||
SocialSecurityCard: 24, | ||
HealthInsuranceCard: 25 | ||
HealthInsuranceCard: 25, | ||
Passport: 26, | ||
SPass: 27 | ||
} | ||
@@ -444,2 +452,5 @@ ); | ||
/** The middle name of the document owner. */ | ||
this.middleName = nativeBarcodeResult.middleName; | ||
/** The last name of the document owner. */ | ||
@@ -446,0 +457,0 @@ this.lastName = nativeBarcodeResult.lastName; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
409973
99
3276
147