@devvit/realtime 0.11.18-next-2025-06-25-22-59-20-64e5118a3.0 → 0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0

package/RealtimeClient.d.ts

@@ -1,4 +1,4 @@
-import type { JSONValue } from '@devvit/shared-types/json.js';
+import type { JSONValue } from '@devvit/shared';
 export declare class RealtimeClient {
     #private;
     constructor();

package/RealtimeClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RealtimeClient.d.ts","sourceRoot":"","sources":["../src/RealtimeClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE9D,qBAAa,cAAc;;;IAOnB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAI3D;AAED,eAAO,MAAM,QAAQ,gBAAuB,CAAC"}
+{"version":3,"file":"RealtimeClient.d.ts","sourceRoot":"","sources":["../src/RealtimeClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,qBAAa,cAAc;;;IAOnB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAI3D;AAED,eAAO,MAAM,QAAQ,gBAAuB,CAAC"}

package/index-browser.d.ts

@@ -0,0 +1,2 @@
+export { connectRealtime } from './realtime.js';
+//# sourceMappingURL=index-browser.d.ts.map

package/index-browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../src/index-browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}

package/index-browser.js

@@ -0,0 +1 @@
+export { connectRealtime } from './realtime.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/realtime",
-  "version": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
+  "version": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -21,22 +21,25 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
-    "@devvit/shared-types": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0"
+    "@devvit/protos": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
+    "@devvit/shared": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0"
   },
   "peerDependencies": {
+    "@devvit/client": "*",
     "@devvit/server": "*"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
-    "@devvit/server": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
-    "@devvit/tsconfig": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
+    "@devvit/client": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
+    "@devvit/repo-tools": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
+    "@devvit/server": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
+    "@devvit/tsconfig": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
     "eslint": "9.11.1",
-    "typescript": "5.8.3"
+    "typescript": "5.8.3",
+    "vitest": "1.6.1"
   },
   "publishConfig": {
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "3e476a3aada9d043a65593a9234d4b46a7da686a"
+  "gitHead": "41b71a78b0e3b443876a98578293ea445f7bda7e"
 }

package/realtime.d.ts

@@ -0,0 +1,35 @@
+import type { JSONValue } from '@devvit/shared';
+type ConnectRealtimeOptions = {
+    channel: string;
+    onConnect?: (channel: string) => void;
+    onDisconnect?: (channel: string) => void;
+    onMessage: (data: JSONValue) => void;
+};
+/**
+ * Connects to a realtime channel for receiving messages.
+ *
+ * @param opts - Connection options including channel name and callbacks
+ * @returns A Connection object with a disconnect method
+ */
+export declare const connectRealtime: (opts: Readonly<ConnectRealtimeOptions>) => Promise<Connection>;
+/**
+ * Clears all connections. Used for testing purposes.
+ * @internal
+ */
+export declare const __clearConnections: () => void;
+declare class Connection {
+    #private;
+    constructor(opts: Readonly<ConnectRealtimeOptions>);
+    /**
+     * Disconnects from the realtime channel.
+     *
+     * This works by sending a list of all channels we want to remain subscribed to,
+     * excluding the channel we want to disconnect from. The effect handler compares this
+     * new list with existing subscriptions and triggers disconnect for any channel
+     * that's no longer in the list.
+     */
+    disconnect(): Promise<void>;
+    onMessage: (ev: MessageEvent) => void;
+}
+export {};
+//# sourceMappingURL=realtime.d.ts.map

package/realtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../src/realtime.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,SAAS,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACtC,CAAC;AAQF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,MAAM,QAAQ,CAAC,sBAAsB,CAAC,KACrC,OAAO,CAAC,UAAU,CAepB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAO,IAErC,CAAC;AAEF,cAAM,UAAU;;gBAGF,IAAI,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IAIlD;;;;;;;OAOG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBjC,SAAS,GAAI,IAAI,YAAY,KAAG,IAAI,CAgClC;CACH"}

package/realtime.js

@@ -0,0 +1,101 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Connection_opts;
+import { emitEffect } from '@devvit/client';
+const connectionsByChannel = new Map();
+/* TODO: Clean up this API. Now that realtime has been removed from the
+ * EFFECTS_WITH_RESPONSE list, we probably don't need to await emitEffect.
+ */
+/**
+ * Connects to a realtime channel for receiving messages.
+ *
+ * @param opts - Connection options including channel name and callbacks
+ * @returns A Connection object with a disconnect method
+ */
+export const connectRealtime = async (opts) => {
+    if (connectionsByChannel.has(opts.channel)) {
+        return connectionsByChannel.get(opts.channel);
+    }
+    const connection = new Connection(opts);
+    connectionsByChannel.set(opts.channel, connection);
+    addEventListener('message', connection.onMessage);
+    await emitEffect({
+        realtimeSubscriptions: { subscriptionIds: [...connectionsByChannel.keys()] },
+        type: 0,
+    });
+    return connection;
+};
+/**
+ * Clears all connections. Used for testing purposes.
+ * @internal
+ */
+export const __clearConnections = () => {
+    connectionsByChannel.clear();
+};
+class Connection {
+    constructor(opts) {
+        _Connection_opts.set(this, void 0);
+        this.onMessage = (ev) => {
+            const { type, data } = ev.data;
+            if (type !== 'devvit-message') {
+                return;
+            }
+            if (!data.realtimeEvent) {
+                return;
+            }
+            const { status, event } = data.realtimeEvent;
+            if (!event?.channel.endsWith(__classPrivateFieldGet(this, _Connection_opts, "f").channel)) {
+                return;
+            }
+            // Normalize the channel name (remove namespacing)
+            event.channel = __classPrivateFieldGet(this, _Connection_opts, "f").channel;
+            if (status === 0) {
+                __classPrivateFieldGet(this, _Connection_opts, "f").onConnect?.(__classPrivateFieldGet(this, _Connection_opts, "f").channel);
+            }
+            else if (status === 1) {
+                __classPrivateFieldGet(this, _Connection_opts, "f").onDisconnect?.(__classPrivateFieldGet(this, _Connection_opts, "f").channel);
+            }
+            else if (event.data) {
+                __classPrivateFieldGet(this, _Connection_opts, "f").onMessage(event.data.msg);
+            }
+            else {
+                console.error('[realtime] Received event without data:', {
+                    channel: __classPrivateFieldGet(this, _Connection_opts, "f").channel,
+                    event,
+                });
+            }
+        };
+        __classPrivateFieldSet(this, _Connection_opts, opts, "f");
+    }
+    /**
+     * Disconnects from the realtime channel.
+     *
+     * This works by sending a list of all channels we want to remain subscribed to,
+     * excluding the channel we want to disconnect from. The effect handler compares this
+     * new list with existing subscriptions and triggers disconnect for any channel
+     * that's no longer in the list.
+     */
+    async disconnect() {
+        const connection = connectionsByChannel.get(__classPrivateFieldGet(this, _Connection_opts, "f").channel);
+        if (!connection) {
+            return;
+        }
+        // Get all current subscriptions except the one we're disconnecting
+        const remainingChannels = [...connectionsByChannel.keys()].filter((ch) => ch !== __classPrivateFieldGet(this, _Connection_opts, "f").channel);
+        await emitEffect({
+            realtimeSubscriptions: { subscriptionIds: remainingChannels },
+            type: 0,
+        });
+        connectionsByChannel.delete(__classPrivateFieldGet(this, _Connection_opts, "f").channel);
+    }
+}
+_Connection_opts = new WeakMap();

package/realtime.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.test.d.ts","sourceRoot":"","sources":["../src/realtime.test.ts"],"names":[],"mappings":""}