automation_model 1.0.63 → 1.0.64

package/build/test_context.d.ts

@@ -0,0 +1,13 @@
+import { BrowserContext, Page, Browser as PlaywrightBrowser } from "playwright";
+import { Environment } from "./environment.js";
+import { StableBrowser } from "./stable_browser.js";
+declare class TestContext {
+    stable: StableBrowser | null;
+    browser: PlaywrightBrowser | null;
+    playContext: BrowserContext | null;
+    page: Page | null;
+    environment: Environment | null;
+    reportFolder: string | null;
+    constructor();
+}
+export { TestContext };

package/build/test_context.js

@@ -0,0 +1,12 @@
+class TestContext {
+    constructor() {
+        this.stable = null;
+        this.browser = null;
+        this.playContext = null;
+        this.page = null;
+        this.environment = null;
+        this.reportFolder = null;
+    }
+}
+export { TestContext };
+//# sourceMappingURL=test_context.js.map

package/build/test_context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test_context.js","sourceRoot":"","sources":["../src/test_context.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW;IAOf;QANA,WAAM,GAAuB,IAAI,CAAA;QACjC,YAAO,GAA2B,IAAI,CAAA;QACtC,gBAAW,GAA0B,IAAI,CAAA;QACzC,SAAI,GAAgB,IAAI,CAAA;QACxB,gBAAW,GAAqB,IAAI,CAAA;QACpC,iBAAY,GAAgB,IAAI,CAAA;IAGhC,CAAC;CACF;AACD,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/env.json

@@ -0,0 +1,3 @@
+{
+    "baseUrl": "https://github.com"
+}

package/package.json

@@ -1,28 +1,31 @@
 {
   "name": "automation_model",
-  "version": "1.0.63",
+  "version": "1.0.64",
   "description": "An automation infrastructure module to be use for generative AI automation projects.",
-  "main": "bin/index.js",
+  "main": "build/index.js",
   "type": "module",
-  "types": "bin/index.d.ts",
+  "types": "build/index.d.ts",
   "directories": {
     "lib": "lib"
   },
   "scripts": {
-    "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",
-    "types": "npx tsc --declaration --allowJs --emitDeclarationOnly --outDir types"
+    "compile": "tsc",
+    "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 ./package.json ./build/package.json",
+    "clean": "rimraf -g build && rimraf -g types",
+    "build": "npm run clean && npm run compile",
+    "test": "node tests/debug.test.js",
+    "types": "tsc --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@playwright/test": "^1.35.0",
-    "playwright": "^1.33.0",
+    "playwright": "^1.39.0",
     "regex-parser": "^2.2.11"
   },
   "devDependencies": {
+    "@playwright/test": "^1.40.0",
+    "@types/node": "^20.9.3",
+    "rimraf": "^5.0.5",
     "typescript": "^5.2.2"
   }
-}
+}

package/{bin/auto_page.js → src/auto_page.ts}

@@ -1,57 +1,58 @@
-import { browserManager } from "./browser_manager.js";
-import { getContext } from "./init_browser.js";
-import fs from "fs";
-import path from "path";
-let context = null;
-const navigate = async (path = "") => {
-  let url = null;
-  if (path === null) {
-    url = context.environment.baseUrl;
-  } else {
-    url = new URL(path, context.environment.baseUrl).href;
-  }
-  await context.stable.goto(url);
-  await context.stable.waitForPageLoad();
-};
-const _findEmptyFolder = (folder) => {
-  if (!folder) {
-    folder = "./runs";
-  }
-  if (!fs.existsSync(folder)) {
-    fs.mkdirSync(folder);
-  }
-  let nextIndex = 1;
-  while (fs.existsSync(path.join(folder, nextIndex.toString()))) {
-    nextIndex++;
-  }
-  return path.join(folder, nextIndex.toString());
-};
-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);
-  }
-
-  return context;
-};
-const closeContext = async () => {
-  if (context && context.browser) {
-    await browserManager.closeBrowser(context.browser);
-  }
-  context = null;
-};
-export { initContext, navigate, closeContext };
+import { browserManager } from "./browser_manager.js";
+import { getContext } from "./init_browser.js";
+import fs from "fs";
+import path from "path";
+import type { TestContext } from "./test_context.js";
+let context:TestContext|null = null;
+const navigate = async (path = "") => {
+  let url = null;
+  if (path === null) {
+    url = context!.environment!.baseUrl!;
+  } else {
+    url = new URL(path, context!.environment!.baseUrl).href;
+  }
+  await context!.stable!.goto(url);
+  await context!.stable!.waitForPageLoad();
+};
+const _findEmptyFolder = (folder?:string) => {
+  if (!folder) {
+    folder = "./runs";
+  }
+  if (!fs.existsSync(folder)) {
+    fs.mkdirSync(folder);
+  }
+  let nextIndex = 1;
+  while (fs.existsSync(path.join(folder, nextIndex.toString()))) {
+    nextIndex++;
+  }
+  return path.join(folder, nextIndex.toString());
+};
+const initContext = async (path:string, doNavigate = true, headless = false, world:any = 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);
+  }
+
+  return context;
+};
+const closeContext = async () => {
+  if (context && context.browser) {
+    await browserManager.closeBrowser(context.browser);
+  }
+  context = null;
+};
+export { initContext, navigate, closeContext };

