dynamsoft-capture-vision-react-native 2.4.2000-alpha.2 → 2.6.1002

package/ios/CPP/RNDynamsoft+JSI.mm

@@ -0,0 +1,145 @@
+/*
+ * Copyright © Dynamsoft Corporation. All rights reserved.
+ */
+
+#import "RNDynamsoft+JSI.h"
+#import "RNDynamsoft+Json.h"
+#import "DSImageData+HostObject.h"
+#import "YeetJSIUtils.h"
+#import <DynamsoftCore/DynamsoftCore.h>
+#import <DynamsoftCaptureVisionRouter/DynamsoftCaptureVisionRouter.h>
+#import <DynamsoftBarcodeReader/DynamsoftBarcodeReader.h>
+#import <DynamsoftLabelRecognizer/DynamsoftLabelRecognizer.h>
+#import <DynamsoftDocumentNormalizer/DynamsoftDocumentNormalizer.h>
+#import <DynamsoftCodeParser/DynamsoftCodeParser.h>
+
+NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
+    return @[@(transform.a), @(transform.b), @(transform.c), @(transform.d), @(transform.tx), @(transform.ty)];
+}
+
+@implementation DSCapturedResultItem (JSI)
+
+- (Object)convertToJSIObject:(Runtime& )runtime {
+    Object obj = Object(runtime);
+    obj.setProperty(runtime, "type", convertNSNumberToJSINumber(runtime, @(self.type)));
+    obj.setProperty(runtime, "targetROIDefName", convertNSStringToJSIString(runtime, self.targetROIDefName));
+    obj.setProperty(runtime, "taskName", convertNSStringToJSIString(runtime, self.taskName));
+    switch (self.type) {
+        case DSCapturedResultItemTypeOriginalImage:
+            {
+                
+            }
+            break;
+        case DSCapturedResultItemTypeBarcode:
+            {
+                DSBarcodeResultItem *item = (DSBarcodeResultItem *)self;
+                obj.setProperty(runtime, "format", convertNSNumberToJSINumber(runtime, @(item.format)));
+                obj.setProperty(runtime, "formatString", convertNSStringToJSIString(runtime, item.formatString));
+                obj.setProperty(runtime, "text", convertNSStringToJSIString(runtime, item.text));
+                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
+                obj.setProperty(runtime, "confidence", convertNSNumberToJSINumber(runtime, @(item.confidence)));
+                obj.setProperty(runtime, "angle", convertNSNumberToJSINumber(runtime, @(item.angle)));
+                obj.setProperty(runtime, "moduleSize", convertNSNumberToJSINumber(runtime, @(item.moduleSize)));
+                obj.setProperty(runtime, "isDPM", convertNSNumberToJSIBoolean(runtime, @(item.isDPM)));
+                obj.setProperty(runtime, "isMirrored", convertNSNumberToJSIBoolean(runtime, @(item.isMirrored)));
+            }
+            break;
+        case DSCapturedResultItemTypeTextLine:
+            {
+                DSTextLineResultItem *item = (DSTextLineResultItem *)self;
+                obj.setProperty(runtime, "text", convertNSStringToJSIString(runtime, item.text));
+                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
+                obj.setProperty(runtime, "confidence",convertNSNumberToJSINumber(runtime, @(item.confidence)));
+                int count = item.charResult.count;
+                if (count > 0) {
+                    jsi::Array array = jsi::Array(runtime, count);
+                    for (size_t i = 0; i < count; i++) {
+                        array.setValueAtIndex(runtime, i, convertNSDictionaryToJSIObject(runtime, [[item.charResult objectAtIndex:i] toJson]));
+                    }
+                    obj.setProperty(runtime, "charResult", array);
+                }
+            }
+            break;
+        case DSCapturedResultItemTypeDetectedQuad:
+            {
+                DSDetectedQuadResultItem *item = (DSDetectedQuadResultItem *)self;
+                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
+                obj.setProperty(runtime, "confidenceAsDocumentBoundary",convertNSNumberToJSINumber(runtime, @(item.confidenceAsDocumentBoundary)));
+            }
+            break;
+        case DSCapturedResultItemTypeNormalizedImage:
+            {
+                DSNormalizedImageResultItem *item = (DSNormalizedImageResultItem *)self;
+                if (item.imageData) {
+                    ImageDataHostObject hostObject = [item.imageData hostObject];
+                    Object object = Object::createFromHostObject(runtime, std::make_shared<ImageDataHostObject>(hostObject));
+                    obj.setProperty(runtime, "imageData", object);
+                }
+                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
+            }
+            break;
+        case DSCapturedResultItemTypeParsedResult:
+            {
+                DSParsedResultItem *item = (DSParsedResultItem *)self;
+                NSDictionary<NSString *, NSString *> *parsedFields = item.parsedFields;
+                NSMutableDictionary *mutableDictionary = [NSMutableDictionary dictionaryWithDictionary:parsedFields];
+                for (NSString *key in [parsedFields allKeys]) {
+                    [mutableDictionary setValue:@{ @"value":[parsedFields valueForKey:key],
+                                                   @"mappingStatus":@([item getFieldMappingStatus:key]),
+                                                   @"validationStatus":@([item getFieldValidationStatus:key]) } forKey:key];
+                }
+                obj.setProperty(runtime, "", convertNSDictionaryToJSIObject(runtime, [mutableDictionary copy]));
+                obj.setProperty(runtime, "jsonString", convertNSStringToJSIString(runtime, item.jsonString));
+                obj.setProperty(runtime, "codeType", convertNSStringToJSIString(runtime, item.codeType));
+            }
+            break;
+    }
+    return obj;
+}
+
+@end
+
+@implementation DSCapturedResult (JSI)
+
+- (Object)convertToJSIObject:(Runtime& )runtime {
+    Object obj = Object(runtime);
+    obj.setProperty(runtime, "originalImageHashId", convertNSStringToJSIString(runtime, self.originalImageHashId));
+    obj.setProperty(runtime, "errorMessage", convertNSStringToJSIString(runtime, self.errorMessage));
+    obj.setProperty(runtime, "errorCode", convertNSNumberToJSINumber(runtime, @(self.errorCode)));
+    obj.setProperty(runtime, "rotationTransformMatrix", convertNSArrayToJSIArray(runtime, CGAffineTransformToArray(self.rotationTransformMatrix)));
+    int count = (int)self.items.count;
+    if (count > 0) {
+        jsi::Array array = jsi::Array(runtime, count);
+        for (size_t i = 0; i < count; i++) {
+            array.setValueAtIndex(runtime, i, [[self.items objectAtIndex:i] convertToJSIObject:runtime]);
+        }
+        obj.setProperty(runtime, "items", array);
+    }
+    return obj;
+}
+
+@end
+
+DSQuadrilateral * convertJSIValueToDSQuadrilateral(
+                               jsi::Runtime &runtime,
+                               const jsi::Object &value)
+{
+    if (value.hasProperty(runtime, "points") && value.getProperty(runtime, "points").isObject() && value.getProperty(runtime, "points").getObject(runtime).isArray(runtime)) {
+        auto jsiPoints = value.getProperty(runtime, "points").getObject(runtime).getArray(runtime);
+        size_t size = jsiPoints.size(runtime);
+        NSMutableArray *points = [NSMutableArray array];
+        for (size_t i = 0; i < size; i++) {
+            auto jsiPoint =  jsiPoints.getValueAtIndex(runtime, i).getObject(runtime);
+            if (jsiPoint.hasProperty(runtime, "x") && jsiPoint.hasProperty(runtime, "y")) {
+                double x = jsiPoint.getProperty(runtime, "x").getNumber();
+                double y = jsiPoint.getProperty(runtime, "y").getNumber();
+                CGPoint point = CGPointMake(x, y);
+                [points addObject:[NSValue valueWithCGPoint:point]];
+            }
+        }
+        if (points.count == 4) {
+            return [[DSQuadrilateral alloc] initWithPointArray:[points copy]];
+        }
+    }
+    return nil;
+}

package/ios/{RNDynamsoftCaptureVision/CPP → CPP}/RNDynamsoft+Json.h

@@ -8,7 +8,6 @@
 #import <DynamsoftLabelRecognizer/DynamsoftLabelRecognizer.h>
 #import <DynamsoftDocumentNormalizer/DynamsoftDocumentNormalizer.h>
 #import <DynamsoftCodeParser/DynamsoftCodeParser.h>
-#import "YeetJSIUtils.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -20,6 +19,12 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+@interface DSCharacterResult (Json)
+
+- (NSDictionary *)toJson;
+
+@end
+
 @interface DSSimplifiedCaptureVisionSettings (Json)
 
 - (void)updateWithDicitionary:(NSDictionary *)dictionary;
@@ -52,12 +57,16 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+@interface DSCapturedResultItem (Json)
+
+- (nullable NSDictionary *)toJson;
+
+@end
+
 @interface DSCapturedResult (Json)
 
 - (NSObject *)toJson;
 
-- (Object)convertToJSIObject:(Runtime& )runtime;
-
 @end
 
 @interface DSDecodedBarcodesResult (Json)
@@ -91,5 +100,3 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 NS_ASSUME_NONNULL_END
-
-DSQuadrilateral * _Nullable convertJSIValueToDSQuadrilateral(jsi::Runtime &runtime, const jsi::Object &value);

package/ios/{RNDynamsoftCaptureVision/CPP/RNDynamsoft+Json.mm → CPP/RNDynamsoft+Json.m}

@@ -3,7 +3,6 @@
  */
 
 #import "RNDynamsoft+Json.h"
-#import "DSImageData+HostObject.h"
 
 NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
     return @[@(transform.a), @(transform.b), @(transform.c), @(transform.d), @(transform.tx), @(transform.ty)];
@@ -228,7 +227,7 @@ NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
                                      @"characterModelName":self.characterModelName ? self.characterModelName : [NSNull null],
                                      @"lineStringRegExPattern":self.lineStringRegExPattern ? self.lineStringRegExPattern : [NSNull null],
                                      @"maxThreadsInOneTask":@(self.maxThreadsInOneTask),
-                                     @"scaleDownThreshold":@(self.scaleDownThreshold) 
+                                     @"scaleDownThreshold":@(self.scaleDownThreshold)
         };
         return dictionary;
     } else {
@@ -364,7 +363,8 @@ NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
                                 @"targetROIDefName":item.targetROIDefName,
                                 @"taskName":item.taskName,
                                 @"location":[item.location toJson],
-                                @"confidenceAsDocumentBoundary":@(item.confidenceAsDocumentBoundary)
+                                @"confidenceAsDocumentBoundary":@(item.confidenceAsDocumentBoundary),
+                                @"crossVerificationStatus":@(item.crossVerificationStatus)
                 };
             }
             break;
@@ -374,7 +374,9 @@ NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
                 dictionary = @{ @"type":@(item.type),
                                 @"targetROIDefName":item.targetROIDefName,
                                 @"taskName":item.taskName,
-                                @"location":[item.location toJson] };
+                                @"location":[item.location toJson],
+                                @"crossVerificationStatus":@(item.crossVerificationStatus)
+                };
             }
             break;
         case DSCapturedResultItemTypeParsedResult:
@@ -400,84 +402,6 @@ NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
     return dictionary;
 }
 
-- (Object)convertToJSIObject:(Runtime& )runtime {
-    Object obj = Object(runtime);
-    obj.setProperty(runtime, "type", convertNSNumberToJSINumber(runtime, @(self.type)));
-    obj.setProperty(runtime, "targetROIDefName", convertNSStringToJSIString(runtime, self.targetROIDefName));
-    obj.setProperty(runtime, "taskName", convertNSStringToJSIString(runtime, self.taskName));
-    switch (self.type) {
-        case DSCapturedResultItemTypeOriginalImage:
-            {
-                
-            }
-            break;
-        case DSCapturedResultItemTypeBarcode:
-            {
-                DSBarcodeResultItem *item = (DSBarcodeResultItem *)self;
-                obj.setProperty(runtime, "format", convertNSNumberToJSINumber(runtime, @(item.format)));
-                obj.setProperty(runtime, "formatString", convertNSStringToJSIString(runtime, item.formatString));
-                obj.setProperty(runtime, "text", convertNSStringToJSIString(runtime, item.text));
-                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
-                obj.setProperty(runtime, "confidence", convertNSNumberToJSINumber(runtime, @(item.confidence)));
-                obj.setProperty(runtime, "angle", convertNSNumberToJSINumber(runtime, @(item.angle)));
-                obj.setProperty(runtime, "moduleSize", convertNSNumberToJSINumber(runtime, @(item.moduleSize)));
-                obj.setProperty(runtime, "isDPM", convertNSNumberToJSIBoolean(runtime, @(item.isDPM)));
-                obj.setProperty(runtime, "isMirrored", convertNSNumberToJSIBoolean(runtime, @(item.isMirrored)));
-            }
-            break;
-        case DSCapturedResultItemTypeTextLine:
-            {
-                DSTextLineResultItem *item = (DSTextLineResultItem *)self;
-                obj.setProperty(runtime, "text", convertNSStringToJSIString(runtime, item.text));
-                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
-                obj.setProperty(runtime, "confidence",convertNSNumberToJSINumber(runtime, @(item.confidence)));
-                int count = item.charResult.count;
-                if (count > 0) {
-                    jsi::Array array = jsi::Array(runtime, count);
-                    for (size_t i = 0; i < count; i++) {
-                        array.setValueAtIndex(runtime, i, convertNSDictionaryToJSIObject(runtime, [[item.charResult objectAtIndex:i] toJson]));
-                    }
-                    obj.setProperty(runtime, "charResult", array);
-                }
-            }
-            break;
-        case DSCapturedResultItemTypeDetectedQuad:
-            {
-                DSDetectedQuadResultItem *item = (DSDetectedQuadResultItem *)self;
-                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
-                obj.setProperty(runtime, "confidenceAsDocumentBoundary",convertNSNumberToJSINumber(runtime, @(item.confidenceAsDocumentBoundary)));
-            }
-            break;
-        case DSCapturedResultItemTypeNormalizedImage:
-            {
-                DSNormalizedImageResultItem *item = (DSNormalizedImageResultItem *)self;
-                if (item.imageData) {
-                    ImageDataHostObject hostObject = [item.imageData hostObject];
-                    Object object = Object::createFromHostObject(runtime, std::make_shared<ImageDataHostObject>(hostObject));
-                    obj.setProperty(runtime, "imageData", object);
-                }
-                obj.setProperty(runtime, "location", convertNSDictionaryToJSIObject(runtime, [item.location toJson]));
-            }
-            break;
-        case DSCapturedResultItemTypeParsedResult:
-            {
-                DSParsedResultItem *item = (DSParsedResultItem *)self;
-                NSDictionary<NSString *, NSString *> *parsedFields = item.parsedFields;
-                NSMutableDictionary *mutableDictionary = [NSMutableDictionary dictionaryWithDictionary:parsedFields];
-                for (NSString *key in [parsedFields allKeys]) {
-                    [mutableDictionary setValue:@{ @"value":[parsedFields valueForKey:key],
-                                                   @"mappingStatus":@([item getFieldMappingStatus:key]),
-                                                   @"validationStatus":@([item getFieldValidationStatus:key]) } forKey:key];
-                }
-                obj.setProperty(runtime, "", convertNSDictionaryToJSIObject(runtime, [mutableDictionary copy]));
-                obj.setProperty(runtime, "jsonString", convertNSStringToJSIString(runtime, item.jsonString));
-                obj.setProperty(runtime, "codeType", convertNSStringToJSIString(runtime, item.codeType));
-            }
-            break;
-    }
-    return obj;
-}
-
 @end
 
 @implementation DSCapturedResult (Json)
@@ -509,23 +433,6 @@ NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
     }
 }
 
-- (Object)convertToJSIObject:(Runtime& )runtime {
-    Object obj = Object(runtime);
-    obj.setProperty(runtime, "originalImageHashId", convertNSStringToJSIString(runtime, self.originalImageHashId));
-    obj.setProperty(runtime, "errorMessage", convertNSStringToJSIString(runtime, self.errorMessage));
-    obj.setProperty(runtime, "errorCode", convertNSNumberToJSINumber(runtime, @(self.errorCode)));
-    obj.setProperty(runtime, "rotationTransformMatrix", convertNSArrayToJSIArray(runtime, CGAffineTransformToArray(self.rotationTransformMatrix)));
-    int count = (int)self.items.count;
-    if (count > 0) {
-        jsi::Array array = jsi::Array(runtime, count);
-        for (size_t i = 0; i < count; i++) {
-            array.setValueAtIndex(runtime, i, [[self.items objectAtIndex:i] convertToJSIObject:runtime]);
-        }
-        obj.setProperty(runtime, "items", array);
-    }
-    return obj;
-}
-
 @end
 
 @implementation DSDecodedBarcodesResult (Json)
@@ -681,28 +588,3 @@ NSArray<NSNumber *> *CGAffineTransformToArray(CGAffineTransform transform) {
 }
 
 @end
-
-
-DSQuadrilateral * convertJSIValueToDSQuadrilateral(
-                               jsi::Runtime &runtime,
-                               const jsi::Object &value)
-{
-    if (value.hasProperty(runtime, "points") && value.getProperty(runtime, "points").isObject() && value.getProperty(runtime, "points").getObject(runtime).isArray(runtime)) {
-        auto jsiPoints = value.getProperty(runtime, "points").getObject(runtime).getArray(runtime);
-        size_t size = jsiPoints.size(runtime);
-        NSMutableArray *points = [NSMutableArray array];
-        for (size_t i = 0; i < size; i++) {
-            auto jsiPoint =  jsiPoints.getValueAtIndex(runtime, i).getObject(runtime);
-            if (jsiPoint.hasProperty(runtime, "x") && jsiPoint.hasProperty(runtime, "y")) {
-                double x = jsiPoint.getProperty(runtime, "x").getNumber();
-                double y = jsiPoint.getProperty(runtime, "y").getNumber();
-                CGPoint point = CGPointMake(x, y);
-                [points addObject:[NSValue valueWithCGPoint:point]];
-            }
-        }
-        if (points.count == 4) {
-            return [[DSQuadrilateral alloc] initWithPointArray:[points copy]];
-        }
-    }
-    return nil;
-}

package/ios/{RNDynamsoftCaptureVision/RNDynamsoftCaptureVisionRouter.mm → RNDynamsoftCaptureVisionRouter.mm}

@@ -11,6 +11,7 @@
 #import <React/RCTUIManager.h>
 #import "RNDynamsoftImageSourceAdapter.h"
 #import "RNDynamsoft+Json.h"
+#import "RNDynamsoft+JSI.h"
 #import <jsi/jsi.h>
 #import <React/RCTBridge+Private.h>
 #import "DSImageData+HostObject.h"

package/ios/{RNDynamsoftCaptureVision/RNDynamsoftImageEditorViewManager.mm → RNDynamsoftImageEditorViewManager.mm}

@@ -58,7 +58,11 @@ RCT_EXPORT_METHOD(getSelectedQuad:(nonnull NSNumber *)tag
              DSDrawingItem *item = [((RNDynamsoftImageEditorView *)view).editorView getSelectedDrawingItem];
              if (item && item.mediaType == DSDrawingItemMediaTypeQuadrilateral) {
                  DSQuadDrawingItem *quadItem = (DSQuadDrawingItem *)item;
-                 resolve([quadItem.quad toJson]);
+                 if (quadItem) {
+                     resolve([quadItem.quad toJson]);
+                 } else {
+                     resolve(nil);
+                 }
              }
          }
      }];

package/ios/{RNDynamsoftCaptureVision/RNDynamsoftImageManager.mm → RNDynamsoftImageManager.mm}

@@ -11,6 +11,7 @@
 #import "YeetJSIUtils.h"
 #import "DSImageData+HostObject.h"
 #import "RNDynamsoft+Json.h"
+#import "RNDynamsoft+JSI.h"
 
 using namespace facebook::jsi;
 using namespace facebook;
@@ -100,13 +101,16 @@ static void install(jsi::Runtime &jsiRuntime, RNDynamsoftImageManager *rnManager
                     [mutableArray addObject:quad];
                 }
             }
-            int hexColor = arguments[2].getNumber();
+            NSInteger hexColor = arguments[2].getNumber();
             int thickness = arguments[3].getNumber();
             UIColor *color = [UIColor colorWithRed:((hexColor >> 16) & 0xFF) / 255.0
                                              green:((hexColor >> 8) & 0xFF) / 255.0
                                               blue:(hexColor & 0xFF) / 255.0
                                              alpha:((hexColor >> 24) & 0xFF) / 255.0];
-            [rnManager.manager drawOnImage:data quads:[mutableArray copy] colour:color thickness:thickness];
+            DSImageData *imageData = [rnManager.manager drawOnImage:data quads:[mutableArray copy] colour:color thickness:thickness];
+            ImageDataHostObject outImageData = [imageData hostObject];
+            Object outObj = Object::createFromHostObject(runtime, std::make_shared<ImageDataHostObject>(outImageData));
+            return outObj;
         }
         return Value(false);
     });

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "dynamsoft-capture-vision-react-native",
   "title": "Dynamsoft Capture Vision React Native",
-  "version": "2.4.2000-alpha.2",
+  "version": "2.6.1002",
   "description": "Dynamsoft Capture Vision React Native SDK. The SDK supports barcode decoding, document scanning and MRZ reading.",
-  "homepage": "https://www.dynamsoft.com/capture-vision/docs/mobile/programming/react-native/",
+  "homepage": "https://github.com/Dynamsoft/capture-vision-react-native-samples",
   "main": "src/index.tsx",
   "files": [
     "README.md",

package/src/core/CapturedResultItem.tsx

@@ -1,7 +1,23 @@
-import type { EnumCapturedResultItemType } from "./EnumCaptureResultItemType";
+import type {EnumCapturedResultItemType} from "./EnumCaptureResultItemType";
 
+/**
+ * The CapturedResultItem class provides a common structure for representing different types of captured results.
+ * Each specific captured result item type will have its own implementation and additional properties specific to that type.
+ * */
 export interface CapturedResultItem {
-  type: EnumCapturedResultItemType | number ;
+  /**
+   * The type of the captured result item.
+   * - {@link EnumCapturedResultItemType}: An enum representing the specific type of the captured result.
+   */
+  type: EnumCapturedResultItemType | number;
+
+  /**
+   * The name of the task that generated the result.
+   * */
   taskName?: string;
+
+  /**
+   * the name of the TargetROIDef object which includes a task that generated the result.
+   * */
   targetROIDefName?: string;
 }

package/src/core/CompletionListener.tsx

@@ -1,4 +1,5 @@
 export interface CompletionListener {
-    onSuccess(): void,
-    onFailure(errorCode: number, errorMessage: string): void
-}
+  onSuccess(): void,
+
+  onFailure(errorCode: number, errorMessage: string): void
+}

package/src/core/CoreModule.tsx

@@ -2,7 +2,7 @@ import {DynamsoftVersions} from '../VersionsModule'
 import {Platform} from "react-native";
 
 export class CoreModule {
-    static getVersion(): string {
-        return '['+Platform.OS+']: ' + DynamsoftVersions.core
-    }
+  static getVersion(): string {
+    return '[' + Platform.OS + ']: ' + DynamsoftVersions.core
+  }
 }

package/src/core/DSRect.tsx

@@ -1,23 +1,30 @@
+/**
+ * The DSRect class represents a rectangle in 2D space,
+ * which contains four integer values that specify the top, left, right, and bottom edges of the rectangle.
+ * @see CameraEnhancer.setScanRegion
+ * */
 export interface DSRect {
-    /**
-     * Y coordinate of the buttom border of the region.
-     */
-    bottom: number;
-    /**
-     * X coordinate of the right border of the region.
-     */
-    right: number;
-    /**
-     * X coordinate of the left border of the region.
-     */
-    left: number;
-    /**
-     * Y coordinate of the top border of the region.
-     */
-    top: number;
-    /**
-     * 1/True: the coordinates are measured by percentage.
-     * 0/False: the coordinates are measured by pixel distance.
-     */
-    measuredInPercentage: number | boolean;
+  /**
+   * The distance between the top of the rect and the x-axis.
+   * If {@link measuredInPercentage} = 1/true, the value specifies the percentage comparing with the height of the parent.
+   * If {@link measuredInPercentage} = 0/false, the value specifies a pixel length.
+   */
+  top: number;
+  /**
+   * Y coordinate of the buttom border of the region.
+   */
+  bottom: number;
+  /**
+   * X coordinate of the right border of the region.
+   */
+  right: number;
+  /**
+   * X coordinate of the left border of the region.
+   */
+  left: number;
+  /**
+   * 1/True: the coordinates are measured by percentage.
+   * 0/False: the coordinates are measured by pixel distance.
+   */
+  measuredInPercentage: number | boolean;
 }

package/src/core/EnumCaptureResultItemType.tsx

@@ -1,8 +1,39 @@
+/**
+ * Defines the various categories of items that can be recognized and captured.
+ * */
 export enum EnumCapturedResultItemType {
-    CRIT_ORIGINAL_IMAGE = 0x1,
-    CRIT_BARCODE = 0x2,
-    CRIT_TEXT_LINE = 0x4,
-    CRIT_DETECTED_QUAD = 0x8,
-    CRIT_NORMALIZED_IMAGE = 0x10,
-    CRIT_PARSED_RESULT = 0x20
-}
+  /**
+   * Not use for react-native edition
+   * */
+  CRIT_ORIGINAL_IMAGE = 0x1,
+
+  /**
+   * The type of the CapturedResultItem is "barcode".
+   * @see BarcodeResultItem
+   * */
+  CRIT_BARCODE = 0x2,
+
+  /**
+   * The type of the CapturedResultItem is "text line".
+   * @see TextLineResultItem
+   * */
+  CRIT_TEXT_LINE = 0x4,
+
+  /**
+   * The type of the CapturedResultItem is "detected quad".
+   * @see DetectedQuadResultItem
+   * */
+  CRIT_DETECTED_QUAD = 0x8,
+
+  /**
+   * The type of the CapturedResultItem is "normalized image".
+   * @see NormalizedImageResultItem
+   * */
+  CRIT_NORMALIZED_IMAGE = 0x10,
+
+  /**
+   * The type of the CapturedResultItem is "parsed result".
+   * @see ParsedResultItem
+   * */
+  CRIT_PARSED_RESULT = 0x20
+}

package/src/core/EnumColourChannelUsageType.tsx

@@ -1,8 +1,26 @@
+/**
+ * Enumerates the different ways color channels can be utilized in image processing.
+ * This allows for flexible image analysis and manipulation by specifying how color data should be handled.
+ *
+ * @see ImageSourceAdapter.getColourChannelUsageType
+ * @see ImageSourceAdapter.setColourChannelUsageType
+ * */
 export enum EnumColourChannelUsageType {
-    CCUT_AUTO = 0,
-    CCUT_FULL_CHANNEL = 1,
-    CCUT_Y_CHANNEL_ONLY = 2,
-    CCUT_RGB_R_CHANNEL_ONLY = 3,
-    CCUT_RGB_G_CHANNEL_ONLY = 4,
-    CCUT_RGB_B_CHANNEL_ONLY = 5
-}
+  /** Automatic color channel usage determination based on image pixel format and scene. */
+  CCUT_AUTO = 0,
+
+  /** Automatic color channel usage determination based on image pixel format and scene. */
+  CCUT_FULL_CHANNEL = 1,
+
+  /** Use only the Y (luminance) channel for processing in images represented in the NV21 format. */
+  CCUT_Y_CHANNEL_ONLY = 2,
+
+  /** Use only the red channel for processing in RGB images.*/
+  CCUT_RGB_R_CHANNEL_ONLY = 3,
+
+  /** Use only the green channel for processing in RGB images.*/
+  CCUT_RGB_G_CHANNEL_ONLY = 4,
+
+  /** Use only the blue channel for processing in RGB images.*/
+  CCUT_RGB_B_CHANNEL_ONLY = 5
+}

package/src/core/EnumCrossVerificationStatus.tsx

@@ -0,0 +1,43 @@
+/**
+ * CrossVerificationStatus describes the status of the captured results.
+ * <p>
+ * Code Snippet:
+ * ```
+ * let router = CaptureVisionRouter.getInstance()
+ * let filter = new MultiFrameResultCrossFilter()
+ * filter.enableResultCrossVerification(EnumCapturedResultItemType.CRIT_DETECTED_QUAD, true)
+ * router.addFilter(filter)
+ *
+ * router.addResultReceiver({
+ *    onDetectedQuadsReceived: result => {
+ *        if(result.items && result.items.length > 0) {
+ *            //Because result cross verification of DETECT_QUAD is enabled,
+ *            //crossVerificationStatus of item will be CVS_PASSED or CVS_FAILED.
+ *            let crossVerificationStatus = result.items[0].crossVerificationStatus
+ *        }
+ *    },
+ * })
+ * //...
+ * router.startCapturing(EnumPresetTemplate.PT_DETECT_DOCUMENT_BOUNDARIES)
+ * ```
+ *
+ * @remarks If {@link CaptureVisionRouter} doesn't add {@link MultiFrameResultCrossFilter} via {@link CaptureVisionRouter.addFilter}
+ * or added {@link MultiFrameResultCrossFilter} doesn't enable verification for the corresponding type,
+ * the crossVerificationStatus property of the item for that type will always remain {@link CVS_NOT_VERIFIED}.
+ * <p>
+ * Currently, only {@link DetectedQuadResultItem} and {@link NormalizedImageResultItem} have the crossVerificationStatus property.
+ *
+ * @see MultiFrameResultCrossFilter.enableResultCrossVerification
+ * @see DetectedQuadResultItem.crossVerificationStatus
+ * @see NormalizedImageResultItem.crossVerificationStatus
+ * */
+export enum EnumCrossVerificationStatus {
+  /** The cross verification has not been performed yet. */
+  CVS_NOT_VERIFIED = 0,
+
+  /** The cross verification has been passed successfully. */
+  CVS_PASSED = 1,
+
+  /** The cross verification has failed. */
+  CVS_FAILED = 2
+}