skill-rails 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/.claude-plugin/marketplace.json +16 -0
  2. package/.claude-plugin/plugin.json +16 -0
  3. package/.mcp.json +8 -0
  4. package/LICENSE +21 -0
  5. package/README.md +255 -0
  6. package/bin/skill-rails.js +4 -0
  7. package/dist/api.d.ts +38 -0
  8. package/dist/api.js +73 -0
  9. package/dist/api.js.map +1 -0
  10. package/dist/cli.d.ts +2 -0
  11. package/dist/cli.js +112 -0
  12. package/dist/cli.js.map +1 -0
  13. package/dist/engine.d.ts +18 -0
  14. package/dist/engine.js +312 -0
  15. package/dist/engine.js.map +1 -0
  16. package/dist/expressions.d.ts +12 -0
  17. package/dist/expressions.js +44 -0
  18. package/dist/expressions.js.map +1 -0
  19. package/dist/flow.d.ts +11 -0
  20. package/dist/flow.js +137 -0
  21. package/dist/flow.js.map +1 -0
  22. package/dist/mcp.d.ts +5 -0
  23. package/dist/mcp.js +37 -0
  24. package/dist/mcp.js.map +1 -0
  25. package/dist/run.d.ts +6 -0
  26. package/dist/run.js +67 -0
  27. package/dist/run.js.map +1 -0
  28. package/dist/schema.d.ts +10 -0
  29. package/dist/schema.js +15 -0
  30. package/dist/schema.js.map +1 -0
  31. package/dist/state.d.ts +6 -0
  32. package/dist/state.js +24 -0
  33. package/dist/state.js.map +1 -0
  34. package/dist/testing.d.ts +50 -0
  35. package/dist/testing.js +233 -0
  36. package/dist/testing.js.map +1 -0
  37. package/dist/types.d.ts +200 -0
  38. package/dist/types.js +2 -0
  39. package/dist/types.js.map +1 -0
  40. package/docs/format.md +256 -0
  41. package/docs/testing.md +100 -0
  42. package/examples/hello/flow.yaml +32 -0
  43. package/examples/hello/tests/hello.test.yaml +22 -0
  44. package/examples/open-pr/flow.yaml +87 -0
  45. package/examples/open-pr/prompts/text.md +26 -0
  46. package/examples/open-pr/scripts/body-file.sh +10 -0
  47. package/examples/open-pr/scripts/context.sh +21 -0
  48. package/examples/open-pr/scripts/create.sh +6 -0
  49. package/examples/open-pr/scripts/push.sh +8 -0
  50. package/examples/open-pr/tests/open-pr.test.yaml +42 -0
  51. package/examples/open-pr/tests/stubs/gh +9 -0
  52. package/package.json +72 -0
  53. package/schema/flow.schema.json +440 -0
  54. package/skills/create-skill-rails/SKILL.md +72 -0
  55. package/skills/create-skill-rails/template/SKILL.md +24 -0
  56. package/skills/migrate-to-skill-rails/SKILL.md +78 -0
  57. package/skills/run-skill-rails/SKILL.md +63 -0
