@trulioo/docv-capture-web 2.13.0 → 2.13.1

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,7 +122,7 @@ 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.
 
@@ -130,7 +130,7 @@ 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) => {
+result.verifyImage().then((verifyFeedback: TruliooVerifyResponse) => {
     if (verifyFeedback.verificationStatus == VerificationStatus.CAN_BE_PROCESSED) {
         // Note that the acceptImage can be called outside of the verifyImage function.
         result.acceptImage().then((status: boolean) => {

package/package.json

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

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

@@ -45,13 +45,12 @@ export declare class TruliooCamera /* extends capture.Camera */ {
     get id(): string;
     get detectionType(): DetectionType;
     removeCamera(): void;
-    renderCamera(parentElementId: string, onCameraLoaded?: (p0: boolean) => void, cameraProps?: Nullable<CameraProps>): void;
+    renderCamera(parentElementId: string, cameraProps?: Nullable<CameraProps>): Promise<boolean>;
 }
 export declare class CameraProps {
-    constructor(backgroundColor: Nullable<string>, onCaptureRegionChange: Nullable<(p0: CaptureRegion) => void>);
-    get backgroundColor(): Nullable<string>;
+    constructor(onCaptureRegionChange: Nullable<(p0: CaptureRegion) => void>);
     get onCaptureRegionChange(): Nullable<(p0: CaptureRegion) => void>;
-    copy(backgroundColor?: Nullable<string>, onCaptureRegionChange?: Nullable<(p0: CaptureRegion) => void>): CameraProps;
+    copy(onCaptureRegionChange?: Nullable<(p0: CaptureRegion) => void>): CameraProps;
     toString(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;