@opensip-cli/contracts 0.1.0

package/dist/command-results.d.ts

@@ -0,0 +1,501 @@
+/**
+ * CommandResult — the discriminated union of every command outcome, plus its
+ * per-command variant interfaces.
+ *
+ * Extracted from `types.ts` so that file stays focused on CLI option / output
+ * shapes and neither grows past the file-length limit. This module depends on
+ * `session-types.ts` for `StoredSession` and `signal-envelope.ts` for the
+ * `SignalEnvelope` every migrated tool returns; `types.ts` does NOT import
+ * back, so there is no cycle. Re-exported from the package barrel
+ * (`index.ts`), so consumers still import these from `@opensip-cli/contracts`.
+ */
+import type { StoredSession } from './session-types.js';
+import type { SignalEnvelope } from './signal-envelope.js';
+import type { ToolProvenance } from '@opensip-cli/core';
+/** One displayed finding inside a verbose findings group. Display fields only —
+ *  no core `Signal` type leaks into contracts. */
+export interface FindingLine {
+    readonly severity: 'error' | 'warning';
+    readonly message: string;
+    /** Source location for display, e.g. `"path/to/file.ts:42"`. */
+    readonly location?: string;
+    readonly suggestion?: string;
+}
+/** A verbose findings block — one per unit (check / scenario) that emitted ≥1
+ *  finding, or that errored. */
+export interface FindingGroup {
+    /** Display name (pretty), falling back to the unit slug. */
+    readonly title: string;
+    /** Set when the unit itself errored (vs. emitted findings). */
+    readonly error?: string;
+    readonly errorCount: number;
+    readonly warningCount: number;
+    readonly findings: readonly FindingLine[];
+}
+/** Renderer-agnostic verbose detail body carried on a migrated `*DoneResult`.
+ *  `resultToView` switches on `kind`: `lines` → verbatim text; `findings` → the
+ *  coloured findings block (rendered identically in Ink and plain text). */
+export type VerboseDetail = {
+    readonly kind: 'lines';
+    readonly lines: readonly string[];
+} | {
+    readonly kind: 'findings';
+    readonly groups: readonly FindingGroup[];
+};
+/** Union type for all command results — App.tsx dispatches on result.type */
+export type CommandResult = FitDoneResult | SimDoneResult | GraphDoneResult | GateDoneResult | GraphStatusResult | ListChecksResult | ListRecipesResult | HistoryResult | ReportResult | InitResult | SimNoticeResult | PluginResult | ClearDoneResult | ConfigureDoneResult | UninstallDoneResult | TextLinesResult | ToolsListResult | ToolsValidateResult | ToolsInstallResult | ToolsUninstallResult | ToolsDataPurgeResult | SessionReplayResult | HelpResult | ErrorResult;
+/** Outcome of an `opensip uninstall` run. */
+export interface UninstallDoneResult {
+    type: 'uninstall-done';
+    /** Discriminator on the dispatch the run took. */
+    action: 'removed' | 'dry-run' | 'cancelled' | 'empty';
+    /** 'user' (default) or 'project' (`--project [path]`). */
+    mode: 'user' | 'project';
+    /** Targets considered for removal. Empty when `action === 'empty'`. */
+    targets: readonly {
+        readonly path: string;
+        readonly kind: 'file' | 'dir';
+    }[];
+    /** Total bytes the targets occupied on disk (0 when nothing was found). */
+    sizeBytes: number;
+    /** Resolved root that was probed (user-level dir or project dir). */
+    rootPath: string;
+}
+export interface ClearDoneResult {
+    type: 'clear-done';
+    action: 'done' | 'cancelled' | 'empty';
+    deletedCount: number;
+    sessionCount: number;
+}
+/** Outcome of an `opensip configure` interactive run. */
+export interface ConfigureDoneResult {
+    type: 'configure-done';
+    /** Where the global config landed on disk. */
+    configPath: string;
+    /** Discriminator: did the user supply a key, or bail at the prompt? */
+    action: 'saved' | 'cancelled';
+    /** When `action === 'saved'`, the masked-for-display key (`abcd…wxyz`). */
+    maskedKey?: string;
+}
+export interface FitDoneResult {
+    type: 'fit-done';
+    label: string;
+    cwd: string;
+    /**
+     * The run's signal envelope (ADR-0011). REQUIRED since Phase 6 (fitness is
+     * migrated): the composition root derives the terminal table (one row per
+     * check `unit`, grouped by `signal.source === checkSlug`) and the
+     * `--json`/cloud/`--report-to` paths FROM this envelope. The fitness-only
+     * `Validated`/`Ignores` columns ride on `envelope.units` as
+     * `filesValidated`/`itemType`/`ignoredCount`.
+     */
+    envelope: SignalEnvelope;
+    reportStatus?: {
+        url: string;
+        findingCount: number;
+        runCount: number;
+        success: boolean;
+        error?: string;
+        chunksTotal?: number;
+        chunksSucceeded?: number;
+    };
+    /** Whether an opensip-cli.config.yml was found in the target directory */
+    configFound?: boolean;
+    /**
+     * Verbose detail body (ADR-0021), present only on `--verbose` runs.
+     * Rendered by the shared `resultToView` seam so the detail is identical
+     * in a TTY and a pipe. Fit populates the `findings` kind.
+     */
+    readonly verboseDetail?: VerboseDetail;
+    /**
+     * User-facing non-fatal warnings collected during the run (plugin load
+     * failures, unknown languages in config, missing check packages, etc.).
+     *
+     * These flow through the result rather than direct stderr writes because
+     * the live-view renderer (Ink) owns the screen and any ambient stderr
+     * write during render desyncs Ink's cursor tracking. Renderers display
+     * these in the summary; non-Ink paths (--json, gate modes) surface them
+     * at their own boundary.
+     */
+    warnings?: readonly string[];
+}
+/**
+ * Outcome of a `graph <scope>` run on the non-`--json` path. Carries only
+ * plain data (no graph types — contracts sits below graph) so `resultToView`
+ * can express it as a view-model the render seam emits as Ink or plain text.
+ */
+export interface GraphDoneResult {
+    type: 'graph-done';
+    /** Fast-tier approximation caveat, or `undefined` for an exact catalog. */
+    readonly resolutionBanner?: string;
+    /** Counts for the shared one-line PASS/FAIL summary. */
+    readonly summary: {
+        readonly passed: number;
+        readonly failed: number;
+        readonly errors: number;
+        readonly warnings: number;
+    };
+    /**
+     * Duration for the top-level summary line (host-owned-run-timing).
+     * After migration this field will be omitted from the result (the host
+     * timer supplies the value that matches the persisted StoredSession so
+     * CLI summary, sessions list, and report agree). Optional during the
+     * transition; when absent the render layer falls back to the host RunTimer.
+     */
+    readonly durationMs?: number;
+    /**
+     * Verbose detail body (ADR-0021). Graph populates the `lines` kind (its
+     * catalog / findings-by-rule / entry-point dump). Rendered by the shared
+     * `resultToView` seam; the non-verbose footer hints are emitted by the seam
+     * too (the old per-result `reportLines`/`footerHints` were retired here).
+     */
+    readonly verboseDetail?: VerboseDetail;
+}
+/**
+ * Outcome of a `fit --gate-save` / `fit --gate-compare` run on the
+ * non-`--json` path. Carries the already-composed lines so the render seam
+ * emits them as Ink or plain text. Exit code (degraded → 1) set by the caller.
+ */
+export interface GateDoneResult {
+    type: 'gate-done';
+    /** Full gate output, one string per line (save summary or compare report). */
+    readonly lines: readonly string[];
+}
+/**
+ * Generic carrier for graph's line-oriented mode output that has no Ink
+ * component twin: `graph-lookup`, `--workspace`, and the `--report-to` status
+ * line. Carries pre-composed plain lines (no graph types — contracts sits
+ * below graph) so the render seam emits them as Ink or plain text instead of
+ * the command writing to stdout directly. The `--json` paths for these
+ * commands are unaffected and still write their machine output at their own
+ * boundary.
+ */
+export interface GraphStatusResult {
+    type: 'graph-status';
+    /** Pre-composed report lines, one string per line. */
+    readonly lines: readonly string[];
+}
+/**
+ * Generic human-readable line carrier for extension commands that do not need a
+ * bespoke first-party view. This keeps `command-result` usable without adding a
+ * new closed union member for every simple command shape.
+ */
+export interface TextLinesResult {
+    type: 'text-lines';
+    /** Optional heading rendered above the lines. */
+    readonly title?: string;
+    /** Pre-composed display lines, one string per line. */
+    readonly lines: readonly string[];
+}
+/** One row of the `tools list` effective-tool inventory (ADR-0041). */
+export interface ToolsListRow {
+    /** The tool's stable id (from its manifest; package name when unreadable). */
+    readonly id: string;
+    /** npm package name, when the tool is a package install. */
+    readonly packageName?: string;
+    readonly version: string;
+    /** Where the tool comes from, in the user-facing vocabulary. */
+    readonly source: 'bundled' | 'global' | 'project';
+    /** Command names the manifest declares (names only — no runtime is loaded). */
+    readonly commands: readonly string[];
+    /**
+     * `loaded` — admitted by THIS run's bootstrap; `manifest-only` — present on
+     * disk (marker + manifest file read) but not loaded this run. `tools list`
+     * never dynamic-imports a runtime, so this is as much as a listing can know.
+     */
+    readonly status: 'loaded' | 'manifest-only';
+    /** True on a GLOBAL row whose tool id is shadowed by a project-local install. */
+    readonly shadowed?: boolean;
+}
+/** Outcome of `opensip tools list` (ADR-0041). */
+export interface ToolsListResult {
+    type: 'tools-list';
+    tools: readonly ToolsListRow[];
+    totalCount: number;
+}
+/** One `tools validate` report section (ADR-0041 / ADR-0042 Tier A). */
+export interface ToolsValidateSection {
+    readonly name: string;
+    /**
+     * `skipped` = the section could not run AND that is expected (in-place path
+     * validation without `--install-deps`); it still makes the overall verdict
+     * `incomplete`, never `passed` — an unverified runtime is not a pass.
+     */
+    readonly status: 'passed' | 'failed' | 'skipped';
+    readonly diagnostics: readonly string[];
+}
+/** Outcome of `opensip tools validate <spec>` (ADR-0041). */
+export interface ToolsValidateResult {
+    type: 'tools-validate';
+    readonly spec: string;
+    readonly toolId?: string;
+    readonly verdict: 'passed' | 'failed' | 'incomplete';
+    readonly sections: readonly ToolsValidateSection[];
+}
+/** Outcome of `opensip tools install <spec>` (ADR-0041): stage → validate → activate. */
+export interface ToolsInstallResult {
+    type: 'tools-install';
+    readonly spec: string;
+    readonly success: boolean;
+    /** The requested install scope. */
+    readonly scope: 'global' | 'project';
+    /** The full validation report the activation decision was made on. */
+    readonly validation: ToolsValidateResult;
+    readonly toolId?: string;
+    readonly version?: string;
+    /** Activation-step failure detail (validation failures live in `validation`). */
+    readonly error?: string;
+}
+/** Outcome of `opensip tools data-purge <tool-id>` (ADR-0042): per-tool row counts. */
+export interface ToolsDataPurgeResult {
+    type: 'tools-data-purge';
+    readonly toolId: string;
+    readonly sessions: number;
+    readonly baselineEntries: number;
+    /** Whether a baseline existence marker was removed. */
+    readonly baselineMeta: boolean;
+    readonly stateRows: number;
+}
+/** Outcome of `opensip tools uninstall <name-or-id>` (ADR-0041). */
+export interface ToolsUninstallResult {
+    type: 'tools-uninstall';
+    /** The id-or-package-name argument as given. */
+    readonly target: string;
+    readonly success: boolean;
+    /** The resolved identity that was removed (displayed before deletion). */
+    readonly removed?: {
+        readonly id: string;
+        readonly packageName: string;
+        readonly scope: 'global' | 'project';
+    };
+    readonly error?: string;
+}
+export interface ListChecksResult {
+    type: 'list-checks';
+    checks: {
+        slug: string;
+        description: string;
+        tags: string[];
+    }[];
+    totalCount: number;
+}
+export interface ListRecipesResult {
+    type: 'list-recipes';
+    recipes: {
+        name: string;
+        description: string;
+        checkCount: string;
+    }[];
+}
+export interface HistorySession extends StoredSession {
+    readonly summary?: {
+        readonly total: number;
+        readonly passed: number;
+        readonly failed: number;
+        readonly errors: number;
+        readonly warnings: number;
+    };
+    readonly showCommand: string;
+}
+export interface HistoryResult {
+    type: 'history';
+    sessions: HistorySession[];
+}
+export interface ReportResult {
+    type: 'report';
+    path: string;
+    opened: boolean;
+}
+/** Classification for a file present under `opensip-cli/` before init ran. */
+export interface PreExistingFile {
+    readonly path: string;
+    readonly classification: 'scaffolded' | 'custom' | 'stale-scaffolded';
+}
+export interface InitResult {
+    type: 'init';
+    created: boolean;
+    path: string;
+    cwd: string;
+    configFilename: string;
+    /**
+     * Set when init refused because the user invoked it from inside an
+     * existing project without an explicit --cwd flag. Carries the
+     * discovered root path and the rendered message — the message is
+     * computed in init.ts so --json consumers get the same string the
+     * human-readable renderer prints.
+     */
+    insideExistingProject?: {
+        readonly discoveredRoot: string;
+        readonly message: string;
+    };
+    /**
+     * The state of the working directory at init time. Useful for
+     * `--json` consumers and for the rendered output to show what
+     * happened. Absent when init bailed before classification (cwd
+     * missing, language unresolvable, mutex flag error).
+     */
+    state?: 'pristine' | 'fully-initialized' | 'partial-config-only' | 'partial-dir-only';
+    /** Languages selected for this scaffold (post-detection or from --language). */
+    languages?: readonly ('typescript' | 'rust' | 'python' | 'go' | 'java' | 'cpp')[];
+    /**
+     * Every file init created, in display order. Includes the config
+     * file plus example check / recipe / scenario scaffolds. Empty
+     * when init refused to write anything.
+     */
+    createdFiles?: readonly string[];
+    /** True when init appended `opensip-cli/.runtime/` to .gitignore. */
+    gitignoreUpdated?: boolean;
+    /**
+     * Files that existed before init ran, classified. Empty (or absent)
+     * in state 'pristine'. Populated for the other states so the user
+     * can see what survived (`--keep`) or was removed (`--remove`).
+     */
+    preExistingFiles?: readonly PreExistingFile[];
+    /**
+     * When init refuses due to partial state (or fully-initialized state)
+     * and no flag was passed, surfaces what's there + a flag hint. Set
+     * together with `created: false`.
+     */
+    partialStateError?: {
+        readonly state: 'partial-config-only' | 'partial-dir-only' | 'fully-initialized';
+        readonly preExistingFiles: readonly PreExistingFile[];
+        readonly message: string;
+    };
+    /**
+     * When detection is ambiguous and --language wasn't passed, init
+     * exits without writing anything and surfaces this error so the
+     * user can re-invoke with --language <list>.
+     */
+    ambiguousLanguageError?: {
+        detected: readonly string[];
+        message: string;
+    };
+}
+export interface SimNoticeResult {
+    type: 'sim-notice';
+    tool: 'sim';
+    cwd: string;
+}
+/** Outcome of a `sim --recipe <name>` run. */
+export interface SimDoneResult {
+    type: 'sim-done';
+    recipeName: string;
+    cwd: string;
+    /**
+     * Duration for the top-level summary line (host-owned-run-timing).
+     * See GraphDoneResult.durationMs for rationale; optional in transition.
+     */
+    durationMs?: number;
+    /**
+     * The run's signal envelope (ADR-0011). REQUIRED since Phase 4 (sim is
+     * migrated): the composition root derives the terminal table (one row per
+     * scenario `unit`, grouped by `signal.source === scenarioId`) and the
+     * `--json`/cloud/`--report-to` paths FROM this envelope. The per-scenario
+     * pass/fail summary is recovered from `envelope.units`, so no scenario
+     * summary fields are duplicated on the result.
+     */
+    envelope: SignalEnvelope;
+    /**
+     * Verbose detail body (ADR-0021), present only on `--verbose` runs. Rendered
+     * by the shared `resultToView` seam. Sim populates the `findings` kind
+     * (per-scenario detail).
+     */
+    readonly verboseDetail?: VerboseDetail;
+}
+/**
+ * Identity of a discovered plugin (exposed by `plugin list`).
+ * Mirrors the `DiscoveredPlugin` shape from core, but kept here as a
+ * separate contract type so the CLI ↔ plugin-result boundary is
+ * stable independently of core's internal representation.
+ */
+export interface PluginInfo {
+    readonly domain: string;
+    readonly namespace: string;
+    readonly pluginType: 'package' | 'file';
+}
+/**
+ * Per-package status from `plugin sync`. `installed: true` means the
+ * `npm install` succeeded; `false` means it failed (the message is
+ * carried in the surrounding `errors[]`).
+ */
+export interface SyncEntry {
+    readonly domain: string;
+    readonly package: string;
+    readonly installed: boolean;
+}
+/**
+ * Discriminated union — one variant per `plugin` subcommand. Each
+ * variant has its own top-level `type` literal, matching the rest of
+ * `CommandResult` (`'fit-done'`, `'sim-done'`, `'list-checks'`, …).
+ * Consumers switch on `result.type` directly; producer/consumer drift
+ * surfaces at compile time.
+ */
+export type PluginResult = {
+    type: 'plugin-list';
+    /**
+     * Ordered plugin domains to render, sourced from registered tool
+     * `pluginLayout` descriptors plus the built-in Tool plugin domain.
+     */
+    domains: readonly string[];
+    plugins: readonly PluginInfo[];
+    totalCount: number;
+    /**
+     * Provenance of the tools admitted through the launch compatibility
+     * gate this run (source + identity + `manifestHash`). Additive — a
+     * parallel section to the discovered-plugin list, sourced from the
+     * per-run provenance holder, not from a disk re-scan. Empty array
+     * when no bootstrap ran (e.g. isolated unit tests).
+     */
+    toolProvenance: readonly ToolProvenance[];
+} | {
+    type: 'plugin-add';
+    packageName: string;
+    success: boolean;
+    error?: string;
+} | {
+    type: 'plugin-remove';
+    packageName: string;
+    success: boolean;
+    error?: string;
+} | {
+    type: 'plugin-sync';
+    synced: readonly SyncEntry[];
+    success: boolean;
+    errors?: readonly string[];
+};
+/**
+ * Outcome of `sessions show <ref>` (and the `--show` shorthand on fit/graph/sim)
+ * on the non-`--json` path. Unlike a live run, a replay is uniform across tools:
+ * it carries the projected {@link SignalEnvelope} (ADR-0011) + display metadata,
+ * and `resultToView` renders it through the SAME shared envelope→table view every
+ * tool's live results use — so a replayed graph session finally shows a table,
+ * and none of them show the live-run "Use --verbose / report" footer (which is
+ * guidance for a fresh run, not a replay).
+ */
+export interface SessionReplayResult {
+    type: 'session-replay';
+    readonly session: {
+        readonly id: string;
+        readonly tool: string;
+        readonly startedAt: string;
+        readonly completedAt: string;
+        readonly recipe?: string;
+        readonly score: number;
+        readonly passed: boolean;
+        readonly durationMs: number;
+    };
+    /** The projected run envelope — rendered via the shared per-unit table. */
+    readonly envelope: SignalEnvelope;
+    /** Replay fidelity, e.g. `'projection'` (rebuilt from persisted findings). */
+    readonly fidelity: string;
+}
+export interface HelpResult {
+    type: 'help';
+}
+export interface ErrorResult {
+    type: 'error';
+    message: string;
+    suggestion?: string;
+    exitCode: number;
+}
+//# sourceMappingURL=command-results.d.ts.map

package/dist/command-results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-results.d.ts","sourceRoot":"","sources":["../src/command-results.ts"],"names":[],"mappings":"AACA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAYxD;kDACkD;AAClD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;gCACgC;AAChC,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;CAC3C;AAED;;4EAE4E;AAC5E,MAAM,MAAM,aAAa,GACrB;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAC7D;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE,CAAC;AAE5E,6EAA6E;AAC7E,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,aAAa,GACb,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,YAAY,GACZ,UAAU,GACV,eAAe,GACf,YAAY,GACZ,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,mBAAmB,GACnB,UAAU,GACV,WAAW,CAAC;AAEhB,6CAA6C;AAC7C,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,gBAAgB,CAAC;IACvB,kDAAkD;IAClD,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;IACtD,0DAA0D;IAC1D,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,uEAAuE;IACvE,OAAO,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,EAAE,CAAC;IAC7E,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,yDAAyD;AACzD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,gBAAgB,CAAC;IACvB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,uEAAuE;IACvE,MAAM,EAAE,OAAO,GAAG,WAAW,CAAC;IAC9B,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;OAOG;IACH,QAAQ,EAAE,cAAc,CAAC;IACzB,YAAY,CAAC,EAAE;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,0EAA0E;IAC1E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,2EAA2E;IAC3E,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,wDAAwD;IACxD,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,8EAA8E;IAC9E,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,cAAc,CAAC;IACrB,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,iDAAiD;IACjD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,uEAAuE;AACvE,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAClD,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,eAAe,CAAC;IAC5C,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,kDAAkD;AAClD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,wEAAwE;AACxE,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED,6DAA6D;AAC7D,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,GAAG,YAAY,CAAC;IACrD,QAAQ,CAAC,QAAQ,EAAE,SAAS,oBAAoB,EAAE,CAAC;CACpD;AAED,yFAAyF;AACzF,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC;IACrC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;IACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,iFAAiF;IACjF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,uFAAuF;AACvF,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,uDAAuD;IACvD,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,oEAAoE;AACpE,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,iBAAiB,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,0EAA0E;IAC1E,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC;KACtC,CAAC;IACF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;IAChE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACtE;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,8EAA8E;AAC9E,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,cAAc,EAAE,YAAY,GAAG,QAAQ,GAAG,kBAAkB,CAAC;CACvE;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE;QACtB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF;;;;;OAKG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,qBAAqB,GAAG,kBAAkB,CAAC;IACtF,gFAAgF;IAChF,SAAS,CAAC,EAAE,SAAS,CAAC,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC;IAClF;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IAC9C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE;QAClB,QAAQ,CAAC,KAAK,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;QACjF,QAAQ,CAAC,gBAAgB,EAAE,SAAS,eAAe,EAAE,CAAC;QACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF;;;;OAIG;IACH,sBAAsB,CAAC,EAAE;QACvB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,8CAA8C;AAC9C,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,QAAQ,EAAE,cAAc,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,MAAM,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GACpB;IACE,IAAI,EAAE,aAAa,CAAC;IACpB;;;OAGG;IACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,cAAc,EAAE,SAAS,cAAc,EAAE,CAAC;CAC3C,GACD;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7E;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAChF;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;QAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;QACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,2EAA2E;IAC3E,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/dist/command-results.js

