domma-cms 0.30.0 → 0.32.1

package/server/routes/api/navigation.js

@@ -1,42 +1,42 @@
-/**
- * Navigation API
- * GET /api/navigation    - get navigation config
- * PUT /api/navigation    - save navigation config
- */
-import {getConfig, saveConfig} from '../../config.js';
-import {authenticate, requirePermission} from '../../middleware/auth.js';
-import * as cache from '../../services/cache/index.js';
-
-export async function navigationRoutes(fastify) {
-    const canRead = {preHandler: [authenticate, requirePermission('navigation', 'read')]};
-    const canUpdate = {preHandler: [authenticate, requirePermission('navigation', 'update')]};
-
-    fastify.get('/navigation', canRead, async () => {
-        return getConfig('navigation');
-    });
-
-    fastify.put('/navigation', canUpdate, async (request, reply) => {
-        const data = request.body;
-        if (!data || typeof data !== 'object') {
-            return reply.status(400).send({ error: 'Invalid navigation data' });
-        }
-        if (!Array.isArray(data.items) && !Array.isArray(data)) {
-            return reply.status(400).send({ error: 'Navigation must be an array of items' });
-        }
-        // Normalise child key: Domma navbar expects `items`, not `children`
-        if (Array.isArray(data.items)) {
-            data.items = data.items.map(item => {
-                const children = item.items || item.children;
-                if (children?.length) {
-                    const { children: _c, ...rest } = item;
-                    return { ...rest, items: children };
-                }
-                const { children: _c, ...rest } = item;
-                return rest;
-            });
-        }
-        saveConfig('navigation', data);
-        await cache.invalidateTags(['nav']);
-        return { success: true };
-    });
-}
+/**
+ * Navigation API
+ * GET /api/navigation    - get navigation config
+ * PUT /api/navigation    - save navigation config
+ */
+import {getConfig, saveConfig} from '../../config.js';
+import {authenticate, requirePermission} from '../../middleware/auth.js';
+import * as cache from '../../services/cache/index.js';
+
+export async function navigationRoutes(fastify) {
+    const canRead = {preHandler: [authenticate, requirePermission('navigation', 'read')]};
+    const canUpdate = {preHandler: [authenticate, requirePermission('navigation', 'update')]};
+
+    fastify.get('/navigation', canRead, async () => {
+        return getConfig('navigation');
+    });
+
+    fastify.put('/navigation', canUpdate, async (request, reply) => {
+        const data = request.body;
+        if (!data || typeof data !== 'object') {
+            return reply.status(400).send({ error: 'Invalid navigation data' });
+        }
+        if (!Array.isArray(data.items) && !Array.isArray(data)) {
+            return reply.status(400).send({ error: 'Navigation must be an array of items' });
+        }
+        // Normalise child key: Domma navbar expects `items`, not `children`
+        if (Array.isArray(data.items)) {
+            data.items = data.items.map(item => {
+                const children = item.items || item.children;
+                if (children?.length) {
+                    const { children: _c, ...rest } = item;
+                    return { ...rest, items: children };
+                }
+                const { children: _c, ...rest } = item;
+                return rest;
+            });
+        }
+        saveConfig('navigation', data);
+        await cache.invalidateTags(['nav']);
+        return { success: true };
+    });
+}

package/server/routes/api/settings.js

