@hey-api/openapi-ts 0.84.0 → 0.84.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,12 +1,13 @@
1
1
  import * as typescript from 'typescript';
2
2
  import typescript__default from 'typescript';
3
- import { C as Comments, P as PluginHandler, a as Plugin, I as ImportExportItemObject, t as tsNodeToString, S as StringCase, U as UserConfig, L as Logger, b as Client$6, c as IR } from './types.d-ClTVswi2.js';
4
- export { j as Client, D as DefinePlugin, E as ExpressionTransformer, k as LegacyIR, O as OpenApi, d as OpenApiMetaObject, e as OpenApiOperationObject, f as OpenApiParameterObject, g as OpenApiRequestBodyObject, h as OpenApiResponseObject, i as OpenApiSchemaObject, T as TypeTransformer } from './types.d-ClTVswi2.js';
3
+ import { C as Comments, P as PluginHandler, a as Plugin, I as ImportExportItemObject, t as tsNodeToString, S as StringCase, U as UserConfig, L as Logger, b as Client$7, c as IR } from './types.d-DOXd97cA.js';
4
+ export { j as Client, D as DefinePlugin, E as ExpressionTransformer, k as LegacyIR, O as OpenApi, d as OpenApiMetaObject, e as OpenApiOperationObject, f as OpenApiParameterObject, g as OpenApiRequestBodyObject, h as OpenApiResponseObject, i as OpenApiSchemaObject, T as TypeTransformer } from './types.d-DOXd97cA.js';
5
5
  import { HttpHeaders, HttpClient, HttpRequest, HttpResponse, HttpErrorResponse } from '@angular/common/http';
6
6
  import { Injector } from '@angular/core';
7
7
  import { CreateAxiosDefaults, AxiosStatic, AxiosInstance, AxiosRequestHeaders, AxiosResponse, AxiosError } from 'axios';
8
8
  import { UseFetchOptions, AsyncDataOptions, useAsyncData, useFetch, useLazyAsyncData, useLazyFetch } from 'nuxt/app';
9
9
  import { Ref } from 'vue';
10
+ import { FetchOptions as FetchOptions$1, ofetch, ResponseType } from 'ofetch';
10
11
  import 'semver';
11
12
  import '@hey-api/codegen-core';
12
13
  import 'node:fs';
@@ -91,7 +92,7 @@ interface QuerySerializerOptions {
91
92
  }
92
93
 
93
94
  type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
94
- type Client$5<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
95
+ type Client$6<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
95
96
  /**
96
97
  * Returns the final request URL.
97
98
  */
@@ -108,7 +109,7 @@ type Client$5<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn
108
109
  [K in HttpMethod]: SseFn;
109
110
  };
110
111
  });
111
- interface Config$5 {
112
+ interface Config$6 {
112
113
  /**
113
114
  * Auth token or a function returning auth token. The resolved value will be
114
115
  * added to the request payload as defined by its `security` array.
@@ -162,7 +163,7 @@ interface Config$5 {
162
163
  responseValidator?: (data: unknown) => Promise<unknown>;
163
164
  }
164
165
 
165
- type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$5, 'method' | 'responseTransformer' | 'responseValidator'> & {
166
+ type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$6, 'method' | 'responseTransformer' | 'responseValidator'> & {
166
167
  /**
167
168
  * Fetch API implementation. You can use this option to provide a custom
168
169
  * fetch instance.
@@ -232,10 +233,10 @@ type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> =
232
233
  stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
233
234
  };
234
235
 
235
- type ErrInterceptor$2<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
236
- type ReqInterceptor$2<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
237
- type ResInterceptor$2<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
238
- declare class Interceptors$2<Interceptor> {
236
+ type ErrInterceptor$3<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
237
+ type ReqInterceptor$3<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
238
+ type ResInterceptor$3<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
239
+ declare class Interceptors$3<Interceptor> {
239
240
  fns: Array<Interceptor | null>;
240
241
  clear(): void;
241
242
  eject(id: number | Interceptor): void;
@@ -244,14 +245,14 @@ declare class Interceptors$2<Interceptor> {
244
245
  update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
245
246
  use(fn: Interceptor): number;
246
247
  }
247
- interface Middleware$2<Req, Res, Err, Options> {
248
- error: Interceptors$2<ErrInterceptor$2<Err, Res, Req, Options>>;
249
- request: Interceptors$2<ReqInterceptor$2<Req, Options>>;
250
- response: Interceptors$2<ResInterceptor$2<Res, Req, Options>>;
248
+ interface Middleware$3<Req, Res, Err, Options> {
249
+ error: Interceptors$3<ErrInterceptor$3<Err, Res, Req, Options>>;
250
+ request: Interceptors$3<ReqInterceptor$3<Req, Options>>;
251
+ response: Interceptors$3<ResInterceptor$3<Res, Req, Options>>;
251
252
  }
252
253
 
253
- type ResponseStyle$1 = 'data' | 'fields';
254
- interface Config$4<T extends ClientOptions$4 = ClientOptions$4> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Omit<Config$5, 'headers'> {
254
+ type ResponseStyle$2 = 'data' | 'fields';
255
+ interface Config$5<T extends ClientOptions$5 = ClientOptions$5> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Omit<Config$6, 'headers'> {
255
256
  /**
256
257
  * Base URL for all requests made by this client.
257
258
  */
@@ -272,7 +273,7 @@ interface Config$4<T extends ClientOptions$4 = ClientOptions$4> extends Omit<Req
272
273
  *
273
274
  * @default 'fields'
274
275
  */
275
- responseStyle?: ResponseStyle$1;
276
+ responseStyle?: ResponseStyle$2;
276
277
  /**
277
278
  * Throw an error instead of returning it in the response?
278
279
  *
@@ -280,7 +281,7 @@ interface Config$4<T extends ClientOptions$4 = ClientOptions$4> extends Omit<Req
280
281
  */
281
282
  throwOnError?: T['throwOnError'];
282
283
  }
283
- interface RequestOptions$4<TData = unknown, TResponseStyle extends ResponseStyle$1 = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$4<{
284
+ interface RequestOptions$5<TData = unknown, TResponseStyle extends ResponseStyle$2 = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$5<{
284
285
  responseStyle: TResponseStyle;
285
286
  throwOnError: ThrowOnError;
286
287
  }>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
@@ -302,10 +303,10 @@ interface RequestOptions$4<TData = unknown, TResponseStyle extends ResponseStyle
302
303
  security?: ReadonlyArray<Auth>;
303
304
  url: Url;
304
305
  }
305
- interface ResolvedRequestOptions$2<TResponseStyle extends ResponseStyle$1 = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions$4<unknown, TResponseStyle, ThrowOnError, Url> {
306
+ interface ResolvedRequestOptions$3<TResponseStyle extends ResponseStyle$2 = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions$5<unknown, TResponseStyle, ThrowOnError, Url> {
306
307
  serializedBody?: string;
307
308
  }
308
- type RequestResult$4<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle$1 = 'fields'> = Promise<ThrowOnError extends true ? TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
309
+ type RequestResult$5<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle$2 = 'fields'> = Promise<ThrowOnError extends true ? TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
309
310
  data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
310
311
  request: HttpRequest<unknown>;
311
312
  response: HttpResponse<TData>;
@@ -322,36 +323,36 @@ type RequestResult$4<TData = unknown, TError = unknown, ThrowOnError extends boo
322
323
  error: TError[keyof TError] | null;
323
324
  };
324
325
  }>;
