Skip to content

Fix the SDK vs Spec types test that is breaking CI #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 29, 2025
+38 −31
Merged

Fix the SDK vs Spec types test that is breaking CI #908

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e408f97
* In jest.config.js,
cliffhall Aug 29, 2025
40282aa
* In jest.config.js,
cliffhall Aug 29, 2025
52fb760
Remove comment from jest.config.js
cliffhall Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 38 additions & 31 deletions src/spec.types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ type RemovePassthrough<T> = T extends object
: {[K in keyof T as string extends K ? never : K]: RemovePassthrough<T[K]>}
: T;

// Adds the `jsonrpc` property to a type, to match the on-wire format of notifications.
type WithJSONRPC<T> = T & { jsonrpc: "2.0" };

// Adds the `jsonrpc` and `id` properties to a type, to match the on-wire format of requests.
type WithJSONRPCRequest<T> = T & { jsonrpc: "2.0"; id: SDKTypes.RequestId };

Comment on lines +24 to +29
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a reasonable approach matching the other generics here to bridge the gap between SDK types and the JSONRPC types.

type IsUnknown<T> = [unknown] extends [T] ? [T] extends [unknown] ? true : false : false;

// Turns {x?: unknown} into {x: unknown} but keeps {_meta?: unknown} unchanged (and leaves other optional properties unchanged, e.g. {x?: string}).
Expand Down Expand Up @@ -48,7 +54,7 @@ type MakeUnknownsNotOptional<T> =
: T);

