askui 0.12.1 → 0.12.2

package/dist/cjs/utils/base_64_image/base-64-image.d.ts

@@ -1,18 +1,15 @@
-/// <reference types="node" />
+import type sharp from 'sharp';
 export declare class Base64Image {
-    private readonly aSharp;
-    private info;
     private buffer;
     static readonly strPrefix = "data:image/png;base64,";
+    private _sharp?;
     private constructor();
-    private static fromSharp;
     static fromPathOrString(pathOrStr: string): Promise<Base64Image>;
-    static fromPath(path: string): Promise<Base64Image>;
+    static fromPath(filePath: string): Promise<Base64Image>;
     static fromString(str: string): Promise<Base64Image>;
-    static fromBuffer(buffer: Buffer): Promise<Base64Image>;
-    get width(): number;
-    get height(): number;
+    private static fromBuffer;
+    private getSharp;
+    getInfo(): Promise<sharp.OutputInfo>;
     resizeToFitInto(dimension: number): Promise<Base64Image>;
     toString(): string;
-    toBuffer(): Buffer;
 }

package/dist/cjs/utils/base_64_image/base-64-image.js

@@ -13,36 +13,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Base64Image = void 0;
-const sharp_1 = __importDefault(require("sharp"));
+const fs_1 = __importDefault(require("fs"));
+const sharp_1 = require("./sharp");
 const base_64_image_string_error_1 = require("./base-64-image-string-error");
 class Base64Image {
-    constructor(aSharp, info, buffer) {
-        this.aSharp = aSharp;
-        this.info = info;
+    constructor(buffer) {
         this.buffer = buffer;
     }
-    static fromSharp(s) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { info, data } = yield s.toBuffer({ resolveWithObject: true });
-            return new Base64Image(s, info, data);
-        });
-    }
     static fromPathOrString(pathOrStr) {
         return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield Base64Image.fromString(pathOrStr);
-            }
-            catch (error) {
-                if (!(error instanceof base_64_image_string_error_1.Base64ImageStringError)) {
-                    throw error;
-                }
+            if (pathOrStr.startsWith(Base64Image.strPrefix)) {
+                return Base64Image.fromString(pathOrStr);
             }
             return Base64Image.fromPath(pathOrStr);
         });
     }
-    static fromPath(path) {
+    static fromPath(filePath) {
         return __awaiter(this, void 0, void 0, function* () {
-            return Base64Image.fromSharp((0, sharp_1.default)(path));
+            const data = yield fs_1.default.promises.readFile(filePath, 'base64');
+            return Base64Image.fromString(`${Base64Image.strPrefix}${data}`);
         });
     }
     static fromString(str) {
@@ -51,36 +40,46 @@ class Base64Image {
                 throw new base_64_image_string_error_1.Base64ImageStringError(str, Base64Image.strPrefix);
             }
             const data = str.substring(Base64Image.strPrefix.length);
-            return Base64Image.fromSharp((0, sharp_1.default)(Buffer.from(data, 'base64')));
+            return new Base64Image(Buffer.from(data, 'base64'));
         });
     }
     static fromBuffer(buffer) {
         return __awaiter(this, void 0, void 0, function* () {
-            return Base64Image.fromSharp((0, sharp_1.default)(buffer));
+            return new Base64Image(buffer);
         });
     }
-    get width() {
-        return this.info.width;
+    getSharp() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._sharp === undefined) {
+                const createSharp = yield (0, sharp_1.getSharpFactory)();
+                this._sharp = createSharp(this.buffer);
+            }
+            return this._sharp;
+        });
     }
-    get height() {
-        return this.info.height;
+    getInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.getSharp())
+                .toBuffer({ resolveWithObject: true })
+                .then(({ info }) => info);
+        });
     }
     resizeToFitInto(dimension) {
         return __awaiter(this, void 0, void 0, function* () {
-            const buffer = yield this.aSharp.resize({
-                width: this.width >= this.height ? dimension : undefined,
-                height: this.height > this.width ? dimension : undefined,
-                fit: sharp_1.default.fit.contain,
-            }).toBuffer();
+            const { width, height } = yield this.getInfo();
+            const buffer = yield (yield this.getSharp())
+                .resize({
+                width: width >= height ? dimension : undefined,
+                height: height > width ? dimension : undefined,
+                fit: 'contain',
+            })
+                .toBuffer();
             return Base64Image.fromBuffer(buffer);
         });
     }
     toString() {
         return `${Base64Image.strPrefix}${this.buffer.toString('base64')}`;
     }
-    toBuffer() {
-        return this.buffer;
-    }
 }
 exports.Base64Image = Base64Image;
 Base64Image.strPrefix = 'data:image/png;base64,';

package/dist/cjs/utils/base_64_image/sharp.d.ts

@@ -0,0 +1,2 @@
+import type sharp from 'sharp';
+export declare function getSharpFactory(): Promise<typeof sharp>;

package/dist/cjs/utils/base_64_image/sharp.js

