scanbot-web-sdk 7.2.0-rc.2 → 7.2.0-rc.3

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 (58) hide show
  1. package/@types/barcode-scanner-view.d.ts +1 -1
  2. package/@types/core/bridge/compiled/BarcodeConfigurationTypes.d.ts +25 -20
  3. package/@types/core/bridge/compiled/BarcodeDocumentTypes.d.ts +1 -1
  4. package/@types/core/bridge/compiled/BarcodeScannerTypes.d.ts +12 -11
  5. package/@types/core/bridge/compiled/BarcodeTypes.d.ts +2 -2
  6. package/@types/core/bridge/compiled/CheckScannerTypes.d.ts +13 -13
  7. package/@types/core/bridge/compiled/CommonFieldType.d.ts +1 -1
  8. package/@types/core/bridge/compiled/CreditCardTypes.d.ts +10 -5
  9. package/@types/core/bridge/compiled/DocumentDataExtractorConfigurationTypes.d.ts +2 -2
  10. package/@types/core/bridge/compiled/DocumentDataExtractorTypes.d.ts +3 -3
  11. package/@types/core/bridge/compiled/DocumentQualityAnalyzerTypes.d.ts +12 -5
  12. package/@types/core/bridge/compiled/DocumentScannerTypes.d.ts +7 -13
  13. package/@types/core/bridge/compiled/EuropeanHealthInsuranceCardTypes.d.ts +1 -1
  14. package/@types/core/bridge/compiled/FrameAccumulationTypes.d.ts +1 -1
  15. package/@types/core/bridge/compiled/GenericDocument.d.ts +3 -3
  16. package/@types/core/bridge/compiled/Geometry.d.ts +2 -2
  17. package/@types/core/bridge/compiled/LicensePlateScannerTypes.d.ts +2 -2
  18. package/@types/core/bridge/compiled/MedicalCertificateTypes.d.ts +3 -3
  19. package/@types/core/bridge/compiled/MrzTypes.d.ts +7 -2
  20. package/@types/core/bridge/compiled/ObjectPoolTypes.d.ts +1 -6
  21. package/@types/core/bridge/compiled/OcrTypes.d.ts +2 -2
  22. package/@types/core/bridge/compiled/ParametricFilters.d.ts +1 -1
  23. package/@types/core/bridge/compiled/PdfConfigurationTypes.d.ts +2 -2
  24. package/@types/core/bridge/compiled/SdkLicenseInfo.d.ts +2 -2
  25. package/@types/core/bridge/compiled/TextPatternScannerTypes.d.ts +20 -7
  26. package/@types/core/bridge/compiled/TiffTypes.d.ts +3 -3
  27. package/@types/core/bridge/compiled/VinScannerTypes.d.ts +3 -3
  28. package/@types/core/bridge/worker-bridge.d.ts +18 -14
  29. package/@types/core/worker/ScanbotSDK.Core.d.ts +1 -1
  30. package/@types/core-types.d.ts +1 -1
  31. package/@types/model/configuration/barcode-scanner-view-configuration.d.ts +1 -1
  32. package/@types/scanbot-sdk.d.ts +8 -5
  33. package/@types/worker/worker-bridge.d.ts +10 -6
  34. package/bundle/ScanbotSDK.min.js +4 -4
  35. package/bundle/ScanbotSDK.ui2.min.js +16 -16
  36. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  37. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  38. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  39. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  40. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  41. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
  42. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
  43. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
  44. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  45. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  46. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  47. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
  48. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
  49. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
  50. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  51. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  52. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  53. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  54. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  55. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
  56. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
  57. package/package.json +1 -1
  58. /package/@types/core/bridge/{common.d.ts → compiled/utils.d.ts} +0 -0
@@ -28,7 +28,7 @@ export default class BarcodeScannerView extends ScannerView<BarcodeScannerProps,
28
28
  popup: BarcodeCalculationPopup | undefined;
29
29
  scannedImage: ScannedImageWithOverlay | undefined;