package/{bin/browser_manager.js → src/browser_manager.ts}

@@ -1,78 +1,87 @@
-import { chromium } from "playwright";
-class BrowserManager {
-  constructor() {
-    this.browsers = [];
-  }
-
-  async closeAll() {
-    await Promise.all(this.browsers.map((browser) => browser.close()));
-    this.browsers = [];
-  }
-  async closeBrowser(browser) {
-    if (!browser && this.browsers.length > 0) {
-      browser = this.browsers[0];
-    }
-
-    if (browser) {
-      await browser.close();
-      for (let i = 0; i < this.browsers.length; i++) {
-        if (this.browsers[i].browser === browser || this.browsers[i] === browser) {
-          this.browsers.splice(i, 1);
-          i--;
-          break;
-        }
-      }
-    }
-  }
-
-  async createBrowser(headless = false) {
-    const browser = new Browser();
-    await browser.init(headless);
-    this.browsers.push(browser);
-    return browser;
-  }
-  async getBrowser(headless = false) {
-    if (this.browsers.length === 0) {
-      return await this.createBrowser(headless);
-    }
-    return this.browsers[0];
-  }
-}
-class Browser {
-  constructor() {
-    this.browser = null;
-    this.context = null;
-    this.page = null;
-  }
-
-  async init(headless = false) {
-    this.browser = await chromium.launch({
-      headless: headless,
-      timeout: 0,
-      args: ["--ignore-https-errors"],
-    });
-
-    this.context = await this.browser.newContext();
-    this.page = await this.context.newPage();
-  }
-
-  async close() {
-    if (this.browser !== null) {
-      await this.browser.close();
-      this.browser = null;
-      this.context = null;
-      this.page = null;
-    }
-  }
-}
-const browserManager = new BrowserManager();
-
-export { browserManager };
-
-// let browser = await browserManager.createBrowser();
-// browser.page.goto("https://www.cnn.com");
-// let browser2 = await browserManager.createBrowser();
-// await browser2.page.goto("https://www.google.com");
-// // sleep for 2 seconds
-// await new Promise((r) => setTimeout(r, 1000));
-// await browserManager.closeAll();
+import { chromium, Browser as PlaywrightBrowser, BrowserContext, Page, BrowserContextOptions } from "playwright";
+import type { Cookie, LocalStorage } from "./environment.js";
+
+type StorageState = {
+  cookies: Cookie[],
+  origins: {origin: string, localStorage: LocalStorage}[]
+}
+class BrowserManager {
+  constructor(public browsers: Browser[] = []) {
+  }
+
+  async closeAll() {
+    await Promise.all(this.browsers.map((browser) => browser.close()));
+    this.browsers = [];
+  }
+  async closeBrowser(browser?: PlaywrightBrowser |Browser) {
+    if (!browser && this.browsers.length > 0) {
+      browser = this.browsers[0];
+    }
+
+    if (browser) {
+      await browser.close();
+      for (let i = 0; i < this.browsers.length; i++) {
+        if (this.browsers[i].browser === browser || this.browsers[i] === browser) {
+          this.browsers.splice(i, 1);
+          i--;
+          break;
+        }
+      }
+    }
+  }
+
+  async createBrowser(headless = false, storageState?:StorageState) {
+    const browser = new Browser();
+    await browser.init(headless, storageState);
+    this.browsers.push(browser);
+    return browser;
+  }
+  async getBrowser(headless = false, storageState?:StorageState) {
+    if (this.browsers.length === 0) {
+      return await this.createBrowser(headless, storageState);
+    }
+    return this.browsers[0];
+  }
+}
+class Browser {
+  browser : PlaywrightBrowser|null;
+  context : BrowserContext | null;
+  page : Page | null;
+  constructor() {
+    this.browser = null;
+    this.context = null;
+    this.page = null;
+  }
+
+  async init(headless = false, storageState?:StorageState) {
+    this.browser = await chromium.launch({
+      headless: headless,
+      timeout: 0,
+      args: ["--ignore-https-errors"],
+    });
+
+    const contextOptions = !!storageState ? {storageState} : undefined
+    this.context = await this.browser.newContext(contextOptions as unknown as BrowserContextOptions);
+    this.page = await this.context.newPage();
+  }
+
+  async close() {
+    if (this.browser !== null) {
+      await this.browser.close();
+      this.browser = null;
+      this.context = null;
+      this.page = null;
+    }
+  }
+}
+const browserManager = new BrowserManager();
+
+export { browserManager };
+export type {BrowserManager, Browser}
+// let browser = await browserManager.createBrowser();
+// browser.page.goto("https://www.cnn.com");
+// let browser2 = await browserManager.createBrowser();
+// await browser2.page.goto("https://www.google.com");
+// // sleep for 2 seconds
+// await new Promise((r) => setTimeout(r, 1000));
+// await browserManager.closeAll();

