From c36af994c2fff3a348130a2a73c15f9732cdcc50 Mon Sep 17 00:00:00 2001 From: Katerina Skroumpelou Date: Wed, 15 Oct 2025 14:50:14 +0300 Subject: [PATCH 1/3] docs(repo): change client libraries references to sdk --- .github/workflows/docs.yml | 14 ++++----- CONTRIBUTING.md | 2 +- README.md | 40 ++++++++++++------------- WARP.md | 20 ++++++------- docs/MIGRATION.md | 4 +-- packages/core/auth-js/README.md | 2 +- packages/core/auth-js/package.json | 2 +- packages/core/functions-js/README.md | 2 +- packages/core/functions-js/package.json | 2 +- packages/core/postgrest-js/README.md | 2 +- packages/core/realtime-js/README.md | 4 +-- packages/core/storage-js/README.md | 4 +-- packages/core/supabase-js/README.md | 2 +- packages/core/supabase-js/package.json | 2 +- 14 files changed, 51 insertions(+), 51 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e64426145..89ad6d4b9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -100,33 +100,33 @@ jobs:

Supabase JavaScript Libraries - API Documentation

-

TypeScript/JavaScript API documentation for all Supabase client libraries.

+

TypeScript/JavaScript API documentation for all Supabase JS SDKs.

Available Documentation:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4e1ee3bf..6f7fe73d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Supabase JS Libraries -Thank you for your interest in contributing to the Supabase JavaScript client libraries! This guide will help you get started with contributing to the Supabase JS monorepo. +Thank you for your interest in contributing to the Supabase JavaScript SDK! This guide will help you get started with contributing to the Supabase JS monorepo. > **Repository Structure Changed:** This repository has been restructured as a monorepo. **All libraries, including `supabase-js`, are now under `packages/core/`**. If you previously contributed to `supabase-js`, `auth-js`, `postgrest-js`, `realtime-js`, `storage-js`, or `functions-js`, please read our **[Migration Guide](docs/MIGRATION.md)** to understand: > diff --git a/README.md b/README.md index 1f80d390b..efc11fc26 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ -

Supabase JS Client Libraries

+

Supabase JS SDK

