@trulioo/docv-capture-web 2.13.0 → 2.14.0

package/README.md

@@ -27,7 +27,7 @@ truliooCapture.initialize(shortCode).then((transactionId) => {
 ### Creating and rendering a camera component
 
 Using the same created instance of `TruliooCapture`, we can get a camera component to be rendered later by calling the `getCameraComponent` function.
-We can specify the camera detection type by providing a `ITruliooCameraConfig` with the desired `DetectionType`.
+We can specify the camera detection type by providing a `TruliooCameraConfig` with the desired `DetectionType`.
 
 ```javascript showLineNumbers
 
@@ -42,21 +42,21 @@ const selfieCamera = truliooCaptureSdkInstance.getCameraComponent({
 ```
 
 To render the camera component on the screen, we just need to call the `renderCamera` function. This will render a full screen camera on the screen by attaching
-a video element to the parent element based on the provided element id. We can also include a callback function that will be called by the SDK when the camera is successfully loaded.
+a video element to the parent element based on the provided element id. The `renderCamera` function will resolve when the camera is successfully loaded, otherwise it will reject with an error.
 The `onCaptureRegionChange` callback function is provided, which will return the current capture frame coordinates location (the location on the camera screen where the document/face should be located to do a capture).
 We can utilize this coordinate information to render custom UI overlay.
 
 ```javascript showLineNumbers
-documentCamera.renderCamera("parent-element-id", (cameraLoadSuccess) => {
-  if (cameraLoadSuccess) {
-    console.log("Camera loaded successfully!")
-  } else {
-    console.log("Failed to load camera.")
-  }
-}, {
-  onCaptureRegionChange: (captureRegion) => {
-    // Utilize the given captureRegion data to render custom UI.
-  }
+const cameraProps = new CameraProps(
+    (captureRegion: CaptureRegion) => {
+        // Utilize the given captureRegion data to render custom UI.
+    }
+)
+
+documentCamera.renderCamera("parent-element-id", cameraProps).then((_) => {
+    console.log("Camera is successfully loaded")
+}).catch((e: Error) => {
+    console.error(`Camera is not loaded successfully: ${e.message}`)
 })
 ```
 
@@ -76,7 +76,7 @@ To do an auto capture experience (a good document/selfie image criteria decided
 currently active/rendered camera component. The promise will only resolve when the SDK manage to capture a good image that is presented in front of the camera capture frame.
 
 ```javascript showLineNumbers
-truliooCapture.startFeedback(documentCamera.id).then((result: ITruliooCaptureResponse) => {
+truliooCapture.startFeedback(documentCamera.id).then((result: TruliooCaptureResponse) => {
     console.log(`Succesfully captured a good image: ${result}`)
 })
 ```
@@ -122,16 +122,17 @@ Note that the above flow is the same for the selfie capture type too.
 ### Analysing the captured image result through post capture verify feedback
 
 
-Once we have the resulting `ITruliooCaptureResponse` image data, we are able to get a post capture feedback by simply calling the `verifyImage` function that is
+Once we have the resulting `TruliooCaptureResponse` image data, we are able to get a post capture feedback by simply calling the `verifyImage` function that is
 part of the response data. This will give use more information regarding the captured image and let us decide whether we should submit the captured image for
 verification by calling the `acceptImage` function.
 
 
 
 ```javascript showLineNumbers
-// As an example, we will submit the captured image for document verification if the post capture feedback returns a CAN_BE_PROCESSED status.
-result.verifyImage().then((verifyFeedback: ITruliooVerifyResponse) => {
-    if (verifyFeedback.verificationStatus == VerificationStatus.CAN_BE_PROCESSED) {
+// As an example, we will submit the captured image for document verification if the post capture feedback documentVerifyResponse.documentTypeAccepted is not RESULT_CHECK_DECLINED.
+// Note that the documentVerifyResponse will have more than just documentTypeAccepted, the below code is just an example of just checking for documentTypeAccepted.
+result.verifyImage().then((verifyFeedback: TruliooVerifyFeedback) => {
+    if (verifyFeedback.documentVerifyResponse.documentTypeAccepted !== ResultCheck.RESULT_CHECK_DECLINED) {
         // Note that the acceptImage can be called outside of the verifyImage function.
         result.acceptImage().then((status: boolean) => {
             console.log("Successfully submitted the image")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trulioo/docv-capture-web",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "main": "trulioo-docv-capture-web.js",
   "types": "trulioo-docv-capture-web.d.ts",
   "devDependencies": {

package/trulioo-docv-capture-web.d.ts

@@ -40,48 +40,6 @@ export declare namespace com.trulioo.docv.core.workflow {
         equals(other: Nullable<any>): boolean;
     }
 }
-export declare class TruliooCamera /* extends capture.Camera */ {
-    constructor(cameraId: string, cameraDetectionType: DetectionType);
-    get id(): string;
-    get detectionType(): DetectionType;
-    removeCamera(): void;
-    renderCamera(parentElementId: string, onCameraLoaded?: (p0: boolean) => void, cameraProps?: Nullable<CameraProps>): void;
-}
-export declare class CameraProps {
-    constructor(backgroundColor: Nullable<string>, onCaptureRegionChange: Nullable<(p0: CaptureRegion) => void>);
-    get backgroundColor(): Nullable<string>;
-    get onCaptureRegionChange(): Nullable<(p0: CaptureRegion) => void>;
-    copy(backgroundColor?: Nullable<string>, onCaptureRegionChange?: Nullable<(p0: CaptureRegion) => void>): CameraProps;
-    toString(): string;
-    hashCode(): number;
-    equals(other: Nullable<any>): boolean;
-}
-export declare interface CaptureRegion {
-    readonly bottomRight: PointCoordinates;
-    readonly center: PointCoordinates;
-    readonly selfieRadius: number;
-    readonly topLeft: PointCoordinates;
-    readonly __doNotUseOrImplementIt: {
-        readonly CaptureRegion: unique symbol;
-    };
-}
-export declare interface PointCoordinates {
-    readonly x: number;
-    readonly y: number;
-    readonly __doNotUseOrImplementIt: {
-        readonly PointCoordinates: unique symbol;
-    };
-}
-export declare class TruliooCapture {
-    constructor();
-    initialize(shortCode: string, previewMode?: boolean): Promise<string>;
-    getCameraComponent(config?: Nullable<TruliooCameraConfig>): TruliooCamera;
-    startFeedback(cameraId: string, imageFeedback?: Nullable<(p0: TruliooImageFeedback) => void>): Promise<TruliooCaptureResponse>;
-    stopFeedback(cameraId: string): Promise<boolean>;
-    onFeedbackState(feedback: (p0: TruliooFeedbackState) => void): void;
-    captureLatestFrame(): Promise<TruliooCaptureResponse>;
-    submitTransaction(): Promise<boolean>;
-}
 export declare interface TruliooCameraConfig {
     readonly detectionType: DetectionType;
     readonly __doNotUseOrImplementIt: {
@@ -138,38 +96,11 @@ export declare interface TruliooCaptureResponse extends TruliooImageFeedback {
 }
 export declare interface TruliooVerifyFeedback {
     readonly isVerifyAttemptAvailable: boolean;
-    readonly verificationStatus: VerificationStatus;
+    readonly documentVerifyResponse: DocumentVerifyResponse;
     readonly __doNotUseOrImplementIt: {
         readonly TruliooVerifyFeedback: unique symbol;
     };
 }
-export declare abstract class VerificationStatus {
-    private constructor();
-    static get CAN_BE_PROCESSED(): VerificationStatus & {
-        get name(): "CAN_BE_PROCESSED";
-        get ordinal(): 0;
-    };
-    static get CANNOT_BE_CLASSIFIED(): VerificationStatus & {
-        get name(): "CANNOT_BE_CLASSIFIED";
-        get ordinal(): 1;
-    };
-    static get UNSUPPORTED_DOCUMENT(): VerificationStatus & {
-        get name(): "UNSUPPORTED_DOCUMENT";
-        get ordinal(): 2;
-    };
-    static get EXPIRED_DOCUMENT(): VerificationStatus & {
-        get name(): "EXPIRED_DOCUMENT";
-        get ordinal(): 3;
-    };
-    static get ERROR(): VerificationStatus & {
-        get name(): "ERROR";
-        get ordinal(): 4;
-    };
-    static values(): Array<VerificationStatus>;
-    static valueOf(value: string): VerificationStatus;
-    get name(): "CAN_BE_PROCESSED" | "CANNOT_BE_CLASSIFIED" | "UNSUPPORTED_DOCUMENT" | "EXPIRED_DOCUMENT" | "ERROR";
-    get ordinal(): 0 | 1 | 2 | 3 | 4;
-}
 export declare abstract class TruliooFeedbackState {
     private constructor();
     static get NONE(): TruliooFeedbackState & {
@@ -205,4 +136,119 @@ export declare abstract class TruliooFeedbackState {
     get name(): "NONE" | "CAPTURING" | "BLUR" | "SUCCESS" | "ERROR" | "TOO_CLOSE" | "TOO_FAR";
     get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6;
 }
+export declare abstract class ResultCheck {
+    private constructor();
+    static get RESULT_CHECK_UNSPECIFIED(): ResultCheck & {
+        get name(): "RESULT_CHECK_UNSPECIFIED";
+        get ordinal(): 0;
+    };
+    static get RESULT_CHECK_DECLINED(): ResultCheck & {
+        get name(): "RESULT_CHECK_DECLINED";
+        get ordinal(): 1;
+    };
+    static get RESULT_CHECK_ACCEPTED(): ResultCheck & {
+        get name(): "RESULT_CHECK_ACCEPTED";
+        get ordinal(): 2;
+    };
+    static values(): Array<ResultCheck>;
+    static valueOf(value: string): ResultCheck;
+    get name(): "RESULT_CHECK_UNSPECIFIED" | "RESULT_CHECK_DECLINED" | "RESULT_CHECK_ACCEPTED";
+    get ordinal(): 0 | 1 | 2;
+}
+export declare abstract class DocumentExpirationCheck {
+    private constructor();
+    static get DOCUMENT_EXPIRATION_CHECK_UNSPECIFIED(): DocumentExpirationCheck & {
+        get name(): "DOCUMENT_EXPIRATION_CHECK_UNSPECIFIED";
+        get ordinal(): 0;
+    };
+    static get DOCUMENT_EXPIRATION_CHECK_EXPIRED(): DocumentExpirationCheck & {
+        get name(): "DOCUMENT_EXPIRATION_CHECK_EXPIRED";
+        get ordinal(): 1;
+    };
+    static get DOCUMENT_EXPIRATION_CHECK_VALID(): DocumentExpirationCheck & {
+        get name(): "DOCUMENT_EXPIRATION_CHECK_VALID";
+        get ordinal(): 2;
+    };
+    static values(): Array<DocumentExpirationCheck>;
+    static valueOf(value: string): DocumentExpirationCheck;
+    get name(): "DOCUMENT_EXPIRATION_CHECK_UNSPECIFIED" | "DOCUMENT_EXPIRATION_CHECK_EXPIRED" | "DOCUMENT_EXPIRATION_CHECK_VALID";
+    get ordinal(): 0 | 1 | 2;
+}
+export declare abstract class BackImageRequirement {
+    private constructor();
+    static get BACK_IMAGE_REQUIREMENT_UNSPECIFIED(): BackImageRequirement & {
+        get name(): "BACK_IMAGE_REQUIREMENT_UNSPECIFIED";
+        get ordinal(): 0;
+    };
+    static get BACK_IMAGE_REQUIREMENT_NOT_REQUIRED(): BackImageRequirement & {
+        get name(): "BACK_IMAGE_REQUIREMENT_NOT_REQUIRED";
+        get ordinal(): 1;
+    };
+    static get BACK_IMAGE_REQUIREMENT_REQUIRED(): BackImageRequirement & {
+        get name(): "BACK_IMAGE_REQUIREMENT_REQUIRED";
+        get ordinal(): 2;
+    };
+    static values(): Array<BackImageRequirement>;
+    static valueOf(value: string): BackImageRequirement;
+    get name(): "BACK_IMAGE_REQUIREMENT_UNSPECIFIED" | "BACK_IMAGE_REQUIREMENT_NOT_REQUIRED" | "BACK_IMAGE_REQUIREMENT_REQUIRED";
+    get ordinal(): 0 | 1 | 2;
+}
+export declare class DocumentVerifyResponse {
+    constructor(documentDetected: ResultCheck, documentTypeAccepted: ResultCheck, documentCountryAccepted: ResultCheck, documentJurisdictionAccepted: ResultCheck, blur: ResultCheck, glare: ResultCheck, skewed: ResultCheck, bright: ResultCheck, documentExpirationCheck: DocumentExpirationCheck, backImageRequirement: BackImageRequirement);
+    get documentDetected(): ResultCheck;
+    get documentTypeAccepted(): ResultCheck;
+    get documentCountryAccepted(): ResultCheck;
+    get documentJurisdictionAccepted(): ResultCheck;
+    get blur(): ResultCheck;
+    get glare(): ResultCheck;
+    get skewed(): ResultCheck;
+    get bright(): ResultCheck;
+    get documentExpirationCheck(): DocumentExpirationCheck;
+    get backImageRequirement(): BackImageRequirement;
+    copy(documentDetected?: ResultCheck, documentTypeAccepted?: ResultCheck, documentCountryAccepted?: ResultCheck, documentJurisdictionAccepted?: ResultCheck, blur?: ResultCheck, glare?: ResultCheck, skewed?: ResultCheck, bright?: ResultCheck, documentExpirationCheck?: DocumentExpirationCheck, backImageRequirement?: BackImageRequirement): DocumentVerifyResponse;
+    toString(): string;
+    hashCode(): number;
+    equals(other: Nullable<any>): boolean;
+}
+export declare class TruliooCamera /* extends capture.Camera */ {
+    constructor(cameraId: string, cameraDetectionType: DetectionType);
+    get id(): string;
+    get detectionType(): DetectionType;
+    removeCamera(): void;
+    renderCamera(parentElementId: string, cameraProps?: Nullable<CameraProps>): Promise<boolean>;
+}
+export declare class CameraProps {
+    constructor(onCaptureRegionChange: Nullable<(p0: CaptureRegion) => void>);
+    get onCaptureRegionChange(): Nullable<(p0: CaptureRegion) => void>;
+    copy(onCaptureRegionChange?: Nullable<(p0: CaptureRegion) => void>): CameraProps;
+    toString(): string;
+    hashCode(): number;
+    equals(other: Nullable<any>): boolean;
+}
+export declare interface CaptureRegion {
+    readonly bottomRight: PointCoordinates;
+    readonly center: PointCoordinates;
+    readonly selfieRadius: number;
+    readonly topLeft: PointCoordinates;
+    readonly __doNotUseOrImplementIt: {
+        readonly CaptureRegion: unique symbol;
+    };
+}
+export declare interface PointCoordinates {
+    readonly x: number;
+    readonly y: number;
+    readonly __doNotUseOrImplementIt: {
+        readonly PointCoordinates: unique symbol;
+    };
+}
+export declare class TruliooCapture {
+    constructor();
+    initialize(shortCode: string, previewMode?: boolean): Promise<string>;
+    getCameraComponent(config?: Nullable<TruliooCameraConfig>): TruliooCamera;
+    startFeedback(cameraId: string, imageFeedback?: Nullable<(p0: TruliooImageFeedback) => void>): Promise<TruliooCaptureResponse>;
+    stopFeedback(cameraId: string): Promise<boolean>;
+    onFeedbackState(feedback: (p0: TruliooFeedbackState) => void): void;
+    captureLatestFrame(): Promise<TruliooCaptureResponse>;
+    submitTransaction(): Promise<boolean>;
+}
 export as namespace trulioo_docv_capture_web;