domma-cms 0.10.0 → 0.13.0

package/server/services/permissionRegistry.js

@@ -1,173 +1,245 @@
-/**
- * Permission Registry
- * Single source of truth for all resource/action definitions in the CMS.
- * Adding a new resource or custom action is a one-file change here.
- */
-
-/** @type {ReadonlyArray<{key:string,label:string,description:string,icon:string,group:string,actions:{key:string,label:string,description:string}[]}>} */
-export const REGISTRY = Object.freeze([
-    {
-        key: 'pages',
-        label: 'Pages',
-        description: 'Manage site pages and their content.',
-        icon: 'file-text',
-        group: 'Content',
-        actions: [
-            {key: 'read', label: 'View', description: 'View pages and their content'},
-            {key: 'create', label: 'Create', description: 'Create new pages'},
-            {key: 'update', label: 'Edit', description: 'Edit existing pages'},
-            {key: 'delete', label: 'Delete', description: 'Delete pages'}
-        ]
-    },
-    {
-        key: 'media',
-        label: 'Media',
-        description: 'Upload and manage media files.',
-        icon: 'image',
-        group: 'Content',
-        actions: [
-            {key: 'read', label: 'View', description: 'View media library'},
-            {key: 'create', label: 'Upload', description: 'Upload new files'},
-            {key: 'update', label: 'Edit', description: 'Rename or update file metadata'},
-            {key: 'delete', label: 'Delete', description: 'Delete media files'}
-        ]
-    },
-    {
-        key: 'blocks',
-        label: 'Blocks',
-        description: 'Manage reusable content blocks.',
-        icon: 'box',
-        group: 'Content',
-        actions: [
-            {key: 'read', label: 'View', description: 'View content blocks'},
-            {key: 'create', label: 'Create', description: 'Create new blocks'},
-            {key: 'update', label: 'Edit', description: 'Edit existing blocks'},
-            {key: 'delete', label: 'Delete', description: 'Delete blocks'}
-        ]
-    },
-    {
-        key: 'navigation',
-        label: 'Navigation',
-        description: 'Configure site navigation menus.',
-        icon: 'menu',
-        group: 'Structure',
-        actions: [
-            {key: 'read', label: 'View', description: 'View navigation menus'},
-            {key: 'create', label: 'Create', description: 'Create new menu items'},
-            {key: 'update', label: 'Edit', description: 'Edit navigation structure'},
-            {key: 'delete', label: 'Delete', description: 'Remove menu items'}
-        ]
-    },
-    {
-        key: 'layouts',
-        label: 'Layouts',
-        description: 'Manage page layouts and templates.',
-        icon: 'layout',
-        group: 'Structure',
-        actions: [
-            {key: 'read', label: 'View', description: 'View layouts'},
-            {key: 'create', label: 'Create', description: 'Create new layouts'},
-            {key: 'update', label: 'Edit', description: 'Edit layouts'},
-            {key: 'delete', label: 'Delete', description: 'Delete layouts'}
-        ]
-    },
-    {
-        key: 'collections',
-        label: 'Collections',
-        description: 'Manage data collections and entries.',
-        icon: 'database',
-        group: 'Data',
-        actions: [
-            {key: 'read', label: 'View', description: 'View collection entries'},
-            {key: 'create', label: 'Create', description: 'Create new entries'},
-            {key: 'update', label: 'Edit', description: 'Edit existing entries'},
-            {key: 'delete', label: 'Delete', description: 'Delete entries'}
-        ]
-    },
-    {
-        key: 'views',
-        label: 'Views',
-        description: 'Create and manage data views.',
-        icon: 'eye',
-        group: 'Data',
-        actions: [
-            {key: 'read', label: 'View', description: 'View data views'},
-            {key: 'create', label: 'Create', description: 'Create new views'},
-            {key: 'update', label: 'Edit', description: 'Edit views'},
-            {key: 'delete', label: 'Delete', description: 'Delete views'}
-        ]
-    },
-    {
-        key: 'actions',
-        label: 'Actions',
-        description: 'Configure automated actions.',
-        icon: 'zap',
-        group: 'Data',
-        actions: [
-            {key: 'read', label: 'View', description: 'View automated actions'},
-            {key: 'create', label: 'Create', description: 'Create new actions'},
-            {key: 'update', label: 'Edit', description: 'Edit actions'},
-            {key: 'delete', label: 'Delete', description: 'Delete actions'}
-        ]
-    },
-    {
-        key: 'users',
-        label: 'Users',
-        description: 'Manage user accounts.',
-        icon: 'users',
-        group: 'Configuration',
-        actions: [
-            {key: 'read', label: 'View', description: 'View user accounts'},
-            {key: 'create', label: 'Create', description: 'Create new users'},
-            {key: 'update', label: 'Edit', description: 'Edit user accounts'},
-            {key: 'delete', label: 'Delete', description: 'Delete users'}
-        ]
-    },
-    {
-        key: 'settings',
-        label: 'Settings',
-        description: 'Configure site settings.',
-        icon: 'settings',
-        group: 'Configuration',
-        actions: [
-            {key: 'read', label: 'View', description: 'View site settings'},
-            {key: 'create', label: 'Create', description: 'Add new settings'},
-            {key: 'update', label: 'Edit', description: 'Modify settings'},
-            {key: 'delete', label: 'Delete', description: 'Remove settings'}
-        ]
-    },
-    {
-        key: 'plugins',
-        label: 'Plugins',
-        description: 'Manage CMS plugins.',
-        icon: 'package',
-        group: 'Configuration',
-        actions: [
-            {key: 'read', label: 'View', description: 'View installed plugins'},
-            {key: 'create', label: 'Install', description: 'Install new plugins'},
-            {key: 'update', label: 'Configure', description: 'Configure plugin settings'},
-            {key: 'delete', label: 'Remove', description: 'Remove plugins'}
-        ]
-    }
-]);
-
-/** Derived array of resource key strings — mirrors the old RESOURCES constant. */
-export const RESOURCES = REGISTRY.map(r => r.key);
-
-/** Default CRUD action keys — mirrors the old ACTIONS constant. */
-export const ACTIONS = ['read', 'create', 'update', 'delete'];
-
-/** Display order for permission groups. */
-export const GROUP_ORDER = ['Content', 'Structure', 'Data', 'Configuration'];
-
-/**
- * Return the action keys defined for a given resource.
- * Falls back to the default CRUD set if the resource is not in the registry.
- *
- * @param {string} resourceKey
- * @returns {string[]}
- */
-export function getActionsForResource(resourceKey) {
-    const resource = REGISTRY.find(r => r.key === resourceKey);
-    return resource ? resource.actions.map(a => a.key) : [...ACTIONS];
-}
+/**
+ * Permission Registry
+ * Single source of truth for all resource/action definitions in the CMS.
+ * Adding a new resource or custom action is a one-file change here.
+ *
+ * Plugin-contributed resources live in _pluginContributed and are merged at
+ * call time via getEffectiveRegistry(). The base REGISTRY is never mutated.
+ */
+
+/** @type {Array<{key:string,label:string,description:string,icon:string,group:string,plugin?:string,actions:{key:string,label:string,description:string}[]}>} */
+export const REGISTRY = [
+    {
+        key: 'pages',
+        label: 'Pages',
+        description: 'Manage site pages and their content.',
+        icon: 'file-text',
+        group: 'Content',
+        actions: [
+            {key: 'read', label: 'View', description: 'View pages and their content'},
+            {key: 'create', label: 'Create', description: 'Create new pages'},
+            {key: 'update', label: 'Edit', description: 'Edit existing pages'},
+            {key: 'delete', label: 'Delete', description: 'Delete pages'}
+        ]
+    },
+    {
+        key: 'media',
+        label: 'Media',
+        description: 'Upload and manage media files.',
+        icon: 'image',
+        group: 'Content',
+        actions: [
+            {key: 'read', label: 'View', description: 'View media library'},
+            {key: 'create', label: 'Upload', description: 'Upload new files'},
+            {key: 'update', label: 'Edit', description: 'Rename or update file metadata'},
+            {key: 'delete', label: 'Delete', description: 'Delete media files'}
+        ]
+    },
+    {
+        key: 'blocks',
+        label: 'Blocks',
+        description: 'Manage reusable content blocks.',
+        icon: 'box',
+        group: 'Content',
+        actions: [
+            {key: 'read', label: 'View', description: 'View content blocks'},
+            {key: 'create', label: 'Create', description: 'Create new blocks'},
+            {key: 'update', label: 'Edit', description: 'Edit existing blocks'},
+            {key: 'delete', label: 'Delete', description: 'Delete blocks'}
+        ]
+    },
+    {
+        key: 'navigation',
+        label: 'Navigation',
+        description: 'Configure site navigation menus.',
+        icon: 'menu',
+        group: 'Structure',
+        actions: [
+            {key: 'read', label: 'View', description: 'View navigation menus'},
+            {key: 'create', label: 'Create', description: 'Create new menu items'},
+            {key: 'update', label: 'Edit', description: 'Edit navigation structure'},
+            {key: 'delete', label: 'Delete', description: 'Remove menu items'}
+        ]
+    },
+    {
+        key: 'layouts',
+        label: 'Layouts',
+        description: 'Manage page layouts and templates.',
+        icon: 'layout',
+        group: 'Structure',
+        actions: [
+            {key: 'read', label: 'View', description: 'View layouts'},
+            {key: 'create', label: 'Create', description: 'Create new layouts'},
+            {key: 'update', label: 'Edit', description: 'Edit layouts'},
+            {key: 'delete', label: 'Delete', description: 'Delete layouts'}
+        ]
+    },
+    {
+        key: 'collections',
+        label: 'Collections',
+        description: 'Manage data collections and entries.',
+        icon: 'database',
+        group: 'Data',
+        actions: [
+            {key: 'read', label: 'View', description: 'View collection entries'},
+            {key: 'create', label: 'Create', description: 'Create new entries'},
+            {key: 'update', label: 'Edit', description: 'Edit existing entries'},
+            {key: 'delete', label: 'Delete', description: 'Delete entries'}
+        ]
+    },
+    {
+        key: 'views',
+        label: 'Views',
+        description: 'Create and manage data views.',
+        icon: 'eye',
+        group: 'Data',
+        actions: [
+            {key: 'read', label: 'View', description: 'View data views'},
+            {key: 'create', label: 'Create', description: 'Create new views'},
+            {key: 'update', label: 'Edit', description: 'Edit views'},
+            {key: 'delete', label: 'Delete', description: 'Delete views'}
+        ]
+    },
+    {
+        key: 'actions',
+        label: 'Actions',
+        description: 'Configure automated actions.',
+        icon: 'zap',
+        group: 'Data',
+        actions: [
+            {key: 'read', label: 'View', description: 'View automated actions'},
+            {key: 'create', label: 'Create', description: 'Create new actions'},
+            {key: 'update', label: 'Edit', description: 'Edit actions'},
+            {key: 'delete', label: 'Delete', description: 'Delete actions'}
+        ]
+    },
+    {
+        key: 'users',
+        label: 'Users',
+        description: 'Manage user accounts.',
+        icon: 'users',
+        group: 'Configuration',
+        actions: [
+            {key: 'read', label: 'View', description: 'View user accounts'},
+            {key: 'create', label: 'Create', description: 'Create new users'},
+            {key: 'update', label: 'Edit', description: 'Edit user accounts'},
+            {key: 'delete', label: 'Delete', description: 'Delete users'}
+        ]
+    },
+    {
+        key: 'settings',
+        label: 'Settings',
+        description: 'Configure site settings.',
+        icon: 'settings',
+        group: 'Configuration',
+        actions: [
+            {key: 'read', label: 'View', description: 'View site settings'},
+            {key: 'create', label: 'Create', description: 'Add new settings'},
+            {key: 'update', label: 'Edit', description: 'Modify settings'},
+            {key: 'delete', label: 'Delete', description: 'Remove settings'}
+        ]
+    },
+    {
+        key: 'plugins',
+        label: 'Plugins',
+        description: 'Manage CMS plugins.',
+        icon: 'package',
+        group: 'Configuration',
+        actions: [
+            {key: 'read', label: 'View', description: 'View installed plugins'},
+            {key: 'create', label: 'Install', description: 'Install new plugins'},
+            {key: 'update', label: 'Configure', description: 'Configure plugin settings'},
+            {key: 'delete', label: 'Remove', description: 'Remove plugins'}
+        ]
+    },
+    {
+        key: 'notifications',
+        label: 'Notifications',
+        description: 'View and manage system notifications.',
+        icon: 'bell',
+        group: 'Configuration',
+        actions: [
+            {key: 'read', label: 'View', description: 'View notifications'},
+            {key: 'update', label: 'Dismiss', description: 'Mark notifications as read'},
+            {key: 'delete', label: 'Clear', description: 'Delete notifications'}
+        ]
+    }
+];
+
+/**
+ * Plugin-contributed resources registered at runtime via registerPluginResource().
+ * Cleared on teardown via unregisterPluginResourcesByPlugin().
+ *
+ * @type {Array<{key:string,label:string,description:string,icon:string,group:string,plugin:string,actions:{key:string,label:string,description:string}[]}>}
+ */
+const _pluginContributed = [];
+
+/**
+ * Register a resource contributed by a plugin.
+ * Idempotent — if the key already exists in the effective registry it is skipped.
+ *
+ * @param {{key:string,label:string,description?:string,icon?:string,group?:string,actions?:{key:string,label:string,description?:string}[]}} resource
+ * @param {string} plugin - Plugin name that owns this resource
+ */
+export function registerPluginResource(resource, plugin) {
+    const effective = getEffectiveRegistry();
+    if (effective.some(r => r.key === resource.key)) return;
+
+    _pluginContributed.push({
+        key: resource.key,
+        label: resource.label,
+        description: resource.description || `${resource.label} (${plugin} plugin)`,
+        icon: resource.icon || 'box',
+        group: resource.group || 'Plugins',
+        plugin,
+        actions: resource.actions?.map(a => ({
+            key: a.key,
+            label: a.label,
+            description: a.description || a.label
+        })) ?? ACTIONS.map(key => ({key, label: key, description: key}))
+    });
+}
+
+/**
+ * Remove all resources registered by a given plugin.
+ *
+ * @param {string} plugin - Plugin name
+ */
+export function unregisterPluginResourcesByPlugin(plugin) {
+    let i = _pluginContributed.length;
+    while (i--) {
+        if (_pluginContributed[i].plugin === plugin) {
+            _pluginContributed.splice(i, 1);
+        }
+    }
+}
+
+/**
+ * Return the combined registry: base resources + all plugin-contributed resources.
+ *
+ * @returns {typeof REGISTRY}
+ */
+export function getEffectiveRegistry() {
+    return [...REGISTRY, ..._pluginContributed];
+}
+
+/** Derived array of base resource key strings. */
+export const RESOURCES = REGISTRY.map(r => r.key);
+
+/** Default CRUD action keys. */
+export const ACTIONS = ['read', 'create', 'update', 'delete'];
+
+/** Display order for permission groups. */
+export const GROUP_ORDER = ['Content', 'Structure', 'Data', 'Configuration', 'Plugins'];
+
+/**
+ * Return the action keys defined for a given resource (base or plugin-contributed).
+ * Falls back to the default CRUD set if the resource is not found.
+ *
+ * @param {string} resourceKey
+ * @returns {string[]}
+ */
+export function getActionsForResource(resourceKey) {
+    const resource = getEffectiveRegistry().find(r => r.key === resourceKey);
+    return resource ? resource.actions.map(a => a.key) : [...ACTIONS];
+}