@agility/create-next-app 1.0.0-beta.2 → 1.0.0-beta.4

package/dist/templates/copyTemplates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"copyTemplates.d.ts","sourceRoot":"","sources":["../../src/templates/copyTemplates.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAG3C;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CA4C3F"}
+{"version":3,"file":"copyTemplates.d.ts","sourceRoot":"","sources":["../../src/templates/copyTemplates.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAS3C;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAmD3F"}

package/dist/templates/copyTemplates.js

@@ -8,6 +8,10 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const ora_1 = __importDefault(require("ora"));
 const copyDirectory_1 = require("./copyDirectory");
+// Folders that should be copied to project root instead of src/
+const ROOT_FOLDERS = ['.claude', 'node', 'data'];
+// Files that should be copied to project root instead of src/
+const ROOT_FILES = [];
 /**
  * Copies template files to the project
  * @param projectPath - Path to the project
@@ -22,17 +26,22 @@ async function copyTemplates(projectPath, options) {
         if (!fs_1.default.existsSync(srcDir)) {
             fs_1.default.mkdirSync(srcDir, { recursive: true });
         }
-        // Copy all template files to src directory, except .claude
+        // Copy all template files to src directory, except special folders/files
         const entries = fs_1.default.readdirSync(templatesDir, { withFileTypes: true });
         for (const entry of entries) {
             const srcPath = path_1.default.join(templatesDir, entry.name);
-            // .claude folder should be copied to project root, not src
-            if (entry.name === '.claude') {
-                const destPath = path_1.default.join(projectPath, '.claude');
-                if (!fs_1.default.existsSync(destPath)) {
-                    fs_1.default.mkdirSync(destPath, { recursive: true });
+            // Check if this should go to project root
+            if (ROOT_FOLDERS.includes(entry.name) || ROOT_FILES.includes(entry.name)) {
+                const destPath = path_1.default.join(projectPath, entry.name);
+                if (entry.isDirectory()) {
+                    if (!fs_1.default.existsSync(destPath)) {
+                        fs_1.default.mkdirSync(destPath, { recursive: true });
+                    }
+                    await (0, copyDirectory_1.copyDirectory)(srcPath, destPath);
+                }
+                else {
+                    fs_1.default.copyFileSync(srcPath, destPath);
                 }
-                await (0, copyDirectory_1.copyDirectory)(srcPath, destPath);
             }
             else {
                 // All other files go to src directory
@@ -48,6 +57,8 @@ async function copyTemplates(projectPath, options) {
                 }
             }
         }
+        // Add prebuild script to package.json
+        await addPrebuildScript(projectPath);
         spinner.succeed('Template files copied');
     }
     catch (error) {
@@ -55,4 +66,21 @@ async function copyTemplates(projectPath, options) {
         throw error;
     }
 }
+/**
+ * Adds the prebuild script to package.json
+ */
+async function addPrebuildScript(projectPath) {
+    const packageJsonPath = path_1.default.join(projectPath, 'package.json');
+    if (fs_1.default.existsSync(packageJsonPath)) {
+        const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, 'utf-8'));
+        // Add prebuild script
+        packageJson.scripts = packageJson.scripts || {};
+        packageJson.scripts.prebuild = 'npx tsx node/prebuild.ts';
+        // Update build script to run prebuild first
+        if (packageJson.scripts.build && !packageJson.scripts.build.includes('prebuild')) {
+            packageJson.scripts.build = 'npm run prebuild && next build';
+        }
+        fs_1.default.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+    }
+}
 //# sourceMappingURL=copyTemplates.js.map

package/dist/templates/copyTemplates.js.map

