agentfootprint 1.23.0 → 2.1.0

package/dist/types/lib/injection-engine/types.d.ts

@@ -0,0 +1,175 @@
+/**
+ * Injection Engine — types.
+ *
+ * THE primitive that unifies every form of context engineering in the
+ * library. Skills, Steering docs, Instructions, RAG, Memory, custom
+ * Context — all reduce to one shape: an `Injection` with a `trigger`
+ * (when), `inject` (what — one or more slot targets), and a `flavor`
+ * (observability tag).
+ *
+ * Pattern: Strategy (GoF) — each Injection's trigger is a strategy for
+ *          "should I activate this iteration?". Each Injection's
+ *          `inject` is the Memento (GoF) carrying content to slots.
+ * Role:    Layer-3 context engineering primitive in the stack.
+ *          Sits below the slot subflows.
+ * Emits:   Engine emits `agentfootprint.context.evaluated` once per
+ *          iteration. Slot subflows emit `agentfootprint.context.injected`
+ *          for each InjectionRecord they place.
+ */
+import type { Tool } from '../../core/tools.js';
+import type { ContextRole, ContextSource } from '../../events/types.js';
+/**
+ * Discriminated union — exactly one of four kinds. Adding a new
+ * trigger kind is one new variant; engine evaluator + Lens chip
+ * naturally extend.
+ */
+export type InjectionTrigger = 
+/** Always-on. Used for steering-doc-style injections. */
+{
+    readonly kind: 'always';
+}
+/** Predicate runs once per iteration. Most flexible. */
+ | {
+    readonly kind: 'rule';
+    readonly activeWhen: (ctx: InjectionContext) => boolean;
+}
+/** Activates after a specific tool returns. The "Dynamic ReAct" flavor —
+ *  tool results steer the next iteration's prompt. `toolName` matches
+ *  literally (string) or by regex. */
+ | {
+    readonly kind: 'on-tool-return';
+    readonly toolName: string | RegExp;
+}
+/** Activates when the LLM calls a designated tool. The "Skill" flavor:
+ *  `read_skill('billing')` activates the billing Skill for the next
+ *  iteration. */
+ | {
+    readonly kind: 'llm-activated';
+    readonly viaToolName: string;
+};
+/**
+ * Multi-slot per Injection. A Skill for example targets BOTH
+ * system-prompt (the body) AND tools (the unlocked capabilities)
+ * in one Injection. Lens displays the same Injection chip across
+ * each slot it lands in.
+ */
+export interface InjectionContent {
+    /** Text appended to the system-prompt slot when active. */
+    readonly systemPrompt?: string;
+    /** Messages prepended to the messages slot when active. */
+    readonly messages?: ReadonlyArray<{
+        readonly role: ContextRole;
+        readonly content: string;
+    }>;
+    /** Tools added to the tools slot when active. */
+    readonly tools?: readonly Tool[];
+}
+/**
+ * Context passed to `rule` predicates. Read-only snapshot of the
+ * agent's iteration state. Internal mutable state is hidden.
+ */
+export interface InjectionContext {
+    /** Current ReAct iteration (1-based). */
+    readonly iteration: number;
+    /** The current user message that started this turn. */
+    readonly userMessage: string;
+    /**
+     * Conversation history up to (but not including) the current
+     * iteration's LLM call. Includes prior iterations within the same turn.
+     */
+    readonly history: ReadonlyArray<{
+        readonly role: ContextRole;
+        readonly content: string;
+        readonly toolName?: string;
+    }>;
+    /**
+     * The most recent tool result, if the previous iteration ended in a
+     * tool call. Used both by `rule` predicates and by `on-tool-return`
+     * trigger evaluation.
+     */
+    readonly lastToolResult?: {
+        readonly toolName: string;
+        readonly result: string;
+    };
+    /**
+     * IDs of LLM-activated injections that the LLM has activated this
+     * turn (via their `viaToolName` tool call). Engine includes them
+     * in the active set on subsequent iterations until turn end.
+     */
+    readonly activatedInjectionIds: readonly string[];
+}
+/**
+ * THE primitive. Five fields. Four trigger kinds. Three slot targets.
+ *
+ * Every named flavor (Skill, Steering, Instruction, Context, RAG,
+ * Memory, Guardrail, …) is a sugar factory that produces one of these.
+ *
+ * @example
+ *   // Direct construction (power user)
+ *   const myInjection: Injection = {
+ *     id: 'demo',
+ *     flavor: 'instructions',
+ *     trigger: { kind: 'rule', activeWhen: (ctx) => ctx.iteration > 1 },
+ *     inject: { systemPrompt: 'Refine the previous answer.' },
+ *   };
+ *
+ *   // Sugar (recommended)
+ *   const myInjection2 = defineInstruction({
+ *     id: 'demo',
+ *     activeWhen: (ctx) => ctx.iteration > 1,
+ *     prompt: 'Refine the previous answer.',
+ *   });
+ */
+export interface Injection {
+    /** Unique id. Used for observability + de-duplication + LLM-activation lookup. */
+    readonly id: string;
+    /** Human-readable description (Lens / docs / debug). */
+    readonly description?: string;
+    /** Observability tag. Drives Lens chip color + ContextRecorder source field. */
+    readonly flavor: ContextSource;
+    /** WHEN to activate. */
+    readonly trigger: InjectionTrigger;
+    /** WHAT to contribute (one or more slots). */
+    readonly inject: InjectionContent;
+}
+/**
+ * Returned by `evaluateInjections()`. Slot subflows consume `active`;
+ * `skipped` is observability metadata (predicate errors).
+ */
+export interface InjectionEvaluation {
+    readonly active: readonly Injection[];
+    readonly skipped: ReadonlyArray<{
+        readonly id: string;
+        readonly reason: 'predicate-threw' | 'unknown-trigger-kind';
+        readonly error?: string;
+    }>;
+}
+/**
+ * POJO projection of an active Injection — flows through footprintjs
+ * scope (which cannot serialize functions) so that slot subflows can
+ * read it across the subflow boundary.
+ *
+ * Drops the `trigger` (already evaluated) and projects `inject.tools`
+ * to schemas only (the Tool's `execute` function lives on the Agent's
+ * closure-held registry, looked up by injection id at exec time).
+ */
+export interface ActiveInjection {
+    readonly id: string;
+    readonly flavor: import('../../events/types.js').ContextSource;
+    readonly description?: string;
+    readonly inject: {
+        readonly systemPrompt?: string;
+        readonly messages?: ReadonlyArray<{
+            readonly role: import('../../events/types.js').ContextRole;
+            readonly content: string;
+        }>;
+        /** Tool schemas only — `execute` lives on Agent's closure registry. */
+        readonly tools?: ReadonlyArray<{
+            readonly schema: import('../../adapters/types.js').LLMToolSchema;
+            readonly injectionId: string;
+        }>;
+    };
+}
+/** Project a full Injection (with functions) into a scope-safe POJO. */
+export declare function projectActiveInjection(inj: Injection): ActiveInjection;
+//# sourceMappingURL=types.d.ts.map

