@scandit/web-datacapture-id 7.0.2 → 7.1.0-beta.2

package/build/js/DataConsistencyCheck.d.ts

@@ -0,0 +1,9 @@
+export declare enum DataConsistencyCheck {
+    IssuingCountryComparison = "issuingCountryComparison",
+    IssuingJurisdictionComparison = "issuingJurisdictionComparison",
+    FullNameComparison = "fullNameComparison",
+    DocumentNumberComparison = "documentNumberComparison",
+    DateOfBirthComparison = "dateOfBirthComparison",
+    DateOfExpiryComparison = "dateOfExpiryComparison",
+    DateOfIssueComparison = "dateOfIssueComparison"
+}

package/build/js/DataConsistencyVerifier.d.ts

@@ -0,0 +1,9 @@
+import type { DataCaptureContext } from "@scandit/web-datacapture-core";
+import type { CapturedId } from "./captured-id/CapturedId";
+import { DataConsistencyResult } from "./captured-id/DataConsistencyResult";
+export declare class DataConsistencyVerifier {
+    private _context;
+    private constructor();
+    static create(context: DataCaptureContext): DataConsistencyVerifier;
+    verify(capturedId: CapturedId): Promise<DataConsistencyResult | null>;
+}

package/build/js/Duration.d.ts

@@ -0,0 +1,11 @@
+import type { DurationJSON } from "./SerializedTypes";
+export declare class Duration {
+    private _days;
+    private _months;
+    private _years;
+    constructor(days: number, months: number, years: number);
+    get days(): number;
+    get months(): number;
+    get years(): number;
+    toJSONObject(): DurationJSON;
+}

package/build/js/Enums.d.ts

@@ -29,3 +29,13 @@ export declare enum IdLayoutLineStyle {
     Light = "light",
     Bold = "bold"
 }
+export declare enum UsRealIdStatus {
+    NotAvailable = "notAvailable",
+    NotRealIdCompliant = "notRealIdCompliant",
+    RealIdCompliant = "realIdCompliant"
+}
+export declare enum Sex {
+    Female = "female",
+    Male = "male",
+    Unspecified = "unspecified"
+}

package/build/js/IdCaptureSettings.d.ts

@@ -3,6 +3,8 @@ import type { Serializable } from "@scandit/web-datacapture-core/build/js/privat
 import { IdAnonymizationMode, IdCaptureTrigger, IdImageType } from "./Enums";
 import type { IdCaptureDocument, IdCaptureDocumentJSON } from "./document/IdCaptureDocument";
 import type { ScannerJSON, IdCaptureScanner } from "./scanner/Scanner";
