@haystackeditor/cli 0.25.1 → 0.27.0

package/dist/schema.js

@@ -10,22 +10,16 @@
  * uses the same envelope as the `--json` output, byte-for-byte.
  */
 export const SCHEMA_VERSIONS = {
-    triage: '2.0.0',
-    setup: '1.0.0',
-    pr: '3.0.0',
-    'pr-status': '1.0.0',
-    inbox: '1.0.0',
-    ask: '1.0.0',
-    submit: '1.0.1',
-    action: '1.0.0',
     'cloud-verifier': '1.0.0',
     'case-batch': '1.0.1',
-    verify: '1.0.4',
-    'pre-verify': '1.0.2',
+    verify: '2.0.0',
+    'verify-raw': '1.0.0',
+    'pre-verify': '2.0.0',
     'verify-answer': '1.0.1',
     'verify-onboarding': '1.0.0',
     init: '1.0.2',
     login: '1.0.0',
+    feedback: '1.0.0',
     error: '1.0.0',
 };
 /** Wrap a payload with the `schema_version` envelope. */

package/dist/utils/haystack-api.js

@@ -1,6 +1,14 @@
 export function haystackApiBase() {
     return process.env.HAYSTACK_API_BASE ?? 'https://haystackeditor.com';
 }
+/** A public API path for `repository` (owner/repo): /v1/repos/{owner}/{repo}{rest}. */
+export function repoApiPath(repository, rest) {
+    const parts = repository.split('/');
+    if (parts.length !== 2 || parts.some(part => !/^[A-Za-z0-9_.-]{1,100}$/.test(part))) {
+        throw new Error(`Invalid repository ${repository}: it must be owner/repo.`);
+    }
+    return `/v1/repos/${parts[0]}/${parts[1]}${rest}`;
+}
 export function haystackApiUrl(path) {
     if (!path.startsWith('/'))
         throw new Error('Haystack API path must be absolute');
@@ -202,39 +210,3 @@ export async function haystackFetch(path, token, init = {}, acceptedStatuses = [
     }
     return response;
 }
-export async function fetchCliIdentity(token) {
-    return haystackJson('/api/cli/me', token);
-}
-export async function fetchHaystackInstallations(token) {
-    const data = await haystackJson('/api/github/user-installations', token);
-    return data.installations ?? [];
-}
-export async function fetchGitHubJson(path, token, init = {}) {
-    return haystackJson(`/api/github${path}`, token, init);
-}
-export async function fetchAnalysisArtifact(owner, repo, prNumber, file, token) {
-    const ref = encodeURIComponent(`${owner}/${repo}#${prNumber}`);
-    const response = await fetch(haystackApiUrl(`/api/analysis/${ref}/${file}`), {
-        headers: headers(token, { 'Cache-Control': 'no-cache' }),
-    });
-    if (response.status === 404)
-        return null;
-    if (!response.ok) {
-        throw await classifyHttpError(response, `Analysis artifact ${file}`);
-    }
-    const data = await response.json();
-    if (!data || typeof data !== 'object' || !('download_url' in data) || !data.download_url) {
-        return data;
-    }
-    const download = await fetch(data.download_url, { headers: { 'User-Agent': 'Haystack-CLI' } });
-    if (!download.ok)
-        throw new Error(`Artifact download failed: HTTP ${download.status}`);
-    return download.json();
-}
-export async function postAskHaystack(owner, repo, prNumber, question, sessionId, token) {
-    return haystackJson(`/api/review-chat/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/${prNumber}/ask`, token, {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ question, session_id: sessionId }),
-    });
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haystackeditor/cli",
-  "version": "0.25.1",
+  "version": "0.27.0",
   "description": "haystack verify: run your app with and without a change, and see what the change broke",
   "type": "module",
   "bin": {
@@ -48,9 +48,7 @@
     "url": "https://github.com/haystackeditor/haystack-review/issues"
   },
   "dependencies": {
-    "@aws-sdk/client-ssm": "3.987.0",
     "@babel/core": "8.0.6",
-    "@inquirer/prompts": "8.7.2",
     "@modelcontextprotocol/sdk": "1.26.0",
     "chalk": "6.0.0",
     "commander": "15.0.0",
@@ -58,7 +56,6 @@
     "parse5-sax-parser": "8.0.0",
     "pg": "8.23.0",
     "pg-connection-string": "2.14.0",
-    "ws": "8.21.3",
     "yaml": "2.9.1",
     "zod": "4.6.5"
   },
