agentfootprint 6.44.0 → 7.0.0

package/dist/esm/memory/causal/snapshotPipeline.d.ts

@@ -0,0 +1,35 @@
+/**
+ * snapshotPipeline — composes `loadSnapshot` + `writeSnapshot` into a
+ * `MemoryPipeline` ready to be mounted by `defineMemory({ type: CAUSAL })`.
+ *
+ *   READ  :  LoadSnapshot — embed query → search → project → format
+ *   WRITE :  WriteSnapshot — embed query → store as MemoryEntry<SnapshotEntry>
+ *
+ * The pipeline emits the same `agentfootprint.context.injected` event
+ * (with `source: 'memory'`) as every other memory flavor, so Lens
+ * shows Causal injections as memory chips alongside Episodic /
+ * Semantic / Narrative without special UI.
+ */
+import type { MemoryStore } from '../store/index.js';
+import type { Embedder } from '../embedding/index.js';
+import type { MemoryPipeline } from '../pipeline/types.js';
+import type { SnapshotProjection } from '../define.types.js';
+export interface SnapshotPipelineConfig {
+    /** Vector-capable store for the snapshots. Must implement `search()`. */
+    readonly store: MemoryStore;
+    /** Embedder used for both write-side indexing and read-side query. */
+    readonly embedder: Embedder;
+    /** Stable id of the embedder — prevents cross-model similarity pollution. */
+    readonly embedderId?: string;
+    /** Top-k past snapshots to consider on read. Default 1. */
+    readonly topK?: number;
+    /** Cosine threshold below which matches are dropped. Default 0.7. */
+    readonly minScore?: number;
+    /** Slice of the snapshot to inject. Default `'decisions'`. */
+    readonly projection?: SnapshotProjection;
+    /** Optional TTL for snapshots in ms. Useful for compliance windows. */
+    readonly ttlMs?: number;
+    /** Optional tier tag for written snapshots. */
+    readonly tier?: 'hot' | 'warm' | 'cold';
+}
+export declare function snapshotPipeline(config: SnapshotPipelineConfig): MemoryPipeline;

