mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 02:15:05 +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>
51 lines
1.5 KiB
Plaintext
51 lines
1.5 KiB
Plaintext
---
|
|
title: Realtime Avatar Stack
|
|
description: Avatar stack in realtime
|
|
---
|
|
|
|
<BlockPreview name="realtime-avatar-stack-demo" />
|
|
|
|
## Installation
|
|
|
|
<BlockItem
|
|
name="realtime-avatar-stack-nuxtjs"
|
|
description="Renders a stack of avatars which are connected via Supabase Realtime"
|
|
framework="vue"
|
|
/>
|
|
|
|
## Folder structure
|
|
|
|
This block assumes that you have already installed a Supabase client for Nuxt from the previous step.
|
|
|
|
<RegistryBlock itemName="realtime-avatar-stack-nuxtjs" />
|
|
|
|
## Usage
|
|
|
|
The `RealtimeAvatarStack` component renders stacked avatars which are connected to Supabase Realtime. It uses the Presence feature of Supabase Realtime. You can use this to show currently online users in a chatroom, game session or collaborative app.
|
|
|
|
```vue
|
|
<script setup lang="ts">
|
|
// Assumes you have Header component created
|
|
import Header from '@/components/Header.vue'
|
|
import RealtimeAvatarStack from '@/components/RealtimeAvatarStack.vue'
|
|
</script>
|
|
|
|
<template>
|
|
<Header class="flex items-center justify-between">
|
|
<h1>Lumon Industries</h1>
|
|
<RealtimeAvatarStack roomName="break_room" />
|
|
</Header>
|
|
</template>
|
|
```
|
|
|
|
## Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
| ---------- | -------- | ------- | ---------------------------------------------------- |
|
|
| `roomName` | `string` | `null` | The name of the Supabase Realtime room to connect to |
|
|
|
|
## Further reading
|
|
|
|
- [Realtime Presence](https://supabase.com/docs/guides/realtime/presence)
|
|
- [Realtime authorization](https://supabase.com/docs/guides/realtime/authorization)
|