scanbot-web-sdk 5.0.1-beta.2 → 6.0.0-alpha.1

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.
Files changed (180) hide show
  1. package/@types/barcode-scanner-view.d.ts +11 -10
  2. package/@types/core/compiled/ParametricFilters.d.ts +1 -1
  3. package/@types/core/utils.d.ts +1 -0
  4. package/@types/core/worker-bridge.d.ts +1 -0
  5. package/@types/cropping-view.d.ts +1 -1
  6. package/@types/document-scanner-view.d.ts +2 -3
  7. package/@types/index.d.ts +5 -3
  8. package/@types/model/barcode/barcode-format.d.ts +1 -1
  9. package/@types/model/barcode/engine-mode.d.ts +1 -1
  10. package/@types/model/camera-info.d.ts +1 -1
  11. package/@types/model/configuration/barcode-scanner-configuration.d.ts +6 -5
  12. package/@types/model/configuration/base-configuration.d.ts +4 -5
  13. package/@types/model/configuration/initialization-options.d.ts +14 -3
  14. package/@types/model/configuration/mrz-scanner-configuration.d.ts +2 -4
  15. package/@types/model/configuration/scanner-configuration.d.ts +3 -1
  16. package/@types/model/configuration/selection-overlay-configuration.d.ts +7 -1
  17. package/@types/model/configuration/text-data-scanner-configuration.d.ts +4 -27
  18. package/@types/model/configuration/view-finder-scanner-configuration.d.ts +11 -0
  19. package/@types/model/configuration/vin-scanner-configuration.d.ts +2 -4
  20. package/@types/model/filter-types.d.ts +3 -3
  21. package/@types/model/mrz/mrz-result.d.ts +1 -1
  22. package/@types/model/response/document-quality-analyzer-result.d.ts +1 -1
  23. package/@types/mrz-scanner-view.d.ts +6 -6
  24. package/@types/scanbot-sdk.d.ts +3 -0
  25. package/@types/scanner-view.d.ts +4 -1
  26. package/@types/service/image-processor.d.ts +1 -1
  27. package/@types/service/pdf-generator.d.ts +3 -3
  28. package/@types/service/simple-mrz-recognizer.d.ts +1 -1
  29. package/@types/service/text-data-recognizer.d.ts +3 -3
  30. package/@types/text-data-scanner-view.d.ts +9 -11
  31. package/@types/ui2/configuration/ActionBarConfiguration.d.ts +42 -0
  32. package/@types/ui2/configuration/ArTrackingOverlayConfiguration.d.ts +323 -0
  33. package/@types/ui2/configuration/BarcodeInfoMapping.d.ts +96 -0
  34. package/@types/ui2/configuration/BarcodeItem.d.ts +30 -0
  35. package/@types/ui2/configuration/BarcodeItemMapper.d.ts +6 -0
  36. package/@types/ui2/configuration/BarcodeRecognizerConfiguration.d.ts +159 -0
  37. package/@types/ui2/configuration/BarcodeResult.d.ts +14 -0
  38. package/@types/ui2/configuration/BarcodeScannerConfiguration.d.ts +221 -0
  39. package/@types/ui2/configuration/BarcodeTextLocalization.d.ts +118 -0
  40. package/@types/ui2/configuration/BarcodeUseCase.d.ts +10 -0
  41. package/@types/ui2/configuration/CameraConfiguration.d.ts +37 -0
  42. package/@types/ui2/configuration/CameraPermission.d.ts +54 -0
  43. package/@types/ui2/configuration/Common.d.ts +376 -0
  44. package/@types/ui2/configuration/FindAndPickScanningModeUseCase.d.ts +25 -0
  45. package/@types/ui2/configuration/MultipleScanningModeUseCase.d.ts +610 -0
  46. package/@types/ui2/configuration/ScanbotAlertDialog.d.ts +49 -0
  47. package/@types/ui2/configuration/SingleScanningModeUseCase.d.ts +202 -0
  48. package/@types/ui2/configuration/TopBarConfiguration.d.ts +55 -0
  49. package/@types/ui2/configuration/UserGuidanceConfiguration.d.ts +30 -0
  50. package/@types/ui2/configuration/ViewFinderConfiguration.d.ts +90 -0
  51. package/@types/ui2/configuration/utils.d.ts +6 -0
  52. package/@types/ui2/configuration.d.ts +20 -0
  53. package/@types/ui2/controllers/barcode-scanner-controller.d.ts +9 -0
  54. package/@types/ui2/controllers/multiple-scanning-mode-controller.d.ts +10 -0
  55. package/@types/ui2/controllers/single-scanning-mode-controller.d.ts +11 -0
  56. package/@types/ui2/create-sb-theme.d.ts +14 -0
  57. package/@types/ui2/model/counted-barcodes.d.ts +32 -0
  58. package/@types/ui2/scanbot-sdk-ui.d.ts +7 -0
  59. package/@types/ui2/scanbot-ui-library.d.ts +17 -0
  60. package/@types/ui2/service/haptics-manager.d.ts +6 -0
  61. package/@types/ui2/service/sound-manager.d.ts +8 -0
  62. package/@types/ui2/utils/barcode-mapper.d.ts +41 -0
  63. package/@types/ui2/utils/camera-config.d.ts +3 -0
  64. package/@types/ui2/utils/dynamic-viewport-height.d.ts +2 -0
  65. package/@types/ui2/utils/lazy-initialized-singleton.d.ts +6 -0
  66. package/@types/ui2/utils/styled-badge.d.ts +9 -0
  67. package/@types/ui2/utils/styled-box.d.ts +8 -0
  68. package/@types/ui2/utils/styled-button.d.ts +7 -0
  69. package/@types/ui2/utils/styled-input.d.ts +6 -0
  70. package/@types/ui2/utils/useScanningViewSize.d.ts +8 -0
  71. package/@types/ui2/views/action-button/action-button-container.d.ts +21 -0
  72. package/@types/ui2/views/action-button/action-button.d.ts +13 -0
  73. package/@types/ui2/views/ar/ar-overlay-barcode-info.d.ts +19 -0
  74. package/@types/ui2/views/barcode-info/barcode-info.d.ts +24 -0
  75. package/@types/ui2/views/barcode-scanner.d.ts +24 -0
  76. package/@types/ui2/views/camera-permission-denied.d.ts +8 -0
  77. package/@types/ui2/views/dialog/barcode-info-dialog.d.ts +28 -0
  78. package/@types/ui2/views/dialog/barcode-mapping-error-dialog.d.ts +12 -0
  79. package/@types/ui2/views/dialog/count-edit-dialog.d.ts +11 -0
  80. package/@types/ui2/views/dialog/styled-dialog.d.ts +7 -0
  81. package/@types/ui2/views/drawer/barcode-result-drawer.d.ts +18 -0
  82. package/@types/ui2/views/drawer/counting-button.d.ts +11 -0
  83. package/@types/ui2/views/drawer/hooks/use-drag-listener.d.ts +26 -0
  84. package/@types/ui2/views/drawer/subviews/barcode-drawer-empty-state.d.ts +8 -0
  85. package/@types/ui2/views/drawer/subviews/barcode-drawer-header.d.ts +9 -0
  86. package/@types/ui2/views/drawer/subviews/barcode-list-item.d.ts +12 -0
  87. package/@types/ui2/views/drawer/subviews/barcode-list.d.ts +12 -0
  88. package/@types/ui2/views/drawer/subviews/drawer-header-content.d.ts +10 -0
  89. package/@types/ui2/views/drawer/subviews/swipe-underlay.d.ts +7 -0
  90. package/@types/ui2/views/form/dialog-button.d.ts +12 -0
  91. package/@types/ui2/views/navigation-bar.d.ts +15 -0
  92. package/@types/ui2/views/styled-text.d.ts +15 -0
  93. package/@types/utils/colors.d.ts +5 -0
  94. package/@types/utils/constants.d.ts +1 -0
  95. package/@types/utils/dto/Frame.d.ts +1 -0
  96. package/@types/utils/dto/Point.d.ts +1 -0
  97. package/@types/utils/dto/Polygon.d.ts +1 -1
  98. package/@types/utils/image-utils.d.ts +1 -0
  99. package/@types/utils/logger.d.ts +1 -0
  100. package/@types/utils/react/usePromise.d.ts +14 -0
  101. package/@types/utils/video-stream.d.ts +8 -0
  102. package/@types/view/barcode-calculation/barcode-calculation-popup.d.ts +1 -1
  103. package/@types/view/barcode-calculation/styled-spinner.d.ts +4 -2
  104. package/@types/view/barcode-polygon/animated-barcode-selection-overlay.d.ts +9 -3
  105. package/@types/view/barcode-polygon/barcode-polygon-label.d.ts +5 -1
  106. package/@types/view/cropping/cropping-image.d.ts +1 -1
  107. package/@types/view/cropping/draggable-handles-component.d.ts +1 -1
  108. package/@types/view/cropping/draggable-lines-container.d.ts +2 -2
  109. package/@types/view/cropping/draggable-points-container.d.ts +2 -2
  110. package/@types/view/cropping/magnetic-lines-component.d.ts +2 -2
  111. package/@types/view/cropping/magnifier-view.d.ts +4 -4
  112. package/@types/view/document-outline.d.ts +1 -1
  113. package/@types/view/polygon/animated-document-polygon.d.ts +1 -1
  114. package/@types/view/polygon/document-line-quad.d.ts +2 -2
  115. package/@types/view/polygon/draggable-document-polygon.d.ts +1 -1
  116. package/@types/view/scanbot-camera-view.d.ts +10 -4
  117. package/@types/view/shutter-button.d.ts +8 -8
  118. package/@types/view/utils/animatable.d.ts +2 -1
  119. package/@types/view/utils/icons/empty-state-box.d.ts +4 -0
  120. package/@types/view/utils/scroll-lock.d.ts +1 -1
  121. package/@types/view/view-finder.d.ts +50 -31
  122. package/@types/worker/worker-bridge.d.ts +7 -3
  123. package/bundle/ScanbotSDK.min.js +34 -5
  124. package/bundle/ScanbotSDK.ui2.min.js +240 -0
  125. package/bundle/ScanbotSDK.ui2.min.js.LICENSE.txt +31 -0
  126. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -0
  127. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  128. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.worker.js +1 -0
  129. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  130. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  131. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm-webpack-file-loader +0 -0
  132. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -0
  133. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -2
  134. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -2
  135. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -0
  136. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  137. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm-webpack-file-loader +0 -0
  138. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.worker.js +1 -0
  139. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  140. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm-webpack-file-loader +0 -0
  141. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  142. package/bundle/bin/complete/ScanbotSDK.Asm.wasm-webpack-file-loader +0 -0
  143. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -0
  144. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -2
  145. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -2
  146. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -0
  147. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  148. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.worker.js +1 -0
  149. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  150. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  151. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm-webpack-file-loader +0 -0
  152. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -0
  153. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -2
  154. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -2
  155. package/package.json +1 -1
  156. package/webpack/fileLoader.js +10 -0
  157. package/webpack/index.js +1 -13
  158. package/webpack/ui.d.ts +0 -0
  159. package/webpack/ui.js +3 -0
  160. package/@types/model/configuration/text-style-configuration.d.ts +0 -5
  161. package/@types/model/configuration/view-finder-configuration.d.ts +0 -8
  162. package/@types/model/configuration/window-style-configuration.d.ts +0 -10
  163. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js.LICENSE.txt +0 -232
  164. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js.LICENSE.txt +0 -232
  165. package/bundle/bin/barcode-scanner/tfjs-backend-wasm-simd.wasm +0 -0
  166. package/bundle/bin/barcode-scanner/tfjs-backend-wasm-threaded-simd.wasm +0 -0
  167. package/bundle/bin/barcode-scanner/tfjs-backend-wasm.wasm +0 -0
  168. package/bundle/bin/complete/ScanbotSDK.Core-simd.js.LICENSE.txt +0 -232
  169. package/bundle/bin/complete/ScanbotSDK.Core.js.LICENSE.txt +0 -232
  170. package/bundle/bin/complete/tfjs-backend-wasm-simd.wasm +0 -0
  171. package/bundle/bin/complete/tfjs-backend-wasm-threaded-simd.wasm +0 -0
  172. package/bundle/bin/complete/tfjs-backend-wasm.wasm +0 -0
  173. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js.LICENSE.txt +0 -232
  174. package/bundle/bin/document-scanner/ScanbotSDK.Core.js.LICENSE.txt +0 -232
  175. package/bundle/bin/document-scanner/tfjs-backend-wasm-simd.wasm +0 -0
  176. package/bundle/bin/document-scanner/tfjs-backend-wasm-threaded-simd.wasm +0 -0
  177. package/bundle/bin/document-scanner/tfjs-backend-wasm.wasm +0 -0
  178. package/bundle/bin/loader/tfjs-backend-wasm-simd.wasm-helper +0 -0
  179. package/bundle/bin/loader/tfjs-backend-wasm-threaded-simd.wasm-helper +0 -0
  180. package/bundle/bin/loader/tfjs-backend-wasm.wasm-helper +0 -0
