feat(openapi-fetch): add support for arbitrary method (#2063)

Author: kerwanp

.changeset/hot-pants-sit.md

@@ -0,0 +1,5 @@
+---
+"openapi-fetch": patch
+---
+
+add support for arbitrary method

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

@@ -199,13 +199,24 @@ export type ClientMethod<
   ...init: InitParam<Init>
 ) => Promise<FetchResponse<Paths[Path][Method], Init, Media>>;
 
+export type ClientRequestMethod<Paths extends Record<string, Record<HttpMethod, {}>>, Media extends MediaType> = <
+  Method extends HttpMethod,
+  Path extends PathsWithMethod<Paths, Method>,
+  Init extends MaybeOptionalInit<Paths[Path], Method>,
+>(
+  method: Method,
+  url: Path,
+  ...init: InitParam<Init>
+) => Promise<FetchResponse<Paths[Path][Method], Init, Media>>;
+
 export type ClientForPath<PathInfo extends Record<string | number, any>, Media extends MediaType> = {
   [Method in keyof PathInfo as Uppercase<string & Method>]: <Init extends MaybeOptionalInit<PathInfo, Method>>(
     ...init: InitParam<Init>
   ) => Promise<FetchResponse<PathInfo[Method], Init, Media>>;
 };
 
 export interface Client<Paths extends {}, Media extends MediaType = MediaType> {
+  request: ClientRequestMethod<Paths, Media>;
   /** Call a GET endpoint */
   GET: ClientMethod<Paths, "get", Media>;
   /** Call a PUT endpoint */

packages/openapi-fetch/src/index.js

@@ -227,6 +227,9 @@ export default function createClient(clientOptions) {
   }
 
   return {
+    request(method, url, init) {
+      return coreFetch(url, { ...init, method: method.toUpperCase() });
+    },
     /** Call a GET endpoint */
     GET(url, init) {
       return coreFetch(url, { ...init, method: "GET" });

packages/openapi-fetch/test/http-methods/request.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, test } from "vitest";
+import { createObservedClient } from "../helpers.js";
+import type { paths as get_paths } from "./schemas/get.js";
+import type { paths as post_paths } from "./schemas/post.js";
+
+describe("request", () => {
+  test("sends correct method", async () => {
+    let method = "";
+    const client = createObservedClient<get_paths>({}, async (req) => {
+      method = req.method;
+      return Response.json({});
+    });
+
+    await client.request("get", "/posts");
+    expect(method).toBe("GET");
+  });
+
+  test("sends correct method with params", async () => {
+    let method = "";
+    const client = createObservedClient<post_paths>({}, async (req) => {
+      method = req.method;
+      return Response.json({});
+    });
+
+    await client.request("post", "/posts", {
+      body: { title: "My Post", body: "Post body", publish_date: new Date("2024-06-06T12:00:00Z").getTime() },
+    });
+
+    expect(method).toBe("POST");
+  });
+});