dwt 18.2.1 → 18.4.0

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

@@ -19,6 +19,7 @@ export interface PDF {
         ) => void
     ): void;
     /**
+	 * @deprecated since version 18.4. This function will be removed in future versions. Use `GetReaderOptions` instead.
      * Return the convert mode.
      */
     GetConvertMode(): number;
@@ -32,16 +33,19 @@ export interface PDF {
      */
     IsTextBasedPDF(path: string): boolean;
     /**
+	 * @deprecated since version 18.4. This function will be removed in future versions. Use `SetReaderOptions` instead.
      * Set the convert mode.
      * @param mode Specify the mode.
      */
     SetConvertMode(mode: DynamsoftEnumsDWT.EnumDWT_ConvertMode | number): boolean;
     /**
+	 * @deprecated since version 18.4. This function will be removed in future versions. Use `SetReaderOptions` instead.
      * Set the password for reading encrypted PDF files.
      * @param password Specify the password.
      */
     SetPassword(password: string): boolean;
     /**
+	 * @deprecated since version 18.4. This function will be removed in future versions. Use `SetReaderOptions` instead.
      * Set the resolution for rasterizing.
      * @param resolution Specify the resolution.
      */
@@ -50,15 +54,25 @@ export interface PDF {
      * Set up the PDF writing engine.
      */
     Write: Write;
+	/**
+     * Set the PDF reader Options.
+     * @param options Specify the reader Options.
+     */
+	SetReaderOptions(options: ReaderOptions): boolean;
+	/**
+     * Returns the current PDF reader options.
+     * @param options Specify the reader Options.
+     */
+	GetReaderOptions(): ReaderOptions;
 }
 export interface Write {
     /**
      * Set up the PDF writing engine.
      * @param settings Configures how the PDF is generated.
      */
-    Setup(settings: PDFWSetting): void;
+    Setup(settings: PDFWSettings): void;
 }
-export interface PDFWSetting {
+export interface PDFWSettings {
     /**
      * Specify the author.
      */
@@ -116,4 +130,58 @@ export interface PDFWSetting {
      * Only valid when the {compression} is 'JPEG' or 'JPEG2000'.
      */
     quality?: number;
+	/**
+     * Reduce the file size when saving the image(s) as a PDF file. 
+     */
+	docCompressor?:{ //18.3
+		/**
+		 * Enabled document compressor.
+		 */
+		enabled: boolean;
+		 /**
+		 * sensitivity
+		 * The value ranges from 1 to 100. Default value is 50.
+		 * Only valid when the {compression} is 'JPEG' or 'JPEG2000'.
+		 */
+		sensitivity?: number;
+		/**
+		 * compressLevel
+		 * The value ranges from 0 to 100. Default value is 50.
+		 * Only valid when the {compression} is 'JPEG' or 'JPEG2000'.
+		 */
+		compressLevel?: number;
+	}
+}
+export interface ReaderOptions {
+    /**
+     * Default value: CM_AUTO
+     */
+    convertMode: DynamsoftEnumsDWT.EnumDWT_ConvertMode | number;   
+    /**
+     * If a password is required to open the PDF, set it here. Default value: "".
+     */
+    password?: string; 
+    renderOptions?: {
+         /**
+         * If convertMode is set to CM_RENDERALL or CM_AUTO, this controls whether or not annotations will be rendered. Default value: false.
+         */
+        renderAnnotations?: boolean;
+        /**
+         * DPI. Only affects text being rasterized. Does not affect images extracted from the PDF file. Default value: 200.
+         */
+		resolution?: number;  
+         /**
+         * Pixels. 0 is no limit. Default value: 0.
+         */
+		maxWidth?: number;
+        /** 
+         * Pixels. 0 is no limit. Default value: 0.
+         */
+		maxHeight?: number;
+         /**
+         * Whether or not to render in grayscale. Default value: false.
+         */
+		renderGrayscale?: boolean; 
+    }
+	
 }

package/dist/types/Dynamsoft.Enum.d.ts

@@ -181,6 +181,9 @@ export namespace DynamsoftEnumsDWT {
         CM_RENDERALL = 1,
         CM_IMAGEONLY = 2,
         CM_AUTO = 3,
+		/*
+		* @deprecated since version 18.4. This value will be removed in future versions. Use `ReaderOptions.renderOptions.renderAnnotations` instead.
+		*/
 		CM_RENDERALLWITHANNOTATION = 4
     }
     enum EnumErrorCode {
@@ -1875,19 +1878,22 @@ export namespace DynamsoftEnumsDWT {
 		SANESCANNER = 0x100,
 		ESCLSCANNER = 0x200,
 		WIFIDIRECTSCANNER = 0x400,
+		/*
+		* @deprecated since version 18.2. This value will be removed in future versions. Use the value `WIASCANNER` instead.
+		*/
 		WIATWAINSCANNER = 0x800
 	}	
 	enum EnumDWT_ImageFormatType{
-		url = 0,  
-		blob = 1,
-		base64 = 2
+		URL = 0,  
+		Blob = 1,
+		Base64 = 2
 	}
 	enum EnumDWT_ResponseType{
-		text = 0,  
-		blob = 1,
-		arraybuffer = 2,
-		xml = 3,
-		json = 4
+		Text = 0,  
+		Blob = 1,
+		ArrayBuffer = 2,
+		XML = 3,
+		JSON = 4
 	}
 	enum EnumDWT_WorkMode{
 		normal = 0, // old mode, the image is processed at the server and then displayed in viewer    

package/dist/types/Dynamsoft.d.ts

@@ -337,6 +337,10 @@ export interface DWTPro {
      * A callback function that is executed when a WebTwain instance is created.
      */
     OnWebTwainReady: () => void;
+	/**
+     * A callback function that is executed when a WebTwain instance is faild.
+     */
+    OnWebTwainError: (error: any) => void;
     /**
      * A callback function that is executed right before the creation of a WebTwain instance.
      */
@@ -354,12 +358,28 @@ export interface DWTPro {
      */
     ProductKey: string;	
     /**
+	 * @deprecated since version 18.0. This property will be removed in future versions. Use `Dynamsoft.DWT.ProductKey` instead.
 	 * LTS Settings
-	*/
+	 */
 	licenseServer?: string[];
+	/**
+	 * @deprecated since version 18.0. This property will be removed in future versions. Use `Dynamsoft.DWT.ProductKey` instead.
+	 * LTS Settings
+	 */
 	handshakeCode?: string;
+	/**
+	 * @deprecated since version 18.0. This property will be removed in future versions. Use `Dynamsoft.DWT.ProductKey` instead.
+	 * LTS Settings
+	 */
 	sessionPassword?: string;
+	/**
+	 * @deprecated since version 18.0. This property will be removed in future versions. Use `Dynamsoft.DWT.ProductKey` instead.
+	 * LTS Settings
+	 */
 	organizationID?: string;
+	/*
+	 * @deprecated since version 18.2. This property will be removed in future versions. Use RegisterEvent `OnWebTwainError` instead.
+	 */
 	licenseException?: string;
     /**
      * The product name.
@@ -379,6 +399,10 @@ export interface DWTPro {
      * Set or return where the library looks for resources files including service installers, CSS, etc.
      */
     ResourcesPath: string;
+	/**
+     * Set or return service installer path.
+     */
+	ServiceInstallerLocation: string;
     /**
      * The version of the Linux edition (the service, not wasm).
      */

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

@@ -66,6 +66,9 @@ export interface WebTwainAcquire extends WebTwainEdit {
      * Load a data source to get it ready to acquire images.
      */
     OpenSourceAsync(): Promise<boolean>;
+	/*
+	* @deprecated since version 10.1. This function will be removed in future versions. Use `GetSourceNamesAsync` instead.
+	*/
     GetSourceNames(bIncludeDetails?: boolean): string[] | SourceDetails[];
     /**
      * Return all available data sources (scanners, etc.) and optionally all detailed information about them.
@@ -82,7 +85,7 @@ export interface WebTwainAcquire extends WebTwainEdit {
     SelectSource(
         successCallBack?: () => void,
         failureCallBack?: (errorCode: number, errorString: string) => void
-    ): boolean | void;
+    ): boolean | string;
     /**
      * Bring up the Source Selection User Interface (UI) for the user to choose a data source.
      * @param deviceType The device type. Added the parameter deviceType in Dynamic Web TWAIN 18
@@ -155,6 +158,7 @@ export interface WebTwainAcquire extends WebTwainEdit {
      */
     GetCustomDSDataEx(): string;
     /**
+	 * @deprecated since version 18.0. This function will be removed in future versions. 
      * Inspect the current data source and return whether it is a scanner, a webcam, etc.
      */
     GetDeviceType(): number;
@@ -350,6 +354,7 @@ export interface WebTwainAcquire extends WebTwainEdit {
      */
     readonly ImageLayoutPageNumber: number;
     /**
+	 * @deprecated since version 10.1. This property will be removed in future versions. Use `RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {})` and get `outputInfo` instead.
      * Return the bit depth of the current image.
      */
     readonly ImageBitsPerPixel: number;
@@ -358,18 +363,22 @@ export interface WebTwainAcquire extends WebTwainEdit {
      */
     readonly ImagePixelType: DynamsoftEnumsDWT.EnumDWT_PixelType | number;
     /**
+	 * @deprecated since version 10.1. This property will be removed in future versions. Use `RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {})` and get `outputInfo` instead.
      * Return the length of the current image.
      */
     readonly ImageLength: number;
     /**
+	 * @deprecated since version 10.1. This property will be removed in future versions. Use `RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {})` and get `outputInfo` instead.
      * Return the width of the current image.
      */
     readonly ImageWidth: number;
     /**
+	 * @deprecated since version 10.1. This property will be removed in future versions. Use `RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {})` and get `outputInfo` instead.
      * Return the horizontal resolution of the current image.
      */
     readonly ImageXResolution: number;
     /**
+	 * @deprecated since version 10.1. This property will be removed in future versions. Use `RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {})` and get `outputInfo` instead.
      * Return the vertical resolution of the current image.
      */
     readonly ImageYResolution: number;
@@ -429,169 +438,170 @@ export interface WebTwainAcquire extends WebTwainEdit {
         failureCallback: (capabilities: Capabilities) => void
     ): void;
     /**
-     * [Deprecation] Specifies the capabiltiy to be negotiated. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Specifies the capabiltiy to be negotiated. This is a runtime property.
      */
     Capability: DynamsoftEnumsDWT.EnumDWT_Cap;
     /**
-     * [Deprecation] Return or set the index (0-based) of
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the index (0-based) of
      * a list to indicate the Current Value when the value of
      * the CapType property is TWON_ENUMERATION. If the data type
      * of the capability is String, the list is in CapItemsString property.
      * For other data types, the list is in CapItems property. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapCurrentIndex: number;
     /**
-     * [Deprecation] Return or set the current value in a range when the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the current value in a range when the
      * value of the CapType property is TWON_RANGE. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapCurrentValue: number;
     /**
-     * [Deprecation] Return the index (0-based) of a list to indicate the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return the index (0-based) of a list to indicate the
      * Default Value when the value of the CapType property is TWON_ENUMERATION.
      * If the data type of the capability is String, the list is in CapItemsString property.
      *  For other data types, the list is in CapItems property. This is a runtime, read-only property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     readonly CapDefaultIndex: number;
     /**
-     * [Deprecation] Return the default value in a range when the value of the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return the default value in a range when the value of the
      * CapType property is TWON_RANGE. This is a runtime, read-only property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapDefaultValue: number;
     /**
-     * [Deprecation] Retruns the description for a capability
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Retruns the description for a capability
      */
     CapDescription: string;
     /**
-     * [Deprecation] Return or set the maximum value in a range when the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the maximum value in a range when the
      * value of the CapType property is TWON_RANGE. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapMaxValue: number;
     /**
-     * [Deprecation] Return or set the minimum value in a range when the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the minimum value in a range when the
      * value of the CapType property is TWON_RANGE. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapMinValue: number;
     /**
-     * [Deprecation] Return or set how many items are in the list when the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set how many items are in the list when the
      *  value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
      * For String data type, the list is in CapItemsString property.
      * For other data types, the list is in CapItems property.
      * This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapNumItems: number;
     /**
-     * [Deprecation] Return or set the step size in a range when the value
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the step size in a range when the value
      * of the CapType property is TWON_RANGE. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapStepSize: number;
     /**
-     * [Deprecation] Return or set the type of capability container used
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the type of capability container used
      * to exchange capability information between application and source.
      * This is a runtime property.
      */
     CapType: DynamsoftEnumsDWT.EnumDWT_CapType;
     /**
-     * [Deprecation] Return or set the value of the capability specified by
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the value of the capability specified by
      *  Capability property when the value of the CapType property is TWON_ONEVALUE.
      * This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapValue: number;
     /**
-     * [Deprecation] Return or set the string value for a capability when the
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the string value for a capability when the
      * value of the CapType property is TWON_ONEVALUE. This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapValueString: string;
     /**
-     * [Deprecation] Return or set the value type for reading the value of a capability.
-     *  This is a runtime property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This property will be removed in future versions. Use function `getCapabilities` and `setCapabilities` instead.
+     * Return or set the value type for reading the value of a capability.
+     * This is a runtime property.
      */
     CapValueType: number;
     /**
-     * [Deprecation] Gets information of the capability specified by the Capability property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Gets information of the capability specified by the Capability property.
      */
     CapGet(): boolean;
     /**
-     * [Deprecation] Return the Source's current Value for the specified capability.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Return the Source's current Value for the specified capability.
      */
     CapGetCurrent(): boolean;
     /**
-     * [Deprecation] Return the Source's Default Value for the specified capability.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Return the Source's Default Value for the specified capability.
      * This is the Source's preferred default value.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapGetDefault(): boolean;
     /**
-     * [Deprecation] Return the value of the bottom-most edge of the specified frame.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Return the value of the bottom-most edge of the specified frame.
      * @param index specifies the value of which frame to get. The index is 0-based.
      */
     CapGetFrameBottom(index: number): number;
     /**
-     * [Deprecation] Return the value (in Unit) of the left-most edge of the specified frame.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Return the value (in Unit) of the left-most edge of the specified frame.
      * @param index specifies the value of which frame to get. The index is 0-based.
      */
     CapGetFrameLeft(index: number): number;
     /**
-     * [Deprecation] Return the value (in Unit) of the left-most edge of the specified frame.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Return the value (in Unit) of the left-most edge of the specified frame.
      * @param index specifies the value of which frame to get. The index is 0-based.
      */
     CapGetFrameRight(index: number): number;
     /**
-     * [Deprecation] Return the value (in Unit) of the top-most edge of the specified frame.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Return the value (in Unit) of the top-most edge of the specified frame.
      * @param index specifies the value of which frame to get. The index is 0-based.
      */
     CapGetFrameTop(index: number): number;
     /**
-     * [Deprecation] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
      */
     CapGetHelp(index: number): number;
     /**
-     * [Deprecation] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
      */
     CapGetLabel(index: number): number;
     /**
-     * [Deprecation] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
      */
     CapGetLabels(index: number): number;
     /**
-     * [Deprecation] Queries whether the Source supports a particular operation on the capability.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Queries whether the Source supports a particular operation on the capability.
      * @param {DynamsoftEnumsDWT.EnumDWT_MessageType} messageType specifies the type of capability operation.
      */
     CapIfSupported(messageType: DynamsoftEnumsDWT.EnumDWT_MessageType): boolean;
     /**
-     * [Deprecation] Changes the Current Value of the capability specified by
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Changes the Current Value of the capability specified by
      * Capability property back to its power-on value.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapReset(): boolean;
     /**
-     * [Deprecation] Sets the current capability using the container type specified by
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Sets the current capability using the container type specified by
      * CapType property. The current capability is specified by Capability property.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      */
     CapSet(): boolean;
     /**
-     * [Deprecation] Sets the values of the specified frame.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
+     * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Sets the values of the specified frame.
      * @param index  specifies the values of which frame to set. The index is 0-based.
      * @param left the value (in Unit) of the left-most edge of the specified frame.
      * @param top the value (in Unit) of the top-most edge of the specified frame.
@@ -600,29 +610,30 @@ export interface WebTwainAcquire extends WebTwainEdit {
      */
     CapSetFrame(index: number, left: number, top: number, right: number, bottom: number): boolean;
     /**
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
      * Get the cap item value of the capability specified by Capability property,
      * when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      * @param index Index is 0-based. It is the index of the cap item.
      */
     GetCapItems(index: number): number;
     /**
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
      * Returns the cap item value of the capability specified by Capability property,
      * when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      * @param index Index is 0-based. It is the index of the cap item.
      */
     GetCapItemsString(index: number): string;
     /**
-     * [Deprecation] Set the value of the specified cap item.
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Set the value of the specified cap item.
      * @param index Index is 0-based. It is the index of the cap item.
      * @param newVal For string type, please use CapItemsstring property.
      */
     SetCapItems(index: number, newVal: number): void;
     /**
-     * [Deprecation] Set the cap item value of the capability specified by Capability property,
+	 * @deprecated since version 16.1.1. This function will be removed in future versions. Use `getCapabilities` and `setCapabilities` instead.
+     * Set the cap item value of the capability specified by Capability property,
      * when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
-     * [Alternative] Use getCapabilities() and setCapabilities() instead.
      * @param index Index is 0-based. It is the index of the cap item.
      * @param newVal The new value to be set.
      */