@microblink/blinkid-react-native 7.6.2 → 8000.0.0

package/src/blinkIdResult.ts

@@ -1,5 +1,4 @@
-import {
-  RecognitionMode,
+import type {
   StringResult,
   DataMatchResult,
   DocumentClassInfo,
@@ -8,6 +7,7 @@ import {
   DriverLicenseDetailedInfo,
   DateResult,
   DetailedCroppedImageResult,
+  ParentInfo,
 } from "./types";
 
 /**
@@ -17,14 +17,7 @@ import {
  * and images from the document.
  *
  **/
-export class BlinkIdScanningResult {
-  /**
-   * Scanning mode used to scan the current document.
-   *
-   * See {@link RecognitionMode} for more information.
-   */
-  recognitionMode?: RecognitionMode;
-
+export type BlinkIdScanningResult = {
   /**
    * The document class information.
    *
@@ -170,6 +163,12 @@ export class BlinkIdScanningResult {
    */
   documentNumber?: StringResult;
 
+  /**
+   *
+   * The card access number.
+   */
+  cardAccessNumber?: StringResult;
+
   /**
    * The personal identification number.
    *
@@ -388,11 +387,12 @@ export class BlinkIdScanningResult {
   secondInputImage?: string;
 
   /**
-   * Returns the input image containing parsable barcode.
+   * Returns the cropped barcode image in the Base64 format when
+   * {@link BarcodeModuleSettings.barcodeImageReturnEnabled} is enabled.
    *
-   * Or `null` if the barcode input image is not available.
+   * Or `null` if the barcode image is not available.
    */
-  barcodeInputImage?: string;
+  barcodeImage?: string;
   /**
    * Returns the cropped document image for the first scanning side.
    *
@@ -423,422 +423,34 @@ export class BlinkIdScanningResult {
   signatureImage?: DetailedCroppedImageResult;
 
   /**
-   * Represents the results of scanning a document.
-   *
-   * This class contains the results of scanning a document, including the extracted data
-   * and images from the document.
-   *
-   */
-  constructor(nativeBlinkIdResult: any) {
-    /**
-     * Scanning mode used to scan the current document.
-     *
-     * See {@link RecognitionMode} for more information.
-     */
-    this.recognitionMode = nativeBlinkIdResult.recognitionMode;
-    /**
-     * The document class information.
-     *
-     * See {@link DocumentClassInfo} for more information.
-     */
-    this.documentClassInfo = nativeBlinkIdResult.documentClassInfo;
-    /**
-     * Info on whether the data extracted from multiple sides matches.
-     *
-     * See {@link DataMatchResult} for more information.
-     */
-    this.dataMatchResult = nativeBlinkIdResult.dataMatchResult;
-
-    /**
-     * The first name of the document owner.
-     *
-     */
-    this.firstName = nativeBlinkIdResult.firstName;
-
-    /**
-     * The last name of the document owner.
-     *
-     */
-    this.lastName = nativeBlinkIdResult.lastName;
-
-    /**
-     * The full name of the document owner.
-     *
-     */
-    this.fullName = nativeBlinkIdResult.fullName;
-
-    /**
-     * The additional name information of the document owner.
-     *
-     */
-    this.additionalNameInformation =
-      nativeBlinkIdResult.additionalNameInformation;
-
-    /**
-     * The localized name of the document owner.
-     *
-     */
-    this.localizedName = nativeBlinkIdResult.localizedName;
-    /**
-     * The fathers name of the document owner.
-     *
-     */
-    this.fathersName = nativeBlinkIdResult.fathersName;
-
-    /**
-     * The mothers name of the document owner.
-     *
-     */
-    this.mothersName = nativeBlinkIdResult.mothersName;
-
-    /**
-     * The address of the doicument owner.
-     *
-     */
-    this.address = nativeBlinkIdResult.address;
-
-    /**
-     * The additional address information of the document owner.
-     *
-     */
-    this.additionalAddressInformation =
-      nativeBlinkIdResult.additionalAddressInformation;
-
-    /**
-     * The one more additional address information of the document owner.
-     *
-     */
-    this.additionalOptionalAddressInformation =
-      nativeBlinkIdResult.additionalOptionalAddressInformation;
-
-    /**
-     * The place of birth of the document owner.
-     *
-     */
-    this.placeOfBirth = nativeBlinkIdResult.placeOfBirth;
-
-    /**
-     * The nationality of the document owner.
-     *
-     */
-    this.nationality = nativeBlinkIdResult.nationality;
-
-    /**
-     * The race of the document owner.
-     *
-     */
-    this.race = nativeBlinkIdResult.race;
-
-    /**
-     * The religion of the document owner.
-     *
-     */
-    this.religion = nativeBlinkIdResult.religion;
-
-    /**
-     * The profession of the document owner.
-     *
-     */
-    this.profession = nativeBlinkIdResult.profession;
-
-    /**
-     * The marital status of the document owner.
-     *
-     */
-    this.maritalStatus = nativeBlinkIdResult.maritalStatus;
-
-    /**
-     * The residential status of the document owner.
-     *
-     */
-    this.residentialStatus = nativeBlinkIdResult.residentialStatus;
-    /**
-     * The employer of the document owner.
-     *
-     */
-    this.employer = nativeBlinkIdResult.employer;
-
-    /**
-     * The sex of the document owner.
-     *
-     */
-    this.sex = nativeBlinkIdResult.sex;
-
-    /**
-     * The sponsor of the document owner.
-     *
-     */
-    this.sponsor = nativeBlinkIdResult.sponsor;
-
-    /**
-     * The blood type of the document owner.
-     *
-     */
-    this.bloodType = nativeBlinkIdResult.bloodType;
-
-    /**
-     * The document number.
-     *
-     */
-    this.documentNumber = nativeBlinkIdResult.documentNumber;
-
-    /**
-     * The personal identification number.
-     *
-     */
-    this.personalIdNumber = nativeBlinkIdResult.personalIdNumber;
-
-    /**
-     * The additional number of the document.
-     *
-     */
-    this.documentAdditionalNumber =
-      nativeBlinkIdResult.documentAdditionalNumber;
-
-    /**
-     * The one more additional number of the document.
-     *
-     */
-    this.documentOptionalAdditionalNumber =
-      nativeBlinkIdResult.documentOptionalAdditionalNumber;
-
-    /**
-     * The additional personal identification number.
-     *
-     */
-    this.additionalPersonalIdNumber =
-      nativeBlinkIdResult.additionalPersonalIdNumber;
-
-    /**
-     * The issuing authority of the document.
-     *
-     */
-    this.issuingAuthority = nativeBlinkIdResult.issuingAuthority;
-
-    /**
-     * The transcription of the document subtype.
-     *
-     */
-    this.documentSubtype = nativeBlinkIdResult.documentSubtype;
-
-    /**
-     * The remarks on the residence permit.
-     *
-     */
-    this.remarks = nativeBlinkIdResult.remarks;
-
-    /**
-     * The residence permit type.
-     *
-     */
-    this.residencePermitType = nativeBlinkIdResult.residencePermitType;
-
-    /**
-     * The manufacturing year.
-     *
-     */
-    this.manufacturingYear = nativeBlinkIdResult.manufacturingYear;
-
-    /**
-     * The vehicle owner.
-     *
-     */
-    this.vehicleOwner = nativeBlinkIdResult.vehicleOwner;
-
-    /**
-     * The vehicle type.
-     *
-     */
-    this.vehicleType = nativeBlinkIdResult.vehicleType;
-
-    /**
-     * The eligibility category.
-     *
-     */
-    this.eligibilityCategory = nativeBlinkIdResult.eligibilityCategory;
-
-    /**
-     * The specific document validity.
-     *
-     */
-    this.specificDocumentValidity =
-      nativeBlinkIdResult.specificDocumentValidity;
-
-    /**
-     * The visa type of the document.
-     *
-     */
-    this.visaType = nativeBlinkIdResult.visaType;
-
-    /**
-     * The country code of the document owner.
-     *
-     */
-    this.countryCode = nativeBlinkIdResult.countryCode;
-
-    /**
-     * The certificate number of the document owner.
-     *
-     */
-    this.certificateNumber = nativeBlinkIdResult.certificateNumber;
-
-    /**
-     * The national insurance number of the document owner.
-     *
-     */
-    this.nationalInsuranceNumber = nativeBlinkIdResult.nationalInsuranceNumber;
-
-    /**
-     * The date of birth of the document owner.
-     *
-     */
-    this.dateOfBirth = nativeBlinkIdResult.dateOfBirth;
-
-    /**
-     * The date of issue of the document.
-     *
-     */
-    this.dateOfIssue = nativeBlinkIdResult.dateOfIssue;
-
-    /**
-     * The date of expiry of the document.
-     *
-     */
-    this.dateOfExpiry = nativeBlinkIdResult.dateOfExpiry;
-
-    /**
-     * The date of entry of the document owner.
-     *
-     */
-    this.dateOfEntry = nativeBlinkIdResult.dateOfEntry;
-
-    /**
-     * The locality code of the document owner.
-     *
-     */
-    this.localityCode = nativeBlinkIdResult.localityCode;
-
-    /**
-     * The maiden name of the document owner.
-     *
-     */
-    this.maidenName = nativeBlinkIdResult.maidenName;
-
-    /**
-     * The municipality code of the document owner.
-     *
-     */
-    this.municipalityCode = nativeBlinkIdResult.municipalityCode;
-
-    /**
-     * The municipality of registration of the document owner.
-     *
-     */
-    this.municipalityOfRegistration =
-      nativeBlinkIdResult.municipalityOfRegistration;
-
-    /**
-     * The polling station code of the document owner.
-     *
-     */
-    this.pollingStationCode = nativeBlinkIdResult.pollingStationCode;
-
-    /**
-     * The registration center code of the document owner.
-     *
-     */
-    this.registrationCenterCode = nativeBlinkIdResult.registrationCenterCode;
-
-    /**
-     * The section code of the document owner.
-     *
-     */
-    this.sectionCode = nativeBlinkIdResult.sectionCode;
-
-    /**
-     * The state code of the document owner.
-     *
-     */
-    this.stateCode = nativeBlinkIdResult.stateCode;
-
-    /**
-     * The state of the document owner.
-     *
-     */
-    this.stateName = nativeBlinkIdResult.stateName;
-
-    /**
-     * Determines if date of expiry is permanent.
-     *
-     */
-    this.dateOfExpiryPermanent = nativeBlinkIdResult.dateOfExpiryPermanent;
-
-    /**
-     * The driver license detailed info.
-     *
-     * See {@link DriverLicenseDetailedInfo} for more information.
-     */
-    this.driverLicenseDetailedInfo =
-      nativeBlinkIdResult.driverLicenseDetailedInfo;
-    /**
-     * The dependents info.
-     *
-     * See {@link DependentInfo} for more information.
-     */
-    this.dependentsInfo = nativeBlinkIdResult.dependentsInfo;
-
-    /**
-     * The results of scanning each side of the document.
-     *
-     * See {@link SingleSideScanningResult} for more information.
-     */
-    this.subResults = nativeBlinkIdResult.subResults;
-    /**
-     * Returns the input image for the first scanning side in the Base64 format.
-     *
-     * Or `null` if the input image is not available.
-     */
-    this.firstInputImage = nativeBlinkIdResult.firstInputImage;
-    /**
-     * Returns the input image for the second scanning side in the Base64 format.
-     *
-     * Or `null` if the input image is not available.
-     */
-    this.secondInputImage = nativeBlinkIdResult.secondInputImage;
-
-    /**
-     * Returns the input image containing parsable barcode.
-     *
-     * Or `null` if the barcode input image is not available.
-     */
-    this.barcodeInputImage = nativeBlinkIdResult.barcodeInputImage;
-    /**
-     * Returns the cropped document image for the first scanning side.
-     *
-     * Or `null` if the document image is not available.
-     */
-    this.firstDocumentImage = nativeBlinkIdResult.firstDocumentImage;
-
-    /**
-     * Returns the cropped document image for the second scanning side.
-     *
-     * Or `null` if the document image is not available.
-     */
-    this.secondDocumentImage = nativeBlinkIdResult.secondDocumentImage;
-    /**
-     * Returns the cropped face image with additional info.
-     * Or `null` if the face image is not available.
-     *
-     * See {@link DetailedCroppedImageResult} for more information.
-     */
-    this.faceImage = nativeBlinkIdResult.faceImage;
-
-    /**
-     * Returns the cropped signature image with additional info.
-     * Or `null` if the signature image is not available.
-     *
-     * See {@link DetailedCroppedImageResult} for more information.
-     */
-    this.signatureImage = nativeBlinkIdResult.signatureImage;
-  }
-}
+   * The effective date of the document.
+   */
+  effectiveDate?: DateResult<StringResult>;
+
+  /**
+   * The parents info.
+   *
+   * See {@link ParentInfo} for more information.
+   */
+  parentsInfo?: ParentInfo[];
+
+  /**
+   * The husband name of the document owner.
+   */
+  husbandName?: StringResult;
+
+  /**
+   * The legal status of the document owner.
+   */
+  legalStatus?: StringResult;
+
+  /**
+   * The social security status of the document owner.
+   */
+  socialSecurityStatus?: StringResult;
+
+  /**
+   * The work restriction of the document owner.
+   */
+  workRestriction?: StringResult;
+};