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
@@ -1,4 +1,4 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  /**
3
3
  PDF attributes.
4
4
  */
@@ -59,7 +59,7 @@ Page size.
59
59
  - `COMM10`:
60
60
  4.125 x 9.5 (inches) 297 x 684 (pixels) at 72 DPI.
61
61
  - `CUSTOM`:
62
- physical size will be calculated from the image dimensions and the `dpi` parameter.
62
+ Physical size will be calculated from the image dimensions and the `dpi` parameter.
63
63
  */
64
64
  export type PageSize = "LETTER" | "LEGAL" | "A3" | "A4" | "A5" | "B4" | "B5" | "EXECUTIVE" | "US4x6" | "US4x8" | "US5x7" | "COMM10" | "CUSTOM";
65
65
  export declare const PageSizeValues: PageSize[];
@@ -1,6 +1,6 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  /**
3
- Status of the license plate scanner.
3
+ Status of the license.
4
4
 
5
5
  - `OKAY`:
6
6
  License is valid and accepted.
@@ -1,5 +1,16 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { Rectangle } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
+ import { Rectangle } from "./utils";
3
+ /**
4
+ Grammar of pattern matching.
5
+
6
+ - `WILDCARD`:
7
+ Simple pattern matching where # stands for any digit and ? stands for any character.
8
+ All other characters represent themselves.
9
+ - `REGEX`:
10
+ Regular expression pattern matching. Uses ECMAScript grammar.
11
+ */
12
+ export type PatternGrammar = "WILDCARD" | "REGEX";
13
+ export declare const PatternGrammarValues: PatternGrammar[];
3
14
  /**
4
15
  Structure containing recognized word text and bounds.
5
16
  */
@@ -103,10 +114,7 @@ export declare class PatternContentValidator extends PartiallyConstructible {
103
114
  */
104
115
  allowedCharacters: string;
105
116
  /**
106
- Wildcard validation pattern.
107
- ? - any character
108
- # - any digit
109
- all other characters represent themselves
117
+ Pattern to match. It can be a simple pattern or a regular expression.
110
118
  */
111
119
  pattern: string;
112
120
  /**
@@ -114,6 +122,11 @@ export declare class PatternContentValidator extends PartiallyConstructible {
114
122
  @defaultValue false;
115
123
  */
116
124
  matchSubstring: boolean;
125
+ /**
126
+ Grammar of pattern matching.
127
+ @defaultValue "WILDCARD";
128
+ */
129
+ patternGrammar: PatternGrammar;
117
130
  /** @param source {@displayType `DeepPartial<PatternContentValidator>`} */
118
131
  constructor(source?: DeepPartial<PatternContentValidator>);
119
132
  }
@@ -122,7 +135,7 @@ Configuration for the text pattern scanner.
122
135
  */
