scanbot-web-sdk 6.0.0-dev.4 → 6.0.0-dev.5

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 (40) hide show
  1. package/@types/core/bridge/compiled/BarcodeDocumentTypes.d.ts +59 -0
  2. package/@types/core/bridge/compiled/BarcodeScannerTypes.d.ts +19 -67
  3. package/@types/core/bridge/compiled/BarcodeTypes.d.ts +1 -5
  4. package/@types/core/bridge/compiled/DocumentDetectorTypes.d.ts +14 -7
  5. package/@types/core/bridge/compiled/DocumentQualityAnalyzerTypes.d.ts +12 -0
  6. package/@types/core/bridge/compiled/GenericDocument.d.ts +10 -0
  7. package/@types/core/bridge/compiled/GenericDocumentRecognizerConfigs.d.ts +9 -41
  8. package/@types/core/bridge/compiled/GenericDocumentTypes.d.ts +1 -24
  9. package/@types/core/bridge/worker-bridge.d.ts +24 -28
  10. package/@types/core/worker/ScanbotSDK.Core.d.ts +3 -2
  11. package/@types/core-types.d.ts +2 -1
  12. package/@types/cropping-view.d.ts +2 -3
  13. package/@types/scanbot-sdk.d.ts +19 -18
  14. package/@types/ui2/configuration/BarcodeScannerTypes.d.ts +1 -1
  15. package/@types/worker/worker-bridge.d.ts +24 -28
  16. package/bundle/ScanbotSDK.min.js +4 -4
  17. package/bundle/ScanbotSDK.ui2.min.js +4 -4
  18. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  19. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  20. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  21. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  22. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  23. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
  24. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
  25. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
  26. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  27. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  28. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  29. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
  30. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
  31. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
  32. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  33. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  34. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  35. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  36. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  37. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
  38. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
  39. package/package.json +1 -1
  40. /package/@types/core/bridge/compiled/{ImageProcessorTypes.d.ts → ImageTypes.d.ts} +0 -0
@@ -0,0 +1,59 @@
1
+ import { BarcodeFormat } from "./BarcodeTypes";
2
+ import { DeepPartial, PartiallyConstructible } from "../common";
3
+ /**
4
+ Type of barcode document format used.
5
+
6
+ - `AAMVA`:
7
+ American Association of Motor Vehicle Administrators barcode document
8
+ - `BOARDING_PASS`:
9
+ Boarding pass barcode document
10
+ - `DE_MEDICAL_PLAN`:
11
+ German medication plan barcode document
12
+ - `MEDICAL_CERTIFICATE`:
13
+ German medical certificate barcode document
14
+ - `ID_CARD_PDF_417`:
15
+ ID card barcode document
16
+ - `SEPA`:
17
+ SEPA barcode (aka GiroCode) document
18
+ - `SWISS_QR`:
19
+ Swiss QR barcode document
20
+ - `VCARD`:
21
+ VCard barcode document
22
+ - `GS1`:
23
+ GS1 barcode document
24
+ - `HIBC`:
25
+ Health industry barcode document
26
+ */
27
+ export type BarcodeDocumentFormat = "AAMVA" | "BOARDING_PASS" | "DE_MEDICAL_PLAN" | "MEDICAL_CERTIFICATE" | "ID_CARD_PDF_417" | "SEPA" | "SWISS_QR" | "VCARD" | "GS1" | "HIBC";
28
+ /**
29
+ Barcode document formats
30
+ */
31
+ export declare class BarcodeDocumentFormats extends PartiallyConstructible {
32
+ /** @param source {@displayType `DeepPartial<BarcodeDocumentFormats>`} */
33
+ constructor(source?: DeepPartial<BarcodeDocumentFormats>);
34
+ }
35
+ export declare namespace BarcodeDocumentFormats {
36
+ /**
37
+ All barcode document formats
38
+ @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
39
+ */
40
+ const all: BarcodeDocumentFormat[];
41
+ /**
42
+ Barcode types that are used to encode documents
43
+ @defaultValue {
44
+ "AAMVA": ["PDF_417"],
45
+ "ID_CARD_PDF_417": ["PDF_417"],
46
+ "SEPA": ["QR_CODE"],
47
+ "MEDICAL_CERTIFICATE": ["PDF_417"],
48
+ "DE_MEDICAL_PLAN": ["DATA_MATRIX"],
49
+ "BOARDING_PASS": ["PDF_417", "AZTEC"],
50
+ "VCARD": ["QR_CODE"],
51
+ "SWISS_QR": ["QR_CODE"],
52
+ "GS1": ["CODE_128", "AZTEC", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "ITF", "MICRO_PDF_417", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"],
53
+ "HIBC": ["CODE_39", "CODE_128", "AZTEC", "DATA_MATRIX", "MICRO_PDF_417", "PDF_417", "QR_CODE"]
54
+ };
55
+ */
56
+ const documentBarcodeFormats: {
57
+ [key in BarcodeDocumentFormat]: BarcodeFormat[];
58
+ };
59
+ }
@@ -1,3 +1,4 @@
1
+ import { BarcodeDocumentFormat } from "./BarcodeDocumentTypes";
1
2
  import { BarcodeFormatConfigurationBase } from "./BarcodeConfigs";
