domma-cms 0.25.15 → 0.25.16

package/admin/js/views/api-reference.js

@@ -1 +1 @@
-export const apiReferenceView={templateUrl:"/admin/js/templates/api-reference.html",async onMount(e){E.tabs(e.find("#api-tabs").get(0)),Domma.icons.scan(),Domma.syntax.scan()}};
+export const apiReferenceView={templateUrl:"/admin/js/templates/api-reference.html",async onMount(){Domma.icons.scan(),Domma.syntax.scan()}};

package/admin/js/views/doc-pages.js

@@ -0,0 +1 @@
+import{mountScaffolder as i}from"../lib/crud-tutorial.js";function t(o,n){return{templateUrl:`/admin/js/templates/docs/${o}.html`,async onMount(e){typeof n=="function"&&n(e),Domma.icons.scan(),Domma.syntax.scan()}}}export const docViews={tutorialCrud:t("tutorial-crud",o=>{const n=o.find("#tutorial-scaffolder-mount").get(0);n&&i(n,null,null)}),tutorialPlugin:t("tutorial-plugin"),tutorialForms:t("tutorial-forms"),componentsReference:t("components-reference"),componentsHowto:t("components-howto"),componentsWalkthrough:t("components-walkthrough"),componentsRules:t("components-rules")};const a=["pages","media","navigation","dconfig","shortcodes","site-settings","plugins","users-roles","views","actions","cta-shortcode"],c=["authentication","pages","settings","layouts","navigation","media","users","plugins","collections","views","actions"],s=o=>o.split("-").map(n=>n.charAt(0).toUpperCase()+n.slice(1)).join("");for(const o of a)docViews["usage"+s(o)]=t(`usage-${o}`);for(const o of c)docViews["apiRef"+s(o)]=t(`api-${o}`);

package/admin/js/views/documentation.js

@@ -1 +1 @@
-export const documentationView={templateUrl:"/admin/js/templates/documentation.html",async onMount(t){E.tabs(t.find("#docs-tabs").get(0)),Domma.icons.scan(),Domma.syntax.scan()}};
+export const documentationView={templateUrl:"/admin/js/templates/documentation.html",async onMount(){Domma.icons.scan(),Domma.syntax.scan()}};

package/admin/js/views/index.js

