New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

blinkid-react-native

Package Overview
Dependencies
Maintainers
9
Versions
64
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.8.1 to 5.9.0

src/ios/MicroblinkModule/MicroblinkModule.xcodeproj/xcuserdata/juraskrlec.xcuserdatad/xcschemes/xcschememanagement.plist

12

index.js

@@ -13,3 +13,3 @@ 'use strict';

/**
* This exposes the appropriate native BlinkID module module as a JS module, based on
* This exposes the appropriate native BlinkID module module as a JS module, based on
* detected platform: Android or iOS. This has functions:

@@ -56,3 +56,3 @@ * -> 'scanWithCamera' which takes the following parameters:

// unlike Cordova, ReactNative does not allow mutation of user-provided recognizers, so we need to
// unlike Cordova, ReactNative does not allow mutation of user-provided recognizers, so we need to
// return results and let user handle them manually.

@@ -62,3 +62,3 @@ let result = recognizerCollection.recognizerArray[i].createResultFromNative(nativeResults[i]);

results.push(result);
}
}
}

@@ -83,3 +83,3 @@ return results;

/**
*
*
* @param recognizerArray Array of recognizer objects that will be used for recognition. Must not be empty!

@@ -90,6 +90,6 @@ */

this.recognizerArray = recognizerArray;
/**
/**
* Whether or not it is allowed for multiple recognizers to process the same image.
* If not, then first recognizer that will be successful in processing the image will
* end the processing chain and other recognizers will not get the chance to process
* end the processing chain and other recognizers will not get the chance to process
* that image.

@@ -96,0 +96,0 @@ */

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

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

@@ -23,3 +23,4 @@ /**

/** Recognizer result contains all required values */
valid : 3
valid : 3,
stageValid: 4
}

@@ -34,7 +35,7 @@ );

constructor(resultState) {
/**
* State of the result. It is always one of the values represented by RecognizerResultState enum
/**
* State of the result. It is always one of the values represented by RecognizerResultState enum
*/
this.resultState = resultState;
}
}
}
import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,103 +29,108 @@

