diff --git a/.cursor/rules/studio-ui.mdc b/.cursor/rules/studio-ui.mdc new file mode 100644 index 00000000000..67db62a0ba1 --- /dev/null +++ b/.cursor/rules/studio-ui.mdc @@ -0,0 +1,253 @@ +--- +description: How to generate pages and interfaces in Studio, a web interface for managing Supabase projects +globs: +alwaysApply: true +--- + +## Project Structure + +- Next.js app using pages router +- Pages go in @apps/studio/pages + - Project related pages go in @apps/studio/pages/projects/[ref] + - Organization related pages go in @apps/studio/pages/org/[slug] +- Studio specific components go in @apps/studio/components + - Studio specific generic UI components go in @apps/studio/components/ui + - Studio specific components related to individual pages go in @apps/studio/components/interfaces e.g. @apps/studio/components/interfaces/Auth +- Generic helper functions go in @apps/studio/lib +- Generic hooks go in @apps/studio/hooks + +## Component system + +Our primitive component system is in @packages/ui and is based off shadcn/ui components. These components can be shared across all @apps e.g. studio and docs. Do not introduce new ui components unless asked to. + +- UI components are imported from this package across apps e.g. import { Button, Badge } from 'ui' +- Some components have a _Shadcn_ namespace appended to component name e.g. import { Input*Shadcn* } from 'ui' +- We should be using _Shadcn_ components where possible +- Before composing interfaces, read @packages/ui/index.tsx file for a full list of available components + +## Styling + +We use Tailwind for styling. + +- You should never use tailwind classes for colours and instead use classes we've defined ourselves + - Backgrounds // most of the time you will not need to define a background + - 'bg' used for main app surface background + - 'bg-muted' for elevating content // you can use Card instead + - 'bg-warning' for highlighting information that needs to be acted on + - 'bg-destructive' for highlighting issues + - Text + - 'text-foreground' for primary text like headings + - 'text-foreground-light' for body text + - 'text-foreground-lighter' for subtle text + - 'text-warning' for calling out information that needs action + - 'text-destructive' for calling out when something went wrong +- When needing to apply typography styles, read @apps/studio/styles/typography.scss and use one of the available classes instead of hard coding classes e.g. use "heading-default" instead of "text-sm font-medium" + +## Page structure + +When creating a new page follow these steps: + +- Create the page in @apps/studio/pages +- Use the PageLayout component that has the following props + + ```jsx + export interface NavigationItem { + id?: string + label: string + href?: string + icon?: ReactNode + onClick?: () => void + badge?: string + active?: boolean + } + + interface PageLayoutProps { + children?: ReactNode + title?: string | ReactNode + subtitle?: string | ReactNode + icon?: ReactNode + breadcrumbs?: Array<{ + label?: string + href?: string + element?: ReactNode + }> + primaryActions?: ReactNode + secondaryActions?: ReactNode + navigationItems?: NavigationItem[] + className?: string + size?: 'default' | 'full' | 'large' | 'small' + isCompact?: boolean + } + ``` + +- If a page has page related actions, add them to primary and secondary action props e.g. Users page has "Create new user" action +- If a page is within an existing section (e.g. Auth), you should use the related layout component e.g. AuthLayout +- Create a new component in @apps/studio/components/interfaces for the contents of the page +- Use ScaffoldContainer if the page should be center aligned in a container +- Use ScaffoldSection, ScaffoldSectionTitle, ScaffoldSectionDescription if the page has multiple sections + +### Page example + +```jsx +import { MyPageComponent } from 'components/interfaces/MyPage/MyPageComponent' +import AuthLayout from './AuthLayout' +import DefaultLayout from 'components/layouts/DefaultLayout' +import { ScaffoldContainer } from 'components/layouts/Scaffold' +import type { NextPageWithLayout } from 'types' + +const MyPage: NextPageWithLayout = () => { + return ( + + + + ) +} + +MyPage.getLayout = (page) => ( + + {page} + +) + +export default MyPage + +export const MyPageComponent = () => ( + +
+ My page section + A brief description of the purpose of the page +
+ // Content goes here +
+) +``` + +## Forms + +- Build forms with `react-hook-form` + `zod`. +- Use our `_Shadcn_` form primitives from `ui` and prefer `FormItemLayout` with layout="flex-row-reverse" for most controls (see `apps/studio/components/interfaces/Settings/Integrations/GithubIntegration/GitHubIntegrationConnectionForm.tsx`). +- Keep imports from `ui` with `_Shadcn_` suffixes. +- Forms should generally be wrapped in a Card unless specified + +### Example (single field) + +```tsx +import { zodResolver } from '@hookform/resolvers/zod' +import { useForm } from 'react-hook-form' +import * as z from 'zod' + +import { Button, Form_Shadcn_, FormField_Shadcn_, FormControl_Shadcn_, Input_Shadcn_ } from 'ui' +import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout' + +const profileSchema = z.object({ + username: z.string().min(2, 'Username must be at least 2 characters'), +}) + +export function ProfileForm() { + const form = useForm>({ + resolver: zodResolver(profileSchema), + defaultValues: { username: '' }, + mode: 'onSubmit', + reValidateMode: 'onBlur', + }) + + function onSubmit(values: z.infer) { + // handle values + } + + return ( + +
+ + + ( + + + + + + )} + /> + + + + + +
+
+ ) +} +``` + +## Cards + +- Use cards when needing to group related pieces of information +- Cards can have sections with CardContent +- Use CardFooter for actions +- Only use CardHeader and CardTitle if the card content has not been described by the surrounding content e.g. Page title or ScaffoldSectionTitle +- Use CardHeader and CardTitle when you are using multiple Cards to group related pieces of content e.g. Primary branch, Persistent branches, Preview branches + +## Sheets + +- Use a sheet when needing to reveal more complicated forms or information relating to an object and context switching away to a new page would be disruptive e.g. we list auth providers, clicking an auth provider opens a sheet with information about that provider and a form to enable, user can close sheet to go back to providers list + +## Tables + +- Use the generic ui table components for most tables +- Tables are generally contained witin a card +- If a table has associated actions, they should go above on right hand side +- If a table has associated search or filters, they should go above on left hand side +- If a table is the main content of a page, and it does not have search or filters, you can add table actions to primary and secondary actions of PageLayout +- If a table is the main content of a page section, and it does not have search or filters, you can add table actions to the right of ScaffoldSectionTitle +- For simple lists of objects you can use ResourceList with ResourceListItem instead + +### Table example + +```jsx +import { Table, TableBody, TableCaption, TableCell, TableHead, TableHeader, TableRow } from 'ui' + +; + A list of your recent invoices. + + + Invoice + Status + Method + Amount + + + + + INV001 + Paid + Credit Card + $250.00 + + +
+``` + +## Alerts + +- Use Admonition component to alert users of important actions or restrictions in place +- Place the Admonition either at the top of the contents of the page (below page title) or at the top of the related ScaffoldSection , below ScaffoldTitle +- Use sparingly + +### Alert example + +```jsx + +``` diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 414afee868f..1d8b37fb1e6 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -15,6 +15,5 @@ /apps/studio/csp.js @supabase/security /apps/studio/components/interfaces/Billing/Payment @supabase/security -/apps/studio/components/interfaces/Organization/BillingSettings/ @supabase/security /apps/studio/components/interfaces/Organization/Documents/ @supabase/security /apps/studio/pages/new/index.tsx @supabase/security diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 00000000000..be2f10f17c8 --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,5 @@ +# Add 'documentation' to any change in apps/docs +# https://github.com/marketplace/actions/labeler +documentation: +- changed-files: + - any-glob-to-any-file: 'apps/docs/**/*' diff --git a/.github/workflows/ai-tests.yml b/.github/workflows/ai-tests.yml index 6684dc0949c..7f579157731 100644 --- a/.github/workflows/ai-tests.yml +++ b/.github/workflows/ai-tests.yml @@ -22,7 +22,7 @@ permissions: jobs: test: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 env: OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} diff --git a/.github/workflows/autofix_linters.yml b/.github/workflows/autofix_linters.yml index 9b2f1d5c6b5..e24443c07bb 100644 --- a/.github/workflows/autofix_linters.yml +++ b/.github/workflows/autofix_linters.yml @@ -15,7 +15,7 @@ permissions: jobs: autofix: - runs-on: ubuntu-latest + runs-on: blacksmith-2vcpu-ubuntu-2404 permissions: contents: write if: ${{ github.event_name == 'pull_request' && (github.event.label.name == 'autofix') }} diff --git a/.github/workflows/avoid-typos.yml b/.github/workflows/avoid-typos.yml index 3a03edd58f5..9897266012e 100644 --- a/.github/workflows/avoid-typos.yml +++ b/.github/workflows/avoid-typos.yml @@ -14,7 +14,7 @@ permissions: jobs: misspell: name: runner / misspell - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Check out code. uses: actions/checkout@v4 diff --git a/.github/workflows/docs-last-changed.yml b/.github/workflows/docs-last-changed.yml index 5025e4b0d10..a7ebfdb0653 100644 --- a/.github/workflows/docs-last-changed.yml +++ b/.github/workflows/docs-last-changed.yml @@ -15,7 +15,7 @@ permissions: jobs: deploy: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 env: NEXT_PUBLIC_SUPABASE_URL: ${{ secrets.SEARCH_SUPABASE_URL }} diff --git a/.github/workflows/docs-lint-v2-comment.yml b/.github/workflows/docs-lint-v2-comment.yml index cd882ce80bc..f69e2fc4f49 100644 --- a/.github/workflows/docs-lint-v2-comment.yml +++ b/.github/workflows/docs-lint-v2-comment.yml @@ -20,7 +20,7 @@ permissions: jobs: comment_on_pr: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'failure' steps: - id: download_artifact diff --git a/.github/workflows/docs-lint-v2-scheduled.yml b/.github/workflows/docs-lint-v2-scheduled.yml index 1eeeb3315dc..af9e6955943 100644 --- a/.github/workflows/docs-lint-v2-scheduled.yml +++ b/.github/workflows/docs-lint-v2-scheduled.yml @@ -13,7 +13,7 @@ permissions: jobs: lint-all: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v3 with: @@ -31,10 +31,10 @@ jobs: ~/.cargo/registry/index/ ~/.cargo/registry/cache/ ~/.cargo/git/db/ - key: 3186b58a532c98d7f470f2b887c2b74a086d5f2e + key: 301e0d4b35f8f0c8553b4e93917b8b2685ef2627 - name: install linter if: steps.cache-cargo.outputs.cache-hit != 'true' - run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 3186b58a532c98d7f470f2b887c2b74a086d5f2e + run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 301e0d4b35f8f0c8553b4e93917b8b2685ef2627 - name: run linter env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/docs-lint-v2.yml b/.github/workflows/docs-lint-v2.yml index ac6f230e817..89f42c2862c 100644 --- a/.github/workflows/docs-lint-v2.yml +++ b/.github/workflows/docs-lint-v2.yml @@ -26,7 +26,7 @@ permissions: jobs: supa-mdx-lint: name: supa-mdx-lint - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 with: @@ -53,10 +53,10 @@ jobs: ~/.cargo/registry/index/ ~/.cargo/registry/cache/ ~/.cargo/git/db/ - key: 3186b58a532c98d7f470f2b887c2b74a086d5f2e + key: 301e0d4b35f8f0c8553b4e93917b8b2685ef2627 - name: install linter if: steps.filter.outputs.docs == 'true' && steps.cache-cargo.outputs.cache-hit != 'true' - run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 3186b58a532c98d7f470f2b887c2b74a086d5f2e + run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 301e0d4b35f8f0c8553b4e93917b8b2685ef2627 - name: install reviewdog if: steps.filter.outputs.docs == 'true' uses: reviewdog/action-setup@3f401fe1d58fe77e10d665ab713057375e39b887 # v1.3.0 diff --git a/.github/workflows/docs-mgmt-api-update.yml b/.github/workflows/docs-mgmt-api-update.yml index 0b8d542d59a..e9261c90096 100644 --- a/.github/workflows/docs-mgmt-api-update.yml +++ b/.github/workflows/docs-mgmt-api-update.yml @@ -12,7 +12,7 @@ permissions: jobs: update-docs: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/docs-sync-troubleshooting.yml b/.github/workflows/docs-sync-troubleshooting.yml index 52c0d793e7c..703df013e7d 100644 --- a/.github/workflows/docs-sync-troubleshooting.yml +++ b/.github/workflows/docs-sync-troubleshooting.yml @@ -14,7 +14,7 @@ permissions: jobs: update-troubleshooting: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 env: DOCS_GITHUB_APP_ID: ${{ secrets.SEARCH_GITHUB_APP_ID }} diff --git a/.github/workflows/docs-sync.yml b/.github/workflows/docs-sync.yml index aa0ba2f714e..d6aaaf8ef80 100644 --- a/.github/workflows/docs-sync.yml +++ b/.github/workflows/docs-sync.yml @@ -19,7 +19,7 @@ permissions: jobs: sync: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 env: NEXT_PUBLIC_SUPABASE_URL: ${{ secrets.SEARCH_SUPABASE_URL }} diff --git a/.github/workflows/docs-tests-smoke.yml b/.github/workflows/docs-tests-smoke.yml index 8dac770f6df..335dffb4316 100644 --- a/.github/workflows/docs-tests-smoke.yml +++ b/.github/workflows/docs-tests-smoke.yml @@ -16,7 +16,7 @@ permissions: jobs: build: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/docs-tests.yml b/.github/workflows/docs-tests.yml index fa43b18ae44..233418e270f 100644 --- a/.github/workflows/docs-tests.yml +++ b/.github/workflows/docs-tests.yml @@ -5,6 +5,7 @@ on: branches: ['master'] paths: - 'apps/docs/**/*.ts*' + - 'apps/docs/spec/**/*.json' # Cancel old builds on new commit for same workflow + branch/PR concurrency: @@ -19,7 +20,7 @@ env: jobs: build: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/label_prs.yml b/.github/workflows/label_prs.yml new file mode 100644 index 00000000000..36f4ec2dc90 --- /dev/null +++ b/.github/workflows/label_prs.yml @@ -0,0 +1,16 @@ +name: 'Pull Request Labeler' + +# only docs uses the labeler at the moment +on: + pull_request_target: + paths: + - 'apps/docs/**/*' + +jobs: + labeler: + permissions: + contents: read + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: actions/labeler@v6 diff --git a/.github/workflows/pg-meta-tests.yml b/.github/workflows/pg-meta-tests.yml index 7dda782e0f9..bd051bf6508 100644 --- a/.github/workflows/pg-meta-tests.yml +++ b/.github/workflows/pg-meta-tests.yml @@ -21,7 +21,7 @@ permissions: jobs: build: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml index 913d1d07cdb..9b06f5d533c 100644 --- a/.github/workflows/prettier.yml +++ b/.github/workflows/prettier.yml @@ -15,7 +15,7 @@ permissions: jobs: format: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Check out repo uses: actions/checkout@v4 @@ -39,7 +39,7 @@ jobs: # i18n is not a node package, so we handle that one separately format-i18n: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Check out repo uses: actions/checkout@v4 @@ -63,7 +63,7 @@ jobs: pnpm exec prettier -c 'i18n/**/*.{js,jsx,ts,tsx,css,md,mdx,json}' format-sql: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Check out repo uses: actions/checkout@v4 diff --git a/.github/workflows/publish_image.yml b/.github/workflows/publish_image.yml index 8d7a0291ad1..8664bcf08ac 100644 --- a/.github/workflows/publish_image.yml +++ b/.github/workflows/publish_image.yml @@ -8,7 +8,7 @@ on: jobs: settings: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 outputs: image_version: ${{ steps.meta.outputs.version }} steps: @@ -25,7 +25,7 @@ jobs: release_x86: needs: settings - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 timeout-minutes: 120 env: arch: amd64 @@ -107,7 +107,7 @@ jobs: - settings - release_x86 - release_arm - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: docker/setup-buildx-action@v2 diff --git a/.github/workflows/search.yml b/.github/workflows/search.yml index c12c3ddd3e2..ade8c38a93b 100644 --- a/.github/workflows/search.yml +++ b/.github/workflows/search.yml @@ -26,7 +26,7 @@ permissions: jobs: deploy: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 env: DOCS_GITHUB_APP_ID: ${{ secrets.SEARCH_GITHUB_APP_ID }} diff --git a/.github/workflows/self-host-tests-smoke.yml b/.github/workflows/self-host-tests-smoke.yml index f5f6066ec35..78094b7ad3b 100644 --- a/.github/workflows/self-host-tests-smoke.yml +++ b/.github/workflows/self-host-tests-smoke.yml @@ -16,7 +16,7 @@ permissions: jobs: build: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/studio-unit-tests.yml b/.github/workflows/studio-unit-tests.yml index f82f29127b5..ab6d4d0c315 100644 --- a/.github/workflows/studio-unit-tests.yml +++ b/.github/workflows/studio-unit-tests.yml @@ -26,8 +26,7 @@ permissions: jobs: test: # Uses larger hosted runner as it significantly decreases build times - runs-on: - group: Default Larger Runners + runs-on: blacksmith-4vcpu-ubuntu-2404 strategy: matrix: test_number: [1] @@ -69,7 +68,7 @@ jobs: finish: needs: test if: ${{ always() }} - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Coveralls Finished uses: coverallsapp/github-action@master diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml index 1ea8e461302..826b08a649c 100644 --- a/.github/workflows/typecheck.yml +++ b/.github/workflows/typecheck.yml @@ -16,8 +16,7 @@ permissions: jobs: typecheck: # Uses larger hosted runner as it significantly decreases build times - runs-on: - group: Default Larger Runners + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Checkout diff --git a/.github/workflows/ui-patterns-tests.yml b/.github/workflows/ui-patterns-tests.yml index 766466ee0a8..e666b815d67 100644 --- a/.github/workflows/ui-patterns-tests.yml +++ b/.github/workflows/ui-patterns-tests.yml @@ -16,7 +16,7 @@ permissions: jobs: build: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml index 6284f0cae2b..4a23fd33359 100644 --- a/.github/workflows/ui-tests.yml +++ b/.github/workflows/ui-tests.yml @@ -16,7 +16,7 @@ permissions: jobs: test: - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 strategy: matrix: test_number: [1] @@ -57,7 +57,7 @@ jobs: finish: needs: test if: ${{ always() }} - runs-on: ubuntu-latest + runs-on: blacksmith-4vcpu-ubuntu-2404 steps: - name: Coveralls Finished uses: coverallsapp/github-action@master diff --git a/apps/cms/next.config.mjs b/apps/cms/next.config.mjs index 3317297c825..092c737bfb8 100644 --- a/apps/cms/next.config.mjs +++ b/apps/cms/next.config.mjs @@ -47,10 +47,6 @@ const nextConfig = { // We are already running linting via GH action, this will skip linting during production build on Vercel ignoreDuringBuilds: true, }, - experimental: { - // Ensure compatibility with Turbopack and Sharp - serverComponentsExternalPackages: ['sharp'], - }, // Configure Sharp as an external package for server-side rendering serverExternalPackages: ['sharp'], } diff --git a/apps/cms/package.json b/apps/cms/package.json index 13e5841a04e..b4d5728204f 100644 --- a/apps/cms/package.json +++ b/apps/cms/package.json @@ -15,7 +15,7 @@ "lint": "cross-env NODE_OPTIONS=--no-deprecation next lint", "migrate": "cross-env NODE_OPTIONS=--no-deprecation tsx scripts/migrate.ts", "payload": "cross-env NODE_OPTIONS=--no-deprecation payload", - "start": "cross-env NODE_OPTIONS=--no-deprecation next start --port 3030", + "start": "cross-env NODE_OPTIONS=--no-deprecation next start", "vercel-build": "pnpm migrate && pnpm build", "typecheck_IGNORED": "tsc --noEmit" }, diff --git a/apps/cms/src/app/(payload)/api/graphql-playground/route.ts b/apps/cms/src/app/(payload)/api/graphql-playground/route.ts deleted file mode 100644 index 17d2954ca2d..00000000000 --- a/apps/cms/src/app/(payload)/api/graphql-playground/route.ts +++ /dev/null @@ -1,7 +0,0 @@ -/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */ -/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */ -import config from '@payload-config' -import '@payloadcms/next/css' -import { GRAPHQL_PLAYGROUND_GET } from '@payloadcms/next/routes' - -export const GET = GRAPHQL_PLAYGROUND_GET(config) diff --git a/apps/cms/src/app/(payload)/api/graphql/route.ts b/apps/cms/src/app/(payload)/api/graphql/route.ts deleted file mode 100644 index 2069ff86b0a..00000000000 --- a/apps/cms/src/app/(payload)/api/graphql/route.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */ -/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */ -import config from '@payload-config' -import { GRAPHQL_POST, REST_OPTIONS } from '@payloadcms/next/routes' - -export const POST = GRAPHQL_POST(config) - -export const OPTIONS = REST_OPTIONS(config) diff --git a/apps/cms/src/payload.config.ts b/apps/cms/src/payload.config.ts index 8858ce58a5e..8e7a31c40d2 100644 --- a/apps/cms/src/payload.config.ts +++ b/apps/cms/src/payload.config.ts @@ -102,7 +102,7 @@ export default buildConfig({ // Global configuration for better performance globals: [], graphQL: { - disable: process.env.NODE_ENV !== 'development', // Disable GraphQL in production for better performance + disable: true, }, // Reduce payload init overhead telemetry: false, diff --git a/apps/design-system/README.md b/apps/design-system/README.md index 47f009cebea..e8db8fd5246 100644 --- a/apps/design-system/README.md +++ b/apps/design-system/README.md @@ -1,46 +1,31 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Supabase Design System + +Design resources for building consistent user experiences at Supabase. ## Getting Started -First, run the development server: +First, make a copy of _.env.local.example_ and name it _env.local_. Then run the development server as described below. + +From within this _design-system_ directory, run: ```bash -npm run dev -# or -yarn dev -# or pnpm dev -# or -bun dev ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Or from the root directory run: -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +```bash +pnpm dev:design-system +``` -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +Open [http://localhost:3003](http://localhost:3003) with your browser to see the result. ### Watching for MDX changes -If you would like to watch for changes to MDX files with hot reload, you can run the following command in a separate Terminal shell: +If you would like to watch for changes to MDX files with hot reload, you can run the following command in a separate terminal shell: ``` pnpm content:dev ``` This runs Contentlayer concurrently and watches for any changes. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. diff --git a/apps/design-system/app/layout.tsx b/apps/design-system/app/layout.tsx index 9b522fbcc1a..c3fa53e49ce 100644 --- a/apps/design-system/app/layout.tsx +++ b/apps/design-system/app/layout.tsx @@ -8,7 +8,7 @@ const inter = Inter({ subsets: ['latin'] }) export const metadata: Metadata = { title: 'Supabase Design System', - description: 'Generated by create next app', + description: 'Design resources for building consistent user experiences at Supabase.', } interface RootLayoutProps { diff --git a/apps/design-system/components/colors.tsx b/apps/design-system/components/colors.tsx index e1d63267d0f..830581aebae 100644 --- a/apps/design-system/components/colors.tsx +++ b/apps/design-system/components/colors.tsx @@ -1,13 +1,26 @@ import { cn } from 'ui/src/lib/utils/cn' -// import { Card } from '@ui/components/shadcn/ui/card' import color from 'ui/src/lib/tailwind-demo-classes' import { Grid, GridItem } from './grid' +import { useState } from 'react' const Colors = ({ definition, }: { definition: 'background' | 'border' | 'text' | 'colors' | 'palletes' }) => { + const [copiedIndex, setCopiedIndex] = useState(null) + + const handleCopy = async (value: string, index: number) => { + try { + await navigator.clipboard.writeText(value) + setCopiedIndex(index) + setTimeout(() => { + setCopiedIndex(null) + }, 2000) + } catch (err) { + console.error('Failed to copy text: ', err) + } + } const Example = ({ x }: { x: string }) => { switch (definition) { case 'background': @@ -53,10 +66,11 @@ const Colors = ({ handleCopy(x, i)} > - - {x} + + {copiedIndex === i ? 'Copied!' : x} ) @@ -66,90 +80,4 @@ const Colors = ({ ) } -{ - /*
-
-
-
Background
-
- {color.background.map((x: string, i) => { - return ( -
-
-
- {x} -
-
- ) - })} -
-
-
-
Border
-
- {color.border.map((x, i) => { - return ( -
-
-
- {x} -
-
- ) - })} -
-
-
-
texts
-
- {color.text.map((x, i) => { - return ( -
- - ### - -
- {x} -
-
- ) - })} -
-
-
-
-
-
Colors
-
- {color.colors.map((x: string, i) => { - return ( -
-
-
- {x} -
-
- ) - })} -
-
-
-
Palletes
-
- {color.palletes.map((x, i) => { - return ( -
-
-
- {x} -
-
- ) - })} -
-
-
-
*/ -} - export { Colors } diff --git a/apps/design-system/config/docs.ts b/apps/design-system/config/docs.ts index 4064fbd6d04..cd0c0bf8e2c 100644 --- a/apps/design-system/config/docs.ts +++ b/apps/design-system/config/docs.ts @@ -38,13 +38,13 @@ export const docsConfig: DocsConfig = { items: [], }, { - title: 'Color usage', - href: '/docs/color-usage', + title: 'Tailwind Classes', + href: '/docs/tailwind-classes', items: [], }, { - title: 'Tailwind classes', - href: '/docs/tailwind-classes', + title: 'Color Usage', + href: '/docs/color-usage', items: [], }, { diff --git a/apps/design-system/content/docs/changelog.mdx b/apps/design-system/content/docs/changelog.mdx index 1ae4506b73a..bd19ae0967b 100644 --- a/apps/design-system/content/docs/changelog.mdx +++ b/apps/design-system/content/docs/changelog.mdx @@ -4,6 +4,13 @@ description: Latest updates and announcements. toc: false --- +## 1st Sep 2025 - Update button styles + +- [`Color usage`](/design-system/docs/color-usage) page updated +- Color tokens improved for accessibility + +[PR](https://github.com/supabase/supabase/pull/38343) + ## 18th Oct 2024 - Update multi-select Improved Multi Select with combobox, badge limit, and more examples. diff --git a/apps/design-system/content/docs/color-usage.mdx b/apps/design-system/content/docs/color-usage.mdx index 62e27d9df88..e4635a07a70 100644 --- a/apps/design-system/content/docs/color-usage.mdx +++ b/apps/design-system/content/docs/color-usage.mdx @@ -1,11 +1,15 @@ --- title: Color usage -description: Colors system breakdown with best practice +description: Colors system breakdown with best practices. --- -Colors available in the Supabase Design System +The shorthand utility classes below simplify our full color palette by providing sensible, contrast-checked defaults. Use them whenever possible to ensure accessible text colors and balanced background fills. -These are examples of using colors with shorthands. +## Text + +Use accent text colors (e.g. text-destructive, text-warning) sparingly to avoid visual overload. + + ## Background @@ -60,15 +64,8 @@ This is not to be confused with `Dialogs`, they require to use the same app back -## Text - -These can also be accessed with `foreground`. Like `text-foreground-light`. - - - ## Other Colors These can also be accessed with `foreground`. Like `text-foreground-light`. -``` diff --git a/apps/design-system/content/docs/tailwind-classes.mdx b/apps/design-system/content/docs/tailwind-classes.mdx index eb149f4e965..a8efa6a3ef1 100644 --- a/apps/design-system/content/docs/tailwind-classes.mdx +++ b/apps/design-system/content/docs/tailwind-classes.mdx @@ -1,37 +1,37 @@ --- title: Tailwind Classes -description: Icons system breakdown. Copy values of Icons. +description: Theming support for Tailwind classes. --- -Supabase is migrating to use tailwind classes that use CSS properties. +Supabase uses Tailwind classes that in turn use CSS properties. This is to support the concept of theming, so that: -1. It is easy for the team to update the theme without changing 100s of files. -2. We could offer custom or additional themes in future. +1. We can update themes from one place. +2. We can offer custom or additional themes in the future. ## Primitives -We (the Supabase Design team ✨) define primitive color values using Figma Variables. +We define primitive color values using these tokens: - `background` - `foreground` - `border` - `brand` -- `destructive` - `warning` +- `destructive` -These values are exported from Figma as a .json file and transformed into tailwind utilities through some scripts under `packages/ui/internals/tokens`. +These values are exported from Figma as a .json file and transformed into Tailwind utilities through some scripts under `packages/ui/internals/tokens`. -Any of these colors are available on any tailwind utility that accepts color. For example: +Any of these colors are available on any Tailwind utility that accepts color. For example: ```jsx -// this uses the default foreground color +// this uses the default foreground color for this theme -// this uses the 'light' foreground color +// this uses the 'light' foreground color for this theme (one notch 'softer' than the default) -// this uses the default warning color +// this uses the default warning color for this theme // this uses the '500' warning color @@ -48,12 +48,12 @@ We support shorthand classes for `background`, `foreground` and `border`. For ex This will stop you from needing to 'double type' the same utility name. -You might notice we use `foreground` and `background` as prefixes, this is only because it is a Design Token standard, where as tailwind uses `bg` and `text`. +You might notice we use `foreground` and `background` as prefixes, this is only because it is a Design Token standard, where as Tailwind uses `bg` and `text`. ## Mixing colors Even with shorthands, remember you can use any color. For example, `foreground-light` can also be applied on borders and backgrounds as `border-foreground-light` and `bg-foreground-light`, if needed. -Similarly, background and border primitives can be used on other tailwind utilities. +Similarly, background and border primitives can be used on other Tailwind utilities. ```jsx // use the text light color for some text @@ -61,13 +61,13 @@ Similarly, background and border primitives can be used on other tailwind utilit // we can use the same color for a background
- I have the same color background as the left example + I have the same background color as the above example
``` ## Opacity support -All the colors are generated using tailwind opacity, like `hsl(--background-default) / var(--tw-bg-opacity)`. +All colors are generated using Tailwind opacity, like `hsl(--background-default) / var(--tw-bg-opacity)`. This means all the color options in our themes can support opacity rules. For example: ```jsx @@ -82,7 +82,9 @@ This means all the color options in our themes can support opacity rules. For ex ## Usage -The following tailwind classes are a combination of tailwind utilities and our primitives. They're under development and are likely to change but most are now in use and will probably be permanent fixtures. +The following Tailwind classes are a combination of Tailwind utilities and our primitives. + +Note that the shade of the `DEFAULT` value on each scale pattern is variable. Sometimes it is fixed at a particular shade (such as `500` or `600`), but only when contrast is sufficient. ### Foreground (Text) @@ -118,7 +120,7 @@ Examples: | `background-control` | Inputs, Radios, Checkboxes | | `background-button-{DEFAULT}` | Button default | -The `background` part can be omitted when used on the `bg` tailwind utility. +The `background` part can be omitted when used on the `bg` Tailwind utility. Examples: diff --git a/apps/design-system/package.json b/apps/design-system/package.json index e6acd2763ef..197bb8d13bc 100644 --- a/apps/design-system/package.json +++ b/apps/design-system/package.json @@ -6,7 +6,7 @@ "scripts": { "preinstall": "npx only-allow pnpm", "dev": "next dev --turbopack --port 3003", - "build": "pnpm run content:build && pnpm run build:registry && next build", + "build": "pnpm run content:build && pnpm run build:registry && next build --turbopack", "build:registry": "tsx --tsconfig ./tsconfig.scripts.json ./scripts/build-registry.mts && prettier --log-level silent --write \"registry/**/*.{ts,tsx,mdx}\" --cache", "start": "next start", "lint": "next lint", diff --git a/apps/design-system/registry/default/example/filter-bar-demo.tsx b/apps/design-system/registry/default/example/filter-bar-demo.tsx index 06ccabdc71e..d69e08ab0fc 100644 --- a/apps/design-system/registry/default/example/filter-bar-demo.tsx +++ b/apps/design-system/registry/default/example/filter-bar-demo.tsx @@ -14,7 +14,7 @@ function CustomDatePicker({ onChange, onCancel, search }: CustomOptionProps) { ) return ( -
+
- + ``` - + ### Step Hike diff --git a/apps/docs/app/page.tsx b/apps/docs/app/page.tsx index 85f11423335..5714662b1ad 100644 --- a/apps/docs/app/page.tsx +++ b/apps/docs/app/page.tsx @@ -268,7 +268,7 @@ const HomePage = () => (
@@ -328,7 +328,7 @@ const HomePage = () => (
diff --git a/apps/docs/app/reference/[...slug]/page.tsx b/apps/docs/app/reference/[...slug]/page.tsx index 2c7bb70463b..0ed5497704c 100644 --- a/apps/docs/app/reference/[...slug]/page.tsx +++ b/apps/docs/app/reference/[...slug]/page.tsx @@ -33,6 +33,10 @@ export default async function ReferencePage(props: { params: Promise<{ slug: Arr const { sdkId, maybeVersion, path } = parsedPath const sdkData = REFERENCES[sdkId] + if (sdkData.enabled === false) { + notFound() + } + const latestVersion = sdkData.versions[0] const version = maybeVersion ?? latestVersion diff --git a/apps/docs/components/Feedback/Feedback.tsx b/apps/docs/components/Feedback/Feedback.tsx index e96f1907158..a54532715de 100644 --- a/apps/docs/components/Feedback/Feedback.tsx +++ b/apps/docs/components/Feedback/Feedback.tsx @@ -161,7 +161,7 @@ function Feedback({ className }: { className?: string }) { '[transition-property:opacity,transform,color] [transition-duration:150ms,250ms,250ms]', 'motion-reduce:[transition-duration:150ms,1ms,300ms]', '[transition-timing-function:cubic-bezier(.76,0,.23,1)]', - !isNo && 'hover:text-warning-600 hover:border-warning-500', + !isNo && 'hover:text-warning hover:border-warning-500', isNo && `bg-warning text-warning-200 !border-warning disabled:opacity-100`, !showNo && 'opacity-0 invisible' )} diff --git a/apps/docs/components/Feedback/FeedbackModal.tsx b/apps/docs/components/Feedback/FeedbackModal.tsx index c2b8af3ea08..e615e41634b 100644 --- a/apps/docs/components/Feedback/FeedbackModal.tsx +++ b/apps/docs/components/Feedback/FeedbackModal.tsx @@ -58,7 +58,7 @@ function FeedbackModal({ visible, page, onCancel, onSubmit }: FeedbackModalProps href="https://supabase.com/dashboard/support/new" target="_blank" rel="noopener noreferrer" - className="text-brand hover:underline" + className="text-brand-link hover:underline" > support request diff --git a/apps/docs/components/HomePageCover.tsx b/apps/docs/components/HomePageCover.tsx index 591c630023e..4958cb9ba99 100644 --- a/apps/docs/components/HomePageCover.tsx +++ b/apps/docs/components/HomePageCover.tsx @@ -20,7 +20,7 @@ function AiPrompt({ className }: { className?: string }) { className={cn( 'group', 'w-fit rounded-full border px-3 py-1 flex gap-2 items-center text-foreground-light text-sm', - 'hover:border-brand hover:text-brand focus-visible:text-brand', + 'hover:border-brand hover:text-brand-link focus-visible:text-brand-link', 'transition-colors', className )} diff --git a/apps/docs/components/Navigation/Navigation.types.ts b/apps/docs/components/Navigation/Navigation.types.ts index 7918a38e68e..816a5b363b0 100644 --- a/apps/docs/components/Navigation/Navigation.types.ts +++ b/apps/docs/components/Navigation/Navigation.types.ts @@ -11,6 +11,9 @@ export interface NavMenuSection { name: string url?: `/${string}` | `https://${string}` items: Partial[] + icon?: string + hasLightIcon?: boolean + isDarkMode?: boolean enabled?: boolean } diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index ea41b02c326..444ad2331d3 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -1,12 +1,13 @@ import type { ComponentProps } from 'react' -import { isFeatureEnabled } from 'common' +import { isFeatureEnabled } from 'common/enabled-features' import type { IconPanel } from 'ui-patterns/IconPanel' import type { GlobalMenuItems, NavMenuConstant, NavMenuSection } from '../Navigation.types' const { authenticationShowProviders: allAuthProvidersEnabled, billingAll: billingEnabled, + docsCompliance: complianceEnabled, 'docsSelf-hosting': selfHostingEnabled, sdkCsharp: sdkCsharpEnabled, sdkDart: sdkDartEnabled, @@ -16,6 +17,7 @@ const { } = isFeatureEnabled([ 'authentication:show_providers', 'billing:all', + 'docs:compliance', 'docs:self-hosting', 'sdk:csharp', 'sdk:dart', @@ -460,7 +462,7 @@ export const NativeMobileLoginItems = [ }, ] -export const SocialLoginItems = [ +export const SocialLoginItems: Array> = [ { name: 'Google', icon: '/docs/img/icons/google-icon', @@ -591,7 +593,7 @@ export const PhoneLoginsItems = [ }, ] -export const auth = { +export const auth: NavMenuConstant = { icon: 'auth', title: 'Auth', items: [ @@ -697,7 +699,7 @@ export const auth = { enabled: allAuthProvidersEnabled, }, { - name: 'Web3 (Sign in with Solana)', + name: 'Web3 (Ethereum or Solana)', url: '/guides/auth/auth-web3', enabled: allAuthProvidersEnabled, }, @@ -791,6 +793,7 @@ export const auth = { { name: 'Password Security', url: '/guides/auth/password-security' }, { name: 'Rate Limits', url: '/guides/auth/rate-limits' }, { name: 'Bot Detection (CAPTCHA)', url: '/guides/auth/auth-captcha' }, + { name: 'Audit Logs', url: '/guides/auth/audit-logs' }, { name: 'JSON Web Tokens (JWT)', url: '/guides/auth/jwts', @@ -1440,6 +1443,10 @@ export const functions: NavMenuConstant = { name: 'Development Environment', url: '/guides/functions/development-environment' as `/${string}`, }, + { + name: 'Architecture', + url: '/guides/functions/architecture', + }, ], }, { @@ -1865,7 +1872,7 @@ export const storage: NavMenuConstant = { ], } -export const vectorIndexItems = [ +export const vectorIndexItems: Array> = [ { name: 'HNSW indexes', url: '/guides/ai/vector-indexes/hnsw-indexes', @@ -1876,7 +1883,7 @@ export const vectorIndexItems = [ }, ] -export const ai = { +export const ai: NavMenuConstant = { icon: 'ai', title: 'AI & Vectors', url: '/guides/ai', @@ -2188,6 +2195,7 @@ export const security: NavMenuConstant = { { name: 'Compliance', url: undefined, + enabled: complianceEnabled, items: [ { name: 'SOC 2', url: '/guides/security/soc-2-compliance' }, { name: 'HIPAA', url: '/guides/security/hipaa-compliance' }, diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx index f18ba82147d..50bcae9a64f 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx @@ -22,7 +22,7 @@ const NavigationMenuCliList = ({ currentLevel, setLevel, id }) => {
  • {icon && } {title} @@ -99,7 +99,7 @@ const NavigationMenuCliList = ({ currentLevel, setLevel, id }) => { href={`${menu.parent ?? '/'}`} className={[ 'flex items-center gap-1 text-xs group mb-3', - 'text-base transition-all duration-200 text-brand hover:text-brand-600 hover:cursor-pointer ', + 'text-base transition-all duration-200 text-brand-link hover:text-brand-600 hover:cursor-pointer ', ].join(' ')} >
    diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx index 25fb97f180c..9991c5c7266 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx @@ -19,7 +19,7 @@ const HeaderLink = React.memo(function HeaderLink(props: { className={[ ' ', !props.title && 'capitalize', - props.url === pathname ? 'text-brand' : 'hover:text-brand text-foreground', + props.url === pathname ? 'text-brand-link' : 'hover:text-brand-link text-foreground', ].join(' ')} > {props.title ?? props.id} @@ -75,7 +75,7 @@ const ContentAccordionLink = React.memo(function ContentAccordionLink(props: any 'flex items-center gap-2', 'cursor-pointer transition text-sm', activeItem - ? 'text-brand font-medium' + ? 'text-brand-link font-medium' : 'hover:text-foreground text-foreground-lighter', ].join(' ')} parent={props.subItem.parent} @@ -104,8 +104,8 @@ const ContentAccordionLink = React.memo(function ContentAccordionLink(props: any className={[ 'cursor-pointer transition text-sm', subSubItem.url === pathname - ? 'text-brand' - : 'hover:text-brand text-foreground-lighter', + ? 'text-brand-link' + : 'hover:text-brand-link text-foreground-lighter', ].join(' ')} > {subSubItem.name} diff --git a/apps/docs/components/Navigation/SideBar.tsx b/apps/docs/components/Navigation/SideBar.tsx index d754fadbc7a..04badfb2787 100644 --- a/apps/docs/components/Navigation/SideBar.tsx +++ b/apps/docs/components/Navigation/SideBar.tsx @@ -105,7 +105,7 @@ const SideBar = ({ menuItems = [] }: { menuItems: any }) => { size={14} strokeWidth={2} /> - + {group.label} @@ -119,7 +119,7 @@ const SideBar = ({ menuItems = [] }: { menuItems: any }) => { 'py-1.5 px-5 rounded text-sm transition', `${ section.url === pathname - ? 'bg-background text-brand' + ? 'bg-background text-brand-link' : 'text-foreground-light hover:text-foreground' }`, ].join(' ')} @@ -144,7 +144,7 @@ const SideBar = ({ menuItems = [] }: { menuItems: any }) => { size={14} strokeWidth={2} /> - + {section.name} @@ -157,7 +157,7 @@ const SideBar = ({ menuItems = [] }: { menuItems: any }) => { 'py-1.5 ml-4 px-5 rounded text-sm transition', `${ item.url === pathname - ? 'bg-background text-brand' + ? 'bg-background text-brand-link' : 'text-foreground-light hover:text-foreground' }`, ].join(' ')} diff --git a/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.tsx b/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.tsx index 88423df9417..b34ed122426 100644 --- a/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.tsx +++ b/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.tsx @@ -274,7 +274,7 @@ function VariableView({ variable, className }: { variable: Variable; className?: const hasBranches = selectedProject?.is_branch_enabled ?? false const ref = hasBranches ? selectedBranch?.project_ref : selectedProject?.ref - const needsApiQuery = variable === 'anonKey' || variable === 'url' + const needsApiQuery = variable === 'publishableKey' || variable === 'url' const needsSupavisorQuery = variable === 'sessionPooler' const { @@ -303,7 +303,7 @@ function VariableView({ variable, className }: { variable: Variable; className?: switch (variable) { case 'url': return !apiData.app_config?.endpoint - case 'anonKey': + case 'publishableKey': return !apiData.service_api_keys?.some((key) => key.tags === 'anon') } } @@ -336,7 +336,7 @@ function VariableView({ variable, className }: { variable: Variable; className?: case 'url': variableValue = `https://${apiData?.app_config?.endpoint}` break - case 'anonKey': + case 'publishableKey': variableValue = apiData?.service_api_keys?.find((key) => key.tags === 'anon')?.api_key || '' break case 'sessionPooler': diff --git a/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.utils.ts b/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.utils.ts index 1d1a125e3dd..2ed28261bed 100644 --- a/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.utils.ts +++ b/apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.utils.ts @@ -6,7 +6,7 @@ export type Org = OrganizationsData[number] export type Project = ProjectsData[number] export type Branch = BranchesData[number] -export type Variable = 'url' | 'anonKey' | 'sessionPooler' +export type Variable = 'url' | 'publishableKey' | 'sessionPooler' function removeDoubleQuotes(str: string) { return str.replaceAll('"', '') @@ -30,7 +30,7 @@ function unescapeDoubleQuotes(str: string) { export const prettyFormatVariable: Record = { url: 'Project URL', - anonKey: 'Anon key', + publishableKey: 'Publishable key', sessionPooler: 'Connection string (pooler session mode)', } diff --git a/apps/docs/content/_partials/api_settings.mdx b/apps/docs/content/_partials/api_settings.mdx new file mode 100644 index 00000000000..090ae9ba089 --- /dev/null +++ b/apps/docs/content/_partials/api_settings.mdx @@ -0,0 +1,16 @@ +### Get API details + +Now that you've created some database tables, you are ready to insert data using the auto-generated API. + +To do this, you need to get the Project URL and key. Get the URL from [the API settings section](/dashboard/project/_/settings/api) of a project and the key from the [the API Keys section of a project's Settings page](/dashboard/project/_/settings/api-keys/). + + + +Supabase is changing the way keys work to improve project security and developer experience. You can [read the full announcement](https://github.com/orgs/supabase/discussions/29260), but in the transition period, you can use both the current `anon` and `service_role` keys and the new publishable key with the form `sb_publishable_xxx` which will replace the older keys. + +To get the key values, open [the API Keys section of a project's Settings page](/dashboard/project/_/settings/api-keys/) and do the following: + +- **For legacy keys**, copy the `anon` key for client-side operations and the `service_role` key for server-side operations from the **Legacy API Keys** tab. +- **For new keys**, open the **API Keys** tab, if you don't have a publishable key already, click **Create new API Keys**, and copy the value from the **Publishable key** section. + + diff --git a/apps/docs/content/_partials/api_settings_steps.mdx b/apps/docs/content/_partials/api_settings_steps.mdx new file mode 100644 index 00000000000..dbd3d3cd7e6 --- /dev/null +++ b/apps/docs/content/_partials/api_settings_steps.mdx @@ -0,0 +1,12 @@ +{/* TODO: How to completely consolidate partials? */} + + + +Supabase is changing the way keys work to improve project security and developer experience. You can [read the full announcement](https://github.com/orgs/supabase/discussions/29260), but in the transition period, you can use both the current `anon` and `service_role` keys and the new publishable key with the form `sb_publishable_xxx` which will replace the older keys. + +To get the key values, open [the API Keys section of a project's Settings page](/dashboard/project/_/settings/api-keys/) and do the following: + +- **For legacy keys**, copy the `anon` key for client-side operations and the `service_role` key for server-side operations from the **Legacy API Keys** tab. +- **For new keys**, open the **API Keys** tab, if you don't have a publishable key already, click **Create new API Keys**, and copy the value from the **Publishable key** section. + + diff --git a/apps/docs/content/_partials/database_setup.mdx b/apps/docs/content/_partials/database_setup.mdx index 5f7dd771a96..dc8ccb952b0 100644 --- a/apps/docs/content/_partials/database_setup.mdx +++ b/apps/docs/content/_partials/database_setup.mdx @@ -11,6 +11,6 @@ Your database will be available in less than a minute. You can find your project credentials on the dashboard: -- [Database connection strings](https://supabase.com/dashboard/project/_/settings/api?showConnect=true): Direct and Pooler connection details including the connection string and parameters. -- [Database password](https://supabase.com/dashboard/project/_/database/settings): Reset database password here if you do not have it. -- [API credentials](https://supabase.com/dashboard/project/_/settings/api): your serverless API URL and `anon` / `service_role` keys. +- [Database connection strings](/dashboard/project/_/settings/api?showConnect=true): Direct and Pooler connection details including the connection string and parameters. +- [Database password](/dashboard/project/_/database/settings): Reset database password here if you do not have it. +- [API credentials](/dashboard/project/_/settings/api): your serverless API URL and `anon` / `service_role` keys. diff --git a/apps/docs/content/_partials/kotlin_project_setup.mdx b/apps/docs/content/_partials/kotlin_project_setup.mdx index a01629914df..751559eaff0 100644 --- a/apps/docs/content/_partials/kotlin_project_setup.mdx +++ b/apps/docs/content/_partials/kotlin_project_setup.mdx @@ -33,13 +33,7 @@ Now we are going to set up the database schema. You can just copy/paste the SQL -### Get the API keys - -Now that you've created some database tables, you are ready to insert data using the auto-generated API. -We just need to get the Project URL and `anon` key from the API settings. - -1. Go to the [API Settings](https://app.supabase.com/project/_/settings/api) page in the Dashboard. -2. Find your Project `URL`, `anon`, and `service_role` keys on this page. +<$Partial path="api_settings.mdx" /> ### Set up Google authentication diff --git a/apps/docs/content/_partials/mcp_supabase_config.mdx b/apps/docs/content/_partials/mcp_supabase_config.mdx index b902d865d8e..871a25462b2 100644 --- a/apps/docs/content/_partials/mcp_supabase_config.mdx +++ b/apps/docs/content/_partials/mcp_supabase_config.mdx @@ -15,19 +15,19 @@ "command": "npx", "args": [ "-y", - "@supabase/mcp-server-supabase@latest", + "@supabase/mcp-server-supabase", "--read-only", "--project-ref=" ], "env": { - "SUPABASE_ACCESS_TOKEN": "" + "SUPABASE_ACCESS_TOKEN": "" } } } } ``` - Replace `` with your project ref, and `` with your personal access token. + Replace `` with your project ref, and `` with your personal access token. @@ -42,12 +42,12 @@ "/c", "npx", "-y", - "@supabase/mcp-server-supabase@latest", + "@supabase/mcp-server-supabase", "--read-only", "--project-ref=" ], "env": { - "SUPABASE_ACCESS_TOKEN": "" + "SUPABASE_ACCESS_TOKEN": "" } } } @@ -65,18 +65,18 @@ Or, if using `pnpm` instead of `npm` "/c", "pnpm", "dlx", - "@supabase/mcp-server-supabase@latest", + "@supabase/mcp-server-supabase", "--read-only", "--project-ref=" ], "env": { - "SUPABASE_ACCESS_TOKEN": "" + "SUPABASE_ACCESS_TOKEN": "" } } } } ``` - Replace `` with your project ref, and `` with your personal access token. + Replace `` with your project ref, and `` with your personal access token. @@ -110,19 +110,19 @@ Or, if using `pnpm` instead of `npm` "args": [ "npx", "-y", - "@supabase/mcp-server-supabase@latest", + "@supabase/mcp-server-supabase", "--read-only", "--project-ref=" ], "env": { - "SUPABASE_ACCESS_TOKEN": "" + "SUPABASE_ACCESS_TOKEN": "" } } } } ``` - Replace `` with your project ref, and `` with your personal access token. + Replace `` with your project ref, and `` with your personal access token. This assumes you have Windows Subsystem for Linux (WSL) enabled and `node`/`npx` are installed within the WSL environment. @@ -137,19 +137,19 @@ Or, if using `pnpm` instead of `npm` "command": "npx", "args": [ "-y", - "@supabase/mcp-server-supabase@latest", + "@supabase/mcp-server-supabase", "--read-only", "--project-ref=" ], "env": { - "SUPABASE_ACCESS_TOKEN": "" + "SUPABASE_ACCESS_TOKEN": "" } } } } ``` - Replace `` with your project ref, and `` with your personal access token. + Replace `` with your project ref, and `` with your personal access token. diff --git a/apps/docs/content/_partials/migration_warnings.mdx b/apps/docs/content/_partials/migration_warnings.mdx index c875713b09b..c221ef2f1d4 100644 --- a/apps/docs/content/_partials/migration_warnings.mdx +++ b/apps/docs/content/_partials/migration_warnings.mdx @@ -2,6 +2,6 @@ - If you're planning to migrate a database larger than 6 GB, we recommend [upgrading to at least a Large compute add-on](/docs/guides/platform/compute-add-ons). This will ensure you have the necessary resources to handle the migration efficiently. -- We strongly advise you to pre-provision the disk space you will need for your migration. On paid projects, you can do this by navigating to the [Compute and Disk Settings](https://supabase.com/dashboard/project/_/settings/compute-and-disk) page. For more information on disk scaling and disk limits, check out our [disk settings](https://supabase.com/docs/guides/platform/compute-and-disk#disk) documentation. +- We strongly advise you to pre-provision the disk space you will need for your migration. On paid projects, you can do this by navigating to the [Compute and Disk Settings](/dashboard/project/_/settings/compute-and-disk) page. For more information on disk scaling and disk limits, check out our [disk settings](/docs/guides/platform/compute-and-disk#disk) documentation. diff --git a/apps/docs/content/_partials/project_setup.mdx b/apps/docs/content/_partials/project_setup.mdx index 23519c82bf2..3548980bcea 100644 --- a/apps/docs/content/_partials/project_setup.mdx +++ b/apps/docs/content/_partials/project_setup.mdx @@ -4,7 +4,7 @@ Before you start building you need to set up the Database and API. You can do th ### Create a project -1. [Create a new project](https://supabase.com/dashboard) in the Supabase Dashboard. +1. [Create a new project](/dashboard) in the Supabase Dashboard. 2. Enter your project details. 3. Wait for the new database to launch. @@ -21,7 +21,7 @@ Now set up the database schema. You can use the "User Management Starter" quicks > -1. Go to the [SQL Editor](https://supabase.com/dashboard/project/_/sql) page in the Dashboard. +1. Go to the [SQL Editor](/dashboard/project/_/sql) page in the Dashboard. 2. Click **User Management Starter** under the **Community > Quickstarts** tab. 3. Click **Run**. @@ -55,11 +55,4 @@ supabase migration new user_management_starter -### Get the API keys - -Now that you've created some database tables, you are ready to insert data using the auto-generated API. - -To do this, you need to get the Project URL and `anon` key from the API settings. - -1. Go to the [API Settings](https://supabase.com/dashboard/project/_/settings/api) page in the Dashboard. -2. Find your Project `URL`, `anon`, and `service_role` keys on this page. +<$Partial path="api_settings.mdx" /> diff --git a/apps/docs/content/_partials/quickstart_db_setup.mdx b/apps/docs/content/_partials/quickstart_db_setup.mdx index b8193923efc..76d441a3650 100644 --- a/apps/docs/content/_partials/quickstart_db_setup.mdx +++ b/apps/docs/content/_partials/quickstart_db_setup.mdx @@ -24,9 +24,9 @@ curl -X POST https://api.supabase.com/v1/projects \ }' ``` -When your project is up and running, go to the [Table Editor](https://supabase.com/dashboard/project/_/editor), create a new table and insert some data. +When your project is up and running, go to the [Table Editor](/dashboard/project/_/editor), create a new table and insert some data. -Alternatively, you can run the following snippet in your project's [SQL Editor](https://supabase.com/dashboard/project/_/sql/new). This will create a `instruments` table with some sample data. +Alternatively, you can run the following snippet in your project's [SQL Editor](/dashboard/project/_/sql/new). This will create a `instruments` table with some sample data. diff --git a/apps/docs/content/_partials/social_provider_settings_supabase.mdx b/apps/docs/content/_partials/social_provider_settings_supabase.mdx index 199589d2077..7587ff9386d 100644 --- a/apps/docs/content/_partials/social_provider_settings_supabase.mdx +++ b/apps/docs/content/_partials/social_provider_settings_supabase.mdx @@ -1,6 +1,6 @@ -- Go to your [Supabase Project Dashboard](https://supabase.com/dashboard) +- Go to your [Supabase Project Dashboard](/dashboard) - In the left sidebar, click the `Authentication` icon (near the top) -- Click on [`Providers`](https://supabase.com/dashboard/project/_/auth/providers) under the Configuration section +- Click on [`Providers`](/dashboard/project/_/auth/providers) under the Configuration section - Click on **{{ .provider }}** from the accordion list to expand and turn **{{ .provider }} Enabled** to ON - Enter your **{{ .provider }} Client ID** and **{{ .provider }} Client Secret** saved in the previous step - Click `Save` diff --git a/apps/docs/content/_partials/social_provider_setup.mdx b/apps/docs/content/_partials/social_provider_setup.mdx index ec446552dce..5af559543ae 100644 --- a/apps/docs/content/_partials/social_provider_setup.mdx +++ b/apps/docs/content/_partials/social_provider_setup.mdx @@ -1,8 +1,8 @@ The next step requires a callback URL, which looks like this: `https://.supabase.co/auth/v1/callback` -- Go to your [Supabase Project Dashboard](https://supabase.com/dashboard) +- Go to your [Supabase Project Dashboard](/dashboard) - Click on the `Authentication` icon in the left sidebar -- Click on [`Providers`](https://supabase.com/dashboard/project/_/auth/providers) under the Configuration section +- Click on [`Providers`](/dashboard/project/_/auth/providers) under the Configuration section - Click on **{{ .provider }}** from the accordion list to expand and you'll find your **Callback URL**, you can click `Copy` to copy it to the clipboard diff --git a/apps/docs/content/guides/ai.mdx b/apps/docs/content/guides/ai.mdx index 6d512aa57a3..c2cfe4743d7 100644 --- a/apps/docs/content/guides/ai.mdx +++ b/apps/docs/content/guides/ai.mdx @@ -139,10 +139,10 @@ export const integrations = [ href: 'https://supabase.com/customers/berriai', }, { - name: 'Mendable switches from Pinecone to Supabase for PostgreSQL vector embeddings', + name: 'Firecrawl switches from Pinecone to Supabase for PostgreSQL vector embeddings', description: - 'How Mendable boosts efficiency and accuracy of chat powered search for documentation using Supabase with pgvector', - href: 'https://supabase.com/customers/mendableai', + 'How Firecrawl boosts efficiency and accuracy of chat powered search for documentation using Supabase with pgvector', + href: 'https://supabase.com/customers/firecrawl', }, { name: 'Markprompt: GDPR-Compliant AI Chatbots for Docs and Websites', diff --git a/apps/docs/content/guides/ai/examples/building-chatgpt-plugins.mdx b/apps/docs/content/guides/ai/examples/building-chatgpt-plugins.mdx index f50a79761f3..468df1a8d55 100644 --- a/apps/docs/content/guides/ai/examples/building-chatgpt-plugins.mdx +++ b/apps/docs/content/guides/ai/examples/building-chatgpt-plugins.mdx @@ -54,7 +54,7 @@ poetry install ### Step 3: Create a Supabase project -Create a [Supabase project](https://supabase.com/dashboard) and database by following the instructions [here](https://supabase.com/docs/guides/platform). Export the environment variables required for the retrieval plugin to work: +Create a [Supabase project](/dashboard) and database by following the instructions [here](/docs/guides/platform). Export the environment variables required for the retrieval plugin to work: ```bash export OPENAI_API_KEY= diff --git a/apps/docs/content/guides/ai/examples/headless-vector-search.mdx b/apps/docs/content/guides/ai/examples/headless-vector-search.mdx index 993b92c178b..7bbf9afc8ba 100644 --- a/apps/docs/content/guides/ai/examples/headless-vector-search.mdx +++ b/apps/docs/content/guides/ai/examples/headless-vector-search.mdx @@ -33,7 +33,7 @@ There are 3 steps to build similarity search inside your documentation: ### Prepare your database -To prepare, create a [new Supabase project](https://database.new) and store the database and API credentials, which you can find in the project [settings](https://supabase.com/dashboard/project/_/settings). +To prepare, create a [new Supabase project](https://database.new) and store the database and API credentials, which you can find in the project [settings](/dashboard/project/_/settings). Now we can use the [Headless Vector Search](https://github.com/supabase/headless-vector-search#set-up) instructions to set up the database: @@ -42,7 +42,7 @@ Now we can use the [Headless Vector Search](https://github.com/supabase/headless 3. Apply the database migrations: `supabase db push` 4. Set your OpenAI key as a secret: `supabase secrets set OPENAI_API_KEY=sk-xxx` 5. Deploy the Edge Functions: `supabase functions deploy --no-verify-jwt` -6. Expose `docs` schema via API in Supabase Dashboard [settings](https://supabase.com/dashboard/project/_/settings/api) > `API Settings` > `Exposed schemas` +6. Expose `docs` schema via API in Supabase Dashboard [settings](/dashboard/project/_/settings/api) > `API Settings` > `Exposed schemas` ### Ingest your documentation @@ -112,6 +112,6 @@ const onSubmit = (e: Event) => { ## Resources -- Read about how we built [ChatGPT for the Supabase Docs](https://supabase.com/blog/chatgpt-supabase-docs). +- Read about how we built [ChatGPT for the Supabase Docs](/blog/chatgpt-supabase-docs). - Read the pgvector Docs for [Embeddings and vector similarity](/docs/guides/database/extensions/pgvector) - See how to build something like this from scratch [using Next.js](/docs/guides/ai/examples/nextjs-vector-search). diff --git a/apps/docs/content/guides/ai/examples/huggingface-image-captioning.mdx b/apps/docs/content/guides/ai/examples/huggingface-image-captioning.mdx index 90a34c421f3..6ded63808f5 100644 --- a/apps/docs/content/guides/ai/examples/huggingface-image-captioning.mdx +++ b/apps/docs/content/guides/ai/examples/huggingface-image-captioning.mdx @@ -6,25 +6,25 @@ video: 'https://www.youtube.com/v/OgnYxRkxEUw' tocVideo: 'OgnYxRkxEUw' --- -We can combine Hugging Face with [Supabase Storage](https://supabase.com/storage) and [Database Webhooks](https://supabase.com/docs/guides/database/webhooks) to automatically caption for any image we upload to a storage bucket. +We can combine Hugging Face with [Supabase Storage](/storage) and [Database Webhooks](/docs/guides/database/webhooks) to automatically caption for any image we upload to a storage bucket. ## About Hugging Face [Hugging Face](https://huggingface.co/) is the collaboration platform for the machine learning community. -[Huggingface.js](https://huggingface.co/docs/huggingface.js/index) provides a convenient way to make calls to 100,000+ Machine Learning models, making it easy to incorporate AI functionality into your [Supabase Edge Functions](https://supabase.com/edge-functions). +[Huggingface.js](https://huggingface.co/docs/huggingface.js/index) provides a convenient way to make calls to 100,000+ Machine Learning models, making it easy to incorporate AI functionality into your [Supabase Edge Functions](/edge-functions). ## Setup -- Open your Supabase project dashboard or [create a new project](https://supabase.com/dashboard/projects). -- [Create a new bucket](https://supabase.com/dashboard/project/_/storage/buckets) called `images`. +- Open your Supabase project dashboard or [create a new project](/dashboard/projects). +- [Create a new bucket](/dashboard/project/_/storage/buckets) called `images`. - Generate TypeScript types from remote Database. - Create a new Database table called `image_caption`. - Create `id` column of type `uuid` which references `storage.objects.id`. - Create a `caption` column of type `text`. - Regenerate TypeScript types to include new `image_caption` table. - Deploy the function to Supabase: `supabase functions deploy huggingface-image-captioning`. -- Create the Database Webhook in the [Supabase Dashboard](https://supabase.com/dashboard/project/_/database/hooks) to trigger the `huggingface-image-captioning` function anytime a record is added to the `storage.objects` table. +- Create the Database Webhook in the [Supabase Dashboard](/dashboard/project/_/database/hooks) to trigger the `huggingface-image-captioning` function anytime a record is added to the `storage.objects` table. ## Generate TypeScript types diff --git a/apps/docs/content/guides/ai/examples/mixpeek-video-search.mdx b/apps/docs/content/guides/ai/examples/mixpeek-video-search.mdx index 1e9b8ad1403..ff8b7bafdb0 100644 --- a/apps/docs/content/guides/ai/examples/mixpeek-video-search.mdx +++ b/apps/docs/content/guides/ai/examples/mixpeek-video-search.mdx @@ -30,7 +30,7 @@ poetry new video-search ## Setup Supabase project -If you haven't already, [install the Supabase CLI](https://supabase.com/docs/guides/cli), then initialize Supabase in the root of your newly created poetry project: +If you haven't already, [install the Supabase CLI](/docs/guides/cli), then initialize Supabase in the root of your newly created poetry project: ```shell supabase init diff --git a/apps/docs/content/guides/ai/examples/nextjs-vector-search.mdx b/apps/docs/content/guides/ai/examples/nextjs-vector-search.mdx index dc0d3b8fc74..741680e583a 100644 --- a/apps/docs/content/guides/ai/examples/nextjs-vector-search.mdx +++ b/apps/docs/content/guides/ai/examples/nextjs-vector-search.mdx @@ -12,19 +12,19 @@ While our [Headless Vector search](/docs/guides/ai/examples/headless-vector-sear 2. Store you embeddings in Postgres using pgvector. 3. Deploy a function for answering your users' questions. -You can read our [Supabase Clippy](https://supabase.com/blog/chatgpt-supabase-docs) blog post for a full example. +You can read our [Supabase Clippy](/blog/chatgpt-supabase-docs) blog post for a full example. We assume that you have a Next.js project with a collection of `.mdx` files nested inside your `pages` directory. We will start developing locally with the Supabase CLI and then push our local database changes to our hosted Supabase project. You can find the [full Next.js example on GitHub](https://github.com/supabase-community/nextjs-openai-doc-search). ## Create a project -1. [Create a new project](https://supabase.com/dashboard) in the Supabase Dashboard. +1. [Create a new project](/dashboard) in the Supabase Dashboard. 1. Enter your project details. 1. Wait for the new database to launch. ## Prepare the database -Let's prepare the database schema. We can use the "OpenAI Vector Search" quickstart in the [SQL Editor](https://supabase.com/dashboard/project/_/sql), or you can copy/paste the SQL below and run it yourself. +Let's prepare the database schema. We can use the "OpenAI Vector Search" quickstart in the [SQL Editor](/dashboard/project/_/sql), or you can copy/paste the SQL below and run it yourself. -1. Go to the [SQL Editor](https://supabase.com/dashboard/project/_/sql) page in the Dashboard. +1. Go to the [SQL Editor](/dashboard/project/_/sql) page in the Dashboard. 2. Click **OpenAI Vector Search**. 3. Click **Run**. @@ -147,7 +147,7 @@ Let's prepare the database schema. We can use the "OpenAI Vector Search" quickst Anytime the user sends a query, we want to find the content that's relevant to their questions. We can do this using pgvector's similarity search. - These are quite complex SQL operations, so let's wrap them in database functions that we can call from our frontend using [RPC](https://supabase.com/docs/reference/javascript/rpc). + These are quite complex SQL operations, so let's wrap them in database functions that we can call from our frontend using [RPC](/docs/reference/javascript/rpc). @@ -527,8 +527,8 @@ const handleConfirm = React.useCallback( Want to learn more about the awesome tech that is powering this? -- Read about how we built [ChatGPT for the Supabase Docs](https://supabase.com/blog/chatgpt-supabase-docs). -- Read the pgvector Docs for [Embeddings and vector similarity](https://supabase.com/docs/guides/database/extensions/pgvector) +- Read about how we built [ChatGPT for the Supabase Docs](/blog/chatgpt-supabase-docs). +- Read the pgvector Docs for [Embeddings and vector similarity](/docs/guides/database/extensions/pgvector) - Watch Greg's video for a full breakdown:
    diff --git a/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx b/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx index 134831fd32f..0110be71963 100644 --- a/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx +++ b/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx @@ -34,7 +34,7 @@ If you haven't already, head over to [database.new](https://database.new) and cr When creating your project, make sure to note down your database password as you will need it to construct the `DB_URL` in the next step. -You can find your database connection string on your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true). Use the Session pooler connection string which looks like this: +You can find your database connection string on your project dashboard, click [Connect](/dashboard/project/_?showConnect=true). Use the Session pooler connection string which looks like this: ```txt postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-0-[REGION].pooler.supabase.com:5432/postgres @@ -188,7 +188,7 @@ seed = "image_search.main:seed" search = "image_search.main:search" ``` -After activating the virtual environment with `poetry shell` you can now run your seed script via `poetry run seed`. You can inspect the generated embeddings in your Supabase Dashboard by visiting the [Table Editor](https://supabase.com/dashboard/project/_/editor), selecting the `vecs` schema, and the `image_vectors` table. +After activating the virtual environment with `poetry shell` you can now run your seed script via `poetry run seed`. You can inspect the generated embeddings in your Supabase Dashboard by visiting the [Table Editor](/dashboard/project/_/editor), selecting the `vecs` schema, and the `image_vectors` table. ## Perform an image search from a text query diff --git a/apps/docs/content/guides/ai/going-to-prod.mdx b/apps/docs/content/guides/ai/going-to-prod.mdx index 5d43a161a6f..388f714dd0d 100644 --- a/apps/docs/content/guides/ai/going-to-prod.mdx +++ b/apps/docs/content/guides/ai/going-to-prod.mdx @@ -26,7 +26,7 @@ On the other hand, if you need to scale your application, you will need to [crea ## HNSW vs IVFFlat indexes -`pgvector` supports two types of indexes: HNSW and IVFFlat. We recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](https://supabase.com/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). +`pgvector` supports two types of indexes: HNSW and IVFFlat. We recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). dbpedia embeddings comparing ivfflat and hnsw queries-per-second using the 4XL compute add-on @@ -60,7 +60,7 @@ You must use the "connection pooling" string (domain ending in `*.pooler.supabas Now all that's left is to step through the notebook. You can do this by clicking the "execute" button (`ctrl+enter`) at the top left of each code cell. The notebook guides you through the process of creating a collection, adding data to it, and querying it. -You can view the inserted items in the [Table Editor](https://supabase.com/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. +You can view the inserted items in the [Table Editor](/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. ![Colab documents](/docs/img/ai/google-colab/colab-documents.png) diff --git a/apps/docs/content/guides/ai/langchain.mdx b/apps/docs/content/guides/ai/langchain.mdx index f0874ca37a7..a25168eb31c 100644 --- a/apps/docs/content/guides/ai/langchain.mdx +++ b/apps/docs/content/guides/ai/langchain.mdx @@ -20,7 +20,7 @@ Prepare you database with the relevant tables: > -1. Go to the [SQL Editor](https://supabase.com/dashboard/project/_/sql) page in the Dashboard. +1. Go to the [SQL Editor](/dashboard/project/_/sql) page in the Dashboard. 2. Click **LangChain** in the Quick start section. 3. Click **Run**. @@ -76,8 +76,8 @@ $$; You can now search your documents using any Node.js application. This is intended to be run on a secure server route. ```js -import { SupabaseVectorStore } from 'langchain/vectorstores/supabase' -import { OpenAIEmbeddings } from 'langchain/embeddings/openai' +import { SupabaseVectorStore } from '@langchain/community/vectorstores/supabase' +import { OpenAIEmbeddings } from '@langchain/openai' import { createClient } from '@supabase/supabase-js' const supabaseKey = process.env.SUPABASE_SERVICE_ROLE_KEY @@ -111,8 +111,8 @@ export const run = async () => { Given the above `match_documents` Postgres function, you can also pass a filter parameter to only return documents with a specific metadata field value. This filter parameter is a JSON object, and the `match_documents` function will use the Postgres JSONB Containment operator `@>` to filter documents by the metadata field values you specify. See details on the [Postgres JSONB Containment operator](https://www.postgresql.org/docs/current/datatype-json.html#JSON-CONTAINMENT) for more information. ```js -import { SupabaseVectorStore } from 'langchain/vectorstores/supabase' -import { OpenAIEmbeddings } from 'langchain/embeddings/openai' +import { SupabaseVectorStore } from '@langchain/community/vectorstores/supabase' +import { OpenAIEmbeddings } from '@langchain/openai' import { createClient } from '@supabase/supabase-js' // First, follow set-up instructions above @@ -147,11 +147,11 @@ export const run = async () => { ### Advanced metadata filtering -You can also use query builder-style filtering ([similar to how the Supabase JavaScript library works](https://supabase.com/docs/reference/javascript/using-filters)) instead of passing an object. Note that since the filter properties will be in the metadata column, you need to use arrow operators (`->` for integer or `->>` for text) as defined in [PostgREST API documentation](https://postgrest.org/en/stable/references/api/tables_views.html?highlight=operators#json-columns) and specify the data type of the property (e.g. the column should look something like `metadata->some_int_value::int`). +You can also use query builder-style filtering ([similar to how the Supabase JavaScript library works](/docs/reference/javascript/using-filters)) instead of passing an object. Note that since the filter properties will be in the metadata column, you need to use arrow operators (`->` for integer or `->>` for text) as defined in [PostgREST API documentation](https://postgrest.org/en/stable/references/api/tables_views.html?highlight=operators#json-columns) and specify the data type of the property (e.g. the column should look something like `metadata->some_int_value::int`). ```js -import { SupabaseFilterRPCCall, SupabaseVectorStore } from 'langchain/vectorstores/supabase' -import { OpenAIEmbeddings } from 'langchain/embeddings/openai' +import { SupabaseFilterRPCCall, SupabaseVectorStore } from '@langchain/community/vectorstores/supabase' +import { OpenAIEmbeddings } from '@langchain/openai' import { createClient } from '@supabase/supabase-js' // First, follow set-up instructions above diff --git a/apps/docs/content/guides/ai/python-clients.mdx b/apps/docs/content/guides/ai/python-clients.mdx index 08e1646adb2..a617f0e11cb 100644 --- a/apps/docs/content/guides/ai/python-clients.mdx +++ b/apps/docs/content/guides/ai/python-clients.mdx @@ -11,7 +11,9 @@ For data science or ephemeral workloads, the [Supabase Vecs](https://supabase.gi -You can get your connection string from the [**Database Settings**](https://supabase.com/dashboard/project/_/database/settings) page in your dashboard. Make sure to check **Use connection pooling**, then copy the URI. Also, change the URI scheme from `postgres` to `postgresql`. `vecs` uses SQLAlchemy under the hood, which only supports `postgresql` as a dialect. +Click [**Connect**](/dashboard/project/_/?showConnect=true) at the top of any project page to get your connection string. + +Copy the URI from the **Shared pooler** option. diff --git a/apps/docs/content/guides/ai/quickstarts/face-similarity.mdx b/apps/docs/content/guides/ai/quickstarts/face-similarity.mdx index 1f4894d5867..6955ffa6919 100644 --- a/apps/docs/content/guides/ai/quickstarts/face-similarity.mdx +++ b/apps/docs/content/guides/ai/quickstarts/face-similarity.mdx @@ -40,7 +40,7 @@ DB_CONNECTION = "postgresql://:@:/" vx = vecs.create_client(DB_CONNECTION) ``` -Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true). +Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](/dashboard/project/_?showConnect=true). @@ -58,7 +58,7 @@ You must use the "connection pooling" string (domain ending in `*.pooler.supabas Now all that's left is to step through the notebook. You can do this by clicking the "execute" button (`ctrl+enter`) at the top left of each code cell. The notebook guides you through the process of creating a collection, adding data to it, and querying it. -You can view the inserted items in the [Table Editor](https://supabase.com/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. +You can view the inserted items in the [Table Editor](/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. ![Colab documents](/docs/img/ai/google-colab/colab-documents.png) diff --git a/apps/docs/content/guides/ai/quickstarts/hello-world.mdx b/apps/docs/content/guides/ai/quickstarts/hello-world.mdx index cbea52b2c55..5a711d43dca 100644 --- a/apps/docs/content/guides/ai/quickstarts/hello-world.mdx +++ b/apps/docs/content/guides/ai/quickstarts/hello-world.mdx @@ -41,7 +41,7 @@ DB_CONNECTION = "postgresql://:@:/" vx = vecs.create_client(DB_CONNECTION) ``` -Replace the `DB_CONNECTION` with your Session pooler connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true). +Replace the `DB_CONNECTION` with your Session pooler connection string. You can find the connection string on your project dashboard by clicking [Connect](/dashboard/project/_?showConnect=true). @@ -59,7 +59,7 @@ You must use the Session pooler connection string with Google Colab since Colab Now all that's left is to step through the notebook. You can do this by clicking the "execute" button (`ctrl+enter`) at the top left of each code cell. The notebook guides you through the process of creating a collection, adding data to it, and querying it. -You can view the inserted items in the [Table Editor](https://supabase.com/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. +You can view the inserted items in the [Table Editor](/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. ![Colab documents](/docs/img/ai/google-colab/colab-documents.png) diff --git a/apps/docs/content/guides/ai/quickstarts/text-deduplication.mdx b/apps/docs/content/guides/ai/quickstarts/text-deduplication.mdx index 34c183f08b0..9bb07c30b3d 100644 --- a/apps/docs/content/guides/ai/quickstarts/text-deduplication.mdx +++ b/apps/docs/content/guides/ai/quickstarts/text-deduplication.mdx @@ -41,7 +41,7 @@ DB_CONNECTION = "postgresql://:@:/" vx = vecs.create_client(DB_CONNECTION) ``` -Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true). +Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](/dashboard/project/_?showConnect=true). @@ -59,7 +59,7 @@ You must use the "connection pooling" string (domain ending in `*.pooler.supabas Now all that's left is to step through the notebook. You can do this by clicking the "execute" button (`ctrl+enter`) at the top left of each code cell. The notebook guides you through the process of creating a collection, adding data to it, and querying it. -You can view the inserted items in the [Table Editor](https://supabase.com/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. +You can view the inserted items in the [Table Editor](/dashboard/project/_/editor/), by selecting the `vecs` schema from the schema dropdown. ![Colab documents](/docs/img/ai/google-colab/colab-documents.png) diff --git a/apps/docs/content/guides/ai/rag-with-permissions.mdx b/apps/docs/content/guides/ai/rag-with-permissions.mdx index a2c86fdc8d9..20156f36c2e 100644 --- a/apps/docs/content/guides/ai/rag-with-permissions.mdx +++ b/apps/docs/content/guides/ai/rag-with-permissions.mdx @@ -113,13 +113,13 @@ You may have an existing system that stores users, documents, and their permissi -RLS is latency-sensitive, so extra caution should be taken before implementing this method. Use the [query plan analyzer](https://supabase.com/docs/guides/platform/performance#optimizing-poor-performing-queries) to measure execution times for your queries to ensure they are within expected ranges. For enterprise applications, contact enterprise@supabase.io. +RLS is latency-sensitive, so extra caution should be taken before implementing this method. Use the [query plan analyzer](/docs/guides/platform/performance#optimizing-poor-performing-queries) to measure execution times for your queries to ensure they are within expected ranges. For enterprise applications, contact enterprise@supabase.io. -For data sources other than Postgres, see [Foreign Data Wrappers](/docs/guides/database/extensions/wrappers/overview) for a list of external sources supported today. If your data lives in a source not provided in the list, contact [support](https://supabase.com/dashboard/support/new) and we'll be happy to discuss your use case. +For data sources other than Postgres, see [Foreign Data Wrappers](/docs/guides/database/extensions/wrappers/overview) for a list of external sources supported today. If your data lives in a source not provided in the list, contact [support](/dashboard/support/new) and we'll be happy to discuss your use case. @@ -189,7 +189,7 @@ Since we're managing users and authentication outside of Supabase, we have two o #### Direct Postgres connection -You can directly connect to your Supabase Postgres DB using the [connection info](/dashboard/project/_/database/settings) on your project's Database Settings page. To use RLS with this method, we use a custom session variable that contains the current user's ID: +You can directly connect to your Supabase Postgres DB using the [connection info](/dashboard/project/_/?showConnect=true) on a project page. To use RLS with this method, we use a custom session variable that contains the current user's ID: ```sql -- enable row level security @@ -271,4 +271,4 @@ order by document_sections.embedding <#> embedding; There are endless approaches to this problem based on the complexities of each system. Luckily Postgres comes with all the primitives needed to provide access control in the way that works best for your project. -If the examples above didn't fit your use case or you need to adjust them slightly to better fit your existing system, feel free to reach out to [support](https://supabase.com/dashboard/support/new) and we'll be happy to assist you. +If the examples above didn't fit your use case or you need to adjust them slightly to better fit your existing system, feel free to reach out to [support](/dashboard/support/new) and we'll be happy to assist you. diff --git a/apps/docs/content/guides/ai/vector-columns.mdx b/apps/docs/content/guides/ai/vector-columns.mdx index 3cc79905896..9767dfcc074 100644 --- a/apps/docs/content/guides/ai/vector-columns.mdx +++ b/apps/docs/content/guides/ai/vector-columns.mdx @@ -22,7 +22,7 @@ Vectors in Supabase are enabled via [pgvector](https://github.com/pgvector/pgvec > -1. Go to the [Database](https://supabase.com/dashboard/project/_/database/tables) page in the Dashboard. +1. Go to the [Database](/dashboard/project/_/database/tables) page in the Dashboard. 2. Click on **Extensions** in the sidebar. 3. Search for "vector" and enable the extension. @@ -63,7 +63,7 @@ In the above SQL snippet, we create a `documents` table with a column called `em -In general, embeddings with fewer dimensions perform best. See our [analysis on fewer dimensions in pgvector](https://supabase.com/blog/fewer-dimensions-are-better-pgvector). +In general, embeddings with fewer dimensions perform best. See our [analysis on fewer dimensions in pgvector](/blog/fewer-dimensions-are-better-pgvector). diff --git a/apps/docs/content/guides/ai/vector-indexes.mdx b/apps/docs/content/guides/ai/vector-indexes.mdx index 03883a0b5c9..93b4d303e73 100644 --- a/apps/docs/content/guides/ai/vector-indexes.mdx +++ b/apps/docs/content/guides/ai/vector-indexes.mdx @@ -14,7 +14,7 @@ Today `pgvector` supports two types of indexes: - [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) - [IVFFlat](/docs/guides/ai/vector-indexes/ivf-indexes) -In general we recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](https://supabase.com/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). +In general we recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). ## Distance operators diff --git a/apps/docs/content/guides/ai/vector-indexes/ivf-indexes.mdx b/apps/docs/content/guides/ai/vector-indexes/ivf-indexes.mdx index 3262a6c5843..61b9ae38f2b 100644 --- a/apps/docs/content/guides/ai/vector-indexes/ivf-indexes.mdx +++ b/apps/docs/content/guides/ai/vector-indexes/ivf-indexes.mdx @@ -14,7 +14,7 @@ Today `pgvector` supports two types of indexes: - [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) - [IVFFlat](/docs/guides/ai/vector-indexes/ivf-indexes) -In general we recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](https://supabase.com/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). If you have a special use case that requires IVFFlat instead, keep reading. +In general we recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). If you have a special use case that requires IVFFlat instead, keep reading. ## Usage diff --git a/apps/docs/content/guides/api.mdx b/apps/docs/content/guides/api.mdx index 250ec91050a..0f4c62d5743 100644 --- a/apps/docs/content/guides/api.mdx +++ b/apps/docs/content/guides/api.mdx @@ -43,4 +43,4 @@ Reference: ## API URL and keys -You can find the API URL and Keys in the [Dashboard](https://supabase.com/dashboard/project/_/settings/api-keys). +You can find the API URL and Keys in the [Dashboard](/dashboard/project/_/settings/api-keys). diff --git a/apps/docs/content/guides/api/creating-routes.mdx b/apps/docs/content/guides/api/creating-routes.mdx index 6ef1b30c0df..2e987ce1074 100644 --- a/apps/docs/content/guides/api/creating-routes.mdx +++ b/apps/docs/content/guides/api/creating-routes.mdx @@ -20,7 +20,7 @@ This creates a corresponding route `todos` which can accept `GET`, `POST`, `PATC > -1. Go to the [Table editor](https://supabase.com/dashboard/project/_/editor) page in the Dashboard. +1. Go to the [Table editor](/dashboard/project/_/editor) page in the Dashboard. 1. Click **New Table** and create a table with the name `todos`. 1. Click **Save**. 1. Click **New Column** and create a column with the name `task` and type `text`. @@ -52,7 +52,7 @@ create table Every Supabase project has a unique API URL. Your API is secured behind an API gateway which requires an API Key for every request. -1. Go to the [Settings](https://supabase.com/dashboard/project/_/settings/general) page in the Dashboard. +1. Go to the [Settings](/dashboard/project/_/settings/general) page in the Dashboard. 2. Click **API** in the sidebar. 3. Find your API `URL`, `anon`, and `service_role` keys on this page. diff --git a/apps/docs/content/guides/api/quickstart.mdx b/apps/docs/content/guides/api/quickstart.mdx index 432838a2aa8..81558335907 100644 --- a/apps/docs/content/guides/api/quickstart.mdx +++ b/apps/docs/content/guides/api/quickstart.mdx @@ -14,9 +14,9 @@ We'll create a database table called `todos` for storing tasks. This creates a c - [Create a new project](https://supabase.com/dashboard) in the Supabase Dashboard. + [Create a new project](/dashboard) in the Supabase Dashboard. - After your project is ready, create a table in your Supabase database. You can do this with either the Table interface or the [SQL Editor](https://supabase.com/dashboard/project/_/sql). + After your project is ready, create a table in your Supabase database. You can do this with either the Table interface or the [SQL Editor](/dashboard/project/_/sql). @@ -109,7 +109,7 @@ We'll create a database table called `todos` for storing tasks. This creates a c - Find your API URL and Keys in your Dashboard [API Settings](https://supabase.com/dashboard/project/_/settings/api). You can now query your "todos" table by appending `/rest/v1/todos` to the API URL. + Find your API URL and Keys in your Dashboard [API Settings](/dashboard/project/_/settings/api). You can now query your "todos" table by appending `/rest/v1/todos` to the API URL. Copy this block of code, substitute `` and ``, then run it from a terminal. diff --git a/apps/docs/content/guides/api/rest/auto-generated-docs.mdx b/apps/docs/content/guides/api/rest/auto-generated-docs.mdx index 7a26b6856b4..7357392b588 100644 --- a/apps/docs/content/guides/api/rest/auto-generated-docs.mdx +++ b/apps/docs/content/guides/api/rest/auto-generated-docs.mdx @@ -4,9 +4,9 @@ title: 'Auto-generated documentation' description: 'Supabase provides documentation that updates automatically.' --- -Supabase generates documentation in the [Dashboard](https://supabase.com/dashboard) which updates as you make database changes. +Supabase generates documentation in the [Dashboard](/dashboard) which updates as you make database changes. -1. Go to the [API](https://supabase.com/dashboard/project/_/api) page in the Dashboard. +1. Go to the [API](/dashboard/project/_/api) page in the Dashboard. 2. Select any table under **Tables and Views** in the sidebar. 3. Switch between the JavaScript and the cURL docs using the tabs. diff --git a/apps/docs/content/guides/api/rest/client-libs.mdx b/apps/docs/content/guides/api/rest/client-libs.mdx index 7a19ded8c01..a40cc247fb6 100644 --- a/apps/docs/content/guides/api/rest/client-libs.mdx +++ b/apps/docs/content/guides/api/rest/client-libs.mdx @@ -9,19 +9,19 @@ Supabase provides client libraries for the REST and Realtime APIs. Some librarie ## Official libraries -| `Language` | `Source Code` | `Documentation` | -| --------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| Javascript/Typescript | [supabase-js](https://github.com/supabase/supabase-js) | [Docs](https://supabase.com/docs/reference/javascript/introduction) | -| Dart/Flutter | [supabase-flutter](https://github.com/supabase/supabase-flutter/tree/main/packages/supabase_flutter) | [Docs](https://supabase.com/docs/reference/dart/introduction) | -| Swift | [supabase-swift](https://github.com/supabase/supabase-swift) | [Docs](https://supabase.com/docs/reference/swift/introduction) | -| Python | [supabase-py](https://github.com/supabase/supabase-py) | [Docs](https://supabase.com/docs/reference/python/initializing) | +| `Language` | `Source Code` | `Documentation` | +| --------------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| Javascript/Typescript | [supabase-js](https://github.com/supabase/supabase-js) | [Docs](/docs/reference/javascript/introduction) | +| Dart/Flutter | [supabase-flutter](https://github.com/supabase/supabase-flutter/tree/main/packages/supabase_flutter) | [Docs](/docs/reference/dart/introduction) | +| Swift | [supabase-swift](https://github.com/supabase/supabase-swift) | [Docs](/docs/reference/swift/introduction) | +| Python | [supabase-py](https://github.com/supabase/supabase-py) | [Docs](/docs/reference/python/initializing) | ## Community libraries -| `Language` | `Source Code` | `Documentation` | -| ----------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| C# | [supabase-csharp](https://github.com/supabase-community/supabase-csharp) | [Docs](https://supabase.com/docs/reference/csharp/introduction) | -| Go | [supabase-go](https://github.com/supabase-community/supabase-go) | | -| Kotlin | [supabase-kt](https://github.com/supabase-community/supabase-kt) | [Docs](https://supabase.com/docs/reference/kotlin/introduction) | -| Ruby | [supabase-rb](https://github.com/supabase-community/supabase-rb) | | -| Godot Engine (GDScript) | [supabase-gdscript](https://github.com/supabase-community/godot-engine.supabase) | | +| `Language` | `Source Code` | `Documentation` | +| ----------------------- | -------------------------------------------------------------------------------- | ------------------------------------------- | +| C# | [supabase-csharp](https://github.com/supabase-community/supabase-csharp) | [Docs](/docs/reference/csharp/introduction) | +| Go | [supabase-go](https://github.com/supabase-community/supabase-go) | | +| Kotlin | [supabase-kt](https://github.com/supabase-community/supabase-kt) | [Docs](/docs/reference/kotlin/introduction) | +| Ruby | [supabase-rb](https://github.com/supabase-community/supabase-rb) | | +| Godot Engine (GDScript) | [supabase-gdscript](https://github.com/supabase-community/godot-engine.supabase) | | diff --git a/apps/docs/content/guides/api/rest/generating-types.mdx b/apps/docs/content/guides/api/rest/generating-types.mdx index d74f2ce603b..3f10c9dee37 100644 --- a/apps/docs/content/guides/api/rest/generating-types.mdx +++ b/apps/docs/content/guides/api/rest/generating-types.mdx @@ -10,7 +10,7 @@ Supabase APIs are generated from your database, which means that we can use data ## Generating types from project dashboard -Supabase allows you to generate and download TypeScript types directly from the [project dashboard](https://supabase.com/dashboard/project/_/api?page=tables-intro). +Supabase allows you to generate and download TypeScript types directly from the [project dashboard](/dashboard/project/_/api?page=tables-intro). ## Generating types using Supabase CLI diff --git a/apps/docs/content/guides/api/using-custom-schemas.mdx b/apps/docs/content/guides/api/using-custom-schemas.mdx index 55af9da01d2..ed14471b84d 100644 --- a/apps/docs/content/guides/api/using-custom-schemas.mdx +++ b/apps/docs/content/guides/api/using-custom-schemas.mdx @@ -18,7 +18,7 @@ CREATE SCHEMA myschema; You can expose custom database schemas - to do so you need to follow these steps: -1. Go to [API settings](https://supabase.com/dashboard/project/_/settings/api) and add your custom schema to "Exposed schemas". +1. Go to [API settings](/dashboard/project/_/settings/api) and add your custom schema to "Exposed schemas". 2. Run the following SQL, substituting `myschema` with your schema name: ```sql diff --git a/apps/docs/content/guides/auth/audit-logs.mdx b/apps/docs/content/guides/auth/audit-logs.mdx new file mode 100644 index 00000000000..69456d59614 --- /dev/null +++ b/apps/docs/content/guides/auth/audit-logs.mdx @@ -0,0 +1,90 @@ +--- +id: 'auth-audit-logs' +title: 'Auth Audit Logs' +description: 'Monitor and track authentication events with audit logging.' +subtitle: 'Monitor and track authentication events with audit logging.' +--- + +Auth audit logs provide comprehensive tracking of authentication events in your Supabase project. Audit logs are automatically captured for all authentication events and help you monitor user authentication activities, detect suspicious behavior, and maintain compliance with security requirements. + +## What gets logged + +Supabase auth audit logs automatically capture all authentication events including: + +- User signups and logins +- Password changes and resets +- Email verification events +- Token refresh and logout events + +## Storage options + +By default, audit logs are stored in two places: + +1. **Your project's Postgres database** - Stored in the `auth.audit_log_entries` table, searchable via SQL but uses database storage +2. **External log storage** - Cost-efficient storage accessible through the dashboard + +You can disable Postgres storage to reduce database storage costs while keeping the external log storage. + +### Configuring audit log storage + +1. Navigate to your project dashboard +2. Go to **Authentication** +3. Find the **Audit Logs** under **Configuration** section +4. Toggle on "Disable writing auth audit logs to project database" to disable database storage + + + +Disabling Postgres storage reduces your database storage costs. Audit logs will still be available through the dashboard. + + + +## Log format + +Audit logs contain detailed information about each authentication event: + +```json +{ + "timestamp": "2025-08-01T10:30:00Z", + "user_id": "uuid", + "action": "user_signedup", + "ip_address": "192.168.1.1", + "user_agent": "Mozilla/5.0...", + "metadata": { + "provider": "email" + } +} +``` + +### Log actions reference + +| Action | Description | +| ------------------------------- | --------------------------------------- | +| `login` | User login attempt | +| `logout` | User logout | +| `invite_accepted` | Team invitation accepted | +| `user_signedup` | New user registration | +| `user_invited` | User invitation sent | +| `user_deleted` | User account deleted | +| `user_modified` | User profile updated | +| `user_recovery_requested` | Password reset request | +| `user_reauthenticate_requested` | User reauthentication required | +| `user_confirmation_requested` | Email/phone confirmation requested | +| `user_repeated_signup` | Duplicate signup attempt | +| `user_updated_password` | Password change completed | +| `token_revoked` | Refresh token revoked | +| `token_refreshed` | Refresh token used to obtain new tokens | +| `generate_recovery_codes` | MFA recovery codes generated | +| `factor_in_progress` | MFA factor enrollment started | +| `factor_unenrolled` | MFA factor removed | +| `challenge_created` | MFA challenge initiated | +| `verification_attempted` | MFA verification attempt | +| `factor_deleted` | MFA factor deleted | +| `recovery_codes_deleted` | MFA recovery codes deleted | +| `factor_updated` | MFA factor settings updated | +| `mfa_code_login` | Login with MFA code | +| `identity_unlinked` | An identity unlinked from account | + +## Limitations + +- There may be a short delay before logs appear +- Query capabilities are limited to the dashboard interface diff --git a/apps/docs/content/guides/auth/auth-anonymous.mdx b/apps/docs/content/guides/auth/auth-anonymous.mdx index f6c16268b0f..5a32482cefe 100644 --- a/apps/docs/content/guides/auth/auth-anonymous.mdx +++ b/apps/docs/content/guides/auth/auth-anonymous.mdx @@ -112,7 +112,7 @@ response = supabase.auth.sign_in_anonymously() ## Convert an anonymous user to a permanent user -Converting an anonymous user to a permanent user requires [linking an identity](/docs/guides/auth/auth-identity-linking#manual-linking-beta) to the user. This requires you to [enable manual linking](/dashboard/project/_/settings/auth) in your Supabase project. +Converting an anonymous user to a permanent user requires [linking an identity](/docs/guides/auth/auth-identity-linking#manual-linking-beta) to the user. This requires you to [enable manual linking](/dashboard/project/_/auth/providers) in your Supabase project. ### Link an email / phone identity diff --git a/apps/docs/content/guides/auth/auth-captcha.mdx b/apps/docs/content/guides/auth/auth-captcha.mdx index 9d5e8c99dab..bc832cf0cb8 100644 --- a/apps/docs/content/guides/auth/auth-captcha.mdx +++ b/apps/docs/content/guides/auth/auth-captcha.mdx @@ -41,7 +41,7 @@ In the Settings page, look for the **Sitekey** section and copy the key. ## Enable CAPTCHA protection for your Supabase project -Navigate to the **[Auth](https://supabase.com/dashboard/project/_/settings/auth)** section of your Project Settings in the Supabase Dashboard and find the **Enable CAPTCHA protection** toggle under Settings > Authentication > Bot and Abuse Protection > Enable CAPTCHA protection. +Navigate to the **[Auth](/dashboard/project/_/auth/protection)** section of your Project Settings in the Supabase Dashboard and find the **Enable CAPTCHA protection** toggle under Settings > Authentication > Bot and Abuse Protection > Enable CAPTCHA protection. Select your CAPTCHA provider from the dropdown, enter your CAPTCHA **Secret key**, and click **Save**. diff --git a/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx b/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx index bda36fa1ae0..810e447bb2c 100644 --- a/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx @@ -9,7 +9,7 @@ sitemapPriority: 0.5 As of 7th Feb 2024, [this repository](https://github.com/supabase-community/auth-ui) is no longer maintained by the Supabase Team. At the moment, the team does not have capacity to give the expected level of care to this repository. We may revisit Auth UI in the future but regrettably have to leave it on hold for now as we focus on other priorities such as improving the Server-Side Rendering (SSR) package and advanced Auth primitives. -As an alternative you can use the [Supabase UI Library](https://supabase.com/ui) which has auth ready blocks to use in your projects. +As an alternative you can use the [Supabase UI Library](/ui) which has auth ready blocks to use in your projects. diff --git a/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx b/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx index 7e276930bb8..cae3db4e57b 100644 --- a/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx @@ -53,7 +53,7 @@ npm install @supabase/auth-helpers-react ## Set up environment variables -Retrieve your project URL and anon key in your project's [API settings](https://supabase.com/dashboard/project/_/settings/api) in the Dashboard to set up the following environment variables. For local development you can set them in a `.env.local` file. See an [example](https://github.com/supabase/auth-helpers/blob/main/examples/nextjs/.env.local.example). +Retrieve your project URL and anon key in your project's [API settings](/dashboard/project/_/settings/api) in the Dashboard to set up the following environment variables. For local development you can set them in a `.env.local` file. See an [example](https://github.com/supabase/auth-helpers/blob/main/examples/nextjs/.env.local.example). ```bash .env.local NEXT_PUBLIC_SUPABASE_URL=your-supabase-url @@ -132,7 +132,7 @@ You can now determine if a user is authenticated by checking that the `user` obj ### Code Exchange API route -The `Code Exchange` API route is required for the [server-side auth flow](https://supabase.com/docs/guides/auth/server-side-rendering) implemented by the Next.js Auth Helpers. It exchanges an auth `code` for the user's `session`, which is set as a cookie for future requests made to Supabase. +The `Code Exchange` API route is required for the [server-side auth flow](/docs/guides/auth/server-side-rendering) implemented by the Next.js Auth Helpers. It exchanges an auth `code` for the user's `session`, which is set as a cookie for future requests made to Supabase. -Ensure you have [enabled replication](https://supabase.com/dashboard/project/_/database/publications) on the table you are subscribing to. +Ensure you have [enabled replication](/dashboard/project/_/database/publications) on the table you are subscribing to. diff --git a/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx b/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx index c518caeba91..5b96f99bcc0 100644 --- a/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx @@ -40,7 +40,7 @@ npm install @supabase/auth-helpers-sveltekit @supabase/supabase-js ### Declare environment variables -Retrieve your project's URL and anon key from your [API settings](https://supabase.com/dashboard/project/_/settings/api), and create a `.env.local` file with the following environment variables: +Retrieve your project's URL and anon key from your [API settings](/dashboard/project/_/settings/api), and create a `.env.local` file with the following environment variables: ```bash .env.local # Find these in your Supabase project settings https://supabase.com/dashboard/project/_/settings/api @@ -161,7 +161,7 @@ Note that we are specifying `filterSerializedResponseHeaders` here. We need to t ### Code Exchange route -The `Code Exchange` route is required for the [server-side auth flow](https://supabase.com/docs/guides/auth/server-side-rendering) implemented by the SvelteKit Auth Helpers. It exchanges an auth `code` for the user's `session`, which is set as a cookie for future requests made to Supabase. +The `Code Exchange` route is required for the [server-side auth flow](/docs/guides/auth/server-side-rendering) implemented by the SvelteKit Auth Helpers. It exchanges an auth `code` for the user's `session`, which is set as a cookie for future requests made to Supabase. { ### Generate types from your database -In order to get the most out of TypeScript and its IntelliSense, you should import the generated Database types into the `app.d.ts` type definition file that comes with your SvelteKit project, where `import('./DatabaseDefinitions')` points to the generated types file outlined in [v2 docs here](https://supabase.com/docs/reference/javascript/release-notes#typescript-support) after you have logged in, linked, and generated types through the Supabase CLI. +In order to get the most out of TypeScript and its IntelliSense, you should import the generated Database types into the `app.d.ts` type definition file that comes with your SvelteKit project, where `import('./DatabaseDefinitions')` points to the generated types file outlined in [v2 docs here](/docs/reference/javascript/release-notes#typescript-support) after you have logged in, linked, and generated types through the Supabase CLI. ```ts src/app.d.ts // src/app.d.ts @@ -368,7 +368,7 @@ export const load = async ({ fetch, data, depends }) => { -TypeScript types can be [generated with the Supabase CLI](https://supabase.com/docs/reference/javascript/typescript-support) and passed to `createSupabaseLoadClient` to add type support to the Supabase client. +TypeScript types can be [generated with the Supabase CLI](/docs/reference/javascript/typescript-support) and passed to `createSupabaseLoadClient` to add type support to the Supabase client. @@ -785,7 +785,7 @@ export const handle: Handle = sequence(supabase, authorization) ### Client-side data fetching with RLS -For [row level security](https://supabase.com/docs/guides/database/postgres/row-level-security) to work properly when fetching data client-side, you need to use `supabaseClient` from `PageData` and only run your query once the session is defined client-side: +For [row level security](/docs/guides/database/postgres/row-level-security) to work properly when fetching data client-side, you need to use `supabaseClient` from `PageData` and only run your query once the session is defined client-side: ```svelte src/routes/+page.svelte