2
3
  import { BarcodeFormat } from "./BarcodeTypes";
3
4
  import { DeepPartial, PartiallyConstructible } from "../common";
@@ -80,63 +81,6 @@ The engine mode for barcode scanning
80
81
  */
81
82
  export type BarcodeScannerEngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_LOW_POWER_AR" | "NEXT_GEN_AR";
82
83
  /**
83
- Type of barcode document format used.
84
-
85
- - `AAMVA`:
86
- American Association of Motor Vehicle Administrators barcode document
87
- - `BOARDING_PASS`:
88
- Boarding pass barcode document
89
- - `DE_MEDICAL_PLAN`:
90
- German medication plan barcode document
91
- - `MEDICAL_CERTIFICATE`:
92
- German medical certificate barcode document
93
- - `ID_CARD_PDF_417`:
94
- ID card barcode document
95
- - `SEPA`:
96
- SEPA barcode (aka GiroCode) document
97
- - `SWISS_QR`:
98
- Swiss QR barcode document
99
- - `VCARD`:
100
- VCard barcode document
101
- - `GS1`:
102
- GS1 barcode document
103
- - `HIBC`:
104
- Health industry barcode document
105
- */
106
- export type BarcodeDocumentFormat = "AAMVA" | "BOARDING_PASS" | "DE_MEDICAL_PLAN" | "MEDICAL_CERTIFICATE" | "ID_CARD_PDF_417" | "SEPA" | "SWISS_QR" | "VCARD" | "GS1" | "HIBC";
107
- /**
108
- Barcode document formats
109
- */
110
- export declare class BarcodeDocumentFormats extends PartiallyConstructible {
111
- /** @param source {@displayType `DeepPartial<BarcodeDocumentFormats>`} */
112
- constructor(source?: DeepPartial<BarcodeDocumentFormats>);
113
- }
114
- export declare namespace BarcodeDocumentFormats {
115
- /**
116
- All barcode document formats
117
- @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
118
- */
119
- const all: BarcodeDocumentFormat[];
120
- /**
121
- Barcode types that are used to encode documents
122
- @defaultValue {
123
- "AAMVA": ["PDF_417"],
124
- "ID_CARD_PDF_417": ["PDF_417"],
125
- "SEPA": ["QR_CODE"],
126
- "MEDICAL_CERTIFICATE": ["PDF_417"],
127
- "DE_MEDICAL_PLAN": ["DATA_MATRIX"],
128
- "BOARDING_PASS": ["PDF_417", "AZTEC"],
129
- "VCARD": ["QR_CODE"],
130
- "SWISS_QR": ["QR_CODE"],
131
- "GS1": ["CODE_128", "AZTEC", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "ITF", "MICRO_PDF_417", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"],
132
- "HIBC": ["CODE_39", "CODE_128", "AZTEC", "DATA_MATRIX", "MICRO_PDF_417", "PDF_417", "QR_CODE"]
133
- };
134
- */
135
- const documentBarcodeFormats: {
136
- [key in BarcodeDocumentFormat]: BarcodeFormat[];
137
- };
138
- }
139
- /**
140
84
  Configuration for the barcode scanner
141
85
  */
142
86
  export declare class BarcodeScannerConfiguration extends PartiallyConstructible {
@@ -146,25 +90,33 @@ export declare class BarcodeScannerConfiguration extends PartiallyConstructible
146
90
  */
147
91
  barcodeFormatConfigurations: BarcodeFormatConfigurationBase[];
148
92
  /**
149
- The engine mode for barcode scanning
150
- @defaultValue "NEXT_GEN_LOW_POWER";
151
- */
152
- engineMode: BarcodeScannerEngineMode;
153
- /**
154
- If true, the barcode recognition will be performed in live mode
155
- @defaultValue true;
156
- */
157
- live: boolean;
158
- /**
159
93
  List of accepted barcode document formats.
94
+ Barcodes that decode to one of the accepted document formats will have parsedDocument field in BarcodeItem populated with the parsed document.
95
+ By default all supported barcode document formats are accepted.
96
+ If empty, no barcodes will be parsed into documents.
160
97
  @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
161
98
  */
162
99
  acceptedDocumentFormats: BarcodeDocumentFormat[];
163
100
  /**
101
+ If true and acceptedDocumentFormats is not empty, then barcodes that don't decode to one of the accepted document formats will be ignored.
102
+ @defaultValue false;
103
+ */
104
+ onlyAcceptDocuments: boolean;
105
+ /**
164
106
  If true, the barcode image will be returned in the BarcodeItem
165
107
  @defaultValue true;
166
108
  */
167
109
  returnBarcodeImage: boolean;
110
+ /**
111
+ The engine mode for barcode scanning
112
+ @defaultValue "NEXT_GEN_LOW_POWER";
113
+ */
114
+ engineMode: BarcodeScannerEngineMode;
115
+ /**
116
+ If true, the barcode recognition will be performed in live mode
117
+ @defaultValue true;
118
+ */
119
+ live: boolean;
168
120
  /** @param source {@displayType `DeepPartial<BarcodeScannerConfiguration>`} */
169
121
  constructor(source?: DeepPartial<BarcodeScannerConfiguration>);
170
122
  }
