@kybernesis/brain-contracts 0.8.2 → 0.8.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kybernesis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# @kybernesis/brain-contracts
+
+[![npm](https://img.shields.io/npm/v/@kybernesis/brain-contracts)](https://www.npmjs.com/package/@kybernesis/brain-contracts)
+
+The **seam definitions** for the [Cortex](../../README.md) brain library: Zod schemas,
+provider interfaces, and shared constants. Everything else in the family depends on this
+package; it depends on nothing else.
+
+This is the package to read if you want to **implement your own provider** — the interfaces
+here are the contract your implementation must satisfy.
+
+## Install
+
+```bash
+pnpm add @kybernesis/brain-contracts
+```
+
+## What's in it
+
+- **Provider interfaces** — `StorageProvider` (and its repositories: timeline, entity-graph,
+  fact, sleep, vector), plus the shapes the kernel injects. The seams a backend must satisfy.
+- **Zod schemas + types** — `TimelineEvent`, `Entity`, `Fact`, sleep types, etc. Canonical
+  field shapes (snake_case to match the wire format), with a guard test enforcing it.
+- **`TenantContext` + `pathsFor`** — the per-brain context describing where its SQLite files
+  live. Build one per agent/workspace.
+- **Constants** — `EMBEDDING_MODEL` (`text-embedding-3-small`), `EMBEDDING_DIM` (1536),
+  `EMBEDDING_INPUT_CAP` (8192), `CLAUDE_MODEL_ALIASES`.
+
+## Subpath exports
+
+Import the whole surface from the root, or cherry-pick for tree-shaking:
+
+```ts
+import { pathsFor, type TenantContext } from '@kybernesis/brain-contracts';
+import { EMBEDDING_DIM } from '@kybernesis/brain-contracts/constants';
+```
+
+Available subpaths: `./tenant`, `./constants`, `./timeline`, `./entity`, `./fact`,
+`./sleep`, `./logger`.
+
+## Notes
+
+- ESM-only, TypeScript strict. No runtime dependencies beyond `zod`.
+- Implementing a provider against these interfaces? Validate it with
+  [`@kybernesis/brain-testkit`](../brain-testkit)'s `runParityHarness` / conformance cases.
+- Part of [Cortex](../../README.md) — `@kybernesis/brain-*`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kybernesis/brain-contracts",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "description": "Zod schemas, provider interfaces, and shared types for the Kybernesis brain library",
   "license": "MIT",
   "author": "David Cruwys (AppyDave)",