@kirrosh/zond 0.22.0 → 0.23.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 (256) hide show
  1. package/CHANGELOG.md +648 -0
  2. package/README.md +58 -6
  3. package/package.json +9 -6
  4. package/src/cli/argv.ts +122 -0
  5. package/src/cli/commands/add-api.ts +134 -0
  6. package/src/cli/commands/api/annotate/idempotency.ts +59 -0
  7. package/src/cli/commands/api/annotate/index.ts +525 -0
  8. package/src/cli/commands/api/annotate/lifecycle.ts +74 -0
  9. package/src/cli/commands/api/annotate/overlay.ts +206 -0
  10. package/src/cli/commands/api/annotate/pagination.ts +60 -0
  11. package/src/cli/commands/api/annotate/prompts.ts +183 -0
  12. package/src/cli/commands/api/annotate/readback.ts +58 -0
  13. package/src/cli/commands/api/annotate/resources.ts +91 -0
  14. package/src/cli/commands/api/annotate/seed-bodies.ts +61 -0
  15. package/src/cli/commands/audit.ts +480 -0
  16. package/src/cli/commands/bootstrap.ts +710 -0
  17. package/src/cli/commands/catalog.ts +35 -0
  18. package/src/cli/commands/check.ts +348 -0
  19. package/src/cli/commands/checks.ts +756 -0
  20. package/src/cli/commands/ci-init.ts +43 -0
  21. package/src/cli/commands/clean.ts +212 -0
  22. package/src/cli/commands/cleanup.ts +262 -0
  23. package/src/cli/commands/completions.ts +16 -0
  24. package/src/cli/commands/coverage.ts +605 -132
  25. package/src/cli/commands/db.ts +178 -7
  26. package/src/cli/commands/describe.ts +37 -2
  27. package/src/cli/commands/discover.ts +1236 -0
  28. package/src/cli/commands/doctor.ts +607 -0
  29. package/src/cli/commands/fixtures.ts +402 -0
  30. package/src/cli/commands/generate.ts +420 -46
  31. package/src/cli/commands/init/bootstrap.ts +30 -1
  32. package/src/cli/commands/{init.ts → init/index.ts} +99 -5
  33. package/src/cli/commands/init/skills.ts +56 -3
  34. package/src/cli/commands/init/templates/agents.md +65 -61
  35. package/src/cli/commands/init/templates/skills/zond-checks.md +397 -0
  36. package/src/cli/commands/init/templates/skills/zond-triage.md +210 -0
  37. package/src/cli/commands/init/templates/skills/zond.md +592 -125
  38. package/src/cli/commands/init/templates/zond-config.yml +8 -9
  39. package/src/cli/commands/prepare-fixtures.ts +135 -0
  40. package/src/cli/commands/probe/mass-assignment.ts +503 -0
  41. package/src/cli/commands/probe/security.ts +454 -0
  42. package/src/cli/commands/probe/static.ts +255 -0
  43. package/src/cli/commands/probe/webhooks.ts +161 -0
  44. package/src/cli/commands/probe.ts +459 -0
  45. package/src/cli/commands/reference.ts +87 -0
  46. package/src/cli/commands/refresh-api.ts +169 -0
  47. package/src/cli/commands/remove-api.ts +150 -0
  48. package/src/cli/commands/report-bundle.ts +318 -0
  49. package/src/cli/commands/report.ts +241 -0
  50. package/src/cli/commands/request.ts +379 -4
  51. package/src/cli/commands/run.ts +842 -53
  52. package/src/cli/commands/session.ts +244 -0
  53. package/src/cli/commands/use.ts +18 -1
  54. package/src/cli/index.ts +20 -3
  55. package/src/cli/json-envelope.ts +112 -3
  56. package/src/cli/json-schemas.ts +263 -0
  57. package/src/cli/program.ts +198 -635
  58. package/src/cli/resolve.ts +105 -0
  59. package/src/cli/status-filter.ts +124 -0
  60. package/src/cli/util/api-context.ts +85 -0
  61. package/src/cli/version.ts +5 -0
  62. package/src/core/anti-fp/bootstrap.ts +34 -0
  63. package/src/core/anti-fp/index.ts +33 -0
  64. package/src/core/anti-fp/registry.ts +44 -0
  65. package/src/core/anti-fp/rules/baseline-echo.ts +74 -0
  66. package/src/core/anti-fp/rules/schemathesis/body_negation_becomes_valid.ts +52 -0
  67. package/src/core/anti-fp/rules/schemathesis/coverage_phase_boundary_positive.ts +38 -0
  68. package/src/core/anti-fp/rules/schemathesis/has_unverifiable_mutations.ts +35 -0
  69. package/src/core/anti-fp/rules/schemathesis/index.ts +24 -0
  70. package/src/core/anti-fp/rules/schemathesis/string_type_mutation_becomes_valid.ts +53 -0
  71. package/src/core/anti-fp/rules/subscription-gated/index.ts +11 -0
  72. package/src/core/anti-fp/rules/subscription-gated/paid-plan-403.ts +75 -0
  73. package/src/core/anti-fp/types.ts +68 -0
  74. package/src/core/checks/checks/_crud-helpers.ts +133 -0
  75. package/src/core/checks/checks/_negative_mutator.ts +133 -0
  76. package/src/core/checks/checks/_readback-helpers.ts +133 -0
  77. package/src/core/checks/checks/content_type_conformance.ts +39 -0
  78. package/src/core/checks/checks/cross_call_references.ts +134 -0
  79. package/src/core/checks/checks/ensure_resource_availability.ts +62 -0
  80. package/src/core/checks/checks/idempotency_replay.ts +246 -0
  81. package/src/core/checks/checks/ignored_auth.ts +211 -0
  82. package/src/core/checks/checks/index.ts +65 -0
  83. package/src/core/checks/checks/lifecycle_transitions.ts +273 -0
  84. package/src/core/checks/checks/missing_required_header.ts +40 -0
  85. package/src/core/checks/checks/negative_data_rejection.ts +45 -0
  86. package/src/core/checks/checks/not_a_server_error.ts +27 -0
  87. package/src/core/checks/checks/open_cors_on_sensitive.ts +131 -0
  88. package/src/core/checks/checks/pagination_invariants.ts +238 -0
  89. package/src/core/checks/checks/positive_data_acceptance.ts +36 -0
  90. package/src/core/checks/checks/rate_limit_headers_absent.ts +77 -0
  91. package/src/core/checks/checks/response_headers_conformance.ts +74 -0
  92. package/src/core/checks/checks/response_schema_conformance.ts +30 -0
  93. package/src/core/checks/checks/status_code_conformance.ts +61 -0
  94. package/src/core/checks/checks/unsupported_method.ts +63 -0
  95. package/src/core/checks/checks/use_after_free.ts +78 -0
  96. package/src/core/checks/index.ts +30 -0
  97. package/src/core/checks/mode.ts +79 -0
  98. package/src/core/checks/recommended-action.ts +64 -0
  99. package/src/core/checks/registry.ts +78 -0
  100. package/src/core/checks/runner.ts +874 -0
  101. package/src/core/checks/sarif.ts +230 -0
  102. package/src/core/checks/stateful.ts +121 -0
  103. package/src/core/checks/types.ts +189 -0
  104. package/src/core/classifier/recommended-action.ts +222 -0
  105. package/src/core/context/current.ts +22 -6
  106. package/src/core/context/session.ts +78 -0
  107. package/src/core/coverage/loader.ts +185 -0
  108. package/src/core/coverage/reasons.ts +300 -0
  109. package/src/core/diagnostics/db-analysis.ts +151 -11
  110. package/src/core/diagnostics/failure-class.ts +120 -0
  111. package/src/core/diagnostics/failure-hints.ts +212 -9
  112. package/src/core/diagnostics/spec-pointer.ts +99 -0
  113. package/src/core/diagnostics/suggested-fixes.ts +156 -0
  114. package/src/core/exporter/case-study/index.ts +270 -0
  115. package/src/core/exporter/curl.ts +40 -0
  116. package/src/core/exporter/exporter.ts +48 -0
  117. package/src/core/exporter/html-report/escape.ts +24 -0
  118. package/src/core/exporter/html-report/index.ts +479 -0
  119. package/src/core/exporter/html-report/script.ts +100 -0
  120. package/src/core/exporter/html-report/styles.ts +408 -0
  121. package/src/core/generator/chunker.ts +42 -16
  122. package/src/core/generator/coverage-phase.ts +0 -0
  123. package/src/core/generator/create-body.ts +89 -0
  124. package/src/core/generator/data-factory.ts +445 -19
  125. package/src/core/generator/describe.ts +1 -1
  126. package/src/core/generator/fixtures-builder.ts +325 -0
  127. package/src/core/generator/index.ts +7 -5
  128. package/src/core/generator/openapi-reader.ts +37 -3
  129. package/src/core/generator/path-param-disambig.ts +114 -0
  130. package/src/core/generator/resources-builder.ts +648 -0
  131. package/src/core/generator/schema-utils.ts +11 -3
  132. package/src/core/generator/serializer.ts +103 -13
  133. package/src/core/generator/suite-generator.ts +419 -111
  134. package/src/core/generator/types.ts +8 -0
  135. package/src/core/identity/identity-file.ts +129 -0
  136. package/src/core/lint/affects.ts +28 -0
  137. package/src/core/lint/config.ts +96 -0
  138. package/src/core/lint/format.ts +42 -0
  139. package/src/core/lint/index.ts +94 -0
  140. package/src/core/lint/reporter.ts +128 -0
  141. package/src/core/lint/rules/consistency.ts +158 -0
  142. package/src/core/lint/rules/heuristics.ts +97 -0
  143. package/src/core/lint/rules/strictness.ts +109 -0
  144. package/src/core/lint/types.ts +96 -0
  145. package/src/core/lint/walker.ts +248 -0
  146. package/src/core/meta/meta-store.ts +6 -73
  147. package/src/core/output/README.md +91 -0
  148. package/src/core/output/index.ts +13 -0
  149. package/src/core/output/run.ts +126 -0
  150. package/src/core/output/types.ts +129 -0
  151. package/src/core/parser/env-interpolation.ts +104 -0
  152. package/src/core/parser/filter.ts +57 -0
  153. package/src/core/parser/schema.ts +129 -4
  154. package/src/core/parser/types.ts +19 -1
  155. package/src/core/parser/variables.ts +0 -0
  156. package/src/core/parser/yaml-parser.ts +58 -12
  157. package/src/core/probe/bootstrap.ts +34 -0
  158. package/src/core/probe/dry-run-envelope.ts +57 -0
  159. package/src/core/probe/mass-assignment-probe-class.ts +198 -0
  160. package/src/core/probe/mass-assignment-probe.ts +1122 -0
  161. package/src/core/probe/mass-assignment-template.ts +212 -0
  162. package/src/core/probe/method-probe.ts +43 -76
  163. package/src/core/probe/method-shared.ts +69 -0
  164. package/src/core/probe/negative-probe.ts +183 -149
  165. package/src/core/probe/orphan-tracker.ts +188 -0
  166. package/src/core/probe/path-discovery.ts +440 -0
  167. package/src/core/probe/probe-harness.ts +120 -0
  168. package/src/core/probe/registry.ts +89 -0
  169. package/src/core/probe/runner.ts +136 -0
  170. package/src/core/probe/security-probe-class.ts +201 -0
  171. package/src/core/probe/security-probe.ts +1453 -0
  172. package/src/core/probe/shared.ts +505 -0
  173. package/src/core/probe/static-probe-class.ts +125 -0
  174. package/src/core/probe/types.ts +165 -0
  175. package/src/core/probe/verdict-aggregator.ts +33 -0
  176. package/src/core/probe/webhooks-probe.ts +284 -0
  177. package/src/core/reporter/console.ts +41 -2
  178. package/src/core/reporter/index.ts +2 -3
  179. package/src/core/reporter/json.ts +11 -1
  180. package/src/core/reporter/junit.ts +27 -12
  181. package/src/core/reporter/ndjson.ts +37 -0
  182. package/src/core/reporter/types.ts +3 -0
  183. package/src/core/runner/assertions.ts +58 -1
  184. package/src/core/runner/async-pool.ts +108 -0
  185. package/src/core/runner/auth-path.ts +8 -0
  186. package/src/core/runner/ci-context.ts +72 -0
  187. package/src/core/runner/executor.ts +264 -20
  188. package/src/core/runner/form-encode.ts +51 -0
  189. package/src/core/runner/http-client.ts +75 -2
  190. package/src/core/runner/learn-drift.ts +293 -0
  191. package/src/core/runner/preflight-vars.ts +149 -0
  192. package/src/core/runner/progress-tracker.ts +73 -0
  193. package/src/core/runner/rate-limiter.ts +89 -17
  194. package/src/core/runner/run-kind.ts +39 -0
  195. package/src/core/runner/schema-validator.ts +312 -0
  196. package/src/core/runner/send-request.ts +153 -20
  197. package/src/core/runner/types.ts +38 -0
  198. package/src/core/secrets/registry.ts +164 -0
  199. package/src/core/secrets/secrets-file.ts +115 -0
  200. package/src/core/selectors/operation-filter.ts +144 -0
  201. package/src/core/setup-api.ts +415 -16
  202. package/src/core/severity/category.ts +94 -0
  203. package/src/core/severity/index.ts +121 -0
  204. package/src/core/spec/layers.ts +154 -0
  205. package/src/core/util/format-eta.ts +21 -0
  206. package/src/core/utils.ts +5 -1
  207. package/src/core/workspace/config.ts +129 -0
  208. package/src/core/workspace/manifest.ts +283 -0
  209. package/src/core/workspace/output-rotation.ts +62 -0
  210. package/src/core/workspace/triage-path.ts +87 -0
  211. package/src/db/lint-runs.ts +47 -0
  212. package/src/db/migrate.ts +126 -0
  213. package/src/db/migrations/0001_run_kind.sql +25 -0
  214. package/src/db/migrations/sql.d.ts +4 -0
  215. package/src/db/queries/collections.ts +133 -0
  216. package/src/db/queries/coverage.ts +9 -0
  217. package/src/db/queries/dashboard.ts +59 -0
  218. package/src/db/queries/results.ts +128 -0
  219. package/src/db/queries/runs.ts +235 -0
  220. package/src/db/queries/sessions.ts +42 -0
  221. package/src/db/queries/settings.ts +28 -0
  222. package/src/db/queries/types.ts +172 -0
  223. package/src/db/queries.ts +72 -802
  224. package/src/db/schema.ts +178 -50
  225. package/src/cli/commands/export.ts +0 -144
  226. package/src/cli/commands/guide.ts +0 -127
  227. package/src/cli/commands/init/templates/skills/scenarios.md +0 -97
  228. package/src/cli/commands/probe-methods.ts +0 -108
  229. package/src/cli/commands/probe-validation.ts +0 -124
  230. package/src/cli/commands/serve.ts +0 -114
  231. package/src/cli/commands/sync.ts +0 -268
  232. package/src/cli/commands/update.ts +0 -189
  233. package/src/cli/commands/validate.ts +0 -34
  234. package/src/core/diagnostics/render-md.ts +0 -112
  235. package/src/core/exporter/postman.ts +0 -963
  236. package/src/core/generator/guide-builder.ts +0 -253
  237. package/src/core/meta/types.ts +0 -19
  238. package/src/core/parser/index.ts +0 -21
  239. package/src/core/runner/execute-run.ts +0 -132
  240. package/src/core/runner/index.ts +0 -12
  241. package/src/core/sync/spec-differ.ts +0 -38
  242. package/src/web/data/collection-state.ts +0 -362
  243. package/src/web/routes/api.ts +0 -314
  244. package/src/web/routes/dashboard.ts +0 -350
  245. package/src/web/routes/runs.ts +0 -64
  246. package/src/web/schemas.ts +0 -121
  247. package/src/web/server.ts +0 -134
  248. package/src/web/static/htmx.min.cjs +0 -1
  249. package/src/web/static/style.css +0 -1148
  250. package/src/web/views/endpoints-tab.ts +0 -174
  251. package/src/web/views/explorer-tab.ts +0 -402
  252. package/src/web/views/health-strip.ts +0 -92
  253. package/src/web/views/layout.ts +0 -48
  254. package/src/web/views/results.ts +0 -210
  255. package/src/web/views/runs-tab.ts +0 -126
  256. package/src/web/views/suites-tab.ts +0 -181
