Improve middleware type definition (#1918)

* Improve middleware type definition

* Add type test for middleware

* Add changeset

Author: yicrotkd

.changeset/short-lizards-rescue.md

@@ -0,0 +1,5 @@
+---
+"openapi-fetch": patch
+---
+
+Improve `Middleware` type definition to require either onRequest or onResponse

packages/openapi-fetch/src/index.d.ts

@@ -146,12 +146,22 @@ export interface MiddlewareCallbackParams {
   readonly options: MergedOptions;
 }
 
-export interface Middleware {
-  onRequest?: (options: MiddlewareCallbackParams) => void | Request | undefined | Promise<Request | undefined | void>;
-  onResponse?: (
-    options: MiddlewareCallbackParams & { response: Response },
-  ) => void | Response | undefined | Promise<Response | undefined | void>;
-}
+type MiddlewareOnRequest = (
+  options: MiddlewareCallbackParams,
+) => void | Request | undefined | Promise<Request | undefined | void>;
+type MiddlewareOnResponse = (
+  options: MiddlewareCallbackParams & { response: Response },
+) => void | Response | undefined | Promise<Response | undefined | void>;
+
+export type Middleware =
+  | {
+      onRequest: MiddlewareOnRequest;
+      onResponse?: MiddlewareOnResponse;
+    }
+  | {
+      onRequest?: MiddlewareOnRequest;
+      onResponse: MiddlewareOnResponse;
+    };
 
 /** This type helper makes the 2nd function param required if params/requestBody are required; otherwise, optional */
 export type MaybeOptionalInit<Params, Location extends keyof Params> = RequiredKeysOf<

packages/openapi-fetch/test/middleware/middleware.test.ts

@@ -1,4 +1,4 @@
-import { expect, test } from "vitest";
+import { expect, test, expectTypeOf, assertType } from "vitest";
 import { createObservedClient } from "../helpers.js";
 import type { Middleware, MiddlewareCallbackParams } from "../../src/index.js";
 import type { paths } from "./schemas/middleware.js";
@@ -354,3 +354,12 @@ test("auth header", async () => {
   });
   expect(headers.get("authorization")).toBe(`Bearer ${accessToken}`);
 });
+
+test("type error occurs only when neither onRequest nor onResponse is specified", async () => {
+  expectTypeOf<Middleware>().not.toEqualTypeOf({});
+  const onRequest = async ({ request }: MiddlewareCallbackParams) => request;
+  const onResponse = async ({ response }: MiddlewareCallbackParams & { response: Response }) => response;
+  assertType<Middleware>({ onRequest });
+  assertType<Middleware>({ onResponse });
+  assertType<Middleware>({ onRequest, onResponse });
+});