mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
docs: wire @supabase/server v1 into the reference pipeline (#47570)
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs update. * https://docs-git-docs-wire-server-v1-reference-supabase.vercel.app/docs/reference/server/introduction * <img width="417" height="628" alt="Screenshot 2026-07-06 at 6 13 33 PM" src="https://github.com/user-attachments/assets/9fc27b04-038b-4434-8855-94051f898b5d" /> ## What is the current behavior? `@supabase/server` has no reference documentation page in the Supabase docs. The library publishes a TypeDoc spec to GitHub Pages but the docs pipeline was not wired up to consume it. ## What is the new behavior? - Adds `spec/reference/server/v1/` with a `config.json` (category order: Middleware, Primitives, Adapters, Errors, Types) and `partials/` for the introduction and installing pages. - Adds a `download.server.v1` Makefile target that fetches `https://supabase.github.io/server/spec.json` into `spec/reference/server/v1/server.json`, and wires it into the top-level `download` target so it runs with the rest. - Registers `server-v1` in `SUPPORTS_NEW_REFERENCE_PROCESS` so the build pipeline picks up the new spec directory and generates `content/reference/server/v1/` at build time. - Seeds the generated `docs/ref/server/` partials (introduction and installing) that the reference router serves. ## Additional context The TypeDoc spec is produced by `@supabase/server`'s `docs.yml` workflow on every push to `main`, so `make download.server.v1` will always pull the latest published API surface. The companion PR in the server repo ([supabase/server#95](https://github.com/supabase/server/pull/95)) adds the `@category` tags that the pipeline requires for symbols to appear in navigation. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a new **Server SDK** item under **Reference**, linking to `/reference/server` and marked with a **New** badge. * Published **Server Reference v1** documentation for `@supabase/server`, including **Introduction** and **Installing** pages. * **Chores / Improvements** * Enhanced the reference documentation generation to include Server v1 content. * Improved reference detail handling (including clearer TypeDoc output such as **Deprecated** notes). <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
This commit is contained in:
1 parent
a84fd10a4f
commit
f77e8e75b6
17 files changed
+316
-5
No files matched your search
@@ -1,6 +1,8 @@
|
||||
REPO_DIR=$(shell pwd)
|
||||
GENERATOR_DIR=../../../packages/generator
|
||||
|
||||
.PHONY: run download download.api.v1 download.storage.v1 download.tsdoc.v2 download.server.v1 transform dereference.api.v1 dereference.auth.v1 dereference.storage.v0 generate generate.sections.api.v1 format
|
||||
|
||||
run: download transform generate format
|
||||
|
||||
|
||||
@@ -9,7 +11,7 @@ run: download transform generate format
|
||||
###############################################################################
|
||||
# comment out download.auth.v1 temporarily, we're manually creating the file
|
||||
# download: download.api.v1 download.auth.v1 download.storage.v1 download.tsdoc.v2
|
||||
download: download.api.v1 download.storage.v1 download.tsdoc.v2
|
||||
download: download.api.v1 download.storage.v1 download.tsdoc.v2 download.server.v1
|
||||
|
||||
download.api.v1:
|
||||
curl -sS https://api.supabase.com/api/v1-json > $(REPO_DIR)/api_v1_openapi.json
|
||||
@@ -44,6 +46,9 @@ download.tsdoc.v2:
|
||||
curl -sS https://supabase.github.io/supabase-js/storage-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/storage.json
|
||||
curl -sS https://supabase.github.io/supabase-js/functions-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/functions.json
|
||||
|
||||
download.server.v1:
|
||||
curl -sSf https://supabase.github.io/server/spec.json > $(REPO_DIR)/reference/server/v1/server.json
|
||||
|
||||
download.analytics.v0:
|
||||
curl -sS https://logflare.app/api/openapi > $(REPO_DIR)/analytics_v0_openapi.json
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"categoryOrder": ["Middleware", "Primitives", "Adapters", "Errors", "Types"],
|
||||
"partialsOrder": ["introduction", "installing"],
|
||||
"navigationPrefixes": {}
|
||||
}
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
id: installing
|
||||
title: Installing
|
||||
slug: installing
|
||||
---
|
||||
|
||||
### Install as a package
|
||||
|
||||
<RefSubLayout.EducationRow>
|
||||
<RefSubLayout.Details>
|
||||
|
||||
Install `@supabase/server` via your package manager.
|
||||
|
||||
</RefSubLayout.Details>
|
||||
|
||||
<RefSubLayout.Examples>
|
||||
|
||||
<Tabs
|
||||
size="small"
|
||||
type="underlined"
|
||||
defaultActiveId="npm"
|
||||
queryGroup="platform"
|
||||
>
|
||||
<TabPanel id="npm" label="npm">
|
||||
|
||||
```sh Terminal
|
||||
npm install @supabase/server
|
||||
```
|
||||
|
||||
</TabPanel>
|
||||
<TabPanel id="yarn" label="Yarn">
|
||||
|
||||
```sh Terminal
|
||||
yarn add @supabase/server
|
||||
```
|
||||
|
||||
</TabPanel>
|
||||
<TabPanel id="pnpm" label="pnpm">
|
||||
|
||||
```sh Terminal
|
||||
pnpm add @supabase/server
|
||||
```
|
||||
|
||||
</TabPanel>
|
||||
</Tabs>
|
||||
|
||||
</RefSubLayout.Examples>
|
||||
</RefSubLayout.EducationRow>
|
||||
|
||||
### Use via JSR (Deno / Bun)
|
||||
|
||||
<RefSubLayout.EducationRow>
|
||||
<RefSubLayout.Details>
|
||||
|
||||
`@supabase/server` is also published to [JSR](https://jsr.io/@supabase/server) for Deno and Bun environments.
|
||||
|
||||
</RefSubLayout.Details>
|
||||
|
||||
<RefSubLayout.Examples>
|
||||
|
||||
<Tabs
|
||||
size="small"
|
||||
type="underlined"
|
||||
defaultActiveId="deno"
|
||||
queryGroup="platform"
|
||||
>
|
||||
<TabPanel id="deno" label="Deno">
|
||||
|
||||
```sh Terminal
|
||||
deno add jsr:@supabase/server
|
||||
```
|
||||
|
||||
</TabPanel>
|
||||
<TabPanel id="bun" label="Bun">
|
||||
|
||||
```sh Terminal
|
||||
bunx jsr add @supabase/server
|
||||
```
|
||||
|
||||
</TabPanel>
|
||||
</Tabs>
|
||||
|
||||
</RefSubLayout.Examples>
|
||||
</RefSubLayout.EducationRow>
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
id: introduction
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
`@supabase/server` is a framework-agnostic library for authenticating requests in server-side JavaScript environments. It verifies JWTs, resolves Supabase API keys, and creates pre-configured Supabase clients — exposing everything through a single `SupabaseContext` that is identical regardless of which adapter or primitive produced it.
|
||||
|
||||
Adapters for Hono, H3, Elysia, and NestJS are included. You can also compose the lower-level primitives directly for custom frameworks or edge runtimes.
|
||||
Reference in new issue
Block a user