@swmansion/argent 0.29.1-next.21 → 0.29.1-next.23

package/dist/tool-args.generated.d.ts

@@ -188,84 +188,84 @@ export interface ArgentToolArgs {
         /** Number of hours to suppress the update notification */
         hours: number;
     };
-    fill: {
-        /** Target device id from `list-devices`. */
-        udid: string;
-        /** The text the focused field must hold afterwards; "" clears it. Supports `{{secret:<NAME>}}` placeholders like `keyboard`. */
-        text: string;
-    };
-    "flow-add-echo": {
-        /** Name of the flow being recorded: the one passed to flow-start-recording. */
+    "e2e-add-echo": {
+        /** Name of the e2e test being recorded: the one passed to e2e-start-recording. */
         name: string;
-        /** Absolute path to the project root of the flow being recorded: the same value passed to flow-start-recording. Together with `name` it identifies which recording this echo belongs to. */
+        /** Absolute path to the project root of the e2e test being recorded: the same value passed to e2e-start-recording. Together with `name` it identifies which recording this echo belongs to. */
         project_root: string;
-        /** Message to echo when the flow is replayed */
+        /** Message to echo when the e2e test is replayed */
         message: string;
     };
-    "flow-add-script": {
-        /** Flow name passed to flow-start-recording. */
+    "e2e-add-script": {
+        /** E2E test name passed to e2e-start-recording. */
         name: string;
-        /** Absolute project root passed to flow-start-recording. */
+        /** Absolute project root passed to e2e-start-recording. */
         project_root: string;
-        /** Path to the .mjs file, relative to the flow YAML. For example: "../../scripts/seed-order.mjs". */
+        /** Path to the .mjs file, relative to the e2e test YAML. For example: "../../scripts/seed-order.mjs". */
         path: string;
         /** Optional time limit in milliseconds. The default is 30000 and the minimum is 100. */
         timeout?: number;
     };
-    "flow-add-step": {
-        /** Name of the flow being recorded: the one passed to flow-start-recording. */
+    "e2e-add-step": {
+        /** Name of the e2e test being recorded: the one passed to e2e-start-recording. */
         name: string;
-        /** Absolute path to the project root of the flow being recorded: the same value passed to flow-start-recording. Together with `name` it identifies which recording this step belongs to. */
+        /** Absolute path to the project root of the e2e test being recorded: the same value passed to e2e-start-recording. Together with `name` it identifies which recording this step belongs to. */
         project_root: string;
-        /** MCP tool to execute and record, for example "gesture-tap". Do not pass a flow directive or a recording tool. Call flow-add-script directly for a requested script step. */
+        /** MCP tool to execute and record, for example "gesture-tap". Do not pass an e2e test directive or a recording tool. Call e2e-add-script directly for a requested script step. */
         command: string;
         /** Tool arguments as a JSON string, e.g. '{"udid": "ABC", "x": 0.5, "y": 0.3}'. Omit for tools with no arguments. */
         args?: string;
         /** Milliseconds to sleep before executing this step during replay. */
         delayMs?: number;
     };
-    "flow-execute": {
-        /** Name of a saved flow to run from `.argent/flows` (e.g. "settings-explore"). Omit when flow_path is set. */
+    "e2e-execute": {
+        /** Name of a saved e2e test to run from `.argent/e2e`, or `.argent/flows` when it is not there (e.g. "settings-explore"). Omit when flow_path is set. */
         name?: string;
-        /** Absolute path to the calling agent's project root: the cwd it is working in. With name, the saved flow is read from `.argent/flows/<name>.yaml` under this root; with flow_path, the flow, its run: siblings, its script: paths and baselines all resolve beside the YAML instead, so pass the agent's cwd. A script still RUNS in this root whichever source was used. */
+        /** Absolute path to the calling agent's project root: the cwd it is working in. With name, the saved e2e test is read from `.argent/e2e/<name>.yaml`, else `.argent/flows/<name>.yaml`, under this root; with flow_path, the e2e test, its run: siblings, its script: paths and baselines all resolve beside the YAML instead, so pass the agent's cwd. A script still RUNS in this root whichever source was used. */
         project_root: string;
-        /** Path to the flow .yaml as readable by the tool-server. Internal: the argent client derives it from project_root and name automatically; leave unset. */
+        /** Path to the e2e test .yaml as readable by the tool-server. Internal: the argent client derives it from project_root and name automatically; leave unset. */
         flow_file?: string;
-        /** Omit when name is set. Absolute path to a flow .yaml on the client. Over a link (argent link or ARGENT_TOOLS_URL), the argent client uploads the file, its run: fragments and the snapshot baselines of each run, and the tool-server runs those copies. Keep run: fragments under project_root or beside the flow file. With updateBaselines, the client writes the new baselines when the run ends. The client also uploads each absolute .png or .yaml path that a tool: step takes as a file argument, when the file is under project_root or beside the flow file. A tool: flow-execute step that names a flow with name and an absolute project_root without a .. segment runs: the client also uploads that flow and its own files. Over a link, the uploaded flows must not have: script: steps; tool: steps that run a flow another way or record a flow; tool: steps that take a directory, an app or an output directory; tool: steps whose tool builds a file path from several arguments; tool: steps that name a relative path or a file other than .png or .yaml. Without a link, the tool-server reads the files in place and all step kinds run. */
+        /** Omit when name is set. Absolute path to an e2e test .yaml on the client. Over a link (argent link or ARGENT_TOOLS_URL), the argent client uploads the file, its run: fragments and the snapshot baselines of each run, and the tool-server runs those copies. Keep run: fragments under project_root or beside the e2e test file. With updateBaselines, the client writes the new baselines when the run ends. The client also uploads each absolute .png or .yaml path that a tool: step takes as a file argument, when the file is under project_root or beside the e2e test file. A tool: e2e-execute step that names an e2e test with name and an absolute project_root without a .. segment runs: the client also uploads that e2e test and its own files. Over a link, the uploaded e2e tests must not have: script: steps; tool: steps that run an e2e test another way or record an e2e test; tool: steps that take a directory, an app or an output directory; tool: steps whose tool builds a file path from several arguments; tool: steps that name a relative path or a file other than .png or .yaml. Without a link, the tool-server reads the files in place and all step kinds run. */
         flow_path?: string;
         /** Device id to run against (iOS UDID, Android/Vega serial, Chromium id), as list-devices reports it. Auto-detected when omitted, but only when exactly one booted device matches (optionally narrowed by `platform`); with several booted the run fails and lists them, so pass this explicitly whenever more than one device is up. */
         device?: string;
-        /** Restrict auto-detection to this platform when several devices are booted. `ios` selects local simulators only; pass `ios-remote` to select a remote one. `chromium` does more than filter: with no `device` it SELECTS the self-boot branch for an e2e flow - the runner boots an Electron instance from the `launch` step's chromium value and tears it down after the run (a single-key `launch: { chromium: … }` map selects it on its own, without this parameter). When it selects that branch it never falls back to device auto-detection (a fragment, or an e2e launch map with no `chromium` key, still does), and the launch value must be a real Electron app path on the tool-server host: a bare-string `launch:` - what the recorder writes - holds an installed-app bundle id, so passing `chromium` for one fails the whole run with `Electron boot: path does not exist`. Edit the launch to `{ chromium: <app path> }` first. */
+        /** Restrict auto-detection to this platform when several devices are booted. `ios` selects local simulators only; pass `ios-remote` to select a remote one. `chromium` does more than filter: with no `device` it SELECTS the self-boot branch for a standalone e2e test - the runner boots an Electron instance from the `launch` step's chromium value and tears it down after the run (a single-key `launch: { chromium: … }` map selects it on its own, without this parameter). When it selects that branch it never falls back to device auto-detection (a fragment, or a standalone e2e test's launch map with no `chromium` key, still does), and the launch value must be a real Electron app path on the tool-server host: a bare-string `launch:` - what the recorder writes - holds an installed-app bundle id, so passing `chromium` for one fails the whole run with `Electron boot: path does not exist`. Edit the launch to `{ chromium: <app path> }` first. */
         platform?: "ios" | "android" | "chromium" | "vega" | "ios-remote";
-        /** Write/refresh screenshot baselines for `snapshot` steps instead of diffing against them, also in the flows that tool: flow-execute steps run, unless such a step sets updateBaselines itself. */
+        /** Write/refresh screenshot baselines for `snapshot` steps instead of diffing against them, also in the e2e tests that tool: e2e-execute steps run, unless such a step sets updateBaselines itself. */
         updateBaselines?: boolean;
         /** Set to true to confirm the execution prerequisite has been met. Required (LLM path) when a fragment defines an executionPrerequisite. */
         prerequisiteAcknowledged?: boolean;
     };
-    "flow-finish-recording": {
-        /** Name of the flow being recorded: the one passed to flow-start-recording. */
+    "e2e-finish-recording": {
+        /** Name of the e2e test being recorded: the one passed to e2e-start-recording. */
         name: string;
-        /** Absolute path to the project root of the flow being recorded: the same value passed to flow-start-recording. Together with `name` it identifies which recording to finish. */
+        /** Absolute path to the project root of the e2e test being recorded: the same value passed to e2e-start-recording. Together with `name` it identifies which recording to finish. */
         project_root: string;
     };
-    "flow-read-prerequisite": {
-        /** Name of a saved flow to inspect from `.argent/flows` (e.g. "settings-explore"). Omit when flow_path is set. */
+    "e2e-read-prerequisite": {
+        /** Name of a saved e2e test to inspect from `.argent/e2e`, or `.argent/flows` when it is not there (e.g. "settings-explore"). Omit when flow_path is set. */
         name?: string;
-        /** Absolute path to the calling agent's project root: the cwd it is working in. With name, the saved flow is read from `.argent/flows/<name>.yaml` under this root; with flow_path, the prerequisite is read from that YAML instead, so pass the agent's cwd. */
+        /** Absolute path to the calling agent's project root: the cwd it is working in. With name, the saved e2e test is read from `.argent/e2e/<name>.yaml`, else `.argent/flows/<name>.yaml`, under this root; with flow_path, the prerequisite is read from that YAML instead, so pass the agent's cwd. */
         project_root: string;
-        /** Path to the flow .yaml as readable by the tool-server. Internal: the argent client derives it from project_root and name automatically; leave unset. */
+        /** Path to the e2e test .yaml as readable by the tool-server. Internal: the argent client derives it from project_root and name automatically; leave unset. */
         flow_file?: string;
-        /** Omit when name is set. Absolute path to a flow .yaml on the client. Over a link (argent link or ARGENT_TOOLS_URL), the argent client uploads the file and the tool-server reads the uploaded copy; without a link, the tool-server reads the file in place. Pass the path through the argent client; a raw path that the file-input boundary did not verify is rejected. Pass the same flow source here as to flow-execute, so the prerequisite you read belongs to the flow that will run. */
+        /** Omit when name is set. Absolute path to an e2e test .yaml on the client. Over a link (argent link or ARGENT_TOOLS_URL), the argent client uploads the file and the tool-server reads the uploaded copy; without a link, the tool-server reads the file in place. Pass the path through the argent client; a raw path that the file-input boundary did not verify is rejected. Pass the same e2e test source here as to e2e-execute, so the prerequisite you read belongs to the e2e test that will run. */
         flow_path?: string;
     };
-    "flow-start-recording": {
-        /** Name for this flow (e.g. "settings-explore"): letters, digits, underscore and hyphen only. */
+    "e2e-start-recording": {
+        /** Name for this e2e test (e.g. "settings-explore"): letters, digits, underscore and hyphen only. */
         name: string;
-        /** Absolute path to the project root directory (the directory that contains or should contain `.argent/flows/`). The flow file is created at `<project_root>/.argent/flows/<name>.yaml`. */
+        /** Absolute path to the project root directory (the directory that contains or should contain `.argent/e2e/`). The e2e test file is created at `<project_root>/.argent/e2e/<name>.yaml`. */
         project_root: string;
-        /** Fragments only: the app/device state assumed on entry (e.g. "Settings app open on General page"). For a self-contained e2e flow, omit this and record a `restart-app` as the first step instead; it is captured as the flow's `launch` step. restart-app has no chromium support, so a chromium flow records as a fragment; add the `launch: { chromium: <app path> }` line to the YAML afterward, deleting the executionPrerequisite line if you passed one, since a flow that starts with a launch must not declare it. */
+        /** Fragments only: the app/device state assumed on entry (e.g. "Settings app open on General page"). For a standalone e2e test, omit this and record a `restart-app` as the first step instead; it is captured as the e2e test's `launch` step. restart-app has no chromium support, so a chromium e2e test records as a fragment; add the `launch: { chromium: <app path> }` line to the YAML afterward, deleting the executionPrerequisite line if you passed one, since an e2e test that starts with a launch must not declare it. */
         executionPrerequisite?: string;
     };
+    fill: {
+        /** Target device id from `list-devices`. */
+        udid: string;
+        /** The text the focused field must hold afterwards; "" clears it. Supports `{{secret:<NAME>}}` placeholders like `keyboard`. */
+        text: string;
+    };
     fold: {
         /** Target device id from `list-devices` (a foldable iOS simulator UDID or Android emulator serial). */
         udid: string;
@@ -893,4 +893,18 @@ export interface ArgentToolArgs {
         /** Whether to include the response body (if captured). Defaults to true. */
         includeBody?: boolean;
     };
+    /** @deprecated Renamed to `e2e-add-echo`. */
+    "flow-add-echo": ArgentToolArgs["e2e-add-echo"];
+    /** @deprecated Renamed to `e2e-add-script`. */
+    "flow-add-script": ArgentToolArgs["e2e-add-script"];
+    /** @deprecated Renamed to `e2e-add-step`. */
+    "flow-add-step": ArgentToolArgs["e2e-add-step"];
+    /** @deprecated Renamed to `e2e-execute`. */
+    "flow-execute": ArgentToolArgs["e2e-execute"];
+    /** @deprecated Renamed to `e2e-finish-recording`. */
+    "flow-finish-recording": ArgentToolArgs["e2e-finish-recording"];
+    /** @deprecated Renamed to `e2e-read-prerequisite`. */
+    "flow-read-prerequisite": ArgentToolArgs["e2e-read-prerequisite"];
+    /** @deprecated Renamed to `e2e-start-recording`. */
+    "flow-start-recording": ArgentToolArgs["e2e-start-recording"];
 }