@haystackeditor/cli 0.25.1 → 0.27.0

package/dist/utils/prompter.js

@@ -1,328 +0,0 @@
-/**
- * Prompter — decouples a wizard's *decisions* from *how they're answered*.
- *
- * `haystack setup` historically welded every decision to inquirer/TTY, so it
- * couldn't run headless, in CI, or under a coding agent. The Prompter is the
- * seam: step code calls `confirm` / `multiselect` / `action`, and the
- * implementation decides how to source the answer.
- *
- * Three modes, one mechanism:
- *   - TtyPrompter  — humans in a terminal (inquirer). Default.
- *   - JsonPrompter — a coding agent: NDJSON events on stdout, answers on stdin.
- *                    The agent can relay a `question` to the user OR auto-answer.
- *   - Pre-supplied answers (flags / --answers file) short-circuit any question
- *     by id, so the same code runs fully autonomously when every answer is known.
- *
- * Human-facing chrome stays as `console.*`; in JSON mode the JsonPrompter
- * redirects `console.*` to stderr so stdout carries only NDJSON.
- */
-import chalk from 'chalk';
-import { Separator, checkbox, confirm } from '@inquirer/prompts';
-import * as readline from 'node:readline';
-import { readFileSync } from 'node:fs';
-function isSeparator(c) {
-    return c.separator !== undefined;
-}
-/** Thrown when an agent explicitly rejects/cancels a prompt (vs. answering it),
- *  so callers can distinguish a cancellation from a valid empty answer. */
-export class PromptCancelledError extends Error {
-    requestID;
-    constructor(requestID) {
-        super(`Prompt "${requestID}" was cancelled.`);
-        this.requestID = requestID;
-        this.name = 'PromptCancelledError';
-    }
-}
-export function loadAnswersFile(path) {
-    const raw = readFileSync(path, 'utf8');
-    const parsed = JSON.parse(raw);
-    if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
-        throw new Error(`--answers file must be a JSON object of {questionId: value}`);
-    }
-    return parsed;
-}
-// ---------------------------------------------------------------------------
-// TTY (human) prompter
-// ---------------------------------------------------------------------------
-/**
- * Await an @inquirer/prompts prompt, keeping the Ctrl+C behaviour the CLI had
- * under inquirer 9: that version answered Ctrl+C by re-sending SIGINT to the
- * process (which terminates it) and never settled the prompt. @inquirer/prompts
- * instead rejects with an ExitPromptError, which would surface as an uncaught
- * error with a stack trace, so translate it back.
- */
-export async function runPrompt(prompt) {
-    try {
-        return await prompt;
-    }
-    catch (err) {
-        if (err instanceof Error && err.name === 'ExitPromptError') {
-            process.kill(process.pid, 'SIGINT');
-            console.log('');
-            return new Promise(() => { });
-        }
-        throw err;
-    }
-}
-// ---------------------------------------------------------------------------
-class TtyPrompter {
-    answers;
-    interactive = true;
-    constructor(answers) {
-        this.answers = answers;
-    }
-    hasPreset(id) {
-        return id in this.answers;
-    }
-    async confirm(q) {
-        if (q.id in this.answers)
-            return toBool(this.answers[q.id]);
-        return runPrompt(confirm({ message: q.message, default: q.default ?? true }));
-    }
-    async multiselect(q) {
-        if (q.id in this.answers)
-            return asArray(this.answers[q.id], q.id);
-        const choices = q.choices.map((c) => isSeparator(c) ? new Separator(c.separator) : { name: c.name, value: c.value, checked: c.checked });
-        return runPrompt(checkbox({ message: q.message, choices, pageSize: 20 }));
-    }
-    async action(q) {
-        if (this.answers[q.id] === 'skip')
-            return 'skip';
-        if (await q.check())
-            return 'ok';
-        console.log(chalk.yellow(`  ${q.message}`));
-        if (q.url)
-            console.log(`  ${chalk.cyan(q.url)}`);
-        console.log(chalk.dim('  Waiting...'));
-        const started = Date.now();
-        const timeout = q.timeoutMs ?? 10 * 60 * 1000;
-        const interval = q.pollIntervalMs ?? 3000;
-        while (Date.now() - started < timeout) {
-            await sleep(interval);
-            if (await q.check())
-                return 'ok';
-        }
-        return 'timeout';
-    }
-    progress(message, detail) {
-        // Only emit carriage-return / clear-line ANSI to a real TTY; piped to a file
-        // or CI log (non-interactive, no --json) those sequences corrupt the output,
-        // so stay silent there.
-        if (!process.stdout.isTTY)
-            return;
-        process.stdout.write(`\r${chalk.dim('  ' + message)}${detail ? chalk.dim(' — ' + detail) : ''}\x1b[K`);
-    }
-    clearProgress() {
-        if (!process.stdout.isTTY)
-            return;
-        process.stdout.write('\r\x1b[K');
-    }
-    result(_data) {
-        // Human output is rendered inline by the step code; nothing structured to emit.
-    }
-    close() {
-        /* nothing to release */
-    }
-}
-// ---------------------------------------------------------------------------
-// JSON (coding-agent) prompter
-// ---------------------------------------------------------------------------
-class JsonPrompter {
-    answers;
-    interactive = false;
-    rl = null;
-    pending = new Map();
-    buffered = new Map();
-    restoreConsole = null;
-    constructor(answers) {
-        this.answers = answers;
-        // Keep stdout pure NDJSON: route human chrome to stderr.
-        const origLog = console.log;
-        const origWarn = console.warn;
-        const origError = console.error;
-        const toErr = (...args) => process.stderr.write(args.map(stringifyArg).join(' ') + '\n');
-        console.log = toErr;
-        console.warn = toErr;
-        console.error = toErr;
-        this.restoreConsole = () => {
-            console.log = origLog;
-            console.warn = origWarn;
-            console.error = origError;
-        };
-    }
-    hasPreset(id) {
-        return id in this.answers;
-    }
-    emit(event) {
-        // Stamp every NDJSON event with the setup schema version so agent
-        // consumers can pin a contract. See docs/SPEC-CLI-FIRST-CLASS.md.
-        const stamped = { schema_version: '1.0.0', ...event };
-        process.stdout.write(JSON.stringify(stamped) + '\n');
-    }
-    /** Lazily open stdin only when we actually need an answer the agent must send. */
-    ensureStdin() {
-        if (this.rl)
-            return;
-        this.rl = readline.createInterface({ input: process.stdin });
-        this.rl.on('line', (line) => {
-            const trimmed = line.trim();
-            if (!trimmed)
-                return;
-            let obj;
-            try {
-                obj = JSON.parse(trimmed);
-            }
-            catch (err) {
-                // Surface malformed input on stderr (PR001: no silent swallow) so an
-                // agent can tell its line was rejected and resend, instead of the
-                // prompt hanging on input that never parsed. stderr keeps stdout NDJSON.
-                process.stderr.write(`haystack setup: ignoring unparseable stdin line: ${err instanceof Error ? err.message : String(err)}\n`);
-                return;
-            }
-            if (!obj || typeof obj !== 'object')
-                return;
-            // Mirror OpenCode: question replies are keyed by `requestID`, permission
-            // replies by `permissionID`.
-            const key = (obj.requestID ?? obj.permissionID);
-            if (typeof key !== 'string')
-                return;
-            const resolve = this.pending.get(key);
-            if (resolve) {
-                this.pending.delete(key);
-                resolve(obj);
-            }
-            else {
-                this.buffered.set(key, obj);
-            }
-        });
-    }
-    /** Wait for the agent's reply object, keyed by the request/permission id. */
-    awaitReply(id) {
-        if (this.buffered.has(id)) {
-            const v = this.buffered.get(id);
-            this.buffered.delete(id);
-            return Promise.resolve(v);
-        }
-        this.ensureStdin();
-        return new Promise((resolve) => this.pending.set(id, resolve));
-    }
-    async confirm(q) {
-        if (q.id in this.answers)
-            return toBool(this.answers[q.id]);
-        // A confirm is a single-choice question; emit OpenCode's `question` envelope.
-        // Reply: {requestID, answers: <bool>}; reject: {requestID, reject: true}.
-        this.emit({ type: 'question', requestID: q.id, kind: 'confirm', prompt: q.message, default: q.default ?? true });
-        const reply = await this.awaitReply(q.id);
-        // Reject = cancellation (distinct from "No"); parse the answer robustly so a
-        // string "false" isn't coerced truthy.
-        if (reply.reject)
-            throw new PromptCancelledError(q.id);
-        return toBool(reply.answers);
-    }
-    async multiselect(q) {
-        if (q.id in this.answers)
-            return asArray(this.answers[q.id], q.id);
-        const options = q.choices
-            .filter((c) => !isSeparator(c))
-            .map((c) => ({ value: c.value, label: c.name, default: c.checked ?? false }));
-        // Reply: {requestID, answers: <value[]>}; reject: {requestID, reject: true}.
-        this.emit({ type: 'question', requestID: q.id, kind: 'multiselect', prompt: q.message, options });
-        const reply = await this.awaitReply(q.id);
-        // Surface a rejection as a distinct cancellation rather than masking it as an
-        // empty selection, and surface a non-array reply as a protocol error rather
-        // than silently coercing to [] (PR001: no silent fallback).
-        if (reply.reject)
-            throw new PromptCancelledError(q.id);
-        return asArray(reply.answers, q.id);
-    }
-    async action(q) {
-        if (this.answers[q.id] === 'skip')
-            return 'skip';
-        if (await q.check())
-            return 'ok';
-        // An out-of-band action maps to OpenCode's `permission` request. Reply:
-        // {permissionID, response: "once"|"always"|"reject"}. We also keep polling
-        // check() so it resolves on its own once the action completes.
-        this.emit({ type: 'permission', permissionID: q.id, prompt: q.message, url: q.url, poll: true });
-        const started = Date.now();
-        const timeout = q.timeoutMs ?? 10 * 60 * 1000;
-        const interval = q.pollIntervalMs ?? 3000;
-        let override = null;
-        this.ensureStdin();
-        const answerPromise = this.awaitReply(q.id).then((reply) => {
-            const r = reply.response;
-            override = r === 'reject' ? 'skip' : 'done';
-        });
-        try {
-            while (Date.now() - started < timeout) {
-                if (await q.check())
-                    return 'ok';
-                if (override === 'skip')
-                    return 'skip';
-                // 'done' means the agent reports the action complete — but completion may
-                // be eventually-consistent, so keep polling check() at the interval until
-                // it confirms or we time out (matching TTY behavior), rather than failing
-                // on a single immediate check.
-                if (override === 'done') {
-                    await sleep(interval);
-                    continue;
-                }
-                await Promise.race([sleep(interval), answerPromise]);
-            }
-            return 'timeout';
-        }
-        finally {
-            // If polling or the timeout won before any stdin reply arrived, drop the
-            // dangling resolver so it doesn't accumulate across action() calls.
-            this.pending.delete(q.id);
-        }
-    }
-    progress(message, detail) {
-        this.emit({ type: 'progress', message, ...(detail ? { detail } : {}) });
-    }
-    clearProgress() {
-        /* no ephemeral line in JSON mode */
-    }
-    result(data) {
-        this.emit({ type: 'result', ...data });
-    }
-    close() {
-        this.rl?.close();
-        this.rl = null;
-        this.restoreConsole?.();
-        this.restoreConsole = null;
-    }
-}
-export function createPrompter(options = {}) {
-    const answers = options.answers ?? {};
-    return options.json ? new JsonPrompter(answers) : new TtyPrompter(answers);
-}
-function sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-}
-/** Coerce an answer to a boolean without the `Boolean("false") === true` trap:
- *  recognizes string forms ("true"/"false", "yes"/"no", "1"/"0") explicitly. */
-function toBool(v) {
-    if (typeof v === 'boolean')
-        return v;
-    if (typeof v === 'string') {
-        const s = v.trim().toLowerCase();
-        if (['true', 'yes', 'y', '1'].includes(s))
-            return true;
-        if (['false', 'no', 'n', '0', ''].includes(s))
-            return false;
-    }
-    return Boolean(v);
-}
-/** Validate a pre-supplied multiselect answer is actually an array before use,
- *  so a bad --answers value (e.g. a string) fails fast with a clear message
- *  instead of crashing downstream array operations. */
-function asArray(value, id) {
-    if (!Array.isArray(value)) {
-        throw new Error(`Answer for "${id}" must be a JSON array, got ${typeof value}.`);
-    }
-    return value;
-}
-function stringifyArg(a) {
-    return typeof a === 'string' ? a : String(a);
-}