package/dist/esm/memory/causal/types.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Causal memory — types.
+ *
+ * A `SnapshotEntry` is the value stored in a Causal `MemoryStore`. It
+ * captures one agent run's "what happened and why" so future turns can
+ * answer follow-up questions ("why did you reject this?") with EXACT
+ * past facts instead of LLM reconstruction.
+ *
+ * Differentiator: footprintjs's `decide()`/`select()` already capture
+ * decision evidence as first-class events during traversal — we just
+ * persist them. Other libraries can't do this without rebuilding their
+ * core to surface decision evidence.
+ *
+ * Stored as `MemoryEntry<SnapshotEntry>` so the existing store layer
+ * (`MemoryStore`, `InMemoryStore`, future Redis/Dynamo/Postgres
+ * adapters) handles persistence + identity isolation + TTL + vector
+ * search out of the box.
+ */
+import type { LLMMessage } from '../../adapters/types.js';
+/**
+ * One stored agent run — the unit of causal memory.
+ *
+ * Decisions, tool calls, iterations, and token usage are harvested DURING the run
+ * by `causalEvidenceRecorder` (the evidence bridge) and persisted here — the Agent
+ * attaches it automatically whenever a CAUSAL memory is mounted. Still deferred: the
+ * FULL `commitLog` + narrative entries with depth/path, which land only when an
+ * out-of-band recorder integrates `executor.getSnapshot()` directly. Consequence: a
+ * persisted snapshot answers "why?" from the recorded DOMAIN evidence (decisions /
+ * tool calls), but cannot yet rehydrate the trace-toolpack tools for cross-restart
+ * step-by-step navigation — use `.selfExplain()` for in-conversation deep traces.
+ */
+export interface SnapshotEntry {
+    /**
+     * The user's message at the time of the run. THIS IS WHAT GETS
+     * EMBEDDED for retrieval — new queries are matched by cosine
+     * similarity against past queries.
+     */
+    readonly query: string;
+    /**
+     * The agent's final answer for the run. Pairs with `query` to form
+     * the (prompt, completion) pair RL/SFT exports project on.
+     */
+    readonly finalContent: string;
+    /**
+     * Iteration count — how many ReAct loop turns the agent used to
+     * produce `finalContent`. Useful for ranking "decisive" runs vs
+     * "thrashy" ones.
+     */
+    readonly iterations: number;
+    /**
+     * Decision records collected via `decide()`/`select()` (and skill-graph routing)
+     * during the run — harvested live by `causalEvidenceRecorder` (the evidence
+     * bridge) and persisted here. Empty only when the run used no decision primitives.
+     * THE killer field (by design): each entry carries the rule that matched + the
+     * evidence values that satisfied it.
+     */
+    readonly decisions: ReadonlyArray<DecisionRecord>;
+    /**
+     * Tool calls made during the run. Each entry: tool name, args,
+     * result (truncated). Surfaces the agent's tool-use trajectory for
+     * RL training of tool-use policies.
+     */
+    readonly toolCalls: ReadonlyArray<ToolCallRecord>;
+    /**
+     * Optional rendered narrative — when an out-of-band recorder
+     * captures `executor.getNarrative()` at write time, the full
+     * human-readable trace lands here.
+     */
+    readonly narrative?: string;
+    /**
+     * Wall-clock duration of the run in milliseconds.
+     */
+    readonly durationMs: number;
+    /**
+     * Cumulative token usage at end of run. Used to skip expensive
+     * snapshots from training-data exports under cost caps.
+     */
+    readonly tokenUsage: {
+        readonly input: number;
+        readonly output: number;
+    };
+    /**
+     * Optional eval score attached by an `evalRecorder`. When present,
+     * exports can filter to high-quality runs for SFT or rank for DPO.
+     */
+    readonly evalScore?: number;
+}
+export interface DecisionRecord {
+    /** Stage id where the decision happened (`'classify-risk'`). */
+    readonly stageId: string;
+    /** Branch chosen (`'rejected'`, `'manual-review'`). */
+    readonly chosen: string;
+    /** Optional human label of the rule that matched. */
+    readonly rule?: string;
+    /** Evidence values that led to the choice (key→value). */
+    readonly evidence?: Readonly<Record<string, unknown>>;
+}
+export interface ToolCallRecord {
+    /** Tool name as registered on the agent. */
+    readonly name: string;
+    /** Arguments passed to the tool. */
+    readonly args: Readonly<Record<string, unknown>>;
+    /** Result returned by the tool — TRUNCATED to keep snapshots small. */
+    readonly resultPreview: string;
+    /** True when the tool threw and the result is the error message. */
+    readonly errored: boolean;
+}
+/**
+ * Default truncation when serializing tool results into the snapshot.
+ * Keeps snapshot entries small enough to fit many in context during
+ * retrieval. Override per-call via `writeSnapshot` config.
+ */
+export declare const DEFAULT_TOOL_RESULT_PREVIEW_LEN = 500;
+/**
+ * What `loadSnapshot` returns to the formatter — the projection slice
+ * the consumer asked for via `defineMemory({ projection })`. Each
+ * projection produces a different `LLMMessage` content layout.
+ */
+export interface ProjectedSnapshot {
+    readonly query: string;
+    readonly content: string;
+    readonly source: {
+        readonly entryId: string;
+        readonly score: number;
+    };
+}
+/**
+ * The shape of a single message produced from a projected snapshot.
+ * Always `system` role so the LLM treats it as authoritative context
+ * about a past run.
+ */
+export type SnapshotMessage = LLMMessage & {
+    readonly role: 'system';
+};

package/dist/esm/memory/causal/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/memory/causal/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAmGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/memory/causal/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAuGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,CAAC"}

package/dist/esm/memory/causal/writeSnapshot.d.ts