123
136
  export declare class TextPatternScannerConfiguration extends PartiallyConstructible {
124
137
  /**
125
- Maximum image side (height or width) for OCR process. 0 - do not rescale.
138
+ Maximum image size (height or width) for OCR process. 0 - do not rescale.
126
139
  @defaultValue 0;
127
140
  */
128
141
  ocrResolutionLimit: number;
@@ -1,10 +1,10 @@
1
- import { DeepPartial, PartiallyConstructible } from "../common";
1
+ import { DeepPartial, PartiallyConstructible } from "./utils";
2
2
  import { ParametricFilter } from "./ParametricFilters";
3
3
  /**
4
4
  TIFF compression type.
5
5
 
6
6
  - `NONE`:
7
- dump mode.
7
+ Dump mode.
8
8
  - `CCITTRLE`:
9
9
  CCITT modified Huffman RLE. For binarized images only.
10
10
  - `CCITT_T4`:
@@ -137,7 +137,7 @@ export declare class TiffGeneratorParameters extends PartiallyConstructible {
137
137
  /**
138
138
  Filter to apply to the input image when adding pages with binarization.
139
139
  If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF.
140
- When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITTFAX4)
140
+ When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6)
141
141
  instead of the default, as it tends to produce the smallest file sizes.
142
142
  If not set, simple thresholding is applied to the image, instead.
143
143
  @defaultValue null;
@@ -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
  import { TextPatternScannerResult } from "./TextPatternScannerTypes";
4
4
  /**
5
5
  Status of the barcode extraction.
@@ -60,7 +60,7 @@ export declare class VinScannerConfiguration extends PartiallyConstructible {
60
60
  */
61
61
  extractVINFromBarcode: boolean;
62
62
  /**
63
- Maximum image side (height or width) for OCR process. 0 - do not rescale.
63
+ Maximum image size (height or width) for OCR process. 0 - do not rescale.
64
64
  @defaultValue 0;
65
65
  */
66
66
  ocrResolutionLimit: number;
@@ -24,7 +24,6 @@ export declare class WorkerBridge {
24
24
  getLicenseInfo: () => Promise<import("./compiled/SdkLicenseInfo").SdkLicenseInfo>;
25
25
  encodeJpeg: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<Uint8Array>;
26
26
  detectDocument: (image: import("../worker/ScanbotSDK.Core").Image, options: {
27
- isLive?: boolean;
28
27
  acceptedAngleScore?: number;
29
28
  acceptedSizeScore?: number;
30
29
  acceptedBrightnessThreshold?: number;
@@ -39,7 +38,6 @@ export declare class WorkerBridge {
39
38
  }) => Promise<import("./compiled/DocumentScannerTypes").DocumentDetectionResult>;
40
39
  detectAndCropDocument: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("../worker/ScanbotSDK.Core").CroppedDetectionResult>;
41
40
  createDocumentScanner: (options: {
42
- isLive?: boolean;
43
41
  acceptedAngleScore?: number;
44
42
  acceptedSizeScore?: number;
45
43
  acceptedBrightnessThreshold?: number;
@@ -100,6 +98,7 @@ export declare class WorkerBridge {
100
98
  minimumSizeScore?: number;
101
99
  addAdditionalQuietZone?: boolean;
102
100
  minimum1DQuietZoneSize?: number;
101
+ stripCheckDigits?: boolean;
103
102
  minimumTextLength?: number;
104
103
  maximumTextLength?: number;
105
104
  _marker?: () => void;
@@ -335,7 +334,7 @@ export declare class WorkerBridge {
335
334
  onlyAcceptDocuments?: boolean;
336
335
  returnBarcodeImage?: boolean;
337
336
  engineMode?: import("./compiled/BarcodeScannerTypes").BarcodeScannerEngineMode;
338
- live?: boolean;
337
+ optimizedForOverlays?: boolean;
339
338
  _marker?: () => void;
340
339
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeScanner">>;
341
340
  scanBarcodes: <ImageType_1 extends import("../worker/ScanbotSDK.Core").Image>(barcodeScannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeScanner">, image: ImageType_1) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult & {
@@ -434,6 +433,7 @@ export declare class WorkerBridge {
434
433
  };
435
434
  enableDetection?: boolean;
436
435
  incompleteResultHandling?: import("./compiled/MrzTypes").MrzIncompleteResultHandling;
436
+ returnCrops?: boolean;
437
437
  _marker?: () => void;
438
438
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"MRZScannerContext">>;
439
439
  scanMRZ: <ImageType_2 extends import("../worker/ScanbotSDK.Core").Image>(mrzScannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"MRZScannerContext">, image: ImageType_2) => Promise<import("./compiled/MrzTypes").MrzScannerResult & {
@@ -455,6 +455,7 @@ export declare class WorkerBridge {
455
455
  allowedCharacters?: string;
456
456
  pattern?: string;
457
457
  matchSubstring?: boolean;
458
+ patternGrammar?: import("./compiled/TextPatternScannerTypes").PatternGrammar;
458
459
  _marker?: () => void;
459
460
  };
460
461
  _marker?: () => void;
@@ -482,6 +483,7 @@ export declare class WorkerBridge {
482
483
  }[];
483
484
  qualityIndices?: import("./compiled/DocumentQualityAnalyzerTypes").DocumentQuality[];
484
485
  detectOrientation?: boolean;
486
+ inspectSmallText?: boolean;
485
487
  maxImageSize?: number;
486
488
  minEstimatedNumberOfSymbolsForDocument?: number;
487
489
  minProcessedFraction?: number;
@@ -492,10 +494,10 @@ export declare class WorkerBridge {
492
494
  _marker?: () => void;
493
495
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">>;
494
496
  documentQualityAnalyzerAnalyze: (dqaToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/DocumentQualityAnalyzerTypes").DocumentQualityAnalyzerResult>;
495
- imageApplyFilter: (image: import("../worker/ScanbotSDK.Core").Image, filter: import("./common").DeepPartial<import("./compiled/ParametricFilters").ParametricFilter>) => Promise<import("./common").RawImage>;
496
- imageCrop: (image: import("../worker/ScanbotSDK.Core").Image, polygon: [import("./common").Point, import("./common").Point, import("./common").Point, import("./common").Point]) => Promise<import("./common").RawImage>;
497
- imageResize: (image: import("../worker/ScanbotSDK.Core").Image, destinationSize: number) => Promise<import("./common").RawImage>;
498
- imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageTypes").ImageRotation) => Promise<import("./common").RawImage>;
497
+ imageApplyFilter: (image: import("../worker/ScanbotSDK.Core").Image, filter: import("./compiled/utils").DeepPartial<import("./compiled/ParametricFilters").ParametricFilter>) => Promise<import("./compiled/utils").RawImage>;
498
+ imageCrop: (image: import("../worker/ScanbotSDK.Core").Image, polygon: [import("./compiled/utils").Point, import("./compiled/utils").Point, import("./compiled/utils").Point, import("./compiled/utils").Point]) => Promise<import("./compiled/utils").RawImage>;
499
+ imageResize: (image: import("../worker/ScanbotSDK.Core").Image, destinationSize: number) => Promise<import("./compiled/utils").RawImage>;
500
+ imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageTypes").ImageRotation) => Promise<import("./compiled/utils").RawImage>;
499
501
  documentDataExtractorCreate: (parameters: {
500
502
  resultAccumulationConfig?: {
501
503
  confirmationMethod?: import("./compiled/FrameAccumulationTypes").ConfirmationMethod;
@@ -548,7 +550,6 @@ export declare class WorkerBridge {
548
550
  getLicenseInfo: () => Promise<import("./compiled/SdkLicenseInfo").SdkLicenseInfo>;
549
551
  encodeJpeg: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<Uint8Array>;
550
552
  detectDocument: (image: import("../worker/ScanbotSDK.Core").Image, options: {
551
- isLive?: boolean;
552
553
  acceptedAngleScore?: number;
553
554
  acceptedSizeScore?: number;
554
555
  acceptedBrightnessThreshold?: number;
@@ -563,7 +564,6 @@ export declare class WorkerBridge {
563
564
  }) => Promise<import("./compiled/DocumentScannerTypes").DocumentDetectionResult>;
564
565
  detectAndCropDocument: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("../worker/ScanbotSDK.Core").CroppedDetectionResult>;
565
566
  createDocumentScanner: (options: {
566
- isLive?: boolean;
567
567
  acceptedAngleScore?: number;
568
568
  acceptedSizeScore?: number;
569
569
  acceptedBrightnessThreshold?: number;
@@ -624,6 +624,7 @@ export declare class WorkerBridge {
624
624
  minimumSizeScore?: number;
625
625
  addAdditionalQuietZone?: boolean;
626
626
  minimum1DQuietZoneSize?: number;
627
+ stripCheckDigits?: boolean;
627
628
  minimumTextLength?: number;
628
629
  maximumTextLength?: number;
629
630
  _marker?: () => void;
@@ -859,7 +860,7 @@ export declare class WorkerBridge {
859
860
  onlyAcceptDocuments?: boolean;
860
861
  returnBarcodeImage?: boolean;
861
862
  engineMode?: import("./compiled/BarcodeScannerTypes").BarcodeScannerEngineMode;
862
- live?: boolean;
863
+ optimizedForOverlays?: boolean;
863
864
  _marker?: () => void;
864
865
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeScanner">>;
865
866
  scanBarcodes: <ImageType_1 extends import("../worker/ScanbotSDK.Core").Image>(barcodeScannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeScanner">, image: ImageType_1) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult & {
@@ -958,6 +959,7 @@ export declare class WorkerBridge {
958
959
  };
959
960
  enableDetection?: boolean;
960
961
  incompleteResultHandling?: import("./compiled/MrzTypes").MrzIncompleteResultHandling;
962
+ returnCrops?: boolean;
961
963
  _marker?: () => void;
962
964
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"MRZScannerContext">>;
963
965
  scanMRZ: <ImageType_2 extends import("../worker/ScanbotSDK.Core").Image>(mrzScannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"MRZScannerContext">, image: ImageType_2) => Promise<import("./compiled/MrzTypes").MrzScannerResult & {
@@ -979,6 +981,7 @@ export declare class WorkerBridge {
979
981
  allowedCharacters?: string;
980
982
  pattern?: string;
981
983
  matchSubstring?: boolean;
984
+ patternGrammar?: import("./compiled/TextPatternScannerTypes").PatternGrammar;
982
985
  _marker?: () => void;
983
986
  };
984
987
  _marker?: () => void;
@@ -1006,6 +1009,7 @@ export declare class WorkerBridge {
1006
1009
  }[];
1007
1010
  qualityIndices?: import("./compiled/DocumentQualityAnalyzerTypes").DocumentQuality[];
1008
1011
  detectOrientation?: boolean;
1012
+ inspectSmallText?: boolean;
1009
1013
  maxImageSize?: number;
1010
1014
  minEstimatedNumberOfSymbolsForDocument?: number;
1011
1015
  minProcessedFraction?: number;
@@ -1016,10 +1020,10 @@ export declare class WorkerBridge {
1016
1020
  _marker?: () => void;
1017
1021
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">>;
1018
1022
  documentQualityAnalyzerAnalyze: (dqaToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentQualityAnalyzer">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/DocumentQualityAnalyzerTypes").DocumentQualityAnalyzerResult>;
1019
- imageApplyFilter: (image: import("../worker/ScanbotSDK.Core").Image, filter: import("./common").DeepPartial<import("./compiled/ParametricFilters").ParametricFilter>) => Promise<import("./common").RawImage>;
1020
- imageCrop: (image: import("../worker/ScanbotSDK.Core").Image, polygon: [import("./common").Point, import("./common").Point, import("./common").Point, import("./common").Point]) => Promise<import("./common").RawImage>;
1021
- imageResize: (image: import("../worker/ScanbotSDK.Core").Image, destinationSize: number) => Promise<import("./common").RawImage>;
1022
- imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageTypes").ImageRotation) => Promise<import("./common").RawImage>;
1023
+ imageApplyFilter: (image: import("../worker/ScanbotSDK.Core").Image, filter: import("./compiled/utils").DeepPartial<import("./compiled/ParametricFilters").ParametricFilter>) => Promise<import("./compiled/utils").RawImage>;
1024
+ imageCrop: (image: import("../worker/ScanbotSDK.Core").Image, polygon: [import("./compiled/utils").Point, import("./compiled/utils").Point, import("./compiled/utils").Point, import("./compiled/utils").Point]) => Promise<import("./compiled/utils").RawImage>;
1025
+ imageResize: (image: import("../worker/ScanbotSDK.Core").Image, destinationSize: number) => Promise<import("./compiled/utils").RawImage>;
1026
+ imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageTypes").ImageRotation) => Promise<import("./compiled/utils").RawImage>;
1023
1027
  documentDataExtractorCreate: (parameters: {
1024
1028
  resultAccumulationConfig?: {
1025
1029
  confirmationMethod?: import("./compiled/FrameAccumulationTypes").ConfirmationMethod;
@@ -11,7 +11,7 @@ import { type BarcodeDocumentFormat } from "../bridge/compiled/BarcodeDocumentTy
11
11
  import { BarcodeScannerConfiguration, type BarcodeScannerResult } from "../bridge/compiled/BarcodeScannerTypes";
12
12
  import { DocumentDataExtractorConfiguration, DocumentDataFrameExtractionParameters as GdrRecognitionParameters, type DocumentDataExtractionResult as GdrRecognitionResult } from "../bridge/compiled/DocumentDataExtractorTypes";
13
13
  import { type Binarization, TiffGeneratorParameters } from "../bridge/compiled/TiffTypes";
14
- import type { RawImage, Point, DeepPartial } from "../bridge/common";
14
+ import type { RawImage, Point, DeepPartial } from "../bridge/compiled/utils";
15
15
  import type { GenericDocument } from "../bridge/compiled/GenericDocument";
16
16
  import { SdkLicenseInfo } from "../bridge/compiled/SdkLicenseInfo";
17
17
  /** Represents an object of type T residing in the WASM's memory. */
@@ -27,5 +27,5 @@ export * from './core/bridge/compiled/BarcodeDocumentModel';
27
27
  export * from './core/bridge/compiled/CheckDocumentModel';
28
28
  export * from './core/bridge/compiled/CreditCardDocumentModel';
29
29
  export * from './core/bridge/compiled/SdkLicenseInfo';
30
- export { PartiallyConstructible, type RawImage, type DeepPartial, type Point, type Rectangle } from './core/bridge/common';
30
+ export { PartiallyConstructible, type RawImage, type DeepPartial, type Point, type Rectangle } from './core/bridge/compiled/utils';
31
31
  export type { ObjectId, Image, CroppedDetectionResult } from './core/worker/ScanbotSDK.Core';
@@ -11,7 +11,7 @@ export declare class BarcodeScannerViewConfiguration extends ViewFinderScannerCo
11
11
  captureDelay?: number;
12
12
  overlay?: SelectionOverlayConfiguration;
13
13
  /** {@displayType `Omit<DeepPartial<BarcodeScannerConfiguration>, "live">`} {@link BarcodeScannerConfiguration}*/
14
- detectionParameters?: Omit<DeepPartial<BarcodeScannerConfiguration>, "live">;
14
+ detectionParameters?: DeepPartial<BarcodeScannerConfiguration>;
15
15
  /**
16
16
  * Special property to enable barcode count mode.
17
17
  * This is a type of a ready-to-use user interface scanning and counting found barcodes.
@@ -58,9 +58,10 @@ export default class ScanbotSDK {
58
58
  detectAndCropDocument(imageBuffer: Image, consumeImage?: ConsumeType): Promise<CroppedDetectionResult | null>;
59
59
  /**
60
60
  * @param image An image URL (e.g. Data URL or HTTP URL) or an Image object
61
- * @param partialDetectionParameters {@displayType `DeepPartial<Omit<BarcodeScannerConfiguration, "live">>`} {@link BarcodeScannerConfiguration}
61
+ * @param detectionParams {@displayType `DeepPartial<Omit<BarcodeScannerConfiguration, "live">>`} {@link BarcodeScannerConfiguration}
62
+ * @param consumeType {@displayType `ConsumeType`} {@link ConsumeType}
62
63
  * */
63
- detectBarcodes(image: string | Image, partialDetectionParameters?: DeepPartial<Omit<BarcodeScannerConfiguration, "live">>, consumeImage?: ConsumeType): Promise<Config.BarcodeScannerResult & {
64
+ detectBarcodes(image: string | Image, detectionParams?: DeepPartial<BarcodeScannerConfiguration>, consumeType?: ConsumeType): Promise<Config.BarcodeScannerResult & {
64
65
  originalImage: Image;
65
66
  }>;
66
67
  parseBarcodeDocument(acceptedDocumentFormats: BarcodeDocumentFormat[], rawBarcodeData: string): Promise<Config.GenericDocument>;
@@ -99,7 +100,6 @@ export default class ScanbotSDK {
99
100
  getLicenseInfo: () => Promise<Config.SdkLicenseInfo>;
100
101
  encodeJpeg: (image: Image) => Promise<Uint8Array>;
101
102
  detectDocument: (image: Image, options: {
102
- isLive?: boolean;
103
103
  acceptedAngleScore?: number;
104
104
  acceptedSizeScore?: number;
105
105
  acceptedBrightnessThreshold?: number;
@@ -114,7 +114,6 @@ export default class ScanbotSDK {
114
114
  }) => Promise<DocumentDetectionResult>;
115
115
  detectAndCropDocument: (image: Image) => Promise<CroppedDetectionResult>;
116
116
  createDocumentScanner: (options: {
117
- isLive?: boolean;
118
117
  acceptedAngleScore?: number;
119
118
  acceptedSizeScore?: number;
120
119
  acceptedBrightnessThreshold?: number;
@@ -175,6 +174,7 @@ export default class ScanbotSDK {
175
174
  minimumSizeScore?: number;
176
175
  addAdditionalQuietZone?: boolean;
177
176
  minimum1DQuietZoneSize?: number;
177
+ stripCheckDigits?: boolean;
178
178
  minimumTextLength?: number;
179
179
  maximumTextLength?: number;
180
180
  _marker?: () => void;
@@ -410,7 +410,7 @@ export default class ScanbotSDK {
410
410
  onlyAcceptDocuments?: boolean;
411
411
  returnBarcodeImage?: boolean;
412
412
  engineMode?: Config.BarcodeScannerEngineMode;
413
- live?: boolean;
413
+ optimizedForOverlays?: boolean;
414
414
  _marker?: () => void;
415
415
  }) => Promise<ObjectId<"BarcodeScanner">>;
416
416
  scanBarcodes: <ImageType_1 extends Image>(barcodeScannerToken: ObjectId<"BarcodeScanner">, image: ImageType_1) => Promise<Config.BarcodeScannerResult & {
@@ -509,6 +509,7 @@ export default class ScanbotSDK {
509
509
  };
510
510
  enableDetection?: boolean;
511
511
  incompleteResultHandling?: Config.MrzIncompleteResultHandling;
512
+ returnCrops?: boolean;
512
513
  _marker?: () => void;
513
514
  }) => Promise<ObjectId<"MRZScannerContext">>;
514
515
  scanMRZ: <ImageType_2 extends Image>(mrzScannerToken: ObjectId<"MRZScannerContext">, image: ImageType_2) => Promise<Config.MrzScannerResult & {
@@ -530,6 +531,7 @@ export default class ScanbotSDK {
530
531
  allowedCharacters?: string;
531
532
  pattern?: string;
532
533
  matchSubstring?: boolean;
534
+ patternGrammar?: Config.PatternGrammar;
533
535
  _marker?: () => void;
534
536
  };
535
537
  _marker?: () => void;
@@ -557,6 +559,7 @@ export default class ScanbotSDK {
557
559
  }[];
558
560
  qualityIndices?: Config.DocumentQuality[];
559
561
  detectOrientation?: boolean;
562
+ inspectSmallText?: boolean;
560
563
  maxImageSize?: number;
561
564
  minEstimatedNumberOfSymbolsForDocument?: number;
562
565
  minProcessedFraction?: number;
@@ -16,7 +16,6 @@ export declare class WorkerBridge {
16
16
  getLicenseInfo: () => Promise<import("../core-types").SdkLicenseInfo>;
17
17
  encodeJpeg: (image: import("../core-types").Image) => Promise<Uint8Array>;
18
18
  detectDocument: (image: import("../core-types").Image, options: {
19
- isLive?: boolean;
20
19
  acceptedAngleScore?: number;
21
20
  acceptedSizeScore?: number;
22
21
  acceptedBrightnessThreshold?: number;
@@ -31,7 +30,6 @@ export declare class WorkerBridge {
31
30
  }) => Promise<import("../core-types").DocumentDetectionResult>;
32
31
  detectAndCropDocument: (image: import("../core-types").Image) => Promise<import("../core-types").CroppedDetectionResult>;
33
32
  createDocumentScanner: (options: {
34
- isLive?: boolean;
35
33
  acceptedAngleScore?: number;
36
34
  acceptedSizeScore?: number;
37
35
  acceptedBrightnessThreshold?: number;
@@ -92,6 +90,7 @@ export declare class WorkerBridge {
92
90
  minimumSizeScore?: number;
93
91
  addAdditionalQuietZone?: boolean;
94
92
  minimum1DQuietZoneSize?: number;
93
+ stripCheckDigits?: boolean;
95
94
  minimumTextLength?: number;
96
95
  maximumTextLength?: number;
97
96
  _marker?: () => void;
@@ -327,7 +326,7 @@ export declare class WorkerBridge {
327
326
  onlyAcceptDocuments?: boolean;
328
327
  returnBarcodeImage?: boolean;
329
328
  engineMode?: import("../core-types").BarcodeScannerEngineMode;
330
- live?: boolean;
329
+ optimizedForOverlays?: boolean;
331
330
  _marker?: () => void;
332
331
  }) => Promise<import("../core-types").ObjectId<"BarcodeScanner">>;
333
332
  scanBarcodes: <ImageType_1 extends import("../core-types").Image>(barcodeScannerToken: import("../core-types").ObjectId<"BarcodeScanner">, image: ImageType_1) => Promise<import("../core-types").BarcodeScannerResult & {
@@ -426,6 +425,7 @@ export declare class WorkerBridge {
426
425
  };
427
426
  enableDetection?: boolean;
428
427
  incompleteResultHandling?: import("../core-types").MrzIncompleteResultHandling;
428
+ returnCrops?: boolean;
429
429
  _marker?: () => void;
430
430
  }) => Promise<import("../core-types").ObjectId<"MRZScannerContext">>;
431
431
  scanMRZ: <ImageType_2 extends import("../core-types").Image>(mrzScannerToken: import("../core-types").ObjectId<"MRZScannerContext">, image: ImageType_2) => Promise<import("../core-types").MrzScannerResult & {
@@ -447,6 +447,7 @@ export declare class WorkerBridge {
447
447
  allowedCharacters?: string;
448
448
  pattern?: string;
449
449
  matchSubstring?: boolean;
450
+ patternGrammar?: import("../core-types").PatternGrammar;
450
451
  _marker?: () => void;
451
452
  };
452
453
  _marker?: () => void;
@@ -474,6 +475,7 @@ export declare class WorkerBridge {
474
475
  }[];
475
476
  qualityIndices?: import("../core-types").DocumentQuality[];
476
477
  detectOrientation?: boolean;
478
+ inspectSmallText?: boolean;
477
479
  maxImageSize?: number;
478
480
  minEstimatedNumberOfSymbolsForDocument?: number;
479
481
  minProcessedFraction?: number;
@@ -540,7 +542,6 @@ export declare class WorkerBridge {
540
542
  getLicenseInfo: () => Promise<import("../core-types").SdkLicenseInfo>;
541
543
  encodeJpeg: (image: import("../core-types").Image) => Promise<Uint8Array>;
542
544
  detectDocument: (image: import("../core-types").Image, options: {
543
- isLive?: boolean;
544
545
  acceptedAngleScore?: number;
545
546
  acceptedSizeScore?: number;
546
547
  acceptedBrightnessThreshold?: number;
@@ -555,7 +556,6 @@ export declare class WorkerBridge {
555
556
  }) => Promise<import("../core-types").DocumentDetectionResult>;
556
557
  detectAndCropDocument: (image: import("../core-types").Image) => Promise<import("../core-types").CroppedDetectionResult>;
557
558
  createDocumentScanner: (options: {
558
- isLive?: boolean;
559
559
  acceptedAngleScore?: number;
560
560
  acceptedSizeScore?: number;
561
561
  acceptedBrightnessThreshold?: number;
@@ -616,6 +616,7 @@ export declare class WorkerBridge {
616
616
  minimumSizeScore?: number;
617
617
  addAdditionalQuietZone?: boolean;
618
618
  minimum1DQuietZoneSize?: number;
619
+ stripCheckDigits?: boolean;
619
620
  minimumTextLength?: number;
620
621
  maximumTextLength?: number;
621
622
  _marker?: () => void;
@@ -851,7 +852,7 @@ export declare class WorkerBridge {
851
852
  onlyAcceptDocuments?: boolean;
852
853
  returnBarcodeImage?: boolean;
853
854
  engineMode?: import("../core-types").BarcodeScannerEngineMode;
854
- live?: boolean;
855
+ optimizedForOverlays?: boolean;
855
856
  _marker?: () => void;
856
857
  }) => Promise<import("../core-types").ObjectId<"BarcodeScanner">>;
857
858
  scanBarcodes: <ImageType_1 extends import("../core-types").Image>(barcodeScannerToken: import("../core-types").ObjectId<"BarcodeScanner">, image: ImageType_1) => Promise<import("../core-types").BarcodeScannerResult & {
@@ -950,6 +951,7 @@ export declare class WorkerBridge {
950
951
  };
951
952
  enableDetection?: boolean;
952
953
  incompleteResultHandling?: import("../core-types").MrzIncompleteResultHandling;
954
+ returnCrops?: boolean;
953
955
  _marker?: () => void;
954
956
  }) => Promise<import("../core-types").ObjectId<"MRZScannerContext">>;
955
957
  scanMRZ: <ImageType_2 extends import("../core-types").Image>(mrzScannerToken: import("../core-types").ObjectId<"MRZScannerContext">, image: ImageType_2) => Promise<import("../core-types").MrzScannerResult & {
@@ -971,6 +973,7 @@ export declare class WorkerBridge {
971
973
  allowedCharacters?: string;
972
974
  pattern?: string;
973
975
  matchSubstring?: boolean;
976
+ patternGrammar?: import("../core-types").PatternGrammar;
974
977
  _marker?: () => void;
975
978
  };
976
979
  _marker?: () => void;
@@ -998,6 +1001,7 @@ export declare class WorkerBridge {
998
1001
  }[];
999
1002
  qualityIndices?: import("../core-types").DocumentQuality[];
1000
1003
  detectOrientation?: boolean;
1004
+ inspectSmallText?: boolean;
1001
1005
  maxImageSize?: number;
1002
1006
  minEstimatedNumberOfSymbolsForDocument?: number;
1003
1007
  minProcessedFraction?: number;