/**
* The additional address information of the document owner.
/**
* The additional address information of the document owner.
*/
this.additionalAddressInformation = nativeResult.additionalAddressInformation;
/**
* The additional name information of the document owner.
/**
* The additional name information of the document owner.
*/
this.additionalNameInformation = nativeResult.additionalNameInformation;
/**
* The address of the document owner.
/**
* The address of the document owner.
*/
this.address = nativeResult.address;
/**
/**
* The current age of the document owner in years. It is calculated difference
* between now and date of birth. Now is current time on the device.
* @return current age of the document owner in years or -1 if date of birth is unknown.
* @return current age of the document owner in years or -1 if date of birth is unknown.
*/
this.age = nativeResult.age;
/**
* Defines possible color and moire statuses determined from scanned back image.
/**
* Defines possible color and moire statuses determined from scanned back image.
*/
this.backImageAnalysisResult = nativeResult.backImageAnalysisResult;
/**
* Defines the data extracted from the back side visual inspection zone.
/**
* Defines the data extracted from the back side visual inspection zone.
*/
this.backVizResult = nativeResult.backVizResult;
/**
* Defines the data extracted from the barcode.
/**
* Defines the data extracted from the barcode.
*/
this.barcodeResult = nativeResult.barcodeResult;
/**
* The classification information.
/**
* The classification information.
*/
this.classInfo = nativeResult.classInfo;
/**
* The date of birth of the document owner.
/**
* The date of birth of the document owner.
*/
this.dateOfBirth = nativeResult.dateOfBirth != null ? new Date(nativeResult.dateOfBirth) : null;
/**
* The date of expiry of the document.
/**
* The date of expiry of the document.
*/
this.dateOfExpiry = nativeResult.dateOfExpiry != null ? new Date(nativeResult.dateOfExpiry) : null;
/**
* Determines if date of expiry is permanent.
/**
* Determines if date of expiry is permanent.
*/
this.dateOfExpiryPermanent = nativeResult.dateOfExpiryPermanent;
/**
* The date of issue of the document.
/**
* The date of issue of the document.
*/
this.dateOfIssue = nativeResult.dateOfIssue != null ? new Date(nativeResult.dateOfIssue) : null;
/**
* 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;
/**
* The additional number of the document.
/**
* The additional number of the document.
*/
this.documentAdditionalNumber = nativeResult.documentAdditionalNumber;
/**
/**
* Returns DataMatchResultSuccess if data from scanned parts/sides of the document match,
* DataMatchResultFailed 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 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.
*/
this.documentDataMatch = nativeResult.documentDataMatch;
/**
* The document number.
/**
* The document number.
*/
this.documentNumber = nativeResult.documentNumber;
/**
* The driver license detailed info.
/**
* The one more additional number of the document.
*/
this.documentOptionalAdditionalNumber = nativeResult.documentOptionalAdditionalNumber;
/**
* The driver license detailed info.
*/
this.driverLicenseDetailedInfo = nativeResult.driverLicenseDetailedInfo;
/**
* The employer of the document owner.
/**
* The employer of the document owner.
*/
this.employer = nativeResult.employer;
/**
/**
* Checks whether the document has expired or not by comparing the current

@@ -138,124 +142,124 @@ * time on the device with the date of expiry.

* date of expiry has passed
* date of expiry is unknown and it is not permanent
* date of expiry is unknown and it is not permanent
*/
this.expired = nativeResult.expired;
/**
* face image from the document if enabled with returnFaceImage property.
/**
* face image from the document if enabled with returnFaceImage property.
*/
this.faceImage = nativeResult.faceImage;
/**
* The first name of the document owner.
/**
* The first name of the document owner.
*/
this.firstName = nativeResult.firstName;
/**
* Defines possible color and moire statuses determined from scanned front image.
/**
* Defines possible color and moire statuses determined from scanned front image.
*/
this.frontImageAnalysisResult = nativeResult.frontImageAnalysisResult;
/**
* Defines the data extracted from the front side visual inspection zone.
/**
* Defines the data extracted from the front side visual inspection zone.
*/
this.frontVizResult = nativeResult.frontVizResult;
/**
* back side image of the document if enabled with returnFullDocumentImage property.
/**
* back side image of the document if enabled with returnFullDocumentImage property.
*/
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.
*/
this.fullDocumentFrontImage = nativeResult.fullDocumentFrontImage;
/**
* The full name of the document owner.
/**
* The full name of the document owner.
*/
this.fullName = nativeResult.fullName;
/**
* The issuing authority of the document.
/**
* The issuing authority of the document.
*/
this.issuingAuthority = nativeResult.issuingAuthority;
/**
* The last name of the document owner.
/**
* The last name of the document owner.
*/
this.lastName = nativeResult.lastName;
/**
* The localized name of the document owner.
/**
* The localized name of the document owner.
*/
this.localizedName = nativeResult.localizedName;
/**
* The marital status of the document owner.
/**
* The marital status of the document owner.
*/
this.maritalStatus = nativeResult.maritalStatus;
/**
* The data extracted from the machine readable zone
/**
* The data extracted from the machine readable zone
*/
this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;
/**
* The nationality of the documet owner.
/**
* The nationality of the documet owner.
*/
this.nationality = nativeResult.nationality;
/**
* The personal identification number.
/**
* The personal identification number.
*/
this.personalIdNumber = nativeResult.personalIdNumber;
/**
* The place of birth of the document owner.
/**
* The place of birth of the document owner.
*/
this.placeOfBirth = nativeResult.placeOfBirth;
/**
* Defines status of the last recognition process.
/**
* Defines status of the last recognition process.
*/
this.processingStatus = nativeResult.processingStatus;
/**
* The profession of the document owner.
/**
* The profession of the document owner.
*/
this.profession = nativeResult.profession;
/**
* The race of the document owner.
/**
* The race of the document owner.
*/
this.race = nativeResult.race;
/**
* Recognition mode used to scan current document.
/**
* Recognition mode used to scan current document.
*/
this.recognitionMode = nativeResult.recognitionMode;
/**
* The religion of the document owner.
/**
* The religion of the document owner.
*/
this.religion = nativeResult.religion;
/**
* The residential stauts of the document owner.
/**
* The residential stauts of the document owner.
*/
this.residentialStatus = nativeResult.residentialStatus;
/**
/**
* 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;
/**
* The sex of the document owner.
/**
* The sex of the document owner.
*/
this.sex = nativeResult.sex;
/**
* image of the signature if enabled with returnSignatureImage property.
/**
* image of the signature if enabled with returnSignatureImage property.
*/

