dynamsoft-capture-vision-react-native 2.6.1016 → 3.0.5100

package/src/rtu/BarcodeScanner.tsx

@@ -1,112 +0,0 @@
-import {NativeModules, Platform} from "react-native";
-import {type BarcodeScanConfig, EnumScanningMode} from "./BarcodeScanConfig";
-import type {BarcodeScanResult} from "./BarcodeScanResult";
-import {EnumBarcodeFormat} from "../dbr";
-import type {DSRect} from "../core";
-
-// @ts-ignore Check whether __turboModuleProxy exists, it may not
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-const DynamsoftBarcodeScannerModule = !isTurboModuleEnabled?
-  NativeModules.DynamsoftBarcodeScannerModule :
-  require("./NativeDynamsoftBarcodeScannerModule").default;
-
-const DefaultConfig: BarcodeScanConfig = {
-    _barcodeFormatNumberString: EnumBarcodeFormat.BF_DEFAULT.toString(),
-    isTorchButtonVisible: true,
-    isBeepEnabled: false,
-    isAutoZoomEnabled: false,
-    isCloseButtonVisible: true,
-    isScanLaserVisible: false,
-    isCameraToggleButtonVisible: false,
-    scanningMode: EnumScanningMode.SM_SINGLE,
-    expectedBarcodesCount: 999,
-    maxConsecutiveStableFramesToExit: 5,
-}
-
-const isIOS: boolean = Platform.OS === 'ios';
-
-export class BarcodeScanner {
-    private constructor() {
-    }
-
-    /**
-     * Starts the barcode scanner by launching a new page (Activity on Android or ViewController on iOS).
-     *
-     * This function initiates the barcode scanning process by launching a new page dedicated to scanning.
-     * It accepts an optional configuration object to customize the scanning behavior. If no configuration
-     * is provided, it uses a default configuration. The function returns a Promise that resolves with the
-     * scan result or rejects with an error if the scanning process fails.
-     *
-     * For Android, this function starts an Activity that handles the barcode scanning. For iOS, it presents
-     * a ViewController for the same purpose. After scanning, the function handles the result and closes
-     * the scanning page if necessary.
-     *
-     * @param config (optional) Configuration parameters for the barcode scanner, including:
-     *   - `license` (string): Dynamsoft license key. If empty, the license is not set.
-     *   - `barcodeFormats` ({@link EnumBarcodeFormat}): Numeric representation of barcode formats, default is `EnumBarcodeFormat.BF_DEFAULT`.
-     *                  Note that if templateContent or templateNodeRequire is set, barcodeFormats will not take effect.
-     *   - `templateFile` - The content of the template as a json string.
-     *   - `templateNodeRequire` - The template node require object.
-     *   - `scanRegion` ({@link DSRect}): Configuration for the scan region. Optional.
-     *   - `isTorchButtonVisible` (boolean): Whether to display the torch button, default is `true`.
-     *   - `isBeepEnabled` (boolean): Whether to enable the beep sound on successful scan, default is `false`.
-     *   - `isAutoZoomEnabled` (boolean): Whether to enable auto-zoom, default is `false`.
-     *   - `isCloseButtonVisible` (boolean): Whether to display the close button, default is `true`.
-     *   - `isScanLaserVisible` (boolean): Whether to display the scan laser line, default is `false`.
-     *   - `scanningMode` ({@link EnumScanningMode}): Scanning mode, default is {@link EnumScanningMode.SM_SINGLE}. When set to {@link EnumScanningMode.SM_MULTIPLE}, `expectedBarcodesCount` and `maxConsecutiveStableFramesToExit` are effective.
-     *   - `expectedBarcodesCount` (number): Expected number of barcodes to be scanned. Effective only when `scanningMode` is set to {@link EnumScanningMode.SM_MULTIPLE}.
-     *          When the number of scanned barcodes is greater than or equal to this value, the scanning process will exit immediately and return the results, default is `999`.
-     *   - `maxConsecutiveStableFramesToExit` (number): Number of consecutive stable frames with the same number of barcode results to exit scanning. Effective only when `scanningMode` is set to {@link EnumScanningMode.SM_MULTIPLE}, default is `5`.
-     *
-     * @returns A Promise that resolves with the scan result as a `BarcodeScanResult` object.
-     *   - If the scan is successful, the Promise resolves with the scan result.
-     *   - If an error occurs during the scan, the Promise rejects with an error message.
-     *   - If the user manually exits the scanner, the Promise resolves with `null`.
-     */
-    static async launch(config?: BarcodeScanConfig): Promise<BarcodeScanResult> {
-        let result: BarcodeScanResult;
-
-        // Prepare the configuration for the native module
-        if (config) {
-            let barcodeFormatId = config.barcodeFormats;
-            config.barcodeFormats = undefined; // Set BigNumber to undefined for JSON.parse()
-            let configTemp: BarcodeScanConfig = JSON.parse(JSON.stringify(config));
-            config.barcodeFormats = barcodeFormatId; // Reset to original value
-
-            // Clear invalid configuration items
-            if (config.license && config.license.length === 0) {
-                configTemp.license = undefined;
-            }
-
-            if((!config.templateFile || config.templateFile.replace(/[\s]/g,'').length === 0)) {
-                if(config.templateNodeRequire) {
-                    try {
-                        configTemp.templateFile = JSON.stringify(config.templateNodeRequire);
-                    } catch (error) {
-                        console.error("Failed to stringify templateNodeRequire:", error);
-                        configTemp.templateFile = undefined;
-                    }
-                } else {
-                    configTemp.templateFile = undefined;
-                }
-            }
-            if(configTemp.templateFile && configTemp.templateFile.replace(/[\s]/g,'') === '{}') {
-                configTemp.templateFile = undefined;
-            }
-
-            if (barcodeFormatId) {
-                configTemp.barcodeFormats = undefined;
-                configTemp._barcodeFormatNumberString = barcodeFormatId.toString();
-            }
-
-            result = await DynamsoftBarcodeScannerModule.startBarcodeScanner(configTemp);
-        } else {
-            // Use default configuration to start the barcode scanner activity/view controller
-            result = await DynamsoftBarcodeScannerModule.startBarcodeScanner(DefaultConfig);
-        }
-        if(isIOS) {
-            await DynamsoftBarcodeScannerModule.closeBarcodeScanner();
-        }
-        return result;
-    }
-}

package/src/rtu/EnumResultState.tsx

@@ -1,21 +0,0 @@
-/**
- * EnumResultStatus is an enumeration that defines the result status of the {@link BarcodeScanResult}/{@link MRZScanResult}.
- *
- * If the status is finished, that indicates that the result has been captured and is available.
- * If the status is canceled, that indicates that the operation has been halted.
- * If the result status is exception, then that means that an error has occurred during the scanning process.
- * */
-export enum EnumResultStatus {
-  /**
-   * The scanning is finished. You can get at least one result from the BarcodeScanResult/MRZScanResult.
-   * */
-  RS_FINISHED,
-  /**
-   * The scanning page is closed before the process is finished. No results are available.
-   * */
-  RS_CANCELED,
-  /**
-   * Failed to start scanning or an error occurs during the scanning process. No results are available.
-   * */
-  RS_EXCEPTION
-}

package/src/rtu/MRZScanConfig.tsx

@@ -1,67 +0,0 @@
-export interface MRZScanConfig {
-  /**
-   * The license key required to initialize the MRZ scanenr.
-   */
-  license?: string,
-
-  /**
-   * Determines whether the torch (flashlight) toggle button is visible on the scanning interface.
-   * Set to true to allow users to switch the device's flashlight on or off during MRZ scanning.
-   */
-  isTorchButtonVisible?: boolean,
-
-  /**
-   * Indicates whether a beep sound is triggered upon a successful MRZ scan.
-   * When enabled (true), the scanner will play a sound to provide audible feedback.
-   */
-  isBeepEnabled?: boolean,
-
-  /**
-   * Controls the visibility of the close button on the scanner's UI.
-   * If true, a close button will be displayed allowing users to exit the MRZ scanning interface.
-   */
-  isCloseButtonVisible?: boolean,
-
-  /**
-   * Specifies the type of document to be scanned for MRZ.
-   * This property accepts values defined in the EnumDocumentType, such as {@link EnumDocumentType.DT_ALL}, {@link EnumDocumentType.DT_ID}, or {@link EnumDocumentType.DT_PASSPORT}.
-   * It helps the scanner to optimize its processing based on the expected document type.
-   *
-   * @see {@link EnumDocumentType}
-   */
-  documentType?: EnumDocumentType,
-
-  /**
-   * Determines whether a guide frame is visible during scanning.
-   * The guide frame assists users in properly aligning the document for optimal MRZ detection.
-   * When set to true, a visual overlay is displayed on the scanning interface.
-   */
-  isGuideFrameVisible?: boolean
-
-  /**
-   * Specifies the template configuration for the MRZ scanner.
-   * This can be either a file path or a JSON string that defines various scanning parameters.
-   */
-  templateFile?: string,
-
-  /**
-   * Provides a Node.js 'require' function to load the template file when running in a Node environment.
-   * This facilitates importing external template configuration files.
-   */
-  templateNodeRequire?: NodeRequire,
-}
-
-export enum EnumDocumentType {
-  /**
-   * Indicates that all types of documents are acceptable for MRZ scanning.
-   */
-  DT_ALL,
-  /**
-   * Specifies that the document to be scanned is an ID card.
-   */
-  DT_ID,
-  /**
-   * Specifies that the document to be scanned is a passport.
-   */
-  DT_PASSPORT,
-}