30
30
  bottomActionBar: BottomActionBar | undefined;
31
- barcodeScannerHandle: ObjectId<"BarcodeScanner"> | null;
31
+ handle: ObjectId<"BarcodeScanner"> | null;
32
32
  readonly barcodes: BarcodeItem[];
33
33
  private detectionRunning;
34
34
  constructor(props: BarcodeScannerProps);
@@ -1,5 +1,5 @@
1
1
  import { BarcodeFormat } from "./BarcodeTypes";
2
- import { DeepPartial, PartiallyConstructible } from "../common";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
3
  import { Gs1Handling } from "./BarcodeTypes";
4
4
  import { UpcEanExtensionBehavior } from "./BarcodeTypes";
5
5
  /**
@@ -49,7 +49,7 @@ export declare class BarcodeFormatCodabarConfiguration extends PartiallyConstruc
49
49
  addAdditionalQuietZone: boolean;
50
50
  /**
51
51
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
52
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
52
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
53
53
  @defaultValue 6;
54
54
  */
55
55
  minimum1DQuietZoneSize: number;
@@ -72,7 +72,7 @@ export declare class BarcodeFormatCodabarConfiguration extends PartiallyConstruc
72
72
  constructor(source?: DeepPartial<BarcodeFormatCodabarConfiguration>);
73
73
  }
74
74
  /**
75
- Code 11 barcode configuration. Add to scanner configuration to scan Code11 barcodes.
75
+ Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.
76
76
  */
77
77
  export declare class BarcodeFormatCode11Configuration extends PartiallyConstructible {
78
78
  readonly _type: "BarcodeFormatCode11Configuration";
@@ -96,7 +96,7 @@ export declare class BarcodeFormatCode11Configuration extends PartiallyConstruct
96
96
  addAdditionalQuietZone: boolean;
97
97
  /**
98
98
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
99
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
99
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
100
100
  @defaultValue 6;
101
101
  */
102
102
  minimum1DQuietZoneSize: number;
@@ -148,7 +148,7 @@ export declare class BarcodeFormatCode39Configuration extends PartiallyConstruct
148
148
  addAdditionalQuietZone: boolean;
149
149
  /**
150
150
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
151
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
151
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
152
152
  @defaultValue 6;
153
153
  */
154
154
  minimum1DQuietZoneSize: number;
@@ -225,11 +225,16 @@ export declare class BarcodeFormatCode93Configuration extends PartiallyConstruct
225
225
  addAdditionalQuietZone: boolean;
226
226
  /**
227
227
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
228
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
228
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
229
229
  @defaultValue 6;
230
230
  */
231
231
  minimum1DQuietZoneSize: number;
232
232
  /**
233
+ If true, the check digits are stripped from the result.
234
+ @defaultValue false;
235
+ */
236
+ stripCheckDigits: boolean;
237
+ /**
233
238
  Minimum text length. Applied only to linear barcode formats that allow variable length.
234
239
  @defaultValue 1;
235
240
  */
@@ -267,7 +272,7 @@ export declare class BarcodeFormatCode128Configuration extends PartiallyConstruc
267
272
  addAdditionalQuietZone: boolean;
268
273
  /**
269
274
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
270
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
275
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
271
276
  @defaultValue 6;
272
277
  */
273
278
  minimum1DQuietZoneSize: number;
@@ -318,7 +323,7 @@ export declare class BarcodeFormatCode2Of5Configuration extends PartiallyConstru
318
323
  addAdditionalQuietZone: boolean;
319
324
  /**
320
325
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
321
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
326
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
322
327
  @defaultValue 6;
323
328
  */
324
329
  minimum1DQuietZoneSize: number;
@@ -385,7 +390,7 @@ export declare class BarcodeFormatDataBarConfiguration extends PartiallyConstruc
385
390
  addAdditionalQuietZone: boolean;
386
391
  /**
387
392
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
388
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
393
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
389
394
  @defaultValue 6;
390
395
  */
391
396
  minimum1DQuietZoneSize: number;
@@ -422,7 +427,7 @@ export declare class BarcodeFormatDataBarExpandedConfiguration extends Partially
422
427
  addAdditionalQuietZone: boolean;
423
428
  /**
424
429
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
425
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
430
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
426
431
  @defaultValue 6;
427
432
  */
428
433
  minimum1DQuietZoneSize: number;
@@ -459,7 +464,7 @@ export declare class BarcodeFormatDataBarLimitedConfiguration extends PartiallyC
459
464
  addAdditionalQuietZone: boolean;
460
465
  /**
461
466
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
462
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
467
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
463
468
  @defaultValue 6;
464
469
  */
465
470
  minimum1DQuietZoneSize: number;
@@ -496,7 +501,7 @@ export declare class BarcodeFormatItfConfiguration extends PartiallyConstructibl
496
501
  addAdditionalQuietZone: boolean;
497
502
  /**
498
503
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
499
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
504
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
500
505
  @defaultValue 6;
501
506
  */
502
507
  minimum1DQuietZoneSize: number;
@@ -556,7 +561,7 @@ export declare class BarcodeFormatMsiPlesseyConfiguration extends PartiallyConst
556
561
  addAdditionalQuietZone: boolean;
557
562
  /**
558
563
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
559
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
564
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
560
565
  @defaultValue 6;
561
566
  */
562
567
  minimum1DQuietZoneSize: number;
@@ -610,7 +615,7 @@ export declare class BarcodeFormatUpcEanConfiguration extends PartiallyConstruct
610
615
  addAdditionalQuietZone: boolean;
611
616
  /**
612
617
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
613
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
618
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
614
619
  @defaultValue 6;
615
620
  */
616
621
  minimum1DQuietZoneSize: number;
@@ -672,7 +677,7 @@ export declare class BarcodeFormatPharmaCodeConfiguration extends PartiallyConst
672
677
  addAdditionalQuietZone: boolean;
673
678
  /**
674
679
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
675
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
680
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
676
681
  @defaultValue 6;
677
682
  */
678
683
  minimum1DQuietZoneSize: number;
@@ -928,7 +933,7 @@ export declare namespace BarcodeFormatFourStateConfigurationBase {
928
933
  }): BarcodeFormatFourStateConfigurationBase;
929
934
  }
930
935
  /**
931
- can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
936
+ Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
932
937
 
933
938
  - `NUMERIC`:
934
939
  Numeric.
@@ -961,7 +966,7 @@ export declare class BarcodeFormatAustraliaPostConfiguration extends PartiallyCo
961
966
  */
962
967
  addAdditionalQuietZone: boolean;
963
968
  /**
964
- Can be either numeric or alpha-numeric and is only relevant for Format Codes 59 and 62.
969
+ Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
965
970
  @defaultValue "ALPHA_NUMERIC";
966
971
  */
967
972
  australiaPostCustomerFormat: AustraliaPostCustomerFormat;
@@ -1144,7 +1149,7 @@ export declare class BarcodeFormatGs1CompositeConfiguration extends PartiallyCon
1144
1149
  addAdditionalQuietZone: boolean;
1145
1150
  /**
1146
1151
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
1147
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
1152
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
1148
1153
  @defaultValue 6;
1149
1154
  */
1150
1155
  minimum1DQuietZoneSize: number;
@@ -1191,7 +1196,7 @@ export declare class BarcodeFormatCommonOneDConfiguration extends PartiallyConst
1191
1196
  addAdditionalQuietZone: boolean;
1192
1197
  /**
1193
1198
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
1194
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
1199
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
1195
1200
  @defaultValue 6;
1196
1201
  */
1197
1202
  minimum1DQuietZoneSize: number;
@@ -1335,7 +1340,7 @@ export declare class BarcodeFormatCommonConfiguration extends PartiallyConstruct
1335
1340
  addAdditionalQuietZone: boolean;
