client-nuxt: `composable` should be optional (default to `$fetch`)

[brolnickij]

Description

Generated ...Mutation() / ...Query() (with @pinia/colada plugin) require passing composable key when used together with @hey-api/client-nuxt

This transport detail (composable: '$fetch' | 'useAsyncData' / ...) is noise and should default internally

Config

plugins: [
  '@hey-api/client-nuxt',
  {
    name: '@pinia/colada',
    queryOptions: true,
    mutationOptions: true
  }
]

Example (current)

const { mutate: updateCounteragent } = useMutation({
  ...updateCounteragentMutation()
})

updateCounteragent({ 
  // it is required key
  composable: '$fetch'
})

Expected behavior

• composable is optional (defaults to $fetch)

const { mutate: updateCounteragent } = useMutation({
  ...updateCounteragentMutation()
})

updateCounteragent()

Reproducible example or configuration

Argument of type '{ body: { edoOperator: "SBIS"; }; path: { organization_id: string; }; onResponse: (data: FetchContext<unknown, ResponseType> & { response: FetchResponse<unknown>; }) => void; }' is not assignable to parameter of type 'Options<TComposable, UpdateCounteragentData, unknown, DefaultT>'.
  Property 'composable' is missing in type '{ body: { edoOperator: "SBIS"; }; path: { organization_id: string; }; onResponse: (data: FetchContext<unknown, ResponseType> & { response: FetchResponse<unknown>; }) => void; }' but required in type 'OmitKeys<RequestOptions<TComposable, unknown, DefaultT, string>, "body" | "path" | "query" | "url">'.

https://stackblitz.com/edit/nuxt-starter-yw7ncxpb?file=app.vue

[bolt-new-by-stackblitz]

Start a new pull request in StackBlitz Codeflow.

• nuxt-starter-yw7ncxpb (Open reproduction)

[dosubot]

There isn't a documented way to make the composable key optional or default to $fetch via configuration or plugin options in @hey-api/client-nuxt or @pinia/colada. The requirement comes from TypeScript type enforcement in the generated code, which expects composable to be explicitly provided. The documentation shows how to customize $fetch and other config, but doesn't mention defaulting or omitting composable in generated mutation/query functions see docs.

A possible workaround is to create a wrapper function around your mutation/query calls that injects composable: '$fetch' if it's missing, or to extend the generated types locally to make composable optional with a default. For now, keep an eye on future releases or changelogs in case this feature is added.

To reply, just mention @dosu.

---

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

[mrlubos]

I agree with this, but if I remember correctly, I had some issue with making it optional

[brolnickij]

@mrlubos

I had some issue with making it optional

yes, the sdk already has some early hints of this

openapi-ts/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts

Line 208 in 62cff55

// default: tsc.ots.string('$fetch'),

openapi-ts/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts

Line 382 in 62cff55

// default: tsc.ots.string('$fetch'),

im happy to take this task, try to make the composable key optional (default to $fetch)

[mrlubos]

Heh, yes. The issue was with types, but I can't remember what exactly anymore