@@ -0,0 +1,241 @@
1
+ import { resolve } from "path";
2
+ import { getDb } from "../../db/schema.ts";
3
+ import {
4
+ getRunById,
5
+ getResultsByRunId,
6
+ getCollectionById,
7
+ } from "../../db/queries.ts";
8
+ import { renderHtmlReport } from "../../core/exporter/html-report/index.ts";
9
+ import { loadCoverage } from "../../core/coverage/loader.ts";
10
+ import type { CoverageMatrix } from "../../core/coverage/reasons.ts";
11
+ import { printError, printWarning } from "../output.ts";
12
+ import { applySanitizer } from "../../core/exporter/exporter.ts";
13
+ import { loadIdentityFromAncestor, redactIdentityIn } from "../../core/identity/identity-file.ts";
14
+ import { rotateOutputTarget } from "../../core/workspace/output-rotation.ts";
15
+ import { resolveTriageOutput } from "../../core/workspace/triage-path.ts";
16
+ import { recordGeneratedFile } from "../../core/workspace/manifest.ts";
17
+ import { findWorkspaceRoot } from "../../core/workspace/root.ts";
18
+ import { jsonOk, jsonError, printJson } from "../json-envelope.ts";
19
+ import { VERSION } from "../version.ts";
20
+
21
+ export interface ReportExportOptions {
22
+ runId: string;
23
+ output?: string;
24
+ api?: string;
25
+ dbPath?: string;
26
+ json?: boolean;
27
+ /** TASK-162 (m-9 P6): when true, overwrite existing target instead of
28
+ * rotating it to <stem>-vN<ext>. */
29
+ overwrite?: boolean;
30
+ /** TASK-164 (m-9 P8): cap each request/response body to N bytes
31
+ * (default 8192). Pass 0 to disable. */
32
+ bodyCapBytes?: number;
33
+ /** TASK-173 (m-10): replace every value from `.identity.yaml` with
34
+ * `<identity:<key>>`. Off by default; opt-in for outbound shares. */
35
+ redactIdentity?: boolean;
36
+ }
37
+
38
+ /** TASK-164: shared default cap. ≤ 8 KB per body keeps SaaS-class
39
+ * exports under ~150 KB while preserving the first page of every body. */
40
+ const DEFAULT_BODY_CAP_BYTES = 8192;
41
+
42
+ function parseRunId(raw: string): number | null {
43
+ const n = Number.parseInt(raw, 10);
44
+ return Number.isFinite(n) && n > 0 ? n : null;
45
+ }
46
+
47
+ export async function reportExportHtmlCommand(
48
+ options: ReportExportOptions,
49
+ ): Promise<number> {
50
+ const runId = parseRunId(options.runId);
51
+ if (runId == null) {
52
+ const msg = `Invalid run-id: ${options.runId}. Expected a positive integer.`;
53
+ if (options.json) printJson(jsonError("report export --html", [msg]));
54
+ else printError(msg);
55
+ return 2;
56
+ }
57
+
58
+ try {
59
+ getDb(options.dbPath);
60
+ } catch (err) {
61
+ const msg = `Failed to open database: ${(err as Error).message}`;
62
+ if (options.json) printJson(jsonError("report export --html", [msg]));
63
+ else printError(msg);
64
+ return 2;
65
+ }
66
+
67
+ const run = getRunById(runId);
68
+ if (!run) {
69
+ const msg = `Run #${runId} not found. List runs with: zond db runs`;
70
+ if (options.json) printJson(jsonError("report export --html", [msg]));
71
+ else printError(msg);
72
+ return 1;
73
+ }
74
+
75
+ const results = getResultsByRunId(runId);
76
+ const collection = run.collection_id != null ? getCollectionById(run.collection_id) : null;
77
+
78
+ // Try to enrich with the spec-aware coverage matrix (TASK-109). Best-effort:
79
+ // skip silently if no API can be resolved or the spec can't load.
80
+ let coverageMatrix: CoverageMatrix | undefined;
81
+ const apiName = options.api ?? collection?.name ?? null;
82
+ if (apiName) {
83
+ try {
84
+ const cov = await loadCoverage({ apiName, runId });
85
+ coverageMatrix = cov.matrix;
86
+ } catch {
87
+ // No registered API / missing spec — fall back to URL-only coverage.
88
+ }
89
+ }
90
+
91
+ const html = renderHtmlReport({
92
+ run,
93
+ results,
94
+ zondVersion: VERSION,
95
+ generatedAt: new Date(),
96
+ collectionName: collection?.name ?? null,
97
+ bodyCapBytes: options.bodyCapBytes ?? DEFAULT_BODY_CAP_BYTES,
98
+ ...(coverageMatrix ? { coverageMatrix } : {}),
99
+ });
100
+
101
+ // TASK-163 (m-9 P7): default to triage/<api>/<run>/ when --output is
102
+ // missing or just a filename. Explicit dir paths are honoured verbatim.
103
+ const triage = resolveTriageOutput({
104
+ command: "html",
105
+ runId,
106
+ api: apiName,
107
+ ext: "html",
108
+ userOutput: options.output,
109
+ });
110
+ const outputPath = triage.absolute;
111
+ const rotation = rotateOutputTarget(outputPath, { overwrite: options.overwrite });
112
+
113
+ try {
114
+ // TASK-168 (m-10): defensive redact pass on the final HTML. Most data
115
+ // is already redacted at DB-write time (TASK-167), but if the user
116
+ // re-ran the same session they may have just registered a new value
117
+ // — wrap the export so it can never out-pace the registry.
118
+ let payload = applySanitizer(html);
119
+ if (options.redactIdentity && collection?.base_dir) {
120
+ const id = loadIdentityFromAncestor(collection.base_dir);
121
+ if (id) payload = redactIdentityIn(payload, id.values);
122
+ }
123
+ await Bun.write(outputPath, payload);
124
+ // TASK-156: register so `zond clean --all` later removes it.
125
+ try {
126
+ const ws = findWorkspaceRoot();
127
+ if (!ws.fromFallback) {
128
+ recordGeneratedFile(ws.root, {
129
+ path: outputPath,
130
+ by: "zond report export",
131
+ api: apiName ?? undefined,
132
+ });
133
+ }
134
+ } catch { /* best-effort */ }
135
+ } catch (err) {
136
+ const msg = `Failed to write report: ${(err as Error).message}`;
137
+ if (options.json) printJson(jsonError("report export --html", [msg]));
138
+ else printError(msg);
139
+ return 2;
140
+ }
141
+
142
+ const sizeKb = Math.round(new Blob([html]).size / 1024);
143
+ const warnings: string[] = [];
144
+ if (sizeKb > 2048) {
145
+ warnings.push(`Report is ${sizeKb} KB (>2 MB) — consider trimming response bodies before re-running`);
146
+ }
147
+ if (rotation.rotatedTo) {
148
+ warnings.push(`Previous report rotated to ${rotation.rotatedTo}`);
149
+ }
150
+
151
+ if (options.json) {
152
+ printJson(
153
+ jsonOk(
154
+ "report export --html",
155
+ {
156
+ runId,
157
+ output: outputPath,
158
+ sizeKb,
159
+ totalSteps: results.length,
160
+ failures: results.filter((r) => r.status !== "pass" && r.status !== "skip").length,
161
+ },
162
+ warnings,
163
+ ),
164
+ );
165
+ } else {
166
+ for (const w of warnings) printWarning(w);
167
+ const failures = results.filter((r) => r.status !== "pass" && r.status !== "skip").length;
168
+ // TASK-241: status → stderr; stdout carries only the artifact path so
169
+ // shells/agents can do `out=$(zond report export <id>)` without parsing.
170
+ process.stderr.write(
171
+ `zond: wrote ${sizeKb} KB (${results.length} step${results.length === 1 ? "" : "s"}, ${failures} failure${failures === 1 ? "" : "s"})\n`,
172
+ );
173
+ process.stdout.write(`${outputPath}\n`);
174
+ }
175
+
176
+ return 0;
177
+ }
178
+
179
+
180
+ import type { Command } from "commander";
181
+ import { globalJson } from "../resolve.ts";
182
+ import { parsePositiveInt } from "../argv.ts";
183
+ import { reportBundleCommand, type BundleArtifact } from "./report-bundle.ts";
184
+
185
+ export function registerReport(program: Command): void {
186
+ const reportCmd = program.command("report").description("Export run reports for sharing");
187
+ reportCmd
188
+ .command("export <run-id>")
189
+ .description("Export a stored run as a single-file HTML report (shareable, openable in any browser)")
190
+ .option("--html", "Render as HTML (default and currently the only supported format)")
191
+ .option("-o, --output <file>", "Output file path (default: zond-run-<id>.html)")
192
+ .option("--api <name>", "Embed coverage map for this registered API (auto-detected from run.collection_id)")
193
+ .option("--db <path>", "Path to SQLite database file")
194
+ .option("--overwrite", "Overwrite existing --output file in place (default: rotate to <stem>-vN.<ext>)")
195
+ .option("--body-cap <n>", "Truncate request/response bodies to N bytes (default 8192). Set 0 / use --no-body-cap to disable.", parsePositiveInt("--body-cap"))
196
+ .option("--no-body-cap", "Keep full request/response bodies (overrides --body-cap)")
197
+ .option("--redact-identity", "Replace values from .identity.yaml with <identity:<key>> placeholders (for outbound sharing)")
198
+ .action(async (runId: string, opts, cmd: Command) => {
199
+ const bodyCapBytes = opts.bodyCap === false ? 0 : (typeof opts.bodyCap === "number" ? opts.bodyCap : undefined);
200
+ process.exitCode = await reportExportHtmlCommand({
201
+ runId,
202
+ output: opts.output,
203
+ api: opts.api,
204
+ dbPath: opts.db,
205
+ overwrite: opts.overwrite === true,
206
+ bodyCapBytes,
207
+ redactIdentity: opts.redactIdentity === true,
208
+ json: globalJson(cmd),
209
+ });
210
+ });
211
+
212
+ reportCmd
213
+ .command("bundle [range]")
214
+ .description("TASK-143: batch triage exporter — collect case-study + HTML report + diagnose JSON for a range of runs in one shot. <range> can be \"A..B\" (inclusive), \"A,B,C\" (list), or use --session <id>.")
215
+ .option("-o, --output <dir>", "Output directory (default: triage/bundle/<timestamp>/)")
216
+ .option("--session <id>", "Resolve runs by session_id instead of an explicit range")
217
+ .option(
218
+ "--include <artefacts>",
219
+ "Comma-separated subset of artefacts to write (default: all). One or more of: case-study, export, diagnose",
220
+ (val: string) => val.split(",").map(s => s.trim()).filter(Boolean),
221
+ )
222
+ .option("--db <path>", "Path to SQLite database file")
223
+ .option("--body-cap <n>", "Truncate request/response bodies to N bytes (default 8192). Pass 0 / use --no-body-cap to disable.", parsePositiveInt("--body-cap"))
224
+ .option("--no-body-cap", "Keep full request/response bodies (overrides --body-cap)")
225
+ .action(async (range: string | undefined, opts, cmd: Command) => {
226
+ const bodyCapBytes = opts.bodyCap === false ? 0 : (typeof opts.bodyCap === "number" ? opts.bodyCap : undefined);
227
+ const include = (opts.include as string[] | undefined)?.filter(
228
+ (a): a is BundleArtifact => a === "case-study" || a === "export" || a === "diagnose",
229
+ );
230
+ process.exitCode = await reportBundleCommand({
231
+ range,
232
+ sessionId: opts.session,
233
+ output: opts.output,
234
+ include,
235
+ dbPath: opts.db,
236
+ bodyCapBytes,
237
+ json: globalJson(cmd),
238
+ });
239
+ });
240
+
241
+ }
@@ -1,6 +1,81 @@
1
1
  import { sendAdHocRequest } from "../../core/runner/send-request.ts";
