API Reference
Use this catalog to choose the Dawn package, subpath, or executable that owns a contract. Application developers should start with @dawn-ai/sdk; use the focused references for exact exports, defaults, errors, and lifecycle rules.
Package and surface index
Application shortcuts: author routes with the @dawn-ai/sdk reference; use the dawn command or runtime entries, including /fetch for supported edge integrations; test programmatically with @dawn-ai/testing; score behavior with @dawn-ai/evals; and import app-specific tool and state types from dawn:routes.
Read the runtime column precisely: node-only records that a surface does not pass Dawn's edge-safety guard, not that the surface cannot run in a browser. Most node-only entries are genuinely server-side, but @dawn-ai/ag-ui/react is browser-targeted and fails the guard only because React's JSX runtime reads process.env.NODE_ENV.
| Package | Purpose | Audience | Stability | Surfaces | Artifact boundaries | README | Reference | Guide |
|---|---|---|---|---|---|---|---|---|
@dawn-ai/ag-ui | AG-UI protocol translation for Dawn runtimes and web clients. | integration | supported | @dawn-ai/ag-ui@dawn-ai/ag-ui/sse@dawn-ai/ag-ui/react@dawn-ai/ag-ui/react/styles.css | focused reference · edge-safe runtime · not-claimed purityfocused reference · edge-safe runtime · not-claimed purityfocused reference · node-only runtime · not-claimed puritycatalog summary · stylesheet asset; resolved by a bundler, never evaluated as JS · purity n/a | README | Reference | Guide |
@dawn-ai/cli | Dawn development, build, type generation, and runtime commands. | tooling | supported | @dawn-ai/cli@dawn-ai/cli/fetch@dawn-ai/cli/runtime@dawn-ai/cli/testingbin.dawn | focused reference · node-only runtime · not-claimed purityfocused reference · edge-safe runtime · not-claimed purityfocused reference · node-only runtime · not-claimed purityfocused reference · node-only runtime · not-claimed purityfocused reference · node-only executable command · purity n/a | README | Reference | Guide |
@dawn-ai/config-biome | Shared Biome configuration for Dawn projects. | tooling | supported | @dawn-ai/config-biome@dawn-ai/config-biome/biome | internal only · static configuration; no runtime import · purity n/a internal only · static configuration; no runtime import · purity n/a | README | Reference | Guide |
@dawn-ai/config-typescript | Shared TypeScript configurations for Dawn projects. | tooling | supported | @dawn-ai/config-typescript@dawn-ai/config-typescript/base@dawn-ai/config-typescript/library@dawn-ai/config-typescript/node@dawn-ai/config-typescript/nextjs | internal only · static configuration; no runtime import · purity n/a internal only · static configuration; no runtime import · purity n/a internal only · static configuration; no runtime import · purity n/a internal only · static configuration; no runtime import · purity n/a internal only · static configuration; no runtime import · purity n/a | README | Reference | Guide |
@dawn-ai/core | Route discovery, app configuration, capabilities, and type generation. | integration | low-level | @dawn-ai/core@dawn-ai/core/node@dawn-ai/core/internal/compiler | focused reference · edge-safe runtime · not-claimed purityfocused reference · node-only runtime · not-claimed purityinternal only · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/devkit | Internal scaffold templates and generated-app test utilities. | internal | internal | @dawn-ai/devkit | internal only · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/evals | Evaluation definitions, scorers, datasets, and runners. | testing | supported | @dawn-ai/evals | focused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/inspector | Browser application for inspecting a running Dawn app. | tooling | supported | dawnInspector.server | catalog summary · node-only separately operated application · purity n/a | README | Reference | Guide |
@dawn-ai/langchain | LangChain backend adapters for Dawn agents and chains. | integration | supported | @dawn-ai/langchain@dawn-ai/langchain/package.json | focused reference · edge-safe runtime · not-claimed purityfocused reference · package metadata; read as data, not runtime code · purity n/a | README | Reference | Guide |
@dawn-ai/langgraph | LangGraph runtime adapters and route contracts. | integration | supported | @dawn-ai/langgraph@dawn-ai/langgraph/define-entry@dawn-ai/langgraph/route-module | focused reference · edge-safe runtime · dependency-free purityfocused reference · edge-safe runtime · dependency-free purityfocused reference · edge-safe runtime · dependency-free purity | README | Reference | Guide |
@dawn-ai/memory | Long-term memory storage, ranking, browsing, and reconciliation. | application | supported | @dawn-ai/memory@dawn-ai/memory/browse@dawn-ai/memory/namespace@dawn-ai/memory/reconcile | focused reference · node-only runtime · not-claimed purityfocused reference · edge-safe runtime · dependency-free purityfocused reference · edge-safe runtime · not-claimed purityfocused reference · edge-safe runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/memory-pgvector | Postgres and pgvector storage for shared long-term memory. | application | supported | @dawn-ai/memory-pgvector | focused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/permissions | Permission matching and Node-backed approval stores. | integration | supported | @dawn-ai/permissions@dawn-ai/permissions/node | focused reference · edge-safe runtime · not-claimed purityfocused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/postgres-storage | Postgres persistence for checkpoints, threads, and permissions. | application | supported | @dawn-ai/postgres-storage@dawn-ai/postgres-storage/node | focused reference · edge-safe runtime · not-claimed purityfocused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/sandbox | Docker-backed isolated workspace execution for Dawn agents. | application | supported | @dawn-ai/sandbox@dawn-ai/sandbox/testing | focused reference · node-only runtime · not-claimed purityfocused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/sdk | Author-facing declarations for agents, tools, middleware, and routes. | application | supported | @dawn-ai/sdk@dawn-ai/sdk/pure@dawn-ai/sdk/testing | focused reference · edge-safe runtime · not-claimed purityfocused reference · edge-safe runtime · dependency-free purityfocused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/sqlite-storage | Local SQLite persistence for Dawn runtime state. | application | supported | @dawn-ai/sqlite-storage | focused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/testing | Harnesses, fixtures, matchers, and runtime test utilities. | testing | supported | @dawn-ai/testing | focused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/vite-plugin | Internal Vite integration for Dawn type generation. | tooling | internal | @dawn-ai/vite-plugin | internal only · node-only runtime · not-claimed purity | README | Reference | Guide |
@dawn-ai/workspace | Filesystem and shell tools for agent workspaces. | application | supported | @dawn-ai/workspace@dawn-ai/workspace/node | focused reference · edge-safe runtime · dependency-free purityfocused reference · node-only runtime · not-claimed purity | README | Reference | Guide |
create-dawn-ai-app | Scaffolder for new Dawn applications. | tooling | supported | bin.create-dawn-ai-app | catalog summary · node-only executable command · purity n/a | README | Reference | Guide |
Generated surface: dawn:routes — focused reference · generated types; compile-time only, no runtime import · purity n/a.
Reference conventions
Audience says who should import a surface: application code, integration code, tests, tooling, or Dawn internals. Stability distinguishes supported APIs from low-level or internal contracts. Documentation says whether this release provides a focused reference, a catalog summary, or an internal-only boundary. Each artifact boundary also states whether a surface is runtime code, static configuration, metadata, generated types, a command, or a separately operated application; runtime imports state their purity claim.
The headings below preserve links from the former single-page reference. They point to the canonical package page and section; use the canonical destination for new links.
@dawn-ai/sdk
The application authoring surface now lives at @dawn-ai/sdk.
Agent
See the canonical agent() and AgentConfig contract.
agent(config)
See the canonical agent() signature.
AgentConfig
See the canonical AgentConfig fields.
ReasoningConfig
See the canonical agent configuration contract.
RetryConfig
See the canonical agent configuration contract.
DawnAgent
See the canonical agent descriptor contract.
Subagent delegation types
See the canonical SDK public export inventory.
isDawnAgent(value)
See the canonical agent descriptor contract.
Middleware
See the canonical middleware result contract.
defineMiddleware(fn)
See the canonical middleware export inventory.
allow(context?)
See the canonical allow() and reject() contract.
reject(status, body?)
See the canonical allow() and reject() contract.
DawnMiddleware
See the canonical middleware export inventory.
MiddlewareRequest
See the canonical middleware export inventory.
MiddlewareResult
See the canonical middleware result contract.
ContinueResult
See the canonical middleware result contract.
RejectResult
See the canonical middleware result contract.
Memory
See the canonical SDK public export inventory and the long-term memory guide.
defineMemory(def)
See the canonical SDK public export inventory.
DefinedMemory
See the canonical SDK public export inventory.
MemoryScopeDimension
See the canonical SDK public export inventory.
Route configuration
See the canonical RouteConfig contract.
RouteConfig
See the canonical RouteConfig contract.
RouteKind
See the canonical RouteConfig contract.
Route types
See the canonical SDK public export inventory.
RouteStateMap
See the canonical SDK public export inventory.
RouteToolMap
See the canonical SDK public export inventory.
Runtime
See the canonical SDK public export inventory.
RuntimeContext<Tools>
See the canonical RuntimeContext export.
RuntimeTool
See the canonical SDK public export inventory.
ToolRegistry
See the canonical SDK public export inventory.
DawnToolContext
See the canonical SDK public export inventory.
WorkspaceFs
See the canonical SDK public export inventory.
Models
See the canonical model validation contract.
KnownModelId
See the canonical SDK model export inventory.
ModelProviderId
See the canonical SDK model export inventory.
OpenAiModelId
See the canonical SDK model export inventory.
GoogleModelId
See the canonical SDK model export inventory.
AnthropicModelId
See the canonical SDK model export inventory.
XaiModelId
See the canonical SDK model export inventory.
inferProvider(model)
See the canonical model validation contract.
SUPPORTED_AGENT_PROVIDERS
See the canonical SDK model export inventory.
validateModelId(opts)
See the canonical validateModelId() contract.
ModelIdValidation
See the canonical validateModelId() contract.
Model id constants
See the canonical SDK model export inventory.
Backend adapter
See the canonical SDK public export inventory.
BackendAdapter
See the canonical SDK public export inventory.
Utilities
See the canonical SDK public export inventory.
Prettify<T>
See the canonical SDK public export inventory.
@dawn-ai/cli
The command and embedding surfaces now live at @dawn-ai/cli.
serveRuntime(options)
See the canonical serveRuntime() contract.
loadStaticModules(manifestUrl)
See the canonical CLI public export inventory.
DawnStaticModules and StaticRouteModule
See the canonical CLI root export inventory.
@dawn-ai/cli/fetch
See the canonical edge-safe fetch subpath.
@dawn-ai/cli/runtime
See the canonical low-level runtime subpath.
@dawn-ai/core
The integration surface now lives at @dawn-ai/core.
Capability exports
See the canonical Core public export inventory.
createCapabilityRegistry(markers) and applyCapabilities()
See the canonical Core public export inventory.
gateToolOp() and wrapToolWithApproval()
See the canonical Core public export inventory.
createWorkspaceFs(options)
See the canonical Core public export inventory.
loadDawnConfig(options) and config(value)
See the canonical loadDawnConfig() contract.
discoverRoutes(options), findDawnApp(options), and route segments
See the canonical Core public export inventory.
State and typegen helpers
See the canonical resolveStateFields() contract.
Tool scope
See the canonical Core public export inventory.
Storage type re-export
See the canonical Core public export inventory.
@dawn-ai/ag-ui
The AG-UI adapter surface now lives at @dawn-ai/ag-ui.
ID factories
See the canonical AG-UI public export inventory.
toAguiEvents(chunks, context)
See the canonical inbound and outbound contracts.
fromRunAgentInput(input)
See the canonical inbound and outbound contracts.
SSE subpath: encodeAgUiSse(event, accept?)
See the canonical SSE subpath inventory.
@dawn-ai/memory
The long-term memory package surface now lives at @dawn-ai/memory.
MemoryStore
See the canonical store and query shapes.
MemoryRecord
See the canonical store and query shapes.
MemoryQuery
See the canonical store and query shapes.
BrowseQuery, BrowsePage, and MemoryStats
See the canonical browse subpath inventory.
@dawn-ai/memory/browse
See the canonical browse subpath inventory.
@dawn-ai/memory-pgvector
The shared memory backend now lives at @dawn-ai/memory-pgvector.
pgvectorMemoryStore(options)
See the canonical PgvectorMemoryStore contract.
PgvectorMemoryStore
See the canonical PgvectorMemoryStore contract.
vectorColumnDef(dimensions)
See the canonical dimension branches contract.
initSchema(client, options)
See the canonical initialization contract.
assertIdentifier(name, value)
See the canonical schema identifier contract.
@dawn-ai/postgres-storage
The durable runtime storage surface now lives at @dawn-ai/postgres-storage.
PostgresStoreOptions
See the canonical PostgresStoreOptions fields.
@dawn-ai/postgres-storage/node
See the canonical Node subpath inventory.
postgresCheckpointer(options)
See the canonical Postgres root export inventory.
createPostgresThreadsStore(options)
See the canonical Postgres root export inventory.
createPostgresPermissionsStore(options)
See the canonical Postgres root export inventory.
assertIdentifier(name, value)
See the canonical Postgres root export inventory.
DEFAULT_SCHEMA / DEFAULT_TABLE_PREFIX
See the canonical Postgres root export inventory.
@dawn-ai/testing
The programmatic test surface now lives at @dawn-ai/testing. For fixture workflows, see Fixtures and Recording.
Harnesses
See the canonical harness options contract.
Aimock fixtures and recording
See the canonical harness and fixture lifecycle.
Matchers
See the canonical testing public export inventory.
Run-result utilities
See the canonical testing public export inventory.
Memory, protocol, and subprocess helpers
See the canonical harness and fixture lifecycle.
Example
See the canonical testing examples.
@dawn-ai/evals
The evaluation surface now lives at @dawn-ai/evals.
Eval definition and execution
See the canonical EvalDefinition contract.
Scores and gates
See the canonical evaluation semantics.
Built-in scorers
See the canonical eval public export inventory.
Memory scorers
See the canonical eval public export inventory.
Example
See the canonical eval examples.
dawn:routes (generated)
The generated application types now live at dawn:routes.
RouteTools<P>
See the canonical generated tool contract.
RouteState<P>
See the canonical generated state contract.
Where to read more
Start with Agents, Routes, and Tools. Use the focused package references above when you need an exact import, field, default, error, or lifecycle rule.