package/dist/types/lib/injection-engine/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/lib/injection-engine/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAIxE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB;AAC1B,yDAAyD;AACvD;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE;AAC7B,wDAAwD;GACtD;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,OAAO,CAAC;CACzD;AACH;;sCAEsC;GACpC;IACE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;CACpC;AACH;;iBAEiB;GACf;IACE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B,CAAC;AAIN;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;QAChC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;QAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;IACH,iDAAiD;IACjD,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,IAAI,EAAE,CAAC;CAClC;AAID;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;QAC9B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;QAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC,CAAC;IACH;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE;QACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,CAAC;IACF;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,CAAC;CACnD;AAID;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,SAAS;IACxB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,gFAAgF;IAChF,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,wBAAwB;IACxB,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;CACnC;AAID;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;QAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,MAAM,EAAE,iBAAiB,GAAG,sBAAsB,CAAC;QAC5D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC,CAAC;CACJ;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,OAAO,uBAAuB,EAAE,aAAa,CAAC;IAC/D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE;QACf,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAC/B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;YAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,uBAAuB,EAAE,WAAW,CAAC;YAC3D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;SAC1B,CAAC,CAAC;QACH,uEAAuE;QACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;YAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,yBAAyB,EAAE,aAAa,CAAC;YACjE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;SAC9B,CAAC,CAAC;KACJ,CAAC;CACH;AAED,wEAAwE;AACxE,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,SAAS,GAAG,eAAe,CAiBtE"}

package/dist/types/lib/rag/defineRAG.d.ts

