Skip to content

feat(pinia-colada): implicit $fetch for client-nuxt (hide composable) #2598

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 8 commits into from
Sep 5, 2025
Merged

feat(pinia-colada): implicit $fetch for client-nuxt (hide composable) #2598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
876482d
docs(client-nuxt): add note about default `$fetch` for `composable` key
brolnickij Sep 4, 2025
67e7b63
feat(client-nuxt): set default `composable` to `$fetch`
brolnickij Sep 4, 2025
3b08665
feat(sdk): add default generic `$fetch` for `TComposable` in SDK opti…
brolnickij Sep 4, 2025
1cd56c2
fix(colada): isolate `client-nuxt` specific options shape (`composable`)
brolnickij Sep 4, 2025
045c1ed
test(client-nuxt): update snapshots
brolnickij Sep 4, 2025
b5f57d1
test(sse-nuxt): update snapshots
brolnickij Sep 4, 2025
7143078
chore: init changeset
brolnickij Sep 4, 2025
771d244
fix(pinia-colada): remove unnecessary `Partial` type for `query`
brolnickij Sep 5, 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/implicit-fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@hey-api/openapi-ts": patch
---

feat(pinia-colada): implicit `$fetch` for `client-nuxt` (hide `composable`)
4 changes: 4 additions & 0 deletions docs/openapi-ts/clients/nuxt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,10 @@ Interceptors (middleware) can be used to modify requests before they're sent or

You can pass any Nuxt/ofetch arguments to the client instance.

::: tip
If you omit `composable`, `$fetch` is used by default.
:::

