mirror of
https://github.com/supabase/supabase.git
synced 2026-10-11 04:15:04 +03:00
abbac3b852
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Refactor, bug fix. Part 1 of 6 in a stack that splits the library redesign into reviewable pieces. This one is the foundation the rest build on and has no visual change. ## What is the current behavior? Three build steps each reimplement "where does this registry file land in the user's project": `process-registry`'s `getDefaultPath`, `registry/utils`' `uniqBy` on `file.path`, and the Markdown exporter. They disagree, which produces real bugs: - A Vue block whose files come from `node_modules/@supabase/vue-blocks/` keeps its package path, so the installer writes the package folder into the user's project. - `registryItemAppend` builds its `docs` string from `(item.docs, items.flatMap(...))` — a comma expression, so the item's own docs are discarded. - A name collision between a block file and its client's file silently keeps one of the two. - Install commands guess the CLI family from substrings in the item name, so `infinite-query-composable` — a Vue block with neither "vue" nor "nuxtjs" in its name — gets the React CLI. - Production Vue installs use `@supabase/<name>`, but the `@supabase` namespace is registered with shadcn, not shadcn-vue. - `build:registry`, `build:content`, `build:markdown` and `build:llms` run in parallel, but the last three read `public/r`. ## What is the new behavior? `lib/registry-resolution.ts` owns installed-path derivation, first-party dependency naming, deduplication, and cycle detection, and every consumer calls it. `build-registry` validates the whole registry against shadcn's schema and resolves every item, so a broken reference fails the build instead of shipping. `clean-registry` throws rather than logging past a failure. Pages declare their install `framework` explicitly instead of it being inferred, and production Vue installs use the absolute registry URL. The build steps are serialized behind `build:prepare`, and a new `library-tests.yml` workflow runs the library's tests, checks the generated registry is committed, and builds the app. ## Additional context Regenerated registry artifacts are the mechanical result of the resolution fix — the Vue client items and the OAuth consent items that gained their client's docs. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added explicit React and Vue framework selection for library blocks and installation commands. * Improved registry resolution, dependency handling, path validation, and Vue file normalization. * Added support for reliable local, preview, and production registry URLs. * **Documentation** * Updated Vue and Nuxt installation documentation to identify the Vue framework explicitly. * **Bug Fixes** * Preserved combined documentation and validated generated registry content more consistently. * **Tests** * Added coverage for installation commands, registry resolution, dependency handling, and generated artifacts. * **Chores** * Added automated pull-request checks for library tests and builds. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
66 lines
2.9 KiB
Plaintext
66 lines
2.9 KiB
Plaintext
---
|
||
title: Social Authentication
|
||
description: Social authentication block for Nuxt.js
|
||
---
|
||
|
||
<BlockPreview name="social-auth/auth/login" />
|
||
|
||
<Callout className="mt-4">
|
||
The block is using Github provider by default, but can be easily switched by changing a single
|
||
parameter.
|
||
</Callout>
|
||
|
||
## Installation
|
||
|
||
<BlockItem
|
||
name="social-auth-nuxtjs"
|
||
description="All needed components for the social auth flow"
|
||
framework="vue"
|
||
/>
|
||
|
||
## Folder structure
|
||
|
||
This block assumes that you have already installed a Supabase client for Nuxt from the previous step.
|
||
|
||
<RegistryBlock itemName="social-auth-nuxtjs" />
|
||
|
||
## Usage
|
||
|
||
Once you install the block in your Nuxt.js project, you'll get all the necessary pages and components to set up a social authentication flow.
|
||
|
||
### Getting started
|
||
|
||
After installing the block, you'll have the following environment variables in your `.env.local` file:
|
||
|
||
```env
|
||
NUXT_PUBLIC_SUPABASE_URL=
|
||
NUXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=
|
||
```
|
||
|
||
- If you're using supabase.com, you can find these values in the [Connect modal](https://supabase.com/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=nuxtjs&using=supabasejs) under App Frameworks or in your project's [API settings](https://supabase.com/dashboard/project/_/settings/api).
|
||
|
||
- If you're using a local instance of Supabase, you can find these values by running `supabase start` or `supabase status` (if you already have it running).
|
||
|
||
### Setting up third party providers
|
||
|
||
We support a wide variety of social providers that you can use to integrate with your application. The full list is available [here](https://supabase.com/docs/guides/auth/social-login).
|
||
This block uses the PKCE flow with GitHub as the provider. To switch providers, just update the `provider` field in the `supabase.auth.signInWithOAuth` call. Enable the provider you want to use under [Auth Providers](https://supabase.com/dashboard/project/_/auth/providers) in the Supabase Dashboard and add the necessary credentials.
|
||
|
||
### Setting up routes and redirect URLs
|
||
|
||
1. Set the site URL in the [URL Configuration](https://supabase.com/dashboard/project/_/auth/url-configuration) settings in the Supabase Dashboard.
|
||
1. Update the redirect paths in `login-form.vue` to point to your app’s logged-in routes. Our examples use `/protected`, but you can set this to whatever fits your app.
|
||
1. Visit `http://your-site-url/auth/login` to see this component in action.
|
||
|
||
### Combining social auth with password-based auth
|
||
|
||
If you want to combine this block with the password-based auth, you need to:
|
||
|
||
- Copy the `handleSocialLogin` function into the password-based `login-form.vue` component and bind it to a "Login with ..." button.
|
||
- Copy the `@/server/routes/auth/oauth.ts` in your app under the same route.
|
||
|
||
## Further reading
|
||
|
||
- [Social login](https://supabase.com/docs/guides/auth/social-login)
|
||
- [Authentication error codes](https://supabase.com/docs/guides/auth/debugging/error-codes)
|