Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ dist
pnpm-lock.yaml
# generated by release-please; prettier restyles its bullets, causing churn
CHANGELOG.md
jsr.json
jsr.json
docs/reference-beta/definitions
288 changes: 288 additions & 0 deletions docs/reference-beta/definition.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,288 @@
{
"title": "Reference definition frontmatter",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"description": "Stable, shared across languages. Must match the file name.",
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"kind": {
"type": "string",
"enum": ["method", "command", "endpoint", "class", "type", "constant"]
},
"category": {
"description": "Groups definitions on the library index page.",
"default": "general",
"type": "string"
},
"title": {
"type": "string"
},
"symbol": {
"description": "Fully qualified name, e.g. `supabase.auth.signUp`.",
"type": "string"
},
"summary": {
"description": "One line, used in lists.",
"type": "string"
},
"description": {
"description": "Markdown.",
"type": "string"
},
"signature": {
"description": "Methods, classes, types and constants.",
"type": "string"
},
"usage": {
"description": "Commands only.",
"type": "string"
},
"http": {
"description": "Endpoints only.",
"type": "object",
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": ["method", "path"],
"additionalProperties": false
},
"type_params": {
"type": "array",
"items": {
"type": "string"
}
},
"stability": {
"default": "stable",
"type": "string",
"enum": ["stable", "beta", "experimental"]
},
"deprecated": {
"default": false,
"type": "boolean"
},
"since": {
"type": "string"
},
"requires": {
"type": "array",
"items": {
"type": "string"
}
},
"inherits_flags": {
"description": "Commands that also accept a shared flag group.",
"type": "string"
},
"auth": {
"description": "Endpoints only.",
"type": "object",
"properties": {
"scopes": {
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"parameters": {
"description": "Arguments of methods, commands and endpoints; constructor arguments of classes.",
"default": [],
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"properties": {
"description": "Members of classes and types. Same shape as parameters, `location: property`.",
"default": [],
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"returns": {
"description": "Methods.",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": ["type"],
"additionalProperties": false
},
"responses": {
"description": "Endpoints only.",
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"description": {
"type": "string"
},
"schema": {}
},
"required": ["status"],
"additionalProperties": false
}
},
"throws": {
"default": [],
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "Error type. Omitted when only a description is given.",
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
},
"examples": {
"default": [],
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Stable within the definition.",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"description": "Markdown.",
"type": "string"
},
"lang": {
"description": "Code fence language, e.g. `js`, `sh`.",
"default": "plaintext",
"type": "string"
},
"code": {
"type": "string"
},
"response": {
"description": "Sample output.",
"type": "string"
}
},
"required": ["id", "title", "code"],
"additionalProperties": false
}
}
},
"required": ["id", "kind", "title", "summary"],
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"location": {
"description": "Where the parameter is passed.",
"type": "string",
"enum": [
"argument",
"positional",
"flag",
"path",
"query",
"header",
"body",
"property"
]
},
"type": {
"type": "string"
},
"required": {
"default": false,
"type": "boolean"
},
"description": {
"description": "Markdown.",
"type": "string"
},
"default": {},
"allowed_values": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"short": {
"description": "Short flag, e.g. `-i`. Commands only.",
"type": "string"
},
"env": {
"description": "Environment variable that sets this parameter.",
"type": "string"
},
"variadic": {
"type": "boolean"
},
"deprecated": {
"type": "boolean"
},
"replaced_by": {
"type": "string"
},
"children": {
"description": "Nested fields, same shape.",
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": ["name"],
"additionalProperties": false
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
id: adapters-elysia-supabase-error
kind: class
category: Adapters
title: SupabaseError
symbol: "@supabase/server/adapters/elysia.SupabaseError"
summary: Wraps an `AuthError` as an Elysia-compatible error.
description: |-
Wraps an `AuthError` as an Elysia-compatible error.

Discriminate in `onError` via `code === 'SupabaseError'`. The original
`AuthError` is available as the typed `.cause`.
signature: class SupabaseError extends Error
stability: stable
deprecated: true
parameters:
- name: inner
location: argument
type: AuthError
required: true
description: ""
properties:
- name: status
location: property
type: number
required: true
description: ""
- name: cause
location: property
type: AuthError
required: true
description: ""
examples: []
---

> **Deprecated:** Removed with the Elysia adapter on December 1, 2026. The Elysia
bridge from the framework integration guide answers auth failures with
a `Response` instead: https://supabase.com/docs/reference/server/frameworks
Loading
Loading