Merge pull request #2513 from hey-api/refactor/client-sse

fix(client): move sse functions into their own namespace

Author: mrlubos

.changeset/grumpy-queens-own.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(client): move sse functions into their own namespace

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/body-response-text-plain/client/client.gen.ts

@@ -1,6 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createSseClient } from '../core/serverSentEvents.gen';
+import type { HttpMethod } from '../core/types.gen';
 import type {
   Client,
   Config,
@@ -193,9 +194,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,
@@ -205,23 +209,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'),
     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;
 };

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/body-response-text-plain/client/types.gen.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,
@@ -201,7 +197,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>;
 };
 

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/body-response-text-plain/core/types.gen.ts

@@ -7,29 +7,36 @@ import type {
   QuerySerializerOptions,
 } from './bodySerializer.gen';
 
-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 {
   /**
@@ -65,16 +72,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

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/form-data/client/client.gen.ts

@@ -1,6 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createSseClient } from '../core/serverSentEvents.gen';
+import type { HttpMethod } from '../core/types.gen';
 import type {
   Client,
   Config,
@@ -193,9 +194,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,
@@ -205,23 +209,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'),
     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;
 };

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/form-data/client/types.gen.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,
@@ -201,7 +197,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>;
 };
 

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/form-data/core/types.gen.ts

@@ -7,29 +7,36 @@ import type {
   QuerySerializerOptions,
 } from './bodySerializer.gen';
 
-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 {
   /**
@@ -65,16 +72,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