fix(core): add | undefined to Transport optional callbacks for exactOptionalPropertyTypes compatibility#1661
Open
rechedev9 wants to merge 2 commits intomodelcontextprotocol:mainfrom
Conversation
…xactOptionalPropertyTypes compatibility Resolves TS2420 errors when users implement the Transport interface in projects with `exactOptionalPropertyTypes: true` enabled. Optional callback properties (onclose, onerror, onmessage, setProtocolVersion, setSupportedProtocolVersions) now include explicit `| undefined` in their types, satisfying the stricter assignability rules. Fixes modelcontextprotocol#1314
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
🦋 Changeset detectedLatest commit: 3052513 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
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
Fixes TS2420 errors when implementing the
Transportinterface in projects withexactOptionalPropertyTypes: trueenabled.The five optional callback/method properties on
Transportpreviously lacked explicit| undefined:With
exactOptionalPropertyTypes: true, TypeScript treatsT | undefinedandTas distinct in optional property contexts. A concrete class that declaresonclose?: (() => void) | undefinedis not assignable to an interface that declaresonclose?: () => voidunder this flag, producing TS2420.The fix adds explicit
| undefinedto all five optional members:This is backwards-compatible: projects not using
exactOptionalPropertyTypesare unaffected.Breaking Changes
None.
Test plan
packages/core/test/shared/transport.types.test.ts— compile-time type test verifying a class with explicit| undefinedcallbacks implementsTransportwithout errorspnpm typecheck:allpasses clean across all packagesFixes #1314