fix: support exactOptionalPropertyTypes in Transport interface#1507
Closed
corvid-agent wants to merge 1 commit intomodelcontextprotocol:mainfrom
Closed
fix: support exactOptionalPropertyTypes in Transport interface#1507corvid-agent wants to merge 1 commit intomodelcontextprotocol:mainfrom
corvid-agent wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
…tyTypes support When TypeScript's `exactOptionalPropertyTypes` is enabled, optional properties typed as `prop?: T` cannot be assigned `undefined` unless the type explicitly includes `| undefined`. This caused TS2420 errors when implementing the Transport interface. Update all optional callback/property types in the Transport interface, TransportSendOptions, and WebStandardStreamableHTTPServerTransportOptions to use the `| undefined` union pattern (e.g., `onclose?: (() => void) | undefined`). Fixes modelcontextprotocol#1314 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: c725192 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
|
In case anyone wants to fix this locally in advance, here's a
diff --git a/dist/esm/shared/transport.d.ts b/dist/esm/shared/transport.d.ts
index 1bd95efb41fcfd1ae09712ca968c57d828e0acaf..62ec4c109392f04141074d444b386882dfd2b052 100644
--- a/dist/esm/shared/transport.d.ts
+++ b/dist/esm/shared/transport.d.ts
@@ -62,13 +62,13 @@ export interface Transport {
*
* This should be invoked when close() is called as well.
*/
- onclose?: () => void;
+ onclose?: (() => void) | undefined;
/**
* Callback for when an error occurs.
*
* Note that errors are not necessarily fatal; they are used for reporting any kind of exceptional condition out of band.
*/
- onerror?: (error: Error) => void;
+ onerror?: ((error: Error) => void) | undefined;
/**
* Callback for when a message (request or response) is received over the connection.
*
@@ -76,11 +76,11 @@ export interface Transport {
*
* The requestInfo can be used to get the original request information (headers, etc.)
*/
- onmessage?: <T extends JSONRPCMessage>(message: T, extra?: MessageExtraInfo) => void;
+ onmessage?: (<T extends JSONRPCMessage>(message: T, extra?: MessageExtraInfo) => void) | undefined;
/**
* The session ID generated for this connection.
*/
- sessionId?: string;
+ sessionId?: string | undefined;
/**
* Sets the protocol version used for the connection (called when the initialize response is received).
*/
|
9 tasks
Contributor
|
Thanks for the contribution! Closing in favor of #1766. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
| undefinedto all optional properties in theTransportinterface,TransportSendOptionstype, andWebStandardStreamableHTTPServerTransportOptionsinterfaceexactOptionalPropertyTypescompiler option, which otherwise causesTS2420: Class incorrectly implements interfaceerrors when implementingTransportDetails
When
exactOptionalPropertyTypes: trueis enabled intsconfig.json, TypeScript distinguishes between "property may be missing" (prop?: T) and "property may be undefined" (prop?: T | undefined). Without the| undefinedunion, classes that declare optional properties (e.g.,onclose?: () => void) cannot be assignedundefinedat runtime, triggering type errors.Affected types:
Transport.onclose,Transport.onerror,Transport.onmessage,Transport.sessionId,Transport.setProtocolVersion,Transport.setSupportedProtocolVersionsTransportSendOptions.onresumptiontokenWebStandardStreamableHTTPServerTransportOptions.sessionIdGenerator,.onsessioninitialized,.onsessionclosedFixes #1314
Test plan
tsc --noEmitpasses for all packages (core, server, client, middleware/node, middleware/express, middleware/hono)| undefinedto optional property types🤖 Generated with Claude Code