@@ -0,0 +1,323 @@
1
+ import { BackgroundStyle } from "./Common";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
+ import { PolygonStyle } from "./Common";
4
+ import { StyledText } from "./Common";
5
+ /**
6
+ Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
7
+ */
8
+ export declare class ArOverlayPolygonConfiguration extends PartiallyConstructible {
9
+ /**
10
+ Control the visibility of the overlay polygon.
11
+ @defaultValue true;
12
+ */
13
+ visible: boolean;
14
+ /**
15
+ Appearance of the overlay polygon when a barcode is not selected.
16
+ @defaultValue new PolygonStyle({
17
+ "strokeColor": "?sbColorSurface",
18
+ "fillColor": "#00000000",
19
+ "strokeWidth": 2.0,
20
+ "cornerRadius": 2.0
21
+ });
22
+ */
23
+ deselected: PolygonStyle;
24
+ /**
25
+ Appearance of the overlay polygon after a barcode has been selected.
26
+ @defaultValue new PolygonStyle({
27
+ "strokeColor": "?sbColorPositive",
28
+ "fillColor": "#00000000",
29
+ "strokeWidth": 2.0,
30
+ "cornerRadius": 2.0
31
+ });
32
+ */
33
+ selected: PolygonStyle;
34
+ /** @param source {@displayType `DeepPartial<ArOverlayPolygonConfiguration>`} */
35
+ constructor(source?: DeepPartial<ArOverlayPolygonConfiguration>);
36
+ }
37
+ /**
38
+ Where to display the barcode info box in the camera preview.
39
+
40
+ - `DISABLED`:
41
+ Don't display any barcode info.
42
+ - `STACKED`:
43
+ Display the barcode info box in the center of the overlay polygon.
44
+ - `BELOW`:
45
+ Display the barcode info box below the overlay polygon.
46
+ - `ABOVE`:
47
+ Display the barcode info box above the overlay polygon.
48
+ */
49
+ export type BarcodeItemInfoPosition = "DISABLED" | "STACKED" | "BELOW" | "ABOVE";
50
+ /**
51
+ Configuration of the barcode info box displayed in the camera preview.
52
+ */
53
+ export declare class BarcodeItemConfiguration extends PartiallyConstructible {
54
+ /**
55
+ Control the visibility of the barcode image in the info box.
56
+ @defaultValue true;
57
+ */
58
+ imageVisible: boolean;
59
+ /**
60
+ Configuration of the text displaying a barcode's value in the info box when the barcode has been selected.
61
+ @defaultValue new StyledText({
62
+ "text": "BARCODE_TITLE",
63
+ "color": "?sbColorOnSurface"
64
+ });
65
+ */
66
+ titleSelected: StyledText;
67
+ /**
68
+ Configuration of the text displaying a barcode's symbology in the info box when the barcode has been selected.
69
+ @defaultValue new StyledText({
70
+ "text": "BARCODE_SUBTITLE",
71
+ "color": "?sbColorOnSurfaceVariant"
72
+ });
73
+ */
74
+ subtitleSelected: StyledText;
75
+ /**
76
+ Configuration of the text displaying a barcode's value in the info box when the barcode is yet to be selected.
77
+ @defaultValue new StyledText({
78
+ "text": "BARCODE_TITLE",
79
+ "color": "?sbColorOnSurface"
80
+ });
81
+ */
82
+ titleDeselected: StyledText;
83
+ /**
84
+ Configuration of the text displaying a barcode's symbology in the info box when the barcode is yet to be selected.
85
+ @defaultValue new StyledText({
86
+ "text": "BARCODE_SUBTITLE",
87
+ "color": "?sbColorOnSurfaceVariant"
88
+ });
89
+ */
90
+ subtitleDeselected: StyledText;
91
+ /**
92
+ Appearance of the barcode info box's background when a barcode has been selected.
93
+ @defaultValue new PolygonStyle({
94
+ "strokeColor": "?sbColorPositive",
95
+ "fillColor": "?sbColorPositive",
96
+ "strokeWidth": 0.0,
97
+ "cornerRadius": 10.0
98
+ });
99
+ */
100
+ backgroundSelected: PolygonStyle;
101
+ /**
102
+ Appearance of the barcode info box's background when a barcode is yet to be selected.
103
+ @defaultValue new PolygonStyle({
104
+ "strokeColor": "?sbColorSurface",
105
+ "fillColor": "?sbColorSurface",
106
+ "strokeWidth": 0.0,
107
+ "cornerRadius": 10.0
108
+ });
109
+ */
110
+ backgroundDeselected: PolygonStyle;
111
+ /** @param source {@displayType `DeepPartial<BarcodeItemConfiguration>`} */
112
+ constructor(source?: DeepPartial<BarcodeItemConfiguration>);
113
+ }
114
+ /**
115
+ Configuration of the round button.
116
+ */
117
+ export declare class BadgeStyle extends PartiallyConstructible {
118
+ /**
119
+ Control the visibility of the badge.
120
+ @defaultValue true;
121
+ */
122
+ visible: boolean;
123
+ /**
124
+ The style of the button's background.
125
+ */
126
+ background: BackgroundStyle;
127
+ /**
128
+ Color of the button foreground (icon, text).
129
+ @defaultValue "?sbColorOnSurface";
130
+ */
131
+ foregroundColor: string;
132
+ /** @param source {@displayType `DeepPartial<BadgeStyle>`} */
133
+ constructor(source?: DeepPartial<BadgeStyle>);
134
+ }
135
+ /**
136
+ Configuration of the AR overlay displayed on top of barcodes in the camera preview.
137
+ */
138
+ export declare class ArOverlayGeneralConfiguration extends PartiallyConstructible {
139
+ /**
140
+ Control the visibility of the user guidance.
141
+ @defaultValue false;
142
+ */
143
+ visible: boolean;
144
+ /**
145
+ Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color.
146
+ @defaultValue new BadgeStyle({
147
+ "background": new BackgroundStyle({}),
148
+ "foregroundColor": "?sbColorOnSurface"
149
+ });
150
+ */
151
+ counterBadge: BadgeStyle;
152
+ /**
153
+ If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them.
154
+ @defaultValue false;
155
+ */
156
+ automaticSelectionEnabled: boolean;
157
+ /**
158
+ Where to display the barcode info box in the camera preview.
159
+ @defaultValue "BELOW";
160
+ */
161
+ barcodeItemInfoPosition: BarcodeItemInfoPosition;
162
+ /**
163
+ Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
164
+ @defaultValue new ArOverlayPolygonConfiguration({
165
+ "visible": true,
166
+ "deselected": new PolygonStyle({}),
167
+ "selected": new PolygonStyle({})
168
+ });
169
+ */
170
+ polygon: ArOverlayPolygonConfiguration;
171
+ /**
172
+ Configuration of the barcode info box displayed in the camera preview.
173
+ @defaultValue new BarcodeItemConfiguration({
174
+ "imageVisible": true,
175
+ "titleSelected": new StyledText({
176
+ "text": "BARCODE_TITLE",
177
+ "color": "?sbColorOnSurface"
178
+ }),
179
+ "subtitleSelected": new StyledText({
180
+ "text": "BARCODE_SUBTITLE",
181
+ "color": "?sbColorOnSurfaceVariant"
182
+ }),
183
+ "titleDeselected": new StyledText({
184
+ "text": "BARCODE_TITLE",
185
+ "color": "?sbColorOnSurface"
186
+ }),
187
+ "subtitleDeselected": new StyledText({
188
+ "text": "BARCODE_SUBTITLE",
189
+ "color": "?sbColorOnSurfaceVariant"
190
+ }),
191
+ "backgroundSelected": new PolygonStyle({
192
+ "strokeColor": "?sbColorPositive",
193
+ "fillColor": "?sbColorPositive",
194
+ "strokeWidth": 1.0,
195
+ "cornerRadius": 5.0
196
+ }),
197
+ "backgroundDeselected": new PolygonStyle({
198
+ "strokeColor": "?sbColorSurface",
199
+ "fillColor": "?sbColorSurface",
200
+ "strokeWidth": 1.0,
201
+ "cornerRadius": 5.0
202
+ })
203
+ });
204
+ */
205
+ barcodeItemConfiguration: BarcodeItemConfiguration;
206
+ /** @param source {@displayType `DeepPartial<ArOverlayGeneralConfiguration>`} */
207
+ constructor(source?: DeepPartial<ArOverlayGeneralConfiguration>);
208
+ }
209
+ /**
210
+ Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
211
+ */
212
+ export declare class FindAndPickArOverlayPolygonConfiguration extends PartiallyConstructible {
213
+ /**
214
+ Control the visibility of the overlay polygon.
215
+ @defaultValue true;
216
+ */
217
+ visible: boolean;
218
+ /**
219
+ Appearance of the overlay polygon when a barcode is partially scanned.
220
+ @defaultValue new PolygonStyle({
221
+ "strokeColor": "?sbColorWarning",
222
+ "fillColor": "#00000000",
223
+ "strokeWidth": 3.0,
224
+ "cornerRadius": 5.0
225
+ });
226
+ */
227
+ partiallyScanned: PolygonStyle;
228
+ /**
229
+ Appearance of the overlay polygon when a barcode is rejected.
230
+ @defaultValue new PolygonStyle({
231
+ "strokeColor": "?sbColorSurface",
232
+ "fillColor": "#00000000",
233
+ "strokeWidth": 3.0,
234
+ "cornerRadius": 5.0
235
+ });
236
+ */
237
+ rejected: PolygonStyle;
238
+ /**
239
+ Appearance of the overlay polygon when a barcode is completed.
240
+ @defaultValue new PolygonStyle({
241
+ "strokeColor": "?sbColorPositive",
242
+ "fillColor": "#00000000",
243
+ "strokeWidth": 3.0,
244
+ "cornerRadius": 5.0
245
+ });
246
+ */
247
+ completed: PolygonStyle;
248
+ /** @param source {@displayType `DeepPartial<FindAndPickArOverlayPolygonConfiguration>`} */
249
+ constructor(source?: DeepPartial<FindAndPickArOverlayPolygonConfiguration>);
250
+ }
251
+ /**
252
+ Configuration of the round badge on find and pick ar layer.
253
+ */
254
+ export declare class FindAndPickBadgeConfiguration extends PartiallyConstructible {
255
+ /**
256
+ Appearance of the badge when a barcode is partially scanned.
257
+ @defaultValue new BadgeStyle({
258
+ "visible": true,
259
+ "background": new BackgroundStyle({
260
+ "strokeColor": "#FFFFFF30",
261
+ "fillColor": "?sbColorWarning",
262
+ "strokeWidth": 0.0
263
+ }),
264
+ "foregroundColor": "?sbColorOnSurface"
265
+ });
266
+ */
267
+ partiallyScanned: BadgeStyle;
268
+ /**
269
+ Appearance of the badge when a barcode is rejected.
270
+ @defaultValue new BadgeStyle({
271
+ "visible": true,
272
+ "background": new BackgroundStyle({
273
+ "strokeColor": "#FFFFFF30",
274
+ "fillColor": "?sbColorNegative",
275
+ "strokeWidth": 0.0
276
+ }),
277
+ "foregroundColor": "?sbColorOnSurface"
278
+ });
279
+ */
280
+ rejected: BadgeStyle;
281
+ /**
282
+ Appearance of the badge when a barcode is completed.
283
+ @defaultValue new BadgeStyle({
284
+ "visible": true,
285
+ "background": new BackgroundStyle({
286
+ "strokeColor": "#FFFFFF30",
287
+ "fillColor": "?sbColorPositive",
288
+ "strokeWidth": 0.0
289
+ }),
290
+ "foregroundColor": "?sbColorOnSurface"
291
+ });
292
+ */
293
+ completed: BadgeStyle;
294
+ /** @param source {@displayType `DeepPartial<FindAndPickBadgeConfiguration>`} */
295
+ constructor(source?: DeepPartial<FindAndPickBadgeConfiguration>);
296
+ }
297
+ /**
298
+ Configuration of the AR overlay.
299
+ */
300
+ export declare class ArOverlayFindAndPickConfiguration extends PartiallyConstructible {
301
+ /**
302
+ Control the visibility of the user guidance.
303
+ @defaultValue false;
304
+ */
305
+ visible: boolean;
306
+ /**
307
+ If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them.
308
+ @defaultValue true;
309
+ */
310
+ automaticSelectionEnabled: boolean;
311
+ /**
312
+ Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
313
+ @defaultValue new FindAndPickArOverlayPolygonConfiguration({});
314
+ */
315
+ polygon: FindAndPickArOverlayPolygonConfiguration;
316
+ /**
317
+ Configuration of the round badge on find and pick ar layer.
318
+ @defaultValue new FindAndPickBadgeConfiguration({});
319
+ */
320
+ badge: FindAndPickBadgeConfiguration;
321
+ /** @param source {@displayType `DeepPartial<ArOverlayFindAndPickConfiguration>`} */
322
+ constructor(source?: DeepPartial<ArOverlayFindAndPickConfiguration>);
323
+ }
@@ -0,0 +1,96 @@
1
+ import { BarcodeItemMapper } from "./BarcodeItemMapper";
2
+ import { ButtonConfiguration } from "./Common";
3
+ import { DeepPartial, PartiallyConstructible } from "./utils";
4
+ import { StyledText } from "./Common";
5
+ /**
6
+ Configuration of the the mapper's error dialog.
7
+ */
8
+ export declare class BarcodeItemErrorState extends PartiallyConstructible {
9
+ /**
10
+ Title displayed above the error message.
11
+ @defaultValue new StyledText({
12
+ "text": "Connection Error!",
13
+ "color": "?sbColorOnSurface"
14
+ });
15
+ */
16
+ title: StyledText;
17
+ /**
18
+ Error message.
19
+ @defaultValue new StyledText({
20
+ "text": "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan.",
21
+ "color": "?sbColorOnSurfaceVariant"
22
+ });
23
+ */
24
+ subtitle: StyledText;
25
+ /**
26
+ Configuration of the retry button.
27
+ @defaultValue new ButtonConfiguration({});
28
+ */
29
+ retryButton: ButtonConfiguration;
30
+ /**
31
+ Configuration of the cancel button.
32
+ @defaultValue new ButtonConfiguration({});
33
+ */
34
+ cancelButton: ButtonConfiguration;
35
+ /** @param source {@displayType `DeepPartial<BarcodeItemErrorState>`} */
36
+ constructor(source?: DeepPartial<BarcodeItemErrorState>);
37
+ }
38
+ /**
39
+ Format of the mapped barcode data.
40
+ */
41
+ export declare class BarcodeMappedData extends PartiallyConstructible {
42
+ /**
43
+ Title of the barcode.
44
+ */
45
+ title: string;
46
+ /**
47
+ Subtitle of the barcode.
48
+ */
49
+ subtitle: string;
50
+ /**
51
+ Image of the barcode.
52
+ */
53
+ barcodeImage: string;
54
+ /** @param source {@displayType `DeepPartial<BarcodeMappedData>`} */
55
+ constructor(source?: DeepPartial<BarcodeMappedData>);
56
+ }
57
+ /**
58
+ Configuration of the barcode data mapping.
59
+ */
60
+ export declare class BarcodeInfoMapping extends PartiallyConstructible {
61
+ /**
62
+ Callback to map the barcode data to the data of the corresponding product.
63
+ @defaultValue null;
64
+ */
65
+ barcodeItemMapper: BarcodeItemMapper;
66
+ /**
67
+ Background color of the barcode info dialog.
68
+ @defaultValue "?sbColorSurface";
69
+ */
70
+ sheetColor: string;
71
+ /**
72
+ Color of the divider and separator lines in the barcode info dialog.
73
+ @defaultValue "?sbColorOutline";
74
+ */
75
+ dividerColor: string;
76
+ /**
77
+ Background color of the overlay surrounding the barcode mapping error dialog.
78
+ @defaultValue "?sbColorModalOverlay";
79
+ */
80
+ modalOverlayColor: string;
81
+ /**
82
+ Text being displayed while a barcode is being mapped.
83
+ @defaultValue new StyledText({
84
+ "text": "Loading message for barcode info mapping.",
85
+ "color": "?sbColorPrimary"
86
+ });
87
+ */
88
+ loadingMessage: StyledText;
89
+ /**
90
+ Configuration of the error state displayed when processing a barcode fails.
91
+ @defaultValue new BarcodeItemErrorState({});
92
+ */
93
+ errorState: BarcodeItemErrorState;
94
+ /** @param source {@displayType `DeepPartial<BarcodeInfoMapping>`} */
95
+ constructor(source?: DeepPartial<BarcodeInfoMapping>);
96
+ }
@@ -0,0 +1,30 @@
1
+ import { BarcodeFormat } from "./BarcodeRecognizerConfiguration";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
+ import { GenericDocument } from "./utils";
4
+ /**
5
+ Data about the scanned barcode.
6
+ */
7
+ export declare class BarcodeItem extends PartiallyConstructible {
8
+ /**
9
+ Recognized barcode symbology.
10
+ */
11
+ type: BarcodeFormat;
12
+ /**
13
+ Number of recognized barcodes of this symbology and value.
14
+ */
15
+ count: number;
16
+ /**
17
+ Recognized value of the barcode.
18
+ */
19
+ text: string;
20
+ /**
21
+ Array of raw bytes that compose the recognized barcode.
22
+ */
23
+ rawBytes: string;
24
+ /**
25
+ The parsed known document format (if parsed successfully).
26
+ */
27
+ parsedDocument: GenericDocument;
28
+ /** @param source {@displayType `DeepPartial<BarcodeItem>`} */
29
+ constructor(source?: DeepPartial<BarcodeItem>);
30
+ }
@@ -0,0 +1,6 @@
1
+ import { BarcodeMappedData } from "./BarcodeInfoMapping";
2
+ import { BarcodeItem } from "./BarcodeItem";
3
+ /**
4
+ * Maps a barcode's data to the data of the corresponding product.
5
+ * */
6
+ export type BarcodeItemMapper = (barcodeItem: BarcodeItem) => Promise<BarcodeMappedData>;
@@ -0,0 +1,159 @@
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
+ /**
3
+ Expected quantity of QR codes in an image.
4
+
5
+ - `LOW`:
6
+ Up to 6 QR codes per image.
7
+ - `HIGH`:
8
+ Up to 24 QR codes per image.
9
+ */
10
+ export type CodeDensity = "LOW" | "HIGH";
11
+ /**
12
+ Type of MSI plessey checksum algorithm used.
13
+
14
+ - `NONE`:
15
+ No checksum algorithm used.
16
+ - `MOD_10`:
17
+ Mod10 checksum algorithm
18
+ - `MOD_11_IBM`:
19
+ Mod11IBM checksum algorithm
20
+ - `MOD_11_NCR`:
21
+ Mod11NCR checksum algorithm
22
+ - `MOD_1010`:
23
+ Mod1010 checksum algorithm
24
+ - `MOD_1110_IBM`:
25
+ Mod1110IBM checksum algorithm
26
+ - `MOD_1110_NCR`:
27
+ Mod1110NCR checksum algorithm
28
+ */
29
+ export type MSIPlesseyChecksumAlgorithm = "NONE" | "MOD_10" | "MOD_11_IBM" | "MOD_11_NCR" | "MOD_1010" | "MOD_1110_IBM" | "MOD_1110_NCR";
30
+ /**
31
+ GS1_COMPOSITE barcode type handling
32
+
33
+ - `NONE`:
34
+ No special handling for GS1-formatted results. Special (FNC1) characters are stripped.
35
+ - `PARSE`:
36
+ GS1 messages are converted to machine-readable format per the GS1 spec (the special character is converted to ASCII \x1D). Message is not validated. The implied 01 AI key is prepended to DataBar results.
37
+ - `VALIDATE`:
38
+ GS1 messages are converted to machine-readable format per the GS1 spec (the special character is converted to ASCII \x1D) and validated. The implied 01 AI key is prepended to DataBar results. Invalid messages are not returned.
39
+ - `DECODE`:
40
+ GS1 strings are converted to human-readable format and validated. The implied (01) AI key is prepended to DataBar results. Invalid messages are not returned.
41
+ */
42
+ export type Gs1Handling = "NONE" | "PARSE" | "VALIDATE" | "DECODE";
43
+ /**
44
+ Type of barcode document format used.
45
+
46
+ - `AAMVA`:
47
+ American Association of Motor Vehicle Administrators barcode document
48
+ - `BOARDING_PASS`:
49
+ Boarding pass barcode document
50
+ - `DE_MEDICAL_PLAN`:
51
+ German medication plan barcode document
52
+ - `MEDICAL_CERTIFICATE`:
53
+ German medical certificate barcode document
54
+ - `ID_CARD_PDF_417`:
55
+ ID card barcode document
56
+ - `SEPA`:
57
+ SEPA barcode (aka GiroCode) document
58
+ - `SWISS_QR`:
59
+ Swiss QR barcode document
60
+ - `VCARD`:
61
+ VCard barcode document
62
+ - `GS1`:
63
+ GS1 barcode document
64
+ */
65
+ export type BarcodeDocumentFormat = "AAMVA" | "BOARDING_PASS" | "DE_MEDICAL_PLAN" | "MEDICAL_CERTIFICATE" | "ID_CARD_PDF_417" | "SEPA" | "SWISS_QR" | "VCARD" | "GS1";
66
+ /**
67
+ Barcode symbology used.
68
+
69
+ - `AZTEC`:
70
+ Aztec barcode type
71
+ - `CODABAR`:
72
+ Codabar barcode type
73
+ - `CODE_25`:
74
+ Code 25 barcode type
75
+ - `CODE_39`:
76
+ Code 39 barcode type
77
+ - `CODE_93`:
78
+ Code 93 barcode type
79
+ - `CODE_128`:
80
+ Code 128 barcode type
81
+ - `DATA_MATRIX`:
82
+ Data Matrix barcode type
83
+ - `EAN_8`:
84
+ EAN-8 barcode type
85
+ - `EAN_13`:
86
+ EAN-13 barcode type
87
+ - `ITF`:
88
+ ITF (Interleaved 2 of 5) barcode type
89
+ - `PDF_417`:
90
+ PDF417 barcode type
91
+ - `QR_CODE`:
92
+ QR Code barcode type
93
+ - `MICRO_QR_CODE`:
94
+ Micro QR Code barcode type
95
+ - `DATABAR`:
96
+ Databar barcode type
97
+ - `DATABAR_EXPANDED`:
98
+ Databar Expanded barcode type
99
+ - `UPC_A`:
100
+ UPC-A barcode type
101
+ - `UPC_E`:
102
+ UPC-E barcode type
103
+ - `MSI_PLESSEY`:
104
+ MSI Plessey barcode type
105
+ - `IATA_2_OF_5`:
106
+ IATA 2 of 5 barcode type
107
+ - `INDUSTRIAL_2_OF_5`:
108
+ Industrial 2 of 5 barcode type
109
+ - `USPS_INTELLIGENT_MAIL`:
110
+ USPS Intelligent Mail (aka USPS OneCode, USPS-STD-11)
111
+ - `ROYAL_MAIL`:
112
+ Royal Mail Four-State Customer Code, (aka RM4SCC, CBC, BPO 4 State Code)
113
+ - `JAPAN_POST`:
114
+ Japan Post Four-State Barcode
115
+ - `ROYAL_TNT_POST`:
116
+ Royal TNT Post Four-State Barcode (aka KIX, Klant IndeX)
117
+ - `AUSTRALIA_POST`:
118
+ Australia Post Four-State Customer Code
119
+ - `DATABAR_LIMITED`:
120
+ GS1 DataBar Limited
121
+ - `GS1_COMPOSITE`:
122
+ GS1 Composite
123
+ - `MICRO_PDF_417`:
124
+ Databar micro pdf 417
125
+ */
126
+ export type BarcodeFormat = "AZTEC" | "CODABAR" | "CODE_25" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "PDF_417" | "QR_CODE" | "MICRO_QR_CODE" | "DATABAR" | "DATABAR_EXPANDED" | "UPC_A" | "UPC_E" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED" | "GS1_COMPOSITE" | "MICRO_PDF_417";
127
+ /**
128
+ Filter for extended EAN and UPC barcodes.
129
+
130
+ - `NO_FILTER`:
131
+ EAN and UPC codes are not filtered. Both are returned regardless if they have an extension or not.
132
+ - `ONLY_WITH_EXTENSIONS`:
133
+ Only EAN and UPC codes with extensions are returned.
134
+ - `ONLY_WITHOUT_EXTENSIONS`:
135
+ Only EAN and UPC codes without extensions are returned.
136
+ */
137
+ export type BarcodesExtensionFilter = "NO_FILTER" | "ONLY_WITH_EXTENSIONS" | "ONLY_WITHOUT_EXTENSIONS";
138
+ /**
139
+ Configuration of the scanning behavior.
140
+ */
141
+ export declare class BarcodeRecognizerConfiguration extends PartiallyConstructible {
142
+ /**
143
+ Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). This option overrides `barcodesExtensionFilter` option.
144
+ @defaultValue "";
145
+ */
146
+ barcodesRegexFilter: string;
147
+ /**
148
+ List of accepted barcode symbologies.
149
+ @defaultValue [];
150
+ */
151
+ barcodeFormats: BarcodeFormat[];
152
+ /**
153
+ The expected way of handling GS1_COMPOSITE barcodes.
154
+ @defaultValue "PARSE";
155
+ */
156
+ gs1Handling: Gs1Handling;
157
+ /** @param source {@displayType `DeepPartial<BarcodeRecognizerConfiguration>`} */
158
+ constructor(source?: DeepPartial<BarcodeRecognizerConfiguration>);
159
+ }
@@ -0,0 +1,14 @@
1
+ import { BarcodeItem } from "./BarcodeItem";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
+ /**
4
+ Results of the barcode scan.
5
+ */
6
+ export declare class BarcodeScannerResult extends PartiallyConstructible {
7
+ /**
8
+ Recognized barcode items.
9
+ @defaultValue [];
10
+ */
11
+ items: BarcodeItem[];
12
+ /** @param source {@displayType `DeepPartial<BarcodeScannerResult>`} */
13
+ constructor(source?: DeepPartial<BarcodeScannerResult>);
14
+ }