@@ -1,141 +1,141 @@
-/**
- * Settings API
- * GET  /api/settings            - get site settings
- * PUT  /api/settings            - save site settings
- * POST /api/settings/test-email - send a test email using stored SMTP config
- */
-import {getConfig, saveConfig} from '../../config.js';
-import {authenticate, requirePermission} from '../../middleware/auth.js';
-import nodemailer from 'nodemailer';
-import fs from 'fs/promises';
-import path from 'path';
-import {fileURLToPath} from 'url';
-import * as cache from '../../services/cache/index.js';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const CUSTOM_CSS_FILE = path.resolve(__dirname, '../../../content/custom.css');
-const CONNECTIONS_FILE = path.resolve(__dirname, '../../../config/connections.json');
-const CUSTOM_CSS_MAX = 100 * 1024; // 100 KB
-
-export async function settingsRoutes(fastify) {
-    const canRead = {preHandler: [authenticate, requirePermission('settings', 'read')]};
-    const canUpdate = {preHandler: [authenticate, requirePermission('settings', 'update')]};
-
-    fastify.get('/settings', canRead, async (request, reply) => {
-        const config = getConfig('site');
-        const safeConfig = { ...config };
-        if (safeConfig.smtp) {
-            safeConfig.smtp = { ...safeConfig.smtp, pass: '' };
-        }
-        return reply.send(safeConfig);
-    });
-
-    fastify.put('/settings', canUpdate, async (request, reply) => {
-        const data = request.body;
-        if (!data || typeof data !== 'object') {
-            return reply.status(400).send({ error: 'Invalid settings data' });
-        }
-        const ALLOWED_KEYS = new Set([
-            'title', 'tagline', 'description', 'logo', 'favicon',
-            'theme', 'adminTheme', 'fontFamily', 'fontSize',
-            'smtp', 'footer', 'analytics', 'social', 'locale',
-            'layoutOptions', 'seo', 'backToTop', 'cookieConsent', 'breadcrumbs', 'autoTheme',
-            'adminBrand'
-        ]);
-        const unknownKeys = Object.keys(data).filter(k => !ALLOWED_KEYS.has(k));
-        if (unknownKeys.length > 0) {
-            return reply.status(400).send({ error: `Unknown settings keys: ${unknownKeys.join(', ')}` });
-        }
-        // Merge incoming data with existing config so partial updates (e.g. just adminBrand)
-        // don't wipe unrelated keys. Nested objects get a shallow merge so sub-fields are
-        // preserved even when only some sub-fields are sent.
-        const existing = getConfig('site');
-        const merged = {...existing};
-        for (const [k, v] of Object.entries(data)) {
-            const isPlainObject = v !== null && typeof v === 'object' && !Array.isArray(v);
-            const existingIsPlainObject = existing[k] !== null && typeof existing[k] === 'object' && !Array.isArray(existing[k]);
-            if (isPlainObject && existingIsPlainObject) {
-                merged[k] = {...existing[k], ...v};
-            } else {
-                merged[k] = v;
-            }
-        }
-        // Never erase smtp.pass with the empty string that the GET endpoint injects for safety
-        if (merged.smtp && merged.smtp.pass === '' && existing.smtp?.pass) {
-            merged.smtp = {...merged.smtp, pass: existing.smtp.pass};
-        }
-        saveConfig('site', merged);
-        await cache.invalidateTags(['site']);
-        return { success: true };
-    });
-
-    fastify.post('/settings/test-email', canRead, async (request, reply) => {
-        const smtp = getConfig('site')?.smtp;
-        if (!smtp?.host) {
-            return reply.status(400).send({ error: 'SMTP is not configured. Save your SMTP settings first.' });
-        }
-
-        const transporter = nodemailer.createTransport({
-            host:   smtp.host,
-            port:   smtp.port || 587,
-            secure: smtp.secure || false,
-            auth:   smtp.user ? { user: smtp.user, pass: smtp.pass } : undefined
-        });
-
-        const to = request.body?.to || smtp.fromAddress;
-        if (!to) {
-            return reply.status(400).send({ error: 'No recipient address. Provide "to" in the request body or set a From Address.' });
-        }
-
-        try {
-            await transporter.sendMail({
-                from:    smtp.fromName ? `"${smtp.fromName}" <${smtp.fromAddress}>` : smtp.fromAddress,
-                to,
-                subject: 'Domma CMS — Test Email',
-                text:    'This is a test email sent from Domma CMS to verify your SMTP configuration.',
-                html:    '<p>This is a test email sent from <strong>Domma CMS</strong> to verify your SMTP configuration.</p>'
-            });
-            return { success: true, message: `Test email sent to ${to}` };
-        } catch (err) {
-            return reply.status(500).send({ error: `Failed to send email: ${err.message}` });
-        }
-    });
-
-    // GET /api/settings/db-status — returns whether MongoDB connections are configured
-    fastify.get('/settings/db-status', canRead, async () => {
-        try {
-            const raw = await fs.readFile(CONNECTIONS_FILE, 'utf8');
-            const connections = JSON.parse(raw);
-            const names = Object.keys(connections).filter(k =>
-                connections[k]?.type === 'mongodb' && connections[k]?.uri
-            );
-            return {configured: names.length > 0, connections: names};
-        } catch {
-            return {configured: false, connections: []};
-        }
-    });
-
-    // GET /api/settings/custom-css — return current CSS as JSON
-    fastify.get('/settings/custom-css', canUpdate, async () => {
-        try {
-            const css = await fs.readFile(CUSTOM_CSS_FILE, 'utf8');
-            return { css };
-        } catch {
-            return { css: '' };
-        }
-    });
-
-    // PUT /api/settings/custom-css — save CSS to content/custom.css
-    fastify.put('/settings/custom-css', canUpdate, async (request, reply) => {
-        const { css } = request.body || {};
-        if (typeof css !== 'string') {
-            return reply.status(400).send({ error: 'css must be a string.' });
-        }
-        if (Buffer.byteLength(css, 'utf8') > CUSTOM_CSS_MAX) {
-            return reply.status(400).send({ error: 'CSS exceeds the 100 KB limit.' });
-        }
-        await fs.writeFile(CUSTOM_CSS_FILE, css, 'utf8');
-        await cache.invalidateTags(['site']);
-        return { success: true };
-    });
-}
+/**
+ * Settings API
+ * GET  /api/settings            - get site settings
+ * PUT  /api/settings            - save site settings
+ * POST /api/settings/test-email - send a test email using stored SMTP config
+ */
+import {getConfig, saveConfig} from '../../config.js';
+import {authenticate, requirePermission} from '../../middleware/auth.js';
+import nodemailer from 'nodemailer';
+import fs from 'fs/promises';
+import path from 'path';
+import {fileURLToPath} from 'url';
+import * as cache from '../../services/cache/index.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const CUSTOM_CSS_FILE = path.resolve(__dirname, '../../../content/custom.css');
+const CONNECTIONS_FILE = path.resolve(__dirname, '../../../config/connections.json');
+const CUSTOM_CSS_MAX = 100 * 1024; // 100 KB
+
+export async function settingsRoutes(fastify) {
+    const canRead = {preHandler: [authenticate, requirePermission('settings', 'read')]};
+    const canUpdate = {preHandler: [authenticate, requirePermission('settings', 'update')]};
+
+    fastify.get('/settings', canRead, async (request, reply) => {
+        const config = getConfig('site');
+        const safeConfig = { ...config };
+        if (safeConfig.smtp) {
+            safeConfig.smtp = { ...safeConfig.smtp, pass: '' };
+        }
+        return reply.send(safeConfig);
+    });
+
+    fastify.put('/settings', canUpdate, async (request, reply) => {
+        const data = request.body;
+        if (!data || typeof data !== 'object') {
+            return reply.status(400).send({ error: 'Invalid settings data' });
+        }
+        const ALLOWED_KEYS = new Set([
+            'title', 'tagline', 'description', 'logo', 'favicon',
+            'theme', 'adminTheme', 'fontFamily', 'fontSize',
+            'smtp', 'footer', 'analytics', 'social', 'locale',
+            'layoutOptions', 'seo', 'backToTop', 'cookieConsent', 'breadcrumbs', 'autoTheme',
+            'adminBrand'
+        ]);
+        const unknownKeys = Object.keys(data).filter(k => !ALLOWED_KEYS.has(k));
+        if (unknownKeys.length > 0) {
+            return reply.status(400).send({ error: `Unknown settings keys: ${unknownKeys.join(', ')}` });
+        }
+        // Merge incoming data with existing config so partial updates (e.g. just adminBrand)
+        // don't wipe unrelated keys. Nested objects get a shallow merge so sub-fields are
+        // preserved even when only some sub-fields are sent.
+        const existing = getConfig('site');
+        const merged = {...existing};
+        for (const [k, v] of Object.entries(data)) {
+            const isPlainObject = v !== null && typeof v === 'object' && !Array.isArray(v);
+            const existingIsPlainObject = existing[k] !== null && typeof existing[k] === 'object' && !Array.isArray(existing[k]);
+            if (isPlainObject && existingIsPlainObject) {
+                merged[k] = {...existing[k], ...v};
+            } else {
+                merged[k] = v;
+            }
+        }
+        // Never erase smtp.pass with the empty string that the GET endpoint injects for safety
+        if (merged.smtp && merged.smtp.pass === '' && existing.smtp?.pass) {
+            merged.smtp = {...merged.smtp, pass: existing.smtp.pass};
+        }
+        saveConfig('site', merged);
+        await cache.invalidateTags(['site']);
+        return { success: true };
+    });
+
+    fastify.post('/settings/test-email', canRead, async (request, reply) => {
+        const smtp = getConfig('site')?.smtp;
+        if (!smtp?.host) {
+            return reply.status(400).send({ error: 'SMTP is not configured. Save your SMTP settings first.' });
+        }
+
+        const transporter = nodemailer.createTransport({
+            host:   smtp.host,
+            port:   smtp.port || 587,
+            secure: smtp.secure || false,
+            auth:   smtp.user ? { user: smtp.user, pass: smtp.pass } : undefined
+        });
+
+        const to = request.body?.to || smtp.fromAddress;
+        if (!to) {
+            return reply.status(400).send({ error: 'No recipient address. Provide "to" in the request body or set a From Address.' });
+        }
+
+        try {
+            await transporter.sendMail({
+                from:    smtp.fromName ? `"${smtp.fromName}" <${smtp.fromAddress}>` : smtp.fromAddress,
+                to,
+                subject: 'Domma CMS — Test Email',
+                text:    'This is a test email sent from Domma CMS to verify your SMTP configuration.',
+                html:    '<p>This is a test email sent from <strong>Domma CMS</strong> to verify your SMTP configuration.</p>'
+            });
+            return { success: true, message: `Test email sent to ${to}` };
+        } catch (err) {
+            return reply.status(500).send({ error: `Failed to send email: ${err.message}` });
+        }
+    });
+
+    // GET /api/settings/db-status — returns whether MongoDB connections are configured
+    fastify.get('/settings/db-status', canRead, async () => {
+        try {
+            const raw = await fs.readFile(CONNECTIONS_FILE, 'utf8');
+            const connections = JSON.parse(raw);
+            const names = Object.keys(connections).filter(k =>
+                connections[k]?.type === 'mongodb' && connections[k]?.uri
+            );
+            return {configured: names.length > 0, connections: names};
+        } catch {
+            return {configured: false, connections: []};
+        }
+    });
+
+    // GET /api/settings/custom-css — return current CSS as JSON
+    fastify.get('/settings/custom-css', canUpdate, async () => {
+        try {
+            const css = await fs.readFile(CUSTOM_CSS_FILE, 'utf8');
+            return { css };
+        } catch {
+            return { css: '' };
+        }
+    });
+
+    // PUT /api/settings/custom-css — save CSS to content/custom.css
+    fastify.put('/settings/custom-css', canUpdate, async (request, reply) => {
+        const { css } = request.body || {};
+        if (typeof css !== 'string') {
+            return reply.status(400).send({ error: 'css must be a string.' });
+        }
+        if (Buffer.byteLength(css, 'utf8') > CUSTOM_CSS_MAX) {
+            return reply.status(400).send({ error: 'CSS exceeds the 100 KB limit.' });
+        }
+        await fs.writeFile(CUSTOM_CSS_FILE, css, 'utf8');
+        await cache.invalidateTags(['site']);
+        return { success: true };
+    });
+}

