@scandit/web-datacapture-id 7.6.2 → 8.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/build/js/Enums.d.ts +31 -0
  2. package/build/js/IdCapture.d.ts +2 -1
  3. package/build/js/IdCaptureSettings.d.ts +9 -9
  4. package/build/js/SerializedTypes.d.ts +171 -87
  5. package/build/js/captured-id/BarcodeResult.d.ts +1 -1
  6. package/build/js/captured-id/CapturedId.d.ts +8 -9
  7. package/build/js/captured-id/DataConsistencyResult.d.ts +2 -3
  8. package/build/js/captured-id/DateResult.d.ts +2 -0
  9. package/build/js/captured-id/MRZResult.d.ts +2 -10
  10. package/build/js/captured-id/MobileDocumentOCRResult.d.ts +21 -0
  11. package/build/js/captured-id/VIZResult.d.ts +1 -2
  12. package/build/js/captured-id/VerificationResult.d.ts +1 -1
  13. package/build/js/document/RegionSpecificSubtype.d.ts +0 -1
  14. package/build/js/index.d.ts +5 -5
  15. package/build/js/index.js +5 -5
  16. package/build/js/scanner/IdCaptureScanner.d.ts +16 -0
  17. package/build/js/scanner/mobileDocuments/MobileDocumentScanner.d.ts +8 -0
  18. package/build/js/scanner/physicalDocuments/FullDocumentScanner.d.ts +7 -0
  19. package/build/js/scanner/physicalDocuments/PhysicalDocumentScanner.d.ts +16 -0
  20. package/build/js/scanner/{SingleSideScanner.d.ts → physicalDocuments/SingleSideScanner.d.ts} +4 -5
  21. package/build/js/worker/IdCaptureMode.d.ts +3 -3
  22. package/build/js/worker/dataCaptureEngine.d.ts +0 -1
  23. package/build/js/worker/dataCaptureWorkerRelated.d.ts +20 -46
  24. package/package.json +2 -2
  25. package/sdc-lib/idcapture/8.0.0-beta.2/resources/centaurus-worker.js +6 -0
  26. package/sdc-lib/idcapture/8.0.0-beta.2/resources/lightweight/advanced/Centaurus.js +1 -0
  27. package/sdc-lib/idcapture/8.0.0-beta.2/resources/lightweight/advanced-threads/Centaurus.js +1 -0
  28. package/sdc-lib/idcapture/8.0.0-beta.2/resources/lightweight/basic/Centaurus.js +1 -0
  29. package/sdc-lib/resources/models/barcode_keypoints_oned.43a682cdf24a.model +0 -0
  30. package/sdc-lib/resources/models/text_semantics_ocr_detector.290bf42945e3.model +0 -0
  31. package/sdc-lib/scandit-datacapture-sdk-id-pthreads.js +1 -1
  32. package/sdc-lib/scandit-datacapture-sdk-id-pthreads.wasm +0 -0
  33. package/sdc-lib/scandit-datacapture-sdk-id-simd-pthreads.js +1 -1
  34. package/sdc-lib/scandit-datacapture-sdk-id-simd-pthreads.wasm +0 -0
  35. package/sdc-lib/scandit-datacapture-sdk-id-simd.js +1 -1
  36. package/sdc-lib/scandit-datacapture-sdk-id-simd.wasm +0 -0
  37. package/sdc-lib/scandit-datacapture-sdk-id.js +1 -1
  38. package/sdc-lib/scandit-datacapture-sdk-id.wasm +0 -0
  39. package/build/js/DataConsistencyVerifier.d.ts +0 -12
  40. package/build/js/scanner/FullDocumentScanner.d.ts +0 -14
  41. package/build/js/scanner/Scanner.d.ts +0 -9
  42. package/sdc-lib/idcapture/7.6.2/resources/centaurus-worker.js +0 -6
  43. package/sdc-lib/idcapture/7.6.2/resources/lightweight/advanced/Centaurus.js +0 -1
  44. package/sdc-lib/idcapture/7.6.2/resources/lightweight/advanced-threads/Centaurus.js +0 -1
  45. package/sdc-lib/idcapture/7.6.2/resources/lightweight/basic/Centaurus.js +0 -1
  46. /package/sdc-lib/idcapture/{7.6.2 → 8.0.0-beta.2}/resources/lightweight/advanced/Centaurus.data +0 -0
  47. /package/sdc-lib/idcapture/{7.6.2 → 8.0.0-beta.2}/resources/lightweight/advanced/Centaurus.wasm +0 -0
  48. /package/sdc-lib/idcapture/{7.6.2 → 8.0.0-beta.2}/resources/lightweight/advanced-threads/Centaurus.data +0 -0
  49. /package/sdc-lib/idcapture/{7.6.2 → 8.0.0-beta.2}/resources/lightweight/advanced-threads/Centaurus.wasm +0 -0
  50. /package/sdc-lib/idcapture/{7.6.2 → 8.0.0-beta.2}/resources/lightweight/basic/Centaurus.data +0 -0
  51. /package/sdc-lib/idcapture/{7.6.2 → 8.0.0-beta.2}/resources/lightweight/basic/Centaurus.wasm +0 -0
