@flowriki/agent 0.1.0-beta.42 → 0.1.0-beta.44

package/dist/cli.js

@@ -14,6 +14,7 @@ import {
   helperRunner,
   mirrorCheckTargets,
   openRunSession,
+  parseGherkin,
   prepareBrowsers,
   replayCase,
   replayFlow,
@@ -22,7 +23,7 @@ import {
   runtimeValue,
   start,
   status
-} from "./chunk-FKD5OAUV.js";
+} from "./chunk-E24RRF2Q.js";
 
 // src/cli.ts
 import { parseArgs } from "util";
@@ -218,6 +219,31 @@ var ServiceClient = class {
     return this.call(`/api/agent/library?${query}`);
   }
   /** Test cases written, edited or linked in one commit; duplicates skipped. */
+  importPart(projectId, draftId, part) {
+    return this.call(
+      `/api/agent/import-drafts/${encodeURIComponent(draftId)}?projectId=${encodeURIComponent(projectId)}&part=${part}`
+    );
+  }
+  saveImportCases(projectId, draftId, body) {
+    return this.call(
+      `/api/agent/import-drafts/${encodeURIComponent(draftId)}/cases?projectId=${encodeURIComponent(projectId)}`,
+      { method: "POST", body: JSON.stringify(body) }
+    );
+  }
+  readCases(projectId, refs) {
+    const ids = refs.filter((r) => /^tc_/.test(r.trim()));
+    const names = refs.filter((r) => !/^tc_/.test(r.trim()));
+    const q = new URLSearchParams({ projectId, ...ids.length ? { ids: ids.join(",") } : {}, ...names.length ? { names: names.join("|") } : {} });
+    return this.call(`/api/agent/cases/read?${q}`);
+  }
+  /** Test cases written down — business steps, no flows yet — on Claude's
+   *  working branch. */
+  writeCases(projectId, groups, changeId) {
+    return this.call(
+      `/api/agent/cases/batch?projectId=${encodeURIComponent(projectId)}`,
+      { method: "POST", body: JSON.stringify({ groups, ...changeId ? { changeId } : {} }) }
+    );
+  }
   saveLibrary(projectId, input) {
     return this.call(`/api/agent/library?projectId=${encodeURIComponent(projectId)}`, { method: "POST", body: JSON.stringify(input) });
   }
@@ -839,6 +865,11 @@ THE MODEL \u2014 get this right before recording anything:
 - A TEST CASE is the test. It strings flows together as rows (in the same
   browser, or a new one for a second person) and switches on the checks it is
   about. Build it with preview_case, then save_case \u2014 which runs it first.