@@ -1 +1 @@
-import{dashboardView as o}from"./dashboard.js";import{pagesView as i}from"./pages.js";import{pageEditorView as r}from"./page-editor.js";import{settingsView as t}from"./settings.js";import{navigationView as e}from"./navigation.js";import{notificationsView as m}from"./notifications.js";import{layoutsView as p}from"./layouts.js";import{mediaView as s}from"./media.js";import{loginView as n}from"./login.js";import{usersView as f}from"./users.js";import{userEditorView as w}from"./user-editor.js";import{pluginsView as c}from"./plugins.js";import{documentationView as V}from"./documentation.js";import{tutorialsView as a}from"./tutorials.js";import{apiReferenceView as d}from"./api-reference.js";import{collectionsView as l}from"./collections.js";import{collectionEditorView as E}from"./collection-editor.js";import{collectionEntriesView as u}from"./collection-entries.js";import{formsView as g}from"./forms.js";import{formEditorView as v}from"./form-editor.js";import{formSubmissionsView as b}from"./form-submissions.js";import{viewsListView as j}from"./views-list.js";import{viewEditorView as k}from"./view-editor.js";import{viewPreviewView as L}from"./view-preview.js";import{actionsListView as y}from"./actions-list.js";import{actionEditorView as h}from"./action-editor.js";import{proDocsView as D}from"./pro-docs.js";import{blocksView as P}from"./blocks.js";import{blockEditorView as R}from"./block-editor.js";import"./block-editor-enhance.js";import{componentsView as S}from"./components.js";import{componentEditorView as T}from"./component-editor.js";import{myProfileView as x}from"./my-profile.js";import{rolesView as M}from"./roles.js";import{roleEditorView as U}from"./role-editor.js";import{effectsView as q}from"./effects.js";import{menusView as z}from"./menus.js";import{menuEditorView as A}from"./menu-editor.js";import{menuLocationsView as B}from"./menu-locations.js";import{projectsView as C}from"./projects.js";import{projectEditorView as F}from"./project-editor.js";import{projectDetailView as G}from"./project-detail.js";import{projectSettingsView as H}from"./project-settings.js";import{apiTokensView as I}from"./api-tokens.js";import{apiEndpointsView as J}from"./api-endpoints.js";import{apiEndpointEditorView as K}from"./api-endpoint-editor.js";const N={templateUrl:"",async onMount(){location.hash="#/menus"}};export const views={projects:C,projectEditor:F,projectDetail:G,projectSettings:H,apiTokens:I,apiEndpoints:J,apiEndpointEditor:K,dashboard:o,pages:i,pageEditor:r,settings:t,navigation:e,layouts:p,media:s,login:n,users:f,userEditor:w,plugins:c,documentation:V,tutorials:a,apiReference:d,collections:l,collectionEditor:E,collectionEntries:u,forms:g,formEditor:v,formSubmissions:b,viewsList:j,viewEditor:k,viewPreview:L,actionsList:y,actionEditor:h,proDocs:D,blocks:P,blockEditor:R,components:S,componentEditor:T,myProfile:x,roles:M,roleEditor:U,effects:q,notifications:m,menus:z,menuEditor:A,menuLocations:B,menusRedirect:N};
+import{dashboardView as o}from"./dashboard.js";import{pagesView as i}from"./pages.js";import{pageEditorView as r}from"./page-editor.js";import{settingsView as t}from"./settings.js";import{navigationView as e}from"./navigation.js";import{notificationsView as m}from"./notifications.js";import{layoutsView as p}from"./layouts.js";import{mediaView as s}from"./media.js";import{loginView as n}from"./login.js";import{usersView as f}from"./users.js";import{userEditorView as w}from"./user-editor.js";import{pluginsView as c}from"./plugins.js";import{documentationView as V}from"./documentation.js";import{tutorialsView as a}from"./tutorials.js";import{docViews as d}from"./doc-pages.js";import{apiReferenceView as l}from"./api-reference.js";import{collectionsView as E}from"./collections.js";import{collectionEditorView as u}from"./collection-editor.js";import{collectionEntriesView as g}from"./collection-entries.js";import{formsView as v}from"./forms.js";import{formEditorView as b}from"./form-editor.js";import{formSubmissionsView as j}from"./form-submissions.js";import{viewsListView as k}from"./views-list.js";import{viewEditorView as L}from"./view-editor.js";import{viewPreviewView as y}from"./view-preview.js";import{actionsListView as h}from"./actions-list.js";import{actionEditorView as D}from"./action-editor.js";import{proDocsView as P}from"./pro-docs.js";import{blocksView as R}from"./blocks.js";import{blockEditorView as S}from"./block-editor.js";import"./block-editor-enhance.js";import{componentsView as T}from"./components.js";import{componentEditorView as x}from"./component-editor.js";import{myProfileView as M}from"./my-profile.js";import{rolesView as U}from"./roles.js";import{roleEditorView as q}from"./role-editor.js";import{effectsView as z}from"./effects.js";import{menusView as A}from"./menus.js";import{menuEditorView as B}from"./menu-editor.js";import{menuLocationsView as C}from"./menu-locations.js";import{projectsView as F}from"./projects.js";import{projectEditorView as G}from"./project-editor.js";import{projectDetailView as H}from"./project-detail.js";import{projectSettingsView as I}from"./project-settings.js";import{apiTokensView as J}from"./api-tokens.js";import{apiEndpointsView as K}from"./api-endpoints.js";import{apiEndpointEditorView as N}from"./api-endpoint-editor.js";const O={templateUrl:"",async onMount(){location.hash="#/menus"}};export const views={projects:F,projectEditor:G,projectDetail:H,projectSettings:I,apiTokens:J,apiEndpoints:K,apiEndpointEditor:N,dashboard:o,pages:i,pageEditor:r,settings:t,navigation:e,layouts:p,media:s,login:n,users:f,userEditor:w,plugins:c,documentation:V,tutorials:a,apiReference:l,collections:E,collectionEditor:u,collectionEntries:g,forms:v,formEditor:b,formSubmissions:j,viewsList:k,viewEditor:L,viewPreview:y,actionsList:h,actionEditor:D,proDocs:P,blocks:R,blockEditor:S,components:T,componentEditor:x,myProfile:M,roles:U,roleEditor:q,effects:z,notifications:m,menus:A,menuEditor:B,menuLocations:C,menusRedirect:O,...d};

package/admin/js/views/tutorials.js