@@ -21,6 +21,37 @@ export declare enum IdCaptureTrigger {
21
21
  Auto = "auto",
22
22
  ButtonTap = "buttonTap"
23
23
  }
24
+ export declare enum IdFieldType {
25
+ AdditionalAddressInformation = "additionalAddressInformation",
26
+ AdditionalNameInformation = "additionalNameInformation",
27
+ Address = "address",
28
+ Age = "age",
29
+ BarcodeDictionary = "barcodeDictionary",
30
+ BloodType = "bloodType",
31
+ DateOfBirth = "dateOfBirth",
32
+ DateOfExpiry = "dateOfExpiry",
33
+ DateOfIssue = "dateOfIssue",
34
+ DocumentAdditionalNumber = "documentAdditionalNumber",
35
+ DocumentNumber = "documentNumber",
36
+ Employer = "employer",
37
+ FathersName = "fathersName",
38
+ FirstName = "firstName",
39
+ FullName = "fullName",
40
+ IssuingAuthority = "issuingAuthority",
41
+ LastName = "lastName",
42
+ MaritalStatus = "maritalStatus",
43
+ MothersName = "mothersName",
44
+ MrzOptionalDataInLine1 = "mrzOptionalDataInLine1",
45
+ MrzOptionalDataInLine2 = "mrzOptionalDataInLine2",
46
+ Nationality = "nationality",
47
+ PersonalIdNumber = "personalIdNumber",
48
+ PlaceOfBirth = "placeOfBirth",
49
+ Profession = "profession",
50
+ Race = "race",
51
+ Religion = "religion",
52
+ ResidentialStatus = "residentialStatus",
53
+ Sex = "sex"
54
+ }
24
55
  export declare enum IdLayoutStyle {
25
56
  Rounded = "rounded",
26
57
  Square = "square"
@@ -97,7 +97,8 @@ export declare class IdCapture implements DataCaptureMode, Serializable<IdCaptur
97
97
  private processFrameWithCentaurus;
98
98
  private reportToBackend;
99
99
  private uint8ArrayImageToBase64;
100
- private convertRawImagesToBase64;
100
+ private processRawImages;
101
+ private anonymizeImage;
101
102
  private triggerListenersForLocalization;
102
103
  private triggerListenersForResult;
103
104
  private notifyRecoveryAfterCrash;
@@ -2,15 +2,16 @@ import type { JSONType } from "@scandit/web-datacapture-core";
2
2
  import type { Serializable } from "@scandit/web-datacapture-core/build/js/private/Serializable";
3
3
  import { Duration } from "./Duration";
4
4
  import type { DurationJSON } from "./SerializedTypes";
5
- import { IdAnonymizationMode, IdCaptureTrigger, IdImageType } from "./Enums";
5
+ import { IdAnonymizationMode, IdCaptureTrigger, IdImageType, type IdFieldType } from "./Enums";
6
6
  import type { IdCaptureDocument, IdCaptureDocumentJSON } from "./document/IdCaptureDocument";
7
- import type { IdCaptureScanner, ScannerJSON } from "./scanner/Scanner";
7
+ import { IdCaptureScanner, type IdCaptureScannerJSON } from "./scanner/IdCaptureScanner";
8
8
  export interface IdCaptureSettingsJSON {
9
9
  acceptedDocuments: IdCaptureDocumentJSON[];
10
10
  rejectedDocuments: IdCaptureDocumentJSON[];
11
- scannerType: ScannerJSON;
11
+ scannerType: IdCaptureScannerJSON;
12
12
  imageToResult: Record<IdImageType, boolean>;
13
13
  anonymizationMode: IdAnonymizationMode;
14
+ anonymizationMap: Record<string, IdFieldType[]>;
14
15
  captureTrigger: IdCaptureTrigger;
15
16
  rejectVoidedIds: boolean;
16
17
  decodeBackOfEuropeanDrivingLicense: boolean;
@@ -19,14 +20,13 @@ export interface IdCaptureSettingsJSON {
19
20
  rejectInconsistentData: boolean;
20
21
  rejectHolderBelowAge: number | null;
21
22
  rejectIdsExpiringIn: DurationJSON | null;
22
- decodeMobileDriverLicenseViz: boolean;
23
23
  notifyOnSideCapture: boolean;
24
24
  properties: JSONType;
25
25
  }
26
26
  export declare class IdCaptureSettings implements Serializable<IdCaptureSettingsJSON> {
27
27
  acceptedDocuments: IdCaptureDocument[];
28
28
  rejectedDocuments: IdCaptureDocument[];
29
- scannerType: IdCaptureScanner;
29
+ scanner: IdCaptureScanner;
30
30
  anonymizationMode: IdAnonymizationMode;
31
31
  captureTrigger: IdCaptureTrigger;
32
32
  rejectVoidedIds: boolean;
@@ -36,18 +36,18 @@ export declare class IdCaptureSettings implements Serializable<IdCaptureSettings
36
36
  rejectInconsistentData: boolean;
37
37
  rejectHolderBelowAge: number | null;
38
38
  rejectIdsExpiringIn: Duration | null;
39
- /**
40
- * @deprecated 7.6.0 This setting is deprecated and will be removed in SDK version 8.0. A replacement API will be introduced in version 8.0.
41
- */
42
- decodeMobileDriverLicenseViz: boolean;
43
39
  notifyOnSideCapture: boolean;
44
40
  private properties;
45
41
  private imageToResult;
42
+ private anonymizationMap;
46
43
  constructor();
47
44
  setProperty(name: string, value: any): void;
48
45
  getProperty(name: string): any;
49
46
  setShouldPassImageTypeToResult(type: IdImageType, shouldPass: boolean): void;
50
47
  getShouldPassImageTypeToResult(type: IdImageType): boolean;
48
+ addAnonymizedField(document: IdCaptureDocument, fieldType: IdFieldType): void;
49
+ removeAnonymizedField(document: IdCaptureDocument, fieldType: IdFieldType): void;
50
+ clearAnonymizedFields(): void;
51
51
  clone(): IdCaptureSettings;
52
52
  toJSONObject(): IdCaptureSettingsJSON;
53
53
  private static fromJSON;
@@ -1,5 +1,39 @@
1
- import type { QuadrilateralJSON } from "@scandit/web-datacapture-core";
1
+ import type { Prettify, QuadrilateralJSON } from "@scandit/web-datacapture-core";
2
2
  import type { DataConsistencyCheck } from "./DataConsistencyCheck";
3
+ /**
4
+ *
5
+ * A CapturedId has many steps through which it does to reach its final shape.
6
+ * Here is a break-down of the used types accross the different steps:
7
+ *
8
+ * ------------
9
+ * | Centaurus |
10
+ * ------------
11
+ * |
12
+ * | VIZResultJSON: The VIZ data coming from Centaurus.
13
+ * |
14
+ * | VIZResultExtendedJSON: The VIZ data coming from Centaurus, but augmented with extra information like the location
15
+ * |
16
+ * | CapturedIdFromCentaurusJSON: A captured id containing the data extracted by Centaurus, as well as the location information.
17
+ * V
18
+ * ------------
19
+ * | SDC |
20
+ * ------------
21
+ * |
22
+ * | CapturedIdBeforeAnonymizationJSON: final shape, but the data does not use anonymized field data yet and it has no image information
23
+ * |
24
+ * | CapturedIdWithRawImageInfoJSON: final shape, but the image format still needs to be processed in the main thread
25
+ * V
26
+ * ---------------
27
+ * | Main Thread |
28
+ * ---------------
29
+ * |
30
+ * | CapturedIdJSON: The public, final shape
31
+ * |
32
+ * V
33
+ *
34
+ * CapturedId
35
+ */
36
+ export type CapturedIdDataField<T> = T;
3
37
  export interface DateResultJSON {
4
38
  day: number | null;
5
39
  month: number | null;
@@ -36,89 +70,82 @@ export interface ImageInfoJSON {
36
70
  frame: string | null;
37
71
  };
38
72
  }
39
- interface CommonFieldsJSON {
40
- firstName: string | null;
41
- lastName: string | null;
42
- secondaryLastName: string | null;
43
- fullName: string;
44
- sex: string | null;
45
- nationality: string | null;
46
- address: string | null;
47
- issuingCountry: string | null;
48
- issuingCountryIso: string | null;
49
- documentNumber: string | null;
50
- documentAdditionalNumber: string | null;
51
- dateOfBirth: DateResultJSON | null;
52
- dateOfExpiry: DateResultJSON | null;
53
- dateOfIssue: DateResultJSON | null;
54
- documentType: string | null;
55
- documentSubtype: string | null;
56
- }
57
- export interface CapturedIdJSON {
58
- firstName: string | null;
59
- lastName: string | null;
60
- secondaryLastName: string | null;
61
- fullName: string;
62
- sex: string | null;
63
- nationality: string | null;
64
- address: string | null;
65
- issuingCountry: string | null;
66
- issuingCountryIso: string | null;
67
- documentNumber: string | null;
68
- documentAdditionalNumber: string | null;
69
- dateOfBirth: DateResultJSON | null;
70
- age: number | null;
71
- dateOfExpiry: DateResultJSON | null;
72
- isExpired: boolean | null;
73
- dateOfIssue: DateResultJSON | null;
74
- documentType: string | null;
75
- documentSubtype: string | null;
73
+ export type CapturedIdJSON = Prettify<{
74
+ firstName: CapturedIdDataField<string | null>;
75
+ lastName: CapturedIdDataField<string | null>;
76
+ fullName: CapturedIdDataField<string | null>;
77
+ sex: CapturedIdDataField<string | null>;
78
+ nationality: CapturedIdDataField<string | null>;
79
+ address: CapturedIdDataField<string | null>;
80
+ issuingCountry: CapturedIdDataField<string | null>;
81
+ issuingCountryIso: CapturedIdDataField<string | null>;
82
+ documentNumber: CapturedIdDataField<string | null>;
83
+ documentAdditionalNumber: CapturedIdDataField<string | null>;
84
+ dateOfBirth: CapturedIdDataField<DateResultJSON | null>;
85
+ dateOfExpiry: CapturedIdDataField<DateResultJSON | null>;
86
+ dateOfIssue: CapturedIdDataField<DateResultJSON | null>;
87
+ documentType: CapturedIdDataField<string | null>;
88
+ documentSubtype: CapturedIdDataField<string | null>;
76
89
  imageInfo: ImageInfoJSON | null;
77
- idVerificationDataComparisonAvailable: boolean;
78
90
  barcodeResult: BarcodeResultJSON | null;
79
91
  mrzResult: MRZResultJSON | null;
80
- verificationResult: VerificationResultJSON | null;
81
92
  vizResult: VIZResultJSON | null;
93
+ mobileDocumentOcrResult: MobileDocumentOCRResultJSON | null;
94
+ verificationResult: VerificationResultJSON | null;
95
+ idVerificationDataComparisonAvailable: boolean;
82
96
  usRealIdStatus: string | null;
97
+ isExpired: CapturedIdDataField<boolean | null>;
98
+ age: CapturedIdDataField<number | null>;
99
+ isCitizenPassport: boolean;
83
100
  isCapturingComplete: boolean;
84
- }
85
- interface RawImageInfo {
101
+ anonymizedFields: string[];
102
+ }>;
103
+ interface FrameInfo {
86
104
  data: Uint8ClampedArray | null;
87
105
  width: number;
88
106
  height: number;
89
107
  mirrorAxis: number;
90
108
  orientation: number;
91
109
  }
92
- export interface CapturedIdJSONWithRawImageInfo extends CapturedIdJSON {
93
- rawImageInfo: {
94
- front: {
95
- face: string | null;
96
- croppedDocument: string | null;
97
- frame: RawImageInfo;
110
+ export interface RawImageInfo {
111
+ front: {
112
+ face: string | null;
113
+ croppedDocument: {
114
+ image: string | null;
115
+ obscuredRegions: QuadrilateralJSON[];
116
+ };
117
+ frame: {
118
+ image: FrameInfo;
119
+ obscuredRegions: QuadrilateralJSON[];
120
+ };
121
+ };
122
+ back: {
123
+ face: null;
124
+ croppedDocument: {
125
+ image: string | null;
126
+ obscuredRegions: QuadrilateralJSON[];
98
127
  };
99
- back: {
100
- face: null;
101
- croppedDocument: string | null;
102
- frame: RawImageInfo;
128
+ frame: {
129
+ image: FrameInfo;
130
+ obscuredRegions: QuadrilateralJSON[];
103
131
  };
104
132
  };
105
133
  }
106
- export type CapturedIdCommonFieldsJSON = Pick<CapturedIdJSON, "address" | "age" | "dateOfBirth" | "dateOfExpiry" | "dateOfIssue" | "documentAdditionalNumber" | "documentNumber" | "documentType" | "documentSubtype" | "firstName" | "fullName" | "isExpired" | "issuingCountry" | "issuingCountryIso" | "lastName" | "nationality" | "secondaryLastName" | "sex">;
107
- export type VIZResultExtendedJSON = Omit<CapturedIdCommonFieldsJSON & VIZResultJSON, "age" | "isExpired"> & {
108
- location?: QuadrilateralJSON | null;
134
+ export type CapturedIdWithRawImageInfoJSON = CapturedIdJSON & {
135
+ rawImageInfo: RawImageInfo;
109
136
  };
110
- interface FieldLocations {
137
+ export type CapturedIdCommonFieldsJSON = Pick<CapturedIdJSON, "address" | "age" | "dateOfBirth" | "dateOfExpiry" | "dateOfIssue" | "documentAdditionalNumber" | "documentNumber" | "documentType" | "documentSubtype" | "firstName" | "fullName" | "isExpired" | "issuingCountry" | "issuingCountryIso" | "lastName" | "nationality" | "sex">;
138
+ type VizResultFieldsCalculatedBySDC = "age" | "isExpired";
139
+ export type VIZResultExtendedJSON = Prettify<Omit<VIZResultJSON, VizResultFieldsCalculatedBySDC> & {
140
+ location: QuadrilateralJSON | null;
111
141
  frontFieldLocations: Partial<Record<string, QuadrilateralJSON>>;
112
- }
113
- export type VIZResultExtendedWithFieldLocationsJSON = FieldLocations & VIZResultExtendedJSON;
114
- export type CapturedIdWithExtendedVIZJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable" | "usRealIdStatus"> & {
142
+ }>;
143
+ export type CapturedIdFromCentaurusJSON = Prettify<Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable" | "usRealIdStatus" | "isCapturingComplete" | "isCitizenPassport" | "anonymizedFields"> & {
115
144
  vizResult: VIZResultExtendedJSON;
116
- };
117
- export type CapturedIdWithExtendedVIZAndLocationsJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON> & {
118
- vizResult: VIZResultExtendedWithFieldLocationsJSON;
119
- };
120
- export interface BarcodeResultJSON extends CommonFieldsJSON {
145
+ }>;
146
+ export interface BarcodeResultJSON {
121
147
  aamvaVersion: number | null;
148
+ address: string | null;
122
149
  aliasFamilyName: string | null;
123
150
  aliasGivenName: string | null;
124
151
  aliasSuffixName: string | null;
@@ -137,12 +164,20 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
137
164
  commissaryFlagDescription: string | null;
138
165
  countryOfBirth: string | null;
139
166
  countryOfBirthIso: string | null;
167
+ dateOfBirth: DateResultJSON | null;
168
+ dateOfExpiry: DateResultJSON | null;
169
+ dateOfIssue: DateResultJSON | null;
140
170
  deersDependentSuffixCode: number | null;
141
171
  deersDependentSuffixDescription: string | null;
172
+ dictionary: Record<string, string>;
142
173
  directCareFlagCode: string | null;
143
174
  directCareFlagDescription: string | null;
175
+ documentAdditionalNumber: string | null;
144
176
  documentCopy: string | null;
145
177
  documentDiscriminatorNumber: string | null;
178
+ documentNumber: string | null;
179
+ documentSubtype: string | null;
180
+ documentType: string | null;
146
181
  driverNamePrefix: string | null;
147
182
  driverNameSuffix: string | null;
148
183
  driverRestrictionCodes: number[] | null;
@@ -152,25 +187,33 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
152
187
  exchangeFlagDescription: string | null;
153
188
  eyeColor: string | null;
154
189
  familySequenceNumber: number | null;
190
+ firstName: string | null;
155
191
  firstNameTruncation: string | null;
156
192
  firstNameWithoutMiddleName: string | null;
157
193
  formNumber: string | null;
194
+ fullName: string | null;
158
195
  genevaConventionCategory: string | null;
159
196
  hairColor: string | null;
160
197
  heightCm: number | null;
161
198
  heightInch: number | null;
162
- iin: string | null;
163
199
  identificationType: string | null;
200
+ iin: string | null;
201
+ isRealId: boolean | null;
202
+ issuingCountry: string | null;
203
+ issuingCountryIso: string | null;
164
204
  issuingJurisdiction: string | null;
165
205
  issuingJurisdictionIso: string | null;
166
206
  jpegData: string | null;
167
207
  jurisdictionVersion: number | null;
208
+ lastName: string | null;
168
209
  lastNameTruncation: string | null;
169
210
  licenseCountryOfIssue: string | null;
211
+ location: QuadrilateralJSON | null;
170
212
  middleName: string | null;
171
213
  middleNameTruncation: string | null;
172
214
  mwrFlagCode: string | null;
173
215
  mwrFlagDescription: string | null;
216
+ nationality: string | null;
174
217
  payGrade: string | null;
175
218
  payPlanCode: string | null;
176
219
  payPlanGradeCode: string | null;
@@ -191,6 +234,8 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
191
234
  restrictionsCode: string | null;
192
235
  securityCode: string | null;
193
236
  serviceCode: string | null;
237
+ sex: string | null;
238
+ sexOriginal: string | null;
194
239
  sponsorFlag: string | null;
195
240
  sponsorName: string | null;
196
241
  sponsorPersonDesignatorIdentifier: number | null;
@@ -201,53 +246,91 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
201
246
  version: string | null;
202
247
  weightKg: number | null;
203
248
  weightLbs: number | null;
204
- isRealId: boolean | null;
205
- dictionary: Record<string, string>;
206
249
  }
207
- export interface MRZResultJSON extends CommonFieldsJSON {
250
+ export interface MRZResultJSON {
251
+ address: string | null;
252
+ capturedMrz: string | null;
253
+ dateOfBirth: DateResultJSON | null;
254
+ dateOfExpiry: DateResultJSON | null;
255
+ dateOfIssue: DateResultJSON | null;
208
256
  documentCode: string;
209
- namesAreTruncated: boolean;
210
- optional: string | null;
211
- optional1: string | null;
212
- optionalDataInLine1: string | null;
213
- optionalDataInLine2: string | null;
214
- capturedMrz: string;
215
- personalIdNumber: string | null;
216
- renewalTimes: number | null;
257
+ documentNumber: string | null;
258
+ firstName: string | null;
259
+ fullName: string | null;
217
260
  fullNameSimplifiedChinese: string | null;
261
+ issuingAuthorityCode: string | null;
262
+ lastName: string | null;
263
+ namesAreTruncated: boolean;
264
+ nationality: string | null;
218
265
  omittedCharacterCountInGbkName: number | null;
219
266
  omittedNameCount: number | null;
220
- issuingAuthorityCode: string | null;
267
+ optionalDataInLine1: string | null;
268
+ optionalDataInLine2: string | null;
269
+ passportDateOfExpiry: DateResultJSON | null;
221
270
  passportIssuerIso: string | null;
222
271
  passportNumber: string | null;
223
- passportDateOfExpiry: DateResultJSON | null;
272
+ personalIdNumber: string | null;
273
+ renewalTimes: number | null;
274
+ sex: string | null;
224
275
  }
225
- export interface VIZResultJSON extends CommonFieldsJSON {
276
+ export interface VIZResultJSON {
226
277
  additionalAddressInformation: string | null;
227
278
  additionalNameInformation: string | null;
279
+ address: string | null;
280
+ bloodType: string | null;
281
+ capturedSides: string;
282
+ dateOfBirth: DateResultJSON | null;
283
+ dateOfExpiry: DateResultJSON | null;
284
+ dateOfIssue: DateResultJSON | null;
228
285
  documentAdditionalNumber: string | null;
286
+ documentNumber: string | null;
287
+ documentSubtype: string | null;
288
+ documentType: string | null;
289
+ drivingLicenseDetails: DrivingLicenseDetailsJSON | null;
229
290
  employer: string | null;
291
+ fathersName: string | null;
292
+ firstName: string | null;
293
+ fullName: string | null;
294
+ isBackSideCaptureSupported: boolean;
230
295
  issuingAuthority: string | null;
296
+ issuingCountry: string | null;
297
+ issuingCountryIso: string | null;
231
298
  issuingJurisdiction: string | null;
232
299
  issuingJurisdictionIso: string | null;
300
+ lastName: string | null;
301
+ location: QuadrilateralJSON | null;
233
302
  maritalStatus: string | null;
303
+ mothersName: string | null;
304
+ mrzDetected: boolean;
305
+ nationality: string | null;
306
+ passportNumber: string | null;
234
307
  personalIdNumber: string | null;
235
308
  placeOfBirth: string | null;
236
309
  profession: string | null;
237
310
  race: string | null;
238
311
  religion: string | null;
239
312
  residentialStatus: string | null;
240
- mothersName: string | null;
241
- fathersName: string | null;
242
- capturedSides: string;
243
- isBackSideCaptureSupported: boolean;
244
- drivingLicenseDetails: DrivingLicenseDetailsJSON | null;
245
- bloodType: string | null;
313
+ sex: string | null;
314
+ sexOriginal: string | null;
246
315
  sponsor: string | null;
247
- visaNumber: string | null;
248
- passportNumber: string | null;
249
316
  usRealIdStatus: string | null;
250
317
  vehicleOwner: string | null;
318
+ visaNumber: string | null;
319
+ }
320
+ export interface MobileDocumentOCRResultJSON {
321
+ dateOfBirth: DateResultJSON | null;
322
+ dateOfExpiry: DateResultJSON | null;
323
+ dateOfIssue: DateResultJSON | null;
324
+ documentNumber: string | null;
325
+ documentAdditionalNumber: string | null;
326
+ firstName: string | null;
327
+ fullName: string | null;
328
+ lastName: string | null;
329
+ sex: string | null;
330
+ nationality: string | null;
331
+ address: string | null;
332
+ issuingJurisdiction: string | null;
333
+ issuingJurisdictionIso: string | null;
251
334
  }
252
335
  export interface IdCaptureErrorJSON {
253
336
  type: string;
@@ -305,5 +388,6 @@ export interface CentaurusSettingsJSON {
305
388
  };
306
389
  scanUnsupportedBack: boolean;
307
390
  skipImagesOccludedByHand: boolean;
391
+ combineResultsFromMultipleInputImages: boolean;
308
392
  }
309
393
  export {};
@@ -92,7 +92,7 @@ export declare class BarcodeResult implements Serializable<BarcodeResultJSON> {
92
92
  get isRealId(): boolean | null;
93
93
  get firstName(): string | null;
94
94
  get lastName(): string | null;
95
- get fullName(): string;
95
+ get fullName(): string | null;
96
96
  get sex(): string | null;
97
97
  get dateOfBirth(): DateResult | null;
98
98
  get nationality(): string | null;
@@ -8,25 +8,20 @@ import { IdImages } from "./IdImages";
8
8
  import { MRZResult } from "./MRZResult";
9
9
  import { VIZResult } from "./VIZResult";
10
10
  import { VerificationResult } from "./VerificationResult";
11
- import { type Sex, UsRealIdStatus } from "../Enums";
11
+ import { type IdFieldType, type Sex, UsRealIdStatus } from "../Enums";
12
12
  import type { Region } from "../Region";
13
+ import { MobileDocumentOCRResult } from "./MobileDocumentOCRResult.js";
13
14
  export declare class CapturedId implements Serializable<CapturedIdJSON> {
14
15
  private json;
15
16
  private _barcodeResult;
16
17
  private _mrzResult;
17
18
  private _vizResult;
18
19
  private _verificationResult;
20
+ private _mobileDocumentOCRResult;
19
21
  get firstName(): string | null;
20
22
  get lastName(): string | null;
21
- get secondaryLastName(): string | null;
22
- get fullName(): string;
23
- /**
24
- * @deprecated This property will be replaced in SDK version 8.0 with a single sex property that returns an optional Sex.
25
- */
23
+ get fullName(): string | null;
26
24
  get sexType(): Sex;
27
- /**
28
- * @deprecated This property will be replaced in SDK version 8.0 with a single sex property that returns an optional Sex.
29
- */
30
25
  get sex(): string | null;
31
26
  get dateOfBirth(): DateResult | null;
32
27
  get age(): number | null;
@@ -39,14 +34,18 @@ export declare class CapturedId implements Serializable<CapturedIdJSON> {
39
34
  get documentAdditionalNumber(): string | null;
40
35
  get dateOfExpiry(): DateResult | null;
41
36
  get isExpired(): boolean | null;
37
+ get isCitizenPassport(): boolean;
42
38
  get dateOfIssue(): DateResult | null;
43
39
  get usRealIdStatus(): UsRealIdStatus;
44
40
  get isCapturingComplete(): boolean;
45
41
  get barcode(): BarcodeResult | null;
46
42
  get mrzResult(): MRZResult | null;
47
43
  get vizResult(): VIZResult | null;
44
+ get mobileDocumentOCRResult(): MobileDocumentOCRResult | null;
48
45
  get verificationResult(): VerificationResult;
49
46
  get images(): IdImages;
47
+ get anonymizedFields(): IdFieldType[];
48
+ isAnonymized(field: IdFieldType): boolean;
50
49
  private get barcodeResultsJSON();
51
50
  private get mrzResultsJSON();
52
51
  private static fromJSON;
@@ -10,8 +10,7 @@ export declare class DataConsistencyResult implements Serializable<DataConsisten
10
10
  private static fromJSON;
11
11
  frontReviewImage(): Promise<string>;
12
12
  toJSONObject(): DataConsistencyResultJSON;
13
- private pushQuadForKey;
14
- private pushQuadsForKeys;
15
- private getMismatchedQuads;
16
13
  private highlightImage;
14
+ private getQuadsForFields;
15
+ private getMismatchedQuads;
17
16
  }
@@ -5,6 +5,8 @@ export declare class DateResult implements Serializable<DateResultJSON> {
5
5
  get day(): number | null;
6
6
  get month(): number | null;
7
7
  get year(): number;
8
+ get localDate(): Date;
9
+ get utcDate(): Date;
8
10
  private static fromJSON;
9
11
  toJSONObject(): DateResultJSON;
10
12
  }
@@ -5,17 +5,9 @@ export declare class MRZResult implements Serializable<MRZResultJSON> {
5
5
  protected json: MRZResultJSON;
6
6
  get documentCode(): string;
7
7
  get namesAreTruncated(): boolean;
8
- /**
9
- * @deprecated Use optionalDataInLine1 and optionalDataInLine2 instead. This property will be removed in SDK version 8.0.
10
- */
11
- get optional(): string | null;
12
- /**
13
- * @deprecated Use optionalDataInLine1 and optionalDataInLine2 instead. This property will be removed in SDK version 8.0.
14
- */
15
- get optional1(): string | null;
16
8
  get optionalDataInLine1(): string | null;
17
9
  get optionalDataInLine2(): string | null;
18
- get capturedMrz(): string;
10
+ get capturedMrz(): string | null;
19
11
  get personalIdNumber(): string | null;
20
12
  get renewalTimes(): number | null;
21
13
  get fullNameSimplifiedChinese(): string | null;
@@ -27,7 +19,7 @@ export declare class MRZResult implements Serializable<MRZResultJSON> {
27
19
  get passportDateOfExpiry(): DateResult | null;
28
20
  get firstName(): string | null;
29
21
  get lastName(): string | null;
30
- get fullName(): string;
22
+ get fullName(): string | null;
31
23
  get sex(): string | null;
32
24
  get dateOfBirth(): DateResult | null;
33
25
  get nationality(): string | null;
@@ -0,0 +1,21 @@
1
+ import type { Serializable } from "@scandit/web-datacapture-core/build/js/private/Serializable";
2
+ import { DateResult } from "./DateResult";
3
+ import type { MobileDocumentOCRResultJSON } from "../SerializedTypes";
4
+ export declare class MobileDocumentOCRResult implements Serializable<MobileDocumentOCRResultJSON> {
5
+ protected json: MobileDocumentOCRResultJSON;
6
+ get dateOfBirth(): DateResult | null;
7
+ get dateOfExpiry(): DateResult | null;
8
+ get documentNumber(): string | null;
9
+ get firstName(): string | null;
10
+ get fullName(): string | null;
11
+ get lastName(): string | null;
12
+ get sex(): string | null;
13
+ get nationality(): string | null;
14
+ get address(): string | null;
15
+ get documentAdditionalNumber(): string | null;
16
+ get dateOfIssue(): DateResult | null;
17
+ get issuingJurisdiction(): string | null;
18
+ get issuingJurisdictionIso(): string | null;
19
+ private static fromJSON;
20
+ toJSONObject(): MobileDocumentOCRResultJSON;
21
+ }
@@ -7,8 +7,7 @@ export declare class VIZResult implements Serializable<VIZResultJSON> {
7
7
  protected json: VIZResultJSON;
8
8
  get firstName(): string | null;
9
9
  get lastName(): string | null;
10
- get secondaryLastName(): string | null;
11
- get fullName(): string;
10
+ get fullName(): string | null;
12
11
  get additionalAddressInformation(): string | null;
13
12
  get additionalNameInformation(): string | null;
14
13
  get documentAdditionalNumber(): string | null;
@@ -2,7 +2,7 @@ import type { Serializable } from "@scandit/web-datacapture-core/build/js/privat
2
2
  import { DataConsistencyResult } from "./DataConsistencyResult";
3
3
  import type { VerificationResultJSON } from "../SerializedTypes";
4
4
  export declare class VerificationResult implements Serializable<VerificationResultJSON> {
5
- protected json: VerificationResultJSON;
5
+ protected json: VerificationResultJSON | null;
6
6
  get dataConsistency(): DataConsistencyResult | null;
7
7
  private static fromJSON;
8
8
  toJSONObject(): VerificationResultJSON;
@@ -8,7 +8,6 @@ export declare enum RegionSpecificSubtype {
8
8
  ApecBusinessTravelCard = "apecBusinessTravelCard",
9
9
  PakistanAfghanCitizenCard = "pakistanAfghanCitizenCard",
10
10
  SingaporeFinCard = "singaporeFinCard",
11
- UsGreenCard = "usGreenCard",
12
11
  MalaysiaIkad = "malaysiaIkad",
13
12
  MalaysiaMykad = "malaysiaMykad",
14
13
  MalaysiaMypr = "malaysiaMypr",
@@ -11,7 +11,6 @@ export * from "./IdCaptureSettings";
11
11
  export * from "./Region";
12
12
  export * from "./AamvaBarcodeVerifier";
13
13
  export * from "./AamvaBarcodeVerifierResult";
14
- export * from "./DataConsistencyVerifier";
15
14
  export * from "./RejectionReason";
16
15
  export * from "./Duration";
17
16
  export * from "./document/IdCaptureDocument";
@@ -23,9 +22,11 @@ export * from "./document/RegionSpecific";
23
22
  export * from "./document/RegionSpecificSubtype";
24
23
  export * from "./document/ResidencePermit";
25
24
  export * from "./document/VisaIcao";
26
- export * from "./scanner/Scanner";
27
- export * from "./scanner/FullDocumentScanner";
28
- export * from "./scanner/SingleSideScanner";
25
+ export * from "./scanner/IdCaptureScanner";
26
+ export * from "./scanner/physicalDocuments/PhysicalDocumentScanner";
27
+ export * from "./scanner/physicalDocuments/FullDocumentScanner";
28
+ export * from "./scanner/physicalDocuments/SingleSideScanner";
29
+ export * from "./scanner/mobileDocuments/MobileDocumentScanner";
29
30
  export * from "./captured-id/BarcodeResult";
30
31
  export * from "./captured-id/CapturedId";
31
32
  export * from "./captured-id/DataConsistencyResult";
@@ -43,4 +44,3 @@ export interface IdCaptureLoaderOptions {
43
44
  }
44
45
  export declare let mainDataCaptureLoader: IdCaptureWorkerManager;
45
46
  export declare function idCaptureLoader(options?: IdCaptureLoaderOptions): ModuleLoader;
46
- export declare function setMainDataCaptureLoader(newLoader: IdCaptureWorkerManager): void;