@supabase/realtime-js - npm Package Compare versions

Comparing version 1.7.4 to 1.8.0-next.1

dist/main/index.d.ts

 import * as Transformers from './lib/transformers';
 import RealtimeClient, { Options as RealtimeClientOptions } from './RealtimeClient';
-import RealtimeSubscription from './RealtimeSubscription';
-export { RealtimeClient, RealtimeClientOptions, RealtimeSubscription, Transformers, };
+import RealtimeChannel from './RealtimeChannel';
+import RealtimePresence from './RealtimePresence';
+export { RealtimeClient, RealtimeClientOptions, RealtimeChannel, RealtimePresence, Transformers, };
 //# sourceMappingURL=index.d.ts.map

dist/main/index.js

@@ -25,3 +25,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transformers = exports.RealtimeSubscription = exports.RealtimeClient = void 0;
+exports.Transformers = exports.RealtimePresence = exports.RealtimeChannel = exports.RealtimeClient = void 0;
 const Transformers = __importStar(require("./lib/transformers"));
@@ -31,4 +31,6 @@ exports.Transformers = Transformers;
 exports.RealtimeClient = RealtimeClient_1.default;
-const RealtimeSubscription_1 = __importDefault(require("./RealtimeSubscription"));
-exports.RealtimeSubscription = RealtimeSubscription_1.default;
+const RealtimeChannel_1 = __importDefault(require("./RealtimeChannel"));
+exports.RealtimeChannel = RealtimeChannel_1.default;
+const RealtimePresence_1 = __importDefault(require("./RealtimePresence"));
+exports.RealtimePresence = RealtimePresence_1.default;
 //# sourceMappingURL=index.js.map

dist/main/lib/push.d.ts

