@book.dev/sdk 1.60.0

package/dist/bookFolder.js

@@ -0,0 +1,98 @@
+import { pageToBookHtml, bookHtmlToPage, slugify } from './bookfile';
+/** Lossless structured sidecar, parsed back by {@link parseBookFolder}. */
+export const SPACE_BUNDLE_FILE = 'openbook.space.json';
+const MAX_DEPTH = 64;
+const pageIcon = (page) => {
+    const icon = page.properties?.sys_icon;
+    return typeof icon === 'string' ? icon : null;
+};
+const folderName = (root) => `${slugify(root.name ?? 'untitled')}--${root.id.slice(0, 8)}`;
+const fileName = (page) => `${slugify(page.name ?? 'untitled')}--${page.id.slice(0, 8)}.html`;
+/** Topmost ancestor: walk `parentId`, or a row's database-host page, to the root. */
+function rootOf(page, byId, dbHost) {
+    let root = page;
+    for (let depth = 0; depth < MAX_DEPTH; depth += 1) {
+        let parentId = null;
+        if (root.parentId)
+            parentId = root.parentId;
+        else if (root.databaseId)
+            parentId = dbHost.get(root.databaseId) ?? null;
+        const parent = parentId ? byId.get(parentId) : null;
+        if (!parent)
+            break;
+        root = parent;
+    }
+    return root;
+}
+/**
+ * Serialise a space to its on-disk files. By default includes the lossless
+ * {@link SPACE_BUNDLE_FILE}; pass `includeBundle: false` for the human-readable
+ * HTML files only.
+ */
+export function spaceToBookFiles(snapshot, opts = {}) {
+    const { pages, databases } = snapshot;
+    const byId = new Map(pages.map((p) => [p.id, p]));
+    const dbHost = new Map(databases.map((d) => [d.id, d.pageId]));
+    const files = [];
+    for (const page of pages) {
+        const root = rootOf(page, byId, dbHost);
+        const html = pageToBookHtml({
+            id: page.id,
+            name: page.name,
+            icon: pageIcon(page),
+            updatedAt: page.updatedAt,
+            data: page.data,
+        });
+        files.push({ path: `${folderName(root)}/${fileName(page)}`, contents: html });
+    }
+    if (opts.includeBundle !== false) {
+        files.push({ path: SPACE_BUNDLE_FILE, contents: JSON.stringify(snapshot, null, 2) });
+    }
+    return files;
+}
+/**
+ * Reconstruct a space from a folder's files. Prefers the lossless
+ * {@link SPACE_BUNDLE_FILE} when present; otherwise falls back to parsing the
+ * `.html` files into a flat list of pages (no databases, no nesting — the most
+ * a human-readable folder can recover). Returns `null` if nothing parseable was
+ * found, so the caller can surface "not an OpenBook folder".
+ */
+export function parseBookFolder(files) {
+    const bundle = files.find((f) => f.path === SPACE_BUNDLE_FILE || f.path.endsWith(`/${SPACE_BUNDLE_FILE}`));
+    if (bundle) {
+        try {
+            const parsed = JSON.parse(bundle.contents);
+            if (Array.isArray(parsed.pages)) {
+                return { pages: parsed.pages, databases: Array.isArray(parsed.databases) ? parsed.databases : [] };
+            }
+        }
+        catch {
+            // Corrupt bundle — fall through to the HTML files.
+        }
+    }
+    const pages = [];
+    for (const file of files) {
+        if (!file.path.endsWith('.html'))
+            continue;
+        const record = bookHtmlToPage(file.contents);
+        if (record)
+            pages.push(recordToPage(record));
+    }
+    return pages.length ? { pages, databases: [] } : null;
+}
+/** Inflate a parsed `.book.html` record into a minimal StoredPage for import. */
+function recordToPage(record) {
+    return {
+        id: record.id,
+        name: record.name,
+        data: record.data,
+        hostedDatabaseId: null,
+        databaseId: null,
+        parentId: null,
+        properties: record.icon ? { sys_icon: record.icon } : {},
+        deletedAt: null,
+        createdAt: record.updatedAt,
+        updatedAt: record.updatedAt,
+    };
+}
+//# sourceMappingURL=bookFolder.js.map

