@microblink/blinkid-react-native 7.7.0 → 8001.0.0

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,22 @@ 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>;
+/**
+ * The `refreshLicenseLease` method refreshes the BlinkID SDK license lease.
+ *
+ * This method can be called periodically to maintain an active license status.
+ * The frequency of refresh calls depends on your license configuration.
+ *
+ * The BlinkID SDK must already be initialized (by calling {@link loadBlinkIdSdk}
+ * or any of the scanning methods) before calling this method.
+ */
+export declare function refreshLicenseLease(): Promise<void>;
+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;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzD;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"}