package/schemas/action.v1.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://docs.haystackeditor.com/cli/schemas/action.v1.json",
-  "title": "haystack <dismiss|mark-reviewed|undismiss|request-review|review> --json",
-  "description": "Shared envelope for every mutating command. Exactly one document on stdout; progress on stderr. status 'error' payloads accompany exit code 1.",
-  "type": "object",
-  "required": ["schema_version", "action", "status"],
-  "properties": {
-    "schema_version": { "type": "string", "const": "1.0.0" },
-    "action": { "type": "string", "enum": ["dismiss", "mark_reviewed", "undismiss", "request_review", "trigger_review", "clear_pending"] },
-    "status": { "type": "string", "enum": ["ok", "error"] },
-    "ref": { "type": ["string", "null"], "description": "owner/repo#number. Null on errors that happen before the ref resolves." },
-    "error": { "type": "string", "description": "Present only when status is 'error'. Actionable message including the remediation." },
-    "detail": { "type": "string", "description": "Human-readable statement of what changed." },
-    "head_sha": { "type": "string", "description": "dismiss/mark_reviewed: the head commit the override is tied to. A new commit invalidates the override." },
-    "reviewer": { "type": ["string", "null"], "description": "request_review: the GitHub user review was requested from, or null for the needs-assignment queue." },
-    "reviewer_request_failed": { "type": ["string", "null"], "description": "request_review: set when the label was applied but the specific-reviewer request failed (partial success)." },
-    "request_id": { "type": "string", "description": "trigger_review: the analysis run id." },
-    "run_status": { "type": "string", "enum": ["started", "already_processing", "completed", "superseded", "running"], "description": "trigger_review: state of the triggered run when the command returned." },
-    "next": { "type": ["string", "null"], "description": "Follow-up command to read results (e.g. `haystack triage <ref> --json`)." }
-  }
-}

