dwt 17.2.3 → 17.3.0

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

@@ -1,3 +1,4 @@
+import { DynamsoftEnumsDWT } from "./Dynamsoft.Enum";
 export interface Camera {
     /**
      * Hide the camera interface.
@@ -43,7 +44,8 @@ export interface Camera {
      * @param resolution Specify the initial resolution.
      */
     play(element?: HTMLElement,
-        resolution?: Resolution
+        resolution?: Resolution,
+		fill?: boolean
     ): Promise<Resolution>;
     /**
      * Pause the video stream.
@@ -79,24 +81,24 @@ export interface Camera {
     ): Promise<Resolution>;
 	/**
      * Start streaming video from the current camera in the viewer.
-     * @param scanConfiguration The scanConfiguration settings. If not set, the default setting is used.
+     * @param documentConfiguration The documentConfiguration settings. If not set, the default setting is used.
      */
-	scanDocument(scanConfiguration?: ScanConfiguration): Promise<Resolution>;
+	scanDocument(documentConfiguration?: DocumentConfiguration): Promise<Resolution>;
     /**
      * Close the camera and hide the video streaming UI.
      */
     closeVideo(): void;
     /**
      * Specify an event listener for the specified built-in viewer event.
-     * @param name Specify the event name.
+     * @param eventName Specify the event name.
      * @param callback The event listener.
      */
-	on(name: string, callback: (event?: any, event1?: any, event2?: any) => void): void;
+	on(eventName: string, callback: (...param: any[]) => void): void;
     /**
      * Remove a built-in viewer event handler.
      * @param eventName Specify the event name.
      */
-	off(eventName: string, callback?: (event: ViewerEvent) => void): boolean;
+	off(eventName: string, callback?: (...param: any[]) => void): void;
 }
 export interface DeviceInfo {
     deviceId: string;
@@ -128,106 +130,154 @@ export interface ViewerEvent {
      */
     pageY: number;
 }
-export interface ScanConfiguration {
-    element?: HTMLDivElement;  //Bind the elment or elment id. 
-                             //After binding, display the video in the spcified element, otherwise, display the video in full screen.
-
-	scannerViewer?: {
-		deviceId?: string;   //camera id
-		maxDocuments?:number;    //The maximum documents can be captured/loaded in to the buffer. 
-		enableBorderDetection?: boolean;   //Whether to enable border detection. The default value is true.
-		fullScreen?: boolean;   //Whether to display the video in full screen. The default value is false.
-		polygonStyle?:{           //The sytle of the auto detect border.
-			stroke?: string;           //default: "#fe8e14". Only supports #16 hexadecimal.
-			strokeWidth?: string;       //default: "2px"
-			dash?: string;   //The allowed value are "solid" and "dashed", the default value is "solid".
-		};
-
-		resolution?: {
-			visibility?: boolean;    //Whether to display the resolution icon in the upper left corner. The default value is true.
-			valueList?: any;
-			defaultValue?: Resolution; //Set the default value according to the value set in the valueList.
-        };
-
-		autoScan?: { //Automatically capture when a clear document is detected. Only applicable to video scanning. 
-			visibility?: boolean;    //Whether to display the automatic scan icon. The default value is true.
-			enableAutoScan?: boolean;   //Whether to enable automatic scan. The default value is false.
-		};
-
-		autoDetect?: { //Only applicable to video scanning.    
-			visibility?: boolean;    //Whether to display the automatic border detection icon. The default value is true.
-			enableAutoDetect?: boolean;   //Whether to enable automatic border detection. The default value is false.          
-			acceptedPolygonConfidence?:number;  //The default value is 80. The higher the setting, the more accurate the automatic border detection.
-			fpsLimit?: number;  //The maximum number of frames detected per second. The default value is 3.
-			acceptedBlurryScore?:number; //The default value is 0.
-			autoCaptureDelay?: number;   //The default value is 1000ms.
-		};
-
-
-        continuousScan?:{   //Only applicable to video scanning.
-			visibility?: boolean;     //Whether to display the continuous scan icon. The default value is true.
-			enableContinuousScan?: boolean;   //Whether to enable continuous scan. The default value is true.
-		};
-
-		switchCamera?: {   //The default camera is the rear camera.
-			visibility?: boolean;   //Whether to display the switch camera icon. The default value is true.
-		};
-                                   
-		loadLocalFile?: {  
-		   visibility?: boolean;   //Whether to display the load local file icon. The default value is true.
-		};
-
-		funcConfirmExitContinuousScan?: (bExistImage: boolean) => void;
-		 //funcConfirmExitContinuousScan is the callback funtion
-		 //Return true：Exit continuous scan mode without saving the captured image data. Return false: Stay on the original viewer
+export interface DocumentConfiguration {
+	scannerViewer?: ScannerViewer;  
+	documentEditorSettings?: DocumentEditorSettings; 
+}
+export interface ScannerViewer {
+	deviceId?: string;   //camera id
+	maxDocuments?:number;    //The maximum documents can be captured/loaded in to the buffer. 
+	enableBorderDetection?: boolean;   //Whether to enable border detection. The default value is true.
+	fullScreen?: boolean;   //Whether to display the video in full screen. The default value is false.
+	polygonStyle?:{           //The sytle of the auto detect border.
+		stroke?: string;           //default: "#fe8e14". Only supports #16 hexadecimal.
+		strokeWidth?: string;       //default: "2px"
+		dash?: string;   //The allowed value are "solid" and "dashed", the default value is "solid".
+	};
+	element?: HTMLDivElement | string;  //Bind the elment or elment id. 
+				//After binding, display the video in the spcified element, otherwise, display the video in full screen.
+	headerStyle?:{
+		background?: string;     //background color of the head, default : "#000000". Only supports #16 hexadecimal.
+		color?: string;     //The color of the icons, default : "#ffffff". Only supports #16 hexadecimal.
+		selectedColor?: string;     //The color of the selected icon, default : "#fe8e14". Only supports #16 hexadecimal.
+	};
+	bodyStyle?:{ 
+		background?: string;  //Background color when the video streaming is not full-screen, default : "#ffffff".  Only supports #16 hexadecimal.
+		loaderBarSource?: string;   //Waiting for the document to appear
+	};
+	footerStyle?:{
+		background?: string;  //background color of the foot, default : "#000000". Only supports #16 hexadecimal.
+		color?: string;       //The color of the icons, default : "#ffffff". Only supports #16 hexadecimal.
+		selectedColor?: string;  //The color of the selected icon, default : "#fe8e14". Only supports #16 hexadecimal.
+	};
+	scanButtonStyle?:{
+		background?: string;  //background color, default : "#fe8e14". Only supports #16 hexadecimal.
+		color?: string;  //icon color, default : "#ffffff". Only supports #16 hexadecimal.
+	};
+	resolution?: {  
+		visibility?: string;    //Whether to display the resolution icon in the upper left corner, the value "visible":"hidden". The default value is "visible".
+		valueList?: any;
+		defaultValue?: Resolution; //Set the default value according to the value set in the valueList.
+	};
+	autoScan?: { //Automatically capture when a clear document is detected. Only applicable to video scanning. 
+		visibility?:string;   //Whether to display the automatic scan icon. The allowed value are "visible" and "hidden". The default value is "visible".
+		enableAutoScan?: boolean;   //Whether to enable automatic scan. The default value is false.
+	};
+	autoDetect?: { //Only applicable to video scanning.    
+		visibility?:string;     //Whether to display the automatic border detection icon. The allowed value are "visible" and "hidden". The default value is "visible".
+		enableAutoDetect?: boolean;   //Whether to enable automatic border detection. The default value is false.          
+		acceptedPolygonConfidence?:number;  //The default value is 80. The higher the setting, the more accurate the automatic border detection.
+		fpsLimit?: number;  //The maximum number of frames detected per second. The default value is 3.
+		acceptedBlurryScore?:number; //The default value is 0.
+		autoCaptureDelay?: number;   //The default value is 1000ms.
+	};
+	continuousScan?: boolean;  //Whether to continuou capture. The default value is true.
+	switchCamera?: {   //The default camera is the rear camera.
+		visibility?:string;   //Whether to display the switch camera icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	};
+							   
+	loadLocalFile?: {  
+	   visibility?:string;   //Whether to display the load local file icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	};
 
-		funcConfirmExit?: (bExistImage: boolean) => void;
-		 //funcConfirmExit is the callback funtion，
-		 //Return true：End this capture without saving the image data. Return false: Stay on the original viewer
-    };
+	funcConfirmExit?: (bExistImage: boolean) => Promise<boolean>;
+	 //funcConfirmExit is the callback funtion,
+  	 //Return Promise.resolve(true): End this capture without saving the image data. Return Promise.resolve(false): Stay on the original viewer
+}
 
-	filterViewer?: {
-		visibility?: boolean;   //Whether to display filter viewer. The default value is true.
+export interface DocumentEditorSettings {
+	visibility?:string;  //Whether to display the documentEditor. The allowed value are "visible" and "hidden". The default value is "visible".
+	element?: HTMLDivElement | string;  //Bind the elment or elment id. 
+                             //After binding, display the video in the spcified element, otherwise, display the video in full screen.
+	defaultViewerName?:string;  // default viewer.  The allowed value are "cropViewer" and "mainViewer". 
+	headerStyle?:{
+		background?: string;     //background color of the head, default: "#000000". Only supports #16 hexadecimal.
+		color?: string;     //The color of the icons, default : "#ffffff". Only supports #16 hexadecimal.
+		selectedColor?: string;     //Selected icon color, default : "#fe8e14". Only supports #16 hexadecimal.
+		disabledColor?: string;   //disabled color. default: "#808080"
+	};
+	bodyStyle?:{ 
+		background?: string;  //Background color when the video streaming is not full-screen, default : "#ffffff".  Only supports #16 hexadecimal.
+		loaderBarSource?: string;   //Waiting for the document to appear
+	};
+	footerStyle?:{
+		background?: string;  //background color of the foot, default : "#000000". Only supports #16 hexadecimal.
+		color?: string;       //The color of the icons, default : "#ffffff". Only supports #16 hexadecimal.
+		selectedColor?: string;  //Selected icon color, default: "#fe8e14". Only supports #16 hexadecimal.
+	};
+	insert?: {   //Insert an image  
+		visibility?:string;    //Whether to display the insert icon. The allowed value are "visible" and "hidden". The default value is "visible".
+		position?: string;  //Set whether to insert the image "before" or "after" the current image. The default value is "before".
+	};
 
-		insert?: {   //Insert an image  
-			visibility?: boolean;   //Whether to display the insert icon. The default value is true.
-			position?: string;  //Set whether to insert the image "before" or "after" the current image. The default value is "before".
-		};
+	remove?: {  //Remove an image
+		visibility?:string;    //Whether to display the remove icon.The allowed value are "visible" and "hidden". The default value is "visible".
+	    funcConfirmRemove?: () => Promise<boolean>;  
+		//funcConfirmRemove is the callback funtion,
+		//Return Promise.resolve(true): delete the image data. Return Promise.resolve(false): Stay on the original viewer
+	};
 
-		remove?: {  //Remove an image
-			visibility?: boolean;   //Whether to display the remove icon. The default value is true.
-		};
+	rotateLeft?: {  
+		visibility?:string;    //Whether to display the rotate left icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	};
 
-		rotateLeft?: {  
-			visibility?: boolean;    //Whether to display the rotate left icon. The default value is true.
-		};
-  
 	filter?: {  
-		visibility?: boolean;   //Whether to display the filter icon. The default value is true.
-	      valueList?:any;
-	      defaultValue?: string;  //Filter selected by default. By default, the original filter is selected.
-		};
-		exitDocumentScanAfterSave: boolean;  //The default value is false.
+	  visibility?:string;   //Whether to display the filter icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	  valueList?:any;
+	  defaultValue?: string;  //Filter selected by default. By default, the original filter is selected.
+	  applyToAll?: {  //Apply to all documents
+		visibility?:string;  //Whether to display the applyToAll icon. The allowed value are "visible" and "hidden". The default value is "visible".
+        enableApplyToAll?: boolean;   //Whether to enable to apply to all documents, Default:false.
+        label?: string; //the label of the applyToAll, default: "Apply to all"            
+	  };
 	};
-
-	cropViewer?: { 
-		visibility?: boolean;   //Whether to display the crop viewer. The default value is true.
+	
+	crop?:{  
+		visibility?:string;   //Whether to display the crop icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	};
+	
+	cropViewer?:CropViewer;
+	funcConfirmExit?: (bChanged: boolean, previousViewerName: string) => Promise<Number | DynamsoftEnumsDWT.EnumDWT_ConfirmExitType>;
+	//funcConfirmExit is the callback funtion.
+	//Return Promise.resolve(EnumDWT_ConfirmExitType.Exit): Exit original viewer without saving the image data. 
+	//Return Promise.resolve(EnumDWT_ConfirmExitType.SaveAndExit): Exit original viewer with saving the image data. 
+	//Return Promise.resolve(EnumDWT_ConfirmExitType.Cancel): Stay on the original viewer
+	funcConfirmExitAfterSave?: (firedByDocumentEdit: boolean) => void;
+	//funcConfirmExitAfterSave is the callback funtion
+}
+export interface CropViewer {
+	visibility?: boolean;   //Whether to display the crop viewer. The allowed value are "visible" and "hidden". The default value is "visible".
       
-		polygonStyle?:{     //The polygon style in the crop viewer.       
-			stroke?: string;          //default : "#fe8e14".  Only supports #16 hexadecimal.
-			strokeWidth?: string;     //default: "2px"
-			dash?: string;   //The allowed value are "solid" and "dashed", the default value is "solid".
-		};
+	polygonStyle?:{     //The polygon style in the crop viewer.       
+		stroke?: string;          //default : "#fe8e14".  Only supports #16 hexadecimal.
+		strokeWidth?: string;     //default: "2px"
+		dash?: string;   //The allowed value are "solid" and "dashed", the default value is "solid".
+	};
 
-		rotateLeft?:{   
-			visibility?: boolean;   //Whether to display the rotate left icon. The default value is true.
-		};
-		rotateRight?:{   
-			visibility?: boolean;   //Whether to display the rotate right icon. The default value is true.
-		};
-    	autoDetectBorder?:{   
-			visibility?: boolean;   //Whether to display the automatic border detection icon. The default value is true.
-		};
+	rotateLeft?:{   
+		visibility?: string;   //Whether to display the rotate left icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	};
+	rotateRight?:{   
+		visibility?: string;   //Whether to display the rotate right icon. The allowed value are "visible" and "hidden". The default value is "visible".
 	};
+	autoDetectBorder?:{   
+		visibility?: string;   //Whether to display the automatic border detection icon. The allowed value are "visible" and "hidden". The default value is "visible".
+	};
+	funcConfirmExit?: (bChanged: boolean, previousViewerName: string) => Promise<Number | DynamsoftEnumsDWT.EnumDWT_ConfirmExitType>;
+	//funcConfirmExit is the callback funtion.
+	//Return Promise.resolve(EnumDWT_ConfirmExitType.Exit): Exit original viewer without saving the image data. 
+	//Return Promise.resolve(EnumDWT_ConfirmExitType.SaveAndExit): Exit original viewer with saving the image data. 
+	//Return Promise.resolve(EnumDWT_ConfirmExitType.Cancel): Stay on the original viewer
 }
 
+

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

@@ -62,49 +62,58 @@ export interface PDFWSetting {
     /**
      * Specify the author.
      */
-    author: string;
+    author?: string;
     /**
      * Specify the compression type.
      */
-    compression: DynamsoftEnumsDWT.EnumDWT_PDFCompressionType | number;
+    compression?: DynamsoftEnumsDWT.EnumDWT_PDFCompressionType | number;
     /**
+     * Specify the page type.
+	 * 0: page width&height decided by image
+	 * 2: A4
+	 * 4: A3
+	 * 6: Letter
+	 * 8: Legal
+     */
+    pageType?: number;
+	/**
      * Specify the creator.
      */
-    creator: string;
+    creator?: string;
     /**
      * Specify the creation date.
      * Note that the argument should start with 'D:' like 'D:20181231'.
      */
-    creationDate: string;
+    creationDate?: string;
     /**
      * Specify the key words.
      */
-    keyWords: string;
+    keyWords?: string;
     /**
      * Specify the modified date.
      * Note that the argument should start with 'D:' like 'D:20181231'.
      */
-    modifiedDate: string;
+    modifiedDate?: string;
     /**
      * Specify the producer.
      */
-    producer: string;
+    producer?: string;
     /**
      * Specify the subject.
      */
-    subject: string;
+    subject?: string;
     /**
      * Specify the title.
      */
-    title: string;
+    title?: string;
     /**
      * Specify the PDF version. For example, '1.5'.
      */
-    version: string;
+    version?: string;
     /**
      * Specify the quality of the images in the file.
      * The value ranges from 0 to 100.
      * Only valid when the {compression} is 'JPEG' or 'JPEG2000'.
      */
-    quality: number;
+    quality?: number;
 }

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

@@ -1572,7 +1572,9 @@ export namespace DynamsoftEnumsDWT {
         /** CCITT modified Huffman RLE. */
         PDF_RLE = 4,
         /** JPEG compression. */
-        PDF_JPEG = 5
+        PDF_JPEG = 5,
+		PDF_JP2000 = 6,
+		PDF_JBIG2 = 7
     }
     /** ICAP_PIXELTYPE values (PT_ means Pixel Type) */
     enum EnumDWT_PixelType {
@@ -1851,4 +1853,13 @@ export namespace DynamsoftEnumsDWT {
         TDM_GENERAL_WIDTH_CONCENTRATION = 2,
         TDM_SKIP = 0
     }
+	enum EnumDWT_ConfirmExitType {
+        Cancel = 0,   //cancel, Stay on the original viewer
+        Exit = 1,     //Exit original viewer without saving the image data
+        SaveAndExit = 2   //Exit original viewer with saving the image data
+    }
+	enum EnumDWT_SelectionMode {
+		Single = 0,
+		Multiple = 1
+	}
 }

package/dist/types/Dynamsoft.d.ts

@@ -156,10 +156,6 @@ export interface DSLibEnv {
      * Whether the operating system is Windows.
      */
     readonly bWin: boolean;
-    /**
-     * Whether the operating system is 64bit Windows.
-     */
-    readonly bWin64: boolean;
     /**
      * The base path.
      */
@@ -188,14 +184,6 @@ export interface DSLibEnv {
      * Whether it is a pad viewer.
      */
     isPadViewer(): boolean;
-    /**
-     * Whether the platform is 64bit.
-     */
-    readonly isX64: boolean;
-    /**
-     * Information about macOSX.
-     */
-    readonly macOSX: string;
     /**
      * OS version.
      */
@@ -333,23 +321,23 @@ export interface DWTPro {
     /**
      * A callback function that is executed when the WebTwain related files are not found.
      */
-    OnWebTwainNotFound: () => {};
+    OnWebTwainNotFound: () => void;
     /**
      * A callback function that is executed after a time-consuming operation.
      */
-    OnWebTwainPostExecute: () => {};
+    OnWebTwainPostExecute: () => void;
     /**
      * A callback function that is executed before a time-consuming operation.
      */
-    OnWebTwainPreExecute: () => {};
+    OnWebTwainPreExecute: () => void;
     /**
      * A callback function that is executed when a WebTwain instance is created.
      */
-    OnWebTwainReady: () => {};
+    OnWebTwainReady: () => void;
     /**
      * A callback function that is executed right before the creation of a WebTwain instance.
      */
-    OnWebTwainWillInit: () => {};
+    OnWebTwainWillInit: () => void;
     /**
      * The version of the PDF module (not the rasterizer).
      */
@@ -522,5 +510,13 @@ export interface WasmConfig {
      */
 	fetchOptions: any;
 }
-declare const Dynamsoft: (typeof DynamsoftStatic);
+export interface DWTInstall {
+    funcConfirmRemove?: () => Promise<boolean>;  
+	funcConfirmExit?: (bExistImage: boolean) => Promise<boolean>;
+	funcConfirmExitAfterSave?: (firedByDocumentEdit: boolean) => void;
+	funcConfirmCropViewerExit?: (bChanged: boolean, previousViewerName: string) => Promise<Number | DynamsoftEnumsDWT.EnumDWT_ConfirmExitType>;
+	funcConfirmMainViewerExit?: (bChanged: boolean, previousViewerName: string) => Promise<Number | DynamsoftEnumsDWT.EnumDWT_ConfirmExitType>;
+}
+declare const Dynamsoft: (DWTInstall & typeof DynamsoftStatic);
+//declare const Dynamsoft: (typeof DynamsoftStatic);
 export default Dynamsoft;

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

@@ -84,14 +84,8 @@ export interface WebTwainAcquire extends WebTwainEdit {
     ): boolean | void;
     /**
      * Bring up the Source Selection User Interface (UI) for the user to choose a data source.
-     * @param successCallback A callback function that is executed if the request succeeds.
-     * @param failureCallback A callback function that is executed if the request fails.
-     * @argument errorCode The error code.
-     * @argument errorString The error string.
      */
     SelectSourceAsync(
-        successCallBack?: () => void,
-        failureCallBack?: (errorCode: number, errorString: string) => void
     ): Promise<boolean>;
     /**
      * Select a data source by its index.
@@ -653,6 +647,21 @@ export interface DeviceConfiguration {
      * How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true.
      */
     extendedImageInfoQueryLevel?: number;
+	 /**
+     * Whether to simulate the manufacturer's UI inside the client-side browser (only effective when IfShowUI is true).
+     * (Added in 16.2)
+     */
+    RemoteScan?:boolean;
+    /**
+     * Whether to simulate the manufacturer's UI inside the client-side browser (only effective when IfShowUI and RemoteScan are both true and the WebTwain instance doing the scan has no viewer of its own).
+     * (Added in 16.2)
+     */
+    ShowRemoteScanUI?:boolean;
+    /**
+     * Specify a source by its index.
+     * (Added in 16.2)
+     */
+    SelectSourceByIndex?: number;
 }
 export interface SourceDetails {
     /**
@@ -982,23 +991,23 @@ export interface CapabilityDetails {
     /**
      * The container type of the Capability
      */
-    conType: ValueAndLabel;
+    conType?: ValueAndLabel;
     /**
      * The index for the current value of the Capability
      */
-    curIndex: number;
+    curIndex?: number;
     /**
      * The current value of the Capability
      */
-    curValue: ValueAndLabel;
+    curValue?: ValueAndLabel;
     /**
      * The index for the default value of the Capability
      */
-    defIndex: number;
+    defIndex?: number;
     /**
      * The operation types that are supported by the Capability. Types include {"get", "set", "reset" "getdefault", "getcurrent"}
      */
-    query: string[];
+    query?: string[];
     /**
      * The value type of the Capability. Value types include
      * TWTY_BOOL: 6
@@ -1015,21 +1024,22 @@ export interface CapabilityDetails {
      * TWTY_UINT16: 4
      * TWTY_int: 5
      */
-    valueType: ValueAndLabel;
+    valueType?: ValueAndLabel;
     /**
      * The available values of the Capability
      */
-    values: ValueAndLabel[];
+    values?: ValueAndLabel[];
 }
 export interface ValueAndLabel {
     /**
      * Numeric representation of the item
      */
-    value: DynamsoftEnumsDWT.EnumDWT_Cap | DynamsoftEnumsDWT.EnumDWT_CapType | DynamsoftEnumsDWT.EnumDWT_CapValueType | number;
+    value?: DynamsoftEnumsDWT.EnumDWT_Cap | DynamsoftEnumsDWT.EnumDWT_CapType | DynamsoftEnumsDWT.EnumDWT_CapValueType | number;
     /**
      * Label or name of the item
      */
-    label: string;
+    label?: string;
+	[key:string]:any;
 }
 export interface Capabilities {
     /**
@@ -1049,7 +1059,7 @@ export interface CapabilitySetup {
     /**
      * The value to set to the capability or the value of the capability after setting.
      */
-    curValue: number | string;
+    curValue: number | string | object;
     errorCode?: number;
     errorString?: string;
     /**