@@ -0,0 +1,141 @@
+/**
+ * defineRAG — sugar factory for retrieval-augmented generation.
+ *
+ * RAG is a context-engineering flavor: embed the user's question,
+ * retrieve top-K semantically similar chunks from a vector store,
+ * inject those chunks into the messages slot of the next LLM call.
+ * It's the same plumbing as `defineMemory({ type: SEMANTIC,
+ * strategy: TOP_K })` — the rename is for intent + ergonomics.
+ *
+ *   defineMemory ─┬─► EPISODIC   (raw conversation)
+ *                 ├─► SEMANTIC   (extracted facts / RAG chunks)
+ *                 ├─► NARRATIVE  (beats / summaries)
+ *                 └─► CAUSAL     (footprintjs decision snapshots)
+ *
+ *   defineRAG    ─►  SEMANTIC + TOP_K with RAG-specific defaults
+ *                    (asRole='user', threshold=0.7, no LLM-extract)
+ *
+ * Pattern: Composition over duplication — defineRAG returns a
+ *          MemoryDefinition produced by defineMemory. No new engine
+ *          code, no new slot subflow, no new event type.
+ *
+ * Role:    Layer-3 context-engineering primitive. Lives next to
+ *          defineSkill / defineSteering / defineInstruction / defineFact
+ *          but resolves to a memory subflow rather than an Injection
+ *          (RAG content is computed at runtime via async retrieval —
+ *          can't fit the synchronous Injection.inject shape).
+ *
+ * Emits:   Indirectly — the underlying memory pipeline emits
+ *          `agentfootprint.context.injected` when retrieved chunks
+ *          land in the messages slot.
+ *
+ * 7-panel review (2026-04-29):
+ * - LLM Systems    ✅  injects as 'user' role by default — RAG chunks
+ *                      land where the LLM treats them as authoritative
+ *                      retrieved context, not behavior rules
+ * - Architect      ✅  composition over defineMemory; zero new engine
+ *                      code; multi-RAG layering works via per-id keys
+ * - API Designer   ✅  one factory, mirrors defineMemory shape; consumer
+ *                      ergonomics: `agent.rag(defineRAG({...}))`
+ * - Performance    ✅  embedding cost is one call per turn (TURN_START
+ *                      timing, default); strict threshold prevents
+ *                      injecting low-confidence noise
+ * - Privacy        ✅  multi-tenant via MemoryIdentity tuple; doc
+ *                      content never crosses tenant boundaries
+ * - ML / IR        ✅  embedder version pinned via `embedderId`; cosine
+ *                      score semantics inherited from MemoryStore
+ * - SoftEng        ✅  thin file (this one); existing memory tests
+ *                      cover the underlying pipeline
+ *
+ * @see ./indexDocuments.ts  for the seeding helper
+ * @see ../../memory/define.ts  for the underlying factory
+ *
+ * @example  Basic usage
+ * ```ts
+ * import {
+ *   Agent, defineRAG, indexDocuments, InMemoryStore, mockEmbedder,
+ * } from 'agentfootprint';
+ *
+ * const embedder = mockEmbedder();
+ * const store = new InMemoryStore();
+ *
+ * // Seed the store once at startup
+ * await indexDocuments(store, embedder, [
+ *   { id: 'doc1', content: 'Refunds are processed within 3 business days.' },
+ *   { id: 'doc2', content: 'Pro plan costs $20/month.' },
+ * ]);
+ *
+ * const docs = defineRAG({
+ *   id: 'product-docs',
+ *   description: 'Retrieve product documentation chunks',
+ *   store,
+ *   embedder,
+ *   topK: 3,
+ *   threshold: 0.6,
+ * });
+ *
+ * const agent = Agent.create({ provider }).rag(docs).build();
+ * ```
+ */
+import type { ContextRole } from '../../events/types.js';
+import type { Embedder } from '../../memory/embedding/index.js';
+import type { MemoryStore } from '../../memory/store/index.js';
+import type { MemoryDefinition } from '../../memory/define.types.js';
+export interface DefineRAGOptions {
+    /** Stable id. Becomes the scope-key suffix and the Lens label. */
+    readonly id: string;
+    /**
+     * Human-readable description. Surfaces in narrative + Lens hover.
+     * Recommend describing the *corpus* (e.g., "Product documentation
+     * chunks indexed weekly from docs.example.com").
+     */
+    readonly description?: string;
+    /**
+     * Vector-capable store containing the indexed corpus. Must implement
+     * `search()`. Use `indexDocuments(store, embedder, docs)` at startup
+     * to populate it. Ships with `InMemoryStore` for dev/tests; swap to
+     * `pgvector` / Pinecone / Qdrant adapters in production.
+     */
+    readonly store: MemoryStore;
+    /**
+     * Embedder used for the read-side query. Pass the SAME embedder
+     * instance (or one with the same `name`) that was used for indexing
+     * — cross-model similarity scores are not comparable.
+     */
+    readonly embedder: Embedder;
+    /**
+     * Stable id of the embedder. Stored on entries during indexing
+     * (via `indexDocuments`) and filtered at search time so a later
+     * embedder swap doesn't pollute results.
+     */
+    readonly embedderId?: string;
+    /**
+     * Top-K chunks to retrieve per turn. Default 3 (balanced —
+     * defends against lost-in-the-middle while giving multiple
+     * perspectives). Increase for richer context, decrease for cost.
+     */
+    readonly topK?: number;
+    /**
+     * Minimum cosine similarity to inject. **Strict** — when no chunk
+     * meets the threshold, NO injection happens (no fallback that would
+     * pollute the prompt with weak matches). Default 0.7.
+     */
+    readonly threshold?: number;
+    /**
+     * Role to use when injecting retrieved chunks into the messages
+     * slot. Default `'user'` — RAG chunks are most often treated as
+     * "context the user provided" by LLMs. Use `'system'` for
+     * authoritative reference docs that should outweigh user instruction.
+     */
+    readonly asRole?: ContextRole;
+}
+/**
+ * Build a RAG context-engineering definition. The returned
+ * `MemoryDefinition` is registered on the Agent via `.rag(definition)`
+ * (or, equivalently, `.memory(definition)` — same plumbing).
+ *
+ * @throws when `store` does not implement `search()`. RAG requires a
+ *         vector-capable adapter.
+ */
+export declare function defineRAG(opts: DefineRAGOptions): MemoryDefinition;
+//# sourceMappingURL=defineRAG.d.ts.map