@@ -140,10 +140,6 @@ results, depending on how the system handles unprintable characters. You may see
140
140
  mark, a box, an escape sequence, a space or nothing at all.
141
141
 
142
142
 
143
- - `NONE`:
144
- The (FNC1) character is simply stripped from the result in barcodes that implement this
145
- mode.
146
- Do not use. Will be removed in a future release.
147
143
  - `PARSE`:
148
144
  This is the default. GS1 messages are converted to the machine-readable format per
149
145
  the GS1 spec (the special FNC1 character is converted to ASCII \x1D).
@@ -161,7 +157,7 @@ mark, a box, an escape sequence, a space or nothing at all.
161
157
  - `DECODE_FULL`:
162
158
  Combines the validations of VALIDATE_FULL and the human-readable output format of DECODE_STRUCTURE.
163
159
  */
164
- export type GS1Handling = "NONE" | "PARSE" | "VALIDATE_STRUCTURE" | "DECODE_STRUCTURE" | "VALIDATE_FULL" | "DECODE_FULL";
160
+ export type GS1Handling = "PARSE" | "VALIDATE_STRUCTURE" | "DECODE_STRUCTURE" | "VALIDATE_FULL" | "DECODE_FULL";
165
161
  /**
166
162
  Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
167
163
 
@@ -47,15 +47,12 @@ export declare class DocumentDetectorParameters extends PartiallyConstructible {
47
47
  The minimum score in percent (0 - 100) that the aspect ratio of the document
48
48
  must match one of the required aspect ratios (if any) to accept a detected document.
49
49
  If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio
50
- matches one of the given aspect ratios, otherwise OK_BAD_ASPECT_RATIO is returned.
51
- If acceptedAspectRatioScore is 0, then documents always pass the aspect ratio check,
52
- but documents that match one of the given aspect ratios will still be preferred.
50
+ matches one of the given aspect ratios (if any), otherwise OK_BAD_ASPECT_RATIO is returned.
53
51
  @defaultValue 85.0;
54
52
  */
55
53
  acceptedAspectRatioScore: number;
56
54
  /**
57
- The desired aspect ratios for the detected document.
58
- Document outlines matching one of the aspect ratios are more likely to be returned as the best match.
55
+ The possible desired aspect ratios for the detected document.
59
56
  A document matches if its aspect ratio matches any of the given aspect ratios.
60
57
  If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio
61
58
  matches one of the given aspect ratios, otherwise OK_BAD_ASPECT_RATIO is returned.
@@ -63,6 +60,14 @@ export declare class DocumentDetectorParameters extends PartiallyConstructible {
63
60
  @defaultValue [];
64
61
  */
65
62
  aspectRatios: AspectRatio[];
63
+ /**
64
+ If false, the document detector will return OK_ORIENTATION_MISMATCH if the
65
+ detected document orientation does not match the input image orientation,
66
+ e.g. if the document is detected as landscape but the input image is portrait.
67
+ If true, the document detector will ignore orientation mismatches.
68
+ @defaultValue false;
69
+ */
70
+ ignoreOrientationMismatch: boolean;
66
71
  /** @param source {@displayType `DeepPartial<DocumentDetectorParameters>`} */
67
72
  constructor(source?: DeepPartial<DocumentDetectorParameters>);
68
73
  }
@@ -95,7 +100,9 @@ Status of the document detection
95
100
  - `OK_BAD_ANGLES`:
96
101
  A polygon was detected, but it has too much perspective distortion
97
102
  - `OK_BAD_ASPECT_RATIO`:
98
- A document was detected, but its aspect ratio is not acceptable or the document orientation does not match the input image orientation
103
+ A document was detected, but its aspect ratio is not acceptable
104
+ - `OK_ORIENTATION_MISMATCH`:
105
+ A document was detected, but its orientation does not match the input image orientation
99
106
  - `OK_OFF_CENTER`:
100
107
  A document was detected, but its center is too far away from the input image center
101
108
  - `OK_TOO_DARK`:
@@ -107,7 +114,7 @@ Status of the document detection
107
114
  - `ERROR_NOISE`:
108
115
  No document was detected, likely because the input image is too noisy or has a complex background
109
116
  */
110
- export type DocumentDetectionStatus = "NOT_ACQUIRED" | "OK" | "OK_SMALL_SIZE" | "OK_BAD_ANGLES" | "OK_BAD_ASPECT_RATIO" | "OK_OFF_CENTER" | "OK_TOO_DARK" | "ERROR_NOTHING_DETECTED" | "ERROR_TOO_DARK" | "ERROR_NOISE";
117
+ export type DocumentDetectionStatus = "NOT_ACQUIRED" | "OK" | "OK_SMALL_SIZE" | "OK_BAD_ANGLES" | "OK_BAD_ASPECT_RATIO" | "OK_ORIENTATION_MISMATCH" | "OK_OFF_CENTER" | "OK_TOO_DARK" | "ERROR_NOTHING_DETECTED" | "ERROR_TOO_DARK" | "ERROR_NOISE";
111
118
  /**
112
119
  The total and partial scores for the detected document contour
113
120
  */