@@ -0,0 +1,73 @@
+/**
+ * writeSnapshot — write-side stage for Causal memory.
+ *
+ * Captures the current run's `(query, finalContent)` pair from
+ * `scope.newMessages` (populated by the Agent's PrepareFinal stage),
+ * embeds the query for retrieval, and persists a `SnapshotEntry` to
+ * the store. Future turns can match new questions against past
+ * queries via cosine similarity to replay decision evidence.
+ *
+ * Reads from scope:  `identity`, `turnNumber`, `newMessages`
+ * Writes to store:   one `SnapshotEntry` per call, id = `snap-{turn}`
+ *
+ * Why per-turn (not per-iteration)?
+ *   Causal memory captures TURN outcomes — "user asked X, agent said Y."
+ *   Mid-iteration state isn't useful for cross-run replay.
+ *
+ * Turn derivation — collisions are impossible by construction:
+ *   The effective turn is `max(scope.turnNumber, maxStoredTurn + 1)` where
+ *   `maxStoredTurn` is the highest `snap-{n}` already live in THIS
+ *   conversation's namespace (`identityNamespace(identity)` — the durable
+ *   conversation anchor across `run()` calls, Agent instances, and
+ *   processes). Rationale:
+ *     - Hosts that track `turnNumber` correctly keep their numbering
+ *       (`turnNumber: 5` → `snap-5`, gaps preserved).
+ *     - Hosts with a stale counter (the Agent seeds `turnNumber = 1` on
+ *       every run) still get a fresh, ordered id — turn 2 of the same
+ *       conversation lands `snap-2` instead of silently replacing
+ *       `snap-1`.
+ *   Causal snapshots are decision evidence (audit/replay data): when
+ *   "stale counter" and "deliberate same-turn rewrite" are
+ *   indistinguishable, never destroying a prior turn's evidence wins.
+ *   TTL-expired snapshots are ignored by the scan (same as every read).
+ *
+ * Empty-newMessages handling:
+ *   When `newMessages` is empty (no final answer produced — e.g.
+ *   pause-resume mid-flight), the stage no-ops. Re-runs after resume
+ *   capture the snapshot then.
+ *
+ * @see ./types.ts          for the SnapshotEntry shape this writes
+ * @see ./loadSnapshot.ts   for the read-side counterpart
+ */
+import type { TypedScope } from 'footprintjs';
+import type { MemoryStore } from '../store/index.js';
+import type { Embedder } from '../embedding/index.js';
+import type { MemoryState } from '../stages/index.js';
+export interface WriteSnapshotConfig {
+    /** The store to persist the snapshot to. */
+    readonly store: MemoryStore;
+    /**
+     * Embedder used to vectorize the query for later cosine-search.
+     * Required — Causal memory's value comes from semantic retrieval
+     * across past runs.
+     */
+    readonly embedder: Embedder;
+    /**
+     * Stable id for the embedder. Stored on the entry so a later
+     * embedder swap doesn't cross-pollute similarity scores.
+     * Default: `'unknown-embedder'` — pass an explicit id when you
+     * may swap embedder instances over time.
+     */
+    readonly embedderId?: string;
+    /**
+     * TTL in milliseconds — drop snapshots after this duration. Useful
+     * for compliance ("delete causal trace after 30 days").
+     */
+    readonly ttlMs?: number;
+    /**
+     * Tier to tag the snapshot with — typical: `'hot'` for current,
+     * `'warm'`/`'cold'` for archived. Read stages can filter by tier.
+     */
+    readonly tier?: 'hot' | 'warm' | 'cold';
+}
+export declare function writeSnapshot(config: WriteSnapshotConfig): (scope: TypedScope<MemoryState>) => Promise<void>;

package/dist/esm/memory/define.d.ts