package/dist/bookFolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bookFolder.js","sourceRoot":"","sources":["../src/bookFolder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,cAAc,EAAE,cAAc,EAAE,OAAO,EAAC,MAAM,YAAY,CAAC;AA6BnE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAEvD,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,MAAM,QAAQ,GAAG,CAAC,IAAgB,EAAiB,EAAE;IACnD,MAAM,IAAI,GAAI,IAAI,CAAC,UAAkD,EAAE,QAAQ,CAAC;IAChF,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAgB,EAAU,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;AAC/G,MAAM,QAAQ,GAAG,CAAC,IAAgB,EAAU,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;AAElH,qFAAqF;AACrF,SAAS,MAAM,CACb,IAAgB,EAChB,IAA6B,EAC7B,MAA2B;IAE3B,IAAI,IAAI,GAAG,IAAI,CAAC;IAChB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAClD,IAAI,QAAQ,GAAkB,IAAI,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ;YAAE,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;aACvC,IAAI,IAAI,CAAC,UAAU;YAAE,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC;QACzE,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpD,IAAI,CAAC,MAAM;YAAE,MAAM;QACnB,IAAI,GAAG,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAuB,EAAE,OAAkC,EAAE;IAC5F,MAAM,EAAC,KAAK,EAAE,SAAS,EAAC,GAAG,QAAQ,CAAC;IACpC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE/D,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,cAAc,CAAC;YAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;YACpB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAC,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,KAAuB;IACrD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC,CAAC;IAC3G,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAA2B,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,OAAO,EAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAC,CAAC;YACnG,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,mDAAmD;QACrD,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,SAAS;QAC3C,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACtD,CAAC;AAED,iFAAiF;AACjF,SAAS,YAAY,CAAC,MAAqG;IACzH,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,gBAAgB,EAAE,IAAI;QACtB,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,IAAI;QACd,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC,EAAE;QACtD,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;KAC5B,CAAC;AACJ,CAAC"}

package/dist/bookfile.d.ts

@@ -0,0 +1,42 @@
+/**
+ * The on-disk **book file** format (OB-134): one HTML file per page. Each file
+ * is human-readable (so external sync/backup tools and editors see real content)
+ * yet round-trips losslessly back into pglite, because it embeds the canonical
+ * {@link PageSnapshot} as a JSON island alongside the rendered body.
+ *
+ * Every rendered block carries a stable `data-block-id` and a `data-block-mtime`,
+ * and the page itself carries `data-page-id` / `data-page-updated` (the DB
+ * `updatedAt` the file was rendered from — the conflict base) / `data-page-mtime`.
+ * Those attributes are the change signal the watcher and conflict resolver read.
+ *
+ * Pure and isomorphic: rendering and the island parse use no DOM, so the server
+ * mirror can emit and re-read files directly. The readable body mirrors the
+ * `export/` look (the `ob-*` class names) without depending on the ui package.
+ */
+import type { PageSnapshot } from './types';
+/** A page reduced to what a book file needs to carry. */
+export interface BookPageRecord {
+    id: string;
+    name: string | null;
+    icon: string | null;
+    /** The DB `updatedAt` this file was rendered from — the conflict base. */
+    updatedAt: string;
+    data: PageSnapshot;
+}
+/** Lower-case, dash-separated, filesystem-safe slug (for the on-disk filename). */
+export declare function slugify(input: string, fallback?: string): string;
+/** Render a page to its on-disk book-file HTML (readable body + canonical island). */
+export declare function pageToBookHtml(record: BookPageRecord): string;
+/** Cheap metadata read from the `<html>` tag — id + conflict base + name. */
+export declare function readBookHtmlMeta(html: string): {
+    id: string;
+    name: string;
+    updatedAt: string;
+} | null;
+/**
+ * Parse a book file back into its page record via the canonical JSON island.
+ * Returns `null` if the file isn't an OpenBook book page or the island is
+ * missing/corrupt. This is the lossless re-import path (sync clients, restored
+ * backups, moved files all preserve the island).
+ */
+export declare function bookHtmlToPage(html: string): BookPageRecord | null;

package/dist/bookfile.js

