Reference

Technical descriptions of every package, class, and method in the Roost framework.

Reference documentation describes what things are and what they do — API signatures, configuration options, type definitions. It is designed for looking things up, not reading start to finish.

Core

Foundational packages required by every Roost application.

@roostjs/core — Dependency injection, configuration, middleware pipeline, application lifecycle, and service providers.
@roostjs/cloudflare — Typed wrappers for D1, KV, R2, Queues, AI, Vectorize, Durable Objects, and Hyperdrive bindings.
@roostjs/start — TanStack Start bridge: middleware factory and server function wrappers.
@roostjs/schema — Fluent JSON Schema builder used by AI tools and MCP tool definitions.

Features

Optional packages that add application capabilities.

@roostjs/auth — WorkOS authentication, session management, middleware guards, CSRF protection, and multi-tenancy.
@roostjs/orm — Model classes, query builder, relationships, lifecycle hooks, migrations, factories, and seeders for D1.
@roostjs/ai — Class-based agents, typed tools, conversation memory, and streaming on Cloudflare Workers AI.
@roostjs/mcp — Model Context Protocol server with tools, resources, and prompts.
@roostjs/billing — Abstract billing interface with a Stripe adapter for subscriptions, checkout, and webhooks.
@roostjs/queue — Background job processing on Cloudflare Queues with retry strategies and lifecycle hooks.

Tooling

Development and testing utilities.

@roostjs/cli — Project scaffolding, code generators, database commands, and deployment.
@roostjs/testing — HTTP test client, response assertions, unified fakes, and test setup helpers.