@@ -56,6 +56,11 @@ export declare class DocumentQualityAnalyzerConfiguration extends PartiallyConst
56
56
  */
57
57
  readonly qualityIndices: DocumentQuality[];
58
58
  /**
59
+ Enable orientation detection. Document orientation will be returned in `DocumentQualityAnalyzerResult.orientation`.
60
+ @defaultValue false;
61
+ */
62
+ readonly detectOrientation: boolean;
63
+ /**
59
64
  Maximum image size in pixels, if image is bigger, it will be resized
60
65
  @defaultValue 2000;
61
66
  */
@@ -100,6 +105,13 @@ export declare class DocumentQualityAnalyzerResult extends PartiallyConstructibl
100
105
  Quality of the document, if found
101
106
  */
102
107
  readonly quality: DocumentQuality | null;
108
+ /**
109
+ Dominant orientation of the document, if found and if orientation detection is enabled.
110
+ The value is in degrees counter-clockwise, where 0 corresponds to the document
111
+ being straight, and the value is in the range of [-180, 180].
112
+ To rotate the document to be straight, rotate the image clockwise by this value.
113
+ */
114
+ readonly orientation: number | null;
103
115
  /** @param source {@displayType `DeepPartial<DocumentQualityAnalyzerResult>`} */
104
116
  constructor(source?: DeepPartial<DocumentQualityAnalyzerResult>);
105
117
  }
@@ -121,6 +121,11 @@ export declare class FieldType extends PartiallyConstructible {
121
121
  Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.
122
122
  */
123
123
  readonly commonType: CommonFieldType | null;
124
+ /**
125
+ A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field
126
+ @defaultValue null;
127
+ */
128
+ readonly listIndex: number | null;
124
129
  /** @param source {@displayType `DeepPartial<FieldType>`} */
125
130
  constructor(source?: DeepPartial<FieldType>);
126
131
  }
@@ -179,6 +184,11 @@ export declare class GenericDocumentType extends PartiallyConstructible {
179
184
  Normalized global document type name. Common document types appearing as child documents in different places will often have the same normalized type name.
180
185
  */
181
186
  readonly normalizedName: string;
187
+ /**
188
+ A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field
189
+ @defaultValue null;
190
+ */
191
+ readonly listIndex: number | null;
182
192
  /** @param source {@displayType `DeepPartial<GenericDocumentType>`} */
183
193
  constructor(source?: DeepPartial<GenericDocumentType>);
184
194
  }
@@ -1,6 +1,5 @@
1
1
  import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { DocumentType as GenericDocumentTypesDocumentType } from "./GenericDocumentTypes";
3
- import { DocumentType as MRZTypesDocumentType } from "./MRZTypes";
2
+ import { DocumentType } from "./MRZTypes";
4
3
  /**
5
4
  Base class for all generic document configurations.
6
5
  */
@@ -21,30 +20,19 @@ Add to recognizer configuration to require date validation checks for specific d
21
20
  export declare class DateValidationConfig extends PartiallyConstructible {
22
21
  readonly _type: "DateValidationConfig";
23
22
  /**
24
- Minimum year of birth
23
+ Minimum year that is considered valid.
25
24
  @defaultValue 0;
26
25
  */
27
- readonly minBirthYear: number;
26
+ readonly minYear: number;
28
27
  /**
29
- Maximum year of birth
28
+ Maximum year that is considered valid.
30
29
  @defaultValue 2999;
31
30
  */
32
- readonly maxBirthYear: number;
31
+ readonly maxYear: number;
33
32
  /**
34
- Minimum card expiration year
35
- @defaultValue 0;
36
- */
37
- readonly minExpirationYear: number;
38
- /**
39
- Maximum card expiration year
40
- @defaultValue 2999;
41
- */
42
- readonly maxExpirationYear: number;
43
- /**
44
- List of generic document formats for which date validation has to be applied.
45
- @defaultValue [];
33
+ Name, FullName, or NormalizedName of field type for which the year bounds should be applied.
46
34
  */
47
- readonly documentTypes: GenericDocumentTypesDocumentType[];
35
+ readonly fieldTypeName: string;
48
36
  /** @param source {@displayType `DeepPartial<DateValidationConfig>`} */
49
37
  constructor(source?: DeepPartial<DateValidationConfig>);
50
38
  }
