fix: support exactOptionalPropertyTypes for optional callbacks#1439
Open
codewithkenzo wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
fix: support exactOptionalPropertyTypes for optional callbacks#1439codewithkenzo wants to merge 1 commit intomodelcontextprotocol:mainfrom
codewithkenzo wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Add `| undefined` to optional callback properties to support TypeScript projects using `exactOptionalPropertyTypes: true`. Changes: - Transport interface: onclose, onerror, onmessage - WebStandardStreamableHTTPServerTransportOptions: sessionIdGenerator, onsessioninitialized, onsessionclosed This is the official TypeScript pattern for exactOptionalPropertyTypes compatibility, used by Radix UI, Material UI, and other major libraries. Fixes modelcontextprotocol#1397
🦋 Changeset detectedLatest commit: e943b7a 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: |
Author
|
Note: This PR is independent from #1433 (onerror callback fix) - they touch different parts of the code:
No conflicts - both can be merged independently. |
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
Adds
| undefinedto optional callback properties to support TypeScript projects usingexactOptionalPropertyTypes: true.Fixes #1397
Changes
Transport interface (
packages/core/src/shared/transport.ts):onclose?: (() => void) | undefinedonerror?: ((error: Error) => void) | undefinedonmessage?: (<T extends JSONRPCMessage>(...) => void) | undefinedWebStandardStreamableHTTPServerTransportOptions (
packages/server/src/server/streamableHttp.ts):sessionIdGenerator?: (() => string) | undefinedonsessioninitialized?: ((sessionId: string) => void | Promise<void>) | undefinedonsessionclosed?: ((sessionId: string) => void | Promise<void>) | undefinedWhy This Pattern
This is the official TypeScript pattern for
exactOptionalPropertyTypescompatibility. Used by Radix UI, Material UI, and other major libraries.Without this fix, users with strict TypeScript configs get errors like:
Testing
pnpm typecheck:allpassesauthExtensions.test.tsunrelated to this change)