package/schemas/ask.v1.json

@@ -1,40 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://docs.haystackeditor.com/cli/schemas/ask.v1.json",
-  "title": "haystack ask <ref> <question> --json",
-  "type": "object",
-  "additionalProperties": false,
-  "required": ["schema_version", "ref", "head_sha", "answer", "evidence", "session_id"],
-  "properties": {
-    "schema_version": { "type": "string", "const": "1.0.0" },
-    "ref": { "type": "string" },
-    "head_sha": { "type": "string" },
-    "answer": { "type": "string" },
-    "session_id": { "type": "string" },
-    "evidence": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "required": ["evidence_id", "type"],
-        "propertyNames": {
-          "enum": [
-            "evidence_id", "type", "title", "body", "author", "state", "isDraft", "labels", "reviewers", "requestedReviewers", "sha",
-            "section_number", "summary", "explanation", "changes", "path", "base_sha", "head_sha", "patch", "start_line", "end_line", "content",
-            "query", "file_pattern", "matches", "files", "totalMatches", "truncated", "scope", "result", "locations", "functions", "change_key", "nodes", "caller", "context",
-            "finding_id", "category", "detail", "suggested_fix", "source", "severity", "source_changes", "test_changes", "changeKey", "testFiles",
-            "uncoveredScenarios", "coverageDescription", "assessment", "id", "filePath", "line", "side", "comments", "isResolved", "isOutdated",
-            "checks", "status", "reason", "blockingChecks", "action", "checkpointId", "commitSha", "commitMessage", "overviewSummary", "userPrompt",
-            "filesTouched", "branch", "checkpoint_id", "chunks", "total_chars", "users", "teams", "result_sha"
-          ]
-        },
-        "properties": {
-          "evidence_id": { "type": "string" },
-          "type": {
-            "type": "string",
-            "enum": ["pr_context", "change_summary", "diff", "source", "search", "call_relationship", "finding", "test_coverage", "review_thread", "ci", "merge", "trace", "suggested_reviewers", "fixer"]
-          }
-        }
-      }
-    }
-  }
-}

