Skip to content

Commit c36af99

Browse files
committed
docs(repo): change client libraries references to sdk
1 parent 4b67d60 commit c36af99

File tree

14 files changed

+51
-51
lines changed

14 files changed

+51
-51
lines changed

.github/workflows/docs.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,33 +100,33 @@ jobs:
100100
</head>
101101
<body>
102102
<h1>Supabase JavaScript Libraries - API Documentation</h1>
103-
<p>TypeScript/JavaScript API documentation for all Supabase client libraries.</p>
103+
<p>TypeScript/JavaScript API documentation for all Supabase JS SDKs.</p>
104104
105105
<h2>Available Documentation:</h2>
106106
<ul>
107107
<li>
108108
<a href="auth-js/v2/spec.json">@supabase/auth-js</a>
109-
<div class="description">Authentication client library</div>
109+
<div class="description">Authentication SDK</div>
110110
</li>
111111
<li>
112112
<a href="functions-js/v2/spec.json">@supabase/functions-js</a>
113-
<div class="description">Edge Functions client library</div>
113+
<div class="description">Edge Functions SDK</div>
114114
</li>
115115
<li>
116116
<a href="postgrest-js/v2/spec.json">@supabase/postgrest-js</a>
117-
<div class="description">PostgREST database client</div>
117+
<div class="description">PostgREST database SDK</div>
118118
</li>
119119
<li>
120120
<a href="realtime-js/v2/spec.json">@supabase/realtime-js</a>
121-
<div class="description">Realtime subscriptions client</div>
121+
<div class="description">Realtime subscriptions SDK</div>
122122
</li>
123123
<li>
124124
<a href="storage-js/v2/spec.json">@supabase/storage-js</a>
125-
<div class="description">File storage client</div>
125+
<div class="description">File storage SDK</div>
126126
</li>
127127
<li>
128128
<a href="supabase-js/v2/spec.json">@supabase/supabase-js</a>
129-
<div class="description">Main isomorphic client combining all libraries</div>
129+
<div class="description">Main isomorphic SDK combining all SDKs</div>
130130
</li>
131131
</ul>
132132

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Supabase JS Libraries
22

3-
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.
3+
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.
44

55
> **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:
66
>

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</picture>
99
</a>
1010

11-
<h1 align="center">Supabase JS Client Libraries</h1>
11+
<h1 align="center">Supabase JS SDK</h1>
1212

1313
<p align="center">
1414
<a href="https://supabase.com/docs/guides/getting-started">Guides</a>
@@ -36,16 +36,16 @@
3636
3737
## 📦 Libraries
3838

39-
This monorepo contains the complete suite of Supabase JavaScript client libraries:
39+
This monorepo contains the complete suite of Supabase JavaScript SDK:
4040

4141
| Library | Description |
4242
| ---------------------------------------------------------- | ---------------------------------------- |
43-
| **[@supabase/supabase-js](./packages/core/supabase-js)** | Main isomorphic client for Supabase |
44-
| **[@supabase/auth-js](./packages/core/auth-js)** | Authentication client |
45-
| **[@supabase/postgrest-js](./packages/core/postgrest-js)** | PostgREST client for database operations |
46-
| **[@supabase/realtime-js](./packages/core/realtime-js)** | Real-time subscriptions client |
47-
| **[@supabase/storage-js](./packages/core/storage-js)** | File storage client |
48-
| **[@supabase/functions-js](./packages/core/functions-js)** | Edge Functions client |
43+
| **[@supabase/supabase-js](./packages/core/supabase-js)** | Main isomorphic sdk for Supabase |
44+
| **[@supabase/auth-js](./packages/core/auth-js)** | Authentication sdk |
45+
| **[@supabase/postgrest-js](./packages/core/postgrest-js)** | PostgREST sdk for database operations |
46+
| **[@supabase/realtime-js](./packages/core/realtime-js)** | Real-time subscriptions sdk |
47+
| **[@supabase/storage-js](./packages/core/storage-js)** | File storage sdk |
48+
| **[@supabase/functions-js](./packages/core/functions-js)** | Edge Functions sdk |
4949

5050
> **💡 Note for Package Users:** If you install and use these packages, **nothing has changed**. Continue installing packages normally:
5151
>
@@ -147,12 +147,12 @@ npx nx test <package-name> --coverage
147147

148148
### API Documentation
149149

150-
- **[Auth Client](./packages/core/auth-js/README.md)** - Authentication and user management
151-
- **[Database Client](./packages/core/postgrest-js/README.md)** - Database queries and operations
152-
- **[Realtime Client](./packages/core/realtime-js/README.md)** - Real-time subscriptions
153-
- **[Storage Client](./packages/core/storage-js/README.md)** - File upload and management
154-
- **[Functions Client](./packages/core/functions-js/README.md)** - Edge Functions invocation
155-
- **[Main Client](./packages/core/supabase-js/README.md)** - Combined client library
150+
- **[Auth sdk](./packages/core/auth-js/README.md)** - Authentication and user management
151+
- **[Database sdk](./packages/core/postgrest-js/README.md)** - Database queries and operations
152+
- **[Realtime sdk](./packages/core/realtime-js/README.md)** - Real-time subscriptions
153+
- **[Storage sdk](./packages/core/storage-js/README.md)** - File upload and management
154+
- **[Functions sdk](./packages/core/functions-js/README.md)** - Edge Functions invocation
155+
- **[Main sdk](./packages/core/supabase-js/README.md)** - Combined sdk
156156

157157
### Architecture Documentation
158158

@@ -194,12 +194,12 @@ Because provenance attestations are a new capability, security features may evol
194194
supabase-js/
195195
├── packages/
196196
│ └── core/ # Published libraries
197-
│ ├── auth-js/ # Authentication client
198-
│ ├── functions-js/ # Edge Functions client
199-
│ ├── postgrest-js/ # PostgREST database client
200-
│ ├── realtime-js/ # Real-time subscriptions client
201-
│ ├── storage-js/ # File storage client
202-
│ └── supabase-js/ # Main isomorphic client
197+
│ ├── auth-js/ # Authentication sdk
198+
│ ├── functions-js/ # Edge Functions sdk
199+
│ ├── postgrest-js/ # PostgREST database sdk
200+
│ ├── realtime-js/ # Real-time subscriptions sdk
201+
│ ├── storage-js/ # File storage sdk
202+
│ └── supabase-js/ # Main isomorphic sdk
203203
├── nx.json # npx nx workspace configuration
204204
├── package.json # Root package.json and workspaces setup
205205
└── ...

WARP.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to WARP (warp.dev) when working with code in this re
44

55
## Repository Overview
66

7-
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.
7+
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.
88

99
> **📚 Key Documentation**: For comprehensive guides, see:
1010
>
@@ -46,12 +46,12 @@ This monorepo replaces the following individual repositories:
4646
```text
4747
supabase-js/
4848
├── packages/core/ # Published libraries
49-
│ ├── supabase-js/ # Main isomorphic client for Supabase (@supabase/supabase-js)
50-
│ ├── auth-js/ # Authentication client (@supabase/auth-js)
51-
│ ├── postgrest-js/ # PostgREST client for database operations (@supabase/postgrest-js)
52-
│ ├── realtime-js/ # Real-time subscriptions client (@supabase/realtime-js)
53-
│ ├── storage-js/ # File storage client (@supabase/storage-js)
54-
│ └── functions-js/ # Edge Functions client (@supabase/functions-js)
49+
│ ├── supabase-js/ # Main isomorphic SDK for Supabase (@supabase/supabase-js)
50+
│ ├── auth-js/ # Authentication SDK (@supabase/auth-js)
51+
│ ├── postgrest-js/ # PostgREST SDK for database operations (@supabase/postgrest-js)
52+
│ ├── realtime-js/ # Real-time subscriptions SDK (@supabase/realtime-js)
53+
│ ├── storage-js/ # File storage SDK (@supabase/storage-js)
54+
│ └── functions-js/ # Edge Functions SDK (@supabase/functions-js)
5555
├── docs/ # Documentation guides
5656
│ ├── CONTRIBUTING.md # Contribution guidelines
5757
│ ├── TESTING.md # Testing guide
@@ -172,15 +172,15 @@ Each library has its own testing infrastructure. See the [TESTING.md](docs/TESTI
172172

173173
### Core Architecture
174174

175-
The main `@supabase/supabase-js` package aggregates all individual client libraries:
175+
The main `@supabase/supabase-js` package aggregates all individual SDKs:
176176

177177
- **auth-js**: Handles authentication and user management
178178
- **postgrest-js**: Provides database query capabilities via PostgREST
179179
- **realtime-js**: Manages real-time subscriptions and channels
180180
- **storage-js**: Handles file uploads and storage operations
181181
- **functions-js**: Invokes Supabase Edge Functions
182182

183-
Each library is designed to work independently but integrates seamlessly when used together through the main client.
183+
Each library is designed to work independently but integrates seamlessly when used together through the main SDK.
184184

185185
### Development Infrastructure
186186

@@ -259,7 +259,7 @@ nx affected --target=test
259259

260260
| Library | Docker Required | Primary Use Case |
261261
| ------------ | --------------- | -------------------------- |
262-
| supabase-js | ❌ No | Main isomorphic client |
262+
| supabase-js | ❌ No | Main isomorphic SDK |
263263
| auth-js | ✅ Yes | Authentication & user mgmt |
264264
| postgrest-js | ✅ Yes | Database queries |
265265
| realtime-js | ❌ No | Real-time subscriptions |

docs/MIGRATION.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ This guide is for contributors who need to understand where code moved and how t
9898

9999
## Why We Migrated
100100

101-
We converted the `supabase-js` repository into a monorepo and absorbed the other js client libraries to solve several challenges:
101+
We converted the `supabase-js` repository into a monorepo and absorbed the other js SDKs to solve several challenges:
102102

103103
### Problems with Separate Repos
104104

@@ -134,7 +134,7 @@ github.com/supabase/storage-js
134134
github.com/supabase/functions-js
135135
```
136136

137-
**After:** The Supabase JS monorepo (absorbed all client libraries)
137+
**After:** The Supabase JS monorepo (absorbed all SDKs)
138138

139139
```tree
140140
github.com/supabase/supabase-js

packages/core/auth-js/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `auth-js`
22

3-
An isomorphic JavaScript client library for the [Supabase Auth](https://github.com/supabase/auth) API.
3+
An isomorphic JavaScript SDK for the [Supabase Auth](https://github.com/supabase/auth) API.
44

55
<div align="center">
66

packages/core/auth-js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@supabase/auth-js",
33
"version": "0.0.0",
44
"private": false,
5-
"description": "Official client library for Supabase Auth",
5+
"description": "Official SDK for Supabase Auth",
66
"keywords": [
77
"auth",
88
"supabase",

packages/core/functions-js/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
</div>
88

9-
JS Client library to interact with Supabase Functions.
9+
JS SDK to interact with Supabase Functions.
1010

1111
## Docs
1212

packages/core/functions-js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@supabase/functions-js",
33
"version": "0.0.0-automated",
4-
"description": "JS Client library to interact with Supabase Functions.",
4+
"description": "JS SDK to interact with Supabase Functions.",
55
"main": "dist/main/index.js",
66
"module": "dist/module/index.js",
77
"types": "dist/module/index.d.ts",

packages/core/postgrest-js/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![License: MIT](https://img.shields.io/npm/l/@supabase/postgrest-js)](#license)
66
[![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)
77

8-
Isomorphic JavaScript client for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface.
8+
Isomorphic JavaScript SDK for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface.
99

1010
Full documentation can be found [here](https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json).
1111

0 commit comments

Comments
 (0)