Katerina Skroumpelou
e1debe9a69
Adds a Frameworks partial to the `@supabase/server` reference, after Installing. It explains how to run `@supabase/middleware` entries inside Hono, H3, Elysia, NestJS, and TanStack Start through a copyable bridge, and how to move off the framework adapters: the auth trap (`withRequiredClaims` versus `withClaims`), the `userClaims` to `jwtClaims` field remap, how each framework scopes an entry array to a group of routes, what CORS and body access cost on NestJS, the step-by-step procedure, and a prompt to hand to a coding agent. The bridge code for all five frameworks lives in supabase/server#168 and is linked, not copied. Resolves [SDK-1599](https://linear.app/supabase/issue/SDK-1599) and [SDK-1862](https://linear.app/supabase/issue/SDK-1862): the retired `withSupabase({ middleware })` form is gone from the text. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added integration guidance and setup examples for Hono, H3/Nuxt, Elysia, NestJS, and TanStack Start, including framework-specific context, response, and route-scoping behavior. * Documented migration options for authentication requirements, changes to context and JWT claims, and differences in response and error handling. * Added a TanStack Start bridge example and migration and verification checklists. * Added the frameworks guide to the API reference navigation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the style guide for how to write a page, and the developers' guide and contributing guide for repo mechanics. If you write with an AI coding agent, use the /write-the-docs skill to draft and /edit-the-docs to revise an existing page.