+- A test case can be WRITTEN BEFORE IT IS AUTOMATED: business steps (Given /
+  When / Then) and no flows \u2014 imported from a spreadsheet, or written with
+  write_test_cases. To automate one, record the flows its steps need, then
+  save_case with the SAME name in the SAME folder: that fills it, and its
+  business steps stay. Its Then lines are the checks to switch on.
 - SIGN-IN is shared setup: a flow or case that needs somebody signed in uses a
   sign-in profile from the catalog (start_flow's signIn), never typed login steps.
   None yet? Make it: record the login as a flow that ends with a check proving
@@ -874,6 +905,16 @@ as learned. Keep what you learn with write_knowledge (features/<name>.md,
 memory/decisions.md, a session summary), on Claude's branch for review \u2014
 never a password, key or token.
 
+CONVERTING A SPREADSHEET: when asked to convert an import (imp_\u2026), read
+every part with read_import_file, then save_import_cases in batches. Group
+cases into features by product area (a sheet or section usually is one). Each
+case is one scenario: name it after what it proves. Steps: preconditions and
+setup as Given; ONE action per When / And \u2014 split steps that do several
+things; each expected result as Then / And, after the action it follows.
+Keep every case and every step's meaning, and its id from the file in row;
+never invent a step or drop one. Rows that are not test cases (titles,
+notes, empty) are left out. Say in note what you could not convert.
+
 HOW TO WORK:
 1. Call project_catalog. Reuse what exists \u2014 published, and on Claude's working
    branch \u2014 rather than writing it again.
@@ -1293,6 +1334,153 @@ ${page}`);
         return text(out);
       }
     },
+    {
+      name: "read_import_file",
+      title: "Read a spreadsheet waiting to be converted",
+      description: "Read one part of a spreadsheet the person is importing (its id is imp_\u2026): every sheet's rows, each as a JSON array of its cells, numbered as the spreadsheet numbers them. Part 1 says how many parts there are; read every one.",
+      inputSchema: {
+        type: "object",
+        properties: { projectId: { type: "string" }, file: { type: "string", description: "The import's id, imp_\u2026" }, part: { type: "number", description: "Which part, from 1." } },
+        required: ["file", "part"],
+        additionalProperties: false
+      },
+      annotations: { readOnlyHint: true },
+      run: async (args) => {
+        const projectId = await projectFor(args["projectId"]);
+        const got = await service.importPart(projectId, str(args["file"]) ?? "", Number(args["part"] ?? 1));
+        return text(`${got.file} \u2014 part ${got.part} of ${got.of}${got.part < got.of ? " (read the rest too)" : " (the last)"}
+
+${got.text}`);
+      }
+    },
+    {
+      name: "save_import_cases",
+      title: "Save the test cases a spreadsheet becomes",
+      description: "Save test cases converted from a spreadsheet being imported (its id is imp_\u2026), in batches as you go: features, each with cases \u2014 name (the scenario it proves), steps as Given / When / Then / And lines, row (its id or row in the file), description (optional). They are shown to the person to import; nothing is written to the project until they do. done: true with the last batch; note: anything you could not convert, and why. restart: true replaces what was saved before.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          projectId: { type: "string" },
+          file: { type: "string", description: "The import's id, imp_\u2026" },
+          features: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                feature: { type: "string" },
+                cases: {
+                  type: "array",
+                  items: {
+                    type: "object",
+                    properties: { name: { type: "string" }, description: { type: "string" }, steps: { type: "array", items: { type: "string" } }, row: { type: "string" } },
+                    required: ["name", "steps"],
+                    additionalProperties: false
+                  }
+                }
+              },
+              required: ["feature", "cases"],
+              additionalProperties: false
+            }
+          },
+          done: { type: "boolean" },
+          note: { type: "string" },
+          restart: { type: "boolean" }
+        },
+        required: ["file", "features"],
+        additionalProperties: false
+      },
+      run: async (args) => {
+        const projectId = await projectFor(args["projectId"]);
+        const features = Array.isArray(args["features"]) ? args["features"] : [];
+        const saved = await service.saveImportCases(projectId, str(args["file"]) ?? "", {
+          features,
+          ...args["done"] === true ? { done: true } : {},
+          ...typeof args["note"] === "string" ? { note: args["note"] } : {},
+          ...args["restart"] === true ? { restart: true } : {}
+        });
+        return text(`Saved ${saved.added} more \u2014 ${saved.total} test cases so far.${saved.done ? " Done: the person can now look them over and import them." : " Keep going, and pass done: true with the last batch."}`);
+      }
+    },
+    {
+      name: "read_test_cases",
+      title: "Read test cases",
+      description: "Read test cases by id (tc_\u2026) or exact name: their feature, business steps (Given / When / Then), whether they are automated, and the flows they run. Read a case's steps before automating it.",
+      inputSchema: {
+        type: "object",
+        properties: { projectId: { type: "string" }, cases: { type: "array", items: { type: "string" }, description: "Ids or names." } },
+        required: ["cases"],
+        additionalProperties: false
+      },
+      annotations: { readOnlyHint: true },
+      run: async (args) => {
+        const projectId = await projectFor(args["projectId"]);
+        const refs = Array.isArray(args["cases"]) ? args["cases"].map(String) : [];
+        const { cases, missing } = await service.readCases(projectId, refs);
+        const parts = cases.map((c) => [
+          `${c.folder} \u203A ${c.name} (${c.id}) \u2014 ${c.automated ? `automated, rows: ${c.rows.join(" \u2192 ")}` : "not automated yet"}`,
+          ...c.description ? [`  ${c.description}`] : [],
+          ...c.businessSteps.length ? c.businessSteps.map((s) => `  ${s.keyword} ${s.text}`) : ["  (no business steps written)"]
+        ].join("\n"));
+        if (missing.length) parts.push(`Not found: ${missing.join(", ")} \u2014 project_catalog lists the test cases.`);
+        return text(parts.join("\n\n") || "No test cases found.");
+      }
+    },
+    {
+      name: "write_test_cases",
+      title: "Write test cases down, before automating them",
+      description: "Write test cases as business steps \u2014 Given / When / Then \u2014 with no flows yet, grouped by feature (the case folder), on Claude's working branch for review. They show as not automated until a test case with the same name is saved into the same folder with save_case, which keeps these steps. A case its folder already has is skipped. Use it when asked to write, plan or list test cases; record and save_case only when asked to automate.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          projectId: { type: "string" },
+          features: {
+            type: "array",
+            description: 'One entry per feature (case folder), e.g. "Account \u2013 Sign up".',
+            items: {
+              type: "object",
+              properties: {
+                feature: { type: "string" },
+                cases: {
+                  type: "array",
+                  items: {
+                    type: "object",
+                    properties: {
+                      name: { type: "string", description: 'The scenario it proves, e.g. "A taken email is refused".' },
+                      description: { type: "string" },
+                      steps: { type: "array", description: `Given / When / Then lines, e.g. "Given the sign-up form is open", "When I sign up with a taken email", "Then I see 'That email is taken'". And / But continue the line above.`, items: { type: "string" } }
+                    },
+                    required: ["name", "steps"],
+                    additionalProperties: false
+                  }
+                }
+              },
+              required: ["feature", "cases"],
+              additionalProperties: false
+            }
+          },
+          branch: { type: "string", description: "Optional: the id of one of Claude's open branches to write to (list_my_branches). Default: the working branch." }
+        },
+        required: ["features"],
+        additionalProperties: false
+      },
+      run: async (args) => {
+        const projectId = await projectFor(args["projectId"]);
+        const features = Array.isArray(args["features"]) ? args["features"] : [];
+        const groups = features.map((f) => ({
+          folder: String(f.feature ?? "").trim(),
+          cases: (Array.isArray(f.cases) ? f.cases : []).map((c) => {
+            const lines = Array.isArray(c.steps) ? c.steps.map(String) : [];
+            const steps = parseGherkin(lines.join("\n"));
+            if (!steps) throw new Error(`the steps of "${String(c.name ?? "")}" must each start with Given, When, Then, And or But`);
+            return { name: String(c.name ?? "").trim(), ...typeof c.description === "string" ? { description: c.description } : {}, businessSteps: steps };
+          })
+        }));
+        const done = await service.writeCases(projectId, groups, str(args["branch"]));
+        catalogs.delete(projectId);
+        const skipped = done.skipped.length ? ` Skipped ${done.skipped.length} the folder already had: ${done.skipped.map((s) => `"${s.name}"`).join(", ")}.` : "";
+        return text(`Wrote ${done.created.length} test case${done.created.length === 1 ? "" : "s"}, not automated yet, on Claude's working branch ${done.branch}.${skipped}`);
+      }
+    },
     {
       name: "create_sign_in",
       title: "Make a sign-in profile",

package/dist/engine.js

@@ -9,7 +9,7 @@ import {
   resolveCheckouts,
   start,
   status
-} from "./chunk-FKD5OAUV.js";
+} from "./chunk-E24RRF2Q.js";
 export {
   AGENT_VERSION,
   browsersReady,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowriki/agent",
-  "version": "0.1.0-beta.42",
+  "version": "0.1.0-beta.44",
   "description": "Run Flowriki UI tests on your own computer. Connects this machine to your Flowriki account.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",