@@ -0,0 +1,63 @@
+/**
+ * defineMemory — the single factory the consumer uses to register a
+ * memory subsystem on an Agent.
+ *
+ *     defineMemory({ id, type, strategy, store }) → MemoryDefinition
+ *
+ * The factory's job:
+ *   1. Switch on `type` (Episodic / Semantic / Narrative / Causal)
+ *      to pick the right family of pipelines.
+ *   2. Switch on `strategy.kind` within that family to wire stage
+ *      configs (loadCount / topK / threshold / extractor / ...).
+ *   3. Return an opaque `MemoryDefinition` that step-4's
+ *      `Agent.memory()` builder method consumes.
+ *
+ * Pattern: Factory + Strategy (GoF). One factory, N strategies, four
+ *          types — all reduce to two compiled FlowCharts (`read`,
+ *          `write?`) that mount as subflows.
+ *
+ * Role:    Layer-2 of the memory stack. Sits between the const-objects
+ *          contract (Layer 1) and the Agent builder method (Layer 4).
+ *
+ * Emits:   Indirectly — the compiled subflows emit
+ *          `agentfootprint.context.injected` with `source: 'memory'`
+ *          when their formatter writes to the messages slot.
+ *
+ * @see ./define.types.ts        for the const-objects + types
+ * @see ./pipeline/*.ts          for the existing pipeline factories this dispatches to
+ */
+import { type DefineMemoryOptions } from './define.types.js';
+import type { MemoryDefinition, ReadonlyMemoryFlowChart } from './define.types.js';
+/**
+ * Build a `MemoryDefinition` from a high-level `{ type, strategy, store }`
+ * config. Internally dispatches to one of the existing pipeline factories
+ * (defaultPipeline / semanticPipeline / factPipeline / narrativePipeline /
+ * autoPipeline / ephemeralPipeline) and wires the compiled flowcharts
+ * into the opaque definition that `Agent.memory()` consumes.
+ *
+ * Supported combinations:
+ *
+ * | type      | strategy.kind | underlying pipeline      |
+ * | --------- | ------------- | ------------------------ |
+ * | EPISODIC  | WINDOW        | defaultPipeline          |
+ * | EPISODIC  | BUDGET        | defaultPipeline          |
+ * | EPISODIC  | SUMMARIZE     | defaultPipeline + summarize stage |
+ * | SEMANTIC  | TOP_K         | semanticPipeline         |
+ * | SEMANTIC  | EXTRACT       | factPipeline             |
+ * | SEMANTIC  | WINDOW        | factPipeline (recency-load) |
+ * | NARRATIVE | EXTRACT       | narrativePipeline        |
+ * | NARRATIVE | WINDOW        | narrativePipeline (recency-load) |
+ * | (any)     | HYBRID        | autoPipeline (when sub-strategies map cleanly) |
+ *
+ * Unsupported combinations throw with a remediation hint pointing to a
+ * working alternative or to the raw `mountMemoryRead`/`mountMemoryWrite`
+ * helpers for power users.
+ */
+export declare function defineMemory(options: DefineMemoryOptions): MemoryDefinition;
+/**
+ * Internal — unwrap the brand. Used by `Agent.memory()` (step 4)
+ * to mount the pipeline. NOT exported.
+ *
+ * @internal
+ */
+export declare function unwrapMemoryFlowChart<T>(branded: ReadonlyMemoryFlowChart<T>): unknown;

package/dist/esm/memory/define.types.d.ts