1336
1341
  /**
1337
1342
  Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
1338
- The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.
1343
+ The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
1339
1344
  @defaultValue 6;
1340
1345
  */
1341
1346
  minimum1DQuietZoneSize: number;
@@ -1,5 +1,5 @@
1
1
  import { BarcodeFormat } from "./BarcodeTypes";
2
- import { DeepPartial, PartiallyConstructible } from "../common";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
3
  /**
4
4
  Type of barcode document format used.
5
5
 
@@ -1,10 +1,10 @@
1
1
  import { BarcodeDocumentFormat } from "./BarcodeDocumentTypes";
2
2
  import { BarcodeFormatConfigurationBase } from "./BarcodeConfigurationTypes";
3
3
  import { BarcodeFormat } from "./BarcodeTypes";
4
- import { DeepPartial, PartiallyConstructible } from "../common";
4
+ import { DeepPartial, PartiallyConstructible } from "./utils";
5
5
  import { GenericDocument } from "./GenericDocument";
6
- import { Point } from "../common";
7
- import { RawImage } from "../common";
6
+ import { Point } from "./utils";
7
+ import { RawImage } from "./utils";
8
8
  /**
9
9
  A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
10
10
  */
@@ -84,12 +84,12 @@ The engine mode for barcode scanning.
84
84
  A faster version of the main engine mode, for use with low-power devices.
85
85
  - `NEXT_GEN`:
86
86
  Main engine mode for high-power devices. Supports all barcodes types.
87
- - `NEXT_GEN_LOW_POWER_AR`:
88
- Similar to NEXT_GEN_LOW_POWER, but optimized for AR.
89
- - `NEXT_GEN_AR`:
90
- Similar to NEXT_GEN, but optimized for AR.
87
+ - `NEXT_GEN_LOW_POWER_FAR_DISTANCE`:
88
+ Similar to NEXT_GEN_LOW_POWER, but optimized for scanning from far distances.
89
+ - `NEXT_GEN_FAR_DISTANCE`:
90
+ Similar to NEXT_GEN, optimized for scanning from far distances.
91
91
  */
92
- export type BarcodeScannerEngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_LOW_POWER_AR" | "NEXT_GEN_AR";
92
+ export type BarcodeScannerEngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_LOW_POWER_FAR_DISTANCE" | "NEXT_GEN_FAR_DISTANCE";
93
93
  export declare const BarcodeScannerEngineModeValues: BarcodeScannerEngineMode[];
94
94
  /**
95
95
  Configuration for the barcode scanner.
@@ -125,10 +125,11 @@ export declare class BarcodeScannerConfiguration extends PartiallyConstructible
125
125
  */
126
126
  engineMode: BarcodeScannerEngineMode;
127
127
  /**
128
- If true, the barcode scanning will be performed in live mode.
129
- @defaultValue true;
128
+ If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image.
129
+ This will also produce stabler barcode outlines across frames for use cases such as AR.
130
+ @defaultValue false;
130
131
  */
131
- live: boolean;
132
+ optimizedForOverlays: boolean;
132
133
  /** @param source {@displayType `DeepPartial<BarcodeScannerConfiguration>`} */
133
134
  constructor(source?: DeepPartial<BarcodeScannerConfiguration>);
134
135
  }
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  /**
3
3
  Enumerates barcode formats.
4
4
 
@@ -120,7 +120,7 @@ export declare namespace BarcodeFormats {
120
120
  }
121
121
  /**
122
122
  GS1 message handling options.
123
- The GS1 standard defines a a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types.
123
+ The GS1 standard defines a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types.
124
124
  https://ref.gs1.org/standards/genspecs/
125
125
 
126
126
  GS1 messages have two representations or formats: a human-readable format and a
@@ -1,40 +1,40 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { DocumentDetectionResult } from "./DocumentScannerTypes";
3
3
  import { GenericDocument } from "./GenericDocument";
4
- import { RawImage } from "../common";
4
+ import { RawImage } from "./utils";
5
5
  /**
6
6
  Check document detection and extraction mode.
7
7
 
8
8
  - `DISABLED`:
9
9
  Document detection is not performed. Successful check scans will only contain the machine-readable check data without a full crop of the check.
10
10
  - `DETECT_DOCUMENT`:
11
- Document scanner will be used to locate the complete check in the input image. The documentDetectionResult field in the result will contain the result of document detection.
11
+ Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection.
12
12
  - `DETECT_AND_CROP_DOCUMENT`:
13
13
  Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection. The croppedImage result field will contain a crop of the entire check.
14
14
  */