@@ -0,0 +1,14 @@
+// @fitness-ignore-file file-length-limit -- one cohesive contract surface: the CommandResult discriminated union plus every per-command variant interface, each member carrying load-bearing JSDoc. Splitting the union across files would fragment the single type the host renders/dispatches. Sits just past the 400-line soft limit (and only shrank under ADR-0035, which removed the per-tool exit-flag field).
+/**
+ * CommandResult — the discriminated union of every command outcome, plus its
+ * per-command variant interfaces.
+ *
+ * Extracted from `types.ts` so that file stays focused on CLI option / output
+ * shapes and neither grows past the file-length limit. This module depends on
+ * `session-types.ts` for `StoredSession` and `signal-envelope.ts` for the
+ * `SignalEnvelope` every migrated tool returns; `types.ts` does NOT import
+ * back, so there is no cycle. Re-exported from the package barrel
+ * (`index.ts`), so consumers still import these from `@opensip-cli/contracts`.
+ */
+export {};
+//# sourceMappingURL=command-results.js.map

package/dist/command-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-results.js","sourceRoot":"","sources":["../src/command-results.ts"],"names":[],"mappings":"AAAA,sZAAsZ;AACtZ;;;;;;;;;;GAUG"}

package/dist/exit-codes.d.ts

@@ -0,0 +1,44 @@
+import { type ToolError } from '@opensip-cli/core';
+export declare const EXIT_CODES: {
+    readonly SUCCESS: 0;
+    readonly RUNTIME_ERROR: 1;
+    readonly CONFIGURATION_ERROR: 2;
+    readonly CHECK_NOT_FOUND: 3;
+    readonly REPORT_FAILED: 4;
+    /**
+     * A plugin was rejected by the compatibility gate (launch) — its
+     * declared `apiVersion` is out of range and it was explicitly requested
+     * (fail-closed; the skip path is silent). Dedicated rather than reusing
+     * `CONFIGURATION_ERROR` so an incompatible plugin is diagnosable from the
+     * exit code alone. Read by the CLI fail-closed admission path (Phase 3).
+     */
+    readonly PLUGIN_INCOMPATIBLE: 5;
+};
+/**
+ * Canonical mapping from typed `ToolError` subclasses to CLI exit
+ * codes. This is the single source of truth for how typed errors flow
+ * into the process exit code — both the CLI's top-level
+ * `handleParseError` and any tool that chooses to handle its own
+ * `ToolError` locally route through this function.
+ *
+ * The mapping policy (see `Tool` interface JSDoc in
+ * `@opensip-cli/core` for the full contract):
+ *
+ *   - `NotFoundError`       → `CHECK_NOT_FOUND` (exit 3)
+ *   - `ConfigurationError`  → `CONFIGURATION_ERROR` (exit 2)
+ *   - `ValidationError`     → `CONFIGURATION_ERROR` (exit 2)
+ *   - `NetworkError`           → `REPORT_FAILED` (exit 4)
+ *   - `PluginIncompatibleError`→ `PLUGIN_INCOMPATIBLE` (exit 5)
+ *   - `TimeoutError`           → `RUNTIME_ERROR` (exit 1)
+ *   - any other `ToolError`    → `RUNTIME_ERROR` (exit 1)
+ */
+export declare function mapToolErrorToExitCode(error: ToolError): number;
+/** Human-readable diagnosis surfaced when a tool fails, with the exit code it maps to. */
+export interface ErrorSuggestion {
+    message: string;
+    action?: string;
+    exitCode: number;
+}
+/** Matches an arbitrary error against the suggestion-rule table; returns null if no rule fires. */
+export declare function getErrorSuggestion(err: unknown): ErrorSuggestion | null;
+//# sourceMappingURL=exit-codes.d.ts.map

package/dist/exit-codes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exit-codes.d.ts","sourceRoot":"","sources":["../src/exit-codes.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,SAAS,EACf,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,UAAU;;;;;;IAMrB;;;;;;OAMG;;CAEK,CAAC;AAEX;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAQ/D;AAED,0FAA0F;AAC1F,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AA4JD,mGAAmG;AACnG,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAWvE"}