@scandit/web-datacapture-id 7.6.1 → 8.0.0-beta.1

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 (47) hide show
  1. package/build/js/Enums.d.ts +31 -0
  2. package/build/js/IdCaptureSettings.d.ts +7 -9
  3. package/build/js/SerializedTypes.d.ts +161 -89
  4. package/build/js/captured-id/CapturedId.d.ts +7 -8
  5. package/build/js/captured-id/DateResult.d.ts +2 -0
  6. package/build/js/captured-id/MRZResult.d.ts +0 -8
  7. package/build/js/captured-id/MobileDocumentOCRResult.d.ts +21 -0
  8. package/build/js/captured-id/VIZResult.d.ts +0 -1
  9. package/build/js/document/RegionSpecificSubtype.d.ts +0 -1
  10. package/build/js/index.d.ts +5 -5
  11. package/build/js/index.js +5 -5
  12. package/build/js/scanner/IdCaptureScanner.d.ts +16 -0
  13. package/build/js/scanner/mobileDocuments/MobileDocumentScanner.d.ts +8 -0
  14. package/build/js/scanner/physicalDocuments/FullDocumentScanner.d.ts +7 -0
  15. package/build/js/scanner/physicalDocuments/PhysicalDocumentScanner.d.ts +16 -0
  16. package/build/js/scanner/{SingleSideScanner.d.ts → physicalDocuments/SingleSideScanner.d.ts} +4 -5
  17. package/build/js/worker/IdCaptureMode.d.ts +3 -3
  18. package/build/js/worker/dataCaptureEngine.d.ts +0 -1
  19. package/build/js/worker/dataCaptureWorkerRelated.d.ts +11 -47
  20. package/package.json +2 -2
  21. package/sdc-lib/idcapture/8.0.0-beta.1/resources/centaurus-worker.js +6 -0
  22. package/sdc-lib/idcapture/8.0.0-beta.1/resources/lightweight/advanced/Centaurus.js +1 -0
  23. package/sdc-lib/idcapture/8.0.0-beta.1/resources/lightweight/advanced-threads/Centaurus.js +1 -0
  24. package/sdc-lib/idcapture/8.0.0-beta.1/resources/lightweight/basic/Centaurus.js +1 -0
  25. package/sdc-lib/resources/models/barcode_keypoints_oned.43a682cdf24a.model +0 -0
  26. package/sdc-lib/resources/models/text_semantics_ocr_detector.290bf42945e3.model +0 -0
  27. package/sdc-lib/scandit-datacapture-sdk-id-pthreads.js +1 -1
  28. package/sdc-lib/scandit-datacapture-sdk-id-pthreads.wasm +0 -0
  29. package/sdc-lib/scandit-datacapture-sdk-id-simd-pthreads.js +1 -1
  30. package/sdc-lib/scandit-datacapture-sdk-id-simd-pthreads.wasm +0 -0
  31. package/sdc-lib/scandit-datacapture-sdk-id-simd.js +1 -1
  32. package/sdc-lib/scandit-datacapture-sdk-id-simd.wasm +0 -0
  33. package/sdc-lib/scandit-datacapture-sdk-id.js +1 -1
  34. package/sdc-lib/scandit-datacapture-sdk-id.wasm +0 -0
  35. package/build/js/DataConsistencyVerifier.d.ts +0 -12
  36. package/build/js/scanner/FullDocumentScanner.d.ts +0 -14
  37. package/build/js/scanner/Scanner.d.ts +0 -9
  38. package/sdc-lib/idcapture/7.6.1/resources/centaurus-worker.js +0 -6
  39. package/sdc-lib/idcapture/7.6.1/resources/lightweight/advanced/Centaurus.js +0 -1
  40. package/sdc-lib/idcapture/7.6.1/resources/lightweight/advanced-threads/Centaurus.js +0 -1
  41. package/sdc-lib/idcapture/7.6.1/resources/lightweight/basic/Centaurus.js +0 -1
  42. /package/sdc-lib/idcapture/{7.6.1 → 8.0.0-beta.1}/resources/lightweight/advanced/Centaurus.data +0 -0
  43. /package/sdc-lib/idcapture/{7.6.1 → 8.0.0-beta.1}/resources/lightweight/advanced/Centaurus.wasm +0 -0
  44. /package/sdc-lib/idcapture/{7.6.1 → 8.0.0-beta.1}/resources/lightweight/advanced-threads/Centaurus.data +0 -0
  45. /package/sdc-lib/idcapture/{7.6.1 → 8.0.0-beta.1}/resources/lightweight/advanced-threads/Centaurus.wasm +0 -0
  46. /package/sdc-lib/idcapture/{7.6.1 → 8.0.0-beta.1}/resources/lightweight/basic/Centaurus.data +0 -0
  47. /package/sdc-lib/idcapture/{7.6.1 → 8.0.0-beta.1}/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"
