Client state · OpenAPI

TanStack Query bindings for each operation.

Adds caching and revalidation on top of the generated operations. Pair it with a client target rather than using it alone.

What it emits

Query and mutation hooksQuery options factoriesQuery key helpers

Options

Options this generator adds on top of its base set. Set them under generator: in the target.

Option	Description	Values	Default
`envelope`	Wrap successful responses in a fixed shape. Set `dataKey`, and optionally `metaKey`, `staticFields`, and `contextFields` for path and timestamp.	`object`	`unset (no envelope)`
`hooks`	Emit the `useX` hooks themselves.	`true \| false`	`false`
`options`	Emit the standalone query and mutation options factories.	`true \| false`	`false`
`suspense`	Also emit `useSuspenseX` variants.	`true \| false`	`false`
`operations`	Per-operation overrides keyed by operation id. Each accepts `hooks`, `options`, `suspense`, and `infinite` — where `infinite` needs an explicit `parameter` and `initialPageParam`, because Kontract never guesses pagination policy.	`object`	`unset`

Shared options

Every OpenAPI generator accepts these, so a schema choice made once stays consistent between a server and its clients.

Option	Description	Values	Default
`audiences`	Apply operation `x-kontract-audiences` policy. `exclude` is validated once against the complete selected OpenAPI source/target universe, not per generated service: siblings with no matching audience generate normally, while a token absent from the whole source fails validation and `generate --clean` preflight before deletion. NestJS may instead set `marker: true` to retain and annotate output.	`object (exclude: string[]; marker: true for typescript-nestjs)`	`unset (operations belong to every audience)`
`zod`	Emit framework-neutral Zod schemas alongside the inferred request and response types.	`true \| false`	`false`
`schemaMode`	How faithfully the source schema is reproduced. `normalize` reshapes inline schemas into named components; `strict` keeps the document as authored.	`normalize \| strict`	`strict for typescript-nestjs, normalize for SDK targets`
`useSingleRequestParameter`	Collapse an operation's parameters into one request object instead of a positional argument list.	`true \| false`	`false`
`stringEnums`	Emit enums as string union types rather than TypeScript `enum` declarations.	`true \| false`	`false`
`enumUnknownDefaultCase`	Add a fallback member so an unrecognised wire value does not throw at the boundary.	`true \| false`	`false`
`modelPropertyNaming`	Casing applied to model properties.	`camelCase \| PascalCase \| snake_case \| original`	`original`
`paramNaming`	Casing applied to operation parameters.	`camelCase \| PascalCase \| snake_case \| original`	`original`
`enumPropertyNaming`	Casing applied to enum members.	`PascalCase \| camelCase \| snake_case \| UPPERCASE \| original`	`original`
`sortModelPropertiesByRequiredFlag`	Order model properties with required ones first.	`true \| false`	`false`
`sortParamsByRequiredFlag`	Order operation parameters with required ones first.	`true \| false`	`false`

Example

type: react-query-hooksgenerates

Each operation produces a query-options factory, a skippable variant, and the hook. Enabling suspense adds the suspense hook; mutations get an options factory and hook of their own.

sumr.yamlyaml

targets:
  - name: web-query
    output: ./apps/web/src/api/query
    generator:
      type: react-query-hooks
      zod: true
      suspense: true

Emitted exportsts

// One operation, getProducts, produces:
export function getProductsQueryOptions(/* … */);
export function getProductsSkippableQueryOptions(/* … */);
export function useGetProducts(/* … */);
export function useSuspenseGetProducts(/* … */);

// And for a mutation, createProduct:
export function createProductMutationOptions(/* … */);
export function useCreateProduct(/* … */);

Options

Shared options

Example

On this page