feat: type in-page channel functions from protocol by posva · Pull Request #314 · devframes/devframe

posva · 2026-08-27T15:57:10Z

No description provided.

vercel · 2026-08-27T15:57:17Z

@posva is attempting to deploy a commit to the NuxtLabs Team on Vercel.

A member of the Team first needs to authorize it.

posva · 2026-08-27T16:32:34Z

I still want to improve the functions type: I think ideally it should be an object so that all functions are defined and it emits a type error if any is missing

posva · 2026-08-28T08:19:02Z

  const registry = createLocalFunctionRegistry(codec)
-  for (const definition of options.functions ?? [])
-    registry.register(definition)
+  for (const [fnName, definition] of Object.entries(options.functions ?? {}))


Here we could use for in, it's a bit faster but goes through inherited properties, which in the case of functions, should be none unless someone pollutes the object prototype. I kept it this way because it shouldn't change much in the end

posva · 2026-08-28T08:19:55Z

  const registry = createLocalFunctionRegistry(codec)
-  for (const definition of options.functions ?? [])
-    registry.register(definition)
+  for (const [fnName, definition] of Object.entries(options.functions ?? {}))


same as in page-script.ts

posva · 2026-08-28T08:43:32Z

-export interface CreatePageScriptChannelOptions extends InPageChannelCommonOptions {
+export interface CreatePageScriptChannelOptions<Protocol extends InPageChannelProtocol = InPageChannelProtocol> extends InPageChannelCommonOptions {
+  /** Implementations of the protocol's page-script functions. */
+  functions: CreatePageScriptChannelOptionsFunctions<Protocol>


I made the functions intentionally required here because you usually must define them and is more type safe

Copilot

Pull request overview

This PR refactors devframe/in-page-channel to type each endpoint’s registered function handlers directly from the shared InPageChannelProtocol, switching function registration from an array of named definitions to an object keyed by function name. This improves type inference and enforces that each endpoint implements the functions declared for its side of the protocol.

Changes:

Updated in-page channel endpoint options to require functions as an object keyed by protocol function names, with handlers contextually typed from the protocol.
Migrated the a11y devframe’s page script + panel channel wiring to the new functions object shape.
Added/updated Vitest type tests (*.test-d.ts) and runtime tests to validate the new typing and registration behavior.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
plugins/a11y/src/spa/lib/channel.ts	Updates panel endpoint channel connection to provide required `functions: {}` under the new options shape.
plugins/a11y/src/inject/index.ts	Migrates page script endpoint function registration from `defineChannelFunction[]` to an object keyed by protocol function names.
packages/devframe/vitest.config.ts	Adds a per-package Vitest config enabling typecheck runs for `devframe`.
packages/devframe/src/in-page-channel/types.ts	Introduces protocol-keyed typing for endpoint `functions` options and makes `functions` required per endpoint.
packages/devframe/src/in-page-channel/types.test-d.ts	Adds type-level tests ensuring handler inference and correct call-site typing for both endpoints.
packages/devframe/src/in-page-channel/panel.ts	Switches function registration to iterate object entries and register definitions by key name.
packages/devframe/src/in-page-channel/page-script.ts	Switches function registration to iterate object entries and register definitions by key name.
packages/devframe/src/in-page-channel/in-page-channel.test.ts	Updates runtime tests to the new `functions` object shape and adds typed defaults for reuse.
docs/content/1.guide/12.in-page-channel.md	Updates documentation examples to the new `functions` object keyed API.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

  const registry = createLocalFunctionRegistry(codec)
-  for (const definition of options.functions ?? [])
-    registry.register(definition)
+  for (const [fnName, definition] of Object.entries(options.functions ?? {}))
+    registry.register({ ...definition, name: fnName })


  const registry = createLocalFunctionRegistry(codec)
-  for (const definition of options.functions ?? [])
-    registry.register(definition)
+  for (const [fnName, definition] of Object.entries(options.functions ?? {}))
+    registry.register({ ...definition, name: fnName })


vercel · 2026-08-28T09:52:19Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
devframe	Ready	Preview	Aug 28, 2026 10:12am

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

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

options.functions is an object keyed by function name, but any name field present on the provided definition is silently ignored/overwritten by the key. This is a footgun if someone reuses defineChannelFunction({ name: ... }) (or otherwise includes name) and the key/name diverge — the function will be registered under the key, and remote calls to the definition.name will fail at runtime. Consider validating key/name consistency before registering to fail fast.

  for (const [fnName, definition] of Object.entries(options.functions ?? {}))
    registry.register({ ...definition, name: fnName })

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

options.functions is keyed by function name, but any name field on a provided definition is silently ignored/overwritten by the key. If a caller passes a named definition (e.g. from defineChannelFunction) with a mismatched key, the handler will be registered under the key and calls to the declared name will fail at runtime. Validating the key/name match here would make these mistakes fail fast.

  const registry = createLocalFunctionRegistry(codec)
  for (const [fnName, definition] of Object.entries(options.functions ?? {}))
    registry.register({ ...definition, name: fnName })

+  const channel = connectPanelChannel<A11yChannelProtocol>({
+    name: A11Y_CHANNEL,
+    functions: {},
+  })


+export interface CreatePageScriptChannelOptions<Protocol extends InPageChannelProtocol = InPageChannelProtocol> extends InPageChannelCommonOptions {
+  /** Implementations of the protocol's page-script functions. */
+  functions: CreatePageScriptChannelOptionsFunctions<Protocol>


Copilot

Pull request overview

Copilot reviewed 10 out of 11 changed files in this pull request and generated no new comments.

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

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

The returns field is documented as a Standard Schema that validates the resolved return value, but the current in-page channel implementation never reads definition.returns (only definition.args is validated). This comment is misleading unless return-value validation is implemented.

  jsonSerializable?: boolean
  handler: ProtocolHandler<F>
}

/**

docs/content/1.guide/12.in-page-channel.md:57

This section says the in-page channel uses Standard-Schema args/returns, but the current implementation only performs runtime validation for args (there is no return-value validation). The wording should avoid implying return schemas are enforced.

Functions use the same authoring metadata as `defineRpcFunction` (`type`, Standard-Schema `args`/`returns`, `jsonSerializable`, `handler`), narrowed to the browser. The required `functions` object's keys are the function names, and it implements every function on that endpoint's protocol side. Each handler is contextually typed from its key and the corresponding function in the protocol. `defineChannelFunction` retains the named definition shape for lower-level authoring. Define each side's functions in that side's source files; the shared protocol file carries only types.

Copilot

Pull request overview

Copilot reviewed 10 out of 11 changed files in this pull request and generated no new comments.

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

packages/devframe/src/in-page-channel/in-page-channel.test.ts:207

The comment says panel B has no local functions "in its protocol", but the generic type used here is the broad InPageChannelProtocol (not a protocol with an explicit empty panel map). This can read as if the protocol type itself is empty rather than just the local handler map being empty. Consider rewording to describe the implementation intent (no local handlers) to avoid confusion for future readers.

    // Panel B deliberately has no local functions in its protocol.
    const panelB = connectPanelChannel<InPageChannelProtocol>({

posva · 2026-08-28T12:23:09Z

 * results flow back through the shared state.
 */
-export interface A11yChannelProtocol extends InPageChannelProtocol {
+export interface A11yChannelProtocol {


The extends makes it get panel: Record<string, ...> which allows anything

feat: type in-page channel functions from protocol

474a0fa

refactor: require in-page channel function maps

23b3ced

posva commented Aug 28, 2026

View reviewed changes

posva added 4 commits August 28, 2026 10:28

refactor: simplify in-page channel option types

6598c40

test: cover in-page channel endpoint types

4e1634b

refactor: require in-page channel functions

91178a5

test: organize in-page channel type coverage

1c06428

posva commented Aug 28, 2026

View reviewed changes

posva marked this pull request as ready for review August 28, 2026 09:39

Copilot AI lite review requested due to automatic review settings August 28, 2026 09:39

Copilot started reviewing on behalf of posva August 28, 2026 09:40 View session

Copilot AI reviewed Aug 28, 2026

View reviewed changes

test: update in-page channel API snapshot

3947113

Copilot AI review requested due to automatic review settings August 28, 2026 09:45

Copilot started reviewing on behalf of posva August 28, 2026 09:46 View session

Copilot AI reviewed Aug 28, 2026

View reviewed changes

vercel Bot deployed to Preview August 28, 2026 09:53 View deployment

fix: keep omitted channel sides strict

9541c9a

Copilot AI review requested due to automatic review settings August 28, 2026 10:04

Copilot started reviewing on behalf of posva August 28, 2026 10:05 View session

fix: declare empty a11y panel protocol

28503b5

Copilot AI reviewed Aug 28, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings August 28, 2026 10:11

Copilot started reviewing on behalf of posva August 28, 2026 10:12 View session

vercel Bot deployed to Preview August 28, 2026 10:12 View deployment

Copilot AI reviewed Aug 28, 2026

View reviewed changes

posva commented Aug 28, 2026

View reviewed changes

Navigation Menu

Uh oh!

feat: type in-page channel functions from protocol - #314

feat: type in-page channel functions from protocol#314
posva wants to merge 9 commits into
devframes:mainfrom
posva:feat/in-page-channel-protocol-functions

posva commented Aug 27, 2026

Uh oh!

vercel Bot commented Aug 27, 2026

Uh oh!

posva commented Aug 27, 2026

Uh oh!

posva Aug 28, 2026 •

edited

Loading

Uh oh!

posva Aug 28, 2026

Uh oh!

posva Aug 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

vercel Bot commented Aug 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

posva Aug 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

posva commented Aug 27, 2026

Uh oh!

vercel Bot commented Aug 27, 2026

Uh oh!

posva commented Aug 27, 2026

Uh oh!

posva Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

posva Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

posva Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

vercel Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

posva Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

posva Aug 28, 2026 •

edited

Loading

vercel Bot commented Aug 28, 2026 •

edited

Loading