automation_model 1.0.60 → 1.0.62

package/bin/auto_page.d.ts

@@ -0,0 +1,3 @@
+export function initContext(path: any, doNavigate?: boolean, headless?: boolean, world?: null): Promise<any>;
+export function navigate(path?: string): Promise<void>;
+export function closeContext(): Promise<void>;

package/bin/auto_page.js

@@ -12,12 +12,35 @@ const navigate = async (path = "") => {
   await context.stable.goto(url);
   await context.stable.waitForPageLoad();
 };
-
-const initContext = async (path, doNavigate = true, headless = false) => {
+const _findEmptyFolder = (folder) => {
+  if (!folder) {
+    folder = "./runs";
+  }
+  if (!fs.existsSync(folder)) {
+    fs.mkdirSync(folder);
+  }
+  let nextIndex = 1;
+  while (fs.existsSync(path.join(folder, nextIndex))) {
+    nextIndex++;
+  }
+  return path.join(folder, nextIndex);
+};
+const initContext = async (path, doNavigate = true, headless = false, world = null) => {
   if (context) {
     return context;
   }
   context = await getContext(null, headless);
+
+  if (world) {
+    world.screenshot = true;
+    const reportFolder = _findEmptyFolder();
+    if (world.attach) {
+      world.attach(reportFolder, { mediaType: "text/plain" });
+    }
+    world.screenshotPath = reportFolder;
+    context.reportFolder = reportFolder;
+  }
+
   if (doNavigate) {
     await navigate(path);
   }

package/bin/browser_manager.d.ts

@@ -0,0 +1,16 @@
+export const browserManager: BrowserManager;
+declare class BrowserManager {
+    browsers: any[];
+    closeAll(): Promise<void>;
+    closeBrowser(browser: any): Promise<void>;
+    createBrowser(headless?: boolean): Promise<Browser>;
+    getBrowser(headless?: boolean): Promise<any>;
+}
+declare class Browser {
+    browser: any;
+    context: any;
+    page: any;
+    init(headless?: boolean): Promise<void>;
+    close(): Promise<void>;
+}
+export {};

package/bin/environment.d.ts

@@ -0,0 +1,4 @@
+export class Environment {
+    baseUrl: any;
+    setBaseUrl(url: any): void;
+}

package/bin/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./auto_page.js";
+export * from "./init_browser.js";
+export * from "./stable_browser.js";
+export * from "./environment.js";
+export * from "./auto_page.js";
+export * from "./browser_manager.js";

package/bin/init_browser.d.ts

@@ -0,0 +1,3 @@
+export function getContext(environment?: null, headless?: boolean, logger?: null): Promise<TestContext>;
+export function closeBrowser(browser: any): Promise<void>;
+import { TestContext } from "./test_context.js";

package/bin/init_browser.js

@@ -17,6 +17,7 @@ const getContext = async function (environment = null, headless = false, logger
   context.playContext = browser.context;
   context.page = browser.page;
   context.environment = environment;
+
   context.stable = new StableBrowser(context.browser, context.page, logger);
   await _initCookies(context);
   return context;
@@ -48,7 +49,8 @@ const initEnvoronment = function () {
       const envObject = JSON.parse(data);
       //console.log("envObject", envObject);
       Object.assign(environment, envObject);
-      console.log("env", environment);
+      //console.log("env", environment);
+      console.log("Base url: " + environment.baseUrl);
     } catch (err) {
       console.error("Error reading env.json", err);
     }

package/bin/locator.d.ts

@@ -0,0 +1,21 @@
+declare function processTableQuary(table: any, quary: any): {
+    cells: any[];
+    error?: undefined;
+    rect?: undefined;
+} | {
+    error: string;
+    cells?: undefined;
+    rect?: undefined;
+} | {
+    cells: any[];
+    rect: any;
+    error?: undefined;
+};
+declare const selectors: null;
+declare const tableSelector: null;
+declare function merge(rec1: any, rec2: any): {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};

package/bin/stable_browser.d.ts

@@ -0,0 +1,61 @@
+export class StableBrowser {
+    constructor(browser: any, page: any, logger: any);
+    browser: any;
+    page: any;
+    logger: any;
+    goto(url: any): Promise<void>;
+    _fixUsingParams(text: any, _params: any): any;
+    _getLocator(locator: any, scope: any, _params: any): any;
+    _locateElementByText(scope: any, text1: any, tag1: any, regex?: boolean, _params?: null): Promise<any>;
+    _collectLocatorInformation(selectorHierarchy: any, index: number | undefined, scope: any, foundLocators: any, _params: any): Promise<void>;
+    _locate(selectors: any, info: any, _params: any, timeout?: number): Promise<any>;
+    click(selector: any, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+    }>;
+    selectOption(selector: any, values: any, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+    }>;
+    fill(selector: any, value: any, enter?: boolean, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+        value: any;
+    }>;
+    getText(selector: any, _params?: null, options?: {}, info?: {}, world?: null): Promise<any>;
+    containsPattern(selector: any, pattern: any, text: any, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+        value: any;
+        pattern: any;
+        foundText: any;
+    }>;
+    containsText(selector: any, text: any, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+        value: any;
+        foundText: any;
+    }>;
+    _screenShot(options?: {}, world?: null): Promise<void>;
+    verifyElementExistInPage(selector: any, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+    }>;
+    analyzeTable(selector: any, query: any, operator: any, value: any, _params?: null, options?: {}, world?: null): Promise<{
+        log: any[];
+        operation: string;
+        selector: any;
+        query: any;
+        query_fixed: any;
+        operator: any;
+        value: any;
+    }>;
+    waitForPageLoad(options?: {}, world?: null): Promise<void>;
+    _reportToWorld(world: any, command: any, _params: any): void;
+}

package/bin/stable_browser.js

@@ -1,6 +1,7 @@
 import reg_parser from "regex-parser";
 import { expect } from "@playwright/test";
 import fs from "fs";
+import path from "path";
 import { getTableCells } from "./table_analyze.js";
 let configuration = null;
 class StableBrowser {
@@ -186,7 +187,7 @@ class StableBrowser {
     throw new Error("failed to locate first element no elements found, " + JSON.stringify(info));
   }
 
-  async click(selector, _params = null, options = {}) {
+  async click(selector, _params = null, options = {}, world = null) {
     const info = {};
     info.log = [];
     info.operation = "click";
@@ -195,7 +196,7 @@ class StableBrowser {
     try {
       let element = await this._locate(selector, info, _params);
 
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       try {
         await element.click({ timeout: 5000 });
       } catch (e) {
@@ -207,14 +208,14 @@ class StableBrowser {
     } catch (e) {
       this.logger.error("click failed " + JSON.stringify(info));
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
 
       this.logger.info("click failed, will try next selector");
     }
   }
 
-  async selectOption(selector, values, _params = null, options = {}) {
+  async selectOption(selector, values, _params = null, options = {}, world = null) {
     const info = {};
     info.log = [];
     info.operation = "selectOptions";
@@ -223,7 +224,7 @@ class StableBrowser {
     try {
       let element = await this._locate(selector, info, _params);
 
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       try {
         await element.selectOption(values, { timeout: 5000 });
       } catch (e) {
@@ -235,14 +236,14 @@ class StableBrowser {
     } catch (e) {
       this.logger.error("selectOption failed " + JSON.stringify(info));
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
 
       this.logger.info("click failed, will try next selector");
     }
   }
 
-  async fill(selector, value, enter = false, _params = null, options = {}) {
+  async fill(selector, value, enter = false, _params = null, options = {}, world = null) {
     const info = {};
     info.log = [];
     info.operation = "fill";
@@ -250,7 +251,7 @@ class StableBrowser {
     info.value = value;
     try {
       let element = await this._locate(selector, info, _params);
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       await element.fill(value, { timeout: 10000 });
       await element.dispatchEvent("change");
       if (enter) {
@@ -261,17 +262,17 @@ class StableBrowser {
     } catch (e) {
       this.logger.error("fill failed " + JSON.stringify(info));
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
     }
   }
 
-  async getText(selector, _params = null, options = {}, info = {}) {
+  async getText(selector, _params = null, options = {}, info = {}, world = null) {
     if (!info.log) {
       info.log = [];
     }
     let element = await this._locate(selector, info, _params);
-    await this._screenShot(options);
+    await this._screenShot(options, world);
     try {
       return await element.innerText();
     } catch (e) {
@@ -279,7 +280,7 @@ class StableBrowser {
       return await element.textContent();
     }
   }
-  async containsPattern(selector, pattern, text, _params = null, options = {}) {
+  async containsPattern(selector, pattern, text, _params = null, options = {}, world = null) {
     const info = {};
     info.log = [];
     info.operation = "containsPattern";
@@ -288,7 +289,7 @@ class StableBrowser {
     info.pattern = pattern;
     let foundText = null;
     try {
-      foundText = await this.getText(selector, _params, options, info);
+      foundText = await this.getText(selector, _params, options, info, world);
       let escapedText = text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
       pattern = pattern.replace("{text}", escapedText);
       let regex = new RegExp(pattern, "m");
@@ -301,19 +302,19 @@ class StableBrowser {
       this.logger.error("verify element contains text failed " + JSON.stringify(info));
       this.logger.error("found text " + foundText + " pattern " + pattern);
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
     }
   }
 
-  async containsText(selector, text, _params = null, options = {}) {
+  async containsText(selector, text, _params = null, options = {}, world = null) {
     const info = {};
     info.log = [];
     info.operation = "containsText";
     info.selector = selector;
     info.value = text;
     try {
-      let foundText = await this.getText(selector, _params, options, info);
+      let foundText = await this.getText(selector, _params, options, info, world);
       if (!foundText.includes(text)) {
         info.foundText = foundText;
         throw new Error("element doesn't contain text " + text);
@@ -322,16 +323,31 @@ class StableBrowser {
     } catch (e) {
       this.logger.error("verify element contains text failed " + JSON.stringify(info));
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
     }
   }
-  async _screenShot(options = {}) {
-    if (options.screenshot) {
+  async _screenShot(options = {}, world = null) {
+    if (world && world.attach && world.screenshot && world.screenshotPath) {
+      if (!fs.existsSync(world.screenshotPath)) {
+        fs.mkdirSync(world.screenshotPath, { recursive: true });
+      }
+      let nextIndex = 1;
+      while (fs.existsSync(path.join(world.screenshotPath, nextIndex + ".png"))) {
+        nextIndex++;
+      }
+      await this.page.screenshot({ path: path.join(world.screenshotPath, nextIndex + ".png") });
+      await world.attach(
+        { path: world.screenshotPath },
+        {
+          mediaType: "application/json",
+        }
+      );
+    } else if (options.screenshot) {
       await this.page.screenshot({ path: options.screenshotPath });
     }
   }
-  async verifyElementExistInPage(selector, _params = null, options = {}) {
+  async verifyElementExistInPage(selector, _params = null, options = {}, world = null) {
     await new Promise((resolve) => setTimeout(resolve, 2000));
     const info = {};
     info.log = [];
@@ -339,17 +355,17 @@ class StableBrowser {
     info.selector = selector;
     try {
       const element = await this._locate(selector, info, _params);
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       await expect(element).toHaveCount(1, { timeout: 10000 });
       return info;
     } catch (e) {
       this.logger.error("verify failed " + JSON.stringify(info));
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
     }
   }
-  async analyzeTable(selector, query, operator, value, _params = null, options = {}) {
+  async analyzeTable(selector, query, operator, value, _params = null, options = {}, world = null) {
     const info = {};
     info.log = [];
     info.operation = "analyzeTable";
@@ -361,7 +377,7 @@ class StableBrowser {
     info.value = value;
     try {
       let table = await this._locate(selector, info, _params);
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       const cells = await getTableCells(this.page, table, query, info);
 
       if (cells.error) {
@@ -437,11 +453,11 @@ class StableBrowser {
     } catch (e) {
       this.logger.error("analyzeTable failed " + JSON.stringify(info));
       Object.assign(e, { info: info });
-      await this._screenShot(options);
+      await this._screenShot(options, world);
       throw e;
     }
   }
-  async waitForPageLoad(options = {}) {
+  async waitForPageLoad(options = {}, world = null) {
     let timeout = 10000;
     if (!configuration) {
       try {
@@ -473,7 +489,13 @@ class StableBrowser {
       console.log("waitForPageLoad error, ignored");
     }
     await new Promise((resolve) => setTimeout(resolve, 2000));
-    await this._screenShot(options);
+    await this._screenShot(options, world);
+  }
+  _reportToWorld(world, command, _params) {
+    if (!world || !world.attach) {
+      return;
+    }
+    world.attach({ command: command, params: _params });
   }
 }
 

package/bin/table_analyze.d.ts

@@ -0,0 +1 @@
+export function getTableCells(page: any, element: any, tableSelector: any, info?: {}): Promise<any>;

package/bin/test_context.d.ts

@@ -0,0 +1,6 @@
+export class TestContext {
+    browser: any;
+    playContext: any;
+    page: any;
+    environment: any;
+}

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "automation_model",
-  "version": "1.0.60",
+  "version": "1.0.62",
   "description": "An automation infrastructure module to be use for generative AI automation projects.",
   "main": "bin/index.js",
   "type": "module",
+  "types": "bin/index.d.ts",
   "directories": {
     "lib": "lib"
   },
   "scripts": {
-    "pack": "mkdir build && mkdir build/bin && cp ./src/auto_page.js ./build/bin/auto_page.js && cp ./src/environment.js ./build/bin/environment.js && cp ./src/browser_manager.js ./build/bin/browser_manager.js && cp ./src/test_context.js ./build/bin/test_context.js && cp ./src/init_browser.js ./build/bin/init_browser.js && cp ./src/stable_browser.js ./build/bin/stable_browser.js && cp ./src/index.js ./build/bin/index.js && cp ./package.json ./build/package.json && cp ./src/table_analyze.js ./build/bin/table_analyze.js && cp ./src/locator.js ./build/bin/locator.js",
-    "clean": "rm -rf ./build",
+    "pack": "npm run types && mkdir build && mkdir build/bin && cp ./src/auto_page.js ./build/bin/auto_page.js && cp ./src/environment.js ./build/bin/environment.js && cp ./src/browser_manager.js ./build/bin/browser_manager.js && cp ./src/test_context.js ./build/bin/test_context.js && cp ./src/init_browser.js ./build/bin/init_browser.js && cp ./src/stable_browser.js ./build/bin/stable_browser.js && cp ./src/index.js ./build/bin/index.js && cp ./package.json ./build/package.json && cp ./src/table_analyze.js ./build/bin/table_analyze.js && cp ./src/locator.js ./build/bin/locator.js && cp ./types/src/*.ts ./build/bin",
+    "clean": "rm -rf ./build && rm -rf ./types",
     "build": "npm run clean && npm run pack",
-    "test": "node ./tests/launch_page.js"
+    "test": "node ./tests/launch_page.js",
+    "types": "npx tsc --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "author": "",
   "license": "ISC",
@@ -19,5 +21,8 @@
     "@playwright/test": "^1.35.0",
     "playwright": "^1.33.0",
     "regex-parser": "^2.2.11"
+  },
+  "devDependencies": {
+    "typescript": "^5.2.2"
   }
 }