dynamsoft-capture-vision-react-native 3.4.1300 → 3.4.3010

package/src/dce/CameraView.tsx

@@ -1,100 +1,100 @@
-// @ts-ignore
-import React, {Component, ComponentProps, createElement} from 'react';
-import {
-    findNodeHandle,
-    type HostComponent,
-    type NativeMethods,
-    requireNativeComponent,
-    StyleSheet,
-    View
-} from "react-native";
-import type {CameraViewNativeProps} from "./DynamsoftCameraViewNativeComponent";
-
-/**
- * Transforms CameraViewNativeProps to a format compatible with the native CameraView component.
- * This ensures only supported properties are passed to the native layer.
- * @param props - The props for the {@link CameraView} component.
- * @returns The transformed native props.
- * @internal
- */
-const transformToNativeCameraViewProps = (props: CameraViewNativeProps | undefined | null): CameraViewNativeProps => {
-    return JSON.parse(JSON.stringify(
-        {
-            visibleLayerIds: props?.visibleLayerIds,
-            scanRegionMaskVisible: props?.scanRegionMaskVisible,
-            scanLaserVisible: props?.scanLaserVisible,
-            torchButton: props?.torchButton,
-            torchButtonVisible: props?.torchButtonVisible,
-            cameraToggleButton: props?.cameraToggleButton,
-            cameraToggleButtonVisible: props?.cameraToggleButtonVisible,
-        }
-    )) as CameraViewNativeProps
-}
-type RefType = React.Component<CameraViewNativeProps> & Readonly<NativeMethods>;
-
-// @ts-ignore Check whether __turboModuleProxy exists, it may not
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-
-const ComponentName = 'DynamsoftCameraView';
-const NativeCameraView: HostComponent<CameraViewNativeProps> = isTurboModuleEnabled?
-    require("./DynamsoftCameraViewNativeComponent").default :
-    requireNativeComponent(ComponentName)
-
-/**
- * The CameraView class is a React Component that wraps the native CameraView, which is used to display the camera preview.
- * Users can add interactable UI elements on the view.
- * You can view {@link CameraViewNativeProps} to know what custom properties you can define.
- * Only available when CameraView is bound on CameraEnhancer by {@link CameraEnhancer.setCameraView} .
- * @prop {@link CameraViewNativeProps}
- * @see {@link CameraViewNativeProps}
- * @see {@link CameraEnhancer.setCameraView}
- */
-export class CameraView extends Component<CameraViewNativeProps, any> {
-    private readonly nativeCameraViewRef: React.RefObject<RefType | null> = React.createRef<RefType>();
-    private readonly nativeProps = transformToNativeCameraViewProps(this.props)
-
-    /** @internal */
-    public get nativeCameraViewHandle(): number | null {
-        return findNodeHandle(this.nativeCameraViewRef.current);
-    }
-
-    componentDidMount() {
-      if(this.nativeProps.torchButton?.visible !== undefined) {
-        console.warn("The `torchButton.visible` property of CameraView has been deprecated, please use the `torchButtonVisible` property of CameraView")
-      }
-    }
-
-    componentDidUpdate(prevProps: CameraViewNativeProps) {
-        let nativePreProps = transformToNativeCameraViewProps(prevProps)
-        let nativeProps = transformToNativeCameraViewProps(this.props)
-        if(nativePreProps !== nativeProps) {
-            this.nativeCameraViewRef.current?.setNativeProps(nativeProps)
-        }
-    }
-
-    public render(): React.ReactNode {
-        return(
-            <View style={[styles.blackBg, this.props?.style]}>
-                <NativeCameraView
-                    style={StyleSheet.absoluteFill}
-                    ref={this.nativeCameraViewRef}
-                    {...this.nativeProps}
-                />
-
-                {this.props?.children}
-            </View>
-        );
-    }
-}
-
-
-const styles = StyleSheet.create({
-    container: {
-        flex: 1,
-        alignItems: 'center',
-        justifyContent: 'center',
-    },
-    blackBg: {
-        backgroundColor: 'black',
-    },
-});
+// @ts-ignore
+import React, {Component, ComponentProps, createElement} from 'react';
+import {
+    findNodeHandle,
+    type HostComponent,
+    type NativeMethods,
+    requireNativeComponent,
+    StyleSheet,
+    View
+} from "react-native";
+import type {CameraViewNativeProps} from "./DynamsoftCameraViewNativeComponent";
+
+/**
+ * Transforms CameraViewNativeProps to a format compatible with the native CameraView component.
+ * This ensures only supported properties are passed to the native layer.
+ * @param props - The props for the {@link CameraView} component.
+ * @returns The transformed native props.
+ * @internal
+ */
+const transformToNativeCameraViewProps = (props: CameraViewNativeProps | undefined | null): CameraViewNativeProps => {
+    return JSON.parse(JSON.stringify(
+        {
+            visibleLayerIds: props?.visibleLayerIds,
+            scanRegionMaskVisible: props?.scanRegionMaskVisible,
+            scanLaserVisible: props?.scanLaserVisible,
+            torchButton: props?.torchButton,
+            torchButtonVisible: props?.torchButtonVisible,
+            cameraToggleButton: props?.cameraToggleButton,
+            cameraToggleButtonVisible: props?.cameraToggleButtonVisible,
+        }
+    )) as CameraViewNativeProps
+}
+type RefType = React.Component<CameraViewNativeProps> & Readonly<NativeMethods>;
+
+// @ts-ignore Check whether __turboModuleProxy exists, it may not
+const isTurboModuleEnabled = global.__turboModuleProxy != null;
+
+const ComponentName = 'DynamsoftCameraView';
+const NativeCameraView: HostComponent<CameraViewNativeProps> = isTurboModuleEnabled?
+    require("./DynamsoftCameraViewNativeComponent").default :
+    requireNativeComponent(ComponentName)
+
+/**
+ * The CameraView class is a React Component that wraps the native CameraView, which is used to display the camera preview.
+ * Users can add interactable UI elements on the view.
+ * You can view {@link CameraViewNativeProps} to know what custom properties you can define.
+ * Only available when CameraView is bound on CameraEnhancer by {@link CameraEnhancer.setCameraView} .
+ * @prop {@link CameraViewNativeProps}
+ * @see {@link CameraViewNativeProps}
+ * @see {@link CameraEnhancer.setCameraView}
+ */
+export class CameraView extends Component<CameraViewNativeProps, any> {
+    private readonly nativeCameraViewRef: React.RefObject<RefType | null> = React.createRef<RefType>();
+    private readonly nativeProps = transformToNativeCameraViewProps(this.props)
+
+    /** @internal */
+    public get nativeCameraViewHandle(): number | null {
+        return findNodeHandle(this.nativeCameraViewRef.current);
+    }
+
+    componentDidMount() {
+      if(this.nativeProps.torchButton?.visible !== undefined) {
+        console.warn("The `torchButton.visible` property of CameraView has been deprecated, please use the `torchButtonVisible` property of CameraView")
+      }
+    }
+
+    componentDidUpdate(prevProps: CameraViewNativeProps) {
+        let nativePreProps = transformToNativeCameraViewProps(prevProps)
+        let nativeProps = transformToNativeCameraViewProps(this.props)
+        if(nativePreProps !== nativeProps) {
+            this.nativeCameraViewRef.current?.setNativeProps(nativeProps)
+        }
+    }
+
+    public render(): React.ReactNode {
+        return(
+            <View style={[styles.blackBg, this.props?.style]}>
+                <NativeCameraView
+                    style={StyleSheet.absoluteFill}
+                    ref={this.nativeCameraViewRef}
+                    {...this.nativeProps}
+                />
+
+                {this.props?.children}
+            </View>
+        );
+    }
+}
+
+
+const styles = StyleSheet.create({
+    container: {
+        flex: 1,
+        alignItems: 'center',
+        justifyContent: 'center',
+    },
+    blackBg: {
+        backgroundColor: 'black',
+    },
+});