@@ -1 +1 @@
-import{mountScaffolder as a}from"../lib/crud-tutorial.js";export const tutorialsView={templateUrl:"/admin/js/templates/tutorials.html",async onMount(t){E.tabs(t.find("#tutorials-tabs").get(0));const o=t.find("#tutorial-scaffolder-mount").get(0);o&&a(o,null,null),Domma.icons.scan(),Domma.syntax.scan()}};
+export const tutorialsView={templateUrl:"/admin/js/templates/tutorials.html",async onMount(){Domma.icons.scan(),Domma.syntax.scan()}};

package/config/menus/admin-sidebar.json

@@ -165,18 +165,88 @@
       "items": [
         {
           "text": "Usage",
-          "url": "#/documentation",
-          "icon": "book"
+          "url": "",
+          "icon": "book",
+          "items": [
+            {"text": "Pages", "url": "#/docs/usage/pages", "icon": "file-text"},
+            {"text": "Media", "url": "#/docs/usage/media", "icon": "image"},
+            {"text": "Navigation", "url": "#/docs/usage/navigation", "icon": "menu"},
+            {"text": "DConfig", "url": "#/docs/usage/dconfig", "icon": "settings"},
+            {"text": "Shortcodes", "url": "#/docs/usage/shortcodes", "icon": "code"},
+            {"text": "Site Settings", "url": "#/docs/usage/site-settings", "icon": "settings"},
+            {"text": "Plugins", "url": "#/docs/usage/plugins", "icon": "package"},
+            {"text": "Users & Roles", "url": "#/docs/usage/users-roles", "icon": "users"},
+            {"text": "Views", "url": "#/docs/usage/views", "icon": "eye"},
+            {"text": "Actions", "url": "#/docs/usage/actions", "icon": "zap"},
+            {"text": "CTA Shortcode", "url": "#/docs/usage/cta-shortcode", "icon": "zap"}
+          ]
         },
         {
           "text": "Tutorials",
-          "url": "#/tutorials",
-          "icon": "document"
+          "url": "",
+          "icon": "document",
+          "items": [
+            {
+              "text": "Building a CRUD App",
+              "url": "#/tutorials/crud",
+              "icon": "database"
+            },
+            {
+              "text": "Writing a Plugin",
+              "url": "#/tutorials/plugin",
+              "icon": "package"
+            },
+            {
+              "text": "Form Follow-Up",
+              "url": "#/tutorials/forms",
+              "icon": "layout"
+            }
+          ]
+        },
+        {
+          "text": "Components",
+          "url": "",
+          "icon": "component",
+          "items": [
+            {
+              "text": "Reference",
+              "url": "#/docs/components",
+              "icon": "book"
+            },
+            {
+              "text": "How-To",
+              "url": "#/docs/components-howto",
+              "icon": "zap"
+            },
+            {
+              "text": "Walkthrough",
+              "url": "#/docs/components-walkthrough",
+              "icon": "document"
+            },
+            {
+              "text": "Rules",
+              "url": "#/docs/components-rules",
+              "icon": "shield"
+            }
+          ]
         },
         {
           "text": "API Reference",
-          "url": "#/api-reference",
-          "icon": "code"
+          "url": "",
+          "icon": "code",
+          "items": [
+            {"text": "Authentication", "url": "#/docs/api/authentication", "icon": "shield"},
+            {"text": "Pages", "url": "#/docs/api/pages", "icon": "file-text"},
+            {"text": "Settings", "url": "#/docs/api/settings", "icon": "settings"},
+            {"text": "Layouts", "url": "#/docs/api/layouts", "icon": "layout"},
+            {"text": "Navigation", "url": "#/docs/api/navigation", "icon": "menu"},
+            {"text": "Media", "url": "#/docs/api/media", "icon": "image"},
+            {"text": "Users", "url": "#/docs/api/users", "icon": "users"},
+            {"text": "Plugins", "url": "#/docs/api/plugins", "icon": "package"},
+            {"text": "Collections", "url": "#/docs/api/collections", "icon": "database"},
+            {"text": "Views API", "url": "#/docs/api/views", "icon": "eye"},
+            {"text": "Actions API", "url": "#/docs/api/actions", "icon": "zap"}
+          ]
         }
       ]
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "domma-cms",
-  "version": "0.25.15",
+  "version": "0.25.16",
   "description": "File-based CMS powered by Domma and Fastify. Run npx domma-cms my-site to create a new project.",
   "type": "module",
   "main": "server/server.js",

package/server/server.js