15
15
  export type CheckDocumentDetectionMode = "DISABLED" | "DETECT_DOCUMENT" | "DETECT_AND_CROP_DOCUMENT";
16
16
  export declare const CheckDocumentDetectionModeValues: CheckDocumentDetectionMode[];
17
17
  /**
18
- Check Scanning Status.
18
+ Check magnetic ink (MICR) strip scanning status.
19
19
 
20
20
  - `SUCCESS`:
21
21
  Scanning successful.
22
- - `VALIDATION_FAILED`:
23
- A check was recognized, but validation failed, indication a standard violation, unsupported standard, or scanner error.
24
- - `FAIL`:
25
- No check was recognized.
22
+ - `INCOMPLETE_VALIDATION`:
23
+ Magnetic ink strip was found, but validation failed, because of a format violation, an unsupported format, or an OCR error.
24
+ - `ERROR_NOTHING_FOUND`:
25
+ Magnetic ink strip was not found.
26
26
  */
27
- export type CheckRecognitionStatus = "SUCCESS" | "VALIDATION_FAILED" | "FAIL";
28
- export declare const CheckRecognitionStatusValues: CheckRecognitionStatus[];
27
+ export type CheckMagneticInkStripScanningStatus = "SUCCESS" | "INCOMPLETE_VALIDATION" | "ERROR_NOTHING_FOUND";
28
+ export declare const CheckMagneticInkStripScanningStatusValues: CheckMagneticInkStripScanningStatus[];
29
29
  /**
30
30
  The result of check scanning.
31
31
  */
