@supabase/realtime-js 2.0.0 → 2.2.0

package/README.md

@@ -1,128 +1,213 @@
-# Realtime Client
+<br />
+<p align="center">
+  <a href="https://supabase.io">
+        <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg">
+      <img alt="Supabase Logo" width="300" src="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg">
+    </picture>
+  </a>
 
-Listens to changes in a PostgreSQL Database and via websockets.
+  <h1 align="center">Supabase Realtime Client</h1>
 
-This is for usage with Supabase [Realtime](https://github.com/supabase/realtime) server.
+  <h3 align="center">Send ephemeral messages with <b>Broadcast</b>, track and synchronize state with <b>Presence</b>, and listen to database changes with <b>Postgres Change Data Capture (CDC)</b>.</h3>
 
-## Usage
+  <p align="center">
+    <a href="https://supabase.com/docs/guides/realtime">Guides</a>
+    ·
+    <a href="https://supabase.com/docs/reference/javascript">Reference Docs</a>
+    ·
+    <a href="https://multiplayer.dev">Multiplayer Demo</a>
+  </p>
+</p>
 
-### Creating a Socket connection
+# Overview
 
-You can set up one connection to be used across the whole app.
+This client enables you to use the following Supabase Realtime's features:
 
-```js
-import { RealtimeClient } from '@supabase/realtime-js'
+- **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.
+- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.
 
-var client = new RealtimeClient(process.env.REALTIME_URL)
-client.connect()
-```
+# Usage
 
-REALTIME_URL is `'ws://localhost:4000/socket'` when developing locally and `'wss://<project_ref>.supabase.co/realtime/v1'` when connecting to your Supabase project.
+## Installing the Package
 
-You can pass in your JWT If you have enabled JWT authorization in Supabase [Realtime](https://github.com/supabase/realtime) server.
+```bash
+npm install @supabase/realtime-js
+```
+
+## Creating a Channel
 
 ```js
 import { RealtimeClient } from '@supabase/realtime-js'
 
-var client = new RealtimeClient(process.env.REALTIME_URL, {
-  params: { apikey: 'token123' },
+const client = new RealtimeClient(REALTIME_URL, {
+  params: {
+    apikey: API_KEY,
+    eventsPerSecond: 10,
+  },
 })
-client.connect()
-```
 
-See [Realtime: Websocket Connection Authorization](https://github.com/supabase/realtime#websocket-connection-authorization) for more information.
+const channel = client.channel('test-channel', {})
 
-### Subscribing to events
+channel.subscribe((status, err) => {
+  if (status === 'SUBSCRIBED') {
+    console.log('Connected!')
+  }
 
-You can listen to `INSERT`, `UPDATE`, `DELETE`, or all `*` events.
+  if (status === 'CHANNEL_ERROR') {
+    console.log(`There was an error subscribing to channel: ${err.message}`)
+  }
 
-You can subscribe to events on the whole database, schema, table, or individual columns using `channel()`. Channels are multiplexed over the Socket connection.
+  if (status === 'TIMED_OUT') {
+    console.log('Realtime server did not respond in time.')
+  }
 
-To join a channel, you must provide the `topic`, where a topic is either:
+  if (status === 'CLOSED') {
+    console.log('Realtime channel was unexpectedly closed.')
+  }
+})
+```
+
+### Notes:
 
-- `realtime` - entire database
-- `realtime:{schema}` - where `{schema}` is the Postgres Schema
-- `realtime:{schema}:{table}` - where `{table}` is the Postgres table name
-- `realtime:{schema}:{table}:{col}=eq.{val}` - where `{col}` is the column name, and `{val}` is the value which you want to match
+- `REALTIME_URL` is `'ws://localhost:4000/socket'` when developing locally and `'wss://<project_ref>.supabase.co/realtime/v1'` when connecting to your Supabase project.
+- `API_KEY` is a JWT whose claims must contain `exp` and `role` (existing database role).
+- Channel name can be any `string`.
+- `eventsPerSecond`, or client-side rate limiting, enforces the number of events sent to the Realtime server uniformly spread across a second. The default is 10, which means that the client can send one event, whether that's **Broadcast**/**Presence**/**Postgres CDC**, every 100 milliseconds. You may change this as you see fit but note that the server's rate limiting will need to be updated accordingly. You can learn more about Realtime's rate limits here: https://supabase.com/docs/guides/realtime/rate-limits.
 
-**Examples**
+## Broadcast
+
+Your client can send and receive messages based on the `event`.
 
 ```js
-// Listen to events on the entire database.
-var databaseChanges = client.channel('realtime:*')
-databaseChanges.on('*', (e) => console.log(e))
-databaseChanges.on('INSERT', (e) => console.log(e))
-databaseChanges.on('UPDATE', (e) => console.log(e))
-databaseChanges.on('DELETE', (e) => console.log(e))
-databaseChanges.subscribe()
-
-// Listen to events on a schema, using the format `realtime:{SCHEMA}`
-var publicSchema = client.channel('realtime:public')
-publicSchema.on('*', (e) => console.log(e))
-publicSchema.on('INSERT', (e) => console.log(e))
-publicSchema.on('UPDATE', (e) => console.log(e))
-publicSchema.on('DELETE', (e) => console.log(e))
-publicSchema.subscribe()
-
-// Listen to events on a table, using the format `realtime:{SCHEMA}:{TABLE}`
-var usersTable = client.channel('realtime:public:users')
-usersTable.on('*', (e) => console.log(e))
-usersTable.on('INSERT', (e) => console.log(e))
-usersTable.on('UPDATE', (e) => console.log(e))
-usersTable.on('DELETE', (e) => console.log(e))
-usersTable.subscribe()
-
-// Listen to events on a row, using the format `realtime:{SCHEMA}:{TABLE}:{COL}=eq.{VAL}`
-var rowChanges = client.channel('realtime:public:users:id=eq.1')
-rowChanges.on('*', (e) => console.log(e))
-rowChanges.on('INSERT', (e) => console.log(e))
-rowChanges.on('UPDATE', (e) => console.log(e))
-rowChanges.on('DELETE', (e) => console.log(e))
-rowChanges.subscribe()
+// Setup...
+
+const channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })
+
+channel.on('broadcast', { event: 'some-event' }, (payload) =>
+  console.log(payload)
+)
+
+channel.subscribe(async (status) => {
+  if (status === 'SUBSCRIBED') {
+    // Send message to other clients listening to 'broadcast-test' channel
+    await channel.send({
+      type: 'broadcast',
+      event: 'some-event',
+      payload: { hello: 'world' },
+    })
+  }
+})
 ```
 
-**Removing a subscription**
+### Notes:
 
-You can unsubscribe from a topic using `channel.unsubscribe()`.
+- Setting `ack` to `true` means that the `channel.send` promise will resolve once server replies with acknowledgement that it received the broadcast message request.
+- Setting `self` to `true` means that the client will receive the broadcast message it sent out.
 
-**Disconnect the socket**
+## Presence
 
-Call `disconnect()` on the socket:
+Your client can track and sync state that's stored in the channel.
 
 ```js
-let { error, data } = await client.disconnect()
+// Setup...
+
+const channel = client.channel('presence-test', { presence: { key: '' } })
+
+channel.on('presence', { event: 'sync' }, () => {
+  console.log('Online users: ', channel.presenceState())
+})
+
+channel.on('presence', { event: 'join' }, ({ newPresences }) => {
+  console.log('New users have joined: ', newPresences)
+})
+
+channel.on('presence', { event: 'leave' }, ({ leftPresences }) => {
+  console.log('Users have left: ', newPresences)
+})
+
+channel.subscribe(async (status) => {
+  if (status === 'SUBSCRIBED') {
+    const status = await channel.track({ 'user_id': 1 })
+    console.log(status)
+  }
+})
 ```
 
-**Duplicate Join Subscriptions**
+## Postgres CDC
 
-While the client may join any number of topics on any number of channels, the client may only hold a single subscription for each unique topic at any given time. When attempting to create a duplicate subscription, the server will close the existing channel, log a warning, and spawn a new channel for the topic. The client will have their `channel.onClose` callbacks fired for the existing channel, and the new
-channel join will have its receive hooks processed as normal.
+Receive database changes on the client.
 
-**Channel Hooks**
+```js
+// Setup...
+
+const channel = client.channel('db-changes')
+
+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: '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') {
+    console.log('Ready to receive database changes!')
+  }
+})
+```
+
+## Get All Channels
+
+You can see all the channels that your client has instantiatied.
 
 ```js
