Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

blinkid-react-native

Package Overview
Dependencies
Maintainers
9
Versions
62
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

blinkid-react-native - npm Package Compare versions

Comparing version 5.2.0 to 5.3.0

recognizers/idBarcodeRecognizer.js

1

index.js

@@ -121,2 +121,3 @@ 'use strict';

export * from './recognizers/documentFaceRecognizer'
export * from './recognizers/idBarcodeRecognizer'
export * from './recognizers/mrtdCombinedRecognizer'

@@ -123,0 +124,0 @@ export * from './recognizers/mrtdRecognizer'

@@ -20,2 +20,79 @@ import { OverlaySettings } from '../overlaySettings'

super('BlinkIdOverlaySettings');
/**
* String: message that is shown while scanning first side of the document.
* If null, default value will be used.
*/
this.firstSideInstructionsText = null;
/**
* String: instructions to flip document, shown when scanning of the first side is done, before scanning the second
* side of the document.
* If null, default value will be used.
*/
this.flipInstructions = null;
/**
* String: instructions for the user to move the document closer.
* If null, default value will be used.
*/
this.errorMoveCloser = null;
/**
* String: instructions for the user to move the document farther.
* If null, default value will be used.
*/
this.errorMoveFarther = null;
/**
* String: title of the dialog, which is shown when scanned document sides are not from the same document.
* If null, default value will be used.
*/
this.sidesNotMatchingTitle = null;
/**
* String: message inside dialog, which is shown when scanned document sides are not from the same document.
* If null, default value will be used.
*/
this.sidesNotMatchingMessage = null;
/**
* String: title of the dialog, which is shown when unsupported document is scanned.
* If null, default value will be used.
*/
this.unsupportedDocumentTitle = null;
/**
* String: message inside dialog, which is shown when unsupported document is scanned.
* If null, default value will be used.
*/
this.unsupportedDocumentMessage = null;
/**
* String: title of the dialog, which is shown on timeout when scanning is stuck on the back document side.
* If null, default value will be used.
*/
this.recognitionTimeoutTitle = null;
/**
* String: message inside dialog, which is shown on timeout when scanning is stuck on the back document side.
* If null, default value will be used.
*/
this.recognitionTimeoutMessage = null;
/**
* String: text of the "retry" button inside dialog, which is shown on timeout when scanning is stuck on the back
* document side.
*/
this.retryButtonText = null;
/**
* If true, BlinkIdCombinedRecognizer will check if sides do match when scanning is finished
* Default: true
*/
this.requireDocumentSidesDataMatch = true;
/**
* Defines whether Document Not Supported dialog will be displayed in UI.
*
* Default: true
*/
this.showNotSupportedDialog = true;
/**
* Option to configure back side scanning timeout.
*
* Default: 17000
*/
this.backSideScanningTimeoutMilliseconds = 17000;
}

@@ -22,0 +99,0 @@ }

2

