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

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 (32) hide show
  1. package/build/js/IdCapture.d.ts +2 -1
  2. package/build/js/IdCaptureSettings.d.ts +2 -0
  3. package/build/js/SerializedTypes.d.ts +30 -17
  4. package/build/js/captured-id/BarcodeResult.d.ts +1 -1
  5. package/build/js/captured-id/CapturedId.d.ts +1 -1
  6. package/build/js/captured-id/DataConsistencyResult.d.ts +2 -3
  7. package/build/js/captured-id/MRZResult.d.ts +2 -2
  8. package/build/js/captured-id/MobileDocumentOCRResult.d.ts +7 -7
  9. package/build/js/captured-id/VIZResult.d.ts +1 -1
  10. package/build/js/captured-id/VerificationResult.d.ts +1 -1
  11. package/build/js/index.js +5 -5
  12. package/build/js/worker/IdCaptureMode.d.ts +2 -2
  13. package/build/js/worker/dataCaptureWorkerRelated.d.ts +10 -0
  14. package/package.json +2 -2
  15. package/sdc-lib/scandit-datacapture-sdk-id-pthreads.js +1 -1
  16. package/sdc-lib/scandit-datacapture-sdk-id-pthreads.wasm +0 -0
  17. package/sdc-lib/scandit-datacapture-sdk-id-simd-pthreads.js +1 -1
  18. package/sdc-lib/scandit-datacapture-sdk-id-simd-pthreads.wasm +0 -0
  19. package/sdc-lib/scandit-datacapture-sdk-id-simd.js +1 -1
  20. package/sdc-lib/scandit-datacapture-sdk-id-simd.wasm +0 -0
  21. package/sdc-lib/scandit-datacapture-sdk-id.js +1 -1
  22. package/sdc-lib/scandit-datacapture-sdk-id.wasm +0 -0
  23. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/centaurus-worker.js +0 -0
  24. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/advanced/Centaurus.data +0 -0
  25. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/advanced/Centaurus.js +0 -0
  26. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/advanced/Centaurus.wasm +0 -0
  27. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/advanced-threads/Centaurus.data +0 -0
  28. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/advanced-threads/Centaurus.js +0 -0
  29. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/advanced-threads/Centaurus.wasm +0 -0
  30. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/basic/Centaurus.data +0 -0
  31. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/basic/Centaurus.js +0 -0
  32. /package/sdc-lib/idcapture/{8.0.0-beta.1 → 8.0.0}/resources/lightweight/basic/Centaurus.wasm +0 -0
@@ -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;
@@ -46,6 +46,8 @@ export declare class IdCaptureSettings implements Serializable<IdCaptureSettings
46
46
  setShouldPassImageTypeToResult(type: IdImageType, shouldPass: boolean): void;
47
47
  getShouldPassImageTypeToResult(type: IdImageType): boolean;
48
48
  addAnonymizedField(document: IdCaptureDocument, fieldType: IdFieldType): void;
49
+ removeAnonymizedField(document: IdCaptureDocument, fieldType: IdFieldType): void;
50
+ clearAnonymizedFields(): void;
49
51
  clone(): IdCaptureSettings;
50
52
  toJSONObject(): IdCaptureSettingsJSON;
51
53
  private static fromJSON;
