checksumai 1.0.16 → 1.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "checksumai",
-  "version": "1.0.16",
+  "version": "1.1.4",
   "description": "Checksum.ai runtime base package",
   "main": "./run.js",
   "type": "module",
@@ -11,7 +11,7 @@
     "checksumai": "run.js"
   },
   "dependencies": {
-    "@checksum-ai/runtime": "^1.0.69",
+    "@checksum-ai/runtime": "1.1.4",
     "ts-node": "^10.9.1"
   },
   "repository": {

package/run.js

@@ -2,4 +2,4 @@
 
 import cli from "@checksum-ai/runtime/cli.js";
 
-console.log("Running checksum..");
+console.log("Running Checksum...");

package/checksum/README.md

@@ -1,65 +0,0 @@
-# Checksum.ai Tests
-
-## Quick Start
-
-1. Run `npm install -D checksumai`.
-2. Navigate to the directory where you want to add Checksum tests and run `npx checksumai init`.
-3. Run `npx playwright install --with-deps` to install Playwright dependencies.
-4. Edit `checksum.config.ts` to include necessary configurations such as:
-   - `apiKey`
-   - `baseURL`
-   - `username`
-   - `password`
-5. Update `login.ts` with your login function using Playwright. See the Login Function section below for guidance.
-6. Run `npx checksumai test` to execute the example test and verify successful login.
-7. If you haven't already, visit [app.checksum.ai](https://app.checksum.ai) to complete the configuration and generate a test. Then, wait for the pull request (PR) to be created and approve it.
-
-## Login Function
-
-1. This function is executed at the start of each test.
-2. We recommend using a consistent seeded user for every test. For example, before each test, call a webhook that creates a user, seeds it with data, and returns the username and password. This approach ensures test reliability and allows parallel test execution. Configure this webhook [in your project](https://app.checksum.ai/#/settings/wizard) for consistent test generation.
-3. After logging in, assert that the login was successful. Playwright waits for assertions to be correct, ensuring that the page is ready for interaction before proceeding.
-4. To reuse authentication states between tests, refer to the Playwright guide on [authentication](https://playwright.dev/docs/auth). At the start of the login function, check if the user is already authenticated and return if so.
-
-## Checksum AI Magic
-
-The tests generated by Checksum are based on Playwright. When executed using the Checksum CLI with an API key, Checksum enhances Playwright's functionality, improving test reliability and automatically maintaining tests.
-
-### Autonomous Test Agent
-
-Checksum runs your Playwright tests regularly, but we added a few extra features to make tests more reliable. All of the features can be turned on/off through `checksum.config.ts`
-
-**Smart Selectors**
-When generating tests, Checksum stores extensive metadata for each action (see the `test-data` folder). If a traditional selector fails, this metadata is used for correction. For example, if a test identifies an element by its ID but the ID changes, Checksum utilizes other data points (e.g., element class, text, parents) to locate the element. Use the `checksumSelector("<id>")` method to link an action to its metadata. Do not alter the IDs.
-
-**Checksum AI**
-If Smart Selectors also fail, Checksum's custom-trained model can regenerate the failed section of the test. In such cases, the model might add, remove, or alter actions to achieve the same objectives, without changing the assertions. The assumption is that as long as the assertions pass, the model has successfully fixed the test. Use the `.checksumAI("<natural language description of the test>")` method to guide the model in fixing the test.
-
-You can modify the description as needed for our model. Additionally, you can include steps with only ChecksumAI descriptions, prompting our model to generate the Playwright code. For example, `await page.checksumAI("Click on 'New Task' button")` without the actual action will have our model generate the necessary Playwright code. You can even author entire tests in this manner.
-
-### Run Modes
-
-Checksum offers three run modes:
-
-1. **Normal** - Tests are executed using the Autonomous Test Agent as defined in the config file.
-2. **Heal** - If the Autonomous Test Agent corrects a test, a new test file with the fix is created. By default, this file is created locally, but you can also configure the Agent to open a PR to your GitHub repository by setting `autoHealPRs` to true.
-3. **Refactor (Work in Progress)** - The Autonomous Test Agent runs the test and, for each action, regenerates a regular Playwright selector, a Smart Selector, and a Checksum AI description.
-
-### Mock Data
-
-When generating tests, Checksum records all backend responses, allowing tests to run in the same backend context. This is particularly useful for debugging or initial test runs, especially if your testing database/context differs from that used for test generation. Note that if your backend response format changes, the mocked data may not work as expected.
-
-### CLI Commands
-
-1. `init` - Initialize the Checksum directory and configurations.
-2. `test` - Run Checksum tests. Accepts all [Playwright command line flags](https://playwright.dev/docs/test-cli). To override `checksum.config.ts`, pass full or partial JSON as a string, e.g., `--checksum-config='{"baseURL": "https://example.com"}'`.
-
-## Running with GitHub Actions
-
-See the example file `github-actions.example.yml`.
-
-## Troubleshooting
-
-**Q: I'm seeing various exceptions when I run "npx checksumai test", even before the test starts.**
-
-A: If you had a pre-installed version of Playwright, it might not be compatible with Checksum. Uninstall the Playwright and Checksum libraries, delete the relevant folder from `node_modules`, and run `npm install -D checksumai`.

package/checksum/checksum.config.ts

@@ -1,54 +0,0 @@
-import { RunMode, getChecksumConfig } from "@checksum-ai/runtime";
-
-export default getChecksumConfig({
-  /**
-   * Checksum Run mode. See Readme for more info
-   */
-  runMode: RunMode.Normal,
-
-  /**
-   * Insert here your Checksum API key. You can find it in https://app.checksum.ai/#/settings/
-   */
-  apiKey: "<API key>",
-
-  /**
-   * This is the base URL of the tested app. E.g. https://example.com. URLs in the tests will be relative to the base URL.
-   */
-  baseURL: "<base URL>",
-
-  /**
-   * Insert the account's username that will be used
-   * to login into your testing environment
-   */
-    username: "<username>",
-
-    /**
-     * Insert the account's password that will be used
-     * to login into your testing environment
-     */
-    password: "<password>",
-
-  options: {
-    /**
-     * Whether to use Checksum Smart Selector when an action fails (see README)
-     */
-    useChecksumSelectors: true,
-    /**
-     * Whether to use Checksum AI when an action fails (see README)
-     */
-    useChecksumAI: true,
-    /**
-     * Whether to use mock API data when running your tests (see README)
-     */
-    useMockData: false,
-    /**
-     * Whether to Upload HTML test reports to app.checksum.ai so they can be viewed through the UI. Only relevant if Playwright reporter config is set to HTML
-     * Reports will be saved locally either way (according to Playwright Configs) and can be viewed using the CLI command show-reports.
-     */
-    hostReports: !!process.env.CI,
-    /**
-     * Whether to create a PR with healed tests. Only relevant when in Heal mode.
-     */
-    autoHealPRs: !!process.env.CI,
-  },
-});

package/checksum/example.checksum.spec.ts

@@ -1,18 +0,0 @@
-/* Checksum.ai autogenerated test */
-import { test as base, expect } from "@playwright/test";
-import { init, IChecksumPage } from "@checksum-ai/runtime";
-
-const { test, defineChecksumTest, login } = init(base);
-
-test.describe("Example test", () => {
-  test.beforeEach(async ({ page }: { page: IChecksumPage }) => {
-    await login(page);
-  });
-
-  test(
-    defineChecksumTest("Navigate to home page", "GPzdp"),
-    async ({ page }) => {
-      await page.goto("/");
-    }
-  );
-});

package/checksum/login.ts

@@ -1,32 +0,0 @@
-import { ChecksumConfig, IChecksumPage } from "@checksum-ai/runtime";
-import { expect, request } from "@playwright/test";
-
-export default async function login(
-  page: IChecksumPage,
-  config: ChecksumConfig
-) {
-  /**
-   * This code provides examples of how to write functions for different login scenarios.
-   * See README for more details
-   *
-   * Example with Seed Function:
-   */
-  // const apiContext = await request.newContext();
-  // const response = await apiContext.get("https://example.com/createseed");
-  // const { username, password } = await response.json();
-  // await page.goto("/login");
-  // await page.getByPlaceholder("Email...").fill(process.env.username);
-  // await page.getByPlaceholder("Password...").fill(process.env.password);
-  // await page.getByText("Login").click();
-  // await expect(page.getByText("Login Successful")).toBeVisible();
-
-  /**
-   * Example with Default Username and Password:
-   * This example demonstrates how to log in to a page using a predefined username and password from a config file.
-   */
-  // await page.goto("/login");
-  // await page.getByPlaceholder("Email...").fill(config.username);
-  // await page.getByPlaceholder("Password...").fill(config.password);
-  // await page.getByText("Login").click();
-  // await expect(page.getByText("Login Successful")).toBeVisible();
-}

package/checksum/playwright.config.ts

@@ -1,64 +0,0 @@
-import { defineConfig, devices } from "@playwright/test";
-
-/**
- * Read environment variables from file.
- * https://github.com/motdotla/dotenv
- */
-require("dotenv").config();
-
-/**
- * See https://playwright.dev/docs/test-configuration.
- */
-export default defineConfig({
-  testDir: "..",
-  /* Set test timeout to 10 minutes (relatively long) as Checksum implements its own timeout mechanism */
-  timeout: 1000 * 60 * 10,
-  /* Run tests in files in parallel */
-  fullyParallel: false,
-  /* Fail the build on CI if you accidentally left test.only in the source code. */
-  forbidOnly: !!process.env.CI,
-  /* Retry on CI only */
-  retries: process.env.CI ? 2 : 0,
-  /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : 1,
-  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: process.env.CI
-    ? [["html", { open: "never", outputFolder: "test-results" }], ["line"]]
-    : "html",
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-  use: {
-    /* Base URL to use in actions like `await page.goto('/')`. */
-    // baseURL: 'http://127.0.0.1:3000',
-
-    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-    trace: "on",
-    video: "on",
-    screenshot: "on",
-    locale: "en-US",
-    timezoneId: "America/Los_Angeles",
-    permissions: ["clipboard-read"],
-    actionTimeout: 1000 * 5, // set action timeout for 5 seconds. When an action times out, checksum's Autonomus Agent kicks in and attempts to fix the test.
-    navigationTimeout: 1000 * 30, 
-
-  },
-  expect: {
-    toHaveScreenshot: { maxDiffPixelRatio: 0.05, maxDiffPixels: 200 },
-  },
-
-  /* Configure projects for major browsers */
-  projects: [
-    {
-      name: "chromium",
-      testMatch: /checksum.spec/,
-      use: {
-        ...devices["Desktop Chrome"],
-      },
-    },
-  ],
-  /* Run your local dev server before starting the tests */
-  // webServer: {
-  //   command: 'npm run start',
-  //   url: 'http://127.0.0.1:3000',
-  //   reuseExistingServer: !process.env.CI,
-  // },
-});