@microblink/blinkid-react-native 7.7.0 → 8001.0.0

package/src/blinkIdSettings.ts

@@ -1,459 +1,348 @@
-import {
-  DetectionLevel,
-  AnonymizationMode,
+import type {
   ScanningMode,
-  DocumentRules,
-  DocumentAnonymizationSettings,
-  RecognitionModeFilter,
   PreferredCamera,
+  DocumentCaptureModuleSettings,
+  MrzModuleSettings,
+  BarcodeModuleSettings,
+  VizModuleSettings,
 } from "./types";
 
 /**
- *  Settings for the initialization of the BlinkID SDK.
- *
+ * Network timeouts for SDK resource downloads. Values are in milliseconds.
+ * Omit unset fields to keep the native SDK default for that timeout (30 seconds
+ * on current BlinkID native SDKs).
  */
-export class BlinkIdSdkSettings {
-  /**
-   * License key for the native SDK.
-   *
-   */
-  licenseKey: string;
-
-  /**
-   * Optional licensee string if the provided license key is not tied to the single application ID.
-   */
-  licensee?: string;
+export type RequestTimeout = {
+  connectionTimeoutMilliseconds?: number;
+  writeTimeoutMilliseconds?: number;
+  readTimeoutMilliseconds?: number;
+};
 
+/**
+ * Configuration for base (non-OTA) SDK resources: download, cache location, and timeouts.
+ *
+ * Maps to native `ResourcesConfig` on Android and `ResourcesConfig` /
+ * `resourcesConfiguration` on iOS.
+ *
+ * When omitted on {@link BlinkIdSdkSettings}, the native SDK defaults are used
+ * (`download: true`, platform default `serviceUrl` / `localFolder`, default timeouts).
+ *
+ * @example
+ * ```ts
+ * const sdkSettings: BlinkIdSdkSettings = {
+ *   licenseKey,
+ *   resourcesConfig: { download: true },
+ * };
+ * ```
+ */
+export type ResourcesConfig = {
   /**
-   * Whether resources required for on-device image processing should be downloaded and cached
-   * on first initialization of the SDK.
+   * Whether resources required for on-device image processing should be downloaded
+   * and cached on first initialization of the SDK.
    *
-   * If set to false, you need to package all the required
-   * resources in your application's assets.
+   * If `false`, package the required resources in the app (Android assets /
+   * iOS bundle) and set {@link localFolder} / {@link bundleIdentifier} as needed.
    *
+   * Default: `true`.
    */
-  downloadResources?: boolean;
+  download?: boolean;
 
   /**
-   * If resources are to be downloaded, the following is the URL where the resources are hosted.
+   * URL where base resources are hosted when {@link download} is enabled.
    *
-   * URL: `"https://models.cdn.microblink.com/resources"`
-   */
-  resourceDownloadUrl?: string;
-
-  /**
-   * Local folder name where resources will be downloaded and cached.
+   * Default: `"https://models.cdn.microblink.com/resources"`.
    *
-   * If resources are being downloaded, this defines the name of the folder within your
-   * application's cache folder where resources will be cached.
+   * Do not use the OTA host (`https://blinkid-ota.microblink.com`) here.
    */
-  resourceLocalFolder?: string;
+  serviceUrl?: string;
 
   /**
-   * [iOS-specific] If resources downloading is disabled, this defines the bundle of your app where the resources reside.
+   * Folder name under the app cache (download enabled) or assets path (download
+   * disabled) where base resources are stored.
    *
-   */
-  bundleIdentifier?: string;
-
-  /**
-   * Timeout settings for resource downloads.
+   * Platform defaults when omitted:
+   * - Android: `"microblink/blinkid"`
+   * - iOS: `"MLModels"`
    *
+   * Keep this separate from the OTA resources folder.
    */
-  resourceRequestTimeout?: number;
+  localFolder?: string;
+
   /**
-   * Set a custom HTTPS URL to be used as a proxy for Ping and license checks.
-   * The proxy URL will be applied only if the license has the appropriate rights.
-   *
-   * The URL must use the HTTPS protocol. Example: https://your-proxy.com/
-   *
-   * If this value is defined, SDK initialization will not be successful in the following cases:
-   *    - if the URL does not use HTTPS or if the URL is invalid
-   *    - if the license does not allow proxy usage
-   *
+   * Network timeouts for resource downloads, in milliseconds.
+   * Omit to use native SDK defaults.
    */
-  microblinkProxyURL?: string;
+  requestTimeout?: RequestTimeout;
 
   /**
+   * [iOS] Bundle identifier of the app bundle that contains prebundled resources
+   * when {@link download} is `false`.
    *
-   * Settings for the initialization of the BlinkID SDK.
+   * Maps to native `ResourcesConfig.bundleUrl` (the bridge resolves the
+   * identifier to a bundle URL). Ignored on Android — use {@link localFolder}
+   * under assets instead.
    */
-  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;
-  }
-}
+  bundleIdentifier?: string;
+};
 
 /**
- * Represents the configuration settings for a scanning session.
+ * Configuration for over-the-air (OTA) document resources.
  *
- * This class holds the settings related to the resources initialization,
- * scanning mode, and specific scanning configurations that define how the scanning
- * session should behave.
+ * Behaves similarly to {@link ResourcesConfig}, with update checks and a
+ * `strict` failure mode. Maps to native `OtaResourcesConfig` on Android and
+ * `OTAResourcesConfig` / `otaResourcesConfiguration` on iOS.
+ *
+ * When omitted on {@link BlinkIdSdkSettings}, native `OtaResourcesConfig()` /
+ * `OTAResourcesConfig()` defaults apply (`checkForUpdates: true`,
+ * `strict: false`, platform default URL/folder).
+ *
+ * Do not cross-wire hosts or folders with {@link ResourcesConfig}:
+ * - OTA default URL: `"https://blinkid-ota.microblink.com"`
+ * - Base resources URL: `"https://models.cdn.microblink.com/resources"`
+ *
+ * @example
+ * ```ts
+ * const sdkSettings: BlinkIdSdkSettings = {
+ *   licenseKey,
+ *   otaResourcesConfig: { checkForUpdates: true, strict: false },
+ * };
+ * ```
  */
