@microblink/blinkid-react-native 7.6.2 → 8000.0.0

package/src/blinkIdSettings.ts

@@ -1,18 +1,17 @@
-import {
-  DetectionLevel,
-  AnonymizationMode,
+import type {
   ScanningMode,
-  DocumentRules,
-  DocumentAnonymizationSettings,
-  RecognitionModeFilter,
   PreferredCamera,
+  DocumentCaptureModuleSettings,
+  MrzModuleSettings,
+  BarcodeModuleSettings,
+  VizModuleSettings,
 } from "./types";
 
 /**
  *  Settings for the initialization of the BlinkID SDK.
  *
  */
-export class BlinkIdSdkSettings {
+export type BlinkIdSdkSettings = {
   /**
    * License key for the native SDK.
    *
@@ -72,31 +71,7 @@ export class BlinkIdSdkSettings {
    *
    */
   microblinkProxyURL?: string;
-
-  /**
-   *
-   * Settings for the initialization of the BlinkID SDK.
-   */
-  constructor(
-    licenseKey: string,
-    licensee?: string,
-    downloadResources?: boolean,
-    resourceDownloadUrl?: string,
-    resourceLocalFolder?: string,
-    bundleIdentifier?: string,
-    resourceRequestTimeout?: number,
-    microblinkProxyURL?: string
-  ) {
-    this.licenseKey = licenseKey;
-    this.licensee = licensee;
-    this.downloadResources = downloadResources;
-    this.resourceDownloadUrl = resourceDownloadUrl;
-    this.resourceLocalFolder = resourceLocalFolder;
-    this.bundleIdentifier = bundleIdentifier;
-    this.resourceRequestTimeout = resourceRequestTimeout;
-    this.microblinkProxyURL = microblinkProxyURL;
-  }
-}
+};
 
 /**
  * Represents the configuration settings for a scanning session.
@@ -105,7 +80,7 @@ export class BlinkIdSdkSettings {
  * scanning mode, and specific scanning configurations that define how the scanning
  * session should behave.
  */
-export class BlinkIdSessionSettings {
+export type BlinkIdSessionSettings = Partial<{
   /**
    * The scanning mode to be used during the scanning session.
    *
@@ -121,30 +96,24 @@ export class BlinkIdSessionSettings {
    *
    * Defines various parameters that control the scanning process.
    */
-  scanningSettings: BlinkIdScanningSettings;
+  scanningSettings: Partial<BlinkIdScanningSettings>;
 
   /**
-   * Duration in seconds before scanning step times out and is cancelled.
+   * Duration in milliseconds before a scanning step times out and is cancelled.
    *
-   * If less than zero, scanning will not time out.
-   * Defaults to 15000 (miliseconds)
+   * Resets on side changes and pauses while onboarding or help dialogs are shown.
+   * Set to `0` to disable the step timeout. Defaults to `60000` (60 seconds).
    */
   stepTimeoutDuration: number;
 
   /**
+   * Duration in milliseconds of UI inactivity (no state change) before timeout.
    *
-   * Represents the configuration settings for a scanning session.
-   *
-   * This class holds the settings related to the resources initialization,
-   * scanning mode, and specific scanning configurations that define how the scanning
-   * session should behave.
+   * Resets whenever the UI state changes (reticle type or message).
+   * Set to `0` to disable the inactivity timeout. Defaults to `10000` (10 seconds).
    */
-  constructor() {
-    this.scanningMode = ScanningMode.Automatic;
-    this.scanningSettings = new BlinkIdScanningSettings();
-    this.stepTimeoutDuration = 15000;
-  }
-}
+  inactivityTimeoutDuration: number;
+}>;
 
 /**
  * Represents the configurable settings for scanning a document.
@@ -154,306 +123,77 @@ export class BlinkIdSessionSettings {
  * along with options for frame processing and image extraction.
  *
  *  */
-export class BlinkIdScanningSettings {
-  /**
-   * The level of blur detection in the document image.
-   *
-   * Defines the severity of blur detected in the document image, as defined
-   * in [DetectionLevel]. Values range from `off` (detection NotAvailable) to higher
-   * levels of blur detection.
-   *
-   * `low` – less sensitive to blur; if something is detected as blur, it is almost certainly actual blur,
-   * but some amount of blur may not be detected at all.
-   * `high` – highly sensitive to blur; it may detect as blur even something that only resembles blur.
-   *
-   * Default: {@link DetectionLevel.Mid}
-   *  */
-  blurDetectionLevel: DetectionLevel;
-
-  /**
-   * Indicates whether images with blur in the document image should be skipped.
-   *
-   * A value of `true` means images with detected blur will be excluded from further processing to prevent blurred images from being used
-   *     - If blurDetectionLevel = `off` - blurred images will be processed
-   *     - If blur is detected `ProcessingStatus` will be `ImagePreprocessingFailed` and blur will be reported in the `ProcessResult`
-   * A value of `false` means images with detected blur will not be excluded from further processing
-   *     - If blurDetectionLevel != `off` - even if blur is detected, the image will be processed and blur will be reported in the `ProcessResult`.
-   *
-   * Default: `true`
-   */
-  skipImagesWithBlur: boolean;
-
-  /**
-   * The level of glare detection in the document image.
-   *
-   * Defines the severity of glare detected in the document image, as defined in [DetectionLevel].
-   * Values range from `off` (detection NotAvailable) to higher levels of glare detection.
-   * `low` – less sensitive to glare; if something is detected as glare, it is almost certainly actual glare,
-   *     but some amount of glare may not be detected at all.
-   * `high` – highly sensitive to glare; it may detect as glare even something that only resembles glare.
-   *
-   * Default: {@link DetectionLevel.Mid}
-   */
-  glareDetectionLevel: DetectionLevel;
-
-  /**
-   * Indicates whether images with glare in the document image should be skipped.
-   *
-   * A value of `true` means images with detected glare will be excluded from further processing to prevent glared images from being used
-   *     - If glareDetectionLevel = `off` - glared images will be processed
-   *     - If glare is detected `ProcessingStatus` will be `ImagePreprocessingFailed` and glare will be reported in the `ProcessResult`
-   * A value of `false` means images with detected glare will not be excluded from further processing
-   *     - If glareDetectionLevel != `off` - even if glare is detected, the image will be processed and glare will be reported in the `ProcessResult`
-   *
-   * Default: `true`
-   */
-  skipImagesWithGlare: boolean;
-
-  /**
-   * The level of allowed detected tilt of the document in the image.
-   *
-   * Defines the severity of allowed detected tilt of the document in the image, as defined in [DetectionLevel].
-   * Values range from `off` (detection NotAvailable) to higher levels of allowed tilt.
-   * `low` – less sensitive to tilt.
-   * `high` – highly sensitive to tilt.
-   *
-   * Default: {@link DetectionLevel.Mid}
-   */
-  tiltDetectionLevel: DetectionLevel;
-
-  /**
-   * Indicates whether images with inadequate lighting conditions should be rejected.
-   *
-   * Inadequate lighting conditions are represented as either `TooBright` or `TooDark` document images,
-   *     as defined in the `ImageAnalysisLightingStatus` enum.
-   * A value of `true` means images with inadequate lighting conditions will be excluded from further processing to prevent images with
-   * inadequate lighting from being used
-   *     - If inadequate light conditions are detected `ProcessingStatus` will be `ImagePreprocessingFailed` and lighting status will be
-   *       reported in the `ProcessResult`.
-   *
-   * Default: `true`
-   */
-  skipImagesWithInadequateLightingConditions: boolean;
-
-  /**
-   * Indicates whether images occluded by hand should be rejected.
-   *
-   * A value of `true` means images occluded by hand will be excluded from further processing to prevent occluded images from being used
-   *     - If hand occlusion is detected `ProcessingStatus` will be `ImagePreprocessingFailed` and hand occlusion status will be reported
-   *       in the `ProcessResult`
-   * This setting is applicable only if `scanCroppedDocumentImage` = false.
-   *
-   * Default: `true`
-   */
-  skipImagesOccludedByHand: boolean;
-
-  /**
-   * Indicates whether the aggregation of data from multiple images is enabled.
-   *
-   *  Disabling this setting will yield higher-quality captured images, but it may slow down the scanning process due to the additional
-   *      effort required to find the optimal image.
-   *  Enabling this setting will simplify the extraction process, but the extracted data will be aggregated from multiple images instead
-   *      of being sourced from a single image.
-   *  This only applies to images from Video input image source - for images from Photo source, setting will be ignored.
-   *
-   * Default: `true`
-   */
-  combineResultsFromMultipleInputImages: boolean;
-
-  /**
-   * Enables barcode recognition to proceed even if the initial VIZ extraction fails.
-   *
-   * If the barcode recognition is successful, recognition will still end in a valid state.
-   * This setting is applicable only to images from Photo source.
-   * For multi-side scanning, it is permitted only for the back side.
-   *
-   * Default: `false`
-   */
-  enableBarcodeScanOnly: boolean;
-
-  /**
-   * Defines custom rules for specific document class.
-   *
-   * When defining [DocumentRules], [DocumentFilter] is optionally set to specify the document to which the rule applies, and a `fields` with
-   *     the appropriate `alphabetType` should be specified as mandatory for that document.
-   * If a `fields` is set to a field that is optional for that document or does not exist on it, all fields on the document become optional.
-   * If a `fields` is set to a field with an incorrect alphabetType, all fields on the document become optional.
-   * If a `fields` is set to a field that doesn’t exist in the internal rules, that rule is ignored.
-   * When adding multiple `fields`, any field that does not match our rules is ignored. Only fields that comply with our rules are set as mandatory.
-   * If the documentFilter fields `country`, `region`, or `type` are set to `null`, all supported values for those fields will be considered.
-   *     For example, if `country = null`, the rule will apply to all supported countries in BlinkID.
-   *
-   * By default, document fields are validated using internal rules that define mandatory fields for the scanned document class. This setting allows
-   *     users to narrow down our internal rules on mandatory fields. All undefined fields will become optional. It is not possible to mark fields as
-   *     mandatory if they cannot theoretically appear on the document.
-   * The more detailed document filter will have priority over the other.
-   *
-   * See {@link DocumentRules} for more detailed information.
-   */
-  customDocumentRules?: DocumentRules[];
-
-  /**
-   * The mode of anonymization applied to the document.
-   *
-   * Redact specific fields based on requirements or laws regarding a specific document.
-   * Data can be redacted from the image, the result or both.
-   *
-   * Default: {@link AnonymizationMode.fullResult}
-   */
-  anonymizationMode: AnonymizationMode;
-
-  /**
-   * Redact fields for specific document class.
-   *
-   * Fields specified by requirements or laws for a specific document will be redacted regardless of this setting.
-   * Based on anonymizationMode setting, data will be redacted from the image, the result or both.
+export type BlinkIdScanningSettings = Partial<{
+  /*
+   * Settings for the document capture module.
    *
-   * See {@link DocumentAnonymizationSettings} for more information.
-   */
-  customDocumentAnonymizationSettings?: DocumentAnonymizationSettings[];
-  /**
-   * Indicates whether input images should be returned.
+   * This module is responsible for the initial document detection, image extraction
+   * (such as face and document images), and image quality validation (blur, glare,
+   * and lighting checks).
    *
-   * Save the input images at the moment of the data extraction or timeout.
-   * This significantly increases memory consumption. The scanning performance is not affected.
-   *
-   * Default: `false`
-   */
-  returnInputImages: boolean;
-
-  /**
-   * Process only cropped document images.
-   * Requires the input image to consist solely of the cropped document image with perspective correction applied.
-   * This only applies to images from Photo input image source - for images from Video input image source, setting will be ignored.
+   * Set to `null` to disable this module.
    *
-   * Default: `false`
+   * See {@link DocumentCaptureModuleSettings} for more information.
    */
-  scanCroppedDocumentImage: boolean;
+  documentCaptureModule: Partial<DocumentCaptureModuleSettings> | null;
 
-  /**
-   * The filter for recognition modes.
+  /*
+   * Settings for the MRZ (Machine Readable Zone) extraction module.
    *
-   * Specifies which recognition modes are enabled during the scanning process, with a default value of true to enable all modes.
-   * [RecognitionModeFilter] is used to enable/disable recognition of specific document groups.
+   * This module is dedicated to the detection and parsing of machine-readable
+   * zone typically found on passports, visas, and identity cards.
    *
-   * This setting is experimental and it will be removed in upcoming releases.
+   * Set to `null` to disable this module.
    *
-   * By default all modes are enabled (set to `true`).
+   * See {@link MrzModuleSettings} for more information.
    */
-  recognitionModeFilter: RecognitionModeFilter;
+  mrzModule: Partial<MrzModuleSettings> | null;
 
   /**
-   * Indicates whether character validation is enabled.
+   * Settings for the barcode extraction module.
    *
-   * Allow only results containing expected characters for a given field.
-   * Each field is validated against a set of rules.
-   * All fields have to be successfully validated in order to successfully scan a document.
-   * Setting is used to improve scanning accuracy.
-   * If set to `true`, when an invalid character is detected `ProcessingStatus.InvalidCharactersFound` is returned.
+   * This module manages the detection and data extraction from various 1D and 2D
+   * barcode formats (such as PDF417, QR codes, and various retail codes).
    *
-   * Default: `true`
-   */
-  enableCharacterValidation: boolean;
-
-  /**
-   * Defines the minimum required margin (in percentage) between the edge of the input image and the document.
+   * It can operate as a standalone module or in combination with document capture.
    *
-   * The setting is applicable only when using images from Video source.
-   * The setting is not applicable if `scanCroppedDocumentImage = true` (it will be ignored).
-   * This setting is implemented to comply with regulations in certain countries that mandate documents
-   * to be stored with adequate margins in the image.
+   * Set to `null` to disable this module.
    *
-   * Default: `0.02` (also recommended value)
+   * See {@link BarcodeModuleSettings} for more information.
    */
-  inputImageMargin: number;
+  barcodeModule: Partial<BarcodeModuleSettings> | null;
 
   /**
-   * Indicates whether backside of unsupported document should be scanned also.
+   * Settings for the VIZ (Visual Inspection Zone) extraction module.
    *
-   * By default, back side of the document will not be scanned if only the front side is supported for a specific
-   * document.
+   * This module is responsible for extracting data from the document's
+   * visual fields.
    *
-   * Default: `false`
-   */
-  scanUnsupportedBack: boolean;
-
-  /**
-   * Indicates whether scanning can continue to the next side despite an uncertain front-side scan.
+   * It supports features such as character validation for increased accuracy,
+   * signature image extraction, and data aggregation across multiple video frames.
    *
-   * This only applies to images from Photo input image source - for images from Video source, setting will be
-   * ignored.
+   * Set to `null` to disable this module.
    *
-   * Default: `false`
+   * See {@link VizModuleSettings} for more information.
    */
-  allowUncertainFrontSideScan: boolean;
+  vizModule: Partial<VizModuleSettings> | null;
 
   /**
    * The maximum allowed mismatches per field during data matching.
    *
    * Configures the maximum number of characters per field that can be inconsistent during data matching.
-   * By defualt, no mismatches are allowed.
    *
-   * Default: `0`
+   * By default, no mismatches are allowed.
    */
   maxAllowedMismatchesPerField: number;
-
-  /**
-   * Indicates whether only the passport data page should be scanned.
-   *
-   * Scan only the data page ( page containing MRZ ) of the passport.
-   * If set to `false`, it will be required to scan the second page of certain passports.
-   *
-   * Default: `true`
-   */
-  scanPassportDataPageOnly: boolean;
-
-  /**
-   * Configures the image processing settings during the scanning process.
-   *
-   * Allows customization of cropped image handling, such as dotsPerInch, extensions, and
-   * whether images should be returned for the document, face or signature regions.
-   *
-   * See {@link CroppedImageSettings} for more information.
-   */
-  croppedImageSettings: CroppedImageSettings;
-
-  /**
-   * Represents the configurable settings for scanning a document.
-   *
-   * This class defines various parameters and policies related to the scanning
-   * process, including image quality handling, data extraction and anonymization,
-   * along with options for frame processing and image extraction.
-   */
-  constructor() {
-    this.blurDetectionLevel = DetectionLevel.Mid;
-    this.skipImagesWithBlur = true;
-    this.glareDetectionLevel = DetectionLevel.Mid;
-    this.skipImagesWithGlare = true;
-    this.tiltDetectionLevel = DetectionLevel.Mid;
-    this.skipImagesWithInadequateLightingConditions = true;
-    this.skipImagesOccludedByHand = true;
-    this.combineResultsFromMultipleInputImages = true;
-    this.enableBarcodeScanOnly = false;
-    this.anonymizationMode = AnonymizationMode.FullResult;
-    this.returnInputImages = false;
-    this.scanCroppedDocumentImage = false;
-    this.recognitionModeFilter = new RecognitionModeFilter();
-    this.enableCharacterValidation = true;
-    this.inputImageMargin = 0.02;
-    this.scanUnsupportedBack = false;
-    this.allowUncertainFrontSideScan = false;
-    this.maxAllowedMismatchesPerField = 0;
-    this.scanPassportDataPageOnly = true;
-    this.croppedImageSettings = new CroppedImageSettings();
-  }
-}
+}>;
 
 /**
  * Allows customization of various aspects of the UI
  * used during the scanning process.
  *
  */
