feat(next-drupal): add next revalidate options to resource-methods an…

…d custom fetch
chapter-three · Jun 27, 2024 · 1679890 · 1679890
1 parent f56c243
commit 1679890
Show file tree

Hide file tree

Showing 4 changed files with 393 additions and 10 deletions.
diff --git a/packages/next-drupal/src/next-drupal.ts b/packages/next-drupal/src/next-drupal.ts
@@ -19,6 +19,7 @@ import type {
  JsonApiUpdateResourceBody,
  JsonApiWithAuthOption,
  JsonApiWithCacheOptions,
+ JsonApiWithNextFetchOptions,
  JsonDeserializer,
  Locale,
  NextDrupalOptions,
@@ -248,7 +249,9 @@ export class NextDrupal extends NextDrupalBase {
  async getResource<T extends JsonApiResource>(
  type: string,
  uuid: string,
- options?: JsonApiOptions & JsonApiWithCacheOptions
+ options?: JsonApiOptions &
+ JsonApiWithCacheOptions &
+ JsonApiWithNextFetchOptions
  ): Promise<T> {
  options = {
  deserialize: true,
@@ -257,6 +260,7 @@ export class NextDrupal extends NextDrupalBase {
  params: {},
  ...options,
  }
+ // Not sure about this node-cache
 
  /* c8 ignore next 11 */
  if (options.withCache) {
@@ -283,6 +287,7 @@ export class NextDrupal extends NextDrupalBase {
 
  const response = await this.fetch(endpoint, {
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  await this.throwIfJsonErrors(response, "Error while fetching resource: ")
@@ -301,7 +306,8 @@ export class NextDrupal extends NextDrupalBase {
  path: string,
  options?: {
  isVersionable?: boolean
- } & JsonApiOptions
+ } & JsonApiOptions &
+ JsonApiWithNextFetchOptions
  ): Promise<T> {
  options = {
  deserialize: true,
@@ -370,6 +376,7 @@ export class NextDrupal extends NextDrupalBase {
  redirect: "follow",
  body: JSON.stringify(payload),
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  const errorMessagePrefix = "Error while fetching resource by path:"
@@ -408,7 +415,8 @@ export class NextDrupal extends NextDrupalBase {
  type: string,
  options?: {
  deserialize?: boolean
- } & JsonApiOptions
+ } & JsonApiOptions &
+ JsonApiWithNextFetchOptions
  ): Promise<T> {
  options = {
  withAuth: this.withAuth,
@@ -427,6 +435,7 @@ export class NextDrupal extends NextDrupalBase {
 
  const response = await this.fetch(endpoint, {
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  await this.throwIfJsonErrors(
@@ -445,6 +454,7 @@ export class NextDrupal extends NextDrupalBase {
  pathPrefix?: PathPrefix
  params?: JsonApiParams
  } & JsonApiWithAuthOption &
+ JsonApiWithNextFetchOptions &
  (
  | {
  locales: Locale[]
@@ -490,6 +500,7 @@ export class NextDrupal extends NextDrupalBase {
  let opts: Parameters<NextDrupal["getResourceCollection"]>[1] = {
  params,
  withAuth: options.withAuth,
+ next: options.next,
  }
  if (locale) {
  opts = {
@@ -547,7 +558,7 @@ export class NextDrupal extends NextDrupalBase {
 
  async translatePath(
  path: string,
- options?: JsonApiWithAuthOption
+ options?: JsonApiWithAuthOption & JsonApiWithNextFetchOptions
  ): Promise<DrupalTranslatedPath | null> {
  options = {
  withAuth: this.withAuth,
@@ -562,6 +573,7 @@ export class NextDrupal extends NextDrupalBase {
 
  const response = await this.fetch(endpoint, {
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  if (response.status === 404) {
@@ -575,7 +587,10 @@ export class NextDrupal extends NextDrupalBase {
  return await response.json()
  }
 
- async getIndex(locale?: Locale): Promise<JsonApiResponse> {
+ async getIndex(
+ locale?: Locale,
+ options?: JsonApiWithNextFetchOptions
+ ): Promise<JsonApiResponse> {
  const endpoint = await this.buildEndpoint({
  locale,
  })
@@ -585,6 +600,7 @@ export class NextDrupal extends NextDrupalBase {
  const response = await this.fetch(endpoint, {
  // As per https://www.drupal.org/node/2984034 /jsonapi is public.
  withAuth: false,
+ next: options?.next,
  })
 
  await this.throwIfJsonErrors(
@@ -657,7 +673,9 @@ export class NextDrupal extends NextDrupalBase {
 
  async getMenu<T = DrupalMenuItem>(
  menuName: string,
- options?: JsonApiOptions & JsonApiWithCacheOptions
+ options?: JsonApiOptions &
+ JsonApiWithCacheOptions &
+ JsonApiWithNextFetchOptions
  ): Promise<{
  items: T[]
  tree: T[]
@@ -692,6 +710,7 @@ export class NextDrupal extends NextDrupalBase {
 
  const response = await this.fetch(endpoint, {
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  await this.throwIfJsonErrors(response, "Error while fetching menu items: ")
@@ -719,7 +738,7 @@ export class NextDrupal extends NextDrupalBase {
 
  async getView<T = JsonApiResource>(
  name: string,
- options?: JsonApiOptions
+ options?: JsonApiOptions & JsonApiWithNextFetchOptions
  ): Promise<DrupalView<T>> {
  options = {
  withAuth: this.withAuth,
@@ -741,6 +760,7 @@ export class NextDrupal extends NextDrupalBase {
 
  const response = await this.fetch(endpoint, {
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  await this.throwIfJsonErrors(response, "Error while fetching view: ")
@@ -759,7 +779,7 @@ export class NextDrupal extends NextDrupalBase {
 
  async getSearchIndex<T = JsonApiResource[]>(
  name: string,
- options?: JsonApiOptions
+ options?: JsonApiOptions & JsonApiWithNextFetchOptions
  ): Promise<T> {
  options = {
  withAuth: this.withAuth,
@@ -778,6 +798,7 @@ export class NextDrupal extends NextDrupalBase {
 
  const response = await this.fetch(endpoint, {
  withAuth: options.withAuth,
+ next: options.next,
  })
 
  await this.throwIfJsonErrors(

diff --git a/packages/next-drupal/src/types/options.ts b/packages/next-drupal/src/types/options.ts
@@ -6,7 +6,7 @@ export type Locale = string
 
 export type PathPrefix = string
 
-export interface FetchOptions extends RequestInit {
+export interface FetchOptions extends RequestInit, JsonApiWithNextFetchOptions {
  withAuth?: boolean | NextDrupalAuth
 }
 
@@ -34,6 +34,9 @@ export type JsonApiWithCacheOptions = {
  cacheKey?: string
 }
 
+export type JsonApiWithNextFetchOptions = {
+ next?: NextFetchRequestConfig
+}
 // TODO: Properly type this.
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export type JsonApiParams = Record<string, any>