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

package/ios/RNDynamsoftImageManager.mm

@@ -3,7 +3,7 @@
  */
 
 #import "RNDynamsoftImageManager.h"
-#import <DynamsoftUtility/DynamsoftUtility.h>
+#import <DynamsoftCaptureVisionBundle/DynamsoftCaptureVisionBundle.h>
 #import <React/RCTBridge+Private.h>
 #import <React/RCTUtils.h>
 #import <jsi/jsi.h>
@@ -19,7 +19,9 @@ using namespace std;
 
 @interface RNDynamsoftImageManager ()
 
-@property (nonatomic, strong) DSImageManager *manager;
+@property (nonatomic, strong) DSImageIO *manager;
+@property (nonatomic, strong) DSImageDrawer *drawer;
+@property (nonatomic, strong) DSImageProcessor *processor;
 
 @end
 
@@ -29,7 +31,9 @@ using namespace std;
 {
     self = [super init];
     if (self) {
-        _manager = [[DSImageManager alloc] init];
+        _manager = [[DSImageIO alloc] init];
+        _drawer = [[DSImageDrawer alloc] init];
+        _processor = [[DSImageProcessor alloc] init];
     }
     return self;
 }
@@ -107,7 +111,7 @@ static void install(jsi::Runtime &jsiRuntime, RNDynamsoftImageManager *rnManager
                                              green:((hexColor >> 8) & 0xFF) / 255.0
                                               blue:(hexColor & 0xFF) / 255.0
                                              alpha:((hexColor >> 24) & 0xFF) / 255.0];
-            DSImageData *imageData = [rnManager.manager drawOnImage:data quads:[mutableArray copy] colour:color thickness:thickness];
+            DSImageData *imageData = [rnManager.drawer 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;
@@ -115,6 +119,31 @@ static void install(jsi::Runtime &jsiRuntime, RNDynamsoftImageManager *rnManager
         return Value(false);
     });
     jsiRuntime.global().setProperty(jsiRuntime, drawOnImageName, std::move(drawOnImageFunc));
+    
+    const char* cropImageName = "imageManager_cropImage";
+    auto cropImageFunc = Function::createFromHostFunction(jsiRuntime,
+                                                    PropNameID::forAscii(jsiRuntime,
+                                                                         cropImageName),
+                                                    2,
+                                                    [rnManager](Runtime &runtime,
+                                                             const Value& /*thisValue*/,
+                                                             const Value* arguments,
+                                                             size_t count) -> Value {
+        Object obj = arguments[0].getObject(runtime);
+        if (obj.isHostObject<ImageDataHostObject>(runtime)) {
+            ImageDataHostObject hostObject = ImageDataHostObject::getHOFromObject(runtime, std::move(obj));
+            DSImageData *data = [DSImageData imageDataFromHostObject:hostObject];
+            Object obj = arguments[1].getObject(runtime);
+            DSQuadrilateral *quad = convertJSIValueToDSQuadrilateral(runtime, obj);
+            NSError *error;
+            DSImageData *imageData = [rnManager.processor cropAndDeskewImage:data quad:quad error:&error];
+            ImageDataHostObject outImageData = [imageData hostObject];
+            Object outObj = Object::createFromHostObject(runtime, std::make_shared<ImageDataHostObject>(outImageData));
+            return outObj;
+        }
+        return Value(false);
+    });
+    jsiRuntime.global().setProperty(jsiRuntime, cropImageName, std::move(cropImageFunc));
 }
 
 @end

package/ios/RNDynamsoftImageSourceAdapter.mm

@@ -8,7 +8,7 @@
 #import <jsi/jsi.h>
 #import <sys/utsname.h>
 #import "YeetJSIUtils.h"
-#import <DynamsoftCore/DynamsoftCore.h>
+#import <DynamsoftCaptureVisionBundle/DynamsoftCaptureVisionBundle.h>
 #import "DSImageData+HostObject.h"
 
 using namespace facebook::jsi;

package/ios/RNDynamsoftLicense.m

@@ -3,7 +3,7 @@
  */
 
 #import "RNDynamsoftLicense.h"
-#import <DynamsoftLicense/DynamsoftLicense.h>
+#import <DynamsoftCaptureVisionBundle/DynamsoftCaptureVisionBundle.h>
 
 @interface RNDynamsoftLicense () <DSLicenseVerificationListener>
 

package/ios/RNDynamsoftMultiCrossFilter.m

@@ -3,7 +3,7 @@
  */
 
 #import "RNDynamsoftMultiCrossFilter.h"
-#import <DynamsoftUtility/DynamsoftUtility.h>
+#import <DynamsoftCaptureVisionBundle/DynamsoftCaptureVisionBundle.h>
 #import "RNDynamsoftCaptureVisionRouter.h"
 
 @implementation RNDynamsoftMultiCrossFilter
@@ -29,10 +29,10 @@ RCT_EXPORT_METHOD(enableResultCrossVerification:(NSString *)key type:(NSInteger)
     [filter enableResultCrossVerification:type isEnabled:isEnabled];
 }
 
-RCT_EXPORT_METHOD(isResultCrossVerificationEnabled:(NSString *)key 
+RCT_EXPORT_METHOD(isResultCrossVerificationEnabled:(NSString *)key
                   type:(NSInteger)type
                   resolver:(RCTPromiseResolveBlock)resolve
-                  rejecter:(RCTPromiseRejectBlock)reject) 
+                  rejecter:(RCTPromiseRejectBlock)reject)
 {
     RNDynamsoftCaptureVisionRouter *router = [self.bridge moduleForClass:[RNDynamsoftCaptureVisionRouter class]];
     DSMultiFrameResultCrossFilter *filter = [router.filterDictionary objectForKey:key];
@@ -61,10 +61,10 @@ RCT_EXPORT_METHOD(setDuplicateForgetTime:(NSString *)key type:(NSInteger)type ti
     [filter setDuplicateForgetTime:type duplicateForgetTime:time];
 }
 
-RCT_EXPORT_METHOD(getDuplicateForgetTime:(NSString *)key 
+RCT_EXPORT_METHOD(getDuplicateForgetTime:(NSString *)key
                   type:(NSInteger)type
                   resolver:(RCTPromiseResolveBlock)resolve
-                  rejecter:(RCTPromiseRejectBlock)reject) 
+                  rejecter:(RCTPromiseRejectBlock)reject)
 {
     RNDynamsoftCaptureVisionRouter *router = [self.bridge moduleForClass:[RNDynamsoftCaptureVisionRouter class]];
     DSMultiFrameResultCrossFilter *filter = [router.filterDictionary objectForKey:key];
@@ -77,10 +77,10 @@ RCT_EXPORT_METHOD(enableLatestOverlapping:(NSString *)key type:(NSInteger)type i
     [filter enableLatestOverlapping:type isEnabled:isEnabled];
 }
 
-RCT_EXPORT_METHOD(isLatestOverlappingEnabled:(NSString *)key 
+RCT_EXPORT_METHOD(isLatestOverlappingEnabled:(NSString *)key
                   type:(NSInteger)type
                   resolver:(RCTPromiseResolveBlock)resolve
-                  rejecter:(RCTPromiseRejectBlock)reject) 
+                  rejecter:(RCTPromiseRejectBlock)reject)
 {
     RNDynamsoftCaptureVisionRouter *router = [self.bridge moduleForClass:[RNDynamsoftCaptureVisionRouter class]];
     DSMultiFrameResultCrossFilter *filter = [router.filterDictionary objectForKey:key];
@@ -93,10 +93,10 @@ RCT_EXPORT_METHOD(setMaxOverlappingFrames:(NSString *)key type:(NSInteger)type m
     [filter setMaxOverlappingFrames:type maxOverlappingFrames:maxOverlappingFrames];
 }
 
-RCT_EXPORT_METHOD(getMaxOverlappingFrames:(NSString *)key 
+RCT_EXPORT_METHOD(getMaxOverlappingFrames:(NSString *)key
                   type:(NSInteger)type
                   resolver:(RCTPromiseResolveBlock)resolve
-                  rejecter:(RCTPromiseRejectBlock)reject) 
+                  rejecter:(RCTPromiseRejectBlock)reject)
 {
     RNDynamsoftCaptureVisionRouter *router = [self.bridge moduleForClass:[RNDynamsoftCaptureVisionRouter class]];
     DSMultiFrameResultCrossFilter *filter = [router.filterDictionary objectForKey:key];

package/ios/RNDynamsoftVersions.m

@@ -3,19 +3,7 @@
  */
 
 #import "RNDynamsoftVersions.h"
-#import <DynamsoftCore/DynamsoftCore.h>
-#import <DynamsoftLicense/DynamsoftLicense.h>
-#import <DynamsoftImageProcessing/DynamsoftImageProcessing.h>
-#import <DynamsoftCaptureVisionRouter/DynamsoftCaptureVisionRouter.h>
-#import <DynamsoftBarcodeReader/DynamsoftBarcodeReader.h>
-#import <DynamsoftLabelRecognizer/DynamsoftLabelRecognizer.h>
-#import <DynamsoftDocumentNormalizer/DynamsoftDocumentNormalizer.h>
-#import <DynamsoftCameraEnhancer/DynamsoftCameraEnhancer.h>
-#import <DynamsoftNeuralNetwork/DynamsoftNeuralNetwork.h>
-#import <DynamsoftUtility/DynamsoftUtility.h>
-#import <DynamsoftCodeParser/DynamsoftCodeParser.h>
-#import <DynamsoftCodeParserDedicator/DynamsoftCodeParserDedicator.h>
-#import <DynamsoftImageProcessing/DynamsoftImageProcessing.h>
+#import <DynamsoftCaptureVisionBundle/DynamsoftCaptureVisionBundle.h>
 
 @implementation RNDynamsoftVersions
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "dynamsoft-capture-vision-react-native",
   "title": "Dynamsoft Capture Vision React Native",
-  "version": "2.6.1016",
-  "description": "Dynamsoft Capture Vision React Native SDK. The SDK supports barcode decoding, document scanning and MRZ reading.",
+  "version": "3.0.5100",
+  "description": "The Dynamsoft Capture Vision React Native SDK provides a wrapper for building barcode scanning, document scanning and MRZ scanning applications with React Native.",
   "homepage": "https://github.com/Dynamsoft/capture-vision-react-native-samples",
   "main": "src/index.tsx",
   "files": [
@@ -37,7 +37,7 @@
     "url": "https://www.dynamsoft.com",
     "email": "support@dynamsoft.com"
   },
-  "license": "MIT",
+  "license": "Apache-2.0",
   "licenseFilename": "LICENSE",
   "readmeFilename": "README.md",
   "peerDependencies": {
@@ -58,13 +58,5 @@
     "react-native": "0.75.2",
     "typedoc": "^0.27.7",
     "typescript": "5.2.2"
-  },
-  "codegenConfig": {
-    "name": "DynamsoftSpecs",
-    "type": "all",
-    "jsSrcsDir": "src",
-    "android": {
-      "javaPackageName": "com.dynamsoft.reactnativelib"
-    }
   }
 }

package/src/core/CapturedResultBase.tsx

@@ -0,0 +1,18 @@
+import {IntermediateResultManager} from "../cvr";
+
+export interface CapturedResultBase {
+  /**
+   * The hash ID of the original image.
+   * @see {@link IntermediateResultManager.getOriginalImage}
+   * */
+  originalImageHashId: string;
+
+  /**Error code associated with the capture result.*/
+  errorCode: number;
+
+  /**Error string providing details about the error.*/
+  errorMessage: string;
+
+  /**the rotation transformation matrix of the original image relative to the rotated image.*/
+  rotationTransformMatrix: Array<number>;
+}

package/src/core/EnumCaptureResultItemType.tsx

@@ -1,9 +1,9 @@
 import type {BarcodeResultItem} from "../dbr";
 import type {TextLineResultItem} from "../dlr";
-import type {DetectedQuadResultItem, NormalizedImageResultItem} from "../ddn";
+import type {DetectedQuadResultItem, EnhancedImageResultItem, DeskewedImageResultItem} from "../ddn";
 import type {ParsedResultItem} from "../dcp";
 
-/**{@link BarcodeResultItem} {@link TextLineResultItem} {@link DetectedQuadResultItem} {@link NormalizedImageResultItem} {@link ParsedResultItem}* */
+/**{@link BarcodeResultItem} {@link TextLineResultItem} {@link DetectedQuadResultItem} {@link DeskewedImageResultItem} {@link ParsedResultItem}  {@link EnhancedImageResultItem}* */
 
 /**
  * Defines the various categories of items that can be recognized and captured.
@@ -33,14 +33,20 @@ export enum EnumCapturedResultItemType {
   CRIT_DETECTED_QUAD = 0x8,
 
   /**
-   * The type of the CapturedResultItem is "normalized image".
-   * @see {@link NormalizedImageResultItem}
+   * The type of the CapturedResultItem is "deskewed image".
+   * @see {@link DeskewedImageResultItem}
    * */
-  CRIT_NORMALIZED_IMAGE = 0x10,
+  CRIT_DESKEWED_IMAGE = 0x10,
 
   /**
    * The type of the CapturedResultItem is "parsed result".
    * @see {@link ParsedResultItem}
    * */
-  CRIT_PARSED_RESULT = 0x20
+  CRIT_PARSED_RESULT = 0x20,
+
+  /**
+   * The type of the CapturedResultItem is "enhanced image".
+   * @see {@link EnhancedImageResultItem}
+   * */
+  CRIT_ENHANCED_IMAGE = 0x40,
 }

package/src/core/EnumCrossVerificationStatus.tsx

@@ -1,4 +1,4 @@
-import type {DetectedQuadResultItem, NormalizedImageResultItem} from "../ddn";
+import {type DetectedQuadResultItem, type DeskewedImageResultItem} from "../ddn";
 import {CaptureVisionRouter} from "../cvr";
 import {MultiFrameResultCrossFilter} from "../utility";
 /**
@@ -12,11 +12,11 @@ import {MultiFrameResultCrossFilter} from "../utility";
  * router.addFilter(filter)
  *
  * router.addResultReceiver({
- *    onDetectedQuadsReceived: result => {
- *        if(result.items && result.items.length > 0) {
+ *    onProcessedDocumentResultReceived: result => {
+ *        if(result.detectedQuadResultItems && result.detectedQuadResultItems.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
+ *            let crossVerificationStatus = result.detectedQuadResultItems[0].crossVerificationStatus
  *        }
  *    },
  * })
@@ -28,11 +28,11 @@ import {MultiFrameResultCrossFilter} from "../utility";
  * 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.
+ * Currently, only {@link DetectedQuadResultItem} and {@link DeskewedImageResultItem} have the crossVerificationStatus property.
  *
  * @see {@link MultiFrameResultCrossFilter.enableResultCrossVerification}
  * @see {@link DetectedQuadResultItem.crossVerificationStatus}
- * @see {@link NormalizedImageResultItem.crossVerificationStatus}
+ * @see {@link DeskewedImageResultItem.crossVerificationStatus}
  * */
 export enum EnumCrossVerificationStatus {
   /** The cross verification has not been performed yet. */

package/src/core/ImageData.tsx

@@ -20,7 +20,7 @@ declare global {
  * */
 export interface ImageData {
   /**
-   * The raw bytes of the image, of type {@link ArrayBuffer}.
+   * The raw bytes of the image, of type {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ArrayBuffer}.
    * */
   buffer: ArrayBuffer;
 

package/src/core/index.tsx

@@ -1,4 +1,5 @@
 // main index.tsx
+export * from "./CapturedResultBase"
 export * from "./CapturedResultItem"
 export * from "./CoreModule"
 export * from "./DSRect"

package/src/cvr/CaptureVisionRouter.tsx

@@ -3,7 +3,7 @@ import {EnumCapturedResultItemType, type ImageData, ImageSourceAdapter} from "..
 import type {CapturedResultReceiver} from "./CapturedResultReceiver";
 import {type CapturedResult, _populateResults} from "./CapturedResult";
 import type {BarcodeResultItem, DecodedBarcodesResult} from "../dbr";
-import type {DetectedQuadsResult, NormalizedImagesResult} from "../ddn";
+import type {ProcessedDocumentResult} from "../ddn";
 import type {RecognizedTextLinesResult} from "../dlr";
 import type {ParsedResult} from "../dcp";
 import type {CapturedResultFilter} from "./CapturedResultFilter";
@@ -76,7 +76,7 @@ export class CaptureVisionRouter {
    *  @throws Error - If the capturing process fails to start, the promise will be rejected with an error.
    *  The error may occur due to invalid template names, or a capturing process is already in progress, etc.
    *
-   * @Important - Always make sure there is no capturing in process or just call `await CaptureVisionRouter.stopCapturing()` to stop any ongoing capturing process
+   * @remarks - Always make sure there is no capturing in process or just call `await CaptureVisionRouter.stopCapturing()` to stop any ongoing capturing process
    * before calling `startCapturing`.
    *
    * @see {@link EnumPresetTemplate}
@@ -121,9 +121,8 @@ export class CaptureVisionRouter {
 
   private receiverMap = new Map<string, CapturedResultReceiver>();
   private onCapturedResultReceived?: EmitterSubscription;
-  private onDetectedQuadsReceived?: EmitterSubscription;
+  private onProcessedDocumentResultReceived?: EmitterSubscription;
   private onDecodedBarcodesReceived?: EmitterSubscription;
-  private onNormalizedImagesReceived?: EmitterSubscription;
   private onRecognizedTextLinesReceived?: EmitterSubscription;
   private onParsedResultsReceived?: EmitterSubscription;
 
@@ -157,11 +156,19 @@ export class CaptureVisionRouter {
       this.onCapturedResultReceived = CVREventEmitter.addListener('onCapturedResultReceived',
         async (result: CapturedResult) => {
           _populateResults(result)
-          if (result.normalizedImagesResult && result.normalizedImagesResult.items?.length) {
+          let processingDocumentResult = result.processingDocumentResult;
+          if (processingDocumentResult && processingDocumentResult.deskewedImageResultItems && processingDocumentResult.deskewedImageResultItems.length > 0) {
             installMethods();
-            let imageArr: ImageData[] = global.getCurrentNormalizedImages();
-            for (let i = 0; i < result.normalizedImagesResult.items.length; i++) {
-              result.normalizedImagesResult.items[i]!!.imageData = imageArr[i]!!;
+            let imageArr: ImageData[] = global.getCurrentDeskewedImages();
+            for (let i = 0; i < processingDocumentResult.deskewedImageResultItems.length; i++) {
+              processingDocumentResult.deskewedImageResultItems[i]!!.imageData = imageArr[i]!!;
+            }
+          }
+          if(processingDocumentResult && processingDocumentResult.enhancedImageResultItems && processingDocumentResult.enhancedImageResultItems.length > 0) {
+            installMethods();
+            let imageArr: ImageData[] = global.getCurrentEnhancedImages();
+            for (let i = 0; i < processingDocumentResult.enhancedImageResultItems.length; i++) {
+              processingDocumentResult.enhancedImageResultItems[i]!!.imageData = imageArr[i]!!;
             }
           }
           for (let _receiver of this.receiverMap.values()) {
@@ -203,34 +210,28 @@ export class CaptureVisionRouter {
       )
     }
 
-    if (!this.onDetectedQuadsReceived && receiver.onDetectedQuadsReceived) {
+    if (!this.onProcessedDocumentResultReceived && receiver.onProcessedDocumentResultReceived) {
       if (Platform.OS == 'ios') {
-        CvrModule.addResultReceiver('onDetectedQuadsReceived')
+        CvrModule.addResultReceiver('onProcessedDocumentResultReceived')
       }
-      this.onDetectedQuadsReceived = CVREventEmitter.addListener('onDetectedQuadsReceived',
-        async (result: DetectedQuadsResult) => {
-          for (let _receiver of this.receiverMap.values()) {
-            await _receiver.onDetectedQuadsReceived?.(result);
+      this.onProcessedDocumentResultReceived = CVREventEmitter.addListener('onProcessedDocumentResultReceived',
+        async (result: ProcessedDocumentResult) => {
+          if (result && result.deskewedImageResultItems && result.deskewedImageResultItems.length > 0) {
+            installMethods();
+            let imageArr: ImageData[] = global.getCurrentDeskewedImages();
+            for (let i = 0; i < result.deskewedImageResultItems.length; i++) {
+              result.deskewedImageResultItems[i]!!.imageData = imageArr[i]!!;
+            }
           }
-          CvrModule.continueCRR()
-        }
-      )
-    }
-    if (!this.onNormalizedImagesReceived && receiver.onNormalizedImagesReceived) {
-      if (Platform.OS == 'ios') {
-        CvrModule.addResultReceiver('onNormalizedImagesReceived')
-      }
-      this.onNormalizedImagesReceived = CVREventEmitter.addListener('onNormalizedImagesReceived',
-        async (result: NormalizedImagesResult) => {
-          if (result && result.items && result.items.length > 0) {
+          if (result && result.enhancedImageResultItems && result.enhancedImageResultItems.length > 0) {
             installMethods();
-            let imageArr: ImageData[] = global.getCurrentNormalizedImages();
-            for (let i = 0; i < result.items.length; i++) {
-              result.items[i]!!.imageData = imageArr[i]!!;
+            let imageArr: ImageData[] = global.getCurrentEnhancedImages();
+            for (let i = 0; i < result.enhancedImageResultItems.length; i++) {
+              result.enhancedImageResultItems[i]!!.imageData = imageArr[i]!!;
             }
           }
           for (let _receiver of this.receiverMap.values()) {
-            await _receiver.onNormalizedImagesReceived?.(result);
+            await _receiver.onProcessedDocumentResultReceived?.(result);
           }
           CvrModule.continueCRR()
         }
@@ -279,8 +280,7 @@ export class CaptureVisionRouter {
       if (_receiver.onCapturedResultReceived) needToKeep_onCapturedResultReceived = true;
       needToKeepTypes |= _receiver.onDecodedBarcodesReceived ? EnumCapturedResultItemType.CRIT_BARCODE : 0;
       needToKeepTypes |= _receiver.onRecognizedTextLinesReceived ? EnumCapturedResultItemType.CRIT_TEXT_LINE : 0;
-      needToKeepTypes |= _receiver.onDetectedQuadsReceived ? EnumCapturedResultItemType.CRIT_DETECTED_QUAD : 0;
-      needToKeepTypes |= _receiver.onNormalizedImagesReceived ? EnumCapturedResultItemType.CRIT_NORMALIZED_IMAGE : 0;
+      needToKeepTypes |= _receiver.onProcessedDocumentResultReceived ? (EnumCapturedResultItemType.CRIT_DETECTED_QUAD | EnumCapturedResultItemType.CRIT_DESKEWED_IMAGE | EnumCapturedResultItemType.CRIT_ENHANCED_IMAGE) : 0;
       needToKeepTypes |= _receiver.onParsedResultsReceived ? EnumCapturedResultItemType.CRIT_PARSED_RESULT : 0;
     }
     if (!needToKeep_onCapturedResultReceived) {
@@ -298,15 +298,10 @@ export class CaptureVisionRouter {
       CvrModule.removeResultReceiver('onRecognizedTextLinesReceived')
       CVREventEmitter.removeAllListeners('onRecognizedTextLinesReceived')
     }
-    if ((needToKeepTypes & EnumCapturedResultItemType.CRIT_DETECTED_QUAD) == 0) {
-      this.onDetectedQuadsReceived = this.onDetectedQuadsReceived?.remove() || undefined
-      CvrModule.removeResultReceiver('onDetectedQuadsReceived')
-      CVREventEmitter.removeAllListeners('onDetectedQuadsReceived')
-    }
-    if ((needToKeepTypes & EnumCapturedResultItemType.CRIT_NORMALIZED_IMAGE) == 0) {
-      this.onNormalizedImagesReceived = this.onNormalizedImagesReceived?.remove() || undefined
-      CvrModule.removeResultReceiver('onNormalizedImagesReceived')
-      CVREventEmitter.removeAllListeners('onNormalizedImagesReceived')
+    if ((needToKeepTypes & (EnumCapturedResultItemType.CRIT_DETECTED_QUAD | EnumCapturedResultItemType.CRIT_DESKEWED_IMAGE | EnumCapturedResultItemType.CRIT_ENHANCED_IMAGE)) == 0) {
+      this.onProcessedDocumentResultReceived = this.onProcessedDocumentResultReceived?.remove() || undefined
+      CvrModule.removeResultReceiver('onProcessedDocumentResultReceived')
+      CVREventEmitter.removeAllListeners('onProcessedDocumentResultReceived')
     }
     if ((needToKeepTypes & EnumCapturedResultItemType.CRIT_PARSED_RESULT) == 0) {
       this.onParsedResultsReceived = this.onParsedResultsReceived?.remove() || undefined
@@ -323,8 +318,7 @@ export class CaptureVisionRouter {
     this.receiverMap.clear()
     this.onCapturedResultReceived?.remove()
     this.onDecodedBarcodesReceived?.remove()
-    this.onDetectedQuadsReceived?.remove()
-    this.onNormalizedImagesReceived?.remove()
+    this.onProcessedDocumentResultReceived?.remove()
     this.onRecognizedTextLinesReceived?.remove()
     this.onParsedResultsReceived?.remove()
   }
@@ -336,7 +330,7 @@ export class CaptureVisionRouter {
    * Code snippet:
    * ```
    * let router = await CaptureVisionRouter.getInstance();
-   * let receiver = router.addFilter(new MultiFrameResultCrossFilter());
+   * let filter = router.addFilter(new MultiFrameResultCrossFilter());
    * //...
    * router.removeFilter(filter);
    * ```
@@ -403,7 +397,7 @@ export class CaptureVisionRouter {
    *    maxParallelTasks: 1,
    *    barcodeSettings: {
    *      expectedBarcodesCount: 999,
-   *      barcodeFormatIds: EnumBarcodeFormats.BF_ONED | EnumBarcodeFormats.BF_QR_CODE,
+   *      barcodeFormatIds: EnumBarcodeFormat.BF_ONED | EnumBarcodeFormat.BF_QR_CODE,
    *    }
    * };
    * //Only timeout, maxParallelTasks, expectedBarcodesCount and barcodeFormatIds will be updated.
@@ -463,20 +457,22 @@ export class CaptureVisionRouter {
    * Get a JSON string that contains settings for the specified templateName.
    *
    * @param templateName - The name of the template that you want to output.
+   * @param includeDefaultValues - Whether to include default values in the output.
    * @return {Promise<string>} - A promise that resolves a JSON string that contains settings for the specified templateName.
    * */
-  outputSettings(templateName: string): Promise<string> {
-    return CvrModule.outputSettings(templateName)
+  outputSettings(templateName: string, includeDefaultValues:boolean): Promise<string> {
+    return CvrModule.outputSettings(templateName, includeDefaultValues)
   }
 
   /**
    * Generates a JSON file download containing the settings for the specified templateName and saved to specified file path.
    * @param templateName - The name of the template that you want to output.
    * @param file - The absolute file path that you want to save the template.
+   * @param includeDefaultValues - Whether to include default values in the output.
    * @return {Promise<void>} - A promise that resolves or rejected with an error when the operation has completed.
    * */
-  outputSettingsToFile(templateName: string, file: string): Promise<void> {
-    return CvrModule.outputSettingsToFile(templateName, file)
+  outputSettingsToFile(templateName: string, file: string, includeDefaultValues:boolean): Promise<void> {
+    return CvrModule.outputSettingsToFile(templateName, file, includeDefaultValues)
   }
 
   /**
@@ -612,8 +608,7 @@ export class IntermediateResultManager {
    * ```
    *
    * @param imageHashId - The image hash ID. Get from {@link CapturedResult.originalImageHashId}, {@link DecodedBarcodesResult.originalImageHashId},
-   *    {@link DetectedQuadsResult.originalImageHashId}, {@link NormalizedImagesResult.originalImageHashId},
-   *    {@link RecognizedTextLinesResult.originalImageHashId}.
+   *    {@link ProcessedDocumentResult.originalImageHashId}, {@link RecognizedTextLinesResult.originalImageHashId}.
    *
    * @remarks `Do not call this method outside the CapturedResultReceiver callback where you get the hashId, otherwise you will not get any valid ImageData.`
    * @see {@link CaptureVisionRouter.addResultReceiver}
@@ -629,6 +624,7 @@ declare var global: {
   captureImageData: (imageData: ImageData, template: string) => CapturedResult | undefined | null;
   captureFile: (file: string, template: string) => CapturedResult | undefined | null;
   captureFileBytes: (fileBytes: ArrayBuffer, template: string) => CapturedResult | undefined | null;
-  getCurrentNormalizedImages: () => ImageData[];
+  getCurrentDeskewedImages: () => ImageData[];
+  getCurrentEnhancedImages: () => ImageData[];
   cvr_getOriginalImage: (imageHashId: string) => ImageData;
 }

package/src/cvr/CapturedResult.tsx

@@ -4,10 +4,11 @@ import type {ParsedResult, ParsedResultItem} from "../dcp";
 import type {RecognizedTextLinesResult, TextLineResultItem} from "../dlr";
 import type {
   DetectedQuadResultItem,
-  DetectedQuadsResult,
-  NormalizedImageResultItem,
-  NormalizedImagesResult
+  DeskewedImageResultItem,
+  EnhancedImageResultItem,
+  ProcessedDocumentResult
 } from "../ddn";
+import type {CapturedResultBase} from "../core/CapturedResultBase";
 
 /**
  * The CapturedResult interface describes the basic structure of a result object returned by Dynamsoft Capture Vision Router({@link CaptureVisionRouter}).
@@ -15,43 +16,26 @@ import type {
  * @remarks Depending on the functional module that generated the result item, the interface may vary:
  * - dynamsoft-barcode-reader: {@link DecodedBarcodesResult}
  * - dynamsoft-label-recognizer: {@link RecognizedTextLinesResult}
- * - dynamsoft-document-normalizer: {@link DetectedQuadsResult} or {@link NormalizedImagesResult}
+ * - dynamsoft-document-normalizer: {@link ProcessedDocumentResult}
  * - dynamsoft-code-parser: {@link ParsedResult}
  *
  * @see {@link CapturedResultReceiver.onCapturedResultReceived}
+ * @see {@link CapturedResultBase}
  * */
-export interface CapturedResult {
-  /**
-   * The hash ID of the original image.
-   * @see {@link IntermediateResultManager.getOriginalImage}
-   * */
-  originalImageHashId: string;
-
+export interface CapturedResult extends CapturedResultBase{
   /**
    * An array of CapturedResultItem objects representing the captured result items.
    * */
   items?: Array<CapturedResultItem>;
 
-  /**Error code associated with the capture result.*/
-  errorCode: number;
-
-  /**Error string providing details about the error.*/
-  errorMessage: string;
-
-  /**the rotation transformation matrix of the original image relative to the rotated image.*/
-  rotationTransformMatrix: Array<number>;
-
   /**Get a {@link DecodedBarcodesResult} object that contains all the {@link BarcodeResultItem} in this CapturedResult.*/
   decodedBarcodesResult?: DecodedBarcodesResult;
 
   /**Get a {@link RecognizedTextLinesResult} object that contains all the {@link TextLineResultItem} in this CapturedResult.*/
   recognizedTextLinesResult?: RecognizedTextLinesResult;
 
-  /**Get a {@link DetectedQuadsResult} object that contains all the {@link DetectedQuadResultItem} in this CapturedResult.*/
-  detectedQuadsResult?: DetectedQuadsResult;
-
-  /**Get a {@link NormalizedImagesResult} object that contains all the {@link NormalizedImageResultItem} in this CapturedResult.*/
-  normalizedImagesResult?: NormalizedImagesResult;
+  /**Get a {@link ProcessedDocumentResult} object that contains all the {@link EnhancedImageResultItem} ,{@link DeskewedImageResultItem} and {@link DetectedQuadResultItem} in this CapturedResult.*/
+  processingDocumentResult?: ProcessedDocumentResult;
 
   /**Get a {@link ParsedResult} object that contains all the {@link ParsedResultItem} in this CapturedResult.*/
   parsedResult?: ParsedResult;
@@ -62,8 +46,7 @@ export function _populateResults(result: CapturedResult | null | undefined) {
   if (result) {
     result.decodedBarcodesResult = getDecodedBarcodesResult(result)
     result.recognizedTextLinesResult = getRecognizedTextLinesResult(result)
-    result.detectedQuadsResult = getDetectedQuadsResult(result)
-    result.normalizedImagesResult = getNormalizedImagesResult(result)
+    result.processingDocumentResult = getProcessingDocumentResult(result)
     result.parsedResult = getParsedResult(result)
   }
 }
@@ -90,7 +73,7 @@ function getRecognizedTextLinesResult(result: CapturedResult): RecognizedTextLin
   return {
     originalImageHashId: result.originalImageHashId,
     errorCode: result.errorCode,
-    errorString: result.errorMessage,
+    errorMessage: result.errorMessage,
     rotationTransformMatrix: result.rotationTransformMatrix,
     items: result.items?.filter(item => {
       return item.type == EnumCapturedResultItemType.CRIT_TEXT_LINE
@@ -101,33 +84,28 @@ function getRecognizedTextLinesResult(result: CapturedResult): RecognizedTextLin
 }
 
 /**@internal*/
-function getDetectedQuadsResult(result: CapturedResult): DetectedQuadsResult {
+function getProcessingDocumentResult(result: CapturedResult): ProcessedDocumentResult {
   return {
     originalImageHashId: result.originalImageHashId,
     errorCode: result.errorCode,
-    errorString: result.errorMessage,
+    errorMessage: result.errorMessage,
     rotationTransformMatrix: result.rotationTransformMatrix,
-    items: result.items?.filter(item => {
+    deskewedImageResultItems: result.items?.filter(item => {
+      return item.type == EnumCapturedResultItemType.CRIT_DESKEWED_IMAGE
+    }).map(item => {
+      return item as DeskewedImageResultItem
+    }),
+    detectedQuadResultItems: result.items?.filter(item => {
       return item.type == EnumCapturedResultItemType.CRIT_DETECTED_QUAD
     }).map(item => {
       return item as DetectedQuadResultItem
-    })
-  } as DetectedQuadsResult;
-}
-
-/**@internal*/
-function getNormalizedImagesResult(result: CapturedResult): NormalizedImagesResult {
-  return {
-    originalImageHashId: result.originalImageHashId,
-    errorCode: result.errorCode,
-    errorString: result.errorMessage,
-    rotationTransformMatrix: result.rotationTransformMatrix,
-    items: result.items?.filter(item => {
-      return item.type == EnumCapturedResultItemType.CRIT_NORMALIZED_IMAGE
+    }),
+    enhancedImageResultItems: result.items?.filter(item => {
+      return item.type == EnumCapturedResultItemType.CRIT_ENHANCED_IMAGE
     }).map(item => {
-      return item as NormalizedImageResultItem
+      return item as EnhancedImageResultItem
     })
-  } as NormalizedImagesResult;
+  } as ProcessedDocumentResult;
 }
 
 /**@internal*/