DeepObject query parameters generate incorrect infiniteQueryOptions with dot notation

[WooWan]

Description

Bug Description
openapi-ts with tanstack/query plugin generates incorrect query parameter names for deepObject style parameters in infiniteQueryOptions and causes TypeScript errors. This is the only blocker preventing us from adopting openapi-ts. We use query param object style for existing APIs, so we need to support it. As far as I know, query param object official spec since OpenAPI 3.0
Thanks for your lovely library!

Current Output

const page = typeof pageParam === 'object' ? pageParam : {
    query: {
        'pageable.page': pageParam  // Wrong: uses dot notation
    }
};

error:

Type 'Pick<Pick<Options<GetDeepObjectData>, "body" | "path" | "query" | "headers" | "baseUrl"> & { _id: string; _infinite?: boolean | undefined; tags?: readonly string[] | undefined; }, "body" | ... 2 more ... | "headers"> | { ...; }' is not assignable to type 'Pick<Pick<Options<GetDeepObjectData>, "body" | "path" | "query" | "headers" | "baseUrl"> & { _id: string; _infinite?: boolean | undefined; tags?: readonly string[] | undefined; }, "body" | ... 2 more ... | "headers">'.
  Type '{ query: { 'pageable.page': number; }; }' is not assignable to type 'Pick<Pick<Options<GetDeepObjectData>, "body" | "path" | "query" | "headers" | "baseUrl"> & { _id: string; _infinite?: boolean | undefined; tags?: readonly string[] | undefined; }, "body" | ... 2 more ... | "headers">'.
    Types of property 'query' are incompatible.
      Object literal may only specify known properties, and ''pageable.page'' does not exist in type '{ pageable: { page?: number | undefined; size?: number | undefined; sort?: string[] | undefined; }; }'

Reproducible example or configuration

https://stackblitz.com/~/github.com/WooWan/openapi-ts-reproduction

OpenAPI specification (optional)

No response

System information (optional)

Environment

openapi-ts: 0.83.1
TypeScript: 5.9.3

[dosubot]

Hi @WooWan! I'm Dosu and I’m helping the openapi-ts team.

Based on the documentation, there is currently no official support or configuration in openapi-ts for handling deepObject query parameters in infiniteQueryOptions, nor any workaround for the dot notation issue you described. The expected OpenAPI behavior for deepObject style is to serialize objects as nested query parameters (e.g., pageable[page]=1), not with dot notation like 'pageable.page'. The TypeScript errors occur because the generated types do not match the expected nested object structure, leading to incompatibility with your API's query param object style.

As of version 0.83.1, this limitation is not addressed in the docs or configuration options for the TanStack Query plugin or openapi-ts itself see docs. You may need to consider manual workarounds in your codebase or monitor for updates in future releases.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}