package/src/dce/DynamsoftCameraViewNativeComponent.ts

@@ -1,96 +1,96 @@
-import type {HostComponent, ViewProps} from "react-native";
-import codegenNativeComponent from "react-native/Libraries/Utilities/codegenNativeComponent";
-import type {Int32} from "react-native/Libraries/Types/CodegenTypes";
-import type {DecodedBarcodesResult} from "../dbr";
-import type {RecognizedTextLinesResult} from "../dlr";
-import type {ProcessedDocumentResult} from "../ddn";
-
-export interface CameraViewNativeProps extends ViewProps {
-    /**
-     * CameraView has three default drawing layers corresponding to
-     * {@link EnumDrawingLayerId.DBR_LAYER_ID}/{@link EnumDrawingLayerId.DLR_LAYER_ID}/{@link EnumDrawingLayerId.DDN_LAYER_ID},
-     * they will draw the corresponding {@link DecodedBarcodesResult}/{@link RecognizedTextLinesResult}/{@link ProcessedDocumentResult} on the camera preview.
-     * If visibleLayerIds is undefined, all layer will be visible.
-     * If defined, only the DrawingLayer corresponding to the layerId in the array will be visible.
-     *
-     * @see {@link EnumDrawingLayerId}
-     * */
-    visibleLayerIds?: number[]
-
-    /**
-     * Set the visibility of the scan region mask.
-     * Only available when set a scan region to CameraEnhancer.
-     * Default is true.
-     * */
-    scanRegionMaskVisible?: boolean
-
-    /**
-     * Set the visibility of the scan laser.
-     * Only available when set a scan region to CameraEnhancer.
-     * Default is false.
-     * */
-    scanLaserVisible?: boolean
-
-    /**
-     * Add a torch button that can control the torch on your view.
-     * If you are using enhanced feature - {@link EnumEnhancedFeatures.EF_SMART_TORCH},
-     * the style of this torch button will be applied to the smart torch as well.
-     * */
-    torchButton?: {
-        /**
-        * Set the top-left point and width and height of the torch button.(All by px)
-        * */
-        location?: {
-            x?: Int32;
-            y?: Int32;
-            width?: Int32;
-            height?: Int32;
-        }
-        /**
-         * Set the visibility of the torch button. Default is false.
-         * */
-        visible?: boolean;
-        /**
-         *  The torch button image that you want to display when the torch is on.
-         * */
-        torchOnImageBase64?: string;
-
-        /**
-         *  The torch button image that you want to display when the torch is off.
-         * */
-        torchOffImageBase64?: string;
-    };
-    /**
-    * Set the visibility of the torch button. Default is false.
-    * */
-    torchButtonVisible?: boolean
-
-    /**
-     * Add a camera toggle button that can switch camera position on your view.
-     * */
-    cameraToggleButton?: {
-        /**
-        * Set the top-left point and width and height of the camera toggle button.(All by px)
-        * */
-        location?: {
-            x?: Int32;
-            y?: Int32;
-            width?: Int32;
-            height?: Int32;
-        }
-
-        /**
-         *  The camera toggle button image.
-         * */
-        cameraToggleImageBase64?: string;
-    };
-
-    /**
-    * Set the visibility of the camera toggle button. Default is false.
-    * */
-    cameraToggleButtonVisible?: boolean
-}
-
-export default codegenNativeComponent<CameraViewNativeProps>(
-    "DynamsoftCameraView"
-) as HostComponent<CameraViewNativeProps>;
+import type {HostComponent, ViewProps} from "react-native";
+import codegenNativeComponent from "react-native/Libraries/Utilities/codegenNativeComponent";
+import type {Int32} from "react-native/Libraries/Types/CodegenTypes";
+import type {DecodedBarcodesResult} from "../dbr";
+import type {RecognizedTextLinesResult} from "../dlr";
+import type {ProcessedDocumentResult} from "../ddn";
+
+export interface CameraViewNativeProps extends ViewProps {
+    /**
+     * CameraView has three default drawing layers corresponding to
+     * {@link EnumDrawingLayerId.DBR_LAYER_ID}/{@link EnumDrawingLayerId.DLR_LAYER_ID}/{@link EnumDrawingLayerId.DDN_LAYER_ID},
+     * they will draw the corresponding {@link DecodedBarcodesResult}/{@link RecognizedTextLinesResult}/{@link ProcessedDocumentResult} on the camera preview.
+     * If visibleLayerIds is undefined, all layer will be visible.
+     * If defined, only the DrawingLayer corresponding to the layerId in the array will be visible.
+     *
+     * @see {@link EnumDrawingLayerId}
+     * */
+    visibleLayerIds?: number[]
+
+    /**
+     * Set the visibility of the scan region mask.
+     * Only available when set a scan region to CameraEnhancer.
+     * Default is true.
+     * */
+    scanRegionMaskVisible?: boolean
+
+    /**
+     * Set the visibility of the scan laser.
+     * Only available when set a scan region to CameraEnhancer.
+     * Default is false.
+     * */
+    scanLaserVisible?: boolean
+
+    /**
+     * Add a torch button that can control the torch on your view.
+     * If you are using enhanced feature - {@link EnumEnhancedFeatures.EF_SMART_TORCH},
+     * the style of this torch button will be applied to the smart torch as well.
+     * */
+    torchButton?: {
+        /**
+        * Set the top-left point and width and height of the torch button.(All by px)
+        * */
+        location?: {
+            x?: Int32;
+            y?: Int32;
+            width?: Int32;
+            height?: Int32;
+        }
+        /**
+         * Set the visibility of the torch button. Default is false.
+         * */
+        visible?: boolean;
+        /**
+         *  The torch button image that you want to display when the torch is on.
+         * */
+        torchOnImageBase64?: string;
+
+        /**
+         *  The torch button image that you want to display when the torch is off.
+         * */
+        torchOffImageBase64?: string;
+    };
+    /**
+    * Set the visibility of the torch button. Default is false.
+    * */
+    torchButtonVisible?: boolean
+
+    /**
+     * Add a camera toggle button that can switch camera position on your view.
+     * */
+    cameraToggleButton?: {
+        /**
+        * Set the top-left point and width and height of the camera toggle button.(All by px)
+        * */
+        location?: {
+            x?: Int32;
+            y?: Int32;
+            width?: Int32;
+            height?: Int32;
+        }
+
+        /**
+         *  The camera toggle button image.
+         * */
+        cameraToggleImageBase64?: string;
+    };
+
+    /**
+    * Set the visibility of the camera toggle button. Default is false.
+    * */
+    cameraToggleButtonVisible?: boolean
+}
+
+export default codegenNativeComponent<CameraViewNativeProps>(
+    "DynamsoftCameraView"
+) as HostComponent<CameraViewNativeProps>;

