@hey-api/openapi-ts 0.86.10 → 0.86.12

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,888 +1,16 @@
1
- import { n as __export } from "./chunk-C-EqMg7d.js";
2
- import { A as AccessLevel, C as PluginHandler, D as Comments, E as MaybeArray, F as types_d_exports, M as FunctionTypeParameter, N as ObjectValue, O as ImportExportItemObject, P as SyntaxKindKeyword, S as Client$2, T as LazyOrAsync, _ as OpenApiRequestBodyObject, c as ExpressionTransformer, d as Client$7, f as Operation, g as OpenApiParameterObject, h as OpenApiOperationObject, i as UserConfig, j as FunctionParameter, k as tsNodeToString, l as DefinePlugin, m as OpenApiMetaObject, o as IR, p as OpenApi, s as TypeTransformer, t as LegacyIR, u as Plugin, v as OpenApiResponseObject, w as StringCase, x as Logger, y as OpenApiSchemaObject } from "./types-BDC4ckIh.js";
1
+ import { A as StringCase, B as FunctionTypeParameter, C as PluginHandler, D as Client$3, E as Client$4, F as ImportExportItemObject, H as SyntaxKindKeyword, I as Modifier, L as tsNodeToString, M as LazyOrAsync, N as MaybeArray, O as Client$1, P as Comments, R as AccessLevel, S as Client$2, T as Client$5, U as types_d_exports, V as ObjectValue, _ as OpenApiSchemaObject, b as Client$7, d as OpenApi, f as OpenApiMetaObject, g as OpenApiResponseObject, h as OpenApiRequestBodyObject, i as UserConfig, j as IR, k as Client, l as Context, m as OpenApiParameterObject, o as DefinePlugin, p as OpenApiOperationObject, s as Plugin, t as LegacyIR, u as Logger, v as TypeTransformer, w as Client$6, x as Operation, y as ExpressionTransformer, z as FunctionParameter } from "./types-BRmx9r9T.js";
3
2
  import "@hey-api/codegen-core";
4
3
  import * as typescript0 from "typescript";
5
4
  import ts from "typescript";
6
- import { HttpClient, HttpErrorResponse, HttpHeaders, HttpRequest, HttpResponse } from "@angular/common/http";
7
- import { Injector } from "@angular/core";
8
- import { AxiosError, AxiosInstance, AxiosRequestHeaders, AxiosResponse, AxiosStatic, CreateAxiosDefaults } from "axios";
9
- import { AsyncDataOptions, UseFetchOptions, useAsyncData, useFetch, useLazyAsyncData, useLazyFetch } from "nuxt/app";
10
- import { Ref } from "vue";
11
- import { FetchOptions, ResponseType, ofetch } from "ofetch";
12
5
 