package/src/rtu/MRZScanResult.tsx

@@ -1,84 +0,0 @@
-import {EnumResultStatus} from "./EnumResultState";
-
-/**
- * MRZScanResult contains the parsed MRZ information and the corresponding additional information.
- * */
-export interface MRZScanResult {
-  /**
-   * The status of the mrz scan result.
-   *  - {@link EnumResultStatus.RS_FINISHED}: The barcode scanning is finished.
-   *  - {@link EnumResultStatus.RS_CANCELED}: The barcode scanning activity is closed before the process is finished.
-   *  - {@link EnumResultStatus.RS_EXCEPTION}: Failed to start barcode scanning or an error occurs when scanning the barcodes.
-   * */
-  resultStatus: EnumResultStatus,
-
-  /**
-   * Returns the error code when the resultStatus is {@link EnumResultStatus.RS_EXCEPTION}.
-   * */
-  errorCode?: number,
-
-  /**
-   * Returns the errorString when the resultStatus is {@link EnumResultStatus.RS_EXCEPTION}.
-   * */
-  errorString?: string,
-
-  /**
-   * The parsed MRZ data.
-   * @see MRZDara
-   * */
-  data?: MRZData
-}
-
-export interface MRZData {
-  /**
-   * The type of document, such as ID cards or passports.
-   * */
-  documentType?: string,
-
-  /**
-   * The first name and last name of the user of the MRZ document.
-   * */
-  firstName?: string,
-
-  /**
-   * The last name of the user of the MRZ document.
-   * */
-  lastName?: string,
-  /**
-   * The sex of the user of the MRZ document.
-   * */
-  sex?: string,
-  /**
-   * The issuing state of the MRZ document.
-   * */
-  issuingState?: string,
-  /**
-   * The nationality of the user of the MRZ document.
-   * */
-  nationality?: string,
-
-  /**
-   * The date of birth of the user of the MRZ document.
-   * */
-  dateOfBirth?: string,
-  /**
-   *  The expiry date of the MRZ document.
-   *  */
-  dateOfExpire?: string,
-
-  /**
-   * The MRZ document number.
-   * */
-  documentNumber?: string,
-
-  /**
-   * The age of the user of the MRZ document.*/
-  age?: number,
-
-  /**
-   * The raw text of the MRZ.
-   * */
-  mrzText?: string,
-}
-
-

package/src/rtu/MRZScanner.tsx