@@ -0,0 +1,278 @@
+/**
+ * Memory subsystem — public type surface.
+ *
+ * THE 2D mental model the library teaches:
+ *
+ *     MEMORY = TYPE × STRATEGY × STORE
+ *
+ *     TYPE       — what shape of memory you're keeping
+ *                  (Episodic messages / Semantic facts / Narrative beats /
+ *                   Causal footprintjs snapshots)
+ *     STRATEGY   — how to fit content into the next LLM call
+ *                  (Window / Budget / Summarize / TopK / Extract / Decay / Hybrid)
+ *     STORE      — where the bytes live
+ *                  (InMemoryStore / Redis / Postgres / DynamoDB / Vector ...)
+ *
+ * Strategy is universal — same Window works for Episodic and for Causal.
+ * That's why examples are organized by strategy (the discipline) not by
+ * type (the shape).
+ *
+ * Pattern: Single-Source-of-Truth const objects + discriminated union.
+ *          Mirrors `src/conventions.ts` (SUBFLOW_IDS, INJECTION_KEYS).
+ *          NEVER enums (TS enums emit runtime objects + opacity).
+ *          Const-as-const erases at compile time, accepts string literals,
+ *          and gives consumers IDE autocomplete + refactor safety.
+ *
+ * Role:    Layer-1 contract for the memory subsystem. Step 2's
+ *          `defineMemory()` factory consumes these to build pipelines;
+ *          Step 4's `Agent.memory()` builder mounts the resulting
+ *          definitions; Step 5's Causal machinery extends them.
+ *
+ * Emits:   Indirectly — every memory pipeline emits the unified
+ *          `agentfootprint.context.injected` event with `source: 'memory'`
+ *          when its read subflow places content into the messages slot.
+ *
+ * @see ./define.ts          for the `defineMemory()` factory itself
+ * @see ../../docs-next      for guides + the 7 strategy examples
+ * @see MEMORY.md            for the load-bearing design memory
+ */
+import type { LLMProvider } from '../adapters/types.js';
+import type { ContextRole } from '../events/types.js';
+import type { Embedder } from './embedding/index.js';
+import type { MemoryStore } from './store/index.js';
+/**
+ * What shape of memory you're keeping.
+ *
+ * - `EPISODIC`  — raw conversation messages, replayed on next turn
+ * - `SEMANTIC`  — extracted structured facts, deduped on key
+ * - `NARRATIVE` — beats / summaries of prior runs (append-only)
+ * - `CAUSAL`    — footprintjs execution snapshots, the differentiator
+ *                 (replays stored decisions + tool evidence for "why?"
+ *                 follow-ups — harvested automatically per run)
+ */
+export declare const MEMORY_TYPES: {
+    readonly EPISODIC: "episodic";
+    readonly SEMANTIC: "semantic";
+    readonly NARRATIVE: "narrative";
+    readonly CAUSAL: "causal";
+};
+export type MemoryType = (typeof MEMORY_TYPES)[keyof typeof MEMORY_TYPES];
+/**
+ * How content is selected / compressed for the next LLM call.
+ *
+ * A `WINDOW` strategy on an Episodic store keeps the last N messages; on
+ * Semantic / Narrative it keeps the last N facts / beats. NOT universal: the
+ * `CAUSAL` type accepts ONLY `TOP_K` — its snapshots are matched semantically
+ * against the new query, never by recency, so `buildCausalPipeline` throws on
+ * any other strategy kind. Mix and match the non-Causal types.
+ */
+export declare const MEMORY_STRATEGIES: {
+    readonly WINDOW: "window";
+    readonly BUDGET: "budget";
+    readonly SUMMARIZE: "summarize";
+    readonly TOP_K: "topK";
+    readonly EXTRACT: "extract";
+    readonly DECAY: "decay";
+    readonly HYBRID: "hybrid";
+};
+export type MemoryStrategyKind = (typeof MEMORY_STRATEGIES)[keyof typeof MEMORY_STRATEGIES];
+/**
+ * When the memory's READ subflow runs.
+ *
+ * Default `TURN_START` reads memory once per `agent.run()`. Use
+ * `EVERY_ITERATION` only when the strategy is sensitive to in-loop tool
+ * results — every-iteration multiplies store-latency by iteration-count.
+ */
+export declare const MEMORY_TIMING: {
+    readonly EVERY_ITERATION: "every-iteration";
+    readonly TURN_START: "turn-start";
+};
+export type MemoryTiming = (typeof MEMORY_TIMING)[keyof typeof MEMORY_TIMING];
+/**
+ * For Causal memory only — which slice of a footprintjs snapshot to
+ * inject. Snapshots can run 100KB+; projecting prevents context blowup.
+ *
+ * - `DECISIONS` — `decide()`/`select()` evidence only (the "why" chain)
+ * - `COMMITS`   — commitLog only (every state write, ordered)
+ * - `NARRATIVE` — narrative entries only (human-readable trace)
+ * - `FULL`      — entire snapshot (use sparingly)
+ */
+export declare const SNAPSHOT_PROJECTIONS: {
+    readonly DECISIONS: "decisions";
+    readonly COMMITS: "commits";
+    readonly NARRATIVE: "narrative";
+    readonly FULL: "full";
+};
+export type SnapshotProjection = (typeof SNAPSHOT_PROJECTIONS)[keyof typeof SNAPSHOT_PROJECTIONS];
+/** Window — keep the last `size` entries. Pure rule, no LLM, no embedder. */
+export interface WindowStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.WINDOW;
+    readonly size: number;
+}
+/**
+ * Budget — pick entries that fit within a token budget. Used as a
+ * decider stage: skip-if-empty | skip-if-no-budget | pick-by-tokens.
+ */
+export interface BudgetStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.BUDGET;
+    /** Reserve N tokens for prompt headers / new user message. Default 256. */
+    readonly reserveTokens?: number;
+    /** Skip injection below this token floor. Default 100. */
+    readonly minimumTokens?: number;
+    /** Hard cap on entries to inject — guards against "lost-in-the-middle". */
+    readonly maxEntries?: number;
+}
+/**
+ * Summarize — when the conversation grows long, an LLM compresses older
+ * turns into a paragraph; recent N turns stay raw. The standard answer
+ * to "long conversations blow context."
+ */
+export interface SummarizeStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.SUMMARIZE;
+    /** Keep this many most-recent turns uncompressed. */
+    readonly recent: number;
+    /** LLM that does the compression — recommend a cheap model (haiku). */
+    readonly llm: LLMProvider;
+}
+/**
+ * Top-K — embed the user's query, retrieve top-K by cosine similarity.
+ * STRICT threshold: when no entry meets the threshold, return EMPTY.
+ * No fallback — garbage in context is worse than no memory.
+ */
+export interface TopKStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.TOP_K;
+    readonly topK: number;
+    /** Min cosine similarity. Strict — no fallback below this. Default 0.7. */
+    readonly threshold?: number;
+    readonly embedder: Embedder;
+}
+/**
+ * Extract — on WRITE, an LLM (or pattern matcher) distills entries from
+ * raw messages into structured shapes (facts/beats). Usually paired with
+ * a load-side strategy like TopK or Window for the read direction.
+ */
+export interface ExtractStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.EXTRACT;
+    /** Pattern-based (regex heuristics, free) or LLM-based (paid). */
+    readonly extractor: 'pattern' | 'llm';
+    /** Required when `extractor: 'llm'`. */
+    readonly llm?: LLMProvider;
+    /** Discard extractions below this confidence. Default 0.7. */
+    readonly minConfidence?: number;
+    /** Cap entries extracted per turn. Default 5. */
+    readonly maxPerTurn?: number;
+}
+/**
+ * Decay — score entries by `recency × accessCount`, drop below floor.
+ * For long-running agents where unused memory should fade.
+ */
+export interface DecayStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.DECAY;
+    /** Half-life in milliseconds for the recency component. */
+    readonly halfLifeMs: number;
+    /** Drop entries scoring below this. Default 0.1. */
+    readonly minScore?: number;
+}
+/**
+ * Hybrid — compose multiple strategies. Each sub-strategy runs as its
+ * own selector branch; results are merged in the order listed.
+ */
+export interface HybridStrategy {
+    readonly kind: typeof MEMORY_STRATEGIES.HYBRID;
+    readonly strategies: ReadonlyArray<Exclude<Strategy, HybridStrategy>>;
+}
+/** The full strategy union — discriminated by `kind`. */
+export type Strategy = WindowStrategy | BudgetStrategy | SummarizeStrategy | TopKStrategy | ExtractStrategy | DecayStrategy | HybridStrategy;
+/**
+ * Reserved API surface for content redaction before memory writes.
+ * Impl is deferred; the field exists now so adding redaction later
+ * is non-breaking. Snapshot/episodic writes may carry PII — this is
+ * the integration point.
+ */
+export interface MemoryRedactionPolicy {
+    /** Patterns to mask in stored content. */
+    readonly patterns?: readonly RegExp[];
+    /** Replacement string. Default `'[REDACTED]'`. */
+    readonly replacement?: string;
+}
+/**
+ * The opaque value `defineMemory()` returns. `Agent.memory()` consumes
+ * one of these per memory the consumer registers; multiple definitions
+ * layer cleanly via per-id scope keys (`memoryInjection_${id}`).
+ *
+ * Generic `T` is the payload shape stored — `Message` for episodic,
+ * `Fact` for semantic, `NarrativeBeat` for narrative, `RunSnapshot` for
+ * causal. The factory infers `T` from `type`.
+ */
+export interface MemoryDefinition<T = unknown> {
+    /** Stable identifier. Becomes the scope-key suffix and the Lens label. */
+    readonly id: string;
+    /** Surfaces in narrative / Lens hover. */
+    readonly description?: string;
+    /** Which TYPE shape — gates legal STRATEGY combinations. */
+    readonly type: MemoryType;
+    /** Compiled read subflow (built by the factory from type × strategy). */
+    readonly read: ReadonlyMemoryFlowChart<T>;
+    /** Compiled write subflow. Optional — `EPHEMERAL`-style configs omit. */
+    readonly write?: ReadonlyMemoryFlowChart<T>;
+    /** When `read` runs. Default `TURN_START`. */
+    readonly timing: MemoryTiming;
+    /** Role to use when injecting formatted content into the messages slot. */
+    readonly asRole: ContextRole;
+    /** Reserved for a future release — patterns to redact before write. */
+    readonly redact?: MemoryRedactionPolicy;
+    /** Snapshot projection — only meaningful when `type === CAUSAL`. */
+    readonly projection?: SnapshotProjection;
+}
+/**
+ * Opaque tag for the compiled flowchart the factory hands back.
+ * The actual type is `FlowChart<MemoryState>` from footprintjs but we
+ * keep it nominal here so consumers can't reach in. The phantom type
+ * parameter is preserved so consumers can write `ReadonlyMemoryFlowChart<MyShape>`
+ * for documentation, even though the brand erases the parameter at runtime.
+ */
+export type ReadonlyMemoryFlowChart<_T> = {
+    readonly __brand: 'ReadonlyMemoryFlowChart';
+};
+/**
+ * Common options for every memory type. Type-specific options layer on
+ * top via discriminated `type` field in the next overload set (Step 2).
+ */
+export interface DefineMemoryOptionsBase {
+    readonly id: string;
+    readonly description?: string;
+    readonly store: MemoryStore;
+    readonly strategy: Strategy;
+    readonly timing?: MemoryTiming;
+    readonly asRole?: ContextRole;
+    readonly redact?: MemoryRedactionPolicy;
+}
+export interface DefineEpisodicOptions extends DefineMemoryOptionsBase {
+    readonly type: typeof MEMORY_TYPES.EPISODIC;
+}
+export interface DefineSemanticOptions extends DefineMemoryOptionsBase {
+    readonly type: typeof MEMORY_TYPES.SEMANTIC;
+}
+export interface DefineNarrativeOptions extends DefineMemoryOptionsBase {
+    readonly type: typeof MEMORY_TYPES.NARRATIVE;
+}
+export interface DefineCausalOptions extends DefineMemoryOptionsBase {
+    readonly type: typeof MEMORY_TYPES.CAUSAL;
+    /** Slice of the snapshot to inject. Default `DECISIONS`. */
+    readonly projection?: SnapshotProjection;
+}
+/** Discriminated by `type`. The factory uses this to pick the pipeline. */
+export type DefineMemoryOptions = DefineEpisodicOptions | DefineSemanticOptions | DefineNarrativeOptions | DefineCausalOptions;
+export declare function isMemoryType(value: string): value is MemoryType;
+export declare function isMemoryStrategyKind(value: string): value is MemoryStrategyKind;
+export declare function isMemoryTiming(value: string): value is MemoryTiming;
+export declare function isSnapshotProjection(value: string): value is SnapshotProjection;
+/**
+ * Scope-key prefix used when mounting multiple `.memory()` definitions
+ * on the same Agent. Each memory writes to `memoryInjection_${id}` so
+ * registrations never collide. Formatter merges all keys with this
+ * prefix in registration order.
+ */
+export declare const MEMORY_INJECTION_KEY_PREFIX: "memoryInjection_";
+export declare function memoryInjectionKey(id: string): string;
+export declare function isMemoryInjectionKey(key: string): boolean;

