Skip to content

docs(reference): the Supabase SDK has two entry points, and the edge one runs in a Worker #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
tobyhede wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(reference): the Supabase SDK has two entry points, and the edge one runs in a Worker #952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 17 additions & 6 deletions docs/reference/supabase-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
are transparently encrypted on mutations, `::jsonb`-cast on selects, encrypted
in filter terms, and decrypted in results.

One entry point, EQL v3 only:
Two entry points, EQL v3 only:

| Entry point | Schema DSL | Column storage |
|---|---|---|
| `encryptedSupabase` | `@cipherstash/stack/eql/v3` (EQL v3) | native `public.eql_v3_*` domains |
| Entry point | Engine | Schema | Runtime |
|---|---|---|---|
| `@cipherstash/stack-supabase` | native | introspected from `public.eql_v3_*` domains | Node |
| `@cipherstash/stack-supabase/wasm-inline` | WASM | declared — `schemas` is required | edge (Deno, Supabase Edge Functions, Cloudflare Workers) |

Both author columns with `@cipherstash/stack/eql/v3` and store them in native
`public.eql_v3_*` domains. They differ only in how the wrapper learns the
schema, and therefore in where it can run.

Rows already written as EQL v2 still decrypt through `@cipherstash/stack`; what
is gone is the ability to author new v2 columns here.
Expand All @@ -30,8 +35,14 @@ free-text by bloom-filter containment).
connect time**: it detects EQL v3 columns by their Postgres domain, derives
each column's encryption config from the domain, and builds the encryption
client internally. Introspection needs a direct Postgres connection
(`options.databaseUrl`, defaulting to `DATABASE_URL`), so the factory cannot
run in a Worker or the browser.
(`options.databaseUrl`, defaulting to `DATABASE_URL`), so this entry cannot run
in a Worker.

Introspection is the only thing that needs Postgres. To run in a Worker, import
`@cipherstash/stack-supabase/wasm-inline` and declare your tables in `schemas`
instead — that entry carries no Postgres driver and never introspects. It is
still server-side: it is not browser-safe, because the WASM client requires a
workspace `clientKey` on every auth path (cipherstash/stack#804).

```typescript
import { encryptedSupabase } from '@cipherstash/stack-supabase'
Expand Down
Loading