domma-cms 0.6.15 → 0.6.16

package/server/routes/api/plugins.js

@@ -5,7 +5,7 @@
  * GET /api/plugins/admin-config - sidebar/routes/views for enabled plugins (authenticated)
  */
 import { authenticate, requireAdmin, requirePermission } from '../../middleware/auth.js';
-import { discoverPlugins, getPluginStates, savePluginState, getAdminPluginConfig } from '../../services/plugins.js';
+import { discoverPlugins, getPluginStates, savePluginState, getAdminPluginConfig, runLifecycleHook } from '../../services/plugins.js';
 
 export async function pluginsRoutes(fastify) {
     const canRead   = { preHandler: [authenticate, requirePermission('plugins', 'read')]   };
@@ -38,7 +38,15 @@ export async function pluginsRoutes(fastify) {
         const manifest = manifests.find(m => m.name === name);
         if (!manifest) return reply.status(404).send({ error: 'Plugin not found' });
 
+        const prevState = getPluginStates()[name] || {};
         savePluginState(name, { enabled: !!enabled, settings: settings || {} });
+
+        if (!prevState.enabled && !!enabled) {
+            await runLifecycleHook(name, 'onEnable', fastify);
+        } else if (prevState.enabled && !enabled) {
+            await runLifecycleHook(name, 'onDisable', fastify);
+        }
+
         return { success: true };
     });
 

package/server/services/plugins.js

@@ -224,6 +224,36 @@ export async function getInjectionSnippets() {
   return {head, headLate, bodyEnd};
 }
 
+/**
+ * Run a lifecycle hook (onEnable or onDisable) for a plugin if it exports one.
+ * Dynamically imports plugin.js and calls the named export with a context object.
+ * Errors are logged but do not crash the process.
+ *
+ * @param {string} name - Plugin directory name
+ * @param {string} hook - Export name to call ('onEnable' or 'onDisable')
+ * @param {import('fastify').FastifyInstance} fastify
+ * @returns {Promise<void>}
+ */
+export async function runLifecycleHook(name, hook, fastify) {
+    // Validate hook name
+    if (!['onEnable', 'onDisable'].includes(hook)) return;
+
+    const pluginJsPath = path.join(PLUGINS_DIR, name, 'plugin.js');
+    try {
+        const mod = await import(pluginJsPath);
+        if (typeof mod[hook] !== 'function') return;
+
+        const [collections, roles] = await Promise.all([
+            import(path.resolve('server/services/collections.js')),
+            import(path.resolve('server/services/roles.js')),
+        ]);
+
+        await mod[hook]({ fastify, services: { collections, roles } });
+    } catch (err) {
+        fastify.log.error(`Plugin "${name}" lifecycle hook "${hook}" failed: ${err.message}`);
+    }
+}
+
 /**
  * Return merged sidebar items, routes, and views from all enabled plugins.
  * Used by the frontend to dynamically extend the admin panel.

package/plugins/example-analytics/admin/templates/analytics.html

@@ -1,10 +0,0 @@
-<div class="view-header">
-    <h1><span data-icon="chart-bar"></span> Analytics</h1>
-    <button id="reset-btn" class="btn btn-ghost btn-sm">Reset stats</button>
-</div>
-
-<div class="card">
-    <div class="card-body">
-        <div id="analytics-table"></div>
-    </div>
-</div>

package/plugins/example-analytics/admin/views/analytics.js

@@ -1,51 +0,0 @@
-/**
- * Analytics Plugin — Admin View
- * Shows a sortable table of page hit counts.
- * Loaded dynamically from /plugins/ static path.
- */
-export const analyticsView = {
-    templateUrl: '/plugins/example-analytics/admin/templates/analytics.html',
-
-    async onMount($container) {
-        await loadStats($container);
-
-        $container.find('#reset-btn').on('click', async () => {
-            const confirmed = await E.confirm('Reset all analytics data? This cannot be undone.');
-            if (!confirmed) return;
-            try {
-                await fetch('/api/plugins/example-analytics/stats', {
-                    method: 'DELETE',
-                    headers: {'Authorization': 'Bearer ' + (S.get('auth_token') || '')}
-                });
-                E.toast('Analytics reset.', {type: 'success'});
-                await loadStats($container);
-            } catch {
-                E.toast('Reset failed.', {type: 'error'});
-            }
-        });
-
-        Domma.icons.scan();
-    }
-};
-
-async function loadStats($container) {
-    let stats = [];
-    try {
-        const res = await fetch('/api/plugins/example-analytics/stats', {
-            headers: {'Authorization': 'Bearer ' + (S.get('auth_token') || '')}
-        });
-        if (!res.ok) throw new Error(`HTTP ${res.status}`);
-        stats = await res.json();
-    } catch {
-        E.toast('Could not load analytics data.', {type: 'error'});
-    }
-
-    T.create('#analytics-table', {
-        data: stats,
-        columns: [
-            {key: 'url', title: 'Page URL', render: (val) => `<code>${val}</code>`},
-            {key: 'hits', title: 'Page views'}
-        ],
-        emptyMessage: 'No page views recorded yet.'
-    });
-}