package/server/routes/docs-public.js

@@ -0,0 +1,43 @@
+/**
+ * Domma Docs — public surface
+ *
+ * Serves the handbook at request time from the admin doc templates:
+ *   GET /domma-docs              → home landing
+ *   GET /domma-docs/<path>       → section landing or leaf page
+ *
+ * The publish switch is the `domma-docs` project's enabled flag: when the
+ * project is disabled the whole surface 404s (no existence oracle), identical
+ * to the catch-all's project kill-switch. Unknown paths 404 the same way.
+ *
+ * This dedicated /domma-docs(/*) prefix out-prioritises public.js's `/*`
+ * catch-all (Fastify ranks static segments above wildcards), exactly as
+ * routes/api/endpoints-public.js `/x/*` coexists with it — so no per-path
+ * special-casing is needed in public.js. Registered at app root (not behind a
+ * prefixed plugin) so the specificity ranking shares one router scope.
+ */
+import {isProjectEnabled} from '../services/projects.js';
+import {renderDocPage} from '../services/docs.js';
+import {getBaseUrl, render404} from './public.js';
+
+const DOCS_PROJECT_SLUG = 'domma-docs';
+
+export async function docsPublicRoutes(fastify) {
+    const handle = async (request, reply) => {
+        // Hard kill-switch: docs disabled → 404 the entire surface.
+        if (!(await isProjectEnabled(DOCS_PROJECT_SLUG))) {
+            reply.status(404);
+            return reply.type('text/html').send(await render404(request.url.split('?')[0]));
+        }
+
+        const docPath = String(request.params['*'] || '');
+        const html = await renderDocPage(docPath, {user: null, baseUrl: getBaseUrl(request)});
+        if (html == null) {
+            reply.status(404);
+            return reply.type('text/html').send(await render404(`/domma-docs${docPath ? '/' + docPath : ''}`));
+        }
+        return reply.type('text/html').send(html);
+    };
+
+    fastify.get('/domma-docs', handle);    // exact — params['*'] === '' (home landing)
+    fastify.get('/domma-docs/*', handle);  // sections + leaves
+}