@@ -1,4 +0,4 @@
-import RealtimeSubscription from '../RealtimeSubscription';
+import RealtimeChannel from '../RealtimeChannel';
 export default class Push {
-    channel: RealtimeSubscription;
+    channel: RealtimeChannel;
     event: string;
@@ -29,3 +29,3 @@ payload: {
      */
-    constructor(channel: RealtimeSubscription, event: string, payload?: {
+    constructor(channel: RealtimeChannel, event: string, payload?: {
         [key: string]: unknown;
@@ -32,0 +32,0 @@ }, timeout?: number);

dist/main/lib/push.js

@@ -70,3 +70,3 @@ "use strict";
         };
-        this.channel.on(this.refEvent, callback);
+        this.channel.on(this.refEvent, {}, callback);
         this.timeoutTimer = setTimeout(() => {
@@ -88,3 +88,3 @@ this.trigger('timeout', {});
         }
-        this.channel.off(this.refEvent);
+        this.channel.off(this.refEvent, {});
     }
@@ -91,0 +91,0 @@ _cancelTimeout() {

dist/main/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "1.7.4";
+export declare const version = "1.8.0-next.1";
 //# sourceMappingURL=version.d.ts.map

dist/main/lib/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '1.7.4';
+exports.version = '1.8.0-next.1';
 //# sourceMappingURL=version.js.map

dist/main/RealtimeClient.d.ts

 import { CONNECTION_STATE } from './lib/constants';
 import Timer from './lib/timer';
 import Serializer from './lib/serializer';
-import RealtimeSubscription from './RealtimeSubscription';
+import RealtimeChannel from './RealtimeChannel';
 export declare type Options = {
@@ -33,3 +33,3 @@ transport?: WebSocket;
     accessToken: string | null;
-    channels: RealtimeSubscription[];
+    channels: RealtimeChannel[];
     endPoint: string;
@@ -148,4 +148,4 @@ headers?: {
      */
-    remove(channel: RealtimeSubscription): void;
-    channel(topic: string, chanParams?: ChannelParams): RealtimeSubscription;
+    remove(channel: RealtimeChannel): void;
+    channel(topic: string, chanParams?: ChannelParams): RealtimeChannel;
     /**
@@ -152,0 +152,0 @@ * Push out a message if the socket is connected.

dist/main/RealtimeClient.js

@@ -11,2 +11,13 @@ "use strict";
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -20,3 +31,3 @@ return (mod && mod.__esModule) ? mod : { "default": mod };
 const serializer_1 = __importDefault(require("./lib/serializer"));
-const RealtimeSubscription_1 = __importDefault(require("./RealtimeSubscription"));
+const RealtimeChannel_1 = __importDefault(require("./RealtimeChannel"));
 const noop = () => { };
@@ -220,3 +231,26 @@ class RealtimeClient {
     channel(topic, chanParams = {}) {
-        const chan = new RealtimeSubscription_1.default(topic, chanParams, this);
+        const { selfBroadcast } = chanParams, params = __rest(chanParams, ["selfBroadcast"]);
+        if (selfBroadcast) {
+            params.self_broadcast = selfBroadcast;
+        }
+        const chan = new RealtimeChannel_1.default(topic, params, this);
+        chan.presence.onJoin((key, currentPresences, newPresences) => {
+            chan.trigger('presence', {
+                event: 'join',
+                key,
+                currentPresences,
+                newPresences,
+            });
+        });
+        chan.presence.onLeave((key, currentPresences, leftPresences) => {
+            chan.trigger('presence', {
+                event: 'leave',
+                key,
+                currentPresences,
+                leftPresences,
+            });
+        });
+        chan.presence.onSync(() => {
+            chan.trigger('presence', { event: 'sync' });
+        });
         this.channels.push(chan);
@@ -223,0 +257,0 @@ return chan;

dist/module/index.d.ts

 import * as Transformers from './lib/transformers';
 import RealtimeClient, { Options as RealtimeClientOptions } from './RealtimeClient';
-import RealtimeSubscription from './RealtimeSubscription';
-export { RealtimeClient, RealtimeClientOptions, RealtimeSubscription, Transformers, };
+import RealtimeChannel from './RealtimeChannel';
+import RealtimePresence from './RealtimePresence';
+export { RealtimeClient, RealtimeClientOptions, RealtimeChannel, RealtimePresence, Transformers, };
 //# sourceMappingURL=index.d.ts.map

dist/module/index.js

 import * as Transformers from './lib/transformers';
 import RealtimeClient from './RealtimeClient';
-import RealtimeSubscription from './RealtimeSubscription';
-export { RealtimeClient, RealtimeSubscription, Transformers, };
+import RealtimeChannel from './RealtimeChannel';
+import RealtimePresence from './RealtimePresence';
+export { RealtimeClient, RealtimeChannel, RealtimePresence, Transformers, };
 //# sourceMappingURL=index.js.map

dist/module/lib/push.d.ts

@@ -1,4 +0,4 @@
-import RealtimeSubscription from '../RealtimeSubscription';
+import RealtimeChannel from '../RealtimeChannel';
 export default class Push {
-    channel: RealtimeSubscription;
+    channel: RealtimeChannel;
     event: string;
@@ -29,3 +29,3 @@ payload: {
      */
-    constructor(channel: RealtimeSubscription, event: string, payload?: {
+    constructor(channel: RealtimeChannel, event: string, payload?: {
         [key: string]: unknown;
@@ -32,0 +32,0 @@ }, timeout?: number);

dist/module/lib/push.js

@@ -68,3 +68,3 @@ import { DEFAULT_TIMEOUT } from '../lib/constants';
         };
-        this.channel.on(this.refEvent, callback);
+        this.channel.on(this.refEvent, {}, callback);
         this.timeoutTimer = setTimeout(() => {
@@ -86,3 +86,3 @@ this.trigger('timeout', {});
         }
-        this.channel.off(this.refEvent);
+        this.channel.off(this.refEvent, {});
     }
@@ -89,0 +89,0 @@ _cancelTimeout() {

dist/module/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "1.7.4";
+export declare const version = "1.8.0-next.1";
 //# sourceMappingURL=version.d.ts.map

dist/module/lib/version.js

@@ -1,2 +0,2 @@
-export const version = '1.7.4';
+export const version = '1.8.0-next.1';
 //# sourceMappingURL=version.js.map

dist/module/RealtimeClient.d.ts

 import { CONNECTION_STATE } from './lib/constants';
 import Timer from './lib/timer';
 import Serializer from './lib/serializer';
-import RealtimeSubscription from './RealtimeSubscription';
+import RealtimeChannel from './RealtimeChannel';
 export declare type Options = {
@@ -33,3 +33,3 @@ transport?: WebSocket;
     accessToken: string | null;
-    channels: RealtimeSubscription[];
+    channels: RealtimeChannel[];
     endPoint: string;
@@ -148,4 +148,4 @@ headers?: {
      */
-    remove(channel: RealtimeSubscription): void;
-    channel(topic: string, chanParams?: ChannelParams): RealtimeSubscription;
+    remove(channel: RealtimeChannel): void;
+    channel(topic: string, chanParams?: ChannelParams): RealtimeChannel;
     /**
@@ -152,0 +152,0 @@ * Push out a message if the socket is connected.

dist/module/RealtimeClient.js

@@ -10,2 +10,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { w3cwebsocket } from 'websocket';
@@ -15,3 +26,3 @@ import { VSN, CHANNEL_EVENTS, TRANSPORTS, SOCKET_STATES, DEFAULT_TIMEOUT, WS_CLOSE_NORMAL, DEFAULT_HEADERS, CONNECTION_STATE, } from './lib/constants';
 import Serializer from './lib/serializer';
-import RealtimeSubscription from './RealtimeSubscription';
+import RealtimeChannel from './RealtimeChannel';
 const noop = () => { };
@@ -215,3 +226,26 @@ export default class RealtimeClient {
     channel(topic, chanParams = {}) {
-        const chan = new RealtimeSubscription(topic, chanParams, this);
+        const { selfBroadcast } = chanParams, params = __rest(chanParams, ["selfBroadcast"]);
+        if (selfBroadcast) {
+            params.self_broadcast = selfBroadcast;
+        }
+        const chan = new RealtimeChannel(topic, params, this);
+        chan.presence.onJoin((key, currentPresences, newPresences) => {
+            chan.trigger('presence', {
+                event: 'join',
+                key,
+                currentPresences,
+                newPresences,
+            });
+        });
+        chan.presence.onLeave((key, currentPresences, leftPresences) => {
+            chan.trigger('presence', {
+                event: 'leave',
+                key,
+                currentPresences,
+                leftPresences,
+            });
+        });
+        chan.presence.onSync(() => {
+            chan.trigger('presence', { event: 'sync' });
+        });
         this.channels.push(chan);
@@ -218,0 +252,0 @@ return chan;

package.json

 {
   "name": "@supabase/realtime-js",
-  "version": "1.7.4",
+  "version": "1.8.0-next.1",
   "description": "Listen to realtime updates to your PostgreSQL database",
@@ -5,0 +5,0 @@ "keywords": [

src/index.ts

@@ -5,3 +5,4 @@ import * as Transformers from './lib/transformers'
 } from './RealtimeClient'
-import RealtimeSubscription from './RealtimeSubscription'
+import RealtimeChannel from './RealtimeChannel'
+import RealtimePresence from './RealtimePresence'
 
@@ -11,4 +12,5 @@ export {
   RealtimeClientOptions,
-  RealtimeSubscription,
+  RealtimeChannel,
+  RealtimePresence,
   Transformers,
 }

src/lib/push.ts

 import { DEFAULT_TIMEOUT } from '../lib/constants'
-import RealtimeSubscription from '../RealtimeSubscription'
+import RealtimeChannel from '../RealtimeChannel'
 
@@ -27,3 +27,3 @@ export default class Push {
   constructor(
-    public channel: RealtimeSubscription,
+    public channel: RealtimeChannel,
     public event: string,
@@ -85,3 +85,3 @@ public payload: { [key: string]: unknown } = {},
 
-    this.channel.on(this.refEvent, callback)
+    this.channel.on(this.refEvent, {}, callback)
 
@@ -107,3 +107,3 @@ this.timeoutTimer = <any>setTimeout(() => {
 
-    this.channel.off(this.refEvent)
+    this.channel.off(this.refEvent, {})
   }
@@ -110,0 +110,0 @@

src/lib/version.ts

@@ -1,1 +0,1 @@
-export const version = '1.7.4'
+export const version = '1.8.0-next.1'

src/RealtimeClient.ts

@@ -14,3 +14,3 @@ import { w3cwebsocket } from 'websocket'
 import Serializer from './lib/serializer'
-import RealtimeSubscription from './RealtimeSubscription'
+import RealtimeChannel from './RealtimeChannel'
 
@@ -45,3 +45,3 @@ export type Options = {
   accessToken: string | null = null
-  channels: RealtimeSubscription[] = []
+  channels: RealtimeChannel[] = []
   endPoint: string = ''
@@ -260,10 +260,39 @@ headers?: { [key: string]: string } = DEFAULT_HEADERS
    */
-  remove(channel: RealtimeSubscription) {
+  remove(channel: RealtimeChannel) {
     this.channels = this.channels.filter(
-      (c: RealtimeSubscription) => c.joinRef() !== channel.joinRef()
+      (c: RealtimeChannel) => c.joinRef() !== channel.joinRef()
     )
   }
 
-  channel(topic: string, chanParams: ChannelParams = {}): RealtimeSubscription {
-    const chan = new RealtimeSubscription(topic, chanParams, this)
+  channel(topic: string, chanParams: ChannelParams = {}): RealtimeChannel {
+    const { selfBroadcast, ...params } = chanParams
+
+    if (selfBroadcast) {
+      params.self_broadcast = selfBroadcast
+    }
+
+    const chan = new RealtimeChannel(topic, params, this)
+
+    chan.presence.onJoin((key, currentPresences, newPresences) => {
+      chan.trigger('presence', {
+        event: 'join',
+        key,
+        currentPresences,
+        newPresences,
+      })
+    })
+
+    chan.presence.onLeave((key, currentPresences, leftPresences) => {
+      chan.trigger('presence', {
+        event: 'leave',
+        key,
+        currentPresences,
+        leftPresences,
+      })
+    })
+
+    chan.presence.onSync(() => {
+      chan.trigger('presence', { event: 'sync' })
+    })
+
     this.channels.push(chan)
@@ -312,4 +341,4 @@ return chan
       this.channels
-        .filter((channel: RealtimeSubscription) => channel.isMember(topic))
-        .forEach((channel: RealtimeSubscription) =>
+        .filter((channel: RealtimeChannel) => channel.isMember(topic))
+        .forEach((channel: RealtimeChannel) =>
           channel.trigger(event, payload, ref)
@@ -402,3 +431,3 @@ )
   private _triggerChanError() {
-    this.channels.forEach((channel: RealtimeSubscription) =>
+    this.channels.forEach((channel: RealtimeChannel) =>
       channel.trigger(CHANNEL_EVENTS.error)
@@ -405,0 +434,0 @@ )

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

286426

30.42%

Number of package files

93

10.71%

Lines of code

5221

32.14%

Worsened metrics

Number of low quality alerts

1

Infinity%

No dependency changes