dwt 17.3.4 → 18.0.2

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

@@ -3,11 +3,11 @@ export interface Camera {
     /**
      * Hide the camera interface.
      */
-    hide(): void;
+    hide(): boolean;
     /**
      * Show the camera interface.
      */
-    show(): void;
+    show(): boolean;
     /**
      * Return a list of all available cameras.
      */
@@ -88,6 +88,18 @@ export interface Camera {
      * Close the camera and hide the video streaming UI.
      */
     closeVideo(): void;
+    /**
+     * Turn on the torch/flashlight.
+     */
+	turnOnTorch(): Promise<void>;
+    /**
+     * Turn off the torch/flashlight.
+     */
+	turnOffTorch(): Promise<void>;
+    /**
+     * Get the camera capabilities. The return type is MediaTrackCapabilities
+     */
+	getCapabilities(): MediaTrackCapabilities;
     /**
      * Specify an event listener for the specified built-in viewer event.
      * @param eventName Specify the event name.
@@ -144,7 +156,7 @@ export interface ScannerViewer {
 		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. 
+	element?: HTMLDivElement | HTMLElement | 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.
@@ -169,6 +181,12 @@ export interface ScannerViewer {
 		valueList?: any;
 		defaultValue?: Resolution; //Set the default value according to the value set in the valueList.
 	};
+	
+	torch?: { //
+		visibility?:string;   //Whether to show torch icon. The allowed values are "visible" and "hidden". The default value is "visible".
+		enableTorch?: boolean;   //Whether to enable torch. The default value is false.
+	};
+	
 	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.
@@ -197,7 +215,7 @@ export interface ScannerViewer {
 
 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. 
+	element?: HTMLDivElement | HTMLElement | 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?:{

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

@@ -1862,4 +1862,18 @@ export namespace DynamsoftEnumsDWT {
 		Single = 0,
 		Multiple = 1
 	}
+	enum EnumDWT_ExtImageInfo {
+		default = 0, 
+        standard = 1, 
+        supported = 2 
+	}
+	enum EnumDWT_DeviceType{
+		TWAINSCANNER = 0x10, 
+		WIATWAINSCANNER = 0x20,
+		TWAINX64SCANNER = 0x40,
+		ICASCANNER = 0x80,
+		SANESCANNER = 0x100,
+		ESCLSCANNER = 0x200,
+		WIFIDIRECTSCANNER = 0x400
+	}	
 }

package/dist/types/Dynamsoft.d.ts

@@ -3,7 +3,7 @@ import { DynamsoftEnumsDWT} from "./Dynamsoft.Enum";
 import { WebTwain } from "./WebTwain";
 import { Settings } from "./Addon.OCRPro";
 import { FileUploader } from "./Dynamsoft.FileUploader";
-
+import { DeviceConfiguration, ServiceInfo, Device, CapabilityDetails, Capabilities} from "./WebTwain.Acquire";
 
 export namespace DynamsoftStatic {
     let Lib: DynamsoftLib;
@@ -26,7 +26,8 @@ export interface DWTInitialConfig {
     WebTwainId: string;
     Host?: string;
     Port?: string;
-    SSLPort?: string;
+    PortSSL?: string;
+	UseLocalService?: boolean;
 }
 export interface DynamsoftLib {
     /**
@@ -218,6 +219,7 @@ export interface DWTPro {
      * Whether to create a WebTwain instance automatically upon page load.
      */
     AutoLoad: boolean;
+	Host: string;
     /**
      * Close a dialog opened by the method ShowDialog.
      */
@@ -357,6 +359,7 @@ export interface DWTPro {
 	handshakeCode?: string;
 	sessionPassword?: string;
 	organizationID?: string;
+	licenseException?: string;
     /**
      * The product name.
      */
@@ -434,6 +437,30 @@ export interface DWTPro {
      * inited, _srcUseLocalService
      */
 	 IfCheckDCP: boolean;
+	 
+	OnLicenseException: () => void;
+    /**
+     * Dynamsoft.DWT.DeviceFriendlyName 
+     */
+	DeviceFriendlyName: string;
+    /**
+     * Bring up the Source Selection User Interface (UI) for the user to choose a data source.
+     * @param serverUrl The URL of the proxy server: https(http)://domain_name:port (default: 443).
+     * @param forceRefresh Default value: false.
+     */
+	FindDynamsoftServiceAsync(serverUrl: string, forceRefresh?: boolean): Promise<ServiceInfo[]>;  
+    /**
+     * Based on serviceInfo, return the existing DWObject if already exists, otherwise, create a new one.
+     * @param serverUrl The proxy server url or the serviceInfo.
+     * @param deviceType The value to filter scanners. Default: TWAINSCANNER
+     * @param forceRefresh Default value: false.
+     */
+	FindDevicesAsync(serverUrl: string | ServiceInfo, deviceType?: DynamsoftEnumsDWT.EnumDWT_DeviceType | number, forceRefresh?: boolean): Promise<Device[]>; 
+    /**
+     * Based on serviceInfo, return the existing object if already exists, otherwise, create a new one.
+     * @param serviceInfo The service information.
+     */
+	CreateRemoteScanObjectAsync(serviceInfo: ServiceInfo): Promise<RemoteScanObject>;
 }
 export interface DisplayInfo {
     loaderBarSource?: string;
@@ -516,6 +543,58 @@ export interface DWTInstall {
 	funcConfirmExitAfterSave?: (firedByDocumentEdit: boolean) => void;
 	funcConfirmCropViewerExit?: (bChanged: boolean, previousViewerName: string) => Promise<Number | DynamsoftEnumsDWT.EnumDWT_ConfirmExitType>;
 	funcConfirmMainViewerExit?: (bChanged: boolean, previousViewerName: string) => Promise<Number | DynamsoftEnumsDWT.EnumDWT_ConfirmExitType>;
+
+    OnLTSConnectionFailure?: (message?: string) => void;
+	OnLTSReturnedAnError?: (message?: string) => void;
+	OnLTSUUIDError?: (message?: string) => void;
+	OnLTSConnectionWarning?: () => void;
+	OnLTSPublicLicenseMessage?: (message?: string) => void;
+}
+export interface RemoteScanObject {
+	/**
+     * Return all available devices (scanners, eSCL scanners, etc.) for the device type (if specified)
+     * @param deviceType The device type
+     * @param refresh Default value: false
+     */
+	getDevices(deviceType?: DynamsoftEnumsDWT.EnumDWT_DeviceType | number, refresh?: boolean): Promise<Device[]>; 
+    /**
+     * Select the device to use for scanning
+     * @param device the device 
+     */
+	selectDevice(device: Device): Promise<boolean>; 
+    /**
+     * Scan documents into another DWObject control. Supports eSCL scanners and all other scanners with limited capabilities.
+     * @param deviceConfiguration The device configuration
+     * @param sendTo The DWObject control to scan into
+     */
+	acquireImage(deviceConfiguration?: DeviceConfiguration, sendTo?: WebTwain): Promise<boolean>; 
+    /**
+     * Close the data source (a TWAIN/ICA/SANE device which in most cases is a scanner) to free it to be used by other applications.
+     */
+	closeSource(): Promise<boolean>; 
+    /**
+     * Bring up the Source Selection User Interface (UI) for the user to choose a data source.
+     * @param deviceType The device type. 
+     */
+	selectSource(deviceType?: DynamsoftEnumsDWT.EnumDWT_DeviceType | number): Promise<number>;
+    /**
+     * Gets detailed information about all capabilities of the current data source.
+     * @argument capabilityDetails Detailed information about the specified capabilities.
+     */
+	getCapabilities():Promise<CapabilityDetails[]>;
+    /**
+     * Sets up one or multiple capabilities in one call.
+     * @param capabilities A object that describes how to set capabilities.
+     */
+	setCapabilities(capabilities: Capabilities): Promise<boolean>;
+    /**
+     * Load a data source to get it ready to acquire images.
+     */
+	openSource():Promise<boolean>;
+    /**
+     * Delete the Remote Scan Object.
+     */
+    dispose(): boolean;
 }
 declare const Dynamsoft: (DWTInstall & typeof DynamsoftStatic);
 //declare const Dynamsoft: (typeof DynamsoftStatic);

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

@@ -1,5 +1,6 @@
 import { DynamsoftEnumsDWT } from "./Dynamsoft.Enum";
 import { WebTwainEdit } from "./WebTwain.Edit";
+import { WebTwain } from "./WebTwain";
 
 export interface WebTwainAcquire extends WebTwainEdit {
     /**
@@ -84,9 +85,10 @@ export interface WebTwainAcquire extends WebTwainEdit {
     ): boolean | void;
     /**
      * 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
      */
-    SelectSourceAsync(
-    ): Promise<boolean>;
+    SelectSourceAsync(deviceType?: DynamsoftEnumsDWT.EnumDWT_DeviceType | number
+    ): Promise<number>;
     /**
      * Select a data source by its index.
      * @param index The index of the data source.
@@ -97,6 +99,22 @@ export interface WebTwainAcquire extends WebTwainEdit {
      * @param index The index of the data source.
      */
     SelectSourceByIndexAsync(index: number): Promise<boolean>;
+    /**
+     * Return all available devices (scanners, eSCL scanners, etc.) for the device type (if specified)
+     * @param deviceType The device type
+     * @param refresh Default value: false
+     */
+	GetDevicesAsync(deviceType?: DynamsoftEnumsDWT.EnumDWT_DeviceType | number, refresh?: boolean): Promise<Device[]>;
+    /**
+     * Select the device to use for scanning
+     * @param device the device 
+     */
+	SelectDeviceAsync(device: Device): Promise< boolean>;
+    /**
+     * Scan documents into another DWObject control. eSCL is not supported.
+     * @param deviceConfiguration The device configuration
+     */
+	AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;
     /**
      * Sets a timer which stops the data source opening process once it expires.
      * @param duration Define the duration of the timer (in milliseconds).
@@ -635,6 +653,10 @@ export interface DeviceConfiguration {
      * Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true.
      */
     IfDisableSourceAfterAcquire?: boolean;
+    /**
+     * Whether to close source after aquisition.
+     */
+	IfCloseSourceAfterAcquire?:boolean;
     /**
      * Whether to retrieve information about the image after it's transferred.
      */
@@ -646,7 +668,7 @@ export interface DeviceConfiguration {
     /**
      * How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true.
      */
-    extendedImageInfoQueryLevel?: number;
+    extendedImageInfoQueryLevel?: DynamsoftEnumsDWT.EnumDWT_ExtImageInfo | number;
 	 /**
      * Whether to simulate the manufacturer's UI inside the client-side browser (only effective when IfShowUI is true).
      * (Added in 16.2)
@@ -1067,3 +1089,15 @@ export interface CapabilitySetup {
      */
     exception?: string;
 }
+export interface ServiceInfo {
+	server: string; // same to serverUrl, user input
+	attrs?: any;
+}
+export interface Device {
+	name: string; 
+	displayName: string; 
+	deviceType: DynamsoftEnumsDWT.EnumDWT_DeviceType;
+	serviceInfo?: ServiceInfo;
+	deviceInfo?: any;
+	acquireImage(deviceConfiguration: DeviceConfiguration | null, sendTo: WebTwain): Promise< boolean>;
+}

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

@@ -67,6 +67,10 @@ export interface WebTwainViewer extends WebTwainAcquire {
      */
     Zoom: number;
     Viewer: DynamsoftViewer;
+     /**
+     * Delete the web-twain Object.
+     */
+	dispose(): Promise<void>;
 }
 export interface DynamsoftViewer {
     /**
@@ -233,7 +237,7 @@ export interface DynamsoftViewer {
      * [Scope] Main viewer
      * [Description] Refresh the viewer, the effect is shown in "onPageRender" event
      */
-    render(): void;
+    render(): boolean;
     /**
      * [Scope] Global
      * [Description] Create an image editor with specified settings.
@@ -255,7 +259,7 @@ export interface DynamsoftViewer {
      * @param location Whether to put the element in the main viewer. Allowed values are left, top, right, bottom.
      * @param ifFull Whether to display the element in full screen.
      */
-    createCustomElement(element: HTMLDivElement, location?: string, ifFull?: boolean): CustomElement;
+    createCustomElement(element: HTMLDivElement | HTMLElement, location?: string, ifFull?: boolean): CustomElement;
 	/**
      * [Scope] Global
      * [Description] Create a document editor with specified settings.
@@ -337,17 +341,17 @@ export interface DynamsoftViewer {
      * [Description] Create a Dynamsoft Viewer instance and bind it to the WebTwain instance.
      * @param element Specify an HTML element to create the viewer.
      */
-    bind(element: HTMLDivElement, documentViewerTemplate?: DocumentViewerTemplate): boolean;
+    bind(element: HTMLDivElement | HTMLElement, documentViewerTemplate?: DocumentViewerTemplate): boolean;
     /**
      * [Scope] Main viewer
      * [Description] Show the viewer (Main viewer, ImageEditor, ThumbnailViewer, CustomElement).
      */
-    show(): void;
+    show(): boolean;
     /**
      * [Scope] Main viewer
      * [Description] Hide the viewer(Main viewer, ImageEditor, ThumbnailViewer, CustomElement).
      */
-    hide(): void;
+    hide(): boolean;
     /**
      * [Scope] Main viewer
      * [Description] Unbind the viewer.
@@ -374,7 +378,7 @@ export interface EditorSettings {
      * [Scope] ImageEditor viewer
      * [Description] Specify an HTML Element.
      */
-    element?: HTMLDivElement;
+    element?: HTMLDivElement | HTMLElement;
     /**
      * [Scope] ImageEditor viewer
      * [Description] The width of the image editor viewer. The default value is "100%".
@@ -581,17 +585,17 @@ export interface CustomElement {
      * [Scope] Current Element
      * [Description] Show the element.
      */
-    show(): void;
+    show(): boolean;
     /**
      * [Scope] Current Element
      * [Description] Hide the element.
      */
-    hide(): void;
+    hide(): boolean;
     /**
      * [Scope] Current Element
      * [Description] Delete the element.
      */
-    dispose(): void;
+    dispose(): boolean;
 	
 	element?: any;
 }
@@ -600,12 +604,12 @@ export interface ImageEditor {
      * [Scope] ImageEditor viewer
      * [Description] Show the ImageEditor viewer.
      */
-    show(): void;
+    show(): boolean;
     /**
      * [Scope] ImageEditor viewer
      * [Description] Hide the ImageEditor viewer.
      */
-    hide(): void;
+    hide(): boolean;
     /**
      * [Scope] ImageEditor viewer
      * [Description] Delete the ImageEditor viewer.
@@ -617,17 +621,17 @@ export interface ThumbnailViewer {
      * [Scope] Thumbnail viewer
      * [Description] Show the Thumbnail viewer.
      */
-    show(): void;
+    show(): boolean;
     /**
      * [Scope] Thumbnail viewer
      * [Description] Hide the Thumbnail viewer.
      */
-    hide(): void;
+    hide(): boolean;
     /**
      * [Scope] Thumbnail viewer
      * [Description] Delete the Thumbnail viewer.
      */
-    dispose(): void;
+    dispose(): boolean;
     /**
      * [Scope] Thumbnail viewer
      * [Description] Set the view mode.
@@ -788,17 +792,17 @@ export interface DocumentEditor {
      * [Scope] DocumentEditor viewer
      * [Description] Show the DocumentEditor viewer.
      */
-    show(): void;
+    show(): boolean;
     /**
      * [Scope] DocumentEditor viewer
      * [Description] Hide the DocumentEditor viewer.
      */
-    hide(): void;
+    hide(): boolean;
     /**
      * [Scope] DocumentEditor viewer
      * [Description] Delete the DocumentEditor viewer.
      */
-    dispose(): void;
+    dispose(): boolean;
 }
 
 export interface ViewMode {

package/dist/types/index.d.ts

@@ -14,7 +14,7 @@
 *
 * Copyright 2022, Dynamsoft Corporation
 * Author: Dynamsoft Support Team
-* Version: 17.3
+* Version: 18.0.2
 */
 import Dynamsoft from "./Dynamsoft";
 export default Dynamsoft;

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "dwt",
-    "version": "17.3.4",
+    "version": "18.0.2",
     "author": {
         "name": "Dynamsoft",
         "url": "https://www.dynamsoft.com"
     },
     "license": "SEE LICENSE IN LICENSE.txt",
     "dependencies": {
-        "dynamsoft-javascript-barcode": "8.8.7"
+        "dynamsoft-javascript-barcode": "9.2.13"
     },
     "description": "Dynamic Web TWAIN is a TWAIN/ICA/SANE-based scanning SDK software specifically designed for web applications running on Windows/macOS/Linux. With just a few lines of code, you can develop robust applications to scan documents from TWAIN/ICA/SANE-compatible scanners, edit the scanned images and save them to a local/server file system or document repository.",
     "devDependencies": {},