@microblink/blinkid-react-native 7.7.0 → 8000.0.0

package/lib/typescript/src/blinkIdSettings.d.ts

@@ -1,9 +1,9 @@
-import { DetectionLevel, AnonymizationMode, ScanningMode, DocumentRules, DocumentAnonymizationSettings, RecognitionModeFilter, PreferredCamera } from "./types";
+import type { ScanningMode, PreferredCamera, DocumentCaptureModuleSettings, MrzModuleSettings, BarcodeModuleSettings, VizModuleSettings } from "./types";
 /**
  *  Settings for the initialization of the BlinkID SDK.
  *
  */
-export declare class BlinkIdSdkSettings {
+export type BlinkIdSdkSettings = {
     /**
      * License key for the native SDK.
      *
@@ -57,12 +57,7 @@ export declare 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);
-}
+};
 /**
  * Represents the configuration settings for a scanning session.
  *
@@ -70,7 +65,7 @@ export declare class BlinkIdSdkSettings {
  * scanning mode, and specific scanning configurations that define how the scanning
  * session should behave.
  */
-export declare class BlinkIdSessionSettings {
+export type BlinkIdSessionSettings = Partial<{
     /**
      * The scanning mode to be used during the scanning session.
      *
@@ -85,24 +80,22 @@ export declare 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();
-}
+    inactivityTimeoutDuration: number;
+}>;
 /**
  * Represents the configurable settings for scanning a document.
  *
@@ -111,263 +104,51 @@ export declare class BlinkIdSessionSettings {
  * along with options for frame processing and image extraction.
  *
  *  */
-export declare 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;
+export type BlinkIdScanningSettings = Partial<{
+    documentCaptureModule: Partial<DocumentCaptureModuleSettings> | null;
+    mrzModule: Partial<MrzModuleSettings> | null;
     /**
-     * Redact fields for specific document class.
+     * Settings for the barcode extraction module.
      *
-     * 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.
+     * This module manages the detection and data extraction from various 1D and 2D
+     * barcode formats (such as PDF417, QR codes, and various retail codes).
      *
-     * See {@link DocumentAnonymizationSettings} for more information.
-     */
-    customDocumentAnonymizationSettings?: DocumentAnonymizationSettings[];
-    /**
-     * Indicates whether input images should be returned.
-     *
-     * 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.
-     *
-     * Default: `false`
-     */
-    scanCroppedDocumentImage: boolean;
-    /**
-     * The filter for recognition modes.
+     * It can operate as a standalone module or in combination with document capture.
      *
-     * 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.
+     * Set to `null` to disable this module.
      *
-     * This setting is experimental and it will be removed in upcoming releases.
-     *
-     * By default all modes are enabled (set to `true`).
+     * See {@link BarcodeModuleSettings} for more information.
      */
-    recognitionModeFilter: RecognitionModeFilter;
+    barcodeModule: Partial<BarcodeModuleSettings> | null;
     /**
-     * Indicates whether character validation is enabled.
+     * Settings for the VIZ (Visual Inspection Zone) 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 is responsible for extracting data from the document's
+     * visual fields.
      *
-     * Default: `true`
-     */
-    enableCharacterValidation: boolean;
-    /**
-     * Defines the minimum required margin (in percentage) between the edge of the input image and the document.
+     * It supports features such as character validation for increased accuracy,
+     * signature image extraction, and data aggregation across multiple video frames.
      *
-     * 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 VizModuleSettings} for more information.
      */
-    inputImageMargin: number;
-    /**
-     * Indicates whether backside of unsupported document should be scanned also.
-     *
-     * By default, back side of the document will not be scanned if only the front side is supported for a specific
-     * document.
-     *
-     * Default: `false`
-     */
-    scanUnsupportedBack: boolean;
-    /**
-     * Indicates whether scanning can continue to the next side despite an uncertain front-side scan.
-     *
-     * This only applies to images from Photo input image source - for images from Video source, setting will be
-     * ignored.
-     *
-     * Default: `false`
-     */
-    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();
-}
+}>;
 /**
  * Allows customization of various aspects of the UI
  * used during the scanning process.
  *
  */
-export declare class BlinkIdScanningUxSettings {
+export type BlinkIdScanningUxSettings = Partial<{
     /**
      * A boolean indicating whether to show a help button
      * and enable help screens during the scanning session.
@@ -398,50 +179,8 @@ export declare 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();
-}
-/**
- * Represents the image cropping settings.
- *
- */
-export declare 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();
-}
+}>;
 //# sourceMappingURL=blinkIdSettings.d.ts.map

package/lib/typescript/src/blinkIdSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blinkIdSettings.d.ts","sourceRoot":"","sources":["../../../src/blinkIdSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,6BAA6B,EAC7B,qBAAqB,EACrB,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;gBAED,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,OAAO,EAC3B,mBAAmB,CAAC,EAAE,MAAM,EAC5B,mBAAmB,CAAC,EAAE,MAAM,EAC5B,gBAAgB,CAAC,EAAE,MAAM,EACzB,sBAAsB,CAAC,EAAE,MAAM,EAC/B,kBAAkB,CAAC,EAAE,MAAM;CAW9B;AAED;;;;;;GAMG;AACH,qBAAa,sBAAsB;IACjC;;;;;;;OAOG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;;;;OAOG;;CAMJ;AAED;;;;;;;MAOM;AACN,qBAAa,uBAAuB;IAClC;;;;;;;;;;;;UAYM;IACN,kBAAkB,EAAE,cAAc,CAAC;IAEnC;;;;;;;;;;OAUG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;OAUG;IACH,mBAAmB,EAAE,cAAc,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;;;OASG;IACH,kBAAkB,EAAE,cAAc,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,0CAA0C,EAAE,OAAO,CAAC;IAEpD;;;;;;;;;OASG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;;;;;;OAUG;IACH,qCAAqC,EAAE,OAAO,CAAC;IAE/C;;;;;;;;OAQG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,aAAa,EAAE,CAAC;IAEtC;;;;;;;OAOG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;;;;;;OAOG;IACH,mCAAmC,CAAC,EAAE,6BAA6B,EAAE,CAAC;IACtE;;;;;;;OAOG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;;;;OAMG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;;;;;OASG;IACH,qBAAqB,EAAE,qBAAqB,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;;;OASG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;;;;OAOG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,2BAA2B,EAAE,OAAO,CAAC;IAErC;;;;;;;OAOG;IACH,4BAA4B,EAAE,MAAM,CAAC;IAErC;;;;;;;OAOG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;;;OAOG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;;CAuBJ;AAED;;;;GAIG;AACH,qBAAa,yBAAyB;IACpC;;;;;OAKG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;;;;;;OAQG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,eAAe,EAAE,eAAe,CAAC;;CAQlC;AAED;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;;CAQJ"}
+{"version":3,"file":"blinkIdSettings.d.ts","sourceRoot":"","sources":["../../../src/blinkIdSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,6BAA6B,EAC7B,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;IAC3C;;;;;;;OAOG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEnD;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,yBAAyB,EAAE,MAAM,CAAC;CACnC,CAAC,CAAC;AAEH;;;;;;;MAOM;AACN,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;IAY5C,qBAAqB,EAAE,OAAO,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC;IAYrE,SAAS,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAE7C;;;;;;;;;;;OAWG;IACH,aAAa,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErD;;;;;;;;;;;;OAYG;IACH,SAAS,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAE7C;;;;;;OAMG;IACH,4BAA4B,EAAE,MAAM,CAAC;CACtC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC;IAC9C;;;;;OAKG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;;;;;;OAQG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC,CAAC"}

package/lib/typescript/src/index.d.ts

@@ -1,9 +1,9 @@
-import { BlinkIdScanningResult } from "./blinkIdResult";
+import type { BlinkIdScanningResult } from "./blinkIdResult";
 import type { BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdScanningUxSettings } from "./blinkIdSettings";
-import type { ClassFilter } from "./types";
+import type { ClassFilter, RedactionSettings, RedactionSettingsResolver } from "./types";
 import type { Spec } from "./NativeBlinkidReactNative";
-export { BlinkIdScanningSettings, BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdScanningUxSettings, CroppedImageSettings, } from "./blinkIdSettings";
-export { BlinkIdScanningResult } from "./blinkIdResult";
+export * from "./blinkIdSettings";
+export type { BlinkIdScanningResult } from "./blinkIdResult";
 export * from "./types";
 declare const BlinkidReactNative: Spec;
 export default BlinkidReactNative;
@@ -30,7 +30,10 @@ export default BlinkidReactNative;
  *
  * To obtain a valid license key, please visit https://developer.microblink.com/ or contact us directly at https://help.microblink.com.
  */
-export declare function loadBlinkIdSdk(blinkIdSdkSettings: BlinkIdSdkSettings): Promise<void>;
+export declare function loadBlinkIdSdk(settingsOrSdk: LoadBlinkIdSdkSettings | BlinkIdSdkSettings): Promise<void>;
+export type LoadBlinkIdSdkSettings = {
+    sdkSettings: BlinkIdSdkSettings;
+};
 /**
  * The `unloadBlinkIdSdk` method terminates the BlinkID SDK and releases all associated resources.
  *
@@ -43,11 +46,14 @@ export declare function loadBlinkIdSdk(blinkIdSdkSettings: BlinkIdSdkSettings):
  * @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 declare function unloadBlinkIdSdk(deleteCachedResources: boolean): Promise<void>;
+export declare function unloadBlinkIdSdk({ deleteCachedResources, }?: UnloadBlinkIdSdkSettings): Promise<void>;
+export type UnloadBlinkIdSdkSettings = {
+    deleteCachedResources?: boolean;
+};
 /**
  * The `performScan` method launches the BlinkID scanning process with the default UX properties.
  *
- * It takes the following parameters: {@link BlinkIdSdkSettings}, {@link BlinkIdSessionSettings} and the optional {@link BlinkIdUiSettings} and {@link ClassFilter} settings.
+ * It takes the following parameters: {@link BlinkIdSdkSettings}, {@link BlinkIdSessionSettings} {@link BlinkIdScanningUxSettings}, {@link RedactionSettingsResolver} {@link ClassFilter}.
  *
  * It returns the {@link BlinkIdScanningResult}.
  *
@@ -58,16 +64,28 @@ export declare function unloadBlinkIdSdk(deleteCachedResources: boolean): Promis
  * @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 Scanning UX Settings - the class that allows customization of various aspects of the UI & UX used during the scanning process.
+ * @param scanningUxSettings - 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.
  *
+ * @param redactionSettingsResolver - The optional Redaction Settings Resolver- Represents the document redaction settings. Use this when need per-document redaction behavior is neede — for example,
+ * anonymizing different fields depending on the document's country or type.
+ *
+ * The resolver is invoked by the SDK immediately before the scanning result is finalized.
+ *
  * @returns `BlinkIdScanningResult` - BlinkID scanning result - 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.
  *
  */
-export declare function performScan(blinkIdSdkSettings: BlinkIdSdkSettings, blinkIdSessionSettings: BlinkIdSessionSettings, blinkIdScanningUxSettings?: BlinkIdScanningUxSettings, classFilter?: ClassFilter): Promise<BlinkIdScanningResult>;
+export declare function performScan(settingsOrSdk: PerformScanSettings | BlinkIdSdkSettings, sessionSettings?: BlinkIdSessionSettings, scanningUxSettings?: BlinkIdScanningUxSettings, classFilter?: ClassFilter, redactionSettingsResolver?: RedactionSettingsResolver): Promise<BlinkIdScanningResult>;
+export type PerformScanSettings = {
+    sdkSettings: BlinkIdSdkSettings;
+    sessionSettings: BlinkIdSessionSettings;
+    scanningUxSettings?: BlinkIdScanningUxSettings;
+    classFilter?: ClassFilter;
+    redactionSettingsResolver?: RedactionSettingsResolver;
+};
 /**
  * The `performDirectApiScan` platform channel method launches the BlinkID scanning process inteded for information extraction from static images.
  *
@@ -79,6 +97,9 @@ export declare function performScan(blinkIdSdkSettings: BlinkIdSdkSettings, blin
  *
  * @param blinkIdSessionSettings - BlinkID Session Settings - the class that contains various settings for the scanning session. It contains the settings for the `ScanningMode` and `BlinkIdScanningSettings`, which define various parameters that control the scanning process.
  *
+ * @param redactionSettings - The optional Redaction settings - Represents the document redaction settings. Use this when need per-document redaction behavior is neede — for example,
+ * anonymizing different fields depending on the document's country or type.
+ *
  * @param firstImage - The `firstImage` Base64 string - image that represents one side of the document.
  * If the document contains two sides and the `ScanningMode` is set to `automatic`, this should contain the image of the front side of the document. In case the [ScanningMode] is set to `single`, it can
  * be either the front or the back side of the document.
@@ -88,5 +109,12 @@ export declare function performScan(blinkIdSdkSettings: BlinkIdSdkSettings, blin
  * @returns `BlinkIdScanningResult` - BlinkID scanning result - 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.
  */
-export declare function performDirectApiScan(blinkIdSdkSettings: BlinkIdSdkSettings, blinkIdSessionSettings: BlinkIdSessionSettings, firstImage: string, secondImage?: string): Promise<BlinkIdScanningResult>;
+export declare function performDirectApiScan(settingsOrSdk: PerformDirectApiScanSettings | BlinkIdSdkSettings, sessionSettings?: BlinkIdSessionSettings, firstImage?: string, secondImage?: string, redactionSettings?: RedactionSettings): Promise<BlinkIdScanningResult>;
+export type PerformDirectApiScanSettings = {
+    sdkSettings: BlinkIdSdkSettings;
+    sessionSettings: BlinkIdSessionSettings;
+    redactionSettings?: RedactionSettings;
+    firstImage: string;
+    secondImage?: string;
+};
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAGvD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,sBAAsB,EACtB,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGxD,cAAc,SAAS,CAAC;AAExB,QAAA,MAAM,kBAAkB,EAAE,IAAoD,CAAC;AAE/E,eAAe,kBAAkB,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,cAAc,CAClC,kBAAkB,EAAE,kBAAkB,GACrC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,gBAAgB,CACpC,qBAAqB,EAAE,OAAO,GAC7B,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,WAAW,CAC/B,kBAAkB,EAAE,kBAAkB,EACtC,sBAAsB,EAAE,sBAAsB,EAC9C,yBAAyB,CAAC,EAAE,yBAAyB,EACrD,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO,CAAC,qBAAqB,CAAC,CAShC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,oBAAoB,CACxC,kBAAkB,EAAE,kBAAkB,EACtC,sBAAsB,EAAE,sBAAsB,EAC9C,UAAU,EAAE,MAAM,EAClB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAShC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,WAAW,EACX,iBAAiB,EACjB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAGvD,cAAc,mBAAmB,CAAC;AAGlC,YAAY,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAG7D,cAAc,SAAS,CAAC;AAExB,QAAA,MAAM,kBAAkB,EAAE,IAAoD,CAAC;AAE/E,eAAe,kBAAkB,CAAC;AA6GlC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,cAAc,CAClC,aAAa,EAAE,sBAAsB,GAAG,kBAAkB,GACzD,OAAO,CAAC,IAAI,CAAC,CASf;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,qBAA6B,GAC9B,GAAE,wBAA6B,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,WAAW,CAC/B,aAAa,EAAE,mBAAmB,GAAG,kBAAkB,EACvD,eAAe,CAAC,EAAE,sBAAsB,EACxC,kBAAkB,CAAC,EAAE,yBAAyB,EAC9C,WAAW,CAAC,EAAE,WAAW,EACzB,yBAAyB,CAAC,EAAE,yBAAyB,GACpD,OAAO,CAAC,qBAAqB,CAAC,CAwBhC;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,kBAAkB,CAAC;IAChC,eAAe,EAAE,sBAAsB,CAAC;IACxC,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;IAC/C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;CACvD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,oBAAoB,CACxC,aAAa,EAAE,4BAA4B,GAAG,kBAAkB,EAChE,eAAe,CAAC,EAAE,sBAAsB,EACxC,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,OAAO,CAAC,qBAAqB,CAAC,CAoBhC;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,WAAW,EAAE,kBAAkB,CAAC;IAChC,eAAe,EAAE,sBAAsB,CAAC;IACxC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}