Guides @@ -36,16 +36,16 @@ ## ๐Ÿ“ฆ Libraries -This monorepo contains the complete suite of Supabase JavaScript client libraries: +This monorepo contains the complete suite of Supabase JavaScript SDK: | Library | Description | | ---------------------------------------------------------- | ---------------------------------------- | -| **[@supabase/supabase-js](./packages/core/supabase-js)** | Main isomorphic client for Supabase | -| **[@supabase/auth-js](./packages/core/auth-js)** | Authentication client | -| **[@supabase/postgrest-js](./packages/core/postgrest-js)** | PostgREST client for database operations | -| **[@supabase/realtime-js](./packages/core/realtime-js)** | Real-time subscriptions client | -| **[@supabase/storage-js](./packages/core/storage-js)** | File storage client | -| **[@supabase/functions-js](./packages/core/functions-js)** | Edge Functions client | +| **[@supabase/supabase-js](./packages/core/supabase-js)** | Main isomorphic sdk for Supabase | +| **[@supabase/auth-js](./packages/core/auth-js)** | Authentication sdk | +| **[@supabase/postgrest-js](./packages/core/postgrest-js)** | PostgREST sdk for database operations | +| **[@supabase/realtime-js](./packages/core/realtime-js)** | Real-time subscriptions sdk | +| **[@supabase/storage-js](./packages/core/storage-js)** | File storage sdk | +| **[@supabase/functions-js](./packages/core/functions-js)** | Edge Functions sdk | > **๐Ÿ’ก Note for Package Users:** If you install and use these packages, **nothing has changed**. Continue installing packages normally: > @@ -147,12 +147,12 @@ npx nx test --coverage ### API Documentation -- **[Auth Client](./packages/core/auth-js/README.md)** - Authentication and user management -- **[Database Client](./packages/core/postgrest-js/README.md)** - Database queries and operations -- **[Realtime Client](./packages/core/realtime-js/README.md)** - Real-time subscriptions -- **[Storage Client](./packages/core/storage-js/README.md)** - File upload and management -- **[Functions Client](./packages/core/functions-js/README.md)** - Edge Functions invocation -- **[Main Client](./packages/core/supabase-js/README.md)** - Combined client library +- **[Auth sdk](./packages/core/auth-js/README.md)** - Authentication and user management +- **[Database sdk](./packages/core/postgrest-js/README.md)** - Database queries and operations +- **[Realtime sdk](./packages/core/realtime-js/README.md)** - Real-time subscriptions +- **[Storage sdk](./packages/core/storage-js/README.md)** - File upload and management +- **[Functions sdk](./packages/core/functions-js/README.md)** - Edge Functions invocation +- **[Main sdk](./packages/core/supabase-js/README.md)** - Combined sdk ### Architecture Documentation @@ -194,12 +194,12 @@ Because provenance attestations are a new capability, security features may evol supabase-js/ โ”œโ”€โ”€ packages/ โ”‚ โ””โ”€โ”€ core/ # Published libraries -โ”‚ โ”œโ”€โ”€ auth-js/ # Authentication client -โ”‚ โ”œโ”€โ”€ functions-js/ # Edge Functions client -โ”‚ โ”œโ”€โ”€ postgrest-js/ # PostgREST database client -โ”‚ โ”œโ”€โ”€ realtime-js/ # Real-time subscriptions client -โ”‚ โ”œโ”€โ”€ storage-js/ # File storage client -โ”‚ โ””โ”€โ”€ supabase-js/ # Main isomorphic client +โ”‚ โ”œโ”€โ”€ auth-js/ # Authentication sdk +โ”‚ โ”œโ”€โ”€ functions-js/ # Edge Functions sdk +โ”‚ โ”œโ”€โ”€ postgrest-js/ # PostgREST database sdk +โ”‚ โ”œโ”€โ”€ realtime-js/ # Real-time subscriptions sdk +โ”‚ โ”œโ”€โ”€ storage-js/ # File storage sdk +โ”‚ โ””โ”€โ”€ supabase-js/ # Main isomorphic sdk โ”œโ”€โ”€ nx.json # npx nx workspace configuration โ”œโ”€โ”€ package.json # Root package.json and workspaces setup โ””โ”€โ”€ ... diff --git a/WARP.md b/WARP.md index d20f92eac..28d6dd868 100644 --- a/WARP.md +++ b/WARP.md @@ -4,7 +4,7 @@ This file provides guidance to WARP (warp.dev) when working with code in this re ## Repository Overview -This is a unified Nx monorepo consolidating all Supabase JavaScript client libraries, built with Nx for optimal developer experience and maintainability. This strategic migration from 6 separate repositories addresses critical maintenance overhead, dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers. +This is a unified Nx monorepo consolidating all Supabase JavaScript SDKs, built with Nx for optimal developer experience and maintainability. This strategic migration from 6 separate repositories addresses critical maintenance overhead, dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers. > **๐Ÿ“š Key Documentation**: For comprehensive guides, see: > @@ -46,12 +46,12 @@ This monorepo replaces the following individual repositories: ```text supabase-js/ โ”œโ”€โ”€ packages/core/ # Published libraries -โ”‚ โ”œโ”€โ”€ supabase-js/ # Main isomorphic client for Supabase (@supabase/supabase-js) -โ”‚ โ”œโ”€โ”€ auth-js/ # Authentication client (@supabase/auth-js) -โ”‚ โ”œโ”€โ”€ postgrest-js/ # PostgREST client for database operations (@supabase/postgrest-js) -โ”‚ โ”œโ”€โ”€ realtime-js/ # Real-time subscriptions client (@supabase/realtime-js) -โ”‚ โ”œโ”€โ”€ storage-js/ # File storage client (@supabase/storage-js) -โ”‚ โ””โ”€โ”€ functions-js/ # Edge Functions client (@supabase/functions-js) +โ”‚ โ”œโ”€โ”€ supabase-js/ # Main isomorphic SDK for Supabase (@supabase/supabase-js) +โ”‚ โ”œโ”€โ”€ auth-js/ # Authentication SDK (@supabase/auth-js) +โ”‚ โ”œโ”€โ”€ postgrest-js/ # PostgREST SDK for database operations (@supabase/postgrest-js) +โ”‚ โ”œโ”€โ”€ realtime-js/ # Real-time subscriptions SDK (@supabase/realtime-js) +โ”‚ โ”œโ”€โ”€ storage-js/ # File storage SDK (@supabase/storage-js) +โ”‚ โ””โ”€โ”€ functions-js/ # Edge Functions SDK (@supabase/functions-js) โ”œโ”€โ”€ docs/ # Documentation guides โ”‚ โ”œโ”€โ”€ CONTRIBUTING.md # Contribution guidelines โ”‚ โ”œโ”€โ”€ TESTING.md # Testing guide @@ -172,7 +172,7 @@ Each library has its own testing infrastructure. See the [TESTING.md](docs/TESTI ### Core Architecture -The main `@supabase/supabase-js` package aggregates all individual client libraries: +The main `@supabase/supabase-js` package aggregates all individual SDKs: - **auth-js**: Handles authentication and user management - **postgrest-js**: Provides database query capabilities via PostgREST @@ -180,7 +180,7 @@ The main `@supabase/supabase-js` package aggregates all individual client librar - **storage-js**: Handles file uploads and storage operations - **functions-js**: Invokes Supabase Edge Functions -Each library is designed to work independently but integrates seamlessly when used together through the main client. +Each library is designed to work independently but integrates seamlessly when used together through the main SDK. ### Development Infrastructure @@ -259,7 +259,7 @@ nx affected --target=test | Library | Docker Required | Primary Use Case | | ------------ | --------------- | -------------------------- | -| supabase-js | โŒ No | Main isomorphic client | +| supabase-js | โŒ No | Main isomorphic SDK | | auth-js | โœ… Yes | Authentication & user mgmt | | postgrest-js | โœ… Yes | Database queries | | realtime-js | โŒ No | Real-time subscriptions | diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md index ae0a9936d..9c867a427 100644 --- a/docs/MIGRATION.md +++ b/docs/MIGRATION.md @@ -98,7 +98,7 @@ This guide is for contributors who need to understand where code moved and how t ## Why We Migrated -We converted the `supabase-js` repository into a monorepo and absorbed the other js client libraries to solve several challenges: +We converted the `supabase-js` repository into a monorepo and absorbed the other js SDKs to solve several challenges: ### Problems with Separate Repos @@ -134,7 +134,7 @@ github.com/supabase/storage-js github.com/supabase/functions-js ``` -**After:** The Supabase JS monorepo (absorbed all client libraries) +**After:** The Supabase JS monorepo (absorbed all SDKs) ```tree github.com/supabase/supabase-js diff --git a/packages/core/auth-js/README.md b/packages/core/auth-js/README.md index ac918e44a..724c583c7 100644 --- a/packages/core/auth-js/README.md +++ b/packages/core/auth-js/README.md @@ -1,6 +1,6 @@ # `auth-js` -An isomorphic JavaScript client library for the [Supabase Auth](https://github.com/supabase/auth) API. +An isomorphic JavaScript SDK for the [Supabase Auth](https://github.com/supabase/auth) API.