-export class BlinkIdSessionSettings {
+export type OtaResourcesConfig = {
   /**
-   * The scanning mode to be used during the scanning session.
-   *
-   * Specifies whether the scanning is for a single side of a document or multiple
-   * sides, as defined in {@link ScanningMode}. The default is set to `automatic`, which
-   * automatically determines the number of sides to scan.
+   * Whether the SDK checks for and downloads updated OTA resources on
+   * initialization.
    *
-   */
-  scanningMode: ScanningMode;
-
-  /**
-   * The specific scanning settings for the scanning session.
+   * When `false`, no update check is performed and cached/bundled OTA resources
+   * are used as-is. First-run downloads are still required when OTA resources
+   * are missing locally — this flag only suppresses update checks, not the
+   * initial fetch.
    *
-   * Defines various parameters that control the scanning process.
+   * Default: `true`.
    */
-  scanningSettings: BlinkIdScanningSettings;
+  checkForUpdates?: boolean;
 
   /**
-   * Duration in seconds before scanning step times out and is cancelled.
+   * How to handle a failed OTA update download during initialization.
+   * Only applied when {@link checkForUpdates} is `true`.
    *
-   * If less than zero, scanning will not time out.
-   * Defaults to 15000 (miliseconds)
+   * - `false` (default): initialization continues and the SDK falls back to
+   *   cached/bundled OTA resources.
+   * - `true`: SDK initialization fails if the OTA download fails. Callers must
+   *   handle that error path.
    */
-  stepTimeoutDuration: number;
+  strict?: boolean;
 
   /**
+   * URL of the OTA versions/download service used when {@link checkForUpdates}
+   * is `true`.
    *
-   * Represents the configuration settings for a scanning session.
+   * Default: `"https://blinkid-ota.microblink.com"`.
    *
-   * This class holds the settings related to the resources initialization,
-   * scanning mode, and specific scanning configurations that define how the scanning
-   * session should behave.
+   * Do not use the base resources host (`https://models.cdn.microblink.com/resources`) here.
    */
-  constructor() {
-    this.scanningMode = ScanningMode.Automatic;
-    this.scanningSettings = new BlinkIdScanningSettings();
-    this.stepTimeoutDuration = 15000;
-  }
-}
+  serviceUrl?: string;
 
-/**
- * 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.
- *
- *  */
-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.
+   * Folder where OTA resources are downloaded and cached (or found when
+   * prebundled).
    *
-   * `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.
+   * Platform defaults when omitted:
+   * - Android: `"microblink/blinkid/ota"`
+   * - iOS: `"OTAMLModels"`
    *
-   * Default: {@link DetectionLevel.Mid}
-   *  */
-  blurDetectionLevel: DetectionLevel;
+   * Keep this separate from {@link ResourcesConfig.localFolder}.
+   */
+  localFolder?: string;
 
   /**
-   * 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`
+   * Network timeouts for OTA resource downloads, in milliseconds.
+   * Omit to use native SDK defaults.
    */
-  skipImagesWithBlur: boolean;
+  requestTimeout?: RequestTimeout;
 
   /**
-   * 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.
+   * [iOS] Bundle identifier of the app bundle that contains prebundled OTA
+   * resources.
    *
-   * Default: {@link DetectionLevel.Mid}
+   * Maps to native `OTAResourcesConfig.bundleUrl` (the bridge resolves the
+   * identifier to a bundle URL). Ignored on Android — place OTA assets under
+   * {@link localFolder} (e.g. `assets/microblink/blinkid/ota`) instead.
    */
-  glareDetectionLevel: DetectionLevel;
+  bundleIdentifier?: string;
+};
 