32
32
  export declare class CheckScanningResult extends PartiallyConstructible {
33
33
  /**
34
- Check recognition status.
35
- @defaultValue "FAIL";
34
+ Magnetic ink strip scanning status.
35
+ @defaultValue "ERROR_NOTHING_FOUND";
36
36
  */
37
- readonly status: CheckRecognitionStatus;
37
+ readonly status: CheckMagneticInkStripScanningStatus;
38
38
  /**
39
39
  Generic document containing check data. Not present, if status is FAIL.
40
40
  */
@@ -18,7 +18,7 @@ Common field types.
18
18
  - `EXPIRY_DATE`:
19
19
  Document expiry date field.
20
20
  - `EYE_COLOR`:
21
- Person height field.
21
+ Person eye color field.
22
22
  - `HEIGHT`:
23
23
  Person height field.
24
24
  - `ISSUE_DATE`:
@@ -1,7 +1,7 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { DocumentDetectionStatus } from "./DocumentScannerTypes";
3
3
  import { GenericDocument } from "./GenericDocument";
4
- import { Point } from "../common";
4
+ import { Point } from "./utils";
5
5
  import { ResultAccumulationConfiguration } from "./FrameAccumulationTypes";
6
6
  /**
7
7
  The status of the scanning process.
@@ -36,7 +36,7 @@ export declare class CreditCardScanningResult extends PartiallyConstructible {
36
36
  */
37
37
  readonly quad: Point[];
38
38
  /**
39
- Coordinates of the detected credit card in the input image (clockwise from top-left), normalized to the range [0, 1].
39
+ Coordinates of the detected credit card in the input image (clockwise from top-left), normalized to the range [0, 1]
40
40
  */
41
41
  readonly quadNormalized: Point[];
42
42
  /** @param source {@displayType `DeepPartial<CreditCardScanningResult>`} */
@@ -69,12 +69,12 @@ export declare class CreditCardScannerConfiguration extends PartiallyConstructib
69
69
  */
70
70
  scanningMode: CreditCardScanningMode;
71
71
  /**
72
- Whether the expiry date is required for a successful scanning.
72
+ Whether the expiry date is required for a successful scan.
73
73
  @defaultValue true;
74
74
  */
75
75
  requireExpiryDate: boolean;
76
76
  /**
77
- Whether the cardholder name is required for a successful scanning.
77
+ Whether the cardholder name is required for a successful scan.
78
78
  @defaultValue true;
79
79
  */
80
80
  requireCardholderName: boolean;
@@ -83,6 +83,11 @@ export declare class CreditCardScannerConfiguration extends PartiallyConstructib
83
83
  @defaultValue new ResultAccumulationConfiguration({});
84
84
  */
85
85
  resultAccumulationConfig: ResultAccumulationConfiguration;
86
+ /**
87
+ If true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
88
+ @defaultValue false;
89
+ */
90
+ returnCreditCardImage: boolean;
86
91
  /** @param source {@displayType `DeepPartial<CreditCardScannerConfiguration>`} */
87
92
  constructor(source?: DeepPartial<CreditCardScannerConfiguration>);
88
93
  }
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { MrzDocumentType } from "./MrzTypes";
3
3
  /**
4
4
  Base class for all generic document configuration elements.
@@ -103,7 +103,7 @@ European Health Insurance Card (EHIC) configuration element. Add to extractor co
103
103
  export declare class EuropeanHealthInsuranceCardConfiguration extends PartiallyConstructible {
104
104
  readonly _type: "EuropeanHealthInsuranceCardConfiguration";
105
105
  /**
106
- If an expected country is selected, validation rules for the given country are used, a
106
+ If an expected country is selected, validation rules for the given country are used,
107
107
  and if the expected country cannot be inferred or the inferred country doesn't match the given country,
108
108
  the result of extract() will be IncompleteValidation.
109
109
  @defaultValue null;
@@ -1,8 +1,8 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { DocumentDataExtractorConfigurationElement } from "./DocumentDataExtractorConfigurationTypes";
3
3
  import { DocumentDetectionResult } from "./DocumentScannerTypes";
4
4
  import { GenericDocument } from "./GenericDocument";
5
- import { RawImage } from "../common";
5
+ import { RawImage } from "./utils";
6
6
  import { ResultAccumulationConfiguration } from "./FrameAccumulationTypes";
7
7
  /**
8
8
  The status of the extraction process.
@@ -60,7 +60,7 @@ Parameters for the extraction process.
60
60
  */
