@devvit/public-api 0.10.23-next-2024-06-13-b4fe6dd97.0 → 0.10.23-next-2024-06-13-8c5a69306.0

package/devvit/internals/blocks/handler/RenderContext.d.ts

@@ -20,7 +20,7 @@ export declare class RenderContext implements EffectEmitter {
         next: number;
     })[];
     _hooks: {
-        [key: string]: Hook;
+        [hookID: string]: Hook;
     };
     _prevHookId: string;
     _effects: {
@@ -49,6 +49,9 @@ export declare class RenderContext implements EffectEmitter {
     constructor(request: UIRequest, meta: Metadata);
     /** The state delta new to this render. */
     get _changedState(): BlocksState;
+    get hooks(): {
+        readonly [hookID: string]: Hook;
+    };
     /** The complete render state. */
     get _state(): BlocksState;
     /** Replacing state resets the delta for the next render. */
@@ -58,6 +61,7 @@ export declare class RenderContext implements EffectEmitter {
     addUndeliveredEventHandler(id: string, handler: EventHandler): void;
     addGlobalUndeliveredEventHandler(id: string, handler: EventHandler): void;
     getHook(ref: HookRef): Hook;
+    /** Catches events with no active handler and routes to the corresponding hook to detach/unsubscribe/etc **/
     static addGlobalUndeliveredEventHandler(id: string, handler: EventHandler): void;
     handleUndeliveredEvent(ev: UIEvent): Promise<Effect[] | void>;
     emitEffect(dedupeKey: string, effect: Effect): void;

package/devvit/internals/blocks/handler/RenderContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RenderContext.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/RenderContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAExF;;;;;;;;;GASG;AACH,qBAAa,aAAc,YAAW,aAAa;;IACjD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAElC,SAAS,EAAE,CAAC,WAAW,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAM;IACnD,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAM;IACrC,WAAW,EAAE,MAAM,CAAM;IACzB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAM;IACzC,QAAQ,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAM;IAC1C,qDAAqD;IACrD,cAAc,EAAE,OAAO,EAAE,CAAM;IAE/B,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAM;IACxC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAM;IAC5C,MAAM,CAAC,0BAA0B,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAM;IACxE,oBAAoB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAM;IAC3D,cAAc,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAEhC,IAAI,aAAa,IAAI,MAAM,CAAC,OAAO,CAKlC;IAED,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAExC;gBAEW,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ;IAO9C,0CAA0C;IAC1C,IAAI,aAAa,IAAI,WAAW,CAI/B;IAED,iCAAiC;IACjC,IAAI,MAAM,IAAI,WAAW,CAExB;IAED,4DAA4D;IAC5D,IAAI,MAAM,CAAC,KAAK,EAAE,WAAW,EAG5B;IAED,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIhC,GAAG,IAAI,IAAI;IAIX,0BAA0B,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAInE,gCAAgC,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAIzE,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI3B,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAI1E,sBAAsB,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAUnE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAInD;;OAEG;IACH,kBAAkB,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;IAmB9C,IAAI,OAAO,IAAI,MAAM,EAAE,CAEtB;IAED,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM;CA0CzC"}
+{"version":3,"file":"RenderContext.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/RenderContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAExF;;;;;;;;;GASG;AACH,qBAAa,aAAc,YAAW,aAAa;;IACjD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAElC,SAAS,EAAE,CAAC,WAAW,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAM;IACnD,MAAM,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAM;IACxC,WAAW,EAAE,MAAM,CAAM;IACzB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAM;IACzC,QAAQ,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAM;IAC1C,qDAAqD;IACrD,cAAc,EAAE,OAAO,EAAE,CAAM;IAE/B,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAM;IACxC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAM;IAC5C,MAAM,CAAC,0BAA0B,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAM;IACxE,oBAAoB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAM;IAC3D,cAAc,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAEhC,IAAI,aAAa,IAAI,MAAM,CAAC,OAAO,CAKlC;IAED,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAExC;gBAEW,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ;IAO9C,0CAA0C;IAC1C,IAAI,aAAa,IAAI,WAAW,CAI/B;IAED,IAAI,KAAK,IAAI;QAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAE/C;IAED,iCAAiC;IACjC,IAAI,MAAM,IAAI,WAAW,CAExB;IAED,4DAA4D;IAC5D,IAAI,MAAM,CAAC,KAAK,EAAE,WAAW,EAG5B;IAED,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIhC,GAAG,IAAI,IAAI;IAIX,0BAA0B,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAInE,gCAAgC,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAIzE,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAG3B,4GAA4G;IAC5G,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAI1E,sBAAsB,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAUnE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAInD;;OAEG;IACH,kBAAkB,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;IAmB9C,IAAI,OAAO,IAAI,MAAM,EAAE,CAEtB;IAED,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM;CA0CzC"}

package/devvit/internals/blocks/handler/RenderContext.js

@@ -55,6 +55,9 @@ export class RenderContext {
             changed[key] = this._state[key];
         return changed;
     }
+    get hooks() {
+        return this._hooks;
+    }
     /** The complete render state. */
     get _state() {
         return __classPrivateFieldGet(this, _RenderContext_state, "f");
@@ -79,6 +82,7 @@ export class RenderContext {
     getHook(ref) {
         return this._hooks[ref.id];
     }
+    /** Catches events with no active handler and routes to the corresponding hook to detach/unsubscribe/etc **/
     static addGlobalUndeliveredEventHandler(id, handler) {
         RenderContext._staticUndeliveredHandlers[id] = handler;
     }

package/devvit/internals/blocks/handler/types.d.ts

@@ -9,9 +9,15 @@ export type Props = {
 };
 export type HookSegment = {
     /**
-     * This is usually the name of the hook: useAsync, useAsyncState, useChannel,
-     * useForm, useInterval, useState, etc, the block element, or the component
-     * name (eg, AppToolbar or FooBar).
+     * This is usually the name of the hook: useAsync, useAsyncState,
+     * useChannel:channelName, useForm, useInterval, useState, the block element,
+     * or the component name (eg, AppToolbar or FooBar).
+     *
+     * Namespaces can be used to encode additional data such as logically shared
+     * instances that would otherwise have to be gathered from Hook instances.
+     *
+     * Dashes (-) and dots (.) delimit hook IDs so don't use those in your
+     * namespace.
      */
     namespace?: string;
     /**
@@ -37,7 +43,7 @@ export type EventHandler = (event: UIEvent, context: RenderContext) => Promise<v
  * Syncs state between client and server, responds to events, provides user
  * API, and transitions state across renders.
  */
-export interface Hook {
+export type Hook = {
     /**
      * State to carry across renders. Hook constructor arguments are recreated on
      * render but state may be passed in the render request and used to prime that
@@ -59,7 +65,7 @@ export interface Hook {
      * 5. state gets serialized.
      */
     onStateLoaded?(): void;
-}
+};
 export type HookRef = {
     id?: string;
 };

package/devvit/internals/blocks/handler/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,KAAK,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE/C,MAAM,MAAM,WAAW,GAAG;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IAEH,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAErB;;;OAGG;IAEH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IAEzB;;;;;;;;;OASG;IACH,aAAa,CAAC,IAAI,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,IAAI,IAAI,CAAC;IACnB,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;CAAG"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,KAAK,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE/C,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IAEH,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAErB;;;OAGG;IAEH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IAEzB;;;;;;;;;OASG;IACH,aAAa,CAAC,IAAI,IAAI,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,IAAI,IAAI,CAAC;IACnB,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;CAAG"}

package/devvit/internals/blocks/handler/useChannel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useChannel.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useChannel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAyFpE,wBAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,GAAG,gBAAgB,CAI3E"}
+{"version":3,"file":"useChannel.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useChannel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAkIpE,wBAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,GAAG,gBAAgB,CAU3E"}

package/devvit/internals/blocks/handler/useChannel.js

@@ -9,31 +9,50 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _ChannelHook_context, _ChannelHook_invalidate, _ChannelHook_opts;
-import { RealtimeSubscriptionStatus } from '@devvit/protos';
+var _ChannelHook_instances, _a, _ChannelHook_context, _ChannelHook_debug, _ChannelHook_invalidate, _ChannelHook_opts, _ChannelHook_emitSubscribed;
+import { EffectType, RealtimeSubscriptionStatus } from '@devvit/protos';
 import { Header } from '@devvit/shared-types/Header.js';
 import { ChannelStatus } from '../../../../types/realtime.js';
 import { registerHook } from './BlocksHandler.js';
+import { RenderContext } from './RenderContext.js';
+const useChannelList = {};
+/** Unsubscribe and delete hooks with no active event handlers **/
+RenderContext.addGlobalUndeliveredEventHandler('useChannel', async (event) => {
+    if (event.realtimeEvent && event.hook) {
+        useChannelList[event.hook].unsubscribe();
+        delete useChannelList[event.hook];
+    }
+});
 class ChannelHook {
     constructor(opts, params) {
+        _ChannelHook_instances.add(this);
         _ChannelHook_context.set(this, void 0);
+        _ChannelHook_debug.set(this, void 0);
         /** Record state in BlocksHandler. */
         _ChannelHook_invalidate.set(this, void 0);
         _ChannelHook_opts.set(this, void 0);
         __classPrivateFieldSet(this, _ChannelHook_context, params.context, "f");
+        __classPrivateFieldSet(this, _ChannelHook_debug, !!params.context._devvitContext?.debug.realtime, "f");
         __classPrivateFieldSet(this, _ChannelHook_opts, opts, "f");
         __classPrivateFieldSet(this, _ChannelHook_invalidate, params.invalidate, "f");
         const appID = params.context.meta[Header.App]?.values[0];
         if (!appID)
-            throw Error('useChannel() missing app ID metadata');
+            throw Error('useChannel error: missing app ID metadata');
         const installID = params.context.meta[Header.Installation]?.values[0];
         if (!installID)
-            throw Error('useChannel() missing install ID from metadata');
+            throw Error('useChannel error: missing install ID from metadata');
+        const channel = `${appID}:${installID}:${opts.name}`;
+        const duplicate = Object.values(__classPrivateFieldGet(this, _ChannelHook_context, "f").hooks)
+            .filter((hook) => hook instanceof _a)
+            .some((hook) => hook.state.channel === channel);
+        if (duplicate)
+            throw Error('useChannel error: channel names must be unique');
         this.state = {
-            channel: `${appID}:${installID}:${opts.name}`,
+            channel,
             connected: false,
             subscribed: false,
         };
+        useChannelList[this.state.channel] = this;
     }
     async onUIEvent(ev) {
         const realtime = ev.realtimeEvent;
@@ -41,16 +60,22 @@ class ChannelHook {
             return;
         switch (realtime.status) {
             case RealtimeSubscriptionStatus.REALTIME_SUBSCRIBED:
+                if (__classPrivateFieldGet(this, _ChannelHook_debug, "f"))
+                    console.debug('[realtime] connected');
                 this.state.connected = true;
                 __classPrivateFieldGet(this, _ChannelHook_invalidate, "f").call(this);
                 await __classPrivateFieldGet(this, _ChannelHook_opts, "f").onSubscribed?.();
                 break;
             case RealtimeSubscriptionStatus.REALTIME_UNSUBSCRIBED:
+                if (__classPrivateFieldGet(this, _ChannelHook_debug, "f"))
+                    console.debug('[realtime] disconnected');
                 this.state.connected = false;
                 __classPrivateFieldGet(this, _ChannelHook_invalidate, "f").call(this);
                 await __classPrivateFieldGet(this, _ChannelHook_opts, "f").onUnsubscribed?.();
                 break;
             default:
+                if (__classPrivateFieldGet(this, _ChannelHook_debug, "f"))
+                    console.debug(`[realtime] received message: ${JSON.stringify(ev, undefined, 2)}`);
                 // to-do: define a RealtimeSubscriptionStatus.MESSAGE. this could have
                 //        been a oneOf but the current approach allows for status + data
                 //        and this default case will break if another new type is added.
@@ -59,8 +84,12 @@ class ChannelHook {
         }
     }
     async send(data) {
-        if (!this.state.subscribed || !this.state.connected)
-            throw Error(`send failed; ${this.state.channel} channel not connected`);
+        if (__classPrivateFieldGet(this, _ChannelHook_debug, "f"))
+            console.debug(`[realtime] send message: ${JSON.stringify(data, undefined, 2)}`);
+        if (!this.state.subscribed || !this.state.connected) {
+            console.debug(`send failed; ${this.state.channel} channel not connected`);
+            throw Error(`useChannel error: send failed; ${this.state.channel} channel not connected`);
+        }
         await __classPrivateFieldGet(this, _ChannelHook_context, "f").devvitContext.realtime.send(this.state.channel, data);
     }
     get status() {
@@ -75,19 +104,39 @@ class ChannelHook {
     subscribe() {
         if (this.state.subscribed)
             return;
+        if (__classPrivateFieldGet(this, _ChannelHook_debug, "f"))
+            console.debug(`[realtime] subscribed`);
         this.state.subscribed = true;
         __classPrivateFieldGet(this, _ChannelHook_invalidate, "f").call(this);
+        __classPrivateFieldGet(this, _ChannelHook_instances, "m", _ChannelHook_emitSubscribed).call(this);
     }
     unsubscribe() {
         if (!this.state.subscribed)
             return;
+        if (__classPrivateFieldGet(this, _ChannelHook_debug, "f"))
+            console.debug(`[realtime] unsubscribed`);
         this.state.subscribed = false;
         __classPrivateFieldGet(this, _ChannelHook_invalidate, "f").call(this);
+        __classPrivateFieldGet(this, _ChannelHook_instances, "m", _ChannelHook_emitSubscribed).call(this);
     }
 }
-_ChannelHook_context = new WeakMap(), _ChannelHook_invalidate = new WeakMap(), _ChannelHook_opts = new WeakMap();
+_a = ChannelHook, _ChannelHook_context = new WeakMap(), _ChannelHook_debug = new WeakMap(), _ChannelHook_invalidate = new WeakMap(), _ChannelHook_opts = new WeakMap(), _ChannelHook_instances = new WeakSet(), _ChannelHook_emitSubscribed = function _ChannelHook_emitSubscribed() {
+    const channels = Object.values(__classPrivateFieldGet(this, _ChannelHook_context, "f").hooks)
+        .filter((hook) => hook instanceof _a && hook.state.subscribed)
+        .map((hook) => hook.state.channel);
+    __classPrivateFieldGet(this, _ChannelHook_context, "f").emitEffect(`useChannel`, {
+        type: EffectType.EFFECT_REALTIME_SUB,
+        realtimeSubscriptions: { subscriptionIds: channels },
+    });
+};
 export function useChannel(opts) {
-    return registerHook({ namespace: 'useChannel' }, (params) => {
+    // encode channel name in the hook ID. this would enable sharing channels
+    // across useChannel() calls and across components more easily but is
+    // currently unused.
+    if (!opts.name || /[^a-zA-Z0-9]/.test(opts.name))
+        throw Error('useChannel error: channel names must be nonempty and alphanumeric');
+    const namespace = `useChannel:${opts.name}`;
+    return registerHook({ namespace }, (params) => {
         return new ChannelHook(opts, params);
     });
 }

package/devvit/internals/context.js

@@ -38,10 +38,10 @@ export function parseDebug(meta) {
         blocks: undefined,
         emitSnapshots: undefined,
         emitState: undefined,
+        realtime: undefined,
         runtime: undefined,
         surface: undefined,
         useAsync: undefined,
-        useChannel: undefined,
     };
     // {[key: Lowercase<AppDebug>]: AppDebug}
     const lowerKeyToKey = {};

package/index.d.ts

@@ -10,4 +10,5 @@ export { useAsync } from './devvit/internals/blocks/handler/useAsync.js';
 export { useState, useAsyncState } from './devvit/internals/blocks/handler/useState.js';
 export { useForm } from './devvit/internals/blocks/handler/useForm.js';
 export { useInterval } from './devvit/internals/blocks/handler/useInterval.js';
+export { useChannel } from './devvit/internals/blocks/handler/useChannel.js';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAE5B,cAAc,+BAA+B,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAC;AACnF,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,+CAA+C,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,OAAO,EAAE,MAAM,8CAA8C,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAE5B,cAAc,+BAA+B,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAC;AACnF,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,+CAA+C,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,OAAO,EAAE,MAAM,8CAA8C,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iDAAiD,CAAC"}

package/index.js

@@ -9,3 +9,4 @@ export { useAsync } from './devvit/internals/blocks/handler/useAsync.js';
 export { useState, useAsyncState } from './devvit/internals/blocks/handler/useState.js';
 export { useForm } from './devvit/internals/blocks/handler/useForm.js';
 export { useInterval } from './devvit/internals/blocks/handler/useInterval.js';
+export { useChannel } from './devvit/internals/blocks/handler/useChannel.js';

package/meta.json

@@ -10066,7 +10066,7 @@
       "format": "esm"
     },
     "../protos/dist/types/devvit/plugin/redditapi/listings/listings_svc.js": {
-      "bytes": 35535,
+      "bytes": 25214,
       "imports": [
         {
           "path": "../../node_modules/protobufjs/minimal.js",
@@ -11368,7 +11368,7 @@
       "format": "esm"
     },
     "../shared-types/dist/Header.js": {
-      "bytes": 1800,
+      "bytes": 1809,
       "imports": [],
       "format": "esm"
     },
@@ -11764,7 +11764,7 @@
       "imports": []
     },
     "src/devvit/internals/context.ts": {
-      "bytes": 2683,
+      "bytes": 2681,
       "imports": [
         {
           "path": "../shared-types/dist/Header.js",
@@ -12305,8 +12305,19 @@
       ],
       "format": "esm"
     },
+    "src/devvit/internals/blocks/handler/RenderContext.ts": {
+      "bytes": 5690,
+      "imports": [
+        {
+          "path": "<runtime>",
+          "kind": "import-statement",
+          "external": true
+        }
+      ],
+      "format": "esm"
+    },
     "src/devvit/internals/blocks/handler/useChannel.ts": {
-      "bytes": 3523,
+      "bytes": 5710,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -12329,16 +12340,10 @@
           "original": "./BlocksHandler.js"
         },
         {
-          "path": "<runtime>",
+          "path": "src/devvit/internals/blocks/handler/RenderContext.ts",
           "kind": "import-statement",
-          "external": true
-        }
-      ],
-      "format": "esm"
-    },
-    "src/devvit/internals/blocks/handler/RenderContext.ts": {
-      "bytes": 5495,
-      "imports": [
+          "original": "./RenderContext.js"
+        },
         {
           "path": "<runtime>",
           "kind": "import-statement",
@@ -12374,7 +12379,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/types.ts": {
-      "bytes": 2887,
+      "bytes": 3147,
       "imports": [],
       "format": "esm"
     },
@@ -13346,7 +13351,7 @@
       "format": "esm"
     },
     "src/index.ts": {
-      "bytes": 707,
+      "bytes": 785,
       "imports": [
         {
           "path": "../../node_modules/core-js/web/url.js",
@@ -13402,6 +13407,11 @@
           "path": "src/devvit/internals/blocks/handler/useInterval.ts",
           "kind": "import-statement",
           "original": "./devvit/internals/blocks/handler/useInterval.js"
+        },
+        {
+          "path": "src/devvit/internals/blocks/handler/useChannel.ts",
+          "kind": "import-statement",
+          "original": "./devvit/internals/blocks/handler/useChannel.js"
         }
       ],
       "format": "esm"
@@ -13831,7 +13841,7 @@
           "bytesInOutput": 3912
         },
         "src/index.ts": {
-          "bytesInOutput": 1826
+          "bytesInOutput": 1860
         },
         "../shared-types/dist/NonNull.js": {
           "bytesInOutput": 118
@@ -14227,7 +14237,7 @@
           "bytesInOutput": 43555
         },
         "../protos/dist/types/devvit/plugin/redditapi/listings/listings_svc.js": {
-          "bytesInOutput": 21563
+          "bytesInOutput": 15070
         },
         "../protos/dist/types/devvit/plugin/redditapi/listings/listings_msg.js": {
           "bytesInOutput": 38038
@@ -14299,7 +14309,7 @@
           "bytesInOutput": 86
         },
         "../shared-types/dist/Header.js": {
-          "bytesInOutput": 1185
+          "bytesInOutput": 1181
         },
         "src/devvit/internals/blocks/useChannel.ts": {
           "bytesInOutput": 3627
@@ -14359,7 +14369,7 @@
           "bytesInOutput": 2930
         },
         "src/devvit/internals/context.ts": {
-          "bytesInOutput": 1798
+          "bytesInOutput": 1796
         },
         "src/devvit/internals/helpers/settingsUtils.ts": {
           "bytesInOutput": 1229
@@ -14410,7 +14420,7 @@
           "bytesInOutput": 3085
         },
         "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
-          "bytesInOutput": 13784
+          "bytesInOutput": 13799
         },
         "src/devvit/internals/blocks/handler/useForm.ts": {
           "bytesInOutput": 915
@@ -14418,11 +14428,11 @@
         "src/devvit/internals/blocks/handler/UIClient.ts": {
           "bytesInOutput": 2049
         },
-        "src/devvit/internals/blocks/handler/useChannel.ts": {
-          "bytesInOutput": 2808
-        },
         "src/devvit/internals/blocks/handler/RenderContext.ts": {
-          "bytesInOutput": 4138
+          "bytesInOutput": 4301
+        },
+        "src/devvit/internals/blocks/handler/useChannel.ts": {
+          "bytesInOutput": 5176
         },
         "src/devvit/internals/blocks/handler/useInterval.ts": {
           "bytesInOutput": 2357
@@ -14524,7 +14534,7 @@
           "bytesInOutput": 4450
         }
       },
-      "bytes": 14994832
+      "bytes": 14977549
     }
   }
 }

package/meta.min.json

@@ -2598,7 +2598,7 @@
       "format": "esm"
     },
     "../shared-types/dist/Header.js": {
-      "bytes": 1800,
+      "bytes": 1809,
       "imports": [],
       "format": "esm"
     },
@@ -2994,7 +2994,7 @@
       "imports": []
     },
     "src/devvit/internals/context.ts": {
-      "bytes": 2683,
+      "bytes": 2681,
       "imports": [
         {
           "path": "../shared-types/dist/Header.js",
@@ -3535,8 +3535,19 @@
       ],
       "format": "esm"
     },
+    "src/devvit/internals/blocks/handler/RenderContext.ts": {
+      "bytes": 5690,
+      "imports": [
+        {
+          "path": "<runtime>",
+          "kind": "import-statement",
+          "external": true
+        }
+      ],
+      "format": "esm"
+    },
     "src/devvit/internals/blocks/handler/useChannel.ts": {
-      "bytes": 3523,
+      "bytes": 5710,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -3559,16 +3570,10 @@
           "original": "./BlocksHandler.js"
         },
         {
-          "path": "<runtime>",
+          "path": "src/devvit/internals/blocks/handler/RenderContext.ts",
           "kind": "import-statement",
-          "external": true
-        }
-      ],
-      "format": "esm"
-    },
-    "src/devvit/internals/blocks/handler/RenderContext.ts": {
-      "bytes": 5495,
-      "imports": [
+          "original": "./RenderContext.js"
+        },
         {
           "path": "<runtime>",
           "kind": "import-statement",
@@ -3604,7 +3609,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/types.ts": {
-      "bytes": 2887,
+      "bytes": 3147,
       "imports": [],
       "format": "esm"
     },
@@ -4576,7 +4581,7 @@
       "format": "esm"
     },
     "src/index.ts": {
-      "bytes": 707,
+      "bytes": 785,
       "imports": [
         {
           "path": "../../node_modules/core-js/web/url.js",
@@ -4632,6 +4637,11 @@
           "path": "src/devvit/internals/blocks/handler/useInterval.ts",
           "kind": "import-statement",
           "original": "./devvit/internals/blocks/handler/useInterval.js"
+        },
+        {
+          "path": "src/devvit/internals/blocks/handler/useChannel.ts",
+          "kind": "import-statement",
+          "original": "./devvit/internals/blocks/handler/useChannel.js"
         }
       ],
       "format": "esm"
@@ -4642,7 +4652,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1136297
+      "bytes": 1140612
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -4799,6 +4809,7 @@
         "svg",
         "useAsync",
         "useAsyncState",
+        "useChannel",
         "useForm",
         "useInterval",
         "useState"
@@ -5214,7 +5225,7 @@
           "bytesInOutput": 1537
         },
         "../shared-types/dist/Header.js": {
-          "bytesInOutput": 869
+          "bytesInOutput": 865
         },
         "src/apis/ui/helpers/getFormValues.ts": {
           "bytesInOutput": 407
@@ -5271,7 +5282,7 @@
           "bytesInOutput": 2377
         },
         "src/devvit/internals/context.ts": {
-          "bytesInOutput": 940
+          "bytesInOutput": 938
         },
         "src/devvit/internals/custom-post.ts": {
           "bytesInOutput": 350
@@ -5328,14 +5339,14 @@
           "bytesInOutput": 422
         },
         "src/devvit/internals/blocks/handler/useChannel.ts": {
-          "bytesInOutput": 1519
+          "bytesInOutput": 2903
+        },
+        "src/devvit/internals/blocks/handler/RenderContext.ts": {
+          "bytesInOutput": 2082
         },
         "src/devvit/internals/blocks/handler/useInterval.ts": {
           "bytesInOutput": 1184
         },
-        "src/devvit/internals/blocks/handler/RenderContext.ts": {
-          "bytesInOutput": 2051
-        },
         "src/devvit/internals/blocks/handler/types.ts": {
           "bytesInOutput": 29
         },
@@ -5427,7 +5438,7 @@
           "bytesInOutput": 2135
         }
       },
-      "bytes": 242970
+      "bytes": 244396
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.10.23-next-2024-06-13-b4fe6dd97.0",
+  "version": "0.10.23-next-2024-06-13-8c5a69306.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.10.23-next-2024-06-13-b4fe6dd97.0",
-    "@devvit/shared-types": "0.10.23-next-2024-06-13-b4fe6dd97.0",
+    "@devvit/protos": "0.10.23-next-2024-06-13-8c5a69306.0",
+    "@devvit/shared-types": "0.10.23-next-2024-06-13-8c5a69306.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -41,7 +41,7 @@
     "@ampproject/filesize": "4.3.0",
     "@devvit/eslint-config": "0.10.22",
     "@devvit/repo-tools": "0.10.22",
-    "@devvit/tsconfig": "0.10.23-next-2024-06-13-b4fe6dd97.0",
+    "@devvit/tsconfig": "0.10.23-next-2024-06-13-8c5a69306.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "11.3.3",
     "@types/clone-deep": "4.0.1",
@@ -64,5 +64,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "d96d7aa0244d2710146e1a6d779c2e59863c9f58"
+  "gitHead": "b31c59acd646237d8ffcb68ffc82fd18a429476f"
 }