package/schemas/inbox.v1.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://docs.haystackeditor.com/cli/schemas/inbox.v1.json",
-  "title": "haystack inbox list --json",
-  "type": "object",
-  "additionalProperties": false,
-  "required": ["schema_version", "pull_requests"],
-  "properties": {
-    "schema_version": { "type": "string", "const": "1.0.0" },
-    "pull_requests": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "additionalProperties": false,
-        "required": ["ref", "title", "head_sha", "bucket", "reason", "action"],
-        "properties": {
-          "ref": { "type": "string" },
-          "title": { "type": "string" },
-          "head_sha": { "type": "string" },
-          "bucket": { "type": "string", "enum": ["analyzing", "needs_shepherding", "needs_review", "good_to_merge"] },
-          "reason": { "type": "string" },
-          "action": { "type": "string" }
-        }
-      }
-    }
-  }
-}

package/schemas/pr-status.v1.json

@@ -1,61 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://docs.haystackeditor.com/cli/schemas/pr-status.v1.json",
-  "title": "haystack pr-status <ref> --json",
-  "description": "Which Haystack feed bucket a PR is in, and why. All state tokens are snake_case — the same vocabulary as `haystack triage --json` and `haystack pr get --json`.",
-  "type": "object",
-  "additionalProperties": false,
-  "required": ["schema_version", "ref", "bucket", "in_feed", "feed_priority", "reason", "analysis", "needs_human_review", "labels", "overrides", "author", "is_author", "is_open", "state_synced_at", "stale_warning"],
-  "properties": {
-    "schema_version": { "type": "string", "const": "1.0.0" },
-    "ref": { "type": "string", "description": "owner/repo#number" },
-    "bucket": {
-      "type": ["string", "null"],
-      "description": "Feed bucket in snake_case. Known values are enumerated below; new buckets may appear (always snake_case). Null when the PR is unclassified (closed or not yet analyzed).",
-      "examples": ["analyzing", "auto_fixing", "good_to_merge", "failed_when_merging", "issues", "needs_assignment", "needs_shepherding", "needs_fixing", "awaiting_review", "review_requested", "snoozed"]
-    },
-    "in_feed": { "type": ["boolean", "null"], "description": "Null when the PR is unclassified (e.g. closed)." },
-    "feed_priority": { "type": ["number", "null"] },
-    "reason": { "type": "string", "description": "Human-readable explanation of the classification." },
-    "analysis": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["status", "verdict", "rating"],
-      "properties": {
-        "status": { "type": "string", "enum": ["pending", "in_queue", "ready", "error"] },
-        "verdict": {
-          "anyOf": [
-            { "type": "string", "enum": ["good_to_merge", "needs_review", "needs_input"] },
-            { "type": "null" }
-          ],
-          "description": "Null until analysis is ready."
-        },
-        "rating": {
-          "anyOf": [
-            { "type": "integer", "minimum": 1, "maximum": 5 },
-            { "type": "null" }
-          ]
-        }
-      }
-    },
-    "needs_human_review": { "type": ["boolean", "null"] },
-    "labels": { "type": "array", "items": { "type": "string" } },
-    "overrides": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["snoozed", "dismissed", "dismissed_agent_alerts", "dismissed_needs_assignment", "manually_good_to_merge"],
-      "properties": {
-        "snoozed": { "type": "boolean" },
-        "dismissed": { "type": "boolean" },
-        "dismissed_agent_alerts": { "type": "boolean" },
-        "dismissed_needs_assignment": { "type": "boolean" },
-        "manually_good_to_merge": { "type": "boolean" }
-      }
-    },
-    "author": { "type": ["string", "null"], "description": "Null when the server could not resolve PR metadata." },
-    "is_author": { "type": ["boolean", "null"] },
-    "is_open": { "type": ["boolean", "null"] },
-    "state_synced_at": { "type": ["string", "null"] },
-    "stale_warning": { "type": ["string", "null"] }
-  }
-}

