dwt 19.0.0 → 19.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -42,7 +42,7 @@ export interface TextResult {
42
42
  */
43
43
  barcodeFormat: DynamsoftEnumsDBR.EnumBarcodeFormat | number;
44
44
  /**
45
- * Extra barcde formats.
45
+ * Extra barcode formats.
46
46
  */
47
47
  barcodeFormat_2: DynamsoftEnumsDBR.EnumBarcodeFormat_2 | number;
48
48
  /**
@@ -70,7 +70,7 @@ export interface Webcam {
70
70
  * Set the specified camera property.
71
71
  * @param property Specify the property.
72
72
  * @param value Specify the value.
73
- * @param auto Specify whether the propery should change automatically.
73
+ * @param auto Specify whether the property should change automatically.
74
74
  */
75
75
  SetCameraControlPropertySetting(
76
76
  property: DynamsoftEnumsDWT.EnumDWT_CameraControlProperty | number,
@@ -95,7 +95,7 @@ export interface Webcam {
95
95
  * Set the specified video property.
96
96
  * @param property Specify the property.
97
97
  * @param value Specify the value.
98
- * @param auto Specify whether the propery should change automatically.
98
+ * @param auto Specify whether the property should change automatically.
99
99
  */
100
100
  SetVideoPropertySetting(
101
101
  property: DynamsoftEnumsDWT.EnumDWT_VideoProperty | number,
@@ -197,7 +197,7 @@ export interface VideoControlProperty {
197
197
  */
198
198
  GetValue(): number;
199
199
  /**
200
- * Return whether the property is set autmatically or not.
200
+ * Return whether the property is set automatically or not.
201
201
  */
202
202
  GetIfAuto(): boolean;
203
203
  }
@@ -219,7 +219,7 @@ export interface VideoControlPropertyExtra {
219
219
  */
220
220
  GetSteppingDelta(): number;
221
221
  /**
222
- * Return whether the property is set autmatically or not.
222
+ * Return whether the property is set automatically or not.
223
223
  */
224
224
  GetIfAuto(): boolean;
225
225
  }
@@ -229,7 +229,7 @@ export interface CameraControlProperty {
229
229
  */
230
230
  GetValue(): number;
231
231
  /**
232
- * Return whether the property is set autmatically or not.
232
+ * Return whether the property is set automatically or not.
233
233
  */
234
234
  GetIfAuto(): boolean;
235
235
  }
@@ -251,7 +251,7 @@ export interface CameraControlPropertyExtra {
251
251
  */
252
252
  GetSteppingDelta(): number;
253
253
  /**
254
- * Return whether the property is set autmatically or not.
254
+ * Return whether the property is set automatically or not.
255
255
  */
256
256
  GetIfAuto(): boolean;
257
257
  }
@@ -276,12 +276,12 @@ export interface DWTPro {
276
276
  */
277
277
  DeleteDWTObject(Id: string): boolean;
278
278
  /**
279
- * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returnd.
279
+ * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returned.
280
280
  * @param ContainerIdOrWebTwainId The ContainerId or WebTwainId.
281
281
  */
282
282
  GetWebTwain(ContainerIdOrWebTwainId?: string): WebTwain;
283
283
  /**
284
- * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returnd.
284
+ * Return the WebTwain instance specified by its ContainerId or WebTwainId. If no parameter is provided, the first valid WebTwain instance is returned.
285
285
  * @param ContainerIdOrWebTwainId The ContainerId or WebTwainId.
286
286
  */
287
287
  GetWebTwainEx(ContainerIdOrWebTwainId?: string): WebTwain;
@@ -56,15 +56,15 @@ export interface RemoteScanObject {
56
56
  /**
57
57
  * @param forceRefresh Default value: false.
58
58
  */
59
- getDynamsoftService(forceRefresh?: boolean): Promise<ServiceInfo[]>;
59
+ getServices(forceRefresh?: boolean): Promise<ServiceInfo[]>;
60
60
  /**
61
61
  * Set the default dynamsoftService for storing the data
62
62
  */
63
- setDefaultDynamsoftService(serviceInfo:ServiceInfo):Promise<void>;
63
+ setDefaultService(serviceInfo:ServiceInfo):Promise<void>;
64
64
  /**
65
65
  * Get the default dynamsoftService.
66
66
  */
67
- getDefaultDynamsoftService():ServiceInfo|null;
67
+ getDefaultService():ServiceInfo|null;
68
68
  /**
69
69
  * Get image(s) form dynamsoftService.
70
70
  * @param indices Specify the image(s).
@@ -355,6 +355,10 @@ export interface WebTwainAcquire extends WebTwainEdit {
355
355
  * Return the value of the top edge of the current image frame (in Unit).
356
356
  */
357
357
  readonly ImageLayoutFrameTop: number;
358
+ /**
359
+ * Return the frame number of the current image.
360
+ */
361
+ readonly ImageLayoutFrameNumber: number;
358
362
  /**
359
363
  * Return the document number of the current image.
360
364
  */
@@ -689,11 +693,11 @@ export interface DeviceConfiguration {
689
693
  */
690
694
  IfDuplexEnabled?: boolean;
691
695
  /**
692
- * Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true.
696
+ * Whether to close the built-in User Interface after acquisition. Only valid when {IfShowUI} is true.
693
697
  */
694
698
  IfDisableSourceAfterAcquire?: boolean;
695
699
  /**
696
- * Whether to close source after aquisition.
700
+ * Whether to close source after acquisition.
697
701
  */
698
702
  IfCloseSourceAfterAcquire?:boolean;
699
703
  /**
@@ -771,7 +775,7 @@ export interface ScanSetup {
771
775
  */
772
776
  setupId?: string;
773
777
  /**
774
- * Whether to ignore or fail the acquistion when an exception is raised. Set "ignore" or "fail".
778
+ * Whether to ignore or fail the acquisition when an exception is raised. Set "ignore" or "fail".
775
779
  */
776
780
  exception?: string;
777
781
  /**
@@ -32,6 +32,10 @@ export interface WebTwainBuffer extends WebTwainIO {
32
32
  * @param tag The tag used as the filter.
33
33
  */
34
34
  FilterImagesByTag(tag: string): boolean;
35
+ /**
36
+ * Stop filtering images by tag.
37
+ */
38
+ ClearFilter(): boolean;
35
39
  /**
36
40
  * Return the pixel bit depth of the specified image.
37
41
  * @param index Specify the image.
@@ -28,7 +28,7 @@ export interface WebTwainEdit extends WebTwainBuffer {
28
28
  * @param index Specify the image.
29
29
  * @param value Specify the value of contrast.
30
30
  */
31
- ChangeContrastAsnyc(
31
+ ChangeContrastAsync(
32
32
  index: number,
33
33
  value: number
34
34
  ): Promise<boolean>;
@@ -165,14 +165,14 @@ export interface WebTwainEdit extends WebTwainBuffer {
165
165
  ) => void
166
166
  ): void;
167
167
  /**
168
- * Invert the colour of the pixels on the specified image.
168
+ * Invert the color of the pixels on the specified image.
169
169
  * @param index Specify the image.
170
170
  */
171
171
  Invert(
172
172
  index: number
173
173
  ): boolean;
174
174
  /**
175
- * Invert the colour of the pixels on the specified image.
175
+ * Invert the color of the pixels on the specified image.
176
176
  * @param index Specify the image.
177
177
  * @param successCallback A callback function that is executed if the request succeeds.
178
178
  * @param failureCallback A callback function that is executed if the request fails.
@@ -499,7 +499,7 @@ export interface WebTwainEdit extends WebTwainBuffer {
499
499
  bottom: number
500
500
  ): boolean;
501
501
  /**
502
- * Return or set the fill colour for the empty area on an image that has been cut/cropped/erased.
502
+ * Return or set the fill color for the empty area on an image that has been cut/cropped/erased.
503
503
  */
504
504
  BackgroundFillColor: number;
505
505
  /**
@@ -499,7 +499,7 @@ export interface WebTwainIO extends WebTwainUtil {
499
499
  * Upload the specified image via a HTTP Post request.
500
500
  * @param host The HTTP Host.
501
501
  * @param index Specify the image.
502
- * @param target The target wherethe request is sent.
502
+ * @param target The target where the request is sent.
503
503
  * @param type The format of the file.
504
504
  * @param fileName The file name.
505
505
  * @param onEmptyResponse A callback function that is executed if the response is empty.
@@ -523,7 +523,7 @@ export interface WebTwainIO extends WebTwainUtil {
523
523
  * Upload the specified image via a HTTP Post request.
524
524
  * @param host The HTTP Host.
525
525
  * @param index Specify the image.
526
- * @param target The target wherethe request is sent.
526
+ * @param target The target where the request is sent.
527
527
  * @param fileName The file name.
528
528
  * @param type The format of the file.
529
529
  * @param onEmptyResponse A callback function that is executed if the response is empty.
@@ -547,7 +547,7 @@ export interface WebTwainIO extends WebTwainUtil {
547
547
  /**
548
548
  * Upload all images in the buffer as a TIFF file via a HTTP Post request.
549
549
  * @param host The HTTP Host.
550
- * @param target The target wherethe request is sent.
550
+ * @param target The target where the request is sent.
551
551
  * @param fileName The file name.
552
552
  * @param onEmptyResponse A callback function that is executed if the response is empty.
553
553
  * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -568,7 +568,7 @@ export interface WebTwainIO extends WebTwainUtil {
568
568
  /**
569
569
  * Upload all images in the buffer as a PDF file via a HTTP Post request.
570
570
  * @param host The HTTP Host.
571
- * @param target The target wherethe request is sent.
571
+ * @param target The target where the request is sent.
572
572
  * @param fileName The file name.
573
573
  * @param onEmptyResponse A callback function that is executed if the response is empty.
574
574
  * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -589,7 +589,7 @@ export interface WebTwainIO extends WebTwainUtil {
589
589
  /**
590
590
  * Upload all selected images in the buffer as a PDF file via a HTTP Post request.
591
591
  * @param host The HTTP Host.
592
- * @param target The target wherethe request is sent.
592
+ * @param target The target where the request is sent.
593
593
  * @param fileName The file name.
594
594
  * @param onEmptyResponse A callback function that is executed if the response is empty.
595
595
  * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -610,7 +610,7 @@ export interface WebTwainIO extends WebTwainUtil {
610
610
  /**
611
611
  * Upload all selected images in the buffer as a TIFF file via a HTTP Post request.
612
612
  * @param host The HTTP Host.
613
- * @param target The target wherethe request is sent.
613
+ * @param target The target where the request is sent.
614
614
  * @param fileName The file name.
615
615
  * @param onEmptyResponse A callback function that is executed if the response is empty.
616
616
  * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -632,7 +632,7 @@ export interface WebTwainIO extends WebTwainUtil {
632
632
  * Upload the specified file via a HTTP Post request.
633
633
  * @param host The HTTP Host.
634
634
  * @param path Specify the file to upload.
635
- * @param target The target wherethe request is sent.
635
+ * @param target The target where the request is sent.
636
636
  * @param fileName The file name.
637
637
  * @param onEmptyResponse A callback function that is executed if the response is empty.
638
638
  * @param onServerReturnedSomething A callback function that is executed if the response is not empty.
@@ -35,7 +35,7 @@ export interface WebTwainUtil {
35
35
  */
36
36
  readonly ProductName: string;
37
37
  /**
38
- * Generate a URL to be used by a FileUpoader instance to fetch the data to upload.
38
+ * Generate a URL to be used by a FileUploader instance to fetch the data to upload.
39
39
  * @param indices Specify the images to upload.
40
40
  * @param type Specify the file type.
41
41
  * @param successCallback A callback function that is executed if the request succeeds.
@@ -17,12 +17,12 @@ export interface WebTwainViewer extends WebTwainAcquire {
17
17
  UnbindViewer(): boolean;
18
18
  /**
19
19
  * @deprecated since version 16.2. This property will be removed in future versions. Use `Viewer.background` instead.
20
- * Return or set the background colour of the viewer.
20
+ * Return or set the background color of the viewer.
21
21
  */
22
22
  BackgroundColor: number;
23
23
  /**
24
24
  * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.selectedPageBorder` instead.
25
- * Return or set the border colour for selected image(s).
25
+ * Return or set the border color for selected image(s).
26
26
  */
27
27
  SelectionImageBorderColor: number;
28
28
  /**
@@ -32,7 +32,7 @@ export interface WebTwainViewer extends WebTwainAcquire {
32
32
  FitWindowType: number;
33
33
  /**
34
34
  * @deprecated since version 16.2. This property will be removed in future versions. Use function `Viewer.fitWindow` instead.
35
- * Return or set the border colour for selected image(s).
35
+ * Return or set the border color for selected image(s).
36
36
  */
37
37
  IfFitWindow: boolean;
38
38
  /**
@@ -101,7 +101,7 @@ export interface DynamsoftViewer {
101
101
  readonly idPostfix: string;
102
102
  /**
103
103
  * [Scope] Main viewer
104
- * [Description] Return or set the background colour/image of the viewer.
104
+ * [Description] Return or set the background color/image of the viewer.
105
105
  * [Usage Notes] 'Invalid property value' is reported when the set value does not meet the CSS standard.
106
106
  * Replace the previous `BackgroundColor` method.
107
107
  * Allow any CSS rules
@@ -233,9 +233,9 @@ export interface DynamsoftViewer {
233
233
  y: string; //Default is "center", values: "top", "bottom", "center"
234
234
  }
235
235
  /**
236
- * Whether the viewer removes the focus border after selecting with the Tab key. Default value: true.
236
+ * Whether the viewer displays the focus border after selecting with the Tab key. Default value: false.
237
237
  */
238
- disableFocusOutline: boolean; // default value: true
238
+ focusOutlineEnabled: boolean; // default value: false
239
239
  /**
240
240
  * [Scope] Main viewer
241
241
  * [Description] Return the index of the next image of the currently selected image.
@@ -357,6 +357,10 @@ export interface DynamsoftViewer {
357
357
  columns: number,
358
358
  rows: number
359
359
  ): boolean;
360
+ /**
361
+ * Return the info of visible pages. It is useful to add elements to document page images in the viewer.
362
+ */
363
+ getVisiblePagesInfo(): VisiblePageInfo[];
360
364
  /**
361
365
  * [Scope] Global
362
366
  * [Description] Create a Dynamsoft Viewer instance and bind it to the WebTwain instance.
@@ -561,7 +565,7 @@ export interface ThumbnailViewerSettings {
561
565
  autoChangeIndex?: boolean;
562
566
  /**
563
567
  * [Scope] Thumbnail viewer
564
- * [Description] Return or set the background colour/image of the thumbnail viewer. The default value is white.
568
+ * [Description] Return or set the background color/image of the thumbnail viewer. The default value is white.
565
569
  * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
566
570
  * Allow any CSS rules
567
571
  */
@@ -660,7 +664,7 @@ export interface ImageEditor {
660
664
  };
661
665
  /**
662
666
  * [Scope] ImageEditor viewer
663
- * Set the selction box styling.
667
+ * Set the selection box styling.
664
668
  * @argument selectionBoxStyleSettings Settings for selection box.
665
669
  */
666
670
  updateSelectionBoxStyle(selectionBoxStyleSettings?: SelectionBoxStyleSettings): boolean;
@@ -698,6 +702,10 @@ export interface ThumbnailViewer {
698
702
  * @argument pageNumberSettings Settings for page numbers.
699
703
  */
700
704
  updatePageNumberStyle(pageNumberSettings?: PageNumberSettings): void;
705
+ /**
706
+ * Return the info of visible pages. It is useful to add elements to document page images in the viewer.
707
+ */
708
+ getVisiblePagesInfo(): VisiblePageInfo[];
701
709
  /**
702
710
  * [Scope] Thumbnail viewer
703
711
  * [Description] Specify an event listener for the viewer event.
@@ -790,7 +798,7 @@ export interface ThumbnailViewer {
790
798
  autoChangeIndex: boolean;
791
799
  /**
792
800
  * [Scope] Thumbnail viewer
793
- * [Description] Return or set the background colour/image of the thumbnail viewer. The default value is white.
801
+ * [Description] Return or set the background color/image of the thumbnail viewer. The default value is white.
794
802
  * [Usage Notes] 'Invalid property value' will be reported when the specified value type is wrong or the parameter name is spelled incorrectly.
795
803
  * Allow any CSS rules
796
804
  */
@@ -884,6 +892,48 @@ export interface ViewerEvent {
884
892
  */
885
893
  pageY: number;
886
894
  }
895
+ /**
896
+ * Info of a visible page.
897
+ */
898
+ export interface VisiblePageInfo {
899
+ /**
900
+ * The index of the document page.
901
+ */
902
+ pageIndex: number;
903
+ /**
904
+ * Whether the mouse is hovering over the document page.
905
+ */
906
+ isHovered: boolean;
907
+ /**
908
+ * Whether the document page is selected.
909
+ */
910
+ isSelected: boolean;
911
+ /**
912
+ * The width of the document page image container.
913
+ */
914
+ pageWidth: number;
915
+ /**
916
+ * The height of the document page image container.
917
+ */
918
+ pageHeight: number;
919
+ /**
920
+ * The x coordinate relative to the canvas.
921
+ */
922
+ canvasOffsetX: number;
923
+ /**
924
+ * The y coordinate relative to the canvas.
925
+ */
926
+ canvasOffsetY: number;
927
+ /**
928
+ * The x coordinate relative to the container of the viewer.
929
+ */
930
+ containerOffsetX: number;
931
+ /**
932
+ * The y coordinate relative to the container of the viewer.
933
+ */
934
+ containerOffsetY: number;
935
+ }
936
+
887
937
  export interface ThumbnailViewerEvent {
888
938
  /**
889
939
  * The index of the current document page.
@@ -980,10 +1030,10 @@ export interface PageNumberSettings {
980
1030
  translateY?: number | string; //default: "", number unit: px, string value: "10px"/"10%", relative to itself
981
1031
  }
982
1032
  export interface SelectionBoxStyleSettings {
983
- borderColor?: string; //Default: rgba(0,0,0,1). Colour in "rgba(r, g, b, a)"
1033
+ borderColor?: string; //Default: rgba(0,0,0,1). Color in "rgba(r, g, b, a)"
984
1034
  borderWidth?: number; //Default: 1. Pixels. Width of individual pattern segments.
985
1035
  lineDash?: [number,number]; //Default: [5,2]. Pixels. Line spacing where x is shaded pixels and y is gap in pixels.
986
1036
  handleWidth?: number; //Default: 9. Pixels.
987
1037
  handleHeight?: number; //Default: 9. Pixels
988
- handleColor?: string; //Default: rgba(0,0,0,1). Colour in "rgba(r, g, b, a)"
1038
+ handleColor?: string; //Default: rgba(0,0,0,1). Color in "rgba(r, g, b, a)"
989
1039
  }
@@ -1,9 +1,4 @@
1
1
  // Project: https://www.dynamsoft.com/products/webtwain_overview.aspx
2
- // Definitions by: Xiao Ling <https://github.com/yushulx>
3
- // Josh Hall <https://github.com/jbh>
4
- // Lincoln Hu <https://github.com/lincoln2018>
5
- // Tom Kent <https://github.com/Tom-Dynamsoft>
6
- // Dave Sueltenfuss <https://github.com/dsueltenfuss>
7
2
  // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
8
3
  // TypeScript Version: 3.1
9
4
 
@@ -13,7 +8,7 @@
13
8
  *
14
9
  * Copyright 2025, Dynamsoft Corporation
15
10
  * Author: Dynamsoft Support Team
16
- * Version: 19.0
11
+ * Version: 19.2
17
12
  */
18
13
  import Dynamsoft from "./Dynamsoft";
19
14
  export default Dynamsoft;
package/dwt-openapi.yaml CHANGED
@@ -2,7 +2,7 @@ openapi: 3.0.1
2
2
  info:
3
3
  title: DWT
4
4
  description: ''
5
- version: 1.0.0
5
+ version: '20250428'
6
6
  tags:
7
7
  - name: Server Control
8
8
  - name: Scanner Control
@@ -114,12 +114,12 @@ paths:
114
114
  version:
115
115
  type: string
116
116
  description: server API version.
117
- examples:
117
+ example:
118
118
  - '20240719'
119
119
  compatible:
120
120
  type: boolean
121
121
  description: server is compatible with the client.
122
- examples:
122
+ example:
123
123
  - true
124
124
  headers: {}
125
125
  '405':
@@ -151,7 +151,7 @@ paths:
151
151
  schema: &ref_2
152
152
  $ref: '#/components/schemas/ScannerType'
153
153
  description: one value of ScannerType
154
- examples:
154
+ example:
155
155
  - 16
156
156
  responses:
157
157
  '200':
@@ -209,7 +209,7 @@ paths:
209
209
  tags:
210
210
  - Scanner Control
211
211
  parameters:
212
- - name: X-DICS-LICENSE-KEY
212
+ - name: DWT-PRODUCT-KEY
213
213
  in: header
214
214
  description: Product key
215
215
  required: true
@@ -933,7 +933,7 @@ paths:
933
933
  example: ''
934
934
  schema:
935
935
  type: string
936
- - name: X-DICS-DOC-PASSWORD
936
+ - name: DWT-DOC-PASSWORD
937
937
  in: header
938
938
  description: the password of document in storage
939
939
  required: false
@@ -1010,7 +1010,7 @@ paths:
1010
1010
  example: ''
1011
1011
  schema:
1012
1012
  type: string
1013
- - name: X-DICS-DOC-PASSWORD
1013
+ - name: DWT-DOC-PASSWORD
1014
1014
  in: header
1015
1015
  description: the password of document in storage
1016
1016
  required: false
@@ -1252,7 +1252,7 @@ paths:
1252
1252
  externalDocs:
1253
1253
  url: >-
1254
1254
  https://www.dynamsoft.com/web-twain/docs/info//api/interfaces.html#pdfwsettings
1255
- - name: X-DICS-DOC-PASSWORD
1255
+ - name: DWT-DOC-PASSWORD
1256
1256
  in: header
1257
1257
  description: the password of document in storage
1258
1258
  required: false
@@ -1356,7 +1356,7 @@ paths:
1356
1356
  example: ''
1357
1357
  schema:
1358
1358
  type: string
1359
- - name: X-DICS-DOC-PASSWORD
1359
+ - name: DWT-DOC-PASSWORD
1360
1360
  in: header
1361
1361
  description: the password of document in storage
1362
1362
  required: false
@@ -1382,7 +1382,7 @@ paths:
1382
1382
  source:
1383
1383
  oneOf:
1384
1384
  - type: string
1385
- examples:
1385
+ example:
1386
1386
  - >-
1387
1387
  https://127.0.0.1:18623/api/device/scanners/jobs/dd40716d-48d1-4d32-89f7-1d53f9665d91/next-page?page=19522d0c5282
1388
1388
  description: >-
@@ -1465,7 +1465,7 @@ paths:
1465
1465
  example: ''
1466
1466
  schema:
1467
1467
  type: string
1468
- - name: X-DICS-DOC-PASSWORD
1468
+ - name: DWT-DOC-PASSWORD
1469
1469
  in: header
1470
1470
  description: the password of document in storage
1471
1471
  required: false
@@ -1541,14 +1541,14 @@ paths:
1541
1541
  currently only process DWT urls, so we cannot pass index,
1542
1542
  only has one page. read-barcode can accept a barcode reader
1543
1543
  template settings. and need to pass extra license with header
1544
- X-DICS-LICENSE-KEY. check-blank can accept null or
1544
+ DWT-PRODUCT-KEY. check-blank can accept null or
1545
1545
  {minBlockHeight?: number, maxBlockHeight?: number}. rotate can
1546
1546
  accept {rotation: number, keepSize?: boolean}.
1547
1547
  calculate-skew-angle can accept null.
1548
1548
  enum:
1549
1549
  - check-blank
1550
1550
  - read-barcode
1551
- - name: X-DICS-LICENSE-KEY
1551
+ - name: DWT-PRODUCT-KEY
1552
1552
  in: header
1553
1553
  description: the license for image processing
1554
1554
  required: false
@@ -4129,7 +4129,7 @@ components:
4129
4129
  message:
4130
4130
  type: string
4131
4131
  description: system error string of the code.
4132
- examples:
4132
+ example:
4133
4133
  - cause:
4134
4134
  code: 3
4135
4135
  message: The system cannot find the path specified.
@@ -4144,7 +4144,7 @@ components:
4144
4144
  url: >-
4145
4145
  https://www.dynamsoft.com/web-twain/docs/info/api/Interfaces.html#outputinfo
4146
4146
  properties: {}
4147
- examples:
4147
+ example:
4148
4148
  - extendedImageInfo: {}
4149
4149
  imageId: 1
4150
4150
  imageInfo:
@@ -4194,7 +4194,7 @@ components:
4194
4194
  * 0x200 ESCLSCANNER
4195
4195
  * 0x400 WIFIDIRECTSCANNER
4196
4196
  * 0x800 WIATWAINSCANNER
4197
- examples:
4197
+ example:
4198
4198
  - 16
4199
4199
  Scanner:
4200
4200
  type: object
@@ -4204,13 +4204,13 @@ components:
4204
4204
  name:
4205
4205
  type: string
4206
4206
  description: Scanner name
4207
- examples:
4207
+ example:
4208
4208
  - TWAIN2 FreeImage Software Scanner
4209
4209
  type: *ref_2
4210
4210
  device:
4211
4211
  type: string
4212
4212
  description: A json string of the scanner details.
4213
- examples:
4213
+ example:
4214
4214
  - >-
4215
4215
  {"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"}
4216
4216
  required:
@@ -4229,6 +4229,11 @@ components:
4229
4229
  will be locked, if the scanner is a twain source, the source will be
4230
4230
  opened automatically. Recommend to set it as false, avoid your
4231
4231
  papers may be scanned by others.
4232
+ requestFocusForScanningUI:
4233
+ type: boolean
4234
+ default: true
4235
+ description: >-
4236
+ If true, the scanner UI will be brought to the top and get focus.
4232
4237
  scannerFailureTimeout:
4233
4238
  type: integer
4234
4239
  format: int32
@@ -4284,7 +4289,7 @@ components:
4284
4289
  to detect the feeder is loaded, if the driver is supported, it can
4285
4290
  work, otherwise it may be not right. (ICA not sure)
4286
4291
  default: false
4287
- examples:
4292
+ example:
4288
4293
  - autoRun: false
4289
4294
  device: >-
4290
4295
  {"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 +4316,7 @@ components:
4311
4316
  properties:
4312
4317
  jobuid:
4313
4318
  type: string
4314
- examples:
4319
+ example:
4315
4320
  - B3701DC5-86D3-44B6-A8A1-FF0B5D43FD86
4316
4321
  status:
4317
4322
  type: string
@@ -4339,7 +4344,7 @@ components:
4339
4344
  properties:
4340
4345
  uid:
4341
4346
  type: string
4342
- examples:
4347
+ example:
4343
4348
  - 190817548d70
4344
4349
  description: page uid
4345
4350
  required:
@@ -4350,7 +4355,7 @@ components:
4350
4355
  properties:
4351
4356
  uid:
4352
4357
  type: string
4353
- examples:
4358
+ example:
4354
4359
  - 190807444d76
4355
4360
  description: document uid
4356
4361
  pages:
@@ -4371,7 +4376,7 @@ components:
4371
4376
  type: integer
4372
4377
  format: int32
4373
4378
  description: 0 is disabled, 30 is verbos, 1 is debug + info + error.
4374
- examples:
4379
+ example:
4375
4380
  - 1
4376
4381
  ServerSettings:
4377
4382
  type: object
@@ -4381,7 +4386,7 @@ components:
4381
4386
  type: integer
4382
4387
  format: int32
4383
4388
  description: 0 is disabled, 30 is verbos, 1 is debug + info + error
4384
- examples:
4389
+ example:
4385
4390
  - 1
4386
4391
  required:
4387
4392
  - logLevel
@@ -4399,7 +4404,7 @@ components:
4399
4404
  settings:
4400
4405
  oneOf:
4401
4406
  - type: object
4402
- examples:
4407
+ example:
4403
4408
  - minBlockHeight: 20
4404
4409
  maxBlockHeight: 30
4405
4410
  - ImageParameter:
@@ -4449,7 +4454,7 @@ components:
4449
4454
  oneOf:
4450
4455
  - type: string
4451
4456
  description: DWT image url. If it's DWT image url, we should think cors.
4452
- examples:
4457
+ example:
4453
4458
  - >-
4454
4459
  https://127.0.0.1:18623/api/device/scanners/jobs/dd40716d-48d1-4d32-89f7-1d53f9665d91/next-page?page=19522d0c5282
4455
4460
  required:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dwt",
3
- "version": "19.0.0",
3
+ "version": "19.2.0",
4
4
  "author": {
5
5
  "name": "Dynamsoft",
6
6
  "url": "https://www.dynamsoft.com"