dwt 18.5.1 → 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.PDF.d.ts

@@ -32,6 +32,11 @@ export interface PDF {
      * @path Specify the path of the PDF file.
      */
     IsTextBasedPDF(path: string): boolean;
+    /**
+     * Detect whether the local PDF file requires rasterization to be read.
+     * @path Specify the path of the PDF file.
+     */
+    IsRasterizationRequired(path: string): boolean;
     /**
 	 * @deprecated since version 18.4. This function will be removed in future versions. Use `SetReaderOptions` instead.
      * Set the convert mode.
@@ -186,6 +191,9 @@ export interface ReaderOptions {
          * Whether or not to render in grayscale. Default value: false.
          */
 		renderGrayscale?: boolean; 
-    }
-	
+    }; 
+    /**
+     * Set whether to preserve the original size when saving an unedited PDF. Default value: false.
+     */
+    preserveUnmodifiedOnSave?: boolean;   
 }

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;
@@ -390,7 +390,7 @@ export interface DWTPro {
      * @param event Specify the event.
      * @param callback Specify the callback.
      */
-    RegisterEvent(event: string, callback: (...args: any[]) => void): boolean;
+    RegisterEvent(event: string, callback: (...args: any[]) => void): void;
     /**
      * Remove all authorizations for accessing local resources.
      */

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.Buffer.d.ts

@@ -210,7 +210,7 @@ export interface WebTwainBuffer extends WebTwainIO {
      * @param index Specify the image.
      */
 	IsBlankImageAsync(index: number, options?: {
-		minBlockHeight?: number,//default value: 10
+		minBlockHeight?: number,//default value: 20
 		maxBlockHeight?: number   //default value: 30
 	}): Promise < boolean > ;
     /**

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

@@ -9,6 +9,10 @@ export interface WebTwainUtil {
      * Return the error string.
      */
     readonly ErrorString: string;
+    /**
+     * The reason for returning the error is an extension of the ErrorString.
+     */
+    readonly ErrorCause: {code: number, message: string} | null;
     /**
      * Return or set the log level for debugging.
      */
@@ -31,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
@@ -232,6 +232,10 @@ export interface DynamsoftViewer {
 		x: string;  //Default is "center", values: "left", "right", "center".
 		y: string;  //Default is "center", values: "top", "bottom", "center"
 	} 
+    /**
+     * Whether the viewer removes the focus border after selecting with the Tab key.  Default value: true.
+     */
+    disableFocusOutline: boolean;  // default value: true
     /**
      * [Scope] Main viewer
      * [Description] Return the index of the next image of the currently selected image.
@@ -353,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.
@@ -557,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
      */
@@ -656,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;
@@ -694,13 +702,17 @@ 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.
      * @param name Specify the event name.
      * @param callback The event listener.
      */
-	on(eventName: string, callback: (...param: any[]) => void): void;
+    on(eventName: string, callback: (event: ThumbnailViewerEvent | KeyboardEvent, domEvent?: MouseEvent) => void): void;
     /**
      * [Scope] Thumbnail viewer
      * [Description] Remove the event handler.
@@ -786,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
      */
@@ -880,19 +892,98 @@ 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 image.
+     * The index of the current document page.
      */
     index: number;
     /**
-     * The x-coordinate relative to the browser page.
+     * The mouse's x coordinate in the thumbnail image container relative to the top-left of the web page.
      */
     pageX: number;
     /**
-     * The y-coordinate relative to the browser page.
+     * The  mouse's y coordinate in the thumbnail image container relative to the top-left of the web page.
      */
     pageY: number;
+    /**
+     * The width of the thumbnail image container.
+     */
+    imageX: number;
+    /**
+     * The height of the thumbnail image container.
+     */
+    imageY: number;
+    /**
+     * The corresponding x coordinate in the original image.
+     */
+    pageHeight: number;
+    /**
+     * The corresponding y coordinate in the original image.
+     */
+    pageWidth: number;
+    /**
+     * The thumbnail image container's relative position.
+     */
+    position: {
+        /**
+         * The x coordinate relative to the container of the viewer.
+         */
+        canvasOffsetX: number;
+        /**
+         * The y coordinate relative to the container of the viewer.
+         */
+        canvasOffsetY: number;
+        /**
+         * The x coordinate relative to the canvas.
+         */
+        containerOffsetX: number;
+        /**
+         * The y coordinate relative to the canvas.
+         */
+        containerOffsetY: number;
+    }
 }
 export interface Area {
 	left: number;
@@ -939,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/dist/types/index.d.ts

@@ -11,9 +11,9 @@
 * Product: Dynamsoft Web Twain
 * Web Site: http://www.dynamsoft.com
 *
-* Copyright 2022, Dynamsoft Corporation
+* Copyright 2025, Dynamsoft Corporation
 * Author: Dynamsoft Support Team
-* Version: 18.4.2
+* Version: 19.0
 */
 import Dynamsoft from "./Dynamsoft";
 export default Dynamsoft;