feat: allow cache and next properties to pass through to fetch

Author: nlf

lib/index.ts

@@ -23,6 +23,15 @@ export type ApplyDefaults<Defaults, Target> = {
   [K in keyof Target as K extends keyof Defaults ? K : never]: Target[K]
 };
 
+declare global {
+  interface RequestInit {
+    next?: {
+      revalidate?: boolean | number;
+      tags?: string[];
+    };
+  }
+}
+
 export type RouteOptions = {
   headers?: HeadersInit;
   params?: unknown;
@@ -37,6 +46,8 @@ export type DefaultRouteOptions = {
   payload?: never;
   query?: never;
   response?: unknown;
+  cache?: RequestInit["cache"];
+  next?: RequestInit["next"];
 };
 
 export type RouteDefinition = Record<string, RouteOptions>;
@@ -114,7 +125,7 @@ export class Client<T extends RouteTable> {
     }
   }
 
-  async #fetch<O extends RouteOptions = RouteOptions>(method: RequestMethod, path: string, options?: WithoutResponse<O>): Promise<ClientResponse<O["response"]>> {
+  async #fetch<O extends DefaultRouteOptions = DefaultRouteOptions>(method: RequestMethod, path: string, options?: WithoutResponse<O>): Promise<ClientResponse<O["response"]>> {
     const realPath = options && "params" in options
       ? replaceParams(path, options.params as Record<string, string>)
       : path;
@@ -167,6 +178,8 @@ export class Client<T extends RouteTable> {
       method,
       headers,
       body: options && "payload" in options ? JSON.stringify(options.payload) : undefined,
+      cache: options?.cache,
+      next: options?.next,
     });
 
     const isJsonResponse = fetchResponse.headers.get("content-type")?.startsWith("application/json");

test/fetch.ts

@@ -2,17 +2,27 @@ import { test, type TestContext } from "node:test";
 import { server, Client } from "./fixture.ts";
 import type { RouteMap } from "./generated.ts";
 
-await test("GET - fetch", async (t) => {
-  let client: Client;
-  t.before(async () => {
-    await server.start();
-    client = new Client({ url: server.info.uri });
-  });
+await test("fetch()", async (t) => {
+  await server.start();
+  const client = new Client({ url: server.info.uri });
 
   t.after(async () => {
     await server.stop();
   });
 
+  await t.test("flags: allows passing `next` property to fetch", async (t) => {
+    const fetchSpy = t.mock.method(global, "fetch");
+    t.after(() => {
+      fetchSpy.mock.restore();
+    });
+
+    const res = await client.get("/simple", { next: { revalidate: 10 } });
+    t.assert.equal(res.status, 200);
+    t.assert.equal(fetchSpy.mock.callCount(), 1);
+    const firstCall = fetchSpy.mock.calls[0];
+    t.assert.partialDeepStrictEqual(firstCall.arguments, [{ next: { revalidate: 10 } }]);
+  });
+
   await t.test("/simple", async (t: TestContext) => {
     const res = await client.get("/simple");
     t.assert.equal(res.status, 200);