Add cache option to fetch

Fixes #809

Add support for the `cache` option in the Next Drupal client.

* Add `cache` option to `JsonApiWithNextFetchOptions` type in `packages/next-drupal/src/types/options.ts`.
* Update `fetch` method in `packages/next-drupal/src/next-drupal.ts` to pass the `cache` option as part of the `init` object if provided.
* Add tests for the `cache` option in `fetch` and `getResource` methods in `packages/next-drupal/tests/NextDrupalBase/fetch-methods.test.ts` and `packages/next-drupal/tests/NextDrupal/resource-methods.test.ts`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/chapter-three/next-drupal/issues/809?shareId=XXXX-XXXX-XXXX-XXXX).

Author: backlineint

packages/next-drupal/src/next-drupal.ts

@@ -115,6 +115,7 @@ export class NextDrupal extends NextDrupalBase {
       method: "POST",
       body: JSON.stringify(body),
       withAuth: options.withAuth,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(response, "Error while creating resource: ")
@@ -158,6 +159,7 @@ export class NextDrupal extends NextDrupalBase {
       },
       body: body.data.attributes.file,
       withAuth: options.withAuth,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(
@@ -202,6 +204,7 @@ export class NextDrupal extends NextDrupalBase {
       method: "PATCH",
       body: JSON.stringify(body),
       withAuth: options.withAuth,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(response, "Error while updating resource: ")
@@ -239,6 +242,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       method: "DELETE",
       withAuth: options.withAuth,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(response, "Error while deleting resource: ")
@@ -287,6 +291,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(response, "Error while fetching resource: ")
@@ -376,6 +381,7 @@ export class NextDrupal extends NextDrupalBase {
       body: JSON.stringify(payload),
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     const errorMessagePrefix = "Error while fetching resource by path:"
@@ -435,6 +441,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(
@@ -500,6 +507,7 @@ export class NextDrupal extends NextDrupalBase {
               params,
               withAuth: options.withAuth,
               next: options.next,
+              cache: options.cache,
             }
             if (locale) {
               opts = {
@@ -573,6 +581,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     if (response.status === 404) {
@@ -600,6 +609,7 @@ export class NextDrupal extends NextDrupalBase {
       // As per https://www.drupal.org/node/2984034 /jsonapi is public.
       withAuth: false,
       next: options?.next,
+      cache: options?.cache,
     })
 
     await this.throwIfJsonErrors(
@@ -710,6 +720,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(response, "Error while fetching menu items: ")
@@ -760,6 +771,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(response, "Error while fetching view: ")
@@ -798,6 +810,7 @@ export class NextDrupal extends NextDrupalBase {
     const response = await this.fetch(endpoint, {
       withAuth: options.withAuth,
       next: options.next,
+      cache: options.cache,
     })
 
     await this.throwIfJsonErrors(

packages/next-drupal/src/types/options.ts

@@ -36,6 +36,7 @@ export type JsonApiWithCacheOptions = {
 
 export type JsonApiWithNextFetchOptions = {
   next?: NextFetchRequestConfig
+  cache?: RequestCache
 }
 // TODO: Properly type this.
 /* eslint-disable  @typescript-eslint/no-explicit-any */

packages/next-drupal/tests/NextDrupal/resource-methods.test.ts

@@ -512,6 +512,29 @@ describe("getResource()", () => {
       })
     )
   })
+
+  test("makes request with cache option", async () => {
+    const drupal = new NextDrupal(BASE_URL)
+    const mockInit = {
+      cache: "no-store",
+    } as FetchOptions
+
+    const fetchSpy = spyOnFetch()
+
+    await drupal.getResource(
+      "node--recipe",
+      "71e04ead-4cc7-416c-b9ca-60b635fdc50f",
+      mockInit
+    )
+
+    expect(fetchSpy).toBeCalledTimes(1)
+    expect(fetchSpy).toBeCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        ...mockInit,
+      })
+    )
+  })
 })
 
 describe("getResourceByPath()", () => {

packages/next-drupal/tests/NextDrupalBase/fetch-methods.test.ts

@@ -200,6 +200,27 @@ describe("fetch()", () => {
       })
     )
   })
+
+  test("optionally adds cache option", async () => {
+    const drupal = new NextDrupalBase(BASE_URL)
+    const mockUrl = "/mock-url"
+    const mockInit = {
+      cache: "no-store",
+    } as FetchOptions
+
+    const fetchSpy = spyOnFetch()
+
+    await drupal.fetch(mockUrl, mockInit)
+
+    expect(fetchSpy).toBeCalledTimes(1)
+    expect(fetchSpy).toBeCalledWith(
+      `${BASE_URL}${mockUrl}`,
+      expect.objectContaining({
+        ...defaultInit,
+        ...mockInit,
+      })
+    )
+  })
 })
 
 describe("getAccessToken()", () => {