scanbot-web-sdk 8.1.0-alpha.1 → 8.1.0-beta.2

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 (96) hide show
  1. package/@types/core/bridge/worker-bridge.d.ts +28 -0
  2. package/@types/core/compiled/BarcodeConfigurationTypes.d.ts +146 -52
  3. package/@types/core/compiled/BarcodeDocumentModel.d.ts +12 -12
  4. package/@types/core/compiled/BarcodeScannerTypes.d.ts +13 -5
  5. package/@types/core/compiled/BarcodeTypes.d.ts +35 -0
  6. package/@types/core/compiled/CommonFieldType.d.ts +7 -1
  7. package/@types/core/compiled/DocumentQualityAnalyzerTypes.d.ts +43 -24
  8. package/@types/core/compiled/DocumentScannerTypes.d.ts +19 -19
  9. package/@types/core/compiled/DocumentsModel.d.ts +443 -1
  10. package/@types/core/compiled/MrzTypes.d.ts +9 -0
  11. package/@types/core/compiled/ParametricFilters.d.ts +36 -1
  12. package/@types/core/compiled/TextPatternScannerTypes.d.ts +5 -0
  13. package/@types/core/compiled/VinScannerTypes.d.ts +5 -0
  14. package/@types/core/compiled/utils.d.ts +1 -1
  15. package/@types/core-types.d.ts +1 -1
  16. package/@types/model/configuration/document-scanner-view-configuration.d.ts +4 -0
  17. package/@types/model/configuration/scanner-configuration.d.ts +3 -0
  18. package/@types/scanbot-sdk.d.ts +14 -0
  19. package/@types/service/pdf-generator.d.ts +2 -1
  20. package/@types/ui2/barcode/controllers/multiple-scanning-mode-controller.d.ts +4 -0
  21. package/@types/ui2/barcode/controllers/single-scanning-mode-controller.d.ts +4 -0
  22. package/@types/ui2/barcode/views/barcode-scanner.d.ts +2 -0
  23. package/@types/ui2/barcode/views/drawer/barcode-result-drawer.d.ts +2 -0
  24. package/@types/ui2/barcode/views/drawer/barcode-result-sidebar.d.ts +2 -0
  25. package/@types/ui2/barcode/views/navigation-bar.d.ts +1 -0
  26. package/@types/ui2/common.d.ts +1 -1
  27. package/@types/ui2/configuration/BarcodeTypes.d.ts +1 -1
  28. package/@types/ui2/configuration/barcode/BarcodeScannerScreenConfiguration.d.ts +2 -2
  29. package/@types/ui2/configuration/barcode/BarcodeTextLocalization.d.ts +15 -0
  30. package/@types/ui2/configuration/barcode/BarcodeUseCase.d.ts +3 -3
  31. package/@types/ui2/configuration/barcode/FindAndPickScanningModeUseCase.d.ts +4 -4
  32. package/@types/ui2/configuration/barcode/MultipleScanningModeUseCase.d.ts +2 -2
  33. package/@types/ui2/configuration/barcode/SingleScanningModeUseCase.d.ts +2 -2
  34. package/@types/ui2/configuration/check/CheckScannerScreenConfiguration.d.ts +4 -4
  35. package/@types/ui2/configuration/check/CheckScannerScreenTextLocalization.d.ts +15 -0
  36. package/@types/ui2/configuration/common/ActionBarConfiguration.d.ts +1 -1
  37. package/@types/ui2/configuration/common/CameraConfiguration.d.ts +6 -0
  38. package/@types/ui2/configuration/common/CameraPermission.d.ts +3 -3
  39. package/@types/ui2/configuration/common/Common.d.ts +19 -0
  40. package/@types/ui2/configuration/common/ScanCompletionOverlay.d.ts +1 -1
  41. package/@types/ui2/configuration/common/ScanbotAlertDialog.d.ts +2 -2
  42. package/@types/ui2/configuration/common/SelectCameraMenu.d.ts +63 -0
  43. package/@types/ui2/configuration/common/TopBarConfiguration.d.ts +8 -2
  44. package/@types/ui2/configuration/common/UserGuidanceConfiguration.d.ts +3 -3
  45. package/@types/ui2/configuration/common/ViewFinderConfiguration.d.ts +1 -1
  46. package/@types/ui2/configuration/credit_card/CreditCardScannerScreenConfiguration.d.ts +4 -4
  47. package/@types/ui2/configuration/credit_card/CreditCardScannerScreenTextLocalization.d.ts +15 -0
  48. package/@types/ui2/configuration/document/CameraScreenConfiguration.d.ts +6 -65
  49. package/@types/ui2/configuration/document/DocumentScannerCameraConfiguration.d.ts +6 -0
  50. package/@types/ui2/configuration/document/DocumentScannerScreens.d.ts +3 -3
  51. package/@types/ui2/configuration/document/DocumentScannerTextLocalization.d.ts +15 -15
  52. package/@types/ui2/configuration/document/DocumentScannerUserGuidance.d.ts +1 -1
  53. package/@types/ui2/configuration/document/DocumentScanningFlow.d.ts +3 -3
  54. package/@types/ui2/configuration/document_data/DocumentDataExtractorScreenConfiguration.d.ts +4 -4
  55. package/@types/ui2/configuration/document_data/DocumentDataExtractorScreenTextLocalization.d.ts +15 -0
  56. package/@types/ui2/configuration/mrz/MRZScannerScreenConfiguration.d.ts +3 -3
  57. package/@types/ui2/configuration/mrz/MRZScannerScreenTextLocalization.d.ts +15 -0
  58. package/@types/ui2/configuration/native/DocumentData.d.ts +1 -1
  59. package/@types/ui2/configuration/native/PageData.d.ts +1 -1
  60. package/@types/ui2/configuration/text_pattern/TextPatternScannerScreenConfiguration.d.ts +2 -2
  61. package/@types/ui2/configuration/text_pattern/TextPatternScannerScreenTextLocalization.d.ts +15 -0
  62. package/@types/ui2/configuration/vin/VINScannerScreenConfiguration.d.ts +2 -2
  63. package/@types/ui2/configuration/vin/VINScannerScreenTextLocalization.d.ts +15 -0
  64. package/@types/ui2/configuration.d.ts +1 -0
  65. package/@types/ui2/data-scanner/views/mrz-scanner-box.d.ts +4 -2
  66. package/@types/ui2/document/views/camera-screen/camera-select-dropdown.d.ts +2 -2
  67. package/@types/ui2/document/views/camera-screen/top-bar.d.ts +18 -3
  68. package/@types/ui2/document/views/camera-screen/use-document-scanner-view.d.ts +1 -0
  69. package/@types/ui2/document/views/common/common-top-bar.d.ts +1 -1
  70. package/@types/utils/assets/camera-localization.d.ts +44 -0
  71. package/@types/view/scanbot-camera-view.d.ts +2 -0
  72. package/@types/worker/worker-bridge.d.ts +28 -0
  73. package/bundle/ScanbotSDK.min.js +4 -4
  74. package/bundle/ScanbotSDK.ui2.min.js +85 -85
  75. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  76. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  77. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  78. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  79. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  80. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
  81. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
  82. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
  83. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  84. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  85. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  86. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
  87. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
  88. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
  89. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  90. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  91. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  92. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  93. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  94. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
  95. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
  96. package/package.json +1 -1
