V0.6.2 docs openapi (#37)
All checks were successful
CI/CD / detect-changes (push) Successful in 4s
CI/CD / test-frontend (push) Successful in 6s
CI/CD / test-go-pg (push) Successful in 2m46s
CI/CD / test-sqlite (push) Successful in 2m49s
CI/CD / build-and-deploy (push) Successful in 28s

Co-authored-by: Jeffrey Smith <jasafpro@gmail.com>
Co-committed-by: Jeffrey Smith <jasafpro@gmail.com>
This commit was merged in pull request #37.
This commit is contained in:
2026-03-31 12:01:51 +00:00
committed by xcaliber
parent 1a7f41493d
commit a887b4c78b
32 changed files with 3862 additions and 548 deletions

View File

@@ -277,6 +277,15 @@ export function createDomains(restClient) {
disable: (id) => rc.put(`/api/v1/admin/surfaces/${id}/disable`, {}),
del: (id) => rc.del(`/api/v1/admin/surfaces/${id}`),
},
// v0.6.1: Backup/Restore
backup: {
create: (opts) => rc.post('/api/v1/admin/backup' + _qs(opts)),
list: () => rc.get('/api/v1/admin/backups'),
download: (name) => `/api/v1/admin/backups/${name}`,
del: (name) => rc.del(`/api/v1/admin/backups/${name}`),
restore: (file) => rc.upload('/api/v1/admin/restore', file),
},
},
// ── Users ──────────────────────────────

View File