@@ -66,7 +63,6 @@
     "@eslint/js": "8.57.1",
     "@types/node": "22.19.8",
     "@types/pg": "8.23.1",
-    "@types/ws": "8.18.1",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@typescript-eslint/parser": "7.18.0",
     "eslint": "8.57.1",

package/schemas/feedback.v1.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.haystackeditor.com/cli/schemas/feedback.v1.json",
+  "title": "Haystack feedback: a message sent to the Haystack team",
+  "description": "Machine-readable output of `haystack feedback --json`. status is sent once the team's channel accepted the message; a failure is the error envelope (`haystack schema error`).",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schema_version", "status"],
+  "properties": {
+    "schema_version": { "const": "1.0.0" },
+    "status": { "const": "sent" }
+  }
+}

package/schemas/pre-verify.v2.json

@@ -0,0 +1,240 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.haystackeditor.com/cli/schemas/pre-verify.v2.json",
+  "title": "haystack pre-verify --json",
+  "description": "CRAWL-V1 amendment 18: the brief of the current change before any crawl: the functions it touches (the front half's blast radius, nearest first) and, when incident planning ran, Haystack's own ideas of what could break. `run` is the run of this capture that holds or will hold the brief; `brief` is null until it does (or when the run ended without one).",
+  "type": "object",
+  "required": ["schema_version", "change", "onboarding", "run", "brief", "capture"],
+  "properties": {
+    "schema_version": { "const": "2.0.0" },
+    "change": {
+      "type": "object",
+      "required": ["baseCommit", "workCommit", "files"],
+      "properties": {
+        "baseCommit": { "type": "string", "pattern": "^[0-9a-f]{40}$" },
+        "workCommit": { "type": "string", "pattern": "^[0-9a-f]{40}$" },
+        "files": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "onboarding": { "description": "The app's onboarding for this base when this command met it (see `haystack schema verify-onboarding`), else null.", "oneOf": [{ "type": "null" }, { "type": "object" }] },
+    "run": {
+      "oneOf": [
+        { "type": "null" },
+        {
+          "type": "object",
+          "required": ["runId", "status"],
+          "properties": {
+            "runId": { "type": "string", "pattern": "^cv_[0-9a-f]{48}$" },
+            "status": { "enum": ["queued", "preparing", "crawling", "draining", "completed", "prepared", "incomplete", "cancelled"] }
+          }
+        }
+      ]
+    },
+    "brief": { "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/brief" }] },
+    "capture": {
+      "description": "CAPTURE-V1 rule 7b (2.0.0): what consenting real users do on the routes this change touches, from Haystack's capture tag, one section per app whose .haystack/capture.json records it (`haystack init` writes it in the app's directory, such as apps/web in a monorepo; `app` is that directory, '.' for the root); null when the checkout has none (capture not set up). The change's files (the brief's function files and the changed files) are joined to routes through each app's route manifest source entries; shares are of distinct captured sessions over the window; sessions on pages no route names are `unmapped`, never counted as zero. A read that fails is `unavailable` and never fails the command.",
+      "oneOf": [
+        { "type": "null" },
+        { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/captureSection" } }
+      ]
+    }
+  },
+  "$defs": {
+    "captureSection": {
+      "oneOf": [
+        {
+          "type": "object", "additionalProperties": false, "required": ["app", "applicationId", "state", "window"],
+          "properties": { "app": { "type": "string" }, "applicationId": { "type": "string" }, "state": { "const": "ready" }, "window": { "$ref": "#/$defs/captureWindow" } }
+        },
+        {
+          "type": "object", "additionalProperties": false, "required": ["app", "applicationId", "state"],
+          "properties": { "app": { "type": "string" }, "applicationId": { "type": "string" }, "state": { "const": "no-data" } }
+        },
+        {
+          "type": "object", "additionalProperties": false, "required": ["app", "applicationId", "state", "reason"],
+          "properties": { "app": { "type": "string" }, "applicationId": { "oneOf": [{ "type": "null" }, { "type": "string" }] }, "state": { "const": "unavailable" }, "reason": { "type": "string" } }
+        }
+      ]
+    },
+    "captureWindow": {
+      "type": "object",
+      "required": ["applicationId", "days", "newestHour", "ageHours", "stale", "sessions", "routes", "union", "unmapped", "releasesWithoutManifest", "dropped"],
+      "properties": {
+        "applicationId": { "type": "string" },
+        "days": { "description": "The UTC days the window covers, oldest first.", "type": "array", "items": { "type": "string" } },
+        "newestHour": { "description": "The newest receipt hour holding events, yyyy-mm-ddThh (UTC).", "oneOf": [{ "type": "null" }, { "type": "string" }] },
+        "ageHours": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0 }] },
+        "stale": { "description": "Older than 24 hours, or no data.", "type": "boolean" },
+        "sessions": { "description": "Distinct captured sessions in the window.", "type": "integer", "minimum": 0 },
+        "routes": {
+          "description": "The changed routes, most sessions first.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["route", "match", "source", "sessions", "share"],
+            "properties": {
+              "route": { "description": "The route id from the app's route manifest.", "type": "string" },
+              "match": { "description": "Its match rule, in the framework adapter's syntax.", "type": "string" },
+              "source": { "description": "The repository file that defines it.", "type": "string" },
+              "sessions": { "type": "integer", "minimum": 0 },
+              "share": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0, "maximum": 1 }] }
+            }
+          }
+        },
+        "union": {
+          "description": "Sessions that visited at least one changed route (exact, not a sum).",
+          "type": "object", "required": ["sessions", "share"],
+          "properties": { "sessions": { "type": "integer", "minimum": 0 }, "share": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0, "maximum": 1 }] } }
+        },
+        "unmapped": {
+          "description": "Sessions on pages no route names: unknown whether they reach the change.",
+          "oneOf": [{ "type": "null" }, { "type": "object", "required": ["sessions", "share"],
+            "properties": { "sessions": { "type": "integer", "minimum": 0 }, "share": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0, "maximum": 1 }] } } }]
+        },
+        "releasesWithoutManifest": { "description": "Releases whose route manifest Haystack does not hold; their pages are unmapped.", "type": "array", "items": { "type": "string" } },
+        "dropped": { "description": "Events dropped at ingest in the window, per reason.", "type": "object", "additionalProperties": { "type": "integer", "minimum": 0 } }
+      }
+    },
+    "brief": {
+      "type": "object",
+      "required": ["functions", "leftOut", "planning"],
+      "properties": {
+        "functions": {
+          "description": "Every affected function the front half listed (at most 2000), nearest first. distance 0 is edited by the change; 1 is one engine edge away.",
+          "type": "array",
+          "maxItems": 2000,
+          "items": {
+            "type": "object",
+            "required": ["file", "name", "lines", "distance", "direction"],
+            "properties": {
+              "file": { "type": "string" },
+              "name": { "type": "string" },
+              "lines": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "integer", "minimum": 0 } },
+              "distance": { "type": "integer", "minimum": 0 },
+              "direction": { "enum": ["changed", "upstream", "downstream"] }
+            }
+          }
+        },
+        "leftOut": {
+          "description": "Functions the blast radius found but did not list, counted with why.",
+          "type": "array",
+          "items": { "type": "object", "required": ["reason", "count"], "properties": { "reason": { "type": "string" }, "count": { "type": "integer", "minimum": 0 } } }
+        },
+        "production": {
+          "description": "CRAWL-V1 amendment 19, only when the repository's own Haystack telemetry holds data in the last 7 days: how the brief's functions ran in production, by their index in `functions` (production runs the code before the change; lines are moved through the change's diff). A function with no row is unknown, not unused.",
+          "type": "object",
+          "required": ["windowDays", "payloads", "newestAt", "partial", "functions"],
+          "properties": {
+            "windowDays": { "type": "integer", "minimum": 1 },
+            "payloads": { "type": "integer", "minimum": 1 },
+            "newestAt": { "type": "string" },
+            "partial": { "type": "boolean", "description": "The read stopped at its byte budget: every count is a lower bound." },
+            "functions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": ["index", "branches", "branchesOmitted", "values", "valuesOmitted"],
+                "properties": {
+                  "index": { "type": "integer", "minimum": 0 },
+                  "branches": {
+                    "type": "array",
+                    "maxItems": 100,
+                    "items": {
+                      "type": "object",
+                      "required": ["line", "whenTrue", "whenFalse", "capped"],
+                      "properties": {
+                        "line": { "type": "integer", "minimum": 1 },
+                        "whenTrue": { "type": "integer", "minimum": 0 },
+                        "whenFalse": { "type": "integer", "minimum": 0 },
+                        "capped": { "type": "boolean", "description": "A counter hit its cap: the counts are lower bounds." }
+                      }
+                    }
+                  },
+                  "branchesOmitted": { "type": "integer", "minimum": 0 },
+                  "values": {
+                    "type": "array",
+                    "maxItems": 100,
+                    "items": {
+                      "type": "object",
+                      "required": ["line", "what", "shapes"],
+                      "properties": {
+                        "line": { "type": "integer", "minimum": 1 },
+                        "what": { "type": "string", "description": "The value observed, e.g. parameter:email or binding:options." },
+                        "shapes": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "required": ["shape", "count"],
+                            "properties": {
+                              "shape": { "type": "string", "description": "A value-free category, e.g. undefined, string:empty:empty, array:few." },
+                              "count": { "type": "integer", "minimum": 0 }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "valuesOmitted": { "type": "integer", "minimum": 0 }
+                }
+              }
+            }
+          }
+        },
+        "planning": {
+          "description": "Incident planning; null when it did not run for this change.",
+          "oneOf": [
+            { "type": "null" },
+            {
+              "type": "object",
+              "required": ["groups", "unresolved", "ideas"],
+              "properties": {
+                "groups": {
+                  "description": "Behavior groups of the change, each with the failure patterns selected for it.",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "required": ["id", "changeKeys", "patterns"],
+                    "properties": {
+                      "id": { "type": "string" },
+                      "changeKeys": { "type": "array", "items": { "type": "string" } },
+                      "patterns": {
+                        "type": "array",
+                        "items": { "type": "object", "required": ["entryId", "mechanism", "symptom"],
+                          "properties": { "entryId": { "type": "string" }, "mechanism": { "type": "string" }, "symptom": { "type": "string" } } }
+                      }
+                    }
+                  }
+                },
+                "unresolved": {
+                  "description": "Changes no behavior group holds, and why.",
+                  "type": "array",
+                  "items": { "type": "object", "required": ["changeKey", "reason"], "properties": { "changeKey": { "type": "string" }, "reason": { "type": "string" } } }
+                },
+                "ideas": {
+                  "description": "Haystack's own ideas: the selected situations, in plan order (at most 64). Every crawl explores them; pass the ones you want first, and your own, to `haystack verify --idea`.",
+                  "type": "array",
+                  "maxItems": 64,
+                  "items": {
+                    "type": "object",
+                    "required": ["id", "groupId", "pattern", "why", "failure", "setup", "exercise", "watch", "start"],
+                    "properties": {
+                      "id": { "type": "string" },
+                      "groupId": { "type": "string" },
+                      "pattern": { "type": "string", "description": "The failure pattern's library id." },
+                      "why": { "type": "string", "description": "How that pattern could arise in this code." },
+                      "failure": { "type": "string", "description": "What would go wrong." },
+                      "setup": { "type": "array", "items": { "type": "string" }, "description": "What must be set up or true first." },
+                      "exercise": { "type": "string", "description": "What to do." },
+                      "watch": { "type": "string", "description": "What to watch." },
+                      "start": { "type": "string", "description": "Where it starts: the start screen, or a prepared start." }
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}