scandit-datacapture-frameworks-id 6.28.1 → 7.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.
- package/dist/dts/common/{SupportedSides.d.ts → CapturedSides.d.ts} +1 -1
- package/dist/dts/common/IdCaptureRegion.d.ts +254 -0
- package/dist/dts/common/IdImageType.d.ts +2 -2
- package/dist/dts/common/IdImages.d.ts +13 -0
- package/dist/dts/common/IdSide.d.ts +4 -0
- package/dist/dts/common/RegionSpecificSubtype.d.ts +66 -0
- package/dist/dts/common/RejectionReason.d.ts +5 -3
- package/dist/dts/common/index.d.ts +5 -12
- package/dist/dts/defaults/IdDefaults.d.ts +1 -1
- package/dist/dts/defaults/SerializedTypes.d.ts +40 -159
- package/dist/dts/id/BarcodeResult.d.ts +97 -0
- package/dist/dts/id/CapturedId.d.ts +19 -49
- package/dist/dts/id/CommonCapturedIdFields.d.ts +5 -3
- package/dist/dts/id/MRZResult.d.ts +10 -0
- package/dist/dts/id/VIZResult.d.ts +8 -2
- package/dist/dts/id/index.d.ts +1 -20
- package/dist/dts/idcapture/IdCaptureFeedback.d.ts +0 -3
- package/dist/dts/idcapture/IdCaptureListener.d.ts +4 -12
- package/dist/dts/idcapture/IdCaptureOverlay.d.ts +0 -3
- package/dist/dts/idcapture/IdCaptureSettings.d.ts +7 -3
- package/dist/dts/idcapture/controller/IdCaptureController.d.ts +0 -4
- package/dist/dts/idcapture/controller/IdCaptureListenerController.d.ts +0 -2
- package/dist/dts/idcapture/controller/IdCaptureListenerProxy.d.ts +1 -7
- package/dist/dts/idcapture/index.d.ts +0 -3
- package/dist/dts/iddocumenttype/DriverLicense.d.ts +16 -0
- package/dist/dts/iddocumenttype/HealthInsuranceCard.d.ts +16 -0
- package/dist/dts/iddocumenttype/IdCaptureDocument.d.ts +11 -0
- package/dist/dts/iddocumenttype/IdCaptureDocumentType.d.ts +9 -0
- package/dist/dts/iddocumenttype/IdCard.d.ts +16 -0
- package/dist/dts/iddocumenttype/Passport.d.ts +16 -0
- package/dist/dts/iddocumenttype/RegionSpecific.d.ts +19 -0
- package/dist/dts/iddocumenttype/ResidencePermit.d.ts +16 -0
- package/dist/dts/iddocumenttype/VisaIcao.d.ts +16 -0
- package/dist/dts/iddocumenttype/index.d.ts +9 -0
- package/dist/dts/index.d.ts +2 -0
- package/dist/dts/scanner/FullDocumentScanner.d.ts +10 -0
- package/dist/dts/scanner/IdCaptureScanner.d.ts +2 -0
- package/dist/dts/scanner/SingleSideScanner.d.ts +13 -0
- package/dist/dts/scanner/index.d.ts +3 -0
- package/dist/index.js +1134 -949
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/dist/dts/common/ComparisonCheck.d.ts +0 -7
- package/dist/dts/common/ComparisonCheckResult.d.ts +0 -5
- package/dist/dts/common/DateComparisonCheck.d.ts +0 -15
- package/dist/dts/common/IdDocumentType.d.ts +0 -22
- package/dist/dts/common/LocalizedOnlyId.d.ts +0 -10
- package/dist/dts/common/RejectedId.d.ts +0 -13
- package/dist/dts/common/StringComparisonCheck.d.ts +0 -14
- package/dist/dts/common/VizMrzComparisonCheck.d.ts +0 -7
- package/dist/dts/common/VizMrzComparisonCheckResult.d.ts +0 -5
- package/dist/dts/common/VizMrzDateComparisonCheck.d.ts +0 -15
- package/dist/dts/common/VizMrzStringComparisonCheck.d.ts +0 -14
- package/dist/dts/id/AAMVABarcodeResult.d.ts +0 -41
- package/dist/dts/id/AamvaVizBarcodeComparisonResult.d.ts +0 -20
- package/dist/dts/id/AamvaVizBarcodeComparisonVerifier.d.ts +0 -7
- package/dist/dts/id/ApecBusinessTravelCardMrzResult.d.ts +0 -14
- package/dist/dts/id/ArgentinaIdBarcodeResult.d.ts +0 -10
- package/dist/dts/id/CapturedResultType.d.ts +0 -18
- package/dist/dts/id/ChinaExitEntryPermitMRZResult.d.ts +0 -10
- package/dist/dts/id/ChinaMainlandTravelPermitMRZResult.d.ts +0 -16
- package/dist/dts/id/ChinaOneWayPermitBackMrzResult.d.ts +0 -11
- package/dist/dts/id/ChinaOneWayPermitFrontMrzResult.d.ts +0 -11
- package/dist/dts/id/ColombiaDlBarcodeResult.d.ts +0 -10
- package/dist/dts/id/ColombiaIdBarcodeResult.d.ts +0 -9
- package/dist/dts/id/CommonAccessCardBarcodeResult.d.ts +0 -20
- package/dist/dts/id/DocumentType.d.ts +0 -83
- package/dist/dts/id/SouthAfricaDlBarcodeResult.d.ts +0 -18
- package/dist/dts/id/SouthAfricaIdBarcodeResult.d.ts +0 -12
- package/dist/dts/id/USUniformedServicesBarcodeResult.d.ts +0 -46
- package/dist/dts/id/USVisaVIZResult.d.ts +0 -10
- package/dist/dts/id/VizMrzComparisonResult.d.ts +0 -17
- package/dist/dts/id/VizMrzComparisonVerifier.d.ts +0 -8
- package/dist/dts/idcapture/IdCaptureError.d.ts +0 -11
- package/dist/dts/idcapture/IdCaptureSession.d.ts +0 -23
- package/dist/dts/idcapture/IdLayout.d.ts +0 -10
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { RejectionReason } from "../common/RejectionReason";
|
|
1
|
+
import { IdCaptureRegion, RegionSpecificSubtype } from "../common";
|
|
2
|
+
import { IdCaptureDocumentType } from "../iddocumenttype";
|
|
4
3
|
export interface DateResultJSON {
|
|
5
4
|
day: number;
|
|
6
5
|
month: number;
|
|
@@ -27,21 +26,24 @@ export interface CommonCapturedIdFieldsJSON {
|
|
|
27
26
|
nationality: string | null;
|
|
28
27
|
address: string | null;
|
|
29
28
|
documentAdditionalNumber: string | null;
|
|
30
|
-
documentType:
|
|
29
|
+
documentType: IdCaptureDocumentType | null;
|
|
30
|
+
documentSubtype: RegionSpecificSubtype | null;
|
|
31
31
|
documentNumber: string | null;
|
|
32
|
-
issuingCountry:
|
|
32
|
+
issuingCountry: IdCaptureRegion;
|
|
33
33
|
issuingCountryIso: string | null;
|
|
34
34
|
dateOfExpiry: DateResultJSON | null;
|
|
35
35
|
dateOfIssue: DateResultJSON | null;
|
|
36
36
|
}
|
|
37
37
|
export interface ImageInfoJSON {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
38
|
+
front: ImageJSON | null;
|
|
39
|
+
back: ImageJSON | null;
|
|
40
|
+
}
|
|
41
|
+
export interface ImageJSON {
|
|
42
|
+
face: string | null;
|
|
43
|
+
frame: string | null;
|
|
44
|
+
croppedDocument: string | null;
|
|
41
45
|
}
|
|
42
46
|
export interface CapturedIdJSON {
|
|
43
|
-
capturedResultType: string;
|
|
44
|
-
capturedResultTypes: string[];
|
|
45
47
|
firstName: string | null;
|
|
46
48
|
lastName: string | null;
|
|
47
49
|
fullName: string;
|
|
@@ -52,7 +54,7 @@ export interface CapturedIdJSON {
|
|
|
52
54
|
isExpired: boolean | null;
|
|
53
55
|
nationality: string | null;
|
|
54
56
|
address: string | null;
|
|
55
|
-
documentType:
|
|
57
|
+
documentType: IdCaptureDocumentType | null;
|
|
56
58
|
issuingCountryIso: string | null;
|
|
57
59
|
issuingCountry: string | null;
|
|
58
60
|
documentAdditionalNumber: string | null;
|
|
@@ -60,24 +62,11 @@ export interface CapturedIdJSON {
|
|
|
60
62
|
dateOfExpiry: DateResultJSON | null;
|
|
61
63
|
dateOfIssue: DateResultJSON | null;
|
|
62
64
|
imageInfo: ImageInfoJSON | null;
|
|
63
|
-
|
|
64
|
-
argentinaIdBarcodeResult: ArgentinaIdBarcodeResultJSON | null;
|
|
65
|
-
colombiaIdBarcodeResult: ColombiaIdBarcodeResultJSON | null;
|
|
66
|
-
colombiaDlBarcodeResult: ColombiaDlBarcodeResultJSON | null;
|
|
67
|
-
commonAccessCardBarcodeResult: CommonAccessCardBarcodeResultJSON | null;
|
|
65
|
+
barcodeResult: BarcodeResultJSON | null;
|
|
68
66
|
mrzResult: MRZResultJSON | null;
|
|
69
|
-
southAfricaDlBarcodeResult: SouthAfricaDlBarcodeResultJSON | null;
|
|
70
|
-
southAfricaIdBarcodeResult: SouthAfricaIdBarcodeResultJSON | null;
|
|
71
|
-
usUniformedServicesBarcodeResult: USUniformedServicesBarcodeResultJSON | null;
|
|
72
|
-
usVisaVizResult: USVisaVizResultJSON | null;
|
|
73
67
|
vizResult: VIZResultJSON | null;
|
|
74
|
-
chinaMainlandTravelPermitMrzResult: ChinaMainlandTravelPermitMRZResultJSON | null;
|
|
75
|
-
chinaExitEntryPermitMrzResult: ChinaExitEntryPermitMRZResultJSON | null;
|
|
76
|
-
chinaOneWayPermitBackMrzResult: ChinaOneWayPermitBackMrzResultJSON | null;
|
|
77
|
-
chinaOneWayPermitFrontMrzResult: ChinaOneWayPermitFrontMrzResultJSON | null;
|
|
78
|
-
apecBusinessTravelCardMrzResult: ApecBusinessTravelCardMrzResultJSON | null;
|
|
79
68
|
}
|
|
80
|
-
export interface
|
|
69
|
+
export interface BarcodeResultJSON {
|
|
81
70
|
aamvaVersion: number;
|
|
82
71
|
isRealId: boolean;
|
|
83
72
|
aliasFamilyName: string | null;
|
|
@@ -110,23 +99,11 @@ export interface AAMVABarcodeResultJSON {
|
|
|
110
99
|
barcodeDataElements: {
|
|
111
100
|
[key: string]: string;
|
|
112
101
|
};
|
|
113
|
-
}
|
|
114
|
-
export interface AamvaBarcodeVerificationResultJSON {
|
|
115
|
-
allChecksPassed: boolean;
|
|
116
|
-
verificationStatus: "authentic" | "maybeForged" | "forged";
|
|
117
|
-
}
|
|
118
|
-
export interface ArgentinaIdBarcodeResultJSON {
|
|
119
102
|
documentCopy: string;
|
|
120
103
|
personalIdNumber: string;
|
|
121
|
-
}
|
|
122
|
-
export interface ColombiaIdBarcodeResultJSON {
|
|
123
104
|
bloodType: string;
|
|
124
|
-
}
|
|
125
|
-
export interface ColombiaDlBarcodeResultJSON {
|
|
126
105
|
categories: string[];
|
|
127
106
|
identificationType: string;
|
|
128
|
-
}
|
|
129
|
-
export interface CommonAccessCardBarcodeResultJSON {
|
|
130
107
|
version: string;
|
|
131
108
|
personDesignatorDocument: number;
|
|
132
109
|
personDesignatorTypeCode: string;
|
|
@@ -139,33 +116,14 @@ export interface CommonAccessCardBarcodeResultJSON {
|
|
|
139
116
|
payPlanGradeCode: string;
|
|
140
117
|
cardInstanceIdentifier: string;
|
|
141
118
|
personMiddleInitial: string;
|
|
142
|
-
}
|
|
143
|
-
export interface MRZResultJSON {
|
|
144
|
-
documentCode: string;
|
|
145
|
-
namesAreTruncated: boolean;
|
|
146
|
-
optional: string | null;
|
|
147
|
-
optional1: string | null;
|
|
148
|
-
capturedMrz: string;
|
|
149
|
-
}
|
|
150
|
-
export interface SouthAfricaDlBarcodeResultJSON {
|
|
151
|
-
version: number;
|
|
152
119
|
licenseCountryOfIssue: string;
|
|
153
|
-
personalIdNumber: string;
|
|
154
120
|
personalIdNumberType: string;
|
|
155
|
-
documentCopy: number;
|
|
156
121
|
driverRestrictionCodes: number[];
|
|
157
122
|
professionalDrivingPermit: ProfessionalDrivingPermitJSON | null;
|
|
158
123
|
vehicleRestrictions: VehicleRestrictionJSON[];
|
|
159
|
-
}
|
|
160
|
-
export interface SouthAfricaIdBarcodeResultJSON {
|
|
161
124
|
countryOfBirth: string;
|
|
162
125
|
countryOfBirthIso: string;
|
|
163
126
|
citizenshipStatus: string;
|
|
164
|
-
personalIdNumber: string;
|
|
165
|
-
}
|
|
166
|
-
export interface USUniformedServicesBarcodeResultJSON {
|
|
167
|
-
bloodType: string | null;
|
|
168
|
-
branchOfService: string;
|
|
169
127
|
champusEffectiveDate: DateResultJSON | null;
|
|
170
128
|
champusExpiryDate: DateResultJSON | null;
|
|
171
129
|
civilianHealthCareFlagCode: string;
|
|
@@ -178,18 +136,14 @@ export interface USUniformedServicesBarcodeResultJSON {
|
|
|
178
136
|
directCareFlagDescription: string;
|
|
179
137
|
exchangeFlagCode: string;
|
|
180
138
|
exchangeFlagDescription: string;
|
|
181
|
-
eyeColor: string;
|
|
182
139
|
familySequenceNumber: number;
|
|
183
140
|
formNumber: string;
|
|
184
141
|
genevaConventionCategory: string | null;
|
|
185
|
-
hairColor: string;
|
|
186
142
|
height: number;
|
|
187
143
|
jpegData: string;
|
|
188
144
|
mwrFlagCode: string;
|
|
189
145
|
mwrFlagDescription: string;
|
|
190
146
|
payGrade: string | null;
|
|
191
|
-
personDesignatorDocument: number;
|
|
192
|
-
rank: string;
|
|
193
147
|
relationshipCode: string | null;
|
|
194
148
|
relationshipDescription: string | null;
|
|
195
149
|
securityCode: string;
|
|
@@ -199,12 +153,27 @@ export interface USUniformedServicesBarcodeResultJSON {
|
|
|
199
153
|
sponsorName: string | null;
|
|
200
154
|
statusCode: string;
|
|
201
155
|
statusCodeDescription: string;
|
|
202
|
-
version: number;
|
|
203
156
|
weight: number;
|
|
204
157
|
}
|
|
205
|
-
export interface
|
|
206
|
-
|
|
207
|
-
|
|
158
|
+
export interface AamvaBarcodeVerificationResultJSON {
|
|
159
|
+
allChecksPassed: boolean;
|
|
160
|
+
verificationStatus: "authentic" | "maybeForged" | "forged";
|
|
161
|
+
}
|
|
162
|
+
export interface MRZResultJSON {
|
|
163
|
+
documentCode: string;
|
|
164
|
+
namesAreTruncated: boolean;
|
|
165
|
+
optional: string | null;
|
|
166
|
+
optional1: string | null;
|
|
167
|
+
capturedMrz: string;
|
|
168
|
+
personalIdNumber: string | null;
|
|
169
|
+
renewalTimes: number | null;
|
|
170
|
+
fullNameSimplifiedChinese: string | null;
|
|
171
|
+
omittedCharacterCountInGbkName: number | null;
|
|
172
|
+
omittedNameCount: number | null;
|
|
173
|
+
issuingAuthorityCode: string | null;
|
|
174
|
+
passportIssuerIso: string | null;
|
|
175
|
+
passportNumber: string | null;
|
|
176
|
+
passportDateOfExpiry: DateResultJSON | null;
|
|
208
177
|
}
|
|
209
178
|
export interface VIZResultJSON {
|
|
210
179
|
additionalAddressInformation: string | null;
|
|
@@ -227,98 +196,10 @@ export interface VIZResultJSON {
|
|
|
227
196
|
sponsor: string | null;
|
|
228
197
|
mothersName: string | null;
|
|
229
198
|
fathersName: string | null;
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
rejectionReason: RejectionReason;
|
|
237
|
-
}
|
|
238
|
-
export interface IdCaptureErrorJSON {
|
|
239
|
-
type: string;
|
|
240
|
-
message: string;
|
|
241
|
-
}
|
|
242
|
-
export interface IdCaptureSessionJSON {
|
|
243
|
-
newlyCapturedId: CapturedIdJSON | null;
|
|
244
|
-
localizedOnlyId: LocalizedIdJSON;
|
|
245
|
-
newlyRejectedId: RejectedIdJSON;
|
|
246
|
-
frameSequenceId: number;
|
|
247
|
-
error: IdCaptureErrorJSON;
|
|
248
|
-
}
|
|
249
|
-
export interface ComparisonCheckJSON {
|
|
250
|
-
checkResult: ComparisonCheckResult;
|
|
251
|
-
resultDescription: string;
|
|
252
|
-
}
|
|
253
|
-
export interface VizMrzComparisonCheckJSON {
|
|
254
|
-
checkResult: VizMrzComparisonCheckResult;
|
|
255
|
-
resultDescription: string;
|
|
256
|
-
}
|
|
257
|
-
export interface StringComparisonCheckJSON extends ComparisonCheckJSON {
|
|
258
|
-
vizValue: string | null;
|
|
259
|
-
aamvaBarcodeValue: string | null;
|
|
260
|
-
}
|
|
261
|
-
export interface VizMrzStringComparisonCheckJSON extends VizMrzComparisonCheckJSON {
|
|
262
|
-
vizValue: string;
|
|
263
|
-
mrzValue: string;
|
|
264
|
-
}
|
|
265
|
-
export interface DateComparisonCheckJSON extends ComparisonCheckJSON {
|
|
266
|
-
vizValue: DateResultJSON | null;
|
|
267
|
-
aamvaBarcodeValue: DateResultJSON | null;
|
|
268
|
-
}
|
|
269
|
-
export interface VizMrzDateComparisonCheckJSON extends VizMrzComparisonCheckJSON {
|
|
270
|
-
vizValue: DateResultJSON | null;
|
|
271
|
-
mrzValue: DateResultJSON | null;
|
|
272
|
-
}
|
|
273
|
-
export interface AamvaVizBarcodeComparisonResultJSON {
|
|
274
|
-
checksPassed: boolean;
|
|
275
|
-
resultDescription: string;
|
|
276
|
-
issuingCountryIsoMatch: StringComparisonCheckJSON;
|
|
277
|
-
issuingJurisdictionIsoMatch: StringComparisonCheckJSON;
|
|
278
|
-
documentNumbersMatch: StringComparisonCheckJSON;
|
|
279
|
-
fullNamesMatch: StringComparisonCheckJSON;
|
|
280
|
-
datesOfBirthMatch: DateComparisonCheckJSON;
|
|
281
|
-
datesOfExpiryMatch: DateComparisonCheckJSON;
|
|
282
|
-
datesOfIssueMatch: DateComparisonCheckJSON;
|
|
283
|
-
frontMismatchImage: string | null;
|
|
284
|
-
}
|
|
285
|
-
export interface ChinaMainlandTravelPermitMRZResultJSON {
|
|
286
|
-
documentCode: string;
|
|
287
|
-
capturedMrz: string;
|
|
288
|
-
personalIdNumber: string;
|
|
289
|
-
renewalTimes: number;
|
|
290
|
-
fullNameSimplifiedChinese: string;
|
|
291
|
-
omittedCharacterCountInGBKName: number;
|
|
292
|
-
omittedNameCount: number;
|
|
293
|
-
issuingAuthorityCode: string | null;
|
|
294
|
-
}
|
|
295
|
-
export interface ChinaExitEntryPermitMRZResultJSON {
|
|
296
|
-
documentCode: string;
|
|
297
|
-
capturedMrz: string;
|
|
298
|
-
}
|
|
299
|
-
export interface ChinaOneWayPermitBackMrzResultJSON {
|
|
300
|
-
documentCode: string;
|
|
301
|
-
capturedMrz: string;
|
|
302
|
-
namesAreTruncated: boolean;
|
|
303
|
-
}
|
|
304
|
-
export interface ChinaOneWayPermitFrontMrzResultJSON {
|
|
305
|
-
documentCode: string;
|
|
306
|
-
capturedMrz: string;
|
|
307
|
-
fullNameSimplifiedChinese: string;
|
|
308
|
-
}
|
|
309
|
-
export interface ApecBusinessTravelCardMrzResultJSON {
|
|
310
|
-
documentCode: string;
|
|
311
|
-
capturedMrz: string;
|
|
312
|
-
passportIssuerIso: string;
|
|
313
|
-
passportNumber: string;
|
|
314
|
-
passportDateOfExpiry: DateResultJSON | null;
|
|
315
|
-
}
|
|
316
|
-
export interface VizMrzComparisonResultJSON {
|
|
317
|
-
checksPassed: boolean;
|
|
318
|
-
resultDescription: string;
|
|
319
|
-
issuingCountryIsoMatch: VizMrzStringComparisonCheckJSON;
|
|
320
|
-
documentNumbersMatch: VizMrzStringComparisonCheckJSON;
|
|
321
|
-
fullNamesMatch: VizMrzStringComparisonCheckJSON;
|
|
322
|
-
datesOfBirthMatch: VizMrzDateComparisonCheckJSON;
|
|
323
|
-
datesOfExpiryMatch: VizMrzDateComparisonCheckJSON;
|
|
199
|
+
visaNumber: string | null;
|
|
200
|
+
passportNumber: string | null;
|
|
201
|
+
firstName: string | null;
|
|
202
|
+
lastName: string | null;
|
|
203
|
+
secondaryLastName: string | null;
|
|
204
|
+
fullName: string;
|
|
324
205
|
}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { DateResult } from "../common";
|
|
2
|
+
import { BarcodeResultJSON } from "../defaults";
|
|
3
|
+
import { ProfessionalDrivingPermit } from "./ProfessionalDrivingPermit";
|
|
4
|
+
import { VehicleRestriction } from "./VehicleRestriction";
|
|
5
|
+
export declare class BarcodeResult {
|
|
6
|
+
private json;
|
|
7
|
+
private constructor();
|
|
8
|
+
private static fromJSON;
|
|
9
|
+
get aamvaVersion(): number | null;
|
|
10
|
+
get aliasFamilyName(): string | null;
|
|
11
|
+
get aliasGivenName(): string | null;
|
|
12
|
+
get aliasSuffixName(): string | null;
|
|
13
|
+
get bloodType(): string | null;
|
|
14
|
+
get branchOfService(): string | null;
|
|
15
|
+
get cardInstanceIdentifier(): string | null;
|
|
16
|
+
get cardRevisionDate(): DateResult | null;
|
|
17
|
+
get categories(): string[];
|
|
18
|
+
get champusEffectiveDate(): DateResult | null;
|
|
19
|
+
get champusExpiryDate(): DateResult | null;
|
|
20
|
+
get citizenshipStatus(): string | null;
|
|
21
|
+
get civilianHealthCareFlagCode(): string | null;
|
|
22
|
+
get civilianHealthCareFlagDescription(): string | null;
|
|
23
|
+
get commissaryFlagCode(): string | null;
|
|
24
|
+
get commissaryFlagDescription(): string | null;
|
|
25
|
+
get countryOfBirth(): string | null;
|
|
26
|
+
get countryOfBirthIso(): string | null;
|
|
27
|
+
get deersDependentSuffixCode(): number | null;
|
|
28
|
+
get deersDependentSuffixDescription(): string | null;
|
|
29
|
+
get directCareFlagCode(): string | null;
|
|
30
|
+
get directCareFlagDescription(): string | null;
|
|
31
|
+
get documentCopy(): string | null;
|
|
32
|
+
get documentDiscriminatorNumber(): string | null;
|
|
33
|
+
get driverNamePrefix(): string | null;
|
|
34
|
+
get driverNameSuffix(): string | null;
|
|
35
|
+
get driverRestrictionCodes(): number[];
|
|
36
|
+
get ediPersonIdentifier(): string | null;
|
|
37
|
+
get endorsementsCode(): string | null;
|
|
38
|
+
get exchangeFlagCode(): string | null;
|
|
39
|
+
get exchangeFlagDescription(): string | null;
|
|
40
|
+
get eyeColor(): string | null;
|
|
41
|
+
get familySequenceNumber(): number | null;
|
|
42
|
+
get firstNameTruncation(): string | null;
|
|
43
|
+
get firstNameWithoutMiddleName(): string | null;
|
|
44
|
+
get formNumber(): string | null;
|
|
45
|
+
get genevaConventionCategory(): string | null;
|
|
46
|
+
get hairColor(): string | null;
|
|
47
|
+
get heightCm(): number | null;
|
|
48
|
+
get heightInch(): number | null;
|
|
49
|
+
get iin(): string | null;
|
|
50
|
+
get identificationType(): string | null;
|
|
51
|
+
get issuingJurisdiction(): string | null;
|
|
52
|
+
get issuingJurisdictionIso(): string | null;
|
|
53
|
+
get jpegData(): string | null;
|
|
54
|
+
get jurisdictionVersion(): number | null;
|
|
55
|
+
get lastNameTruncation(): string | null;
|
|
56
|
+
get licenseCountryOfIssue(): string | null;
|
|
57
|
+
get middleName(): string | null;
|
|
58
|
+
get middleNameTruncation(): string | null;
|
|
59
|
+
get mwrFlagCode(): string | null;
|
|
60
|
+
get mwrFlagDescription(): string | null;
|
|
61
|
+
get payGrade(): string | null;
|
|
62
|
+
get payPlanCode(): string | null;
|
|
63
|
+
get payPlanGradeCode(): string | null;
|
|
64
|
+
get personDesignatorDocument(): number | null;
|
|
65
|
+
get personDesignatorTypeCode(): string | null;
|
|
66
|
+
get personMiddleInitial(): string | null;
|
|
67
|
+
get personalIdNumber(): string | null;
|
|
68
|
+
get personalIdNumberType(): string | null;
|
|
69
|
+
get personnelCategoryCode(): string | null;
|
|
70
|
+
get personnelEntitlementConditionType(): string | null;
|
|
71
|
+
get placeOfBirth(): string | null;
|
|
72
|
+
get professionalDrivingPermit(): ProfessionalDrivingPermit | null;
|
|
73
|
+
get race(): string | null;
|
|
74
|
+
get rank(): string | null;
|
|
75
|
+
get relationshipCode(): string | null;
|
|
76
|
+
get relationshipDescription(): string | null;
|
|
77
|
+
get restrictionsCode(): string | null;
|
|
78
|
+
get securityCode(): string | null;
|
|
79
|
+
get serviceCode(): string | null;
|
|
80
|
+
get sponsorFlag(): string | null;
|
|
81
|
+
get sponsorName(): string | null;
|
|
82
|
+
get sponsorPersonDesignatorIdentifier(): number | null;
|
|
83
|
+
get statusCode(): string | null;
|
|
84
|
+
get statusCodeDescription(): string | null;
|
|
85
|
+
get vehicleClass(): string | null;
|
|
86
|
+
get vehicleRestrictions(): VehicleRestriction[];
|
|
87
|
+
get version(): string | null;
|
|
88
|
+
get weightKg(): number | null;
|
|
89
|
+
get weightLbs(): number | null;
|
|
90
|
+
get isRealId(): boolean | null;
|
|
91
|
+
get barcodeDataElements(): {
|
|
92
|
+
[key: string]: string;
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
export interface PrivateBarcodeResult {
|
|
96
|
+
fromJSON(json: BarcodeResultJSON): BarcodeResult;
|
|
97
|
+
}
|
|
@@ -1,23 +1,11 @@
|
|
|
1
1
|
import { CapturedIdJSON } from '../defaults/SerializedTypes';
|
|
2
|
-
import {
|
|
3
|
-
import { AAMVABarcodeResult } from './AAMVABarcodeResult';
|
|
4
|
-
import { ApecBusinessTravelCardMrzResult } from './ApecBusinessTravelCardMrzResult';
|
|
5
|
-
import { ArgentinaIdBarcodeResult } from './ArgentinaIdBarcodeResult';
|
|
6
|
-
import { CapturedResultType } from './CapturedResultType';
|
|
7
|
-
import { ChinaExitEntryPermitMRZResult } from './ChinaExitEntryPermitMRZResult';
|
|
8
|
-
import { ChinaMainlandTravelPermitMRZResult } from './ChinaMainlandTravelPermitMRZResult';
|
|
9
|
-
import { ChinaOneWayPermitBackMrzResult } from './ChinaOneWayPermitBackMrzResult';
|
|
10
|
-
import { ChinaOneWayPermitFrontMrzResult } from './ChinaOneWayPermitFrontMrzResult';
|
|
11
|
-
import { ColombiaDlBarcodeResult } from './ColombiaDlBarcodeResult';
|
|
12
|
-
import { ColombiaIdBarcodeResult } from './ColombiaIdBarcodeResult';
|
|
2
|
+
import { IdCaptureRegion, RegionSpecificSubtype } from '../common';
|
|
13
3
|
import { DateResult } from '../common/DateResult';
|
|
14
4
|
import { MRZResult } from './MRZResult';
|
|
15
|
-
import { SouthAfricaDlBarcodeResult } from './SouthAfricaDlBarcodeResult';
|
|
16
|
-
import { SouthAfricaIdBarcodeResult } from './SouthAfricaIdBarcodeResult';
|
|
17
|
-
import { USUniformedServicesBarcodeResult } from './USUniformedServicesBarcodeResult';
|
|
18
|
-
import { USVisaVIZResult } from './USVisaVIZResult';
|
|
19
5
|
import { VIZResult } from './VIZResult';
|
|
20
|
-
import {
|
|
6
|
+
import { BarcodeResult } from './BarcodeResult';
|
|
7
|
+
import { IdCaptureDocument } from '../iddocumenttype';
|
|
8
|
+
import { IdImages } from '../common/IdImages';
|
|
21
9
|
export declare class CapturedId {
|
|
22
10
|
private json;
|
|
23
11
|
private commonCapturedFields;
|
|
@@ -31,49 +19,31 @@ export declare class CapturedId {
|
|
|
31
19
|
get isExpired(): boolean | null;
|
|
32
20
|
get nationality(): string | null;
|
|
33
21
|
get address(): string | null;
|
|
34
|
-
|
|
35
|
-
get
|
|
36
|
-
get documentType(): DocumentType;
|
|
22
|
+
private _document;
|
|
23
|
+
get document(): IdCaptureDocument | null;
|
|
37
24
|
get issuingCountryIso(): string | null;
|
|
38
|
-
get issuingCountry():
|
|
25
|
+
get issuingCountry(): IdCaptureRegion;
|
|
39
26
|
get documentAdditionalNumber(): string | null;
|
|
40
27
|
get documentNumber(): string | null;
|
|
41
28
|
get dateOfExpiry(): DateResult | null;
|
|
42
29
|
get dateOfIssue(): DateResult | null;
|
|
43
|
-
private
|
|
44
|
-
get
|
|
45
|
-
private _argentinaIdBarcodeResult;
|
|
46
|
-
get argentinaIdBarcodeResult(): ArgentinaIdBarcodeResult | null;
|
|
47
|
-
private _colombiaIdBarcodeResult;
|
|
48
|
-
get colombiaIdBarcodeResult(): ColombiaIdBarcodeResult | null;
|
|
49
|
-
private _colombiaDlBarcodeResult;
|
|
50
|
-
get colombiaDlBarcodeResult(): ColombiaDlBarcodeResult | null;
|
|
30
|
+
private _barcodeResult;
|
|
31
|
+
get barcode(): BarcodeResult | null;
|
|
51
32
|
private _mrzResult;
|
|
52
33
|
get mrzResult(): MRZResult | null;
|
|
53
|
-
private _southAfricaIdBarcodeResult;
|
|
54
|
-
get southAfricaIdBarcodeResult(): SouthAfricaIdBarcodeResult | null;
|
|
55
|
-
private _southAfricaDlBarcodeResult;
|
|
56
|
-
get southAfricaDlBarcodeResult(): SouthAfricaDlBarcodeResult | null;
|
|
57
|
-
private _commonAccessBarcodeResult;
|
|
58
|
-
get commonAccessCardBarcodeResult(): CommonAccessCardBarcodeResult | null;
|
|
59
|
-
private _usUniformedServicesBarcodeResult;
|
|
60
|
-
get usUniformedServicesBarcodeResult(): USUniformedServicesBarcodeResult | null;
|
|
61
|
-
private _usVisaVizResult;
|
|
62
|
-
get usVisaViz(): USVisaVIZResult | null;
|
|
63
34
|
private _vizResult;
|
|
64
35
|
get vizResult(): VIZResult | null;
|
|
65
|
-
private
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
get apecBusinessTravelCardMrzResult(): ApecBusinessTravelCardMrzResult | null;
|
|
36
|
+
private _images;
|
|
37
|
+
isIdCard(): boolean;
|
|
38
|
+
isDriverLicense(): boolean;
|
|
39
|
+
isPassport(): boolean;
|
|
40
|
+
isVisaIcao(): boolean;
|
|
41
|
+
isRegionSpecific(subtype: RegionSpecificSubtype): boolean;
|
|
42
|
+
isResidencePermit(): boolean;
|
|
43
|
+
isHealthInsuranceCard(): boolean;
|
|
44
|
+
get images(): IdImages;
|
|
75
45
|
private static fromJSON;
|
|
76
|
-
|
|
46
|
+
private static getDocument;
|
|
77
47
|
}
|
|
78
48
|
export interface PrivateCapturedId {
|
|
79
49
|
fromJSON(json: CapturedIdJSON): CapturedId;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { DateResult } from "../common";
|
|
1
|
+
import { DateResult, IdCaptureRegion, RegionSpecificSubtype } from "../common";
|
|
2
2
|
import { CommonCapturedIdFieldsJSON } from "../defaults";
|
|
3
|
+
import { IdCaptureDocumentType } from "../iddocumenttype";
|
|
3
4
|
export declare class CommonCapturedIdFields {
|
|
4
5
|
private json;
|
|
5
6
|
get firstName(): string | null;
|
|
@@ -13,9 +14,10 @@ export declare class CommonCapturedIdFields {
|
|
|
13
14
|
get nationality(): string | null;
|
|
14
15
|
get address(): string | null;
|
|
15
16
|
get documentAdditionalNumber(): string | null;
|
|
16
|
-
get documentType():
|
|
17
|
+
get documentType(): IdCaptureDocumentType | null;
|
|
18
|
+
get documentSubtype(): RegionSpecificSubtype | null;
|
|
17
19
|
get documentNumber(): string | null;
|
|
18
|
-
get issuingCountry():
|
|
20
|
+
get issuingCountry(): IdCaptureRegion;
|
|
19
21
|
get issuingCountryIso(): string | null;
|
|
20
22
|
get dateOfExpiry(): DateResult | null;
|
|
21
23
|
get dateOfIssue(): DateResult | null;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { MRZResultJSON } from "../defaults";
|
|
2
|
+
import { DateResult } from "../common/DateResult";
|
|
2
3
|
export declare class MRZResult {
|
|
3
4
|
private json;
|
|
4
5
|
get documentCode(): string;
|
|
@@ -6,6 +7,15 @@ export declare class MRZResult {
|
|
|
6
7
|
get optional(): string | null;
|
|
7
8
|
get optional1(): string | null;
|
|
8
9
|
get capturedMrz(): string;
|
|
10
|
+
get personalIdNumber(): string | null;
|
|
11
|
+
get renewalTimes(): number | null;
|
|
12
|
+
get fullNameSimplifiedChinese(): string | null;
|
|
13
|
+
get omittedCharacterCountInGbkName(): number | null;
|
|
14
|
+
get omittedNameCount(): number | null;
|
|
15
|
+
get issuingAuthorityCode(): string | null;
|
|
16
|
+
get passportIssuerIso(): string | null;
|
|
17
|
+
get passportNumber(): string | null;
|
|
18
|
+
get passportDateOfExpiry(): DateResult | null;
|
|
9
19
|
private static fromJSON;
|
|
10
20
|
}
|
|
11
21
|
export interface PrivateMRZResult {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { VIZResultJSON } from "../defaults";
|
|
2
|
-
import {
|
|
2
|
+
import { CapturedSides } from "../common";
|
|
3
3
|
export declare class VIZResult {
|
|
4
4
|
private json;
|
|
5
5
|
get additionalAddressInformation(): string | null;
|
|
@@ -16,12 +16,18 @@ export declare class VIZResult {
|
|
|
16
16
|
get race(): string | null;
|
|
17
17
|
get religion(): string | null;
|
|
18
18
|
get residentialStatus(): string | null;
|
|
19
|
-
get capturedSides():
|
|
19
|
+
get capturedSides(): CapturedSides;
|
|
20
20
|
get isBackSideCaptureSupported(): boolean;
|
|
21
21
|
get bloodType(): string | null;
|
|
22
22
|
get sponsor(): string | null;
|
|
23
23
|
get mothersName(): string | null;
|
|
24
24
|
get fathersName(): string | null;
|
|
25
|
+
get passportNumber(): string | null;
|
|
26
|
+
get visaNumber(): string | null;
|
|
27
|
+
get firstName(): string | null;
|
|
28
|
+
get lastName(): string | null;
|
|
29
|
+
get secondaryLastName(): string | null;
|
|
30
|
+
get fullName(): string;
|
|
25
31
|
private static fromJSON;
|
|
26
32
|
}
|
|
27
33
|
export interface PrivateVIZResult {
|
package/dist/dts/id/index.d.ts
CHANGED
|
@@ -1,29 +1,10 @@
|
|
|
1
|
-
export * from './AAMVABarcodeResult';
|
|
2
1
|
export * from './AamvaBarcodeVerificationResult';
|
|
3
2
|
export * from './AamvaBarcodeVerifier';
|
|
4
|
-
export * from './AamvaVizBarcodeComparisonResult';
|
|
5
|
-
export * from './AamvaVizBarcodeComparisonVerifier';
|
|
6
|
-
export * from './ApecBusinessTravelCardMrzResult';
|
|
7
|
-
export * from './ArgentinaIdBarcodeResult';
|
|
8
3
|
export * from './CapturedId';
|
|
9
|
-
export * from './CapturedResultType';
|
|
10
|
-
export * from './ChinaExitEntryPermitMRZResult';
|
|
11
|
-
export * from './ChinaMainlandTravelPermitMRZResult';
|
|
12
|
-
export * from './ChinaOneWayPermitBackMrzResult';
|
|
13
|
-
export * from './ChinaOneWayPermitFrontMrzResult';
|
|
14
|
-
export * from './ColombiaDlBarcodeResult';
|
|
15
|
-
export * from './ColombiaIdBarcodeResult';
|
|
16
|
-
export * from './CommonAccessCardBarcodeResult';
|
|
17
4
|
export * from './CommonCapturedIdFields';
|
|
18
|
-
export * from './DocumentType';
|
|
19
5
|
export * from './MRZResult';
|
|
20
6
|
export * from './ProfessionalDrivingPermit';
|
|
21
|
-
export * from './SouthAfricaDlBarcodeResult';
|
|
22
|
-
export * from './SouthAfricaIdBarcodeResult';
|
|
23
|
-
export * from './USUniformedServicesBarcodeResult';
|
|
24
|
-
export * from './USVisaVIZResult';
|
|
25
7
|
export * from './VehicleRestriction';
|
|
26
|
-
export * from './VizMrzComparisonResult';
|
|
27
|
-
export * from './VizMrzComparisonVerifier';
|
|
28
8
|
export * from './VIZResult';
|
|
29
9
|
export * from './AamvaBarcodeVerificationStatus';
|
|
10
|
+
export * from './BarcodeResult';
|
|
@@ -9,9 +9,6 @@ export declare class IdCaptureFeedback extends DefaultSerializeable {
|
|
|
9
9
|
private _idRejected;
|
|
10
10
|
get idRejected(): Feedback;
|
|
11
11
|
set idRejected(idRejected: Feedback);
|
|
12
|
-
private _idCaptureTimeout;
|
|
13
|
-
get idCaptureTimeout(): Feedback;
|
|
14
|
-
set idCaptureTimeout(idCaptureTimeout: Feedback);
|
|
15
12
|
private static fromJSON;
|
|
16
13
|
private static get idDefaults();
|
|
17
14
|
private updateFeedback;
|
|
@@ -1,15 +1,7 @@
|
|
|
1
|
-
import { FrameData } from 'scandit-datacapture-frameworks-core';
|
|
2
1
|
import { IdCapture } from './IdCapture';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
2
|
+
import { RejectionReason } from '../common';
|
|
3
|
+
import { CapturedId } from '../id/CapturedId';
|
|
5
4
|
export interface IdCaptureListener {
|
|
6
|
-
didCaptureId?(idCapture: IdCapture,
|
|
7
|
-
|
|
8
|
-
didRejectId?(idCapture: IdCapture, session: IdCaptureSession, getFrameData: () => Promise<FrameData>): void;
|
|
9
|
-
/**
|
|
10
|
-
* @deprecated This method is no longer executed by the listener.
|
|
11
|
-
* See didRejectId and didTimeoutInSession for scenarios previously reported by this callback.
|
|
12
|
-
*/
|
|
13
|
-
didFailWithError?(idCapture: IdCapture, error: IdCaptureError, session: IdCaptureSession, getFrameData: () => Promise<FrameData>): void;
|
|
14
|
-
didTimeoutInSession?(idCapture: IdCapture, session: IdCaptureSession, getFrameData: () => Promise<FrameData>): void;
|
|
5
|
+
didCaptureId?(idCapture: IdCapture, capturedId: CapturedId): void;
|
|
6
|
+
didRejectId?(idCapture: IdCapture, rejectedId: CapturedId | null, reason: RejectionReason): void;
|
|
15
7
|
}
|
|
@@ -1,14 +1,12 @@
|
|
|
1
1
|
import { Brush, DataCaptureOverlay, DataCaptureView, DefaultSerializeable } from 'scandit-datacapture-frameworks-core';
|
|
2
2
|
import { IdCapture } from './IdCapture';
|
|
3
3
|
import { IdLayoutLineStyle } from './IdLayoutLineStyle';
|
|
4
|
-
import { IdLayout } from './IdLayout';
|
|
5
4
|
import { IdLayoutStyle } from './IdLayoutStyle';
|
|
6
5
|
import { TextHintPosition } from '../common/TextHintPosition';
|
|
7
6
|
export declare class IdCaptureOverlay extends DefaultSerializeable implements DataCaptureOverlay {
|
|
8
7
|
private type;
|
|
9
8
|
private idCapture;
|
|
10
9
|
private view;
|
|
11
|
-
private _idLayout;
|
|
12
10
|
private _idLayoutStyle;
|
|
13
11
|
private _idLayoutLineStyle;
|
|
14
12
|
private _textHintPosition;
|
|
@@ -25,7 +23,6 @@ export declare class IdCaptureOverlay extends DefaultSerializeable implements Da
|
|
|
25
23
|
static withIdCapture(idCapture: IdCapture): IdCaptureOverlay;
|
|
26
24
|
static withIdCaptureForView(idCapture: IdCapture, view: DataCaptureView | null): IdCaptureOverlay;
|
|
27
25
|
private constructor();
|
|
28
|
-
setIdLayout(idLayout: IdLayout): void;
|
|
29
26
|
setFrontSideTextHint(text: string): void;
|
|
30
27
|
setBackSideTextHint(text: string): void;
|
|
31
28
|
get idLayoutStyle(): IdLayoutStyle;
|
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
import { DefaultSerializeable } from 'scandit-datacapture-frameworks-core';
|
|
2
|
-
import {
|
|
2
|
+
import { IdAnonymizationMode, IdImageType } from '../common';
|
|
3
|
+
import { IdCaptureDocument } from '../iddocumenttype';
|
|
4
|
+
import { IdCaptureScanner } from '../scanner';
|
|
3
5
|
export declare class IdCaptureSettings extends DefaultSerializeable {
|
|
4
6
|
private properties;
|
|
5
7
|
private imageToResult;
|
|
6
|
-
supportedDocuments: IdDocumentType[];
|
|
7
|
-
supportedSides: SupportedSides;
|
|
8
8
|
anonymizationMode: IdAnonymizationMode;
|
|
9
9
|
rejectVoidedIds: boolean;
|
|
10
|
+
decodeBackOfEuropeanDrivingLicense: boolean;
|
|
11
|
+
acceptedDocuments: IdCaptureDocument[];
|
|
12
|
+
rejectedDocuments: IdCaptureDocument[];
|
|
13
|
+
scannerType: IdCaptureScanner;
|
|
10
14
|
constructor();
|
|
11
15
|
private static get idCaptureDefaults();
|
|
12
16
|
setProperty(name: string, value: any): void;
|