@graphrefly/graphrefly 0.27.0 → 0.29.0

package/dist/{index-B6D3QNSA.d.ts → index-BiyjsZ0m.d.ts}

@@ -1,5 +1,6 @@
-import { j as GraphReFlyConfig } from './node-BmerH3kS.js';
-import { s as GraphPersistSnapshot, l as GraphCheckpointRecord, a as Graph, T as TopologyEvent, C as CausalChain, h as CausalStep, D as DescribeFilter, E as ExplainPathOptions, i as GRAPH_META_SEGMENT, j as GraphActorOptions, k as GraphAttachStorageOptions, b as GraphDescribeOptions, c as GraphDescribeOutput, m as GraphDiagramDirection, n as GraphDiagramOptions, o as GraphDiffChange, g as GraphDiffResult, p as GraphFactoryContext, f as GraphNodeFactory, q as GraphObserveAll, r as GraphObserveOne, G as GraphOptions, e as GraphProfileOptions, d as GraphProfileResult, t as GraphVersionChange, u as GraphWALDiff, N as NodeProfile, O as ObserveDetail, v as ObserveEvent, w as ObserveOptions, x as ObserveResult, y as ObserveTheme, z as ObserveThemeName, R as ReachableDirection, A as ReachableOptions, S as SNAPSHOT_VERSION, B as TraceEntry, F as diffForWAL, H as explainPath, I as graphProfile, J as reachable } from './graph-CCwGKLCm.js';
+import { o as GraphReFlyConfig } from './node-Dd6wHSib.js';
+import { d as GraphPersistSnapshot, i as GraphCheckpointRecord, G as Graph, C as CausalChain, e as CausalStep, D as DescribeFilter, E as ExplainPathOptions, f as GRAPH_META_SEGMENT, g as GraphActorOptions, h as GraphAttachStorageOptions, b as GraphDescribeOptions, c as GraphDescribeOutput, j as GraphDiagramDirection, k as GraphDiagramOptions, l as GraphDiffChange, m as GraphDiffResult, n as GraphFactoryContext, o as GraphNodeFactory, p as GraphObserveAll, q as GraphObserveOne, a as GraphOptions, r as GraphProfileOptions, s as GraphProfileResult, t as GraphVersionChange, u as GraphWALDiff, N as NodeProfile, O as ObserveDetail, v as ObserveEvent, w as ObserveOptions, x as ObserveResult, y as ObserveTheme, z as ObserveThemeName, R as ReachableDirection, A as ReachableOptions, S as SNAPSHOT_VERSION, T as TopologyEvent, B as TraceEntry, F as diffForWAL, H as explainPath, I as graphProfile, J as mermaidLiveUrl, K as reachable } from './graph-Qjg9gWHI.js';
+import { w as watchTopologyTree } from './topology-tree-one6oSKY.js';
 
 /**
  * Approximate in-memory size estimation for arbitrary JS values.
@@ -255,26 +256,147 @@ declare function registerBuiltinCodecs(config: GraphReFlyConfig): void;
 declare function replayWAL(entries: readonly WALEntry[]): GraphPersistSnapshot;
 
 /**
- * Subscribe to structural changes across `graph` and every transitively
- * mounted subgraph. `cb` fires on every {@link TopologyEvent} from any
- * graph in the tree. Newly-mounted subgraphs are auto-wired when their
- * parent emits `{kind: "added", nodeKind: "mount"}`; newly-unmounted
- * subgraphs' subscriptions are disposed via the parent's
- * `{kind: "removed", nodeKind: "mount"}` event plus the returned
- * `GraphRemoveAudit`.
+ * Graph observability validation — smoke-exercise helper (D4).
  *
- * The callback receives a third argument `prefix`: the `::`-delimited
- * path from the root watched graph to the emitter, ending with `"::"`
- * (empty string when the event comes from the root itself). Compute
- * a qualified path for an added/removed entry as `prefix + event.name`.
+ * One library-level utility that walks every observability surface the library
+ * ships — `describe()`, `explain(from, to)`, `observe(path)` — and reports
+ * failures as a structured result. Non-throwing by default; composable into
+ * example dry-run paths, CI smoke tests, and MCP reduce-path validators.
  *
- * @param graph - Root graph to watch.
- * @param cb - Receives `(event, emitterGraph, prefix)`.
- * @returns Dispose function — tears down every active subscription.
+ * **Motivation.** Dry-run equivalence (CLAUDE.md) requires every observability
+ * call the real run exercises to also run under dry-run. Previously each
+ * example reimplemented the walk (inbox-reducer caught a `describe()`
+ * dangling-pointer bug only after adding an ad-hoc `graph.explain` check).
+ * This utility centralizes the smoke-exercise so regressions in
+ * `describe` / `explain` / `observe` surface BEFORE any wire spend.
  *
- * @category observability
+ * **Non-goals.** Not a deep correctness check. `describe()` structural
+ * invariants (dangling deps, duplicate paths) are what this catches; actual
+ * data assertions belong in application tests.
+ *
+ * @module
+ */
+
+/** Describe render formats exercised by {@link validateGraphObservability}. */
+type ObservabilityDescribeFormat = "json" | "pretty" | "mermaid" | "mermaid-url" | "d2" | "ascii";
+/** One observability check performed by {@link validateGraphObservability}. */
+type ObservabilityCheck = 
+/** `describe()` was exercised and its structural invariants (nodes ⊇ deps) held. */
+{
+    kind: "describe";
+    ok: true;
+    nodeCount: number;
+    edgeCount: number;
+} | {
+    kind: "describe";
+    ok: false;
+    reason: string;
+    danglingDeps?: readonly string[];
+}
+/** `describe({ format })` render was exercised and produced non-empty output. */
+ | {
+    kind: "describe-format";
+    ok: true;
+    format: ObservabilityDescribeFormat;
+    length: number;
+} | {
+    kind: "describe-format";
+    ok: false;
+    format: ObservabilityDescribeFormat;
+    reason: string;
+}
+/** `observe(path)` succeeded / failed. `path` is the requested path. */
+ | {
+    kind: "observe";
+    ok: true;
+    path: string;
+} | {
+    kind: "observe";
+    ok: false;
+    path: string;
+    reason: string;
+}
+/** `explain(from, to)` succeeded / failed. `found` is the chain's found flag. */
+ | {
+    kind: "explain";
+    ok: true;
+    from: string;
+    to: string;
+    found: boolean;
+    steps: number;
+} | {
+    kind: "explain";
+    ok: false;
+    from: string;
+    to: string;
+    reason: string;
+};
+/** Structured result returned by {@link validateGraphObservability}. */
+interface ValidateObservabilityResult {
+    /** `true` iff every performed check passed (`ok: true`). */
+    readonly ok: boolean;
+    /** All checks performed, in the order they ran. */
+    readonly checks: readonly ObservabilityCheck[];
+    /** Convenience — checks with `ok: false`. */
+    readonly failures: readonly ObservabilityCheck[];
+    /** Single-line summary (e.g. for `process.stderr`). */
+    summary(): string;
+}
+/** Options for {@link validateGraphObservability}. */
+interface ValidateObservabilityOptions {
+    /**
+     * Paths to exercise via `graph.observe(path)`. Each path is resolved against
+     * the same path grammar `graph.observe` / `graph.resolve` use. Non-existent
+     * paths are reported as observe failures.
+     */
+    readonly paths?: readonly string[];
+    /**
+     * `(from, to)` pairs to exercise via `graph.explain(from, to)`. Each pair
+     * records `found` and `steps`; a pair where `found === false` does NOT
+     * fail the overall result — pass `requireFound: true` to tighten that.
+     */
+    readonly pairs?: ReadonlyArray<readonly [from: string, to: string]>;
+    /**
+     * When `true`, `explain` pairs that return `found: false` count as failures.
+     * Default `true` — the common case is "assert this chain exists."
+     */
+    readonly requireFound?: boolean;
+    /**
+     * When `true`, skip the `describe()` structural check (nodes ⊇ deps).
+     * Default `false`. Turn off only when your graph intentionally keeps
+     * untracked deps (rare — COMPOSITION-GUIDE §24 argues against it).
+     */
+    readonly skipDescribe?: boolean;
+    /**
+     * Describe formats to exercise via `graph.describe({ format })`. Each
+     * format renders the graph once and checks that the result is a non-empty
+     * string. Useful in dry-run blocks so regressions in the render paths
+     * (ascii, mermaid, pretty, json, d2, mermaid-url) surface before any wire
+     * spend.
+     */
+    readonly formats?: readonly ObservabilityDescribeFormat[];
+}
+/**
+ * Exercise every observability surface on `graph` and report failures.
+ *
+ * Does NOT throw — returns a structured result so callers (dry-run blocks,
+ * CLI smoke tests, MCP reduce-path validators) can exit non-zero with a
+ * diagnostic instead of letting the process crash mid-inspection.
+ *
+ * @example
+ * ```ts
+ * const result = validateGraphObservability(graph, {
+ *   paths: ["input", "output"],
+ *   pairs: [["input", "output"]],
+ * });
+ * if (!result.ok) {
+ *   console.error(result.summary());
+ *   for (const f of result.failures) console.error(f);
+ *   process.exit(3);
+ * }
+ * ```
  */
