add custom properties to request object (#1653)

* add custom properties to request object

* fix typing for accept custom properties

* added unit test

* add changeset

* fix unused types

Author: FreeAoi

.changeset/red-pants-cover.md

@@ -0,0 +1,5 @@
+---
+"openapi-fetch": patch
+---
+
+Let request object have custom properties

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

@@ -166,7 +166,7 @@ export type ClientMethod<Paths extends Record<string, PathMethods>, M extends Ht
   I extends MaybeOptionalInit<Paths[P], M>,
 >(
   url: P,
-  ...init: HasRequiredKeys<I> extends never ? [I?] : [I]
+  ...init: HasRequiredKeys<I> extends never ? [(I & { [key: string]: unknown })?] : [I]
 ) => Promise<FetchResponse<Paths[P][M], I, Media>>;
 
 export default function createClient<Paths extends {}, Media extends MediaType = MediaType>(

packages/openapi-fetch/src/index.js

@@ -5,6 +5,22 @@ const DEFAULT_HEADERS = {
 
 const PATH_PARAM_RE = /\{[^{}]+\}/g;
 
+/**
+ * Add custom parameters to Request object
+ */
+class CustomRequest extends Request {
+  constructor(input, init) {
+    super(input, init);
+
+    // add custom parameters
+    for (const key in init) {
+      if (!this[key]) {
+        this[key] = init[key];
+      }
+    }
+  }
+}
+
 /**
  * Create an openapi-fetch client.
  * @type {import("./index.js").default}
@@ -67,7 +83,7 @@ export default function createClient(clientOptions) {
     if (requestInit.body instanceof FormData) {
       requestInit.headers.delete("Content-Type");
     }
-    let request = new Request(createFinalURL(url, { baseUrl, params, querySerializer }), requestInit);
+    let request = new CustomRequest(createFinalURL(url, { baseUrl, params, querySerializer }), requestInit);
     // middleware (request)
     const mergedOptions = {
       baseUrl,

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

@@ -854,6 +854,29 @@ describe("client", () => {
         expect(req.headers.get("foo")).toBe("bar");
       });
 
+      it("can attach custom properties to request", async () => {
+        function createCustomFetch(data: any) {
+          const response = {
+            clone: () => ({ ...response }),
+            headers: new Headers(),
+            json: async () => data,
+            status: 200,
+            ok: true,
+          } as Response;
+          return async (input: Request) => {
+            expect(input).toHaveProperty("customProperty", "value");
+            return Promise.resolve(response);
+          };
+        }
+
+        const customFetch = createCustomFetch({});
+        const client = createClient<paths>({ fetch: customFetch, baseUrl });
+
+        client.GET("/self", {
+          customProperty: "value",
+        });
+      });
+
       it("can modify response", async () => {
         const toUnix = (date: string) => new Date(date).getTime();