Docs V2: Supabase integration section + canonical encryptedSupabase reference (CIP-3328)#39
Open
coderdan wants to merge 3 commits into
Open
Docs V2: Supabase integration section + canonical encryptedSupabase reference (CIP-3328)#39coderdan wants to merge 3 commits into
coderdan wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…reference (CIP-3328)
- /reference/stack/supabase: THE canonical encryptedSupabase page —
one signature ({encryptionClient, supabaseClient}, .from(table,
schema)), full query-builder surface, schema-capability → EQL-term
mapping, response/error shapes, deferred-execution model
- /integrations/supabase: flagship tutorial rewritten on EQL v3
(install script → eql_v3 typed columns → wrapper → queries incl.
ORDER BY on _ord; free-text as token containment, no LIKE)
- /integrations/supabase/{database,auth,dashboard-experience}:
migrations-vs-SQL-Editor install, grants, indexes, RLS composition;
Supabase Auth JWT → LockContext; Table Editor expectations + OAuth
integration flow
- placeholder pages for 6 forward-linked IA URLs (identity-aware-
encryption, schema-design, encrypt-existing-data, drizzle,
audit-logging, cts) so no internal link 404s
- IA.md: tick CIP-3328 items; add CIP-3355 SDK-alignment gate
(wrapper wire behaviour is still EQL v2 — blocks final merge)
coderdan
force-pushed
the
cip-3328-supabase
branch
from
9683c86 to
fd918a6
Compare
Reorganize /integrations/supabase from 4 pages into: Overview (front
door from the marketplace listing), Quickstart (the tutorial, OAuth
folded in as optional), Fundamentals (database.mdx + dashboard-
experience.mdx merged), Data layer (ORM/framework router), Auth
(rebuilt on OIDC federation), and Edge Functions (new).
- Auth: replace the deprecated LockContext.identify() flow with
OidcFederationStrategy as config.authStrategy, then
.withLockContext({ identityClaim }) — lock context now correctly
documented as requiring federation.
- Data layer: document the PostgREST vs direct-Postgres fork and
Supabase pooler/connection glue; link out to canonical ORM pages
rather than duplicating them.
- Edge Functions: written on the @cipherstash/stack/wasm-inline
surface; wrapper-on-edge question gated behind a callout.
- Add Prisma + Next.js integration placeholders so Data-layer links
resolve; fix stale /supabase/database link in the stack reference.
- Reorder meta.json; remove merged pages.
Addresses Vercel preview comment: the section folder and the index page were both labelled 'Supabase', so the sidebar read 'Supabase › Supabase'. Title the index page 'Overview' to remove the repeat.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of the docs V2 overhaul (CIP-3307); implements CIP-3328. Stacks on the v2 branch (PR #37).
Pages
/reference/stack/supabase— THE canonicalencryptedSupabasepage. One signature:encryptedSupabase({ encryptionClient, supabaseClient })+.from(tableName, schema)(verified against the SDK's generated TypeDoc, v0.18.0 @ 917b5c0). Full builder surface, schema-capability → EQL-term table, response/error shapes, deferred-execution model. Kills the legacy(url, key)/ single-arg-.from()variant, which never matched the shipped SDK./integrations/supabase— flagship tutorial, rewritten on EQL v3: install script → typedeql_v3columns → SDK schema → wrapper → queries (.eq,.gt,.orderon_ord,.ilikeas token containment). Pays off the marketplace listing's promises; the listing links here./integrations/supabase/database— migration-file vs SQL-Editor install (zero-timestamp trick,db resetsurvival), role grants, functional indexes, RLS composition, pooler note./integrations/supabase/auth— Supabase Auth session JWT →LockContext→.withLockContext(); where identity-locking fits and where it doesn't./integrations/supabase/dashboard-experience— Table Editor expectations (ciphertext payloads, read-only, UI filtering meaningless), SQL-editor schema work, API-settings guidance, CipherStash-dashboard OAuth flow.The wrapper's API surface documented here is shipped (0.18.0). Its wire behaviour is still EQL v2 (composite type, PostgREST
like,v: 2payloads), and the SDK's v3 branches don't touchsrc/supabase/yet. CIP-3355 (twin of CIP-3352) itemizes what must land in the SDK before the v2 branch merges — please add the blocks-CIP-3335 relation in Linear (MCP can't set relations).Notable verification item: the docs claim custom domain types don't show in the Table Editor's type picker (SQL editor recommended) — needs a quick check against a live project.
Notes for review
/reference/eql/*; these pages link, never restate..like()/.ilike()are documented as encrypted token containment (their true semantics in 0.18) with an explicit not-SQL-LIKE callout — consistent with the EQL text page.