@plebeiantech/lat.md 0.12.3-fork.13 → 0.12.3-fork.15

package/dist/src/view/search.js

@@ -1,5 +1,6 @@
 import { dirname, relative, resolve } from 'node:path';
-import { toPosix } from '../walk.js';
+import { toPosix } from '../path.js';
+import { documentUrl } from './document-route.js';
 const VIEW_SEARCH_LIMIT = 10;
 const defaultDependencies = {
     async runIndex(latDir) {
@@ -11,11 +12,6 @@ const defaultDependencies = {
         return runSearch(latDir, query, limit, undefined, options);
     },
 };
-function documentUrl(path, headingId) {
-    const encodedPath = path.split('/').map(encodeURIComponent).join('/');
-    const fragment = headingId ? `#${encodeURIComponent(headingId)}` : '';
-    return `/docs/${encodedPath}${fragment}`;
-}
 function viewSearchResult(latDir, match) {
     const section = match.section;
     const projectRoot = dirname(latDir);
@@ -27,7 +23,7 @@ function viewSearchResult(latDir, match) {
         path,
         breadcrumbs: [...fileBreadcrumbs, ...section.id.split('#').slice(1)],
         description: section.firstParagraph,
-        url: documentUrl(path, section.githubSlug),
+        url: documentUrl(path, section.githubSlug ?? ''),
         score: match.score ?? 0,
     };
 }

package/dist/src/view/server.d.ts

@@ -1,5 +1,6 @@
 import { type Server } from 'node:http';
-import type { CmdContext } from '../context.js';
+import { type LatServerApp } from '../../vendor/lat.md-server/index.js';
+import { type CmdContext } from '../context.js';
 import { type ViewSearch } from './search.js';
 import { type ViewStore } from './store.js';
 export declare const DEFAULT_VIEW_PORT = 4242;
@@ -9,6 +10,11 @@ export type ViewServer = {
     url: string;
     close: () => Promise<void>;
 };
+export type ViewApp = {
+    app: LatServerApp;
+    store: ViewStore;
+    close: () => Promise<void>;
+};
 export type ViewServerOptions = {
     clientDir?: string;
     git?: boolean;
@@ -18,6 +24,9 @@ export type ViewServerOptions = {
     port?: number;
     search?: ViewSearch;
     watch?: boolean;
+    externalCa?: string | Buffer;
 };
-/** Start the read-only loopback server used by `lat ui`. */
+/** Create the portable Express application used by live Lat UI servers. */
+export declare function createViewApp(ctx: CmdContext, options?: ViewServerOptions): Promise<ViewApp>;
+/** Start the loopback server used by `lat ui`. */
 export declare function startViewServer(ctx: CmdContext, options?: ViewServerOptions): Promise<ViewServer>;

package/dist/src/view/server.js

@@ -1,22 +1,22 @@
 import { readFile } from 'node:fs/promises';
-import { createServer } from 'node:http';
+import { randomUUID } from 'node:crypto';
 import { extname, join, relative, resolve, sep } from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { createLatServerApp, listenLatServer, } from '../../vendor/lat.md-server/index.js';
+import { plainStyler } from '../context.js';
+import { sectionCommand } from '../cli/section.js';
 import { DEFAULT_VIEW_LOGO_TEXT, } from './protocol.js';
-import { ViewDocumentNotFoundError, ViewSourceNotFoundError, } from './repository.js';
+import { ViewDocumentConflictError } from './document-edit.js';
+import { ViewExternalNotFoundError, ViewDocumentNotFoundError, ViewSourceNotFoundError, } from './repository.js';
 import { createViewSearch } from './search.js';
 import { createViewStore } from './store.js';
+import { rewriteClientAssetUrls } from './client-shell.js';
+import { documentResourcePath, documentUrl, rawDocumentPath, } from './document-route.js';
 const DEFAULT_HOST = '127.0.0.1';
 export const DEFAULT_VIEW_PORT = 4242;
+const MAX_DOCUMENT_EDIT_BODY_BYTES = 16 * 1024 * 1024;
+const MAX_DOCUMENT_CONTENT_LENGTH = 8 * 1024 * 1024;
 const defaultClientDir = fileURLToPath(new URL('./client/', import.meta.url));
-function documentUrl(path) {
-    return `/docs/${path.split('/').map(encodeURIComponent).join('/')}`;
-}
-function setSecurityHeaders(res) {
-    res.setHeader('Content-Security-Policy', "default-src 'self'; img-src 'self' data:; style-src 'self' 'unsafe-inline'; worker-src 'self' blob:; object-src 'none'; base-uri 'none'; frame-ancestors 'none'");
-    res.setHeader('Referrer-Policy', 'no-referrer');
-    res.setHeader('X-Content-Type-Options', 'nosniff');
-}
 function send(res, status, contentType, body, headOnly = false) {
     res.statusCode = status;
     res.setHeader('Content-Type', contentType);
@@ -27,6 +27,24 @@ function sendJson(res, status, value, headOnly) {
     res.setHeader('Cache-Control', 'no-store');
     send(res, status, 'application/json; charset=utf-8', JSON.stringify(value), headOnly);
 }
+async function readJsonBody(req) {
+    const chunks = [];
+    let size = 0;
+    for await (const value of req) {
+        const chunk = Buffer.isBuffer(value) ? value : Buffer.from(value);
+        size += chunk.byteLength;
+        if (size > MAX_DOCUMENT_EDIT_BODY_BYTES) {
+            throw new RangeError('Document edit is too large');
+        }
+        chunks.push(chunk);
+    }
+    try {
+        return JSON.parse(Buffer.concat(chunks).toString('utf8'));
+    }
+    catch {
+        throw new SyntaxError('Document edit must be valid JSON');
+    }
+}
 function contentType(path) {
     switch (extname(path)) {
         case '.css':
@@ -37,8 +55,17 @@ function contentType(path) {
             return 'text/javascript; charset=utf-8';
         case '.json':
             return 'application/json; charset=utf-8';
+        case '.gif':
+            return 'image/gif';
+        case '.jpeg':
+        case '.jpg':
+            return 'image/jpeg';
+        case '.png':
+            return 'image/png';
         case '.svg':
             return 'image/svg+xml';
+        case '.webp':
+            return 'image/webp';
         case '.woff2':
             return 'font/woff2';
         default:
@@ -71,23 +98,20 @@ async function sendClientFile(res, path, headOnly, immutable = false) {
         send(res, 404, 'text/plain; charset=utf-8', 'Not found', headOnly);
     }
 }
-function listen(server, host, port) {
-    return new Promise((resolveListen, reject) => {
-        const onError = (error) => {
-            server.off('listening', onListening);
-            reject(error);
-        };
-        const onListening = () => {
-            server.off('error', onError);
-            resolveListen();
-        };
-        server.once('error', onError);
-        server.once('listening', onListening);
-        server.listen(port, host);
-    });
+async function sendClientShell(res, path, headOnly) {
+    try {
+        const body = rewriteClientAssetUrls(await readFile(path, 'utf8'), '/');
+        res.setHeader('Cache-Control', 'no-cache');
+        send(res, 200, 'text/html; charset=utf-8', body, headOnly);
+    }
+    catch (error) {
+        if (error.code !== 'ENOENT')
+            throw error;
+        send(res, 404, 'text/plain; charset=utf-8', 'Not found', headOnly);
+    }
 }
-/** Start the read-only loopback server used by `lat ui`. */
-export async function startViewServer(ctx, options = {}) {
+/** Create the portable Express application used by live Lat UI servers. */
+export async function createViewApp(ctx, options = {}) {
     const host = options.host ?? DEFAULT_HOST;
     const clientDir = options.clientDir ?? defaultClientDir;
     const logoText = options.logoText ?? DEFAULT_VIEW_LOGO_TEXT;
@@ -95,27 +119,34 @@ export async function startViewServer(ctx, options = {}) {
         git: options.git,
         gitPollMs: options.gitPollMs,
         watch: options.watch,
+        externalCa: options.externalCa,
     });
     const search = options.search ??
         createViewSearch(ctx.latDir, undefined, () => store.markdownGeneration);
     const eventClients = new Set();
+    const instanceId = randomUUID();
     const broadcastChange = (change) => {
-        const message = `event: change\ndata: ${JSON.stringify(change)}\n\n`;
+        const message = `event: change\ndata: ${JSON.stringify({ ...change, instanceId })}\n\n`;
         for (const client of eventClients)
             client.write(message);
     };
     const unsubscribeStore = store.subscribe(broadcastChange);
-    const server = createServer((req, res) => {
+    const heartbeat = setInterval(() => {
+        for (const client of eventClients)
+            client.write(': heartbeat\n\n');
+    }, 15_000);
+    heartbeat.unref();
+    const handleRequest = (req, res) => {
         void (async () => {
-            setSecurityHeaders(res);
             const method = req.method ?? 'GET';
             const headOnly = method === 'HEAD';
-            if (method !== 'GET' && !headOnly) {
+            const url = new URL(req.url ?? '/', `http://${host}`);
+            const documentEdit = method === 'PATCH' && url.pathname === '/api/document';
+            if (method !== 'GET' && !headOnly && !documentEdit) {
                 res.setHeader('Allow', 'GET, HEAD');
                 send(res, 405, 'text/plain; charset=utf-8', 'Method not allowed');
                 return;
             }
-            const url = new URL(req.url ?? '/', `http://${host}`);
             if (url.pathname === '/') {
                 const entry = store.getIndex().entry;
                 if (!entry) {
@@ -146,12 +177,52 @@ export async function startViewServer(ctx, options = {}) {
                     return;
                 }
                 eventClients.add(res);
-                res.write(`event: ready\ndata: ${JSON.stringify({ generation: store.snapshot.generation, markdownGeneration: store.markdownGeneration })}\n\n`);
+                res.write(`retry: 1000\nevent: ready\ndata: ${JSON.stringify({ instanceId, generation: store.snapshot.generation, markdownGeneration: store.markdownGeneration })}\n\n`);
                 req.once('close', () => eventClients.delete(res));
                 return;
             }
             if (url.pathname === '/api/document') {
                 const path = url.searchParams.get('path') ?? '';
+                if (documentEdit) {
+                    let body;
+                    try {
+                        body = await readJsonBody(req);
+                    }
+                    catch (error) {
+                        sendJson(res, error instanceof RangeError ? 413 : 400, { error: error.message }, false);
+                        return;
+                    }
+                    if (!body ||
+                        typeof body !== 'object' ||
+                        typeof body.baseContent !==
+                            'string' ||
+                        typeof body.content !==
+                            'string') {
+                        sendJson(res, 400, {
+                            error: 'Document edit content is required',
+                        }, false);
+                        return;
+                    }
+                    const edit = body;
+                    if (edit.baseContent.length > MAX_DOCUMENT_CONTENT_LENGTH ||
+                        edit.content.length > MAX_DOCUMENT_CONTENT_LENGTH) {
+                        sendJson(res, 413, { error: 'Document edit is too large' }, false);
+                        return;
+                    }
+                    try {
+                        sendJson(res, 200, await store.editDocument(path, edit.baseContent, edit.content), false);
+                    }
+                    catch (error) {
+                        if (error instanceof ViewDocumentConflictError) {
+                            sendJson(res, 409, { error: error.message }, false);
+                            return;
+                        }
+                        if (!(error instanceof ViewDocumentNotFoundError))
+                            throw error;
+                        sendJson(res, 404, { error: error.message }, false);
+                    }
+                    return;
+                }
                 try {
                     sendJson(res, 200, await store.getDocument(path), headOnly);
                 }
@@ -162,6 +233,18 @@ export async function startViewServer(ctx, options = {}) {
                 }
                 return;
             }
+            if (url.pathname === '/api/document-source') {
+                const path = url.searchParams.get('path') ?? '';
+                try {
+                    sendJson(res, 200, await store.getDocumentSource(path), headOnly);
+                }
+                catch (error) {
+                    if (!(error instanceof ViewDocumentNotFoundError))
+                        throw error;
+                    sendJson(res, 404, { error: error.message }, headOnly);
+                }
+                return;
+            }
             if (url.pathname === '/api/search') {
                 const query = (url.searchParams.get('query') ?? '').trim();
                 if (query.length > 500) {
@@ -171,6 +254,30 @@ export async function startViewServer(ctx, options = {}) {
                 sendJson(res, 200, await search(query), headOnly);
                 return;
             }
+            if (url.pathname === '/api/section') {
+                const query = (url.searchParams.get('query') ?? '').trim();
+                if (!query) {
+                    sendJson(res, 400, { error: 'Section ID is required' }, headOnly);
+                    return;
+                }
+                if (query.length > 1_000) {
+                    sendJson(res, 400, { error: 'Section ID is too long' }, headOnly);
+                    return;
+                }
+                const result = await sectionCommand({
+                    latDir: ctx.latDir,
+                    projectRoot: ctx.projectRoot,
+                    styler: plainStyler,
+                    mode: 'cli',
+                }, query);
+                const tree = await store.renderSectionOutput(result.output, query);
+                sendJson(res, 200, {
+                    output: result.output,
+                    tree,
+                    isError: result.isError === true,
+                }, headOnly);
+                return;
+            }
             if (url.pathname === '/api/source') {
                 const path = url.searchParams.get('path') ?? '';
                 const symbol = url.searchParams.get('symbol') ?? '';
@@ -193,6 +300,18 @@ export async function startViewServer(ctx, options = {}) {
                 }
                 return;
             }
+            if (url.pathname === '/api/external') {
+                const target = url.searchParams.get('target') ?? '';
+                try {
+                    sendJson(res, 200, await store.getExternal(target), headOnly);
+                }
+                catch (error) {
+                    if (!(error instanceof ViewExternalNotFoundError))
+                        throw error;
+                    sendJson(res, 404, { error: error.message }, headOnly);
+                }
+                return;
+            }
             if (url.pathname.startsWith('/assets/')) {
                 const path = clientPath(clientDir, url.pathname);
                 if (!path) {
@@ -202,11 +321,40 @@ export async function startViewServer(ctx, options = {}) {
                 await sendClientFile(res, path, headOnly, true);
                 return;
             }
+            const rawMarkdownPath = rawDocumentPath(url.pathname);
+            if (rawMarkdownPath) {
+                try {
+                    const source = await store.getDocumentSource(rawMarkdownPath);
+                    res.setHeader('Cache-Control', 'no-cache');
+                    send(res, 200, 'text/markdown; charset=utf-8', source.content, headOnly);
+                }
+                catch (error) {
+                    if (!(error instanceof ViewDocumentNotFoundError))
+                        throw error;
+                    send(res, 404, 'text/plain; charset=utf-8', error.message, headOnly);
+                }
+                return;
+            }
+            const resourcePath = documentResourcePath(url.pathname);
+            if (resourcePath) {
+                try {
+                    const body = await store.getDocumentResource(resourcePath);
+                    res.setHeader('Cache-Control', 'no-cache');
+                    send(res, 200, contentType(resourcePath), body, headOnly);
+                }
+                catch (error) {
+                    if (!(error instanceof ViewDocumentNotFoundError))
+                        throw error;
+                    send(res, 404, 'text/plain; charset=utf-8', error.message, headOnly);
+                }
+                return;
+            }
             if (url.pathname === '/search' ||
                 url.pathname === '/graph' ||
                 url.pathname.startsWith('/docs/') ||
-                url.pathname.startsWith('/code/')) {
-                await sendClientFile(res, join(clientDir, 'index.html'), headOnly);
+                url.pathname.startsWith('/code/') ||
+                url.pathname.startsWith('/external/')) {
+                await sendClientShell(res, join(clientDir, 'index.html'), headOnly);
                 return;
             }
             send(res, 404, 'text/plain; charset=utf-8', 'Not found', headOnly);
@@ -217,50 +365,44 @@ export async function startViewServer(ctx, options = {}) {
             }
             sendJson(res, 500, { error: error.message }, false);
         });
-    });
-    try {
-        const requestedPort = options.port;
-        let port = requestedPort ?? DEFAULT_VIEW_PORT;
-        while (true) {
-            try {
-                await listen(server, host, port);
-                break;
-            }
-            catch (error) {
-                if (requestedPort !== undefined ||
-                    error.code !== 'EADDRINUSE' ||
-                    port === 65_535) {
-                    throw error;
-                }
-                port++;
-            }
-        }
-    }
-    catch (error) {
-        unsubscribeStore();
-        await store.close();
-        throw error;
-    }
-    const address = server.address();
-    if (!address || typeof address === 'string') {
-        await new Promise((resolveClose) => server.close(() => resolveClose()));
-        unsubscribeStore();
-        await store.close();
-        throw new Error('Could not determine lat ui server address');
-    }
+    };
+    const app = createLatServerApp({ handle: handleRequest });
     return {
-        server,
+        app,
         store,
-        url: `http://${host}:${address.port}/`,
         close: async () => {
+            clearInterval(heartbeat);
             unsubscribeStore();
             for (const client of eventClients)
                 client.end();
             eventClients.clear();
             await store.close();
-            await new Promise((resolveClose, reject) => {
-                server.close((error) => (error ? reject(error) : resolveClose()));
-            });
+        },
+    };
+}
+/** Start the loopback server used by `lat ui`. */
+export async function startViewServer(ctx, options = {}) {
+    const host = options.host ?? DEFAULT_HOST;
+    const view = await createViewApp(ctx, options);
+    let running;
+    try {
+        const requestedPort = options.port;
+        running = await listenLatServer(view.app, {
+            host,
+            port: requestedPort ?? DEFAULT_VIEW_PORT,
+            findAvailablePort: requestedPort === undefined,
+        });
+    }
+    catch (error) {
+        await view.close();
+        throw error;
+    }
+    return {
+        server: running.server,
+        store: view.store,
+        url: running.url,
+        close: async () => {
+            await Promise.all([running.close(), view.close()]);
         },
     };
 }

package/dist/src/view/source-target.js

@@ -1,16 +1,13 @@
-import { extname, posix } from 'node:path';
-import { SOURCE_EXTENSIONS } from '../source-parser.js';
+import { extname } from 'node:path';
+import { normalizeRepositoryPath } from '../repository-path.js';
+import { isSourceFileExtension } from '../source-formats.js';
 /** Normalize a supported source wiki-link target for view indexes and routes. */
 export function viewSourceTarget(target) {
     const hash = target.indexOf('#');
     const authoredPath = hash === -1 ? target : target.slice(0, hash);
-    if (!authoredPath ||
-        authoredPath.includes('\\') ||
-        posix.isAbsolute(authoredPath) ||
-        !SOURCE_EXTENSIONS.has(extname(authoredPath))) {
+    const path = normalizeRepositoryPath(authoredPath);
+    if (!path || !isSourceFileExtension(extname(path)))
         return null;
-    }
-    const path = posix.normalize(authoredPath).replace(/^\.\//, '');
     const symbol = hash === -1 ? '' : target.slice(hash + 1);
     const fileKey = path.toLowerCase();
     return {

package/dist/src/view/static-build.d.ts

@@ -3,6 +3,7 @@ export type StaticViewBuildOptions = {
     basePath?: string;
     clientDir?: string;
     logoText?: string;
+    externalCa?: string | Buffer;
 };
 export type StaticViewBuildResult = {
     documents: number;