@graphrefly/graphrefly 0.27.0 → 0.29.0

package/dist/index-C8RfjffH.d.ts

@@ -0,0 +1,291 @@
+import { j as CompileSpecOptions, G as GraphSpec, c as GraphSpecCatalog, C as CatalogFnEntry, a as CatalogSourceEntry, b as ConfigFieldSchema, F as FnFactory, d as GraphSpecFeedbackEdge, e as GraphSpecNode, f as GraphSpecTemplate, g as GraphSpecTemplateRef, h as GraphSpecValidation, S as SourceFactory } from './index-DDy8eeXS.js';
+import { G as Graph, o as GraphNodeFactory, m as GraphDiffResult } from './graph-Qjg9gWHI.js';
+import { StorageTier } from './extra/storage-core.js';
+
+/**
+ * Surface: create a graph from a {@link GraphSpec} (§9.3-core).
+ *
+ * Thin wrapper over {@link compileSpec} that converts the two failure modes
+ * ({@link validateSpec} structural errors, and catalog-aware validation
+ * errors) into typed {@link SurfaceError} throws. Consumers are MCP/CLI
+ * wrappers, not end-user graph code — those should import `compileSpec`
+ * directly.
+ *
+ * @module
+ */
+
+/** Options for {@link createGraph}. Same shape as {@link CompileSpecOptions}. */
+type CreateGraphOptions = CompileSpecOptions;
+/**
+ * Build a {@link Graph} from a parsed {@link GraphSpec} with surface-layer
+ * error typing.
+ *
+ * @throws {SurfaceError} `invalid-spec` for structural errors;
+ *   `catalog-error` when fn/source names or config don't match the catalog.
+ */
+declare function createGraph(spec: GraphSpec, opts?: CreateGraphOptions): Graph;
+
+/**
+ * Typed errors for the surface layer (§9.3-core).
+ *
+ * The surface layer is consumed by `@graphrefly/mcp-server` and
+ * `@graphrefly/cli`. Both have native error channels (MCP's `isError` flag,
+ * CLI's exit codes), so surface functions throw a {@link SurfaceError}
+ * carrying a structured code + details payload that wrappers can map to
+ * their native shape. No `Result` envelope — keep the callsite idiom
+ * `try/catch` and let each wrapper surface the error its own way.
+ *
+ * @module
+ */
+/** Structured error codes emitted by the surface layer. JSON-safe. */
+type SurfaceErrorCode = "invalid-spec" | "graph-not-found" | "graph-exists" | "snapshot-not-found" | "node-not-found" | "reduce-timeout" | "catalog-error" | "restore-failed" | "snapshot-failed" | "tier-no-list" | "compose-not-configured" | "compose-failed" | "internal-error";
+/** JSON-safe shape surfaces should echo back through the wrapper. */
+interface SurfaceErrorPayload {
+    code: SurfaceErrorCode;
+    message: string;
+    /** Optional structured detail; must be JSON-safe. */
+    details?: Readonly<Record<string, unknown>>;
+}
+/**
+ * Thrown by surface layer functions on failure. `code` is the stable
+ * machine-readable identifier; `details` carries structured context
+ * (e.g. `validateSpec` errors, missing path name). Both fields round-trip
+ * through `toJSON()` for wrappers that serialize errors over the wire.
+ */
+declare class SurfaceError extends Error {
+    readonly code: SurfaceErrorCode;
+    readonly details?: Readonly<Record<string, unknown>>;
+    constructor(code: SurfaceErrorCode, message: string, details?: Readonly<Record<string, unknown>>);
+    /**
+     * JSON-safe payload for wire serialization. Defensively validates
+     * `details` — if it can't be round-tripped through `JSON.stringify`
+     * (cyclic refs, `BigInt`, `Error` instance not pre-toJSON'd), the
+     * payload falls back to `{code, message}` only rather than crashing
+     * the MCP/CLI wrapper when it serializes this error onto the wire.
+     */
+    toJSON(): SurfaceErrorPayload;
+}
+/** Wrap any thrown value as a SurfaceError. Idempotent on existing SurfaceError. */
+declare function asSurfaceError(err: unknown, fallbackCode?: SurfaceErrorCode): SurfaceError;
+
+/**
+ * Surface: one-shot `input → pipeline → output` (§9.3-core).
+ *
+ * `runReduction` compiles a {@link GraphSpec}, pushes an input value to a
+ * named state node, awaits the first post-push DATA emission on a named
+ * output, then disposes the graph. Stateless per call — no graphId, no
+ * registry.
+ *
+ * Named `runReduction` (not `reduce`) to avoid collision with the
+ * reactive {@link reduce} operator in `extra/operators.ts`. The MCP tool
+ * name (`graphrefly_reduce`) and CLI subcommand (`graphrefly reduce`) use
+ * the short form; the library export carries the verb.
+ *
+ * The subscribe-before-push ordering is deliberate. `graph.set` propagates
+ * synchronously for sync derived/operator chains; for async sources
+ * (`fromPromise`, `fromAsyncIter`, LLM adapters) the first post-push DATA
+ * arrives on a later tick. Subscribing before the push catches both, and
+ * skipping the priming push-on-subscribe emission avoids resolving with the
+ * stale pre-push cache (spec §2.2).
+ *
+ * @module
+ */
+
+/** Options for {@link reduce}. */
+interface ReduceOptions {
+    /** Fn/source catalog for {@link createGraph}. */
+    catalog?: GraphSpecCatalog;
+    /** Path of the state node that receives the input. Default `"input"`. */
+    inputPath?: string;
+    /** Path of the node whose first post-push DATA is the result. Default `"output"`. */
+    outputPath?: string;
+    /** Hard deadline in milliseconds. Default `30_000`. */
+    timeoutMs?: number;
+}
+/**
+ * Run a spec as a one-shot reduction: `input → graph → output`.
+ *
+ * Resolves on the first `[DATA, v]` **or** `[RESOLVED]` emitted by
+ * `outputPath` after the input push. The RESOLVED path handles spec
+ * §1.3.3 equals-substitution (output recomputed to a value equal to its
+ * cache, so the graph skips the DATA push) by returning `outputNode.cache`
+ * — the caller always gets the settled value, never hangs on idempotent
+ * inputs.
+ *
+ * @throws {SurfaceError} `invalid-spec` / `catalog-error` (propagated from
+ *   {@link createGraph}), `node-not-found` when `inputPath`/`outputPath`
+ *   can't be resolved, `reduce-timeout` when `timeoutMs` elapses without
+ *   a post-push emission, or the ERROR payload from the graph re-thrown
+ *   as `internal-error`.
+ */
+declare function runReduction(spec: GraphSpec, input: unknown, opts?: ReduceOptions): Promise<unknown>;
+
+/**
+ * Surface: snapshot save/restore/diff/list over {@link StorageTier} (§9.3-core).
+ *
+ * One-shot snapshot management for stateless callers (MCP tools, CLI
+ * commands) layered on the existing multi-tier auto-checkpoint substrate.
+ * A saved snapshot is a `mode: "full"` {@link GraphCheckpointRecord} with
+ * `seq: 0` — byte-identical to the baseline anchor
+ * {@link Graph.attachStorage} writes on its first flush. An
+ * auto-checkpointed graph can therefore be restored through this surface,
+ * and a surface-saved snapshot can be picked up by `attachStorage({
+ * autoRestore: true })`.
+ *
+ * The wire envelope stays at {@link SNAPSHOT_WIRE_VERSION}; no new format.
+ *
+ * @module
+ */
+
+/**
+ * Current envelope version. Re-exported from `graph.ts` so the one-shot
+ * surface path and `Graph.attachStorage` write byte-identical
+ * `format_version` fields — no silent wire drift.
+ */
+declare const SNAPSHOT_WIRE_VERSION = 1;
+/** Shape returned by {@link saveSnapshot}. */
+interface SaveSnapshotResult {
+    snapshotId: string;
+    timestamp_ns: number;
+}
+/** Options for {@link restoreSnapshot}. */
+interface RestoreSnapshotOptions {
+    /** Passthrough to `Graph.fromSnapshot`. First matching pattern wins. */
+    factories?: Record<string, GraphNodeFactory>;
+}
+/**
+ * Write a graph's current state as a one-shot `mode: "full"` record.
+ *
+ * Uses the same {@link GraphCheckpointRecord} envelope as
+ * {@link Graph.attachStorage} so the two persistence paths interoperate.
+ *
+ * @throws {SurfaceError} `snapshot-failed` when the tier's `save` throws.
+ */
+declare function saveSnapshot(graph: Graph, snapshotId: string, tier: StorageTier): Promise<SaveSnapshotResult>;
+/**
+ * Load a snapshot from a tier and materialize it as a new {@link Graph}.
+ *
+ * Uses {@link Graph.fromSnapshot} to reconstruct topology; pass
+ * `factories` when the graph includes non-state nodes that the default
+ * hydrator can't rebuild on its own.
+ *
+ * **Requires a `mode: "full"` record.** Surface-written snapshots from
+ * {@link saveSnapshot} always qualify. Records written by
+ * {@link Graph.attachStorage} with `compactEvery > 1` may be
+ * `mode: "diff"` between compacts — those throw `restore-failed` until
+ * the tier's next compact flush (or until Phase 8.7 WAL replay lands).
+ * If you need interop during development, either call
+ * {@link saveSnapshot} explicitly (always full) or configure
+ * `attachStorage({compactEvery: 1})`.
+ *
+ * @throws {SurfaceError} `snapshot-not-found` on miss; `restore-failed`
+ *   when the payload shape doesn't match, when the record is
+ *   `mode: "diff"`, or when `Graph.fromSnapshot` rejects.
+ */
+declare function restoreSnapshot(snapshotId: string, tier: StorageTier, opts?: RestoreSnapshotOptions): Promise<Graph>;
+/**
+ * Load two snapshots and compute a {@link GraphDiffResult} via static
+ * {@link Graph.diff}. Returns the audit shape (structural + value diff,
+ * no payload); use {@link diffForWAL} directly for WAL-oriented diffs.
+ *
+ * @throws {SurfaceError} `snapshot-not-found` on either miss.
+ */
+declare function diffSnapshots(snapshotIdA: string, snapshotIdB: string, tier: StorageTier): Promise<GraphDiffResult>;
+/**
+ * Enumerate snapshot ids on a tier.
+ *
+ * Only keys written by {@link saveSnapshot} are returned. Surface-written
+ * records are stored under the `"snapshot:"` key prefix and decoded back to
+ * the caller-visible id before being returned — other keys on the same tier
+ * (notably `attachStorage` baseline/WAL keys written under `graph.name`) are
+ * filtered out automatically. This lets a single tier back both the surface
+ * and `attachStorage` without leaking graph names through `listSnapshots`.
+ *
+ * @param tier — the storage tier to enumerate.
+ * @param opts.includeUnprefixed — when `true`, also return keys that are
+ *   NOT under the namespacing prefix. Off by default; set this when reading
+ *   pre-namespacing snapshot sets.
+ *
+ *   **Caveat:** when a tier is shared with {@link Graph.attachStorage}, its
+ *   auto-checkpoint baseline + WAL keys (written under `graph.name`) are
+ *   unprefixed. Calling with `includeUnprefixed: true` returns those keys
+ *   alongside surface snapshots — and subsequent `restoreSnapshot` /
+ *   `deleteSnapshot` will operate on them via the fallback-lookup path,
+ *   potentially overwriting or deleting live auto-checkpoint state. Use
+ *   `includeUnprefixed` only against tiers you know are NOT shared with
+ *   `attachStorage`, or follow up with a predicate filter to separate
+ *   ids you own from ones owned by other subsystems.
+ *
+ * @throws {SurfaceError} `tier-no-list` when the tier does not implement
+ *   the optional `list()` method. Check `typeof tier.list === "function"`
+ *   before calling if you want to branch on capability.
+ */
+declare function listSnapshots(tier: StorageTier, opts?: {
+    includeUnprefixed?: boolean;
+}): Promise<readonly string[]>;
+/**
+ * Delete a snapshot from a tier.
+ *
+ * Silent on miss (clear semantics). `tier.clear` is optional — throws
+ * `snapshot-failed` when the tier is append-only.
+ *
+ * @throws {SurfaceError} `snapshot-failed` when `clear` is unsupported
+ *   or throws.
+ */
+declare function deleteSnapshot(snapshotId: string, tier: StorageTier): Promise<void>;
+
+/**
+ * Surface layer (§9.3-core) — shared, JSON-safe operations consumed by
+ * `@graphrefly/mcp-server` and `@graphrefly/cli`.
+ *
+ * The surface is a thin projection of existing Graph APIs (`describe`,
+ * `observe`, `explain`, `snapshot`, `restore`, static `diff`), plus two
+ * genuinely new operations:
+ *
+ * 1. {@link createGraph} — `compileSpec` wrapped with typed surface errors.
+ * 2. {@link reduce} — one-shot `input → pipeline → output`.
+ *
+ * Snapshot persistence reuses the {@link StorageTier} substrate introduced
+ * for `Graph.attachStorage`, so one-shot snapshots and auto-checkpoints
+ * share the {@link GraphCheckpointRecord} envelope. No new wire format.
+ *
+ * Errors throw as {@link SurfaceError} — wrappers map to their native
+ * error channel (MCP `isError`, CLI exit code). No `Result<T, E>` wrapper.
+ *
+ * @module
+ */
+
+declare const index_CatalogFnEntry: typeof CatalogFnEntry;
+declare const index_CatalogSourceEntry: typeof CatalogSourceEntry;
+declare const index_ConfigFieldSchema: typeof ConfigFieldSchema;
+type index_CreateGraphOptions = CreateGraphOptions;
+declare const index_FnFactory: typeof FnFactory;
+declare const index_GraphSpec: typeof GraphSpec;
+declare const index_GraphSpecCatalog: typeof GraphSpecCatalog;
+declare const index_GraphSpecFeedbackEdge: typeof GraphSpecFeedbackEdge;
+declare const index_GraphSpecNode: typeof GraphSpecNode;
+declare const index_GraphSpecTemplate: typeof GraphSpecTemplate;
+declare const index_GraphSpecTemplateRef: typeof GraphSpecTemplateRef;
+declare const index_GraphSpecValidation: typeof GraphSpecValidation;
+type index_ReduceOptions = ReduceOptions;
+type index_RestoreSnapshotOptions = RestoreSnapshotOptions;
+declare const index_SNAPSHOT_WIRE_VERSION: typeof SNAPSHOT_WIRE_VERSION;
+type index_SaveSnapshotResult = SaveSnapshotResult;
+declare const index_SourceFactory: typeof SourceFactory;
+type index_SurfaceError = SurfaceError;
+declare const index_SurfaceError: typeof SurfaceError;
+type index_SurfaceErrorCode = SurfaceErrorCode;
+type index_SurfaceErrorPayload = SurfaceErrorPayload;
+declare const index_asSurfaceError: typeof asSurfaceError;
+declare const index_createGraph: typeof createGraph;
+declare const index_deleteSnapshot: typeof deleteSnapshot;
+declare const index_diffSnapshots: typeof diffSnapshots;
+declare const index_listSnapshots: typeof listSnapshots;
+declare const index_restoreSnapshot: typeof restoreSnapshot;
+declare const index_runReduction: typeof runReduction;
+declare const index_saveSnapshot: typeof saveSnapshot;
+declare namespace index {
+  export { index_CatalogFnEntry as CatalogFnEntry, index_CatalogSourceEntry as CatalogSourceEntry, index_ConfigFieldSchema as ConfigFieldSchema, type index_CreateGraphOptions as CreateGraphOptions, index_FnFactory as FnFactory, index_GraphSpec as GraphSpec, index_GraphSpecCatalog as GraphSpecCatalog, index_GraphSpecFeedbackEdge as GraphSpecFeedbackEdge, index_GraphSpecNode as GraphSpecNode, index_GraphSpecTemplate as GraphSpecTemplate, index_GraphSpecTemplateRef as GraphSpecTemplateRef, index_GraphSpecValidation as GraphSpecValidation, type index_ReduceOptions as ReduceOptions, type index_RestoreSnapshotOptions as RestoreSnapshotOptions, index_SNAPSHOT_WIRE_VERSION as SNAPSHOT_WIRE_VERSION, type index_SaveSnapshotResult as SaveSnapshotResult, index_SourceFactory as SourceFactory, index_SurfaceError as SurfaceError, type index_SurfaceErrorCode as SurfaceErrorCode, type index_SurfaceErrorPayload as SurfaceErrorPayload, index_asSurfaceError as asSurfaceError, index_createGraph as createGraph, index_deleteSnapshot as deleteSnapshot, index_diffSnapshots as diffSnapshots, index_listSnapshots as listSnapshots, index_restoreSnapshot as restoreSnapshot, index_runReduction as runReduction, index_saveSnapshot as saveSnapshot };
+}
+
+export { type CreateGraphOptions as C, type ReduceOptions as R, SNAPSHOT_WIRE_VERSION as S, type RestoreSnapshotOptions as a, type SaveSnapshotResult as b, SurfaceError as c, type SurfaceErrorCode as d, type SurfaceErrorPayload as e, asSurfaceError as f, createGraph as g, deleteSnapshot as h, diffSnapshots as i, runReduction as j, index as k, listSnapshots as l, restoreSnapshot as r, saveSnapshot as s };