fix: restrict in-page emits to events

Author: posva

packages/devframe/src/in-page-channel/types.test-d.ts

@@ -148,6 +148,7 @@ describe('In-page script channel', () => {
   describe('Function calling', () => {
     it('types fire-and-forget calls to panel functions', () => {
       expectTypeOf(channel.emit('notify', 'ready')).toEqualTypeOf<void>()
+      expectTypeOf(channel.callEvent('notify', 'ready')).toEqualTypeOf<void>()
 
       // @ts-expect-error In-page script functions cannot be called on panels.
       channel.emit('echo', 'ready')
@@ -159,6 +160,19 @@ describe('In-page script channel', () => {
       channel.emit('notify', 'ready', 'extra')
     })
 
+    it('rejects fire-and-forget calls to panel queries', () => {
+      const mixedChannel = createPageScriptChannel<MixedPanelProtocol>({
+        name: 'devframes:mixed-panel',
+        functions: {},
+      })
+
+      mixedChannel.emit('notify', 'ready')
+      // @ts-expect-error Queries cannot be emitted as events.
+      mixedChannel.emit('confirm', 'continue?')
+      // @ts-expect-error The deprecated alias has the same event-only contract.
+      mixedChannel.callEvent('confirm', 'continue?')
+    })
+
     it('types calls to connected panels', () => {
       const panel = channel.panels[0]!
 
@@ -330,16 +344,19 @@ describe('Panel channel', () => {
     })
 
     it('types fire-and-forget calls to in-page script functions', () => {
-      expectTypeOf(channel.emit('echo', 'hello')).toEqualTypeOf<void>()
-      expectTypeOf(channel.emit('sum', 1, 2)).toEqualTypeOf<void>()
       expectTypeOf(channel.emit('save', 'draft')).toEqualTypeOf<void>()
+      expectTypeOf(channel.callEvent('save', 'draft')).toEqualTypeOf<void>()
 
       // @ts-expect-error Panel functions cannot be emitted to the in-page script.
       channel.emit('notify', 'hello')
-      // @ts-expect-error `echo` requires a string.
-      channel.emit('echo', false)
-      // @ts-expect-error `sum` requires two arguments.
-      channel.emit('sum', 1)
+      // @ts-expect-error Queries cannot be emitted as events.
+      channel.emit('echo', 'hello')
+      // @ts-expect-error Queries cannot be emitted as events.
+      channel.emit('sum', 1, 2)
+      // @ts-expect-error `save` requires a string.
+      channel.emit('save', false)
+      // @ts-expect-error The deprecated alias has the same event-only contract.
+      channel.callEvent('echo', 'hello')
     })
 
     it('types channel state', () => {

packages/devframe/src/in-page-channel/types.ts

@@ -346,14 +346,14 @@ export interface PageScriptChannel<P extends InPageChannelProtocol> {
   readonly panels: readonly PanelPeer<P>[]
   readonly events: Pick<EventEmitter<PageScriptChannelEvents<P>>, 'on' | 'once'>
   /** Fan an event out to every connected panel. */
-  emit: <K extends keyof PanelFunctions<P> & string>(
+  emit: <K extends keyof PanelFunctionsEvents<P> & string>(
     name: K,
-    ...args: FnArgs<PanelFunctions<P>[K]>
+    ...args: FnArgs<PanelFunctionsEvents<P>[K]>
   ) => void
   /** @deprecated Use `emit()` instead. */
-  callEvent: <K extends keyof PanelFunctions<P> & string>(
+  callEvent: <K extends keyof PanelFunctionsEvents<P> & string>(
     name: K,
-    ...args: FnArgs<PanelFunctions<P>[K]>
+    ...args: FnArgs<PanelFunctionsEvents<P>[K]>
   ) => void
   /** Subscribe to an event emitted by a panel. Returns an unsubscribe function. */
   on: <K extends keyof PageScriptFunctionsEvents<P> & string>(
@@ -403,14 +403,14 @@ export interface PanelChannel<P extends InPageChannelProtocol> {
    * Emit an event to the page script. While `connecting` the event is buffered
    * (up to `eventBufferLimit`) and flushed on connect.
    */
-  emit: <K extends keyof PageScriptFunctions<P> & string>(
+  emit: <K extends keyof PageScriptFunctionsEvents<P> & string>(
     name: K,
-    ...args: FnArgs<PageScriptFunctions<P>[K]>
+    ...args: FnArgs<PageScriptFunctionsEvents<P>[K]>
   ) => void
   /** @deprecated Use `emit()` instead. */
-  callEvent: <K extends keyof PageScriptFunctions<P> & string>(
+  callEvent: <K extends keyof PageScriptFunctionsEvents<P> & string>(
     name: K,
-    ...args: FnArgs<PageScriptFunctions<P>[K]>
+    ...args: FnArgs<PageScriptFunctionsEvents<P>[K]>
   ) => void
   /** Subscribe to an event emitted by the page script. Returns an unsubscribe function. */
   on: <K extends keyof PanelFunctionsEvents<P> & string>(

tests/__snapshots__/tsnapi/devframe/in-page-channel.snapshot.d.ts

@@ -25,8 +25,8 @@ export interface PageScriptChannel<P extends InPageChannelProtocol> {
   readonly instanceId: string;
   readonly panels: readonly PanelPeer<P>[];
   readonly events: Pick<EventEmitter<PageScriptChannelEvents<P>>, 'on' | 'once'>;
-  emit: <K extends keyof PanelFunctions<P> & string>(_: K, ..._: FnArgs<PanelFunctions<P>[K]>) => void;
-  callEvent: <K extends keyof PanelFunctions<P> & string>(_: K, ..._: FnArgs<PanelFunctions<P>[K]>) => void;
+  emit: <K extends keyof PanelFunctionsEvents<P> & string>(_: K, ..._: FnArgs<PanelFunctionsEvents<P>[K]>) => void;
+  callEvent: <K extends keyof PanelFunctionsEvents<P> & string>(_: K, ..._: FnArgs<PanelFunctionsEvents<P>[K]>) => void;
   on: <K extends keyof PageScriptFunctionsEvents<P> & string>(_: K, _: (..._: FnArgs<PageScriptFunctionsEvents<P>[K]>) => void) => () => void;
   readonly sharedState: InPageSharedStateHost<P>;
   addPanelPort: (_: MessagePort) => PanelPeer<P>;
@@ -41,8 +41,8 @@ export interface PanelChannel<P extends InPageChannelProtocol> {
   readonly events: Pick<EventEmitter<PanelChannelEvents>, 'on' | 'once'>;
   whenConnected: (_?: number) => Promise<void>;
   call: <K extends keyof PageScriptFunctions<P> & string>(_: K, ..._: FnArgs<PageScriptFunctions<P>[K]>) => Promise<FnReturn<PageScriptFunctions<P>[K]>>;
-  emit: <K extends keyof PageScriptFunctions<P> & string>(_: K, ..._: FnArgs<PageScriptFunctions<P>[K]>) => void;
-  callEvent: <K extends keyof PageScriptFunctions<P> & string>(_: K, ..._: FnArgs<PageScriptFunctions<P>[K]>) => void;
+  emit: <K extends keyof PageScriptFunctionsEvents<P> & string>(_: K, ..._: FnArgs<PageScriptFunctionsEvents<P>[K]>) => void;
+  callEvent: <K extends keyof PageScriptFunctionsEvents<P> & string>(_: K, ..._: FnArgs<PageScriptFunctionsEvents<P>[K]>) => void;
   on: <K extends keyof PanelFunctionsEvents<P> & string>(_: K, _: (..._: FnArgs<PanelFunctionsEvents<P>[K]>) => void) => () => void;
   readonly sharedState: InPageSharedStateHost<P>;
   close: () => void;