-export class BlinkIdScanningUxSettings {
+export type BlinkIdScanningUxSettings = Partial<{
   /**
    * A boolean indicating whether to show a help button
    * and enable help screens during the scanning session.
@@ -486,67 +226,7 @@ export class BlinkIdScanningUxSettings {
    * This value represents the user’s choice of front or back camera.
    * The system determines the actual physical camera device.
    *
-   * Default: {@link PrefferedCamera.back}
+   * Default: {@link PreferredCamera.back}
    */
   preferredCamera: PreferredCamera;
-
-  constructor() {
-    this.showHelpButton = true;
-    this.showOnboardingDialog = true;
-    this.allowHapticFeedback = true;
-    this.preferredCamera = PreferredCamera.Back;
-  }
-}
-
-/**
- * Represents the image cropping settings.
- *
- */
-export class CroppedImageSettings {
-  /**
-   * The DPI value for the cropped image.
-   *
-   * Default: `250`
-   */
-  dotsPerInch: number;
-
-  /**
-   * The extension factor for the cropped image.
-   *
-   * Default: `0`
-   */
-  extensionFactor: number;
-
-  /**
-   * Indicates whether the document image should be returned.
-   *
-   * Default: `false`
-   */
-  returnDocumentImage: boolean;
-
-  /**
-   * Indicates whether the face image should be returned.
-   *
-   * Default: `false`
-   */
-  returnFaceImage: boolean;
-
-  /**
-   * Indicates whether the signature image should be returned.
-   *
-   * Default: `false`
-   */
-  returnSignatureImage: boolean;
-
-  /**
-   * Represents the image cropping settings.
-   *
-   */
-  constructor() {
-    this.dotsPerInch = 250;
-    this.extensionFactor = 0;
-    this.returnDocumentImage = false;
-    this.returnFaceImage = false;
-    this.returnSignatureImage = false;
-  }
-}
+}>;