Skip to content

Runbook: Test Utils: Conformance

Auto-generated from ./src/test-utils/conformance.ts. Do not edit by hand — run node scripts/gen-runbooks.mjs.

Import path: personaforge/test-utils/conformance · Public symbols: 10 · Guide: /guide/eval

What it is

personaforge/test-utils/conformance is a public entry point of personaforge. Import it directly; you only pull in this feature's code (subpath exports are tree-shakeable and optional native deps load lazily).

Install

bash
npm i personaforge
# or: bun add personaforge · pnpm add personaforge · yarn add personaforge

Import

ts
import { runSessionStoreConformance, runMemoryStoreConformance, runProviderConformance } from 'personaforge/test-utils/conformance';

Public API surface

  • Factories / functionsrunSessionStoreConformance, runMemoryStoreConformance, runProviderConformance, runVectorStoreConformance, runToolConformance, runKVStoreConformance
  • InterfacesAssertion, TestRunner, VectorStoreAdapter, KVStoreLike

Minimal use

ts
import { runSessionStoreConformance, runMemoryStoreConformance, runProviderConformance } from 'personaforge/test-utils/conformance';

// `runSessionStoreConformance` is the primary entry for this feature.
// See the type signature for full options.
const result = runSessionStoreConformance(/* opts */);

Verify it works

  • Type-check: npx tsc --noEmit resolves personaforge/test-utils/conformance with no missing-module error.
  • Runtime: node -e "import('personaforge/test-utils/conformance').then(m => console.log(Object.keys(m)))" lists the exports above.
  • Behavior: follow the runnable example in /guide/eval.

Common failures

  • Cannot find module 'personaforge/test-utils/conformance' — package not installed or stale build; run npm i personaforge and rebuild.
  • Cannot find module '<peer>' at call time — this feature lazy-loads an optional native/SDK dep; install the one named in the error.
  • Type errors after upgrade — check CHANGELOG.md for the symbol you import; names above are the current contract.

Rollback

  • Remove the import and the feature is gone from your bundle (subpaths are isolated; nothing else depends on importing it).
  • Pin a known-good version: npm i personaforge@<version>.

Released under the MIT License.