package/schemas/pr.v1.json

@@ -1,97 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://docs.haystackeditor.com/cli/schemas/pr.v1.json",
-  "title": "haystack pr <ref> --json",
-  "deprecated": true,
-  "description": "HISTORICAL: superseded by pr.v2.json. The CLI no longer emits this shape; this file is retained immutably for consumers pinned to the v1 contract.",
-  "type": "object",
-  "required": [
-    "schema_version",
-    "owner",
-    "repo",
-    "prNumber",
-    "bucket",
-    "state"
-  ],
-  "properties": {
-    "schema_version": {
-      "type": "string",
-      "const": "1.0.0"
-    },
-    "owner": {
-      "type": "string"
-    },
-    "repo": {
-      "type": "string"
-    },
-    "prNumber": {
-      "type": "integer"
-    },
-    "bucket": {
-      "type": "string"
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "open",
-        "closed",
-        "merged"
-      ]
-    },
-    "title": {
-      "type": "string"
-    },
-    "headSha": {
-      "type": "string"
-    },
-    "haystackUrl": {
-      "type": "string"
-    },
-    "mergeQueue": {
-      "type": "object",
-      "properties": {
-        "state": {
-          "type": "string",
-          "enum": [
-            "not-enrolled",
-            "eligible",
-            "grace",
-            "queued",
-            "merging",
-            "merged",
-            "blocked"
-          ]
-        },
-        "graceEndsAt": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "blockedReason": {
-          "type": [
-            "string",
-            "null"
-          ]
-        }
-      }
-    },
-    "lastTriage": {
-      "type": [
-        "object",
-        "null"
-      ],
-      "properties": {
-        "rating": {
-          "type": "integer"
-        },
-        "completedAt": {
-          "type": "string"
-        },
-        "headSha": {
-          "type": "string"
-        }
-      }
-    }
-  }
-}

