@vitest-agent/sdk

Part of the vitest-agent ecosystem. Most users want @vitest-agent/plugin, which pulls this package in automatically. Install @vitest-agent/sdk directly only if you build tooling on the shared schemas or data layer.

The no-internal-deps base for the vitest-agent ecosystem. Carries the Effect Schemas, SQLite migrations and data layer, services and live layers, formatters, XDG path resolution, the public reporter and dispatcher contract types, and testing utilities.

Features

• Effect Schemas — all domain types (RunEvent, RenderState, CoverageTargets, TurnPayload, identity types) defined with Effect Schema; runtime validation and TypeScript types from one source
• SQLite data layer — DataStore and DataReader Effect services with live and :memory: test layers; ensureMigrated for safe multi-project setups
• XDG path resolution — deterministic dbPath derivation from workspace identity with a five-source fallback chain
• Reporter and dispatcher contracts — VitestAgentReporterFactory, ReporterKit, ResolvedReporterConfig, DispatchInputs and the types consumed by every other package
• Sidecar dispatch core — dispatch, injectEnv and exitCodeForTag on the @vitest-agent/sdk/dispatch sub-path for a minimal SEA bundle
• Test utilities — makeTestLayer, DataStoreTestLayer and five preset factory functions on the @vitest-agent/sdk/testing sub-path

Install

npm install @vitest-agent/sdk
# or
pnpm add @vitest-agent/sdk

Quick start

import { Effect } from "effect";
import { DataReader } from "@vitest-agent/sdk";
import { singlePassingRun } from "@vitest-agent/sdk/testing";

const layer = singlePassingRun(":memory:");

await Effect.runPromise(
  Effect.provide(
    Effect.flatMap(DataReader, (r) => r.getLatestRun("default", null)),
    layer,
  ),
);
// returns the seeded run row

Documentation

Package reference at vitest-agent.dev/sdk.

License

MIT