@trulioo/docv-capture-web 2.14.1 → 2.14.3

package/README.md

@@ -17,7 +17,7 @@ const shortCode = "generatedFromTruliooAPI"
 const truliooCapture = new TruliooCapture()
 
 truliooCapture.initialize(shortCode).then((transactionId) => {
-    console.log(`Success initialize with transaction ID: ${transactionId}`)
+    console.log(`Successfully initialized with transaction ID: ${transactionId}`)
 }).catch(error => {
     console.log(`Error on initialize: ${error}`)
 })
@@ -36,7 +36,7 @@ const documentCamera = truliooCapture.getCameraComponent()
 
 
 // To get a selfie detection type camera.
-const selfieCamera = truliooCaptureSdkInstance.getCameraComponent({
+const selfieCamera = truliooCapture.getCameraComponent({
   detectionType: DetectionType.BIOMETRIC_SELFIE,
 })
 ```
@@ -44,7 +44,7 @@ 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. 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.
+We can utilize this coordinate information to render a custom UI overlay.
 
 ```javascript showLineNumbers
 const cameraProps = new CameraProps(
@@ -75,15 +75,15 @@ documentCamera.resumeCamera()
 ### Starting the document capture flow
 
 
-Once the camera component is loaded and ready. We can start the document capture experience by calling `startFeedback` from previously created `TruliooCapture` instance.
+Once the camera component is loaded and ready, we can start the document capture experience by calling `startFeedback` from previously created `TruliooCapture` instance.
 
 
 To do an auto capture experience (a good document/selfie image criteria decided entirely by SDK), we can simply call `startFeedback` by just providing the camera id that refers to the
-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.
+currently active/rendered camera component. The promise will only resolve when the SDK manages to capture a good image that is presented in front of the camera capture frame.
 
 ```javascript showLineNumbers
 truliooCapture.startFeedback(documentCamera.id).then((result: TruliooCaptureResponse) => {
-    console.log(`Succesfully captured a good image with imageId: ${result.imageId}`)
+    console.log(`Successfully captured a good image with imageId: ${result.imageId}`)
 })
 ```
 
@@ -100,10 +100,10 @@ It is recommended to check this specific error to make sure it is not treated as
 import { HandledError } from '@trulioo/docv-capture-web'
 
 truliooCapture.startFeedback(documentCamera.id).then((result: TruliooCaptureResponse) => {
-    console.log(`Succesfully captured a good image with imageId: ${result.imageId}`)
+    console.log(`Successfully captured a good image with imageId: ${result.imageId}`)
 }).catch((error: unknown) => {
     if (error == HandledError.FeedbackStopped) {
-        console.log("startFeedback is stopped.")
+        console.log("startFeedback was stopped.")
     } else {
         // Other error handling
     }
@@ -115,7 +115,7 @@ Note that we would want to make sure the camera feed is currently running before
 
 ```javascript showLineNumbers
 truliooCapture.captureLatestFrame(documentCamera.id).then((result: TruliooManualCaptureResponse) => {
-    console.log(`Succesfully captured an image with manual capture with imageId: ${result.imageId}`)
+    console.log(`Successfully captured an image manually with imageId: ${result.imageId}`)
 })
 
 ```
@@ -138,7 +138,7 @@ truliooCapture.onFeedbackState(
                 // The detected document is blurry. Show a blur UI feedback to user.
                 break
             case FeedbackState.SUCCESS:
-                // Manage to captured a document.
+                // Managed to capture a document.
                 break
             default:
                 break
@@ -154,7 +154,7 @@ Note that the above flow is the same for the selfie capture type too.
 
 
 Once we have the resulting `TruliooCaptureResponse` or `TruliooManualCaptureResponse` 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
+part of the response data. This will give us more information regarding the captured image and let us decide whether we should submit the captured image for
 verification by calling the `acceptImage` function.
 
 
@@ -166,10 +166,10 @@ 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")
+            console.log("Successfully submitted the image.")
         })
     } else {
-        // Do something else. Ex. notify the user about the not accepted image and retake a new image.
+        // Do something else, e.g., notify the user about the not accepted image and retake a new image.
     }
 })
 ```
@@ -177,11 +177,11 @@ result.verifyImage().then((verifyFeedback: TruliooVerifyFeedback) => {
 
 ### Finalize the document verification transaction
 
-Once we submitted all the necessary image for the transaction, we can finalize the transaction by calling the `submitTransaction` function.
+Once we submitted all the necessary images for the transaction, we can finalize the transaction by calling the `submitTransaction` function.
 
 
 ```javascript showLineNumbers
-truliooCapture.submitTransaction().then((status: Boolean) => {
-    console.log("Transaction Successfully submitted.")
+truliooCapture.submitTransaction().then((status: boolean) => {
+    console.log("Transaction successfully submitted.")
 })
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trulioo/docv-capture-web",
-  "version": "2.14.1",
+  "version": "2.14.3",
   "main": "trulioo-docv-capture-web.js",
   "types": "trulioo-docv-capture-web.d.ts",
   "devDependencies": {
@@ -15,10 +15,10 @@
     "@connectrpc/connect": "1.4.0",
     "@connectrpc/connect-web": "1.4.0",
     "@bufbuild/protobuf": "1.10.0",
-    "format-util": "^1.0.5",
     "node-fetch": "2.6.7",
     "abort-controller": "3.0.0",
     "ws": "8.5.0",
+    "format-util": "^1.0.5",
     "@js-joda/core": "3.2.0"
   },
   "dependencies": {},