2
- import { printError } from "../output.ts";
3
- import { jsonOk, jsonError, printJson } from "../json-envelope.ts";
2
+ import { printError, printSuccess, printWarning } from "../output.ts";
3
+ import { jsonOk, jsonError, printJson, zerr } from "../json-envelope.ts";
4
+ import { existsSync, readdirSync } from "node:fs";
5
+ import { join } from "node:path";
6
+ import { createSchemaValidator } from "../../core/runner/schema-validator.ts";
7
+ import { readOpenApiSpec, extractEndpoints } from "../../core/generator/openapi-reader.ts";
8
+ import { resolveCollectionSpec } from "../../core/setup-api.ts";
9
+ import { findCollectionByNameOrId } from "../../db/queries.ts";
10
+ import { getDb } from "../../db/schema.ts";
11
+ import type { AssertionResult } from "../../core/runner/types.ts";
12
+
13
+ // TASK-272: when the request fails authentication (401/403) and the user
14
+ // did NOT pass `--api <name>`, surface a one-liner pointing at auto-auth via
15
+ // `apis/<name>/.secrets.yaml`. Only fires if an apis/ workspace exists in cwd
16
+ // (otherwise the hint is irrelevant). Also triggered when the headers contain a
17
+ // literal unexpanded shell-substitution shape ($(…) or `…`) — a tell-tale of a
18
+ // blocked-by-sandbox manual auth attempt.
19
+ function detectApisWorkspace(cwd: string): string[] {
20
+ const apisDir = join(cwd, "apis");
21
+ if (!existsSync(apisDir)) return [];
22
+ try {
23
+ return readdirSync(apisDir, { withFileTypes: true })
24
+ .filter((d) => d.isDirectory())
25
+ .map((d) => d.name);
26
+ } catch {
27
+ return [];
28
+ }
29
+ }
30
+
31
+ function looksLikeBlockedShellSubstitution(s: string | undefined): boolean {
32
+ if (!s) return false;
33
+ // unexpanded `$(...)` or backtick `...` with a likely secret-fetching command
34
+ return /\$\([^)]+\)|`[^`]+`/.test(s) && /yq|cat|jq|grep|awk|sed|sh /.test(s);
35
+ }
36
+
37
+ /** ARV-110 / ARV-144: pretty-print --json-path failure to stderr.
38
+ * Two distinct hints depending on the failure:
39
+ * - top-level array (reason starts with "expected an array index"):
40
+ * user wrote `data[0].id` against a body that's already an array →
41
+ * suggest `[0].id` / `0.id`.
42
+ * - envelope confusion (firstSeg in body/data, resolved is empty):
43
+ * user came from `--json | jq .data.body.id` and forgot that --json-path
44
+ * addresses the response body, not the envelope. */
45
+ function printJsonPathDiagnostic(
46
+ jsonPath: string | undefined,
47
+ diag: { resolved: string[]; failedAt?: string; reason?: string } | undefined,
48
+ ): void {
49
+ if (!jsonPath || !diag?.failedAt) return;
50
+ const resolved = diag.resolved.length > 0 ? diag.resolved.join(".") : "(root)";
51
+ process.stderr.write(
52
+ `zond: --json-path '${jsonPath}' did not resolve — stopped at segment "${diag.failedAt}" after ${resolved}: ${diag.reason ?? "unknown"}\n`,
53
+ );
54
+ const firstSeg = jsonPath.replace(/\[\d+\]/g, "").split(".")[0];
55
+ const isArrayMismatch = diag.resolved.length === 0 && /^expected an array index/.test(diag.reason ?? "");
56
+ if (isArrayMismatch) {
57
+ const tail = jsonPath.replace(/^[^.[]+/, "");
58
+ const suggestion = tail ? `[0]${tail.startsWith(".") || tail.startsWith("[") ? tail : "." + tail}` : "[0]";
59
+ process.stderr.write(
60
+ ` Hint: response body is a top-level array — use \`--json-path '${suggestion}'\` or \`--json-path '0${tail}'\` to index it.\n`,
61
+ );
62
+ return;
63
+ }
64
+ if ((firstSeg === "body" || firstSeg === "data") && diag.resolved.length === 0) {
65
+ process.stderr.write(
66
+ ` Hint: --json-path extracts from the response body, not the zond envelope. ` +
67
+ `To address the envelope's data.body.id, use \`--json\` and pipe to jq.\n`,
68
+ );
69
+ }
70
+ }
71
+
72
+ function authHintLines(apis: string[]): string[] {
73
+ const example = apis[0] ?? "<name>";
74
+ return [
75
+ `Hint: pass \`--api ${example}\` to auto-load Authorization from apis/${example}/.secrets.yaml`,
76
+ ` (avoids manual "$(yq ...)" shell substitution and keeps secrets out of shell history).`,
77
+ ];
78
+ }
4
79
 
