@theokit/sdk-memory 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog — @theokit/sdk-memory
+
+## [Unreleased]
+
+### Security (drift sync — iter 112/114/115, 2026-06-09)
+
+Three security/perf hardenings shipped in `@theokit/sdk`'s
+`internal/memory/` copies AFTER Stage 3 source-move completed
+(iter 44-75) were silently absent from `@theokit/sdk-memory`'s
+hybrid copies. Per ADR 0002 Stage 4 byte-equivalence invariant,
+they have now been synced. Consumers routing through
+`@theokit/sdk-memory` get the hardened behavior. The drift detector
+(iter 93) caught each gap and flipped to PASS after the sync.
+
+- **T4.9 — cross-tenant cache-key collision (iter 112)** —
+  `active-memory-cache.ts`'s `cacheKey` now accepts an optional
+  `TenantContext` (`namespace`/`userId`/`scope`) and NUL-separates
+  every key part. Pre-sync, two users sharing a process with the
+  same query could receive each other's cached result (DR4 finding
+  #9 — CRITICAL cross-tenant data leak).
+
+- **T4.6 — dreaming O(N²) sweep cap (iter 114)** —
+  `dreaming-phases.ts`'s `remPhase` accepts an optional
+  `maxFactsPerSweep` (default 500) and deterministically
+  subsamples when input exceeds the cap. Pre-sync, a 5000-fact
+  sweep ran 12.5M cosine-similarity comparisons (unacceptable).
+
+- **T5.2 — Lance SQL escape hardening (iter 115)** —
+  `lance-index.ts`'s `escapeSqlValue` now rejects NUL bytes,
+  C0 control chars, and DEL via `ConfigurationError({code:
+  'sql_injection_blocked'})`, and escapes backslashes (`\` →
+  `\\`) in addition to single quotes. Pre-sync, only `'` → `''`
+  was applied — `\'` could escape the closing quote on engines
+  that interpret backslash-escapes.
+
+### Added (Stage 3 source-move COMPLETE — iter 44-75, 2026-06-08 → 2026-06-09)
+
+38/38 source files from sdk-core's `internal/memory/*` now have
+canonical hybrid copies in this package. sdk-core retains its copies
+for v1.x back-compat; consumers installing this package get the
+canonical surface that sdk-core's Stage 4 routing delegates to.
+
+**Closed clusters:**
+- Dreaming (iter 54+59+60): `dreaming-phases.ts`, `dreaming-diary.ts`,
+  `dreaming-run.ts` + `active-memory-types.ts` (iter 48)
+- Sessions (iter 61+62): `session-summary-writer.ts`, `session-loader.ts`
+- Storage (iter 53+55-58+62): `markdown-store.ts`, `chunk-markdown.ts`,
+  `reader.ts`, `transcript-store.ts`, `wiki-loader.ts`
+- Index (iter 47+49-50+65-72): `index-manager-contract.ts`,
+  `index-schema.ts`, `memory-index.ts`, `index-db.ts`,
+  `sqlite-vec-loader.ts`, `vec-index.ts`, `lance-index.ts`,
+  `lance-memory-adapter.ts`, `index-manager-dispatch.ts`,
+  `index-manager.ts`
+- Migration (iter 63+71): `migration.ts`, `migrate-sqlite-to-lance.ts`
+- Adapters (iter 45+46+73+74): `embedding-adapter.ts`,
+  `embedding-cache.ts`, `openai-compatible.ts` + inlined
+  `adapter-http-error.ts` + 6 provider adapters
+  (openai/mistral/openrouter/voyage/deepinfra/ollama) +
+  `adapter-catalog.ts`
+- Core (iter 44+51+52+64+75): `circuit-breaker.ts`,
+  `active-memory-cache.ts`, `memory-types.ts`, `tools.ts`,
+  `active-memory.ts`
+
+**Optional peers** (sdk-memory dynamically loads when present):
+- `better-sqlite3` (iter 65)
+- `sqlite-vec` (iter 66)
+- `@lancedb/lancedb` (iter 68)
+
+**287 GREEN tests** across 38 files document every move's behavior;
+**zero unexpected drift** between sdk-core and sdk-memory copies
+(verified by the Stage 3 drift detector, iter 93).
+
+### Added (Phase 1 Stage 3 prep — iter 33-35, 2026-06-08)
+- `createInMemoryMarkdownProvider.recordSessionSummary` ships REAL
+  filesystem-backed impl (was no-op). Writes
+  `${cwd}/.theokit/memory/sessions/${sanitizeRunId(runId)}.md` via
+  `replaceFileAtomic` imported from `@theokit/sdk/internal/persistence`
+  (ADR-008 sub-path resolution). Mirrors sdk-core's legacy
+  `writeSessionSummary` semantics — YAML frontmatter + User/Assistant
+  sections, 2000-char truncation, runId sanitization.
+- `runActivePass()` now reads previously-written session summaries
+  from disk + substring-matches against the user message — closes
+  the "write but never read" gap. In-process Map facts AND disk-recall
+  hits both contribute to `systemPromptAdditions`. Capped at 5 hits
+  per pass.
+- NEW LLM-facing tool: `memory_search(query)` — surfaced in
+  `buildTools` alongside `memory_remember`. The LLM can explicitly
+  query the disk sessions corpus when the user references past
+  conversations. Returns JSON `{ok, count, results: [{id, snippet}]}`.
+
+### Changed (Phase 1 physical Stage 1 — iter 19, 2026-06-08)
+- `createInMemoryMarkdownProvider` now implements the new optional
+  `sync(handle)` port method (no-op for the in-process impl — facts
+  are written synchronously to the Map at handler-call time; nothing
+  to re-index post-run). Future LanceDB-backed impl will fire
+  `IndexManager.sync()` here. Back-compat preserved: existing impls
+  that omit `sync` are still valid per the optional-method spec.
+
+## [0.1.0] — 2026-06-08
+
+### Added
+- Initial release. Consumes the `MemoryProvider` port from `@theokit/sdk@>=1.7.0`
+  (SDK 2.0 Phase 1 / T1.6).
+- `createInMemoryMarkdownProvider()` — first concrete impl. In-process
+  fact store; LLM-facing `memory_remember` tool; `runActivePass()` emits
+  `systemPromptAdditions` for recalled facts; full lifecycle compliance.
+
+### Notes
+- LanceDB / embeddings / circuit-breaker / dreaming-sweep deferred to future
+  versions. This release ships the package foundation + a working impl so
+  the SDK 2.0 cohort can publish (Phase 7).
+- `peerDependency`: `@theokit/sdk >= 1.7.0` (where the port was shipped).

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 usetheo.dev
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,86 @@
+# @theokit/sdk-memory
+
+Memory subsystem for [`@theokit/sdk`](https://www.npmjs.com/package/@theokit/sdk).
+Implements the kernel-facing `MemoryProvider` port (SDK 2.0 Phase 1 / T1.1 —
+Hexagonal Architecture / SOLID Dependency Inversion).
+
+```ts
+import { Agent } from "@theokit/sdk";
+import { createInMemoryMarkdownProvider } from "@theokit/sdk-memory";
+
+const agent = await Agent.create({
+  agentId: "support-bot",
+  model: { id: "anthropic/claude-3-5-haiku-latest" },
+  memoryProvider: createInMemoryMarkdownProvider(),
+  // ...other options
+});
+```
+
+## What ships today (Unreleased, post v0.1.0)
+
+`createInMemoryMarkdownProvider()` is now a real cross-session recall
+provider with the full canonical memory surface:
+
+| Method | What it does |
+|---|---|
+| `init(opts)` | Captures `cwd` for disk paths; sets up per-agent in-process Map. |
+| `buildTools()` | Surfaces **2 LLM-facing tools**: `memory_remember(content)` + `memory_search(query)`. |
+| `runActivePass()` | Combines in-process facts (this session's Map) AND disk-recalled session summaries (previous sessions, substring-matched against user message). Up to 5 hits. |
+| `recordSessionSummary()` | Real filesystem write to `${cwd}/.theokit/memory/sessions/${runId}.md`. Atomic via sdk-core's `replaceFileAtomic`. Same semantics as sdk-core's legacy `writeSessionSummary`. |
+| `sync()` | No-op (in-process Map writes are synchronous). |
+| `dispose()` | Clears in-process Map. Disk artefacts persist by design (cross-session recall). |
+
+LLM-facing tools surfaced via `buildTools`:
+
+- **`memory_remember(content)`** — the LLM writes a fact to the
+  per-session Map. Useful for "remember this for the rest of this
+  conversation" use cases.
+- **`memory_search(query)`** — the LLM queries previously-written
+  session summaries on disk. Returns up to 5 short snippets as JSON.
+  Useful when the user asks about something from a past conversation.
+
+## What's coming (future versions)
+
+- `createLanceMemoryProvider(...)` — persistent LanceDB-backed store
+  with **embedding-based ANN recall** (replaces the current substring
+  matcher) via OpenAI / Ollama / Voyage embedding adapters.
+- Circuit-breaker + active-memory cache for hot-path resilience.
+- Multi-adapter fan-out (write to multiple stores; merge-dedup recall).
+- Dreaming sweep + memory revisions.
+
+## Cross-package coupling: `@theokit/sdk/internal/persistence`
+
+sdk-memory's `recordSessionSummary` consumes
+`replaceFileAtomic` from sdk-core via the
+`@theokit/sdk/internal/persistence` sub-path (per ADR-008). The sub-path
+is internal API — semver-exempt; may break in patch releases. Pin both
+packages to the same SemVer minor when upgrading sdk-core.
+
+The cross-package import keeps the **single-process mutex Map invariant**
+intact (one module instance shared across packages — both writers
+serialize against the same registry).
+
+## Architecture
+
+This package is a **port consumer**, not a kernel mod. The contract
+lives in `@theokit/sdk/internal/runtime/memory-provider.ts` and is
+exposed to consumers via:
+
+```ts
+import type {
+  MemoryProvider,
+  MemoryProviderHandle,
+  MemoryProviderInitOptions,
+  ActiveMemoryPassArgs,
+  ActiveMemoryPassResult,
+} from "@theokit/sdk";
+```
+
+The agent loop calls the port's four lifecycle methods at well-defined
+hook points (init / buildTools / runActivePass / dispose). Your impl
+fulfills the contract; sdk-core never imports this package directly —
+that's the seam that makes the split possible.
+
+## License
+
+Apache-2.0 © useTheo

package/dist/in-memory-provider.d.ts

@@ -0,0 +1,38 @@
+/**
+ * `createInMemoryMarkdownProvider` — first concrete `MemoryProvider`
+ * impl shipped in `@theokit/sdk-memory` (SDK 2.0 Phase 1 / T1.6).
+ *
+ * Goal: prove the contract works end-to-end with a real (non-no-op)
+ * impl WITHOUT pulling LanceDB / embedding / circuit-breaker infrastructure.
+ * That richer impl lands in subsequent iters.
+ *
+ * Semantics:
+ *   - Stores recalled facts in a per-agent in-process Map.
+ *   - `runActivePass()` returns the facts plus a `systemPromptAdditions`
+ *     string that joins fact contents with newlines (so the LLM sees
+ *     them in the system slot).
+ *   - `buildTools()` surfaces a `memory_remember(content)` tool the LLM
+ *     can call to persist a fact mid-conversation.
+ *   - `recordSessionSummary()` writes a markdown summary to
+ *     `${cwd}/.theokit/memory/sessions/${runId}.md` (real disk write
+ *     via `@theokit/sdk/internal/persistence` per ADR-008).
+ *   - `dispose()` clears the handle's per-agent map (releases memory).
+ *
+ * @public
+ */
+import type { MemoryProvider } from "@theokit/sdk";
+/**
+ * Build a fresh `MemoryProvider` whose facts live in-process. The
+ * returned provider is independent — call `createInMemoryMarkdownProvider()`
+ * per agent OR share across agents (each `init()` gets its own state).
+ *
+ * Iter 33: `recordSessionSummary()` writes session-summary markdown
+ * files to disk under `${cwd}/.theokit/memory/sessions/`.
+ * Iter 34: `runActivePass()` reads back those summaries + substring-
+ * matches against the user message for genuine cross-session recall.
+ *
+ * Future LanceDB-backed impl will replace the substring match with
+ * semantic-similarity ANN over embedding vectors.
+ */
+export declare function createInMemoryMarkdownProvider(): MemoryProvider;
+//# sourceMappingURL=in-memory-provider.d.ts.map

package/dist/in-memory-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-provider.d.ts","sourceRoot":"","sources":["../src/in-memory-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,OAAO,KAAK,EASV,cAAc,EAMf,MAAM,cAAc,CAAC;AAyRtB;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,IAAI,cAAc,CAoE/D"}