package/dist/types/lib/rag/defineRAG.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineRAG.d.ts","sourceRoot":"","sources":["../../../../src/lib/rag/defineRAG.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAIrE,MAAM,WAAW,gBAAgB;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,CA8BlE"}

package/dist/types/lib/rag/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * RAG — retrieval-augmented generation as a context-engineering
+ * flavor. ONE factory + ONE seeding helper. Composes over the memory
+ * subsystem (semantic + top-K + strict threshold).
+ */
+export { defineRAG, type DefineRAGOptions } from './defineRAG.js';
+export { indexDocuments, type IndexDocumentsOptions, type RagDocument } from './indexDocuments.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/rag/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/rag/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/types/lib/rag/indexDocuments.d.ts

@@ -0,0 +1,77 @@
+/**
+ * indexDocuments — seed a vector-capable MemoryStore with documents.
+ *
+ * Embeds each document, builds a `MemoryEntry<{content, metadata?}>`,
+ * batches into `store.putMany()`. Used at application startup to
+ * populate a RAG store before the first agent run.
+ *
+ * Pattern: Bulk-write helper. Not a flowchart stage — it runs once
+ *          at boot, not per-iteration.
+ * Role:    Layer-3 RAG pipeline starter. Pairs with `defineRAG()`
+ *          which only does the read side.
+ * Emits:   N/A — startup-time batch write, not part of the agent run.
+ *
+ * @example
+ * ```ts
+ * import { InMemoryStore, mockEmbedder, indexDocuments, defineRAG } from 'agentfootprint';
+ *
+ * const store = new InMemoryStore();
+ * const embedder = mockEmbedder();
+ *
+ * await indexDocuments(store, embedder, [
+ *   { id: 'doc1', content: 'Refunds processed within 3 business days.' },
+ *   { id: 'doc2', content: 'Pro plan: $20/mo, includes priority support.', metadata: { tier: 'pro' } },
+ *   { id: 'doc3', content: 'Free plan: limited to 100 calls/month.' },
+ * ]);
+ *
+ * const docs = defineRAG({ id: 'product-docs', store, embedder });
+ * agent.rag(docs);
+ * ```
+ */
+import type { Embedder } from '../../memory/embedding/index.js';
+import type { MemoryStore } from '../../memory/store/index.js';
+import type { MemoryIdentity } from '../../memory/identity/index.js';
+/** A document to index. `id` must be unique within the store + identity. */
+export interface RagDocument {
+    readonly id: string;
+    readonly content: string;
+    readonly metadata?: Readonly<Record<string, unknown>>;
+}
+export interface IndexDocumentsOptions {
+    /**
+     * Identity scope to write under. Default: a single shared
+     * `{ conversationId: '_global' }` namespace, suitable for app-wide
+     * corpora. Override for per-tenant document partitions.
+     */
+    readonly identity?: MemoryIdentity;
+    /**
+     * Stable id of the embedder. Stored on each entry so a future
+     * embedder swap doesn't silently mix similarity scores. Default:
+     * `'default-embedder'` — pass an explicit id when you may rotate
+     * embedders.
+     */
+    readonly embedderId?: string;
+    /**
+     * Optional tier tag to attach to indexed entries (`'hot'` /
+     * `'warm'` / `'cold'`). Useful when read-side `defineRAG` should
+     * filter to a subset of the corpus.
+     */
+    readonly tier?: 'hot' | 'warm' | 'cold';
+    /**
+     * Optional TTL in milliseconds from indexing time. Useful for
+     * compliance retention windows (e.g., re-index quarterly).
+     */
+    readonly ttlMs?: number;
+    /**
+     * Optional abort signal — embedders making network calls thread
+     * this through to abort batch indexing on shutdown / timeout.
+     */
+    readonly signal?: AbortSignal;
+}
+/**
+ * Embed + persist documents. Returns the count actually indexed
+ * (skips duplicates if the store rejects them). Throws on embedder
+ * failure or store error — fail loud at startup is desirable.
+ */
+export declare function indexDocuments(store: MemoryStore, embedder: Embedder, documents: readonly RagDocument[], options?: IndexDocumentsOptions): Promise<number>;
+//# sourceMappingURL=indexDocuments.d.ts.map