5
80
  export interface RequestOptions {
6
81
  method: string;
@@ -13,6 +88,23 @@ export interface RequestOptions {
13
88
  jsonPath?: string;
14
89
  dbPath?: string;
15
90
  json?: boolean;
91
+ /** TASK-142: validate the response body against the OpenAPI response schema. */
92
+ validateSchema?: boolean;
93
+ /** TASK-142: explicit "METHOD:/path" override when path-templating heuristics
94
+ * fail or the user wants to validate against a different endpoint. */
95
+ validateAgainst?: string;
96
+ /** ARV-149: send the body as `application/x-www-form-urlencoded` (Stripe v1
97
+ * style). When omitted but `--api` is set, zond auto-detects from the
98
+ * spec's requestBody.content. */
99
+ form?: boolean;
100
+ }
101
+
102
+ interface SchemaValidationOutcome {
103
+ status: "PASS" | "FAIL" | "no-spec" | "no-endpoint" | "no-schema";
104
+ matchedEndpoint: { method: string; path: string } | null;
105
+ matchedResponseStatus: string | null;
106
+ errors: AssertionResult[];
107
+ message?: string;
16
108
  }
17
109
 
18
110
  export async function requestCommand(options: RequestOptions): Promise<number> {
@@ -27,6 +119,15 @@ export async function requestCommand(options: RequestOptions): Promise<number> {
27
119
  }
28
120
  }
29
121
 
122
+ // ARV-149: when --form is not set but --api is, peek at the spec to see
123
+ // whether the matching endpoint declares only application/x-www-form-urlencoded
124
+ // (Stripe v1 pattern). If so, default to form encoding so users don't get
125
+ // a 400 "wrong content type" on every POST against form-only APIs.
126
+ let useForm = options.form === true;
127
+ if (!useForm && options.api) {
128
+ useForm = await detectFormFromSpec(options).catch(() => false);
129
+ }
130
+
30
131
  const result = await sendAdHocRequest({
31
132
  method: options.method.toUpperCase(),
32
133
  url: options.url,
@@ -37,21 +138,295 @@ export async function requestCommand(options: RequestOptions): Promise<number> {
37
138
  collectionName: options.api,
38
139
  jsonPath: options.jsonPath,
39
140
  dbPath: options.dbPath,
141
+ form: useForm,
40
142
  });
41
143
 
144
+ let validation: SchemaValidationOutcome | null = null;
145
+ if (options.validateSchema || options.validateAgainst) {
146
+ validation = await runSchemaValidation(options, result);
147
+ }
148
+
42
149
  if (options.json) {
43
- printJson(jsonOk("request", result));
150
+ printJson(jsonOk("request", validation ? { ...result, schema_validation: validation } : result));
151
+ // ARV-110: surface jsonPath diagnostic on stderr in --json mode too, so
152
+ // pipelines that read envelope from stdout still see *why* `body` came
153
+ // back null. Without this, the only signal was a silent null inside the
154
+ // envelope — easy to misread as "envelope shape differs between modes".
155
+ printJsonPathDiagnostic(options.jsonPath, result.jsonPathDiagnostic);
156
+ } else if (options.jsonPath) {
157
+ // TASK-133: pipe-friendly mode — print only the extracted value.
158
+ // Scalars (string/number/bool) emit verbatim with no JSON quoting so
159
+ // shells can use the output directly (e.g. `id=$(zond request … --json-path data.id)`).
160
+ // null/undefined → empty line. Objects/arrays → compact JSON.
161
+ const v = result.body;
162
+ if (v === null || v === undefined) {
163
+ console.log("");
164
+ printJsonPathDiagnostic(options.jsonPath, result.jsonPathDiagnostic);
165
+ } else if (typeof v === "string" || typeof v === "number" || typeof v === "boolean") {
166
+ console.log(String(v));
167
+ } else {
168
+ console.log(JSON.stringify(v));
169
+ }
170
+ if (validation) printSchemaValidation(validation);
44
171
  } else {
45
172
  console.log(JSON.stringify(result, null, 2));
173
+ if (validation) printSchemaValidation(validation);
46
174
  }
175
+
176
+ // TASK-272: post-response auto-auth hint on 401/403 without --api
177
+ if (
178
+ !options.json
179
+ && (result.status === 401 || result.status === 403)
180
+ && !options.api
181
+ ) {
182
+ const apis = detectApisWorkspace(process.cwd());
183
+ if (apis.length > 0) {
184
+ for (const line of authHintLines(apis)) console.error(line);
185
+ }
186
+ }
187
+ if (validation && validation.status === "FAIL") return 1;
47
188
  return 0;
48
189
  } catch (err) {
49
190
  const message = err instanceof Error ? err.message : String(err);
50
191
  if (options.json) {
51
- printJson(jsonError("request", [message]));
192
+ const code = /not registered/.test(message) ? "api_not_registered" : "unknown_error";
193
+ printJson(jsonError("request", [zerr(code, message)]));
52
194
  } else {
53
195
  printError(message);
196
+ // TASK-272: if the failure is shaped like blocked shell-substitution in
197
+ // body/header (sandbox refused to expand `$(yq ...)`), point users at
198
+ // `--api <name>` auto-auth instead.
199
+ const headerBlob = (options.headers ?? []).join("\n");
200
+ if (
201
+ !options.api
202
+ && (looksLikeBlockedShellSubstitution(options.body) || looksLikeBlockedShellSubstitution(headerBlob))
203
+ ) {
204
+ const apis = detectApisWorkspace(process.cwd());
205
+ if (apis.length > 0) {
206
+ for (const line of authHintLines(apis)) console.error(line);
207
+ }
208
+ }
54
209
  }
55
210
  return 1;
56
211
  }
57
212
  }