325
- interface ClientOptions$4 {
326
+ interface ClientOptions$5 {
326
327
  baseUrl?: string;
327
- responseStyle?: ResponseStyle$1;
328
+ responseStyle?: ResponseStyle$2;
328
329
  throwOnError?: boolean;
329
330
  }
330
- type MethodFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: Omit<RequestOptions$4<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult$4<TData, TError, ThrowOnError, TResponseStyle>;
331
- type SseFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: Omit<RequestOptions$4<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
332
- type RequestFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: Omit<RequestOptions$4<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$4<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult$4<TData, TError, ThrowOnError, TResponseStyle>;
333
- type RequestOptionsFn = <ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: RequestOptions$4<unknown, TResponseStyle, ThrowOnError>) => HttpRequest<unknown>;
334
- type BuildUrlFn$4 = <TData extends {
331
+ type MethodFn$5 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$2 = 'fields'>(options: Omit<RequestOptions$5<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult$5<TData, TError, ThrowOnError, TResponseStyle>;
332
+ type SseFn$5 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$2 = 'fields'>(options: Omit<RequestOptions$5<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
333
+ type RequestFn$5 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$2 = 'fields'>(options: Omit<RequestOptions$5<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$5<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult$5<TData, TError, ThrowOnError, TResponseStyle>;
334
+ type RequestOptionsFn = <ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$2 = 'fields'>(options: RequestOptions$5<unknown, TResponseStyle, ThrowOnError>) => HttpRequest<unknown>;
335
+ type BuildUrlFn$5 = <TData extends {
335
336
  body?: unknown;
336
337
  path?: Record<string, unknown>;
337
338
  query?: Record<string, unknown>;
338
339
  url: string;
339
- }>(options: Pick<TData, 'url'> & Options$4<TData>) => string;
340
- type Client$4 = Client$5<RequestFn$4, Config$4, MethodFn$4, BuildUrlFn$4, SseFn$4> & {
341
- interceptors: Middleware$2<HttpRequest<unknown>, HttpResponse<unknown>, unknown, ResolvedRequestOptions$2>;
340
+ }>(options: Pick<TData, 'url'> & Options$5<TData>) => string;
341
+ type Client$5 = Client$6<RequestFn$5, Config$5, MethodFn$5, BuildUrlFn$5, SseFn$5> & {
342
+ interceptors: Middleware$3<HttpRequest<unknown>, HttpResponse<unknown>, unknown, ResolvedRequestOptions$3>;
342
343
  requestOptions: RequestOptionsFn;
343
344
  };
344
- interface TDataShape$4 {
345
+ interface TDataShape$5 {
345
346
  body?: unknown;
346
347
  headers?: unknown;
347
348
  path?: unknown;
348
349
  query?: unknown;
349
350
  url: string;
350
351
  }
351
- type OmitKeys$4<T, K> = Pick<T, Exclude<keyof T, K>>;
352
- type Options$4<TData extends TDataShape$4 = TDataShape$4, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle$1 = 'fields'> = OmitKeys$4<RequestOptions$4<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
352
+ type OmitKeys$5<T, K> = Pick<T, Exclude<keyof T, K>>;
353
+ type Options$5<TData extends TDataShape$5 = TDataShape$5, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle$2 = 'fields'> = OmitKeys$5<RequestOptions$5<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
353
354
 
354
- interface Config$3<T extends ClientOptions$3 = ClientOptions$3> extends Omit<CreateAxiosDefaults, 'auth' | 'baseURL' | 'headers' | 'method'>, Config$5 {
355
+ interface Config$4<T extends ClientOptions$4 = ClientOptions$4> extends Omit<CreateAxiosDefaults, 'auth' | 'baseURL' | 'headers' | 'method'>, Config$6 {
355
356
  /**
356
357
  * Axios implementation. You can use this option to provide either an
357
358
  * `AxiosStatic` or an `AxiosInstance`.
@@ -377,7 +378,7 @@ interface Config$3<T extends ClientOptions$3 = ClientOptions$3> extends Omit<Cre
377
378
  */
378
379
  throwOnError?: T['throwOnError'];
379
380
  }
380
- interface RequestOptions$3<TData = unknown, ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$3<{
381
+ interface RequestOptions$4<TData = unknown, ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$4<{
381
382
  throwOnError: ThrowOnError;
382
383
  }>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
383
384
  /**
@@ -394,42 +395,42 @@ interface RequestOptions$3<TData = unknown, ThrowOnError extends boolean = boole
394
395
  security?: ReadonlyArray<Auth>;
395
396
  url: Url;
396
397
  }
397
- interface ClientOptions$3 {
398
+ interface ClientOptions$4 {
398
399
  baseURL?: string;
399
400
  throwOnError?: boolean;
400
401
  }
401
- type RequestResult$3<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData>> : Promise<(AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData> & {
402
+ type RequestResult$4<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData>> : Promise<(AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData> & {
402
403
  error: undefined;
403
404
  }) | (AxiosError<TError extends Record<string, unknown> ? TError[keyof TError] : TError> & {
404
405
  data: undefined;
405
406
  error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
406
407
  })>;
407
- type MethodFn$3 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$3<TData, ThrowOnError>, 'method'>) => RequestResult$3<TData, TError, ThrowOnError>;
408
- type SseFn$3 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$3<TData, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
409
- type RequestFn$3 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$3<TData, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$3<TData, ThrowOnError>>, 'method'>) => RequestResult$3<TData, TError, ThrowOnError>;
410
- type BuildUrlFn$3 = <TData extends {
408
+ type MethodFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$4<TData, ThrowOnError>, 'method'>) => RequestResult$4<TData, TError, ThrowOnError>;
409
+ type SseFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$4<TData, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
410
+ type RequestFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$4<TData, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$4<TData, ThrowOnError>>, 'method'>) => RequestResult$4<TData, TError, ThrowOnError>;
411
+ type BuildUrlFn$4 = <TData extends {
411
412
  body?: unknown;
412
413
  path?: Record<string, unknown>;
413
414
  query?: Record<string, unknown>;
414
415
  url: string;
415
- }>(options: Pick<TData, 'url'> & Options$3<TData>) => string;
416
- type Client$3 = Client$5<RequestFn$3, Config$3, MethodFn$3, BuildUrlFn$3, SseFn$3> & {
416
+ }>(options: Pick<TData, 'url'> & Options$4<TData>) => string;
417
+ type Client$4 = Client$6<RequestFn$4, Config$4, MethodFn$4, BuildUrlFn$4, SseFn$4> & {
417
418
  instance: AxiosInstance;
418
419
  };
419
- interface TDataShape$3 {
420
+ interface TDataShape$4 {
420
421
  body?: unknown;
421
422
  headers?: unknown;
422
423
  path?: unknown;
423
424
  query?: unknown;
424
425
  url: string;
425
426
  }
426
- type OmitKeys$3<T, K> = Pick<T, Exclude<keyof T, K>>;
427
- type Options$3<TData extends TDataShape$3 = TDataShape$3, ThrowOnError extends boolean = boolean, TResponse = unknown> = OmitKeys$3<RequestOptions$3<TResponse, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
427
+ type OmitKeys$4<T, K> = Pick<T, Exclude<keyof T, K>>;
428
+ type Options$4<TData extends TDataShape$4 = TDataShape$4, ThrowOnError extends boolean = boolean, TResponse = unknown> = OmitKeys$4<RequestOptions$4<TResponse, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
428
429
 
429
- type ErrInterceptor$1<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
430
- type ReqInterceptor$1<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
431
- type ResInterceptor$1<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
432
- declare class Interceptors$1<Interceptor> {
430
+ type ErrInterceptor$2<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
431
+ type ReqInterceptor$2<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
432
+ type ResInterceptor$2<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
433
+ declare class Interceptors$2<Interceptor> {
433
434
  fns: Array<Interceptor | null>;
434
435
  clear(): void;
435
436
  eject(id: number | Interceptor): void;
@@ -438,14 +439,14 @@ declare class Interceptors$1<Interceptor> {
438
439
  update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
439
440
  use(fn: Interceptor): number;
440
441
  }
441
- interface Middleware$1<Req, Res, Err, Options> {
442
- error: Interceptors$1<ErrInterceptor$1<Err, Res, Req, Options>>;
443
- request: Interceptors$1<ReqInterceptor$1<Req, Options>>;
444
- response: Interceptors$1<ResInterceptor$1<Res, Req, Options>>;
442
+ interface Middleware$2<Req, Res, Err, Options> {
443
+ error: Interceptors$2<ErrInterceptor$2<Err, Res, Req, Options>>;
444
+ request: Interceptors$2<ReqInterceptor$2<Req, Options>>;
445
+ response: Interceptors$2<ResInterceptor$2<Res, Req, Options>>;
445
446
  }
446
447
 
447
- type ResponseStyle = 'data' | 'fields';
448
- interface Config$2<T extends ClientOptions$2 = ClientOptions$2> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$5 {
448
+ type ResponseStyle$1 = 'data' | 'fields';
449
+ interface Config$3<T extends ClientOptions$3 = ClientOptions$3> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$6 {
449
450
  /**
450
451
  * Base URL for all requests made by this client.
451
452
  */
@@ -478,7 +479,7 @@ interface Config$2<T extends ClientOptions$2 = ClientOptions$2> extends Omit<Req
478
479
  *
479
480
  * @default 'fields'
480
481
  */
481
- responseStyle?: ResponseStyle;
482
+ responseStyle?: ResponseStyle$1;
482
483
  /**
483
484
  * Throw an error instead of returning it in the response?
484
485
  *
@@ -486,7 +487,7 @@ interface Config$2<T extends ClientOptions$2 = ClientOptions$2> extends Omit<Req
486
487
  */
487
488
  throwOnError?: T['throwOnError'];
488
489
  }
489
- interface RequestOptions$2<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$2<{
490
+ interface RequestOptions$3<TData = unknown, TResponseStyle extends ResponseStyle$1 = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$3<{
490
491
  responseStyle: TResponseStyle;
491
492
  throwOnError: ThrowOnError;
492
493
  }>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
@@ -504,10 +505,10 @@ interface RequestOptions$2<TData = unknown, TResponseStyle extends ResponseStyle
504
505
  security?: ReadonlyArray<Auth>;
505
506
  url: Url;
506
507
  }
507
- interface ResolvedRequestOptions$1<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions$2<unknown, TResponseStyle, ThrowOnError, Url> {
508
+ interface ResolvedRequestOptions$2<TResponseStyle extends ResponseStyle$1 = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions$3<unknown, TResponseStyle, ThrowOnError, Url> {
508
509
  serializedBody?: string;
509
510
  }
510
- type RequestResult$2<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
511
+ type RequestResult$3<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle$1 = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
511
512
  data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
512
513
  request: Request;
513
514
  response: Response;
@@ -521,37 +522,37 @@ type RequestResult$2<TData = unknown, TError = unknown, ThrowOnError extends boo
521
522
  request: Request;
522
523
  response: Response;
523
524
  }>;
524
- interface ClientOptions$2 {
525
+ interface ClientOptions$3 {
525
526
  baseUrl?: string;
526
- responseStyle?: ResponseStyle;
527
+ responseStyle?: ResponseStyle$1;
527
528
  throwOnError?: boolean;
528
529
  }
529
- type MethodFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions$2<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult$2<TData, TError, ThrowOnError, TResponseStyle>;
530
- type SseFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions$2<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
531
- type RequestFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions$2<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$2<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult$2<TData, TError, ThrowOnError, TResponseStyle>;
532
- type BuildUrlFn$2 = <TData extends {
530
+ type MethodFn$3 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: Omit<RequestOptions$3<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult$3<TData, TError, ThrowOnError, TResponseStyle>;
531
+ type SseFn$3 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: Omit<RequestOptions$3<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
532
+ type RequestFn$3 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$1 = 'fields'>(options: Omit<RequestOptions$3<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$3<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult$3<TData, TError, ThrowOnError, TResponseStyle>;
533
+ type BuildUrlFn$3 = <TData extends {
533
534
  body?: unknown;
534
535
  path?: Record<string, unknown>;
535
536
  query?: Record<string, unknown>;
536
537
  url: string;
537
- }>(options: Pick<TData, 'url'> & Options$2<TData>) => string;
538
- type Client$2 = Client$5<RequestFn$2, Config$2, MethodFn$2, BuildUrlFn$2, SseFn$2> & {
539
- interceptors: Middleware$1<Request, Response, unknown, ResolvedRequestOptions$1>;
538
+ }>(options: Pick<TData, 'url'> & Options$3<TData>) => string;
539
+ type Client$3 = Client$6<RequestFn$3, Config$3, MethodFn$3, BuildUrlFn$3, SseFn$3> & {
540
+ interceptors: Middleware$2<Request, Response, unknown, ResolvedRequestOptions$2>;
540
541
  };
541
- interface TDataShape$2 {
542
+ interface TDataShape$3 {
542
543
  body?: unknown;
543
544
  headers?: unknown;
544
545
  path?: unknown;
545
546
  query?: unknown;
546
547
  url: string;
547
548
  }
548
- type OmitKeys$2<T, K> = Pick<T, Exclude<keyof T, K>>;
549
- type Options$2<TData extends TDataShape$2 = TDataShape$2, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys$2<RequestOptions$2<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
549
+ type OmitKeys$3<T, K> = Pick<T, Exclude<keyof T, K>>;
550
+ type Options$3<TData extends TDataShape$3 = TDataShape$3, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle$1 = 'fields'> = OmitKeys$3<RequestOptions$3<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
550
551
 
551
- type ErrInterceptor<Err, Res, Options> = (error: Err, response: Res, options: Options) => Err | Promise<Err>;
552
- type ReqInterceptor<Options> = (options: Options) => void | Promise<void>;
553
- type ResInterceptor<Res, Options> = (response: Res, options: Options) => Res | Promise<Res>;
554
- declare class Interceptors<Interceptor> {
552
+ type ErrInterceptor$1<Err, Res, Options> = (error: Err, response: Res, options: Options) => Err | Promise<Err>;
553
+ type ReqInterceptor$1<Options> = (options: Options) => void | Promise<void>;
554
+ type ResInterceptor$1<Res, Options> = (response: Res, options: Options) => Res | Promise<Res>;
555
+ declare class Interceptors$1<Interceptor> {
555
556
  fns: Array<Interceptor | null>;
556
557
  clear(): void;
557
558
  eject(id: number | Interceptor): void;
@@ -560,13 +561,13 @@ declare class Interceptors<Interceptor> {
560
561
  update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
561
562
  use(fn: Interceptor): number;
562
563
  }
563
- interface Middleware<Res, Err, Options> {
564
- error: Interceptors<ErrInterceptor<Err, Res, Options>>;
565
- request: Interceptors<ReqInterceptor<Options>>;
566
- response: Interceptors<ResInterceptor<Res, Options>>;
564
+ interface Middleware$1<Res, Err, Options> {
565
+ error: Interceptors$1<ErrInterceptor$1<Err, Res, Options>>;
566
+ request: Interceptors$1<ReqInterceptor$1<Options>>;
567
+ response: Interceptors$1<ResInterceptor$1<Res, Options>>;
567
568
  }
568
569
 
569
- interface Config$1<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$5 {
570
+ interface Config$2<T extends ClientOptions$2 = ClientOptions$2> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$6 {
570
571
  /**
571
572
  * Base URL for all requests made by this client.
572
573
  */
@@ -594,7 +595,7 @@ interface Config$1<T extends ClientOptions$1 = ClientOptions$1> extends Omit<Req
594
595
  */
595
596
  throwOnError?: T['throwOnError'];
596
597
  }
597
- interface RequestOptions$1<TData = unknown, ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$1<{
598
+ interface RequestOptions$2<TData = unknown, ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$2<{
598
599
  throwOnError: ThrowOnError;
599
600
  }>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
600
601
  /**
@@ -611,10 +612,10 @@ interface RequestOptions$1<TData = unknown, ThrowOnError extends boolean = boole
611
612
  security?: ReadonlyArray<Auth>;
612
613
  url: Url;
613
614
  }
614
- interface ResolvedRequestOptions<ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions$1<unknown, ThrowOnError, Url> {
615
+ interface ResolvedRequestOptions$1<ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions$2<unknown, ThrowOnError, Url> {
615
616
  serializedBody?: string;
616
617
  }
617
- type RequestResult$1<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<{
618
+ type RequestResult$2<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<{
618
619
  data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
619
620
  response: Response;
620
621
  }> : Promise<({
@@ -626,38 +627,38 @@ type RequestResult$1<TData = unknown, TError = unknown, ThrowOnError extends boo
626
627
  }) & {
627
628
  response: Response;
628
629
  }>;
629
- interface ClientOptions$1 {
630
+ interface ClientOptions$2 {
630
631
  baseUrl?: string;
631
632
  throwOnError?: boolean;
632
633
  }
633
- type MethodFn$1 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$1<TData, ThrowOnError>, 'method'>) => RequestResult$1<TData, TError, ThrowOnError>;
634
- type SseFn$1 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$1<TData, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
635
- type RequestFn$1 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$1<TData, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$1<TData, ThrowOnError>>, 'method'>) => RequestResult$1<TData, TError, ThrowOnError>;
636
- type BuildUrlFn$1 = <TData extends {
634
+ type MethodFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$2<TData, ThrowOnError>, 'method'>) => RequestResult$2<TData, TError, ThrowOnError>;
635
+ type SseFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$2<TData, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
636
+ type RequestFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$2<TData, ThrowOnError>, 'method'> & Pick<Required<RequestOptions$2<TData, ThrowOnError>>, 'method'>) => RequestResult$2<TData, TError, ThrowOnError>;
637
+ type BuildUrlFn$2 = <TData extends {
637
638
  body?: unknown;
638
639
  path?: Record<string, unknown>;
639
640
  query?: Record<string, unknown>;
640
641
  url: string;
641
- }>(options: Pick<TData, 'url'> & Options$1<TData>) => string;
642
- type Client$1 = Client$5<RequestFn$1, Config$1, MethodFn$1, BuildUrlFn$1, SseFn$1> & {
643
- interceptors: Middleware<Response, unknown, ResolvedRequestOptions>;
642
+ }>(options: Pick<TData, 'url'> & Options$2<TData>) => string;
643
+ type Client$2 = Client$6<RequestFn$2, Config$2, MethodFn$2, BuildUrlFn$2, SseFn$2> & {
644
+ interceptors: Middleware$1<Response, unknown, ResolvedRequestOptions$1>;
644
645
  };
645
- interface TDataShape$1 {
646
+ interface TDataShape$2 {
646
647
  body?: unknown;
647
648
  headers?: unknown;
648
649
  path?: unknown;
649
650
  query?: unknown;
650
651
  url: string;
651
652
  }
652
- type OmitKeys$1<T, K> = Pick<T, Exclude<keyof T, K>>;
653
- type Options$1<TData extends TDataShape$1 = TDataShape$1, ThrowOnError extends boolean = boolean, TResponse = unknown> = OmitKeys$1<RequestOptions$1<TResponse, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
653
+ type OmitKeys$2<T, K> = Pick<T, Exclude<keyof T, K>>;
654
+ type Options$2<TData extends TDataShape$2 = TDataShape$2, ThrowOnError extends boolean = boolean, TResponse = unknown> = OmitKeys$2<RequestOptions$2<TResponse, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
654
655
 
655
- type QuerySerializer = (query: Parameters<Client['buildUrl']>[0]['query']) => string;
656
+ type QuerySerializer = (query: Parameters<Client$1['buildUrl']>[0]['query']) => string;
656
657
  type WithRefs<TData> = {
657
658
  [K in keyof TData]: NonNullable<TData[K]> extends object ? WithRefs<NonNullable<TData[K]>> | Ref<NonNullable<TData[K]>> : NonNullable<TData[K]> | Ref<NonNullable<TData[K]>>;
658
659
  };
659
660
  type KeysOf<T> = Array<T extends T ? (keyof T extends string ? keyof T : never) : never>;
660
- interface Config<T extends ClientOptions = ClientOptions> extends Omit<FetchOptions<unknown>, 'baseURL' | 'body' | 'headers' | 'method' | 'query'>, WithRefs<Pick<FetchOptions<unknown>, 'query'>>, Omit<Config$5, 'querySerializer'> {
661
+ interface Config$1<T extends ClientOptions$1 = ClientOptions$1> extends Omit<FetchOptions<unknown>, 'baseURL' | 'body' | 'headers' | 'method' | 'query'>, WithRefs<Pick<FetchOptions<unknown>, 'query'>>, Omit<Config$6, 'querySerializer'> {
661
662
  /**
662
663
  * Base URL for all requests made by this client.
663
664
  */
@@ -671,7 +672,7 @@ interface Config<T extends ClientOptions = ClientOptions> extends Omit<FetchOpti
671
672
  */
672
673
  querySerializer?: QuerySerializer | QuerySerializerOptions;
673
674
  }
674
- interface RequestOptions<TComposable extends Composable = '$fetch', ResT = unknown, DefaultT = undefined, Url extends string = string> extends Config, WithRefs<{
675
+ interface RequestOptions$1<TComposable extends Composable = '$fetch', ResT = unknown, DefaultT = undefined, Url extends string = string> extends Config$1, WithRefs<{
675
676
  /**
676
677
  * Any body that you want to add to your request.
677
678
  *
@@ -691,28 +692,210 @@ interface RequestOptions<TComposable extends Composable = '$fetch', ResT = unkno
691
692
  security?: ReadonlyArray<Auth>;
692
693
  url: Url;
693
694
  }
694
- type RequestResult<TComposable extends Composable, ResT, TError> = TComposable extends '$fetch' ? ReturnType<typeof $fetch<ResT>> : TComposable extends 'useAsyncData' ? ReturnType<typeof useAsyncData<ResT | null, TError>> : TComposable extends 'useFetch' ? ReturnType<typeof useFetch<ResT | null, TError>> : TComposable extends 'useLazyAsyncData' ? ReturnType<typeof useLazyAsyncData<ResT | null, TError>> : TComposable extends 'useLazyFetch' ? ReturnType<typeof useLazyFetch<ResT | null, TError>> : never;
695
- interface ClientOptions {
695
+ type RequestResult$1<TComposable extends Composable, ResT, TError> = TComposable extends '$fetch' ? ReturnType<typeof $fetch<ResT>> : TComposable extends 'useAsyncData' ? ReturnType<typeof useAsyncData<ResT | null, TError>> : TComposable extends 'useFetch' ? ReturnType<typeof useFetch<ResT | null, TError>> : TComposable extends 'useLazyAsyncData' ? ReturnType<typeof useLazyAsyncData<ResT | null, TError>> : TComposable extends 'useLazyFetch' ? ReturnType<typeof useLazyFetch<ResT | null, TError>> : never;
696
+ interface ClientOptions$1 {
696
697
  baseURL?: string;
697
698
  }
698
- type MethodFn = <TComposable extends Composable = '$fetch', ResT = unknown, TError = unknown, DefaultT = undefined>(options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'>) => RequestResult<TComposable, ResT, TError>;
699
- type SseFn = <TComposable extends Composable = '$fetch', ResT = unknown, TError = unknown, DefaultT = undefined>(options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'>) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;
700
- type RequestFn = <TComposable extends Composable = '$fetch', ResT = unknown, TError = unknown, DefaultT = undefined>(options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'> & Pick<Required<RequestOptions<TComposable, ResT, DefaultT>>, 'method'>) => RequestResult<TComposable, ResT, TError>;
701
- interface TDataShape {
699
+ type MethodFn$1 = <TComposable extends Composable = '$fetch', ResT = unknown, TError = unknown, DefaultT = undefined>(options: Omit<RequestOptions$1<TComposable, ResT, DefaultT>, 'method'>) => RequestResult$1<TComposable, ResT, TError>;
700
+ type SseFn$1 = <TComposable extends Composable = '$fetch', ResT = unknown, TError = unknown, DefaultT = undefined>(options: Omit<RequestOptions$1<TComposable, ResT, DefaultT>, 'method'>) => Promise<ServerSentEventsResult<RequestResult$1<TComposable, ResT, TError>>>;
701
+ type RequestFn$1 = <TComposable extends Composable = '$fetch', ResT = unknown, TError = unknown, DefaultT = undefined>(options: Omit<RequestOptions$1<TComposable, ResT, DefaultT>, 'method'> & Pick<Required<RequestOptions$1<TComposable, ResT, DefaultT>>, 'method'>) => RequestResult$1<TComposable, ResT, TError>;
702
+ interface TDataShape$1 {
702
703
  body?: unknown;
703
704
  headers?: unknown;
704
705
  path?: FetchOptions<unknown>['query'];
705
706
  query?: FetchOptions<unknown>['query'];
706
707
  url: string;
707
708
  }
708
- type BuildUrlOptions<TData extends Omit<TDataShape, 'headers'> = Omit<TDataShape, 'headers'>> = Pick<WithRefs<TData>, 'path' | 'query'> & Pick<TData, 'url'> & Pick<Options<'$fetch', TData>, 'baseURL' | 'querySerializer'>;
709
- type BuildUrlFn = <TData extends Omit<TDataShape, 'headers'>>(options: BuildUrlOptions<TData>) => string;
710
- type Client = Client$5<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
711
- type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
712
- type Options<TComposable extends Composable = '$fetch', TData extends TDataShape = TDataShape, ResT = unknown, DefaultT = undefined> = OmitKeys<RequestOptions<TComposable, ResT, DefaultT>, 'body' | 'path' | 'query' | 'url'> & WithRefs<Omit<TData, 'url'>>;
709
+ type BuildUrlOptions<TData extends Omit<TDataShape$1, 'headers'> = Omit<TDataShape$1, 'headers'>> = Pick<WithRefs<TData>, 'path' | 'query'> & Pick<TData, 'url'> & Pick<Options$1<'$fetch', TData>, 'baseURL' | 'querySerializer'>;
710
+ type BuildUrlFn$1 = <TData extends Omit<TDataShape$1, 'headers'>>(options: BuildUrlOptions<TData>) => string;
711
+ type Client$1 = Client$6<RequestFn$1, Config$1, MethodFn$1, BuildUrlFn$1, SseFn$1>;
712
+ type OmitKeys$1<T, K> = Pick<T, Exclude<keyof T, K>>;
713
+ type Options$1<TComposable extends Composable = '$fetch', TData extends TDataShape$1 = TDataShape$1, ResT = unknown, DefaultT = undefined> = OmitKeys$1<RequestOptions$1<TComposable, ResT, DefaultT>, 'body' | 'path' | 'query' | 'url'> & WithRefs<Omit<TData, 'url'>>;
713
714
  type FetchOptions<TData> = Omit<UseFetchOptions<TData, TData>, keyof AsyncDataOptions<TData>>;
714
715
  type Composable = '$fetch' | 'useAsyncData' | 'useFetch' | 'useLazyAsyncData' | 'useLazyFetch';
715
716
 
717
+ type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
718
+ type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
719
+ type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
720
+ declare class Interceptors<Interceptor> {
721
+ fns: Array<Interceptor | null>;
722
+ clear(): void;
723
+ eject(id: number | Interceptor): void;
724
+ exists(id: number | Interceptor): boolean;
725
+ getInterceptorIndex(id: number | Interceptor): number;
726
+ update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
727
+ use(fn: Interceptor): number;
728
+ }
729
+ interface Middleware<Req, Res, Err, Options> {
730
+ error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
731
+ request: Interceptors<ReqInterceptor<Req, Options>>;
732
+ response: Interceptors<ResInterceptor<Res, Req, Options>>;
733
+ }
734
+
735
+ type ResponseStyle = 'data' | 'fields';
736
+ interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$6 {
737
+ /**
738
+ * HTTP(S) agent configuration (Node.js only). Passed through to ofetch.
739
+ */
740
+ agent?: FetchOptions$1['agent'];
741
+ /**
742
+ * Base URL for all requests made by this client.
743
+ */
744
+ baseUrl?: T['baseUrl'];
745
+ /**
746
+ * Node-only proxy/agent options.
747
+ */
748
+ dispatcher?: FetchOptions$1['dispatcher'];
749
+ /**
750
+ * Fetch API implementation. Used for SSE streaming. You can use this option
751
+ * to provide a custom fetch instance.
752
+ *
753
+ * @default globalThis.fetch
754
+ */
755
+ fetch?: typeof fetch;
756
+ /**
757
+ * Controls the native ofetch behaviour that throws `FetchError` when
758
+ * `response.ok === false`. We default to suppressing it to match the fetch
759
+ * client semantics and let `throwOnError` drive the outcome.
760
+ */
761
+ ignoreResponseError?: FetchOptions$1['ignoreResponseError'];
762
+ /**
763
+ * Please don't use the Fetch client for Next.js applications. The `next`
764
+ * options won't have any effect.
765
+ *
766
+ * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
767
+ */
768
+ next?: never;
769
+ /**
770
+ * Custom ofetch instance created via `ofetch.create()`. If provided, it will
771
+ * be used for requests instead of the default `ofetch` export.
772
+ */
773
+ ofetch?: typeof ofetch;
774
+ /**
775
+ * ofetch hook called before a request is sent.
776
+ */
777
+ onRequest?: FetchOptions$1['onRequest'];
778
+ /**
779
+ * ofetch hook called when a request fails before receiving a response
780
+ * (e.g., network errors or aborted requests).
781
+ */
782
+ onRequestError?: FetchOptions$1['onRequestError'];
783
+ /**
784
+ * ofetch hook called after a successful response is received and parsed.
785
+ */
786
+ onResponse?: FetchOptions$1['onResponse'];
787
+ /**
788
+ * ofetch hook called when the response indicates an error (non-ok status)
789
+ * or when response parsing fails.
790
+ */
791
+ onResponseError?: FetchOptions$1['onResponseError'];
792
+ /**
793
+ * Return the response data parsed in a specified format. By default, `auto`
794
+ * will infer the appropriate method from the `Content-Type` response header.
795
+ * You can override this behavior with any of the {@link Body} methods.
796
+ * Select `stream` if you don't want to parse response data at all.
797
+ *
798
+ * @default 'auto'
799
+ */
800
+ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
801
+ /** Custom response parser (ofetch). */
802
+ parseResponse?: FetchOptions$1['parseResponse'];
803
+ /**
804
+ * Should we return only data or multiple fields (data, error, response, etc.)?
805
+ *
806
+ * @default 'fields'
807
+ */
808
+ responseStyle?: ResponseStyle;
809
+ /**
810
+ * ofetch responseType override. If provided, it will be passed directly to
811
+ * ofetch and take precedence over `parseAs`.
812
+ */
813
+ responseType?: ResponseType;
814
+ /**
815
+ * Automatically retry failed requests.
816
+ */
817
+ retry?: FetchOptions$1['retry'];
818
+ /**
819
+ * Delay (in ms) between retry attempts.
820
+ */
821
+ retryDelay?: FetchOptions$1['retryDelay'];
822
+ /**
823
+ * HTTP status codes that should trigger a retry.
824
+ */
825
+ retryStatusCodes?: FetchOptions$1['retryStatusCodes'];
826
+ /**
827
+ * Throw an error instead of returning it in the response?
828
+ *
829
+ * @default false
830
+ */
831
+ throwOnError?: T['throwOnError'];
832
+ /**
833
+ * Abort the request after the given milliseconds.
834
+ */
835
+ timeout?: number;
836
+ }
837
+ interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
838
+ responseStyle: TResponseStyle;
839
+ throwOnError: ThrowOnError;
840
+ }>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
841
+ /**
842
+ * Any body that you want to add to your request.
843
+ *
844
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
845
+ */
846
+ body?: unknown;
847
+ path?: Record<string, unknown>;
848
+ query?: Record<string, unknown>;
849
+ /**
850
+ * Security mechanism(s) to use for the request.
851
+ */
852
+ security?: ReadonlyArray<Auth>;
853
+ url: Url;
854
+ }
855
+ interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
856
+ serializedBody?: string;
857
+ }
858
+ type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
859
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
860
+ request: Request;
861
+ response: Response;
862
+ }> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
863
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
864
+ error: undefined;
865
+ } | {
866
+ data: undefined;
867
+ error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
868
+ }) & {
869
+ request: Request;
870
+ response: Response;
871
+ }>;
872
+ interface ClientOptions {
873
+ baseUrl?: string;
874
+ responseStyle?: ResponseStyle;
875
+ throwOnError?: boolean;
876
+ }
877
+ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
878
+ type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
879
+ type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
880
+ type BuildUrlFn = <TData extends {
881
+ body?: unknown;
882
+ path?: Record<string, unknown>;
883
+ query?: Record<string, unknown>;
884
+ url: string;
885
+ }>(options: Pick<TData, 'url'> & Options<TData>) => string;
886
+ type Client = Client$6<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
887
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
888
+ };
889
+ interface TDataShape {
890
+ body?: unknown;
891
+ headers?: unknown;
892
+ path?: unknown;
893
+ query?: unknown;
894
+ url: string;
895
+ }
896
+ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
897
+ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
898
+
716
899
  declare const defaultPaginationKeywords: readonly ["after", "before", "cursor", "offset", "page", "start"];
717
900
 
718
901
  /**
@@ -1378,10 +1561,10 @@ type Configs = UserConfig | (() => UserConfig) | (() => Promise<UserConfig>);
1378
1561
  *
1379
1562
  * @param userConfig User provided {@link UserConfig} configuration.
1380
1563
  */
1381
- declare const createClient: (userConfig?: Configs, logger?: Logger) => Promise<ReadonlyArray<Client$6 | IR.Context>>;
1564
+ declare const createClient: (userConfig?: Configs, logger?: Logger) => Promise<ReadonlyArray<Client$7 | IR.Context>>;
1382
1565
  /**
1383
1566
  * Type helper for openapi-ts.config.ts, returns {@link UserConfig} object
1384
1567
  */
1385
1568
  declare const defineConfig: (config: Configs) => Promise<UserConfig>;
1386
1569
 
1387
- export { type Client$4 as AngularClient, type Client$3 as AxiosClient, type Client$2 as FetchClient, IR, Logger, type Client$1 as NextClient, type Client as NuxtClient, Plugin, UserConfig, clientDefaultConfig, clientDefaultMeta, clientPluginHandler, compiler, createClient, defaultPaginationKeywords, defaultPlugins, defineConfig, definePluginConfig, tsc, utils };
1570
+ export { type Client$5 as AngularClient, type Client$4 as AxiosClient, type Client$3 as FetchClient, IR, Logger, type Client$2 as NextClient, type Client$1 as NuxtClient, type Client as OfetchClient, Plugin, UserConfig, clientDefaultConfig, clientDefaultMeta, clientPluginHandler, compiler, createClient, defaultPaginationKeywords, defaultPlugins, defineConfig, definePluginConfig, tsc, utils };