@microblink/blinkid-react-native/lib/module/index.js

A small and powerful ID card scanning library. Powered by Microblink (www.microblink.com).

"use strict";

// index.ts

// Configuration classes
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.
 *
 * Initializes and loads the BlinkID SDK if it is not already loaded.
 *
 * This method handles:
 * - SDK initialization
 * - Resource downloading
 * - License verification
 *
 * It ensures that only one SDK instance exists at any time.
 *
 * You can call this method in advance to **preload** the SDK before starting a scanning session.
 * Doing so reduces loading time for the {@link performScan} and {@link performDirectApiScan} methods,
 * since all resources will already be available and the license verified.
 *
 * If you do not call this method beforehand, it will still be automatically invoked on the native platform channels
 * when a scan starts. However, the initial scan may take longer due to resource loading and license checks.
 *
 * @param blinkIdSdkSettings - {@link BlinkIdSdkSettings} - the class that contains all of the available SDK settings.
 * It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.
 *
 * 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(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.
 *
 * This method safely shuts down the SDK instance and frees any allocated memory.
 * After calling this method, you must reinitialize the SDK (by calling {@link loadBlinkIdSdk}
 * or any of the scanning methods) before using it again.
 *
 * This method is automatically called after each successful scan session.
 *
 * @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 = 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} {@link BlinkIdScanningUxSettings}, {@link RedactionSettingsResolver} {@link ClassFilter}.
 *
 * It returns the {@link BlinkIdScanningResult}.
 *
 * @param blinkIdSdkSettings - BlinkID SDK Settings - the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK
 * needs for the scanning process, should be obtained.
 * To obtain a valid license key, please visit https://developer.microblink.com/ or contact us directly at https://help.microblink.com.
 *
 * @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 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(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.
 *
 * It takes the following parameters: {@link BlinkIdSdkSettings}, {@link BlinkIdSessionSettings}, `firstImage` string in the Base64 format and the optional `secondImage` string in the Base64 format.
 *
 * It returns the {@link BlinkIdScanningResult}.
 *
 * @param blinkIdSdkSettings - BlinkID SDK Settings - the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.
 *
 * @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.
 *
 * @param secondImage - The optional `secondImage` Base64 string: needed if the information from back side of the document is required and the `ScanningMode` is set to `automatic`.
 *
 * @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(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);
}
//# sourceMappingURL=index.js.map