213
+
214
+ // ──────────────────────────────────────────────
215
+ // TASK-142: --validate-schema / --validate-against
216
+ // ──────────────────────────────────────────────
217
+
218
+ async function runSchemaValidation(
219
+ options: RequestOptions,
220
+ result: { status: number; body: unknown },
221
+ ): Promise<SchemaValidationOutcome> {
222
+ if (!options.api) {
223
+ return {
224
+ status: "no-spec",
225
+ matchedEndpoint: null,
226
+ matchedResponseStatus: null,
227
+ errors: [],
228
+ message: "schema validation requires --api <name> (the spec is loaded from the registered collection)",
229
+ };
230
+ }
231
+
232
+ getDb(options.dbPath);
233
+ const col = findCollectionByNameOrId(options.api);
234
+ if (!col?.openapi_spec) {
235
+ return {
236
+ status: "no-spec",
237
+ matchedEndpoint: null,
238
+ matchedResponseStatus: null,
239
+ errors: [],
240
+ message: `collection '${options.api}' has no openapi_spec — register one with \`zond add api ${options.api} --spec <path>\``,
241
+ };
242
+ }
243
+
244
+ let doc;
245
+ try {
246
+ doc = await readOpenApiSpec(resolveCollectionSpec(col.openapi_spec));
247
+ } catch (err) {
248
+ return {
249
+ status: "no-spec",
250
+ matchedEndpoint: null,
251
+ matchedResponseStatus: null,
252
+ errors: [],
253
+ message: `failed to load OpenAPI spec: ${(err as Error).message}`,
254
+ };
255
+ }
256
+
257
+ let method: string;
258
+ let path: string;
259
+ if (options.validateAgainst) {
260
+ const parsed = parseMethodPathArg(options.validateAgainst);
261
+ if (!parsed) {
262
+ return {
263
+ status: "no-endpoint",
264
+ matchedEndpoint: null,
265
+ matchedResponseStatus: null,
266
+ errors: [],
267
+ message: `--validate-against expects "METHOD:/path" (e.g. "GET:/users/{id}"), got: ${options.validateAgainst}`,
268
+ };
269
+ }
270
+ method = parsed.method;
271
+ path = parsed.path;
272
+ } else {
273
+ method = options.method.toUpperCase();
274
+ path = extractPath(options.url);
275
+ }
276
+
277
+ const validator = createSchemaValidator(doc);
278
+ const inspect = validator.inspect(method, path, result.status);
279
+
280
+ if (!inspect.matchedEndpoint) {
281
+ return {
282
+ status: "no-endpoint",
283
+ matchedEndpoint: null,
284
+ matchedResponseStatus: null,
285
+ errors: [],
286
+ message: `no spec endpoint matches ${method} ${path}. Pass \`--validate-against "METHOD:/path"\` (use spec template form, e.g. "GET:/users/{id}") to override.`,
287
+ };
288
+ }
289
+ if (!inspect.hasJsonSchema) {
290
+ return {
291
+ status: "no-schema",
292
+ matchedEndpoint: inspect.matchedEndpoint,
293
+ matchedResponseStatus: inspect.matchedResponseStatus,
294
+ errors: [],
295
+ message: `endpoint ${inspect.matchedEndpoint.method} ${inspect.matchedEndpoint.path} has no application/json schema for status ${result.status} (matched branch: ${inspect.matchedResponseStatus ?? "none"})`,
296
+ };
297
+ }
298
+
299
+ const errors = validator.validate(method, path, result.status, result.body);
300
+ return {
301
+ status: errors.length === 0 ? "PASS" : "FAIL",
302
+ matchedEndpoint: inspect.matchedEndpoint,
303
+ matchedResponseStatus: inspect.matchedResponseStatus,
304
+ errors,
305
+ };
306
+ }
307
+
308
+ function printSchemaValidation(v: SchemaValidationOutcome): void {
309
+ const ep = v.matchedEndpoint ? `${v.matchedEndpoint.method} ${v.matchedEndpoint.path}` : "—";
310
+ const branch = v.matchedResponseStatus ?? "—";
311
+ console.log("");
312
+ console.log(`Schema validation: ${v.status}`);
313
+ console.log(` endpoint: ${ep}`);
314
+ console.log(` response branch: ${branch}`);
315
+ if (v.message) console.log(` ${v.message}`);
316
+ if (v.status === "FAIL") {
317
+ for (const e of v.errors) {
318
+ console.log(` • ${e.field} — ${e.rule}: ${e.expected}`);
319
+ }
320
+ }
321
+ if (v.status === "no-endpoint" || v.status === "no-spec" || v.status === "no-schema") {
322
+ printWarning(v.message ?? `validation skipped: ${v.status}`);
323
+ } else if (v.status === "PASS") {
324
+ printSuccess("response body matches the response schema");
325
+ }
326
+ }
327
+
328
+ function parseMethodPathArg(raw: string): { method: string; path: string } | null {
329
+ const m = raw.match(/^\s*([A-Za-z]+)\s*[: ]\s*(\/.*?)\s*$/);
330
+ if (!m) return null;
331
+ return { method: m[1]!.toUpperCase(), path: m[2]! };
332
+ }
333
+
334
+ /** ARV-149: peek at the OpenAPI spec for the matching endpoint and return
335
+ * true when its requestBody declares only application/x-www-form-urlencoded
336
+ * (no JSON variant). Cheap-failing — any spec/db error returns false so the
337
+ * caller falls back to the JSON default. */
338
+ async function detectFormFromSpec(options: RequestOptions): Promise<boolean> {
339
+ if (!options.api || !options.body) return false;
340
+ getDb(options.dbPath);
341
+ const col = findCollectionByNameOrId(options.api);
342
+ if (!col?.openapi_spec) return false;
343
+ const doc = await readOpenApiSpec(resolveCollectionSpec(col.openapi_spec));
344
+ const endpoints = extractEndpoints(doc);
345
+ const method = options.method.toUpperCase();
346
+ const path = extractPath(options.url);
347
+ // The OpenAPI reader normalises requestBodyContentType (prefers JSON when
348
+ // present, otherwise records the first declared content type). For a true
349
+ // form-only endpoint that field is "application/x-www-form-urlencoded".
350
+ const exact = endpoints.find(e => e.method.toUpperCase() === method && e.path === path);
351
+ const matched = exact ?? endpoints.find(e => {
352
+ if (e.method.toUpperCase() !== method) return false;
353
+ const re = new RegExp(
354
+ "^" + e.path.replace(/\{[^}]+\}/g, "[^/]+").replace(/\//g, "\\/") + "$",
355
+ );
356
+ return re.test(path);
357
+ });
358
+ return matched?.requestBodyContentType === "application/x-www-form-urlencoded";
359
+ }
360
+
361
+ function extractPath(url: string): string {
362
+ // Absolute URL → use URL parser. Relative URL ("/users/1") → use as-is.
363
+ if (/^https?:\/\//i.test(url)) {
364
+ try {
365
+ return new URL(url).pathname;
366
+ } catch {
367
+ return url;
368
+ }
369
+ }
370
+ // Strip query string from relative paths.
371
+ const q = url.indexOf("?");
372
+ return q >= 0 ? url.slice(0, q) : url;
373
+ }
374
+
375
+ import type { Command } from "commander";
376
+ import { globalJson } from "../resolve.ts";
377
+ import { collect, parsePositiveInt } from "../argv.ts";
378
+ import { getApi } from "../util/api-context.ts";
379
+ import { loadEnvMeta } from "../../core/parser/variables.ts";
380
+ import { resolveTimeoutMs } from "../../core/workspace/config.ts";
381
+
382
+ export function registerRequest(program: Command): void {
383
+ program
384
+ .command("request <method> <url>")
385
+ .description("Send an ad-hoc HTTP request")
386
+ .option("--header <H>", `Request header "Name: Value" (repeatable)`, collect, [])
387
+ .option("--body <json>", "Request body (JSON string)")
388
+ .option("--timeout <ms>", "Request timeout (overrides apis/<name>/.env.yaml `timeoutMs` and zond.config.yml `defaults.timeout_ms`; default 30000)", parsePositiveInt("--timeout"))
389
+ .option("--env <name>", "Environment for variable interpolation")
390
+ .option("--api <name>", "Collection name; auto-loads env + Authorization from apis/<name>/.secrets.yaml")
391
+ .option(
392
+ "--json-path <path>",
393
+ "Extract one field from the RESPONSE BODY (not the zond envelope; " +
394
+ "to address envelope.data.body.id pipe `--json` through jq instead). " +
395
+ "Dot notation, e.g. 'data.id', 'items[0].name'. For top-level array " +
396
+ "responses use '[0].id' or '0.id'. Without --json, prints " +
397
+ "the value verbatim — scalars without quotes for shell use " +
398
+ "(`id=$(zond request --json-path data.id ...)`), objects/arrays as compact JSON. " +
399
+ "With --json, embeds the extracted value as the envelope's `body` field.",
400
+ )
401
+ .option("--db <path>", "Path to SQLite database file")
402
+ .option("--validate-schema", "TASK-142: validate the response body against the OpenAPI response schema (requires --api). Endpoint is auto-resolved from the request method + URL.path; templated paths like /users/{id} are matched via regex. Falls back gracefully if no endpoint matches — pass --validate-against to override.")
403
+ .option("--validate-against <method:path>", "TASK-142: explicit endpoint override for --validate-schema, e.g. \"GET:/users/{id}\". Use the spec template form (with \"{...}\" placeholders).")
404
+ .option("--form", "ARV-149: send --body as application/x-www-form-urlencoded (Stripe v1, Rails/PHP-style APIs). Parses --body as JSON to lift fields, re-encodes with bracket notation. Auto-detected when --api is set and the spec endpoint declares only the form content type.")
405
+ .action(async (method: string, url: string, opts, cmd: Command) => {
406
+ const headers = (opts.header as string[] | undefined)?.length ? (opts.header as string[]) : undefined;
407
+ // ARV-53.
408
+ const api = getApi(cmd, opts);
409
+ let envTimeout: number | undefined;
410
+ if (api) {
411
+ try {
412
+ envTimeout = (await loadEnvMeta(opts.env, `apis/${api}`)).timeoutMs;
413
+ } catch { /* meta is best-effort */ }
414
+ }
415
+ const timeout = resolveTimeoutMs(opts.timeout, envTimeout);
416
+ process.exitCode = await requestCommand({
417
+ method,
418
+ url,
419
+ headers,
420
+ body: opts.body,
421
+ timeout,
422
+ env: opts.env,
423
+ api,
424
+ jsonPath: opts.jsonPath,
425
+ dbPath: opts.db,
426
+ json: globalJson(cmd),
427
+ validateSchema: opts.validateSchema === true || typeof opts.validateAgainst === "string",
428
+ validateAgainst: opts.validateAgainst,
429
+ form: opts.form === true,
430
+ });
431
+ });
432
+ }