fix: keep omitted channel sides strict

Author: posva

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

@@ -2,6 +2,7 @@ import type { AttachedChannelPort } from './internal'
 import type {
   CreatePageScriptChannelOptions,
   InPageChannelProtocol,
+  InPageFunctionDefinitionAny,
   PageScriptChannel,
   PageScriptChannelEvents,
   PanelPeer,
@@ -63,7 +64,7 @@ export function createPageScriptChannel<P extends InPageChannelProtocol>(
   let heartbeatTimer: ReturnType<typeof setInterval> | undefined
 
   const registry = createLocalFunctionRegistry(codec)
-  for (const [fnName, definition] of Object.entries(options.functions ?? {}))
+  for (const [fnName, definition] of Object.entries(options.functions) as [string, Omit<InPageFunctionDefinitionAny, 'name'>][])
     registry.register({ ...definition, name: fnName })
 
   const stateHost = createPageScriptStateHost<P>(function* () {

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

@@ -3,6 +3,7 @@ import type {
   ConnectPanelChannelOptions,
   InPageChannelProtocol,
   InPageChannelStatus,
+  InPageFunctionDefinitionAny,
   PanelChannel,
   PanelChannelEvents,
 } from './types'
@@ -62,7 +63,7 @@ export function connectPanelChannel<P extends InPageChannelProtocol>(
 
   const events = createEventEmitter<PanelChannelEvents>()
   const registry = createLocalFunctionRegistry(codec)
-  for (const [fnName, definition] of Object.entries(options.functions ?? {}))
+  for (const [fnName, definition] of Object.entries(options.functions) as [string, Omit<InPageFunctionDefinitionAny, 'name'>][])
     registry.register({ ...definition, name: fnName })
 
   let status: InPageChannelStatus = 'connecting'

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

@@ -14,6 +14,12 @@ interface TestProtocol extends InPageChannelProtocol {
   }
 }
 
+interface PageScriptOnlyProtocol extends InPageChannelProtocol {
+  pageScript: {
+    echo: (value: string) => string
+  }
+}
+
 describe('In-page script channel', () => {
   const channel = createPageScriptChannel<TestProtocol>({
     name: 'devframes:test',
@@ -117,6 +123,18 @@ describe('In-page script channel', () => {
       // @ts-expect-error `notify` requires a string.
       panel.call('notify', false)
     })
+
+    it('rejects calls when the protocol omits panel functions', () => {
+      const pageScriptOnlyChannel = createPageScriptChannel<PageScriptOnlyProtocol>({
+        name: 'devframes:page-script-only',
+        functions: {
+          echo: { handler: value => value },
+        },
+      })
+
+      // @ts-expect-error The protocol has no panel functions.
+      pageScriptOnlyChannel.callEvent('notify', 'ready')
+    })
   })
 
   describe('Event checking', () => {
@@ -200,6 +218,21 @@ describe('Panel channel', () => {
         },
       })
     })
+
+    it('rejects definitions when the protocol omits panel functions', () => {
+      connectPanelChannel<PageScriptOnlyProtocol>({
+        name: 'devframes:page-script-only',
+        functions: {},
+      })
+
+      connectPanelChannel<PageScriptOnlyProtocol>({
+        name: 'devframes:page-script-only',
+        functions: {
+          // @ts-expect-error The protocol has no panel functions.
+          notify: { handler: () => {} },
+        },
+      })
+    })
   })
 
   describe('Function calling', () => {

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

@@ -22,9 +22,13 @@ export interface InPageChannelProtocol {
   sharedStates?: Record<string, object>
 }
 
-type SideFunctions<S> = S extends Record<string, (...args: any[]) => any> ? S : Record<string, never>
-type PageScriptFunctions<P extends InPageChannelProtocol> = SideFunctions<NonNullable<P['pageScript']>>
-type PanelFunctions<P extends InPageChannelProtocol> = SideFunctions<NonNullable<P['panel']>>
+type SideFunctions<P, S> = InPageChannelProtocol extends P
+  ? Record<string, (...args: any[]) => any>
+  : S extends Record<string, (...args: any[]) => any>
+    ? string extends keyof S ? Record<never, never> : S
+    : Record<never, never>
+type PageScriptFunctions<P extends InPageChannelProtocol> = SideFunctions<P, NonNullable<P['pageScript']>>
+type PanelFunctions<P extends InPageChannelProtocol> = SideFunctions<P, NonNullable<P['panel']>>
 type SharedStates<P extends InPageChannelProtocol>
   = P['sharedStates'] extends Record<string, object> ? P['sharedStates'] : Record<string, never>
 
@@ -113,7 +117,9 @@ interface InPageFunctionOption<F> {
  */
 type CreatePageScriptChannelOptionsFunctions<P extends InPageChannelProtocol> = {
   [NAME in keyof PageScriptFunctions<P> & string]: InPageFunctionOption<PageScriptFunctions<P>[NAME]>
-}
+} extends infer FUNCTIONS
+  ? keyof FUNCTIONS extends never ? Record<string, never> : FUNCTIONS
+  : never
 
 /**
  * Functions implemented by {@link connectPanelChannel}.
@@ -122,7 +128,9 @@ type CreatePageScriptChannelOptionsFunctions<P extends InPageChannelProtocol> =
  */
 type ConnectPanelChannelOptionsFunctions<P extends InPageChannelProtocol> = {
   [NAME in keyof PanelFunctions<P> & string]: InPageFunctionOption<PanelFunctions<P>[NAME]>
-}
+} extends infer FUNCTIONS
+  ? keyof FUNCTIONS extends never ? Record<string, never> : FUNCTIONS
+  : never
 
 /**
  * Connection lifecycle of a panel endpoint: `connecting` (handshake retry