@supabase/realtime-js 2.71.2-canary.6 → 2.72.1-canary.2

package/README.md

@@ -50,7 +50,7 @@ import { RealtimeClient } from '@supabase/realtime-js'
 
 const client = new RealtimeClient(REALTIME_URL, {
   params: {
-    apikey: API_KEY
+    apikey: API_KEY,
   },
 })
 
@@ -90,9 +90,7 @@ Your client can send and receive messages based on the `event`.
 
 const channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })
 
-channel.on('broadcast', { event: 'some-event' }, (payload) =>
-  console.log(payload)
-)
+channel.on('broadcast', { event: 'some-event' }, (payload) => console.log(payload))
 
 channel.subscribe(async (status) => {
   if (status === 'SUBSCRIBED') {
@@ -119,16 +117,13 @@ Your client can track and sync state that's stored in the channel.
 ```js
 // Setup...
 
-const channel = client.channel(
-  'presence-test',
-  {
-    config: {
-      presence: {
-        key: ''
-      }
-    }
-  }
-)
+const channel = client.channel('presence-test', {
+  config: {
+    presence: {
+      key: '',
+    },
+  },
+})
 
 channel.on('presence', { event: 'sync' }, () => {
   console.log('Online users: ', channel.presenceState())
@@ -144,7 +139,7 @@ channel.on('presence', { event: 'leave' }, ({ leftPresences }) => {
 
 channel.subscribe(async (status) => {
   if (status === 'SUBSCRIBED') {
-    const status = await channel.track({ 'user_id': 1 })
+    const status = await channel.track({ user_id: 1 })
     console.log(status)
   }
 })
@@ -163,13 +158,21 @@ channel.on('postgres_changes', { event: '*', schema: 'public' }, (payload) => {
   console.log('All changes in public schema: ', payload)
 })
 
-channel.on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'messages' }, (payload) => {
-  console.log('All inserts in messages table: ', payload)
-})
+channel.on(
+  'postgres_changes',
+  { event: 'INSERT', schema: 'public', table: 'messages' },
+  (payload) => {
+    console.log('All inserts in messages table: ', payload)
+  }
+)
 
-channel.on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' }, (payload) => {
-  console.log('All updates on users table when username is Realtime: ', payload)
-})
+channel.on(
+  'postgres_changes',
+  { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' },
+  (payload) => {
+    console.log('All updates on users table when username is Realtime: ', payload)
+  }
+)
 
 channel.subscribe(async (status) => {
   if (status === 'SUBSCRIBED') {
@@ -199,25 +202,89 @@ It is highly recommended that you clean up your channels after you're done with
 
 const channel = client.channel('some-channel-to-remove')
 
-channel.subscribe()
-
+channel.unsubscribe()
 client.removeChannel(channel)
 ```
 
-- Remove all channels
+- Remove all channels and close the connection
 
 ```js
 // Setup...
 
-const channel1 = client.channel('a-channel-to-remove')
-const channel2 = client.channel('another-channel-to-remove')
+client.removeAllChannels()
+client.disconnect()
+```
 
-channel1.subscribe()
-channel2.subscribe()
+## Development
 
-client.removeAllChannels()
+This package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js-libs). To work on this package:
+
+### Building
+
+```bash
+# Complete build (from monorepo root)
+npx nx build realtime-js
+
+# Build with watch mode for development
+npx nx build realtime-js --watch
+
+# Individual build targets
+npx nx build:main realtime-js    # CommonJS build (dist/main/)
+npx nx build:module realtime-js  # ES Modules build (dist/module/)
+
+# Other useful commands
+npx nx clean realtime-js         # Clean build artifacts
+npx nx format realtime-js        # Format code with Prettier
+npx nx lint realtime-js          # Run ESLint
+npx nx typecheck realtime-js     # TypeScript type checking
 ```
 
+#### Build Outputs
+
+- **CommonJS (`dist/main/`)** - For Node.js environments
+- **ES Modules (`dist/module/`)** - For modern bundlers (Webpack, Vite, Rollup)
+- **TypeScript definitions (`dist/module/index.d.ts`)** - Type definitions for TypeScript projects
+
+Note: Unlike some other packages, realtime-js doesn't include a UMD build since it's primarily used in Node.js or bundled applications.
+
+#### Validating Package Exports
+
+```bash
+# Check if package exports are correctly configured
+npx nx check-exports realtime-js
+```
+
+This command uses ["Are the types wrong?"](https://github.com/arethetypeswrong/arethetypeswrong.github.io) to verify that the package exports work correctly in different environments. Run this before publishing to ensure your package can be imported correctly by all consumers.
+
+### Testing
+
+**No Docker or Supabase instance required!** The realtime-js tests use mocked WebSocket connections, so they're completely self-contained.
+
+```bash
+# Run unit tests (from monorepo root)
+npx nx test realtime-js
+
+# Run tests with coverage report
+npx nx test:coverage realtime-js
+
+# Run tests in watch mode during development
+npx nx test:watch realtime-js
+```
+
+#### Test Scripts Explained
+
+- **test** - Runs all unit tests once using Vitest
+- **test:coverage** - Runs tests and generates coverage report with terminal output
+- **test:watch** - Runs tests in interactive watch mode for development
+
+The tests mock WebSocket connections using `mock-socket`, so you can run them anytime without any external dependencies.
+
+### Contributing
+
+We welcome contributions! Please see our [Contributing Guide](../../../CONTRIBUTING.md) for details on how to get started.
+
+For major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.
+
 ## Credits
 
 This repo draws heavily from [phoenix-js](https://github.com/phoenixframework/phoenix/tree/master/assets/js/phoenix).

package/dist/main/lib/constants.d.ts

@@ -1,6 +1,6 @@
-export declare const DEFAULT_VERSION = "realtime-js/0.0.0-automated";
+export declare const DEFAULT_VERSION = "realtime-js/2.72.1-canary.2";
 export declare const VSN: string;
-export declare const VERSION = "0.0.0-automated";
+export declare const VERSION = "2.72.1-canary.2";
 export declare const DEFAULT_TIMEOUT = 10000;
 export declare const WS_CLOSE_NORMAL = 1000;
 export declare const MAX_PUSH_BUFFER_SIZE = 100;

package/dist/main/lib/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.0.0-automated";
+export declare const version = "2.72.1-canary.2";
 //# sourceMappingURL=version.d.ts.map

package/dist/main/lib/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}

package/dist/main/lib/version.js

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.0.0-automated';
+// Generated automatically during releases by scripts/update-version-files.js
+// This file provides runtime access to the package version for:
+// - HTTP request headers (e.g., X-Client-Info header for API requests)
+// - Debugging and support (identifying which version is running)
+// - Telemetry and logging (version reporting in errors/analytics)
+// - Ensuring build artifacts match the published package version
+exports.version = '2.72.1-canary.2';
 //# sourceMappingURL=version.js.map

package/dist/main/lib/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,iBAAiB,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACpD,QAAA,OAAO,GAAG,iBAAiB,CAAA"}

package/dist/module/lib/constants.d.ts

@@ -1,6 +1,6 @@
-export declare const DEFAULT_VERSION = "realtime-js/0.0.0-automated";
+export declare const DEFAULT_VERSION = "realtime-js/2.72.1-canary.2";
 export declare const VSN: string;
-export declare const VERSION = "0.0.0-automated";
+export declare const VERSION = "2.72.1-canary.2";
 export declare const DEFAULT_TIMEOUT = 10000;
 export declare const WS_CLOSE_NORMAL = 1000;
 export declare const MAX_PUSH_BUFFER_SIZE = 100;

package/dist/module/lib/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.0.0-automated";
+export declare const version = "2.72.1-canary.2";
 //# sourceMappingURL=version.d.ts.map

package/dist/module/lib/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}

package/dist/module/lib/version.js

@@ -1,2 +1,8 @@
-export const version = '0.0.0-automated';
+// Generated automatically during releases by scripts/update-version-files.js
+// This file provides runtime access to the package version for:
+// - HTTP request headers (e.g., X-Client-Info header for API requests)
+// - Debugging and support (identifying which version is running)
+// - Telemetry and logging (version reporting in errors/analytics)
+// - Ensuring build artifacts match the published package version
+export const version = '2.72.1-canary.2';
 //# sourceMappingURL=version.js.map

package/dist/module/lib/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,iBAAiB,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,iBAAiB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/realtime-js",
-  "version": "2.71.2-canary.6",
+  "version": "2.72.1-canary.2",
   "description": "Listen to realtime updates to your PostgreSQL database",
   "keywords": [
     "realtime",
@@ -35,13 +35,11 @@
     "build:module": "tsc -p tsconfig.module.json",
     "test": "vitest run",
     "test:watch": "vitest",
-    "coverage": "vitest run --coverage",
-    "coverage:text": "vitest run --coverage.enabled true --coverage.reporter=text",
+    "test:coverage": "vitest run --coverage.enabled true --coverage.reporter=text",
     "docs": "typedoc src/index.ts --out docs/v2",
     "docs:json": "typedoc --json docs/v2/spec.json --excludeExternals src/index.ts",
     "check-exports": "attw --pack .",
-    "ci": "npm run test && npm run coverage",
-    "test:ci": "npm run test && npm run coverage"
+    "test:ci": "vitest run --coverage"
   },
   "dependencies": {
     "@types/phoenix": "^1.6.6",

package/src/lib/version.ts

@@ -1 +1,7 @@
-export const version = '0.0.0-automated'
+// Generated automatically during releases by scripts/update-version-files.js
+// This file provides runtime access to the package version for:
+// - HTTP request headers (e.g., X-Client-Info header for API requests)
+// - Debugging and support (identifying which version is running)
+// - Telemetry and logging (version reporting in errors/analytics)
+// - Ensuring build artifacts match the published package version
+export const version = '2.72.1-canary.2'