Commit Graph
65 Commits
Author SHA1 Message Date
Chris Chinchilla 9cbda3ecdc docs: Fix broken redirects and update SDK references to use more appropriate URLs (#41461)
Fix broken redirects and update SDK references to use more appropriate URLs
2025-12-19 11:17:32 +01:00
Katerina Skroumpelou cf17967a3a chore: update readme js sdk links (#41198) 2025-12-16 14:42:22 +02:00
Katerina Skroumpelou a552194fb9 docs: manually surface OAuth docs (#41194) 2025-12-09 14:33:08 +00:00
github-actions[bot] 964e4b9b1f docs: update js client libraries (2.86.0) (#40845) 2025-11-27 18:10:49 +02:00
a0e62693aa docs: update js client libraries (patch) (#40779)
* docs: update js client libraries (patch)

* docs(storage): update sections and navmenu

* docs: fix broken links in runtime

* docs: update examples

* docs: update snapshot

* docs: fix type return

* docs: updated return and snaps

* docs: fix some rendering reference issues

* docs: surface types

* docs: update examples

* docs: update snapshot

* docs: remove script for gaps analysis

---------

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2025-11-26 15:51:02 +02:00
Katerina Skroumpelouandsupabase-releaser[bot] 2e64be1463 docs: vector bucket and vector analytics js docs (#40467)
* docs: update js client libraries (2.83.0)

* docs: vector buckets and analytics js docs

---------

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2025-11-18 17:42:08 +02:00
Eduardo Gurgel 00d8c49135 docs(realtime): use the new httpSend for REST broadcast (#40227)
channel.send has been soft deprecated for REST broadcast usage
2025-11-10 09:20:03 +13:00
Marouane Souda d3ac458aef fix(docs): change 'countries' to 'characters' to match JS example to data source (#39840) 2025-10-27 16:53:36 +00:00
Timothy Lim 1e6941df4d docs: fix Javascript sign out syntax (#39279) 2025-10-06 15:30:08 +08:00
Katerina SkroumpelouandCharis Lam b7f1616e3c chore: update docs from js monorepo (#39200)
* chore: update docs from js monorepo

* chore: remove sparse-checkout for workflow to work

* chore: update workflow with no-frozen-lockfile

* chore(js libs docs update): regenerate typespec snapshot on update

* fix(typespec): fix missing types in transformed typespec

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-10-03 12:02:53 +03:00
Charis 7596274204 fix: correct ref paths for new sdk specs (#39085) 2025-10-02 12:36:04 +03:00
Charis 62fef7b9c8 fix(docs): typo (#38760) 2025-09-16 15:42:37 -04:00
e8c158bc48 docs: web3 and some other js reference improvements (#38670)
* docs: web3 and some other js reference improvements

* add MetaMask to spell rules

* apply suggestion from @cemalkilic

Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com>

* fix tests

* test: update snapshot

---------

Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-15 14:56:34 +02:00
Chris StocktonandChris Stockton 6a777e1fae fix: small typo in identites -> identities (#38292)
Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
2025-09-03 15:28:47 -07:00
Stojan DimitrovskiandChris Chinchilla 93ba2a312c docs: indicate publishable key instead of anon in many examples (#37411)
* docs: indicate publishable key instead of anon in many examples

* replace your-anon-key to string indicating publishable or anon

* fix your_...

* apply suggestion from @ChrisChinchilla

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update keys in code examples

* Prettier fix

* Update apps/docs/content/guides/functions/schedule-functions.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-18 13:47:48 +02:00
Guilherme SouzaandChris Chinchilla b6b906cff4 docs: add flutter phone factor reference doc and example (#37828)
* docs: add flutter phone factor reference doc and example

* Update apps/docs/spec/supabase_dart_v2.yml

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/spec/supabase_js_v2.yml

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/spec/supabase_dart_v2.yml

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/spec/supabase_dart_v2.yml

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-14 15:03:01 -03:00
Srinivas AandCharis a8b254f0ef docs: enhance verifyOtp() and resend() method description with detailed verification types (#37339)
* docs: enhance verifyOtp() method description with detailed verification types and examples

* Update apps/docs/spec/supabase_js_v2.yml

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-08-04 16:10:30 -04:00
Charis 1c2312975b docs: add auth getClaims method (#37122) 2025-07-14 21:13:23 +00:00
Gaurav Deep 6d728885d3 docs: fix RPC example for parameterless calls by adding undefined (#36714)
docs: fix RPC example when using options for parameterless call (#36713)
2025-06-26 16:21:20 +00:00
Andrew Smith c621403b93 fix(docs): update invalid redirect urls link in ref docs (#35646) 2025-05-13 13:52:21 +00:00
Nico Kempe 3fcc5538b7 docs(auth-js): add nonce usage note to reauthenticate() docs (#35206)
docs(auth-js): include reminder to pass OTP as nonce in updateUser()

Add one‑liner on using the received OTP as the `nonce` in updateUser()
2025-05-06 23:27:36 +00:00
bnlvn 4f2c9e5c45 docs:Clarify behavior of email confirmation during email updates (#35150)
Updated the email update note in the docs to explain that confirmation emails are still sent due to the Secure Email Change setting. Added a direct link to the relevant dashboard setting to help users better understand and manage the behavior.
2025-04-21 13:02:41 +00:00
bnlvn 68fde6cf84 docs(auth): clarify mapping of user metadata in updateUser example (#35047)
Adds a note explaining that the `data` field maps to `raw_user_meta_data` in the database,
and is returned as `user_metadata` when calling `getUser()`.
2025-04-17 00:16:35 +00:00
Charis 60f53d4b2a fix(docs): example (#34088)
Example returns incorrect data.
2025-03-10 10:25:34 +01:00
Andrew ValleteauandCharis Lam ac54d858a1 chore(docs): setup docs for overrideTypes (#33705)
* chore(docs): setup docs for overrideTypes

* fix: add overrideTypes to docs section

* chore: regen specs

* chore: update snapshot

* chore: regenerate all specs

* revert realtime spec changes

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-03-03 15:35:39 +01:00
Teng Wei Herr dd3a9b5e09 docs(supabase-js): add example to clarify how to fetch data with spaces in table name (#33443)
* docs: add supabase-js example with spaces in table names

* update copy and example
2025-02-24 17:50:08 +00:00
Jason CrevistonandJason Creviston f49dbe3d69 docs: clarify triggered password recovery events (#33797)
Co-authored-by: Jason Creviston <jason@malynium.com>
2025-02-24 17:37:08 +00:00
Phil Pirozhkov dbf64aab45 Fix the syntax of JS .select (#33392)
It doesn't support passing a list of columns as varargs, only as a comma-separated string.
2025-02-06 16:56:44 +01:00
Charis 93885b090f chore: examples (#33183) 2025-01-30 13:08:46 -05:00
Bobbie Soedirgo 1f9af325c2 docs: add example to order parent table by referenced table (#32920)
* docs: add example to order parent table by referenced table

* docs: more ordering by referenced table examples
2025-01-21 15:59:50 +08:00
Ivan Vasilov b0cf2bf6fa chore: Move parser package to packages folder (#29522)
* Move the spec/parser package into packages folder.

* Fix the spec generation with the new paths.

* Remove the spec folder from prettierignore.

* Run prettier on the spec folder (without regenerating, that's should be done by the product teams).
2024-09-25 23:45:14 +02:00
Samuel SengandAlaister Young a30e0ea4bf docs: Add Query nested foreign tables throught a join table example for supabase-js (#29387)
* docs: Add Query nested foreign tables throught a join table example for supabase-js

* Update apps/docs/spec/examples/examples.yml

* Update apps/docs/spec/supabase_js_v2.yml

---------

Co-authored-by: Alaister Young <alaister@users.noreply.github.com>
2024-09-19 07:50:28 +00:00
Charis fc164b5d07 Refactor/app router refs (#28095)
Migrates client SDK References to App Router. (Management and CLI API references aren't migrated yet, nor are self-hosting config references.)

Some notes:

Big changes to the way crawler pages are built and individual section URLs (e.g., javascript/select) are served. All of these used to be SSG-generated pages, but the number of heavy pages was just too much to handle -- slow as molasses and my laptop sounded like it was taking off, and CI sometimes refuses to build it all at all.

Tried various tricks with caching and pre-generating data but no dice.

So I changed to only building one copy of each SDK+version page, then serving the sub-URLs through a response rewrite. That's for the actual user-visible pages.

For the bot pages, each sub-URL needs to be its own page, but prebuilding it doesn't work, and rendering on demand from React components is too slow (looking for super-fast response here for SEO). Instead I changed to using an API route that serves very minimal, hand-crafted HTML. It looks ugly, but it's purely for the search bots.

You can test what bots see by running curl --user-agent "Mozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" <URL_OF_PAGE>

Also added some smoke tests to run against prod for the crawler routes, since we don't keep an eye on those regularly, and Vercel config changes could surprise-break them. Tested the meta images on Open Graph and all seems to work fine.

With this approach, full production builds are really fast: ~5 minutes

Starts using the new type spec handling, which is better at finding params automatically, so I could remove some of the manually written ones from the spec files.
2024-08-13 16:12:59 -04:00
Joel LeeandStojan Dimitrovski 339050bc32 feat: update JavaScript client library spec for MFA (Phone) (#28376)
* feat: update client lib docs

* fix: update js v2 yml

* fix: update spec

* fix: remove superfluous sections

* fix: update responses and field names

* fix: update challenge response with type field

* fix: update apps/docs/spec/supabase_js_v2.yml

* fix: Update apps/docs/spec/supabase_js_v2.yml spelling

Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com>

---------

Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com>
2024-08-12 19:35:58 +08:00
Charis 76d1d1e870 fix(docs): hydration error on js references (#28345)
Our syntax highlighter doesn't recognize HTML (tried to install it but it's not
on the lsit of supported languages) and this somehow causes the server and
client to make different highlighting decisions, with the server attempting to
highlight the code block and the client not.

Removing the html language specifier removes the hydration error (and since the
client never properly highlighted it anyway, we don't lose much in terms of
syntax highlighting.)
2024-08-05 12:26:35 +02:00
Jason CrevistonandJason Creviston ca5bf3069d docs: correct the javascript setSession method. (#27908)
docs: correct the javasript setSession method.

Co-authored-by: Jason Creviston <jason@malynium.com>
2024-07-12 01:59:36 +00:00
Duncan 2fc37fe1e4 Update supabase_js_v2.yml (#27871)
Fix subscription destructuring
2024-07-09 22:29:53 +00:00
Meet VyasandCharis 1781431e37 docs: correct responses for file upload methods corrected (#27795)
* docs: responses for file upload methods corrected

* fix: json formatting

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-07-04 16:41:16 +00:00
SURJEET KUMAR ebead099da [Fix #26947] Update Twilio Phone Auth Guide Link (#27178)
feat: Update Twilio Phone Auth Guide link for configuring WhatsApp sign in

The Twilio Phone Auth Guide link for configuring WhatsApp sign in has been updated in the magic link section of the Supabase JS v2 documentation. The new link points to the correct guide page.
2024-06-11 14:29:55 +00:00
Stojan Dimitrovski 5772fbf911 docs: add error codes auth (#22793) 2024-06-08 12:31:52 +02:00
f00fandCharis ff7b2909a7 Update supabase_js_v2.yml (#26992)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-06-04 18:15:47 +00:00
Bobbie Soedirgo ea9cfb921a docs(js): add example for deleting a record and returning it (#26855)
* docs(js): add example for deleting a record and returning it

* docs(js): clarify response object

Make it more obvious that `status` and `statusText` comes from the whole
response object, not from `data` or `error`
2024-05-31 16:53:44 +08:00
Bobbie Soedirgo b90ddcef21 docs(js): add example on setting timeout (#26825) 2024-05-31 16:53:34 +08:00
Charis 9c03be41e4 enhance(ref docs): add params and returns for realtime and storage (#26687) 2024-05-23 13:09:17 -04:00
Charis 3c196e3bf5 enhance(refs): add params and return examples for database and auth (#26676)
enhance(refs): add params and return types

Add params and return types for database and auth functions in
supabase-js library.
2024-05-22 19:55:00 -04:00
ynnsuisandCharis 525bb4d303 Add example for deleting multiple records with delete().in() (#25883)
* docs : Add example for deleting multiple records with delete().in()

* Separate delete examples into single and multiple records sections

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-09 17:28:25 +00:00
ec86bbc4fe feat: new auth ia (#22812)
Co-authored-by: Kang Ming <kang.ming1996@gmail.com>
Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>
2024-05-07 20:15:06 +00:00
Bobbie Soedirgo 6d10b3adc4 Chore/docs/rpc get (#22837)
* chore: update spec for JS libs

* docs(js): add example for RPC w/ `get: true`

* docs: call out `get: true` in RR guide
2024-04-18 15:21:51 +07:00
Rodrigo Mansueli f44637d376 feat: add types for available regions in the docs (#22654)
* feat: add types for available regions in the docs

* Update supabase_js_v2.yml

* notes weren't showing, make the example clearer

* Update supabase_js_v2.yml

* split them, so each region is by itself
2024-04-15 16:47:29 -03:00
Daniel Turuș 64832cac34 Fixed typo (#22570) 2024-04-08 13:39:33 +00:00