package/server/routes/public.js

@@ -26,7 +26,7 @@ import * as cache from '../services/cache/index.js';
  * @param {import('fastify').FastifyRequest} request
  * @returns {string} e.g. 'https://example.com' (no trailing slash)
  */
-function getBaseUrl(request) {
+export function getBaseUrl(request) {
     const override = (getConfig('site') || {}).baseUrl;
     if (override) return override.toString().trim().replace(/\/+$/, '');
     const host = request.host || request.headers.host || request.hostname;
@@ -178,7 +178,7 @@ export async function publicRoutes(fastify) {
  * Render a 404 response — tries content/pages/404.md first, falls back to
  * a minimal inline page so the site theme is applied when possible.
  */
-async function render404(urlPath) {
+export async function render404(urlPath) {
     try {
         const page404 = await getPage('/404');
         if (page404 && page404.status === 'published') {

package/server/server.js

@@ -224,6 +224,11 @@ try {
 await cache.initCache(config.cache);
 console.log(`[cache] driver=${cache.isEnabled() ? config.cache.driver : 'disabled'}`);
 
+// Docs are rendered at request time from the shipped admin templates; clear any
+// previously-cached docs HTML so a version bump (new templates) never serves
+// stale pages. No-op on a cold memory cache; matters for the Redis driver.
+await cache.invalidateTags(['docs']);
+
 // Serve uploaded media files — nosniff prevents browsers rendering spoofed content types
 await app.register(staticPlugin, {
     root: mediaDir,
@@ -359,7 +364,9 @@ for (const [name, plugin] of Object.entries(getLoadedPlugins())) {
         await app.register(publicPlugin, {
             settings,
             auth: { authenticate: _authenticate, requireAdmin: _requireAdmin, requireVisibility: _requireVisibility },
-            config: getConfig()
+            // getConfig() requires a name; pass the startup config singleton instead.
+            // (Without this every enabled plugin.public.js fails to register.)
+            config
         });
     } catch (err) {
         app.log.error(`[plugins] Failed to register public plugin ${name}: ${err.message}`);
@@ -370,6 +377,11 @@ for (const [name, plugin] of Object.entries(getLoadedPlugins())) {
 // Public Site (catch-all — must be last)
 // ---------------------------------------------------------------------------
 
+// Domma Docs (request-time handbook) — dedicated /domma-docs(/*) prefix that
+// out-prioritises the catch-all; must be registered before it.
+const { docsPublicRoutes } = await import('./routes/docs-public.js');
+await app.register(docsPublicRoutes);
+
 const { publicRoutes } = await import('./routes/public.js');
 await app.register(publicRoutes);