CAPI-233: optimise demo gif

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.5.1] - 11-06-2024
+
+-   (chore): load demo gif asynchronously before init is called
+-   (chore): reduce demo gif size
+-   (fix): race condition when environment loads its own opencv
+
 ## [1.5.0] - 05-06-2024
 
 -   (feat): pre-process image for quality check using opencv before resolving `init` promise

package.json

@@ -1,7 +1,7 @@
 {
 	"author": "Anyline",
 	"name": "@anyline/anyline-guidance-sdk",
-	"version": "1.5.0",
+	"version": "1.5.1",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
 	"types": "dist/esm/index.d.ts",

src/camera/init.ts

@@ -8,6 +8,14 @@ import { type Config } from '../modules/ConfigManager';
 import OpenCVManager from '../modules/OpenCVManager';
 import DocumentScrollController from '../modules/DocumentScrollController';
 
+// load demoInstructionsImage chunk before it is requested
+// to ensure lower loading time for the gif when sdk is initialised
+void import(
+	'../screens/onboardingInstructions/instructionsBody/demoInstructionsImage'
+).catch(() => {
+	console.log('Error loading demo gif');
+});
+
 export interface ImageMetadata {
 	width: number;
 	height: number;

src/modules/ImageChecker.ts

@@ -24,14 +24,17 @@ export default class ImageChecker {
 
 	public async isImageQualityGood(): Promise<boolean> {
 		if (this.blob === null) throw new Error('No image to process');
-		const { isBlurDetected, isContrastLow, isEdgeDetected } =
-			await preProcessImage(this.blob);
-
-		return (
-			!(isBlurDetected ?? false) &&
-			(isEdgeDetected ?? false) &&
-			!(isContrastLow ?? false)
-		);
+		try {
+			const { isBlurDetected, isContrastLow, isEdgeDetected } =
+				await preProcessImage(this.blob);
+			return (
+				!(isBlurDetected ?? false) &&
+				(isEdgeDetected ?? false) &&
+				!(isContrastLow ?? false)
+			);
+		} catch (err) {
+			return true;
+		}
 	}
 
 	public destroy(): void {

src/modules/OpenCVManager.ts

@@ -22,10 +22,7 @@ export default class OpenCVManager {
 	}
 
 	public loadOpenCV(): void {
-		if (
-			Boolean((window as any).cv?.getBuildInformation()) &&
-			this.opencvLoadedResolve !== null
-		) {
+		if (Boolean((window as any)?.cv) && this.opencvLoadedResolve !== null) {
 			this.opencvLoadedResolve();
 			return;
 		}