package/src/dce/DynamsoftImageEditorViewNativeComponent.ts

@@ -1,9 +1,9 @@
-import type {HostComponent, ViewProps} from "react-native";
-import codegenNativeComponent from "react-native/Libraries/Utilities/codegenNativeComponent";
-
-export interface ImageEditorViewNativeProps extends ViewProps {
-}
-
-export default codegenNativeComponent<ImageEditorViewNativeProps>(
-    "DynamsoftImageEditorView"
-) as HostComponent<ImageEditorViewNativeProps>;
+import type {HostComponent, ViewProps} from "react-native";
+import codegenNativeComponent from "react-native/Libraries/Utilities/codegenNativeComponent";
+
+export interface ImageEditorViewNativeProps extends ViewProps {
+}
+
+export default codegenNativeComponent<ImageEditorViewNativeProps>(
+    "DynamsoftImageEditorView"
+) as HostComponent<ImageEditorViewNativeProps>;

package/src/dce/EnumCameraPosition.tsx

@@ -1,25 +1,25 @@
-/**
- * @see {@link CameraEnhancer.selectCamera}
- * */
-export enum EnumCameraPosition {
-    /**
-     * Use the back-facing camera.
-     */
-    CP_BACK,
-    /**
-     * Use the front-facing camera.
-     */
-    CP_FRONT,
-
-    /**
-     * Use the ultra-wide back-facing camera.
-     * @note iOS only. This option is not available on other platforms.
-     */
-    CP_BACK_ULTRA_WIDE,
-
-     /**
-     * Use the ultra-wide back-facing camera.
-     * @note iOS only. This option is not available on other platforms.
-     */
-    CP_BACK_DUAL_WIDE_AUTO,
-}
+/**
+ * @see {@link CameraEnhancer.selectCamera}
+ * */
+export enum EnumCameraPosition {
+    /**
+     * Use the back-facing camera.
+     */
+    CP_BACK,
+    /**
+     * Use the front-facing camera.
+     */
+    CP_FRONT,
+
+    /**
+     * Use the ultra-wide back-facing camera.
+     * @note iOS only. This option is not available on other platforms.
+     */
+    CP_BACK_ULTRA_WIDE,
+
+     /**
+     * Use the ultra-wide back-facing camera.
+     * @note iOS only. This option is not available on other platforms.
+     */
+    CP_BACK_DUAL_WIDE_AUTO,
+}

package/src/dce/EnumDrawingLayerId.tsx

@@ -1,17 +1,17 @@
-export enum EnumDrawingLayerId {
-    /**
-     * The preset DrawingLayer of Dynamsoft Document Normalizer.
-     * */
-    DDN_LAYER_ID = 1,
-
-    /**
-     * The preset DrawingLayer of Dynamsoft Barcode Reader.
-     * */
-    DBR_LAYER_ID = 2,
-
-    /**
-     * The preset DrawingLayer of Dynamsoft Label Recognizer.
-     * */
-    DLR_LAYER_ID = 3,
-    TIP_LAYER_ID = 999
-}
+export enum EnumDrawingLayerId {
+    /**
+     * The preset DrawingLayer of Dynamsoft Document Normalizer.
+     * */
+    DDN_LAYER_ID = 1,
+
+    /**
+     * The preset DrawingLayer of Dynamsoft Barcode Reader.
+     * */
+    DBR_LAYER_ID = 2,
+
+    /**
+     * The preset DrawingLayer of Dynamsoft Label Recognizer.
+     * */
+    DLR_LAYER_ID = 3,
+    TIP_LAYER_ID = 999
+}

package/src/dce/EnumEnhancedFeatures.tsx

@@ -1,24 +1,24 @@
-/**
- * Enumeration EnhancedFeatures indicates the advanced features of Dynamsoft Camera Enhancer.
- * */
-export enum EnumEnhancedFeatures {
-  /**
-   * `Frame Filter`: The frame sharpness filter feature of DCE. By enabling this feature, the low-quality frame will be recognized and discarded automatically.
-   * */
-  EF_FRAME_FILTER = 1,
-
-  /**`Sensor Control`: The sensor filter feature of DCE. By enabling this feature, the frames will be discarded automatically while the device is shaking.*/
-  EF_SENSOR_CONTROL = 2,
-
-  /**`Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus.*/
-  EF_ENHANCED_FOCUS = 4,
-
-  /**`Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area.*/
-  EF_AUTO_ZOOM = 8,
-
-  /**`Smart Torch`: Add a smart torch on the UI. The torch will be hided when the environment brightness is high and displayed when the brightness is low.*/
-  EF_SMART_TORCH = 16,
-
-  /**Enable all.*/
-  EF_ALL = 31
-}
+/**
+ * Enumeration EnhancedFeatures indicates the advanced features of Dynamsoft Camera Enhancer.
+ * */
+export enum EnumEnhancedFeatures {
+  /**
+   * `Frame Filter`: The frame sharpness filter feature of DCE. By enabling this feature, the low-quality frame will be recognized and discarded automatically.
+   * */
+  EF_FRAME_FILTER = 1,
+
+  /**`Sensor Control`: The sensor filter feature of DCE. By enabling this feature, the frames will be discarded automatically while the device is shaking.*/
+  EF_SENSOR_CONTROL = 2,
+
+  /**`Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus.*/
+  EF_ENHANCED_FOCUS = 4,
+
+  /**`Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area.*/
+  EF_AUTO_ZOOM = 8,
+
+  /**`Smart Torch`: Add a smart torch on the UI. The torch will be hided when the environment brightness is high and displayed when the brightness is low.*/
+  EF_SMART_TORCH = 16,
+
+  /**Enable all.*/
+  EF_ALL = 31
+}

package/src/dce/EnumFocusMode.tsx

@@ -1,6 +1,6 @@
-export enum EnumFocusMode {
-    /**Lock the focal length.*/
-    FM_LOCKED = 1,
-    /**Keep continuous auto-focus.*/
-    FM_CONTINUOUS_AUTO  = 2
-}
+export enum EnumFocusMode {
+    /**Lock the focal length.*/
+    FM_LOCKED = 1,
+    /**Keep continuous auto-focus.*/
+    FM_CONTINUOUS_AUTO  = 2
+}

package/src/dce/EnumResolution.tsx

@@ -1,8 +1,8 @@
-export enum EnumResolution {
-  RESOLUTION_AUTO = 0,
-  RESOLUTION_480P = 1,
-  RESOLUTION_720P = 2,
-  Resolution1080P = 3,
-  RESOLUTION_4K = 4,
-  RESOLUTION_MAX = 5,
-}
+export enum EnumResolution {
+  RESOLUTION_AUTO = 0,
+  RESOLUTION_480P = 1,
+  RESOLUTION_720P = 2,
+  Resolution1080P = 3,
+  RESOLUTION_4K = 4,
+  RESOLUTION_MAX = 5,
+}

package/src/dce/EnumTorchState.tsx

@@ -1,10 +1,10 @@
-export enum EnumTorchState {
-    /**
-     * Set the torch state to off.
-     */
-    OFF,
-    /**
-     * Set the torch state to on.
-     */
-    ON
-}
+export enum EnumTorchState {
+    /**
+     * Set the torch state to off.
+     */
+    OFF,
+    /**
+     * Set the torch state to on.
+     */
+    ON
+}

package/src/dce/FeedBack.tsx

@@ -1,28 +1,28 @@
-import {NativeModules} from "react-native";
-
-// @ts-ignore Check whether __turboModuleProxy exists, it may not
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-
-const DynamsoftCameraEnhancerModule = isTurboModuleEnabled ?
-    require("./NativeDynamsoftCameraViewModule").default :
-    NativeModules.DynamsoftCameraView;
-
-/**
- * The Feedback class provides methods to trigger feedbacks from the hardware, such as vibrate and beep.
- * @hideconstructor
- * */
-export class FeedBack {
-    /**
-     * Trigger a beep.
-     * */
-    static beep(): void {
-        DynamsoftCameraEnhancerModule.beep();
-    }
-
-    /**
-     * Trigger a vibrate.
-     * */
-    static vibrate(): void {
-        DynamsoftCameraEnhancerModule.vibrate();
-    }
-}
+import {NativeModules} from "react-native";
+
+// @ts-ignore Check whether __turboModuleProxy exists, it may not
+const isTurboModuleEnabled = global.__turboModuleProxy != null;
+
+const DynamsoftCameraEnhancerModule = isTurboModuleEnabled ?
+    require("./NativeDynamsoftCameraViewModule").default :
+    NativeModules.DynamsoftCameraView;
+
+/**
+ * The Feedback class provides methods to trigger feedbacks from the hardware, such as vibrate and beep.
+ * @hideconstructor
+ * */
+export class FeedBack {
+    /**
+     * Trigger a beep.
+     * */
+    static beep(): void {
+        DynamsoftCameraEnhancerModule.beep();
+    }
+
+    /**
+     * Trigger a vibrate.
+     * */
+    static vibrate(): void {
+        DynamsoftCameraEnhancerModule.vibrate();
+    }
+}