package/dist/types/lib/rag/indexDocuments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexDocuments.d.ts","sourceRoot":"","sources":["../../../../src/lib/rag/indexDocuments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAEhE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAErE,4EAA4E;AAC5E,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC;IAEnC;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAExC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAID;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,SAAS,WAAW,EAAE,EACjC,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CAwCjB"}

package/dist/types/memory/beats/extractor.d.ts

@@ -18,7 +18,7 @@
  * rules-based extractor for a specific domain, or a hybrid that
  * combines heuristics with LLM rescoring.
  */
-import type { Message } from '../../types/messages';
+import type { LLMMessage as Message } from '../../adapters/types';
 import type { NarrativeBeat } from './types';
 export interface ExtractArgs {
     /**

package/dist/types/memory/beats/extractor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extractor.d.ts","sourceRoot":"","sources":["../../../../src/memory/beats/extractor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,aAAa,EAAE,CAAC,CAAC;CAC/D"}
+{"version":3,"file":"extractor.d.ts","sourceRoot":"","sources":["../../../../src/memory/beats/extractor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,EAAE,UAAU,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,aAAa,EAAE,CAAC,CAAC;CAC/D"}

package/dist/types/memory/beats/llmExtractor.d.ts

@@ -32,11 +32,11 @@
  *
  * const pipeline = narrativePipeline({
  *   store: new InMemoryStore(),
- *   extractor: llmExtractor({ provider: anthropic('claude-haiku-4-5') }),
+ *   extractor: llmExtractor({ provider: yourLLMProvider }),
  * });
  * ```
  */
-import type { LLMProvider } from '../../types';
+import type { LLMProvider } from '../../adapters/types';
 import type { BeatExtractor } from './extractor';
 export interface LLMExtractorConfig {
     /** The provider used for extraction. Typically a cheap/fast model. */

package/dist/types/memory/beats/llmExtractor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"llmExtractor.d.ts","sourceRoot":"","sources":["../../../../src/memory/beats/llmExtractor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,KAAK,EAAE,WAAW,EAAW,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,aAAa,CAAC;AAI9D,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CACtE;AA4FD,wBAAgB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,aAAa,CA4BtE"}
+{"version":3,"file":"llmExtractor.d.ts","sourceRoot":"","sources":["../../../../src/memory/beats/llmExtractor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,KAAK,EAAE,WAAW,EAAyB,MAAM,sBAAsB,CAAC;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,aAAa,CAAC;AAI9D,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CACtE;AA6ED,wBAAgB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,aAAa,CA2BtE"}

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

@@ -0,0 +1,6 @@
+export type { SnapshotEntry, DecisionRecord, ToolCallRecord, ProjectedSnapshot, SnapshotMessage, } from './types.js';
+export { DEFAULT_TOOL_RESULT_PREVIEW_LEN } from './types.js';
+export { writeSnapshot, type WriteSnapshotConfig } from './writeSnapshot.js';
+export { loadSnapshot, type LoadSnapshotConfig } from './loadSnapshot.js';
+export { snapshotPipeline, type SnapshotPipelineConfig } from './snapshotPipeline.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/memory/causal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/memory/causal/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,aAAa,EACb,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAC;AAE7D,OAAO,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,MAAM,uBAAuB,CAAC"}

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

@@ -0,0 +1,52 @@
+/**
+ * loadSnapshot — read-side stage for Causal memory.
+ *
+ * Embeds the user's current question, searches the store for the most
+ * similar past run, projects the snapshot per `SnapshotProjection`,
+ * and writes the formatted result to `scope.formatted` so the
+ * downstream slot subflow injects it as a system message.
+ *
+ * Reads from scope:   `identity`, `messages` (or `newMessages` fallback)
+ * Writes to scope:    `formatted` — array of `LLMMessage` to inject
+ *
+ * Strict-threshold semantics:
+ *   When `minScore` is set and no past snapshot meets it, returns an
+ *   empty `formatted`. NO fallback — garbage past context is worse than
+ *   no context. Aligns with the LLM-systems panel verdict in the design.
+ *
+ * Empty-query handling:
+ *   No user message → no embedding → no search → empty result.
+ */
+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';
+import { type SnapshotProjection } from '../define.types.js';
+export interface LoadSnapshotConfig {
+    /** Vector-capable store. Must implement `search()`. */
+    readonly store: MemoryStore;
+    /** Embedder used to vectorize the current query. */
+    readonly embedder: Embedder;
+    /** Stable id of the embedder — filters cross-model results out. */
+    readonly embedderId?: string;
+    /** Top-k snapshots to retrieve. Default 1 (most-relevant past run). */
+    readonly topK?: number;
+    /**
+     * Minimum cosine score [-1, 1]. Strict — entries below this are
+     * dropped. When no entry meets the threshold, the stage emits no
+     * messages (no fallback). Default 0.7.
+     */
+    readonly minScore?: number;
+    /**
+     * Slice of the snapshot to project. Default `'decisions'` —
+     * decision evidence is the highest-signal field for "why" follow-ups.
+     */
+    readonly projection?: SnapshotProjection;
+    /**
+     * Optional override for query extraction. Default: last user
+     * message in `scope.messages` (current turn's question).
+     */
+    readonly queryFrom?: (scope: TypedScope<MemoryState>) => string;
+}
+export declare function loadSnapshot(config: LoadSnapshotConfig): (scope: TypedScope<MemoryState>) => Promise<void>;
+//# sourceMappingURL=loadSnapshot.d.ts.map

package/dist/types/memory/causal/loadSnapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadSnapshot.d.ts","sourceRoot":"","sources":["../../../../src/memory/causal/loadSnapshot.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAwB,KAAK,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAEnF,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,mEAAmE;IACnE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B,uEAAuE;IACvE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEzC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC;CACjE;AAaD,wBAAgB,YAAY,CAAC,MAAM,EAAE,kBAAkB,WAahC,WAAW,WAAW,CAAC,KAAG,QAAQ,IAAI,CAAC,CA+B7D"}

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

@@ -0,0 +1,36 @@
+/**
+ * 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;
+//# sourceMappingURL=snapshotPipeline.d.ts.map

package/dist/types/memory/causal/snapshotPipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotPipeline.d.ts","sourceRoot":"","sources":["../../../../src/memory/causal/snapshotPipeline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAK7D,MAAM,WAAW,sBAAsB;IACrC,yEAAyE;IACzE,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B,sEAAsE;IACtE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B,8DAA8D;IAC9D,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEzC,uEAAuE;IACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;CACzC;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,cAAc,CAkC/E"}