@@ -115,26 +103,6 @@ EHIC configuration. Add to recognizer configuration to scan EHIC.
115
103
  export declare class EuropeanHealthInsuranceCardConfig extends PartiallyConstructible {
116
104
  readonly _type: "EuropeanHealthInsuranceCardConfig";
117
105
  /**
118
- Minimum year of birth
119
- @defaultValue 0;
120
- */
121
- readonly minBirthYear: number;
122
- /**
123
- Maximum year of birth
124
- @defaultValue 2999;
125
- */
126
- readonly maxBirthYear: number;
127
- /**
128
- Minimum card expiration year
129
- @defaultValue 0;
130
- */
131
- readonly minExpirationYear: number;
132
- /**
133
- Maximum card expiration year
134
- @defaultValue 2999;
135
- */
136
- readonly maxExpirationYear: number;
137
- /**
138
106
  If an expected country is selected, validation rules for the given country are used, a
139
107
  and if the expected country cannot be inferred or the inferred country doesn't match the given country,
140
108
  the result of recognize() will be IncompleteValidation.
@@ -162,7 +130,7 @@ export declare class MRZFallbackConfig extends PartiallyConstructible {
162
130
  List of MRZ document formats for which MRZ fallback is enabled.
163
131
  @defaultValue [];
164
132
  */
165
- readonly acceptedMRZTypes: MRZTypesDocumentType[];
133
+ readonly acceptedMRZTypes: DocumentType[];
166
134
  /** @param source {@displayType `DeepPartial<MRZFallbackConfig>`} */
167
135
  constructor(source?: DeepPartial<MRZFallbackConfig>);
168
136
  }
@@ -176,7 +144,7 @@ export declare class GDRGroupConfig extends PartiallyConstructible {
176
144
  /**
177
145
  List of generic document formats to scan. By default, the list is empty.
178
146
  */
179
- readonly acceptedDocumentTypes: GenericDocumentTypesDocumentType[];
147
+ readonly acceptedDocumentTypes: string[];
180
148
  /** @param source {@displayType `DeepPartial<GDRGroupConfig>`} */
181
149
  constructor(source?: DeepPartial<GDRGroupConfig>);
182
150
  }
@@ -1,28 +1,5 @@
1
1
  import { DeepPartial, PartiallyConstructible } from "../common";
2
2
  /**
3
- Enumerates generic document formats.
4
-
5
- - `DeIdCardFront`:
6
- DeIdCardFront
7
- - `DeIdCardBack`:
8
- DeIdCardBack
9
- - `DePassport`:
10
- DePassport
11
- - `DeDriverLicenseFront`:
12
- DeDriverLicenseFront
13
- - `DeDriverLicenseBack`:
14
- DeDriverLicenseBack
15
- - `DeResidencePermitFront`:
16
- DeResidencePermitFront
17
- - `DeResidencePermitBack`:
18
- DeResidencePermitBack
19
- - `EuropeanHealthInsuranceCard`:
20
- EuropeanHealthInsuranceCard
21
- - `DeHealthInsuranceCardFront`:
22
- DeHealthInsuranceCardFront
23
- */
24
- export type DocumentType = "DeIdCardFront" | "DeIdCardBack" | "DePassport" | "DeDriverLicenseFront" | "DeDriverLicenseBack" | "DeResidencePermitFront" | "DeResidencePermitBack" | "EuropeanHealthInsuranceCard" | "DeHealthInsuranceCardFront";
25
- /**
26
3
  Lists of generic document types to decode
27
4
  */
28
5
  export declare class DocumentTypes extends PartiallyConstructible {
@@ -34,5 +11,5 @@ export declare namespace DocumentTypes {
34
11
  List of all generic document types
35
12
  @defaultValue ["DeIdCardFront", "DeIdCardBack", "DePassport", "DeDriverLicenseFront", "DeDriverLicenseBack", "DeResidencePermitFront", "DeResidencePermitBack", "EuropeanHealthInsuranceCard", "DeHealthInsuranceCardFront"];
36
13
  */
37
- const all: DocumentType[];
14
+ const all: string[];
38
15
  }
@@ -34,6 +34,7 @@ export declare class WorkerBridge {
34
34
  readonly height?: number;
35
35
  _marker?: () => void;
36
36
  }[];
37
+ ignoreOrientationMismatch?: boolean;
37
38
  _marker?: () => void;
38
39
  }) => Promise<import("./compiled/DocumentDetectorTypes").DocumentDetectionResult>;
39
40
  detectAndCropDocument: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("../worker/ScanbotSDK.Core").CroppedDetectionResult>;
@@ -48,12 +49,13 @@ export declare class WorkerBridge {
48
49
  readonly height?: number;
49
50
  _marker?: () => void;
50
51
  }[];
52
+ ignoreOrientationMismatch?: boolean;
51
53
  _marker?: () => void;
52
54
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">>;
53
55
  documentDetectorDetect: <ImageType extends import("../worker/ScanbotSDK.Core").Image>(documentDetectorToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">, image: ImageType) => Promise<import("./compiled/DocumentDetectorTypes").DocumentDetectionResult & {
54
56
  originalImage: ImageType;
55
57
  }>;