package.json
{
"name": "blinkid-react-native",
"version": "5.2.0",
"version": "5.3.0",
"description": "A small and powerful ID card scanning library. Powered by Microblink (www.microblink.com).",

@@ -5,0 +5,0 @@ "main": "index.js",

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* The additional address information of the document owner.
* The additional address information of the document owner.
*/

@@ -53,2 +53,7 @@ this.additionalAddressInformation = nativeResult.additionalAddressInformation;

/**
* Determines if date of expiry is permanent.
*/
this.dateOfExpiryPermanent = nativeResult.dateOfExpiryPermanent;
/**
* The date of issue of the document.

@@ -59,3 +64,3 @@ */

/**
* 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.
*/

@@ -65,3 +70,3 @@ 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.
*/

@@ -79,3 +84,3 @@ this.digitalSignatureVersion = nativeResult.digitalSignatureVersion;

* of the document and values do not match, this method will return DataMatchResultFailed. Result will
* be DataMatchResultSuccess only if scanned values for all fields that are compared are the same.
* be DataMatchResultSuccess only if scanned values for all fields that are compared are the same.
*/

@@ -100,3 +105,3 @@ this.documentDataMatch = nativeResult.documentDataMatch;

/**
* face image from the document if enabled with returnFaceImage property.
* face image from the document if enabled with returnFaceImage property.
*/

@@ -111,3 +116,3 @@ this.faceImage = nativeResult.faceImage;

/**
* back side image of the document if enabled with returnFullDocumentImage property.
* back side image of the document if enabled with returnFullDocumentImage property.
*/

@@ -117,3 +122,3 @@ this.fullDocumentBackImage = nativeResult.fullDocumentBackImage;

/**
* front side image of the document if enabled with returnFullDocumentImage property.
* front side image of the document if enabled with returnFullDocumentImage property.
*/

@@ -148,3 +153,3 @@ this.fullDocumentFrontImage = nativeResult.fullDocumentFrontImage;

/**
* The data extracted from the machine readable zone
* The data extracted from the machine readable zone
*/

@@ -190,3 +195,3 @@ this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;

* 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.
*/

@@ -212,4 +217,4 @@ this.scanningFirstSideDone = nativeResult.scanningFirstSideDone;

* Defines whether blured frames filtering is allowed
*
*
*
*
*/

@@ -219,6 +224,21 @@ this.allowBlurFilter = true;

/**
* Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed
*
*
*/
this.allowUnparsedMrzResults = false;
/**
* Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed
* Unverified MRZ is parsed, but check digits are incorrect
*
*
*/
this.allowUnverifiedMrzResults = true;
/**
* Property for setting DPI for face images
* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -230,4 +250,4 @@ this.faceImageDpi = 250;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -238,5 +258,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -247,4 +267,4 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* Sets whether face image from ID card should be extracted
*
*
*
*
*/

@@ -255,4 +275,4 @@ this.returnFaceImage = false;

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -263,4 +283,4 @@ this.returnFullDocumentImage = false;

* Whether or not recognition result should be signed.
*
*
*
*
*/

@@ -267,0 +287,0 @@ this.signResult = false;

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* The additional address information of the document owner.
* The additional address information of the document owner.
*/

@@ -53,2 +53,7 @@ this.additionalAddressInformation = nativeResult.additionalAddressInformation;

/**
* Determines if date of expiry is permanent.
*/
this.dateOfExpiryPermanent = nativeResult.dateOfExpiryPermanent;
/**
* The date of issue of the document.

@@ -79,3 +84,3 @@ */

/**
* face image from the document if enabled with returnFaceImage property.
* face image from the document if enabled with returnFaceImage property.
*/

@@ -90,3 +95,3 @@ this.faceImage = nativeResult.faceImage;

/**
* full document image if enabled with returnFullDocumentImage property.
* full document image if enabled with returnFullDocumentImage property.
*/

@@ -121,3 +126,3 @@ this.fullDocumentImage = nativeResult.fullDocumentImage;

/**
* The data extracted from the machine readable zone
* The data extracted from the machine readable zone
*/

@@ -178,4 +183,4 @@ this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;

* Defines whether blured frames filtering is allowed
*
*
*
*
*/

@@ -185,6 +190,21 @@ this.allowBlurFilter = true;

/**
* Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed
*
*
*/
this.allowUnparsedMrzResults = false;
/**
* Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed
* Unverified MRZ is parsed, but check digits are incorrect
*
*
*/
this.allowUnverifiedMrzResults = true;
/**
* Property for setting DPI for face images
* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -196,4 +216,4 @@ this.faceImageDpi = 250;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -204,5 +224,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -213,4 +233,4 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* Sets whether face image from ID card should be extracted
*
*
*
*
*/

@@ -221,4 +241,4 @@ this.returnFaceImage = false;

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -225,0 +245,0 @@ this.returnFullDocumentImage = false;

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* Quadrangle represeting corner points of the document within the input image.
* Quadrangle represeting corner points of the document within the input image.
*/

@@ -28,3 +28,3 @@ this.documentLocation = nativeResult.documentLocation != null ? new Quadrilateral(nativeResult.documentLocation) : null;

/**
* face image from the document if enabled with returnFaceImage property.
* face image from the document if enabled with returnFaceImage property.
*/

@@ -34,3 +34,3 @@ this.faceImage = nativeResult.faceImage;

/**
* Quadrangle represeting corner points of the face image within the input image.
* Quadrangle represeting corner points of the face image within the input image.
*/

@@ -40,3 +40,3 @@ this.faceLocation = nativeResult.faceLocation != null ? new Quadrilateral(nativeResult.faceLocation) : null;

/**
* full document image if enabled with returnFullDocumentImage property.
* full document image if enabled with returnFullDocumentImage property.
*/

@@ -50,3 +50,3 @@ this.fullDocumentImage = nativeResult.fullDocumentImage;

* Class for configuring Document Face Recognizer Recognizer.
*
*
* Document Face Recognizer recognizer is used for scanning documents containing face images.

@@ -60,4 +60,4 @@ */

* Type of docment this recognizer will scan.
*
*
*
*
*/

@@ -69,4 +69,4 @@ this.detectorType = DocumentFaceDetectorType.TD1;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -78,4 +78,4 @@ this.faceImageDpi = 250;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -86,5 +86,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -96,6 +96,6 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* returns this document as a result of the deteciton
*
*
* Higher number means more reliable detection, but slower processing
*
*
*
*
*/

@@ -106,4 +106,4 @@ this.numStableDetectionsThreshold = 6;

* Sets whether face image from ID card should be extracted
*
*
*
*
*/

@@ -114,4 +114,4 @@ this.returnFaceImage = false;

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -118,0 +118,0 @@ this.returnFullDocumentImage = false;

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* 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.
*/

@@ -28,3 +28,3 @@ 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.
*/

@@ -37,3 +37,3 @@ this.digitalSignatureVersion = nativeResult.digitalSignatureVersion;

* of the document and values do not match, this method will return DataMatchResultFailed. Result will
* be DataMatchResultSuccess only if scanned values for all fields that are compared are the same.
* be DataMatchResultSuccess only if scanned values for all fields that are compared are the same.
*/

@@ -43,3 +43,3 @@ this.documentDataMatch = nativeResult.documentDataMatch;

/**
* face image from the document if enabled with returnFaceImage property.
* face image from the document if enabled with returnFaceImage property.
*/

@@ -49,3 +49,3 @@ this.faceImage = nativeResult.faceImage;

/**
* back side image of the document if enabled with returnFullDocumentImage property.
* back side image of the document if enabled with returnFullDocumentImage property.
*/

@@ -55,3 +55,3 @@ this.fullDocumentBackImage = nativeResult.fullDocumentBackImage;

/**
* front side image of the document if enabled with returnFullDocumentImage property.
* front side image of the document if enabled with returnFullDocumentImage property.
*/

@@ -61,3 +61,3 @@ this.fullDocumentFrontImage = nativeResult.fullDocumentFrontImage;

/**
* Returns the Data extracted from the machine readable zone.
* Returns the Data extracted from the machine readable zone.
*/

@@ -68,3 +68,3 @@ this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;

* 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.
*/

@@ -78,3 +78,3 @@ this.scanningFirstSideDone = nativeResult.scanningFirstSideDone;

* MRTD Combined recognizer
*
*
* MRTD Combined recognizer is used for scanning both front and back side of generic IDs.

@@ -88,4 +88,4 @@ */

* Whether special characters are allowed
*
*
*
*
*/

@@ -96,4 +96,4 @@ this.allowSpecialCharacters = false;

* Whether returning of unparsed results is allowed
*
*
*
*
*/

@@ -105,4 +105,4 @@ this.allowUnparsedResults = false;

* Unverified result is result that is parsed, but check digits are incorrect.
*
*
*
*
*/

@@ -113,4 +113,4 @@ this.allowUnverifiedResults = false;

* Type of document this recognizer will scan.
*
*
*
*
*/

@@ -122,4 +122,4 @@ this.detectorType = DocumentFaceDetectorType.TD1;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -131,4 +131,4 @@ this.faceImageDpi = 250;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -139,5 +139,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -149,6 +149,6 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* returns this document as a result of the deteciton
*
*
* Higher number means more reliable detection, but slower processing
*
*
*
*
*/

@@ -159,4 +159,4 @@ this.numStableDetectionsThreshold = 6;

* Sets whether face image from ID card should be extracted
*
*
*
*
*/

@@ -167,4 +167,4 @@ this.returnFaceImage = false;

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -175,4 +175,4 @@ this.returnFullDocumentImage = false;

* Whether or not recognition result should be signed.
*
*
*
*
*/

@@ -179,0 +179,0 @@ this.signResult = false;

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* full document image if enabled with returnFullDocumentImage property.
* full document image if enabled with returnFullDocumentImage property.
*/

@@ -28,3 +28,3 @@ this.fullDocumentImage = nativeResult.fullDocumentImage;

/**
* Returns the Data extracted from the machine readable zone.
* Returns the Data extracted from the machine readable zone.
*/

@@ -45,4 +45,4 @@ this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;

* Whether special characters are allowed
*
*
*
*
*/

@@ -53,4 +53,4 @@ this.allowSpecialCharacters = false;

* Whether returning of unparsed results is allowed
*
*
*
*
*/

@@ -62,4 +62,4 @@ this.allowUnparsedResults = false;

* Unverified result is result that is parsed, but check digits are incorrect.
*
*
*
*
*/

@@ -70,4 +70,4 @@ this.allowUnverifiedResults = false;

* Defines if glare detection should be turned on/off.
*
*
*
*
*/

@@ -79,4 +79,4 @@ this.detectGlare = true;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -87,5 +87,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -96,4 +96,4 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -100,0 +100,0 @@ this.returnFullDocumentImage = false;

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* face image from the document if enabled with returnFaceImage property.
* face image from the document if enabled with returnFaceImage property.
*/

@@ -28,3 +28,3 @@ this.faceImage = nativeResult.faceImage;

/**
* full document image if enabled with returnFullDocumentImage property.
* full document image if enabled with returnFullDocumentImage property.
*/

@@ -50,4 +50,4 @@ this.fullDocumentImage = nativeResult.fullDocumentImage;

* Defines whether to anonymize Netherlands MRZ
*
*
*
*
*/

@@ -58,4 +58,4 @@ this.anonymizeNetherlandsMrz = true;

* Defines if glare detection should be turned on/off.
*
*
*
*
*/

@@ -67,4 +67,4 @@ this.detectGlare = true;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -76,4 +76,4 @@ this.faceImageDpi = 250;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -84,5 +84,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -93,4 +93,4 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* Sets whether face image from ID card should be extracted
*
*
*
*
*/

@@ -101,4 +101,4 @@ this.returnFaceImage = false;

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -105,0 +105,0 @@ this.returnFullDocumentImage = false;

@@ -22,3 +22,3 @@ import { Recognizer, RecognizerResult } from '../recognizer'

/**
* face image from the document if enabled with returnFaceImage property.
* face image from the document if enabled with returnFaceImage property.
*/

@@ -28,3 +28,3 @@ this.faceImage = nativeResult.faceImage;

/**
* full document image if enabled with returnFullDocumentImage property.
* full document image if enabled with returnFullDocumentImage property.
*/

@@ -50,4 +50,4 @@ this.fullDocumentImage = nativeResult.fullDocumentImage;

* Defines if glare detection should be turned on/off.
*
*
*
*
*/

@@ -59,4 +59,4 @@ this.detectGlare = true;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -68,4 +68,4 @@ this.faceImageDpi = 250;

* Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
*
*
*
*
*/

@@ -76,5 +76,5 @@ this.fullDocumentImageDpi = 250;

* Image extension factors for full document image.
*
*
* @see ImageExtensionFactors
*
*
*/

@@ -85,4 +85,4 @@ this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();

* Sets whether face image from ID card should be extracted
*
*
*
*
*/

@@ -93,4 +93,4 @@ this.returnFaceImage = false;

* Sets whether full document image of ID card should be extracted.
*
*
*
*
*/

@@ -97,0 +97,0 @@ this.returnFullDocumentImage = false;

@@ -64,2 +64,30 @@ /**

/**
* Possible types of documents scanned with IdBarcodeRecognizer.
*/
export const IdBarcodeDocumentType = Object.freeze(
{
/** No document was scanned */
None: 1,
/** AAMVACompliant document was scanned */
AAMVACompliant: 2,
/** Argentina ID document was scanned */
ArgentinaID: 3,
/** Argentina driver license document was scanned */
ArgentinaDL: 4,
/** Colombia ID document was scanned */
ColombiaID: 5,
/** Colombia driver license document was scanned */
ColombiaDL: 6,
/** NigeriaVoter ID document was scanned */
NigeriaVoterID: 7,
/** Nigeria driver license document was scanned */
NigeriaDL: 8,
/** Panama ID document was scanned */
PanamaID: 9,
/** SouthAfrica ID document was scanned */
SouthAfricaID: 10
}
);
/**
* Represents data extracted from MRZ (Machine Readable Zone) of Machine Readable Travel Document (MRTD).

@@ -66,0 +94,0 @@ */

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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc