dwt 19.0.0 → 19.1.0

package/dist/types/Addon.BarcodeReader.d.ts

@@ -42,7 +42,7 @@ export interface TextResult {
      */
     barcodeFormat: DynamsoftEnumsDBR.EnumBarcodeFormat | number; 
     /**
-     * Extra barcde formats.
+     * Extra barcode formats.
      */
     barcodeFormat_2: DynamsoftEnumsDBR.EnumBarcodeFormat_2 | number;
     /**

package/dist/types/Addon.Webcam.d.ts

@@ -70,7 +70,7 @@ export interface Webcam {
      * Set the specified camera property.
      * @param property Specify the property.
      * @param value Specify the value.
-     * @param auto Specify whether the propery should change automatically.
+     * @param auto Specify whether the property should change automatically.
      */
     SetCameraControlPropertySetting(
         property: DynamsoftEnumsDWT.EnumDWT_CameraControlProperty | number,
@@ -95,7 +95,7 @@ export interface Webcam {
      * Set the specified video property.
      * @param property Specify the property.
      * @param value Specify the value.
-     * @param auto Specify whether the propery should change automatically.
+     * @param auto Specify whether the property should change automatically.
      */
     SetVideoPropertySetting(
         property: DynamsoftEnumsDWT.EnumDWT_VideoProperty | number,
@@ -197,7 +197,7 @@ export interface VideoControlProperty {
      */
     GetValue(): number;
     /**
-     * Return whether the property is set autmatically or not.
+     * Return whether the property is set automatically or not.
      */
     GetIfAuto(): boolean;
 }
@@ -219,7 +219,7 @@ export interface VideoControlPropertyExtra {
      */
     GetSteppingDelta(): number;
     /**
-     * Return whether the property is set autmatically or not.
+     * Return whether the property is set automatically or not.
      */
     GetIfAuto(): boolean;
 }
@@ -229,7 +229,7 @@ export interface CameraControlProperty {
      */
     GetValue(): number;
     /**
-     * Return whether the property is set autmatically or not.
+     * Return whether the property is set automatically or not.
      */
     GetIfAuto(): boolean;
 }
@@ -251,7 +251,7 @@ export interface CameraControlPropertyExtra {
      */
     GetSteppingDelta(): number;
     /**
-     * Return whether the property is set autmatically or not.
+     * Return whether the property is set automatically or not.
      */
     GetIfAuto(): boolean;
 }

package/dist/types/Dynamsoft.d.ts

@@ -276,12 +276,12 @@ export interface DWTPro {
      */
     DeleteDWTObject(Id: string): boolean;
     /**
-     * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returnd.
+     * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returned.
      * @param ContainerIdOrWebTwainId The ContainerId or WebTwainId.
      */
     GetWebTwain(ContainerIdOrWebTwainId?: string): WebTwain;
     /**
-     * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returnd.
+     * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returned.
      * @param ContainerIdOrWebTwainId The ContainerId or WebTwainId.
      */
     GetWebTwainEx(ContainerIdOrWebTwainId?: string): WebTwain;

package/dist/types/WebTwain.Acquire.d.ts

@@ -689,11 +689,11 @@ export interface DeviceConfiguration {
      */
     IfDuplexEnabled?: boolean;
     /**
-     * Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true.
+     * Whether to close the built-in User Interface after acquisition. Only valid when {IfShowUI} is true.
      */
     IfDisableSourceAfterAcquire?: boolean;
     /**
-     * Whether to close source after aquisition.
+     * Whether to close source after acquisition.
      */
 	IfCloseSourceAfterAcquire?:boolean;
     /**
@@ -771,7 +771,7 @@ export interface ScanSetup {
      */
     setupId?: string;
     /**
-     * Whether to ignore or fail the acquistion when an exception is raised. Set "ignore" or "fail".
+     * Whether to ignore or fail the acquisition when an exception is raised. Set "ignore" or "fail".
      */
     exception?: string;
     /**

package/dist/types/WebTwain.Edit.d.ts

@@ -28,7 +28,7 @@ export interface WebTwainEdit extends WebTwainBuffer {
      * @param index Specify the image.
      * @param value Specify the value of contrast.
      */
-	ChangeContrastAsnyc(
+    ChangeContrastAsnyc(
         index: number,
         value: number
     ): Promise<boolean>;
@@ -165,14 +165,14 @@ export interface WebTwainEdit extends WebTwainBuffer {
         ) => void
     ): void;
     /**
-     * Invert the colour of the pixels on the specified image.
+     * Invert the color of the pixels on the specified image.
      * @param index Specify the image.
      */
     Invert(
         index: number
     ): boolean;
 	/**
-     * Invert the colour of the pixels on the specified image.
+     * Invert the color of the pixels on the specified image.
      * @param index Specify the image.
      * @param successCallback A callback function that is executed if the request succeeds.
      * @param failureCallback A callback function that is executed if the request fails.
@@ -499,7 +499,7 @@ export interface WebTwainEdit extends WebTwainBuffer {
         bottom: number
     ): boolean;
     /**
-     * Return or set the fill colour for the empty area on an image that has been cut/cropped/erased.
+     * Return or set the fill color for the empty area on an image that has been cut/cropped/erased.
      */
     BackgroundFillColor: number;
     /**

package/dist/types/WebTwain.IO.d.ts

@@ -499,7 +499,7 @@ export interface WebTwainIO extends WebTwainUtil {
      * Upload the specified image via a HTTP Post request.
      * @param host The HTTP Host.
      * @param index Specify the image.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param type The format of the file.
      * @param fileName The file name.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
@@ -523,7 +523,7 @@ export interface WebTwainIO extends WebTwainUtil {
      * Upload the specified image via a HTTP Post request.
      * @param host The HTTP Host.
      * @param index Specify the image.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param fileName The file name.
      * @param type The format of the file.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
@@ -547,7 +547,7 @@ export interface WebTwainIO extends WebTwainUtil {
     /**
      * Upload all images in the buffer as a TIFF file via a HTTP Post request.
      * @param host The HTTP Host.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param fileName The file name.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
      * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -568,7 +568,7 @@ export interface WebTwainIO extends WebTwainUtil {
     /**
      * Upload all images in the buffer as a PDF file via a HTTP Post request.
      * @param host The HTTP Host.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param fileName The file name.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
      * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -589,7 +589,7 @@ export interface WebTwainIO extends WebTwainUtil {
     /**
      * Upload all selected images in the buffer as a PDF file via a HTTP Post request.
      * @param host The HTTP Host.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param fileName The file name.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
      * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -610,7 +610,7 @@ export interface WebTwainIO extends WebTwainUtil {
     /**
      * Upload all selected images in the buffer as a TIFF file via a HTTP Post request.
      * @param host The HTTP Host.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param fileName The file name.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
      * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -632,7 +632,7 @@ export interface WebTwainIO extends WebTwainUtil {
      * Upload the specified file via a HTTP Post request.
      * @param host The HTTP Host.
      * @param path Specify the file to upload.
-     * @param target The target wherethe request is sent.
+     * @param target The target where the request is sent.
      * @param fileName The file name.
      * @param onEmptyResponse A callback function that is executed if the response is empty.
      * @param onServerReturnedSomething A callback function that is executed if the response is not empty.

package/dist/types/WebTwain.Util.d.ts

@@ -35,7 +35,7 @@ export interface WebTwainUtil {
      */
     readonly ProductName: string;
     /**
-     * Generate a URL to be used by a FileUpoader instance to fetch the data to upload.
+     * Generate a URL to be used by a FileUploader instance to fetch the data to upload.
      * @param indices Specify the images to upload.
      * @param type Specify the file type.
      * @param successCallback A callback function that is executed if the request succeeds.

package/dist/types/WebTwain.Viewer.d.ts

@@ -17,12 +17,12 @@ export interface WebTwainViewer extends WebTwainAcquire {
     UnbindViewer(): boolean;
     /**
 	 * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.background` instead.
-     * Return or set the background colour of the viewer.
+     * Return or set the background color of the viewer.
      */
     BackgroundColor: number;
     /**
 	 * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.selectedPageBorder` instead.
-     * Return or set the border colour for selected image(s).
+     * Return or set the border color for selected image(s).
      */
     SelectionImageBorderColor: number;
     /**
@@ -32,7 +32,7 @@ export interface WebTwainViewer extends WebTwainAcquire {
     FitWindowType: number;
     /**
 	 * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.fitWindow` instead.
-     * Return or set the border colour for selected image(s).
+     * Return or set the border color for selected image(s).
      */
     IfFitWindow: boolean;
     /**
@@ -101,7 +101,7 @@ export interface DynamsoftViewer {
     readonly idPostfix: string;
     /**
      * [Scope] Main viewer
-     * [Description] Return or set the background colour/image of the viewer.
+     * [Description] Return or set the background color/image of the viewer.
      * [Usage Notes] 'Invalid property value' is reported when the set value does not meet the CSS standard.
      * Replace the previous `BackgroundColor` method.
      * Allow any CSS rules
@@ -357,6 +357,10 @@ export interface DynamsoftViewer {
         columns: number,
         rows: number
     ): boolean;	
+    /**
+     * Return the info of visible pages. It is useful to add elements to document page images in the viewer.
+     */
+    getVisiblePagesInfo(): VisiblePageInfo[];
     /**
      * [Scope] Global
      * [Description] Create a Dynamsoft Viewer instance and bind it to the WebTwain instance.
@@ -561,7 +565,7 @@ export interface ThumbnailViewerSettings {
     autoChangeIndex?: boolean;
     /**
      * [Scope] Thumbnail viewer
-     * [Description] Return or set the background colour/image of the thumbnail viewer. The default value is white.
+     * [Description] Return or set the background color/image of the thumbnail viewer. The default value is white.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
      * Allow any CSS rules
      */
@@ -660,7 +664,7 @@ export interface ImageEditor {
 	};	
 	/**
      * [Scope] ImageEditor viewer
-     * Set the selction box styling.
+     * Set the selection box styling.
      * @argument selectionBoxStyleSettings Settings for selection box.
      */
 	updateSelectionBoxStyle(selectionBoxStyleSettings?: SelectionBoxStyleSettings): boolean;
@@ -698,6 +702,10 @@ export interface ThumbnailViewer {
 	 * @argument pageNumberSettings Settings for page numbers.
      */
 	updatePageNumberStyle(pageNumberSettings?: PageNumberSettings): void;
+    /**
+     * Return the info of visible pages. It is useful to add elements to document page images in the viewer.
+     */
+      getVisiblePagesInfo(): VisiblePageInfo[];
     /**
      * [Scope] Thumbnail viewer
      * [Description] Specify an event listener for the viewer event.
@@ -790,7 +798,7 @@ export interface ThumbnailViewer {
     autoChangeIndex: boolean;
     /**
      * [Scope] Thumbnail viewer
-     * [Description] Return or set the background colour/image of the thumbnail viewer. The default value is white.
+     * [Description] Return or set the background color/image of the thumbnail viewer. The default value is white.
      * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
      * Allow any CSS rules
      */
@@ -884,6 +892,48 @@ export interface ViewerEvent {
      */
     pageY: number;
 }
+/**
+* Info of a visible page.
+*/
+export interface VisiblePageInfo {
+    /**
+     * The index of the document page.
+     */
+    pageIndex: number;
+    /**
+     * Whether the mouse is hovering over the document page.
+     */
+    isHovered: boolean;
+    /**
+     * Whether the document page is selected.
+     */
+    isSelected: boolean;
+    /**
+     * The width of the document page image container.
+     */
+    pageWidth: number;
+    /**
+     * The height of the document page image container.
+     */
+    pageHeight: number;
+     /**
+     * The x coordinate relative to the canvas.
+     */
+    canvasOffsetX: number;
+    /**
+     * The y coordinate relative to the canvas.
+     */
+    canvasOffsetY: number;
+    /**
+     * The x coordinate relative to the container of the viewer.
+     */
+    containerOffsetX: number;
+    /**
+     * The y coordinate relative to the container of the viewer.
+     */
+    containerOffsetY: number;
+ }
+
 export interface ThumbnailViewerEvent {
     /**
      * The index of the current document page.
@@ -980,10 +1030,10 @@ export interface PageNumberSettings {
   translateY?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to itself
 }
 export interface SelectionBoxStyleSettings {
-  borderColor?: string;  //Default: rgba(0,0,0,1). Colour in "rgba(r, g, b, a)"
+  borderColor?: string;  //Default: rgba(0,0,0,1). Color in "rgba(r, g, b, a)"
   borderWidth?: number;  //Default: 1. Pixels. Width of individual pattern segments.
   lineDash?: [number,number];  //Default: [5,2]. Pixels. Line spacing where x is shaded pixels and y is gap in pixels.
   handleWidth?: number;  //Default: 9. Pixels.
   handleHeight?: number;   //Default: 9. Pixels
-  handleColor?: string;  //Default: rgba(0,0,0,1). Colour in "rgba(r, g, b, a)"
+  handleColor?: string;  //Default: rgba(0,0,0,1). Color in "rgba(r, g, b, a)"
 }

package/dwt-openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.1
 info:
   title: DWT
   description: ''
-  version: 1.0.0
+  version: '20250428'
 tags:
   - name: Server Control
   - name: Scanner Control
@@ -114,12 +114,12 @@ paths:
                   version:
                     type: string
                     description: server API version.
-                    examples:
+                    example:
                       - '20240719'
                   compatible:
                     type: boolean
                     description: server is compatible with the client.
-                    examples:
+                    example:
                       - true
           headers: {}
         '405':
@@ -151,7 +151,7 @@ paths:
           schema: &ref_2
             $ref: '#/components/schemas/ScannerType'
             description: one value of ScannerType
-            examples:
+            example:
               - 16
       responses:
         '200':
@@ -209,7 +209,7 @@ paths:
       tags:
         - Scanner Control
       parameters:
-        - name: X-DICS-LICENSE-KEY
+        - name: DWT-PRODUCT-KEY
           in: header
           description: Product key
           required: true
@@ -933,7 +933,7 @@ paths:
           example: ''
           schema:
             type: string
-        - name: X-DICS-DOC-PASSWORD
+        - name: DWT-DOC-PASSWORD
           in: header
           description: the password of document in storage
           required: false
@@ -1010,7 +1010,7 @@ paths:
           example: ''
           schema:
             type: string
-        - name: X-DICS-DOC-PASSWORD
+        - name: DWT-DOC-PASSWORD
           in: header
           description: the password of document in storage
           required: false
@@ -1252,7 +1252,7 @@ paths:
             externalDocs:
               url: >-
                 https://www.dynamsoft.com/web-twain/docs/info//api/interfaces.html#pdfwsettings
-        - name: X-DICS-DOC-PASSWORD
+        - name: DWT-DOC-PASSWORD
           in: header
           description: the password of document in storage
           required: false
@@ -1356,7 +1356,7 @@ paths:
           example: ''
           schema:
             type: string
-        - name: X-DICS-DOC-PASSWORD
+        - name: DWT-DOC-PASSWORD
           in: header
           description: the password of document in storage
           required: false
@@ -1382,7 +1382,7 @@ paths:
                 source:
                   oneOf:
                     - type: string
-                      examples:
+                      example:
                         - >-
                           https://127.0.0.1:18623/api/device/scanners/jobs/dd40716d-48d1-4d32-89f7-1d53f9665d91/next-page?page=19522d0c5282
                   description: >-
@@ -1465,7 +1465,7 @@ paths:
           example: ''
           schema:
             type: string
-        - name: X-DICS-DOC-PASSWORD
+        - name: DWT-DOC-PASSWORD
           in: header
           description: the password of document in storage
           required: false
@@ -1541,14 +1541,14 @@ paths:
               currently only process DWT urls, so we cannot pass index,
               only has one page. read-barcode can accept a barcode reader
               template settings. and need to pass extra license with header
-              X-DICS-LICENSE-KEY. check-blank can accept null or
+              DWT-PRODUCT-KEY. check-blank can accept null or
               {minBlockHeight?: number, maxBlockHeight?: number}. rotate can
               accept {rotation: number, keepSize?: boolean}.
               calculate-skew-angle can accept null.
             enum:
               - check-blank
               - read-barcode
-        - name: X-DICS-LICENSE-KEY
+        - name: DWT-PRODUCT-KEY
           in: header
           description: the license for image processing
           required: false
@@ -4129,7 +4129,7 @@ components:
             message:
               type: string
               description: system error string of the code.
-      examples:
+      example:
         - cause:
             code: 3
             message: The system cannot find the path specified.
@@ -4144,7 +4144,7 @@ components:
         url: >-
           https://www.dynamsoft.com/web-twain/docs/info/api/Interfaces.html#outputinfo
       properties: {}
-      examples:
+      example:
         - extendedImageInfo: {}
           imageId: 1
           imageInfo:
@@ -4194,7 +4194,7 @@ components:
           * 0x200 ESCLSCANNER
           * 0x400 WIFIDIRECTSCANNER
           * 0x800 WIATWAINSCANNER 
-      examples:
+      example:
         - 16
     Scanner:
       type: object
@@ -4204,13 +4204,13 @@ components:
         name:
           type: string
           description: Scanner name
-          examples:
+          example:
             - TWAIN2 FreeImage Software Scanner
         type: *ref_2
         device:
           type: string
           description: A json string of the scanner details.
-          examples:
+          example:
             - >-
               {"deviceInfo":{"Manufacturer":"VFdBSU4gV29ya2luZyBHcm91cA==","ProductFamily":"U29mdHdhcmUgU2Nhbg==","ProductName":"VFdBSU4yIEZyZWVJbWFnZSBTb2Z0d2FyZSBTY2FubmVy","ProtocolMajor":2,"ProtocolMinor":1,"SupportedGroups":0,"Version":{"Country":1,"Info":"Mi4xLjMgc2FtcGxlIHJlbGVhc2UgMzJiaXQ=","Language":2,"MajorNum":2,"MinorNum":1}},"deviceType":16,"isSystemDefaultPrinter":false,"name":"VFdBSU4yIEZyZWVJbWFnZSBTb2Z0d2FyZSBTY2FubmVy"}
       required:
@@ -4284,7 +4284,7 @@ components:
             to detect the feeder is loaded, if the driver is supported, it can
             work, otherwise it may be not right. (ICA not sure)
           default: false
-      examples:
+      example:
         - autoRun: false
           device: >-
             {"deviceInfo":{"Manufacturer":"VFdBSU4gV29ya2luZyBHcm91cA==","ProductFamily":"U29mdHdhcmUgU2Nhbg==","ProductName":"VFdBSU4yIEZyZWVJbWFnZSBTb2Z0d2FyZSBTY2FubmVy","ProtocolMajor":2,"ProtocolMinor":1,"SupportedGroups":0,"Version":{"Country":1,"Info":"Mi4xLjMgc2FtcGxlIHJlbGVhc2UgMzJiaXQ=","Language":2,"MajorNum":2,"MinorNum":1}},"deviceType":16,"isSystemDefaultPrinter":false,"name":"VFdBSU4yIEZyZWVJbWFnZSBTb2Z0d2FyZSBTY2FubmVy"}
@@ -4311,7 +4311,7 @@ components:
       properties:
         jobuid:
           type: string
-          examples:
+          example:
             - B3701DC5-86D3-44B6-A8A1-FF0B5D43FD86
         status:
           type: string
@@ -4339,7 +4339,7 @@ components:
       properties:
         uid:
           type: string
-          examples:
+          example:
             - 190817548d70
           description: page uid
       required:
@@ -4350,7 +4350,7 @@ components:
       properties:
         uid:
           type: string
-          examples:
+          example:
             - 190807444d76
           description: document uid
         pages:
@@ -4371,7 +4371,7 @@ components:
           type: integer
           format: int32
           description: 0 is disabled, 30 is verbos, 1 is debug + info + error.
-          examples:
+          example:
             - 1
     ServerSettings:
       type: object
@@ -4381,7 +4381,7 @@ components:
           type: integer
           format: int32
           description: 0 is disabled, 30 is verbos, 1 is debug + info + error
-          examples:
+          example:
             - 1
       required:
         - logLevel
@@ -4399,7 +4399,7 @@ components:
         settings:
           oneOf:
             - type: object
-              examples:
+              example:
                 - minBlockHeight: 20
                   maxBlockHeight: 30
                 - ImageParameter:
@@ -4449,7 +4449,7 @@ components:
           oneOf:
             - type: string
               description: DWT image url. If it's DWT image url, we should think cors.
-              examples:
+              example:
                 - >-
                   https://127.0.0.1:18623/api/device/scanners/jobs/dd40716d-48d1-4d32-89f7-1d53f9665d91/next-page?page=19522d0c5282
       required:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dwt",
-    "version": "19.0.0",
+    "version": "19.1.0",
     "author": {
         "name": "Dynamsoft",
         "url": "https://www.dynamsoft.com"