ferst-core 0.7.2 → 0.7.4

package/integration.mjs

@@ -1,64 +1,83 @@
-/**
- * ferst() — the Astro integration that makes a client site's ROUTING package-owned.
- *
- * A thin client adds `integrations: [ferst()]` to astro.config.mjs and carries
- * ZERO page files: the page catch-all (which also owns the home page), the
- * calendar route and the blog routes are injected from ferst-core. A routing fix
- * then ships as a package bump + rebuild — the same channel component fixes travel
- * through — instead of being hand-copied into every client repo.
- *
- * Irreducible caveat (Astro 5): content collections must be defined in the CONSUMER,
- * so the one-line `src/content/config.ts` re-export stays. "Zero page files" is
- * reachable; "zero files" is not. Explicit client `.astro` routes still win over
- * these injected ones, so a one-off hand-built page is always possible.
- *
- * The blog routes (posts index / individual post / tag pages) inject as a set:
- * the listing components (NewsList, PostsFilter) now live in core, so `/posts`,
- * `/posts/[...slug]` and `/posts/tag/[...tag]` all ship from the package. Turn
- * the whole capability off with `blog: false` (then a client wanting posts hand-
- * builds its own routes over `ferst-core/lib/posts`).
- *
- * @param {object} [options]
- * @param {boolean} [options.calendar=true] Inject the `/calendar` route.
- * @param {boolean} [options.blog=true] Inject the blog routes (`/posts`,
- *   `/posts/[...slug]`, `/posts/tag/[...tag]`).
- * @returns {import('astro').AstroIntegration}
- */
-export default function ferst(options = {}) {
-  const { calendar = true, blog = true } = options;
-  return {
-    name: 'ferst',
-    hooks: {
-      'astro:config:setup': ({ injectRoute }) => {
-        // Pages + home: the reserved `index` entry renders at `/`, every other
-        // `pages` entry at its own slug (see lib/pages.ts `getSiteRoutes`).
-        injectRoute({
-          pattern: '/[...slug]',
-          entrypoint: 'ferst-core/routes/[...slug].astro',
-        });
-        if (calendar) {
-          injectRoute({
-            pattern: '/calendar',
-            entrypoint: 'ferst-core/routes/calendar/index.astro',
-          });
-        }
-        if (blog) {
-          // The posts capability: index, individual post, and tag pages. Reads
-          // the `posts`/`tags`/`postsSettings` collections (content/collections.ts).
-          injectRoute({
-            pattern: '/posts',
-            entrypoint: 'ferst-core/routes/posts/index.astro',
-          });
-          injectRoute({
-            pattern: '/posts/[...slug]',
-            entrypoint: 'ferst-core/routes/posts/[...slug].astro',
-          });
-          injectRoute({
-            pattern: '/posts/tag/[...tag]',
-            entrypoint: 'ferst-core/routes/posts/tag/[...tag].astro',
-          });
-        }
-      },
-    },
-  };
-}
+/**
+ * ferst() — the Astro integration that makes a client site's ROUTING package-owned.
+ *
+ * A thin client adds `integrations: [ferst()]` to astro.config.mjs and carries
+ * ZERO page files: the page catch-all (which also owns the home page), the
+ * calendar route and the blog routes are injected from ferst-core. A routing fix
+ * then ships as a package bump + rebuild — the same channel component fixes travel
+ * through — instead of being hand-copied into every client repo.
+ *
+ * Irreducible caveat (Astro 5): content collections must be defined in the CONSUMER,
+ * so the one-line `src/content/config.ts` re-export stays. "Zero page files" is
+ * reachable; "zero files" is not. Explicit client `.astro` routes still win over
+ * these injected ones, so a one-off hand-built page is always possible.
+ *
+ * The blog routes (posts index / individual post / tag pages) inject as a set:
+ * the listing components (NewsList, PostsFilter) now live in core, so `/posts`,
+ * `/posts/[...slug]` and `/posts/tag/[...tag]` all ship from the package. Turn
+ * the whole capability off with `blog: false` (then a client wanting posts hand-
+ * builds its own routes over `ferst-core/lib/posts`).
+ *
+ * @param {object} [options]
+ * @param {boolean} [options.calendar=true] Inject the `/calendar` route.
+ * @param {boolean} [options.blog=true] Inject the blog routes (`/posts`,
+ *   `/posts/[...slug]`, `/posts/tag/[...tag]`).
+ * @param {boolean} [options.cookiePolicy=true] Inject `/cookie-policy` (the page the cookie
+ *   banner links to), generated from the blocks the site uses. Skipped automatically when
+ *   the site has its own `src/pages/cookie-policy.astro`.
+ * @returns {import('astro').AstroIntegration}
+ */
+import { existsSync } from 'node:fs';
+
+export default function ferst(options = {}) {
+  const { calendar = true, blog = true, cookiePolicy = true } = options;
+  return {
+    name: 'ferst',
+    hooks: {
+      'astro:config:setup': ({ injectRoute, config }) => {
+        // Pages + home: the reserved `index` entry renders at `/`, every other
+        // `pages` entry at its own slug (see lib/pages.ts `getSiteRoutes`).
+        injectRoute({
+          pattern: '/[...slug]',
+          entrypoint: 'ferst-core/routes/[...slug].astro',
+        });
+        if (calendar) {
+          injectRoute({
+            pattern: '/calendar',
+            entrypoint: 'ferst-core/routes/calendar/index.astro',
+          });
+        }
+        if (blog) {
+          // The posts capability: index, individual post, and tag pages. Reads
+          // the `posts`/`tags`/`postsSettings` collections (content/collections.ts).
+          injectRoute({
+            pattern: '/posts',
+            entrypoint: 'ferst-core/routes/posts/index.astro',
+          });
+          injectRoute({
+            pattern: '/posts/[...slug]',
+            entrypoint: 'ferst-core/routes/posts/[...slug].astro',
+          });
+          injectRoute({
+            pattern: '/posts/tag/[...tag]',
+            entrypoint: 'ferst-core/routes/posts/tag/[...tag].astro',
+          });
+          // Index pages 2+ (page 1 is /posts; tag pages paginate inside their own route).
+          injectRoute({
+            pattern: '/posts/page/[page]',
+            entrypoint: 'ferst-core/routes/posts/page/[page].astro',
+          });
+        }
+        // The cookie banner links here on every page, so it must always resolve. A site's
+        // own hand-built page wins (Astro would otherwise see two routes for one path).
+        const bespoke = config?.root && existsSync(new URL('src/pages/cookie-policy.astro', config.root));
+        if (cookiePolicy && !bespoke) {
+          injectRoute({
+            pattern: '/cookie-policy',
+            entrypoint: 'ferst-core/routes/cookie-policy.astro',
+          });
+        }
+      },
+    },
+  };
+}