+/**
+ * Settings for the initialization of the BlinkID SDK.
+ */
+export type BlinkIdSdkSettings = {
   /**
-   * 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`
+   * License key for the native SDK.
    */
-  skipImagesWithGlare: boolean;
+  licenseKey: string;
 
   /**
-   * 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}
+   * Optional licensee string if the provided license key is not tied to a single
+   * application ID.
    */
-  tiltDetectionLevel: DetectionLevel;
+  licensee?: string;
 
   /**
-   * Indicates whether images with inadequate lighting conditions should be rejected.
+   * Base resource download and cache configuration.
    *
-   * 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`.
+   * Replaces the former flat fields `downloadResources`, `resourceDownloadUrl`,
+   * `resourceLocalFolder`, `resourceRequestTimeout`, and `bundleIdentifier`.
    *
-   * Default: `true`
+   * When omitted, native `ResourcesConfig()` defaults apply.
+   *
+   * @see {@link ResourcesConfig}
    */
-  skipImagesWithInadequateLightingConditions: boolean;
+  resourcesConfig?: ResourcesConfig;
 
   /**
-   * Indicates whether images occluded by hand should be rejected.
+   * Over-the-air (OTA) resource download and cache configuration.
    *
-   * 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.
+   * When omitted, native OTA defaults apply (update checks enabled, non-strict).
    *
-   * Default: `true`
+   * @see {@link OtaResourcesConfig}
    */
-  skipImagesOccludedByHand: boolean;
+  otaResourcesConfig?: OtaResourcesConfig;
 
   /**
-   * Indicates whether the aggregation of data from multiple images is enabled.
+   * Set a custom HTTPS URL to be used as a proxy for Ping and license checks.
+   * The proxy URL will be applied only if the license has the appropriate rights.
    *
-   *  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.
+   * The URL must use the HTTPS protocol. Example: https://your-proxy.com/
+   *
+   * If this value is defined, SDK initialization will not be successful in the following cases:
+   *    - if the URL does not use HTTPS or if the URL is invalid
+   *    - if the license does not allow proxy usage
    *
-   * Default: `true`
    */
-  combineResultsFromMultipleInputImages: boolean;
+  microblinkProxyURL?: string;
+};
 
+/**
+ * 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.
+ */
+export type BlinkIdSessionSettings = Partial<{
   /**
-   * Enables barcode recognition to proceed even if the initial VIZ extraction fails.
+   * The scanning mode to be used during the scanning session.
    *
-   * 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.
+   * Specifies whether the scanning is for a single side of a document or multiple
+   * sides, as defined in {@link ScanningMode}. The default is set to `automatic`, which
+   * automatically determines the number of sides to scan.
    *
-   * Default: `false`
    */
-  enableBarcodeScanOnly: boolean;
+  scanningMode: ScanningMode;
 
   /**
-   * 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.
+   * The specific scanning settings for the scanning session.
+   *
+   * Defines various parameters that control the scanning process.
    */
-  customDocumentRules?: DocumentRules[];
+  scanningSettings: Partial<BlinkIdScanningSettings>;
 
   /**
-   * 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.
+   * Duration in milliseconds before a scanning step times out and is cancelled.
    *
-   * Default: {@link AnonymizationMode.fullResult}
+   * 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).
    */
-  anonymizationMode: AnonymizationMode;
+  stepTimeoutDuration: number;
 
   /**
-   * 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.
+   * Duration in milliseconds of UI inactivity (no state change) before timeout.
    *
-   * See {@link DocumentAnonymizationSettings} for more information.
+   * Resets whenever the UI state changes (reticle type or message).
+   * Set to `0` to disable the inactivity timeout. Defaults to `10000` (10 seconds).
    */
-  customDocumentAnonymizationSettings?: DocumentAnonymizationSettings[];
-  /**
-   * Indicates whether input images should be returned.
+  inactivityTimeoutDuration: number;
+}>;
+
+/**
+ * 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.
+ *
+ *  */
+export type BlinkIdScanningSettings = Partial<{
+  /*
+   * Settings for the document capture module.
    *
-   * Save the input images at the moment of the data extraction or timeout.
-   * This significantly increases memory consumption. The scanning performance is not affected.
+   * 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).
    *
-   * 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 +375,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;
-  }
-}
+}>;