domma-cms 0.25.15 → 0.30.0

package/admin/js/templates/docs/api-navigation.html

@@ -0,0 +1,99 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Navigation</h1>
+  <a href="#/api-reference" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> API overview</a>
+</div>
+<style>
+    .method-badge {
+        display: inline-block;
+        font-size: 11px;
+        font-weight: 700;
+        letter-spacing: 0.5px;
+        padding: 2px 7px;
+        border-radius: 4px;
+        font-family: var(--dm-font-mono, monospace);
+        margin-right: 6px;
+        vertical-align: middle;
+    }
+
+    .method-get {
+        background: #d1fae5;
+        color: #065f46;
+    }
+
+    .method-post {
+        background: #dbeafe;
+        color: #1e40af;
+    }
+
+    .method-put {
+        background: #fef3c7;
+        color: #92400e;
+    }
+
+    .method-patch {
+        background: #ccfbf1;
+        color: #134e4a;
+    }
+
+    .method-delete {
+        background: #fee2e2;
+        color: #991b1b;
+    }
+
+    .endpoint-path {
+        font-family: var(--dm-font-mono, monospace);
+        font-size: 14px;
+    }
+
+    .auth-note {
+        font-size: 12px;
+        color: var(--dm-color-text-muted, #6b7280);
+        margin: 4px 0 12px;
+    }
+
+    .auth-note code {
+        font-size: 11px;
+    }
+
+    .docs-body h3 {
+        margin-top: 24px;
+        margin-bottom: 8px;
+    }
+
+    .docs-body h3:first-child {
+        margin-top: 0;
+    }
+</style>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/navigation</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>navigation</code> permission.</p>
+                  <p>Return the navigation configuration from <code>config/navigation.json</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{
+  "items": [
+    { "label": "Home", "url": "/" },
+    { "label": "About", "url": "/about" },
+    { "label": "Resources", "items": [ { "label": "Blog", "url": "/blog" } ] }
+  ]
+}</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/navigation</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>navigation</code> permission.</p>
+                  <p>Replace the navigation config. Sub-items must use the <code>items</code> key (the server normalises
+                      <code>children</code>
+                      to <code>items</code> automatically).</p>
+                  <pre class="code-block"><code>// Request body
+{ "items": [ { "label": "Home", "url": "/" }, { "label": "About", "url": "/about" } ] }
+
+// Response 200
+{ "success": true }</code></pre>
+
+    </div>
+  </div>
+</div>

package/admin/js/templates/docs/api-pages.html

@@ -0,0 +1,214 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Pages</h1>
+  <a href="#/api-reference" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> API overview</a>
+</div>
+<style>
+    .method-badge {
+        display: inline-block;
+        font-size: 11px;
+        font-weight: 700;
+        letter-spacing: 0.5px;
+        padding: 2px 7px;
+        border-radius: 4px;
+        font-family: var(--dm-font-mono, monospace);
+        margin-right: 6px;
+        vertical-align: middle;
+    }
+
+    .method-get {
+        background: #d1fae5;
+        color: #065f46;
+    }
+
+    .method-post {
+        background: #dbeafe;
+        color: #1e40af;
+    }
+
+    .method-put {
+        background: #fef3c7;
+        color: #92400e;
+    }
+
+    .method-patch {
+        background: #ccfbf1;
+        color: #134e4a;
+    }
+
+    .method-delete {
+        background: #fee2e2;
+        color: #991b1b;
+    }
+
+    .endpoint-path {
+        font-family: var(--dm-font-mono, monospace);
+        font-size: 14px;
+    }
+
+    .auth-note {
+        font-size: 12px;
+        color: var(--dm-color-text-muted, #6b7280);
+        margin: 4px 0 12px;
+    }
+
+    .auth-note code {
+        font-size: 11px;
+    }
+
+    .docs-body h3 {
+        margin-top: 24px;
+        margin-bottom: 8px;
+    }
+
+    .docs-body h3:first-child {
+        margin-top: 0;
+    }
+</style>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<h3><span class="method-badge method-post">POST</span><span
+                          class="endpoint-path">/api/pages/preview</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission.</p>
+                  <p>Render Markdown to HTML (shortcodes processed, no frontmatter). Useful for live editor
+                      previews.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>markdown</code></td>
+                          <td>string</td>
+                          <td>Markdown string to render</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "html": "&lt;p&gt;Hello &lt;strong&gt;world&lt;/strong&gt;&lt;/p&gt;" }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/pages/tags</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission.</p>
+                  <p>Aggregate all unique tags across every page, sorted alphabetically.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "tags": ["guide", "news", "tutorial"] }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/pages</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission.</p>
+                  <p>List all pages with their metadata. Body content is excluded.</p>
+                  <pre class="code-block"><code>// Response 200
+[
+  {
+    "urlPath": "/about",
+    "title": "About Us",
+    "slug": "about",
+    "status": "published",
+    "layout": "default",
+    "tags": [],
+    "updatedAt": "2024-01-15T10:30:00.000Z",
+    "createdAt": "2024-01-01T09:00:00.000Z"
+  }
+]</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/pages/*</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission. The <code>*</code> is the
+                      URL path,
+                      e.g. <code>/api/pages/about</code>.</p>
+                  <p>Retrieve a single page including its frontmatter and full body content.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "urlPath": "/about", "title": "About Us", "body": "## Our Story\n\nWe started...", ... }
+
+// Error 404
+{ "error": "Page not found" }</code></pre>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/pages</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission.</p>
+                  <p>Create a new page. Fails with 409 if a page already exists at the given path.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>urlPath</code></td>
+                          <td>string</td>
+                          <td>Required. Public URL path e.g. <code>/about</code></td>
+                      </tr>
+                      <tr>
+                          <td><code>frontmatter</code></td>
+                          <td>object</td>
+                          <td>YAML frontmatter fields (title, status, etc.)</td>
+                      </tr>
+                      <tr>
+                          <td><code>body</code></td>
+                          <td>string</td>
+                          <td>Markdown content</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 201 — returns the created page object</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/pages/*</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission.</p>
+                  <p>Update an existing page. Optionally rename it to a new URL path.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>frontmatter</code></td>
+                          <td>object</td>
+                          <td>Updated frontmatter fields</td>
+                      </tr>
+                      <tr>
+                          <td><code>body</code></td>
+                          <td>string</td>
+                          <td>Updated Markdown content</td>
+                      </tr>
+                      <tr>
+                          <td><code>newUrlPath</code></td>
+                          <td>string</td>
+                          <td>Optional. Rename the page to a different URL path</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200 — returns the updated page object
+
+// Error 404
+{ "error": "Page not found" }
+
+// Error 409
+{ "error": "A page already exists at that path" }</code></pre>
+
+                  <h3><span class="method-badge method-delete">DELETE</span><span
+                          class="endpoint-path">/api/pages/*</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>pages</code> permission.</p>
+                  <p>Delete a page and its source file.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }
+
+// Error 404
+{ "error": "Page not found" }</code></pre>
+
+    </div>
+  </div>
+</div>

package/admin/js/templates/docs/api-plugins.html

@@ -0,0 +1,136 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Plugins</h1>
+  <a href="#/api-reference" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> API overview</a>
+</div>
+<style>
+    .method-badge {
+        display: inline-block;
+        font-size: 11px;
+        font-weight: 700;
+        letter-spacing: 0.5px;
+        padding: 2px 7px;
+        border-radius: 4px;
+        font-family: var(--dm-font-mono, monospace);
+        margin-right: 6px;
+        vertical-align: middle;
+    }
+
+    .method-get {
+        background: #d1fae5;
+        color: #065f46;
+    }
+
+    .method-post {
+        background: #dbeafe;
+        color: #1e40af;
+    }
+
+    .method-put {
+        background: #fef3c7;
+        color: #92400e;
+    }
+
+    .method-patch {
+        background: #ccfbf1;
+        color: #134e4a;
+    }
+
+    .method-delete {
+        background: #fee2e2;
+        color: #991b1b;
+    }
+
+    .endpoint-path {
+        font-family: var(--dm-font-mono, monospace);
+        font-size: 14px;
+    }
+
+    .auth-note {
+        font-size: 12px;
+        color: var(--dm-color-text-muted, #6b7280);
+        margin: 4px 0 12px;
+    }
+
+    .auth-note code {
+        font-size: 11px;
+    }
+
+    .docs-body h3 {
+        margin-top: 24px;
+        margin-bottom: 8px;
+    }
+
+    .docs-body h3:first-child {
+        margin-top: 0;
+    }
+</style>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/plugins</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + admin role.</p>
+                  <p>List all discovered plugins with their current enabled state and settings.</p>
+                  <pre class="code-block"><code>// Response 200
+[
+  {
+    "name": "form-builder",
+    "displayName": "Form Builder",
+    "version": "1.0.0",
+    "description": "Build and manage contact forms.",
+    "author": "Domma Team",
+    "date": "2024-01-01",
+    "icon": "clipboard",
+    "enabled": true,
+    "settings": {}
+  }
+]</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span
+                          class="endpoint-path">/api/plugins/:name</span></h3>
+                  <p class="auth-note">Requires Bearer token + admin role.</p>
+                  <p>Enable or disable a plugin, or update its settings.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>enabled</code></td>
+                          <td>boolean</td>
+                          <td>Whether the plugin is active</td>
+                      </tr>
+                      <tr>
+                          <td><code>settings</code></td>
+                          <td>object</td>
+                          <td>Plugin-specific settings object</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }
+
+// Error 404
+{ "error": "Plugin not found" }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/plugins/admin-config</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token (any role).</p>
+                  <p>Return the merged admin configuration for all enabled plugins — sidebar items, SPA routes, and view
+                      entry points.</p>
+                  <pre class="code-block"><code>// Response 200
+{
+  "sidebar": [ { "id": "form-builder", "text": "Form Settings", "icon": "clipboard", "url": "#/form-settings" } ],
+  "routes": [ { "path": "/form-settings", "view": "formSettings", "title": "Form Settings - Domma CMS" } ],
+  "views": { "formSettings": { "entry": "form-builder/admin/views/settings.js", "exportName": "formSettingsView" } }
+}</code></pre>
+
+    </div>
+  </div>
+</div>

package/admin/js/templates/docs/api-settings.html

@@ -0,0 +1,148 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Settings</h1>
+  <a href="#/api-reference" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> API overview</a>
+</div>
+<style>
+    .method-badge {
+        display: inline-block;
+        font-size: 11px;
+        font-weight: 700;
+        letter-spacing: 0.5px;
+        padding: 2px 7px;
+        border-radius: 4px;
+        font-family: var(--dm-font-mono, monospace);
+        margin-right: 6px;
+        vertical-align: middle;
+    }
+
+    .method-get {
+        background: #d1fae5;
+        color: #065f46;
+    }
+
+    .method-post {
+        background: #dbeafe;
+        color: #1e40af;
+    }
+
+    .method-put {
+        background: #fef3c7;
+        color: #92400e;
+    }
+
+    .method-patch {
+        background: #ccfbf1;
+        color: #134e4a;
+    }
+
+    .method-delete {
+        background: #fee2e2;
+        color: #991b1b;
+    }
+
+    .endpoint-path {
+        font-family: var(--dm-font-mono, monospace);
+        font-size: 14px;
+    }
+
+    .auth-note {
+        font-size: 12px;
+        color: var(--dm-color-text-muted, #6b7280);
+        margin: 4px 0 12px;
+    }
+
+    .auth-note code {
+        font-size: 11px;
+    }
+
+    .docs-body h3 {
+        margin-top: 24px;
+        margin-bottom: 8px;
+    }
+
+    .docs-body h3:first-child {
+        margin-top: 0;
+    }
+</style>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/settings</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>settings</code> permission.</p>
+                  <p>Return the full site settings object from <code>config/site.json</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "siteName": "My Site", "adminTheme": "charcoal-dark", "smtp": { ... }, ... }</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/settings</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>settings</code> permission.</p>
+                  <p>Replace the site settings object. Send the full merged object — partial updates overwrite the
+                      entire config.</p>
+                  <pre class="code-block"><code>// Request body — full site settings object
+{ "siteName": "My Site", "adminTheme": "ocean-dark", ... }
+
+// Response 200
+{ "success": true }</code></pre>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/settings/test-email</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>settings</code> permission.</p>
+                  <p>Send a test email using the stored SMTP configuration.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>to</code></td>
+                          <td>string</td>
+                          <td>Optional. Recipient address. Defaults to the configured From Address.</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true, "message": "Test email sent to alice@example.com" }
+
+// Error 400
+{ "error": "SMTP is not configured. Save your SMTP settings first." }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/settings/custom-css</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>settings</code> permission.</p>
+                  <p>Return the current custom CSS from <code>content/custom.css</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "css": "body { font-family: sans-serif; }" }</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/settings/custom-css</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>settings</code> permission.</p>
+                  <p>Write CSS to <code>content/custom.css</code>. Maximum size is 100 KB.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>css</code></td>
+                          <td>string</td>
+                          <td>CSS string (max 100 KB)</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }</code></pre>
+
+    </div>
+  </div>
+</div>