docs(reference): the Supabase SDK has two entry points, and the edge one runs in a Worker - #952
Draft
tobyhede wants to merge 1 commit into
Draft
docs(reference): the Supabase SDK has two entry points, and the edge one runs in a Worker#952tobyhede wants to merge 1 commit into
tobyhede wants to merge 1 commit into
Conversation
…one runs in a Worker `docs/reference/supabase-sdk.md` still described the state before #912: one entry point, and a factory that "cannot run in a Worker or the browser". #912 added `@cipherstash/stack-supabase/wasm-inline`, which carries no Postgres driver and takes declared `schemas` instead of introspecting. Introspection was the only thing that needed a Postgres socket, so that entry does run in a Worker. The reference never said so. Corrects both halves: - the "One entry point" table now lists both, with the engine, how each learns the schema, and where each runs; - the factory paragraph now scopes its restriction to the native entry and points at the edge entry as the way to run in a Worker. The browser half of the old sentence was correct and is kept, with the reason named: the WASM client requires a workspace `clientKey` on every auth path (#804). Internal reference documentation — no package ships `docs/`, so no changeset. The same stale sentence is still live in `skills/stash-supabase/SKILL.md` and `packages/stack-supabase/README.md`, both of which DO ship; those are tracked separately. Claude-Session: https://claude.ai/code/session_01E1J2nVGJWVkqvLepDfinRf
|
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.
Summary
docs/reference/supabase-sdk.mdis our internal reference sheet for the Supabase integration — the page an agent or engineer reads to find out what the wrapper can do. It described the world before #912: one entry point, and a factory that "cannot run in a Worker or the browser".#912 added a second entry point,
@cipherstash/stack-supabase/wasm-inline. It carries no Postgres driver and takes the tables you declare instead of reading them out of the database. Reading them out of the database — introspection — was the only thing that needed a raw Postgres socket, so that entry does run in a Worker. The reference never said so.Changes
clientKeyon every authentication path, so a browser build would ship the key with it.Verification
docs/ships in no package — nofilesarray includes it and no build copies it — so there is no changeset and nothing to rebuild. Checked withgit grepthat the stale sentence appears nowhere else indocs/reference/.The two-entry claim is checked against
packages/stack-supabase/package.json, whoseexportsmap declares.and./wasm-inline, and againstpackages/stack-supabase/src/wasm-inline.ts:49-68, whose docblock states the same position this reference now takes.Related
Refs #912, #804.
The same stale sentence is live in two documents that do ship to customers —
skills/stash-supabase/SKILL.mdandpackages/stack-supabase/README.md. Those are #950, fixed by #951. This PR deliberately does not touch them: they need changesets and a rebuild, and this one needs neither.