-channel._onError(() => console.log('there was an error!'))
-channel._onClose(() => console.log('the channel has gone away gracefully'))
+// Setup...
+
+client.getChannels()
 ```
 
-- `onError` hooks are invoked if the socket connection drops, or the channel crashes on the server. In either case, a channel rejoin is attempted automatically in an exponential backoff manner.
-- `onClose` hooks are invoked only in two cases. 1) the channel explicitly closed on the server, or 2). The client explicitly closed, by calling `channel.unsubscribe()`
+## Cleanup
 
-**Subscription Hooks**
+It is highly recommended that you clean up your channels after you're done with them.
+
+- Remove a single channel
 
 ```js
-publicSchema
-  .subscribe()
-  .receive('ok', () => console.log('Connected.'))
-  .receive('error', () => console.log('Failed.'))
-  .receive('timeout', () => console.log('Timed out, retrying.'))
+// Setup...
+
+const channel = client.channel('some-channel-to-remove')
+
+channel.subscribe()
+
+client.removeChannel(channel)
+```
+
+- Remove all channels
+
+```js
+// Setup...
+
+const channel1 = client.channel('a-channel-to-remove')
+const channel2 = client.channel('another-channel-to-remove')
+
+channel1.subscribe()
+channel2.subscribe()
+
+client.removeAllChannels()
 ```
 
 ## Credits
 
-- Original Node.js client was made by Mario Campa of [phoenix-channels](github.com/mcampa/phoenix-client).
-- API was made by authors of the [Phoenix Framework](http://www.phoenixframework.org/). See their website for complete list of authors.
+This repo draws heavily from [phoenix-js](https://github.com/phoenixframework/phoenix/tree/master/assets/js/phoenix).
 
 ## License
 
-MIT. License is the same as [phoenix-channels](https://github.com/mcampa/phoenix-client) and [Phoenix Framework](https://phoenixframework.org/).
+MIT.

package/dist/main/RealtimeChannel.d.ts

@@ -7,7 +7,7 @@ export declare type RealtimeChannelOptions = {
     config: {
         /**
          * self option enables client to receive message it broadcast
-         * ack option instructs server to acknowlege that broadcast message was received
+         * ack option instructs server to acknowledge that broadcast message was received
          */
         broadcast?: {
             self?: boolean;
@@ -21,17 +21,42 @@ export declare type RealtimeChannelOptions = {
         };
     };
 };
-export declare type RealtimePostgresChangesPayload<T extends {
-    [key: string]: any;
-}> = {
+declare type RealtimePostgresChangesPayloadBase = {
     schema: string;
     table: string;
     commit_timestamp: string;
-    eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}` | `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}` | `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`;
-    new: T | {};
-    old: Partial<T> | {};
     errors: string[];
 };
