@microblink/blinkid-react-native 7.5.0 → 7.6.1

package/src/index.tsx

@@ -2,7 +2,7 @@ import { BlinkIdScanningResult } from "./blinkIdResult";
 import type {
   BlinkIdSdkSettings,
   BlinkIdSessionSettings,
-  BlinkIdUiSettings,
+  BlinkIdScanningUxSettings,
 } from "./blinkIdSettings";
 import BlinkidReactNative from "./NativeBlinkidReactNative";
 import type { ClassFilter } from "./types";
@@ -12,7 +12,7 @@ export {
   BlinkIdScanningSettings,
   BlinkIdSdkSettings,
   BlinkIdSessionSettings,
-  BlinkIdUiSettings,
+  BlinkIdScanningUxSettings,
   CroppedImageSettings,
 } from "./blinkIdSettings";
 
@@ -21,6 +21,53 @@ export { BlinkIdScanningResult } from "./blinkIdResult";
 // Types & enums
 export * from "./types";
 
+/**  The `loadBlinkIdSdk` method creates or retrieves the instance of the BlinkID SDK.
+ *
+ * Initializes and loads the BlinkID SDK if it is not already loaded.
+ *
+ * This method handles:
+ * - SDK initialization
+ * - Resource downloading
+ * - License verification
+ *
+ * It ensures that only one SDK instance exists at any time.
+ *
+ * You can call this method in advance to **preload** the SDK before starting a scanning session.
+ * Doing so reduces loading time for the {@link performScan} and {@link performDirectApiScan} methods,
+ * since all resources will already be available and the license verified.
+ *
+ * If you do not call this method beforehand, it will still be automatically invoked on the native platform channels
+ * when a scan starts. However, the initial scan may take longer due to resource loading and license checks.
+ *
+ * @param blinkIdSdkSettings - {@link BlinkIdSdkSettings} - the class that contains all of the available SDK settings.
+ * It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.
+ *
+ * To obtain a valid license key, please visit https://developer.microblink.com/ or contact us directly at https://help.microblink.com.
+ */
+export async function loadBlinkIdSdk(
+  blinkIdSdkSettings: BlinkIdSdkSettings
+): Promise<void> {
+  await BlinkidReactNative.loadBlinkIdSdk(JSON.stringify(blinkIdSdkSettings));
+}
+
+/**
+ * The `unloadBlinkIdSdk` method terminates the BlinkID SDK and releases all associated resources.
+ *
+ * This method safely shuts down the SDK instance and frees any allocated memory.
+ * After calling this method, you must reinitialize the SDK (by calling {@link loadBlinkIdSdk}
+ * or any of the scanning methods) before using it again.
+ *
+ * This method is automatically called after each successful scan session.
+ *
+ * @param deleteCachedResources - if set to `true` (`false` is default), the method performs a **complete cleanup**,
+ * including deletion of all downloaded and cached SDK resources from the device.
+ */
+export async function unloadBlinkIdSdk(
+  deleteCachedResources: boolean
+): Promise<void> {
+  await BlinkidReactNative.unloadBlinkIdSdk(deleteCachedResources);
+}
+
 /**
  * The `performScan` method launches the BlinkID scanning process with the default UX properties.
  *
@@ -35,7 +82,7 @@ export * from "./types";
  * @param blinkIdSessionSettings - BlinkID Session Settings - the class that contains various settings for the scanning session. It contains the settings for the {@link ScanningMode} and
  * {@link BlinkIdScanningSettings}, which define various parameters that control the scanning process.
  *
- * @param blinkIdUiSettings - BlinkID UI Settings - the class that allows customization of various aspects of the UI used during the scanning process.
+ * @param blinkIdUiSettings - BlinkID Scanning UX Settings - the class that allows customization of various aspects of the UI & UX used during the scanning process.
  *
  * @param classFilter - The optional `ClassFilter` class - the class which controls which documents will be accepted or reject for information extraction during the scanning session.
  * See {@link ClassFilter} for more implementation information.
@@ -47,13 +94,13 @@ export * from "./types";
 export async function performScan(
   blinkIdSdkSettings: BlinkIdSdkSettings,
   blinkIdSessionSettings: BlinkIdSessionSettings,
-  blinkIdUiSettings?: BlinkIdUiSettings,
+  blinkIdScanningUxSettings?: BlinkIdScanningUxSettings,
   classFilter?: ClassFilter
 ): Promise<BlinkIdScanningResult> {
   const jsonResult = await BlinkidReactNative.performScan(
     JSON.stringify(blinkIdSdkSettings),
     JSON.stringify(blinkIdSessionSettings),
-    JSON.stringify(blinkIdUiSettings),
+    JSON.stringify(blinkIdScanningUxSettings),
     JSON.stringify(classFilter)
   );
   return new BlinkIdScanningResult(JSON.parse(jsonResult));

package/src/types.ts

@@ -1171,6 +1171,66 @@ export class VizResult {
    */
   dateOfExpiry?: DateResult<StringResult>;
 
