Skip to content

fix: tanstack inference #111

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 2 commits into from
Sep 1, 2025
Merged

fix: tanstack inference #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b47729
fix: tanstack inference in some edge cases
astahmer Sep 1, 2025
80b1372
chore: changeset
astahmer Sep 1, 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
5 changes: 5 additions & 0 deletions .changeset/good-baboons-dress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"typed-openapi": patch
---

fix: tanstack inference in some edge cases
15 changes: 10 additions & 5 deletions packages/typed-openapi/src/tanstack-query.generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati

const file = `
import { queryOptions } from "@tanstack/react-query"
import type { EndpointByMethod, ApiClient, SuccessStatusCode, ErrorStatusCode, InferResponseByStatus } from "${ctx.relativeApiClientPath}"
import type { EndpointByMethod, ApiClient, SuccessStatusCode, ErrorStatusCode, InferResponseByStatus, TypedSuccessResponse } from "${ctx.relativeApiClientPath}"
import { errorStatusCodes, TypedResponseError } from "${ctx.relativeApiClientPath}"

type EndpointQueryKey<TOptions extends EndpointParameters> = [
Expand Down Expand Up @@ -66,6 +66,11 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati

type MaybeOptionalArg<T> = RequiredKeys<T> extends never ? [config?: T] : [config: T];

type InferResponseData<TEndpoint, TStatusCode> = TypedSuccessResponse<any, any, any> extends
InferResponseByStatus<TEndpoint, TStatusCode>
? Extract<InferResponseByStatus<TEndpoint, TStatusCode>, { data: {}}>["data"]
: Extract<InferResponseByStatus<TEndpoint, TStatusCode>["data"], {}>;

// </ApiClientTypes>

// <ApiClient>
Expand Down Expand Up @@ -98,7 +103,7 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
withResponse: false as const
};
const res = await this.client.${method}(path, requestParams as never);
return res as Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"];
return res as InferResponseData<TEndpoint, SuccessStatusCode>;
},
queryKey: queryKey
}),
Expand All @@ -123,7 +128,7 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
TWithResponse extends boolean = false,
TSelection = TWithResponse extends true
? InferResponseByStatus<TEndpoint, SuccessStatusCode>
: Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"],
: InferResponseData<TEndpoint, SuccessStatusCode>,
TError = TEndpoint extends { responses: infer TResponses }
? TResponses extends Record<string | number, unknown>
? InferResponseByStatus<TEndpoint, ErrorStatusCode>
Expand All @@ -133,15 +138,15 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
withResponse?: TWithResponse;
selectFn?: (res: TWithResponse extends true
? InferResponseByStatus<TEndpoint, SuccessStatusCode>
: Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"]
: InferResponseData<TEndpoint, SuccessStatusCode>
) => TSelection;
throwOnStatusError?: boolean
throwOnError?: boolean | ((error: TError) => boolean)
}) {
const mutationKey = [{ method, path }] as const;
const mutationFn = async <TLocalWithResponse extends boolean = TWithResponse, TLocalSelection = TLocalWithResponse extends true
? InferResponseByStatus<TEndpoint, SuccessStatusCode>
: Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"]>
: InferResponseData<TEndpoint, SuccessStatusCode>>
(params: (TEndpoint extends { parameters: infer Parameters } ? Parameters : {}) & {
withResponse?: TLocalWithResponse;
throwOnStatusError?: boolean;
Expand Down
17 changes: 16 additions & 1 deletion packages/typed-openapi/tests/integration.types.tstyche.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Integration test for generated query client using TSTyche
// This test ensures the generated client (TS types only, no schema validation) has no inference errors

import { mutationOptions, queryOptions, useMutation } from "@tanstack/react-query";
import { mutationOptions, queryOptions, useMutation, useQuery } from "@tanstack/react-query";
import { describe, expect, it } from "tstyche";
import {
type Endpoints,
Expand Down Expand Up @@ -438,4 +438,19 @@ describe("Example API Client", () => {
queryOptions(query);
queryOptions(query.queryOptions);
});

it("TanstackQueryApiClient useQuery withResponse: undefined (global+local)", async () => {
const tanstack = {} as TanstackQueryApiClient;

const queryWithSomeResponseUnknownData = tanstack.get("/pet/findByStatus", { query: {status: "available"} });
const queryHook = useQuery(queryWithSomeResponseUnknownData.queryOptions);

expect(queryHook.data).type.toBe<Schemas.Pet[]|undefined>();
// ^?

const secondQuery = tanstack.get("/pet/custom");
const secondQueryHook = useQuery(secondQuery.queryOptions);
expect(secondQueryHook.data).type.toBe<Schemas.Pet|undefined>();
// ^?
});
});
20 changes: 13 additions & 7 deletions packages/typed-openapi/tests/tanstack-query.generator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ describe("generator", () => {
SuccessStatusCode,
ErrorStatusCode,
InferResponseByStatus,
TypedSuccessResponse,
} from "./api.client.ts";
import { errorStatusCodes, TypedResponseError } from "./api.client.ts";

Expand Down Expand Up @@ -75,6 +76,11 @@ describe("generator", () => {

type MaybeOptionalArg<T> = RequiredKeys<T> extends never ? [config?: T] : [config: T];

type InferResponseData<TEndpoint, TStatusCode> =
TypedSuccessResponse<any, any, any> extends InferResponseByStatus<TEndpoint, TStatusCode>
? Extract<InferResponseByStatus<TEndpoint, TStatusCode>, { data: {} }>["data"]
: Extract<InferResponseByStatus<TEndpoint, TStatusCode>["data"], {}>;

// </ApiClientTypes>

// <ApiClient>
Expand All @@ -101,7 +107,7 @@ describe("generator", () => {
withResponse: false as const,
};
const res = await this.client.put(path, requestParams as never);
return res as Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"];
return res as InferResponseData<TEndpoint, SuccessStatusCode>;
},
queryKey: queryKey,
}),
Expand Down Expand Up @@ -131,7 +137,7 @@ describe("generator", () => {
withResponse: false as const,
};
const res = await this.client.post(path, requestParams as never);
return res as Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"];
return res as InferResponseData<TEndpoint, SuccessStatusCode>;
},
queryKey: queryKey,
}),
Expand Down Expand Up @@ -161,7 +167,7 @@ describe("generator", () => {
withResponse: false as const,
};
const res = await this.client.get(path, requestParams as never);
return res as Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"];
return res as InferResponseData<TEndpoint, SuccessStatusCode>;
},
queryKey: queryKey,
}),
Expand Down Expand Up @@ -191,7 +197,7 @@ describe("generator", () => {
withResponse: false as const,
};
const res = await this.client.delete(path, requestParams as never);
return res as Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"];
return res as InferResponseData<TEndpoint, SuccessStatusCode>;
},
queryKey: queryKey,
}),
Expand All @@ -213,7 +219,7 @@ describe("generator", () => {
TWithResponse extends boolean = false,
TSelection = TWithResponse extends true
? InferResponseByStatus<TEndpoint, SuccessStatusCode>
: Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"],
: InferResponseData<TEndpoint, SuccessStatusCode>,
TError = TEndpoint extends { responses: infer TResponses }
? TResponses extends Record<string | number, unknown>
? InferResponseByStatus<TEndpoint, ErrorStatusCode>
Expand All @@ -227,7 +233,7 @@ describe("generator", () => {
selectFn?: (
res: TWithResponse extends true
? InferResponseByStatus<TEndpoint, SuccessStatusCode>
: Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"],
: InferResponseData<TEndpoint, SuccessStatusCode>,
) => TSelection;
throwOnStatusError?: boolean;
throwOnError?: boolean | ((error: TError) => boolean);
Expand All @@ -238,7 +244,7 @@ describe("generator", () => {
TLocalWithResponse extends boolean = TWithResponse,
TLocalSelection = TLocalWithResponse extends true
? InferResponseByStatus<TEndpoint, SuccessStatusCode>
: Extract<InferResponseByStatus<TEndpoint, SuccessStatusCode>, { data: {} }>["data"],
: InferResponseData<TEndpoint, SuccessStatusCode>,
>(
params: (TEndpoint extends { parameters: infer Parameters } ? Parameters : {}) & {
withResponse?: TLocalWithResponse;
Expand Down
Loading