package/plugins/example-analytics/config.js

@@ -1,6 +0,0 @@
-/**
- * Example Analytics Plugin — Default Configuration
- */
-export default {
-    excludeAdmin: true
-};

package/plugins/example-analytics/plugin.js

@@ -1,58 +0,0 @@
-/**
- * Example Analytics Plugin — Server
- * Tracks page hits in a JSON file alongside the plugin.
- * Endpoints:
- *   POST   /api/plugins/example-analytics/hit    - public: record a hit { url }
- *   GET    /api/plugins/example-analytics/stats  - admin: return all hit counts
- *   DELETE /api/plugins/example-analytics/stats  - admin: reset all stats
- */
-import fs from 'fs/promises';
-import path from 'path';
-import {fileURLToPath} from 'url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const STATS_FILE = path.join(__dirname, 'stats.json');
-
-async function readStats() {
-    try {
-        return JSON.parse(await fs.readFile(STATS_FILE, 'utf8'));
-    } catch {
-        return {};
-    }
-}
-
-async function writeStats(stats) {
-    await fs.writeFile(STATS_FILE, JSON.stringify(stats, null, 2) + '\n', 'utf8');
-}
-
-export default async function analyticsPlugin(fastify, options) {
-    const {authenticate, requireAdmin} = options.auth;
-
-    // Record a page hit — called by the client-side injection script (public)
-    fastify.post('/hit', async (request, reply) => {
-        const {url} = request.body || {};
-        if (!url || typeof url !== 'string') {
-            return reply.status(400).send({error: 'url is required'});
-        }
-
-        const normalised = url.split('?')[0].replace(/\/$/, '') || '/';
-        const stats = await readStats();
-        stats[normalised] = (stats[normalised] || 0) + 1;
-        await writeStats(stats);
-        return {ok: true};
-    });
-
-    // Return all stats — admin only
-    fastify.get('/stats', {preHandler: [authenticate, requireAdmin]}, async () => {
-        const stats = await readStats();
-        return Object.entries(stats)
-            .map(([url, hits]) => ({url, hits}))
-            .sort((a, b) => b.hits - a.hits);
-    });
-
-    // Reset stats — admin only
-    fastify.delete('/stats', {preHandler: [authenticate, requireAdmin]}, async () => {
-        await writeStats({});
-        return {ok: true};
-    });
-}

package/plugins/example-analytics/plugin.json

@@ -1,45 +0,0 @@
-{
-  "name": "example-analytics",
-  "displayName": "Analytics",
-  "version": "1.0.0",
-  "description": "Basic page view analytics. Tracks hits per page using a simple JSON store.",
-  "author": "Darryl Waterhouse",
-  "date": "2026-03-01",
-  "icon": "chart-bar",
-  "admin": {
-    "sidebar": [
-      {
-        "id": "analytics",
-        "text": "Analytics",
-        "icon": "chart-bar",
-        "url": "#/plugins/analytics",
-        "section": "#/plugins/analytics"
-      }
-    ],
-    "routes": [
-      {
-        "path": "/plugins/analytics",
-        "view": "plugin-analytics",
-        "title": "Analytics - Domma CMS"
-      }
-    ],
-    "views": {
-      "plugin-analytics": {
-        "entry": "example-analytics/admin/views/analytics.js",
-        "exportName": "analyticsView"
-      }
-    }
-  },
-  "inject": {
-    "head": "public/inject-head.html",
-    "bodyEnd": "public/inject-body.html"
-  },
-  "scaffold": {
-    "reset": [
-      {
-        "path": "stats.json",
-        "content": "{}"
-      }
-    ]
-  }
-}

package/plugins/example-analytics/public/inject-body.html

@@ -1,14 +0,0 @@
-<!-- example-analytics: page view tracker -->
-<script>
-    (function () {
-        var url = window.location.pathname;
-        if (typeof fetch === 'function') {
-            fetch('/api/plugins/example-analytics/hit', {
-                method: 'POST',
-                headers: {'Content-Type': 'application/json'},
-                body: JSON.stringify({url: url})
-            }).catch(function () { /* silent fail */
-            });
-        }
-    })();
-</script>

package/plugins/example-analytics/public/inject-head.html

@@ -1 +0,0 @@
-<!-- example-analytics: head injection (empty — tracking is done via body script) -->

package/plugins/example-analytics/stats.json

@@ -1,24 +0,0 @@
-{
-  "/": 138,
-  "/about": 71,
-  "/blog": 30,
-  "/contact": 30,
-  "/resources/typography": 4,
-  "/resources": 13,
-  "/resources/shortcodes": 14,
-  "/resources/cards": 15,
-  "/resources/interactive": 13,
-  "/resources/grid": 6,
-  "/forms": 14,
-  "/resources/effects": 6,
-  "/blog/hello-world": 20,
-  "/feedback": 38,
-  "/resources/dependencies": 2,
-  "/resources/components": 6,
-  "/gdpr": 3,
-  "/scratch": 51,
-  "/getting-started": 3,
-  "/resources/pro": 1,
-  "/todo": 23,
-  "/thank-you": 1
-}