@hey-api/openapi-ts 0.81.0 → 0.82.0

package/dist/clients/angular/client.ts

@@ -15,6 +15,7 @@ import { firstValueFrom } from 'rxjs';
 import { filter } from 'rxjs/operators';
 
 import { createSseClient } from '../core/serverSentEvents';
+import type { HttpMethod } from '../core/types';
 import type {
   Client,
   Config,
@@ -198,9 +199,12 @@ export const createClient = (config: Config = {}): Client => {
     }
   };
 
-  const makeMethod = (method: Required<Config>['method']) => {
-    const fn = (options: RequestOptions) => request({ ...options, method });
-    fn.sse = async (options: RequestOptions) => {
+  const makeMethodFn =
+    (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
+      request({ ...options, method });
+
+  const makeSseFn =
+    (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
       const { opts, url } = await beforeRequest(options);
       return createSseClient({
         ...opts,
@@ -210,21 +214,19 @@ export const createClient = (config: Config = {}): Client => {
         url,
       });
     };
-    return fn;
-  };
 
   return {
     buildUrl,
-    connect: makeMethod('CONNECT'),
-    delete: makeMethod('DELETE'),
-    get: makeMethod('GET'),
+    connect: makeMethodFn('CONNECT'),
+    delete: makeMethodFn('DELETE'),
+    get: makeMethodFn('GET'),
     getConfig,
-    head: makeMethod('HEAD'),
+    head: makeMethodFn('HEAD'),
     interceptors,
-    options: makeMethod('OPTIONS'),
-    patch: makeMethod('PATCH'),
-    post: makeMethod('POST'),
-    put: makeMethod('PUT'),
+    options: makeMethodFn('OPTIONS'),
+    patch: makeMethodFn('PATCH'),
+    post: makeMethodFn('POST'),
+    put: makeMethodFn('PUT'),
     request,
     requestOptions: (options) => {
       if (options.security) {
@@ -240,6 +242,17 @@ export const createClient = (config: Config = {}): Client => {
       return requestOptions(options).req;
     },
     setConfig,
-    trace: makeMethod('TRACE'),
+    sse: {
+      connect: makeSseFn('CONNECT'),
+      delete: makeSseFn('DELETE'),
+      get: makeSseFn('GET'),
+      head: makeSseFn('HEAD'),
+      options: makeSseFn('OPTIONS'),
+      patch: makeSseFn('PATCH'),
+      post: makeSseFn('POST'),
+      put: makeSseFn('PUT'),
+      trace: makeSseFn('TRACE'),
+    },
+    trace: makeMethodFn('TRACE'),
   } as Client;
 };

package/dist/clients/angular/types.ts

@@ -155,7 +155,7 @@ export interface ClientOptions {
   throwOnError?: boolean;
 }
 
-type MethodFnBase = <
+type MethodFn = <
   TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
@@ -164,7 +164,7 @@ type MethodFnBase = <
   options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>,
 ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
 
-type MethodFnServerSentEvents = <
+type SseFn = <
   TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
@@ -173,10 +173,6 @@ type MethodFnServerSentEvents = <
   options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>,
 ) => Promise<ServerSentEventsResult<TData, TError>>;
 
-type MethodFn = MethodFnBase & {
-  sse: MethodFnServerSentEvents;
-};
-
 type RequestFn = <
   TData = unknown,
   TError = unknown,
@@ -208,7 +204,13 @@ type BuildUrlFn = <
   options: Pick<TData, 'url'> & Options<TData>,
 ) => string;
 
-export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn> & {
+export type Client = CoreClient<
+  RequestFn,
+  Config,
+  MethodFn,
+  BuildUrlFn,
+  SseFn
+> & {
   interceptors: Middleware<
     HttpRequest<unknown>,
     HttpResponse<unknown>,

package/dist/clients/axios/client.ts

@@ -2,6 +2,7 @@ import type { AxiosError, AxiosInstance, RawAxiosRequestHeaders } from 'axios';
 import axios from 'axios';
 
 import { createSseClient } from '../core/serverSentEvents';
+import type { HttpMethod } from '../core/types';
 import type { Client, Config, RequestOptions } from './types';
 import {
   buildUrl,
@@ -111,9 +112,12 @@ export const createClient = (config: Config = {}): Client => {
     }
   };
 
-  const makeMethod = (method: Required<Config>['method']) => {
-    const fn = (options: RequestOptions) => request({ ...options, method });
-    fn.sse = async (options: RequestOptions) => {
+  const makeMethodFn =
+    (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
+      request({ ...options, method });
+
+  const makeSseFn =
+    (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
       const { opts, url } = await beforeRequest(options);
       return createSseClient({
         ...opts,
@@ -125,23 +129,32 @@ export const createClient = (config: Config = {}): Client => {
         url,
       });
     };
-    return fn;
-  };
 
   return {
     buildUrl,
-    connect: makeMethod('CONNECT'),
-    delete: makeMethod('DELETE'),
-    get: makeMethod('GET'),
+    connect: makeMethodFn('CONNECT'),
+    delete: makeMethodFn('DELETE'),
+    get: makeMethodFn('GET'),
     getConfig,
-    head: makeMethod('HEAD'),
+    head: makeMethodFn('HEAD'),
     instance,
-    options: makeMethod('OPTIONS'),
-    patch: makeMethod('PATCH'),
-    post: makeMethod('POST'),
-    put: makeMethod('PUT'),
+    options: makeMethodFn('OPTIONS'),
+    patch: makeMethodFn('PATCH'),
+    post: makeMethodFn('POST'),
+    put: makeMethodFn('PUT'),
     request,
     setConfig,
-    trace: makeMethod('TRACE'),
+    sse: {
+      connect: makeSseFn('CONNECT'),
+      delete: makeSseFn('DELETE'),
+      get: makeSseFn('GET'),
+      head: makeSseFn('HEAD'),
+      options: makeSseFn('OPTIONS'),
+      patch: makeSseFn('PATCH'),
+      post: makeSseFn('POST'),
+      put: makeSseFn('PUT'),
+      trace: makeSseFn('TRACE'),
+    },
+    trace: makeMethodFn('TRACE'),
   } as Client;
 };

package/dist/clients/axios/types.ts

@@ -116,7 +116,7 @@ export type RequestResult<
         })
     >;
 
-type MethodFnBase = <
+type MethodFn = <
   TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
@@ -124,7 +124,7 @@ type MethodFnBase = <
   options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>,
 ) => RequestResult<TData, TError, ThrowOnError>;
 
-type MethodFnServerSentEvents = <
+type SseFn = <
   TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
@@ -132,10 +132,6 @@ type MethodFnServerSentEvents = <
   options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>,
 ) => Promise<ServerSentEventsResult<TData, TError>>;
 
-type MethodFn = MethodFnBase & {
-  sse: MethodFnServerSentEvents;
-};
-
 type RequestFn = <
   TData = unknown,
   TError = unknown,
@@ -156,7 +152,13 @@ type BuildUrlFn = <
   options: Pick<TData, 'url'> & Omit<Options<TData>, 'axios'>,
 ) => string;
 
-export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn> & {
+export type Client = CoreClient<
+  RequestFn,
+  Config,
+  MethodFn,
+  BuildUrlFn,
+  SseFn
+> & {
   instance: AxiosInstance;
 };
 

package/dist/clients/core/serverSentEvents.ts

@@ -5,6 +5,17 @@ export type ServerSentEventsOptions<TData = unknown> = Omit<
   'method'
 > &
   Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & {
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Implementing clients can call request interceptors inside this hook.
+     */
+    onRequest?: (url: string, init: RequestInit) => Promise<Request>;
     /**
      * Callback invoked when a network or parsing error occurs during streaming.
      *
@@ -22,6 +33,7 @@ export type ServerSentEventsOptions<TData = unknown> = Omit<
      * @returns Nothing (void).
      */
     onSseEvent?: (event: StreamEvent<TData>) => void;
+    serializedBody?: RequestInit['body'];
     /**
      * Default retry delay in milliseconds.
      *
@@ -73,6 +85,7 @@ export type ServerSentEventsResult<
 };
 
 export const createSseClient = <TData = unknown>({
+  onRequest,
   onSseError,
   onSseEvent,
   responseTransformer,
@@ -110,7 +123,21 @@ export const createSseClient = <TData = unknown>({
       }
 
       try {
-        const response = await fetch(url, { ...options, headers, signal });
+        const requestInit: RequestInit = {
+          redirect: 'follow',
+          ...options,
+          body: options.serializedBody,
+          headers,
+          signal,
+        };
+        let request = new Request(url, requestInit);
+        if (onRequest) {
+          request = await onRequest(url, requestInit);
+        }
+        // fetch must be assigned here, otherwise it would throw the error:
+        // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+        const _fetch = options.fetch ?? globalThis.fetch;
+        const response = await _fetch(request);
 
         if (!response.ok)
           throw new Error(

package/dist/clients/core/types.ts

@@ -5,29 +5,36 @@ import type {
   QuerySerializerOptions,
 } from './bodySerializer';
 
-export interface Client<
+export type HttpMethod =
+  | 'connect'
+  | 'delete'
+  | 'get'
+  | 'head'
+  | 'options'
+  | 'patch'
+  | 'post'
+  | 'put'
+  | 'trace';
+
+export type Client<
   RequestFn = never,
   Config = unknown,
   MethodFn = never,
   BuildUrlFn = never,
-> {
+  SseFn = never,
+> = {
   /**
    * Returns the final request URL.
    */
   buildUrl: BuildUrlFn;
-  connect: MethodFn;
-  delete: MethodFn;
-  get: MethodFn;
   getConfig: () => Config;
-  head: MethodFn;
-  options: MethodFn;
-  patch: MethodFn;
-  post: MethodFn;
-  put: MethodFn;
   request: RequestFn;
   setConfig: (config: Config) => Config;
-  trace: MethodFn;
-}
+} & {
+  [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never]
+    ? { sse?: never }
+    : { sse: { [K in HttpMethod]: SseFn } });
 
 export interface Config {
   /**
@@ -63,16 +70,7 @@ export interface Config {
    *
    * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
    */
-  method?:
-    | 'CONNECT'
-    | 'DELETE'
-    | 'GET'
-    | 'HEAD'
-    | 'OPTIONS'
-    | 'PATCH'
-    | 'POST'
-    | 'PUT'
-    | 'TRACE';
+  method?: Uppercase<HttpMethod>;
   /**
    * A function for serializing request query parameters. By default, arrays
    * will be exploded in form style, objects will be exploded in deepObject

package/dist/clients/fetch/client.ts

@@ -1,4 +1,5 @@
 import { createSseClient } from '../core/serverSentEvents';
+import type { HttpMethod } from '../core/types';
 import type {
   Client,
   Config,
@@ -105,23 +106,41 @@ export const createClient = (config: Config = {}): Client => {
     };
 
     if (response.ok) {
+      const parseAs =
+        (opts.parseAs === 'auto'
+          ? getParseAs(response.headers.get('Content-Type'))
+          : opts.parseAs) ?? 'json';
+
       if (
         response.status === 204 ||
         response.headers.get('Content-Length') === '0'
       ) {
+        let emptyData: any;
+        switch (parseAs) {
+          case 'arrayBuffer':
+          case 'blob':
+          case 'text':
+            emptyData = await response[parseAs]();
+            break;
+          case 'formData':
+            emptyData = new FormData();
+            break;
+          case 'stream':
+            emptyData = response.body;
+            break;
+          case 'json':
+          default:
+            emptyData = {};
+            break;
+        }
         return opts.responseStyle === 'data'
-          ? {}
+          ? emptyData
           : {
-              data: {},
+              data: emptyData,
               ...result,
             };
       }
 
-      const parseAs =
-        (opts.parseAs === 'auto'
-          ? getParseAs(response.headers.get('Content-Type'))
-          : opts.parseAs) ?? 'json';
-
       let data: any;
       switch (parseAs) {
         case 'arrayBuffer':
@@ -191,35 +210,56 @@ export const createClient = (config: Config = {}): Client => {
         };
   };
 
-  const makeMethod = (method: Required<Config>['method']) => {
-    const fn = (options: RequestOptions) => request({ ...options, method });
-    fn.sse = async (options: RequestOptions) => {
+  const makeMethodFn =
+    (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
+      request({ ...options, method });
+
+  const makeSseFn =
+    (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
       const { opts, url } = await beforeRequest(options);
       return createSseClient({
         ...opts,
         body: opts.body as BodyInit | null | undefined,
         headers: opts.headers as unknown as Record<string, string>,
         method,
+        onRequest: async (url, init) => {
+          let request = new Request(url, init);
+          for (const fn of interceptors.request._fns) {
+            if (fn) {
+              request = await fn(request, opts);
+            }
+          }
+          return request;
+        },
         url,
       });
     };
-    return fn;
-  };
 
   return {
     buildUrl,
-    connect: makeMethod('CONNECT'),
-    delete: makeMethod('DELETE'),
-    get: makeMethod('GET'),
+    connect: makeMethodFn('CONNECT'),
+    delete: makeMethodFn('DELETE'),
+    get: makeMethodFn('GET'),
     getConfig,
-    head: makeMethod('HEAD'),
+    head: makeMethodFn('HEAD'),
     interceptors,
-    options: makeMethod('OPTIONS'),
-    patch: makeMethod('PATCH'),
-    post: makeMethod('POST'),
-    put: makeMethod('PUT'),
+    options: makeMethodFn('OPTIONS'),
+    patch: makeMethodFn('PATCH'),
+    post: makeMethodFn('POST'),
+    put: makeMethodFn('PUT'),
     request,
     setConfig,
-    trace: makeMethod('TRACE'),
+    sse: {
+      connect: makeSseFn('CONNECT'),
+      delete: makeSseFn('DELETE'),
+      get: makeSseFn('GET'),
+      head: makeSseFn('HEAD'),
+      options: makeSseFn('OPTIONS'),
+      patch: makeSseFn('PATCH'),
+      post: makeSseFn('POST'),
+      put: makeSseFn('PUT'),
+      trace: makeSseFn('TRACE'),
+    },
+    trace: makeMethodFn('TRACE'),
   } as Client;
 };

package/dist/clients/fetch/types.ts

@@ -24,7 +24,7 @@ export interface Config<T extends ClientOptions = ClientOptions>
    *
    * @default globalThis.fetch
    */
-  fetch?: (request: Request) => ReturnType<typeof fetch>;
+  fetch?: typeof fetch;
   /**
    * Please don't use the Fetch client for Next.js applications. The `next`
    * options won't have any effect.
@@ -153,7 +153,7 @@ export interface ClientOptions {
   throwOnError?: boolean;
 }
 
-type MethodFnBase = <
+type MethodFn = <
   TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
@@ -162,7 +162,7 @@ type MethodFnBase = <
   options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>,
 ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
 
-type MethodFnServerSentEvents = <
+type SseFn = <
   TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
@@ -171,10 +171,6 @@ type MethodFnServerSentEvents = <
   options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>,
 ) => Promise<ServerSentEventsResult<TData, TError>>;
 
-type MethodFn = MethodFnBase & {
-  sse: MethodFnServerSentEvents;
-};
-
 type RequestFn = <
   TData = unknown,
   TError = unknown,
@@ -199,7 +195,13 @@ type BuildUrlFn = <
   options: Pick<TData, 'url'> & Options<TData>,
 ) => string;
 
-export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn> & {
+export type Client = CoreClient<
+  RequestFn,
+  Config,
+  MethodFn,
+  BuildUrlFn,
+  SseFn
+> & {
   interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
 };
 

package/dist/clients/next/client.ts

@@ -1,4 +1,5 @@
 import { createSseClient } from '../core/serverSentEvents';
+import type { HttpMethod } from '../core/types';
 import type {
   Client,
   Config,
@@ -100,21 +101,39 @@ export const createClient = (config: Config = {}): Client => {
     };
 
     if (response.ok) {
+      const parseAs =
+        (opts.parseAs === 'auto'
+          ? getParseAs(response.headers.get('Content-Type'))
+          : opts.parseAs) ?? 'json';
+
       if (
         response.status === 204 ||
         response.headers.get('Content-Length') === '0'
       ) {
+        let emptyData: any;
+        switch (parseAs) {
+          case 'arrayBuffer':
+          case 'blob':
+          case 'text':
+            emptyData = await response[parseAs]();
+            break;
+          case 'formData':
+            emptyData = new FormData();
+            break;
+          case 'stream':
+            emptyData = response.body;
+            break;
+          case 'json':
+          default:
+            emptyData = {};
+            break;
+        }
         return {
-          data: {},
+          data: emptyData,
           ...result,
         };
       }
 
-      const parseAs =
-        (opts.parseAs === 'auto'
-          ? getParseAs(response.headers.get('Content-Type'))
-          : opts.parseAs) ?? 'json';
-
       let data: any;
       switch (parseAs) {
         case 'arrayBuffer':
@@ -177,35 +196,62 @@ export const createClient = (config: Config = {}): Client => {
     };
   };
 
-  const makeMethod = (method: Required<Config>['method']) => {
-    const fn = (options: RequestOptions) => request({ ...options, method });
-    fn.sse = async (options: RequestOptions) => {
+  const makeMethodFn =
+    (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
+      request({ ...options, method });
+
+  const makeSseFn =
+    (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
       const { opts, url } = await beforeRequest(options);
       return createSseClient({
         ...opts,
         body: opts.body as BodyInit | null | undefined,
         headers: opts.headers as unknown as Record<string, string>,
         method,
+        onRequest: async (url, init) => {
+          let request = new Request(url, init);
+          const requestInit = {
+            ...init,
+            method: init.method as Config['method'],
+            url,
+          };
+          for (const fn of interceptors.request._fns) {
+            if (fn) {
+              await fn(requestInit);
+              request = new Request(requestInit.url, requestInit);
+            }
+          }
+          return request;
+        },
         url,
       });
     };
-    return fn;
-  };
 
   return {
     buildUrl,
-    connect: makeMethod('CONNECT'),
-    delete: makeMethod('DELETE'),
-    get: makeMethod('GET'),
+    connect: makeMethodFn('CONNECT'),
+    delete: makeMethodFn('DELETE'),
+    get: makeMethodFn('GET'),
     getConfig,
-    head: makeMethod('HEAD'),
+    head: makeMethodFn('HEAD'),
     interceptors,
-    options: makeMethod('OPTIONS'),
-    patch: makeMethod('PATCH'),
-    post: makeMethod('POST'),
-    put: makeMethod('PUT'),
+    options: makeMethodFn('OPTIONS'),
+    patch: makeMethodFn('PATCH'),
+    post: makeMethodFn('POST'),
+    put: makeMethodFn('PUT'),
     request,
     setConfig,
-    trace: makeMethod('TRACE'),
+    sse: {
+      connect: makeSseFn('CONNECT'),
+      delete: makeSseFn('DELETE'),
+      get: makeSseFn('GET'),
+      head: makeSseFn('HEAD'),
+      options: makeSseFn('OPTIONS'),
+      patch: makeSseFn('PATCH'),
+      post: makeSseFn('POST'),
+      put: makeSseFn('PUT'),
+      trace: makeSseFn('TRACE'),
+    },
+    trace: makeMethodFn('TRACE'),
   } as Client;
 };