13
- //#region src/plugins/@hey-api/client-core/bundle/auth.d.ts
14
- type AuthToken = string | undefined;
15
- interface Auth {
16
- /**
17
- * Which part of the request do we use to send the auth?
18
- *
19
- * @default 'header'
20
- */
21
- in?: 'header' | 'query' | 'cookie';
22
- /**
23
- * Header or query parameter name.
24
- *
25
- * @default 'Authorization'
26
- */
27
- name?: string;
28
- scheme?: 'basic' | 'bearer';
29
- type: 'apiKey' | 'http';
30
- }
31
- //#endregion
32
- //#region src/plugins/@hey-api/client-core/bundle/pathSerializer.d.ts
33
- interface SerializerOptions<T$1> {
34
- /**
35
- * @default true
36
- */
37
- explode: boolean;
38
- style: T$1;
39
- }
40
- type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
41
- type ObjectStyle = 'form' | 'deepObject';
42
- //#endregion
43
- //#region src/plugins/@hey-api/client-core/bundle/bodySerializer.d.ts
44
- type QuerySerializer$1 = (query: Record<string, unknown>) => string;
45
- type BodySerializer = (body: any) => any;
46
- type QuerySerializerOptionsObject = {
47
- allowReserved?: boolean;
48
- array?: Partial<SerializerOptions<ArrayStyle>>;
49
- object?: Partial<SerializerOptions<ObjectStyle>>;
50
- };
51
- type QuerySerializerOptions = QuerySerializerOptionsObject & {
52
- /**
53
- * Per-parameter serialization overrides. When provided, these settings
54
- * override the global array/object settings for specific parameter names.
55
- */
56
- parameters?: Record<string, QuerySerializerOptionsObject>;
57
- };
58
- //#endregion
59
- //#region src/plugins/@hey-api/client-core/bundle/types.d.ts
60
- type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
61
- type Client$8<RequestFn$6 = never, Config$7 = unknown, MethodFn$6 = never, BuildUrlFn$6 = never, SseFn$6 = never> = {
62
- /**
63
- * Returns the final request URL.
64
- */
65
- buildUrl: BuildUrlFn$6;
66
- getConfig: () => Config$7;
67
- request: RequestFn$6;
68
- setConfig: (config: Config$7) => Config$7;
69
- } & { [K in HttpMethod]: MethodFn$6 } & ([SseFn$6] extends [never] ? {
70
- sse?: never;
71
- } : {
72
- sse: { [K in HttpMethod]: SseFn$6 };
73
- });
74
- interface Config {
75
- /**
76
- * Auth token or a function returning auth token. The resolved value will be
77
- * added to the request payload as defined by its `security` array.
78
- */
79
- auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
80
- /**
81
- * A function for serializing request body parameter. By default,
82
- * {@link JSON.stringify()} will be used.
83
- */
84
- bodySerializer?: BodySerializer | null;
85
- /**
86
- * An object containing any HTTP headers that you want to pre-populate your
87
- * `Headers` object with.
88
- *
89
- * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
90
- */
91
- headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
92
- /**
93
- * The request method.
94
- *
95
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
96
- */
97
- method?: Uppercase<HttpMethod>;
98
- /**
99
- * A function for serializing request query parameters. By default, arrays
100
- * will be exploded in form style, objects will be exploded in deepObject
101
- * style, and reserved characters are percent-encoded.
102
- *
103
- * This method will have no effect if the native `paramsSerializer()` Axios
104
- * API function is used.
105
- *
106
- * {@link https://swagger.io/docs/specification/serialization/#query View examples}
107
- */
108
- querySerializer?: QuerySerializer$1 | QuerySerializerOptions;
109
- /**
110
- * A function validating request data. This is useful if you want to ensure
111
- * the request conforms to the desired shape, so it can be safely sent to
112
- * the server.
113
- */
114
- requestValidator?: (data: unknown) => Promise<unknown>;
115
- /**
116
- * A function transforming response data before it's returned. This is useful
117
- * for post-processing data, e.g. converting ISO strings into Date objects.
118
- */
119
- responseTransformer?: (data: unknown) => Promise<unknown>;
120
- /**
121
- * A function validating response data. This is useful if you want to ensure
122
- * the response conforms to the desired shape, so it can be safely passed to
123
- * the transformers and returned to the user.
124
- */
125
- responseValidator?: (data: unknown) => Promise<unknown>;
126
- }
127
- //#endregion
128
- //#region src/plugins/@hey-api/client-core/bundle/serverSentEvents.d.ts
129
- type ServerSentEventsOptions<TData$1 = unknown> = Omit<RequestInit, 'method'> & Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & {
130
- /**
131
- * Fetch API implementation. You can use this option to provide a custom
132
- * fetch instance.
133
- *
134
- * @default globalThis.fetch
135
- */
136
- fetch?: typeof fetch;
137
- /**
138
- * Implementing clients can call request interceptors inside this hook.
139
- */
140
- onRequest?: (url: string, init: RequestInit) => Promise<Request>;
141
- /**
142
- * Callback invoked when a network or parsing error occurs during streaming.
143
- *
144
- * This option applies only if the endpoint returns a stream of events.
145
- *
146
- * @param error The error that occurred.
147
- */
148
- onSseError?: (error: unknown) => void;
149
- /**
150
- * Callback invoked when an event is streamed from the server.
151
- *
152
- * This option applies only if the endpoint returns a stream of events.
153
- *
154
- * @param event Event streamed from the server.
155
- * @returns Nothing (void).
156
- */
157
- onSseEvent?: (event: StreamEvent<TData$1>) => void;
158
- serializedBody?: RequestInit['body'];
159
- /**
160
- * Default retry delay in milliseconds.
161
- *
162
- * This option applies only if the endpoint returns a stream of events.
163
- *
164
- * @default 3000
165
- */
166
- sseDefaultRetryDelay?: number;
167
- /**
168
- * Maximum number of retry attempts before giving up.
169
- */
170
- sseMaxRetryAttempts?: number;
171
- /**
172
- * Maximum retry delay in milliseconds.
173
- *
174
- * Applies only when exponential backoff is used.
175
- *
176
- * This option applies only if the endpoint returns a stream of events.
177
- *
178
- * @default 30000
179
- */
180
- sseMaxRetryDelay?: number;
181
- /**
182
- * Optional sleep function for retry backoff.
183
- *
184
- * Defaults to using `setTimeout`.
185
- */
186
- sseSleepFn?: (ms: number) => Promise<void>;
187
- url: string;
188
- };
189
- interface StreamEvent<TData$1 = unknown> {
190
- data: TData$1;
191
- event?: string;
192
- id?: string;
193
- retry?: number;
194
- }
195
- type ServerSentEventsResult<TData$1 = unknown, TReturn = void, TNext = unknown> = {
196
- stream: AsyncGenerator<TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1, TReturn, TNext>;
197
- };
198
- //#endregion
199
- //#region src/plugins/@hey-api/client-angular/bundle/utils.d.ts
200
- type ErrInterceptor$3<Err$1, Res$1, Req$1, Options$7> = (error: Err$1, response: Res$1, request: Req$1, options: Options$7) => Err$1 | Promise<Err$1>;
201
- type ReqInterceptor$3<Req$1, Options$7> = (request: Req$1, options: Options$7) => Req$1 | Promise<Req$1>;
202
- type ResInterceptor$3<Res$1, Req$1, Options$7> = (response: Res$1, request: Req$1, options: Options$7) => Res$1 | Promise<Res$1>;
203
- declare class Interceptors$3<Interceptor> {
204
- fns: Array<Interceptor | null>;
205
- clear(): void;
206
- eject(id: number | Interceptor): void;
207
- exists(id: number | Interceptor): boolean;
208
- getInterceptorIndex(id: number | Interceptor): number;
209
- update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
210
- use(fn: Interceptor): number;
211
- }
212
- interface Middleware$3<Req$1, Res$1, Err$1, Options$7> {
213
- error: Interceptors$3<ErrInterceptor$3<Err$1, Res$1, Req$1, Options$7>>;
214
- request: Interceptors$3<ReqInterceptor$3<Req$1, Options$7>>;
215
- response: Interceptors$3<ResInterceptor$3<Res$1, Req$1, Options$7>>;
216
- }
217
- //#endregion
218
- //#region src/plugins/@hey-api/client-angular/bundle/types.d.ts
219
- type ResponseStyle$2 = 'data' | 'fields';
220
- interface Config$6<T$1 extends ClientOptions$5 = ClientOptions$5> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Omit<Config, 'headers'> {
221
- /**
222
- * Base URL for all requests made by this client.
223
- */
224
- baseUrl?: T$1['baseUrl'];
225
- /**
226
- * An object containing any HTTP headers that you want to pre-populate your
227
- * `HttpHeaders` object with.
228
- *
229
- * {@link https://angular.dev/api/common/http/HttpHeaders#constructor See more}
230
- */
231
- headers?: HttpHeaders | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
232
- /**
233
- * The HTTP client to use for making requests.
234
- */
235
- httpClient?: HttpClient;
236
- /**
237
- * Should we return only data or multiple fields (data, error, response, etc.)?
238
- *
239
- * @default 'fields'
240
- */
241
- responseStyle?: ResponseStyle$2;
242
- /**
243
- * Throw an error instead of returning it in the response?
244
- *
245
- * @default false
246
- */
247
- throwOnError?: T$1['throwOnError'];
248
- }
249
- interface RequestOptions$5<TData$1 = unknown, TResponseStyle$1 extends ResponseStyle$2 = 'fields', ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends Config$6<{
250
- responseStyle: TResponseStyle$1;
251
- throwOnError: ThrowOnError$1;
252
- }>, Pick<ServerSentEventsOptions<TData$1>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
253
- /**
254
- * Any body that you want to add to your request.
255
- *
256
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
257
- */
258
- body?: unknown;
259
- /**
260
- * Optional custom injector for dependency resolution if you don't implicitly or explicitly provide one.
261
- */
262
- injector?: Injector;
263
- path?: Record<string, unknown>;
264
- query?: Record<string, unknown>;
265
- /**
266
- * Security mechanism(s) to use for the request.
267
- */
268
- security?: ReadonlyArray<Auth>;
269
- url: Url;
270
- }
271
- interface ResolvedRequestOptions$3<TResponseStyle$1 extends ResponseStyle$2 = 'fields', ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends RequestOptions$5<unknown, TResponseStyle$1, ThrowOnError$1, Url> {
272
- serializedBody?: string;
273
- }
274
- type RequestResult$5<TData$1 = unknown, TError$1 = unknown, ThrowOnError$1 extends boolean = boolean, TResponseStyle$1 extends ResponseStyle$2 = 'fields'> = Promise<ThrowOnError$1 extends true ? TResponseStyle$1 extends 'data' ? TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1 : {
275
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
276
- request: HttpRequest<unknown>;
277
- response: HttpResponse<TData$1>;
278
- } : TResponseStyle$1 extends 'data' ? (TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1) | undefined : {
279
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
280
- error: undefined;
281
- request: HttpRequest<unknown>;
282
- response: HttpResponse<TData$1>;
283
- } | {
284
- data: undefined;
285
- error: TError$1[keyof TError$1];
286
- request: HttpRequest<unknown>;
287
- response: HttpErrorResponse & {
288
- error: TError$1[keyof TError$1] | null;
289
- };
290
- }>;
291
- interface ClientOptions$5 {
292
- baseUrl?: string;
293
- responseStyle?: ResponseStyle$2;
294
- throwOnError?: boolean;
295
- }
296
- 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>;
297
- 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>>;
298
- 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>;
299
- type RequestOptionsFn = <ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle$2 = 'fields'>(options: RequestOptions$5<unknown, TResponseStyle, ThrowOnError>) => HttpRequest<unknown>;
300
- type BuildUrlFn$5 = <TData extends {
301
- body?: unknown;
302
- path?: Record<string, unknown>;
303
- query?: Record<string, unknown>;
304
- url: string;
305
- }>(options: Pick<TData, 'url'> & Options$6<TData>) => string;
306
- type Client = Client$8<RequestFn$5, Config$6, MethodFn$5, BuildUrlFn$5, SseFn$5> & {
307
- interceptors: Middleware$3<HttpRequest<unknown>, HttpResponse<unknown>, unknown, ResolvedRequestOptions$3>;
308
- requestOptions: RequestOptionsFn;
309
- };
310
- interface TDataShape$5 {
311
- body?: unknown;
312
- headers?: unknown;
313
- path?: unknown;
314
- query?: unknown;
315
- url: string;
316
- }
317
- type OmitKeys$5<T$1, K$1> = Pick<T$1, Exclude<keyof T$1, K$1>>;
318
- type Options$6<TData$1 extends TDataShape$5 = TDataShape$5, ThrowOnError$1 extends boolean = boolean, TResponse = unknown, TResponseStyle$1 extends ResponseStyle$2 = 'fields'> = OmitKeys$5<RequestOptions$5<TResponse, TResponseStyle$1, ThrowOnError$1>, 'body' | 'path' | 'query' | 'url'> & Omit<TData$1, 'url'>;
319
- //#endregion
320
- //#region src/plugins/@hey-api/client-axios/bundle/types.d.ts
321
- interface Config$5<T$1 extends ClientOptions$4 = ClientOptions$4> extends Omit<CreateAxiosDefaults, 'auth' | 'baseURL' | 'headers' | 'method'>, Config {
322
- /**
323
- * Axios implementation. You can use this option to provide either an
324
- * `AxiosStatic` or an `AxiosInstance`.
325
- *
326
- * @default axios
327
- */
328
- axios?: AxiosStatic | AxiosInstance;
329
- /**
330
- * Base URL for all requests made by this client.
331
- */
332
- baseURL?: T$1['baseURL'];
333
- /**
334
- * An object containing any HTTP headers that you want to pre-populate your
335
- * `Headers` object with.
336
- *
337
- * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
338
- */
339
- headers?: AxiosRequestHeaders | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
340
- /**
341
- * Throw an error instead of returning it in the response?
342
- *
343
- * @default false
344
- */
345
- throwOnError?: T$1['throwOnError'];
346
- }
347
- interface RequestOptions$4<TData$1 = unknown, ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends Config$5<{
348
- throwOnError: ThrowOnError$1;
349
- }>, Pick<ServerSentEventsOptions<TData$1>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
350
- /**
351
- * Any body that you want to add to your request.
352
- *
353
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
354
- */
355
- body?: unknown;
356
- path?: Record<string, unknown>;
357
- query?: Record<string, unknown>;
358
- /**
359
- * Security mechanism(s) to use for the request.
360
- */
361
- security?: ReadonlyArray<Auth>;
362
- url: Url;
363
- }
364
- interface ClientOptions$4 {
365
- baseURL?: string;
366
- throwOnError?: boolean;
367
- }
368
- type RequestResult$4<TData$1 = unknown, TError$1 = unknown, ThrowOnError$1 extends boolean = boolean> = ThrowOnError$1 extends true ? Promise<AxiosResponse<TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1>> : Promise<(AxiosResponse<TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1> & {
369
- error: undefined;
370
- }) | (AxiosError<TError$1 extends Record<string, unknown> ? TError$1[keyof TError$1] : TError$1> & {
371
- data: undefined;
372
- error: TError$1 extends Record<string, unknown> ? TError$1[keyof TError$1] : TError$1;
373
- })>;
374
- type MethodFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$4<TData, ThrowOnError>, 'method'>) => RequestResult$4<TData, TError, ThrowOnError>;
375
- type SseFn$4 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$4<TData, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
376
- 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>;
377
- type BuildUrlFn$4 = <TData extends {
378
- body?: unknown;
379
- path?: Record<string, unknown>;
380
- query?: Record<string, unknown>;
381
- url: string;
382
- }>(options: Pick<TData, 'url'> & Options$5<TData>) => string;
383
- type Client$1 = Client$8<RequestFn$4, Config$5, MethodFn$4, BuildUrlFn$4, SseFn$4> & {
384
- instance: AxiosInstance;
385
- };
386
- interface TDataShape$4 {
387
- body?: unknown;
388
- headers?: unknown;
389
- path?: unknown;
390
- query?: unknown;
391
- url: string;
392
- }
393
- type OmitKeys$4<T$1, K$1> = Pick<T$1, Exclude<keyof T$1, K$1>>;
394
- type Options$5<TData$1 extends TDataShape$4 = TDataShape$4, ThrowOnError$1 extends boolean = boolean, TResponse = unknown> = OmitKeys$4<RequestOptions$4<TResponse, ThrowOnError$1>, 'body' | 'path' | 'query' | 'url'> & Omit<TData$1, 'url'>;
395
- //#endregion
396
- //#region src/plugins/@hey-api/client-fetch/bundle/utils.d.ts
397
- type ErrInterceptor$2<Err$1, Res$1, Req$1, Options$7> = (error: Err$1, response: Res$1, request: Req$1, options: Options$7) => Err$1 | Promise<Err$1>;
398
- type ReqInterceptor$2<Req$1, Options$7> = (request: Req$1, options: Options$7) => Req$1 | Promise<Req$1>;
399
- type ResInterceptor$2<Res$1, Req$1, Options$7> = (response: Res$1, request: Req$1, options: Options$7) => Res$1 | Promise<Res$1>;
400
- declare class Interceptors$2<Interceptor> {
401
- fns: Array<Interceptor | null>;
402
- clear(): void;
403
- eject(id: number | Interceptor): void;
404
- exists(id: number | Interceptor): boolean;
405
- getInterceptorIndex(id: number | Interceptor): number;
406
- update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
407
- use(fn: Interceptor): number;
408
- }
409
- interface Middleware$2<Req$1, Res$1, Err$1, Options$7> {
410
- error: Interceptors$2<ErrInterceptor$2<Err$1, Res$1, Req$1, Options$7>>;
411
- request: Interceptors$2<ReqInterceptor$2<Req$1, Options$7>>;
412
- response: Interceptors$2<ResInterceptor$2<Res$1, Req$1, Options$7>>;
413
- }
414
- //#endregion
415
- //#region src/plugins/@hey-api/client-fetch/bundle/types.d.ts
416
- type ResponseStyle$1 = 'data' | 'fields';
417
- interface Config$4<T$1 extends ClientOptions$3 = ClientOptions$3> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config {
418
- /**
419
- * Base URL for all requests made by this client.
420
- */
421
- baseUrl?: T$1['baseUrl'];
422
- /**
423
- * Fetch API implementation. You can use this option to provide a custom
424
- * fetch instance.
425
- *
426
- * @default globalThis.fetch
427
- */
428
- fetch?: typeof fetch;
429
- /**
430
- * Please don't use the Fetch client for Next.js applications. The `next`
431
- * options won't have any effect.
432
- *
433
- * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
434
- */
435
- next?: never;
436
- /**
437
- * Return the response data parsed in a specified format. By default, `auto`
438
- * will infer the appropriate method from the `Content-Type` response header.
439
- * You can override this behavior with any of the {@link Body} methods.
440
- * Select `stream` if you don't want to parse response data at all.
441
- *
442
- * @default 'auto'
443
- */
444
- parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
445
- /**
446
- * Should we return only data or multiple fields (data, error, response, etc.)?
447
- *
448
- * @default 'fields'
449
- */
450
- responseStyle?: ResponseStyle$1;
451
- /**
452
- * Throw an error instead of returning it in the response?
453
- *
454
- * @default false
455
- */
456
- throwOnError?: T$1['throwOnError'];
457
- }
458
- interface RequestOptions$3<TData$1 = unknown, TResponseStyle$1 extends ResponseStyle$1 = 'fields', ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends Config$4<{
459
- responseStyle: TResponseStyle$1;
460
- throwOnError: ThrowOnError$1;
461
- }>, Pick<ServerSentEventsOptions<TData$1>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
462
- /**
463
- * Any body that you want to add to your request.
464
- *
465
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
466
- */
467
- body?: unknown;
468
- path?: Record<string, unknown>;
469
- query?: Record<string, unknown>;
470
- /**
471
- * Security mechanism(s) to use for the request.
472
- */
473
- security?: ReadonlyArray<Auth>;
474
- url: Url;
475
- }
476
- interface ResolvedRequestOptions$2<TResponseStyle$1 extends ResponseStyle$1 = 'fields', ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends RequestOptions$3<unknown, TResponseStyle$1, ThrowOnError$1, Url> {
477
- serializedBody?: string;
478
- }
479
- type RequestResult$3<TData$1 = unknown, TError$1 = unknown, ThrowOnError$1 extends boolean = boolean, TResponseStyle$1 extends ResponseStyle$1 = 'fields'> = ThrowOnError$1 extends true ? Promise<TResponseStyle$1 extends 'data' ? TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1 : {
480
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
481
- request: Request;
482
- response: Response;
483
- }> : Promise<TResponseStyle$1 extends 'data' ? (TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1) | undefined : ({
484
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
485
- error: undefined;
486
- } | {
487
- data: undefined;
488
- error: TError$1 extends Record<string, unknown> ? TError$1[keyof TError$1] : TError$1;
489
- }) & {
490
- request: Request;
491
- response: Response;
492
- }>;
493
- interface ClientOptions$3 {
494
- baseUrl?: string;
495
- responseStyle?: ResponseStyle$1;
496
- throwOnError?: boolean;
497
- }
498
- 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>;
499
- 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>>;
500
- 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>;
501
- type BuildUrlFn$3 = <TData extends {
502
- body?: unknown;
503
- path?: Record<string, unknown>;
504
- query?: Record<string, unknown>;
505
- url: string;
506
- }>(options: Pick<TData, 'url'> & Options$4<TData>) => string;
507
- type Client$3 = Client$8<RequestFn$3, Config$4, MethodFn$3, BuildUrlFn$3, SseFn$3> & {
508
- interceptors: Middleware$2<Request, Response, unknown, ResolvedRequestOptions$2>;
509
- };
510
- interface TDataShape$3 {
511
- body?: unknown;
512
- headers?: unknown;
513
- path?: unknown;
514
- query?: unknown;
515
- url: string;
516
- }
517
- type OmitKeys$3<T$1, K$1> = Pick<T$1, Exclude<keyof T$1, K$1>>;
518
- type Options$4<TData$1 extends TDataShape$3 = TDataShape$3, ThrowOnError$1 extends boolean = boolean, TResponse = unknown, TResponseStyle$1 extends ResponseStyle$1 = 'fields'> = OmitKeys$3<RequestOptions$3<TResponse, TResponseStyle$1, ThrowOnError$1>, 'body' | 'path' | 'query' | 'url'> & Omit<TData$1, 'url'>;
519
- //#endregion
520
- //#region src/plugins/@hey-api/client-next/bundle/utils.d.ts
521
- type ErrInterceptor$1<Err$1, Res$1, Options$7> = (error: Err$1, response: Res$1, options: Options$7) => Err$1 | Promise<Err$1>;
522
- type ReqInterceptor$1<Options$7> = (options: Options$7) => void | Promise<void>;
523
- type ResInterceptor$1<Res$1, Options$7> = (response: Res$1, options: Options$7) => Res$1 | Promise<Res$1>;
524
- declare class Interceptors$1<Interceptor> {
525
- fns: Array<Interceptor | null>;
526
- clear(): void;
527
- eject(id: number | Interceptor): void;
528
- exists(id: number | Interceptor): boolean;
529
- getInterceptorIndex(id: number | Interceptor): number;
530
- update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
531
- use(fn: Interceptor): number;
532
- }
533
- interface Middleware$1<Res$1, Err$1, Options$7> {
534
- error: Interceptors$1<ErrInterceptor$1<Err$1, Res$1, Options$7>>;
535
- request: Interceptors$1<ReqInterceptor$1<Options$7>>;
536
- response: Interceptors$1<ResInterceptor$1<Res$1, Options$7>>;
537
- }
538
- //#endregion
539
- //#region src/plugins/@hey-api/client-next/bundle/types.d.ts
540
- interface Config$3<T$1 extends ClientOptions$2 = ClientOptions$2> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config {
541
- /**
542
- * Base URL for all requests made by this client.
543
- */
544
- baseUrl?: T$1['baseUrl'];
545
- /**
546
- * Fetch API implementation. You can use this option to provide a custom
547
- * fetch instance.
548
- *
549
- * @default globalThis.fetch
550
- */
551
- fetch?: typeof fetch;
552
- /**
553
- * Return the response data parsed in a specified format. By default, `auto`
554
- * will infer the appropriate method from the `Content-Type` response header.
555
- * You can override this behavior with any of the {@link Body} methods.
556
- * Select `stream` if you don't want to parse response data at all.
557
- *
558
- * @default 'auto'
559
- */
560
- parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
561
- /**
562
- * Throw an error instead of returning it in the response?
563
- *
564
- * @default false
565
- */
566
- throwOnError?: T$1['throwOnError'];
567
- }
568
- interface RequestOptions$2<TData$1 = unknown, ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends Config$3<{
569
- throwOnError: ThrowOnError$1;
570
- }>, Pick<ServerSentEventsOptions<TData$1>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
571
- /**
572
- * Any body that you want to add to your request.
573
- *
574
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
575
- */
576
- body?: unknown;
577
- path?: Record<string, unknown>;
578
- query?: Record<string, unknown>;
579
- /**
580
- * Security mechanism(s) to use for the request.
581
- */
582
- security?: ReadonlyArray<Auth>;
583
- url: Url;
584
- }
585
- interface ResolvedRequestOptions$1<ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends RequestOptions$2<unknown, ThrowOnError$1, Url> {
586
- serializedBody?: string;
587
- }
588
- type RequestResult$2<TData$1 = unknown, TError$1 = unknown, ThrowOnError$1 extends boolean = boolean> = ThrowOnError$1 extends true ? Promise<{
589
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
590
- response: Response;
591
- }> : Promise<({
592
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
593
- error: undefined;
594
- } | {
595
- data: undefined;
596
- error: TError$1 extends Record<string, unknown> ? TError$1[keyof TError$1] : TError$1;
597
- }) & {
598
- response: Response;
599
- }>;
600
- interface ClientOptions$2 {
601
- baseUrl?: string;
602
- throwOnError?: boolean;
603
- }
604
- type MethodFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$2<TData, ThrowOnError>, 'method'>) => RequestResult$2<TData, TError, ThrowOnError>;
605
- type SseFn$2 = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions$2<TData, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
606
- 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>;
607
- type BuildUrlFn$2 = <TData extends {
608
- body?: unknown;
609
- path?: Record<string, unknown>;
610
- query?: Record<string, unknown>;
611
- url: string;
612
- }>(options: Pick<TData, 'url'> & Options$3<TData>) => string;
613
- type Client$4 = Client$8<RequestFn$2, Config$3, MethodFn$2, BuildUrlFn$2, SseFn$2> & {
614
- interceptors: Middleware$1<Response, unknown, ResolvedRequestOptions$1>;
615
- };
616
- interface TDataShape$2 {
617
- body?: unknown;
618
- headers?: unknown;
619
- path?: unknown;
620
- query?: unknown;
621
- url: string;
622
- }
623
- type OmitKeys$2<T$1, K$1> = Pick<T$1, Exclude<keyof T$1, K$1>>;
624
- type Options$3<TData$1 extends TDataShape$2 = TDataShape$2, ThrowOnError$1 extends boolean = boolean, TResponse = unknown> = OmitKeys$2<RequestOptions$2<TResponse, ThrowOnError$1>, 'body' | 'path' | 'query' | 'url'> & Omit<TData$1, 'url'>;
625
- //#endregion
626
- //#region src/plugins/@hey-api/client-nuxt/bundle/types.d.ts
627
- type QuerySerializer = (query: Parameters<Client$5['buildUrl']>[0]['query']) => string;
628
- type WithRefs<TData$1> = { [K in keyof TData$1]: NonNullable<TData$1[K]> extends object ? WithRefs<NonNullable<TData$1[K]>> | Ref<NonNullable<TData$1[K]>> : NonNullable<TData$1[K]> | Ref<NonNullable<TData$1[K]>> };
629
- type KeysOf<T$1> = Array<T$1 extends T$1 ? (keyof T$1 extends string ? keyof T$1 : never) : never>;
630
- interface Config$2<T$1 extends ClientOptions$1 = ClientOptions$1> extends Omit<FetchOptions$1<unknown>, 'baseURL' | 'body' | 'headers' | 'method' | 'query'>, WithRefs<Pick<FetchOptions$1<unknown>, 'query'>>, Omit<Config, 'querySerializer'> {
631
- /**
632
- * Base URL for all requests made by this client.
633
- */
634
- baseURL?: T$1['baseURL'];
635
- /**
636
- * A function for serializing request query parameters. By default, arrays
637
- * will be exploded in form style, objects will be exploded in deepObject
638
- * style, and reserved characters are percent-encoded.
639
- *
640
- * {@link https://swagger.io/docs/specification/serialization/#query View examples}
641
- */
642
- querySerializer?: QuerySerializer | QuerySerializerOptions;
643
- }
644
- interface RequestOptions$1<TComposable$1 extends Composable = '$fetch', ResT$1 = unknown, DefaultT$1 = undefined, Url extends string = string> extends Config$2, WithRefs<{
645
- /**
646
- * Any body that you want to add to your request.
647
- *
648
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
649
- */
650
- body?: unknown;
651
- path?: FetchOptions$1<unknown>['query'];
652
- query?: FetchOptions$1<unknown>['query'];
653
- rawBody?: unknown;
654
- }>, Pick<ServerSentEventsOptions<ResT$1>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
655
- asyncDataOptions?: AsyncDataOptions<ResT$1, ResT$1, KeysOf<ResT$1>, DefaultT$1>;
656
- composable?: TComposable$1;
657
- key?: string;
658
- /**
659
- * Security mechanism(s) to use for the request.
660
- */
661
- security?: ReadonlyArray<Auth>;
662
- url: Url;
663
- }
664
- type RequestResult$1<TComposable$1 extends Composable, ResT$1, TError$1> = TComposable$1 extends '$fetch' ? ReturnType<typeof $fetch<ResT$1>> : TComposable$1 extends 'useAsyncData' ? ReturnType<typeof useAsyncData<ResT$1 | null, TError$1>> : TComposable$1 extends 'useFetch' ? ReturnType<typeof useFetch<ResT$1 | null, TError$1>> : TComposable$1 extends 'useLazyAsyncData' ? ReturnType<typeof useLazyAsyncData<ResT$1 | null, TError$1>> : TComposable$1 extends 'useLazyFetch' ? ReturnType<typeof useLazyFetch<ResT$1 | null, TError$1>> : never;
665
- interface ClientOptions$1 {
666
- baseURL?: string;
667
- }
668
- 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>;
669
- 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>>>;
670
- 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>;
671
- /**
672
- * The `createClientConfig()` function will be called on client initialization
673
- * and the returned object will become the client's initial configuration.
674
- *
675
- * You may want to initialize your client this way instead of calling
676
- * `setConfig()`. This is useful for example if you're using Next.js
677
- * to ensure your client always has the correct values.
678
- */
679
-
680
- interface TDataShape$1 {
681
- body?: unknown;
682
- headers?: unknown;
683
- path?: FetchOptions$1<unknown>['query'];
684
- query?: FetchOptions$1<unknown>['query'];
685
- url: string;
686
- }
687
- type BuildUrlOptions<TData$1 extends Omit<TDataShape$1, 'headers'> = Omit<TDataShape$1, 'headers'>> = Pick<WithRefs<TData$1>, 'path' | 'query'> & Pick<TData$1, 'url'> & Pick<Options$2<'$fetch', TData$1>, 'baseURL' | 'querySerializer'>;
688
- type BuildUrlFn$1 = <TData extends Omit<TDataShape$1, 'headers'>>(options: BuildUrlOptions<TData>) => string;
689
- type Client$5 = Client$8<RequestFn$1, Config$2, MethodFn$1, BuildUrlFn$1, SseFn$1>;
690
- type OmitKeys$1<T$1, K$1> = Pick<T$1, Exclude<keyof T$1, K$1>>;
691
- type Options$2<TComposable$1 extends Composable = '$fetch', TData$1 extends TDataShape$1 = TDataShape$1, ResT$1 = unknown, DefaultT$1 = undefined> = OmitKeys$1<RequestOptions$1<TComposable$1, ResT$1, DefaultT$1>, 'body' | 'path' | 'query' | 'url'> & WithRefs<Omit<TData$1, 'url'>>;
692
- type FetchOptions$1<TData$1> = Omit<UseFetchOptions<TData$1, TData$1>, keyof AsyncDataOptions<TData$1>>;
693
- type Composable = '$fetch' | 'useAsyncData' | 'useFetch' | 'useLazyAsyncData' | 'useLazyFetch';
694
- //#endregion
695
- //#region src/plugins/@hey-api/client-ofetch/bundle/utils.d.ts
696
- type ErrInterceptor<Err$1, Res$1, Req$1, Options$7> = (error: Err$1, response: Res$1, request: Req$1, options: Options$7) => Err$1 | Promise<Err$1>;
697
- type ReqInterceptor<Req$1, Options$7> = (request: Req$1, options: Options$7) => Req$1 | Promise<Req$1>;
698
- type ResInterceptor<Res$1, Req$1, Options$7> = (response: Res$1, request: Req$1, options: Options$7) => Res$1 | Promise<Res$1>;
699
- declare class Interceptors<Interceptor> {
700
- fns: Array<Interceptor | null>;
701
- clear(): void;
702
- eject(id: number | Interceptor): void;
703
- exists(id: number | Interceptor): boolean;
704
- getInterceptorIndex(id: number | Interceptor): number;
705
- update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
706
- use(fn: Interceptor): number;
707
- }
708
- interface Middleware<Req$1, Res$1, Err$1, Options$7> {
709
- error: Interceptors<ErrInterceptor<Err$1, Res$1, Req$1, Options$7>>;
710
- request: Interceptors<ReqInterceptor<Req$1, Options$7>>;
711
- response: Interceptors<ResInterceptor<Res$1, Req$1, Options$7>>;
712
- }
713
- //#endregion
714
- //#region src/plugins/@hey-api/client-ofetch/bundle/types.d.ts
715
- type ResponseStyle = 'data' | 'fields';
716
- interface Config$1<T$1 extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config {
717
- /**
718
- * HTTP(S) agent configuration (Node.js only). Passed through to ofetch.
719
- */
720
- agent?: FetchOptions['agent'];
721
- /**
722
- * Base URL for all requests made by this client.
723
- */
724
- baseUrl?: T$1['baseUrl'];
725
- /**
726
- * Node-only proxy/agent options.
727
- */
728
- dispatcher?: FetchOptions['dispatcher'];
729
- /**
730
- * Fetch API implementation. Used for SSE streaming. You can use this option
731
- * to provide a custom fetch instance.
732
- *
733
- * @default globalThis.fetch
734
- */
735
- fetch?: typeof fetch;
736
- /**
737
- * Controls the native ofetch behaviour that throws `FetchError` when
738
- * `response.ok === false`. We default to suppressing it to match the fetch
739
- * client semantics and let `throwOnError` drive the outcome.
740
- */
741
- ignoreResponseError?: FetchOptions['ignoreResponseError'];
742
- /**
743
- * Please don't use the Fetch client for Next.js applications. The `next`
744
- * options won't have any effect.
745
- *
746
- * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
747
- */
748
- next?: never;
749
- /**
750
- * Custom ofetch instance created via `ofetch.create()`. If provided, it will
751
- * be used for requests instead of the default `ofetch` export.
752
- */
753
- ofetch?: typeof ofetch;
754
- /**
755
- * ofetch hook called before a request is sent.
756
- */
757
- onRequest?: FetchOptions['onRequest'];
758
- /**
759
- * ofetch hook called when a request fails before receiving a response
760
- * (e.g., network errors or aborted requests).
761
- */
762
- onRequestError?: FetchOptions['onRequestError'];
763
- /**
764
- * ofetch hook called after a successful response is received and parsed.
765
- */
766
- onResponse?: FetchOptions['onResponse'];
767
- /**
768
- * ofetch hook called when the response indicates an error (non-ok status)
769
- * or when response parsing fails.
770
- */
771
- onResponseError?: FetchOptions['onResponseError'];
772
- /**
773
- * Return the response data parsed in a specified format. By default, `auto`
774
- * will infer the appropriate method from the `Content-Type` response header.
775
- * You can override this behavior with any of the {@link Body} methods.
776
- * Select `stream` if you don't want to parse response data at all.
777
- *
778
- * @default 'auto'
779
- */
780
- parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
781
- /** Custom response parser (ofetch). */
782
- parseResponse?: FetchOptions['parseResponse'];
783
- /**
784
- * Should we return only data or multiple fields (data, error, response, etc.)?
785
- *
786
- * @default 'fields'
787
- */
788
- responseStyle?: ResponseStyle;
789
- /**
790
- * ofetch responseType override. If provided, it will be passed directly to
791
- * ofetch and take precedence over `parseAs`.
792
- */
793
- responseType?: ResponseType;
794
- /**
795
- * Automatically retry failed requests.
796
- */
797
- retry?: FetchOptions['retry'];
798
- /**
799
- * Delay (in ms) between retry attempts.
800
- */
801
- retryDelay?: FetchOptions['retryDelay'];
802
- /**
803
- * HTTP status codes that should trigger a retry.
804
- */
805
- retryStatusCodes?: FetchOptions['retryStatusCodes'];
806
- /**
807
- * Throw an error instead of returning it in the response?
808
- *
809
- * @default false
810
- */
811
- throwOnError?: T$1['throwOnError'];
812
- /**
813
- * Abort the request after the given milliseconds.
814
- */
815
- timeout?: number;
816
- }
817
- interface RequestOptions<TData$1 = unknown, TResponseStyle$1 extends ResponseStyle = 'fields', ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends Config$1<{
818
- responseStyle: TResponseStyle$1;
819
- throwOnError: ThrowOnError$1;
820
- }>, Pick<ServerSentEventsOptions<TData$1>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
821
- /**
822
- * Any body that you want to add to your request.
823
- *
824
- * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
825
- */
826
- body?: unknown;
827
- path?: Record<string, unknown>;
828
- query?: Record<string, unknown>;
829
- /**
830
- * Security mechanism(s) to use for the request.
831
- */
832
- security?: ReadonlyArray<Auth>;
833
- url: Url;
834
- }
835
- interface ResolvedRequestOptions<TResponseStyle$1 extends ResponseStyle = 'fields', ThrowOnError$1 extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle$1, ThrowOnError$1, Url> {
836
- serializedBody?: string;
837
- }
838
- type RequestResult<TData$1 = unknown, TError$1 = unknown, ThrowOnError$1 extends boolean = boolean, TResponseStyle$1 extends ResponseStyle = 'fields'> = ThrowOnError$1 extends true ? Promise<TResponseStyle$1 extends 'data' ? TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1 : {
839
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
840
- request: Request;
841
- response: Response;
842
- }> : Promise<TResponseStyle$1 extends 'data' ? (TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1) | undefined : ({
843
- data: TData$1 extends Record<string, unknown> ? TData$1[keyof TData$1] : TData$1;
844
- error: undefined;
845
- } | {
846
- data: undefined;
847
- error: TError$1 extends Record<string, unknown> ? TError$1[keyof TError$1] : TError$1;
848
- }) & {
849
- request: Request;
850
- response: Response;
851
- }>;
852
- interface ClientOptions {
853
- baseUrl?: string;
854
- responseStyle?: ResponseStyle;
855
- throwOnError?: boolean;
856
- }
857
- 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>;
858
- 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>>;
859
- 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>;
860
- type BuildUrlFn = <TData extends {
861
- body?: unknown;
862
- path?: Record<string, unknown>;
863
- query?: Record<string, unknown>;
864
- url: string;
865
- }>(options: Pick<TData, 'url'> & Options$1<TData>) => string;
866
- type Client$6 = Client$8<RequestFn, Config$1, MethodFn, BuildUrlFn, SseFn> & {
867
- interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
868
- };
869
- interface TDataShape {
870
- body?: unknown;
871
- headers?: unknown;
872
- path?: unknown;
873
- query?: unknown;
874
- url: string;
875
- }
876
- type OmitKeys<T$1, K$1> = Pick<T$1, Exclude<keyof T$1, K$1>>;
877
- type Options$1<TData$1 extends TDataShape = TDataShape, ThrowOnError$1 extends boolean = boolean, TResponse = unknown, TResponseStyle$1 extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle$1, ThrowOnError$1>, 'body' | 'path' | 'query' | 'url'> & Omit<TData$1, 'url'>;
878
- //#endregion
879
6
  //#region src/generate.d.ts
