Commit Graph
19 Commits
Author SHA1 Message Date
d8bd6b047c docs: Examples Key changes (#45170)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated examples and guides to use Supabase publishable (client) keys
instead of anon keys for client-side usage across frameworks and
platforms.
* Renamed environment variable examples and .env templates to reflect
publishable key naming.
* Adjusted sample requests and client-init examples to send/use the
publishable key via the apikey header where applicable.
* Updated references from service_role to secret for server-side
credential guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: fadymak <fady@fadymak.com>
2026-05-04 12:58:16 +02:00
Katerina Skroumpelou 41f9ddd70c docs: update setAll callbacks to accept cache headers second argument (#44240)
## What

Updates all `setAll` cookie handler implementations across docs and
examples to accept the new `headers` second argument introduced in
`@supabase/ssr` v0.10.0
([supabase/ssr#176](https://github.com/supabase/ssr/pull/176)).

## Why

`@supabase/ssr` v0.10.0 introduced a breaking change: `setAll` now
receives a required second argument `headers: Record<string, string>`
alongside the cookies array. When a token refresh occurs, the library
passes cache headers (`Cache-Control`, `Expires`, `Pragma`) that must be
applied to the HTTP response to prevent CDN caching of auth responses.

Because TypeScript allows functions with fewer parameters to satisfy a
type expecting more, existing `setAll` implementations do not produce a
type error when the second argument is omitted. Users who copy an
outdated snippet will silently miss the CDN protection.

Root cause and context:
[supabase/supabase-js#1682](https://github.com/supabase/supabase-js/issues/1682)

## Changes

**Proxy/middleware contexts** (where token refreshes happen) now apply
the cache headers to their response:
- Next.js proxy files: `supabaseResponse.headers.set(key, value)`
- SvelteKit hooks: `event.setHeaders(headers)`
- Hono middleware: `c.header(key, value)`
- Pages Router (Express-style): `ctx.res.setHeader(key, value)`
- Remix/React Router loaders and actions: applied to response headers
(outer `headers` variable renamed to `responseHeaders` to avoid naming
conflict with the new param)

**Server Component and API route contexts** (no response object
available) accept `_headers` without applying them.

## Files updated

- `apps/docs/content/guides/auth/server-side/creating-a-client.mdx`
(inline Astro, Remix, React Router, Express snippets)
- `apps/docs/content/_partials/oauth_pkce_flow.mdx`
- `apps/docs/content/guides/auth/oauth-server/getting-started.mdx`
- `apps/docs/content/guides/auth/passwords.mdx`
-
`apps/docs/content/troubleshooting/how-to-migrate-from-supabase-auth-helpers-to-ssr-package-5NRunM.mdx`
- `examples/auth/nextjs/`, `examples/auth/nextjs-full/` (proxy + server)
- `examples/auth/sveltekit/`, `examples/auth/sveltekit-full/`
- `examples/auth/hono/`, `examples/auth/hono-full/`
- `examples/user-management/nextjs-user-management/` (proxy + server)
- `examples/user-management/sveltekit-user-management/`
- `examples/realtime/nextjs-authorization-demo/` (proxy + server)
- `examples/realtime/nextjs-auth-presence/` (pages router)
- `examples/prompts/nextjs-supabase-auth.md`
2026-03-30 16:08:29 +03:00
Ivan Vasilov d07e78a616 chore: Run prettier on examples folder (#43851)
This PR runs `prettier` on the `examples` folder.

Depends on https://github.com/supabase/supabase/pull/43849.
2026-03-18 10:51:10 +01:00
Steven Eubank 82f79e5af6 Fix logic conflicts (#40362)
When applying these rules to my personal project. My cursor bug bot detected logical gaps in these 2 prompts.
2026-01-27 02:42:41 +00:00
Francisco Ruiz ec9589fa5c docs: fix typo in edge-functions.md (#41853) 2026-01-14 06:45:05 +00:00
Chris Chinchillaandkallebysantos ae727a4659 docs: update supabase docs for nextjs 16 proxyts change (#40555)
* Quickstart next 16 update

* Fix paths and env vars

* docs: refactor nextjs server-side auth to use Proxy instead of middleware

* docs: refactor nextjs server-side auth to match proxy

* docs: refactor nextjs example to match Proxy

* docs: refactor nextjs auth AI prompt to match Proxy

* docs: refactor nextjs sentry telemetry integration to match Proxy

* examples: update nextjs realtime example to match middleware

* docs: refactoring guides to use nextjs proxy

* examples: update nextjs-full example to match Next16 template

* example: update nextjs-user-management to match nextjs 16

* docs: refactoring nextjs user-management tutorial to use typescript only

* docs: refactoring nextjs quickstart, removing step 4

since this step is already included on `with-supabase` template, we can
just remove this redundant step

* docs: auth-helpers nextjs pages, Nextjs16 proxy disclaimer

* stamp: lint

* stamp: revert 'NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY'

* stamp: nextjs examples, revert to use cookie options

* fix(docs): typo

* docs: updating nextjs-auth troubleshoot guide to match proxy

* Update apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx

* Revert auth-helpers changes

* Revert auth-helpers content

* Apply suggestions from code review

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Apply suggestions from code review

* Prettier

---------

Co-authored-by: kallebysantos <kalleby_santos@hotmail.com>
2025-12-01 16:53:12 +01:00
Filipe CabaçoandIvan Vasilov 7fb163daa9 realtime: add ai rules (#38220)
---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2025-08-28 13:39:50 +01: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
Tyler e3b03513e9 examples: Updates example rules to match the latest format of Cursor rules and add declarative schema example (#34992)
* remove glob from all examples

* Add declarative schema instructions

* run prettier

* update file extension for declarative-database-schema rule

* update the example prompts in the examples folder
2025-04-16 01:02:10 +09:00
Tyler 266b245ff9 docs: Update example prompt for implementing SSR on Next.js (#33417)
Update example prompt for implementing SSR on Next.js
2025-02-09 09:23:29 +09:00
TylerandCharis Lam b3cbbc7353 docs: Fix AI prompts page title and menu item title. (#33341)
* remove displaying heading for the AI prompts

* remove the prompt note for test

* revert the change for not displaying the heading for the menu

* Add back the title for each prompt

* allow putting frontmatter before heading

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-02-06 09:14:01 +09:00
Tyler 806a8227b9 docs: Update the prompt examples to make it more Cursor friendly (#33315)
* Update the instruction to add to project

* bringing Cursor at the front, because that is the most popular one of all

* Add sample description and globs for all sample prompt within the docs

* remove the cursor rule I created by mistake

* fix typo
2025-02-05 10:16:25 +09:00
Lakshan Perera b0100265e1 chore: add more rules to Edge Functions AI prompt (#33284)
chore: add more rules to edge functions AI prompt
2025-02-03 17:24:03 -05:00
Lakshan Perera 010243ed1b fix: typo in edge functions prompt (#33280) 2025-02-03 20:39:02 +00:00
Aleksi Immonen e58e99aca7 Typo fix in edge-functions.md (#33266)
Update edge-functions.md
2025-02-04 02:46:57 +11:00
Lakshan Perera b6aa2af832 chore: add prompts for Edge Functions (#33264) 2025-02-03 12:15:50 +01:00
Greg Richardson da52ba3245 More AI prompts (#31252)
* feat: more database prompts

* fix: title casing
2024-12-19 12:19:19 -07:00
CharisandFrancesco Sansalvadore 2fb8b9f74c feat(docs): ai prompts section (#30342)
Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
2024-11-26 13:43:04 -05:00
2d4e046afb Adding a prompts folder (#29131)
* adds migration prompt

* Adds a prompt for coding style

* Update examples/prompts/code-format-sql.md

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update examples/prompts/database-create-migration.md

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Tyler <dshukertjr@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-10-17 13:37:54 +02:00