@microblink/blinkid-core 7.3.2 → 7.4.1

package/types/BlinkIdCore.d.ts

@@ -4,13 +4,27 @@
 import type { BlinkIdWorkerInitSettings, BlinkIdWorkerProxy, ProgressStatusCallback } from "@microblink/blinkid-worker";
 import type { SetOptional, Simplify } from "type-fest";
 import { Remote } from "comlink";
+/**
+ * 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 type BlinkIdInitSettings = SetOptional<BlinkIdWorkerInitSettings, "userId" | "useLightweightBuild">;
+/**
+ * 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 type BlinkIdCore = Simplify<Remote<BlinkIdWorkerProxy>>;
 /**
- * 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>;
 //# sourceMappingURL=BlinkIdCore.d.ts.map

package/types/BlinkIdCore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlinkIdCore.d.ts","sourceRoot":"","sources":["../src/BlinkIdCore.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGvD,OAAO,EAAS,MAAM,EAAE,MAAM,SAAS,CAAC;AAIxC,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAC3C,yBAAyB,EACzB,QAAQ,GAAG,qBAAqB,CACjC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAE/D;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,mBAAmB,EAC7B,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,WAAW,CAAC,CAqCtB"}
+{"version":3,"file":"BlinkIdCore.d.ts","sourceRoot":"","sources":["../src/BlinkIdCore.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,yBAAyB,EACzB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGvD,OAAO,EAAS,MAAM,EAAE,MAAM,SAAS,CAAC;AAGxC;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAC3C,yBAAyB,EAEzB,QAAQ,GAAG,qBAAqB,CACjC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,mBAAmB,EAC7B,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,WAAW,CAAC,CAqCtB"}

package/types/createCustomImageData.d.ts

@@ -2,13 +2,11 @@
  * 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;
 //# sourceMappingURL=createCustomImageData.d.ts.map

package/types/createCustomImageData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createCustomImageData.d.ts","sourceRoot":"","sources":["../src/createCustomImageData.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS;;;;;EASzD"}
+{"version":3,"file":"createCustomImageData.d.ts","sourceRoot":"","sources":["../src/createCustomImageData.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CA2BrE"}

package/types/createProxyWorker.d.ts

@@ -10,5 +10,11 @@ import type { BlinkIdWorkerProxy } from "@microblink/blinkid-worker";
  * @returns a Comlink-proxied instance of the Web Worker
  */
 export declare const createProxyWorker: (resourcesLocation?: string) => Promise<import("comlink").Remote<BlinkIdWorkerProxy>>;
+/**
+ * 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 type RemoteWorker = ReturnType<typeof createProxyWorker>;
 //# sourceMappingURL=createProxyWorker.d.ts.map

package/types/createProxyWorker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createProxyWorker.d.ts","sourceRoot":"","sources":["../src/createProxyWorker.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AA8DrE;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,oBAAmB,MAA6B,0DAuBjD,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC"}
+{"version":3,"file":"createProxyWorker.d.ts","sourceRoot":"","sources":["../src/createProxyWorker.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AA8DrE;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,oBAAmB,MAA6B,0DAuBjD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/types/defaultSessionSettings.d.ts

@@ -2,5 +2,13 @@
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 import { BlinkIdSessionSettings } from "@microblink/blinkid-wasm";
+/**
+ * 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;
 //# sourceMappingURL=defaultSessionSettings.d.ts.map

package/types/defaultSessionSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultSessionSettings.d.ts","sourceRoot":"","sources":["../src/defaultSessionSettings.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,eAAO,MAAM,sBAAsB,EAAE,sBAwCpC,CAAC"}
+{"version":3,"file":"defaultSessionSettings.d.ts","sourceRoot":"","sources":["../src/defaultSessionSettings.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,EAAE,sBAwCpC,CAAC"}

package/types/getCrossOriginWorkerURL.d.ts

@@ -1,10 +1,25 @@
 /**
  * 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.
+ */
 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;
 };
+/**
+ * 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>;
 export {};
 //# sourceMappingURL=getCrossOriginWorkerURL.d.ts.map

package/types/getCrossOriginWorkerURL.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getCrossOriginWorkerURL.d.ts","sourceRoot":"","sources":["../src/getCrossOriginWorkerURL.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,KAAK,OAAO,GAAG;IACb,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAClC,mBAAmB,MAAM,EACzB,WAAU,OAAY,oBA6DvB,CAAC"}
+{"version":3,"file":"getCrossOriginWorkerURL.d.ts","sourceRoot":"","sources":["../src/getCrossOriginWorkerURL.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;GAKG;AACH,KAAK,OAAO,GAAG;IACb,+EAA+E;IAC/E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,uEAAuE;IACvE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,GAClC,mBAAmB,MAAM,EACzB,WAAU,OAAY,oBA4DvB,CAAC"}

package/types/getUserId.d.ts

@@ -2,7 +2,10 @@
  * 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;

package/types/getUserId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getUserId.d.ts","sourceRoot":"","sources":["../src/getUserId.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH;;;GAGG;AACH,wBAAgB,SAAS,WAgBxB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,YAQ/B"}
+{"version":3,"file":"getUserId.d.ts","sourceRoot":"","sources":["../src/getUserId.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH;;;;;;GAMG;AACH,wBAAgB,SAAS,WAgBxB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,YAQ/B"}

package/types/index.d.ts

@@ -1,6 +1,12 @@
 /**
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
+/**
+ * @packageDocumentation
+ * Core functionality of BlinkID SDK - provides essential document scanning capabilities and worker management.
+ * This package serves as the foundation for document scanning, handling WASM initialization, worker communication,
+ * and core scanning operations.
+ */
 import { WorkerScanningSession } from "@microblink/blinkid-worker";
 import { Remote } from "comlink";
 export * from "./BlinkIdCore";
@@ -12,6 +18,7 @@ export * from "./getUserId";
 export * from "./utils";
 export type * from "@microblink/blinkid-wasm";
 export type * from "@microblink/blinkid-worker";
+/** Represents a remote scanning session. */
 export type RemoteScanningSession = Remote<WorkerScanningSession>;
 declare const testSymbol: unique symbol;
 declare global {

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AAExB,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,4BAA4B,CAAC;AAEhD,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAIlE,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,gBAAgB,EAAE,OAAO,UAAU,CAAC;CACzC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AAExB,mBAAmB,0BAA0B,CAAC;AAC9C,mBAAmB,4BAA4B,CAAC;AAEhD,4CAA4C;AAC5C,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAIlE,QAAA,MAAM,UAAU,eAAW,CAAC;AAE5B,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,gBAAgB,EAAE,OAAO,UAAU,CAAC;CACzC"}