@checksum-ai/runtime 1.0.6 → 1.0.7

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@checksum-ai/runtime",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "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-cs": "npm:@playwright/test@1.37.0"
   },
   "repository": {
     "type": "git",

package/postinstall.js

@@ -7,8 +7,13 @@ try {
   const packageJsonPath = path.join(process.cwd(), "package.json");
   const packageJson = JSON.parse(fs.readFileSync(packageJsonPath));
 
+  // verify that the package.json has a scripts section
+  if (!packageJson.scripts) {
+    packageJson.scripts = {};
+  }
+
   packageJson.scripts["checksum"] =
-    "node ./node_modules/@checksum-ai/runtime/cli.js";
+    "ts-node --esm --skipIgnore ./node_modules/@checksum-ai/runtime/cli.ts";
 
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 } catch (e) {
@@ -19,7 +24,7 @@ try {
 (async () => {
   try {
     console.log("Installing checksum files and folders");
-    await execCmd("npm run checksum install");
+    await execCmd("npm run checksum init");
   } catch (e) {
     console.log("Failed installing checksum files and folders, ", e);
     process.exit(1);

package/types.ts

@@ -0,0 +1,58 @@
+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;
+};