package/src/environment.ts

@@ -0,0 +1,24 @@
+type Cookie ={
+ name: string
+ value: string
+  domain?: string
+  path?: string
+  expires?: number
+  httpOnly?: boolean
+  secure?: boolean
+  sameSite?: string
+}
+
+type LocalStorage = Record<string, string>
+
+class Environment {
+  cookies:Cookie[] = []
+  origins:{origin:string, localStorage:LocalStorage}[] = []
+  constructor(public baseUrl?: string) {
+  }
+  setBaseUrl(url: string) {
+    this.baseUrl = url;
+  }
+}
+export { Environment };
+export type { Cookie, LocalStorage };

package/{bin/index.js → src/index.ts}

@@ -1,6 +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";
+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/src/init_browser.ts

@@ -0,0 +1,65 @@
+import fs from "node:fs";
+import { Environment } from "./environment.js";
+import { browserManager } from "./browser_manager.js";
+import { TestContext } from "./test_context.js";
+import { StableBrowser } from "./stable_browser.js";
+import {  Browser as PlaywrightBrowser } from "playwright";
+import { Browser } from "./browser_manager.js";
+
+// let environment = null;
+
+// init browser create context and page, if context and page are not null
+const getContext = async function (environment: Environment|null, headless = false, logger?: null) {
+  if (environment === null) {
+    environment = initEnvironment();
+  }
+  const {cookies, origins} = environment;
+  const storageState = {cookies, origins};
+  let browser = await browserManager.getBrowser(headless, storageState);
+  let context = new TestContext();
+  context.browser = browser.browser;
+  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;
+};
+// const _initCookies = async function (context) {
+//   if (context.environment.cookies) {
+//     const cookies = [];
+//     for (let i = 0; i < context.environment.cookies.length; i++) {
+//       const cookie = context.environment.cookies[i];
+//       if (cookie.expires && cookie.expires == "undefined") {
+//         delete cookie.expires;
+//       }
+//       cookies.push(cookie);
+//     }
+//     await context.playContext.addCookies(cookies);
+//   }
+// };
+
+const closeBrowser = async function (browser? :Browser|PlaywrightBrowser) {
+  await browserManager.closeBrowser(browser);
+};
+
+const initEnvironment = function () {
+  // if (environment === null) {
+    const environment = new Environment();
+    try {
+      const data = fs.readFileSync("env.json", "utf8");
+      //console.log("data", data);
+      const envObject = JSON.parse(data);
+      //console.log("envObject", envObject);
+      Object.assign(environment, envObject);
+      //console.log("env", environment);
+      console.log("Base url: " + environment.baseUrl);
+    } catch (err) {
+      console.error("Error reading env.json", err);
+    }
+  // }
+  return environment;
+};
+
+export { getContext, closeBrowser };