Skip to content

Commit fc0c481

Browse files
mrlubosmrlubos
authored
Merge pull request #2598 from brolnickij/feat/init-default-composable-for-nuxt-client
2 parents 984cf2b + 771d244 commit fc0c481

File tree

36 files changed

+396
-344
lines changed

36 files changed

+396
-344
lines changed

‎.changeset/implicit-fetch.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@hey-api/openapi-ts": patch
3+
---
4+
5+
feat(pinia-colada): implicit `$fetch` for `client-nuxt` (hide `composable`)

‎docs/openapi-ts/clients/nuxt.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,10 @@ Interceptors (middleware) can be used to modify requests before they're sent or
175175

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

178+
::: tip
179+
If you omit `composable`, `$fetch` is used by default.
180+
:::
181+
178182
```js
179183
import { client } from 'client/client.gen';
180184

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-false/client/client.gen.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {
6161

6262
const request: Client['request'] = ({
6363
asyncDataOptions,
64-
composable,
64+
composable = '$fetch',
6565
...options
6666
}) => {
6767
const key = options.key;

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-false/client/types.gen.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
6464
}
6565

6666
export interface RequestOptions<
67-
TComposable extends Composable = Composable,
67+
TComposable extends Composable = '$fetch',
6868
ResT = unknown,
6969
DefaultT = undefined,
7070
Url extends string = string,
@@ -89,7 +89,7 @@ export interface RequestOptions<
8989
| 'sseMaxRetryDelay'
9090
> {
9191
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
92-
composable: TComposable;
92+
composable?: TComposable;
9393
key?: string;
9494
/**
9595
* Security mechanism(s) to use for the request.
@@ -119,7 +119,7 @@ export interface ClientOptions {
119119
}
120120

121121
type MethodFn = <
122-
TComposable extends Composable,
122+
TComposable extends Composable = '$fetch',
123123
ResT = unknown,
124124
TError = unknown,
125125
DefaultT = undefined,
@@ -128,7 +128,7 @@ type MethodFn = <
128128
) => RequestResult<TComposable, ResT, TError>;
129129

130130
type SseFn = <
131-
TComposable extends Composable,
131+
TComposable extends Composable = '$fetch',
132132
ResT = unknown,
133133
TError = unknown,
134134
DefaultT = undefined,
@@ -137,7 +137,7 @@ type SseFn = <
137137
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;
138138

139139
type RequestFn = <
140-
TComposable extends Composable,
140+
TComposable extends Composable = '$fetch',
141141
ResT = unknown,
142142
TError = unknown,
143143
DefaultT = undefined,
@@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
181181
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
182182

183183
export type Options<
184-
TComposable extends Composable,
184+
TComposable extends Composable = '$fetch',
185185
TData extends TDataShape = TDataShape,
186186
ResT = unknown,
187187
DefaultT = undefined,

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-number/client/client.gen.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {
6161

6262
const request: Client['request'] = ({
6363
asyncDataOptions,
64-
composable,
64+
composable = '$fetch',
6565
...options
6666
}) => {
6767
const key = options.key;

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-number/client/types.gen.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
6464
}
6565

6666
export interface RequestOptions<
67-
TComposable extends Composable = Composable,
67+
TComposable extends Composable = '$fetch',
6868
ResT = unknown,
6969
DefaultT = undefined,
7070
Url extends string = string,
@@ -89,7 +89,7 @@ export interface RequestOptions<
8989
| 'sseMaxRetryDelay'
9090
> {
9191
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
92-
composable: TComposable;
92+
composable?: TComposable;
9393
key?: string;
9494
/**
9595
* Security mechanism(s) to use for the request.
@@ -119,7 +119,7 @@ export interface ClientOptions {
119119
}
120120

121121
type MethodFn = <
122-
TComposable extends Composable,
122+
TComposable extends Composable = '$fetch',
123123
ResT = unknown,
124124
TError = unknown,
125125
DefaultT = undefined,
@@ -128,7 +128,7 @@ type MethodFn = <
128128
) => RequestResult<TComposable, ResT, TError>;
129129

130130
type SseFn = <
131-
TComposable extends Composable,
131+
TComposable extends Composable = '$fetch',
132132
ResT = unknown,
133133
TError = unknown,
134134
DefaultT = undefined,
@@ -137,7 +137,7 @@ type SseFn = <
137137
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;
138138

139139
type RequestFn = <
140-
TComposable extends Composable,
140+
TComposable extends Composable = '$fetch',
141141
ResT = unknown,
142142
TError = unknown,
143143
DefaultT = undefined,
@@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
181181
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
182182

183183
export type Options<
184-
TComposable extends Composable,
184+
TComposable extends Composable = '$fetch',
185185
TData extends TDataShape = TDataShape,
186186
ResT = unknown,
187187
DefaultT = undefined,

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-strict/client/client.gen.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {
6161

6262
const request: Client['request'] = ({
6363
asyncDataOptions,
64-
composable,
64+
composable = '$fetch',
6565
...options
6666
}) => {
6767
const key = options.key;

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-strict/client/types.gen.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
6464
}
6565

6666
export interface RequestOptions<
67-
TComposable extends Composable = Composable,
67+
TComposable extends Composable = '$fetch',
6868
ResT = unknown,
6969
DefaultT = undefined,
7070
Url extends string = string,
@@ -89,7 +89,7 @@ export interface RequestOptions<
8989
| 'sseMaxRetryDelay'
9090
> {
9191
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
92-
composable: TComposable;
92+
composable?: TComposable;
9393
key?: string;
9494
/**
9595
* Security mechanism(s) to use for the request.
@@ -119,7 +119,7 @@ export interface ClientOptions {
119119
}
120120

121121
type MethodFn = <
122-
TComposable extends Composable,
122+
TComposable extends Composable = '$fetch',
123123
ResT = unknown,
124124
TError = unknown,
125125
DefaultT = undefined,
@@ -128,7 +128,7 @@ type MethodFn = <
128128
) => RequestResult<TComposable, ResT, TError>;
129129

130130
type SseFn = <
131-
TComposable extends Composable,
131+
TComposable extends Composable = '$fetch',
132132
ResT = unknown,
133133
TError = unknown,
134134
DefaultT = undefined,
@@ -137,7 +137,7 @@ type SseFn = <
137137
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;
138138

139139
type RequestFn = <
140-
TComposable extends Composable,
140+
TComposable extends Composable = '$fetch',
141141
ResT = unknown,
142142
TError = unknown,
143143
DefaultT = undefined,
@@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
181181
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
182182

183183
export type Options<
184-
TComposable extends Composable,
184+
TComposable extends Composable = '$fetch',
185185
TData extends TDataShape = TDataShape,
186186
ResT = unknown,
187187
DefaultT = undefined,

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-string/client/client.gen.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const createClient = (config: Config = {}): Client => {
6161

6262
const request: Client['request'] = ({
6363
asyncDataOptions,
64-
composable,
64+
composable = '$fetch',
6565
...options
6666
}) => {
6767
const key = options.key;

‎packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/base-url-string/client/types.gen.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
6464
}
6565

6666
export interface RequestOptions<
67-
TComposable extends Composable = Composable,
67+
TComposable extends Composable = '$fetch',
6868
ResT = unknown,
6969
DefaultT = undefined,
7070
Url extends string = string,
@@ -89,7 +89,7 @@ export interface RequestOptions<
8989
| 'sseMaxRetryDelay'
9090
> {
9191
asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
92-
composable: TComposable;
92+
composable?: TComposable;
9393
key?: string;
9494
/**
9595
* Security mechanism(s) to use for the request.
@@ -119,7 +119,7 @@ export interface ClientOptions {
119119
}
120120

121121
type MethodFn = <
122-
TComposable extends Composable,
122+
TComposable extends Composable = '$fetch',
123123
ResT = unknown,
124124
TError = unknown,
125125
DefaultT = undefined,
@@ -128,7 +128,7 @@ type MethodFn = <
128128
) => RequestResult<TComposable, ResT, TError>;
129129

130130
type SseFn = <
131-
TComposable extends Composable,
131+
TComposable extends Composable = '$fetch',
132132
ResT = unknown,
133133
TError = unknown,
134134
DefaultT = undefined,
@@ -137,7 +137,7 @@ type SseFn = <
137137
) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;
138138

139139
type RequestFn = <
140-
TComposable extends Composable,
140+
TComposable extends Composable = '$fetch',
141141
ResT = unknown,
142142
TError = unknown,
143143
DefaultT = undefined,
@@ -181,7 +181,7 @@ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
181181
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
182182

183183
export type Options<
184-
TComposable extends Composable,
184+
TComposable extends Composable = '$fetch',
185185
TData extends TDataShape = TDataShape,
186186
ResT = unknown,
187187
DefaultT = undefined,

0 commit comments

Comments
 (0)