@supabase/realtime-js 2.0.0 → 2.2.0

package/src/RealtimeClient.ts

@@ -159,10 +159,17 @@ export default class RealtimeClient {
     }
   }
 
+  /**
+   * Returns all created channels
+   */
   getChannels(): RealtimeChannel[] {
     return this.channels
   }
 
+  /**
+   * Unsubscribes and removes a single channel
+   * @param channel A RealtimeChannel instance
+   */
   removeChannel(
     channel: RealtimeChannel
   ): Promise<RealtimeRemoveChannelResponse> {
@@ -174,6 +181,9 @@ export default class RealtimeClient {
     })
   }
 
+  /**
+   * Unsubscribes and removes all channels
+   */
   removeAllChannels(): Promise<RealtimeRemoveChannelResponse[]> {
     return Promise.all(
       this.channels.map((channel) => channel.unsubscribe())
@@ -186,7 +196,7 @@ export default class RealtimeClient {
   /**
    * Logs the message.
    *
-   * For customized logging, `this.logger` can be overriden.
+   * For customized logging, `this.logger` can be overridden.
    */
   log(kind: string, msg: string, data?: any) {
     this.logger(kind, msg, data)
@@ -209,7 +219,7 @@ export default class RealtimeClient {
   }
 
   /**
-   * Retuns `true` is the connection is open.
+   * Returns `true` is the connection is open.
    */
   isConnected(): boolean {
     return this.connectionState() === CONNECTION_STATE.Open
@@ -274,6 +284,8 @@ export default class RealtimeClient {
 
   /**
    * Return the next message ref, accounting for overflows
+   *
+   * @internal
    */
   _makeRef(): string {
     let newRef = this.ref + 1
@@ -288,6 +300,8 @@ export default class RealtimeClient {
 
   /**
    * Unsubscribe from channels with the specified topic.
+   *
+   * @internal
    */
   _leaveOpenTopic(topic: string): void {
     let dupChannel = this.channels.find(
@@ -303,6 +317,8 @@ export default class RealtimeClient {
    * Removes a subscription from the socket.
    *
    * @param channel An open subscription.
+   *
+   * @internal
    */
   _remove(channel: RealtimeChannel) {
     this.channels = this.channels.filter(
@@ -312,6 +328,8 @@ export default class RealtimeClient {
 
   /**
    * Returns the URL of the websocket.
+   *
+   * @internal
    */
   private _endPointURL(): string {
     return this._appendParams(
@@ -320,6 +338,7 @@ export default class RealtimeClient {
     )
   }
 
+  /** @internal */
   private _onConnMessage(rawMessage: { data: any }) {
     this.decode(rawMessage.data, (msg: RealtimeMessage) => {
       let { topic, event, payload, ref } = msg
@@ -347,6 +366,7 @@ export default class RealtimeClient {
     })
   }
 
+  /** @internal */
   private _onConnOpen() {
     this.log('transport', `connected to ${this._endPointURL()}`)
     this._flushSendBuffer()
@@ -359,6 +379,7 @@ export default class RealtimeClient {
     this.stateChangeCallbacks.open.forEach((callback) => callback())!
   }
 
+  /** @internal */
   private _onConnClose(event: any) {
     this.log('transport', 'close', event)
     this._triggerChanError()
@@ -367,18 +388,21 @@ export default class RealtimeClient {
     this.stateChangeCallbacks.close.forEach((callback) => callback(event))
   }
 
+  /** @internal */
   private _onConnError(error: ErrorEvent) {
     this.log('transport', error.message)
     this._triggerChanError()
     this.stateChangeCallbacks.error.forEach((callback) => callback(error))
   }
 
+  /** @internal */
   private _triggerChanError() {
     this.channels.forEach((channel: RealtimeChannel) =>
       channel._trigger(CHANNEL_EVENTS.error)
     )
   }
 
+  /** @internal */
   private _appendParams(
     url: string,
     params: { [key: string]: string }
@@ -392,13 +416,14 @@ export default class RealtimeClient {
     return `${url}${prefix}${query}`
   }
 
+  /** @internal */
   private _flushSendBuffer() {
     if (this.isConnected() && this.sendBuffer.length > 0) {
       this.sendBuffer.forEach((callback) => callback())
       this.sendBuffer = []
     }
   }
-
+  /** @internal */
   private _sendHeartbeat() {
     if (!this.isConnected()) {
       return
@@ -422,6 +447,7 @@ export default class RealtimeClient {
     this.setAuth(this.accessToken)
   }
 
+  /** @internal */
   private _throttle(
     callback: Function,
     eventsPerSecondLimit: number = this.eventsPerSecondLimitMs

package/src/RealtimePresence.ts

@@ -10,25 +10,24 @@ import {
 } from 'phoenix'
 import RealtimeChannel from './RealtimeChannel'
 
-type Presence = {
+type Presence<T extends { [key: string]: any } = {}> = {
   presence_ref: string
-  [key: string]: any
-}
+} & T
 
 export type RealtimePresenceState = { [key: string]: Presence[] }
 
-export type RealtimePresenceJoinPayload = {
+export type RealtimePresenceJoinPayload<T extends { [key: string]: any }> = {
   event: `${REALTIME_PRESENCE_LISTEN_EVENTS.JOIN}`
   key: string
-  currentPresences: Presence[]
-  newPresences: Presence[]
+  currentPresences: Presence<T>[]
+  newPresences: Presence<T>[]
 }
 
-export type RealtimePresenceLeavePayload = {
+export type RealtimePresenceLeavePayload<T extends { [key: string]: any }> = {
   event: `${REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE}`
   key: string
-  currentPresences: Presence[]
-  leftPresences: Presence[]
+  currentPresences: Presence<T>[]
+  leftPresences: Presence<T>[]
 }
 
 export enum REALTIME_PRESENCE_LISTEN_EVENTS {
@@ -159,6 +158,8 @@ export default class RealtimePresence {
    * An optional `onJoin` and `onLeave` callback can be provided to
    * react to changes in the client's local presences across
    * disconnects and reconnects with the server.
+   *
+   * @internal
    */
   private static syncState(
     currentState: RealtimePresenceState,
@@ -216,6 +217,8 @@ export default class RealtimePresence {
    * Like `syncState`, `syncDiff` accepts optional `onJoin` and
    * `onLeave` callbacks to react to a user joining or leaving from a
    * device.
+   *
+   * @internal
    */
   private static syncDiff(
     state: RealtimePresenceState,
@@ -276,6 +279,7 @@ export default class RealtimePresence {
     return state
   }
 
+  /** @internal */
   private static map<T = any>(
     obj: RealtimePresenceState,
     func: PresenceChooser<T>
@@ -303,6 +307,8 @@ export default class RealtimePresence {
    *    ]
    *  }
    * })
+   *
+   * @internal
    */
   private static transformState(
     state: RawPresenceState | RealtimePresenceState
@@ -329,22 +335,27 @@ export default class RealtimePresence {
     }, {} as RealtimePresenceState)
   }
 
+  /** @internal */
   private static cloneDeep(obj: { [key: string]: any }) {
     return JSON.parse(JSON.stringify(obj))
   }
 
+  /** @internal */
   private onJoin(callback: PresenceOnJoinCallback): void {
     this.caller.onJoin = callback
   }
 
+  /** @internal */
   private onLeave(callback: PresenceOnLeaveCallback): void {
     this.caller.onLeave = callback
   }
 
+  /** @internal */
   private onSync(callback: () => void): void {
     this.caller.onSync = callback
   }
 
+  /** @internal */
   private inPendingSyncState(): boolean {
     return !this.joinRef || this.joinRef !== this.channel._joinRef()
   }

package/src/index.ts

@@ -6,7 +6,11 @@ import RealtimeClient, {
 import RealtimeChannel, {
   RealtimeChannelOptions,
   RealtimeChannelSendResponse,
+  RealtimePostgresChangesFilter,
   RealtimePostgresChangesPayload,
+  RealtimePostgresInsertPayload,
+  RealtimePostgresUpdatePayload,
+  RealtimePostgresDeletePayload,
   REALTIME_LISTEN_TYPES,
   REALTIME_POSTGRES_CHANGES_LISTEN_EVENT,
   REALTIME_SUBSCRIBE_STATES,
@@ -26,7 +30,11 @@ export {
   RealtimeClient,
   RealtimeClientOptions,
   RealtimeMessage,
+  RealtimePostgresChangesFilter,
   RealtimePostgresChangesPayload,
+  RealtimePostgresInsertPayload,
+  RealtimePostgresUpdatePayload,
+  RealtimePostgresDeletePayload,
   RealtimePresenceJoinPayload,
   RealtimePresenceLeavePayload,
   RealtimePresenceState,

package/src/lib/version.ts

@@ -1 +1 @@
-export const version = '2.0.0'
+export const version = '2.2.0'