@microblink/blinkid-core 7.3.2 → 7.4.1

package/types/index.rollup.d.ts

@@ -19,15 +19,18 @@ export declare type AddressDetailedInfo = {
 
 /** Represents a string result for a specific alphabet */
 export declare type AlphabetStringResult = {
+    /** The value of the string result. */
     value: string;
+    /** The location of the string result. */
     location?: Rectangle;
+    /** The side of the string result. */
     side?: ScanningSide;
 };
 
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
-/** Represents the type of the alphabet used in the document */
+/** Represents the type of the alphabet used in the document. */
 export declare type AlphabetType = "latin" | "arabic" | "cyrillic" | "greek";
 
 /**
@@ -57,8 +60,11 @@ export declare type BarcodeData = {
     rawData: Uint8Array;
 };
 
+/** Represents a key-value pair of a barcode element. */
 export declare type BarcodeElement = {
+    /** The key of the barcode element. */
     key: BarcodeElementKey;
+    /** The value of the barcode element. */
     value: string;
 };
 
@@ -66,8 +72,8 @@ export declare type BarcodeElement = {
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 /**
- * BarcodeElementKey defines additional fields present in the barcode. Currently, this is
- * only used for AAMVACompliant documents.
+ * BarcodeElementKey defines additional fields present in the barcode.
+ * Currently, this is only used for AAMVACompliant documents.
  */
 export declare type BarcodeElementKey = 
 /**
@@ -948,6 +954,11 @@ export declare type BarcodeType =
 /** Indicates that PDF417 2D barcode has been detected. */
 | "pdf417-barcode";
 
+/**
+ * The BlinkID bindings.
+ *
+ * @ignore
+ */
 export declare interface BlinkIdBindings {
     createBlinkIdScanningSession: (sessionSettings: BlinkIdSessionSettings) => BlinkIdScanningSession;
     initializeWithLicenseKey: (licenceKey: string, userId: string, allowHelloMessage: boolean) => LicenseUnlockResult;
@@ -956,8 +967,20 @@ export declare interface BlinkIdBindings {
     setPingProxyUrl: (url: string) => void;
 }
 
+/**
+ * Represents the BlinkID core instance.
+ *
+ * This type extends the Remote type from Comlink, which is used to proxy calls to the BlinkID worker.
+ * It simplifies the type to remove unnecessary complexity.
+ */
 export declare type BlinkIdCore = Simplify<Remote<BlinkIdWorkerProxy>>;
 
+/**
+ * Configuration options for initializing the BlinkID core.
+ *
+ * This type extends the BlinkIdWorkerInitSettings type by making the userId and useLightweightBuild properties optional.
+ * It allows for partial configuration of the initialization settings.
+ */
 export declare type BlinkIdInitSettings = SetOptional<BlinkIdWorkerInitSettings, "userId" | "useLightweightBuild">;
 
 /**
@@ -974,6 +997,7 @@ export declare type BlinkIdProcessResult = {
     resultCompleteness: ResultCompleteness;
 };
 
+/** Represents the final complete result of the scanning process. */
 export declare type BlinkIdScanningResult = {
     /** Scanning mode used to scan current document */
     mode?: RecognitionMode;
@@ -1087,9 +1111,15 @@ export declare type BlinkIdScanningSession = EmbindObject<{
      * Processes the input camera frame
      *
      * @param image The frame to process
+     * @returns The `BlinkIdProcessResult` if successful, `BlinkIdSessionError` if
+     *   failed
      */
     process: (image: ImageData) => BlinkIdProcessResult | BlinkIdSessionError;
-    /** Returns the {@link BlinkIdScanningResult} */
+    /**
+     * Returns the result of the scanning session.
+     *
+     * @returns The `BlinkIdScanningResult`
+     */
     getResult: () => BlinkIdScanningResult;
 }>;
 
@@ -1098,15 +1128,14 @@ export declare type BlinkIdScanningSession = EmbindObject<{
  * `BlinkIdScanningSession.reset`.
  */
 export declare type BlinkIdSessionError = {
+    /** The error type. */
     error: BlinkIdSessionErrorType;
 };
 
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
-/**
- * Represents the error statuses returned from the `BlinkIDScanningSession`.
- */
+/** Represents the error statuses returned from the `BlinkIDScanningSession`. */
 export declare type BlinkIdSessionErrorType = "document-scanned" | "result-retrieved";
 
 /**
@@ -1115,42 +1144,91 @@ export declare type BlinkIdSessionErrorType = "document-scanned" | "result-retri
  * This structure holds the settings related to the resources initialization,
  * input image source, scanning mode, and specific scanning configurations that
  * define how the scanning session should behave.
+ *
+ * The settings control various aspects of the scanning process including:
+ *
+ * - Input source (video stream or single photo)
+ *
+ * - Scanning mode (single or multiple sides)
+ *
+ * - Document detection and quality analysis
+ *
+ * - Image processing and result extraction
+ *
+ * @public
  */
 export declare type BlinkIdSessionSettings = {
     /**
      * The type of image source for the scanning session.
      *
      * Defines whether the images are sourced from a video stream or a single
-     * photo, as defined by {@link InputImageSource}. The default is set to
-     * `video`.
+     * photo, as defined by `InputImageSource`. The default is set to `video` for
+     * real-time scanning through a camera feed.
+     *
+     * - `video` - Uses continuous camera feed for scanning
+     *
+     * - `photo` - Uses a single captured photo for scanning
+     *
+     * @defaultValue `video`
      */
     inputImageSource: InputImageSource;
     /**
      * 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.
+     * multiple sides, as defined in `ScanningMode`. The default is set to
+     * `automatic`, which automatically determines the number of sides to scan
+     * based on the detected document type.
+     *
+     * - `automatic` - Automatically determines required sides
+     *
+     * - `single` - Scans only one side
+     *
+     * @defaultValue `automatic`
      */
     scanningMode: ScanningMode;
     /**
      * The specific scanning settings for the scanning session.
      *
-     * Defines various parameters that control the scanning process.
+     * Defines various parameters that control the scanning process including:
+     *
+     * - Document detection and quality thresholds
+     * - Image processing options
+     * - Result extraction and validation rules
+     * - Document-specific scanning behaviors
+     *
+     * @see `ScanningSettings` for detailed configuration options
      */
     scanningSettings: ScanningSettings;
 };
 
+/**
+ * The BlinkID Wasm module.
+ *
+ * @ignore
+ */
 export declare interface BlinkIdWasmModule extends BlinkIdBindings, EmscriptenModule {
 }
 
+/**
+ * The BlinkID worker.
+ */
 declare class BlinkIdWorker {
     #private;
+    /**
+     * The progress status callback.
+     */
     progressStatusCallback?: ProgressStatusCallback;
     /**
      * This method initializes everything.
      */
     initBlinkId(settings: BlinkIdWorkerInitSettings, defaultSessionSettings: BlinkIdSessionSettings, progressCallback?: ProgressStatusCallback): Promise<void>;
+    /**
+     * This method creates a BlinkID scanning session.
+     *
+     * @param options - The options for the session.
+     * @returns The session.
+     */
     createBlinkIdScanningSession(options?: PartialBlinkIdSessionSettings): {
         reset: () => void | BlinkIdSessionError;
         getResult: () => BlinkIdScanningResult;
@@ -1160,10 +1238,32 @@ declare class BlinkIdWorker {
         isAliasOf: (other: any) => boolean;
         process: (image: ImageData) => ProcessResultWithBuffer;
     } & {
+        /**
+         * Gets the settings.
+         *
+         * @returns The settings.
+         */
         getSettings: () => BlinkIdSessionSettings;
+        /**
+         * Shows the demo overlay.
+         *
+         * @returns Whether the demo overlay is shown.
+         */
         showDemoOverlay: () => boolean;
+        /**
+         * Shows the production overlay.
+         *
+         * @returns Whether the production overlay is shown.
+         */
         showProductionOverlay: () => boolean;
     } & ProxyMarked;
+    /**
+     * This method creates a proxy session.
+     *
+     * @param session - The session.
+     * @param sessionSettings - The session settings.
+     * @returns The proxy session.
+     */
     createProxySession(session: BlinkIdScanningSession, sessionSettings: BlinkIdSessionSettings): WorkerScanningSession & ProxyMarked;
     /**
      * This method is called when the worker is terminated.
@@ -1173,10 +1273,25 @@ declare class BlinkIdWorker {
      * Terminates the workers and the Wasm runtime.
      */
     terminate(): void;
+    /**
+     * If the ping is enabled, this method will return 1.
+     *
+     * @returns 1 if the ping is enabled, 0 otherwise.
+     */
     ping(): number;
 }
 
+/**
+ * Initialization settings for the BlinkID worker.
+ *
+ * These settings control how the BlinkID worker is initialized and configured,
+ * including resource locations, memory allocation, and build variants.
+ */
 export declare type BlinkIdWorkerInitSettings = {
+    /**
+     * The license key required to unlock and use the BlinkID SDK.
+     * This must be a valid license key obtained from Microblink.
+     */
     licenseKey: string;
     /**
      * The URL of the Microblink proxy server. This proxy handles requests to Microblink's Baltazar and Ping servers.
@@ -1198,17 +1313,38 @@ export declare type BlinkIdWorkerInitSettings = {
      * Defaults to `window.location.href`, at the root of the current page.
      */
     resourcesLocation?: string;
+    /**
+     * A unique identifier for the user/session.
+     * Used for analytics and tracking purposes.
+     */
     userId: string;
+    /**
+     * The WebAssembly module variant to use.
+     * Different variants may offer different performance/size tradeoffs.
+     */
     wasmVariant?: WasmVariant;
     /**
      * The initial memory allocation for the Wasm module, in megabytes.
+     * Larger values may improve performance but increase memory usage.
      */
     initialMemory?: number;
+    /**
+     * Whether to use the lightweight build of the SDK.
+     * Lightweight builds have reduced size but may have limited functionality.
+     */
     useLightweightBuild: boolean;
 };
 
+/**
+ * The BlinkID worker proxy.
+ */
 export declare type BlinkIdWorkerProxy = Omit<BlinkIdWorker, typeof finalizer>;
 
+/**
+ * Options for a C call.
+ *
+ * @ignore
+ */
 export declare interface CCallOpts {
     async?: boolean | undefined;
 }
@@ -1223,15 +1359,13 @@ export declare type Country = "albania" | "algeria" | "argentina" | "australia"
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 /**
- * fix for postmessage performance
- * https://bugs.chromium.org/p/chromium/issues/detail?id=1439768&q=&can=4
+ * Creates a custom ImageData object with the same properties as the original ImageData.
+ * This is a workaround for the performance issue in Chromium browsers.
+ *
+ * @param imageData - The original ImageData object to be wrapped.
+ * @returns A custom ImageData object with the same properties.
  */
-export declare function createCustomImageData(imageData: ImageData): {
-    data: Uint8ClampedArray<ArrayBufferLike>;
-    width: number;
-    height: number;
-    colorSpace: PredefinedColorSpace;
-};
+export declare function createCustomImageData(imageData: ImageData): ImageData;
 
 /**
  * Creates a Comlink-proxied Web Worker
@@ -1245,20 +1379,40 @@ export declare const createProxyWorker: (resourcesLocation?: string) => Promise<
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
-/** Represents the image cropping options. */
+/**
+ * Represents the image cropping options.
+ *
+ * @public
+ */
 export declare type CroppedImageSettings = {
-    /** The DPI value for the cropped image. */
+    /**
+     * The DPI value for the cropped image - Specifies the resolution of the
+     * output image.
+     */
     dotsPerInch: number;
     /**
-     * The extension factor for the cropped image. Applicable only to
-     * document images. Allowed value is from `0.0` to `1.0`
+     * The extension factor for the cropped image - Determines the additional
+     * space around the detected document. Applicable only to document images.
+     * Allowed value is from `0.0` to `1.0`. This determines how much additional
+     * space around the detected document should be included in the crop.
      */
     extensionFactor: number;
-    /** Indicates whether the document image should be returned. */
+    /**
+     * Whether the document image should be returned - Controls document image
+     * output. When true, the cropped document image will be included in the
+     * result.
+     */
     returnDocumentImage: boolean;
-    /** Indicates whether the face image should be returned. */
+    /**
+     * Whether the face image should be returned - Controls face image output.
+     * When true, the cropped face image will be included in the result.
+     */
     returnFaceImage: boolean;
-    /** Indicates whether the signature image should be returned. */
+    /**
+     * Whether the signature image should be returned - Controls signature image
+     * output. When true, the cropped signature image will be included in the
+     * result.
+     */
     returnSignatureImage: boolean;
 };
 
@@ -1273,9 +1427,11 @@ export declare type DataMatchFieldState = {
 /** Type of field on which data match algorithm has been performed. */
 export declare type DataMatchFieldType = "date-of-birth" | "date-of-expiry" | "document-number" | "document-additional-number" | "document-optional-additional-number" | "personal-id-number";
 
+/** Represents the result of the data match algorithm. */
 export declare type DataMatchResult = {
     /** Info on whether the data extracted from multiple sides matches */
     statePerField?: DataMatchFieldState[];
+    /** The overall state of the data match. */
     overallState: DataMatchState;
 };
 
@@ -1288,7 +1444,11 @@ export declare type DataMatchResult = {
  */
 export declare type DataMatchState = "not-performed" | "failed" | "success";
 
-/** Smart date result structure. */
+/**
+ * Smart date result structure.
+ *
+ * @template S - The type of the string result.
+ */
 export declare type DateResult<S extends string | StringResult> = {
     /** Day in month [1-31] */
     day?: number;
@@ -1304,6 +1464,14 @@ export declare type DateResult<S extends string | StringResult> = {
     successfullyParsed?: boolean;
 };
 
+/**
+ * Default session settings for BlinkID core.
+ *
+ * This is the default session settings for BlinkID core.
+ * It is used to initialize the BlinkID core instance, unless overridden by the user.
+ *
+ * @see BlinkIdSessionSettings for more details.
+ */
 export declare const defaultSessionSettings: BlinkIdSessionSettings;
 
 /** The additional information on the document owner's dependents. */
@@ -1323,8 +1491,11 @@ export declare type DependentInfo = {
  * details.
  */
 export declare type DetailedCroppedImageResult = {
+    /** The image data. */
     image: ImageData;
+    /** The location of the image. */
     location?: Rectangle;
+    /** The side of the image. */
     side?: ScanningSide;
 };
 
@@ -1344,32 +1515,40 @@ export declare type DetailedFieldType = {
  *
  * DetectionLevel is used to configure detection thresholds and enable or
  * disable detection functionality. The levels range from turning detection off
- * completely to setting various levels of sensitivity (low, nid, high).
+ * completely to setting various levels of sensitivity (low, mid, high).
  */
 export declare type DetectionLevel = "off" | "low" | "mid" | "high";
 
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
-/** Represents the status of the document detection process. */
-export declare type DetectionStatus = 
-/** Detection has failed. */
-"failed"
-/** Document has been detected. */
-| "success"
-/** Document has been detected but the camera is too far from the document. */
-| "camera-too-far"
-/** Document has been detected but the camera is too close to the document. */
-| "camera-too-close"
-/** Document has been detected but the camera’s angle is too steep. */
-| "camera-angle-too-steep"
-/**
-* Document has been detected but the document is too close to the camera
-* edge.
-*/
-| "document-too-close-to-camera-edge"
-/** Only part of the document is visible. */
-| "document-partially-visible";
+/**
+ * Represents the status of the document detection process.
+ *
+ * This type represents all possible states that can occur during document detection:
+ *
+ * - `failed`
+ *   - Detection has failed
+ *
+ * - `success`
+ *   - Document has been successfully detected
+ *
+ * - `camera-too-far`
+ *   - Camera is positioned too far from the document
+ *
+ * - `camera-too-close`
+ *   - Camera is positioned too close to the document
+ *
+ * - `camera-angle-too-steep`
+ *   - Camera angle relative to the document is too steep
+ *
+ * - `document-too-close-to-camera-edge`
+ *   - Document is positioned too close to the edge of camera view
+ *
+ * - `document-partially-visible`
+ *   - Only part of the document is visible in camera view
+ */
+export declare type DetectionStatus = "failed" | "success" | "camera-too-far" | "camera-too-close" | "camera-angle-too-steep" | "document-too-close-to-camera-edge" | "document-partially-visible";
 
 /** Represents the document anonymization settings. */
 export declare type DocumentAnonymizationSettings = {
@@ -1381,6 +1560,7 @@ export declare type DocumentAnonymizationSettings = {
     documentNumberAnonymizationSettings?: DocumentNumberAnonymizationSettings;
 };
 
+/** Represents the document class information. */
 export declare type DocumentClassInfo = {
     /** The document country. */
     country?: Country;
@@ -1432,7 +1612,7 @@ export declare type DocumentImageColor =
 /** Color image scanned */
 | "color";
 
-/** Represents the document number annotation settings. */
+/** Represents the document number anonymization settings. */
 export declare type DocumentNumberAnonymizationSettings = {
     /**
      * Defines how many digits at the beginning of the document number remain
@@ -1482,13 +1662,20 @@ export declare type DocumentRules = {
 declare type DocumentType_2 = "consular-id" | "dl" | "dl-public-services-card" | "employment-pass" | "fin-card" | "id" | "multipurpose-id" | "mykad" | "mykid" | "mypr" | "mytentera" | "pan-card" | "professional-id" | "public-services-card" | "residence-permit" | "resident-id" | "temporary-residence-permit" | "voter-id" | "work-permit" | "ikad" | "military-id" | "mykas" | "social-security-card" | "health-insurance-card" | "passport" | "s-pass" | "address-card" | "alien-id" | "alien-passport" | "green-card" | "minors-id" | "postal-id" | "professional-dl" | "tax-id" | "weapon-permit" | "visa" | "border-crossing-card" | "driver-card" | "global-entry-card" | "mypolis" | "nexus-card" | "passport-card" | "proof-of-age-card" | "refugee-id" | "tribal-id" | "veteran-id" | "citizenship-certificate" | "my-number-card" | "consular-passport" | "minors-passport" | "minors-public-services-card" | "driving-privilege-card" | "asylum-request" | "driver-qualification-card" | "provisional-dl" | "refugee-passport" | "special-id" | "uniformed-services-id" | "immigrant-visa" | "consular-voter-id" | "twic-card" | "exit-entry-permit" | "mainland-travel-permit-taiwan" | "nbi-clearance" | "proof-of-registration" | "temporary-protection-permit" | "afghan-citizen-card" | "eid" | "pass" | "sis-id" | "asic-card" | "bidoon-card" | "interim-health-insurance-card" | "non-voter-id" | "reciprocal-health-insurance-card" | "vehicle-registration" | "esaad-card" | "registration-certificate" | "medical-marijuana-id" | "non-card-tribal-id" | "diplomatic-id";
 export { DocumentType_2 as DocumentType }
 
+/**
+ * The download progress.
+ */
 declare type DownloadProgress = {
     loaded: number;
     contentLength: number;
     progress: number;
 };
 
-/** Represents detailed information from a driver's license */
+/**
+ * Represents detailed information from a driver's license.
+ *
+ * @template S - The type of the string result.
+ */
 export declare type DriverLicenceDetailedInfo<S extends string | StringResult> = {
     /**
      * The restrictions to driving privileges for the United States driver license
@@ -1511,8 +1698,9 @@ export declare type DriverLicenceDetailedInfo<S extends string | StringResult> =
  * JavaScript engine. The memory used by the object must be cleaned up manually
  * by calling the delete() method.
  *
- * {@link}
- * https://emscripten.org/docs/porting/connecting_cpp_and_javascript/embind.html#memory-management
+ * @see https://emscripten.org/docs/porting/connecting_cpp_and_javascript/embind.html#memory-management for more details.
+ *
+ * @ignore
  */
 export declare type EmbindObject<T extends {}> = T & {
     delete: () => void;
@@ -1521,6 +1709,11 @@ export declare type EmbindObject<T extends {}> = T & {
     isAliasOf: (other: any) => boolean;
 };
 
+/**
+ * The main EmscriptenModule interface.
+ *
+ * @ignore
+ */
 export declare interface EmscriptenModule {
     print(str: string): void;
     printErr(str: string): void;
@@ -1602,30 +1795,80 @@ export declare interface EmscriptenModule {
  * application's types.
  *
  * @param moduleOverrides Default properties for the initialized module.
+ *
+ * @ignore
  */
 export declare type EmscriptenModuleFactory<T extends EmscriptenModule = EmscriptenModule> = (moduleOverrides?: Partial<T>) => Promise<T>;
 
+/**
+ * The environment type.
+ *
+ * @ignore
+ */
 export declare type EnvironmentType = "WEB" | "NODE" | "SHELL" | "WORKER";
 
+/**
+ * Extracts the barcode input image from the scanning result.
+ *
+ * @param blinkIdScanningResult - The scanning result.
+ * @returns The barcode input image.
+ */
 export declare function extractBarcodeImage(blinkIdScanningResult: BlinkIdScanningResult): ImageData | null;
 
+/**
+ * Extracts the face image from the scanning result.
+ *
+ * @param blinkIdScanningResult - The scanning result.
+ * @returns The face image.
+ */
 export declare function extractFaceImage(blinkIdScanningResult: BlinkIdScanningResult): ImageData | null;
 
+/**
+ * Extracts the document image for a given side from the scanning result.
+ *
+ * @param blinkIdScanningResult - The scanning result.
+ * @param side - The side to extract the document image for.
+ * @returns The document image for the given side.
+ */
 export declare function extractSideDocumentImage(blinkIdScanningResult: BlinkIdScanningResult, side: ScanningSide): ImageData | null;
 
+/**
+ * Extracts the input image for a given side from the scanning result.
+ *
+ * @param blinkIdScanningResult - The scanning result.
+ * @param side - The side to extract the input image for.
+ * @returns The input image for the given side.
+ */
 export declare function extractSideInputImage(blinkIdScanningResult: BlinkIdScanningResult, side: ScanningSide): ImageData | null;
 
+/**
+ * Extracts the signature image from the scanning result.
+ *
+ * @param blinkIdScanningResult - The scanning result.
+ * @returns The signature image.
+ */
 export declare function extractSignatureImage(blinkIdScanningResult: BlinkIdScanningResult): ImageData | null;
 
+/** Represents all possible field types that can be extracted from the document. */
 export declare type FieldType = Simplify<keyof VizResult | "mrz">;
 
+/**
+ * Gets a cross-origin worker URL as a data URL or blob URL. If the URL is same-origin, it will return the original URL.
+ *
+ * @param originalWorkerUrl - The original worker URL.
+ * @param _options - The options for the worker.
+ * @returns A promise that resolves with the cross-origin worker URL.
+ */
 export declare const getCrossOriginWorkerURL: (originalWorkerUrl: string, _options?: Options) => Promise<string>;
 
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 /**
- * Gets the user id from local storage, or generates a new one
+ * Gets the user id from local storage, or generates a new one.
+ *
+ * This is a workaround for the lack of a user id in the worker scope.
+ *
  * @returns a unique user id
  */
 export declare function getUserId(): string;
@@ -1722,50 +1965,96 @@ export declare type InputImageAnalysisResult = {
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/**
+ * Represents the source type of an image.
+ *
+ * This type is used to indicate whether an image was obtained from a video
+ * stream or a single-source input such as a standalone photo.
+ */
 export declare type InputImageSource = "video" | "photo";
 
+/**
+ * Error thrown when license unlock fails
+ */
+export declare class LicenseError extends Error {
+    code: LicenseErrorCode;
+    constructor(message: string, code: LicenseErrorCode);
+}
+
+export declare type LicenseErrorCode = "LICENSE_ERROR";
+
+/** The license request. */
 export declare type LicenseRequest = Readonly<{
+    /** The license id. */
     licenseId: string;
+    /** The licensee. */
     licensee: string;
+    /** The application ids. */
     applicationIds: Array<string>;
+    /** The package name. */
     packageName: string;
+    /** The platform. */
     platform: string;
+    /** The sdk name. */
     sdkName: string;
+    /** The sdk version. */
     sdkVersion: string;
 }>;
 
+/** The license status response. */
 export declare type LicenseStatusResponse = Record<string, string>;
 
+/** The license token state. */
 export declare type LicenseTokenState = "invalid" | "requires-server-permission" | "valid";
 
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/** The license unlock result. */
 export declare type LicenseUnlockResult = Readonly<{
+    /** Whether the license is a trial license. */
     isTrial: boolean;
+    /** Whether the license has ping enabled. */
     hasPing: boolean;
+    /** The license id. */
     licenseId: string;
+    /** The licensee. */
     licensee: string;
+    /** The application ids. */
     applicationIds: Array<string>;
+    /** The package name. */
     packageName: string;
+    /** The sdk name. */
     sdkName: string;
+    /** The sdk version. */
     sdkVersion: string;
+    /** The unlock result. */
     unlockResult: LicenseTokenState;
+    /** The license error. */
     licenseError: string;
+    /** Whether to show the demo overlay. */
     showDemoOverlay: boolean;
+    /** Whether to show the production overlay. */
     showProductionOverlay: boolean;
+    /** Whether to allow baltazar proxy. */
     allowBaltazarProxy: boolean;
+    /** Whether to allow ping proxy. */
     allowPingProxy: boolean;
 }>;
 
 /**
- * Creates a BlinkID worker and initializes it with the provided settings.
+ * Creates and initializes a BlinkID core instance.
  *
- * @param {BlinkIdInitSettings} settings
- * @param {ProgressStatusCallback} progressCallback - Callback function used to track the progress of resource downloads (e.g., WASM and data files). It receives a DownloadProgress object, which contains details like the number of bytes loaded, the total content length, and the percentage of progress.
+ * @param settings - Configuration for BlinkID initialization including license key and resources location
+ * @param progressCallback - Optional callback for tracking resource download progress (WASM, data files)
+ * @returns Promise that resolves with initialized BlinkID core instance
+ * @throws Error if initialization fails
  */
 export declare function loadBlinkIdCore(settings: BlinkIdInitSettings, progressCallback?: ProgressStatusCallback): Promise<BlinkIdCore>;
 
+/**
+ * The load Wasm params.
+ */
 export declare type LoadWasmParams = {
     resourceUrl: string;
     variant?: WasmVariant;
@@ -1827,15 +2116,29 @@ export declare type MrzResult = {
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/**
+ * Options for the getCrossOriginWorkerURL function.
+ *
+ * @param skipSameOrigin - If true, the function will return the original URL if it is same-origin.
+ * @param useBlob - If true, the function will return a blob URL.
+ */
 declare type Options = {
+    /** If true, the function will return the original URL if it is same-origin. */
     skipSameOrigin?: boolean;
+    /** If true, the function will return a blob URL if not same-origin. */
     useBlob?: boolean;
 };
 
+/**
+ * The partial BlinkID session settings.
+ */
 declare type PartialBlinkIdSessionSettings = OverrideProperties<Partial<BlinkIdSessionSettings>, {
     scanningSettings?: PartialScanningSettings;
 }>;
 
+/**
+ * The partial scanning settings.
+ */
 declare type PartialScanningSettings = Partial<OverrideProperties<ScanningSettings, {
     croppedImageSettings: Partial<CroppedImageSettings>;
     recognitionModeFilter: Partial<RecognitionModeFilter>;
@@ -1845,11 +2148,11 @@ declare type PartialScanningSettings = Partial<OverrideProperties<ScanningSettin
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
-/** Represents a 2D point */
+/** Represents a 2D point. */
 export declare type Point = {
-    /** X-coordinate of the point */
+    /** X-coordinate of the point. */
     x: number;
-    /** Y-coordinate of the point */
+    /** Y-coordinate of the point. */
     y: number;
 };
 
@@ -1926,21 +2229,35 @@ export declare type ProcessingStatus =
 */
 | "barcode-detection-failed";
 
+/**
+ * The process result with buffer.
+ */
 export declare type ProcessResultWithBuffer = BlinkIdProcessResult & {
     arrayBuffer: ArrayBuffer;
 };
 
+/**
+ * The progress status callback.
+ */
 export declare type ProgressStatusCallback = (progress: DownloadProgress) => void;
 
-/** Represents a quadrilateral shape with signed integer coordinates */
+/**
+ * Error thrown when proxy URL validation fails
+ */
+export declare class ProxyUrlValidationError extends Error {
+    readonly url: string;
+    constructor(message: string, url: string);
+}
+
+/** Represents a quadrilateral shape with signed integer coordinates. */
 export declare type Quadrilateral = {
-    /** Upper left point of the quadrilateral */
+    /** Upper left point of the quadrilateral. */
     upperLeft: Point;
-    /** Upper right point of the quadrilateral */
+    /** Upper right point of the quadrilateral. */
     upperRight: Point;
-    /** Lower right point of the quadrilateral */
+    /** Lower right point of the quadrilateral. */
     lowerRight: Point;
-    /** Lower left point of the quadrilateral */
+    /** Lower left point of the quadrilateral. */
     lowerLeft: Point;
 };
 
@@ -1986,9 +2303,7 @@ export declare type RecognitionModeFilter = {
     enableFullDocumentRecognition: boolean;
 };
 
-/**
- * Represents a rectangle.
- */
+/** Represents a rectangle. */
 export declare type Rectangle = {
     /** X coordinate of the top-left corner of the rectangle. */
     x: number;
@@ -2006,10 +2321,25 @@ export declare type Rectangle = {
 /** Represents regions */
 export declare type Region = "alabama" | "alaska" | "alberta" | "arizona" | "arkansas" | "australian-capital-territory" | "british-columbia" | "california" | "colorado" | "connecticut" | "delaware" | "district-of-columbia" | "florida" | "georgia" | "hawaii" | "idaho" | "illinois" | "indiana" | "iowa" | "kansas" | "kentucky" | "louisiana" | "maine" | "manitoba" | "maryland" | "massachusetts" | "michigan" | "minnesota" | "mississippi" | "missouri" | "montana" | "nebraska" | "nevada" | "new-brunswick" | "new-hampshire" | "new-jersey" | "new-mexico" | "new-south-wales" | "new-york" | "northern-territory" | "north-carolina" | "north-dakota" | "nova-scotia" | "ohio" | "oklahoma" | "ontario" | "oregon" | "pennsylvania" | "quebec" | "queensland" | "rhode-island" | "saskatchewan" | "south-australia" | "south-carolina" | "south-dakota" | "tasmania" | "tennessee" | "texas" | "utah" | "vermont" | "victoria" | "virginia" | "washington" | "western-australia" | "west-virginia" | "wisconsin" | "wyoming" | "yukon" | "ciudad-de-mexico" | "jalisco" | "newfoundland-and-labrador" | "nuevo-leon" | "baja-california" | "chihuahua" | "guanajuato" | "guerrero" | "mexico" | "michoacan" | "new-york-city" | "tamaulipas" | "veracruz" | "chiapas" | "coahuila" | "durango" | "guerrero-cocula" | "guerrero-juchitan" | "guerrero-tepecoacuilco" | "guerrero-tlacoapa" | "gujarat" | "hidalgo" | "karnataka" | "kerala" | "khyber-pakhtunkhwa" | "madhya-pradesh" | "maharashtra" | "morelos" | "nayarit" | "oaxaca" | "puebla" | "punjab" | "queretaro" | "san-luis-potosi" | "sinaloa" | "sonora" | "tabasco" | "tamil-nadu" | "yucatan" | "zacatecas" | "aguascalientes" | "baja-california-sur" | "campeche" | "colima" | "quintana-roo-benito-juarez" | "quintana-roo" | "quintana-roo-solidaridad" | "tlaxcala" | "quintana-roo-cozumel" | "sao-paolo" | "rio-de-janeiro" | "rio-grande-do-sul" | "northwest-territories" | "nunavut" | "prince-edward-island" | "distrito-federal" | "maranhao" | "mato-grosso" | "minas-gerais" | "para" | "parana" | "pernambuco" | "santa-catarina" | "andhra-pradesh" | "ceara" | "goias" | "guerrero-acapulco-de-juarez" | "haryana" | "sergipe" | "alagoas" | "bangsamoro";
 
+/** Represents a remote scanning session. */
 export declare type RemoteScanningSession = Remote<WorkerScanningSession>;
 
+/**
+ * Represents a remote worker instance.
+ *
+ * This type is the return type of the createProxyWorker function, which creates a Comlink-proxied Web Worker.
+ * It simplifies the type to remove unnecessary complexity.
+ */
 export declare type RemoteWorker = ReturnType<typeof createProxyWorker>;
 
+/**
+ * Removes the internals of an Embind object.
+ *
+ * @param T - The type of the object to remove the internals from.
+ * @returns The object with the internals removed.
+ *
+ * @ignore
+ */
 export declare type RemoveEmbindInternals<T> = Omit<T, "delete" | "isDeleted" | "deleteLater" | "isAliasOf">;
 
 /**
@@ -2042,9 +2372,9 @@ export declare type ResultCompleteness = {
 /**
  * Represents the mode of document scanning.
  *
- * ScanningMode defines whether the scanning process is limited to a single
- * side of the document or includes multiple sides, automatically identifying
- * how many sides need to be scanned.
+ * ScanningMode defines whether the scanning process is limited to a single side
+ * of the document or includes multiple sides, automatically identifying how
+ * many sides need to be scanned.
  */
 export declare type ScanningMode = "single" | "automatic";
 
@@ -2060,7 +2390,7 @@ export declare type ScanningSettings = {
      * The level of blur detection in the document image.
      *
      * Defines the severity of blur detected in the document image, as defined in
-     * {@link DetectionLevel}. Values range from `off` (detection NotAvailable) to
+     * `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
@@ -2077,24 +2407,24 @@ export declare type ScanningSettings = {
      * A value of `true` means images with detected blur will be excluded from
      * further processing to prevent blurred images from being used
      *
-     * - If {@link blurDetectionLevel} `=` `off` - blurred images will be processed
-     * - If blur is detected {@link InputImageAnalysisResult#processingStatus}. will
-     *   be `image-preprocessing-failed` and blur will be reported in the
-     *   {@link BlinkIdProcessResult}
+     * - If `blurDetectionLevel` is `off` - blurred images will be processed
+     * - If blur is detected `InputImageAnalysisResult#processingStatus` will be
+     *   `image-preprocessing-failed` and blur will be reported in the
+     *   `BlinkIdProcessResult`
      *
      * A value of `false` means images with detected blur will not be excluded
      * from further processing
      *
-     * - If {@link blurDetectionLevel} `!=` `off` - even if blur is detected, the
-     *   image will be processed and blur will be reported in the
-     *   {@link BlinkIdProcessResult}.
+     * - If `blurDetectionLevel` is not `off` - even if blur is detected, the image
+     *   will be processed and blur will be reported in the
+     *   `BlinkIdProcessResult`.
      */
     skipImagesWithBlur: boolean;
     /**
      * The level of glare detection in the document image.
      *
      * Defines the severity of glare detected in the document image, as defined in
-     * {@link DetectionLevel}. Values range from `off` (detection NotAvailable) to
+     * `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
@@ -2112,24 +2442,24 @@ export declare type ScanningSettings = {
      * A value of `true` means images with detected glare will be excluded from
      * further processing to prevent glared images from being used
      *
-     * - If {@link glareDetectionLevel} `=` `off` - glared images will be processed
-     * - If glare is detected {@link InputImageAnalysisResult#processingStatus} will
-     *   be `image-preprocessing-failed` and glare will be reported in the
-     *   {@link BlinkIdProcessResult}
+     * - If `glareDetectionLevel` is `off` - glared images will be processed
+     * - If glare is detected `InputImageAnalysisResult#processingStatus` will be
+     *   `image-preprocessing-failed` and glare will be reported in the
+     *   `BlinkIdProcessResult`
      *
      * A value of `false` means images with detected glare will not be excluded
      * from further processing
      *
-     * - If {@link glareDetectionLevel} `!=` `off` - even if glare is detected, the
+     * - If `glareDetectionLevel` is not `off` - even if glare is detected, the
      *   image will be processed and glare will be reported in the
-     *   {@link BlinkIdProcessResult}
+     *   `BlinkIdProcessResult`
      */
     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 {@link DetectionLevel}. Values range from `off` (detection
+     * as defined in `DetectionLevel`. Values range from `off` (detection
      * NotAvailable) to higher levels of allowed tilt.
      *
      * `low` – less sensitive to tilt.
@@ -2148,9 +2478,9 @@ export declare type ScanningSettings = {
      * lighting from being used
      *
      * - If inadequate light conditions are detected
-     *   {@link InputImageAnalysisResult#processingStatus} will be
+     *   `InputImageAnalysisResult#processingStatus` will be
      *   `image-preprocessing-failed` and lighting status will be reported in the
-     *   {@link BlinkIdProcessResult}.
+     *   `BlinkIdProcessResult`.
      */
     skipImagesWithInadequateLightingConditions: boolean;
     /**
@@ -2159,12 +2489,11 @@ export declare type ScanningSettings = {
      * 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
-     *   {@link InputImageAnalysisResult#processingStatus} will be
-     *   `image-preprocessing-failed` and hand occlusion status will be reported
-     *   in the {@link BlinkIdProcessResult}.
+     * - If hand occlusion is detected `InputImageAnalysisResult#processingStatus`
+     *   will be `image-preprocessing-failed` and hand occlusion status will be
+     *   reported in the `BlinkIdProcessResult`.
      *
-     * This setting is applicable only if `scanCroppedDocumentImage` = false.
+     * This setting is applicable only if `scanCroppedDocumentImage` is false.
      */
     skipImagesOccludedByHand: boolean;
     /**
@@ -2178,8 +2507,8 @@ export declare type ScanningSettings = {
      * extracted data will be aggregated from multiple images instead of being
      * sourced from a single image.
      *
-     * This only applies when {@link InputImageSource} is equal to `video` - for
-     * images from `photo` source, setting will be ignored.
+     * This only applies when `InputImageSource` is equal to `video` - for images
+     * from `photo` source, setting will be ignored.
      */
     combineResultsFromMultipleInputImages: boolean;
     /**
@@ -2207,7 +2536,7 @@ export declare type ScanningSettings = {
      * 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,
+     * 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
@@ -2276,11 +2605,10 @@ export declare type ScanningSettings = {
      * input image and the document.
      *
      * Default value is `0.02f` (also recommended value). The setting is
-     * applicable only when using images from `video` source The setting is not
-     * applicable if {@link scanCroppedDocumentImage} is enabled (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.
+     * applicable only when using images from `video` source. The setting is not
+     * applicable if `scanCroppedDocumentImage` is enabled (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.
      */
     inputImageMargin: number;
     /**
@@ -2351,11 +2679,16 @@ export declare type ScanningSide = "first" | "second";
  */
 export declare type ScanningStatus = "scanning-side-in-progress" | "scanning-barcode-in-progress" | "side-scanned" | "document-scanned" | "cancelled";
 
+/** The server permission error. */
 export declare type ServerPermissionError = "network-error" | "remote-lock" | "permission-expired" | "payload-corrupted" | "payload-signature-verification-failed" | "incorrect-token-state" | "detected-skewed-clock";
 
+/** The server permission submit result. */
 export declare type ServerPermissionSubmitResult = Readonly<{
+    /** The error. */
     error: ServerPermissionError;
+    /** The lease. */
     lease: number;
+    /** The network error description. */
     networkErrorDescription?: string;
 }>;
 
@@ -2389,15 +2722,19 @@ export declare type StringResult = {
  */
 export declare function testLocalStorage(): boolean;
 
-/** Represents the information about the vehicle class */
+/**
+ * Represents the information about the vehicle class.
+ *
+ * @template S - The type of the string result.
+ */
 export declare type VehicleClassInfo<S extends string | StringResult> = {
-    /** The type of vehicle the driver license owner has privilege to drive */
+    /** The type of vehicle the driver license owner has privilege to drive. */
     vehicleClass?: S;
-    /** The type of driver licence */
+    /** The type of driver licence. */
     licenceType?: S;
-    /** The date since licence is effective */
+    /** The date since licence is effective. */
     effectiveDate?: DateResult<S>;
-    /** The date of expiry of licence */
+    /** The date of expiry of licence. */
     expiryDate?: DateResult<S>;
 };
 
@@ -2495,19 +2832,45 @@ export declare type VizResult = {
     nationalInsuranceNumber?: StringResult;
 };
 
+/**
+ * The WASM variant.
+ */
 declare type WasmVariant = "basic" | "advanced" | "advanced-threads";
 
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/**
+ * The WebAssembly module, for compatibility.
+ *
+ * @ignore
+ */
 export declare interface WebAssemblyModule {
 }
 
+/**
+ * The worker scanning session.
+ */
 export declare type WorkerScanningSession = OverrideProperties<BlinkIdScanningSession, {
     process: (image: ImageData) => ProcessResultWithBuffer;
 }> & {
+    /**
+     * Gets the settings.
+     *
+     * @returns The settings.
+     */
     getSettings: () => BlinkIdSessionSettings;
+    /**
+     * Shows the demo overlay.
+     *
+     * @returns Whether the demo overlay is shown.
+     */
     showDemoOverlay: () => boolean;
+    /**
+     * Shows the production overlay.
+     *
+     * @returns Whether the production overlay is shown.
+     */
     showProductionOverlay: () => boolean;
 };