package/dist/run.js ADDED
@@ -0,0 +1,67 @@
1
+ // Runs a `run` step with bash, and reads its outputs.
2
+ import { spawnSync } from 'node:child_process';
3
+ import crypto from 'node:crypto';
4
+ import fs from 'node:fs';
5
+ import os from 'node:os';
6
+ import path from 'node:path';
7
+ import { text } from './expressions.js';
8
+ const TIMEOUT_MS = 10 * 60_000;
9
+ const WARNING = /^::warning::(.*)$/;
10
+ /** Lines `key=value`, or `key<<DELIMITER` ... `DELIMITER`, as in GITHUB_OUTPUT. */
11
+ export function parseOutputs(content) {
12
+ const outputs = {};
13
+ const lines = content.split('\n');
14
+ for (let i = 0; i < lines.length; i++) {
15
+ const line = lines[i] ?? '';
16
+ const heredoc = line.match(/^([\w-]+)<<(.+)$/);
17
+ if (heredoc?.[1] && heredoc[2]) {
18
+ const body = [];
19
+ for (i++; i < lines.length && lines[i] !== heredoc[2]; i++)
20
+ body.push(lines[i] ?? '');
21
+ outputs[heredoc[1]] = body.join('\n');
22
+ continue;
23
+ }
24
+ const eq = line.indexOf('=');
25
+ if (eq > 0)
26
+ outputs[line.slice(0, eq)] = line.slice(eq + 1);
27
+ }
28
+ return outputs;
29
+ }
30
+ /** `::warning::<text>` lines on stdout, as in GitHub Actions. The agent shows them to the user. */
31
+ export const parseWarnings = (stdout) => stdout
32
+ .split('\n')
33
+ .map((line) => line.match(WARNING)?.[1])
34
+ .filter((warning) => Boolean(warning));
35
+ // A list becomes one line per item, so that a script can read it with `while read`.
36
+ const envValue = (value) => (Array.isArray(value) ? value.map(text).join('\n') : text(value));
37
+ export function runCommand(command, { env = {}, dir, cwd, timeoutMs = TIMEOUT_MS }) {
38
+ const outputFile = path.join(os.tmpdir(), `skill-rails-output-${crypto.randomUUID()}`);
39
+ fs.writeFileSync(outputFile, '');
40
+ const values = Object.fromEntries(Object.entries(env).map(([key, value]) => [key, envValue(value)]));
41
+ const result = spawnSync('bash', ['-eo', 'pipefail', '-c', command], {
42
+ cwd,
43
+ env: {
44
+ ...process.env,
45
+ ...values,
46
+ FLOW_DIR: dir,
47
+ FLOW_OUTPUT: outputFile,
48
+ // scripts/ next to the flow file comes first, so that a step can be `run: build.sh`.
49
+ PATH: `${path.join(dir, 'scripts')}${path.delimiter}${process.env.PATH ?? ''}`,
50
+ },
51
+ encoding: 'utf8',
52
+ stdio: ['ignore', 'pipe', 'pipe'],
53
+ timeout: timeoutMs,
54
+ maxBuffer: 64 * 1024 * 1024,
55
+ });
56
+ const outputs = parseOutputs(fs.readFileSync(outputFile, 'utf8'));
57
+ fs.rmSync(outputFile, { force: true });
58
+ const exitCode = result.status ?? 1;
59
+ return {
60
+ outcome: exitCode === 0 ? 'success' : 'failure',
61
+ exitCode,
62
+ outputs,
63
+ warnings: parseWarnings(result.stdout ?? ''),
64
+ stderr: `${result.stderr ?? ''}${result.error ? `\n${result.error.message}` : ''}`,
65
+ };
66
+ }
67
+ //# sourceMappingURL=run.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,MAAM,UAAU,GAAG,EAAE,GAAG,MAAM,CAAC;AAC/B,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAEpC,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAC/C,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAa,EAAE,CAAC;YAC1B,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;gBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YACtF,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtC,SAAS;QACX,CAAC;QACD,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,EAAE,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,mGAAmG;AACnG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAY,EAAE,CACxD,MAAM;KACH,KAAK,CAAC,IAAI,CAAC;KACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KACvC,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;AAE9D,oFAAoF;AACpF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;AAE/G,MAAM,UAAU,UAAU,CAAC,OAAe,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,GAAG,UAAU,EAAc;IACpG,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACvF,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrG,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE;QACnE,GAAG;QACH,GAAG,EAAE;YACH,GAAG,OAAO,CAAC,GAAG;YACd,GAAG,MAAM;YACT,QAAQ,EAAE,GAAG;YACb,WAAW,EAAE,UAAU;YACvB,qFAAqF;YACrF,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE;SAC/E;QACD,QAAQ,EAAE,MAAM;QAChB,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;QACjC,OAAO,EAAE,SAAS;QAClB,SAAS,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;KAC5B,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;IACpC,OAAO;QACL,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QAC/C,QAAQ;QACR,OAAO;QACP,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;QAC5C,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;KACnF,CAAC;AACJ,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { Ajv, type ErrorObject } from 'ajv';
2
+ import type { JsonObject } from './types.js';
3
+ export declare const schema: JsonObject & {
4
+ $id: string;
5
+ properties: JsonObject;
6
+ };
7
+ export declare const ajv: Ajv;
8
+ export declare const formatErrors: (prefix: string, errors: ErrorObject[] | null | undefined) => string[];
9
+ /** Validates a step output against the JSON Schema of the step. Returns the errors. */
10
+ export declare function validateOutput(outputSchema: JsonObject, value: unknown): string[];
package/dist/schema.js ADDED
@@ -0,0 +1,15 @@
1
+ import fs from 'node:fs';
2
+ import { Ajv } from 'ajv';
3
+ export const schema = JSON.parse(fs.readFileSync(new URL('../schema/flow.schema.json', import.meta.url), 'utf8'));
4
+ export const ajv = new Ajv({ allErrors: true, strict: false });
5
+ ajv.addSchema(schema);
6
+ export const formatErrors = (prefix, errors) => (errors ?? []).map((error) => {
7
+ const extra = error.keyword === 'additionalProperties' ? ` ("${String(error.params.additionalProperty)}")` : '';
8
+ return `${prefix}${error.instancePath} ${error.message ?? 'is not valid'}${extra}`.trim();
9
+ });
10
+ /** Validates a step output against the JSON Schema of the step. Returns the errors. */
11
+ export function validateOutput(outputSchema, value) {
12
+ const check = ajv.compile(outputSchema);
13
+ return check(value) ? [] : formatErrors('output', check.errors);
14
+ }
15
+ //# sourceMappingURL=schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,GAAG,EAAoB,MAAM,KAAK,CAAC;AAG5C,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAG/G,CAAC;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AAC/D,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAEtB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,MAAwC,EAAY,EAAE,CACjG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;IAC3B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,KAAK,sBAAsB,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAChH,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,IAAI,cAAc,GAAG,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;AAC5F,CAAC,CAAC,CAAC;AAEL,uFAAuF;AACvF,MAAM,UAAU,cAAc,CAAC,YAAwB,EAAE,KAAc;IACrE,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AAClE,CAAC"}
@@ -0,0 +1,6 @@
1
+ import type { State } from './types.js';
2
+ export declare const stateDir: () => string;
3
+ export declare function statePath(name: string, cwd: string): string;
4
+ export declare function readState(name: string, cwd: string): State;
5
+ export declare function writeState(state: State): void;
6
+ export declare function removeState(name: string, cwd: string): void;
package/dist/state.js ADDED
@@ -0,0 +1,24 @@
1
+ // One state file per flow name and working directory.
2
+ import crypto from 'node:crypto';
3
+ import fs from 'node:fs';
4
+ import os from 'node:os';
5
+ import path from 'node:path';
6
+ export const stateDir = () => process.env.SKILL_RAILS_STATE_DIR ?? path.join(os.tmpdir(), 'skill-rails');
7
+ export function statePath(name, cwd) {
8
+ const hash = crypto.createHash('sha256').update(path.resolve(cwd)).digest('hex').slice(0, 12);
9
+ return path.join(stateDir(), `${hash}-${name}.json`);
10
+ }
11
+ export function readState(name, cwd) {
12
+ const file = statePath(name, cwd);
13
+ if (!fs.existsSync(file))
14
+ throw new Error(`no flow "${name}" was started in ${cwd}`);
15
+ return JSON.parse(fs.readFileSync(file, 'utf8'));
16
+ }
17
+ export function writeState(state) {
18
+ fs.mkdirSync(stateDir(), { recursive: true });
19
+ fs.writeFileSync(statePath(state.flow.name, state.cwd), JSON.stringify(state));
20
+ }
21
+ export function removeState(name, cwd) {
22
+ fs.rmSync(statePath(name, cwd), { force: true });
23
+ }
24
+ //# sourceMappingURL=state.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"state.js","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAW,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC;AAEjH,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,GAAW;IACjD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9F,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,GAAW;IACjD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,oBAAoB,GAAG,EAAE,CAAC,CAAC;IACrF,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAU,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAY;IACrC,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,GAAW;IACnD,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACnD,CAAC"}
@@ -0,0 +1,50 @@
1
+ import type { StepResult } from './types.js';
2
+ /** Expected value: a string that starts and ends with `/` is a regular expression. */
3
+ type Matcher = string | number | boolean | null;
4
+ export interface TestCase {
5
+ name: string;
6
+ /** The test file, for relative paths. */
7
+ file: string;
8
+ flow: string;
9
+ /** A folder copied into the temp working directory. */
10
+ fixture?: string;
11
+ /** Run `git init` and commit the fixture (default true). */
12
+ git?: boolean;
13
+ /** Bash commands run in the working directory before the flow. */
14
+ setup?: string;
15
+ inputs?: Record<string, unknown>;
16
+ env?: Record<string, string>;
17
+ /** Folders put first in PATH, for stub commands. Relative to the test file. */
18
+ path?: string[];
19
+ /** `{{cwd}}` (the temp working directory) and `{{dir}}` (the folder of the test file) work in env, inputs and answers. */
20
+ /**
21
+ * The agent output of each step, by step id. `$files` writes files first; `$fail` fails the step.
22
+ * A list gives one answer per occurrence of the step, in order (a step in a foreach comes back once per item).
23
+ */
24
+ answers?: Record<string, Record<string, unknown> | Array<Record<string, unknown>>>;
25
+ expect?: {
26
+ status?: 'done' | 'failed' | 'error';
27
+ message?: Matcher;
28
+ steps?: Record<string, StepResult['outcome']>;
29
+ outputs?: Record<string, Matcher>;
30
+ files?: Record<string, Matcher>;
31
+ notes?: Matcher[];
32
+ };
33
+ }
34
+ export interface TestResult {
35
+ name: string;
36
+ file: string;
37
+ passed: boolean;
38
+ failures: string[];
39
+ /** The ids of the agent steps, in order. */
40
+ trace: string[];
41
+ ms: number;
42
+ }
43
+ /** Reads a test file: one test, or `tests:` with shared keys at the top. */
44
+ export declare function loadTests(file: string): TestCase[];
45
+ /** The test files in the given files and folders. */
46
+ export declare function findTests(targets: string[]): string[];
47
+ export declare function runTest(test: TestCase): TestResult;
48
+ /** Runs the tests of the given files and folders. */
49
+ export declare function runTests(targets: string[]): TestResult[];
50
+ export {};
@@ -0,0 +1,233 @@
1
+ // Deterministic flow tests: the flow runs for real, and fixed answers stand in for the agent.
2
+ import { spawnSync } from 'node:child_process';
3
+ import fs from 'node:fs';
4
+ import os from 'node:os';
5
+ import path from 'node:path';
6
+ import yaml from 'js-yaml';
7
+ import { done, start } from './api.js';
8
+ import { readState } from './state.js';
9
+ import { rootResults } from './engine.js';
10
+ const MAX_STEPS = 500;
11
+ const isRegex = (value) => typeof value === 'string' && value.length > 1 && value.startsWith('/') && value.endsWith('/');
12
+ function matches(expected, actual) {
13
+ if (isRegex(expected))
14
+ return new RegExp(expected.slice(1, -1)).test(typeof actual === 'string' ? actual : JSON.stringify(actual));
15
+ return JSON.stringify(expected) === JSON.stringify(actual);
16
+ }
17
+ /** `{{cwd}}` and `{{dir}}` in an answer become the working directory and the folder of the test file. */
18
+ function substitute(value, vars) {
19
+ if (typeof value === 'string')
20
+ return value.replace(/\{\{(\w+)\}\}/g, (all, key) => vars[key] ?? all);
21
+ if (Array.isArray(value))
22
+ return value.map((item) => substitute(item, vars));
23
+ if (value && typeof value === 'object')
24
+ return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, substitute(v, vars)]));
25
+ return value;
26
+ }
27
+ /** Reads a test file: one test, or `tests:` with shared keys at the top. */
28
+ export function loadTests(file) {
29
+ const raw = yaml.load(fs.readFileSync(file, 'utf8'));
30
+ const { tests, ...shared } = raw;
31
+ const list = tests ?? [{}];
32
+ return list.map((test, index) => {
33
+ // env and path add to the shared ones; the other keys replace them.
34
+ const merged = {
35
+ ...shared,
36
+ ...test,
37
+ env: { ...shared.env, ...test.env },
38
+ path: [...(test.path ?? []), ...(shared.path ?? [])],
39
+ };
40
+ if (!merged.flow)
41
+ throw new Error(`${file}: a test needs a flow`);
42
+ return { ...merged, flow: merged.flow, file, name: merged.name ?? (tests ? `test ${index + 1}` : path.basename(file)) };
43
+ });
44
+ }
45
+ /** The test files in the given files and folders. */
46
+ export function findTests(targets) {
47
+ const found = [];
48
+ const walk = (target) => {
49
+ const stat = fs.statSync(target);
50
+ if (stat.isFile())
51
+ found.push(target);
52
+ else
53
+ for (const entry of fs.readdirSync(target, { withFileTypes: true })) {
54
+ if (entry.name === 'node_modules' || entry.name === '.git')
55
+ continue;
56
+ const child = path.join(target, entry.name);
57
+ if (entry.isDirectory())
58
+ walk(child);
59
+ else if (entry.name.endsWith('.test.yaml') || entry.name.endsWith('.test.yml'))
60
+ found.push(child);
61
+ }
62
+ };
63
+ for (const target of targets)
64
+ walk(target);
65
+ return found.sort();
66
+ }
67
+ function withEnv(env, fn) {
68
+ const saved = Object.fromEntries(Object.keys(env).map((key) => [key, process.env[key]]));
69
+ for (const [key, value] of Object.entries(env)) {
70
+ if (value === undefined)
71
+ delete process.env[key];
72
+ else
73
+ process.env[key] = value;
74
+ }
75
+ try {
76
+ return fn();
77
+ }
78
+ finally {
79
+ for (const [key, value] of Object.entries(saved)) {
80
+ if (value === undefined)
81
+ delete process.env[key];
82
+ else
83
+ process.env[key] = value;
84
+ }
85
+ }
86
+ }
87
+ function prepare(test, dir, cwd) {
88
+ if (test.fixture)
89
+ fs.cpSync(path.resolve(dir, test.fixture), cwd, { recursive: true });
90
+ const git = (...args) => spawnSync('git', args, { cwd, encoding: 'utf8', env: { ...process.env, GIT_AUTHOR_NAME: 'skill-rails', GIT_AUTHOR_EMAIL: 'test@skill-rails', GIT_COMMITTER_NAME: 'skill-rails', GIT_COMMITTER_EMAIL: 'test@skill-rails' } });
91
+ if (test.git !== false) {
92
+ git('init', '-q', '-b', 'main');
93
+ git('add', '-A');
94
+ git('commit', '-q', '--allow-empty', '-m', 'fixture');
95
+ }
96
+ if (test.setup) {
97
+ const result = spawnSync('bash', ['-eo', 'pipefail', '-c', test.setup], { cwd, encoding: 'utf8', env: process.env });
98
+ if (result.status !== 0)
99
+ throw new Error(`setup failed: ${result.stderr || result.stdout}`);
100
+ }
101
+ }
102
+ export function runTest(test) {
103
+ const began = Date.now();
104
+ const dir = path.dirname(path.resolve(test.file));
105
+ const failures = [];
106
+ const trace = [];
107
+ const result = (passed = failures.length === 0) => ({ name: test.name, file: test.file, passed, failures, trace, ms: Date.now() - began });
108
+ const stateDir = fs.mkdtempSync(path.join(os.tmpdir(), 'skill-rails-state-'));
109
+ const cwd = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'skill-rails-run-')));
110
+ const vars = { cwd, dir };
111
+ const pathPrefix = (test.path ?? []).map((p) => path.resolve(dir, p)).join(path.delimiter);
112
+ const env = {
113
+ ...substitute(test.env ?? {}, vars),
114
+ SKILL_RAILS_STATE_DIR: stateDir,
115
+ ...(pathPrefix ? { PATH: `${pathPrefix}${path.delimiter}${process.env.PATH ?? ''}` } : {}),
116
+ };
117
+ return withEnv(env, () => {
118
+ try {
119
+ prepare(test, dir, cwd);
120
+ }
121
+ catch (error) {
122
+ failures.push(error.message);
123
+ return result();
124
+ }
125
+ const answers = substitute(test.answers ?? {}, vars);
126
+ const used = new Map();
127
+ const flowFile = path.resolve(dir, test.flow);
128
+ const notes = [];
129
+ const collect = (r) => {
130
+ if ('notes' in r && r.notes)
131
+ notes.push(...r.notes);
132
+ return r;
133
+ };
134
+ let report = collect(start({ file: flowFile, inputs: substitute(test.inputs ?? {}, vars), cwd }));
135
+ let flowName = 'status' in report && 'flow' in report ? report.flow : '';
136
+ for (let i = 0; report.status === 'step' && i < MAX_STEPS; i++) {
137
+ const id = report.id;
138
+ trace.push(id);
139
+ const given = answers[id];
140
+ const count = used.get(id) ?? 0;
141
+ const answer = Array.isArray(given) ? given[count] : given;
142
+ if (!answer) {
143
+ failures.push(given
144
+ ? `the flow asked for step "${id}" a ${count + 1}th time, and the test has ${count} answers for it`
145
+ : `the flow asked for step "${id}" (${report.type}), and the test has no answer for it`);
146
+ break;
147
+ }
148
+ used.set(id, count + 1);
149
+ const { $files, $fail, ...output } = answer;
150
+ for (const [rel, content] of Object.entries($files ?? {})) {
151
+ const target = path.resolve(cwd, rel);
152
+ fs.mkdirSync(path.dirname(target), { recursive: true });
153
+ fs.writeFileSync(target, content);
154
+ }
155
+ const next = done({ flow: flowName, id, output: $fail === undefined ? output : undefined, fail: $fail, cwd });
156
+ if (next.status === 'invalid') {
157
+ failures.push(`the answer of step "${id}" is not valid: ${next.errors.join('; ')}`);
158
+ break;
159
+ }
160
+ report = collect(next);
161
+ }
162
+ if (report.status === 'error')
163
+ failures.push(`the flow has errors: ${report.errors.join('; ')}`);
164
+ for (const [id, given] of Object.entries(answers)) {
165
+ if (failures.length)
166
+ break;
167
+ const count = used.get(id) ?? 0;
168
+ if (!count)
169
+ failures.push(`the flow never asked for step "${id}"`);
170
+ else if (Array.isArray(given) && count < given.length)
171
+ failures.push(`the flow asked for step "${id}" ${count} times, and the test has ${given.length} answers for it`);
172
+ }
173
+ const expect = test.expect ?? {};
174
+ const status = report.status;
175
+ if (failures.length === 0) {
176
+ if (expect.status && status !== expect.status)
177
+ failures.push(`status: expected ${expect.status}, got ${status}`);
178
+ const message = 'message' in report ? report.message : null;
179
+ if (expect.message !== undefined && !matches(expect.message, message))
180
+ failures.push(`message: expected ${JSON.stringify(expect.message)}, got ${JSON.stringify(message)}`);
181
+ let steps = {};
182
+ try {
183
+ flowName ||= report.flow ?? '';
184
+ steps = rootResults(readState(flowName, cwd));
185
+ }
186
+ catch {
187
+ // the flow has no state: a flow file error
188
+ }
189
+ for (const [id, outcome] of Object.entries(expect.steps ?? {})) {
190
+ const actual = steps[id]?.outcome ?? 'not reached';
191
+ if (actual !== outcome)
192
+ failures.push(`step "${id}": expected ${outcome}, got ${actual}`);
193
+ }
194
+ for (const [key, expected] of Object.entries(expect.outputs ?? {})) {
195
+ const [id, ...rest] = key.split('.');
196
+ const actual = steps[id ?? '']?.outputs?.[rest.join('.')];
197
+ if (!matches(expected, actual ?? null))
198
+ failures.push(`output ${key}: expected ${JSON.stringify(expected)}, got ${JSON.stringify(actual ?? null)}`);
199
+ }
200
+ for (const expected of expect.notes ?? []) {
201
+ if (!notes.some((note) => matches(expected, note)))
202
+ failures.push(`notes: no note matches ${JSON.stringify(expected)} (got ${JSON.stringify(notes)})`);
203
+ }
204
+ for (const [rel, expected] of Object.entries(expect.files ?? {})) {
205
+ const target = path.resolve(cwd, rel);
206
+ const exists = fs.existsSync(target);
207
+ if (expected === 'exists' || expected === 'absent') {
208
+ if (exists !== (expected === 'exists'))
209
+ failures.push(`file ${rel}: expected ${expected}`);
210
+ }
211
+ else if (!exists)
212
+ failures.push(`file ${rel}: expected it to exist`);
213
+ else if (!matches(expected, fs.readFileSync(target, 'utf8')))
214
+ failures.push(`file ${rel}: the content does not match ${JSON.stringify(expected)}`);
215
+ }
216
+ }
217
+ fs.rmSync(cwd, { recursive: true, force: true });
218
+ fs.rmSync(stateDir, { recursive: true, force: true });
219
+ return result();
220
+ });
221
+ }
222
+ /** Runs the tests of the given files and folders. */
223
+ export function runTests(targets) {
224
+ return findTests(targets).flatMap((file) => {
225
+ try {
226
+ return loadTests(file).map(runTest);
227
+ }
228
+ catch (error) {
229
+ return [{ name: path.basename(file), file, passed: false, failures: [error.message], trace: [], ms: 0 }];
230
+ }
231
+ });
232
+ }
233
+ //# sourceMappingURL=testing.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG1C,MAAM,SAAS,GAAG,GAAG,CAAC;AA8CtB,MAAM,OAAO,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAEnJ,SAAS,OAAO,CAAC,QAAiB,EAAE,MAAe;IACjD,IAAI,OAAO,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IACnI,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED,yGAAyG;AACzG,SAAS,UAAU,CAAI,KAAQ,EAAE,IAA4B;IAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAM,CAAC;IACnH,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAM,CAAC;IAClF,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAM,CAAC;IACxI,OAAO,KAAK,CAAC;AACf,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAyE,CAAC;IAC7H,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC;IACjC,MAAM,IAAI,GAAG,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC9B,oEAAoE;QACpE,MAAM,MAAM,GAAG;YACb,GAAG,MAAM;YACT,GAAG,IAAI;YACP,GAAG,EAAE,EAAE,GAAI,MAAM,CAAC,GAAc,EAAE,GAAI,IAAI,CAAC,GAAc,EAAE;YAC3D,IAAI,EAAE,CAAC,GAAG,CAAE,IAAI,CAAC,IAAiB,IAAI,EAAE,CAAC,EAAE,GAAG,CAAE,MAAM,CAAC,IAAiB,IAAI,EAAE,CAAC,CAAC;SAC5D,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,uBAAuB,CAAC,CAAC;QAClE,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAc,CAAC;IACtI,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,SAAS,CAAC,OAAiB;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,EAAE;QAC9B,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEpC,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBACpE,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;oBAAE,SAAS;gBACrE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC5C,IAAI,KAAK,CAAC,WAAW,EAAE;oBAAE,IAAI,CAAC,KAAK,CAAC,CAAC;qBAChC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpG,CAAC;IACL,CAAC,CAAC;IACF,KAAK,MAAM,MAAM,IAAI,OAAO;QAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;AACtB,CAAC;AAED,SAAS,OAAO,CAAI,GAAuC,EAAE,EAAW;IACtE,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;;YAC5C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAChC,CAAC;IACD,IAAI,CAAC;QACH,OAAO,EAAE,EAAE,CAAC;IACd,CAAC;YAAS,CAAC;QACT,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;;gBAC5C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAChC,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,OAAO,CAAC,IAAc,EAAE,GAAW,EAAE,GAAW;IACvD,IAAI,IAAI,CAAC,OAAO;QAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvF,MAAM,GAAG,GAAG,CAAC,GAAG,IAAc,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,eAAe,EAAE,aAAa,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,aAAa,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAChQ,IAAI,IAAI,CAAC,GAAG,KAAK,KAAK,EAAE,CAAC;QACvB,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAChC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjB,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QACrH,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,IAAc;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAc,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IAEvJ,MAAM,QAAQ,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC9E,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IACxF,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IAC1B,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3F,MAAM,GAAG,GAAG;QACV,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE,IAAI,CAAC;QACnC,qBAAqB,EAAE,QAAQ;QAC/B,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3F,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE;QACvB,IAAI,CAAC;YACH,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC;YACxC,OAAO,MAAM,EAAE,CAAC;QAClB,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,CAAC,CAAS,EAAU,EAAE;YACpC,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YACpD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QACF,IAAI,MAAM,GAAW,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAC1G,IAAI,QAAQ,GAAG,QAAQ,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,CAAC,CAAC,CAAE,MAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAE/F,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/D,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC3D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,QAAQ,CAAC,IAAI,CACX,KAAK;oBACH,CAAC,CAAC,4BAA4B,EAAE,OAAO,KAAK,GAAG,CAAC,6BAA6B,KAAK,iBAAiB;oBACnG,CAAC,CAAC,4BAA4B,EAAE,MAAM,MAAM,CAAC,IAAI,sCAAsC,CAC1F,CAAC;gBACF,MAAM;YACR,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACxB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,GAAG,MAAuF,CAAC;YAC7H,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBACtC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACxD,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9G,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC9B,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,mBAAmB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACpF,MAAM;YACR,CAAC;YACD,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,wBAAwB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjG,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAClD,IAAI,QAAQ,CAAC,MAAM;gBAAE,MAAM;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK;gBAAE,QAAQ,CAAC,IAAI,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;iBAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM;gBAAE,QAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,KAAK,KAAK,4BAA4B,KAAK,CAAC,MAAM,iBAAiB,CAAC,CAAC;QAC1K,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,KAAK,MAAM,CAAC,MAAM;gBAAE,QAAQ,CAAC,IAAI,CAAC,oBAAoB,MAAM,CAAC,MAAM,SAAS,MAAM,EAAE,CAAC,CAAC;YACjH,MAAM,OAAO,GAAG,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YAC5D,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;gBAAE,QAAQ,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC5K,IAAI,KAAK,GAA+B,EAAE,CAAC;YAC3C,IAAI,CAAC;gBACH,QAAQ,KAAM,MAA4B,CAAC,IAAI,IAAI,EAAE,CAAC;gBACtD,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;YAChD,CAAC;YAAC,MAAM,CAAC;gBACP,2CAA2C;YAC7C,CAAC;YACD,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC/D,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,IAAI,aAAa,CAAC;gBACnD,IAAI,MAAM,KAAK,OAAO;oBAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,OAAO,SAAS,MAAM,EAAE,CAAC,CAAC;YAC5F,CAAC;YACD,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;gBACnE,MAAM,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,IAAI,IAAI,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,GAAG,cAAc,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC;YACtJ,CAAC;YACD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;gBAC1C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzJ,CAAC;YACD,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;gBACjE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBACtC,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBACrC,IAAI,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBACnD,IAAI,MAAM,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC;wBAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,GAAG,cAAc,QAAQ,EAAE,CAAC,CAAC;gBAC7F,CAAC;qBAAM,IAAI,CAAC,MAAM;oBAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,GAAG,wBAAwB,CAAC,CAAC;qBAClE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,GAAG,gCAAgC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrJ,CAAC;QACH,CAAC;QACD,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACjD,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,OAAO,MAAM,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,QAAQ,CAAC,OAAiB;IACxC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACzC,IAAI,CAAC;YACH,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAE,KAAe,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACtH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,200 @@
1
+ export type JsonObject = {
2
+ [key: string]: unknown;
3
+ };
4
+ export interface InputSpec {
5
+ type?: 'string' | 'boolean' | 'number';
6
+ default?: string | boolean | number;
7
+ required?: boolean;
8
+ description?: string;
9
+ }
10
+ export type Condition = string | boolean;
11
+ interface BaseStep {
12
+ id?: string;
13
+ if?: Condition;
14
+ }
15
+ export interface RunStep extends BaseStep {
16
+ run: string;
17
+ env?: Record<string, unknown>;
18
+ 'continue-on-error'?: boolean;
19
+ /** Poll: run again until this condition is true. */
20
+ until?: Condition;
21
+ 'interval-seconds'?: number;
22
+ 'timeout-minutes'?: number;
23
+ }
24
+ export interface ForeachStep extends BaseStep {
25
+ id: string;
26
+ /** An expression that gives a list, or a list. */
27
+ foreach: string | unknown[];
28
+ steps: Step[];
29
+ }
30
+ export interface UsesStep extends BaseStep {
31
+ id: string;
32
+ /** The flow file, relative to the flow that uses it. */
33
+ uses: string;
34
+ with?: Record<string, unknown>;
35
+ 'continue-on-error'?: boolean;
36
+ /** The loaded flow. */
37
+ flow?: Flow;
38
+ }
39
+ export interface SkillStep extends BaseStep {
40
+ id: string;
41
+ skill: string;
42
+ with?: string;
43
+ prompt?: string;
44
+ 'prompt-file'?: string;
45
+ output?: JsonObject;
46
+ }
47
+ export interface PromptStep extends BaseStep {
48
+ id: string;
49
+ prompt?: string;
50
+ 'prompt-file'?: string;
51
+ output?: JsonObject;
52
+ }
53
+ export interface Option {
54
+ label: string;
55
+ description: string;
56
+ /** Text that the question tool shows next to the option, for example a draft to approve. */
57
+ preview?: string;
58
+ }
59
+ export interface Question {
60
+ id: string;
61
+ if?: Condition;
62
+ question: string;
63
+ header: string;
64
+ multiSelect?: boolean;
65
+ /** The user answers with free text; the options are then suggestions. */
66
+ free?: boolean;
67
+ /** An option, or an expression that gives a list of options. */
68
+ options?: Array<Option | string>;
69
+ }
70
+ export interface AskStep extends BaseStep {
71
+ id: string;
72
+ ask: Question[];
73
+ }
74
+ export interface StopStep extends BaseStep {
75
+ stop: string;
76
+ outcome?: 'success' | 'failure';
77
+ }
78
+ export interface BreakStep extends BaseStep {
79
+ break: true;
80
+ }
81
+ export type Step = RunStep | SkillStep | PromptStep | AskStep | StopStep | ForeachStep | UsesStep | BreakStep;
82
+ export type StepKind = 'run' | 'skill' | 'prompt' | 'ask' | 'stop' | 'foreach' | 'uses' | 'break';
83
+ export interface Flow {
84
+ name: string;
85
+ description?: string;
86
+ inputs: Record<string, InputSpec>;
87
+ steps: Step[];
88
+ /** The folder of the flow file. */
89
+ dir: string;
90
+ }
91
+ export type InputValue = string | number | boolean | null;
92
+ export interface StepResult {
93
+ outcome: 'success' | 'failure' | 'skipped';
94
+ exitCode?: number;
95
+ outputs?: Record<string, unknown>;
96
+ }
97
+ export interface RenderedQuestion {
98
+ id: string;
99
+ question: string;
100
+ header: string;
101
+ multiSelect: boolean;
102
+ free: boolean;
103
+ options: Option[];
104
+ }
105
+ /** A step that waits for the agent. */
106
+ export interface PendingStep {
107
+ id: string;
108
+ type: 'skill' | 'prompt' | 'ask' | 'wait';
109
+ skill?: string;
110
+ args?: string;
111
+ instructions?: string;
112
+ questions?: RenderedQuestion[];
113
+ output?: JsonObject;
114
+ }
115
+ /** A running list of steps: the root flow, a sub-flow, or one iteration of a foreach. */
116
+ export interface Frame {
117
+ kind: 'root' | 'flow' | 'foreach';
118
+ /** The id of the step that started the frame (none for the root). */
119
+ id?: string;
120
+ name: string;
121
+ dir: string;
122
+ steps: Step[];
123
+ index: number;
124
+ inputs: Record<string, InputValue>;
125
+ results: Record<string, StepResult>;
126
+ /** foreach: the items, the current position, and the results of the finished iterations. */
127
+ items?: unknown[];
128
+ position?: number;
129
+ iterations?: Array<{
130
+ item: unknown;
131
+ steps: Record<string, StepResult>;
132
+ }>;
133
+ /** run steps with until: when the polling started. */
134
+ pollStarted?: number;
135
+ }
136
+ export interface State {
137
+ flow: Flow;
138
+ cwd: string;
139
+ /** The root frame first. */
140
+ frames: Frame[];
141
+ notes: string[];
142
+ status: 'running' | 'done' | 'failed';
143
+ pending: PendingStep | null;
144
+ message: string | null;
145
+ }
146
+ export interface Context {
147
+ inputs: Record<string, InputValue>;
148
+ steps: Record<string, StepResult>;
149
+ env: Record<string, string | undefined>;
150
+ flow: {
151
+ name: string;
152
+ dir: string;
153
+ };
154
+ item: unknown;
155
+ loop: {
156
+ index: number;
157
+ count: number;
158
+ } | null;
159
+ }
160
+ export interface RunOptions {
161
+ env?: Record<string, unknown>;
162
+ dir: string;
163
+ cwd: string;
164
+ timeoutMs?: number;
165
+ }
166
+ export interface RunResult {
167
+ outcome: 'success' | 'failure';
168
+ exitCode: number;
169
+ outputs: Record<string, string>;
170
+ warnings: string[];
171
+ stderr: string;
172
+ }
173
+ export type Exec = (command: string, options: RunOptions) => RunResult;
174
+ /** What the agent reads after each command. */
175
+ export type Report = ({
176
+ status: 'step';
177
+ flow: string;
178
+ notes?: string[];
179
+ } & PendingStep) | {
180
+ status: 'done' | 'failed' | 'running';
181
+ flow: string;
182
+ message: string | null;
183
+ notes?: string[];
184
+ } | {
185
+ status: 'invalid';
186
+ id: string;
187
+ errors: string[];
188
+ output?: JsonObject;
189
+ } | {
190
+ status: 'error';
191
+ errors: string[];
192
+ } | {
193
+ status: 'ok';
194
+ flow: string;
195
+ steps: number;
196
+ } | {
197
+ status: 'reset';
198
+ flow: string;
199
+ };
200
+ export {};
package/dist/types.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}