@depup/supabase__realtime-js 2.99.3-depup.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/README.md +32 -0
  2. package/changes.json +14 -0
  3. package/dist/main/RealtimeChannel.d.ts +370 -0
  4. package/dist/main/RealtimeChannel.d.ts.map +1 -0
  5. package/dist/main/RealtimeChannel.js +644 -0
  6. package/dist/main/RealtimeChannel.js.map +1 -0
  7. package/dist/main/RealtimeClient.d.ts +238 -0
  8. package/dist/main/RealtimeClient.d.ts.map +1 -0
  9. package/dist/main/RealtimeClient.js +870 -0
  10. package/dist/main/RealtimeClient.js.map +1 -0
  11. package/dist/main/RealtimePresence.d.ts +76 -0
  12. package/dist/main/RealtimePresence.d.ts.map +1 -0
  13. package/dist/main/RealtimePresence.js +237 -0
  14. package/dist/main/RealtimePresence.js.map +1 -0
  15. package/dist/main/index.d.ts +6 -0
  16. package/dist/main/index.d.ts.map +1 -0
  17. package/dist/main/index.js +18 -0
  18. package/dist/main/index.js.map +1 -0
  19. package/dist/main/lib/constants.d.ts +39 -0
  20. package/dist/main/lib/constants.d.ts.map +1 -0
  21. package/dist/main/lib/constants.js +48 -0
  22. package/dist/main/lib/constants.js.map +1 -0
  23. package/dist/main/lib/push.d.ts +48 -0
  24. package/dist/main/lib/push.d.ts.map +1 -0
  25. package/dist/main/lib/push.js +102 -0
  26. package/dist/main/lib/push.js.map +1 -0
  27. package/dist/main/lib/serializer.d.ts +33 -0
  28. package/dist/main/lib/serializer.d.ts.map +1 -0
  29. package/dist/main/lib/serializer.js +155 -0
  30. package/dist/main/lib/serializer.js.map +1 -0
  31. package/dist/main/lib/timer.d.ts +22 -0
  32. package/dist/main/lib/timer.d.ts.map +1 -0
  33. package/dist/main/lib/timer.js +39 -0
  34. package/dist/main/lib/timer.js.map +1 -0
  35. package/dist/main/lib/transformers.d.ts +109 -0
  36. package/dist/main/lib/transformers.d.ts.map +1 -0
  37. package/dist/main/lib/transformers.js +241 -0
  38. package/dist/main/lib/transformers.js.map +1 -0
  39. package/dist/main/lib/version.d.ts +2 -0
  40. package/dist/main/lib/version.d.ts.map +1 -0
  41. package/dist/main/lib/version.js +11 -0
  42. package/dist/main/lib/version.js.map +1 -0
  43. package/dist/main/lib/websocket-factory.d.ts +81 -0
  44. package/dist/main/lib/websocket-factory.d.ts.map +1 -0
  45. package/dist/main/lib/websocket-factory.js +131 -0
  46. package/dist/main/lib/websocket-factory.js.map +1 -0
  47. package/dist/module/RealtimeChannel.d.ts +370 -0
  48. package/dist/module/RealtimeChannel.d.ts.map +1 -0
  49. package/dist/module/RealtimeChannel.js +639 -0
  50. package/dist/module/RealtimeChannel.js.map +1 -0
  51. package/dist/module/RealtimeClient.d.ts +238 -0
  52. package/dist/module/RealtimeClient.d.ts.map +1 -0
  53. package/dist/module/RealtimeClient.js +866 -0
  54. package/dist/module/RealtimeClient.js.map +1 -0
  55. package/dist/module/RealtimePresence.d.ts +76 -0
  56. package/dist/module/RealtimePresence.d.ts.map +1 -0
  57. package/dist/module/RealtimePresence.js +233 -0
  58. package/dist/module/RealtimePresence.js.map +1 -0
  59. package/dist/module/index.d.ts +6 -0
  60. package/dist/module/index.d.ts.map +1 -0
  61. package/dist/module/index.js +6 -0
  62. package/dist/module/index.js.map +1 -0
  63. package/dist/module/lib/constants.d.ts +39 -0
  64. package/dist/module/lib/constants.d.ts.map +1 -0
  65. package/dist/module/lib/constants.js +45 -0
  66. package/dist/module/lib/constants.js.map +1 -0
  67. package/dist/module/lib/push.d.ts +48 -0
  68. package/dist/module/lib/push.d.ts.map +1 -0
  69. package/dist/module/lib/push.js +99 -0
  70. package/dist/module/lib/push.js.map +1 -0
  71. package/dist/module/lib/serializer.d.ts +33 -0
  72. package/dist/module/lib/serializer.d.ts.map +1 -0
  73. package/dist/module/lib/serializer.js +152 -0
  74. package/dist/module/lib/serializer.js.map +1 -0
  75. package/dist/module/lib/timer.d.ts +22 -0
  76. package/dist/module/lib/timer.d.ts.map +1 -0
  77. package/dist/module/lib/timer.js +36 -0
  78. package/dist/module/lib/timer.js.map +1 -0
  79. package/dist/module/lib/transformers.d.ts +109 -0
  80. package/dist/module/lib/transformers.d.ts.map +1 -0
  81. package/dist/module/lib/transformers.js +229 -0
  82. package/dist/module/lib/transformers.js.map +1 -0
  83. package/dist/module/lib/version.d.ts +2 -0
  84. package/dist/module/lib/version.d.ts.map +1 -0
  85. package/dist/module/lib/version.js +8 -0
  86. package/dist/module/lib/version.js.map +1 -0
  87. package/dist/module/lib/websocket-factory.d.ts +81 -0
  88. package/dist/module/lib/websocket-factory.d.ts.map +1 -0
  89. package/dist/module/lib/websocket-factory.js +127 -0
  90. package/dist/module/lib/websocket-factory.js.map +1 -0
  91. package/dist/tsconfig.module.tsbuildinfo +1 -0
  92. package/dist/tsconfig.tsbuildinfo +1 -0
  93. package/package.json +85 -0
  94. package/src/RealtimeChannel.ts +1039 -0
  95. package/src/RealtimeClient.ts +1023 -0
  96. package/src/RealtimePresence.ts +346 -0
  97. package/src/index.ts +53 -0
  98. package/src/lib/constants.ts +49 -0
  99. package/src/lib/push.ts +121 -0
  100. package/src/lib/serializer.ts +203 -0
  101. package/src/lib/timer.ts +43 -0
  102. package/src/lib/transformers.ts +270 -0
  103. package/src/lib/version.ts +7 -0
  104. package/src/lib/websocket-factory.ts +192 -0