+  /**
+   * The date of entry of the document owner.
+   *
+   */
+  dateOfEntry?: DateResult<StringResult>;
+
+  /**
+   * The locality code of the document owner.
+   *
+   */
+  localityCode?: StringResult;
+
+  /**
+   * The maiden name of the document owner.
+   *
+   */
+  maidenName?: StringResult;
+
+  /**
+   * The municipality code of the document owner.
+   *
+   */
+  municipalityCode?: StringResult;
+
+  /**
+   * The municipality of registration of the document owner.
+   *
+   */
+  municipalityOfRegistration?: StringResult;
+
+  /**
+   * The polling station code of the document owner.
+   *
+   */
+  pollingStationCode?: StringResult;
+
+  /**
+   * The registration center code of the document owner.
+   *
+   */
+  registrationCenterCode?: StringResult;
+
+  /**
+   * The section code of the document owner.
+   *
+   */
+  sectionCode?: StringResult;
+
+  /**
+   * The state code of the document owner.
+   *
+   */
+  stateCode?: StringResult;
+
+  /**
+   * The state of the document owner.
+   *
+   */
+  stateName?: StringResult;
+
   /**
    * Determines if date of expiry is permanent.
    *
@@ -1328,6 +1388,17 @@ export class VizResult {
     this.dateOfBirth = nativeVizResult.dateOfBirth;
     this.dateOfIssue = nativeVizResult.dateOfIssue;
     this.dateOfExpiry = nativeVizResult.dateOfExpiry;
+    this.dateOfEntry = nativeVizResult.dateOfEntry;
+    this.localityCode = nativeVizResult.localityCode;
+    this.maidenName = nativeVizResult.maidenName;
+    this.municipalityCode = nativeVizResult.municipalityCode;
+    this.municipalityOfRegistration =
+      nativeVizResult.municipalityOfRegistration;
+    this.pollingStationCode = nativeVizResult.pollingStationCode;
+    this.registrationCenterCode = nativeVizResult.registrationCenterCode;
+    this.sectionCode = nativeVizResult.sectionCode;
+    this.stateCode = nativeVizResult.stateCode;
+    this.stateName = nativeVizResult.stateName;
     this.dateOfExpiryPermanent = nativeVizResult.dateOfExpiryPermanent;
     this.documentNumber = nativeVizResult.documentNumber;
     this.personalIdNumber = nativeVizResult.personalIdNumber;
@@ -2686,6 +2757,18 @@ export class BarcodeExtendedElements {
    */
   weightRange?: string;
 
+  /**
+   * SubField Designator extracted from barcode, to support proper document classification based on the standard.
+   *
+   * Subfield designator is a 2-character code that specifies the type of document, typically DL or ID.
+   *
+   * It is located immediately after the IIN and the variable metadata structure in the PDF417 barcode data structure.
+   *
+   *
+   *  For example: ANSI 636010090002DL00410267ZF03080067DLDAQS1234567812300000000000000 ^^ |           | |           +-- SubField Designator (DL, ID, EN, etc.) +----- IIN (636010)
+   */
+  subFieldDesignator?: string;
+
   /**
    *
    * @param nativeBarcodeExtendedElements - specifies the extended barcode elements obtained from the native SDK.
@@ -2807,6 +2890,7 @@ export class BarcodeExtendedElements {
     this.weightKilograms = nativeBarcodeExtendedElements.weightKilograms;
     this.weightPounds = nativeBarcodeExtendedElements.weightPounds;
     this.weightRange = nativeBarcodeExtendedElements.weightRange;
+    this.subFieldDesignator = nativeBarcodeExtendedElements.subFieldDesignator;
   }
 }
 
@@ -4016,6 +4100,8 @@ export enum Region {
   Alagos = "alagos",
 
   Bangsamoro = "bangsamoro",
+
+  Telangana = "telangana",
 }
 
 /**
@@ -4182,6 +4268,18 @@ export enum DocumentType {
   RegistrationCertificate = "registrationCertificate",
 
   MedicalMarijuanaId = "medicalMarijuanaId",
+
+  NonCardTribalId = "nonCardTribalId",
+
+  DiplomaticId = "diplomaticId",
+
+  EmergencyPassport = "emergencyPassport",
+
+  temporaryPassport = "temporaryPassport",
+
+  metisFederationCard = "metisFederationCard",
+
+  adrCertificate = "adrCertificate",
 }
 
 /**
@@ -4289,5 +4387,47 @@ export enum FieldType {
 
   SpecificDocumentValidity = "specificDocumentValidity",
 
-  VehnicleOwner = "vehicleOwner",
+  VehicleOwner = "vehicleOwner",
+
+  nationalInsuranceNumber = "nationalInsuranceNumber",
+
+  CountryCode = "countryCode",
+
+  CertificateNumber = "certificateNumber",
+
+  MunicipalityOfRegistration = "municipalityOfRegistration",
+
+  LocalityCode = "localityCode",
+
+  MaidenName = "maidenName",
+
+  StateCode = "stateCode",
+
+  DateOfEntry = "dateOfEntry",
+
+  MunicipalityCode = "municipalityCode",
+
+  PollingStationCode = "pollingStationCode",
+
+  SectionCode = "sectionCode",
+
+  RegistrationCenterCode = "registrationCenterCode",
+
+  StateName = "stateName",
+}
+
+/** An enum indicating preffered camera position for document capturing. */
+export enum PreferredCamera {
+  /**
+   * Use the back-facing camera
+   *
+   * This is the default value
+   */
+  Back = "back",
+
+  /**
+   * Use the front-facing camera
+   *
+   */
+  Front = "front",
 }