@checksum-ai/runtime 4.5.0 → 4.7.0

package/.env

@@ -1 +1 @@
-CHECKSUM_RUNTIME_BUILD_TIME=2026-06-18T11:56:27.052Z
+CHECKSUM_RUNTIME_BUILD_TIME=2026-07-01T07:45:17.033Z

package/README.md

@@ -5,7 +5,7 @@
 1. Install the package using `npm install -D checksumai` or `yarn add checksumai -D`.
 2. Navigate to the directory where you want to initialize the Checksum tests folder and run `npx checksumai init`.
 3. In the newly created `checksum` folder:
-   1. Edit `checksum.config.ts` and add the necessary configuration, including your API key. Define `BASE_URL` in `checksum/.env` because the starter config reads `process.env.BASE_URL!`.
+   1. Define `CHECKSUM_API_KEY` and `BASE_URL` in `checksum/.env` or your shell; the starter config reads `process.env.CHECKSUM_API_KEY` and `process.env.BASE_URL!`.
    2. Update `login.ts` with your Playwright login flow. See the Login Function section below for the current params-object API.
    3. Review the starter examples in `checksum/tests/examples/example.checksum.spec.ts` and `checksum/tests/examples/example.checksum.md`.
    4. Re-running `npx checksumai init` later backfills any missing starter files without overwriting files you already customized.
@@ -91,10 +91,10 @@ Alongside standard test run configurations found in `playwright.config.ts`, use
   runMode: RunMode.Normal,
 
   /**
-   * Insert here your Checksum API key.
+   * Define CHECKSUM_API_KEY in checksum/.env or your shell.
    * You can find it in https://app.checksum.ai/#/settings/
    */
-  apiKey: "<API key>",
+  apiKey: process.env.CHECKSUM_API_KEY,
 
      /**
    * Define your test run environments and test users within each environment.

package/checksum-root/.gitignore.example

@@ -1,11 +1,15 @@
 node_modules/
-/test-results/
-/playwright-report/
-/blob-report/
-/playwright/.cache/
+test-results/
+playwright-report/
+blob-report/
+playwright/.cache/
 .auth
-.eval.checksum.spec.ts
+*.eval.checksum.spec.ts
 *.rrweb.json.jsonl
 *.rrweb.jsonl
 .chk/
-test-instrumentation/
+test-instrumentation/
+.env
+checksum/test-data/*
+!checksum/test-data/bin/
+.DS_Store

package/checksum-root/checksum.config.ts

@@ -1,6 +1,17 @@
 import { RunMode, getChecksumConfig } from "@checksum-ai/runtime";
-import { resolve } from "path";
-require("dotenv").config({ path: resolve(__dirname, ".env") });
+import * as path from "path";
+import * as dotenv from "dotenv";
+
+// Load env vars from the project-root .env first, then checksum/.env. The root
+// is derived from this file's location (checksum/ lives at <project>/checksum),
+// NOT from process.cwd(), so it resolves correctly no matter which directory
+// Playwright/the CLI is launched from. dotenv does not overwrite variables that
+// are already set, so the root .env wins on any overlapping key and
+// checksum/.env only fills in the rest (and anything already exported in the
+// real shell environment beats both files).
+const projectRoot = path.join(__dirname, "..");
+dotenv.config({ path: path.join(projectRoot, ".env") });
+dotenv.config({ path: path.join(__dirname, ".env") });
 
 export default getChecksumConfig({
   /**
@@ -9,9 +20,10 @@ export default getChecksumConfig({
   runMode: RunMode.Normal,
 
   /**
-   * Insert here your Checksum API key. You can find it in https://app.checksum.ai/#/settings/
+   * Define CHECKSUM_API_KEY in checksum/.env or your shell.
+   * You can find it in https://app.checksum.ai/#/settings/
    */
-  apiKey: "<API key>",
+  apiKey: process.env.CHECKSUM_API_KEY,
 
   /**
    * Define your test run environments and test users within each environment.

package/checksum-root/eslint.config.mjs

@@ -0,0 +1,31 @@
+// ESLint 9+ flat config for Checksum Playwright tests.
+//
+// Rules come from the shared, published checksumai-eslint-config package — the
+// same config existing customers are auto-upgraded to via the platform's
+// dependency-upgrade flow. Keeping fresh installs on the shared package means a
+// brand-new project lints identically to an upgraded one (single source of
+// truth), instead of drifting on a hand-rolled copy.
+//
+// Install the peer toolchain with:
+//   npm i -D checksumai-eslint-config eslint typescript-eslint @eslint/js typescript
+import { tests } from "checksumai-eslint-config";
+
+export default [
+  ...tests,
+  {
+    // Project-layout ignores live here (not in the shared package) because the
+    // report directories and scratch REPL spec name are conventions of a
+    // Checksum test repo's layout, not of the lint ruleset.
+    ignores: [
+      "test-results/",
+      "playwright-report/",
+      "blob-report/",
+      "playwright/.cache/",
+      // scratch REPL specs — both the dot-prefixed (.eval.checksum.spec.ts) and
+      // any <name>.eval.checksum.spec.ts form (ESLint's `*` doesn't match a
+      // leading dot, so both globs are needed).
+      "**/.eval.checksum.spec.ts",
+      "**/*.eval.checksum.spec.ts",
+    ],
+  },
+];

package/checksum-root/tsconfig.json

@@ -5,5 +5,5 @@
       "@checksum/*": ["./*"]
     }
   },
-  "include": ["./**/*", ".chk/**/*"]
+  "include": ["./tests/**/*", ".chk/**/*"]
 }