@@ -274,57 +278,57 @@ this.signatureImage = nativeResult.signatureImage;

/**
/**
* Defines whether blured frames filtering is allowed
*
*
*
*/
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;
/**
/**
* Defines whether sensitive data should be removed from images, result fields or both.
* The setting only applies to certain documents
*
*
*
*/
this.anonymizationMode = AnonymizationMode.FullResult;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* Pading is a minimum distance from the edge of the frame and is defined as a percentage of the frame width. Default value is 0.0f and in that case

@@ -334,61 +338,61 @@ * padding edge and image edge are the same.

*
*
*
*/
this.paddingEdge = 0.0;
/**
/**
* Enable or disable recognition of specific document groups supported by the current license.
*
*
*
*/
this.recognitionModeFilter = new RecognitionModeFilter();
/**
/**
* 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;
/**
/**
* Sets whether signature image from ID card should be extracted.
*
*
*
*/
this.returnSignatureImage = false;
/**
/**
* Whether or not recognition result should be signed.
*
*
*
*/
this.signResult = 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;
/**
/**
* Skip back side capture and processing step when back side of the document is not supported
*
*
*
*/
this.skipUnsupportedBack = false;
/**
/**
* Defines whether result characters validatation is performed.
* If a result member contains invalid character, the result state cannot be valid
*
*
*
*/

@@ -395,0 +399,0 @@ this.validateResultCharacters = true;

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,75 +29,80 @@

/**
* The additional address information of the document owner.
/**
* The additional address information of the document owner.
*/
this.additionalAddressInformation = nativeResult.additionalAddressInformation;
/**
* The additional name information of the document owner.
/**
* The additional name information of the document owner.
*/
this.additionalNameInformation = nativeResult.additionalNameInformation;
/**
* The address of the document owner.
/**
* The address of the document owner.
*/
this.address = nativeResult.address;
/**
/**
* The current age of the document owner in years. It is calculated difference
* between now and date of birth. Now is current time on the device.
* @return current age of the document owner in years or -1 if date of birth is unknown.
* @return current age of the document owner in years or -1 if date of birth is unknown.
*/
this.age = nativeResult.age;
/**
* Defines the data extracted from the barcode.
/**
* Defines the data extracted from the barcode.
*/
this.barcodeResult = nativeResult.barcodeResult;
/**
* The classification information.
/**
* The classification information.
*/
this.classInfo = nativeResult.classInfo;
/**
* The date of birth of the document owner.
/**
* The date of birth of the document owner.
*/
this.dateOfBirth = nativeResult.dateOfBirth != null ? new Date(nativeResult.dateOfBirth) : null;
/**
* The date of expiry of the document.
/**
* The date of expiry of the document.
*/
this.dateOfExpiry = nativeResult.dateOfExpiry != null ? new Date(nativeResult.dateOfExpiry) : null;
/**
* Determines if date of expiry is permanent.
/**
* Determines if date of expiry is permanent.
*/
this.dateOfExpiryPermanent = nativeResult.dateOfExpiryPermanent;
/**
* The date of issue of the document.
/**
* The date of issue of the document.
*/
this.dateOfIssue = nativeResult.dateOfIssue != null ? new Date(nativeResult.dateOfIssue) : null;
/**
* The additional number of the document.
/**
* The additional number of the document.
*/
this.documentAdditionalNumber = nativeResult.documentAdditionalNumber;
/**
* The document number.
/**
* The document number.
*/
this.documentNumber = nativeResult.documentNumber;
/**
* The driver license detailed info.
/**
* The one more additional number of the document.
*/
this.documentOptionalAdditionalNumber = nativeResult.documentOptionalAdditionalNumber;
/**
* The driver license detailed info.
*/
this.driverLicenseDetailedInfo = nativeResult.driverLicenseDetailedInfo;
/**
* The employer of the document owner.
/**
* The employer of the document owner.
*/
this.employer = nativeResult.employer;
/**
/**
* Checks whether the document has expired or not by comparing the current

@@ -110,113 +114,113 @@ * time on the device with the date of expiry.

* date of expiry has passed
* date of expiry is unknown and it is not permanent
* date of expiry is unknown and it is not permanent
*/
this.expired = nativeResult.expired;
/**
* face image from the document if enabled with returnFaceImage property.
/**
* face image from the document if enabled with returnFaceImage property.
*/
this.faceImage = nativeResult.faceImage;
/**
* The first name of the document owner.
/**
* The first name of the document owner.
*/
this.firstName = nativeResult.firstName;
/**
* full document image if enabled with returnFullDocumentImage property.
/**
* full document image if enabled with returnFullDocumentImage property.
*/
this.fullDocumentImage = nativeResult.fullDocumentImage;
/**
* The full name of the document owner.
/**
* The full name of the document owner.
*/
this.fullName = nativeResult.fullName;
/**
* Defines possible color and moire statuses determined from scanned image.
/**
* Defines possible color and moire statuses determined from scanned image.
*/
this.imageAnalysisResult = nativeResult.imageAnalysisResult;
/**
* The issuing authority of the document.
/**
* The issuing authority of the document.
*/
this.issuingAuthority = nativeResult.issuingAuthority;
/**
* The last name of the document owner.
/**
* The last name of the document owner.
*/
this.lastName = nativeResult.lastName;
/**
* The localized name of the document owner.
/**
* The localized name of the document owner.
*/
this.localizedName = nativeResult.localizedName;
/**
* The marital status of the document owner.
/**
* The marital status of the document owner.
*/
this.maritalStatus = nativeResult.maritalStatus;
/**
* The data extracted from the machine readable zone
/**
* The data extracted from the machine readable zone
*/
this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;
/**
* The nationality of the documet owner.
/**
* The nationality of the documet owner.
*/
this.nationality = nativeResult.nationality;
/**
* The personal identification number.
/**
* The personal identification number.
*/
this.personalIdNumber = nativeResult.personalIdNumber;
/**
* The place of birth of the document owner.
/**
* The place of birth of the document owner.
*/
this.placeOfBirth = nativeResult.placeOfBirth;
/**
* Defines status of the last recognition process.
/**
* Defines status of the last recognition process.
*/
this.processingStatus = nativeResult.processingStatus;
/**
* The profession of the document owner.
/**
* The profession of the document owner.
*/
this.profession = nativeResult.profession;
/**
* The race of the document owner.
/**
* The race of the document owner.
*/
this.race = nativeResult.race;
/**
* Recognition mode used to scan current document.
/**
* Recognition mode used to scan current document.
*/
this.recognitionMode = nativeResult.recognitionMode;
/**
* The religion of the document owner.
/**
* The religion of the document owner.
*/
this.religion = nativeResult.religion;
/**
* The residential stauts of the document owner.
/**
* The residential stauts of the document owner.
*/
this.residentialStatus = nativeResult.residentialStatus;
/**
* The sex of the document owner.
/**
* The sex of the document owner.
*/
this.sex = nativeResult.sex;
/**
* image of the signature if enabled with returnSignatureImage property.
/**
* image of the signature if enabled with returnSignatureImage property.
*/
this.signatureImage = nativeResult.signatureImage;
/**
* Defines the data extracted from the visual inspection zone
/**
* Defines the data extracted from the visual inspection zone
*/

@@ -235,57 +239,57 @@ this.vizResult = nativeResult.vizResult;

/**
/**
* Defines whether blured frames filtering is allowed
*
*
*
*/
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;
/**
/**
* Defines whether sensitive data should be removed from images, result fields or both.
* The setting only applies to certain documents
*
*
*
*/
this.anonymizationMode = AnonymizationMode.FullResult;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* Pading is a minimum distance from the edge of the frame and is defined as a percentage of the frame width. Default value is 0.0f and in that case

@@ -295,47 +299,47 @@ * padding edge and image edge are the same.

*
*
*
*/
this.paddingEdge = 0.0;
/**
/**
* Enable or disable recognition of specific document groups supported by the current license.
*
*
*
*/
this.recognitionModeFilter = new RecognitionModeFilter();
/**
/**
* 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;
/**
/**
* 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.
* If a result member contains invalid character, the result state cannot be valid
*
*
*
*/

@@ -342,0 +346,0 @@ this.validateResultCharacters = true;

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,19 +29,19 @@