@@ -1,90 +0,0 @@
-import {NativeModules, Platform} from "react-native";
-import {type MRZScanConfig, EnumDocumentType} from "./MRZScanConfig";
-import type {MRZScanResult} from "./MRZScanResult";
-
-// @ts-ignore Check whether __turboModuleProxy exists, it may not
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-const DynamsoftMRZScannerModule = !isTurboModuleEnabled?
-  NativeModules.DynamsoftMRZScannerModule :
-  require("./NativeDynamsoftMRZScannerModule").default;
-
-const DefaultConfig: MRZScanConfig = {
-    isTorchButtonVisible: true,
-    isBeepEnabled: false,
-    isCloseButtonVisible: true,
-    documentType: EnumDocumentType.DT_ALL,
-    isGuideFrameVisible: true,
-}
-
-const isIOS: boolean = Platform.OS === 'ios';
-
-export class MRZScanner {
-    private constructor() {
-    }
-
-    /**
-     * Starts the MRZ (Machine Readable Zone) scanner by launching a new page (Activity on Android or ViewController on iOS).
-     *
-     * This function initiates the MRZ scanning process by launching a new page dedicated to scanning.
-     * It accepts an optional configuration object to customize the scanning behavior. If no configuration
-     * is provided, it uses a default configuration. The function returns a Promise that resolves with the
-     * scan result or rejects with an error if the scanning process fails.
-     *
-     * For Android, this function starts an Activity that handles the MRZ scanning. For iOS, it presents
-     * a ViewController for the same purpose. After scanning, the function handles the result and closes
-     * the scanning page if necessary.
-     *
-     * @param config (optional) Configuration parameters for the MRZ scanner, including:
-     *   - `license` (string): Dynamsoft license key. If empty, the license is not set.
-     *   - `isTorchButtonVisible` (boolean): Whether to display the torch button, default is `true`.
-     *   - `isBeepEnabled` (boolean): Whether to enable the beep sound on successful scan, default is `false`.
-     *   - `isCloseButtonVisible` (boolean): Whether to display the close button, default is `true`.
-     *   - `documentType` ({@link EnumDocumentType}): The type of document to be scanned, default is {@link EnumDocumentType.DT_ALL}.
-     *     This can be set to specific document types like {@link EnumDocumentType.DT_ID} or {@link EnumDocumentType.DT_PASSPORT} to optimize scanning.
-     *   - `isGuideFrameVisible` (boolean): Whether to display the guide frame to assist with scanning, default is `true`.
-     *   - `templateFile` - The content of the template as a json string.
-     *   - `templateNodeRequire` - The template node require object.
-     *
-     * @returns A Promise that resolves with the scan result as an `MRZScanResult` object.
-     *   - If the scan is successful, the Promise resolves with the scan result.
-     *   - If an error occurs during the scan, the Promise rejects with an error message.
-     *   - If the user manually exits the scanner, the Promise resolves with `null`.
-     */
-    static async launch(config?: MRZScanConfig): Promise<MRZScanResult> {
-        let result: MRZScanResult;
-
-        // Prepare the configuration for the native module
-        if (config) {
-            let configTemp: MRZScanConfig = JSON.parse(JSON.stringify(config));
-
-            // Clear invalid configuration items
-            if (config.license && config.license.length === 0) {
-                configTemp.license = undefined;
-            }
-
-            if((!config.templateFile || config.templateFile.replace(/[\s]/g,'').length === 0)) {
-                if(config.templateNodeRequire) {
-                    try {
-                        configTemp.templateFile = JSON.stringify(config.templateNodeRequire);
-                    } catch (error) {
-                        console.error("Failed to stringify templateNodeRequire:", error);
-                        configTemp.templateFile = undefined;
-                    }
-                } else {
-                    configTemp.templateFile = undefined;
-                }
-            }
-            if(configTemp.templateFile && configTemp.templateFile.replace(/[\s]/g,'') === '{}') {
-                configTemp.templateFile = undefined;
-            }
-            result = await DynamsoftMRZScannerModule.startMRZScanner(configTemp);
-        } else {
-            // Use default configuration to start the MRZ scanner activity/view controller
-            result = await DynamsoftMRZScannerModule.startMRZScanner(DefaultConfig);
-        }
-        if(isIOS) {
-            await DynamsoftMRZScannerModule.closeMRZScanner();
-        }
-        return result;
-    }
-}

package/src/rtu/NativeDynamsoftBarcodeScannerModule.tsx

@@ -1,6 +0,0 @@
-import {type TurboModule, TurboModuleRegistry } from "react-native";
-export interface Spec extends TurboModule {
-  startBarcodeScanner(config:unknown) : Promise<unknown>;
-  closeBarcodeScanner() : Promise<void>;
-}
-export default TurboModuleRegistry.get<Spec>("DynamsoftBarcodeScannerModule") as Spec | null;

package/src/rtu/NativeDynamsoftMRZScannerModule.tsx

@@ -1,6 +0,0 @@
-import {type TurboModule, TurboModuleRegistry } from "react-native";
-export interface Spec extends TurboModule {
-  startMRZScanner(config:unknown) : Promise<unknown>;
-  closeMRZScanner() : Promise<void>;
-}
-export default TurboModuleRegistry.get<Spec>("DynamsoftMRZScannerModule") as Spec | null;

package/src/rtu/index.tsx

@@ -1,7 +0,0 @@
-export * from "./BarcodeScanner"
-export * from "./BarcodeScanResult"
-export * from "./BarcodeScanConfig"
-export * from "./MRZScanner"
-export * from "./MRZScanResult"
-export * from "./MRZScanConfig"
-export * from "./EnumResultState"