Public packages

Use declared package entry points. Each package’s README contains public-import examples and its package.json declares the supported exports.

Package / entry point	Scope
`counterfact`	`counterfact()` and simulator configuration/lifecycle types; the CLI combines generation, runtime, and REPL.
`@counterfact/client`	Raw HTTP client, route catalog, and immutable request builder.
`@counterfact/openapi`	OpenAPI loading, bundling, dereferencing, and overlays.
`@counterfact/generator`	TypeScript contracts, editable route scaffolding, scenarios, and templates.
`@counterfact/runtime`	Registries, dispatch contracts, validation, and module loading.
`@counterfact/runtime/koa`	Koa HTTP adapter.
`@counterfact/runtime/msw`	MSW adapter interfaces.
`@counterfact/repl`	Embeddable REPL.
`@counterfact/types`	Shared contracts for generated code and package integration.

Architecture overview

OpenAPI spec (YAML or JSON, local or URL)
        │
        ▼
┌──────────────────────┐
│ TypeScript Generator │  → routes/  (one .ts per path)
│                      │  → types/   (request/response interfaces)
└──────────────────────┘
        │
        ▼
┌──────────────────────┐
│  Koa HTTP Server     │  → dispatches requests to route handlers
│  + Hot Reload        │  → watches for file changes via chokidar
│  + REPL              │  → interactive terminal attached to live state
│  + Proxy             │  → optional passthrough to a real backend
└──────────────────────┘

Package-level examples

The repository package directory contains README files and runnable examples for individual packages.

The MSW entry point is an adapter interface. Its existence does not imply that the Node-oriented runtime can be loaded directly into a browser. The standard Counterfact workflow runs a real HTTP server.

For everyday simulator use, start with counterfact; use focused packages when embedding individual capabilities.