7
+
880
8
  /**
881
9
  * Generate a client from the provided configuration.
882
10
  *
883
11
  * @param userConfig User provided {@link UserConfig} configuration(s).
884
12
  */
885
- declare const createClient: (userConfig?: LazyOrAsync<MaybeArray<UserConfig>>, logger?: Logger) => Promise<ReadonlyArray<Client$7 | IR.Context>>;
13
+ declare const createClient: (userConfig?: LazyOrAsync<MaybeArray<UserConfig>>, logger?: Logger) => Promise<ReadonlyArray<Client$7 | Context>>;
886
14
  //#endregion
887
15
  //#region src/config/parser.d.ts
888
16
  declare const defaultPaginationKeywords: readonly ["after", "before", "cursor", "offset", "page", "start"];
@@ -1201,10 +329,12 @@ declare const tsc: {
1201
329
  typeParameters?: typescript0.TypeParameterDeclaration[];
1202
330
  }) => typescript0.FunctionTypeNode;
1203
331
  getAccessorDeclaration: ({
332
+ modifiers,
1204
333
  name,
1205
334
  returnType,
1206
335
  statements
1207
336
  }: {
337
+ modifiers?: Modifier | ReadonlyArray<Modifier>;
1208
338
  name: string | typescript0.PropertyName;
1209
339
  returnType?: string | typescript0.Identifier;
1210
340
  statements: ReadonlyArray<typescript0.Statement>;
@@ -1373,7 +503,7 @@ declare const tsc: {
1373
503
  type
1374
504
  }: {
1375
505
  initializer?: typescript0.Expression;
1376
- modifier?: "async" | AccessLevel | "export" | "readonly" | "static";
506
+ modifier?: Modifier;
1377
507
  name: string | typescript0.PropertyName;
1378
508
  type?: typescript0.TypeNode;
1379
509
  }) => typescript0.PropertyDeclaration;
@@ -1742,10 +872,12 @@ declare const compiler: {
1742
872
  typeParameters?: typescript0.TypeParameterDeclaration[];
1743
873
  }) => typescript0.FunctionTypeNode;
1744
874
  getAccessorDeclaration: ({
875
+ modifiers,
1745
876
  name,
1746
877
  returnType,
1747
878
  statements
1748
879
  }: {
880
+ modifiers?: Modifier | ReadonlyArray<Modifier>;
1749
881
  name: string | typescript0.PropertyName;
1750
882
  returnType?: string | typescript0.Identifier;
1751
883
  statements: ReadonlyArray<typescript0.Statement>;
@@ -1914,7 +1046,7 @@ declare const compiler: {
1914
1046
  type
1915
1047
  }: {
1916
1048
  initializer?: typescript0.Expression;
1917
- modifier?: "async" | AccessLevel | "export" | "readonly" | "static";
1049
+ modifier?: Modifier;
1918
1050
  name: string | typescript0.PropertyName;
1919
1051
  type?: typescript0.TypeNode;
1920
1052
  }) => typescript0.PropertyDeclaration;