56
- parseBarcodeDocument: (options: import("./compiled/BarcodeScannerTypes").BarcodeDocumentFormat[], data: string) => Promise<import("./compiled/GenericDocument").GenericDocument>;
58
+ parseBarcodeDocument: (options: import("./compiled/BarcodeDocumentTypes").BarcodeDocumentFormat[], data: string) => Promise<import("./compiled/GenericDocument").GenericDocument>;
57
59
  createBarcodeRecognizer: (options: {
58
60
  barcodeFormatConfigurations?: ({
59
61
  readonly _type?: "BarcodeFormatCodabarConfiguration";
@@ -269,10 +271,11 @@ export declare class WorkerBridge {
269
271
  readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[];
270
272
  _marker?: () => void;
271
273
  })[];
274
+ acceptedDocumentFormats?: import("./compiled/BarcodeDocumentTypes").BarcodeDocumentFormat[];
275
+ onlyAcceptDocuments?: boolean;
276
+ returnBarcodeImage?: boolean;
272
277
  engineMode?: import("./compiled/BarcodeScannerTypes").BarcodeScannerEngineMode;
273
278
  live?: boolean;
274
- acceptedDocumentFormats?: import("./compiled/BarcodeScannerTypes").BarcodeDocumentFormat[];
275
- returnBarcodeImage?: boolean;
276
279
  _marker?: () => void;
277
280
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">>;
278
281
  recognizeBarcodes: <ImageType_1 extends import("../worker/ScanbotSDK.Core").Image>(barcodeRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult & {
@@ -408,6 +411,7 @@ export declare class WorkerBridge {
408
411
  _marker?: () => void;
409
412
  }[];
410
413
  readonly qualityIndices?: import("./compiled/DocumentQualityAnalyzerTypes").DocumentQuality[];
414
+ readonly detectOrientation?: boolean;
411
415
  readonly maxImageSize?: number;
412
416
  minEstimatedNumberOfSymbolsForDocument?: number;
413
417
  readonly minProcessedFraction?: number;
@@ -420,7 +424,7 @@ export declare class WorkerBridge {
420
424
  imageApplyFilter: (image: import("../worker/ScanbotSDK.Core").Image, filter: import("./common").DeepPartial<import("./compiled/ParametricFilters").ParametricFilter>) => Promise<import("./common").RawImage>;
421
425
  imageCrop: (image: import("../worker/ScanbotSDK.Core").Image, polygon: [import("./common").Point, import("./common").Point, import("./common").Point, import("./common").Point]) => Promise<import("./common").RawImage>;
422
426
  imageResize: (image: import("../worker/ScanbotSDK.Core").Image, destinationSize: number) => Promise<import("./common").RawImage>;
423
- imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageProcessorTypes").ImageRotation) => Promise<import("./common").RawImage>;
427
+ imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageTypes").ImageRotation) => Promise<import("./common").RawImage>;
424
428
  genericDocumentRecognizerCreate: (parameters: {
425
429
  resultAccumulationConfig?: {
426
430
  confirmationMethod?: import("./compiled/FrameAccumulationTypes").ConfirmationMethod;
@@ -432,18 +436,12 @@ export declare class WorkerBridge {
432
436
  fieldExcludeList?: string[];
433
437
  configurations?: ({
434
438
  readonly _type?: "DateValidationConfig";
435
- readonly minBirthYear?: number;
436
- readonly maxBirthYear?: number;
437
- readonly minExpirationYear?: number;
438
- readonly maxExpirationYear?: number;
439
- readonly documentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[];
439
+ readonly minYear?: number;
440
+ readonly maxYear?: number;
441
+ readonly fieldTypeName?: string;
440
442
  _marker?: () => void;
441
443
  } | {
442
444
  readonly _type?: "EuropeanHealthInsuranceCardConfig";
443
- readonly minBirthYear?: number;
444
- readonly maxBirthYear?: number;
445
- readonly minExpirationYear?: number;
446
- readonly maxExpirationYear?: number;
447
445
  readonly expectedCountry?: import("./compiled/GenericDocumentRecognizerConfigs").EHICIssuingCountry;
448
446
  _marker?: () => void;
449
447
  } | {
@@ -453,7 +451,7 @@ export declare class WorkerBridge {
453
451
  _marker?: () => void;
454
452
  } | {
455
453
  readonly _type?: "GDRGroupConfig";
456
- readonly acceptedDocumentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[];
454
+ readonly acceptedDocumentTypes?: string[];
457
455
  _marker?: () => void;
458
456
  })[];
459
457
  _marker?: () => void;
@@ -488,6 +486,7 @@ export declare class WorkerBridge {
488
486
  readonly height?: number;
489
487
  _marker?: () => void;
490
488
  }[];
489
+ ignoreOrientationMismatch?: boolean;
491
490
  _marker?: () => void;
492
491
  }) => Promise<import("./compiled/DocumentDetectorTypes").DocumentDetectionResult>;
493
492
  detectAndCropDocument: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("../worker/ScanbotSDK.Core").CroppedDetectionResult>;
@@ -502,12 +501,13 @@ export declare class WorkerBridge {
502
501
  readonly height?: number;
503
502
  _marker?: () => void;
504
503
  }[];
504
+ ignoreOrientationMismatch?: boolean;
505
505
  _marker?: () => void;
506
506
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">>;
507
507
  documentDetectorDetect: <ImageType extends import("../worker/ScanbotSDK.Core").Image>(documentDetectorToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">, image: ImageType) => Promise<import("./compiled/DocumentDetectorTypes").DocumentDetectionResult & {
508
508
  originalImage: ImageType;
509
509
  }>;
510
- parseBarcodeDocument: (options: import("./compiled/BarcodeScannerTypes").BarcodeDocumentFormat[], data: string) => Promise<import("./compiled/GenericDocument").GenericDocument>;
510
+ parseBarcodeDocument: (options: import("./compiled/BarcodeDocumentTypes").BarcodeDocumentFormat[], data: string) => Promise<import("./compiled/GenericDocument").GenericDocument>;
511
511
  createBarcodeRecognizer: (options: {
512
512
  barcodeFormatConfigurations?: ({
513
513
  readonly _type?: "BarcodeFormatCodabarConfiguration";
@@ -723,10 +723,11 @@ export declare class WorkerBridge {
723
723
  readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[];
724
724
  _marker?: () => void;
725
725
  })[];
726
+ acceptedDocumentFormats?: import("./compiled/BarcodeDocumentTypes").BarcodeDocumentFormat[];
727
+ onlyAcceptDocuments?: boolean;
728
+ returnBarcodeImage?: boolean;
726
729
  engineMode?: import("./compiled/BarcodeScannerTypes").BarcodeScannerEngineMode;
727
730
  live?: boolean;
728
- acceptedDocumentFormats?: import("./compiled/BarcodeScannerTypes").BarcodeDocumentFormat[];
729
- returnBarcodeImage?: boolean;
730
731
  _marker?: () => void;
731
732
  }) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">>;
732
733
  recognizeBarcodes: <ImageType_1 extends import("../worker/ScanbotSDK.Core").Image>(barcodeRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult & {
@@ -862,6 +863,7 @@ export declare class WorkerBridge {
862
863
  _marker?: () => void;
863
864
  }[];
864
865
  readonly qualityIndices?: import("./compiled/DocumentQualityAnalyzerTypes").DocumentQuality[];
866
+ readonly detectOrientation?: boolean;
865
867
  readonly maxImageSize?: number;
866
868
  minEstimatedNumberOfSymbolsForDocument?: number;
867
869
  readonly minProcessedFraction?: number;
@@ -874,7 +876,7 @@ export declare class WorkerBridge {
874
876
  imageApplyFilter: (image: import("../worker/ScanbotSDK.Core").Image, filter: import("./common").DeepPartial<import("./compiled/ParametricFilters").ParametricFilter>) => Promise<import("./common").RawImage>;
875
877
  imageCrop: (image: import("../worker/ScanbotSDK.Core").Image, polygon: [import("./common").Point, import("./common").Point, import("./common").Point, import("./common").Point]) => Promise<import("./common").RawImage>;
876
878
  imageResize: (image: import("../worker/ScanbotSDK.Core").Image, destinationSize: number) => Promise<import("./common").RawImage>;
877
- imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageProcessorTypes").ImageRotation) => Promise<import("./common").RawImage>;
879
+ imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageTypes").ImageRotation) => Promise<import("./common").RawImage>;
878
880
  genericDocumentRecognizerCreate: (parameters: {
879
881
  resultAccumulationConfig?: {
880
882
  confirmationMethod?: import("./compiled/FrameAccumulationTypes").ConfirmationMethod;
@@ -886,18 +888,12 @@ export declare class WorkerBridge {
886
888
  fieldExcludeList?: string[];
887
889
  configurations?: ({
888
890
  readonly _type?: "DateValidationConfig";
889
- readonly minBirthYear?: number;
890
- readonly maxBirthYear?: number;
891
- readonly minExpirationYear?: number;
892
- readonly maxExpirationYear?: number;
893
- readonly documentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[];
891
+ readonly minYear?: number;
892
+ readonly maxYear?: number;
893
+ readonly fieldTypeName?: string;
894
894
  _marker?: () => void;
895
895
  } | {
896
896
  readonly _type?: "EuropeanHealthInsuranceCardConfig";
897
- readonly minBirthYear?: number;
898
- readonly maxBirthYear?: number;
899
- readonly minExpirationYear?: number;
900
- readonly maxExpirationYear?: number;
901
897
  readonly expectedCountry?: import("./compiled/GenericDocumentRecognizerConfigs").EHICIssuingCountry;
902
898
  _marker?: () => void;
903
899
  } | {
@@ -907,7 +903,7 @@ export declare class WorkerBridge {
907
903
  _marker?: () => void;
908
904
  } | {
909
905
  readonly _type?: "GDRGroupConfig";
910
- readonly acceptedDocumentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[];
906
+ readonly acceptedDocumentTypes?: string[];
911
907
  _marker?: () => void;
912
908
  })[];
913
909
  _marker?: () => void;
@@ -2,11 +2,12 @@ import { PdfConfig } from "../bridge/compiled/PdfConfig";
2
2
  import { type RecognitionResult as MrzRecognitionResult, RecognizerConfiguration as MrzRecognizerConfig } from "../bridge/compiled/MRZTypes";
3
3
  import { DocumentQualityAnalyzerConfiguration, type DocumentQualityAnalyzerResult } from "../bridge/compiled/DocumentQualityAnalyzerTypes";
4
4
  import { ParametricFilter } from "../bridge/compiled/ParametricFilters";
5
- import type { ImageRotation } from "../bridge/compiled/ImageProcessorTypes";
5
+ import type { ImageRotation } from "../bridge/compiled/ImageTypes";
6
6
  import { DocumentDetectorParameters, type DocumentDetectionResult } from "../bridge/compiled/DocumentDetectorTypes";
7
7
  import { ScannerConfiguration as GtsConfig, type ScannerResult as GtsResult } from "../bridge/compiled/GenericTextLineScannerTypes";
8
8
  import type { Page } from "../bridge/compiled/OcrElements";
9
- import { type BarcodeDocumentFormat, BarcodeScannerConfiguration, type BarcodeScannerResult } from "../bridge/compiled/BarcodeScannerTypes";
9
+ import { type BarcodeDocumentFormat } from "../bridge/compiled/BarcodeDocumentTypes";
10
+ import { BarcodeScannerConfiguration, type BarcodeScannerResult } from "../bridge/compiled/BarcodeScannerTypes";
10
11
  import { GenericDocumentRecognizerParameters, RecognitionParameters as GdrRecognitionParameters, type RecognitionResult as GdrRecognitionResult } from "../bridge/compiled/GenericDocumentRecognizerTypes";
11
12
  import { type Binarization, TIFFWriterParameters } from "../bridge/compiled/TiffTypes";
12
13
  import type { RawImage, Point, DeepPartial } from "../bridge/common";
@@ -1,6 +1,7 @@
1
1
  export * as BarcodeConfigs from './core/bridge/compiled/BarcodeConfigs';
2
2
  export * as BarcodeScannerTypes from './core/bridge/compiled/BarcodeScannerTypes';
3
3
  export * as BarcodeTypes from './core/bridge/compiled/BarcodeTypes';
4
+ export * as BarcodeDocumentTypes from "./core/bridge/compiled/BarcodeDocumentTypes";
4
5
  export * as CheckRecognizerTypes from './core/bridge/compiled/CheckRecognizerTypes';
5
6
  export * as CommonFieldType from './core/bridge/compiled/CommonFieldType';
6
7
  export * as DocumentDetectorTypes from './core/bridge/compiled/DocumentDetectorTypes';
@@ -12,7 +13,6 @@ export * as GenericDocumentRecognizerTypes from './core/bridge/compiled/GenericD
12
13
  export * as GenericDocumentTypes from './core/bridge/compiled/GenericDocumentTypes';
13
14
  export * as GenericTextLineScannerTypes from './core/bridge/compiled/GenericTextLineScannerTypes';
14
15
  export * as Geometry from './core/bridge/compiled/Geometry';
15
- export * as ImageProcessorTypes from './core/bridge/compiled/ImageProcessorTypes';
16
16
  export * as LicensePlateScannerTypes from './core/bridge/compiled/LicensePlateScannerTypes';
17
17
  export * as MedicalCertificateTypes from './core/bridge/compiled/MedicalCertificateTypes';
18
18
  export * as MRZTypes from './core/bridge/compiled/MRZTypes';
@@ -22,5 +22,6 @@ export * as PdfConfig from './core/bridge/compiled/PdfConfig';
22
22
  export * as TiffTypes from './core/bridge/compiled/TiffTypes';
23
23
  export * as FrameUtilities from './core/bridge/compiled/FrameUtilities';
24
24
  export * as FrameAccumulationTypes from './core/bridge/compiled/FrameAccumulationTypes';
25
+ export * as ImageTypes from './core/bridge/compiled/ImageTypes';
25
26
  export type { ObjectId, Image, CroppedDetectionResult } from './core/worker/ScanbotSDK.Core';
26
27
  export { PartiallyConstructible, type RawImage, type DeepPartial, type Point, type Rectangle } from './core/bridge/common';
@@ -8,9 +8,8 @@ import { Point } from "./utils/dto/Point";
8
8
  import { MagneticLine } from "./utils/dto/MagneticLine";
9
9
  import { Polygon } from "./utils/dto/Polygon";
10
10
  import MagnifierView, { MagnifierOptions } from "./view/cropping/magnifier-view";
11
- import { ImageProcessorTypes } from "./core-types";
12
11
  import { ICroppingViewHandle } from "./interfaces/i-cropping-view-handle";
13
- import { DocumentDetectorTypes } from "./core-types";
12
+ import { DocumentDetectorTypes, ImageTypes } from "./core-types";
14
13
  export interface CroppingViewProps {
15
14
  configuration: CroppingViewConfiguration;
16
15
  container?: HTMLElement;
@@ -70,7 +69,7 @@ export default class CroppingView extends React.Component<CroppingViewProps, Cro
70
69
  */
71
70
  apply(): Promise<CroppingResult>;
72
71
  MAX_ROTATIONS: number;
73
- toCoreRotations(cw: number): ImageProcessorTypes.ImageRotation;
72
+ toCoreRotations(cw: number): ImageTypes.ImageRotation;
74
73
  rotate(rotations: number): Promise<void>;
75
74
  detect(): Promise<void>;
76
75
  dispose(): void;