/**
* Quadrangle represeting corner points of the document within the input image.
/**
* Quadrangle represeting corner points of the document within the input image.
*/
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.
*/
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.
*/
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.
*/

@@ -63,34 +62,34 @@ this.fullDocumentImage = nativeResult.fullDocumentImage;

/**
/**
* Type of docment this recognizer will scan.
*
*
*
*/
this.detectorType = DocumentFaceDetectorType.TD1;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* Defines how many times the same document should be detected before the detector

@@ -101,17 +100,17 @@ * returns this document as a result of the deteciton

*
*
*
*/
this.numStableDetectionsThreshold = 6;
/**
/**
* Sets whether face image from ID card should be extracted
*
*
*
*/
this.returnFaceImage = false;
/**
/**
* Sets whether full document image of ID card should be extracted.
*
*
*
*/

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

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,74 +29,74 @@

/**
* The additional name information of the document owner.
/**
* The additional name information of the document owner.
*/
this.additionalNameInformation = nativeResult.additionalNameInformation;
/**
* The address of the document owner.
/**
* The address of the document owner.
*/
this.address = nativeResult.address;
/**
/**
* The current age of the document owner in years. It is calculated difference
* between now and date of birth. Now is current time on the device.
* @return current age of the document owner in years or -1 if date of birth is unknown.
* @return current age of the document owner in years or -1 if date of birth is unknown.
*/
this.age = nativeResult.age;
/**
/**
* Type of the barcode scanned
*
* @return Type of the barcode
* @return Type of the barcode
*/
this.barcodeType = nativeResult.barcodeType;
/**
* The city address portion of the document owner.
/**
* The city address portion of the document owner.
*/
this.city = nativeResult.city;
/**
* The date of birth of the document owner.
/**
* The date of birth of the document owner.
*/
this.dateOfBirth = nativeResult.dateOfBirth != null ? new Date(nativeResult.dateOfBirth) : null;
/**
* The date of expiry of the document.
/**
* The date of expiry of the document.
*/
this.dateOfExpiry = nativeResult.dateOfExpiry != null ? new Date(nativeResult.dateOfExpiry) : null;
/**
* The date of issue of the document.
/**
* The date of issue of the document.
*/
this.dateOfIssue = nativeResult.dateOfIssue != null ? new Date(nativeResult.dateOfIssue) : null;
/**
* The additional number of the document.
/**
* The additional number of the document.
*/
this.documentAdditionalNumber = nativeResult.documentAdditionalNumber;
/**
* The document number.
/**
* The document number.
*/
this.documentNumber = nativeResult.documentNumber;
/**
/**
* The document type deduced from the recognized barcode
*
* @return Type of the document
* @return Type of the document
*/
this.documentType = nativeResult.documentType;
/**
* The employer of the document owner.
/**
* The employer of the document owner.
*/
this.employer = nativeResult.employer;
/**
* The additional privileges granted to the driver license owner.
/**
* The additional privileges granted to the driver license owner.
*/
this.endorsements = nativeResult.endorsements;
/**
/**
* Checks whether the document has expired or not by comparing the current

@@ -109,114 +108,114 @@ * time on the device with the date of expiry.

* date of expiry has passed
* date of expiry is unknown and it is not permanent
* date of expiry is unknown and it is not permanent
*/
this.expired = nativeResult.expired;
/**
* The first name of the document owner.
/**
* The first name of the document owner.
*/
this.firstName = nativeResult.firstName;
/**
* The full name of the document owner.
/**
* The full name of the document owner.
*/
this.fullName = nativeResult.fullName;
/**
* The issuing authority of the document.
/**
* The issuing authority of the document.
*/
this.issuingAuthority = nativeResult.issuingAuthority;
/**
* The jurisdiction code address portion of the document owner.
/**
* The jurisdiction code address portion of the document owner.
*/
this.jurisdiction = nativeResult.jurisdiction;
/**
* The last name of the document owner.
/**
* The last name of the document owner.
*/
this.lastName = nativeResult.lastName;
/**
* The marital status of the document owner.
/**
* The marital status of the document owner.
*/
this.maritalStatus = nativeResult.maritalStatus;
/**
* The middle name of the document owner.
/**
* The middle name of the document owner.
*/
this.middleName = nativeResult.middleName;
/**
* The nationality of the documet owner.
/**
* The nationality of the documet owner.
*/
this.nationality = nativeResult.nationality;
/**
* The personal identification number.
/**
* The personal identification number.
*/
this.personalIdNumber = nativeResult.personalIdNumber;
/**
* The place of birth of the document owner.
/**
* The place of birth of the document owner.
*/
this.placeOfBirth = nativeResult.placeOfBirth;
/**
* The postal code address portion of the document owner.
/**
* The postal code address portion of the document owner.
*/
this.postalCode = nativeResult.postalCode;
/**
* The profession of the document owner.
/**
* The profession of the document owner.
*/
this.profession = nativeResult.profession;
/**
* The race of the document owner.
/**
* The race of the document owner.
*/
this.race = nativeResult.race;
/**
* Byte array with result of the scan
/**
* Byte array with result of the scan
*/
this.rawData = nativeResult.rawData;
/**
* The religion of the document owner.
/**
* The religion of the document owner.
*/
this.religion = nativeResult.religion;
/**
* The residential stauts of the document owner.
/**
* The residential stauts of the document owner.
*/
this.residentialStatus = nativeResult.residentialStatus;
/**
* The restrictions to driving privileges for the driver license owner.
/**
* The restrictions to driving privileges for the driver license owner.
*/
this.restrictions = nativeResult.restrictions;
/**
* The sex of the document owner.
/**
* The sex of the document owner.
*/
this.sex = nativeResult.sex;
/**
* The street address portion of the document owner.
/**
* The street address portion of the document owner.
*/
this.street = nativeResult.street;
/**
* Retrieves string content of scanned data
/**
* Retrieves string content of scanned data
*/
this.stringData = nativeResult.stringData;
/**
/**
* Flag indicating uncertain scanning data
* E.g obtained from damaged barcode.
* E.g obtained from damaged barcode.
*/
this.uncertain = nativeResult.uncertain;
/**
* The type of vehicle the driver license owner has privilege to drive.
/**
* The type of vehicle the driver license owner has privilege to drive.
*/

