@microblink/blinkid-react-native 7.7.0 → 8001.0.0

package/lib/module/index.js

@@ -1,15 +1,63 @@
 "use strict";
 
 // index.ts
-import { BlinkIdScanningResult } from "./blinkIdResult.js";
+
 // Configuration classes
-export { BlinkIdScanningSettings, BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdScanningUxSettings, CroppedImageSettings } from "./blinkIdSettings.js";
-export { BlinkIdScanningResult } from "./blinkIdResult.js";
+export * from "./blinkIdSettings.js";
+
+// BlinkID result
 
 // Types & enums
 export * from "./types.js";
 const BlinkidReactNative = require("./NativeBlinkidReactNative").default;
 export default BlinkidReactNative;
+function stringifySettings(value) {
+  return JSON.stringify(value ?? null);
+}
+function parseNativeScanResult(jsonResult) {
+  const parsed = typeof jsonResult === "string" ? JSON.parse(jsonResult) : jsonResult;
+  const payload = Array.isArray(parsed) ? parsed[0] : parsed;
+  if (typeof payload === "string") {
+    return JSON.parse(payload);
+  }
+  return payload;
+}
+function assertSdkSettings(sdkSettings, methodName) {
+  if (!sdkSettings?.licenseKey) {
+    throw new Error(`${methodName} requires sdkSettings with a licenseKey. ` + `Use ${methodName}({ sdkSettings: { licenseKey, ... }, sessionSettings: { ... } }) ` + `instead of the legacy positional call style.`);
+  }
+  return sdkSettings;
+}
+function resolvePerformScanSettings(first, sessionSettings, scanningUxSettings, classFilter, redactionSettingsResolver) {
+  if (typeof first === "object" && first !== null && "sdkSettings" in first && "sessionSettings" in first) {
+    return first;
+  }
+  if (typeof first === "object" && first !== null && "licenseKey" in first && sessionSettings) {
+    return {
+      sdkSettings: first,
+      sessionSettings,
+      scanningUxSettings,
+      classFilter,
+      redactionSettingsResolver
+    };
+  }
+  throw new Error("Invalid performScan arguments. Pass a single settings object: " + "performScan({ sdkSettings, sessionSettings, ... }).");
+}
+function resolvePerformDirectApiScanSettings(first, sessionSettings, firstImage, secondImage, redactionSettings) {
+  if (typeof first === "object" && first !== null && "sdkSettings" in first && "sessionSettings" in first && "firstImage" in first) {
+    return first;
+  }
+  if (typeof first === "object" && first !== null && "licenseKey" in first && sessionSettings && firstImage) {
+    return {
+      sdkSettings: first,
+      sessionSettings,
+      firstImage,
+      secondImage,
+      redactionSettings
+    };
+  }
+  throw new Error("Invalid performDirectApiScan arguments. Pass a single settings object: " + "performDirectApiScan({ sdkSettings, sessionSettings, firstImage, ... }).");
+}
 
 /**  The `loadBlinkIdSdk` method creates or retrieves the instance of the BlinkID SDK.
  *
@@ -34,10 +82,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 async function loadBlinkIdSdk(blinkIdSdkSettings) {
-  await BlinkidReactNative.loadBlinkIdSdk(JSON.stringify(blinkIdSdkSettings));
+export async function loadBlinkIdSdk(settingsOrSdk) {
+  const sdkSettings = "sdkSettings" in settingsOrSdk ? settingsOrSdk.sdkSettings : settingsOrSdk;
+  await BlinkidReactNative.loadBlinkIdSdk(stringifySettings(assertSdkSettings(sdkSettings, "loadBlinkIdSdk")));
 }
-
 /**
  * The `unloadBlinkIdSdk` method terminates the BlinkID SDK and releases all associated resources.
  *
@@ -50,14 +98,15 @@ export async function loadBlinkIdSdk(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 async function unloadBlinkIdSdk(deleteCachedResources) {
+export async function unloadBlinkIdSdk({
+  deleteCachedResources = false
+} = {}) {
   await BlinkidReactNative.unloadBlinkIdSdk(deleteCachedResources);
 }
-
 /**
  * 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}.
  *
@@ -68,20 +117,31 @@ export async function unloadBlinkIdSdk(deleteCachedResources) {
  * @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 async function performScan(blinkIdSdkSettings, blinkIdSessionSettings, blinkIdScanningUxSettings, classFilter) {
-  const jsonResult = await BlinkidReactNative.performScan(JSON.stringify(blinkIdSdkSettings), JSON.stringify(blinkIdSessionSettings), JSON.stringify(blinkIdScanningUxSettings), JSON.stringify(classFilter));
-  return new BlinkIdScanningResult(JSON.parse(jsonResult));
+export async function performScan(settingsOrSdk, sessionSettings, scanningUxSettings, classFilter, redactionSettingsResolver) {
+  const {
+    sdkSettings,
+    sessionSettings: resolvedSessionSettings,
+    scanningUxSettings: resolvedScanningUxSettings,
+    classFilter: resolvedClassFilter,
+    redactionSettingsResolver: resolvedRedactionSettingsResolver
+  } = resolvePerformScanSettings(settingsOrSdk, sessionSettings, scanningUxSettings, classFilter, redactionSettingsResolver);
+  const jsonResult = await BlinkidReactNative.performScan(stringifySettings(assertSdkSettings(sdkSettings, "performScan")), stringifySettings(resolvedSessionSettings), stringifySettings(resolvedScanningUxSettings), stringifySettings(resolvedClassFilter), stringifySettings(resolvedRedactionSettingsResolver));
+  return parseNativeScanResult(jsonResult);
 }
-
 /**
  * The `performDirectApiScan` platform channel method launches the BlinkID scanning process inteded for information extraction from static images.
  *
@@ -93,6 +153,9 @@ export async function performScan(blinkIdSdkSettings, blinkIdSessionSettings, bl
  *
  * @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.
@@ -102,8 +165,22 @@ export async function performScan(blinkIdSdkSettings, blinkIdSessionSettings, bl
  * @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 async function performDirectApiScan(blinkIdSdkSettings, blinkIdSessionSettings, firstImage, secondImage) {
-  const jsonResult = await BlinkidReactNative.performDirectApiScan(JSON.stringify(blinkIdSdkSettings), JSON.stringify(blinkIdSessionSettings), firstImage, secondImage);
-  return new BlinkIdScanningResult(JSON.parse(jsonResult));
+export async function performDirectApiScan(settingsOrSdk, sessionSettings, firstImage, secondImage, redactionSettings) {
+  const resolvedSettings = resolvePerformDirectApiScanSettings(settingsOrSdk, sessionSettings, firstImage, secondImage, redactionSettings);
+  const jsonResult = await BlinkidReactNative.performDirectApiScan(stringifySettings(assertSdkSettings(resolvedSettings.sdkSettings, "performDirectApiScan")), stringifySettings(resolvedSettings.sessionSettings), resolvedSettings.firstImage, resolvedSettings.secondImage, stringifySettings(resolvedSettings.redactionSettings));
+  return parseNativeScanResult(jsonResult);
+}
+
+/**
+ * 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 async function refreshLicenseLease() {
+  await BlinkidReactNative.refreshLicenseLease();
 }
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["BlinkIdScanningResult","BlinkIdScanningSettings","BlinkIdSdkSettings","BlinkIdSessionSettings","BlinkIdScanningUxSettings","CroppedImageSettings","BlinkidReactNative","require","default","loadBlinkIdSdk","blinkIdSdkSettings","JSON","stringify","unloadBlinkIdSdk","deleteCachedResources","performScan","blinkIdSessionSettings","blinkIdScanningUxSettings","classFilter","jsonResult","parse","performDirectApiScan","firstImage","secondImage"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA;AACA,SAASA,qBAAqB,QAAQ,oBAAiB;AASvD;AACA,SACEC,uBAAuB,EACvBC,kBAAkB,EAClBC,sBAAsB,EACtBC,yBAAyB,EACzBC,oBAAoB,QACf,sBAAmB;AAE1B,SAASL,qBAAqB,QAAQ,oBAAiB;;AAEvD;AACA,cAAc,YAAS;AAEvB,MAAMM,kBAAwB,GAAGC,OAAO,CAAC,4BAA4B,CAAC,CAACC,OAAO;AAE9E,eAAeF,kBAAkB;;AAEjC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeG,cAAcA,CAClCC,kBAAsC,EACvB;EACf,MAAMJ,kBAAkB,CAACG,cAAc,CAACE,IAAI,CAACC,SAAS,CAACF,kBAAkB,CAAC,CAAC;AAC7E;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeG,gBAAgBA,CACpCC,qBAA8B,EACf;EACf,MAAMR,kBAAkB,CAACO,gBAAgB,CAACC,qBAAqB,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,WAAWA,CAC/BL,kBAAsC,EACtCM,sBAA8C,EAC9CC,yBAAqD,EACrDC,WAAyB,EACO;EAChC,MAAMC,UAAU,GAAG,MAAMb,kBAAkB,CAACS,WAAW,CACrDJ,IAAI,CAACC,SAAS,CAACF,kBAAkB,CAAC,EAClCC,IAAI,CAACC,SAAS,CAACI,sBAAsB,CAAC,EACtCL,IAAI,CAACC,SAAS,CAACK,yBAAyB,CAAC,EACzCN,IAAI,CAACC,SAAS,CAACM,WAAW,CAC5B,CAAC;EAED,OAAO,IAAIlB,qBAAqB,CAACW,IAAI,CAACS,KAAK,CAACD,UAAU,CAAC,CAAC;AAC1D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeE,oBAAoBA,CACxCX,kBAAsC,EACtCM,sBAA8C,EAC9CM,UAAkB,EAClBC,WAAoB,EACY;EAChC,MAAMJ,UAAU,GAAG,MAAMb,kBAAkB,CAACe,oBAAoB,CAC9DV,IAAI,CAACC,SAAS,CAACF,kBAAkB,CAAC,EAClCC,IAAI,CAACC,SAAS,CAACI,sBAAsB,CAAC,EACtCM,UAAU,EACVC,WACF,CAAC;EAED,OAAO,IAAIvB,qBAAqB,CAACW,IAAI,CAACS,KAAK,CAACD,UAAU,CAAC,CAAC;AAC1D","ignoreList":[]}
+{"version":3,"names":["BlinkidReactNative","require","default","stringifySettings","value","JSON","stringify","parseNativeScanResult","jsonResult","parsed","parse","payload","Array","isArray","assertSdkSettings","sdkSettings","methodName","licenseKey","Error","resolvePerformScanSettings","first","sessionSettings","scanningUxSettings","classFilter","redactionSettingsResolver","resolvePerformDirectApiScanSettings","firstImage","secondImage","redactionSettings","loadBlinkIdSdk","settingsOrSdk","unloadBlinkIdSdk","deleteCachedResources","performScan","resolvedSessionSettings","resolvedScanningUxSettings","resolvedClassFilter","resolvedRedactionSettingsResolver","performDirectApiScan","resolvedSettings","refreshLicenseLease"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA;;AAcA;AACA,cAAc,sBAAmB;;AAEjC;;AAGA;AACA,cAAc,YAAS;AAEvB,MAAMA,kBAAwB,GAAGC,OAAO,CAAC,4BAA4B,CAAC,CAACC,OAAO;AAE9E,eAAeF,kBAAkB;AAEjC,SAASG,iBAAiBA,CAACC,KAAc,EAAU;EACjD,OAAOC,IAAI,CAACC,SAAS,CAACF,KAAK,IAAI,IAAI,CAAC;AACtC;AAEA,SAASG,qBAAqBA,CAACC,UAAkB,EAAyB;EACxE,MAAMC,MAAe,GACnB,OAAOD,UAAU,KAAK,QAAQ,GAAGH,IAAI,CAACK,KAAK,CAACF,UAAU,CAAC,GAAGA,UAAU;EAEtE,MAAMG,OAAO,GAAGC,KAAK,CAACC,OAAO,CAACJ,MAAM,CAAC,GAAGA,MAAM,CAAC,CAAC,CAAC,GAAGA,MAAM;EAC1D,IAAI,OAAOE,OAAO,KAAK,QAAQ,EAAE;IAC/B,OAAON,IAAI,CAACK,KAAK,CAACC,OAAO,CAAC;EAC5B;EAEA,OAAOA,OAAO;AAChB;AAEA,SAASG,iBAAiBA,CACxBC,WAA2C,EAC3CC,UAAkB,EACE;EACpB,IAAI,CAACD,WAAW,EAAEE,UAAU,EAAE;IAC5B,MAAM,IAAIC,KAAK,CACb,GAAGF,UAAU,2CAA2C,GACtD,OAAOA,UAAU,mEAAmE,GACpF,8CACJ,CAAC;EACH;EAEA,OAAOD,WAAW;AACpB;AAEA,SAASI,0BAA0BA,CACjCC,KAA+C,EAC/CC,eAAwC,EACxCC,kBAA8C,EAC9CC,WAAyB,EACzBC,yBAAqD,EAChC;EACrB,IACE,OAAOJ,KAAK,KAAK,QAAQ,IACzBA,KAAK,KAAK,IAAI,IACd,aAAa,IAAIA,KAAK,IACtB,iBAAiB,IAAIA,KAAK,EAC1B;IACA,OAAOA,KAAK;EACd;EAEA,IACE,OAAOA,KAAK,KAAK,QAAQ,IACzBA,KAAK,KAAK,IAAI,IACd,YAAY,IAAIA,KAAK,IACrBC,eAAe,EACf;IACA,OAAO;MACLN,WAAW,EAAEK,KAA2B;MACxCC,eAAe;MACfC,kBAAkB;MAClBC,WAAW;MACXC;IACF,CAAC;EACH;EAEA,MAAM,IAAIN,KAAK,CACb,gEAAgE,GAC9D,qDACJ,CAAC;AACH;AAEA,SAASO,mCAAmCA,CAC1CL,KAAwD,EACxDC,eAAwC,EACxCK,UAAmB,EACnBC,WAAoB,EACpBC,iBAAqC,EACP;EAC9B,IACE,OAAOR,KAAK,KAAK,QAAQ,IACzBA,KAAK,KAAK,IAAI,IACd,aAAa,IAAIA,KAAK,IACtB,iBAAiB,IAAIA,KAAK,IAC1B,YAAY,IAAIA,KAAK,EACrB;IACA,OAAOA,KAAK;EACd;EAEA,IACE,OAAOA,KAAK,KAAK,QAAQ,IACzBA,KAAK,KAAK,IAAI,IACd,YAAY,IAAIA,KAAK,IACrBC,eAAe,IACfK,UAAU,EACV;IACA,OAAO;MACLX,WAAW,EAAEK,KAA2B;MACxCC,eAAe;MACfK,UAAU;MACVC,WAAW;MACXC;IACF,CAAC;EACH;EAEA,MAAM,IAAIV,KAAK,CACb,yEAAyE,GACvE,0EACJ,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeW,cAAcA,CAClCC,aAA0D,EAC3C;EACf,MAAMf,WAAW,GACf,aAAa,IAAIe,aAAa,GAC1BA,aAAa,CAACf,WAAW,GACzBe,aAAa;EAEnB,MAAM9B,kBAAkB,CAAC6B,cAAc,CACrC1B,iBAAiB,CAACW,iBAAiB,CAACC,WAAW,EAAE,gBAAgB,CAAC,CACpE,CAAC;AACH;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAegB,gBAAgBA,CAAC;EACrCC,qBAAqB,GAAG;AACA,CAAC,GAAG,CAAC,CAAC,EAAiB;EAC/C,MAAMhC,kBAAkB,CAAC+B,gBAAgB,CAACC,qBAAqB,CAAC;AAClE;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,WAAWA,CAC/BH,aAAuD,EACvDT,eAAwC,EACxCC,kBAA8C,EAC9CC,WAAyB,EACzBC,yBAAqD,EACrB;EAChC,MAAM;IACJT,WAAW;IACXM,eAAe,EAAEa,uBAAuB;IACxCZ,kBAAkB,EAAEa,0BAA0B;IAC9CZ,WAAW,EAAEa,mBAAmB;IAChCZ,yBAAyB,EAAEa;EAC7B,CAAC,GAAGlB,0BAA0B,CAC5BW,aAAa,EACbT,eAAe,EACfC,kBAAkB,EAClBC,WAAW,EACXC,yBACF,CAAC;EAED,MAAMhB,UAAU,GAAG,MAAMR,kBAAkB,CAACiC,WAAW,CACrD9B,iBAAiB,CAACW,iBAAiB,CAACC,WAAW,EAAE,aAAa,CAAC,CAAC,EAChEZ,iBAAiB,CAAC+B,uBAAuB,CAAC,EAC1C/B,iBAAiB,CAACgC,0BAA0B,CAAC,EAC7ChC,iBAAiB,CAACiC,mBAAmB,CAAC,EACtCjC,iBAAiB,CAACkC,iCAAiC,CACrD,CAAC;EAED,OAAO9B,qBAAqB,CAACC,UAAU,CAAC;AAC1C;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAe8B,oBAAoBA,CACxCR,aAAgE,EAChET,eAAwC,EACxCK,UAAmB,EACnBC,WAAoB,EACpBC,iBAAqC,EACL;EAChC,MAAMW,gBAAgB,GAAGd,mCAAmC,CAC1DK,aAAa,EACbT,eAAe,EACfK,UAAU,EACVC,WAAW,EACXC,iBACF,CAAC;EAED,MAAMpB,UAAU,GAAG,MAAMR,kBAAkB,CAACsC,oBAAoB,CAC9DnC,iBAAiB,CACfW,iBAAiB,CAACyB,gBAAgB,CAACxB,WAAW,EAAE,sBAAsB,CACxE,CAAC,EACDZ,iBAAiB,CAACoC,gBAAgB,CAAClB,eAAe,CAAC,EACnDkB,gBAAgB,CAACb,UAAU,EAC3Ba,gBAAgB,CAACZ,WAAW,EAC5BxB,iBAAiB,CAACoC,gBAAgB,CAACX,iBAAiB,CACtD,CAAC;EAED,OAAOrB,qBAAqB,CAACC,UAAU,CAAC;AAC1C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAegC,mBAAmBA,CAAA,EAAkB;EACzD,MAAMxC,kBAAkB,CAACwC,mBAAmB,CAAC,CAAC;AAChD","ignoreList":[]}