@@ -0,0 +1,159 @@
+import { latestBlockMtime } from './mtime';
+const MARKER = 'application/openbook+json';
+const esc = (s) => s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
+/** Lower-case, dash-separated, filesystem-safe slug (for the on-disk filename). */
+export function slugify(input, fallback = 'untitled') {
+    const slug = (input || '')
+        .normalize('NFKD')
+        .replace(/[̀-ͯ]/g, '')
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '')
+        .slice(0, 80);
+    return slug || fallback;
+}
+/** Ordered top-level blocks with resolved ids (matching sdk `snapshotBlocks`). */
+function orderedBlocks(data) {
+    const blockdoc = data.blockdoc;
+    const raw = data.editor === 'blocks' && Array.isArray(blockdoc?.blocks)
+        ? blockdoc.blocks
+        : (data.editorjs?.blocks ?? []);
+    return raw.map((b, i) => ({ id: typeof b.id === 'string' && b.id ? b.id : `b${i}`, type: b.type ?? 'unknown', block: b }));
+}
+/** Inline HTML for a block-editor rich-text run. */
+function runHtml(run) {
+    let out = esc(run.t).replace(/\n/g, '<br>');
+    const a = run.a ?? {};
+    if (a.c)
+        out = `<code>${out}</code>`;
+    if (a.b)
+        out = `<strong>${out}</strong>`;
+    if (a.i)
+        out = `<em>${out}</em>`;
+    if (a.u)
+        out = `<u>${out}</u>`;
+    if (a.s)
+        out = `<s>${out}</s>`;
+    if (typeof a.m === 'string')
+        out = `<a class="ob-mention" data-page-id="${esc(a.m)}">${out}</a>`;
+    else if (typeof a.a === 'string')
+        out = `<a href="${esc(a.a)}">${out}</a>`;
+    return out;
+}
+const runsHtml = (runs) => (runs ?? []).map(runHtml).join('');
+/** Best-effort readable inner HTML for one block (the island stays authoritative). */
+function blockInnerHtml(type, block) {
+    const d = block.data ?? {};
+    // Block-editor pages carry rich-text runs; EditorJS pages carry HTML strings.
+    const textHtml = block.text ? runsHtml(block.text) : typeof d.text === 'string' ? d.text : '';
+    switch (type) {
+        case 'heading':
+        case 'header': {
+            const level = Math.min(6, Math.max(1, Number(block.props?.level ?? d.level ?? 2)));
+            return { tag: `h${level}`, inner: textHtml };
+        }
+        case 'quote':
+            return { tag: 'blockquote', inner: textHtml };
+        case 'code':
+            return { tag: 'pre', inner: `<code>${esc(block.text ? (block.text.map((r) => r.t).join('')) : String(d.code ?? ''))}</code>` };
+        case 'list': {
+            const items = Array.isArray(d.items) ? d.items : [];
+            const ordered = d.style === 'ordered';
+            const lis = items
+                .map((it) => `<li>${typeof it === 'string' ? it : esc(String(it?.content ?? ''))}</li>`)
+                .join('');
+            return { tag: ordered ? 'ol' : 'ul', inner: lis };
+        }
+        case 'todo':
+        case 'checklist': {
+            const checked = block.props?.checked === true || d.checked === true;
+            return { tag: 'p', inner: `<input type="checkbox"${checked ? ' checked' : ''} disabled> ${textHtml}` };
+        }
+        case 'delimiter':
+        case 'divider':
+            return { tag: 'hr', inner: '' };
+        case 'paragraph':
+            return { tag: 'p', inner: textHtml };
+        default:
+            // Unknown / rich blocks (charts, tables, kit, …): readable text only — the
+            // JSON island carries their full data for a faithful re-import.
+            return { tag: 'div', inner: textHtml || `<em class="ob-raw">${esc(type)} block</em>` };
+    }
+}
+/** Render a page to its on-disk book-file HTML (readable body + canonical island). */
+export function pageToBookHtml(record) {
+    const { id, name, icon, updatedAt, data } = record;
+    const title = (name ?? '').trim() || 'Untitled';
+    const mtime = new Map(data.mtimes ?? []);
+    const pageMtime = latestBlockMtime(data) ?? updatedAt;
+    const body = orderedBlocks(data)
+        .map(({ id: blockId, type, block }) => {
+        const { tag, inner } = blockInnerHtml(type, block);
+        const attrs = `data-block-id="${esc(blockId)}" data-block-type="${esc(type)}" data-block-mtime="${esc(mtime.get(blockId) ?? updatedAt)}"`;
+        return tag === 'hr' ? `    <hr ${attrs}>` : `    <${tag} ${attrs}>${inner}</${tag}>`;
+    })
+        .join('\n');
+    // The island JSON is escaped so a literal `</script>` in content can't close
+    // the tag early; `<\/` is still valid JSON and parses back to `</`.
+    const island = JSON.stringify({ version: 1, id, name, icon, updatedAt, data }).replace(/<\//g, '<\\/');
+    return `<!doctype html>
+<html lang="en" data-openbook="book-page" data-page-id="${esc(id)}" data-page-name="${esc(title)}" data-page-updated="${esc(updatedAt)}" data-page-mtime="${esc(pageMtime)}">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>${esc(title)}</title>
+</head>
+<body class="ob-page">
+  <article>
+    <h1 class="ob-page-title">${icon ? `${esc(icon)} ` : ''}${esc(title)}</h1>
+${body}
+  </article>
+  <script type="${MARKER}" data-openbook-snapshot>
+${island}
+  </script>
+</body>
+</html>
+`;
+}
+/** Cheap metadata read from the `<html>` tag — id + conflict base + name. */
+export function readBookHtmlMeta(html) {
+    const tag = html.match(/<html\b[^>]*\bdata-openbook="book-page"[^>]*>/i)?.[0];
+    if (!tag)
+        return null;
+    const attr = (n) => {
+        const m = tag.match(new RegExp(`\\b${n}="([^"]*)"`, 'i'));
+        return m ? unesc(m[1]) : '';
+    };
+    const id = attr('data-page-id');
+    if (!id)
+        return null;
+    return { id, name: attr('data-page-name'), updatedAt: attr('data-page-updated') };
+}
+const unesc = (s) => s.replace(/&quot;/g, '"').replace(/&gt;/g, '>').replace(/&lt;/g, '<').replace(/&amp;/g, '&');
+/**
+ * Parse a book file back into its page record via the canonical JSON island.
+ * Returns `null` if the file isn't an OpenBook book page or the island is
+ * missing/corrupt. This is the lossless re-import path (sync clients, restored
+ * backups, moved files all preserve the island).
+ */
+export function bookHtmlToPage(html) {
+    const m = html.match(new RegExp(`<script[^>]*type="${MARKER.replace(/[/+]/g, '\\$&')}"[^>]*>([\\s\\S]*?)</script>`, 'i'));
+    if (!m)
+        return null;
+    try {
+        const parsed = JSON.parse(m[1].trim());
+        if (!parsed.id || !parsed.data)
+            return null;
+        return {
+            id: parsed.id,
+            name: parsed.name ?? null,
+            icon: parsed.icon ?? null,
+            updatedAt: parsed.updatedAt ?? '',
+            data: parsed.data,
+        };
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=bookfile.js.map

package/dist/bookfile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bookfile.js","sourceRoot":"","sources":["../src/bookfile.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAYzC,MAAM,MAAM,GAAG,2BAA2B,CAAC;AAE3C,MAAM,GAAG,GAAG,CAAC,CAAS,EAAU,EAAE,CAChC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAE/F,mFAAmF;AACnF,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,QAAQ,GAAG,UAAU;IAC1D,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;SACvB,SAAS,CAAC,MAAM,CAAC;SACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChB,OAAO,IAAI,IAAI,QAAQ,CAAC;AAC1B,CAAC;AAWD,kFAAkF;AAClF,SAAS,aAAa,CAAC,IAAkB;IACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAA6C,CAAC;IACpE,MAAM,GAAG,GACP,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC;QACzD,CAAC,CAAC,QAAQ,CAAC,MAAM;QACjB,CAAC,CAAC,CAAE,IAAI,CAAC,QAA8C,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;IAC3E,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,QAAQ,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,SAAS,EAAE,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;AAC3H,CAAC;AAED,oDAAoD;AACpD,SAAS,OAAO,CAAC,GAA6C;IAC5D,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACtB,IAAI,CAAC,CAAC,CAAC;QAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAAC;IACrC,IAAI,CAAC,CAAC,CAAC;QAAE,GAAG,GAAG,WAAW,GAAG,WAAW,CAAC;IACzC,IAAI,CAAC,CAAC,CAAC;QAAE,GAAG,GAAG,OAAO,GAAG,OAAO,CAAC;IACjC,IAAI,CAAC,CAAC,CAAC;QAAE,GAAG,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,IAAI,CAAC,CAAC,CAAC;QAAE,GAAG,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ;QAAE,GAAG,GAAG,uCAAuC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC;SAC5F,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ;QAAE,GAAG,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC;IAC3E,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,IAAsB,EAAU,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAExF,sFAAsF;AACtF,SAAS,cAAc,CAAC,IAAY,EAAE,KAAe;IACnD,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;IAC3B,8EAA8E;IAC9E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAE,CAAC,CAAC,IAAe,CAAC,CAAC,CAAC,EAAE,CAAC;IAE1G,QAAQ,IAAI,EAAE,CAAC;QACf,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAE,KAAK,CAAC,KAA0B,EAAE,KAAK,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACzG,OAAO,EAAC,GAAG,EAAE,IAAI,KAAK,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAC,CAAC;QAC7C,CAAC;QACD,KAAK,OAAO;YACV,OAAO,EAAC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAC,CAAC;QAC9C,KAAK,MAAM;YACT,OAAO,EAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,SAAS,EAAC,CAAC;QAC/H,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,KAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC;YACtC,MAAM,GAAG,GAAG,KAAK;iBACd,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAE,EAAyB,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;iBAC/G,IAAI,CAAC,EAAE,CAAC,CAAC;YACZ,OAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAC,CAAC;QAClD,CAAC;QACD,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,OAAO,GAAI,KAAK,CAAC,KAA6B,EAAE,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC;YAC7F,OAAO,EAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,yBAAyB,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,cAAc,QAAQ,EAAE,EAAC,CAAC;QACvG,CAAC;QACD,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS;YACZ,OAAO,EAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC;QAChC,KAAK,WAAW;YACd,OAAO,EAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAC,CAAC;QACrC;YACE,2EAA2E;YAC3E,gEAAgE;YAChE,OAAO,EAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,IAAI,sBAAsB,GAAG,CAAC,IAAI,CAAC,aAAa,EAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,cAAc,CAAC,MAAsB;IACnD,MAAM,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAC,GAAG,MAAM,CAAC;IACjD,MAAM,KAAK,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,UAAU,CAAC;IAChD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAiB,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;IAEtD,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;SAC7B,GAAG,CAAC,CAAC,EAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAC,EAAE,EAAE;QAClC,MAAM,EAAC,GAAG,EAAE,KAAK,EAAC,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,kBAAkB,GAAG,CAAC,OAAO,CAAC,sBAAsB,GAAG,CAAC,IAAI,CAAC,uBAAuB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC;QAC1I,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,KAAK,IAAI,KAAK,KAAK,GAAG,GAAG,CAAC;IACvF,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,6EAA6E;IAC7E,oEAAoE;IACpE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErG,OAAO;0DACiD,GAAG,CAAC,EAAE,CAAC,qBAAqB,GAAG,CAAC,KAAK,CAAC,wBAAwB,GAAG,CAAC,SAAS,CAAC,sBAAsB,GAAG,CAAC,SAAS,CAAC;;;;SAIjK,GAAG,CAAC,KAAK,CAAC;;;;gCAIa,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC;EACtE,IAAI;;kBAEY,MAAM;EACtB,MAAM;;;;CAIP,CAAC;AACF,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,gDAAgD,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9E,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,MAAM,IAAI,GAAG,CAAC,CAAS,EAAU,EAAE;QACjC,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC;QAC1D,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9B,CAAC,CAAC;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC;IACrB,OAAO,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAC,CAAC;AAClF,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,CAAS,EAAU,EAAE,CAClC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAClB,IAAI,MAAM,CAAC,qBAAqB,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,8BAA8B,EAAE,GAAG,CAAC,CACpG,CAAC;IACF,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAiD,CAAC;QACvF,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QAC5C,OAAO;YACL,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI;YACzB,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;YACjC,IAAI,EAAE,MAAM,CAAC,IAAI;SAClB,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,279 @@
+import type { PluginPackage, StoredPlugin } from './plugins';
+import type { AgentChatEvent, AgentChatMessage, AgentChatOptions, AiConfig, AiSearchResponse, AiSkill, AiStatus, AiTasksResponse } from './ai';
+import type { PageInput, PageMeta, StoredPage } from './types';
+import type { ImportRequest, ImportResult } from './backup';
+import type { DatabaseInput, DatabaseRow, DatabaseUpdate, RowInput, RowUpdate, StoredDatabase } from './database';
+import type { CommentInput, StoredComment, StoredSuggestion, SuggestionInput, SuggestionStatus, SuggestionUpdate } from './suggestions';
+/** Handlers for a single page's live update stream. */
+export interface PageSubscription {
+    /** A newer version of the page was saved (by anyone). */
+    onPage?: (page: StoredPage) => void;
+    /** The page was deleted. */
+    onDeleted?: (id: string) => void;
+}
+/**
+ * Storage-agnostic data access used by the document UI.
+ *
+ * The desktop app and the web shell both talk to a server through the same
+ * {@link HttpDataClient} — the desktop just points it at its bundled local
+ * server, the web shell at a remote one. Swapping the target URL is how a user
+ * moves between "store locally" and "connect to an external server"; the
+ * document code never changes.
+ */
+export interface DataClient {
+    /** List all pages' metadata, most-recently-updated first. */
+    listPages(): Promise<PageMeta[]>;
+    /** Fetch a page by id, or `null` if it does not exist. */
+    getPage(id: string): Promise<StoredPage | null>;
+    /** Create or update a page (upsert keyed on `input.id`). */
+    savePage(input: PageInput): Promise<StoredPage>;
+    /** Update only a page's name (leaves its document data untouched). */
+    renamePage(id: string, name: string | null): Promise<StoredPage>;
+    /**
+     * Shallow-merge structured property values into a page (owner, verification,
+     * …), leaving its document content and other properties untouched. Used by
+     * the page properties panel for non-row pages (database rows use {@link updateRow}).
+     */
+    setPageProperties(id: string, properties: Record<string, unknown>): Promise<StoredPage>;
+    /** List the live pages that link to `id` (via `@`-mentions), newest first. */
+    listBacklinks(id: string): Promise<PageMeta[]>;
+    /**
+     * Move a page within the sidebar tree: set its parent (`null` = top level) and
+     * the full ordered list of sibling ids under that parent (including this page).
+     * Used by drag-to-reorder / drag-to-nest. Rejects a move that would create a
+     * cycle (nesting a page under itself or a descendant).
+     */
+    movePage(id: string, move: {
+        parentId: string | null;
+        orderedIds: string[];
+    }): Promise<StoredPage>;
+    aiStatus(): Promise<AiStatus>;
+    aiSetConfig(config: AiConfig): Promise<AiConfig>;
+    aiIndex(): Promise<{
+        pages: number;
+        chunks: number;
+    }>;
+    aiSearch(query: string, limit?: number): Promise<AiSearchResponse>;
+    aiTasks(goal: string, context?: string): Promise<AiTasksResponse>;
+    aiDownloadModel(url?: string): Promise<AiStatus['download']>;
+    aiComplete(text: string, onToken: (token: string) => void, opts?: {
+        instruction?: string;
+        signal?: AbortSignal;
+    }): Promise<string>;
+    aiGenerate(prompt: string, onToken: (token: string) => void, opts?: {
+        system?: string;
+        maxTokens?: number;
+        signal?: AbortSignal;
+    }): Promise<string>;
+    /**
+     * Run the workspace agent on a conversation. `onEvent` fires once per step
+     * (tool call, tool result, reasoning, proposals, final answer, error);
+     * resolves when the run ends. `opts` carries effort/thinking/skills overrides.
+     */
+    agentChat(messages: AgentChatMessage[], onEvent: (event: AgentChatEvent) => void, opts?: AgentChatOptions): Promise<void>;
+    /** List the workspace's prompt/recipe skills. */
+    aiSkills(): Promise<AiSkill[]>;
+    /** Create or replace a prompt/recipe skill (keyed on its slug). */
+    aiSaveSkill(skill: AiSkill): Promise<AiSkill>;
+    /** Delete a prompt/recipe skill by name. */
+    aiDeleteSkill(name: string): Promise<boolean>;
+    listPlugins(): Promise<StoredPlugin[]>;
+    installPlugin(pkg: PluginPackage): Promise<StoredPlugin>;
+    setPluginEnabled(id: string, enabled: boolean): Promise<StoredPlugin>;
+    removePlugin(id: string): Promise<boolean>;
+    /**
+     * Move a page (and its nested subtree) to the trash. Soft delete: the page is
+     * recoverable via {@link restorePage} until the server's cleanup job purges
+     * it. Resolves `true` if a live page was trashed.
+     */
+    deletePage(id: string): Promise<boolean>;
+    /** Export the whole space: every live page (full data) + every database. */
+    exportSpace(): Promise<{
+        pages: StoredPage[];
+        databases: StoredDatabase[];
+    }>;
+    /** Restore a (client-selected) set of pages/databases; see {@link ImportRequest}. */
+    importSpace(req: ImportRequest): Promise<ImportResult>;
+    /** List the trash (most-recently-deleted first). */
+    listTrash(): Promise<PageMeta[]>;
+    /** Restore a trashed page, or `null` if it isn't in the trash. */
+    restorePage(id: string): Promise<StoredPage | null>;
+    /** Permanently delete one trashed page (and its subtree). `true` if removed. */
+    purgePage(id: string): Promise<boolean>;
+    /** Permanently empty the whole trash. Resolves the number of pages purged. */
+    emptyTrash(): Promise<number>;
+    /** Subscribe to a single page's live updates. Returns an unsubscribe fn. */
+    subscribePage(id: string, handlers: PageSubscription): () => void;
+    /** Subscribe to live page-list updates. Returns an unsubscribe fn. */
+    subscribePages(onList: (pages: PageMeta[]) => void): () => void;
+    /** Create a database for a host page. */
+    createDatabase(input: DatabaseInput): Promise<StoredDatabase>;
+    /** Fetch a database by id, or `null` if it does not exist. */
+    getDatabase(id: string): Promise<StoredDatabase | null>;
+    /** Fetch the database hosted by a page, or `null` if the page hosts none. */
+    getPageDatabase(pageId: string): Promise<StoredDatabase | null>;
+    /** Update a database's name and/or schema. */
+    updateDatabase(id: string, patch: DatabaseUpdate): Promise<StoredDatabase>;
+    /** Delete a database and all its row pages. Resolves `true` if removed. */
+    deleteDatabase(id: string): Promise<boolean>;
+    /** List a database's rows (projected: properties + exported cell values). */
+    listRows(databaseId: string): Promise<DatabaseRow[]>;
+    /** Create a row (a new page) inside a database. Returns the row page. */
+    createRow(databaseId: string, input?: RowInput): Promise<StoredPage>;
+    /** Update a row's title and/or manual property values. */
+    updateRow(databaseId: string, rowId: string, patch: RowUpdate): Promise<DatabaseRow>;
+    /** Set the manual order of a database's rows (full ordered id list). */
+    reorderRows(databaseId: string, orderedIds: string[]): Promise<void>;
+    /** Subscribe to a database's live row-list updates. Returns an unsubscribe fn. */
+    subscribeRows(databaseId: string, onRows: (rows: DatabaseRow[]) => void): () => void;
+    /** List a page's suggestions, newest first. `status` filters (e.g. only open). */
+    listSuggestions(pageId: string, status?: SuggestionStatus): Promise<StoredSuggestion[]>;
+    /** Persist a new suggestion (status defaults to `open`). */
+    createSuggestion(input: SuggestionInput): Promise<StoredSuggestion>;
+    /** Update a suggestion (today: its status). Returns the updated suggestion. */
+    updateSuggestion(id: string, patch: SuggestionUpdate): Promise<StoredSuggestion>;
+    /** Delete a suggestion (and its thread). Resolves `true` if removed. */
+    deleteSuggestion(id: string): Promise<boolean>;
+    /** List a page's comments, oldest first (so a thread reads top-to-bottom). */
+    listComments(pageId: string): Promise<StoredComment[]>;
+    /** Persist a new comment (on a suggestion or a block). */
+    createComment(input: CommentInput): Promise<StoredComment>;
+    /** Delete a comment. Resolves `true` if removed. */
+    deleteComment(id: string): Promise<boolean>;
+}
+/**
+ * The `fetch` surface {@link HttpDataClient} needs. Defaults to the global
+ * `fetch`; the desktop injects an implementation that tunnels requests over its
+ * host IPC bridge (a Unix-socket server with no TCP port) instead.
+ */
+export type FetchLike = (input: string, init?: RequestInit) => Promise<Response>;
+/**
+ * The global `fetch`, wrapped so it's safe to store on an object and call as a
+ * property/method. WebKit (the desktop WKWebView) throws "Can only call
+ * Window.fetch on instances of Window" when `fetch` runs with a `this` that
+ * isn't the window — which is exactly what `obj.fetchImpl(...)` does once the
+ * bare global is assigned to a property. Calling the unqualified global here
+ * sidesteps that, so it's the right default wherever a {@link FetchLike} is
+ * stored and later invoked as a method.
+ */
+export declare const globalFetch: FetchLike;
+/**
+ * The slice of `EventSource` {@link LiveStream} uses (named events + open/error
+ * via `addEventListener`, plus `close`). Defaults to a real `EventSource`; the
+ * desktop injects a source backed by host IPC events, since its server speaks
+ * over a socket the webview can't open an `EventSource` to.
+ */
+export interface LiveSourceLike {
+    addEventListener(type: string, handler: (event: {
+        data?: string;
+    }) => void): void;
+    close(): void;
+}
+/** Options for swapping {@link HttpDataClient}'s transport (desktop IPC). */
+export interface HttpDataClientOptions {
+    /** Replacement for the global `fetch` (e.g. tunnel requests over host IPC). */
+    fetchImpl?: FetchLike;
+    /** Factory for the live-update source (e.g. an IPC-event-backed source). */
+    createLiveSource?: (url: string) => LiveSourceLike;
+}
+/**
+ * {@link DataClient} backed by an OpenBook server's HTTP API. Isomorphic, and
+ * transport-pluggable: by default it uses the global `fetch` + `EventSource`
+ * (web, remote), but the desktop injects a `fetchImpl`/`createLiveSource` that
+ * tunnel over its host IPC bridge to a portless Unix-socket server.
+ */
+export declare class HttpDataClient implements DataClient {
+    private readonly baseUrl;
+    private readonly token?;
+    private readonly fetchImpl;
+    private readonly createLiveSource;
+    private live;
+    /**
+     * @param baseUrl  Server base URL. May be empty when a `fetchImpl` resolves
+     *                 paths itself (the desktop IPC transport).
+     * @param token    Optional access token required by a published (LAN) server;
+     *                 sent as `Authorization: Bearer` on requests and `?token=` on
+     *                 the SSE stream (EventSource can't set headers). Omit for a
+     *                 loopback/local server, which needs none.
+     * @param opts     Optional transport overrides (desktop IPC).
+     */
+    constructor(baseUrl: string, token?: string, opts?: HttpDataClientOptions);
+    /** `fetch` (or the injected transport) with the access token attached (when set). */
+    private authFetch;
+    /** Lazily create the shared live connection (browser-only). */
+    private liveStream;
+    listPages(): Promise<PageMeta[]>;
+    getPage(id: string): Promise<StoredPage | null>;
+    savePage(input: PageInput): Promise<StoredPage>;
+    renamePage(id: string, name: string | null): Promise<StoredPage>;
+    setPageProperties(id: string, properties: Record<string, unknown>): Promise<StoredPage>;
+    listBacklinks(id: string): Promise<PageMeta[]>;
+    movePage(id: string, move: {
+        parentId: string | null;
+        orderedIds: string[];
+    }): Promise<StoredPage>;
+    deletePage(id: string): Promise<boolean>;
+    exportSpace(): Promise<{
+        pages: StoredPage[];
+        databases: StoredDatabase[];
+    }>;
+    importSpace(req: ImportRequest): Promise<ImportResult>;
+    listTrash(): Promise<PageMeta[]>;
+    restorePage(id: string): Promise<StoredPage | null>;
+    purgePage(id: string): Promise<boolean>;
+    emptyTrash(): Promise<number>;
+    subscribePage(id: string, handlers: PageSubscription): () => void;
+    subscribePages(onList: (pages: PageMeta[]) => void): () => void;
+    createDatabase(input: DatabaseInput): Promise<StoredDatabase>;
+    getDatabase(id: string): Promise<StoredDatabase | null>;
+    getPageDatabase(pageId: string): Promise<StoredDatabase | null>;
+    updateDatabase(id: string, patch: DatabaseUpdate): Promise<StoredDatabase>;
+    deleteDatabase(id: string): Promise<boolean>;
+    listRows(databaseId: string): Promise<DatabaseRow[]>;
+    createRow(databaseId: string, input?: RowInput): Promise<StoredPage>;
+    updateRow(databaseId: string, rowId: string, patch: RowUpdate): Promise<DatabaseRow>;
+    reorderRows(databaseId: string, orderedIds: string[]): Promise<void>;
+    subscribeRows(databaseId: string, onRows: (rows: DatabaseRow[]) => void): () => void;
+    listSuggestions(pageId: string, status?: SuggestionStatus): Promise<StoredSuggestion[]>;
+    createSuggestion(input: SuggestionInput): Promise<StoredSuggestion>;
+    updateSuggestion(id: string, patch: SuggestionUpdate): Promise<StoredSuggestion>;
+    deleteSuggestion(id: string): Promise<boolean>;
+    listComments(pageId: string): Promise<StoredComment[]>;
+    createComment(input: CommentInput): Promise<StoredComment>;
+    deleteComment(id: string): Promise<boolean>;
+    aiStatus(): Promise<AiStatus>;
+    aiSetConfig(config: AiConfig): Promise<AiConfig>;
+    aiIndex(): Promise<{
+        pages: number;
+        chunks: number;
+    }>;
+    aiSearch(query: string, limit?: number): Promise<AiSearchResponse>;
+    aiTasks(goal: string, context?: string): Promise<AiTasksResponse>;
+    aiDownloadModel(url?: string): Promise<AiStatus['download']>;
+    /**
+     * Stream a document completion. `onToken` fires per token; resolves with
+     * the full text. Abort via the optional signal.
+     */
+    aiComplete(text: string, onToken: (token: string) => void, opts?: {
+        instruction?: string;
+        signal?: AbortSignal;
+    }): Promise<string>;
+    /** Stream a raw generation (prompt + optional system). */
+    aiGenerate(prompt: string, onToken: (token: string) => void, opts?: {
+        system?: string;
+        maxTokens?: number;
+        signal?: AbortSignal;
+    }): Promise<string>;
+    listPlugins(): Promise<StoredPlugin[]>;
+    installPlugin(pkg: PluginPackage): Promise<StoredPlugin>;
+    setPluginEnabled(id: string, enabled: boolean): Promise<StoredPlugin>;
+    removePlugin(id: string): Promise<boolean>;
+    aiSkills(): Promise<AiSkill[]>;
+    aiSaveSkill(skill: AiSkill): Promise<AiSkill>;
+    aiDeleteSkill(name: string): Promise<boolean>;
+    /** Run the workspace agent, surfacing each streamed step via `onEvent`. */
+    agentChat(messages: AgentChatMessage[], onEvent: (event: AgentChatEvent) => void, opts?: AgentChatOptions): Promise<void>;
+    /** POST a body and consume the SSE token stream the AI endpoints emit. */
+    private aiStream;
+    private request;
+}