```js
import { client } from 'client/client.gen';

Expand Down
2 changes: 1 addition & 1 deletion ...test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-false/client/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {

const request: Client['request'] = ({
asyncDataOptions,
composable,
composable = '$fetch',
...options
}) => {
const key = options.key;
Expand Down
12 changes: 6 additions & 6 deletions .../test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-false/client/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
}

export interface RequestOptions<
TComposable extends Composable = Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
DefaultT = undefined,
Url extends string = string,
Expand All @@ -89,7 +89,7 @@ export interface RequestOptions<
| 'sseMaxRetryDelay'
> {
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
composable: TComposable;
composable?: TComposable;
key?: string;
/**
* Security mechanism(s) to use for the request.
Expand Down Expand Up @@ -119,7 +119,7 @@ export interface ClientOptions {
}

type MethodFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -128,7 +128,7 @@ type MethodFn = <
) => RequestResult<TComposable, ResT, TError>;

type SseFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -137,7 +137,7 @@ type SseFn = <
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;

type RequestFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand Down Expand Up @@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;

export type Options<
TComposable extends Composable,
TComposable extends Composable = '$fetch',
TData extends TDataShape = TDataShape,
ResT = unknown,
DefaultT = undefined,
Expand Down
2 changes: 1 addition & 1 deletion ...est/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-number/client/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {

const request: Client['request'] = ({
asyncDataOptions,
composable,
composable = '$fetch',
...options
}) => {
const key = options.key;
Expand Down
12 changes: 6 additions & 6 deletions ...test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-number/client/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
}

export interface RequestOptions<
TComposable extends Composable = Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
DefaultT = undefined,
Url extends string = string,
Expand All @@ -89,7 +89,7 @@ export interface RequestOptions<
| 'sseMaxRetryDelay'
> {
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
composable: TComposable;
composable?: TComposable;
key?: string;
/**
* Security mechanism(s) to use for the request.
Expand Down Expand Up @@ -119,7 +119,7 @@ export interface ClientOptions {
}

type MethodFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -128,7 +128,7 @@ type MethodFn = <
) => RequestResult<TComposable, ResT, TError>;

type SseFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -137,7 +137,7 @@ type SseFn = <
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;

type RequestFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand Down Expand Up @@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;

export type Options<
TComposable extends Composable,
TComposable extends Composable = '$fetch',
TData extends TDataShape = TDataShape,
ResT = unknown,
DefaultT = undefined,
Expand Down
2 changes: 1 addition & 1 deletion ...est/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-strict/client/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {

const request: Client['request'] = ({
asyncDataOptions,
composable,
composable = '$fetch',
...options
}) => {
const key = options.key;
Expand Down
12 changes: 6 additions & 6 deletions ...test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-strict/client/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
}

export interface RequestOptions<
TComposable extends Composable = Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
DefaultT = undefined,
Url extends string = string,
Expand All @@ -89,7 +89,7 @@ export interface RequestOptions<
| 'sseMaxRetryDelay'
> {
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
composable: TComposable;
composable?: TComposable;
key?: string;
/**
* Security mechanism(s) to use for the request.
Expand Down Expand Up @@ -119,7 +119,7 @@ export interface ClientOptions {
}

type MethodFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -128,7 +128,7 @@ type MethodFn = <
) => RequestResult<TComposable, ResT, TError>;

type SseFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -137,7 +137,7 @@ type SseFn = <
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;

type RequestFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand Down Expand Up @@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;

export type Options<
TComposable extends Composable,
TComposable extends Composable = '$fetch',
TData extends TDataShape = TDataShape,
ResT = unknown,
DefaultT = undefined,
Expand Down
2 changes: 1 addition & 1 deletion ...est/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-string/client/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {

const request: Client['request'] = ({
asyncDataOptions,
composable,
composable = '$fetch',
...options
}) => {
const key = options.key;
Expand Down
12 changes: 6 additions & 6 deletions ...test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-string/client/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
}

export interface RequestOptions<
TComposable extends Composable = Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
DefaultT = undefined,
Url extends string = string,
Expand All @@ -89,7 +89,7 @@ export interface RequestOptions<
| 'sseMaxRetryDelay'
> {
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
composable: TComposable;
composable?: TComposable;
key?: string;
/**
* Security mechanism(s) to use for the request.
Expand Down Expand Up @@ -119,7 +119,7 @@ export interface ClientOptions {
}

type MethodFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -128,7 +128,7 @@ type MethodFn = <
) => RequestResult<TComposable, ResT, TError>;

type SseFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -137,7 +137,7 @@ type SseFn = <
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;

type RequestFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand Down Expand Up @@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;

export type Options<
TComposable extends Composable,
TComposable extends Composable = '$fetch',
TData extends TDataShape = TDataShape,
ResT = unknown,
DefaultT = undefined,
Expand Down
2 changes: 1 addition & 1 deletion ...in/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/clean-false/client/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {

const request: Client['request'] = ({
asyncDataOptions,
composable,
composable = '$fetch',
...options
}) => {
const key = options.key;
Expand Down
12 changes: 6 additions & 6 deletions ...ain/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/clean-false/client/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
}

export interface RequestOptions<
TComposable extends Composable = Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
DefaultT = undefined,
Url extends string = string,
Expand All @@ -89,7 +89,7 @@ export interface RequestOptions<
| 'sseMaxRetryDelay'
> {
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
composable: TComposable;
composable?: TComposable;
key?: string;
/**
* Security mechanism(s) to use for the request.
Expand Down Expand Up @@ -119,7 +119,7 @@ export interface ClientOptions {
}

type MethodFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -128,7 +128,7 @@ type MethodFn = <
) => RequestResult<TComposable, ResT, TError>;

type SseFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand All @@ -137,7 +137,7 @@ type SseFn = <
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;

type RequestFn = <
TComposable extends Composable,
TComposable extends Composable = '$fetch',
ResT = unknown,
TError = unknown,
DefaultT = undefined,
Expand Down Expand Up @@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;

export type Options<
TComposable extends Composable,
TComposable extends Composable = '$fetch',
TData extends TDataShape = TDataShape,
ResT = unknown,
DefaultT = undefined,
Expand Down
Loading
Loading