feat(next-drupal): add new method to support App Router's generateStaticParams()

The App Router's new generateStaticParams() replaces Pages Router's
getStaticProps(). The new getResourceCollectionPathSegments() method supports
generateStaticParams() by returning a list of path segments. This new method
replaces the old getStaticPathsFromContext() method.

Fixes #665

Author: JohnAlbin

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

@@ -12,14 +12,17 @@ import type {
   JsonApiCreateFileResourceBody,
   JsonApiCreateResourceBody,
   JsonApiOptions,
+  JsonApiParams,
   JsonApiResource,
+  JsonApiResourceWithPath,
   JsonApiResponse,
   JsonApiUpdateResourceBody,
   JsonApiWithAuthOption,
   JsonApiWithCacheOptions,
   JsonDeserializer,
   Locale,
   NextDrupalOptions,
+  PathPrefix,
 } from "./types"
 
 const DEFAULT_API_PREFIX = "/jsonapi"
@@ -426,6 +429,112 @@ export class NextDrupal extends NextDrupalBase {
     return options.deserialize ? this.deserialize(json) : json
   }
 
+  async getResourceCollectionPathSegments(
+    types: string | string[],
+    options?: {
+      pathPrefix?: PathPrefix
+      params?: JsonApiParams
+    } & JsonApiWithAuthOption &
+      (
+        | {
+            locales: Locale[]
+            defaultLocale: Locale
+          }
+        | {
+            locales?: undefined
+            defaultLocale?: never
+          }
+      )
+  ): Promise<
+    {
+      path: string
+      type: string
+      locale: Locale
+      segments: string[]
+    }[]
+  > {
+    options = {
+      withAuth: this.withAuth,
+      pathPrefix: "",
+      params: {},
+      ...options,
+    }
+
+    if (typeof types === "string") {
+      types = [types]
+    }
+
+    const paths = await Promise.all(
+      types.map(async (type) => {
+        // Use sparse fieldset to expand max size.
+        // Note we don't need status filter here since this runs non-authenticated (by default).
+        const params = {
+          [`fields[${type}]`]: "path",
+          ...options?.params,
+        }
+
+        const locales = options?.locales?.length ? options.locales : [undefined]
+
+        return Promise.all(
+          locales.map(async (locale) => {
+            let opts: Parameters<NextDrupal["getResourceCollection"]>[1] = {
+              params,
+              withAuth: options.withAuth,
+            }
+            if (locale) {
+              opts = {
+                ...opts,
+                deserialize: true,
+                locale,
+                defaultLocale: options.defaultLocale,
+              }
+            }
+            const resources = await this.getResourceCollection<
+              JsonApiResourceWithPath[]
+            >(type, opts)
+
+            return (
+              resources
+                .map((resource) => {
+                  return resource?.path?.alias === this.frontPage
+                    ? /* c8 ignore next */ "/"
+                    : resource?.path?.alias
+                })
+                // Remove results with no path aliases.
+                .filter(Boolean)
+                .map((path) => {
+                  let segmentPath = path
+
+                  // Trim the pathPrefix off the front of the path.
+                  if (
+                    options.pathPrefix &&
+                    (segmentPath.startsWith(
+                      `${options.pathPrefix}/`
+                    ) /* c8 ignore next */ ||
+                      segmentPath === options.pathPrefix)
+                  ) {
+                    segmentPath = segmentPath.slice(options.pathPrefix.length)
+                  }
+
+                  // Convert the trimmed path into an array of path segments.
+                  const segments = segmentPath.split("/").filter(Boolean)
+
+                  return {
+                    path,
+                    type,
+                    locale,
+                    segments,
+                  }
+                })
+            )
+          })
+        )
+      })
+    )
+
+    return paths.flat(2)
+  }
+
   async translatePath(
     path: string,
     options?: JsonApiWithAuthOption