@@ -1 +1 @@
-{"version":3,"file":"copyTemplates.js","sourceRoot":"","sources":["../../src/templates/copyTemplates.ts"],"names":[],"mappings":";;;;;AAWA,sCA4CC;AAvDD,4CAAoB;AACpB,gDAAwB;AACxB,8CAAsB;AAEtB,mDAAgD;AAEhD;;;;GAIG;AACI,KAAK,UAAU,aAAa,CAAC,WAAmB,EAAE,OAAmB;IAC1E,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,sCAAsC,CAAC,CAAC,KAAK,EAAE,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,2DAA2D;QAC3D,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAEtE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAEpD,2DAA2D;YAC3D,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBACnD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC7B,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,CAAC;gBACD,MAAM,IAAA,6BAAa,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC/C,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;oBACxB,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC7B,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC9C,CAAC;oBACD,MAAM,IAAA,6BAAa,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,CAAC;oBACN,YAAE,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC9C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}
+{"version":3,"file":"copyTemplates.js","sourceRoot":"","sources":["../../src/templates/copyTemplates.ts"],"names":[],"mappings":";;;;;AAiBA,sCAmDC;AApED,4CAAoB;AACpB,gDAAwB;AACxB,8CAAsB;AAEtB,mDAAgD;AAEhD,gEAAgE;AAChE,MAAM,YAAY,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjD,8DAA8D;AAC9D,MAAM,UAAU,GAAa,EAAE,CAAC;AAEhC;;;;GAIG;AACI,KAAK,UAAU,aAAa,CAAC,WAAmB,EAAE,OAAmB;IAC1E,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,sCAAsC,CAAC,CAAC,KAAK,EAAE,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,yEAAyE;QACzE,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAEtE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAEpD,0CAA0C;YAC1C,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzE,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;oBACxB,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC7B,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC9C,CAAC;oBACD,MAAM,IAAA,6BAAa,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,CAAC;oBACN,YAAE,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC/C,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;oBACxB,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC7B,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC9C,CAAC;oBACD,MAAM,IAAA,6BAAa,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,CAAC;oBACN,YAAE,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;QACH,CAAC;QAED,sCAAsC;QACtC,MAAM,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAErC,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC9C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,iBAAiB,CAAC,WAAmB;IAClD,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IAE/D,IAAI,YAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QACnC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QAE1E,sBAAsB;QACtB,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC;QAChD,WAAW,CAAC,OAAO,CAAC,QAAQ,GAAG,0BAA0B,CAAC;QAE1D,4CAA4C;QAC5C,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACjF,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,gCAAgC,CAAC;QAC/D,CAAC;QAED,YAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACjF,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/create-next-app",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.4",
   "description": "Create a new Next.js project with Agility CMS integration",
   "main": "dist/cli/index.js",
   "bin": {
@@ -42,4 +42,4 @@
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}

package/src/templates/copyTemplates.ts

@@ -4,6 +4,12 @@ import ora from 'ora';
 import type { CliOptions } from '../types';
 import { copyDirectory } from './copyDirectory';
 
+// Folders that should be copied to project root instead of src/
+const ROOT_FOLDERS = ['.claude', 'node', 'data'];
+
+// Files that should be copied to project root instead of src/
+const ROOT_FILES: string[] = [];
+
 /**
  * Copies template files to the project
  * @param projectPath - Path to the project
@@ -21,19 +27,23 @@ export async function copyTemplates(projectPath: string, options: CliOptions): P
       fs.mkdirSync(srcDir, { recursive: true });
     }
 
-    // Copy all template files to src directory, except .claude
+    // Copy all template files to src directory, except special folders/files
     const entries = fs.readdirSync(templatesDir, { withFileTypes: true });
 
     for (const entry of entries) {
       const srcPath = path.join(templatesDir, entry.name);
 
-      // .claude folder should be copied to project root, not src
-      if (entry.name === '.claude') {
-        const destPath = path.join(projectPath, '.claude');
-        if (!fs.existsSync(destPath)) {
-          fs.mkdirSync(destPath, { recursive: true });
+      // Check if this should go to project root
+      if (ROOT_FOLDERS.includes(entry.name) || ROOT_FILES.includes(entry.name)) {
+        const destPath = path.join(projectPath, entry.name);
+        if (entry.isDirectory()) {
+          if (!fs.existsSync(destPath)) {
+            fs.mkdirSync(destPath, { recursive: true });
+          }
+          await copyDirectory(srcPath, destPath);
+        } else {
+          fs.copyFileSync(srcPath, destPath);
         }
-        await copyDirectory(srcPath, destPath);
       } else {
         // All other files go to src directory
         const destPath = path.join(srcDir, entry.name);
@@ -48,6 +58,9 @@ export async function copyTemplates(projectPath: string, options: CliOptions): P
       }
     }
 
+    // Add prebuild script to package.json
+    await addPrebuildScript(projectPath);
+
     spinner.succeed('Template files copied');
   } catch (error) {
     spinner.fail('Failed to copy template files');
@@ -55,3 +68,25 @@ export async function copyTemplates(projectPath: string, options: CliOptions): P
   }
 }
 
+/**
+ * Adds the prebuild script to package.json
+ */
+async function addPrebuildScript(projectPath: string): Promise<void> {
+  const packageJsonPath = path.join(projectPath, 'package.json');
+
+  if (fs.existsSync(packageJsonPath)) {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+
+    // Add prebuild script
+    packageJson.scripts = packageJson.scripts || {};
+    packageJson.scripts.prebuild = 'npx tsx node/prebuild.ts';
+
+    // Update build script to run prebuild first
+    if (packageJson.scripts.build && !packageJson.scripts.build.includes('prebuild')) {
+      packageJson.scripts.build = 'npm run prebuild && next build';
+    }
+
+    fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+  }
+}
+

package/templates/README.md

@@ -141,6 +141,9 @@ AGILITY_API_FETCH_KEY=your-fetch-api-key
 AGILITY_API_PREVIEW_KEY=your-preview-api-key
 AGILITY_LOCALES=en-us
 AGILITY_SITEMAP=website
+
+# Optional: Build Hook URL for redirect rebuilds (see Deployment section)
+BUILD_HOOK_URL=https://your-build-hook-url
 ```
 
 ## 🎯 Common Tasks
@@ -180,7 +183,8 @@ const posts = await getContentList({
 
 ```bash
 npm run dev       # Start development server
-npm run build     # Build for production
+npm run prebuild  # Rebuild redirect cache from Agility CMS
+npm run build     # Build for production (runs prebuild automatically)
 npm run start     # Start production server
 npm run lint      # Run ESLint
 ```
@@ -193,6 +197,7 @@ npm run lint      # Run ESLint
 - ✅ **TypeScript** - Full type safety
 - ✅ **Caching** - ISR with on-demand revalidation
 - ✅ **Preview Mode** - See draft content before publishing
+- ✅ **URL Redirects** - Managed in Agility CMS, applied via middleware
 - ✅ **AI-Friendly Docs** - Optimized for all AI coding tools
 
 ## 🔗 Key Concepts
@@ -209,6 +214,16 @@ Collections like blog posts, testimonials, team members. Fetched with `getConten
 ### Locales
 Multi-language support. Default locale (en-us) has clean URLs, others are prefixed (/fr/, /es/).
 
+### URL Redirects
+URL redirects are managed in Agility CMS (Settings > URL Redirections) and applied via Next.js middleware.
+
+**How it works:**
+1. The `prebuild` script fetches all redirects from Agility CMS and saves them to `data/redirections.json`
+2. The middleware checks incoming requests against this cache
+3. When a redirect is published in Agility CMS, the revalidate webhook triggers a rebuild (if `BUILD_HOOK_URL` is configured)
+
+**Important:** Redirects are cached at build time. Changes to redirects in Agility CMS require a rebuild to take effect. Configure a build hook to automate this.
+
 ## 📖 Learn More
 
 ### Documentation
@@ -245,9 +260,28 @@ Set these in your hosting platform:
 - `AGILITY_GUID`
 - `AGILITY_API_FETCH_KEY`
 - `AGILITY_API_PREVIEW_KEY`
-- `AGILITY_SECURITY_KEY` (for webhooks)
+- `AGILITY_SECURITY_KEY` (required for preview mode and Web Studio)
 - `AGILITY_LOCALES`
 - `AGILITY_SITEMAP`
+- `BUILD_HOOK_URL` (optional, for automatic redirect rebuilds)
+
+> **Important:** To enable preview mode and Web Studio integration from Agility CMS, you must add the **Security Key** from your Agility CMS instance to the `AGILITY_SECURITY_KEY` environment variable on your deployment platform. You can find this key in Agility CMS under **Settings > API Keys > Security Key**.
+
+### Configure Build Hook for URL Redirects
+
+When URL redirects are changed in Agility CMS, the site needs to rebuild to pick up the changes. To automate this:
+
+**Vercel:**
+1. Go to your project Settings > Git > Deploy Hooks
+2. Create a new hook (e.g., "Agility Redirect Rebuild")
+3. Copy the hook URL and add it to your environment variables as `BUILD_HOOK_URL`
+
+**Netlify:**
+1. Go to Site Settings > Build & deploy > Build hooks
+2. Add a new build hook
+3. Copy the hook URL and add it to your environment variables as `BUILD_HOOK_URL`
+
+When a redirect is published in Agility CMS (not a page or content item), the `/api/revalidate` webhook will automatically trigger this build hook.
 
 ## 🐛 Troubleshooting
 

package/templates/app/robots.txt

@@ -0,0 +1,8 @@
+# Agility CMS Robots Configuration
+# This allows indexing of all pages and references the sitemap
+
+User-agent: *
+Allow: /
+
+# Sitemap location (update the domain for your production site)
+Sitemap: ${SITE_URL}/sitemap.xml

package/templates/app/sitemap.tsx

@@ -0,0 +1,56 @@
+import { getSitemapFlat } from "@/lib/cms/getSitemapFlat"
+import { locales, defaultLocale } from "@/lib/i18n/config"
+import type { MetadataRoute } from "next"
+
+/**
+ * Agility CMS Sitemap
+ *
+ * Generates a sitemap from Agility CMS pages using getSitemapFlat().
+ * Iterates through all configured locales and generates entries for each visible page.
+ */
+export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
+	const allSitemapEntries: MetadataRoute.Sitemap = []
+	const baseUrl = process.env.SITE_URL || "https://example.com"
+
+	// Generate sitemap entries for each locale
+	for (const locale of locales) {
+		const sitemapData = await getSitemapFlat({
+			channelName: process.env.AGILITY_SITEMAP || "website",
+			languageCode: locale
+		})
+
+		if (!sitemapData) continue
+
+		const localeEntries = Object.keys(sitemapData)
+			.filter((path) => {
+				const node = sitemapData[path]
+
+				// Skip folders and redirects
+				if (node.isFolder || node.redirect) {
+					return false
+				}
+
+				// Skip pages not visible in sitemap
+				if (!node.visible?.sitemap) {
+					return false
+				}
+
+				return true
+			})
+			.map((path, index) => {
+				// For default locale, don't add locale prefix to URL
+				const localizedPath = locale === defaultLocale ? path : `/${locale}${path}`
+
+				return {
+					url: index === 0 && path === "/" ? baseUrl : `${baseUrl}${localizedPath}`,
+					lastModified: new Date(),
+					changeFrequency: "daily" as const,
+					priority: path === "/" ? 1.0 : 0.8
+				}
+			})
+
+		allSitemapEntries.push(...localeEntries)
+	}
+
+	return allSitemapEntries
+}

package/templates/data/redirections.json

@@ -0,0 +1,5 @@
+{
+	"lastAccessDate": "",
+	"isUpToDate": false,
+	"items": {}
+}

package/templates/lib/cms-content/checkRedirect.ts

@@ -0,0 +1,35 @@
+import type { Redirection, RedirectionsMap } from "../cms/getRedirections"
+
+// Import redirections from the prebuild-generated JSON file
+// This file is generated by running `npm run prebuild` before building
+let allRedirects: RedirectionsMap = { lastAccessDate: "", isUpToDate: false, items: {} }
+
+try {
+	// Dynamic import at build time - the file may not exist during development
+	allRedirects = require("../../../data/redirections.json") as RedirectionsMap
+} catch {
+	// File doesn't exist yet - that's OK during development or first build
+}
+
+/**
+ * Check if a path should be redirected.
+ * Uses the prebuild-generated redirections.json file for fast lookups.
+ *
+ * Inspired by: https://nextjs.org/docs/app/building-your-application/routing/redirecting#managing-redirects-at-scale-advanced
+ *
+ * @param path - The URL path to check for redirects
+ * @returns The redirection if found, null otherwise
+ */
+export const checkRedirect = async ({ path }: { path: string }): Promise<Redirection | null> => {
+	// Don't redirect the root path
+	if (path === "/") return null
+
+	// Get the redirections from the cached file
+	const redirections = allRedirects
+	if (!redirections || !redirections.items) return null
+
+	// Look up the path (case-insensitive)
+	const redirection = redirections.items[path.toLowerCase()]
+
+	return redirection || null
+}

package/templates/lib/cms-content/rebuildRedirectCache.ts

@@ -0,0 +1,29 @@
+import fs from 'fs/promises'
+import { getRedirections } from '../cms/getRedirections'
+
+/**
+ * Rebuild the redirection cache.
+ * This should be called during prebuild (before `next build`) to ensure
+ * redirects are available at runtime in the middleware.
+ *
+ * Inspired by: https://nextjs.org/docs/app/building-your-application/routing/redirecting#managing-redirects-at-scale-advanced
+ */
+export const rebuildRedirectCache = async () => {
+	console.log("Agility CMS => Rebuilding redirect cache...")
+	try {
+		// Force a rebuild of the redirection cache from Agility CMS
+		const redirections = await getRedirections({ forceUpdate: true })
+
+		const allKeys = Object.keys(redirections.items)
+		console.log(`Agility CMS => Found ${allKeys.length} redirects`)
+
+		// Save the redirections to the data folder for use in middleware
+		const fileName = 'data/redirections.json'
+		await fs.writeFile(fileName, JSON.stringify(redirections, null, 2), 'utf8')
+
+		console.log("Agility CMS => Redirect cache rebuilt successfully")
+
+	} catch (error) {
+		console.error("Error rebuilding redirect cache", error)
+	}
+}

package/templates/node/prebuild.ts

@@ -0,0 +1,16 @@
+import { rebuildRedirectCache } from "../src/lib/cms-content/rebuildRedirectCache"
+
+require("dotenv").config({
+	path: `.env.local`,
+})
+
+const doWork = async () => {
+	console.log("Agility CMS => Prebuild Started")
+
+	// Rebuild the redirects cache from Agility CMS
+	await rebuildRedirectCache()
+
+	console.log("Agility CMS => Prebuild Complete")
+}
+
+doWork()

package/templates/proxy.ts

@@ -1,6 +1,7 @@
 import { NextResponse } from 'next/server'
 import type { NextRequest } from 'next/server'
 import { defaultLocale, locales, isValidLocale, getLocaleFromPathname, removeLocaleFromPathname } from './lib/i18n/config'
+import { checkRedirect } from './lib/cms-content/checkRedirect'
 
 export async function proxy(request: NextRequest) {
 	/*****************************
@@ -9,6 +10,7 @@ export async function proxy(request: NextRequest) {
 	 * 2: Check if we are exiting preview
 	 * 3: Check if this is a direct to a dynamic page
 	 *    based on a content id
+	 * 4: Check for URL redirects from Agility CMS
 	 *******************************/
 
 	let pathname = request.nextUrl.pathname
@@ -38,6 +40,36 @@ export async function proxy(request: NextRequest) {
 			return NextResponse.rewrite(dynredirectUrl)
 		}
 	} else if ((!ext || ext.length === 0)) {
+
+		/**********************
+		 * CHECK FOR REDIRECT *
+		 **********************/
+		const redirection = await checkRedirect({ path: request.nextUrl.pathname })
+
+		if (redirection) {
+			// Redirect to the destination URL
+			// Cache the redirect for 10 minutes (relative) or 1 hour (absolute)
+			if (redirection.destinationUrl.startsWith("/")) {
+				// Handle relative paths
+				const url = request.nextUrl.clone()
+				url.pathname = redirection.destinationUrl
+				return NextResponse.redirect(url, {
+					status: redirection.statusCode,
+					headers: {
+						"Cache-Control": "public, max-age=600, stale-while-revalidate"
+					}
+				})
+			} else {
+				// Handle absolute paths (external URLs)
+				return NextResponse.redirect(redirection.destinationUrl, {
+					status: redirection.statusCode,
+					headers: {
+						"Cache-Control": "public, max-age=3600, stale-while-revalidate"
+					}
+				})
+			}
+		}
+
 		/**************************************
 		 * SPECIAL CASE FOR lang= QUERY PARAM *
 		 **************************************/