domma-cms 0.25.14 → 0.25.16

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

@@ -0,0 +1,347 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Collections</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">
+
+<p>Collections have two access planes: <strong>admin endpoints</strong> (authenticated, role-gated)
+                      and <strong>public
+                          endpoints</strong> (access level configured per collection).</p>
+
+                  <h3 style="margin-top:16px;font-size:15px;text-transform:uppercase;letter-spacing:.5px;opacity:.6">
+                      Schema Management</h3>
+
+                  <h3><span class="method-badge method-get">GET</span><span
+                          class="endpoint-path">/api/collections</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>List all collection schemas (metadata only, no entries).</p>
+                  <pre class="code-block"><code>// Response 200
+[ { "slug": "blog", "title": "Blog Posts", "description": "...", "fields": [...] } ]</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/pro-status</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Check whether the Pro (MongoDB) storage adapter is available.</p>
+                  <pre class="code-block"><code>// Response 200 (free)
+{ "pro": false, "connections": [] }
+
+// Response 200 (pro)
+{ "pro": true, "connections": ["default", "analytics"] }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/connections</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + admin role.</p>
+                  <p>Return configured MongoDB connections from <code>config/connections.json</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "default": { "type": "mongodb", "uri": "mongodb://localhost:27017", "database": "my_cms" } }</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/collections/connections</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + admin role.</p>
+                  <p>Save MongoDB connection definitions. Each connection requires <code>type</code>, <code>uri</code>,
+                      and <code>database</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }
+
+// Error 400
+{ "error": "Connection \"default\" requires type, uri, and database" }</code></pre>
+
+                  <h3><span class="method-badge method-post">POST</span><span
+                          class="endpoint-path">/api/collections</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Create a new collection. A <code>slug</code> is auto-generated from the title if not provided.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>title</code></td>
+                          <td>string</td>
+                          <td>Required. Human-readable collection name</td>
+                      </tr>
+                      <tr>
+                          <td><code>slug</code></td>
+                          <td>string</td>
+                          <td>Optional. URL-safe identifier. Auto-generated if omitted.</td>
+                      </tr>
+                      <tr>
+                          <td><code>description</code></td>
+                          <td>string</td>
+                          <td>Optional description</td>
+                      </tr>
+                      <tr>
+                          <td><code>fields</code></td>
+                          <td>array</td>
+                          <td>Field definitions</td>
+                      </tr>
+                      <tr>
+                          <td><code>api</code></td>
+                          <td>object</td>
+                          <td>Public API access config per operation</td>
+                      </tr>
+                      <tr>
+                          <td><code>storage</code></td>
+                          <td>object</td>
+                          <td>Optional Pro: <code>{ "adapter": "mongodb", "connection": "default" }</code></td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 201 — returns the created schema object
+
+// Error 409
+{ "error": "A collection with that slug already exists" }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span
+                          class="endpoint-path">/api/collections/:slug</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Return the schema for a single collection by slug.</p>
+
+                  <h3><span class="method-badge method-put">PUT</span><span
+                          class="endpoint-path">/api/collections/:slug</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Update a collection schema.</p>
+
+                  <h3><span class="method-badge method-delete">DELETE</span><span class="endpoint-path">/api/collections/:slug</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Delete a collection and all its entries. Preset collections cannot be deleted.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }
+
+// Error 403
+{ "error": "Cannot delete a preset collection" }</code></pre>
+
+                  <h3 style="margin-top:24px;font-size:15px;text-transform:uppercase;letter-spacing:.5px;opacity:.6">
+                      Admin Entry CRUD</h3>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/:slug/entries</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>List entries with pagination, sorting, and full-text search.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Query param</th>
+                          <th>Default</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>page</code></td>
+                          <td>1</td>
+                          <td>Page number</td>
+                      </tr>
+                      <tr>
+                          <td><code>limit</code></td>
+                          <td>50</td>
+                          <td>Entries per page</td>
+                      </tr>
+                      <tr>
+                          <td><code>sort</code></td>
+                          <td>createdAt</td>
+                          <td>Field to sort by</td>
+                      </tr>
+                      <tr>
+                          <td><code>order</code></td>
+                          <td>desc</td>
+                          <td><code>asc</code> or <code>desc</code></td>
+                      </tr>
+                      <tr>
+                          <td><code>search</code></td>
+                          <td>—</td>
+                          <td>Full-text search query</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "entries": [ { "id": "uuid", "data": { ... }, "createdAt": "...", "updatedAt": "..." } ], "total": 42, "page": 1, "limit": 50 }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/:slug/entries/:id</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Return a single entry by ID.</p>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/collections/:slug/entries</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Create a new entry. Data is validated against the collection schema.</p>
+                  <pre class="code-block"><code>// Response 201 — returns the created entry</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/collections/:slug/entries/:id</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Update an entry. Data is validated against the schema.</p>
+
+                  <h3><span class="method-badge method-delete">DELETE</span><span class="endpoint-path">/api/collections/:slug/entries/:id</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Delete a single entry.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }</code></pre>
+
+                  <h3><span class="method-badge method-delete">DELETE</span><span class="endpoint-path">/api/collections/:slug/entries</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Clear all entries from a collection. Irreversible.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }</code></pre>
+
+                  <h3 style="margin-top:24px;font-size:15px;text-transform:uppercase;letter-spacing:.5px;opacity:.6">
+                      Export &amp; Import</h3>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/:slug/export</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Download all entries as a file attachment.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Query param</th>
+                          <th>Values</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>format</code></td>
+                          <td><code>json</code> (default), <code>csv</code></td>
+                          <td>Export format</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200 — file download
+// Content-Disposition: attachment; filename="blog-entries.json"</code></pre>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/collections/:slug/import</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>collections</code> permission.</p>
+                  <p>Bulk-import entries from a JSON array. Existing entries are not removed.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>entries</code></td>
+                          <td>array</td>
+                          <td>Array of entry objects with a <code>data</code> field each</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Request body
+{ "entries": [ { "data": { "title": "Post 1" } }, { "data": { "title": "Post 2" } } ] }
+
+// Response 201
+{ "imported": 2, "skipped": 0 }</code></pre>
+
+                  <h3 style="margin-top:24px;font-size:15px;text-transform:uppercase;letter-spacing:.5px;opacity:.6">
+                      Public Access</h3>
+
+                  <p>Public endpoints respect the per-collection <code>api</code> config. Each operation can be <strong>disabled</strong>,
+                      <strong>public</strong> (no auth), or restricted to a minimum role level.</p>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/:slug/public</span>
+                  </h3>
+                  <p class="auth-note">Access level: per collection <code>api.read</code> config.</p>
+                  <p>List entries publicly. Supports the same pagination and search query params as the admin
+                      endpoint.</p>
+
+                  <h3><span class="method-badge method-get">GET</span><span class="endpoint-path">/api/collections/:slug/public/:id</span>
+                  </h3>
+                  <p class="auth-note">Access level: per collection <code>api.read</code> config.</p>
+                  <p>Return a single entry publicly by ID.</p>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/collections/:slug/public</span>
+                  </h3>
+                  <p class="auth-note">Access level: per collection <code>api.create</code> config.</p>
+                  <p>Create an entry publicly (e.g. form submissions). Entry is tagged with <code>source: "api"</code>.
+                  </p>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/collections/:slug/public/:id</span>
+                  </h3>
+                  <p class="auth-note">Access level: per collection <code>api.update</code> config.</p>
+                  <p>Update an entry publicly.</p>
+
+                  <h3><span class="method-badge method-delete">DELETE</span><span class="endpoint-path">/api/collections/:slug/public/:id</span>
+                  </h3>
+                  <p class="auth-note">Access level: per collection <code>api.delete</code> config.</p>
+                  <p>Delete an entry publicly.</p>
+
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,123 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Layouts</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/layouts</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>layouts</code> permission.</p>
+                  <p>Return all layout presets from <code>config/presets.json</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{
+  "default": { "label": "Default", "sections": [...] },
+  "full-width": { "label": "Full Width", "sections": [...] }
+}</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span class="endpoint-path">/api/layouts</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>layouts</code> permission.</p>
+                  <p>Replace the entire layout presets object.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span
+                          class="endpoint-path">/api/layouts/options</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>layouts</code> permission.</p>
+                  <p>Return layout display options stored in <code>config/site.json</code> under
+                      <code>layoutOptions</code>.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "spacerSize": 8 }</code></pre>
+
+                  <h3><span class="method-badge method-put">PUT</span><span
+                          class="endpoint-path">/api/layouts/options</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>layouts</code> permission.</p>
+                  <p>Merge layout option updates into the existing options. Existing keys not included are
+                      preserved.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>spacerSize</code></td>
+                          <td>number</td>
+                          <td>Default spacer block size in pixels</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }</code></pre>
+
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,158 @@
+<div class="view-header">
+  <h1><span data-icon="code"></span> API · Media</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/media</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>media</code> permission.</p>
+                  <p>List all media files in the uploads directory.</p>
+                  <pre class="code-block"><code>// Response 200
+[ { "name": "hero.jpg", "url": "/media/hero.jpg", "size": 204800, "mime": "image/jpeg" } ]</code></pre>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/media</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>media</code> permission. Content-Type: <code>multipart/form-data</code>.
+                  </p>
+                  <p>Upload one or more files. Returns a single object for one file, or an array for multiple.</p>
+                  <pre class="code-block"><code>// Response 201 (single)
+{ "name": "photo.jpg", "url": "/media/photo.jpg", "size": 98304, "mime": "image/jpeg" }</code></pre>
+
+                  <h3><span class="method-badge method-patch">PATCH</span><span
+                          class="endpoint-path">/api/media/:name</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>media</code> permission.</p>
+                  <p>Rename a media file. Fails with 409 if the new name already exists.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>newName</code></td>
+                          <td>string</td>
+                          <td>New filename (will be sanitised)</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Response 200
+{ "name": "new-photo.jpg", "url": "/media/new-photo.jpg", ... }</code></pre>
+
+                  <h3><span class="method-badge method-delete">DELETE</span><span
+                          class="endpoint-path">/api/media/:name</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>media</code> permission.</p>
+                  <p>Delete a media file from the uploads directory.</p>
+                  <pre class="code-block"><code>// Response 200
+{ "success": true }</code></pre>
+
+                  <h3><span class="method-badge method-get">GET</span><span
+                          class="endpoint-path">/api/media/:name/info</span></h3>
+                  <p class="auth-note">Requires Bearer token + <code>media</code> permission.</p>
+                  <p>Return image metadata (dimensions, format, file size) for editable image formats (JPEG, PNG, WebP,
+                      GIF, TIFF).</p>
+                  <pre class="code-block"><code>// Response 200
+{ "width": 1920, "height": 1080, "format": "jpeg", "size": 204800 }</code></pre>
+
+                  <h3><span class="method-badge method-post">POST</span><span class="endpoint-path">/api/media/:name/transform</span>
+                  </h3>
+                  <p class="auth-note">Requires Bearer token + <code>media</code> permission.</p>
+                  <p>Apply image transformations (resize, crop, rotate, watermark, etc.) and optionally save to a new
+                      filename.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Type</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>operations</code></td>
+                          <td>object</td>
+                          <td>Transformation operations to apply</td>
+                      </tr>
+                      <tr>
+                          <td><code>saveAs</code></td>
+                          <td>string</td>
+                          <td>Optional. Output filename. Defaults to overwriting the source.</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <pre class="code-block"><code>// Request body
+{ "operations": { "resize": { "width": 800, "height": 600 }, "format": "webp" }, "saveAs": "hero-800.webp" }
+
+// Response 200
+{ "name": "hero-800.webp", "url": "/media/hero-800.webp", ... }</code></pre>
+
+    </div>
+  </div>
+</div>