@rmdes/indiekit-endpoint-site-config 1.0.0-beta.5 → 1.0.0-beta.7

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/identity.js

@@ -44,6 +44,7 @@ function parseSocialFromBody(body) {
 export function parseIdentityBody(body) {
   return {
     name:           safeString(body.name),
+    siteName:       safeString(body.siteName),
     avatar:         safeUrlOrEmpty(body.avatar),
     title:          safeString(body.title),
     pronoun:        safeString(body.pronoun),

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-site.js

@@ -37,6 +37,11 @@ export const DEFAULTS_SITE = Object.freeze({
   schemaVersion: 3,
   identity: Object.freeze({
     name: "",
+    // Site title / brand — drives the header, <title>, og:site_name and
+    // schema.org publisher. Distinct from `name` (the person, used by the
+    // h-card / hero). Empty falls back to `name` in the theme so single-author
+    // sites where the brand IS the person keep working with one field.
+    siteName: "",
     avatar: "",
     title: "",
     pronoun: "",
@@ -78,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,12 +17,25 @@
       "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.",
       "profile": {
         "legend": "Profile",
-        "name":        { "label": "Name",        "hint": "Your name as shown in the h-card and OG metadata" },
+        "name":        { "label": "Name",        "hint": "The person's name, shown in the h-card, hero, and author cards. For the site/brand title, use Site title below." },
         "title":       { "label": "Title",       "hint": "Job title or tagline (e.g. 'Middleware Engineer')" },
         "avatar":      { "label": "Avatar URL",  "hint": "URL of your profile photo for the h-card" },
         "pronoun":     { "label": "Pronouns",    "hint": "e.g. she/her, he/him, they/them" },
@@ -55,7 +69,7 @@
       "preferences": {
         "legend": "Site preferences"
       },
-      "name":            "Site name",
+      "siteName":        { "label": "Site title", "hint": "Shown in the site header, browser tab, and link previews. Leave blank to use your Name above (for single-author sites where the brand is the person)." },
       "description":     "Description",
       "tagline":         "Tagline",
       "defaultOgImage":  "Default OpenGraph image URL",

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,12 +17,25 @@
       "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.",
       "profile": {
         "legend": "Profil",
-        "name":        { "label": "Nom",            "hint": "Votre nom tel qu'il apparaît dans la h-card et les métadonnées OG" },
+        "name":        { "label": "Nom",            "hint": "Le nom de la personne, affiché dans la h-card, le hero et les cartes d'auteur. Pour le titre du site/de la marque, utilisez Titre du site ci-dessous." },
         "title":       { "label": "Titre",          "hint": "Intitulé de poste ou slogan (ex. « Ingénieur middleware »)" },
         "avatar":      { "label": "URL de l'avatar","hint": "URL de votre photo de profil pour la h-card" },
         "pronoun":     { "label": "Pronoms",        "hint": "ex. elle, il, iel" },
@@ -55,7 +69,7 @@
       "preferences": {
         "legend": "Préférences du site"
       },
-      "name":            "Nom du site",
+      "siteName":        { "label": "Titre du site", "hint": "Affiché dans l'en-tête du site, l'onglet du navigateur et les aperçus de liens. Laissez vide pour utiliser votre Nom ci-dessus (pour les sites mono-auteur où la marque est la personne)." },
       "description":     "Description",
       "tagline":         "Slogan",
       "defaultOgImage":  "Image OpenGraph par défaut",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rmdes/indiekit-endpoint-site-config",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.0-beta.7",
   "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-identity.njk

@@ -334,6 +334,12 @@
   <section class="hp-section">
     <h2>{{ __('siteConfig.identity.preferences.legend') }}</h2>
     <div class="hp-field-grid">
+      <div class="field field--full">
+        <label class="field__label" for="siteName">{{ __('siteConfig.identity.siteName.label') }}</label>
+        <input class="field__input" type="text" id="siteName" name="siteName"
+               value="{{ config.identity.siteName or '' }}">
+        <p class="field__hint">{{ __('siteConfig.identity.siteName.hint') }}</p>
+      </div>
       <div class="field">
         <label class="field__label" for="locale">{{ __('siteConfig.identity.locale') }}</label>
         <input class="field__input" type="text" id="locale" name="locale"