@itmetsam/samurai-framework 0.19.0 → 0.20.0

package/dist/capabilities.d.ts

@@ -33,6 +33,8 @@ export declare const CAPABILITIES: {
     readonly outputDir: true;
     /** `runFlowInProject`'s `outputDir` gives each node its own folder, `nodes/<node id>/`. */
     readonly flowNodeFolders: true;
+    /** `nodeFolder(nodeId)` from `./flows/run`: a flow node's folder under `outputDir`, so an app need not rebuild it. */
+    readonly nodeFolder: true;
     /** Assertion matchers version 2: `toBeHidden`, `toBeEnabled`, `toBeChecked`, `toHaveClass` and `toHaveCSS`, in the framework and the step codec. */
     readonly assertionMatchers: 2;
     /** `expect(page).toHaveURL` and `toHaveTitle`, and the `expectPage` step in the step codec. */

package/dist/capabilities.js

@@ -33,6 +33,8 @@ export const CAPABILITIES = {
     outputDir: true,
     /** `runFlowInProject`'s `outputDir` gives each node its own folder, `nodes/<node id>/`. */
     flowNodeFolders: true,
+    /** `nodeFolder(nodeId)` from `./flows/run`: a flow node's folder under `outputDir`, so an app need not rebuild it. */
+    nodeFolder: true,
     /** Assertion matchers version 2: `toBeHidden`, `toBeEnabled`, `toBeChecked`, `toHaveClass` and `toHaveCSS`, in the framework and the step codec. */
     assertionMatchers: 2,
     /** `expect(page).toHaveURL` and `toHaveTitle`, and the `expectPage` step in the step codec. */

package/dist/flows/run/index.d.ts

@@ -2,6 +2,7 @@
 export * from "./events.js";
 export { HANDLERS } from "./handlers/index.js";
 export type { Handler, HandlerRun, Outcome } from "./handlers/index.js";
+export { nodeFolder } from "./node-folder.js";
 export { runFlow, type RunFlowOptions } from "./run.js";
 export { FLOW_SUFFIX, flowsDir, listFlows, readFlow, readFlowPath, readFlows, } from "./files.js";
 export * from "./report.js";

package/dist/flows/run/index.js

@@ -1,6 +1,7 @@
 /** Running flows: handlers, the walker, a project's flow files. Node only; see `flows/core` for the pure half. */
 export * from "./events.js";
 export { HANDLERS } from "./handlers/index.js";
+export { nodeFolder } from "./node-folder.js";
 export { runFlow } from "./run.js";
 export { FLOW_SUFFIX, flowsDir, listFlows, readFlow, readFlowPath, readFlows, } from "./files.js";
 export * from "./report.js";

package/dist/flows/run/node-folder.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The folder a flow node's screenshots go in, relative to `runFlowInProject`'s `outputDir`, with `/` separators:
+ * `nodes/` and the node id cleaned for a file name. A node's screenshot paths are relative to this folder.
+ */
+export declare function nodeFolder(nodeId: string): string;

package/dist/flows/run/node-folder.js

@@ -0,0 +1,8 @@
+import { cleanName } from "../../browser/evidence.js";
+/**
+ * The folder a flow node's screenshots go in, relative to `runFlowInProject`'s `outputDir`, with `/` separators:
+ * `nodes/` and the node id cleaned for a file name. A node's screenshot paths are relative to this folder.
+ */
+export function nodeFolder(nodeId) {
+    return `nodes/${cleanName(nodeId)}`;
+}

package/dist/flows/run/project.js

@@ -1,5 +1,4 @@
 import path from "node:path";
-import { cleanName } from "../../browser/evidence.js";
 import { DEFAULT_SRC_DIR } from "../../config/defaults.js";
 import { projectConfig } from "../../config/config.js";
 import { checkFlow, withKeys, } from "../core/index.js";
@@ -15,6 +14,7 @@ import TestRunner from "../../runner/test-runner.js";
 import { WorkerPool } from "../../runner/worker-pool.js";
 import { processWorkerFactory } from "../../runner/worker-process.js";
 import { readFlow } from "./files.js";
+import { nodeFolder } from "./node-folder.js";
 import { itemsOf, runOnPool } from "./node-pool.js";
 import { FlowCheckError, } from "./project-options.js";
 import { projectSteps } from "../steps/set.js";
@@ -198,7 +198,7 @@ async function walkFlowInProject(options) {
             runTests: async ({ nodeId, tests, onEvent, signal, browsers }) => {
                 // Each node gets a folder of its own: the same test in two nodes would overwrite its screenshots
                 const outputDir = options.outputDir !== undefined
-                    ? path.join(options.outputDir, "nodes", cleanName(nodeId))
+                    ? path.join(options.outputDir, ...nodeFolder(nodeId).split("/"))
                     : undefined;
                 if (pool)
                     return runOnPool(pool, itemsOf(tests, browsers ?? browsersFor({ project: config.browsers }), outputDir), onEvent, signal);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itmetsam/samurai-framework",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Browser test framework over WebDriver BiDi: auto-waiting locators, environments and secrets, a recorder, and a command line.",
   "main": "dist/api.js",
   "exports": {