@wdio/ocr-service 2.2.5 → 2.2.7

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @wdio/ocr-service
 
+## 2.2.7
+
+### Patch Changes
+
+- 75d31d1: fix: [657](#657) in multiremote, commands are now executed on the requested instances (ocrGetText no longer loop)
+
+  ## Committers: 1
+
+    -   P-Courteille ([@P-Courteille](https://github.com/P-Courteille))
+
+## 2.2.6
+
+### Patch Changes
+
+- 42956e4: 🔧 Other
+
+  - 🆙 Updated dependencies
+
+  ***
+
+  ## Committers: 1
+
+  - Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+
 ## 2.2.5
 
 ### Patch Changes
@@ -8,7 +32,7 @@
 
 ### Committers: 1
 
--   Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+- Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
 
 ## 2.2.4
 

package/dist/service.d.ts

@@ -5,6 +5,7 @@ export default class WdioOcrService {
     private _ocrDir;
     private _ocrLanguage;
     private _ocrContrast;
+    private _isTesseractAvailable;
     constructor(options: OcrOptions);
     /**
      * Set up the service if users want to use it in standalone mode

package/dist/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAgB5C,MAAM,CAAC,OAAO,OAAO,cAAc;;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAsD;IACvE,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,YAAY,CAAQ;gBAEhB,OAAO,EAAE,UAAU;IAM/B;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;IAIzE,MAAM,CACR,YAAY,EAAE,WAAW,CAAC,YAAY,EACtC,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;CA0EpE"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAgB5C,MAAM,CAAC,OAAO,OAAO,cAAc;;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAsD;IACvE,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,qBAAqB,CAAS;gBAE1B,OAAO,EAAE,UAAU;IAQ/B;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;IAIzE,MAAM,CACR,YAAY,EAAE,WAAW,CAAC,YAAY,EACtC,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;CA4EpE"}

package/dist/service.js

@@ -20,10 +20,13 @@ export default class WdioOcrService {
     _ocrDir;
     _ocrLanguage;
     _ocrContrast;
+    _isTesseractAvailable;
     constructor(options) {
         this._ocrDir = createOcrDir(options?.imagesFolder || DEFAULT_IMAGES_FOLDER);
         this._ocrLanguage = options?.language || SUPPORTED_LANGUAGES.ENGLISH;
         this._ocrContrast = options?.contrast || CONTRAST;
+        this._ocrLanguage = options?.language || SUPPORTED_LANGUAGES.ENGLISH;
+        this._isTesseractAvailable = isSystemTesseractAvailable();
     }
     /**
      * Set up the service if users want to use it in standalone mode
@@ -46,49 +49,53 @@ export default class WdioOcrService {
         const browserNames = Object.keys(capabilities);
         const self = this;
         log.info(`Adding commands to Multi Browser: ${browserNames.join(', ')}`);
-        for (const browserName of browserNames) {
-            const multiremoteBrowser = browser;
-            const browserInstance = multiremoteBrowser.getInstance(browserName);
-            await this.#addCommandsToBrowser(browserInstance);
-        }
         /**
-         * Add all OCR commands to the global browser object that will execute
-         * on each browser in the Multi Remote.
+         * Add all commands to the global browser object that will execute on each browser in the Multi Remote.
          */
-        for (const command of Object.keys(ocrCommands)) {
-            browser.addCommand(command, async function (...args) {
+        for (const commandName of Object.keys(ocrCommands)) {
+            browser.addCommand(commandName, async function (...args) {
                 const returnData = {};
                 if (typeof args[0] === 'object' && args[0] !== null) {
                     const options = args[0];
+                    options.ocrImagesPath = options?.imagesFolder || self._ocrDir;
                     options.contrast = options?.contrast || self._ocrContrast;
+                    options.language = options?.language || self._ocrLanguage;
+                    options.isTesseractAvailable = self._isTesseractAvailable;
                     args[0] = options;
                 }
                 for (const browserName of browserNames) {
                     const multiremoteBrowser = browser;
                     const browserInstance = multiremoteBrowser.getInstance(browserName);
-                    if (typeof browserInstance[command] === 'function') {
-                        returnData[browserName] = await browserInstance[command].apply(browserInstance, args);
+                    if (typeof browserInstance[commandName] === 'function') {
+                        returnData[browserName] = await browserInstance[commandName].apply(browserInstance, args);
                     }
                     else {
-                        throw new Error(`Command ${command} is not a function on the browser instance ${browserName}`);
+                        throw new Error(`Command ${commandName} is not a function on the browser instance ${browserName}`);
                     }
                 }
                 return returnData;
             });
         }
+        /**
+         * Add all commands to each instance (but Single Remote version)
+         */
+        for (const browserName of browserNames) {
+            const multiremoteBrowser = browser;
+            const browserInstance = multiremoteBrowser.getInstance(browserName);
+            await this.#addCommandsToBrowser(browserInstance);
+        }
     }
     async #addCommandsToBrowser(currentBrowser) {
-        const isTesseractAvailable = isSystemTesseractAvailable();
         const self = this;
         for (const [commandName, command] of Object.entries(ocrCommands)) {
             log.info(`Adding browser command "${commandName}" to browser object`);
             currentBrowser.addCommand(commandName, function (options) {
                 return command.bind(this)({
                     ...options,
+                    ocrImagesPath: self._ocrDir,
                     contrast: options?.contrast || self._ocrContrast,
-                    isTesseractAvailable,
                     language: options?.language || self._ocrLanguage,
-                    ocrImagesPath: self._ocrDir,
+                    isTesseractAvailable: self._isTesseractAvailable
                 });
             });
         }

package/dist/utils/getData.js

@@ -1,6 +1,6 @@
 import logger from '@wdio/logger';
 import { getNodeOcrData, getSystemOcrData } from './tesseract.js';
-import { adjustElementBbox, getScreenshotSize, isRectanglesObject } from './index.js';
+import { adjustElementBbox, getBase64ScreenshotSize, isRectanglesObject } from './index.js';
 import { drawHighlightedWords, processImage } from './imageProcessing.js';
 const log = logger('@wdio/ocr-service:getData');
 export default async function getData(browser, options) {
@@ -11,7 +11,7 @@ export default async function getData(browser, options) {
         if (!cliFile) {
             const screenSize = await browser.getWindowSize();
             screenshot = await browser.takeScreenshot();
-            const { width } = getScreenshotSize(screenshot);
+            const { width } = getBase64ScreenshotSize(screenshot);
             dpr = width / screenSize.width;
         }
         else {

package/dist/utils/index.d.ts

@@ -1,6 +1,6 @@
 import type { ChainablePromiseElement } from 'webdriverio';
 import type { ClickPoint, DetermineClickPointOptions, Rectangles, RectReturn, ScreenshotSize } from '../types.js';
-export declare function getScreenshotSize(screenshot: string): ScreenshotSize;
+export declare function getBase64ScreenshotSize(screenshot: string): ScreenshotSize;
 export declare function getDprPositions(values: Rectangles, dpr: number): Rectangles;
 /**
  * Determine the click point

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,0BAA0B,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CAKpE;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAO3E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,GAAG,UAAU,CAMnF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,UAAU,CAOvF;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAKvD;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,UAAU,GAAG,OAAO,CAM3G"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,0BAA0B,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CAK1E;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAO3E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,GAAG,UAAU,CAMnF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,UAAU,CAOvF;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAKvD;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,UAAU,GAAG,OAAO,CAM3G"}

package/dist/utils/index.js

@@ -1,6 +1,6 @@
 import { join } from 'node:path';
 import { mkdirSync } from 'node:fs';
-export function getScreenshotSize(screenshot) {
+export function getBase64ScreenshotSize(screenshot) {
     return {
         height: Math.round(Buffer.from(screenshot, 'base64').readUInt32BE(20)),
         width: Math.round(Buffer.from(screenshot, 'base64').readUInt32BE(16)),

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wdio/ocr-service",
   "author": "Wim Selles - wswebcreation",
   "description": "A WebdriverIO service that is using Tesseract OCR for Desktop/Mobile Web and Mobile Native App tests.",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "license": "MIT",
   "homepage": "https://webdriver.io/docs/visual-testing",
   "repository": {
@@ -22,18 +22,18 @@
   "type": "module",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@wdio/globals": "^9.9.1",
-    "@wdio/logger": "^9.4.4",
-    "@wdio/types": "^9.9.0",
+    "@wdio/globals": "^9.17.0",
+    "@wdio/logger": "^9.18.0",
+    "@wdio/types": "^9.16.2",
     "fuse.js": "^7.1.0",
-    "@inquirer/prompts": "7.3.2",
+    "@inquirer/prompts": "7.6.0",
     "jimp": "^1.6.0",
     "node-tesseract-ocr": "^2.2.1",
     "tesseract.js": "^5.1.1",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@types/inquirer": "~9.0.7",
+    "@types/inquirer": "~9.0.8",
     "@types/xml2js": "~0.4.14"
   },
   "scripts": {