package/dist/esm/memory/define.types.js

@@ -33,7 +33,7 @@
  *          when its read subflow places content into the messages slot.
  *
  * @see ./define.ts          for the `defineMemory()` factory itself
- * @see ../../docs-site      for guides + the 7 strategy examples
+ * @see ../../docs-next      for guides + the 7 strategy examples
  * @see MEMORY.md            for the load-bearing design memory
  */
 // ─── Const-objects (SSOT) ───────────────────────────────────────────
@@ -56,9 +56,11 @@ export const MEMORY_TYPES = {
 /**
  * How content is selected / compressed for the next LLM call.
  *
- * Universal across types. A `WINDOW` strategy on an Episodic store keeps
- * the last N messages; on a Causal store it keeps the last N snapshots.
- * Mix and match.
+ * A `WINDOW` strategy on an Episodic store keeps the last N messages; on
+ * Semantic / Narrative it keeps the last N facts / beats. NOT universal: the
+ * `CAUSAL` type accepts ONLY `TOP_K` — its snapshots are matched semantically
+ * against the new query, never by recency, so `buildCausalPipeline` throws on
+ * any other strategy kind. Mix and match the non-Causal types.
  */
 export const MEMORY_STRATEGIES = {
     WINDOW: 'window',

package/dist/esm/memory/define.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"define.types.js","sourceRoot":"","sources":["../../../src/memory/define.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAOH,uEAAuE;AAEvE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,MAAM;IACb,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;CAChB,CAAC;AAGX;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;CACJ,CAAC;AA+MX,uEAAuE;AAEvE,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAQ,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAQ,MAAM,CAAC,MAAM,CAAC,aAAa,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAQ,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,uEAAuE;AAEvE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,kBAA2B,CAAC;AAEvE,MAAM,UAAU,kBAAkB,CAAC,EAAU;IAC3C,OAAO,GAAG,2BAA2B,GAAG,EAAE,EAAE,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,OAAO,GAAG,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;AACrD,CAAC"}
+{"version":3,"file":"define.types.js","sourceRoot":"","sources":["../../../src/memory/define.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAOH,uEAAuE;AAEvE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,MAAM;IACb,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;CAChB,CAAC;AAGX;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;CACJ,CAAC;AA+MX,uEAAuE;AAEvE,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAQ,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAQ,MAAM,CAAC,MAAM,CAAC,aAAa,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAQ,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,uEAAuE;AAEvE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,kBAA2B,CAAC;AAEvE,MAAM,UAAU,kBAAkB,CAAC,EAAU;IAC3C,OAAO,GAAG,2BAA2B,GAAG,EAAE,EAAE,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,OAAO,GAAG,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;AACrD,CAAC"}

package/dist/esm/memory/embedding/cosine.d.ts

@@ -0,0 +1,18 @@
+/**
+ * cosineSimilarity — the similarity metric used by `store.search()`.
+ *
+ *   cos(a, b) = dot(a, b) / (||a|| * ||b||)
+ *
+ * Range: [-1, 1]. Equal-direction vectors → 1. Orthogonal → 0.
+ * Opposite → -1.
+ *
+ * Zero-magnitude handling: if either vector is all-zero (or the empty
+ * vector), returns 0 — never NaN. NaN in a similarity score would
+ * poison downstream picker comparisons (NaN < x is false for all x)
+ * and silently demote the entry. Explicit 0 is safer.
+ *
+ * Length mismatch THROWS: comparing vectors of different dimensions
+ * is almost always a bug (different embedders mixed in the same store).
+ * Fail loud rather than silently truncate.
+ */
+export declare function cosineSimilarity(a: readonly number[], b: readonly number[]): number;