+export declare type RealtimePostgresInsertPayload<T extends {
+    [key: string]: any;
+}> = RealtimePostgresChangesPayloadBase & {
+    eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`;
+    new: T;
+    old: {};
+};
+export declare type RealtimePostgresUpdatePayload<T extends {
+    [key: string]: any;
+}> = RealtimePostgresChangesPayloadBase & {
+    eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`;
+    new: T;
+    old: Partial<T>;
+};
+export declare type RealtimePostgresDeletePayload<T extends {
+    [key: string]: any;
+}> = RealtimePostgresChangesPayloadBase & {
+    eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`;
+    new: {};
+    old: Partial<T>;
+};
+export declare type RealtimePostgresChangesPayload<T extends {
+    [key: string]: any;
+}> = RealtimePostgresInsertPayload<T> | RealtimePostgresUpdatePayload<T> | RealtimePostgresDeletePayload<T>;
+export declare type RealtimePostgresChangesFilter<T extends string> = {
+    event: T;
+    schema: string;
+    table?: string;
+    filter?: string;
+};
 export declare type RealtimeChannelSendResponse = 'ok' | 'timed out' | 'rate limited';
 export declare enum REALTIME_POSTGRES_CHANGES_LISTEN_EVENT {
     ALL = "*",
@@ -50,7 +75,13 @@ export declare enum REALTIME_SUBSCRIBE_STATES {
     CLOSED = "CLOSED",
     CHANNEL_ERROR = "CHANNEL_ERROR"
 }
+/** A channel is the basic building block of Realtime
+ * and narrows the scope of data flow to subscribed clients.
+ * You can think of a channel as a chatroom where participants are able to see who's online
+ * and send and receive messages.
+ **/
 export default class RealtimeChannel {
+    /** Topic name can be any string. */
     topic: string;
     params: RealtimeChannelOptions;
     socket: RealtimeClient;
@@ -71,7 +102,10 @@ export default class RealtimeChannel {
     rejoinTimer: Timer;
     pushBuffer: Push[];
     presence: RealtimePresence;
-    constructor(topic: string, params: RealtimeChannelOptions, socket: RealtimeClient);
+    constructor(
+    /** Topic name can be any string. */
+    topic: string, params: RealtimeChannelOptions, socket: RealtimeClient);
+    /** Subscribe registers your client with the server */
     subscribe(callback?: (status: `${REALTIME_SUBSCRIBE_STATES}`, err?: Error) => void, timeout?: number): RealtimeChannel;
     presenceState(): RealtimePresenceState;
     track(payload: {
@@ -82,6 +116,19 @@ export default class RealtimeChannel {
     untrack(opts?: {
         [key: string]: any;
     }): Promise<RealtimeChannelSendResponse>;
+    /**
+     * Creates an event handler that listens to changes
+     * @param type Realtime feature (broadcast, presence, or postgres_changes)
+     * @param filter Pre-defined and custom values specific to the Realtime feature
+     * @param filter.schema Database schema
+     * @param filter.event Event to listen to. If listening to postgres_changes type
+     * then this value is one of INSERT, UPDATE, DELETE, *
+     * @param filter.filter If listening to postgres_changes type then this value is used to specify
+     * the Postgres Changes filter (eq, neq, lt, lte, gt, or gte) and value to listen to
+     * @param filter.table If listening to postgres_changes type then this value is used to specify
+     * the database table to listen to
+     * @param callback Function to be invoked when event handler is triggered
+     */
     on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
         event: string;
     }, callback: (payload: {
@@ -90,16 +137,30 @@ export default class RealtimeChannel {
         [key: string]: any;
     }) => void): RealtimeChannel;
     on(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
-        event: `${REALTIME_PRESENCE_LISTEN_EVENTS}`;
-    }, callback: (payload: RealtimePresenceJoinPayload | RealtimePresenceLeavePayload | undefined) => void): RealtimeChannel;
+        event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}`;
+    }, callback: () => void): RealtimeChannel;
+    on<T extends {
+        [key: string]: any;
+    }>(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
+        event: `${REALTIME_PRESENCE_LISTEN_EVENTS.JOIN}`;
+    }, callback: (payload: RealtimePresenceJoinPayload<T>) => void): RealtimeChannel;
+    on<T extends {
+        [key: string]: any;
+    }>(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
+        event: `${REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE}`;
+    }, callback: (payload: RealtimePresenceLeavePayload<T>) => void): RealtimeChannel;
     on<T extends {
         [key: string]: any;
-    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: {
-        event: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT}`;
-        schema: string;
-        table?: string;
-        filter?: string;
-    }, callback: (payload: RealtimePostgresChangesPayload<T>) => void): RealtimeChannel;
+    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL}`>, callback: (payload: RealtimePostgresChangesPayload<T>) => void): RealtimeChannel;
+    on<T extends {
+        [key: string]: any;
+    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`>, callback: (payload: RealtimePostgresInsertPayload<T>) => void): RealtimeChannel;
+    on<T extends {
+        [key: string]: any;
+    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`>, callback: (payload: RealtimePostgresUpdatePayload<T>) => void): RealtimeChannel;
+    on<T extends {
+        [key: string]: any;
+    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`>, callback: (payload: RealtimePostgresDeletePayload<T>) => void): RealtimeChannel;
     send(payload: {
         type: string;
         [key: string]: any;
@@ -119,45 +180,6 @@ export default class RealtimeChannel {
      * channel.unsubscribe().receive("ok", () => alert("left!") )
      */
     unsubscribe(timeout?: number): Promise<'ok' | 'timed out' | 'error'>;
-    _push(event: string, payload: {
-        [key: string]: any;
-    }, timeout?: number): Push;
-    /**
-     * Overridable message hook
-     *
-     * Receives all events for specialized message handling before dispatching to the channel callbacks.
-     * Must return the payload, modified or unmodified.
-     */
-    _onMessage(_event: string, payload: any, _ref?: string): any;
-    _isMember(topic: string): boolean;
-    _joinRef(): string;
-    _trigger(type: string, payload?: any, ref?: string): void;
-    _isClosed(): boolean;
-    _isJoined(): boolean;
-    _isJoining(): boolean;
-    _isLeaving(): boolean;
-    _replyEventName(ref: string): string;
-    _on(type: string, filter: {
-        [key: string]: any;
-    }, callback: Function): this;
-    _off(type: string, filter: {
-        [key: string]: any;
-    }): this;
-    private static isEqual;
-    private _rejoinUntilConnected;
-    /**
-     * Registers a callback that will be executed when the channel closes.
-     */
-    private _onClose;
-    /**
-     * Registers a callback that will be executed when the channel encounteres an error.
-     */
-    private _onError;
-    /**
-     * Returns `true` if the socket is connected and the channel has been joined.
-     */
-    private _canPush;
-    private _rejoin;
-    private _getPayloadRecords;
 }
+export {};
 //# sourceMappingURL=RealtimeChannel.d.ts.map

package/dist/main/RealtimeChannel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RealtimeChannel.d.ts","sourceRoot":"","sources":["../../src/RealtimeChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,IAAI,MAAM,YAAY,CAAA;AAC7B,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,MAAM,aAAa,CAAA;AAC/B,OAAO,gBAAgB,EAAE,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,+BAA+B,EAChC,MAAM,oBAAoB,CAAA;AAG3B,oBAAY,sBAAsB,GAAG;IACnC,MAAM,EAAE;QACN;;;WAGG;QACH,SAAS,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAC;YAAC,GAAG,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QAC7C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,GAAG,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAC5B,CAAA;CACF,CAAA;AAED,oBAAY,8BAA8B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IAAI;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EACL,GAAG,sCAAsC,CAAC,MAAM,EAAE,GAClD,GAAG,sCAAsC,CAAC,MAAM,EAAE,GAClD,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IACtD,GAAG,EAAE,CAAC,GAAG,EAAE,CAAA;IACX,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IACpB,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,oBAAY,2BAA2B,GAAG,IAAI,GAAG,WAAW,GAAG,cAAc,CAAA;AAE7E,oBAAY,sCAAsC;IAChD,GAAG,MAAM;IACT,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,oBAAY,qBAAqB;IAC/B,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,gBAAgB,qBAAqB;CACtC;AAED,oBAAY,yBAAyB;IACnC,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,aAAa,kBAAkB;CAChC;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;IAkBzB,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,sBAAsB;IAC9B,MAAM,EAAE,cAAc;IAnB/B,QAAQ,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAA;YACZ,MAAM,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAA;YAC9B,QAAQ,EAAE,QAAQ,CAAA;YAClB,EAAE,CAAC,EAAE,MAAM,CAAA;SACZ,EAAE,CAAA;KACJ,CAAK;IACN,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,iBAAwB;IAC7B,UAAU,UAAQ;IAClB,QAAQ,EAAE,IAAI,CAAA;IACd,WAAW,EAAE,KAAK,CAAA;IAClB,UAAU,EAAE,IAAI,EAAE,CAAK;IACvB,QAAQ,EAAE,gBAAgB,CAAA;gBAGjB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,sBAAuC,EAC/C,MAAM,EAAE,cAAc;IAuD/B,SAAS,CACP,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,yBAAyB,EAAE,EAAE,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,EACxE,OAAO,SAAe,GACrB,eAAe;IA8GlB,aAAa,IAAI,qBAAqB;IAIhC,KAAK,CACT,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC/B,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAWjC,OAAO,CACX,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAUvC,EAAE,CACA,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,EAC1C,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EACzB,QAAQ,EAAE,CAAC,OAAO,EAAE;QAClB,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAA;QAC1C,KAAK,EAAE,MAAM,CAAA;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CACA,IAAI,EAAE,GAAG,qBAAqB,CAAC,QAAQ,EAAE,EACzC,MAAM,EAAE;QAAE,KAAK,EAAE,GAAG,+BAA+B,EAAE,CAAA;KAAE,EACvD,QAAQ,EAAE,CACR,OAAO,EACH,2BAA2B,GAC3B,4BAA4B,GAC5B,SAAS,KACV,IAAI,GACR,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,gBAAgB,EAAE,EACjD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG,sCAAsC,EAAE,CAAA;QAClD,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,QAAQ,EAAE,CAAC,OAAO,EAAE,8BAA8B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC7D,eAAe;IASlB,IAAI,CACF,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC7C,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAwBvC,iBAAiB,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI;IAIxD;;;;;;;;OAQG;IACH,WAAW,CAAC,OAAO,SAAe,GAAG,OAAO,CAAC,IAAI,GAAG,WAAW,GAAG,OAAO,CAAC;IAmC1E,KAAK,CACH,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC/B,OAAO,SAAe;IAgBxB;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM;IAItD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIjC,QAAQ,IAAI,MAAM;IAIlB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM;IAwElD,SAAS,IAAI,OAAO;IAGpB,SAAS,IAAI,OAAO;IAGpB,UAAU,IAAI,OAAO;IAGrB,UAAU,IAAI,OAAO;IAIrB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIpC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,QAAQ,EAAE,QAAQ;IAkBpE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAYjD,OAAO,CAAC,MAAM,CAAC,OAAO;IAiBtB,OAAO,CAAC,qBAAqB;IAO7B;;OAEG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,OAAO;IASf,OAAO,CAAC,kBAAkB;CAsB3B"}
+{"version":3,"file":"RealtimeChannel.d.ts","sourceRoot":"","sources":["../../src/RealtimeChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,IAAI,MAAM,YAAY,CAAA;AAC7B,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,MAAM,aAAa,CAAA;AAC/B,OAAO,gBAAgB,EAAE,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,+BAA+B,EAChC,MAAM,oBAAoB,CAAA;AAG3B,oBAAY,sBAAsB,GAAG;IACnC,MAAM,EAAE;QACN;;;WAGG;QACH,SAAS,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAC;YAAC,GAAG,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QAC7C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,GAAG,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAC5B,CAAA;CACF,CAAA;AAED,aAAK,kCAAkC,GAAG;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,oBAAY,6BAA6B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACxE,kCAAkC,GAAG;IACnC,SAAS,EAAE,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IAC7D,GAAG,EAAE,CAAC,CAAA;IACN,GAAG,EAAE,EAAE,CAAA;CACR,CAAA;AAEH,oBAAY,6BAA6B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACxE,kCAAkC,GAAG;IACnC,SAAS,EAAE,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IAC7D,GAAG,EAAE,CAAC,CAAA;IACN,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CAChB,CAAA;AAEH,oBAAY,6BAA6B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACxE,kCAAkC,GAAG;IACnC,SAAS,EAAE,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IAC7D,GAAG,EAAE,EAAE,CAAA;IACP,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CAChB,CAAA;AAEH,oBAAY,8BAA8B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACvE,6BAA6B,CAAC,CAAC,CAAC,GAChC,6BAA6B,CAAC,CAAC,CAAC,GAChC,6BAA6B,CAAC,CAAC,CAAC,CAAA;AAEpC,oBAAY,6BAA6B,CAAC,CAAC,SAAS,MAAM,IAAI;IAC5D,KAAK,EAAE,CAAC,CAAA;IACR,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,oBAAY,2BAA2B,GAAG,IAAI,GAAG,WAAW,GAAG,cAAc,CAAA;AAE7E,oBAAY,sCAAsC;IAChD,GAAG,MAAM;IACT,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,oBAAY,qBAAqB;IAC/B,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,gBAAgB,qBAAqB;CACtC;AAED,oBAAY,yBAAyB;IACnC,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,aAAa,kBAAkB;CAChC;AAED;;;;IAII;AACJ,MAAM,CAAC,OAAO,OAAO,eAAe;IAkBhC,oCAAoC;IAC7B,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,sBAAsB;IAC9B,MAAM,EAAE,cAAc;IApB/B,QAAQ,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAA;YACZ,MAAM,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAA;YAC9B,QAAQ,EAAE,QAAQ,CAAA;YAClB,EAAE,CAAC,EAAE,MAAM,CAAA;SACZ,EAAE,CAAA;KACJ,CAAK;IACN,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,iBAAwB;IAC7B,UAAU,UAAQ;IAClB,QAAQ,EAAE,IAAI,CAAA;IACd,WAAW,EAAE,KAAK,CAAA;IAClB,UAAU,EAAE,IAAI,EAAE,CAAK;IACvB,QAAQ,EAAE,gBAAgB,CAAA;;IAGxB,oCAAoC;IAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,sBAAuC,EAC/C,MAAM,EAAE,cAAc;IAuD/B,sDAAsD;IACtD,SAAS,CACP,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,yBAAyB,EAAE,EAAE,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,EACxE,OAAO,SAAe,GACrB,eAAe;IA8GlB,aAAa,IAAI,qBAAqB;IAIhC,KAAK,CACT,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC/B,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAWjC,OAAO,CACX,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAUvC;;;;;;;;;;;;OAYG;IACH,EAAE,CACA,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,EAC1C,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EACzB,QAAQ,EAAE,CAAC,OAAO,EAAE;QAClB,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAA;QAC1C,KAAK,EAAE,MAAM,CAAA;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CACA,IAAI,EAAE,GAAG,qBAAqB,CAAC,QAAQ,EAAE,EACzC,MAAM,EAAE;QAAE,KAAK,EAAE,GAAG,+BAA+B,CAAC,IAAI,EAAE,CAAA;KAAE,EAC5D,QAAQ,EAAE,MAAM,IAAI,GACnB,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,QAAQ,EAAE,EACzC,MAAM,EAAE;QAAE,KAAK,EAAE,GAAG,+BAA+B,CAAC,IAAI,EAAE,CAAA;KAAE,EAC5D,QAAQ,EAAE,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC1D,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,QAAQ,EAAE,EACzC,MAAM,EAAE;QAAE,KAAK,EAAE,GAAG,+BAA+B,CAAC,KAAK,EAAE,CAAA;KAAE,EAC7D,QAAQ,EAAE,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC3D,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,gBAAgB,EAAE,EACjD,MAAM,EAAE,6BAA6B,CAAC,GAAG,sCAAsC,CAAC,GAAG,EAAE,CAAC,EACtF,QAAQ,EAAE,CAAC,OAAO,EAAE,8BAA8B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC7D,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,gBAAgB,EAAE,EACjD,MAAM,EAAE,6BAA6B,CAAC,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAC,EACzF,QAAQ,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5D,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,gBAAgB,EAAE,EACjD,MAAM,EAAE,6BAA6B,CAAC,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAC,EACzF,QAAQ,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5D,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,gBAAgB,EAAE,EACjD,MAAM,EAAE,6BAA6B,CAAC,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAC,EACzF,QAAQ,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5D,eAAe;IASlB,IAAI,CACF,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC7C,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAwBvC,iBAAiB,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI;IAIxD;;;;;;;;OAQG;IACH,WAAW,CAAC,OAAO,SAAe,GAAG,OAAO,CAAC,IAAI,GAAG,WAAW,GAAG,OAAO,CAAC;CAqS3E"}

package/dist/main/RealtimeChannel.js

@@ -61,8 +61,15 @@ var REALTIME_SUBSCRIBE_STATES;
     REALTIME_SUBSCRIBE_STATES["CLOSED"] = "CLOSED";
     REALTIME_SUBSCRIBE_STATES["CHANNEL_ERROR"] = "CHANNEL_ERROR";
 })(REALTIME_SUBSCRIBE_STATES = exports.REALTIME_SUBSCRIBE_STATES || (exports.REALTIME_SUBSCRIBE_STATES = {}));
+/** A channel is the basic building block of Realtime
+ * and narrows the scope of data flow to subscribed clients.
+ * You can think of a channel as a chatroom where participants are able to see who's online
+ * and send and receive messages.
+ **/
 class RealtimeChannel {
-    constructor(topic, params = { config: {} }, socket) {
+    constructor(
+    /** Topic name can be any string. */
+    topic, params = { config: {} }, socket) {
         this.topic = topic;
         this.params = params;
         this.socket = socket;
@@ -110,6 +117,7 @@ class RealtimeChannel {
         });
         this.presence = new RealtimePresence_1.default(this);
     }
+    /** Subscribe registers your client with the server */
     subscribe(callback, timeout = this.timeout) {
         var _a, _b;
         if (this.joinedOnce) {
@@ -258,6 +266,7 @@ class RealtimeChannel {
             }
         });
     }
+    /** @internal */
     _push(event, payload, timeout = this.timeout) {
         if (!this.joinedOnce) {
             throw `tried to push '${event}' to '${this.topic}' before joining. Use channel.subscribe() before pushing events`;
@@ -277,16 +286,21 @@ class RealtimeChannel {
      *
      * Receives all events for specialized message handling before dispatching to the channel callbacks.
      * Must return the payload, modified or unmodified.
+     *
+     * @internal
      */
     _onMessage(_event, payload, _ref) {
         return payload;
     }
+    /** @internal */
     _isMember(topic) {
         return this.topic === topic;
     }
+    /** @internal */
     _joinRef() {
         return this.joinPush.ref;
     }
+    /** @internal */
     _trigger(type, payload, ref) {
         var _a, _b;
         const typeLower = type.toLocaleLowerCase();
@@ -347,21 +361,27 @@ class RealtimeChannel {
             });
         }
     }
+    /** @internal */
     _isClosed() {
         return this.state === constants_1.CHANNEL_STATES.closed;
     }
+    /** @internal */
     _isJoined() {
         return this.state === constants_1.CHANNEL_STATES.joined;
     }
+    /** @internal */
     _isJoining() {
         return this.state === constants_1.CHANNEL_STATES.joining;
     }
+    /** @internal */
     _isLeaving() {
         return this.state === constants_1.CHANNEL_STATES.leaving;
     }
+    /** @internal */
     _replyEventName(ref) {
         return `chan_reply_${ref}`;
     }
+    /** @internal */
     _on(type, filter, callback) {
         const typeLower = type.toLocaleLowerCase();
         const binding = {
@@ -377,6 +397,7 @@ class RealtimeChannel {
         }
         return this;
     }
+    /** @internal */
     _off(type, filter) {
         const typeLower = type.toLocaleLowerCase();
         this.bindings[typeLower] = this.bindings[typeLower].filter((bind) => {
@@ -386,6 +407,7 @@ class RealtimeChannel {
         });
         return this;
     }
+    /** @internal */
     static isEqual(obj1, obj2) {
         if (Object.keys(obj1).length !== Object.keys(obj2).length) {
             return false;
@@ -397,6 +419,7 @@ class RealtimeChannel {
         }
         return true;
     }
+    /** @internal */
     _rejoinUntilConnected() {
         this.rejoinTimer.scheduleTimeout();
         if (this.socket.isConnected()) {
@@ -405,22 +428,29 @@ class RealtimeChannel {
     }
     /**
      * Registers a callback that will be executed when the channel closes.
+     *
+     * @internal
      */
     _onClose(callback) {
         this._on(constants_1.CHANNEL_EVENTS.close, {}, callback);
     }
     /**
      * Registers a callback that will be executed when the channel encounteres an error.
+     *
+     * @internal
      */
     _onError(callback) {
         this._on(constants_1.CHANNEL_EVENTS.error, {}, (reason) => callback(reason));
     }
     /**
      * Returns `true` if the socket is connected and the channel has been joined.
+     *
+     * @internal
      */
     _canPush() {
         return this.socket.isConnected() && this._isJoined();
     }
+    /** @internal */
     _rejoin(timeout = this.timeout) {
         if (this._isLeaving()) {
             return;
@@ -429,6 +459,7 @@ class RealtimeChannel {
         this.state = constants_1.CHANNEL_STATES.joining;
         this.joinPush.resend(timeout);
     }
+    /** @internal */
     _getPayloadRecords(payload) {
         const records = {
             new: {},