@@ -36,7 +36,7 @@ export function UserMenu({ placement = 'down-right', onAction, extraItems }) {
// Fetch installed surfaces once on mount.
// Filter out core surfaces that have dedicated menu entries below.
const CORE_IDS = new Set(['admin', 'settings', 'team-admin', 'workflow', 'workflow-landing']);
const CORE_IDS = new Set(['admin', 'settings', 'team-admin', 'workflow', 'workflow-landing', 'docs']);
useEffect(() => {
if (!sw?.api?.surfaces?.list) return;
@@ -68,6 +68,11 @@ export function UserMenu({ placement = 'down-right', onAction, extraItems }) {
}
// ── Standard items ─────────────────────
// Docs — skip if current surface IS docs
if (current !== 'docs') {
list.push({ label: 'Docs', action: 'docs', icon: '\ud83d\udcd6' });
}
// Settings — skip if current surface IS settings
if (current !== 'settings') {
list.push({ label: 'Settings', action: 'settings', icon: '\u2699\ufe0f' });
@@ -107,6 +112,9 @@ export function UserMenu({ placement = 'down-right', onAction, extraItems }) {
location.href = BASE + '/login';
});
break;
case 'docs':
location.href = BASE + '/docs/GETTING-STARTED';
break;
case 'debug':
window.dispatchEvent(new CustomEvent('debug:toggle'));
break;

View File

@@ -0,0 +1,162 @@
/**
* Admin > System > Backup
*
* Create, download, and restore .swb backup archives.
*/
const { html } = window;
const { useState, useEffect, useCallback } = hooks;
export default function BackupSection() {
const [backups, setBackups] = useState([]);
const [loading, setLoading] = useState(true);
const [creating, setCreating] = useState(false);
const [restoring, setRestoring] = useState(false);
const load = useCallback(async () => {
try {
const resp = await sw.api.admin.backup.list();
setBackups(Array.isArray(resp) ? resp : resp.data || []);
} catch (e) { sw.toast(e.message, 'error'); }
finally { setLoading(false); }
}, []);
useEffect(() => { load(); }, []);
async function createBackup(store) {
setCreating(true);
try {
if (store) {
await sw.api.admin.backup.create({ store: 'true' });
sw.toast('Backup created', 'success');
load();
} else {
// Stream download
const url = '/api/v1/admin/backup';
const token = sw.auth.token();
const resp = await fetch(url, {
method: 'POST',
headers: { 'Authorization': 'Bearer ' + token },
});
if (!resp.ok) throw new Error('Backup failed');
const blob = await resp.blob();
const disposition = resp.headers.get('Content-Disposition') || '';
const match = disposition.match(/filename="?([^"]+)"?/);
const filename = match ? match[1] : 'backup.swb';
const a = document.createElement('a');
a.href = URL.createObjectURL(blob);
a.download = filename;
a.click();
URL.revokeObjectURL(a.href);
sw.toast('Backup downloaded', 'success');
}
} catch (e) { sw.toast(e.message, 'error'); }
finally { setCreating(false); }
}
async function downloadBackup(name) {
const token = sw.auth.token();
const resp = await fetch(sw.api.admin.backup.download(name), {
headers: { 'Authorization': 'Bearer ' + token },
});
if (!resp.ok) { sw.toast('Download failed', 'error'); return; }
const blob = await resp.blob();
const a = document.createElement('a');
a.href = URL.createObjectURL(blob);
a.download = name;
a.click();
URL.revokeObjectURL(a.href);
}
async function deleteBackup(name) {
const ok = await sw.confirm(`Delete backup "${name}"?`);
if (!ok) return;
try {
await sw.api.admin.backup.del(name);
sw.toast('Backup deleted', 'success');
load();
} catch (e) { sw.toast(e.message, 'error'); }
}
async function restoreBackup() {
const input = document.createElement('input');
input.type = 'file';
input.accept = '.swb';
input.onchange = async () => {
const file = input.files[0];
if (!file) return;
const ok = await sw.confirm(
`Restore from "${file.name}"? This will replace ALL data in the database. This action cannot be undone.`
);
if (!ok) return;
setRestoring(true);
try {
const resp = await sw.api.admin.backup.restore(file);
const d = resp.data || resp;
sw.toast(`Restored ${d.rows_restored || 0} rows`, 'success');
load();
} catch (e) { sw.toast('Restore failed: ' + e.message, 'error'); }
finally { setRestoring(false); }
};
input.click();
}
function formatBytes(b) {
if (!b) return '0 B';
if (b < 1024) return b + ' B';
if (b < 1048576) return (b / 1024).toFixed(1) + ' KB';
if (b < 1073741824) return (b / 1048576).toFixed(1) + ' MB';
return (b / 1073741824).toFixed(2) + ' GB';
}
function formatDate(d) {
if (!d) return '\u2014';
return new Date(d).toLocaleString();
}
if (loading) return html`<div class="settings-placeholder">Loading\u2026</div>`;
return html`
<div>
<div style="display:flex;gap:8px;margin-bottom:20px;flex-wrap:wrap;">
<button class="btn btn-primary" onclick=${() => createBackup(false)} disabled=${creating || restoring}>
${creating ? 'Creating\u2026' : 'Download Backup'}
</button>
<button class="btn" onclick=${() => createBackup(true)} disabled=${creating || restoring}>
${creating ? 'Creating\u2026' : 'Save to Server'}
</button>
<button class="btn btn-danger" onclick=${restoreBackup} disabled=${creating || restoring}>
${restoring ? 'Restoring\u2026' : 'Restore from File'}
</button>
</div>
<h3 style="margin:0 0 12px;">Server Backups</h3>
${backups.length === 0 ? html`
<p style="color:var(--text-secondary);">No server-side backups. Use "Save to Server" to create one.</p>
` : html`
<table class="data-table">
<thead>
<tr>
<th>Name</th>
<th>Size</th>
<th>Created</th>
<th style="width:120px;">Actions</th>
</tr>
</thead>
<tbody>
${backups.map(b => html`
<tr key=${b.name}>
<td><code>${b.name}</code></td>
<td>${formatBytes(b.size)}</td>
<td>${formatDate(b.created_at)}</td>
<td>
<button class="btn btn-sm" onclick=${() => downloadBackup(b.name)}>Download</button>
<button class="btn btn-sm btn-danger" onclick=${() => deleteBackup(b.name)} style="margin-left:4px;">Delete</button>
</td>
</tr>
`)}
</tbody>
</table>
`}
</div>
`;
}

View File

@@ -21,7 +21,7 @@ import { UserMenu } from '../../shell/user-menu.js';
const ADMIN_SECTIONS = {
people: ['users', 'teams', 'groups'],
workflows: ['workflows'],
system: ['settings', 'storage', 'packages', 'connections', 'broadcast'],
system: ['settings', 'storage', 'packages', 'connections', 'broadcast', 'backup'],
monitoring: ['audit'],
};
@@ -30,6 +30,7 @@ const ADMIN_LABELS = {
workflows: 'Workflows',
settings: 'Settings', storage: 'Storage', packages: 'Packages',
connections: 'Connections', broadcast: 'Broadcast',
backup: 'Backup',
audit: 'Audit',
};
@@ -67,6 +68,7 @@ const sectionModules = {
packages: () => import(`./packages.js${_v}`),
connections: () => import(`./connections.js${_v}`),
broadcast: () => import(`./broadcast.js${_v}`),
backup: () => import(`./backup.js${_v}`),
audit: () => import(`./audit.js${_v}`),
};

View File

@@ -0,0 +1,461 @@
/**
* DocsSurface — builtin documentation viewer (v0.6.2)
*
* Reads globals:
* __SECTION__ — active doc slug (e.g. "GETTING-STARTED")
* __BASE__ — base path
*
* Fetches markdown from GET /api/v1/docs/:name, renders with
* a simple markdown-to-HTML converter. Sidebar lists all docs.
*
* v0.6.2: dark mode fix, topbar navigation, error handling.
*/
const { html } = window;
const { useState, useEffect, useCallback, useMemo } = hooks;
const { render } = preact;
import { Topbar } from '../../shell/topbar.js';
function DocsSurface() {
const [docs, setDocs] = useState([]);
const [active, setActive] = useState(window.__SECTION__ || 'GETTING-STARTED');
const [content, setContent] = useState('');
const [title, setTitle] = useState('');
const [loading, setLoading] = useState(true);
const [listError, setListError] = useState(false);
// Load doc list
useEffect(() => {
if (!sw?.api?.get) return;
sw.api.get('/api/v1/docs').then(r => {
setDocs(Array.isArray(r) ? r : r.data || []);
setListError(false);
}).catch(() => { setListError(true); });
}, []);
// Load active doc
const loadDoc = useCallback(async (slug) => {
setLoading(true);
setActive(slug);
try {
const resp = await sw.api.get(`/api/v1/docs/${slug}`);
const d = resp.data || resp;
setTitle(d.title || slug);
setContent(d.content || 'Document not found.');
} catch (e) {
setContent('Failed to load document.');
}
setLoading(false);
// Update URL without reload
const base = window.__BASE__ || '';
history.replaceState(null, '', `${base}/docs/${slug}`);
}, []);
useEffect(() => { loadDoc(active); }, []);
function navigate(slug) {
if (slug === active) return;
loadDoc(slug);
// Scroll to top
const el = document.querySelector('.docs-content');
if (el) el.scrollTop = 0;
}
// Extract document outline from markdown content
const outline = useMemo(() => {
if (!content) return [];
const headings = [];
let inCode = false;
for (const line of content.split('\n')) {
if (line.startsWith('```')) { inCode = !inCode; continue; }
if (inCode) continue;
const m = line.match(/^(#{1,4})\s+(.+)/);
if (m) {
const text = m[2].replace(/[*_`\[\]]/g, '');
const id = text.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/(^-|-$)/g, '');
headings.push({ level: m[1].length, text, id });
}
}
return headings;
}, [content]);
function scrollToHeading(id) {
const el = document.getElementById(id);
if (el) el.scrollIntoView({ behavior: 'smooth', block: 'start' });
}
function retryList() {
setListError(false);
sw.api.get('/api/v1/docs').then(r => {
setDocs(Array.isArray(r) ? r : r.data || []);
}).catch(() => { setListError(true); });
}
return html`
<${Topbar} title="Documentation" />
<div class="docs-layout">
<nav class="docs-sidebar">
<h3 class="docs-sidebar__heading">Documentation</h3>
${listError ? html`
<div class="docs-error-inline">
<p>Failed to load docs list.</p>
<button onclick=${retryList} class="docs-retry-btn">Retry</button>
</div>
` : docs.map(d => html`
<a key=${d.slug}
class="docs-nav-item ${d.slug === active ? 'active' : ''}"
onclick=${() => navigate(d.slug)}
href="javascript:void(0)">
${d.title}
</a>
`)}
</nav>
<main class="docs-content">
${loading ? html`
<div class="docs-loading">Loading\u2026</div>
` : html`
<article class="docs-article"
dangerouslySetInnerHTML=${{ __html: renderMarkdown(content) }}>
</article>
`}
</main>
${!loading && outline.length > 2 ? html`
<aside class="docs-outline">
<h4 class="docs-outline__heading">On this page</h4>
${outline.map(h => html`
<a key=${h.id}
class="docs-outline__item docs-outline__item--h${h.level}"
onclick=${(e) => { e.preventDefault(); scrollToHeading(h.id); }}
href="#${h.id}">
${h.text}
</a>
`)}
</aside>
` : null}
</div>
`;
}
// ── Simple markdown renderer ─────────────────
// Handles: headings, code blocks, inline code, bold, italic, links, lists, paragraphs, tables, hr.
// Not a full CommonMark parser — good enough for documentation.
function renderMarkdown(md) {
if (!md) return '';
let html = '';
const lines = md.split('\n');
let i = 0;
let inCode = false;
let codeLang = '';
let codeLines = [];
let inList = false;
let listType = '';
let inTable = false;
let tableRows = [];
function esc(s) {
return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
}
function inline(s) {
s = esc(s);
// Links [text](url)
s = s.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '<a href="$2" target="_blank" rel="noopener">$1</a>');
// Bold **text** or __text__
s = s.replace(/\*\*(.+?)\*\*/g, '<strong>$1</strong>');
s = s.replace(/__(.+?)__/g, '<strong>$1</strong>');
// Italic *text* or _text_
s = s.replace(/(?<!\*)\*([^*]+)\*(?!\*)/g, '<em>$1</em>');
// Inline code `code`
s = s.replace(/`([^`]+)`/g, '<code>$1</code>');
return s;
}
function flushTable() {
if (!inTable || tableRows.length === 0) return;
inTable = false;
html += '<table class="data-table"><thead><tr>';
const headers = tableRows[0];
for (const h of headers) html += `<th>${inline(h.trim())}</th>`;
html += '</tr></thead><tbody>';
for (let r = 2; r < tableRows.length; r++) {
html += '<tr>';
for (const cell of tableRows[r]) html += `<td>${inline(cell.trim())}</td>`;
html += '</tr>';
}
html += '</tbody></table>';
tableRows = [];
}
function flushList() {
if (!inList) return;
inList = false;
html += listType === 'ol' ? '</ol>' : '</ul>';
}
while (i < lines.length) {
const line = lines[i];
// Fenced code blocks
if (line.startsWith('```')) {
if (inCode) {
html += `<pre><code class="language-${esc(codeLang)}">${esc(codeLines.join('\n'))}</code></pre>`;
inCode = false;
codeLines = [];
codeLang = '';
} else {
flushList();
flushTable();
inCode = true;
codeLang = line.slice(3).trim();
}
i++;
continue;
}
if (inCode) {
codeLines.push(line);
i++;
continue;
}
// Table rows
if (line.includes('|') && line.trim().startsWith('|')) {
flushList();
const cells = line.split('|').slice(1, -1);
if (!inTable) inTable = true;
// Skip separator row (---|---)
if (cells.every(c => /^[\s:-]+$/.test(c))) {
tableRows.push(cells); // keep for row counting
} else {
tableRows.push(cells);
}
i++;
continue;
} else {
flushTable();
}
// Headings
const headingMatch = line.match(/^(#{1,6})\s+(.+)/);
if (headingMatch) {
flushList();
const level = headingMatch[1].length;
const text = headingMatch[2];
const id = text.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/(^-|-$)/g, '');
html += `<h${level} id="${id}">${inline(text)}</h${level}>`;
i++;
continue;
}
// Horizontal rule
if (/^(-{3,}|\*{3,}|_{3,})$/.test(line.trim())) {
flushList();
html += '<hr>';
i++;
continue;
}
// Unordered list
if (/^\s*[-*+]\s+/.test(line)) {
if (!inList || listType !== 'ul') {
flushList();
inList = true;
listType = 'ul';
html += '<ul>';
}
html += `<li>${inline(line.replace(/^\s*[-*+]\s+/, ''))}</li>`;
i++;
continue;
}
// Ordered list
if (/^\s*\d+\.\s+/.test(line)) {
if (!inList || listType !== 'ol') {
flushList();
inList = true;
listType = 'ol';
html += '<ol>';
}
html += `<li>${inline(line.replace(/^\s*\d+\.\s+/, ''))}</li>`;
i++;
continue;
}
flushList();
// Empty line
if (line.trim() === '') {
i++;
continue;
}
// Paragraph
html += `<p>${inline(line)}</p>`;
i++;
}
flushList();
flushTable();
return html;
}
// ── Styles ──────────────────────────────────
const style = document.createElement('style');
style.textContent = `
.docs-layout {
display: flex;
flex: 1;
min-height: 0;
overflow: hidden;
gap: 0;
}
.docs-sidebar {
width: 220px;
min-width: 220px;
height: 100%;
padding: 20px 16px;
border-right: 1px solid var(--border);
background: var(--bg-secondary);
overflow-y: auto;
box-sizing: border-box;
}
.docs-sidebar__heading {
margin: 0 0 12px;
font-size: 14px;
color: var(--text-3);
text-transform: uppercase;
letter-spacing: 0.5px;
}
.docs-nav-item {
display: block;
padding: 6px 10px;
margin: 2px 0;
border-radius: 6px;
color: var(--text);
text-decoration: none;
font-size: 13px;
cursor: pointer;
transition: background 0.15s;
}
.docs-nav-item:hover {
background: var(--bg-hover);
}
.docs-nav-item.active {
background: var(--accent-dim);
color: var(--accent);
font-weight: 600;
}
.docs-content {
flex: 1;
height: 100%;
padding: 24px 40px;
max-width: 800px;
overflow-y: auto;
box-sizing: border-box;
}
.docs-loading {
padding: 40px;
text-align: center;
color: var(--text-3);
animation: docs-pulse 1.5s ease-in-out infinite;
}
@keyframes docs-pulse {
0%, 100% { opacity: 1; }
50% { opacity: 0.4; }
}
.docs-error-inline {
padding: 12px;
color: var(--text-3);
font-size: 13px;
text-align: center;
}
.docs-retry-btn {
margin-top: 8px;
padding: 4px 12px;
background: var(--bg-hover);
border: 1px solid var(--border);
border-radius: 6px;
color: var(--text);
font-size: 12px;
cursor: pointer;
}
.docs-retry-btn:hover { background: var(--bg-elevated); }
.docs-outline {
width: 200px;
min-width: 200px;
height: 100%;
padding: 20px 12px;
border-left: 1px solid var(--border);
overflow-y: auto;
box-sizing: border-box;
}
.docs-outline__heading {
margin: 0 0 10px;
font-size: 11px;
color: var(--text-3);
text-transform: uppercase;
letter-spacing: 0.5px;
font-weight: 600;
}
.docs-outline__item {
display: block;
padding: 3px 8px;
margin: 1px 0;
border-radius: 4px;
color: var(--text-2);
text-decoration: none;
font-size: 12px;
line-height: 1.4;
cursor: pointer;
transition: color 0.15s, background 0.15s;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.docs-outline__item:hover { color: var(--text); background: var(--bg-hover); }
.docs-outline__item--h1 { padding-left: 8px; font-weight: 600; color: var(--text); }
.docs-outline__item--h2 { padding-left: 8px; }
.docs-outline__item--h3 { padding-left: 20px; }
.docs-outline__item--h4 { padding-left: 32px; font-size: 11px; }
.docs-article h1, .docs-article h2, .docs-article h3, .docs-article h4 { scroll-margin-top: 16px; }
.docs-article h1 { font-size: 28px; margin: 0 0 16px; border-bottom: 1px solid var(--border); padding-bottom: 8px; color: var(--text); }
.docs-article h2 { font-size: 22px; margin: 24px 0 12px; color: var(--text); }
.docs-article h3 { font-size: 18px; margin: 20px 0 8px; color: var(--text); }
.docs-article p { margin: 8px 0; line-height: 1.6; color: var(--text); }
.docs-article pre {
background: var(--bg-code);
border: 1px solid var(--border);
border-radius: 6px;
padding: 12px 16px;
overflow-x: auto;
font-size: 13px;
line-height: 1.5;
margin: 12px 0;
}
.docs-article code {
background: var(--bg-code);
padding: 2px 5px;
border-radius: 3px;
font-size: 0.9em;
color: var(--text);
}
.docs-article pre code { background: none; padding: 0; }
.docs-article ul, .docs-article ol { margin: 8px 0; padding-left: 24px; }
.docs-article li { margin: 4px 0; line-height: 1.5; color: var(--text); }
.docs-article hr { border: none; border-top: 1px solid var(--border); margin: 24px 0; }
.docs-article a { color: var(--accent); }
.docs-article .data-table { width: 100%; border-collapse: collapse; margin: 12px 0; font-size: 13px; }
.docs-article .data-table th { text-align: left; padding: 8px 12px; border-bottom: 2px solid var(--border); color: var(--text); font-weight: 600; }
.docs-article .data-table td { padding: 6px 12px; border-bottom: 1px solid var(--border); color: var(--text-2); }
.docs-article .data-table tr:hover td { background: var(--bg-hover); }
.docs-article strong { color: var(--text); }
`;
document.head.appendChild(style);
// ── Mount ───────────────────────────────────
const mount = document.getElementById('docs-mount');
if (mount) {
mount.innerHTML = '';
render(preact.h(DocsSurface, null), mount);
}