package/schemas/pr.v3.json

@@ -1,45 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://docs.haystackeditor.com/cli/schemas/pr.v3.json",
-  "title": "haystack pr get <ref> --json",
-  "type": "object",
-  "additionalProperties": false,
-  "required": ["schema_version", "ref", "title", "head_sha", "triage", "merge"],
-  "properties": {
-    "schema_version": { "type": "string", "const": "3.0.0" },
-    "ref": { "type": "string" },
-    "title": { "type": "string" },
-    "head_sha": { "type": "string" },
-    "triage": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["status", "verdict", "findings_count"],
-      "properties": {
-        "status": { "type": "string", "enum": ["pending", "complete", "failed", "stale", "unavailable"] },
-        "verdict": { "type": ["string", "null"], "enum": ["good_to_merge", "needs_review", "needs_input", null] },
-        "findings_count": { "type": "integer", "minimum": 0 }
-      }
-    },
-    "merge": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["status", "reason", "blocking_checks", "action"],
-      "properties": {
-        "status": { "type": "string" },
-        "reason": { "type": "string" },
-        "blocking_checks": { "type": "array", "items": { "type": "string" } },
-        "action": { "type": ["string", "null"] }
-      }
-    },
-    "fixer": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["status", "result_sha", "summary"],
-      "properties": {
-        "status": { "type": "string", "enum": ["completed", "failed"] },
-        "result_sha": { "type": "string" },
-        "summary": { "type": "string" }
-      }
-    }
-  }
-}