@wdio/ocr-service 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @wdio/ocr-service
 
+## 2.1.1
+
+### Patch Changes
+
+# d76044f 🐛 Fix ERR_BUFFER_OUT_OF_BOUNDS for multiremote
+
+Functions in utils such as `getData.ts` used the global `browser`, but this is not browser is not the browser making for example the `ocrClick` function call when the we are running in the multiremote context. This could lead to `ERR_BUFFER_OUT_OF_BOUNDS` error. This release fixes that error.
+
+  # Committers: 1
+
+  - Chanatan Charnkijtawarush ([@ccharnkij](https://github.com/ccharnkij))
+
+## 2.1.0
+
+### Minor Changes
+
+- f5f8041: fix click duration for 0ms
+
+### Committers: 1
+
+- Fabien CELLIER ([@lacell75](https://github.com/lacell75))
+
 ## 2.0.0
 
 ### Major Changes

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAUA,eAAO,MAAM,mBAAmB,wHAI/B,CAAA"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAWA,eAAO,MAAM,mBAAmB,wHAI/B,CAAA"}

package/dist/cli.js

@@ -6,6 +6,7 @@ import getData from './utils/getData.js';
 import { createOcrDir } from './utils/index.js';
 import { isSystemTesseractAvailable } from './utils/tesseract.js';
 import { SUPPORTED_LANGUAGES } from './utils/constants.js';
+import { remote } from 'webdriverio';
 export const CONFIG_HELPER_INTRO = `
 =============================
 🤖 WDIO OCR-Service Wizard 🧙
@@ -136,8 +137,10 @@ async function main() {
             contrast: parseFloat(advancedOptions),
         };
     }
+    // For cli use, empty browser context to pass into getData
+    const browser = await remote({ capabilities: { browserName: 'stub' }, automationProtocol: './protocol-stub.js' });
     console.log('\nProcessing image...\n');
-    await getData(options);
+    await getData(browser, options);
     console.log('\nDone!');
 }
 main();

package/dist/commands/ocrClickOnText.d.ts

@@ -1,3 +1,3 @@
 import type { OcrClickOnTextOptions } from '../types.js';
-export default function ocrClickOnText(options: OcrClickOnTextOptions): Promise<void>;
+export default function ocrClickOnText(this: WebdriverIO.Browser, options: OcrClickOnTextOptions): Promise<void>;
 //# sourceMappingURL=ocrClickOnText.d.ts.map

package/dist/commands/ocrClickOnText.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ocrClickOnText.d.ts","sourceRoot":"","sources":["../../src/commands/ocrClickOnText.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAGxD,wBAA8B,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2B1F"}
+{"version":3,"file":"ocrClickOnText.d.ts","sourceRoot":"","sources":["../../src/commands/ocrClickOnText.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAGxD,wBAA8B,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BrH"}

package/dist/commands/ocrClickOnText.js

@@ -1,9 +1,8 @@
-import { browser } from '@wdio/globals';
 import ocrGetElementPositionByText from './ocrGetElementPositionByText.js';
 import { determineClickPoint } from '../utils/index.js';
 import { drawTarget } from '../utils/imageProcessing.js';
 export default async function ocrClickOnText(options) {
-    const element = await ocrGetElementPositionByText(options);
+    const element = await ocrGetElementPositionByText.bind(this)(options);
     let { x, y } = determineClickPoint({ rectangles: element.dprPosition });
     const { relativePosition } = options;
     // Adjust the x and y coordinates based on the relative position
@@ -14,9 +13,9 @@ export default async function ocrClickOnText(options) {
     }
     // Draw a target on the image so a user can see where the click will happen
     await drawTarget({ filePath: element.filePath, targetX: x, targetY: y });
-    const actionType = browser.isMobile ? 'touch' : 'mouse';
-    const clickDuration = options.clickDuration ? options.clickDuration : 500;
-    await browser
+    const actionType = this.isMobile ? 'touch' : 'mouse';
+    const clickDuration = options.clickDuration ?? 500;
+    await this
         .action('pointer', {
         parameters: { pointerType: actionType }
     })

package/dist/commands/ocrGetElementPositionByText.d.ts

@@ -1,3 +1,3 @@
 import type { OcrGetElementPositionByText, OcrGetElementPositionByTextOptions } from '../types.js';
-export default function ocrGetElementPositionByText(data: OcrGetElementPositionByTextOptions): Promise<OcrGetElementPositionByText>;
+export default function ocrGetElementPositionByText(this: WebdriverIO.Browser, data: OcrGetElementPositionByTextOptions): Promise<OcrGetElementPositionByText>;
 //# sourceMappingURL=ocrGetElementPositionByText.d.ts.map

package/dist/commands/ocrGetElementPositionByText.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ocrGetElementPositionByText.d.ts","sourceRoot":"","sources":["../../src/commands/ocrGetElementPositionByText.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAgB,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAA;AAMhH,wBAA8B,2BAA2B,CACrD,IAAI,EAAE,kCAAkC,GACzC,OAAO,CAAC,2BAA2B,CAAC,CAuDtC"}
+{"version":3,"file":"ocrGetElementPositionByText.d.ts","sourceRoot":"","sources":["../../src/commands/ocrGetElementPositionByText.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAgB,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAA;AAMhH,wBAA8B,2BAA2B,CACrD,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,kCAAkC,GACzC,OAAO,CAAC,2BAA2B,CAAC,CAuDtC"}

package/dist/commands/ocrGetElementPositionByText.js

@@ -4,7 +4,7 @@ import { fuzzyFind } from '../utils/fuzzySearch.js';
 const log = logger('@wdio/ocr-service:ocrGetElementPositionByText');
 export default async function ocrGetElementPositionByText(data) {
     const { contrast, haystack, fuzzyFindOptions, isTesseractAvailable, language, ocrImagesPath, text, } = data;
-    const textPositions = await getTextPositions({
+    const textPositions = await getTextPositions(this, {
         contrast,
         haystack,
         isTesseractAvailable,

package/dist/commands/ocrGetText.d.ts

@@ -1,3 +1,3 @@
 import type { OcrGetTextOptions } from '../types.js';
-export default function ocrGetText(options: OcrGetTextOptions): Promise<string>;
+export default function ocrGetText(this: WebdriverIO.Browser, options: OcrGetTextOptions): Promise<string>;
 //# sourceMappingURL=ocrGetText.d.ts.map

package/dist/commands/ocrGetText.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ocrGetText.d.ts","sourceRoot":"","sources":["../../src/commands/ocrGetText.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAEpD,wBAA8B,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CAIpF"}
+{"version":3,"file":"ocrGetText.d.ts","sourceRoot":"","sources":["../../src/commands/ocrGetText.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAEpD,wBAA8B,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CAI/G"}

package/dist/commands/ocrGetText.js

@@ -1,5 +1,5 @@
 import getData from '../utils/getData.js';
 export default async function ocrGetText(options) {
-    const { text } = await getData(options);
+    const { text } = await getData(this, options);
     return text.replace(/\n\s*\n/g, '\n');
 }

package/dist/commands/ocrSetValue.d.ts

@@ -1,3 +1,3 @@
 import type { OcrSetValueOptions } from '../types.js';
-export default function ocrSetValue(options: OcrSetValueOptions): Promise<void>;
+export default function ocrSetValue(this: WebdriverIO.Browser, options: OcrSetValueOptions): Promise<void>;
 //# sourceMappingURL=ocrSetValue.d.ts.map

package/dist/commands/ocrSetValue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ocrSetValue.d.ts","sourceRoot":"","sources":["../../src/commands/ocrSetValue.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAIrD,wBAA8B,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDpF"}
+{"version":3,"file":"ocrSetValue.d.ts","sourceRoot":"","sources":["../../src/commands/ocrSetValue.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAIrD,wBAA8B,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmD/G"}

package/dist/commands/ocrSetValue.js

@@ -1,10 +1,9 @@
-import { driver } from '@wdio/globals';
 import sendKeys from '../utils/sendKeys.js';
 import ocrClickOnText from './ocrClickOnText.js';
 export default async function ocrSetValue(options) {
     const { contrast, clickDuration, haystack, fuzzyFindOptions, isTesseractAvailable, language, ocrImagesPath, submitValue = false, text, value, } = options;
     // 1. First click on the position of the text to make sure it is intractable
-    await ocrClickOnText({
+    await ocrClickOnText.bind(this)({
         contrast,
         clickDuration,
         haystack,
@@ -15,22 +14,22 @@ export default async function ocrSetValue(options) {
         text,
     });
     // 2. If Mobile then a keyboard might be shown
-    if (driver.isMobile) {
+    if (this.isMobile) {
         try {
             // Wait for 3 seconds for the keyboard to be shown
-            await driver.waitUntil(async () => driver.isKeyboardShown(), { timeout: 3 * 1000 });
+            await this.waitUntil(async () => this.isKeyboardShown(), { timeout: 3 * 1000 });
         }
         catch (_ign) {
             // Keyboard is not shown
         }
     }
     // 3. Send the value to the active element
-    await sendKeys(value, submitValue);
+    await sendKeys(this, value, submitValue);
     // 4. If Mobile then hide the keyboard
-    if (driver.isMobile) {
+    if (this.isMobile) {
         try {
-            await driver.hideKeyboard();
-            await driver.waitUntil(async () => !(await driver.isKeyboardShown()), { timeout: 3 * 1000 });
+            await this.hideKeyboard();
+            await this.waitUntil(async () => !(await this.isKeyboardShown()), { timeout: 3 * 1000 });
         }
         catch (_ign) {
             // Keyboard is not present or not hidden

package/dist/commands/ocrWaitForTextDisplayed.d.ts

@@ -1,3 +1,3 @@
 import type { OcrWaitForTextDisplayedOptions } from '../types.js';
-export default function ocrWaitForTextDisplayed(options: OcrWaitForTextDisplayedOptions): Promise<import("../types.js").OcrGetElementPositionByText>;
+export default function ocrWaitForTextDisplayed(this: WebdriverIO.Browser, options: OcrWaitForTextDisplayedOptions): Promise<import("../types.js").OcrGetElementPositionByText>;
 //# sourceMappingURL=ocrWaitForTextDisplayed.d.ts.map

package/dist/commands/ocrWaitForTextDisplayed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ocrWaitForTextDisplayed.d.ts","sourceRoot":"","sources":["../../src/commands/ocrWaitForTextDisplayed.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAGjE,wBAA8B,uBAAuB,CACjD,OAAO,EAAE,8BAA8B,8DAW1C"}
+{"version":3,"file":"ocrWaitForTextDisplayed.d.ts","sourceRoot":"","sources":["../../src/commands/ocrWaitForTextDisplayed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAGjE,wBAA8B,uBAAuB,CACjD,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,OAAO,EAAE,8BAA8B,8DAW1C"}

package/dist/commands/ocrWaitForTextDisplayed.js

@@ -1,8 +1,7 @@
-import { driver } from '@wdio/globals';
 import ocrGetElementPositionByText from './ocrGetElementPositionByText.js';
 export default async function ocrWaitForTextDisplayed(options) {
     const { timeout, timeoutMsg } = options;
-    return driver.waitUntil(async () => ocrGetElementPositionByText(options), {
+    return this.waitUntil(async () => ocrGetElementPositionByText.bind(this)(options), {
         timeout: timeout || 180000,
         timeoutMsg: timeoutMsg || `Could not find the text "${options.text}" within the requested time.`,
     });

package/dist/service.js

@@ -83,7 +83,7 @@ export default class WdioOcrService {
         for (const [commandName, command] of Object.entries(ocrCommands)) {
             log.info(`Adding browser command "${commandName}" to browser object`);
             currentBrowser.addCommand(commandName, function (options) {
-                return command({
+                return command.bind(this)({
                     ...options,
                     contrast: options?.contrast || self._ocrContrast,
                     isTesseractAvailable,

package/dist/utils/getData.d.ts

@@ -1,3 +1,3 @@
 import type { GetData, GetDataOptions } from '../types.js';
-export default function getData(options: GetDataOptions): Promise<GetData>;
+export default function getData(browser: WebdriverIO.Browser, options: GetDataOptions): Promise<GetData>;
 //# sourceMappingURL=getData.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getData.d.ts","sourceRoot":"","sources":["../../src/utils/getData.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAoB,OAAO,EAAE,cAAc,EAAqB,MAAM,aAAa,CAAA;AAM/F,wBAA8B,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CA+E/E"}
+{"version":3,"file":"getData.d.ts","sourceRoot":"","sources":["../../src/utils/getData.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAoB,OAAO,EAAE,cAAc,EAAqB,MAAM,aAAa,CAAA;AAM/F,wBAA8B,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CA+E7G"}

package/dist/utils/getData.js

@@ -1,10 +1,9 @@
 import logger from '@wdio/logger';
-import { browser } from '@wdio/globals';
 import { getNodeOcrData, getSystemOcrData } from './tesseract.js';
 import { adjustElementBbox, getScreenshotSize, isRectanglesObject } from './index.js';
 import { drawHighlightedWords, processImage } from './imageProcessing.js';
 const log = logger('@wdio/ocr-service:getData');
-export default async function getData(options) {
+export default async function getData(browser, options) {
     const { contrast, cliFile, haystack, isTesseractAvailable, language, ocrImagesPath, } = options;
     try {
         let dpr = 1;
@@ -18,7 +17,7 @@ export default async function getData(options) {
         else {
             screenshot = cliFile;
         }
-        const { filePath } = await processImage({ contrast, isAndroid: browser.isAndroid = false, isIOS: browser.isIOS = false, ocrImagesPath, screenshot });
+        const { filePath } = await processImage({ contrast, isAndroid: browser.isAndroid, isIOS: browser.isIOS, ocrImagesPath, screenshot });
         let elementRectangles;
         let croppedFilePath;
         if (haystack) {

package/dist/utils/getTextPositions.d.ts

@@ -1,3 +1,3 @@
 import type { GetTextPositions, GetTextPositionsOptions } from '../types.js';
-export default function getTextPositions(options: GetTextPositionsOptions): Promise<GetTextPositions[]>;
+export default function getTextPositions(browser: WebdriverIO.Browser, options: GetTextPositionsOptions): Promise<GetTextPositions[]>;
 //# sourceMappingURL=getTextPositions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTextPositions.d.ts","sourceRoot":"","sources":["../../src/utils/getTextPositions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAQ,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAElF,wBAA8B,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAa5G"}
+{"version":3,"file":"getTextPositions.d.ts","sourceRoot":"","sources":["../../src/utils/getTextPositions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAQ,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAElF,wBAA8B,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAa1I"}

package/dist/utils/getTextPositions.js

@@ -1,7 +1,7 @@
 import getData from './getData.js';
 import { getDprPositions } from './index.js';
-export default async function getTextPositions(options) {
-    const { dpr, filePath, words } = await getData(options);
+export default async function getTextPositions(browser, options) {
+    const { dpr, filePath, words } = await getData(browser, options);
     return (words
         .map(({ text, bbox }) => ({
         dprPosition: getDprPositions(JSON.parse(JSON.stringify(bbox)), dpr),

package/dist/utils/sendKeys.d.ts

@@ -1,2 +1,2 @@
-export default function sendKeys(value: string, submitValue: boolean): Promise<void>;
+export default function sendKeys(browser: WebdriverIO.Browser, value: string, submitValue: boolean): Promise<void>;
 //# sourceMappingURL=sendKeys.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sendKeys.d.ts","sourceRoot":"","sources":["../../src/utils/sendKeys.ts"],"names":[],"mappings":"AAGA,wBAA8B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBzF"}
+{"version":3,"file":"sendKeys.d.ts","sourceRoot":"","sources":["../../src/utils/sendKeys.ts"],"names":[],"mappings":"AAEA,wBAA8B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBvH"}

package/dist/utils/sendKeys.js

@@ -1,6 +1,5 @@
-import { browser } from '@wdio/globals';
 import { Key } from 'webdriverio';
-export default async function sendKeys(value, submitValue) {
+export default async function sendKeys(browser, value, submitValue) {
     const actionChain = browser.action('key');
     [...value].forEach((char) => {
         actionChain.down(char);

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.0.0",
+  "version": "2.1.1",
   "license": "MIT",
   "homepage": "https://webdriver.io/docs/visual-testing",
   "repository": {
@@ -22,14 +22,14 @@
   "type": "module",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@wdio/globals": "^9.0.7",
-    "@wdio/logger": "^9.0.4",
-    "@wdio/types": "^9.0.4",
+    "@wdio/globals": "^9.1.2",
+    "@wdio/logger": "^9.1.0",
+    "@wdio/types": "^9.1.2",
     "fuse.js": "^7.0.0",
-    "@inquirer/prompts": "5.3.8",
+    "@inquirer/prompts": "5.5.0",
     "jimp": "^0.22.12",
     "node-tesseract-ocr": "^2.2.1",
-    "tesseract.js": "^5.1.0",
+    "tesseract.js": "^5.1.1",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {