+
+
+ 
+
Supabase Auth JS SDK
+ +An isomorphic JavaScript SDK for the Supabase Auth API.
+ ++ Guides + ยท + Reference Docs + ยท + TypeDoc +
+
+[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)
+[](https://www.npmjs.com/package/@supabase/auth-js)
+[](#license)
[](https://pkg.pr.new/~/supabase/auth-js)
-
-## 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 +47,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/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/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 d8d17a9dd..dc893338e 100644
--- a/packages/core/functions-js/README.md
+++ b/packages/core/functions-js/README.md
@@ -1,19 +1,35 @@
-# `functions-js`
++
+
+
+
Supabase Functions JS SDK
+ +JavaScript SDK to interact with Supabase Edge Functions.
+ ++ Guides + ยท + Reference Docs + ยท + TypeDoc +
+
+[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)
+[](https://www.npmjs.com/package/@supabase/functions-js)
+[](#license)
[](https://pkg.pr.new/~/supabase/functions-js)
-JS Client library to interact with Supabase Functions.
-
-## Docs
-
-- **API Reference**: +
+
+
+
Supabase PostgREST JS SDK
+ +Isomorphic JavaScript SDK for PostgREST with an ORM-like interface.
+ ++ Guides + ยท + Reference Docs + ยท + TypeDoc +
+ + +
+
+[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)
[](https://www.npmjs.com/package/@supabase/postgrest-js)
-[](#license)
+[](#license)
[](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.
-
-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/realtime-js/README.md b/packages/core/realtime-js/README.md
index c2a3fb152..6a315d1b9 100755
--- a/packages/core/realtime-js/README.md
+++ b/packages/core/realtime-js/README.md
@@ -8,7 +8,7 @@
- Supabase Realtime Client
+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,13 +23,16 @@
+[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)
+[](https://www.npmjs.com/package/@supabase/realtime-js)
+[](#license)
[](https://pkg.pr.new/~/supabase/realtime-js)
# 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..3d9c5c482 100644
--- a/packages/core/storage-js/README.md
+++ b/packages/core/storage-js/README.md
@@ -1,16 +1,34 @@
-# `storage-js`
++
+
+
+
Supabase Storage JS SDK
+ +JavaScript SDK to interact with Supabase Storage.
+ ++ Guides + ยท + Reference Docs + ยท + TypeDoc +
+
+[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)
+[](https://www.npmjs.com/package/@supabase/storage-js)
+[](#license)
[](https://pkg.pr.new/~/supabase/storage-js)
-
-JS Client library 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
@@ -393,7 +411,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..6c7d6eeda 100644
--- a/packages/core/supabase-js/README.md
+++ b/packages/core/supabase-js/README.md
@@ -1,10 +1,31 @@
-# `supabase-js` - Isomorphic JavaScript Client for Supabase.
-
-- **Documentation:** https://supabase.com/docs/reference/javascript/start
-- TypeDoc: https://supabase.github.io/supabase-js/supabase-js/v2/spec.json
++
+
+
+
Supabase JS SDK
+ +Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.
+ ++ Guides + ยท + Reference Docs + ยท + TypeDoc +
+
+[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)
+[](https://www.npmjs.com/package/@supabase/supabase-js)
+[](#license)
[](https://pkg.pr.new/~/supabase/supabase-js)
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",
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