@@ -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,16 @@ 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;
51
49
  clone(): IdCaptureSettings;
52
50
  toJSONObject(): IdCaptureSettingsJSON;
53
51
  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,73 @@ 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>;
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;
98
- };
99
- back: {
100
- face: null;
101
- croppedDocument: string | null;
102
- frame: RawImageInfo;
103
- };
110
+ export type CapturedIdBeforeAnonymizationJSON = {
111
+ [key in keyof CapturedIdJSON]: CapturedIdJSON[key] extends CapturedIdDataField<infer A> ? A : CapturedIdJSON[key];
112
+ };
113
+ export interface RawImageInfo {
114
+ front: {
115
+ face: string | null;
116
+ croppedDocument: string | null;
117
+ frame: FrameInfo;
118
+ };
119
+ back: {
120
+ face: null;
121
+ croppedDocument: string | null;
122
+ frame: FrameInfo;
104
123
  };
105
124
  }
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;
125
+ export type CapturedIdWithRawImageInfoJSON = CapturedIdJSON & {
126
+ rawImageInfo: RawImageInfo;
109
127
  };
110
- interface FieldLocations {
128
+ export type CapturedIdCommonFieldsJSON = Pick<CapturedIdJSON, "address" | "age" | "dateOfBirth" | "dateOfExpiry" | "dateOfIssue" | "documentAdditionalNumber" | "documentNumber" | "documentType" | "documentSubtype" | "firstName" | "fullName" | "isExpired" | "issuingCountry" | "issuingCountryIso" | "lastName" | "nationality" | "sex">;
129
+ type VizResultFieldsCalculatedBySDC = "age" | "isExpired";
130
+ export type VIZResultExtendedJSON = Prettify<Omit<VIZResultJSON, VizResultFieldsCalculatedBySDC> & {
131
+ location: QuadrilateralJSON | null;
111
132
  frontFieldLocations: Partial<Record<string, QuadrilateralJSON>>;
112
- }
113
- export type VIZResultExtendedWithFieldLocationsJSON = FieldLocations & VIZResultExtendedJSON;
114
- export type CapturedIdWithExtendedVIZJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable" | "usRealIdStatus"> & {
133
+ }>;
134
+ export type CapturedIdFromCentaurusJSON = Prettify<Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable" | "usRealIdStatus" | "isCapturingComplete" | "isCitizenPassport" | "anonymizedFields"> & {
115
135
  vizResult: VIZResultExtendedJSON;