diff --git a/packages/core/auth-js/package.json b/packages/core/auth-js/package.json index 90a901a2e..f7cad7d88 100644 --- a/packages/core/auth-js/package.json +++ b/packages/core/auth-js/package.json @@ -2,7 +2,7 @@ "name": "@supabase/auth-js", "version": "0.0.0", "private": false, - "description": "Official client library for Supabase Auth", + "description": "Official SDK for Supabase Auth", "keywords": [ "auth", "supabase", diff --git a/packages/core/functions-js/README.md b/packages/core/functions-js/README.md index d8d17a9dd..5b057b760 100644 --- a/packages/core/functions-js/README.md +++ b/packages/core/functions-js/README.md @@ -6,7 +6,7 @@
-JS Client library to interact with Supabase Functions. +JS SDK to interact with Supabase Functions. ## Docs diff --git a/packages/core/functions-js/package.json b/packages/core/functions-js/package.json index b39b66d95..6a92d2220 100644 --- a/packages/core/functions-js/package.json +++ b/packages/core/functions-js/package.json @@ -1,7 +1,7 @@ { "name": "@supabase/functions-js", "version": "0.0.0-automated", - "description": "JS Client library to interact with Supabase Functions.", + "description": "JS SDK to interact with Supabase Functions.", "main": "dist/main/index.js", "module": "dist/module/index.js", "types": "dist/module/index.d.ts", diff --git a/packages/core/postgrest-js/README.md b/packages/core/postgrest-js/README.md index 61b094c5d..1fb6413b1 100644 --- a/packages/core/postgrest-js/README.md +++ b/packages/core/postgrest-js/README.md @@ -5,7 +5,7 @@ [![License: MIT](https://img.shields.io/npm/l/@supabase/postgrest-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js) -Isomorphic JavaScript client for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface. +Isomorphic JavaScript SDK for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface. Full documentation can be found [here](https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json). diff --git a/packages/core/realtime-js/README.md b/packages/core/realtime-js/README.md index c2a3fb152..0d0eb80dd 100755 --- a/packages/core/realtime-js/README.md +++ b/packages/core/realtime-js/README.md @@ -8,7 +8,7 @@ -

Supabase Realtime Client

+

Supabase Realtime SDK

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

@@ -29,7 +29,7 @@ # Overview -This client enables you to use the following Supabase Realtime's features: +This SDK enables you to use the following Supabase Realtime's features: - **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users. - **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage. diff --git a/packages/core/storage-js/README.md b/packages/core/storage-js/README.md index 4eda3e826..f71461e12 100644 --- a/packages/core/storage-js/README.md +++ b/packages/core/storage-js/README.md @@ -6,7 +6,7 @@ -JS Client library to interact with Supabase Storage. +JS SDK to interact with Supabase Storage. - Documentation: https://supabase.io/docs/reference/javascript/storage-createbucket - Typedoc: https://supabase.github.io/supabase-js/storage-js/v2/spec.json @@ -393,7 +393,7 @@ The test infrastructure (`infra/docker-compose.yml`) includes: #### What About Supabase CLI? -**No**, you don't need `supabase start` or a regular Supabase instance for these tests. The storage-js tests use their own specialized Docker setup that's lighter and focused specifically on testing the storage client library. This test infrastructure: +**No**, you don't need `supabase start` or a regular Supabase instance for these tests. The storage-js tests use their own specialized Docker setup that's lighter and focused specifically on testing the storage SDK. This test infrastructure: - Is completely independent from any Supabase CLI projects - Uses fixed test authentication keys diff --git a/packages/core/supabase-js/README.md b/packages/core/supabase-js/README.md index 7a42087b4..39623962b 100644 --- a/packages/core/supabase-js/README.md +++ b/packages/core/supabase-js/README.md @@ -1,4 +1,4 @@ -# `supabase-js` - Isomorphic JavaScript Client for Supabase. +# `supabase-js` - Isomorphic JavaScript SDK for Supabase. - **Documentation:** https://supabase.com/docs/reference/javascript/start - TypeDoc: https://supabase.github.io/supabase-js/supabase-js/v2/spec.json diff --git a/packages/core/supabase-js/package.json b/packages/core/supabase-js/package.json index 1727c69fc..e2c584be7 100644 --- a/packages/core/supabase-js/package.json +++ b/packages/core/supabase-js/package.json @@ -1,7 +1,7 @@ { "name": "@supabase/supabase-js", "version": "0.0.0-automated", - "description": "Isomorphic Javascript client for Supabase", + "description": "Isomorphic Javascript SDK for Supabase", "keywords": [ "javascript", "typescript", From b012a7fb08c6bd4cc9e5a66da138b324ca512aab Mon Sep 17 00:00:00 2001 From: Katerina Skroumpelou Date: Wed, 15 Oct 2025 15:23:05 +0300 Subject: [PATCH 2/3] docs(repo): make all READMEs similar --- .cursorrules | 2 +- CLAUDE.md | 4 +-- docs/MIGRATION.md | 2 +- packages/core/auth-js/README.md | 36 ++++++++++++++------ packages/core/auth-js/src/lib/error-codes.ts | 2 +- packages/core/functions-js/README.md | 31 ++++++++++++----- packages/core/postgrest-js/README.md | 31 ++++++++++++++--- packages/core/storage-js/README.md | 28 +++++++++++---- packages/core/supabase-js/README.md | 26 +++++++++++--- packages/core/supabase-js/src/lib/types.ts | 4 +-- 10 files changed, 124 insertions(+), 42 deletions(-) diff --git a/.cursorrules b/.cursorrules index 5d05a8303..209153337 100644 --- a/.cursorrules +++ b/.cursorrules @@ -1,6 +1,6 @@ # Cursor Rules for Supabase JS Libraries Monorepo -You are working in a unified Nx monorepo that consolidates all Supabase JavaScript client libraries. This migration from 6 separate repositories addresses maintenance overhead, dependency duplication, and release coordination challenges. +You are working in a unified Nx monorepo that consolidates all Supabase JavaScript SDKs. This migration from 6 separate repositories addresses maintenance overhead, dependency duplication, and release coordination challenges. ## Repository Context diff --git a/CLAUDE.md b/CLAUDE.md index 2b42ed756..0851bb572 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,6 +1,6 @@ # Claude AI Instructions for Supabase JS Libraries Monorepo -You are assisting with development in a unified Nx monorepo that consolidates all Supabase JavaScript client libraries, built with Nx for optimal developer experience and maintainability. This strategic migration from 6 separate repositories addresses critical maintenance overhead, dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers. +You are assisting with development in a unified Nx monorepo that consolidates all Supabase JavaScript SDKs, built with Nx for optimal developer experience and maintainability. This strategic migration from 6 separate repositories addresses critical maintenance overhead, dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers. > **๐Ÿ“š Essential Documentation**: Always refer to these guides for detailed information: > @@ -777,4 +777,4 @@ _No user-facing changes in this release._ - Unchanged packages show "No user-facing changes" - Single npm install updates entire SDK suite -Remember: This monorepo optimizes for developer experience and maintenance efficiency while ensuring zero breaking changes for the millions of developers using Supabase client libraries. +Remember: This monorepo optimizes for developer experience and maintenance efficiency while ensuring zero breaking changes for the millions of developers using Supabase SDKs. diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md index 9c867a427..ae94ba578 100644 --- a/docs/MIGRATION.md +++ b/docs/MIGRATION.md @@ -325,7 +325,7 @@ Use these names with Nx commands: - `postgrest-js` - PostgREST library - `realtime-js` - Realtime library - `storage-js` - Storage library -- `supabase-js` - Main client library +- `supabase-js` - Main SDK ### Useful New Commands diff --git a/packages/core/auth-js/README.md b/packages/core/auth-js/README.md index 724c583c7..7065683ff 100644 --- a/packages/core/auth-js/README.md +++ b/packages/core/auth-js/README.md @@ -1,6 +1,25 @@ -# `auth-js` - -An isomorphic JavaScript SDK for the [Supabase Auth](https://github.com/supabase/auth) API. +
+

+ + + + + Supabase Logo + + + +

Supabase Auth JS SDK

+ +

An isomorphic JavaScript SDK for the Supabase Auth API.

+ +

+ Guides + ยท + Reference Docs + ยท + TypeDoc +

+

@@ -8,11 +27,6 @@ An isomorphic JavaScript SDK for the [Supabase Auth](https://github.com/supabase
-## Docs - -- Using `auth-js`: https://supabase.com/docs/reference/javascript/auth-signup -- TypeDoc: https://supabase.github.io/supabase-js/auth-js/v2/spec.json - ## Quick start Install @@ -31,9 +45,9 @@ const GOTRUE_URL = 'http://localhost:9999' const auth = new AuthClient({ url: GOTRUE_URL }) ``` -- `signUp()`: https://supabase.io/docs/reference/javascript/auth-signup -- `signIn()`: https://supabase.io/docs/reference/javascript/auth-signin -- `signOut()`: https://supabase.io/docs/reference/javascript/auth-signout +- `signUp()`: https://supabase.com/docs/reference/javascript/auth-signup +- `signIn()`: https://supabase.com/docs/reference/javascript/auth-signin +- `signOut()`: https://supabase.com/docs/reference/javascript/auth-signout ### Custom `fetch` implementation diff --git a/packages/core/auth-js/src/lib/error-codes.ts b/packages/core/auth-js/src/lib/error-codes.ts index 27c04097c..6c3d339b7 100644 --- a/packages/core/auth-js/src/lib/error-codes.ts +++ b/packages/core/auth-js/src/lib/error-codes.ts @@ -1,6 +1,6 @@ /** * Known error codes. Note that the server may also return other error codes - * not included in this list (if the client library is older than the version + * not included in this list (if the SDK is older than the version * on the server). */ export type ErrorCode = diff --git a/packages/core/functions-js/README.md b/packages/core/functions-js/README.md index 5b057b760..cd442fe26 100644 --- a/packages/core/functions-js/README.md +++ b/packages/core/functions-js/README.md @@ -1,4 +1,25 @@ -# `functions-js` +
+

+ + + + + Supabase Logo + + + +

Supabase Functions JS SDK

+ +

JavaScript SDK to interact with Supabase Edge Functions.

+ +

+ Guides + ยท + Reference Docs + ยท + TypeDoc +

+

@@ -6,14 +27,6 @@
-JS SDK to interact with Supabase Functions. - -## Docs - -- **API Reference**: -- **Functions Guide**: -- **Typedoc**: - ## Quick Start ### Installation diff --git a/packages/core/postgrest-js/README.md b/packages/core/postgrest-js/README.md index 1fb6413b1..3a91b2401 100644 --- a/packages/core/postgrest-js/README.md +++ b/packages/core/postgrest-js/README.md @@ -1,13 +1,34 @@ -# `postgrest-js` +
+

+ + + + + Supabase Logo + + + +

Supabase PostgREST JS SDK

+ +

Isomorphic JavaScript SDK for PostgREST with an ORM-like interface.

+ +

+ Guides + ยท + Reference Docs + ยท + TypeDoc +

+

+ +
[![Build](https://github.com/supabase/postgrest-js/workflows/CI/badge.svg)](https://github.com/supabase/postgrest-js/actions?query=branch%3Amaster) [![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js) [![License: MIT](https://img.shields.io/npm/l/@supabase/postgrest-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js) -Isomorphic JavaScript SDK for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface. - -Full documentation can be found [here](https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json). +
### Quick start @@ -167,7 +188,7 @@ It performs these steps: - **Port 3000** - PostgREST server (API) - **Port 8080** - Database schema endpoint (for type generation) -**Note:** Unlike a full Supabase instance, this uses a minimal PostgREST setup specifically for testing the client library. +**Note:** Unlike a full Supabase instance, this uses a minimal PostgREST setup specifically for testing the SDK. ### Contributing diff --git a/packages/core/storage-js/README.md b/packages/core/storage-js/README.md index f71461e12..ddec1de1d 100644 --- a/packages/core/storage-js/README.md +++ b/packages/core/storage-js/README.md @@ -1,4 +1,25 @@ -# `storage-js` +
+

+ + + + + Supabase Logo + + + +

Supabase Storage JS SDK

+ +

JavaScript SDK to interact with Supabase Storage.

+ +

+ Guides + ยท + Reference Docs + ยท + TypeDoc +

+

@@ -6,11 +27,6 @@
-JS SDK to interact with Supabase Storage. - -- Documentation: https://supabase.io/docs/reference/javascript/storage-createbucket -- Typedoc: https://supabase.github.io/supabase-js/storage-js/v2/spec.json - ## Quick Start Guide ### Installing the module diff --git a/packages/core/supabase-js/README.md b/packages/core/supabase-js/README.md index 39623962b..3de6a26be 100644 --- a/packages/core/supabase-js/README.md +++ b/packages/core/supabase-js/README.md @@ -1,7 +1,25 @@ -# `supabase-js` - Isomorphic JavaScript SDK for Supabase. - -- **Documentation:** https://supabase.com/docs/reference/javascript/start -- TypeDoc: https://supabase.github.io/supabase-js/supabase-js/v2/spec.json +
+

+ + + + + Supabase Logo + + + +

Supabase JS SDK

+ +

Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.

+ +

+ Guides + ยท + Reference Docs + ยท + TypeDoc +

+

diff --git a/packages/core/supabase-js/src/lib/types.ts b/packages/core/supabase-js/src/lib/types.ts index d20845692..3cf8c3895 100644 --- a/packages/core/supabase-js/src/lib/types.ts +++ b/packages/core/supabase-js/src/lib/types.ts @@ -97,9 +97,9 @@ export type SupabaseClientOptions = { /** * Optional function for using a third-party authentication system with * Supabase. The function should return an access token or ID token (JWT) by - * obtaining it from the third-party auth client library. Note that this + * obtaining it from the third-party auth SDK. Note that this * function may be called concurrently and many times. Use memoization and - * locking techniques if this is not supported by the client libraries. + * locking techniques if this is not supported by the SDKs. * * When set, the `auth` namespace of the Supabase client cannot be used. * Create another client if you wish to use Supabase Auth and third-party From b407af973fa6c63d1e5db92aac1e17a8e8533f7e Mon Sep 17 00:00:00 2001 From: Katerina Skroumpelou Date: Wed, 15 Oct 2025 15:27:28 +0300 Subject: [PATCH 3/3] docs(repo): all badges to all readmes --- README.md | 3 +++ packages/core/auth-js/README.md | 4 +++- packages/core/functions-js/README.md | 3 +++ packages/core/postgrest-js/README.md | 4 ++-- packages/core/realtime-js/README.md | 5 ++++- packages/core/storage-js/README.md | 4 +++- packages/core/supabase-js/README.md | 3 +++ 7 files changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index efc11fc26..5d25f8cd4 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@
+[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) +[![Package](https://img.shields.io/npm/v/@supabase/supabase-js)](https://www.npmjs.com/package/@supabase/postgrest-js) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/supabase-js)](https://pkg.pr.new/~/supabase/supabase-js)
diff --git a/packages/core/auth-js/README.md b/packages/core/auth-js/README.md index 7065683ff..88d63419e 100644 --- a/packages/core/auth-js/README.md +++ b/packages/core/auth-js/README.md @@ -23,8 +23,10 @@
+[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) +[![Package](https://img.shields.io/npm/v/@supabase/auth-js)](https://www.npmjs.com/package/@supabase/auth-js) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/auth-js)](https://pkg.pr.new/~/supabase/auth-js) -
## Quick start diff --git a/packages/core/functions-js/README.md b/packages/core/functions-js/README.md index cd442fe26..dc893338e 100644 --- a/packages/core/functions-js/README.md +++ b/packages/core/functions-js/README.md @@ -23,6 +23,9 @@
+[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) +[![Package](https://img.shields.io/npm/v/@supabase/functions-js)](https://www.npmjs.com/package/@supabase/functions-js) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/functions-js)](https://pkg.pr.new/~/supabase/functions-js)
diff --git a/packages/core/postgrest-js/README.md b/packages/core/postgrest-js/README.md index 3a91b2401..52f4a41b3 100644 --- a/packages/core/postgrest-js/README.md +++ b/packages/core/postgrest-js/README.md @@ -23,9 +23,9 @@
-[![Build](https://github.com/supabase/postgrest-js/workflows/CI/badge.svg)](https://github.com/supabase/postgrest-js/actions?query=branch%3Amaster) +[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) [![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js) -[![License: MIT](https://img.shields.io/npm/l/@supabase/postgrest-js)](#license) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)
diff --git a/packages/core/realtime-js/README.md b/packages/core/realtime-js/README.md index 0d0eb80dd..6a315d1b9 100755 --- a/packages/core/realtime-js/README.md +++ b/packages/core/realtime-js/README.md @@ -8,7 +8,7 @@ -

Supabase Realtime SDK

+

Supabase Realtime JS SDK

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

@@ -23,6 +23,9 @@
+[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) +[![Package](https://img.shields.io/npm/v/@supabase/realtime-js)](https://www.npmjs.com/package/@supabase/realtime-js) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)
diff --git a/packages/core/storage-js/README.md b/packages/core/storage-js/README.md index ddec1de1d..3d9c5c482 100644 --- a/packages/core/storage-js/README.md +++ b/packages/core/storage-js/README.md @@ -23,8 +23,10 @@
+[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) +[![Package](https://img.shields.io/npm/v/@supabase/storage-js)](https://www.npmjs.com/package/@supabase/storage-js) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/storage-js)](https://pkg.pr.new/~/supabase/storage-js) -
## Quick Start Guide diff --git a/packages/core/supabase-js/README.md b/packages/core/supabase-js/README.md index 3de6a26be..6c7d6eeda 100644 --- a/packages/core/supabase-js/README.md +++ b/packages/core/supabase-js/README.md @@ -23,6 +23,9 @@
+[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster) +[![Package](https://img.shields.io/npm/v/@supabase/supabase-js)](https://www.npmjs.com/package/@supabase/supabase-js) +[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license) [![pkg.pr.new](https://pkg.pr.new/badge/supabase/supabase-js)](https://pkg.pr.new/~/supabase/supabase-js)