dawn:routes

Use this when

Import from dawn:routes when application code needs route paths, dynamic parameters, tools, or state keyed by a route path. These are generated types, not runtime values. Run dawn typegen, dawn dev, or dawn build before type-checking code that imports them.

Install and import

The module is generated with your Dawn app; it is not a package to install.

import type { DawnRouteParams, DawnRoutePath, DawnRouteTools, RouteTools } from "dawn:routes"

Do not hand-edit .dawn/dawn.generated.d.ts. Change routes, tools, or state.ts, then regenerate it.

Compatibility and audience

The module has no runtime or purity classification because every export is erased by TypeScript.

Public exports

dawn:routes

DawnRoutePath, DawnRouteParams, DawnRouteTools, and RouteTools are always generated. DawnRouteState and RouteState are generated only when at least one discovered route declares state.ts and contributes a route-state entry.

Key contracts

Route paths and parameters

With no routes, DawnRoutePath is never and the parameter map is empty. A dynamic segment becomes string, a catch-all becomes string[], and an optional catch-all becomes an optional string[] property. DawnRouteParams tells callers which dynamic-segment fields to include in invocation input; Dawn derives the names, not the values, from the route path. For ordinary [param] agent routes, Dawn separates those fields from message input and exposes them to middleware and tool context instead of merging them into DawnRouteState.

Tools

DawnRouteTools includes routes with discovered or capability-contributed tools and omits routes with none. Members are readonly and return Promise<output>. A no-input tool renders as () => Promise<output>, not (input: void) => Promise<output>.

Behavior contract generated-routes.tool-signatures

DawnRouteTools omits routes with no tools and renders void-input tools as zero-argument functions returning promises.

State

State types come only from fields discovered in a route's state.ts. When state exports are present, RouteState<P> indexes DawnRouteState[P] for a route in that map; it does not merge dynamic route parameters into state.

Behavior contract generated-routes.state-conditional

DawnRouteState and RouteState are generated when route state is present and omitted when state types are not supplied.

Examples and related guides

import type { DawnRouteParams, RouteTools } from "dawn:routes"
 
type TenantParams = DawnRouteParams["/support/[tenant]"]
type SupportTools = RouteTools<"/support/[tenant]">

Continue with State, Tools, Routes, and CLI Reference.