116
- };
117
- export type CapturedIdWithExtendedVIZAndLocationsJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON> & {
118
- vizResult: VIZResultExtendedWithFieldLocationsJSON;
119
- };
120
- export interface BarcodeResultJSON extends CommonFieldsJSON {
136
+ }>;
137
+ export interface BarcodeResultJSON {
121
138
  aamvaVersion: number | null;
139
+ address: string | null;
122
140
  aliasFamilyName: string | null;
123
141
  aliasGivenName: string | null;
124
142
  aliasSuffixName: string | null;
@@ -137,12 +155,20 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
137
155
  commissaryFlagDescription: string | null;
138
156
  countryOfBirth: string | null;
139
157
  countryOfBirthIso: string | null;
158
+ dateOfBirth: DateResultJSON | null;
159
+ dateOfExpiry: DateResultJSON | null;
160
+ dateOfIssue: DateResultJSON | null;
140
161
  deersDependentSuffixCode: number | null;
141
162
  deersDependentSuffixDescription: string | null;
163
+ dictionary: Record<string, string>;
142
164
  directCareFlagCode: string | null;
143
165
  directCareFlagDescription: string | null;
166
+ documentAdditionalNumber: string | null;
144
167
  documentCopy: string | null;
145
168
  documentDiscriminatorNumber: string | null;
169
+ documentNumber: string | null;
170
+ documentSubtype: string | null;
171
+ documentType: string | null;
146
172
  driverNamePrefix: string | null;
147
173
  driverNameSuffix: string | null;
148
174
  driverRestrictionCodes: number[] | null;
@@ -152,25 +178,33 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
152
178
  exchangeFlagDescription: string | null;
153
179
  eyeColor: string | null;
154
180
  familySequenceNumber: number | null;
181
+ firstName: string | null;
155
182
  firstNameTruncation: string | null;
156
183
  firstNameWithoutMiddleName: string | null;
157
184
  formNumber: string | null;
185
+ fullName: string;
158
186
  genevaConventionCategory: string | null;
159
187
  hairColor: string | null;
160
188
  heightCm: number | null;
161
189
  heightInch: number | null;
162
- iin: string | null;
163
190
  identificationType: string | null;
191
+ iin: string | null;
192
+ isRealId: boolean | null;
193
+ issuingCountry: string | null;
194
+ issuingCountryIso: string | null;
164
195
  issuingJurisdiction: string | null;
165
196
  issuingJurisdictionIso: string | null;
166
197
  jpegData: string | null;
167
198
  jurisdictionVersion: number | null;
199
+ lastName: string | null;
168
200
  lastNameTruncation: string | null;
169
201
  licenseCountryOfIssue: string | null;
202
+ location: QuadrilateralJSON | null;
170
203
  middleName: string | null;
171
204
  middleNameTruncation: string | null;
172
205
  mwrFlagCode: string | null;
173
206
  mwrFlagDescription: string | null;
207
+ nationality: string | null;
174
208
  payGrade: string | null;
175
209
  payPlanCode: string | null;
176
210
  payPlanGradeCode: string | null;
@@ -191,6 +225,8 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
191
225
  restrictionsCode: string | null;
192
226
  securityCode: string | null;
193
227
  serviceCode: string | null;
228
+ sex: string | null;
229
+ sexOriginal: string | null;
194
230
  sponsorFlag: string | null;
195
231
  sponsorName: string | null;
196
232
  sponsorPersonDesignatorIdentifier: number | null;
@@ -201,53 +237,89 @@ export interface BarcodeResultJSON extends CommonFieldsJSON {
201
237
  version: string | null;
202
238
  weightKg: number | null;
203
239
  weightLbs: number | null;
204
- isRealId: boolean | null;
205
- dictionary: Record<string, string>;
206
240
  }
207
- export interface MRZResultJSON extends CommonFieldsJSON {
208
- documentCode: string;
209
- namesAreTruncated: boolean;
210
- optional: string | null;
211
- optional1: string | null;
212
- optionalDataInLine1: string | null;
213
- optionalDataInLine2: string | null;
241
+ export interface MRZResultJSON {
242
+ address: string | null;
214
243
  capturedMrz: string;
215
- personalIdNumber: string | null;
216
- renewalTimes: number | null;
244
+ dateOfBirth: DateResultJSON | null;
245
+ dateOfExpiry: DateResultJSON | null;
246
+ dateOfIssue: DateResultJSON | null;
247
+ documentCode: string;
248
+ documentNumber: string | null;
249
+ firstName: string | null;
250
+ fullName: string;
217
251
  fullNameSimplifiedChinese: string | null;
252
+ issuingAuthorityCode: string | null;
253
+ lastName: string | null;
254
+ namesAreTruncated: boolean;
255
+ nationality: string | null;
218
256
  omittedCharacterCountInGbkName: number | null;
219
257
  omittedNameCount: number | null;
220
- issuingAuthorityCode: string | null;
258
+ optionalDataInLine1: string | null;
259
+ optionalDataInLine2: string | null;
260
+ passportDateOfExpiry: DateResultJSON | null;
221
261
  passportIssuerIso: string | null;
222
262
  passportNumber: string | null;
223
- passportDateOfExpiry: DateResultJSON | null;
263
+ personalIdNumber: string | null;
264
+ renewalTimes: number | null;
265
+ sex: string | null;
224
266
  }
225
- export interface VIZResultJSON extends CommonFieldsJSON {
267
+ export interface VIZResultJSON {
226
268
  additionalAddressInformation: string | null;
227
269
  additionalNameInformation: string | null;
270
+ address: string | null;
271
+ bloodType: string | null;
272
+ capturedSides: string;
273
+ dateOfBirth: DateResultJSON | null;
274
+ dateOfExpiry: DateResultJSON | null;
275
+ dateOfIssue: DateResultJSON | null;
228
276
  documentAdditionalNumber: string | null;
277
+ documentNumber: string | null;
278
+ documentSubtype: string | null;
279
+ documentType: string | null;
280
+ drivingLicenseDetails: DrivingLicenseDetailsJSON | null;
229
281
  employer: string | null;
282
+ fathersName: string | null;
283
+ firstName: string | null;
284
+ fullName: string;
285
+ isBackSideCaptureSupported: boolean;
230
286
  issuingAuthority: string | null;
287
+ issuingCountry: string | null;
288
+ issuingCountryIso: string | null;
231
289
  issuingJurisdiction: string | null;
232
290
  issuingJurisdictionIso: string | null;
291
+ lastName: string | null;
292
+ location: QuadrilateralJSON | null;
233
293
  maritalStatus: string | null;
294
+ mothersName: string | null;
295
+ mrzDetected: boolean;
296
+ nationality: string | null;
297
+ passportNumber: string | null;
234
298
  personalIdNumber: string | null;
235
299
  placeOfBirth: string | null;
236
300
  profession: string | null;
237
301
  race: string | null;
238
302
  religion: string | null;
239
303
  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;
304
+ sex: string | null;
305
+ sexOriginal: string | null;
246
306
  sponsor: string | null;
247
- visaNumber: string | null;
248
- passportNumber: string | null;
249
307
  usRealIdStatus: string | null;
250
308
  vehicleOwner: string | null;
309
+ visaNumber: string | null;
310
+ }
311
+ export interface MobileDocumentOCRResultJSON {
312
+ dateOfBirth: DateResultJSON | null;
313
+ dateOfExpiry: DateResultJSON | null;
314
+ documentNumber: string | null;
315
+ documentType: string | null;
316
+ firstName: string | null;
317
+ fullName: string;
318
+ issuingCountry: string | null;
319
+ issuingCountryIso: string | null;
320
+ issuingJurisdiction: string | null;
321
+ issuingJurisdictionIso: string | null;
322
+ lastName: string | null;
251
323
  }
252
324
  export interface IdCaptureErrorJSON {
253
325
  type: string;
@@ -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
23
  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
- */
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;
@@ -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,14 +5,6 @@ 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
10
  get capturedMrz(): string;
@@ -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
+ import type { Region } from "../Region.js";
5
+ import type { IdCaptureDocumentType } from "../document/IdCaptureDocument.js";
6
+ export declare class MobileDocumentOCRResult implements Serializable<MobileDocumentOCRResultJSON> {
7
+ protected json: MobileDocumentOCRResultJSON;
8
+ get dateOfBirth(): DateResult | null;
9
+ get dateOfExpiry(): DateResult | null;
10
+ get documentNumber(): string | null;
11
+ get documentType(): IdCaptureDocumentType;
12
+ get firstName(): string | null;
13
+ get fullName(): string;
14
+ get issuingCountry(): Region;
15
+ get issuingCountryIso(): string | null;
16
+ get issuingJurisdiction(): string | null;
17
+ get issuingJurisdictionIso(): string | null;
18
+ get lastName(): string | null;
19
+ private static fromJSON;
20
+ toJSONObject(): MobileDocumentOCRResultJSON;
21
+ }
@@ -7,7 +7,6 @@ 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
10
  get fullName(): string;
12
11
  get additionalAddressInformation(): string | null;
13
12
  get additionalNameInformation(): string | null;
@@ -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;