61
61
  export declare class DocumentDataFrameExtractionParameters extends PartiallyConstructible {
62
62
  /**
63
- The extraction.
63
+ The extraction mode.
64
64
  @defaultValue "LIVE";
65
65
  */
66
66
  mode: DocumentDataExtractionMode;
@@ -1,5 +1,5 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { RawImage } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
+ import { RawImage } from "./utils";
3
3
  /**
4
4
  Result of document quality analysis.
5
5
 
@@ -63,22 +63,29 @@ export declare class DocumentQualityAnalyzerConfiguration extends PartiallyConst
63
63
  */
64
64
  detectOrientation: boolean;
65
65
  /**
66
+ Inspect small text (typically less than 12 pixels height) when analyzing the document quality.
67
+ If true, processing will be slower, but when the quality issue with a document is the low resolution of the text,
68
+ then the issue will be caught.
69
+ @defaultValue false;
70
+ */
71
+ inspectSmallText: boolean;
72
+ /**
66
73
  Maximum image size in pixels, if image is bigger, it will be resized.
67
74
  @defaultValue 2000;
68
75
  */
69
76
  maxImageSize: number;
70
77
  /**
71
- if estimated number of symbols is less than this value, return that document is not found.
78
+ If estimated number of symbols is less than this value, return that document is not found.
72
79
  @defaultValue 20;
73
80
  */
74
81
  minEstimatedNumberOfSymbolsForDocument: number;
75
82
  /**
76
- at least this fraction of the image will be processed, range is from 0 to 1.
83
+ At least this fraction of the image will be processed, range is from 0 to 1.
77
84
  @defaultValue 0.0;
78
85
  */
79
86
  minProcessedFraction: number;
80
87
  /**
81
- at most this fraction of the image will be processed, range is from 0 to 1.
88
+ At most this fraction of the image will be processed, range is from 0 to 1.
82
89
  @defaultValue 0.5;
83
90
  */
84
91
  maxProcessedFraction: number;
@@ -1,8 +1,8 @@
1
1
  import { AspectRatio } from "./Geometry";
2
- import { DeepPartial, PartiallyConstructible } from "../common";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
3
  import { LineSegmentFloat } from "./Geometry";
4
4
  import { LineSegmentInt } from "./Geometry";
5
- import { Point } from "../common";
5
+ import { Point } from "./utils";
6
6
  /**
7
7
  Engines for document scanning.
8
8
 
@@ -17,18 +17,12 @@ export declare const DocumentScannerEngineModeValues: DocumentScannerEngineMode[
17
17
  Parameters for the document scanner.
18
18
  */
19
19
  export declare class DocumentScannerParameters extends PartiallyConstructible {
20
- /**
21
- If true, the document scanner will return only the best document contour.
22
- If false, the document scanner will additionally return alternative document contours suitable for the cropping screen.
23
- @defaultValue false;
24
- */
25
- isLive: boolean;
26
20
  /**
27
21
  The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
28
22
  Set lower values to accept more perspective distortion.
29
23
 
30
24
  Warning: Lower values result in more blurred document images.
31
- @defaultValue 75.0;
25
+ @defaultValue 75;
32
26
  */
33
27
  acceptedAngleScore: number;
34
28
  /**
@@ -36,7 +30,7 @@ export declare class DocumentScannerParameters extends PartiallyConstructible {
36
30
  It is sufficient that height or width match the score.
37
31
 
38
32
  Warning: Lower values result in low resolution document images.
39
- @defaultValue 80.0;
33
+ @defaultValue 80;
40
34
  */
41
35
  acceptedSizeScore: number;
42
36
  /**
@@ -49,7 +43,7 @@ export declare class DocumentScannerParameters extends PartiallyConstructible {
49
43
  must match one of the required aspect ratios (if any) to accept a detected document.
50
44
  If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio
51
45
  matches one of the given aspect ratios (if any), otherwise OK_BUT_BAD_ASPECT_RATIO is returned.
52
- @defaultValue 85.0;
46
+ @defaultValue 85;
53
47
  */
54
48
  acceptedAspectRatioScore: number;
55
49
  /**
@@ -99,7 +93,7 @@ Status of the document detection.
99
93
  - `OK_BUT_TOO_SMALL`:
100
94
  A document was detected, but it is too small.
101
95
  - `OK_BUT_BAD_ANGLES`:
102
- A polygon was detected, but it has too much perspective distortion.
96
+ A document was detected, but it has too much perspective distortion.
103
97
  - `OK_BUT_BAD_ASPECT_RATIO`:
104
98
  A document was detected, but its aspect ratio is not acceptable.
105
99
  - `OK_BUT_ORIENTATION_MISMATCH`:
@@ -134,7 +128,7 @@ export declare class DocumentDetectionScores extends PartiallyConstructible {
134
128
  */
135
129
  readonly angleScore: number;
136
130
  /**
137
- 100 points if the contour occupies at least 50% of the area of the image
131
+ 100 points, if the contour occupies at least 50% of the area of the image
138
132
  */
139
133
  readonly sizeScore: number;
140
134
  /**
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { EuropeanHealthInsuranceCardIssuingCountry } from "./DocumentDataExtractorConfigurationTypes";
3
3
  /**
4
4
  The result of the health insurance card recognition.
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  /**
3
3
  Method used to confirm a result.
4
4
 
@@ -1,7 +1,7 @@
1
1
  import { CommonFieldType } from "./CommonFieldType";
2
- import { DeepPartial, PartiallyConstructible } from "../common";
3
- import { Point } from "../common";
4
- import { RawImage } from "../common";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
+ import { Point } from "./utils";
4
+ import { RawImage } from "./utils";
5
5
  /**
6
6
  Result of OCR text recognition.
7
7
  */
@@ -1,5 +1,5 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { Point } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
+ import { Point } from "./utils";
3
3
  /**
4
4
  Represents a line segment in 2D space.
5
5
  */
@@ -1,5 +1,5 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { RawImage } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
+ import { RawImage } from "./utils";
3
3
  /**
4
4
  Type of the scanner internally to scan the license plate.
5
5
 
@@ -1,7 +1,7 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { DocumentDetectionResult } from "./DocumentScannerTypes";
3
- import { Point } from "../common";
4
- import { RawImage } from "../common";
3
+ import { Point } from "./utils";
4
+ import { RawImage } from "./utils";
5
5
  /**
6
6
  Parameters for the medical certificate scanning. The scanner supports
7
7
  Form 1 (Arbeitsunfähigkeitsbescheinigung) and
@@ -1,5 +1,5 @@
1
1
  import { AccumulatedResultsVerifierConfiguration } from "./FrameAccumulationTypes";
2
- import { DeepPartial, PartiallyConstructible } from "../common";
2
+ import { DeepPartial, PartiallyConstructible } from "./utils";
3
3
  import { GenericDocument } from "./GenericDocument";
4
4
  /**
5
5
  Type of document containing the MRZ.
@@ -65,9 +65,14 @@ export declare class MrzScannerConfiguration extends PartiallyConstructible {
65
65
  enableDetection: boolean;
66
66
  /**
67
67
  Defines how to handle incomplete MRZ results (e.g. caused by failed validation).
68
- @defaultValue "ACCEPT";
68
+ @defaultValue "REJECT";
69
69
  */
70
70
  incompleteResultHandling: MrzIncompleteResultHandling;
71
+ /**
72
+ If true, crops of the detected MRZ and its fields will be returned in the result.
73
+ @defaultValue false;
74
+ */
75
+ returnCrops: boolean;
71
76
  /** @param source {@displayType `DeepPartial<MrzScannerConfiguration>`} */
72
77
  constructor(source?: DeepPartial<MrzScannerConfiguration>);
73
78
  }
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  /**
3
3
  Profile info of a reference-counted stored object.
4
4
  */
@@ -21,11 +21,6 @@ export declare class RefCountedObjectProfile extends PartiallyConstructible {
21
21
  @defaultValue 0;
22
22
  */
23
23
  readonly serializedReferences: number;
24
- /**
25
- True, if a serialized reference to this object has likely leaked. Serialized references cannot be tracked via garbage collection (GC) or automatic reference counting (ARC), so they're much more likely to leak. On the other hand, serialized references are almost immediately deserialized (and thus converted to strong references) in all code paths, so the serialized reference count should be zero most of the time. If a serialized reference has existed for more than 5 seconds, it can be assumed that it has leaked.
26
- @defaultValue false;
27
- */
28
- readonly serializedReferenceLeak: boolean;
29
24
  /** @param source {@displayType `DeepPartial<RefCountedObjectProfile>`} */
30
25
  constructor(source?: DeepPartial<RefCountedObjectProfile>);
31
26
  }
@@ -1,5 +1,5 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { Point } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
+ import { Point } from "./utils";
3
3
  /**
4
4
  Base class for units of text, e.g. glyphs, words, lines, blocks, pages.
5
5
  */
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  /**
3
3
  Output mode of binarization filter.
4
4