@@ -0,0 +1,56 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSharpFactory = void 0;
+let lazilyInitializedSharpFactory;
+class SharpImportError extends Error {
+}
+function dynamicallyImportSharp() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const sharp = yield Promise.resolve().then(() => __importStar(require('sharp')));
+            return sharp.default;
+        }
+        catch (err) {
+            throw new SharpImportError('Can\'t find "sharp" module to do resizing of image!'
+                + ' Please, install sharp for resizing support with'
+                + ' "npm install --save-dev sharp" or "npm install --save sharp".');
+        }
+    });
+}
+function getSharpFactory() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (lazilyInitializedSharpFactory === undefined) {
+            lazilyInitializedSharpFactory = yield dynamicallyImportSharp();
+        }
+        return lazilyInitializedSharpFactory;
+    });
+}
+exports.getSharpFactory = getSharpFactory;

package/dist/cjs/utils/proxy/proxy-builder.js

@@ -40,7 +40,9 @@ function dynmicImportHpagent() {
             return yield Promise.resolve().then(() => __importStar(require('hpagent')));
         }
         catch (err) {
-            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy! Please, install hpagent for proxy support with "npm install --save-dev hpagent".');
+            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy!'
+                + ' Please, install hpagent for proxy support with'
+                + ' "npm install --save-dev hpagent" or "npm install --save hpagent".');
         }
     });
 }

package/dist/cjs/utils/transformations.js

@@ -28,13 +28,15 @@ function resizeBase64ImageWithSameRatio(base64ImageString, maxEdge = 1400) {
         lib_1.logger.debug('Image resizing');
         try {
             const image = yield base_64_image_1.Base64Image.fromString(base64ImageString);
-            if (image.height <= maxEdge && image.width <= maxEdge) {
+            const imageInfo = yield image.getInfo();
+            if (imageInfo.height <= maxEdge && imageInfo.width <= maxEdge) {
                 return { base64Image: base64ImageString, resizeRatio: 1 };
             }
             const resizedImage = yield image.resizeToFitInto(maxEdge);
+            const resizedImageInfo = yield resizedImage.getInfo();
             return {
                 base64Image: resizedImage.toString(),
-                resizeRatio: image.width / resizedImage.width,
+                resizeRatio: imageInfo.width / resizedImageInfo.width,
             };
         }
         catch (error) {

package/dist/esm/utils/base_64_image/base-64-image.d.ts

@@ -1,18 +1,15 @@
-/// <reference types="node" />
+import type sharp from 'sharp';
 export declare class Base64Image {
-    private readonly aSharp;
-    private info;
     private buffer;
     static readonly strPrefix = "data:image/png;base64,";
+    private _sharp?;
     private constructor();
-    private static fromSharp;
     static fromPathOrString(pathOrStr: string): Promise<Base64Image>;
-    static fromPath(path: string): Promise<Base64Image>;
+    static fromPath(filePath: string): Promise<Base64Image>;
     static fromString(str: string): Promise<Base64Image>;
-    static fromBuffer(buffer: Buffer): Promise<Base64Image>;
-    get width(): number;
-    get height(): number;
+    private static fromBuffer;
+    private getSharp;
+    getInfo(): Promise<sharp.OutputInfo>;
     resizeToFitInto(dimension: number): Promise<Base64Image>;
     toString(): string;
-    toBuffer(): Buffer;
 }

package/dist/esm/utils/base_64_image/base-64-image.js

@@ -7,36 +7,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import sharp from 'sharp';
+import fs from 'fs';
+import { getSharpFactory } from './sharp';
 import { Base64ImageStringError } from './base-64-image-string-error';
 export class Base64Image {
-    constructor(aSharp, info, buffer) {
-        this.aSharp = aSharp;
-        this.info = info;
+    constructor(buffer) {
         this.buffer = buffer;
     }
-    static fromSharp(s) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { info, data } = yield s.toBuffer({ resolveWithObject: true });
-            return new Base64Image(s, info, data);
-        });
-    }
     static fromPathOrString(pathOrStr) {
         return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield Base64Image.fromString(pathOrStr);
-            }
-            catch (error) {
-                if (!(error instanceof Base64ImageStringError)) {
-                    throw error;
-                }
+            if (pathOrStr.startsWith(Base64Image.strPrefix)) {
+                return Base64Image.fromString(pathOrStr);
             }
             return Base64Image.fromPath(pathOrStr);
         });
     }
-    static fromPath(path) {
+    static fromPath(filePath) {
         return __awaiter(this, void 0, void 0, function* () {
-            return Base64Image.fromSharp(sharp(path));
+            const data = yield fs.promises.readFile(filePath, 'base64');
+            return Base64Image.fromString(`${Base64Image.strPrefix}${data}`);
         });
     }
     static fromString(str) {
@@ -45,35 +34,45 @@ export class Base64Image {
                 throw new Base64ImageStringError(str, Base64Image.strPrefix);
             }
             const data = str.substring(Base64Image.strPrefix.length);
-            return Base64Image.fromSharp(sharp(Buffer.from(data, 'base64')));
+            return new Base64Image(Buffer.from(data, 'base64'));
         });
     }
     static fromBuffer(buffer) {
         return __awaiter(this, void 0, void 0, function* () {
-            return Base64Image.fromSharp(sharp(buffer));
+            return new Base64Image(buffer);
         });
     }
-    get width() {
-        return this.info.width;
+    getSharp() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._sharp === undefined) {
+                const createSharp = yield getSharpFactory();
+                this._sharp = createSharp(this.buffer);
+            }
+            return this._sharp;
+        });
     }
-    get height() {
-        return this.info.height;
+    getInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.getSharp())
+                .toBuffer({ resolveWithObject: true })
+                .then(({ info }) => info);
+        });
     }
     resizeToFitInto(dimension) {
         return __awaiter(this, void 0, void 0, function* () {
-            const buffer = yield this.aSharp.resize({
-                width: this.width >= this.height ? dimension : undefined,
-                height: this.height > this.width ? dimension : undefined,
-                fit: sharp.fit.contain,
-            }).toBuffer();
+            const { width, height } = yield this.getInfo();
+            const buffer = yield (yield this.getSharp())
+                .resize({
+                width: width >= height ? dimension : undefined,
+                height: height > width ? dimension : undefined,
+                fit: 'contain',
+            })
+                .toBuffer();
             return Base64Image.fromBuffer(buffer);
         });
     }
     toString() {
         return `${Base64Image.strPrefix}${this.buffer.toString('base64')}`;
     }
-    toBuffer() {
-        return this.buffer;
-    }
 }
 Base64Image.strPrefix = 'data:image/png;base64,';

package/dist/esm/utils/base_64_image/sharp.d.ts

@@ -0,0 +1,2 @@
+import type sharp from 'sharp';
+export declare function getSharpFactory(): Promise<typeof sharp>;

package/dist/esm/utils/base_64_image/sharp.js

@@ -0,0 +1,33 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+let lazilyInitializedSharpFactory;
+class SharpImportError extends Error {
+}
+function dynamicallyImportSharp() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const sharp = yield import('sharp');
+            return sharp.default;
+        }
+        catch (err) {
+            throw new SharpImportError('Can\'t find "sharp" module to do resizing of image!'
+                + ' Please, install sharp for resizing support with'
+                + ' "npm install --save-dev sharp" or "npm install --save sharp".');
+        }
+    });
+}
+export function getSharpFactory() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (lazilyInitializedSharpFactory === undefined) {
+            lazilyInitializedSharpFactory = yield dynamicallyImportSharp();
+        }
+        return lazilyInitializedSharpFactory;
+    });
+}

package/dist/esm/utils/proxy/proxy-builder.js

@@ -17,7 +17,9 @@ function dynmicImportHpagent() {
             return yield import('hpagent');
         }
         catch (err) {
-            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy! Please, install hpagent for proxy support with "npm install --save-dev hpagent".');
+            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy!'
+                + ' Please, install hpagent for proxy support with'
+                + ' "npm install --save-dev hpagent" or "npm install --save hpagent".');
         }
     });
 }

package/dist/esm/utils/transformations.js

@@ -25,13 +25,15 @@ export function resizeBase64ImageWithSameRatio(base64ImageString, maxEdge = 1400
         logger.debug('Image resizing');
         try {
             const image = yield Base64Image.fromString(base64ImageString);
-            if (image.height <= maxEdge && image.width <= maxEdge) {
+            const imageInfo = yield image.getInfo();
+            if (imageInfo.height <= maxEdge && imageInfo.width <= maxEdge) {
                 return { base64Image: base64ImageString, resizeRatio: 1 };
             }
             const resizedImage = yield image.resizeToFitInto(maxEdge);
+            const resizedImageInfo = yield resizedImage.getInfo();
             return {
                 base64Image: resizedImage.toString(),
-                resizeRatio: image.width / resizedImage.width,
+                resizeRatio: imageInfo.width / resizedImageInfo.width,
             };
         }
         catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.12.1",
+    "version": "0.12.2",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",
@@ -58,7 +58,6 @@
         "node-machine-id": "1.1.12",
         "pino": "7.8.1",
         "pino-pretty": "7.5.3",
-        "sharp": "0.30.6",
         "tough-cookie": "4.1.2",
         "url-join": "4.0.1",
         "wait-port": "0.2.9",
@@ -79,12 +78,14 @@
         "jest-extended": "^4.0.1",
         "proxy": "^1.0.2",
         "proxy-agent": "^5.0.0",
-        "sharp": "0.30.6",
         "shx": "0.3.4",
         "ts-jest": "28.0.4",
         "typescript": "4.5.4"
     },
     "lint-staged": {
         "./**/*.{js,ts}": "eslint --cache --fix --max-warnings 0"
+    },
+    "optionalDependencies": {
+        "sharp": "^0.32.6"
     }
 }