@@ -223,0 +222,0 @@ this.vehicleClass = nativeResult.vehicleClass;

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,43 +29,43 @@

/**
* 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 DataMatchResultSuccess if data from scanned parts/sides of the document match,
* DataMatchResultFailed 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 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.
*/
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;
/**
* back side image of the document if enabled with returnFullDocumentImage property.
/**
* back side image of the document if enabled with returnFullDocumentImage property.
*/
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.
*/
this.fullDocumentFrontImage = nativeResult.fullDocumentFrontImage;
/**
* Returns the Data extracted from the machine readable zone.
/**
* Returns the Data extracted from the machine readable zone.
*/
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.
*/

@@ -87,56 +86,56 @@ this.scanningFirstSideDone = nativeResult.scanningFirstSideDone;

/**
/**
* Whether special characters are allowed
*
*
*
*/
this.allowSpecialCharacters = false;
/**
/**
* Whether returning of unparsed results is allowed
*
*
*
*/
this.allowUnparsedResults = false;
/**
/**
* Whether returning of unverified results is allowed
* Unverified result is result that is parsed, but check digits are incorrect.
*
*
*
*/
this.allowUnverifiedResults = false;
/**
/**
* Type of document this recognizer will scan.
*
*
*
*/
this.detectorType = DocumentFaceDetectorType.TD1;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* Defines how many times the same document should be detected before the detector

@@ -147,24 +146,24 @@ * returns this document as a result of the deteciton

*
*
*
*/
this.numStableDetectionsThreshold = 6;
/**
/**
* 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;
/**
/**
* Whether or not recognition result should be signed.
*
*
*
*/

@@ -171,0 +170,0 @@ this.signResult = false;

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,9 +29,9 @@

/**
* full document image if enabled with returnFullDocumentImage property.
/**
* full document image if enabled with returnFullDocumentImage property.
*/
this.fullDocumentImage = nativeResult.fullDocumentImage;
/**
* Returns the Data extracted from the machine readable zone.
/**
* Returns the Data extracted from the machine readable zone.
*/

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