@@ -79,6 +79,13 @@ export declare class WorkerBridge {
79
79
  paperWhiteningBias?: number;
80
80
  } & {
81
81
  readonly _type: "ColorDocumentFilter";
82
+ }) | ({
83
+ contrastEnhancement?: number;
84
+ colorEnhancement?: number;
85
+ paperSaturation?: number;
86
+ paperLightness?: number;
87
+ } & {
88
+ readonly _type: "ColorDocumentShadowRemovalFilter";
82
89
  }) | ({
83
90
  brightness?: number;
84
91
  } & {
@@ -147,6 +154,13 @@ export declare class WorkerBridge {
147
154
  paperWhiteningBias?: number;
148
155
  } & {
149
156
  readonly _type: "ColorDocumentFilter";
157
+ }) | ({
158
+ contrastEnhancement?: number;
159
+ colorEnhancement?: number;
160
+ paperSaturation?: number;
161
+ paperLightness?: number;
162
+ } & {
163
+ readonly _type: "ColorDocumentShadowRemovalFilter";
150
164
  }) | ({
151
165
  brightness?: number;
152
166
  } & {
@@ -230,6 +244,13 @@ export declare class WorkerBridge {
230
244
  paperWhiteningBias?: number;
231
245
  } & {
232
246
  readonly _type: "ColorDocumentFilter";
247
+ }) | ({
248
+ contrastEnhancement?: number;
249
+ colorEnhancement?: number;
250
+ paperSaturation?: number;
251
+ paperLightness?: number;
252
+ } & {
253
+ readonly _type: "ColorDocumentShadowRemovalFilter";
233
254
  }) | ({
234
255
  brightness?: number;
235
256
  } & {
@@ -298,6 +319,13 @@ export declare class WorkerBridge {
298
319
  paperWhiteningBias?: number;
299
320
  } & {
300
321
  readonly _type: "ColorDocumentFilter";
322
+ }) | ({
323
+ contrastEnhancement?: number;
324
+ colorEnhancement?: number;
325
+ paperSaturation?: number;
326
+ paperLightness?: number;
327
+ } & {
328
+ readonly _type: "ColorDocumentShadowRemovalFilter";
301
329
  }) | ({
302
330
  brightness?: number;
303
331
  } & {
@@ -1,6 +1,7 @@
1
1
  import type { DeepPartial } from "./utils";
2
2
  import { BarcodeFormat } from "./BarcodeTypes";
3
3
  import { Gs1Handling } from "./BarcodeTypes";
4
+ import { OneDConfirmationMode } from "./BarcodeTypes";
4
5
  import { UpcEanExtensionBehavior } from "./BarcodeTypes";
5
6
  /**
6
7
  Base class for all barcode configurations.
@@ -50,10 +51,17 @@ export declare class BarcodeFormatCodabarConfiguration {
50
51
  */
51
52
  minimum1DQuietZoneSize: number;
52
53
  /**
53
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
54
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
55
+ Linear barcodes are more prone to false positives.
56
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
54
57
  @defaultValue 1;
55
58
  */
56
- minimum1DConfirmationCount: number;
59
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
60
+ /**
61
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
62
+ @defaultValue "THOROUGH";
63
+ */
64
+ oneDConfirmationMode: OneDConfirmationMode;
57
65
  /**
58
66
  Minimum text length. Applied only to linear barcode formats that allow variable length.
59
67
  @defaultValue 1;
@@ -65,7 +73,7 @@ export declare class BarcodeFormatCodabarConfiguration {
65
73
  */
66
74
  maximumTextLength: number;
67
75
  /**
68
- If true, barcodes with heavy blur or from far distance are tried to scan.
76
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
69
77
  @defaultValue true;
70
78
  */
71
79
  enableOneDBlurScanner: boolean;
@@ -107,10 +115,17 @@ export declare class BarcodeFormatCode11Configuration {
107
115
  */
108
116
  minimum1DQuietZoneSize: number;
109
117
  /**
110
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
118
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
119
+ Linear barcodes are more prone to false positives.
120
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
111
121
  @defaultValue 1;
112
122
  */
113
- minimum1DConfirmationCount: number;
123
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
124
+ /**
125
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
126
+ @defaultValue "THOROUGH";
127
+ */
128
+ oneDConfirmationMode: OneDConfirmationMode;
114
129
  /**
115
130
  If true, the check digits are stripped from the result.
116
131
  @defaultValue false;
@@ -164,10 +179,17 @@ export declare class BarcodeFormatCode39Configuration {
164
179
  */
165
180
  minimum1DQuietZoneSize: number;
166
181
  /**
167
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
182
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
183
+ Linear barcodes are more prone to false positives.
184
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
168
185
  @defaultValue 1;
169
186
  */
170
- minimum1DConfirmationCount: number;
187
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
188
+ /**
189
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
190
+ @defaultValue "THOROUGH";
191
+ */
192
+ oneDConfirmationMode: OneDConfirmationMode;
171
193
  /**
172
194
  If true, the check digits are stripped from the result.
173
195
  @defaultValue false;
@@ -184,7 +206,7 @@ export declare class BarcodeFormatCode39Configuration {
184
206
  */
185
207
  maximumTextLength: number;
186
208
  /**
187
- If true, barcodes with heavy blur or from far distance are tried to scan.
209
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
188
210
  @defaultValue true;
189
211
  */
190
212
  enableOneDBlurScanner: boolean;
@@ -251,10 +273,17 @@ export declare class BarcodeFormatCode93Configuration {
251
273
  */
252
274
  minimum1DQuietZoneSize: number;
253
275
  /**
254
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
276
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
277
+ Linear barcodes are more prone to false positives.
278
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
255
279
  @defaultValue 1;
256
280
  */
257
- minimum1DConfirmationCount: number;
281
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
282
+ /**
283
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
284
+ @defaultValue "THOROUGH";
285
+ */
286
+ oneDConfirmationMode: OneDConfirmationMode;
258
287
  /**
259
288
  If true, the check digits are stripped from the result.
260
289
  @defaultValue false;
@@ -271,7 +300,7 @@ export declare class BarcodeFormatCode93Configuration {
271
300
  */
272
301
  maximumTextLength: number;
273
302
  /**
274
- If true, barcodes with heavy blur or from far distance are tried to scan.
303
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
275
304
  @defaultValue true;
276
305
  */
277
306
  enableOneDBlurScanner: boolean;
@@ -308,10 +337,17 @@ export declare class BarcodeFormatCode128Configuration {
308
337
  */
309
338
  minimum1DQuietZoneSize: number;
310
339
  /**
311
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
340
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
341
+ Linear barcodes are more prone to false positives.
342
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
312
343
  @defaultValue 1;
313
344
  */
314
- minimum1DConfirmationCount: number;
345
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
346
+ /**
347
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
348
+ @defaultValue "THOROUGH";
349
+ */
350
+ oneDConfirmationMode: OneDConfirmationMode;
315
351
  /**
316
352
  GS1 message handling options.
317
353
  @defaultValue "PARSE";
@@ -328,7 +364,7 @@ export declare class BarcodeFormatCode128Configuration {
328
364
  */
329
365
  maximumTextLength: number;
330
366
  /**
331
- If true, barcodes with heavy blur or from far distance are tried to scan.
367
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
332
368
  @defaultValue true;
333
369
  */
334
370
  enableOneDBlurScanner: boolean;
@@ -369,10 +405,17 @@ export declare class BarcodeFormatCode2Of5Configuration {
369
405
  */
370
406
  minimum1DQuietZoneSize: number;
371
407
  /**
372
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
408
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
409
+ Linear barcodes are more prone to false positives.
410
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
373
411
  @defaultValue 1;
374
412
  */
375
- minimum1DConfirmationCount: number;
413
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
414
+ /**
415
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
416
+ @defaultValue "THOROUGH";
417
+ */
418
+ oneDConfirmationMode: OneDConfirmationMode;
376
419
  /**
377
420
  If true, the check digits are stripped from the result.
378
421
  @defaultValue false;
@@ -441,10 +484,17 @@ export declare class BarcodeFormatDataBarConfiguration {
441
484
  */
442
485
  minimum1DQuietZoneSize: number;
443
486
  /**
444
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
487
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
488
+ Linear barcodes are more prone to false positives.
489
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
445
490
  @defaultValue 1;
446
491
  */
447
- minimum1DConfirmationCount: number;
492
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
493
+ /**
494
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
495
+ @defaultValue "THOROUGH";
496
+ */
497
+ oneDConfirmationMode: OneDConfirmationMode;
448
498
  /**
449
499
  GS1 message handling options.
450
500
  @defaultValue "PARSE";
@@ -483,10 +533,17 @@ export declare class BarcodeFormatDataBarExpandedConfiguration {
483
533
  */
484
534
  minimum1DQuietZoneSize: number;
485
535
  /**
486
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
536
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
537
+ Linear barcodes are more prone to false positives.
538
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
487
539
  @defaultValue 1;
488
540
  */
489
- minimum1DConfirmationCount: number;
541
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
542
+ /**
543
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
544
+ @defaultValue "THOROUGH";
545
+ */
546
+ oneDConfirmationMode: OneDConfirmationMode;
490
547
  /**
491
548
  GS1 message handling options.
492
549
  @defaultValue "PARSE";
@@ -525,10 +582,17 @@ export declare class BarcodeFormatDataBarLimitedConfiguration {
525
582
  */
526
583
  minimum1DQuietZoneSize: number;
527
584
  /**
528
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
585
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
586
+ Linear barcodes are more prone to false positives.
587
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
529
588
  @defaultValue 1;
530
589
  */
531
- minimum1DConfirmationCount: number;
590
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
591
+ /**
592
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
593
+ @defaultValue "THOROUGH";
594
+ */
595
+ oneDConfirmationMode: OneDConfirmationMode;
532
596
  /**
533
597
  GS1 message handling options.
534
598
  @defaultValue "PARSE";
@@ -567,10 +631,17 @@ export declare class BarcodeFormatItfConfiguration {
567
631
  */
568
632
  minimum1DQuietZoneSize: number;
569
633
  /**
570
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
634
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
635
+ Linear barcodes are more prone to false positives.
636
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
571
637
  @defaultValue 1;
572
638
  */
573
- minimum1DConfirmationCount: number;
639
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
640
+ /**
641
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
642
+ @defaultValue "THOROUGH";
643
+ */
644
+ oneDConfirmationMode: OneDConfirmationMode;
574
645
  /**
575
646
  Minimum text length. Applied only to linear barcode formats that allow variable length.
576
647
  @defaultValue 1;
@@ -582,7 +653,7 @@ export declare class BarcodeFormatItfConfiguration {
582
653
  */
583
654
  maximumTextLength: number;
584
655
  /**
585
- If true, barcodes with heavy blur or from far distance are tried to scan.
656
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
586
657
  @defaultValue true;
587
658
  */
588
659
  enableOneDBlurScanner: boolean;
@@ -662,10 +733,17 @@ export declare class BarcodeFormatMsiPlesseyConfiguration {
662
733
  */
663
734
  minimum1DQuietZoneSize: number;
664
735
  /**
665
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
736
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
737
+ Linear barcodes are more prone to false positives.
738
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
666
739
  @defaultValue 1;
667
740
  */
668
- minimum1DConfirmationCount: number;
741
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
742
+ /**
743
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
744
+ @defaultValue "THOROUGH";
745
+ */
746
+ oneDConfirmationMode: OneDConfirmationMode;
669
747
  /**
670
748
  If true, the check digits are stripped from the result.
671
749
  @defaultValue false;
@@ -682,7 +760,7 @@ export declare class BarcodeFormatMsiPlesseyConfiguration {
682
760
  */
683
761
  maximumTextLength: number;
684
762
  /**
685
- If true, barcodes with heavy blur or from far distance are tried to scan.
763
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
686
764
  @defaultValue true;
687
765
  */
688
766
  enableOneDBlurScanner: boolean;
@@ -726,18 +804,26 @@ export declare class BarcodeFormatUpcEanConfiguration {
726
804
  */
727
805
  minimum1DQuietZoneSize: number;
728
806
  /**
729
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
807
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
808
+ Linear barcodes are more prone to false positives.
809
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
730
810
  @defaultValue 1;
731
811
  */
732
- minimum1DConfirmationCount: number;
812
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
813
+ /**
814
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
815
+ @defaultValue "THOROUGH";
816
+ */
817
+ oneDConfirmationMode: OneDConfirmationMode;
733
818
  /**
734
819
  If true, the check digits are stripped from the result.
735
820
  @defaultValue false;
736
821
  */
737
822
  stripCheckDigits: boolean;
738
823
  /**
739
- If true, barcodes with heavy blur or from far distance are tried to scan.
740
- @defaultValue true;
824
+ If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
825
+ Enabling this option may increase the number of misreads (false positives).
826
+ @defaultValue false;
741
827
  */
742
828
  enableOneDBlurScanner: boolean;
743
829
  /**
@@ -766,11 +852,13 @@ export declare class BarcodeFormatUpcEanConfiguration {
766
852
  */
767
853
  extensions: UpcEanExtensionBehavior;
768
854
  /**
769
- In case that ean/upc both with and without extensions are allowed,
770
- we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid.
855
+ In case that EAN/UPC barcodes both with and without extensions are allowed,
856
+ we require this number of frames on which the standalone EAN or UPC (i.e. without extension) has to be detected to be considered as valid (live scanning only).
857
+ EAN/UPC barcodes with extensions are more prone to slicing (incomplete decoding).
858
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability that an extension is accidentally missed.
771
859
  @defaultValue 1;
772
860
  */
773
- minimumStandaloneConfirmationCount: number;
861
+ minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless: number;
774
862
  /** @param source {@displayType `DeepPartial<BarcodeFormatUpcEanConfiguration>`} */
775
863
  constructor(source?: DeepPartial<BarcodeFormatUpcEanConfiguration>);
776
864
  }
@@ -804,10 +892,17 @@ export declare class BarcodeFormatPharmaCodeConfiguration {
804
892
  */
805
893
  minimum1DQuietZoneSize: number;
806
894
  /**
807
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
895
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
896
+ Linear barcodes are more prone to false positives.
897
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
808
898
  @defaultValue 1;
809
899
  */
810
- minimum1DConfirmationCount: number;
900
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
901
+ /**
902
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
903
+ @defaultValue "THOROUGH";
904
+ */
905
+ oneDConfirmationMode: OneDConfirmationMode;
811
906
  /**
812
907
  Minimum value for PharmaCode. Very low values are likely to produce more false positives.
813
908
  @defaultValue 16;
@@ -1017,11 +1112,6 @@ export declare class BarcodeFormatDataMatrixConfiguration {
1017
1112
  @defaultValue "PARSE";
1018
1113
  */
1019
1114
  gs1Handling: Gs1Handling;
1020
- /**
1021
- If true, twod barcodes on strongly curved (e.g. cylindrical) objects are tried to scan.
1022
- @defaultValue true;
1023
- */
1024
- enableTwoDCurvatureScanner: boolean;
1025
1115
  /** @param source {@displayType `DeepPartial<BarcodeFormatDataMatrixConfiguration>`} */
1026
1116
  constructor(source?: DeepPartial<BarcodeFormatDataMatrixConfiguration>);
1027
1117
  }
@@ -1338,10 +1428,12 @@ export declare class BarcodeFormatCommonOneDConfiguration {
1338
1428
  */
1339
1429
  minimum1DQuietZoneSize: number;
1340
1430
  /**
1341
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
1431
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
1432
+ Linear barcodes are more prone to false positives.
1433
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
1342
1434
  @defaultValue 1;
1343
1435
  */
1344
- minimum1DConfirmationCount: number;
1436
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
1345
1437
  /**
1346
1438
  If true, the check digits are stripped from the result.
1347
1439
  @defaultValue false;
@@ -1363,10 +1455,10 @@ export declare class BarcodeFormatCommonOneDConfiguration {
1363
1455
  */
1364
1456
  gs1Handling: Gs1Handling;
1365
1457
  /**
1366
- If true, barcodes with heavy blur or from far distance are tried to scan.
1367
- @defaultValue true;
1458
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
1459
+ @defaultValue "THOROUGH";
1368
1460
  */
1369
- enableOneDBlurScanner: boolean;
1461
+ oneDConfirmationMode: OneDConfirmationMode;
1370
1462
  /**
1371
1463
  List of linear (1D) barcode formats to scan.
1372
1464
  @defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN_7", "PZN_8", "UPC_A", "UPC_E"];
@@ -1492,10 +1584,12 @@ export declare class BarcodeFormatCommonConfiguration {
1492
1584
  */
1493
1585
  minimum1DQuietZoneSize: number;
1494
1586
  /**
1495
- In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
1587
+ Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
1588
+ Linear barcodes are more prone to false positives.
1589
+ Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
1496
1590
  @defaultValue 1;
1497
1591
  */
1498
- minimum1DConfirmationCount: number;
1592
+ minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
1499
1593
  /**
1500
1594
  If true, the check digits are stripped from the result.
1501
1595
  @defaultValue false;
@@ -1522,10 +1616,10 @@ export declare class BarcodeFormatCommonConfiguration {
1522
1616
  */
1523
1617
  strictMode: boolean;
1524
1618
  /**
1525
- If true, barcodes with heavy blur or from far distance are tried to scan.
1526
- @defaultValue true;
1619
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
1620
+ @defaultValue "THOROUGH";
1527
1621
  */
1528
- enableOneDBlurScanner: boolean;
1622
+ oneDConfirmationMode: OneDConfirmationMode;
1529
1623
  /**
1530
1624
  List of barcode formats to scan. By default, the most commonly used formats are enabled.
1531
1625
  @defaultValue ["AZTEC", "CODABAR", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "ITF", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"];
@@ -864,8 +864,8 @@ export declare class VCard {
864
864
  get emails(): VCard.Email[];
865
865
  /** An array of all children of type "IMPP". */
866
866
  get impps(): VCard.IMPP[];
867
- /** An array of all children of type "Languages". */
868
- get languageses(): VCard.Languages[];
867
+ /** An array of all children of type "Language". */
868
+ get languages(): VCard.Language[];
869
869
  /** An array of all children of type "TimeZone". */
870
870
  get timeZones(): VCard.TimeZone[];
871
871
  /** An array of all children of type "GeoLocation". */
@@ -884,8 +884,8 @@ export declare class VCard {
884
884
  get members(): VCard.Member[];
885
885
  /** An array of all children of type "Related". */
886
886
  get relateds(): VCard.Related[];
887
- /** An array of all children of type "Categories". */
888
- get categorieses(): VCard.Categories[];
887
+ /** An array of all children of type "Category". */
888
+ get categories(): VCard.Category[];
889
889
  /** An array of all children of type "Note". */
890
890
  get notes(): VCard.Note[];
891
891
  /** The child document of type "ProductId". */
@@ -903,11 +903,11 @@ export declare class VCard {
903
903
  /** An array of all children of type "PublicKey". */
904
904
  get publicKeys(): VCard.PublicKey[];
905
905
  /** An array of all children of type "BusyTimeURL". */
906
- get busyTimeURLS(): VCard.BusyTimeURL[];
906
+ get busyTimeURLs(): VCard.BusyTimeURL[];
907
907
  /** An array of all children of type "CalendarURIForRequests". */
908
908
  get calendarURIForRequestss(): VCard.CalendarURIForRequests[];
909
909
  /** An array of all children of type "CalendarURI". */
910
- get calendarURwe(): VCard.CalendarURI[];
910
+ get calendarURIs(): VCard.CalendarURI[];
911
911
  /** The child document of type "SortString". */
912
912
  get sortString(): VCard.SortString | undefined;
913
913
  /** The child document of type "Classification". */
@@ -1031,9 +1031,9 @@ export declare namespace VCard {
1031
1031
  constructor(document: GenericDocument);
1032
1032
  requiredDocumentType(): string;
1033
1033
  }
1034
- /** Languages */
1035
- class Languages extends Entry {
1036
- static readonly DOCUMENT_TYPE = "Languages";
1034
+ /** Language */
1035
+ class Language extends Entry {
1036
+ static readonly DOCUMENT_TYPE = "Language";
1037
1037
  constructor(document: GenericDocument);
1038
1038
  requiredDocumentType(): string;
1039
1039
  }
@@ -1091,9 +1091,9 @@ export declare namespace VCard {
1091
1091
  constructor(document: GenericDocument);
1092
1092
  requiredDocumentType(): string;
1093
1093
  }
1094
- /** Categories */
1095
- class Categories extends Entry {
1096
- static readonly DOCUMENT_TYPE = "Categories";
1094
+ /** Category */
1095
+ class Category extends Entry {
1096
+ static readonly DOCUMENT_TYPE = "Category";
1097
1097
  constructor(document: GenericDocument);
1098
1098
  requiredDocumentType(): string;
1099
1099
  }
@@ -221,11 +221,6 @@ export declare class BarcodeScannerConfiguration {
221
221
  */
222
222
  returnBarcodeImage: boolean;
223
223
  /**
224
- The engine mode for barcode scanning.
225
- @defaultValue "NEXT_GEN_LOW_POWER";
226
- */
227
- engineMode: BarcodeScannerEngineMode;
228
- /**
229
224
  Configuration to accumulate barcodes across multiple frames in live mode.
230
225
  @defaultValue new BarcodeAccumulationConfiguration({});
231
226
  */
@@ -237,6 +232,19 @@ export declare class BarcodeScannerConfiguration {
237
232
  */
238
233
  optimizedForOverlays: boolean;
239
234
  /**
235
+ In single-shot mode, if the combined area of detected barcodes exceeds this fraction of the input image, the scanner returns the result immediately.
236
+ Further scanning is skipped, even if more barcodes may be present.
237
+ This can be used to accelerate scanning when barcode sizes are known in advance.
238
+ To disable this behaviour, the value must be set to 1.0.
239
+ @defaultValue 0.8;
240
+ */
241
+ directAcceptanceAreaFraction: number;
242
+ /**
243
+ The engine mode for barcode scanning.
244
+ @defaultValue "NEXT_GEN_LOW_POWER";
245
+ */
246
+ engineMode: BarcodeScannerEngineMode;
247
+ /**
240
248
  Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
241
249
 
242
250
  On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results.
@@ -635,3 +635,38 @@ Return any detected extension if present, but do not require it.
635
635
  "ALLOW_ANY";
636
636
  /** @hidden */
637
637
  export declare const UpcEanExtensionBehaviorValues: ReadonlyArray<UpcEanExtensionBehavior>;
638
+ /**
639
+ Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
640
+ Some barcode types are naturally prone to false positives (e.g. MSI Plessey).
641
+ For those barcode types false positives can be drastically reduced (precision can be increased) by requiring that multiple scan-lines in the input scan to the same result.
642
+ However, this stronger condition can lead to missed barcodes (lower recall).
643
+ Confirmation is avoided for barcode types, which are by design resistant to false positives, (e.g. Code128) to maximize recall.
644
+
645
+ - `NONE`:
646
+ No confirmation is required. This mode is the most prone to generating false positives.
647
+ - `MINIMAL`:
648
+ Minimal confirmation is performed. Compared to no confirmation, it provides a substantial decrease in false positives (increased precision), at the cost of a minimal decrease in recall.
649
+ - `MODERATE`:
650
+ Moderate confirmation is performed. Compared to minimal confirmation, it provides an additional decrease in false positives, at the cost of a slight decrease in recall.
651
+ - `THOROUGH`:
652
+ Recommended. Thorough confirmation is performed. Almost completely eliminates false positives, at the cost of an additional slight decrease in recall.
653
+ */
654
+ export type OneDConfirmationMode =
655
+ /**
656
+ No confirmation is required. This mode is the most prone to generating false positives.
657
+ */
658
+ "NONE" |
659
+ /**
660
+ Minimal confirmation is performed. Compared to no confirmation, it provides a substantial decrease in false positives (increased precision), at the cost of a minimal decrease in recall.
661
+ */
662
+ "MINIMAL" |
663
+ /**
664
+ Moderate confirmation is performed. Compared to minimal confirmation, it provides an additional decrease in false positives, at the cost of a slight decrease in recall.
665
+ */
666
+ "MODERATE" |
667
+ /**
668
+ Recommended. Thorough confirmation is performed. Almost completely eliminates false positives, at the cost of an additional slight decrease in recall.
669
+ */
670
+ "THOROUGH";
671
+ /** @hidden */
672
+ export declare const OneDConfirmationModeValues: ReadonlyArray<OneDConfirmationMode>;
@@ -55,6 +55,8 @@ Common field types.
55
55
  Full name field.
56
56
  - `CARD_ACCESS_NUMBER`:
57
57
  Card access number field.
58
+ - `PERSONAL_ID`:
59
+ ID of the holder of the document.
58
60
  */
59
61
  export type CommonFieldType =
60
62
  /**
@@ -164,6 +166,10 @@ Full name field.
164
166
  /**
165
167
  Card access number field.
166
168
  */
167
- "CARD_ACCESS_NUMBER";
169
+ "CARD_ACCESS_NUMBER" |
170
+ /**
171
+ ID of the holder of the document.
172
+ */
173
+ "PERSONAL_ID";
168
174
  /** @hidden */
169
175
  export declare const CommonFieldTypeValues: ReadonlyArray<CommonFieldType>;