package/README.md ADDED
@@ -0,0 +1,32 @@
1
+ # @depup/supabase__realtime-js
2
+
3
+ > Dependency-bumped version of [@supabase/realtime-js](https://www.npmjs.com/package/@supabase/realtime-js)
4
+
5
+ Generated by [DepUp](https://github.com/depup/npm) -- all production
6
+ dependencies bumped to latest versions.
7
+
8
+ ## Installation
9
+
10
+ ```bash
11
+ npm install @depup/supabase__realtime-js
12
+ ```
13
+
14
+ | Field | Value |
15
+ |-------|-------|
16
+ | Original | [@supabase/realtime-js](https://www.npmjs.com/package/@supabase/realtime-js) @ 2.99.3 |
17
+ | Processed | 2026-03-22 |
18
+ | Smoke test | passed |
19
+ | Deps updated | 2 |
20
+
21
+ ## Dependency Changes
22
+
23
+ | Dependency | From | To |
24
+ |------------|------|-----|
25
+ | @types/phoenix | ^1.6.6 | ^1.6.7 |
26
+ | ws | ^8.18.2 | ^8.20.0 |
27
+
28
+ ---
29
+
30
+ Source: https://github.com/depup/npm | Original: https://www.npmjs.com/package/@supabase/realtime-js
31
+
32
+ License inherited from the original package.
package/changes.json ADDED
@@ -0,0 +1,14 @@
1
+ {
2
+ "bumped": {
3
+ "@types/phoenix": {
4
+ "from": "^1.6.6",
5
+ "to": "^1.6.7"
6
+ },
7
+ "ws": {
8
+ "from": "^8.18.2",
9
+ "to": "^8.20.0"
10
+ }
11
+ },
12
+ "timestamp": "2026-03-22T00:37:59.820Z",
13
+ "totalUpdated": 2
14
+ }
@@ -0,0 +1,370 @@
1
+ import { CHANNEL_STATES } from './lib/constants';
2
+ import Push from './lib/push';
3
+ import type RealtimeClient from './RealtimeClient';
4
+ import Timer from './lib/timer';
5
+ import RealtimePresence, { REALTIME_PRESENCE_LISTEN_EVENTS } from './RealtimePresence';
6
+ import type { RealtimePresenceJoinPayload, RealtimePresenceLeavePayload, RealtimePresenceState } from './RealtimePresence';
7
+ type ReplayOption = {
8
+ since: number;
9
+ limit?: number;
10
+ };
11
+ export type RealtimeChannelOptions = {
12
+ config: {
13
+ /**
14
+ * self option enables client to receive message it broadcast
15
+ * ack option instructs server to acknowledge that broadcast message was received
16
+ * replay option instructs server to replay broadcast messages
17
+ */
18
+ broadcast?: {
19
+ self?: boolean;
20
+ ack?: boolean;
21
+ replay?: ReplayOption;
22
+ };
23
+ /**
24
+ * key option is used to track presence payload across clients
25
+ */
26
+ presence?: {
27
+ key?: string;
28
+ enabled?: boolean;
29
+ };
30
+ /**
31
+ * defines if the channel is private or not and if RLS policies will be used to check data
32
+ */
33
+ private?: boolean;
34
+ };
35
+ };
36
+ type RealtimeChangesPayloadBase = {
37
+ schema: string;
38
+ table: string;
39
+ };
40
+ type RealtimeBroadcastChangesPayloadBase = RealtimeChangesPayloadBase & {
41
+ id: string;
42
+ };
43
+ export type RealtimeBroadcastInsertPayload<T extends {
44
+ [key: string]: any;
45
+ }> = RealtimeBroadcastChangesPayloadBase & {
46
+ operation: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`;
47
+ record: T;
48
+ old_record: null;
49
+ };
50
+ export type RealtimeBroadcastUpdatePayload<T extends {
51
+ [key: string]: any;
52
+ }> = RealtimeBroadcastChangesPayloadBase & {
53
+ operation: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`;
54
+ record: T;
55
+ old_record: T;
56
+ };
57
+ export type RealtimeBroadcastDeletePayload<T extends {
58
+ [key: string]: any;
59
+ }> = RealtimeBroadcastChangesPayloadBase & {
60
+ operation: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`;
61
+ record: null;
62
+ old_record: T;
63
+ };
64
+ export type RealtimeBroadcastPayload<T extends {
65
+ [key: string]: any;
66
+ }> = RealtimeBroadcastInsertPayload<T> | RealtimeBroadcastUpdatePayload<T> | RealtimeBroadcastDeletePayload<T>;
67
+ type RealtimePostgresChangesPayloadBase = {
68
+ schema: string;
69
+ table: string;
70
+ commit_timestamp: string;
71
+ errors: string[];
72
+ };
73
+ export type RealtimePostgresInsertPayload<T extends {
74
+ [key: string]: any;
75
+ }> = RealtimePostgresChangesPayloadBase & {
76
+ eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`;
77
+ new: T;
78
+ old: {};
79
+ };
80
+ export type RealtimePostgresUpdatePayload<T extends {
81
+ [key: string]: any;
82
+ }> = RealtimePostgresChangesPayloadBase & {
83
+ eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`;
84
+ new: T;
85
+ old: Partial<T>;
86
+ };
87
+ export type RealtimePostgresDeletePayload<T extends {
88
+ [key: string]: any;
89
+ }> = RealtimePostgresChangesPayloadBase & {
90
+ eventType: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`;
91
+ new: {};
92
+ old: Partial<T>;
93
+ };
94
+ export type RealtimePostgresChangesPayload<T extends {
95
+ [key: string]: any;
96
+ }> = RealtimePostgresInsertPayload<T> | RealtimePostgresUpdatePayload<T> | RealtimePostgresDeletePayload<T>;
97
+ export type RealtimePostgresChangesFilter<T extends `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT}`> = {
98
+ /**
99
+ * The type of database change to listen to.
100
+ */
101
+ event: T;
102
+ /**
103
+ * The database schema to listen to.
104
+ */
105
+ schema: string;
106
+ /**
107
+ * The database table to listen to.
108
+ */
109
+ table?: string;
110
+ /**
111
+ * Receive database changes when filter is matched.
112
+ */
113
+ filter?: string;
114
+ };
115
+ export type RealtimeChannelSendResponse = 'ok' | 'timed out' | 'error';
116
+ export declare enum REALTIME_POSTGRES_CHANGES_LISTEN_EVENT {
117
+ ALL = "*",
118
+ INSERT = "INSERT",
119
+ UPDATE = "UPDATE",
120
+ DELETE = "DELETE"
121
+ }
122
+ export declare enum REALTIME_LISTEN_TYPES {
123
+ BROADCAST = "broadcast",
124
+ PRESENCE = "presence",
125
+ POSTGRES_CHANGES = "postgres_changes",
126
+ SYSTEM = "system"
127
+ }
128
+ export declare enum REALTIME_SUBSCRIBE_STATES {
129
+ SUBSCRIBED = "SUBSCRIBED",
130
+ TIMED_OUT = "TIMED_OUT",
131
+ CLOSED = "CLOSED",
132
+ CHANNEL_ERROR = "CHANNEL_ERROR"
133
+ }
134
+ export declare const REALTIME_CHANNEL_STATES: typeof CHANNEL_STATES;
135
+ /** A channel is the basic building block of Realtime
136
+ * and narrows the scope of data flow to subscribed clients.
137
+ * You can think of a channel as a chatroom where participants are able to see who's online
138
+ * and send and receive messages.
139
+ */
140
+ export default class RealtimeChannel {
141
+ /** Topic name can be any string. */
142
+ topic: string;
143
+ params: RealtimeChannelOptions;
144
+ socket: RealtimeClient;
145
+ bindings: {
146
+ [key: string]: {
147
+ type: string;
148
+ filter: {
149
+ [key: string]: any;
150
+ };
151
+ callback: Function;
152
+ id?: string;
153
+ }[];
154
+ };
155
+ timeout: number;
156
+ state: CHANNEL_STATES;
157
+ joinedOnce: boolean;
158
+ joinPush: Push;
159
+ rejoinTimer: Timer;
160
+ pushBuffer: Push[];
161
+ presence: RealtimePresence;
162
+ broadcastEndpointURL: string;
163
+ subTopic: string;
164
+ private: boolean;
165
+ /**
166
+ * Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.
167
+ *
168
+ * The topic determines which realtime stream you are subscribing to. Config options let you
169
+ * enable acknowledgement for broadcasts, presence tracking, or private channels.
170
+ *
171
+ * @example
172
+ * ```ts
173
+ * import RealtimeClient from '@supabase/realtime-js'
174
+ *
175
+ * const client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {
176
+ * params: { apikey: 'public-anon-key' },
177
+ * })
178
+ * const channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)
179
+ * ```
180
+ */
181
+ constructor(
182
+ /** Topic name can be any string. */
183
+ topic: string, params: RealtimeChannelOptions | undefined, socket: RealtimeClient);
184
+ /** Subscribe registers your client with the server */
185
+ subscribe(callback?: (status: REALTIME_SUBSCRIBE_STATES, err?: Error) => void, timeout?: number): RealtimeChannel;
186
+ /**
187
+ * Returns the current presence state for this channel.
188
+ *
189
+ * The shape is a map keyed by presence key (for example a user id) where each entry contains the
190
+ * tracked metadata for that user.
191
+ */
192
+ presenceState<T extends {
193
+ [key: string]: any;
194
+ } = {}>(): RealtimePresenceState<T>;
195
+ /**
196
+ * Sends the supplied payload to the presence tracker so other subscribers can see that this
197
+ * client is online. Use `untrack` to stop broadcasting presence for the same key.
198
+ */
199
+ track(payload: {
200
+ [key: string]: any;
201
+ }, opts?: {
202
+ [key: string]: any;
203
+ }): Promise<RealtimeChannelSendResponse>;
204
+ /**
205
+ * Removes the current presence state for this client.
206
+ */
207
+ untrack(opts?: {
208
+ [key: string]: any;
209
+ }): Promise<RealtimeChannelSendResponse>;
210
+ /**
211
+ * Creates an event handler that listens to changes.
212
+ */
213
+ on(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
214
+ event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}`;
215
+ }, callback: () => void): RealtimeChannel;
216
+ on<T extends {
217
+ [key: string]: any;
218
+ }>(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
219
+ event: `${REALTIME_PRESENCE_LISTEN_EVENTS.JOIN}`;
220
+ }, callback: (payload: RealtimePresenceJoinPayload<T>) => void): RealtimeChannel;
221
+ on<T extends {
222
+ [key: string]: any;
223
+ }>(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
224
+ event: `${REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE}`;
225
+ }, callback: (payload: RealtimePresenceLeavePayload<T>) => void): RealtimeChannel;
226
+ on<T extends {
227
+ [key: string]: any;
228
+ }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL}`>, callback: (payload: RealtimePostgresChangesPayload<T>) => void): RealtimeChannel;
229
+ on<T extends {
230
+ [key: string]: any;
231
+ }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`>, callback: (payload: RealtimePostgresInsertPayload<T>) => void): RealtimeChannel;
232
+ on<T extends {
233
+ [key: string]: any;
234
+ }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`>, callback: (payload: RealtimePostgresUpdatePayload<T>) => void): RealtimeChannel;
235
+ on<T extends {
236
+ [key: string]: any;
237
+ }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`>, callback: (payload: RealtimePostgresDeletePayload<T>) => void): RealtimeChannel;
238
+ on<T extends {
239
+ [key: string]: any;
240
+ }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT}`>, callback: (payload: RealtimePostgresChangesPayload<T>) => void): RealtimeChannel;
241
+ /**
242
+ * The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.
243
+ * @param type One of "broadcast", "presence", or "postgres_changes".
244
+ * @param filter Custom object specific to the Realtime feature detailing which payloads to receive.
245
+ * @param callback Function to be invoked when event handler is triggered.
246
+ */
247
+ on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
248
+ event: string;
249
+ }, callback: (payload: {
250
+ type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
251
+ event: string;
252
+ meta?: {
253
+ replayed?: boolean;
254
+ id: string;
255
+ };
256
+ [key: string]: any;
257
+ }) => void): RealtimeChannel;
258
+ on<T extends {
259
+ [key: string]: any;
260
+ }>(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
261
+ event: string;
262
+ }, callback: (payload: {
263
+ type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
264
+ event: string;
265
+ meta?: {
266
+ replayed?: boolean;
267
+ id: string;
268
+ };
269
+ payload: T;
270
+ }) => void): RealtimeChannel;
271
+ on<T extends Record<string, unknown>>(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
272
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL;
273
+ }, callback: (payload: {
274
+ type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
275
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL;
276
+ payload: RealtimeBroadcastPayload<T>;
277
+ }) => void): RealtimeChannel;
278
+ on<T extends {
279
+ [key: string]: any;
280
+ }>(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
281
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT;
282
+ }, callback: (payload: {
283
+ type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
284
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT;
285
+ payload: RealtimeBroadcastInsertPayload<T>;
286
+ }) => void): RealtimeChannel;
287
+ on<T extends {
288
+ [key: string]: any;
289
+ }>(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
290
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE;
291
+ }, callback: (payload: {
292
+ type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
293
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE;
294
+ payload: RealtimeBroadcastUpdatePayload<T>;
295
+ }) => void): RealtimeChannel;
296
+ on<T extends {
297
+ [key: string]: any;
298
+ }>(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
299
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE;
300
+ }, callback: (payload: {
301
+ type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
302
+ event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE;
303
+ payload: RealtimeBroadcastDeletePayload<T>;
304
+ }) => void): RealtimeChannel;
305
+ on<T extends {
306
+ [key: string]: any;
307
+ }>(type: `${REALTIME_LISTEN_TYPES.SYSTEM}`, filter: {}, callback: (payload: any) => void): RealtimeChannel;
308
+ /**
309
+ * Sends a broadcast message explicitly via REST API.
310
+ *
311
+ * This method always uses the REST API endpoint regardless of WebSocket connection state.
312
+ * Useful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.
313
+ *
314
+ * @param event The name of the broadcast event
315
+ * @param payload Payload to be sent (required)
316
+ * @param opts Options including timeout
317
+ * @returns Promise resolving to object with success status, and error details if failed
318
+ */
319
+ httpSend(event: string, payload: any, opts?: {
320
+ timeout?: number;
321
+ }): Promise<{
322
+ success: true;
323
+ } | {
324
+ success: false;
325
+ status: number;
326
+ error: string;
327
+ }>;
328
+ /**
329
+ * Sends a message into the channel.
330
+ *
331
+ * @param args Arguments to send to channel
332
+ * @param args.type The type of event to send
333
+ * @param args.event The name of the event being sent
334
+ * @param args.payload Payload to be sent
335
+ * @param opts Options to be used during the send process
336
+ */
337
+ send(args: {
338
+ type: 'broadcast' | 'presence' | 'postgres_changes';
339
+ event: string;
340
+ payload?: any;
341
+ [key: string]: any;
342
+ }, opts?: {
343
+ [key: string]: any;
344
+ }): Promise<RealtimeChannelSendResponse>;
345
+ /**
346
+ * Updates the payload that will be sent the next time the channel joins (reconnects).
347
+ * Useful for rotating access tokens or updating config without re-creating the channel.
348
+ */
349
+ updateJoinPayload(payload: {
350
+ [key: string]: any;
351
+ }): void;
352
+ /**
353
+ * Leaves the channel.
354
+ *
355
+ * Unsubscribes from server events, and instructs channel to terminate on server.
356
+ * Triggers onClose() hooks.
357
+ *
358
+ * To receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:
359
+ * channel.unsubscribe().receive("ok", () => alert("left!") )
360
+ */
361
+ unsubscribe(timeout?: number): Promise<'ok' | 'timed out' | 'error'>;
362
+ /**
363
+ * Teardown the channel.
364
+ *
365
+ * Destroys and stops related timers.
366
+ */
367
+ teardown(): void;
368
+ }
369
+ export {};
370
+ //# sourceMappingURL=RealtimeChannel.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RealtimeChannel.d.ts","sourceRoot":"","sources":["../../src/RealtimeChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAwB,MAAM,iBAAiB,CAAA;AACtF,OAAO,IAAI,MAAM,YAAY,CAAA;AAC7B,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,MAAM,aAAa,CAAA;AAC/B,OAAO,gBAAgB,EAAE,EAAE,+BAA+B,EAAE,MAAM,oBAAoB,CAAA;AACtF,OAAO,KAAK,EACV,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACtB,MAAM,oBAAoB,CAAA;AAI3B,KAAK,YAAY,GAAG;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE;QACN;;;;WAIG;QACH,SAAS,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAC;YAAC,GAAG,CAAC,EAAE,OAAO,CAAC;YAAC,MAAM,CAAC,EAAE,YAAY,CAAA;SAAE,CAAA;QACpE;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QAC9C;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAA;CACF,CAAA;AAED,KAAK,0BAA0B,GAAG;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,KAAK,mCAAmC,GAAG,0BAA0B,GAAG;IACtE,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACzE,mCAAmC,GAAG;IACpC,SAAS,EAAE,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IAC7D,MAAM,EAAE,CAAC,CAAA;IACT,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAEH,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACzE,mCAAmC,GAAG;IACpC,SAAS,EAAE,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IAC7D,MAAM,EAAE,CAAC,CAAA;IACT,UAAU,EAAE,CAAC,CAAA;CACd,CAAA;AAEH,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACzE,mCAAmC,GAAG;IACpC,SAAS,EAAE,GAAG,sCAAsC,CAAC,MAAM,EAAE,CAAA;IAC7D,MAAM,EAAE,IAAI,CAAA;IACZ,UAAU,EAAE,CAAC,CAAA;CACd,CAAA;AAEH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,IACjE,8BAA8B,CAAC,CAAC,CAAC,GACjC,8BAA8B,CAAC,CAAC,CAAC,GACjC,8BAA8B,CAAC,CAAC,CAAC,CAAA;AAErC,KAAK,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,GAAG,sCAAsC,EAAE,IAAI;IACjG;;OAEG;IACH,KAAK,EAAE,CAAC,CAAA;IACR;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,IAAI,GAAG,WAAW,GAAG,OAAO,CAAA;AAEtE,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;IACrC,MAAM,WAAW;CAClB;AAED,oBAAY,yBAAyB;IACnC,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,aAAa,kBAAkB;CAChC;AAED,eAAO,MAAM,uBAAuB,uBAAiB,CAAA;AAWrD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAqChC,oCAAoC;IAC7B,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,sBAAsB;IAC9B,MAAM,EAAE,cAAc;IAvC/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,EAAE,cAAc,CAAwB;IAC7C,UAAU,UAAQ;IAClB,QAAQ,EAAE,IAAI,CAAA;IACd,WAAW,EAAE,KAAK,CAAA;IAClB,UAAU,EAAE,IAAI,EAAE,CAAK;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAEhB;;;;;;;;;;;;;;;OAeG;;IAED,oCAAoC;IAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,sBAAsB,YAAiB,EAC/C,MAAM,EAAE,cAAc;IAiE/B,sDAAsD;IACtD,SAAS,CACP,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,yBAAyB,EAAE,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,EACnE,OAAO,SAAe,GACrB,eAAe;IAsGlB;;;;;OAKG;IACH,aAAa,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,EAAE,KAAK,qBAAqB,CAAC,CAAC,CAAC;IAIhF;;;OAGG;IACG,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;IAWvC;;OAEG;IACG,OAAO,CAAC,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAUtF;;OAEG;IACH,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;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,EAAE,CAAC,EAClF,QAAQ,EAAE,CAAC,OAAO,EAAE,8BAA8B,CAAC,CAAC,CAAC,KAAK,IAAI,GAC7D,eAAe;IAClB;;;;;OAKG;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,IAAI,CAAC,EAAE;YACL,QAAQ,CAAC,EAAE,OAAO,CAAA;YAClB,EAAE,EAAE,MAAM,CAAA;SACX,CAAA;QACD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,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,IAAI,CAAC,EAAE;YACL,QAAQ,CAAC,EAAE,OAAO,CAAA;YAClB,EAAE,EAAE,MAAM,CAAA;SACX,CAAA;QACD,OAAO,EAAE,CAAC,CAAA;KACX,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,EAC1C,MAAM,EAAE;QAAE,KAAK,EAAE,sCAAsC,CAAC,GAAG,CAAA;KAAE,EAC7D,QAAQ,EAAE,CAAC,OAAO,EAAE;QAClB,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAA;QAC1C,KAAK,EAAE,sCAAsC,CAAC,GAAG,CAAA;QACjD,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAA;KACrC,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,EAC1C,MAAM,EAAE;QAAE,KAAK,EAAE,sCAAsC,CAAC,MAAM,CAAA;KAAE,EAChE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAClB,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAA;QAC1C,KAAK,EAAE,sCAAsC,CAAC,MAAM,CAAA;QACpD,OAAO,EAAE,8BAA8B,CAAC,CAAC,CAAC,CAAA;KAC3C,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,EAC1C,MAAM,EAAE;QAAE,KAAK,EAAE,sCAAsC,CAAC,MAAM,CAAA;KAAE,EAChE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAClB,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAA;QAC1C,KAAK,EAAE,sCAAsC,CAAC,MAAM,CAAA;QACpD,OAAO,EAAE,8BAA8B,CAAC,CAAC,CAAC,CAAA;KAC3C,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,EAC1C,MAAM,EAAE;QAAE,KAAK,EAAE,sCAAsC,CAAC,MAAM,CAAA;KAAE,EAChE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAClB,IAAI,EAAE,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAA;QAC1C,KAAK,EAAE,sCAAsC,CAAC,MAAM,CAAA;QACpD,OAAO,EAAE,8BAA8B,CAAC,CAAC,CAAC,CAAA;KAC3C,KAAK,IAAI,GACT,eAAe;IAClB,EAAE,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EACjC,IAAI,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,EACvC,MAAM,EAAE,EAAE,EACV,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAC/B,eAAe;IAelB;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,GAAG,EACZ,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,OAAO,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAgDjF;;;;;;;;OAQG;IACG,IAAI,CACR,IAAI,EAAE;QACJ,IAAI,EAAE,WAAW,GAAG,UAAU,GAAG,kBAAkB,CAAA;QACnD,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,EACD,IAAI,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAO,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAgEvC;;;OAGG;IACH,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;IAkC1E;;;;OAIG;IACH,QAAQ;CAqST"}