@goodfellow-cms/next 0.1.0 → 0.2.0

package/README.md

@@ -4,9 +4,9 @@ Goodfellow pages and the admin panel in a Next.js App Router site, exported as s
 
 Start from the Next.js starter: `npm create goodfellow@latest my-site -- --template next`.
 
-[Goodfellow](https://github.com/chartung17/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://chartung17.github.io/goodfellow-cms/) for everything else.
+[Goodfellow](https://github.com/goodfellow-cms/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://goodfellow-cms.github.io/goodfellow-cms/) for everything else.
 
-More in the docs: [Next.js](https://chartung17.github.io/goodfellow-cms/docs/nextjs).
+More in the docs: [Next.js](https://goodfellow-cms.github.io/goodfellow-cms/docs/nextjs).
 
 ## License
 

package/bin/goodfellow-next.js

@@ -1,19 +1,37 @@
 #!/usr/bin/env node
-// After `next build`: `goodfellow-next finish out` fixes the export's prefetch files on Windows
-// and writes the search index for sites with a search block. `index` only writes the index.
+// After `next build`: `goodfellow-next finish out` fixes the export's prefetch files on Windows,
+// writes the calendar files of collections of events and the pages at redirects' old addresses, and the search index for sites with a search block. `index` only writes the index.
+// `goodfellow-next update` updates Goodfellow, as `goodfellow update` does for other sites.
+import { parseArgs } from "node:util";
+import { formatUpdateResult } from "@goodfellow-cms/core";
+import { update } from "@goodfellow-cms/core/node";
 import { writeSearchIndex } from "@goodfellow-cms/core/search-index";
-import { fixSegmentFiles } from "@goodfellow-cms/next/export";
+import { fixSegmentFiles, writeCalendarFiles, writeRedirectFiles } from "@goodfellow-cms/next/export";
 
 const [command, dir = "out"] = process.argv.slice(2);
+if (command === "update") {
+  const { values } = parseArgs({
+    args: process.argv.slice(3),
+    options: { to: { type: "string" }, publish: { type: "boolean" } },
+  });
+  const result = await update({ to: values.to, publish: values.publish });
+  // For the admin panel, which reads it in the host's log.
+  console.log(formatUpdateResult(result));
+  process.exit(result.state === "failed" ? 1 : 0);
+}
 if (command !== "finish" && command !== "index") {
   console.error(
     [
       "Usage: goodfellow-next finish [folder]",
       "       goodfellow-next index [folder]",
+      "       goodfellow-next update [--to fixes|automatic|latest|<release>] [--publish]",
       "",
       "finish  Gets the exported site in folder (default: out) ready to publish: puts the files",
-      "        Next.js uses to load pages ahead where browsers look for them, and indexes it for search.",
+      "        Next.js uses to load pages ahead where browsers look for them, writes calendar files",
+      "        for collections of events and pages that send visitors on from old addresses, and",
+      "        indexes it for search.",
       "index   Only indexes the exported site for its search block.",
+      "update  Updates Goodfellow, and blocks from its registry, if the site still builds.",
     ].join("\n"),
   );
   process.exit(1);
@@ -21,6 +39,10 @@ if (command !== "finish" && command !== "index") {
 if (command === "finish") {
   const moved = await fixSegmentFiles(dir);
   if (moved > 0) console.log(`Moved ${moved} of Next.js's prefetch files to where browsers look for them`);
+  const calendars = await writeCalendarFiles(dir);
+  if (calendars > 0) console.log(`Wrote ${calendars} calendar files`);
+  const redirects = await writeRedirectFiles(dir);
+  if (redirects > 0) console.log(`Wrote ${redirects} redirects`);
 }
 const indexed = await writeSearchIndex(dir);
 console.log(

package/dist/config.d.ts

@@ -14,6 +14,8 @@ export interface GoodfellowNextOptions {
  * - Serves the site from `basePath`, or else the `GOODFELLOW_BASE` environment
  *   variable, as `goodfellow build` does (GitHub Pages serves most sites from `/repository-name/`).
  * - Serves images as they are unless the site sets an image loader, since static files can't be optimized on request.
+ * - Adds the site's redirects (Site Settings → Redirects) ahead of the site's own, for hosts that
+ *   send them, such as Vercel. Others get the pages `goodfellow-next finish` writes at old addresses.
  * - In `next dev`, runs the admin panel's local backend, so publishing saves to
  *   the files on disk. It's never part of a build.
  * - In `next dev`, turns off React's debug channel (`experimental.reactDebugChannel`)

package/dist/config.js

@@ -1,5 +1,5 @@
-import { normalizeBase } from "@goodfellow-cms/core";
-import { DEV_API_PREFIX, handleDevApi, isLocalOrigin, localFileStore, localRegistryDir } from "@goodfellow-cms/core/node";
+import { CALENDARS_DIR, allPages, loadSiteContent, normalizeBase, redirectFrom, redirectProblems } from "@goodfellow-cms/core";
+import { DEV_API_PREFIX, fileSystemSource, handleDevApi, isLocalOrigin, localFileStore, localRegistryDir } from "@goodfellow-cms/core/node";
 import { createServer } from "node:http";
 import { resolve } from "node:path";
 //#region src/config.ts
@@ -53,6 +53,32 @@ function imageSettings(images) {
 		...images
 	};
 }
+/** An address as Next.js matches a redirect's source, with the characters its patterns use escaped. */
+function redirectSource(path) {
+	return encodeURI(path).replace(/[()[\]{}+*?:!]/g, "\\$&");
+}
+/**
+* The site's redirects (`content/redirects.json`) for hosts that send them
+* themselves, such as Vercel, which reads them from the build. Redirects from
+* an address a page or a collection's item has are left out, since pages win,
+* as they do over the pages `goodfellow-next finish` writes at old addresses.
+* Content with a problem gives none, and the build reports the problem.
+*/
+async function siteRedirects(root) {
+	const content = await loadSiteContent(fileSystemSource(root)).catch(() => void 0);
+	if (!content?.redirects) return [];
+	const taken = new Set(allPages(content).map((page) => page.path));
+	const problems = redirectProblems(content.redirects);
+	return content.redirects.flatMap((redirect, index) => {
+		const from = redirectFrom(redirect.from);
+		if (problems[index] || !from.ok || taken.has(from.path)) return [];
+		return [{
+			source: redirectSource(from.path),
+			destination: redirect.to.trim(),
+			permanent: true
+		}];
+	});
+}
 /**
 * Sets up Next.js for a Goodfellow site, in `next.config.ts`:
 * `export default withGoodfellow({ ... })`.
@@ -63,6 +89,8 @@ function imageSettings(images) {
 * - Serves the site from `basePath`, or else the `GOODFELLOW_BASE` environment
 *   variable, as `goodfellow build` does (GitHub Pages serves most sites from `/repository-name/`).
 * - Serves images as they are unless the site sets an image loader, since static files can't be optimized on request.
+* - Adds the site's redirects (Site Settings → Redirects) ahead of the site's own, for hosts that
+*   send them, such as Vercel. Others get the pages `goodfellow-next finish` writes at old addresses.
 * - In `next dev`, runs the admin panel's local backend, so publishing saves to
 *   the files on disk. It's never part of a build.
 * - In `next dev`, turns off React's debug channel (`experimental.reactDebugChannel`)
@@ -85,20 +113,25 @@ function withGoodfellow(nextConfig = {}, options = {}) {
 		};
 		if (phase !== PHASE_DEVELOPMENT_SERVER) return {
 			output: "export",
-			...config
+			...config,
+			redirects: async () => [...await siteRedirects(root), ...await nextConfig.redirects?.() ?? []]
 		};
 		const port = await startDevApi(root);
 		const rewrite = {
 			source: `${DEV_API_PREFIX}/:path*`,
 			destination: `http://127.0.0.1:${port}${DEV_API_PREFIX}/:path*`
 		};
+		const calendars = {
+			source: `/${CALENDARS_DIR}/:file(.+\\.ics)`,
+			destination: `http://127.0.0.1:${port}${DEV_API_PREFIX}/${CALENDARS_DIR}/:file`
+		};
 		return {
 			...config,
 			experimental: {
 				reactDebugChannel: false,
 				...nextConfig.experimental
 			},
-			rewrites: async () => withRewrite(await nextConfig.rewrites?.(), rewrite)
+			rewrites: async () => withRewrite(withRewrite(await nextConfig.rewrites?.(), calendars), rewrite)
 		};
 	};
 }

package/dist/export.d.ts

@@ -1,4 +1,16 @@
 //#region src/export.d.ts
+/**
+ * Writes the calendar files of the site's collections of events into the
+ * export, as `goodfellow build` does: Next.js has no route for them. Returns
+ * how many it wrote.
+ */
+export declare function writeCalendarFiles(outDir: string, root?: string): Promise<number>;
+/**
+ * Writes a page at each of the site's old addresses that sends visitors on, as
+ * `goodfellow build` does. Pages win: an address the export has a page at keeps
+ * it. Returns how many it wrote.
+ */
+export declare function writeRedirectFiles(outDir: string, root?: string): Promise<number>;
 /**
  * Puts a static export's prefetch files where the browser asks for them.
  * Next.js names each after its segment path with `/` turned into `.`

package/dist/export.js

@@ -1,7 +1,58 @@
-import { join, relative } from "node:path";
-import { readdir, rename, rm } from "node:fs/promises";
+import { allPages, calendarFiles, loadSiteContent, redirectFiles } from "@goodfellow-cms/core";
+import { fileSystemSource } from "@goodfellow-cms/core/node";
+import { dirname, join, relative, resolve } from "node:path";
+import { access, mkdir, readFile, readdir, rename, rm, writeFile } from "node:fs/promises";
 //#region src/export.ts
 /**
+* Writes the calendar files of the site's collections of events into the
+* export, as `goodfellow build` does: Next.js has no route for them. Returns
+* how many it wrote.
+*/
+async function writeCalendarFiles(outDir, root = process.cwd()) {
+	const files = calendarFiles(await loadSiteContent(fileSystemSource(resolve(root))));
+	for (const file of files) {
+		const target = join(outDir, file.path.slice(1));
+		await mkdir(dirname(target), { recursive: true });
+		await writeFile(target, file.content);
+	}
+	return files.length;
+}
+/** The `basePath` the export was built with, which Next.js records in `.next/routes-manifest.json`. */
+async function exportBasePath(root) {
+	try {
+		const manifest = JSON.parse(await readFile(join(root, ".next/routes-manifest.json"), "utf8"));
+		return typeof manifest.basePath === "string" ? manifest.basePath : "";
+	} catch {
+		return "";
+	}
+}
+async function exists(path) {
+	return access(path).then(() => true, () => false);
+}
+/**
+* Writes a page at each of the site's old addresses that sends visitors on, as
+* `goodfellow build` does. Pages win: an address the export has a page at keeps
+* it. Returns how many it wrote.
+*/
+async function writeRedirectFiles(outDir, root = process.cwd()) {
+	const dir = resolve(root);
+	const content = await loadSiteContent(fileSystemSource(dir));
+	const files = redirectFiles(content, {
+		taken: allPages(content).map((page) => page.path),
+		base: await exportBasePath(dir)
+	});
+	let written = 0;
+	for (const file of files) {
+		const target = join(outDir, file.path.slice(1));
+		const page = join(outDir, `${file.path.replace(/\/index\.html$/, "")}.html`);
+		if (await exists(target) || await exists(page)) continue;
+		await mkdir(dirname(target), { recursive: true });
+		await writeFile(target, file.content);
+		written++;
+	}
+	return written;
+}
+/**
 * Puts a static export's prefetch files where the browser asks for them.
 * Next.js names each after its segment path with `/` turned into `.`
 * (`__next.$oc$path.__PAGE__.txt`), but on Windows the path has `\` instead, so
@@ -38,4 +89,4 @@ async function fixSegmentFiles(outDir) {
 	return moved;
 }
 //#endregion
-export { fixSegmentFiles };
+export { fixSegmentFiles, writeCalendarFiles, writeRedirectFiles };

package/dist/index.d.ts

@@ -38,6 +38,8 @@ export declare function goodfellowPages(config: GoodfellowConfig, options?: Good
     path: string[];
   }>>;
   generateMetadata({ params }: PageProps): Promise<Metadata>;
+  /** For `app/admin/layout.tsx`: the admin panel's title, kept out of search engines, with the site's icon. */
+  adminMetadata(): Promise<Metadata>;
   /**
    * For `app/(site)/layout.tsx`: the site's header and footer around every page, kept as
    * they are when moving between pages. Menus mark the current page in the browser.

package/dist/index.js

@@ -1,8 +1,8 @@
 import { CurrentMenuLinks, NextImage, NextLink } from "./components.js";
-import { absoluteUrl, allPages, demoContent, getPageHead, googleFontsUrl, loadSiteContent, normalizePagePath, themeToCss, withBase } from "@goodfellow-cms/core";
+import { absoluteUrl, demoContent, findRedirect, getPageHead, googleFontsUrl, loadSiteContent, normalizePagePath, sitePages, themeToCss, todayIn, withBase } from "@goodfellow-cms/core";
 import { fileSystemSource, readMediaSizes } from "@goodfellow-cms/core/node";
 import { BodyCode, HeadCode, PageBody, PageContent, PageFooter, PageHeader, applyPageEntry, createPuckConfigs, prepareLayout, preparePage } from "@goodfellow-cms/react";
-import { notFound } from "next/navigation";
+import { notFound, redirect } from "next/navigation";
 import { cache } from "react";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 //#region src/index.tsx
@@ -27,8 +27,12 @@ function pathOf(segments) {
 		return "";
 	}
 }
-function findPage(content, path) {
-	return allPages(content).find((page) => page.path === path);
+/** Every page the site's export has: its pages, entries' pages and the pages blocks add, such as a calendar's months. */
+function exportedPages(content, blocks) {
+	return sitePages(content, todayIn(content.settings.timeZone), blocks);
+}
+function findPage(content, blocks, path) {
+	return exportedPages(content, blocks).find((page) => page.path === path);
 }
 function toAbsolute(siteUrl, url) {
 	if (!url || !siteUrl || !url.startsWith("/") || url.startsWith("//")) return url;
@@ -99,13 +103,22 @@ function goodfellowPages(config, options = {}) {
 	return {
 		/** Every page's address, so Next.js builds them all. Any other address is "not found". */
 		async generateStaticParams() {
-			return allPages(await site()).filter((page) => page.path !== "/404").map((page) => ({ path: page.path === "/" ? [] : page.path.slice(1).split("/") }));
+			return exportedPages(await site(), config.blocks).filter((page) => page.path !== "/404").map((page) => ({ path: page.path === "/" ? [] : page.path.slice(1).split("/") }));
 		},
 		async generateMetadata({ params }) {
 			const content = await site();
-			const page = findPage(content, pathOf((await params).path));
+			const page = findPage(content, config.blocks, pathOf((await params).path));
 			return page ? pageMetadata(content, applyPageEntry(configs, content, page), basePath()) : {};
 		},
+		/** For `app/admin/layout.tsx`: the admin panel's title, kept out of search engines, with the site's icon. */
+		async adminMetadata() {
+			const favicon = await site().then((content) => content.settings.favicon, () => void 0);
+			return {
+				title: "Site admin",
+				robots: { index: false },
+				...favicon && { icons: { icon: withBase(favicon, basePath()) } }
+			};
+		},
 		/**
 		* For `app/(site)/layout.tsx`: the site's header and footer around every page, kept as
 		* they are when moving between pages. Menus mark the current page in the browser.
@@ -134,8 +147,13 @@ function goodfellowPages(config, options = {}) {
 		/** The page at the route's address, inside `Layout`'s header and footer. */
 		async Page({ params }) {
 			const content = await site();
-			const page = findPage(content, pathOf((await params).path));
-			if (!page || page.path === "/404") notFound();
+			const segments = (await params).path;
+			const page = findPage(content, config.blocks, pathOf(segments));
+			if (!page || page.path === "/404") {
+				const moved = findRedirect(content, `/${(segments ?? []).join("/")}`);
+				if (moved) redirect(moved.to);
+				notFound();
+			}
 			const prepared = await preparePage(configs, content, page, await renderOptions());
 			return /* @__PURE__ */ jsx(PageContent, {
 				site: prepared.site,
@@ -149,7 +167,7 @@ function goodfellowPages(config, options = {}) {
 		*/
 		async NotFound() {
 			const content = await site();
-			const page = findPage(content, "/404");
+			const page = findPage(content, config.blocks, "/404");
 			if (!page) return /* @__PURE__ */ jsx("h1", { children: "Page not found" });
 			const prepared = await preparePage(configs, content, page, await renderOptions());
 			return /* @__PURE__ */ jsxs(Fragment, { children: [
@@ -172,7 +190,7 @@ function goodfellowPages(config, options = {}) {
 			const content = await site();
 			const url = content.settings.url;
 			if (!url) return [];
-			return allPages(content).filter((page) => page.path !== "/404").map((page) => ({ url: absoluteUrl(url, page.path) }));
+			return exportedPages(content, config.blocks).filter((page) => page.path !== "/404").map((page) => ({ url: absoluteUrl(url, page.path) }));
 		},
 		/**
 		* For `app/admin/demo-content.json/route.ts`: in a demo (the config's `demo`), the copy of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goodfellow-cms/next",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Goodfellow pages and the admin panel in a Next.js site.",
   "keywords": [
     "goodfellow",
@@ -10,12 +10,12 @@
     "nextjs",
     "next"
   ],
-  "homepage": "https://chartung17.github.io/goodfellow-cms/docs/nextjs",
-  "bugs": "https://github.com/chartung17/goodfellow-cms/issues",
+  "homepage": "https://goodfellow-cms.github.io/goodfellow-cms/docs/nextjs",
+  "bugs": "https://github.com/goodfellow-cms/goodfellow-cms/issues",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/chartung17/goodfellow-cms.git",
+    "url": "git+https://github.com/goodfellow-cms/goodfellow-cms.git",
     "directory": "packages/next"
   },
   "type": "module",
@@ -53,15 +53,15 @@
     "dist"
   ],
   "dependencies": {
-    "@goodfellow-cms/core": "0.1.0",
-    "@goodfellow-cms/react": "0.1.0"
+    "@goodfellow-cms/core": "0.2.0",
+    "@goodfellow-cms/react": "0.2.0"
   },
   "peerDependencies": {
     "@puckeditor/core": "0.23.0",
     "next": "^16.0.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
-    "@goodfellow-cms/admin": "0.1.0"
+    "@goodfellow-cms/admin": "0.2.0"
   },
   "devDependencies": {
     "@puckeditor/core": "0.23.0",
@@ -71,7 +71,7 @@
     "next": "16.3.8",
     "react": "19.3.0",
     "react-dom": "19.3.0",
-    "@goodfellow-cms/admin": "0.1.0"
+    "@goodfellow-cms/admin": "0.2.0"
   },
   "engines": {
     "node": ">=22"