@kybernesis/brain-testkit 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,71 @@
+# @kybernesis/brain-testkit
+
+[![npm](https://img.shields.io/npm/v/@kybernesis/brain-testkit)](https://www.npmjs.com/package/@kybernesis/brain-testkit)
+
+Testing tools for the [Cortex](../../README.md) brain library — a parity harness, storage
+conformance cases, an isolated tenant factory, and an LLM stub. This is what you use to
+**prove a provider implementation conforms** to the contracts, and to test code that builds
+on `brain-core`.
+
+## Install
+
+```bash
+pnpm add -D @kybernesis/brain-testkit
+```
+
+## What's in it
+
+### `runParityHarness` — prove two backends agree
+
+```ts
+import { runParityHarness } from '@kybernesis/brain-testkit/parity';
+```
+
+Drives a sequence of brain operations against two `StorageProvider` implementations and
+asserts their resulting database state matches. The tool that guards "this new backend behaves
+exactly like the canonical one."
+
+### Storage conformance cases
+
+```ts
+import { storageConformanceCases } from '@kybernesis/brain-testkit/conformance';
+```
+
+A reusable suite a `StorageProvider` implementation runs against itself to verify it satisfies
+the [`@kybernesis/brain-contracts`](../brain-contracts) interface. (`brain-storage-sqlite`
+uses these in its own test suite.)
+
+### `createTestTenant` — isolated brain per test
+
+```ts
+import { createTestTenant } from '@kybernesis/brain-testkit/helpers';
+
+const { tenant, cleanup } = createTestTenant('my-suite');
+afterEach(cleanup);
+```
+
+Builds a `TenantContext` rooted in a unique tmpdir, so parallel tests never share SQLite files.
+
+### `makeLLMStub` — a deterministic LLM seam
+
+```ts
+import { makeLLMStub } from '@kybernesis/brain-testkit';
+import { setLLMProvider } from '@kybernesis/brain-core';
+
+const llm = makeLLMStub({ 'extract entities': '["Ada"]', '*': '[]' });
+setLLMProvider(llm);
+// …run code…
+expect(llm.calls).toHaveLength(1);   // every call is recorded (prompt + opts)
+```
+
+Maps prompt-substrings to canned responses (`'*'` is the wildcard fallback) and records every
+invocation on `.calls` so you can assert what the kernel passed through.
+
+## Subpath exports
+
+`.` (stub + tenant + re-exports), `./parity`, `./conformance`, `./helpers`.
+
+## Notes
+
+- ESM-only, TypeScript strict. Intended as a `devDependency`.
+- Part of [Cortex](../../README.md) — `@kybernesis/brain-*`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kybernesis/brain-testkit",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "description": "In-memory fakes and parity harness for testing brain-* consumers",
   "license": "MIT",
   "author": "David Cruwys (AppyDave)",
@@ -39,7 +39,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@kybernesis/brain-contracts": "0.8.2"
+    "@kybernesis/brain-contracts": "0.8.3"
   },
   "publishConfig": {
     "access": "public"