@checksum-ai/runtime 1.0.8 → 1.0.10

package/cli.js

@@ -0,0 +1,19 @@
+var m=Object.create;var p=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var w=Object.getPrototypeOf,y=Object.prototype.hasOwnProperty;var k=(c,t,e,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of C(t))!y.call(c,o)&&o!==e&&p(c,o,{get:()=>t[o],enumerable:!(s=f(t,o))||s.enumerable});return c};var P=(c,t,e)=>(e=c!=null?m(w(c)):{},k(t||!c||!c.__esModule?p(e,"default",{value:c,enumerable:!0}):e,c));var n=require("fs"),l=P(require("child_process")),r=require("path");var d="checksum";var g=class{constructor(){this.UPLOAD_AGENT_PATH=(0,r.join)(__dirname,"upload-agent.js");this.CHECKSUM_API_URL="http://localhost:3000";this.didFail=!1;this.mock=!0;this.completeIndicators={upload:!1,tests:!1,report:!1};this.guardReturn=async(t,e=1e3,s="action hang guard timed out")=>{let o="guard-timed-out",i=async()=>(await this.awaitSleep(e+1e3),o),a=await Promise.race([t,i()]);if(typeof a=="string"&&a===o)throw new Error(s);return a};this.awaitSleep=t=>new Promise(e=>setTimeout(e,t))}async execute(){var t;switch(process.argv[2]){case"init":this.install();break;case"test":if(((t=process.argv)==null?void 0:t[3])==="--help"){await this.printHelp("test");break}await this.test(process.argv.slice(3));break;case"show-report":this.showReport(process.argv.slice(3));break;default:await this.printHelp()}process.exit(0)}async execCmd(t){let e=await l.spawn(t,{shell:!0,stdio:"inherit"});return new Promise((o,i)=>{e.on("exit",a=>{a===0?o(!0):i(new Error(`Checsum failed execution with code: ${a} `))})})}async getCmdOutput(t){return new Promise(function(e,s){l.exec(t,(o,i,a)=>{if(o){s(`Error executing command: ${o.message}`);return}e(i)})})}async printHelp(t){switch(t){default:console.log(`
+Checksum CLI
+Usage: checksum [command] [options]
+
+Commands:
+init                            installs checksum files and folders
+test [options] [test-filter...] runs checksum tests
+help                            prints this help message
+show-report [options] [report]  show HTML report
+`);break;case"test":try{let e="npx playwright test --help",s=(await this.getCmdOutput(e)).replace(/npx playwright/g,"yarn checksum").split(`
+`);s.splice(5,0,"  --checksum-config=<config>   Checksum configuration in JSON format").join(`
+`),console.log(s.join(`
+`))}catch(e){console.log("Error",e.message)}break}}async showReport(t){let e=`npx playwright show-report ${t.join(" ")}`;try{await this.execCmd(e)}catch(s){console.log("Error showing report",s.message)}}async test(t){t=this.getChecksumConfigFromCommand(t),this.setChecksumConfig(),await this.getSession();let e;try{let{uuid:o,uploadURL:i}=this.testSession;e=await this.guardReturn(this.startUploadAgent(o,i),1e4,"Upload agent timeout")}catch{console.log("Error starting upload agent. Test results will not be available on checksum.")}this.buildVolatileConfig();let s=`${e?`CHECKSUM_UPLOAD_AGENT_PORT=${e} `:""} PWDEBUG=console npx playwright test --config ${this.getPlaywrightConfigFile()} ${t.join(" ")}`;try{await this.execCmd(s)}catch(o){this.didFail=!0,console.log("Error during test",o.message)}finally{let o=this.getPlaywrightReportPath();(0,n.existsSync)(o)?this.uploadAgent.stdin.write(`cli:report=${o}`):console.log(`Could not find report file at ${o}`),this.completeIndicators.tests=!0,await this.handleCompleteMessage()}}getPlaywrightReportPath(){var o,i;let t=(0,r.join)(process.cwd(),"playwright-report"),e=require(this.getPlaywrightConfigFile()),{reporter:s}=e;return s instanceof Array&&s.length>1&&((o=s[1])!=null&&o.outputFolder)&&(t=(i=s[1])==null?void 0:i.outputFolder),process.env.PLAYWRIGHT_HTML_REPORT&&(t=process.env.PLAYWRIGHT_HTML_REPORT),(0,r.join)(t,"index.html")}getPlaywrightConfigFile(){return(0,r.join)(this.getRootDirPath(),"playwright.config.ts")}startUploadAgent(t,e){return new Promise((s,o)=>{console.log("Starting upload agent"),this.uploadAgent=l.spawn("node",[this.UPLOAD_AGENT_PATH,JSON.stringify({sessionId:t,checksumApiURL:this.CHECKSUM_API_URL,apiKey:this.config.apiKey}),...this.mock?["mock"]:[]]),this.uploadAgent.stdout.on("data",i=>{let a=i.toString().trim();if(!a.startsWith("upag:"))return;let[u,h]=a.substring(5).split("=");u==="port"?(console.log("Received port from upload agent",h),s(h)):this.handleUploadAgentMessage(u,h)}),this.uploadAgent.on("exit",(i,a)=>{console.log(`upload agent process exited with code ${i} and signal ${a}`)}),this.uploadAgent.on("error",i=>{console.error(`Error starting upload agent: ${i.message}`)})})}async handleUploadAgentMessage(t,e){switch(t){case"complete":this.sendUploadsComplete().then(()=>{this.completeIndicators.upload=!0});break;case"report-uploaded":let s=await this.sendTestrunEnd();this.completeIndicators.report=!0,s&&console.log(`*******************
+* Checksum report URL: ${s}
+*******************`);break;default:console.warn(`Unhandled upload agent message: ${t}=${e}`)}}async handleCompleteMessage(){for(;;)Object.keys(this.completeIndicators).find(t=>!this.completeIndicators[t])?await this.awaitSleep(1e3):(console.log("Tests complete"),this.shutdown(this.didFail?1:0))}shutdown(t=0){this.cleanup(),process.exit(t)}buildVolatileConfig(){if(!this.volatileChecksumConfig)return;let t=this.getVolatileConfigPath(),e=`
+    import { RunMode, getChecksumConfig } from "@checksum-ai/runtime";
+    
+    export default getChecksumConfig(${JSON.stringify(this.config,null,2)});
+    `;(0,n.writeFileSync)(t,e)}cleanup(){this.deleteVolatileConfig(),this.uploadAgent.stdin.write("cli:shutdown"),this.uploadAgent.kill()}async getSession(){try{if(this.mock){this.testSession={uuid:"session-id-1234",uploadURL:"http://localhost:3000/upload"};return}let t=this.config.apiKey;(!t||t==="<API key>")&&(console.error("No API key found in checksum config"),this.shutdown(1));let e=JSON.stringify(await this.getEnvInfo()),s=await fetch(`${this.CHECKSUM_API_URL}/client-api/test-runs`,{method:"POST",headers:{Accept:"application/json","Content-Type":"application/json",ChecksumAppCode:t},body:e});this.testSession=await s.json()}catch(t){console.error("Error getting checksum test session",t),this.shutdown(1)}}async sendTestrunEnd(){try{if(this.mock)return"https://mock.report.url";let{uuid:t}=this.testSession,e=JSON.stringify({failed:this.didFail?1:0,passed:0,healed:0,endedAt:Date.now()}),{reportURL:s}=await this.updateTestRun(`${this.CHECKSUM_API_URL}/client-api/test-runs/${t}`,"PATCH",e);return s}catch(t){return console.log("Error sending test run end",t.message),null}}async sendUploadsComplete(){if(!this.mock)try{let{uuid:t}=this.testSession;await this.updateTestRun(`${this.CHECKSUM_API_URL}/client-api/test-runs/${t}/uploads-completed`,"PATCH")}catch(t){console.log("Error sending test run uploads complete",t.message)}}async updateTestRun(t,e,s=void 0){return(await fetch(t,{method:e,headers:{Accept:"application/json","Content-Type":"application/json",ChecksumAppCode:this.config.apiKey},body:s})).json()}async getEnvInfo(){let t={commitHash:"",branch:"branch",environment:process.env.CI?"CI":"local",name:"name",startedAt:Date.now()};try{t.commitHash=(await this.getCmdOutput("git rev-parse HEAD")).toString().trim()}catch(e){console.log("Error getting git hash",e.message)}try{t.branch=(await this.getCmdOutput("git rev-parse --abbrev-ref HEAD")).toString().trim()}catch(e){console.log("Error getting branch name",e.message)}return t}getVolatileConfigPath(){return(0,r.join)(this.getRootDirPath(),"checksum.config.tmp.ts")}deleteVolatileConfig(){let t=this.getVolatileConfigPath();(0,n.existsSync)(t)&&(0,n.rmSync)(t)}setChecksumConfig(){this.config={...require((0,r.join)(this.getRootDirPath(),"checksum.config.ts")).default||{},...this.volatileChecksumConfig||{}}}getChecksumConfigFromCommand(t){this.deleteVolatileConfig();for(let e of t)if(e.startsWith("--checksum-config"))try{return this.volatileChecksumConfig=JSON.parse(e.split("=")[1]),t.filter(s=>s!==e)}catch(s){console.log("Error parsing checksum config",s.message),this.volatileChecksumConfig=void 0}return t}install(){console.log("Creating Checksum directory and necessary files to run your tests");let t=this.getRootDirPath();if((0,n.existsSync)(this.getRootDirPath())||(0,n.mkdirSync)(t),!(0,n.existsSync)(this.getChecksumRootOrigin()))throw new Error("Could not find checksum root directory, please install @checksum-ai/runtime package");["checksum.config.ts","playwright.config.ts","login.ts","README.md"].forEach(e=>{(0,n.copyFileSync)((0,r.join)(this.getChecksumRootOrigin(),e),(0,r.join)(t,e))}),(0,n.mkdirSync)((0,r.join)(t,"tests"),{recursive:!0}),["esra","har","trace","log"].forEach(e=>{(0,n.mkdirSync)((0,r.join)(t,"test-data",e),{recursive:!0})})}getRootDirPath(){return(0,r.join)(process.cwd(),d)}getChecksumRootOrigin(){return(0,r.join)(process.cwd(),"node_modules","@checksum-ai","runtime","checksum-root")}};(async()=>await new g().execute())();

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@checksum-ai/runtime",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "Checksum.ai test runtime",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "playwright-test-cs": "npm:@playwright/test@1.37.0"
+    "@playwright/test": "1.37.0",
+    "ts-node": "^10.9.1"
   },
   "repository": {
     "type": "git",

package/postinstall.js

@@ -13,7 +13,7 @@ try {
   }
 
   packageJson.scripts["checksum"] =
-    "ts-node --esm --skipIgnore ./node_modules/@checksum-ai/runtime/cli.ts";
+    "ts-node --esm --skipIgnore ./node_modules/@checksum-ai/runtime/cli.js";
 
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 } catch (e) {

package/cli.ts

@@ -1,599 +0,0 @@
-import { copyFileSync, existsSync, mkdirSync, rmSync, writeFileSync } from "fs";
-import * as childProcess from "child_process";
-import { join } from "path";
-import {
-  CHECKSUM_ROOT_FOLDER,
-  ChecksumConfig,
-  TestSuiteSession,
-} from "./types";
-
-class ChecksumCLI {
-  private readonly UPLOAD_AGENT_PATH = join(__dirname, "upload-agent.js");
-  private readonly CHECKSUM_API_URL = "http://localhost:3000";
-
-  private testSession: TestSuiteSession;
-  private volatileChecksumConfig;
-  private uploadAgent;
-  private config: ChecksumConfig;
-
-  private didFail = false;
-  private mock = true;
-
-  private completeIndicators = {
-    upload: false,
-    tests: false,
-    report: false,
-  };
-
-  constructor() {}
-
-  // rename install to init
-  // rename run to test
-  // rename import of playwright to our alias
-  async execute() {
-    switch (process.argv[2]) {
-      case "init":
-        this.install();
-        break;
-      case "test":
-        if (process.argv?.[3] === "--help") {
-          await this.printHelp("test");
-          break;
-        }
-        await this.test(process.argv.slice(3));
-        break;
-      case "show-report":
-        this.showReport(process.argv.slice(3));
-        break;
-      default:
-        // should we simply forward to playwright in default case?
-        await this.printHelp();
-    }
-    process.exit(0);
-  }
-
-  async execCmd(cmdString) {
-    const child = await childProcess.spawn(cmdString, {
-      shell: true,
-      stdio: "inherit",
-    });
-
-    const exitPromise = new Promise((resolve, reject) => {
-      child.on("exit", (code) => {
-        if (code === 0) {
-          resolve(true);
-        } else {
-          reject(new Error(`Checsum failed execution with code: ${code} `));
-        }
-      });
-    });
-
-    return exitPromise;
-  }
-
-  async getCmdOutput(cmdString): Promise<string> {
-    return new Promise<string>(function (resolve, reject) {
-      childProcess.exec(cmdString, (error, stdout, stderr) => {
-        if (error) {
-          reject(`Error executing command: ${error.message}`);
-          return;
-        }
-
-        resolve(stdout);
-      });
-    });
-
-    // return promise;
-  }
-
-  async printHelp(command?: string) {
-    switch (command) {
-      default:
-        console.log(`
-Checksum CLI
-Usage: checksum [command] [options]
-
-Commands:
-init                            installs checksum files and folders
-test [options] [test-filter...] runs checksum tests
-help                            prints this help message
-show-report [options] [report]  show HTML report
-`);
-        break;
-      case "test":
-        try {
-          const cmd = `npx playwright test --help`;
-          const testHelp = (await this.getCmdOutput(cmd))
-            .replace(/npx playwright/g, "yarn checksum")
-            .split("\n");
-          testHelp
-            .splice(
-              5,
-              0,
-              "  --checksum-config=<config>   Checksum configuration in JSON format"
-            )
-            .join("\n");
-          console.log(testHelp.join("\n"));
-        } catch (e) {
-          console.log("Error", e.message);
-        }
-
-        break;
-    }
-  }
-
-  async showReport(args: string[]) {
-    const cmd = `npx playwright show-report ${args.join(" ")}`;
-
-    try {
-      await this.execCmd(cmd);
-    } catch (e) {
-      console.log("Error showing report", e.message);
-    }
-  }
-
-  async test(args: string[]) {
-    // check for checksum config in command
-    args = this.getChecksumConfigFromCommand(args);
-
-    // load checksum config
-    this.setChecksumConfig();
-
-    // init new test session
-    await this.getSession();
-
-    // start upload agent
-    let uploadAgentListeningPort;
-    try {
-      const { uuid, uploadURL } = this.testSession;
-      // load upload agent, timout after 20 seconds
-      uploadAgentListeningPort = await this.guardReturn(
-        this.startUploadAgent(uuid, uploadURL),
-        10_000,
-        "Upload agent timeout"
-      );
-    } catch (e) {
-      console.log(
-        "Error starting upload agent. Test results will not be available on checksum."
-      );
-    }
-
-    // write volatile config if set
-    this.buildVolatileConfig();
-
-    // build shell command
-    const cmd = `${
-      uploadAgentListeningPort
-        ? `CHECKSUM_UPLOAD_AGENT_PORT=${uploadAgentListeningPort} `
-        : ""
-    } PWDEBUG=console npx playwright test --config ${this.getPlaywrightConfigFile()} ${args.join(
-      " "
-    )}`;
-
-    try {
-      // run tests
-      await this.execCmd(cmd);
-    } catch (e) {
-      this.didFail = true;
-      console.log("Error during test", e.message);
-    } finally {
-      const reportFile = this.getPlaywrightReportPath();
-      if (!existsSync(reportFile)) {
-        console.log(`Could not find report file at ${reportFile}`);
-      } else {
-        this.uploadAgent.stdin.write(`cli:report=${reportFile}`);
-      }
-      // upload report
-      this.completeIndicators.tests = true;
-      await this.handleCompleteMessage();
-    }
-  }
-
-  getPlaywrightReportPath() {
-    // default path
-    let reportFolder = join(process.cwd(), "playwright-report");
-    // check for playwright report path in config file
-    // for now, ignore cases of multiple reporters
-    const playwrightConfig = require(this.getPlaywrightConfigFile());
-    const { reporter } = playwrightConfig;
-    if (
-      reporter instanceof Array &&
-      reporter.length > 1 &&
-      reporter[1]?.outputFolder
-    ) {
-      reportFolder = reporter[1]?.outputFolder;
-    }
-
-    // check for env variable
-    if (process.env.PLAYWRIGHT_HTML_REPORT) {
-      reportFolder = process.env.PLAYWRIGHT_HTML_REPORT;
-    }
-
-    return join(reportFolder, "index.html");
-  }
-
-  getPlaywrightConfigFile() {
-    return join(this.getRootDirPath(), "playwright.config.ts");
-  }
-
-  startUploadAgent(sessionId: string, uploadURL: string) {
-    return new Promise((resolve, reject) => {
-      console.log("Starting upload agent");
-      this.uploadAgent = childProcess.spawn("node", [
-        this.UPLOAD_AGENT_PATH,
-        JSON.stringify({
-          sessionId,
-          checksumApiURL: this.CHECKSUM_API_URL,
-          apiKey: this.config.apiKey,
-        }),
-        ...(this.mock ? ["mock"] : []),
-      ]);
-
-      // Listen for messages from the upload agent
-      this.uploadAgent.stdout.on("data", (data) => {
-        const message = data.toString().trim();
-
-        // if not a formatted message from upload agent - ignore
-        if (!message.startsWith("upag:")) {
-          //   console.log(`Message from upload agent: ${message}`); // remove
-          return;
-        }
-
-        const [key, value] = message.substring(5).split("=");
-        if (key === "port") {
-          console.log("Received port from upload agent", value);
-          resolve(value);
-        } else {
-          this.handleUploadAgentMessage(key, value);
-        }
-      });
-
-      // Handle exit event
-      this.uploadAgent.on("exit", (code, signal) => {
-        console.log(
-          `upload agent process exited with code ${code} and signal ${signal}`
-        );
-      });
-
-      // Handle errors
-      this.uploadAgent.on("error", (err) => {
-        console.error(`Error starting upload agent: ${err.message}`);
-      });
-    });
-  }
-
-  private async handleUploadAgentMessage(key: any, value: any) {
-    switch (key) {
-      case "complete":
-        // console.log("Received upload complete message from upload agent");
-        this.sendUploadsComplete().then(() => {
-          this.completeIndicators.upload = true;
-        });
-        break;
-      case "report-uploaded":
-        // console.log("Received report uploaded message from upload agent");
-        const reportURL = await this.sendTestrunEnd();
-        this.completeIndicators.report = true;
-        if (reportURL) {
-          console.log(
-            `*******************\n* Checksum report URL: ${reportURL}\n*******************`
-          );
-        }
-        break;
-
-      default:
-        console.warn(`Unhandled upload agent message: ${key}=${value}`);
-    }
-  }
-
-  async handleCompleteMessage() {
-    while (true) {
-      if (
-        Object.keys(this.completeIndicators).find(
-          (key) => !this.completeIndicators[key]
-        )
-      ) {
-        await this.awaitSleep(1000);
-      } else {
-        console.log("Tests complete");
-        this.shutdown(this.didFail ? 1 : 0);
-      }
-    }
-  }
-
-  shutdown(code = 0) {
-    this.cleanup();
-    process.exit(code);
-  }
-
-  buildVolatileConfig() {
-    // if no volatile config set - return
-    if (!this.volatileChecksumConfig) {
-      return;
-    }
-
-    const configPath = this.getVolatileConfigPath();
-    const configString = `
-    import { RunMode, getChecksumConfig } from "@checksum-ai/runtime";
-    
-    export default getChecksumConfig(${JSON.stringify(this.config, null, 2)});
-    `;
-
-    writeFileSync(configPath, configString);
-  }
-
-  cleanup() {
-    this.deleteVolatileConfig();
-    this.uploadAgent.stdin.write("cli:shutdown");
-    this.uploadAgent.kill();
-  }
-
-  async getSession() {
-    try {
-      if (this.mock) {
-        this.testSession = {
-          uuid: "session-id-1234",
-          uploadURL: "http://localhost:3000/upload",
-        };
-        return;
-      }
-
-      const apiKey = this.config.apiKey;
-      if (!apiKey || apiKey === "<API key>") {
-        console.error("No API key found in checksum config");
-        this.shutdown(1);
-      }
-
-      const body = JSON.stringify(await this.getEnvInfo());
-      const res = await fetch(`${this.CHECKSUM_API_URL}/client-api/test-runs`, {
-        method: "POST",
-        headers: {
-          Accept: "application/json",
-          "Content-Type": "application/json",
-          ChecksumAppCode: apiKey,
-        },
-        body,
-      });
-
-      this.testSession = await res.json();
-    } catch (e) {
-      console.error("Error getting checksum test session", e);
-      this.shutdown(1);
-    }
-  }
-
-  async sendTestrunEnd() {
-    try {
-      if (this.mock) {
-        return "https://mock.report.url";
-      }
-      const { uuid: id } = this.testSession;
-      const body = JSON.stringify({
-        failed: this.didFail ? 1 : 0,
-        passed: 0,
-        healed: 0,
-        endedAt: Date.now(),
-      });
-
-      const { reportURL } = await this.updateTestRun(
-        `${this.CHECKSUM_API_URL}/client-api/test-runs/${id}`,
-        "PATCH",
-        body
-      );
-      return reportURL;
-    } catch (e) {
-      console.log("Error sending test run end", e.message);
-      return null;
-    }
-  }
-
-  async sendUploadsComplete() {
-    if (this.mock) {
-      return;
-    }
-    try {
-      const { uuid: id } = this.testSession;
-
-      await this.updateTestRun(
-        `${this.CHECKSUM_API_URL}/client-api/test-runs/${id}/uploads-completed`,
-        "PATCH"
-      );
-    } catch (e) {
-      console.log("Error sending test run uploads complete", e.message);
-    }
-  }
-
-  /**
-   * Sends update to the test run API
-   *
-   * @param url API endpoint
-   * @param method HTTP method
-   * @param body request body
-   * @returns JSON response from API
-   */
-  async updateTestRun(
-    url: string,
-    method: string,
-    body: string | undefined = undefined
-  ) {
-    const res = await fetch(url, {
-      method,
-      headers: {
-        Accept: "application/json",
-        "Content-Type": "application/json",
-        ChecksumAppCode: this.config.apiKey,
-      },
-      body,
-    });
-
-    return res.json();
-  }
-
-  async getEnvInfo() {
-    const info = {
-      commitHash: "",
-      branch: "branch",
-      environment: process.env.CI ? "CI" : "local",
-      name: "name",
-      startedAt: Date.now(),
-    };
-
-    try {
-      info.commitHash = (await this.getCmdOutput(`git rev-parse HEAD`))
-        .toString()
-        .trim();
-    } catch (e) {
-      console.log("Error getting git hash", e.message);
-    }
-
-    try {
-      info.branch = (await this.getCmdOutput(`git rev-parse --abbrev-ref HEAD`))
-        .toString()
-        .trim();
-    } catch (e) {
-      console.log("Error getting branch name", e.message);
-    }
-
-    return info;
-  }
-
-  getVolatileConfigPath() {
-    return join(this.getRootDirPath(), "checksum.config.tmp.ts");
-  }
-
-  deleteVolatileConfig() {
-    const configPath = this.getVolatileConfigPath();
-    if (existsSync(configPath)) {
-      rmSync(configPath);
-    }
-  }
-
-  setChecksumConfig() {
-    this.config = {
-      ...(require(join(this.getRootDirPath(), "checksum.config.ts")).default ||
-        {}),
-      ...(this.volatileChecksumConfig || {}),
-    };
-  }
-
-  /**
-   * Search for checksum config in the command arguments.
-   * If found, parse and remove from args.
-   *
-   * @param args arguments passed to the command
-   * @returns args without checksum config
-   */
-  getChecksumConfigFromCommand(args) {
-    // delete any old config if exists
-    this.deleteVolatileConfig();
-
-    for (const arg of args) {
-      if (arg.startsWith("--checksum-config")) {
-        try {
-          this.volatileChecksumConfig = JSON.parse(arg.split("=")[1]);
-          return args.filter((a) => a !== arg);
-        } catch (e) {
-          console.log("Error parsing checksum config", e.message);
-          this.volatileChecksumConfig = undefined;
-        }
-      }
-    }
-
-    return args;
-  }
-
-  install() {
-    console.log(
-      "Creating Checksum directory and necessary files to run your tests"
-    );
-
-    const checksumRoot = this.getRootDirPath();
-
-    if (!existsSync(this.getRootDirPath())) {
-      mkdirSync(checksumRoot);
-    }
-
-    if (!existsSync(this.getChecksumRootOrigin())) {
-      throw new Error(
-        "Could not find checksum root directory, please install @checksum-ai/runtime package"
-      );
-
-      // automatically install?
-    }
-
-    // copy sources
-    [
-      "checksum.config.ts",
-      "playwright.config.ts",
-      "login.ts",
-      "README.md",
-    ].forEach((file) => {
-      copyFileSync(
-        join(this.getChecksumRootOrigin(), file),
-        join(checksumRoot, file)
-      );
-    });
-
-    // create tests folder
-    mkdirSync(join(checksumRoot, "tests"), {
-      recursive: true,
-    });
-
-    // create test data directories
-    ["esra", "har", "trace", "log"].forEach((folder) => {
-      mkdirSync(join(checksumRoot, "test-data", folder), {
-        recursive: true,
-      });
-    });
-  }
-
-  getRootDirPath() {
-    return join(process.cwd(), CHECKSUM_ROOT_FOLDER);
-  }
-
-  getChecksumRootOrigin() {
-    return join(
-      process.cwd(),
-      "node_modules",
-      "@checksum-ai",
-      "runtime",
-      "checksum-root"
-    );
-  }
-
-  /**
-   * Adds a timeout limit for a promise to resolve
-   * Will throw an error if the promise does not resolve within the timeout limit
-   *
-   * @param promise promise to add timeout to
-   * @param timeout timeout in milliseconds
-   * @param errMessage error message to throw if timeout is reached
-   * @returns promise that resolves if the original promise resolves within the timeout limit
-   */
-  guardReturn = async (
-    promise,
-    timeout = 1_000,
-    errMessage = "action hang guard timed out"
-  ) => {
-    const timeoutStringIdentifier = "guard-timed-out";
-    const guard = async () => {
-      await this.awaitSleep(timeout + 1_000);
-      return timeoutStringIdentifier;
-    };
-
-    const res = await Promise.race([promise, guard()]);
-    if (typeof res === "string" && res === timeoutStringIdentifier) {
-      throw new Error(errMessage);
-    }
-    return res;
-  };
-
-  awaitSleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-}
-
-/**
- * Trigger the main function
- */
-(async () => {
-  await new ChecksumCLI().execute();
-})();

package/types.ts

@@ -1,58 +0,0 @@
-import { Page } from "@playwright/test";
-
-/**
- * Checksum runtime root folder
- */
-export const CHECKSUM_ROOT_FOLDER = "checksum";
-
-/**
- * Checksum runtime running mode -
- * normal -   tests run normally
- * heal -     checksum will attempt to heal tests that failed using fallback
- * refactor - checksum will attempt to refactor and improve your tests
- */
-export enum RunMode {
-  Normal = "normal",
-  Heal = "heal",
-  Refactor = "refactor",
-}
-
-export interface IChecksumPage extends Page {
-  initWithTest: (testInfo) => Promise<void>;
-  checksumId: (id: string) => IChecksumPage;
-  checksumStep: (thought: string, testFunction?: () => void) => IChecksumPage;
-  testId: (testId: string) => void;
-}
-
-export type RuntimeOptions = {
-  /**
-   * fallback to ESRA if the action selector is not found
-   */
-  actionsESRAfallback: boolean;
-  actionsLLMFallback: boolean; // use LLM fallback if action selector is not found
-  //   actionsChangeSelectors: boolean; // change the selector of the action if found better match
-  //   existingAssertionsESRAfallback: boolean; // fallback to ESRA if the existing assertion selector is not found
-  //   existingAssertionsChangeSelectors: boolean; // change the selector of existing assertion if found better match
-  newAssertionsEnabled: boolean; // add new assertions
-  writeTraceFile: boolean; // saves trace file at the end of the test
-  useMockData: boolean; // use mocked data
-  printLogs: boolean; // print logs to console
-};
-
-export type ChecksumConfig = {
-  runMode: RunMode;
-  apiKey: string;
-  baseURL: string;
-  username?: string;
-  password?: string;
-  options?: RuntimeOptions;
-
-  apiURL: string;
-  uploadAgentHOST: string;
-  uploadAgentPort: number;
-};
-
-export type TestSuiteSession = {
-  uuid: string;
-  uploadURL: string;
-};