@@ -73,7 +73,7 @@ export interface ImageInfoJSON {
73
73
  export type CapturedIdJSON = Prettify<{
74
74
  firstName: CapturedIdDataField<string | null>;
75
75
  lastName: CapturedIdDataField<string | null>;
76
- fullName: CapturedIdDataField<string>;
76
+ fullName: CapturedIdDataField<string | null>;
77
77
  sex: CapturedIdDataField<string | null>;
78
78
  nationality: CapturedIdDataField<string | null>;
79
79
  address: CapturedIdDataField<string | null>;
@@ -107,19 +107,28 @@ interface FrameInfo {
107
107
  mirrorAxis: number;
108
108
  orientation: number;
109
109
  }
110
- export type CapturedIdBeforeAnonymizationJSON = {
111
- [key in keyof CapturedIdJSON]: CapturedIdJSON[key] extends CapturedIdDataField<infer A> ? A : CapturedIdJSON[key];
112
- };
113
110
  export interface RawImageInfo {
114
111
  front: {
115
112
  face: string | null;
116
- croppedDocument: string | null;
117
- frame: FrameInfo;
113
+ croppedDocument: {
114
+ image: string | null;
115
+ obscuredRegions: QuadrilateralJSON[];
116
+ };
117
+ frame: {
118
+ image: FrameInfo;
119
+ obscuredRegions: QuadrilateralJSON[];
120
+ };
118
121
  };
119
122
  back: {
120
123
  face: null;
121
- croppedDocument: string | null;
122
- frame: FrameInfo;
124
+ croppedDocument: {
125
+ image: string | null;
126
+ obscuredRegions: QuadrilateralJSON[];
127
+ };
128
+ frame: {
129
+ image: FrameInfo;
130
+ obscuredRegions: QuadrilateralJSON[];
131
+ };
123
132
  };
124
133
  }
125
134
  export type CapturedIdWithRawImageInfoJSON = CapturedIdJSON & {
@@ -130,6 +139,7 @@ type VizResultFieldsCalculatedBySDC = "age" | "isExpired";
130
139
  export type VIZResultExtendedJSON = Prettify<Omit<VIZResultJSON, VizResultFieldsCalculatedBySDC> & {
131
140
  location: QuadrilateralJSON | null;
132
141
  frontFieldLocations: Partial<Record<string, QuadrilateralJSON>>;
142
+ backFieldLocations: Partial<Record<string, QuadrilateralJSON>>;
133
143
  }>;
134
144
  export type CapturedIdFromCentaurusJSON = Prettify<Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable" | "usRealIdStatus" | "isCapturingComplete" | "isCitizenPassport" | "anonymizedFields"> & {
135
145
  vizResult: VIZResultExtendedJSON;
@@ -182,7 +192,7 @@ export interface BarcodeResultJSON {
182
192
  firstNameTruncation: string | null;
183
193
  firstNameWithoutMiddleName: string | null;
184
194
  formNumber: string | null;
185
- fullName: string;
195
+ fullName: string | null;
186
196
  genevaConventionCategory: string | null;
187
197
  hairColor: string | null;
188
198
  heightCm: number | null;
@@ -240,14 +250,14 @@ export interface BarcodeResultJSON {
240
250
  }
241
251
  export interface MRZResultJSON {
242
252
  address: string | null;
243
- capturedMrz: string;
253
+ capturedMrz: string | null;
244
254
  dateOfBirth: DateResultJSON | null;
245
255
  dateOfExpiry: DateResultJSON | null;
246
256
  dateOfIssue: DateResultJSON | null;
247
257
  documentCode: string;
248
258
  documentNumber: string | null;
249
259
  firstName: string | null;
250
- fullName: string;
260
+ fullName: string | null;
251
261
  fullNameSimplifiedChinese: string | null;
252
262
  issuingAuthorityCode: string | null;
253
263
  lastName: string | null;
@@ -281,7 +291,7 @@ export interface VIZResultJSON {
281
291
  employer: string | null;
282
292
  fathersName: string | null;
283
293
  firstName: string | null;
284
- fullName: string;
294
+ fullName: string | null;
285
295
  isBackSideCaptureSupported: boolean;
286
296
  issuingAuthority: string | null;
287
297
  issuingCountry: string | null;
@@ -311,15 +321,17 @@ export interface VIZResultJSON {
311
321
  export interface MobileDocumentOCRResultJSON {
312
322
  dateOfBirth: DateResultJSON | null;
313
323
  dateOfExpiry: DateResultJSON | null;
324
+ dateOfIssue: DateResultJSON | null;
314
325
  documentNumber: string | null;
315
- documentType: string | null;
326
+ documentAdditionalNumber: string | null;
316
327
  firstName: string | null;
317
- fullName: string;
318
- issuingCountry: string | null;
319
- issuingCountryIso: string | null;
328
+ fullName: string | null;
329
+ lastName: string | null;
330
+ sex: string | null;
331
+ nationality: string | null;
332
+ address: string | null;
320
333
  issuingJurisdiction: string | null;
321
334
  issuingJurisdictionIso: string | null;
322
- lastName: string | null;
323
335
  }
324
336
  export interface IdCaptureErrorJSON {
325
337
  type: string;
@@ -377,5 +389,6 @@ export interface CentaurusSettingsJSON {
377
389
  };
378
390
  scanUnsupportedBack: boolean;
379
391
  skipImagesOccludedByHand: boolean;
392
+ combineResultsFromMultipleInputImages: boolean;
380
393
  }
381
394
  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;
@@ -20,7 +20,7 @@ export declare class CapturedId implements Serializable<CapturedIdJSON> {
20
20
  private _mobileDocumentOCRResult;
21
21
  get firstName(): string | null;
22
22
  get lastName(): string | null;
23
- get fullName(): string;
23
+ get fullName(): string | null;
24
24
  get sexType(): Sex;
25
25
  get sex(): string | null;
26
26
  get dateOfBirth(): DateResult | null;
@@ -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
  }
@@ -7,7 +7,7 @@ export declare class MRZResult implements Serializable<MRZResultJSON> {
7
7
  get namesAreTruncated(): boolean;
8
8
  get optionalDataInLine1(): string | null;
9
9
  get optionalDataInLine2(): string | null;
10
- get capturedMrz(): string;
10
+ get capturedMrz(): string | null;
11
11
  get personalIdNumber(): string | null;
12
12
  get renewalTimes(): number | null;
13
13
  get fullNameSimplifiedChinese(): string | null;
@@ -19,7 +19,7 @@ export declare class MRZResult implements Serializable<MRZResultJSON> {
19
19
  get passportDateOfExpiry(): DateResult | null;
20
20
  get firstName(): string | null;
21
21
  get lastName(): string | null;
22
- get fullName(): string;
22
+ get fullName(): string | null;
23
23
  get sex(): string | null;
24
24
  get dateOfBirth(): DateResult | null;
25
25
  get nationality(): string | null;
@@ -1,21 +1,21 @@
1
1
  import type { Serializable } from "@scandit/web-datacapture-core/build/js/private/Serializable";
2
2
  import { DateResult } from "./DateResult";
3
3
  import type { MobileDocumentOCRResultJSON } from "../SerializedTypes";
4
- import type { Region } from "../Region.js";
5
- import type { IdCaptureDocumentType } from "../document/IdCaptureDocument.js";
6
4
  export declare class MobileDocumentOCRResult implements Serializable<MobileDocumentOCRResultJSON> {
7
5
  protected json: MobileDocumentOCRResultJSON;
8
6
  get dateOfBirth(): DateResult | null;
9
7
  get dateOfExpiry(): DateResult | null;
10
8
  get documentNumber(): string | null;
11
- get documentType(): IdCaptureDocumentType;
12
9
  get firstName(): string | null;
13
- get fullName(): string;
14
- get issuingCountry(): Region;
15
- get issuingCountryIso(): 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;
16
17
  get issuingJurisdiction(): string | null;
17
18
  get issuingJurisdictionIso(): string | null;
18
- get lastName(): string | null;
19
19
  private static fromJSON;
20
20
  toJSONObject(): MobileDocumentOCRResultJSON;
21
21
  }
@@ -7,7 +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 fullName(): string;
10
+ get fullName(): string | null;
11
11
  get additionalAddressInformation(): string | null;
12
12
  get additionalNameInformation(): string | null;
13
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;