+import { Duration } from "./Duration";
+import type { DurationJSON } from "./SerializedTypes";
 export interface IdCaptureSettingsJSON {
     acceptedDocuments: IdCaptureDocumentJSON[];
     rejectedDocuments: IdCaptureDocumentJSON[];
@@ -12,6 +14,11 @@ export interface IdCaptureSettingsJSON {
     captureTrigger: IdCaptureTrigger;
     rejectVoidedIds: boolean;
     decodeBackOfEuropeanDrivingLicense: boolean;
+    rejectExpiredIds: boolean;
+    rejectNotRealIdCompliant: boolean;
+    rejectInconsistentData: boolean;
+    rejectHolderBelowAge: number | null;
+    rejectIdsExpiringIn: DurationJSON | null;
     properties: JSONType;
 }
 export declare class IdCaptureSettings implements Serializable<IdCaptureSettingsJSON> {
@@ -22,6 +29,11 @@ export declare class IdCaptureSettings implements Serializable<IdCaptureSettings
     captureTrigger: IdCaptureTrigger;
     rejectVoidedIds: boolean;
     decodeBackOfEuropeanDrivingLicense: boolean;
+    rejectExpiredIds: boolean;
+    rejectNotRealIdCompliant: boolean;
+    rejectInconsistentData: boolean;
+    rejectHolderBelowAge: number | null;
+    rejectIdsExpiringIn: Duration | null;
     private properties;
     private imageToResult;
     constructor();

package/build/js/RejectionReason.d.ts

@@ -3,5 +3,11 @@ export declare enum RejectionReason {
     InvalidFormat = "invalidFormat",
     DocumentVoided = "documentVoided",
     Timeout = "timeout",
-    SingleImageNotRecognized = "singleImageNotRecognized"
+    SingleImageNotRecognized = "singleImageNotRecognized",
+    DocumentExpired = "documentExpired",
+    DocumentExpiresSoon = "documentExpiresSoon",
+    NotRealIdCompliant = "notRealIdCompliant",
+    HolderUnderage = "holderUnderage",
+    ForgedAamvaBarcode = "forgedAamvaBarcode",
+    InconsistentData = "inconsistentData"
 }

package/build/js/SerializedTypes.d.ts

@@ -1,4 +1,5 @@
 import type { QuadrilateralJSON } from "@scandit/web-datacapture-core";
+import type { DataConsistencyCheck } from "./DataConsistencyCheck";
 export interface DateResultJSON {
     day: number | null;
     month: number | null;
@@ -76,7 +77,9 @@ export interface CapturedIdJSON {
     idVerificationDataComparisonAvailable: boolean;
     barcodeResult: BarcodeResultJSON | null;
     mrzResult: MRZResultJSON | null;
+    verificationResult: VerificationResultJSON | null;
     vizResult: VIZResultJSON | null;
+    usRealIdStatus: string | null;
 }
 interface RawImageInfo {
     data: Uint8ClampedArray | null;
@@ -105,7 +108,7 @@ interface FieldLocations {
     frontFieldLocations: Partial<Record<string, QuadrilateralJSON>>;
 }
 export type VIZResultExtendedWithFieldLocationsJSON = FieldLocations & VIZResultExtendedJSON;
-export type CapturedIdWithExtendedVIZJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable"> & {
+export type CapturedIdWithExtendedVIZJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON | "idVerificationDataComparisonAvailable" | "usRealIdStatus"> & {
     vizResult: VIZResultExtendedJSON;
 };
 export type CapturedIdWithExtendedVIZAndLocationsJSON = Omit<CapturedIdJSON, keyof CapturedIdCommonFieldsJSON> & {
@@ -238,6 +241,7 @@ export interface VIZResultJSON extends CommonFieldsJSON {
     sponsor: string | null;
     visaNumber: string | null;
     passportNumber: string | null;
+    usRealIdStatus: string | null;
 }
 export interface IdCaptureErrorJSON {
     type: string;
@@ -265,4 +269,18 @@ export interface BarcodeMetadataJSON {
     moduleCountX: number;
     moduleCountY: number;
 }
+export interface DataConsistencyResultJSON {
+    allChecksPassed: boolean;
+    failedChecks: DataConsistencyCheck[];
+    skippedChecks: DataConsistencyCheck[];
+    passedChecks: DataConsistencyCheck[];
+}
+export interface VerificationResultJSON {
+    dataConsistencyResult: DataConsistencyResultJSON | null;
+}
+export interface DurationJSON {
+    days: number;
+    months: number;
+    years: number;
+}
 export {};

package/build/js/captured-id/CapturedId.d.ts

@@ -7,16 +7,20 @@ import { DateResult } from "./DateResult";
 import { IdImages } from "./IdImages";
 import { MRZResult } from "./MRZResult";
 import { VIZResult } from "./VIZResult";
+import { VerificationResult } from "./VerificationResult";
+import { type Sex, UsRealIdStatus } from "../Enums";
 import type { Region } from "../Region";
 export declare class CapturedId implements Serializable<CapturedIdJSON> {
     private json;
     private _barcodeResult;
     private _mrzResult;
     private _vizResult;
+    private _verificationResult;
     get firstName(): string | null;
     get lastName(): string | null;
     get secondaryLastName(): string | null;
     get fullName(): string;
+    get sexType(): Sex;
     get sex(): string | null;
     get dateOfBirth(): DateResult | null;
     get age(): number | null;
@@ -30,9 +34,11 @@ export declare class CapturedId implements Serializable<CapturedIdJSON> {
     get dateOfExpiry(): DateResult | null;
     get isExpired(): boolean | null;
     get dateOfIssue(): DateResult | null;
+    get usRealIdStatus(): UsRealIdStatus;
     get barcode(): BarcodeResult | null;
     get mrzResult(): MRZResult | null;
     get vizResult(): VIZResult | null;
+    get verificationResult(): VerificationResult;
     get images(): IdImages;
     private get barcodeResultsJSON();
     private get mrzResultsJSON();

package/build/js/captured-id/DataConsistencyResult.d.ts

@@ -0,0 +1,17 @@
+import type { Serializable } from "@scandit/web-datacapture-core/build/js/private/Serializable";
+import { DataConsistencyCheck } from "../DataConsistencyCheck";
+import type { DataConsistencyResultJSON } from "../SerializedTypes";
+export declare class DataConsistencyResult implements Serializable<DataConsistencyResultJSON> {
+    private json;
+    get allChecksPassed(): boolean;
+    get failedChecks(): DataConsistencyCheck[];
+    get skippedChecks(): DataConsistencyCheck[];
+    get passedChecks(): DataConsistencyCheck[];
+    private static fromJSON;
+    frontReviewImage(): Promise<string>;
+    toJSONObject(): DataConsistencyResultJSON;
+    private pushQuadForKey;
+    private pushQuadsForKeys;
+    private getMismatchedQuads;
+    private highlightImage;
+}

package/build/js/captured-id/VerificationResult.d.ts

@@ -0,0 +1,9 @@
+import type { Serializable } from "@scandit/web-datacapture-core/build/js/private/Serializable";
+import { DataConsistencyResult } from "./DataConsistencyResult";
+import type { VerificationResultJSON } from "../SerializedTypes";
+export declare class VerificationResult implements Serializable<VerificationResultJSON> {
+    protected json: VerificationResultJSON;
+    get dataConsistency(): DataConsistencyResult | null;
+    private static fromJSON;
+    toJSONObject(): VerificationResultJSON;
+}

package/build/js/index.d.ts

@@ -12,7 +12,9 @@ export * from "./IdCaptureSettings";
 export * from "./Region";
 export * from "./AamvaBarcodeVerifier";
 export * from "./AamvaBarcodeVerifierResult";
+export * from "./DataConsistencyVerifier";
 export * from "./RejectionReason";
+export * from "./Duration";
 export * from "./document/IdCaptureDocument";
 export * from "./document/DriverLicense";
 export * from "./document/HealthInsuranceCard";
@@ -27,6 +29,7 @@ export * from "./scanner/FullDocumentScanner";
 export * from "./scanner/SingleSideScanner";
 export * from "./captured-id/BarcodeResult";
 export * from "./captured-id/CapturedId";
+export * from "./captured-id/DataConsistencyResult";
 export * from "./captured-id/DateResult";
 export * from "./captured-id/DrivingLicenseCategory";
 export * from "./captured-id/DrivingLicenseDetails";