@@ -202,7 +202,7 @@ try {
 }
 
 try {
-    const {runMigration: runSidebarMigration, ensureSidebarItem} = await import('./services/sidebar-migration.js');
+    const {runMigration: runSidebarMigration, ensureSidebarItem, ensureDocumentationSubmenus} = await import('./services/sidebar-migration.js');
     await runSidebarMigration();
     // Surface admin pages added after first boot on existing installs.
     await ensureSidebarItem({
@@ -213,6 +213,8 @@ try {
         groupText: 'Data',
         item: {text: 'API Builder', url: '#/api-endpoints', icon: 'code', permission: 'api-endpoints'}
     });
+    // Restructure Documentation: Tutorials → submenu, add Components reference set.
+    await ensureDocumentationSubmenus();
 } catch (err) {
     app.log.warn(`[admin-sidebar] Migration skipped: ${err.message}`);
 }

package/server/services/sidebar-migration.js

@@ -63,13 +63,80 @@ const SEED_ITEMS = [
     {
         text: 'Documentation', icon: 'book',
         items: [
-            {text: 'Usage',         url: '#/documentation',  icon: 'book'},
-            {text: 'Tutorials',     url: '#/tutorials',      icon: 'document'},
-            {text: 'API Reference', url: '#/api-reference',  icon: 'code'}
+            DOC_USAGE_SUBMENU(),
+            DOC_TUTORIALS_SUBMENU(),
+            DOC_COMPONENTS_SUBMENU(),
+            DOC_API_SUBMENU()
         ]
     }
 ];
 
+// ─── Documentation sub-trees ──────────────────────────────────────────────
+// Defined as factory functions so the seed and the migration each get their
+// own fresh object (never a shared reference). Used by both SEED_ITEMS (fresh
+// installs) and ensureDocumentationSubmenus() (existing installs).
+
+function DOC_USAGE_SUBMENU() {
+    return {
+        text: 'Usage', icon: 'book',
+        items: [
+            {text: 'Pages',         url: '#/docs/usage/pages',         icon: 'file-text'},
+            {text: 'Media',         url: '#/docs/usage/media',         icon: 'image'},
+            {text: 'Navigation',    url: '#/docs/usage/navigation',    icon: 'menu'},
+            {text: 'DConfig',       url: '#/docs/usage/dconfig',       icon: 'settings'},
+            {text: 'Shortcodes',    url: '#/docs/usage/shortcodes',    icon: 'code'},
+            {text: 'Site Settings', url: '#/docs/usage/site-settings', icon: 'settings'},
+            {text: 'Plugins',       url: '#/docs/usage/plugins',       icon: 'package'},
+            {text: 'Users & Roles', url: '#/docs/usage/users-roles',   icon: 'users'},
+            {text: 'Views',         url: '#/docs/usage/views',         icon: 'eye'},
+            {text: 'Actions',       url: '#/docs/usage/actions',       icon: 'zap'},
+            {text: 'CTA Shortcode', url: '#/docs/usage/cta-shortcode', icon: 'zap'}
+        ]
+    };
+}
+
+function DOC_TUTORIALS_SUBMENU() {
+    return {
+        text: 'Tutorials', icon: 'document',
+        items: [
+            {text: 'Building a CRUD App', url: '#/tutorials/crud',   icon: 'database'},
+            {text: 'Writing a Plugin',    url: '#/tutorials/plugin', icon: 'package'},
+            {text: 'Form Follow-Up',      url: '#/tutorials/forms',  icon: 'layout'}
+        ]
+    };
+}
+
+function DOC_COMPONENTS_SUBMENU() {
+    return {
+        text: 'Components', icon: 'component',
+        items: [
+            {text: 'Reference',   url: '#/docs/components',             icon: 'book'},
+            {text: 'How-To',      url: '#/docs/components-howto',       icon: 'zap'},
+            {text: 'Walkthrough', url: '#/docs/components-walkthrough', icon: 'document'},
+            {text: 'Rules',       url: '#/docs/components-rules',       icon: 'shield'}
+        ]
+    };
+}
+
+function DOC_API_SUBMENU() {
+    return {
+        text: 'API Reference', icon: 'code',
+        items: [
+            {text: 'Authentication', url: '#/docs/api/authentication', icon: 'shield'},
+            {text: 'Pages',          url: '#/docs/api/pages',          icon: 'file-text'},
+            {text: 'Settings',       url: '#/docs/api/settings',       icon: 'settings'},
+            {text: 'Layouts',        url: '#/docs/api/layouts',        icon: 'layout'},
+            {text: 'Navigation',     url: '#/docs/api/navigation',     icon: 'menu'},
+            {text: 'Media',          url: '#/docs/api/media',          icon: 'image'},
+            {text: 'Users',          url: '#/docs/api/users',          icon: 'users'},
+            {text: 'Plugins',        url: '#/docs/api/plugins',        icon: 'package'},
+            {text: 'Collections',    url: '#/docs/api/collections',    icon: 'database'},
+            {text: 'Views API',      url: '#/docs/api/views',          icon: 'eye'},
+            {text: 'Actions API',    url: '#/docs/api/actions',        icon: 'zap'}
+        ]
+    };
+}
+
 async function exists(p) {
     try { await fs.access(p); return true; } catch { return false; }
 }
@@ -160,3 +227,78 @@ export async function ensureSidebarItem({groupText, item}, opts = {}) {
     console.log(`[admin-sidebar] Added "${item.text}" to the ${groupText} group`);
     return {ensured: true};
 }
+
+/**
+ * Upgrade EXISTING installs so the Documentation group's one-page docs become
+ * per-topic submenus. Idempotent and non-clobbering:
+ *
+ *  - If the persisted menu has no "Documentation" group, do nothing (the admin
+ *    may have removed it deliberately — don't resurrect it).
+ *  - Convert each flat leaf — "Usage" (`#/documentation`), "Tutorials"
+ *    (`#/tutorials`) and "API Reference" (`#/api-reference`) — into its
+ *    submenu, replacing the node in place so its position is preserved. A leaf
+ *    that the admin already turned into a parent, or whose new pages already
+ *    appear anywhere in the group, is left untouched.
+ *  - Add the Components submenu only if `#/docs/components` isn't present yet —
+ *    inserted before "API Reference" when that node exists.
+ *
+ * Returns `{updated: boolean, reason?: string}`.
+ *
+ * @param {{configDir?: string}} [opts]
+ */
+export async function ensureDocumentationSubmenus(opts = {}) {
+    const configDir = opts.configDir || DEFAULT_CONFIG_DIR;
+    const menuPath  = path.join(configDir, 'menus', 'admin-sidebar.json');
+
+    if (!await exists(menuPath)) {
+        return {updated: false, reason: 'admin-sidebar.json not present'};
+    }
+
+    const menu  = await readJson(menuPath);
+    const items = Array.isArray(menu.items) ? menu.items : [];
+    const docGroup = items.find(n => typeof n?.text === 'string' && n.text.toLowerCase() === 'documentation');
+    if (!docGroup || !Array.isArray(docGroup.items)) {
+        return {updated: false, reason: 'no Documentation group'};
+    }
+
+    const hasUrl = (nodes, url) => Array.isArray(nodes) &&
+        nodes.some(n => n?.url === url || hasUrl(n?.items, url));
+    const findByText = (text) => docGroup.items.findIndex(n =>
+        typeof n?.text === 'string' && n.text.toLowerCase() === text.toLowerCase());
+
+    let changed = false;
+
+    // Leaf → submenu conversions. `guardUrl` is a page from the submenu: if it's
+    // already present anywhere we've migrated before and skip.
+    const CONVERSIONS = [
+        {text: 'Usage',         guardUrl: '#/docs/usage/pages',         build: DOC_USAGE_SUBMENU},
+        {text: 'Tutorials',     guardUrl: '#/tutorials/crud',           build: DOC_TUTORIALS_SUBMENU},
+        {text: 'API Reference', guardUrl: '#/docs/api/authentication',  build: DOC_API_SUBMENU}
+    ];
+    for (const {text, guardUrl, build} of CONVERSIONS) {
+        if (hasUrl(docGroup.items, guardUrl)) continue;
+        const idx = findByText(text);
+        if (idx === -1) continue;
+        const node = docGroup.items[idx];
+        const alreadyParent = Array.isArray(node.items) && node.items.length > 0;
+        if (alreadyParent) continue;
+        docGroup.items[idx] = build();
+        changed = true;
+    }
+
+    // Components submenu — add if absent, before API Reference.
+    if (!hasUrl(docGroup.items, '#/docs/components')) {
+        const apiIdx = findByText('API Reference');
+        const node = DOC_COMPONENTS_SUBMENU();
+        if (apiIdx !== -1) docGroup.items.splice(apiIdx, 0, node);
+        else docGroup.items.push(node);
+        changed = true;
+    }
+
+    if (!changed) return {updated: false, reason: 'already up to date'};
+
+    menu.meta = {...(menu.meta || {}), updatedAt: new Date().toISOString()};
+    await writeJson(menuPath, menu);
+    console.log('[admin-sidebar] Upgraded Documentation group with per-topic submenus');
+    return {updated: true};
+}