-declare function watchTopologyTree(graph: Graph, cb: (event: TopologyEvent, emitter: Graph, prefix: string) => void): () => void;
+declare function validateGraphObservability(graph: Graph, opts?: ValidateObservabilityOptions): ValidateObservabilityResult;
 
 /**
  * Graph container: registry, wiring, introspection (Phase 1).
@@ -312,6 +434,8 @@ declare const index_GraphWALDiff: typeof GraphWALDiff;
 declare const index_JsonCodec: typeof JsonCodec;
 type index_LazyGraphCodec = LazyGraphCodec;
 declare const index_NodeProfile: typeof NodeProfile;
+type index_ObservabilityCheck = ObservabilityCheck;
+type index_ObservabilityDescribeFormat = ObservabilityDescribeFormat;
 declare const index_ObserveDetail: typeof ObserveDetail;
 declare const index_ObserveEvent: typeof ObserveEvent;
 declare const index_ObserveOptions: typeof ObserveOptions;
@@ -324,6 +448,8 @@ declare const index_SIZEOF_SYMBOL: typeof SIZEOF_SYMBOL;
 declare const index_SNAPSHOT_VERSION: typeof SNAPSHOT_VERSION;
 declare const index_TopologyEvent: typeof TopologyEvent;
 declare const index_TraceEntry: typeof TraceEntry;
+type index_ValidateObservabilityOptions = ValidateObservabilityOptions;
+type index_ValidateObservabilityResult = ValidateObservabilityResult;
 type index_WALEntry = WALEntry;
 declare const index_createDagCborCodec: typeof createDagCborCodec;
 declare const index_createDagCborZstdCodec: typeof createDagCborZstdCodec;
@@ -332,13 +458,15 @@ declare const index_diffForWAL: typeof diffForWAL;
 declare const index_encodeEnvelope: typeof encodeEnvelope;
 declare const index_explainPath: typeof explainPath;
 declare const index_graphProfile: typeof graphProfile;
+declare const index_mermaidLiveUrl: typeof mermaidLiveUrl;
 declare const index_reachable: typeof reachable;
 declare const index_registerBuiltinCodecs: typeof registerBuiltinCodecs;
 declare const index_replayWAL: typeof replayWAL;
 declare const index_sizeof: typeof sizeof;
+declare const index_validateGraphObservability: typeof validateGraphObservability;
 declare const index_watchTopologyTree: typeof watchTopologyTree;
 declare namespace index {
-  export { index_CausalChain as CausalChain, index_CausalStep as CausalStep, index_DescribeFilter as DescribeFilter, index_ENVELOPE_VERSION as ENVELOPE_VERSION, type index_EvictedSubgraphInfo as EvictedSubgraphInfo, type index_EvictionPolicy as EvictionPolicy, index_ExplainPathOptions as ExplainPathOptions, index_GRAPH_META_SEGMENT as GRAPH_META_SEGMENT, index_Graph as Graph, index_GraphActorOptions as GraphActorOptions, index_GraphAttachStorageOptions as GraphAttachStorageOptions, index_GraphCheckpointRecord as GraphCheckpointRecord, type index_GraphCodec as GraphCodec, index_GraphDescribeOptions as GraphDescribeOptions, index_GraphDescribeOutput as GraphDescribeOutput, index_GraphDiagramDirection as GraphDiagramDirection, index_GraphDiagramOptions as GraphDiagramOptions, index_GraphDiffChange as GraphDiffChange, index_GraphDiffResult as GraphDiffResult, index_GraphFactoryContext as GraphFactoryContext, index_GraphNodeFactory as GraphNodeFactory, index_GraphObserveAll as GraphObserveAll, index_GraphObserveOne as GraphObserveOne, index_GraphOptions as GraphOptions, index_GraphPersistSnapshot as GraphPersistSnapshot, index_GraphProfileOptions as GraphProfileOptions, index_GraphProfileResult as GraphProfileResult, index_GraphVersionChange as GraphVersionChange, index_GraphWALDiff as GraphWALDiff, index_JsonCodec as JsonCodec, type index_LazyGraphCodec as LazyGraphCodec, index_NodeProfile as NodeProfile, index_ObserveDetail as ObserveDetail, index_ObserveEvent as ObserveEvent, index_ObserveOptions as ObserveOptions, index_ObserveResult as ObserveResult, index_ObserveTheme as ObserveTheme, index_ObserveThemeName as ObserveThemeName, index_ReachableDirection as ReachableDirection, index_ReachableOptions as ReachableOptions, OVERHEAD as SIZEOF_OVERHEAD, index_SIZEOF_SYMBOL as SIZEOF_SYMBOL, index_SNAPSHOT_VERSION as SNAPSHOT_VERSION, index_TopologyEvent as TopologyEvent, index_TraceEntry as TraceEntry, type index_WALEntry as WALEntry, index_createDagCborCodec as createDagCborCodec, index_createDagCborZstdCodec as createDagCborZstdCodec, index_decodeEnvelope as decodeEnvelope, index_diffForWAL as diffForWAL, index_encodeEnvelope as encodeEnvelope, index_explainPath as explainPath, index_graphProfile as graphProfile, index_reachable as reachable, index_registerBuiltinCodecs as registerBuiltinCodecs, index_replayWAL as replayWAL, index_sizeof as sizeof, index_watchTopologyTree as watchTopologyTree };
+  export { index_CausalChain as CausalChain, index_CausalStep as CausalStep, index_DescribeFilter as DescribeFilter, index_ENVELOPE_VERSION as ENVELOPE_VERSION, type index_EvictedSubgraphInfo as EvictedSubgraphInfo, type index_EvictionPolicy as EvictionPolicy, index_ExplainPathOptions as ExplainPathOptions, index_GRAPH_META_SEGMENT as GRAPH_META_SEGMENT, index_Graph as Graph, index_GraphActorOptions as GraphActorOptions, index_GraphAttachStorageOptions as GraphAttachStorageOptions, index_GraphCheckpointRecord as GraphCheckpointRecord, type index_GraphCodec as GraphCodec, index_GraphDescribeOptions as GraphDescribeOptions, index_GraphDescribeOutput as GraphDescribeOutput, index_GraphDiagramDirection as GraphDiagramDirection, index_GraphDiagramOptions as GraphDiagramOptions, index_GraphDiffChange as GraphDiffChange, index_GraphDiffResult as GraphDiffResult, index_GraphFactoryContext as GraphFactoryContext, index_GraphNodeFactory as GraphNodeFactory, index_GraphObserveAll as GraphObserveAll, index_GraphObserveOne as GraphObserveOne, index_GraphOptions as GraphOptions, index_GraphPersistSnapshot as GraphPersistSnapshot, index_GraphProfileOptions as GraphProfileOptions, index_GraphProfileResult as GraphProfileResult, index_GraphVersionChange as GraphVersionChange, index_GraphWALDiff as GraphWALDiff, index_JsonCodec as JsonCodec, type index_LazyGraphCodec as LazyGraphCodec, index_NodeProfile as NodeProfile, type index_ObservabilityCheck as ObservabilityCheck, type index_ObservabilityDescribeFormat as ObservabilityDescribeFormat, index_ObserveDetail as ObserveDetail, index_ObserveEvent as ObserveEvent, index_ObserveOptions as ObserveOptions, index_ObserveResult as ObserveResult, index_ObserveTheme as ObserveTheme, index_ObserveThemeName as ObserveThemeName, index_ReachableDirection as ReachableDirection, index_ReachableOptions as ReachableOptions, OVERHEAD as SIZEOF_OVERHEAD, index_SIZEOF_SYMBOL as SIZEOF_SYMBOL, index_SNAPSHOT_VERSION as SNAPSHOT_VERSION, index_TopologyEvent as TopologyEvent, index_TraceEntry as TraceEntry, type index_ValidateObservabilityOptions as ValidateObservabilityOptions, type index_ValidateObservabilityResult as ValidateObservabilityResult, type index_WALEntry as WALEntry, index_createDagCborCodec as createDagCborCodec, index_createDagCborZstdCodec as createDagCborZstdCodec, index_decodeEnvelope as decodeEnvelope, index_diffForWAL as diffForWAL, index_encodeEnvelope as encodeEnvelope, index_explainPath as explainPath, index_graphProfile as graphProfile, index_mermaidLiveUrl as mermaidLiveUrl, index_reachable as reachable, index_registerBuiltinCodecs as registerBuiltinCodecs, index_replayWAL as replayWAL, index_sizeof as sizeof, index_validateGraphObservability as validateGraphObservability, index_watchTopologyTree as watchTopologyTree };
 }
 
-export { ENVELOPE_VERSION as E, type GraphCodec as G, JsonCodec as J, type LazyGraphCodec as L, OVERHEAD as O, SIZEOF_SYMBOL as S, type WALEntry as W, type EvictedSubgraphInfo as a, type EvictionPolicy as b, createDagCborCodec as c, createDagCborZstdCodec as d, decodeEnvelope as e, encodeEnvelope as f, replayWAL as g, index as i, registerBuiltinCodecs as r, sizeof as s, watchTopologyTree as w };
+export { ENVELOPE_VERSION as E, type GraphCodec as G, JsonCodec as J, type LazyGraphCodec as L, type ObservabilityCheck as O, SIZEOF_SYMBOL as S, type ValidateObservabilityOptions as V, type WALEntry as W, type EvictedSubgraphInfo as a, type EvictionPolicy as b, type ObservabilityDescribeFormat as c, OVERHEAD as d, type ValidateObservabilityResult as e, createDagCborCodec as f, createDagCborZstdCodec as g, decodeEnvelope as h, encodeEnvelope as i, index as j, replayWAL as k, registerBuiltinCodecs as r, sizeof as s, validateGraphObservability as v };