function checkCancelledNotification(
sdk: SDKTypes.CancelledNotification,
sdk: WithJSONRPC<SDKTypes.CancelledNotification>,
spec: SpecTypes.CancelledNotification
) {
sdk = spec;
Expand All @@ -69,29 +75,29 @@ function checkImplementation(
spec = sdk;
}
function checkProgressNotification(
sdk: SDKTypes.ProgressNotification,
sdk: WithJSONRPC<SDKTypes.ProgressNotification>,
spec: SpecTypes.ProgressNotification
) {
sdk = spec;
spec = sdk;
}

function checkSubscribeRequest(
sdk: SDKTypes.SubscribeRequest,
sdk: WithJSONRPCRequest<SDKTypes.SubscribeRequest>,
spec: SpecTypes.SubscribeRequest
) {
sdk = spec;
spec = sdk;
}
function checkUnsubscribeRequest(
sdk: SDKTypes.UnsubscribeRequest,
sdk: WithJSONRPCRequest<SDKTypes.UnsubscribeRequest>,
spec: SpecTypes.UnsubscribeRequest
) {
sdk = spec;
spec = sdk;
}
function checkPaginatedRequest(
sdk: SDKTypes.PaginatedRequest,
sdk: WithJSONRPCRequest<SDKTypes.PaginatedRequest>,
spec: SpecTypes.PaginatedRequest
) {
sdk = spec;
Expand All @@ -105,7 +111,7 @@ function checkPaginatedResult(
spec = sdk;
}
function checkListRootsRequest(
sdk: SDKTypes.ListRootsRequest,
sdk: WithJSONRPCRequest<SDKTypes.ListRootsRequest>,
spec: SpecTypes.ListRootsRequest
) {
sdk = spec;
Expand All @@ -126,7 +132,7 @@ function checkRoot(
spec = sdk;
}
function checkElicitRequest(
sdk: RemovePassthrough<SDKTypes.ElicitRequest>,
sdk: WithJSONRPCRequest<RemovePassthrough<SDKTypes.ElicitRequest>>,
spec: SpecTypes.ElicitRequest
) {
sdk = spec;
Expand All @@ -140,7 +146,7 @@ function checkElicitResult(
spec = sdk;
}
function checkCompleteRequest(
sdk: RemovePassthrough<SDKTypes.CompleteRequest>,
sdk: WithJSONRPCRequest<RemovePassthrough<SDKTypes.CompleteRequest>>,
spec: SpecTypes.CompleteRequest
) {
sdk = spec;
Expand Down Expand Up @@ -231,7 +237,7 @@ function checkClientResult(
spec = sdk;
}
function checkClientNotification(
sdk: SDKTypes.ClientNotification,
sdk: WithJSONRPC<SDKTypes.ClientNotification>,
spec: SpecTypes.ClientNotification
) {
sdk = spec;
Expand Down Expand Up @@ -273,7 +279,7 @@ function checkTool(
spec = sdk;
}
function checkListToolsRequest(
sdk: SDKTypes.ListToolsRequest,
sdk: WithJSONRPCRequest<SDKTypes.ListToolsRequest>,
spec: SpecTypes.ListToolsRequest
) {
sdk = spec;
Expand All @@ -294,42 +300,42 @@ function checkCallToolResult(
spec = sdk;
}
function checkCallToolRequest(
sdk: SDKTypes.CallToolRequest,
sdk: WithJSONRPCRequest<SDKTypes.CallToolRequest>,
spec: SpecTypes.CallToolRequest
) {
sdk = spec;
spec = sdk;
}
function checkToolListChangedNotification(
sdk: SDKTypes.ToolListChangedNotification,
sdk: WithJSONRPC<SDKTypes.ToolListChangedNotification>,
spec: SpecTypes.ToolListChangedNotification
) {
sdk = spec;
spec = sdk;
}
function checkResourceListChangedNotification(
sdk: SDKTypes.ResourceListChangedNotification,
sdk: WithJSONRPC<SDKTypes.ResourceListChangedNotification>,
spec: SpecTypes.ResourceListChangedNotification
) {
sdk = spec;
spec = sdk;
}
function checkPromptListChangedNotification(
sdk: SDKTypes.PromptListChangedNotification,
sdk: WithJSONRPC<SDKTypes.PromptListChangedNotification>,
spec: SpecTypes.PromptListChangedNotification
) {
sdk = spec;
spec = sdk;
}
function checkRootsListChangedNotification(
sdk: SDKTypes.RootsListChangedNotification,
sdk: WithJSONRPC<SDKTypes.RootsListChangedNotification>,
spec: SpecTypes.RootsListChangedNotification
) {
sdk = spec;
spec = sdk;
}
function checkResourceUpdatedNotification(
sdk: SDKTypes.ResourceUpdatedNotification,
sdk: WithJSONRPC<SDKTypes.ResourceUpdatedNotification>,
spec: SpecTypes.ResourceUpdatedNotification
) {
sdk = spec;
Expand All @@ -350,28 +356,28 @@ function checkCreateMessageResult(
spec = sdk;
}
function checkSetLevelRequest(
sdk: SDKTypes.SetLevelRequest,
sdk: WithJSONRPCRequest<SDKTypes.SetLevelRequest>,
spec: SpecTypes.SetLevelRequest
) {
sdk = spec;
spec = sdk;
}
function checkPingRequest(
sdk: SDKTypes.PingRequest,
sdk: WithJSONRPCRequest<SDKTypes.PingRequest>,
spec: SpecTypes.PingRequest
) {
sdk = spec;
spec = sdk;
}
function checkInitializedNotification(
sdk: SDKTypes.InitializedNotification,
sdk: WithJSONRPC<SDKTypes.InitializedNotification>,
spec: SpecTypes.InitializedNotification
) {
sdk = spec;
spec = sdk;
}
function checkListResourcesRequest(
sdk: SDKTypes.ListResourcesRequest,
sdk: WithJSONRPCRequest<SDKTypes.ListResourcesRequest>,
spec: SpecTypes.ListResourcesRequest
) {
sdk = spec;
Expand All @@ -385,7 +391,7 @@ function checkListResourcesResult(
spec = sdk;
}
function checkListResourceTemplatesRequest(
sdk: SDKTypes.ListResourceTemplatesRequest,
sdk: WithJSONRPCRequest<SDKTypes.ListResourceTemplatesRequest>,
spec: SpecTypes.ListResourceTemplatesRequest
) {
sdk = spec;
Expand All @@ -399,7 +405,7 @@ function checkListResourceTemplatesResult(
spec = sdk;
}
function checkReadResourceRequest(
sdk: SDKTypes.ReadResourceRequest,
sdk: WithJSONRPCRequest<SDKTypes.ReadResourceRequest>,
spec: SpecTypes.ReadResourceRequest
) {
sdk = spec;
Expand Down Expand Up @@ -462,7 +468,7 @@ function checkPrompt(
spec = sdk;
}
function checkListPromptsRequest(
sdk: SDKTypes.ListPromptsRequest,
sdk: WithJSONRPCRequest<SDKTypes.ListPromptsRequest>,
spec: SpecTypes.ListPromptsRequest
) {
sdk = spec;
Expand All @@ -476,7 +482,7 @@ function checkListPromptsResult(
spec = sdk;
}
function checkGetPromptRequest(
sdk: SDKTypes.GetPromptRequest,
sdk: WithJSONRPCRequest<SDKTypes.GetPromptRequest>,
spec: SpecTypes.GetPromptRequest
) {
sdk = spec;
Expand Down Expand Up @@ -588,14 +594,14 @@ function checkJSONRPCMessage(
spec = sdk;
}
function checkCreateMessageRequest(
sdk: RemovePassthrough<SDKTypes.CreateMessageRequest>,
sdk: WithJSONRPCRequest<RemovePassthrough<SDKTypes.CreateMessageRequest>>,
spec: SpecTypes.CreateMessageRequest
) {
sdk = spec;
spec = sdk;
}
function checkInitializeRequest(
sdk: RemovePassthrough<SDKTypes.InitializeRequest>,
sdk: WithJSONRPCRequest<RemovePassthrough<SDKTypes.InitializeRequest>>,
spec: SpecTypes.InitializeRequest
) {
sdk = spec;
Expand Down Expand Up @@ -623,28 +629,28 @@ function checkServerCapabilities(
spec = sdk;
}
function checkClientRequest(
sdk: RemovePassthrough<SDKTypes.ClientRequest>,
sdk: WithJSONRPCRequest<RemovePassthrough<SDKTypes.ClientRequest>>,
spec: SpecTypes.ClientRequest
) {
sdk = spec;
spec = sdk;
}
function checkServerRequest(
sdk: RemovePassthrough<SDKTypes.ServerRequest>,
sdk: WithJSONRPCRequest<RemovePassthrough<SDKTypes.ServerRequest>>,
spec: SpecTypes.ServerRequest
) {
sdk = spec;
spec = sdk;
}
function checkLoggingMessageNotification(
sdk: MakeUnknownsNotOptional<SDKTypes.LoggingMessageNotification>,
sdk: MakeUnknownsNotOptional<WithJSONRPC<SDKTypes.LoggingMessageNotification>>,
spec: SpecTypes.LoggingMessageNotification
) {
sdk = spec;
spec = sdk;
}
function checkServerNotification(
sdk: MakeUnknownsNotOptional<SDKTypes.ServerNotification>,
sdk: MakeUnknownsNotOptional<WithJSONRPC<SDKTypes.ServerNotification>>,
spec: SpecTypes.ServerNotification
) {
sdk = spec;
Expand All @@ -665,6 +671,7 @@ const SDK_TYPES_FILE = 'src/types.ts';
const MISSING_SDK_TYPES = [
// These are inlined in the SDK:
'Role',
'Error', // The inner error object of a JSONRPCError

// These aren't supported by the SDK yet:
// TODO: Add definitions to the SDK
Expand All @@ -685,7 +692,7 @@ describe('Spec Types', () => {
it('should define some expected types', () => {
expect(specTypes).toContain('JSONRPCNotification');
expect(specTypes).toContain('ElicitResult');
expect(specTypes).toHaveLength(91);
expect(specTypes).toHaveLength(92);
});

it('should have up to date list of missing sdk types', () => {
Expand Down