/**
/**
* Whether special characters are allowed
*
*
*
*/
this.allowSpecialCharacters = false;
/**
/**
* Whether returning of unparsed results is allowed
*
*
*
*/
this.allowUnparsedResults = false;
/**
/**
* Whether returning of unverified results is allowed
* Unverified result is result that is parsed, but check digits are incorrect.
*
*
*
*/
this.allowUnverifiedResults = false;
/**
/**
* Defines if glare detection should be turned on/off.
*
*
*
*/
this.detectGlare = true;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* Sets whether full document image of ID card should be extracted.
*
*
*
*/

@@ -102,0 +101,0 @@ this.returnFullDocumentImage = false;

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,24 +29,24 @@

/**
* 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;
/**
* 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;
/**
* The data extracted from the machine readable zone.
/**
* The data extracted from the machine readable zone.
*/

@@ -66,58 +65,58 @@ this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;

/**
/**
* Defines whether to anonymize Netherlands MRZ
*
*
*
*/
this.anonymizeNetherlandsMrz = true;
/**
/**
* Defines if glare detection should be turned on/off.
*
*
*
*/
this.detectGlare = true;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* 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;
/**
/**
* Whether or not recognition result should be signed.
*
*
*
*/

@@ -124,0 +123,0 @@ this.signResult = false;

import { Recognizer, RecognizerResult } from '../recognizer'
import {
Date,
Point,
Date,
Point,
Quadrilateral,
MrtdDocumentType,
MrtdDocumentType,
MrzResult,

@@ -17,5 +17,4 @@ DocumentFaceDetectorType,

AnonymizationMode,
RecognitionModeFilter,
RecognitionModeFilter,
} from '../types'

@@ -30,14 +29,14 @@

/**
* 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;
/**
* The data extracted from the machine readable zone.
/**
* The data extracted from the machine readable zone.
*/

@@ -56,44 +55,44 @@ this.mrzResult = nativeResult.mrzResult != null ? new MrzResult(nativeResult.mrzResult) : null;

/**
/**
* Defines if glare detection should be turned on/off.
*
*
*
*/
this.detectGlare = true;
/**
/**
* 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;
/**
/**
* Image extension factors for full document image.
*
* @see ImageExtensionFactors
*
*
*/
this.fullDocumentImageExtensionFactors = new ImageExtensionFactors();
/**
/**
* Sets whether face image from ID card should be extracted
*
*
*
*/
this.returnFaceImage = false;
/**
/**
* Sets whether full document image of ID card should be extracted.
*
*
*
*/

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

@@ -60,3 +60,3 @@ /**

MalaysianPassIMM13P : 6,
/** One liner ISO DL */
/** One liner ISO DL */
Dl: 7,

@@ -310,3 +310,17 @@ /** One liner ISO DL */

Peru: 91,
Uruguay: 92
Uruguay: 92,
Bahamas: 93,
Bermuda: 94,
Bolivia: 95,
China: 96,
EuropeanUnion: 97,
Haiti: 98,
Honduras: 99,
Iceland: 100,
Japan: 101,
Luxembourg: 102,
Montenegro: 103,
Nicaragua: 104,
SouthKorea: 105,
Venezuela: 106
}

@@ -392,3 +406,12 @@ );

NewfoundlandAndLabrador: 72,
NuevoLeon: 73
NuevoLeon: 73,
BajaCalifornia: 74,
Chihuahua: 75,
Guanajuato: 76,
Guerrero: 77,
Mexico: 78,
Michoacan: 79,
NewYorkCity: 80,
Tamaulipas: 81,
Veracruz: 82
}

@@ -428,3 +451,12 @@ );

Passport: 26,
SPass: 27
SPass: 27,
AddressCard: 28,
AlienId: 29,
AlienPassport: 30,
GreenCard: 31,
MinorsId: 32,
PostalId: 33,
ProfessionalDl: 34,
TaxId: 35,
WeaponPermit: 36
}

@@ -616,2 +648,5 @@ );

this.empty = nativeVizResult.empty;
/** The one more additional number of the document. */
this.documentOptionalAdditionalNumber = nativeVizResult.documentOptionalAdditionalNumber;
}

@@ -775,2 +810,3 @@ }

};
/**

@@ -777,0 +813,0 @@ * RecognitionModeFilter is used to enable/disable recognition of specific document groups.

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

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