feat(basic-starter): upgrade starters to App Router

Fixes #601

Author: JohnAlbin

pages/[...slug].tsx renamed to app/[...slug]/page.tsx

@@ -1,54 +1,14 @@
-import Head from "next/head"
+import { draftMode } from "next/headers"
+import { notFound } from "next/navigation"
+import { getDraftData } from "next-drupal/draft"
 import { Article } from "@/components/drupal/Article"
 import { BasicPage } from "@/components/drupal/BasicPage"
-import { Layout } from "@/components/Layout"
 import { drupal } from "@/lib/drupal"
-import type {
-  GetStaticPaths,
-  GetStaticProps,
-  InferGetStaticPropsType,
-} from "next"
+import type { Metadata, ResolvingMetadata } from "next"
 import type { DrupalArticle, DrupalPage, NodesPath } from "@/types"
 
-export const getStaticPaths = (async (context) => {
-  // Fetch the paths for the first 50 articles and pages.
-  // We'll fall back to on-demand generation for the rest.
-  const data = await drupal.query<{
-    nodeArticles: NodesPath
-    nodePages: NodesPath
-  }>({
-    query: `query {
-      nodeArticles(first: 50) {
-        nodes {
-          path,
-        }
-      }
-      nodePages(first: 50) {
-        nodes {
-          path,
-        }
-      }
-    }`,
-  })
-
-  // Build static paths.
-  const paths = [
-    ...(data?.nodeArticles?.nodes as { path: string }[]),
-    ...(data?.nodePages?.nodes as { path: string }[]),
-  ].map(({ path }) => ({ params: { slug: path.split("/").filter(Boolean) } }))
-
-  return {
-    paths,
-    fallback: "blocking",
-  }
-}) satisfies GetStaticPaths
-
-export const getStaticProps = (async (context) => {
-  if (!context?.params?.slug) {
-    return {
-      notFound: true,
-    }
-  }
+async function getNode(slug: string[]) {
+  const path = `/${slug.join("/")}`
 
   const data = await drupal.query<{
     route: { entity: DrupalArticle | DrupalPage }
@@ -92,46 +52,96 @@ export const getStaticProps = (async (context) => {
       }
     }`,
     variables: {
-      path: `/${(context.params.slug as []).join("/")}`,
+      path,
     },
   })
 
   const resource = data?.route?.entity
 
-  // If we're not in preview mode and the resource is not published,
-  // Return page not found.
-  if (!resource || (!context.preview && resource?.status === false)) {
-    return {
-      notFound: true,
-    }
+  if (!resource) {
+    throw new Error(`Failed to fetch resource: ${path}`, {
+      cause: "DrupalError",
+    })
+  }
+
+  return resource
+}
+
+type NodePageParams = {
+  slug: string[]
+}
+type NodePageProps = {
+  params: NodePageParams
+  searchParams: { [key: string]: string | string[] | undefined }
+}
+
+export async function generateMetadata(
+  { params: { slug } }: NodePageProps,
+  parent: ResolvingMetadata
+): Promise<Metadata> {
+  let node
+  try {
+    node = await getNode(slug)
+  } catch (e) {
+    // If we fail to fetch the node, don't return any metadata.
+    return {}
   }
 
   return {
-    props: {
-      resource,
-    },
+    title: node.title,
+  }
+}
+
+export async function generateStaticParams(): Promise<NodePageParams[]> {
+  // Fetch the paths for the first 50 articles and pages.
+  // We'll fall back to on-demand generation for the rest.
+  const data = await drupal.query<{
+    nodeArticles: NodesPath
+    nodePages: NodesPath
+  }>({
+    query: `query {
+      nodeArticles(first: 50) {
+        nodes {
+          path,
+        }
+      }
+      nodePages(first: 50) {
+        nodes {
+          path,
+        }
+      }
+    }`,
+  })
+
+  return [
+    ...(data?.nodeArticles?.nodes as { path: string }[]),
+    ...(data?.nodePages?.nodes as { path: string }[]),
+  ].map(({ path }) => ({ slug: path.split("/").filter(Boolean) }))
+}
+
+export default async function Page({
+  params: { slug },
+  searchParams,
+}: NodePageProps) {
+  const isDraftMode = draftMode().isEnabled
+
+  let node
+  try {
+    node = await getNode(slug)
+  } catch (error) {
+    // If getNode throws an error, tell Next.js the path is 404.
+    notFound()
   }
-}) satisfies GetStaticProps<{
-  resource: DrupalArticle | DrupalPage
-}>
 
-export default function Page({
-  resource,
-}: InferGetStaticPropsType<typeof getStaticProps>) {
-  if (!resource) return null
+  // If we're not in draft mode and the resource is not published, return a 404.
+  if (!isDraftMode && node?.status === false) {
+    notFound()
+  }
 
   return (
-    <Layout>
-      <Head>
-        <title>{resource.title}</title>
-        <meta
-          name="description"
-          content="A Next.js site powered by Drupal."
-          key="description"
-        />
-      </Head>
-      {resource.__typename === "NodePage" && <BasicPage node={resource} />}
-      {resource.__typename === "NodeArticle" && <Article node={resource} />}
-    </Layout>
+    <>
+      {node.__typename === "NodePage" && <BasicPage node={node} />}
+      {node.__typename === "NodeArticle" && <Article node={node} />}
+    </>
   )
 }

app/api/disable-draft/route.ts

@@ -0,0 +1,6 @@
+import { disableDraftMode } from "next-drupal/draft"
+import type { NextRequest } from "next/server"
+
+export async function GET(request: NextRequest) {
+  return disableDraftMode()
+}

app/api/draft/route.ts

@@ -0,0 +1,7 @@
+import { drupal } from "@/lib/drupal"
+import { enableDraftMode } from "next-drupal/draft"
+import type { NextRequest } from "next/server"
+
+export async function GET(request: NextRequest): Promise<Response | never> {
+  return enableDraftMode(request, drupal)
+}

app/api/revalidate/route.ts

@@ -0,0 +1,28 @@
+import { revalidatePath } from "next/cache"
+import type { NextRequest } from "next/server"
+
+async function handler(request: NextRequest) {
+  const searchParams = request.nextUrl.searchParams
+  const path = searchParams.get("path")
+  const secret = searchParams.get("secret")
+
+  // Validate secret.
+  if (secret !== process.env.DRUPAL_REVALIDATE_SECRET) {
+    return new Response("Invalid secret.", { status: 401 })
+  }
+
+  // Validate path.
+  if (!path) {
+    return new Response("Invalid path.", { status: 400 })
+  }
+
+  try {
+    revalidatePath(path)
+
+    return new Response("Revalidated.")
+  } catch (error) {
+    return new Response((error as Error).message, { status: 500 })
+  }
+}
+
+export { handler as GET, handler as POST }

app/layout.tsx

@@ -0,0 +1,37 @@
+import { DraftAlert } from "@/components/misc/DraftAlert"
+import { HeaderNav } from "@/components/navigation/HeaderNav"
+import type { Metadata } from "next"
+import type { ReactNode } from "react"
+
+import "@/styles/globals.css"
+
+export const metadata: Metadata = {
+  title: {
+    default: "Next.js for Drupal",
+    template: "%s | Next.js for Drupal",
+  },
+  description: "A Next.js site powered by a Drupal backend.",
+  icons: {
+    icon: "/favicon.ico",
+  },
+}
+
+export default function RootLayout({
+  // Layouts must accept a children prop.
+  // This will be populated with nested layouts or pages
+  children,
+}: {
+  children: ReactNode
+}) {
+  return (
+    <html lang="en">
+      <body>
+        <DraftAlert />
+        <div className="max-w-screen-md px-6 mx-auto">
+          <HeaderNav />
+          <main className="container py-10 mx-auto">{children}</main>
+        </div>
+      </body>
+    </html>
+  )
+}

pages/index.tsx renamed to app/page.tsx

@@ -1,11 +1,13 @@
-import Head from "next/head"
 import { ArticleTeaser } from "@/components/drupal/ArticleTeaser"
-import { Layout } from "@/components/Layout"
 import { drupal } from "@/lib/drupal"
-import type { InferGetStaticPropsType, GetStaticProps } from "next"
+import type { Metadata } from "next"
 import type { DrupalArticle } from "@/types"
 
-export const getStaticProps = (async (context) => {
+export const metadata: Metadata = {
+  description: "A Next.js site powered by a Drupal backend.",
+}
+
+export default async function Home() {
   // Fetch the first 10 articles.
   const data = await drupal.query<{
     nodeArticles: {
@@ -38,29 +40,10 @@ export const getStaticProps = (async (context) => {
       }
     `,
   })
+  const nodes = data?.nodeArticles?.nodes ?? []
 
-  return {
-    props: {
-      nodes: data?.nodeArticles?.nodes ?? [],
-    },
-  }
-}) satisfies GetStaticProps<{
-  nodes: DrupalArticle[]
-}>
-
-export default function Home({
-  nodes,
-}: InferGetStaticPropsType<typeof getStaticProps>) {
   return (
-    <Layout>
-      <Head>
-        <title>Next.js for Drupal</title>
-        <meta
-          name="description"
-          content="A Next.js site powered by a Drupal backend."
-          key="description"
-        />
-      </Head>
+    <>
       <h1 className="mb-10 text-6xl font-black">Latest Articles.</h1>
       {nodes?.length ? (
         nodes.map((node) => (
@@ -72,6 +55,6 @@ export default function Home({
       ) : (
         <p className="py-4">No nodes found</p>
       )}
-    </Layout>
+    </>
   )
 }

components/layout.tsx

@@ -1,33 +1,36 @@
+"use client"
+
 import { useEffect, useState } from "react"
-import { useRouter } from "next/router"
 
-export function PreviewAlert() {
-  const router = useRouter()
-  const isPreview = router.isPreview
-  const [showPreviewAlert, setShowPreviewAlert] = useState<boolean>(false)
+export function DraftAlertClient({
+  isDraftEnabled,
+}: {
+  isDraftEnabled: boolean
+}) {
+  const [showDraftAlert, setShowDraftAlert] = useState<boolean>(false)
 
   useEffect(() => {
-    setShowPreviewAlert(isPreview && window.top === window.self)
-  }, [isPreview])
+    setShowDraftAlert(isDraftEnabled && window.top === window.self)
+  }, [isDraftEnabled])
 
-  if (!showPreviewAlert) {
+  if (!showDraftAlert) {
     return null
   }
 
   function buttonHandler() {
-    void fetch("/api/exit-preview")
-    setShowPreviewAlert(false)
+    void fetch("/api/disable-draft")
+    setShowDraftAlert(false)
   }
 
   return (
     <div className="sticky top-0 left-0 z-50 w-full px-2 py-1 text-center text-white bg-black">
       <p className="mb-0">
-        This page is a preview.{" "}
+        This page is a draft.
         <button
           className="inline-block ml-3 rounded border px-1.5 hover:bg-white hover:text-black active:bg-gray-200 active:text-gray-500"
           onClick={buttonHandler}
         >
-          Exit preview mode
+          Exit draft mode
         </button>
       </p>
     </div>