@rmdes/indiekit-endpoint-site-config 1.0.0-beta.6 → 1.0.0-beta.8

package/index.js

@@ -7,6 +7,7 @@ import { brandingRouter   } from "./lib/controllers/branding.js";
 import { homepageRouter   } from "./lib/controllers/homepage.js";
 import { blogRouter       } from "./lib/controllers/blog.js";
 import { navigationRouter } from "./lib/controllers/navigation.js";
+import { generalRouter    } from "./lib/controllers/general.js";
 import { apiRouter        } from "./lib/controllers/api.js";
 
 import { getSiteConfig     } from "./lib/storage/get-site-config.js";
@@ -77,6 +78,7 @@ export default class SiteConfigEndpoint {
     protectedRouter.use("/homepage",   homepageRouter(Indiekit));
     protectedRouter.use("/blog",       blogRouter(Indiekit));
     protectedRouter.use("/navigation", navigationRouter(Indiekit));
+    protectedRouter.use("/general",    generalRouter(Indiekit));
 
     this.routes = protectedRouter;
 

package/lib/controllers/general.js

@@ -0,0 +1,71 @@
+import express from "express";
+import { getSiteConfig } from "../storage/get-site-config.js";
+import { saveSiteConfig } from "../storage/save-site-config.js";
+import { writeSiteJson } from "../render/write-site-json.js";
+import { isValidUrl } from "../validators/identity.js";
+
+function safeString(raw) {
+  return typeof raw === "string" ? raw.trim() : "";
+}
+
+/**
+ * Coerce an HTML checkbox value to a boolean.
+ * Unchecked checkboxes are absent from the body; checked ones send "on".
+ * @param {*} raw - Raw body value
+ * @returns {boolean}
+ */
+function checkbox(raw) {
+  return raw === "on" || raw === "true" || raw === true || raw === "1";
+}
+
+/**
+ * Accept an absolute URL or a root-relative path (e.g. "/ai", "/about/ai",
+ * "https://example.com/ai-policy"). Falls back to the default when invalid.
+ * @param {*} raw - Raw body value
+ * @param {string} [fallback] - Default link
+ * @returns {string}
+ */
+function safeLinkOrDefault(raw, fallback = "/ai") {
+  const v = safeString(raw);
+  if (!v) return fallback;
+  if (v.startsWith("/")) return v; // root-relative path
+  if (isValidUrl(v, { allowEmpty: false })) return v; // absolute URL
+  return fallback;
+}
+
+export function parseGeneralBody(body) {
+  return {
+    aiTransparency: checkbox(body.aiTransparency),
+    aiTransparencyUrl: safeLinkOrDefault(body.aiTransparencyUrl),
+  };
+}
+
+export function generalRouter(Indiekit) {
+  const router = express.Router();
+
+  router.get("/", async (req, res, next) => {
+    try {
+      const config = await getSiteConfig(Indiekit);
+      res.render("site-config-general", {
+        config,
+        activeTab: "general",
+      });
+    } catch (error) {
+      next(error);
+    }
+  });
+
+  router.post("/", async (req, res, next) => {
+    try {
+      const features = parseGeneralBody(req.body);
+      const userIdent = Indiekit.config?.publication?.me || "unknown";
+      const updated = await saveSiteConfig(Indiekit, { features }, userIdent);
+      await writeSiteJson(updated);
+      res.redirect("/site-config/general?saved=1");
+    } catch (error) {
+      next(error);
+    }
+  });
+
+  return router;
+}

package/lib/controllers/homepage.js

@@ -7,6 +7,20 @@ import { LAYOUT_PRESETS } from "../presets/layout-presets.js";
 
 const VALID_LAYOUTS = new Set(["single-column", "two-column", "full-width-hero"]);
 
+// Hero "read more" CTA: accept a root-relative path or absolute URL, else fall
+// back to /about. Text is free-form (localizable per site), defaulting to "Read more".
+function safeHeroLink(raw, fallback = "/about") {
+  const v = typeof raw === "string" ? raw.trim() : "";
+  if (!v) return fallback;
+  if (v.startsWith("/")) return v;
+  try { new URL(v); return v; } catch { return fallback; }
+}
+
+function safeHeroText(raw, fallback = "Read more") {
+  const v = typeof raw === "string" ? raw.trim() : "";
+  return v || fallback;
+}
+
 export function parseEntryArray(value) {
   if (Array.isArray(value)) return value;
   if (typeof value === "string") {
@@ -33,6 +47,8 @@ export function parseHomepageBody(body) {
     hero: {
       enabled:    body.heroEnabled    === "on" || body.heroEnabled    === true,
       showSocial: body.heroShowSocial === "on" || body.heroShowSocial === true,
+      ctaText:    safeHeroText(body.heroCtaText),
+      ctaUrl:     safeHeroLink(body.heroCtaUrl),
     },
     sections: parseEntryArray(body.sections),
     sidebar:  parseEntryArray(body.sidebar),

package/lib/render/write-site-json.js

@@ -47,6 +47,7 @@ export function renderSiteJson(config) {
     identity:      config.identity,
     branding:      config.branding,
     navigation:    config.navigation,
+    features:      config.features,
     updatedAt:     config.updatedAt,
   };
   const replacer = (key, value) => (PRIVATE_KEYS.has(key) ? undefined : value);

package/lib/storage/defaults-homepage.js

@@ -20,6 +20,11 @@ export const DEFAULTS_HOMEPAGE = Object.freeze({
   hero: Object.freeze({
     enabled: true,
     showSocial: true,
+    // "Read more" call-to-action shown after the site description in the hero.
+    // ctaText is free-text (localize per site, e.g. "À propos"); ctaUrl is the
+    // target (default /about — keeps existing sites unchanged).
+    ctaText: "Read more",
+    ctaUrl: "/about",
   }),
   sections: Object.freeze([
     Object.freeze({

package/lib/storage/defaults-site.js

@@ -83,6 +83,14 @@ export const DEFAULTS_SITE = Object.freeze({
   navigation: Object.freeze({
     items: Object.freeze([]),
   }),
+  // Site-wide feature toggles. `aiTransparency` gates the theme's per-post AI
+  // usage disclosure (off by default — not every site uses AI); when on, the
+  // disclosure renders on every post/page. `aiTransparencyUrl` is the
+  // customizable "learn more" link target (defaults to the /ai page).
+  features: Object.freeze({
+    aiTransparency: false,
+    aiTransparencyUrl: "/ai",
+  }),
 });
 
 // Legacy export name for any code path that hasn't been updated yet.

package/locales/en.json

@@ -7,7 +7,8 @@
       "branding": "Branding",
       "homepage": "Homepage",
       "blog": "Blog",
-      "navigation": "Navigation"
+      "navigation": "Navigation",
+      "general": "General"
     },
     "common": {
       "save": "Save",
@@ -16,6 +17,19 @@
       "reset": "Reset",
       "preview": "Live preview"
     },
+    "general": {
+      "aiTransparency": {
+        "title": "AI transparency",
+        "description": "Show an AI usage disclosure on posts and pages. Turn this on only if you use AI to help draft or write content — when off, no AI disclosure is shown anywhere on the site.",
+        "label": "Show AI usage disclosure",
+        "hint": "When enabled, every post and page shows its AI usage (text/code level and tools) at the bottom.",
+        "urlLabel": "Learn-more link"
+      },
+      "aiTransparencyUrl": {
+        "label": "“Learn more” link",
+        "hint": "Where the “Learn more about AI usage” link points. Defaults to /ai; use any path (e.g. /about/ai) or full URL."
+      }
+    },
     "identity": {
       "title": "Identity",
       "saved": "Identity saved successfully. Refresh your site to see changes.",
@@ -156,7 +170,15 @@
       "hero": {
         "title": "Hero Section",
         "enabled": "Show hero section with author info",
-        "showSocial": "Show social links in hero"
+        "showSocial": "Show social links in hero",
+        "ctaText": {
+          "label": "“Read more” link text",
+          "hint": "Text for the call-to-action shown after the site description (e.g. “Read more”, “À propos”, “En savoir plus”)."
+        },
+        "ctaUrl": {
+          "label": "“Read more” link target",
+          "hint": "Where the hero “read more” link points. Defaults to /about; use any path (e.g. /apropos) or a full URL."
+        }
       },
       "sections": {
         "title": "Content Sections",

package/locales/fr.json

@@ -7,7 +7,8 @@
       "branding": "Identité visuelle",
       "homepage": "Accueil",
       "blog": "Blog",
-      "navigation": "Navigation"
+      "navigation": "Navigation",
+      "general": "Général"
     },
     "common": {
       "save": "Enregistrer",
@@ -16,6 +17,19 @@
       "reset": "Réinitialiser",
       "preview": "Aperçu en direct"
     },
+    "general": {
+      "aiTransparency": {
+        "title": "Transparence IA",
+        "description": "Afficher une mention d'utilisation de l'IA sur les billets et les pages. À activer uniquement si vous utilisez l'IA pour rédiger du contenu — désactivé, aucune mention IA n'apparaît sur le site.",
+        "label": "Afficher la mention d'utilisation de l'IA",
+        "hint": "Une fois activé, chaque billet et page affiche son utilisation de l'IA (niveau texte/code et outils) en bas de page.",
+        "urlLabel": "Lien « en savoir plus »"
+      },
+      "aiTransparencyUrl": {
+        "label": "Lien « en savoir plus »",
+        "hint": "Cible du lien « en savoir plus sur l'utilisation de l'IA ». Par défaut /ai ; utilisez un chemin (ex. /about/ai) ou une URL complète."
+      }
+    },
     "identity": {
       "title": "Identité",
       "saved": "Identité enregistrée avec succès. Actualisez votre site pour voir les modifications.",
@@ -156,7 +170,15 @@
       "hero": {
         "title": "Section Hero",
         "enabled": "Afficher la section hero avec les informations sur l'auteur",
-        "showSocial": "Afficher les liens sociaux dans le hero"
+        "showSocial": "Afficher les liens sociaux dans le hero",
+        "ctaText": {
+          "label": "Texte du lien « en savoir plus »",
+          "hint": "Texte de l'appel à l'action affiché après la description du site (ex. « À propos », « En savoir plus »)."
+        },
+        "ctaUrl": {
+          "label": "Cible du lien « en savoir plus »",
+          "hint": "Destination du lien « en savoir plus » du hero. Par défaut /about ; utilisez un chemin (ex. /apropos) ou une URL complète."
+        }
       },
       "sections": {
         "title": "Sections de contenu",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rmdes/indiekit-endpoint-site-config",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.8",
   "type": "module",
   "description": "Site identity, branding, and navigation configuration for Indiekit",
   "main": "index.js",

package/views/partials/tab-strip.njk

@@ -31,7 +31,8 @@
     {key: 'branding',   href: '/site-config/branding'},
     {key: 'homepage',   href: '/site-config/homepage'},
     {key: 'blog',       href: '/site-config/blog'},
-    {key: 'navigation', href: '/site-config/navigation'}
+    {key: 'navigation', href: '/site-config/navigation'},
+    {key: 'general',    href: '/site-config/general'}
   ] %}
   {% for tab in tabs %}
     <a href="{{ tab.href }}"

package/views/site-config-general.njk

@@ -0,0 +1,76 @@
+{% extends "document.njk" %}
+
+{% block title %}{{ __('siteConfig.tabs.general') }}{% endblock %}
+
+{% block content %}
+<style>
+  .sc-form { display: flex; flex-direction: column; gap: var(--space-xl, 2rem); }
+  .sc-section {
+    background: var(--color-offset, #f5f5f5);
+    border-radius: var(--border-radius-small, 0.5rem);
+    padding: var(--space-m, 1.5rem);
+  }
+  .sc-section h2 {
+    font: var(--font-heading, bold 1.25rem/1.4 sans-serif);
+    margin-block-end: var(--space-s, 0.75rem);
+    padding-block-end: var(--space-xs, 0.5rem);
+    border-block-end: 1px solid var(--color-outline-variant, #ddd);
+  }
+  .sc-section__desc {
+    color: var(--color-on-offset, #666);
+    margin-block-end: var(--space-m, 1.25rem);
+  }
+  .sc-field { margin-block-end: var(--space-m, 1.25rem); }
+  .sc-field--toggle { display: flex; align-items: flex-start; gap: var(--space-s, 0.75rem); }
+  .sc-field--toggle input { margin-block-start: 0.25rem; }
+  .sc-field__label { display: block; font-weight: 600; margin-block-end: var(--space-xs, 0.4rem); }
+  .sc-field__input {
+    width: 100%; max-width: 28rem;
+    padding: var(--space-xs, 0.5rem) var(--space-s, 0.75rem);
+    border: 1px solid var(--color-outline-variant, #ccc);
+    border-radius: var(--border-radius-small, 0.375rem);
+    font: inherit;
+  }
+  .sc-field__hint { color: var(--color-on-offset, #666); font-size: 0.875rem; margin-block-start: var(--space-xs, 0.4rem); }
+</style>
+
+<header class="page-header">
+  <h1 class="page-header__title">{{ __("siteConfig.title") }}</h1>
+  <p class="page-header__description">{{ __("siteConfig.description") }}</p>
+</header>
+
+{% include "partials/tab-strip.njk" %}
+
+{% if request.query.saved %}
+<div class="notice notice--success" role="status">
+  <p>{{ __("siteConfig.common.saved") }}</p>
+</div>
+{% endif %}
+
+<form method="post" action="/site-config/general" class="sc-form">
+  <section class="sc-section">
+    <h2>{{ __("siteConfig.general.aiTransparency.title") }}</h2>
+    <p class="sc-section__desc">{{ __("siteConfig.general.aiTransparency.description") }}</p>
+
+    <div class="sc-field sc-field--toggle">
+      <input type="checkbox" id="aiTransparency" name="aiTransparency"
+             {% if config.features.aiTransparency %}checked{% endif %}>
+      <label for="aiTransparency">
+        <span class="sc-field__label">{{ __("siteConfig.general.aiTransparency.label") }}</span>
+        <span class="sc-field__hint">{{ __("siteConfig.general.aiTransparency.hint") }}</span>
+      </label>
+    </div>
+
+    <div class="sc-field">
+      <label class="sc-field__label" for="aiTransparencyUrl">{{ __("siteConfig.general.aiTransparencyUrl.label") }}</label>
+      <input class="sc-field__input" type="text" id="aiTransparencyUrl" name="aiTransparencyUrl"
+             value="{{ config.features.aiTransparencyUrl or '/ai' }}" placeholder="/ai">
+      <p class="sc-field__hint">{{ __("siteConfig.general.aiTransparencyUrl.hint") }}</p>
+    </div>
+  </section>
+
+  <div class="button-group">
+    <button type="submit" class="button button--primary">{{ __("siteConfig.common.save") }}</button>
+  </div>
+</form>
+{% endblock %}

package/views/site-config-homepage.njk

@@ -400,6 +400,18 @@
         {{ __("siteConfig.homepage.hero.showSocial") }}
       </label>
     </div>
+    <div class="field">
+      <label class="field__label" for="heroCtaText">{{ __("siteConfig.homepage.hero.ctaText.label") }}</label>
+      <input class="field__input" type="text" id="heroCtaText" name="heroCtaText"
+             value="{{ homepage.hero.ctaText or 'Read more' }}" placeholder="Read more">
+      <p class="field__hint">{{ __("siteConfig.homepage.hero.ctaText.hint") }}</p>
+    </div>
+    <div class="field">
+      <label class="field__label" for="heroCtaUrl">{{ __("siteConfig.homepage.hero.ctaUrl.label") }}</label>
+      <input class="field__input" type="text" id="heroCtaUrl" name="heroCtaUrl"
+             value="{{ homepage.hero.ctaUrl or '/about' }}" placeholder="/about">
+      <p class="field__hint">{{ __("siteConfig.homepage.hero.ctaUrl.hint") }}</p>
+    </div>
   </section>
 
   {# Content Sections #}