npm - @luckystack/docs-ui - Versions diffs - 0.1.9 → 0.2.0 - Mend

@luckystack/docs-ui 0.1.9 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/CHANGELOG.md +14 -14
package/CLAUDE.md +55 -55
package/LICENSE +21 -21
package/README.md +86 -86
package/dist/chunk-IL5ERE5J.js +578 -0
package/dist/chunk-IL5ERE5J.js.map +1 -0
package/dist/index.d.ts +7 -0
package/dist/index.js +3 -447
package/dist/index.js.map +1 -1
package/dist/register.d.ts +2 -0
package/dist/register.js +8 -0
package/dist/register.js.map +1 -0
package/docs/html-generation.md +9 -6
package/package.json +16 -3

package/dist/index.d.ts CHANGED Viewed

@@ -58,6 +58,13 @@ interface MountDocsUiOptions {
      * runner needs a logged-in session.
      */
     enableTryItOut?: boolean;
+    /**
+     * Optional per-request authorization hook. Called after the env/bind-address
+     * gate passes. Return `true` to allow the request, `false` to serve 403.
+     * Use to restrict docs access to authenticated or IP-allowlisted callers on
+     * non-loopback deployments.
+     */
+    authorize?: (req: IncomingMessage) => boolean | Promise<boolean>;
 }
 type DocsRouteHandler = (req: IncomingMessage, res: ServerResponse) => Promise<boolean>;
 /**

package/dist/index.js CHANGED Viewed

@@ -1,450 +1,6 @@
-// src/index.ts
-import fs from "fs/promises";
-import { getGeneratedApiDocsPath, tryCatch } from "@luckystack/core";
-// src/docsHtml.ts
-var renderDocsHtml = (jsonPath, pageTitle, options = {}) => {
-  const branding = options.branding ?? {};
-  const accent = branding.brandColor ?? "#58a6ff";
-  const fontFamily = branding.fontFamily ?? `system-ui, -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif`;
-  const logoMarkup = branding.logoUrl ? `<img src="${escapeHtml(branding.logoUrl)}" alt="logo" style="height:32px;width:auto;margin-right:12px;" />` : "";
-  const tryItOutData = options.enableTryItOut ? "true" : "false";
-  return `<!DOCTYPE html>
-<html lang="en">
-<head>
-<meta charset="utf-8" />
-<meta name="viewport" content="width=device-width, initial-scale=1" />
-<title>${escapeHtml(pageTitle)}</title>
-<style>
-  :root {
-    --bg: #0e1116;
-    --container: #161b22;
-    --container-hover: #1c232b;
-    --border: #2a313c;
-    --title: #e6edf3;
-    --common: #c9d1d9;
-    --muted: #8b949e;
-    --accent: ${accent};
-    --font-family: ${fontFamily};
-    --get: #3fb950;
-    --post: ${accent};
-    --put: #d29922;
-    --delete: #f85149;
-  }
-  @media (prefers-color-scheme: light) {
-    :root {
-      --bg: #ffffff;
-      --container: #f6f8fa;
-      --container-hover: #eaeef2;
-      --border: #d0d7de;
-      --title: #1f2328;
-      --common: #1f2328;
-      --muted: #59636e;
-    }
-  }
-  * { box-sizing: border-box; }
-  body {
-    margin: 0; padding: 0;
-    font-family: var(--font-family);
-    background: var(--bg); color: var(--common);
-    line-height: 1.5;
-  }
-  .brand-row { display: flex; align-items: center; }
-  .try-it-out { margin-top: 12px; padding: 12px; background: var(--container-hover); border: 1px solid var(--border); border-radius: 6px; }
-  .try-it-out textarea { width: 100%; min-height: 80px; background: var(--bg); color: var(--common); border: 1px solid var(--border); padding: 6px; font-family: ui-monospace, monospace; font-size: 12px; }
-  .try-it-out button { margin-top: 6px; padding: 6px 12px; background: var(--accent); color: white; border: 0; border-radius: 4px; cursor: pointer; }
-  .try-it-out pre.result { margin-top: 8px; padding: 8px; background: var(--bg); border: 1px solid var(--border); border-radius: 4px; max-height: 240px; overflow: auto; font-size: 12px; }
-  .layout {
-    max-width: 1200px;
-    margin: 0 auto;
-    padding: 32px 24px 96px;
-  }
-  h1 { color: var(--title); margin: 0 0 4px; font-size: 28px; }
-  .lead { color: var(--muted); margin: 0 0 32px; font-size: 14px; }
-  .summary { display: flex; gap: 24px; margin-bottom: 24px; flex-wrap: wrap; }
-  .summary-pill {
-    background: var(--container);
-    border: 1px solid var(--border);
-    padding: 8px 14px;
-    border-radius: 8px;
-    font-size: 13px;
-  }
-  .summary-pill strong { color: var(--title); }
-  .filter-bar {
-    margin-bottom: 24px;
-    display: flex;
-    gap: 12px;
-    align-items: center;
-  }
-  input[type="search"] {
-    flex: 1;
-    background: var(--container);
-    border: 1px solid var(--border);
-    color: var(--common);
-    padding: 10px 14px;
-    border-radius: 8px;
-    font-size: 14px;
-    font-family: inherit;
-  }
-  input[type="search"]:focus {
-    outline: none;
-    border-color: var(--accent);
-  }
-  .group {
-    margin-bottom: 24px;
-    background: var(--container);
-    border: 1px solid var(--border);
-    border-radius: 12px;
-    overflow: hidden;
-  }
-  .group-header {
-    padding: 12px 18px;
-    background: var(--container-hover);
-    font-size: 13px;
-    font-weight: 600;
-    color: var(--muted);
-    text-transform: uppercase;
-    letter-spacing: 0.04em;
-    border-bottom: 1px solid var(--border);
-  }
-  .endpoint {
-    padding: 14px 18px;
-    border-bottom: 1px solid var(--border);
-    font-family: ui-monospace, SFMono-Regular, "SF Mono", Consolas, monospace;
-    font-size: 13px;
-    cursor: pointer;
-    transition: background 80ms;
-  }
-  .endpoint:last-child { border-bottom: none; }
-  .endpoint:hover { background: var(--container-hover); }
-  .endpoint-summary { display: flex; align-items: center; gap: 12px; }
-  .method {
-    display: inline-block;
-    min-width: 56px;
-    padding: 2px 8px;
-    border-radius: 4px;
-    font-size: 11px;
-    font-weight: 700;
-    text-align: center;
-    color: #fff;
-  }
-  .method.GET    { background: var(--get); }
-  .method.POST   { background: var(--post); }
-  .method.PUT    { background: var(--put); color: #1f2328; }
-  .method.DELETE { background: var(--delete); }
-  .endpoint-name { color: var(--title); font-weight: 500; }
-  .endpoint-meta { margin-left: auto; color: var(--muted); font-size: 12px; }
-  .endpoint-detail {
-    margin-top: 12px;
-    padding: 12px;
-    background: var(--bg);
-    border-radius: 8px;
-    border: 1px solid var(--border);
-    display: none;
-    white-space: pre-wrap;
-    word-break: break-word;
-  }
-  .endpoint.open .endpoint-detail { display: block; }
-  .detail-section { margin-bottom: 12px; }
-  .detail-section:last-child { margin-bottom: 0; }
-  .detail-label {
-    color: var(--muted);
-    font-size: 11px;
-    text-transform: uppercase;
-    letter-spacing: 0.04em;
-    margin-bottom: 4px;
-  }
-  pre {
-    margin: 0;
-    color: var(--common);
-    font-size: 12px;
-    overflow-x: auto;
-  }
-  .auth-tag {
-    display: inline-block;
-    padding: 1px 6px;
-    border-radius: 4px;
-    background: var(--container-hover);
-    color: var(--muted);
-    font-size: 11px;
-    margin-right: 4px;
-  }
-  .empty {
-    padding: 48px;
-    text-align: center;
-    color: var(--muted);
-  }
-  a.json-link { color: var(--accent); }
-</style>
-</head>
-<body>
-<div class="layout">
-  <div class="brand-row">${logoMarkup}<h1>${escapeHtml(pageTitle)}</h1></div>
-  <p class="lead">Generated from <code>apiDocs.generated.json</code>. Raw JSON: <a class="json-link" href="${escapeHtml(jsonPath)}">${escapeHtml(jsonPath)}</a></p>
-  <div class="summary" id="summary"></div>
-  <div class="filter-bar">
-    <input type="search" id="filter" placeholder="Filter by route name\u2026" autofocus />
-  </div>
-  <div id="content"></div>
-</div>
-<script>
-  const JSON_PATH = ${JSON.stringify(jsonPath)};
-  const ENABLE_TRY_IT_OUT = ${tryItOutData};
-  const stateByKey = new Map();
-  //? Inline runner: hits the live server using the same fetch transport
-  //? that the framework apiRequest helper uses. Auth comes from the
-  //? browser's existing session cookie or sessionStorage; no token prompt.
-  const runEndpoint = async (button, route, version, dataField) => {
-    let parsed;
-    try {
-      parsed = dataField.value.trim().length === 0 ? {} : JSON.parse(dataField.value);
-    } catch (err) {
-      const resultEl = button.parentElement.querySelector('pre.result');
-      resultEl.textContent = 'JSON parse error: ' + err.message;
-      return;
-    }
-    button.disabled = true;
-    const resultEl = button.parentElement.querySelector('pre.result');
-    resultEl.textContent = 'Sending...';
-    try {
-      const response = await fetch('/' + route + '?stream=false', {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        credentials: 'include',
-        body: JSON.stringify(parsed),
-      });
-      const text = await response.text();
-      try {
-        resultEl.textContent = JSON.stringify(JSON.parse(text), null, 2);
-      } catch {
-        resultEl.textContent = text;
-      }
-    } catch (err) {
-      resultEl.textContent = 'Network error: ' + err.message;
-    } finally {
-      button.disabled = false;
-    }
-  };
-  const renderTryItOut = (route, version) => {
-    if (!ENABLE_TRY_IT_OUT) return '';
-    return '<div class="try-it-out">' +
-      '<div style="font-weight:600;font-size:12px;margin-bottom:4px;">Try it out (live request)</div>' +
-      '<textarea placeholder=\\'{"key":"value"}\\'>{}</textarea>' +
-      '<button onclick="runEndpoint(this,\\'' + route + '\\',\\'' + version + '\\',this.previousElementSibling)">Send</button>' +
-      '<pre class="result"></pre>' +
-      '</div>';
-  };
-  const escapeHtml = (str) => String(str).replace(/[&<>"']/g, (c) => ({
-    '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&#39;'
-  })[c]);
-  const renderAuth = (auth) => {
-    if (!auth) return '<span class="auth-tag">public</span>';
-    const tags = [];
-    if (auth.login) tags.push('login required');
-    if (Array.isArray(auth.additional)) {
-      for (const rule of auth.additional) {
-        if (rule.key) tags.push(rule.key + (rule.value !== undefined ? '=' + JSON.stringify(rule.value) : ''));
-      }
-    }
-    if (tags.length === 0) tags.push('public');
-    return tags.map(t => '<span class="auth-tag">' + escapeHtml(t) + '</span>').join('');
-  };
-  const renderEndpoint = (page, name, version, meta) => {
-    const key = page + '/' + name + '@' + version;
-    const method = (meta.method || 'POST').toUpperCase();
-    const rate = meta.rateLimit;
-    const rateLabel = rate === false ? 'no rate limit' : rate === undefined ? 'default rate' : (rate + '/min');
-    const isOpen = stateByKey.get(key) === true;
-    const path = '/api/' + page + '/' + name + '/' + version;
-    return \`
-      <div class="endpoint \${isOpen ? 'open' : ''}" data-key="\${escapeHtml(key)}">
-        <div class="endpoint-summary">
-          <span class="method \${method}">\${method}</span>
-          <span class="endpoint-name">\${escapeHtml(path)}</span>
-          <span class="endpoint-meta">\${escapeHtml(rateLabel)}</span>
-        </div>
-        <div class="endpoint-detail">
-          <div class="detail-section">
-            <div class="detail-label">auth</div>
-            <div>\${renderAuth(meta.auth)}</div>
-          </div>
-          <div class="detail-section">
-            <div class="detail-label">input</div>
-            <pre>\${escapeHtml(meta.input || '{}')}</pre>
-          </div>
-          <div class="detail-section">
-            <div class="detail-label">output</div>
-            <pre>\${escapeHtml(meta.output || 'unknown')}</pre>
-          </div>
-          \${meta.stream ? \`
-            <div class="detail-section">
-              <div class="detail-label">stream</div>
-              <pre>\${escapeHtml(meta.stream)}</pre>
-            </div>
-          \` : ''}
-          \${meta.owner ? \`
-            <div class="detail-section">
-              <div class="detail-label">owner</div>
-              <div>\${escapeHtml(meta.owner)}</div>
-            </div>
-          \` : ''}
-          \${meta.tags && meta.tags.length ? \`
-            <div class="detail-section">
-              <div class="detail-label">tags</div>
-              <div>\${meta.tags.map(t => '<span class="badge">' + escapeHtml(String(t)) + '</span>').join(' ')}</div>
-            </div>
-          \` : ''}
-          \${meta.deprecated ? \`
-            <div class="detail-section">
-              <div class="detail-label">deprecated</div>
-              <div style="color:var(--delete);">\${escapeHtml(String(meta.deprecated))}</div>
-            </div>
-          \` : ''}
-          \${renderTryItOut(page + '/' + name + '/' + version, version)}
-        </div>
-      </div>
-    \`;
-  };
-  const passesFilter = (filter, page, name) => {
-    if (!filter) return true;
-    const haystack = (page + '/' + name).toLowerCase();
-    return haystack.includes(filter.toLowerCase());
-  };
-  const render = (data, filter) => {
-    const summary = document.getElementById('summary');
-    const content = document.getElementById('content');
-    const apis = data && data.apis ? data.apis : data;
-    if (!apis || typeof apis !== 'object') {
-      content.innerHTML = '<div class="empty">No API docs available. Run <code>npm run generateArtifacts</code> to generate them.</div>';
-      summary.innerHTML = '';
-      return;
-    }
-    let total = 0;
-    let visible = 0;
-    const groups = [];
-    for (const [page, names] of Object.entries(apis)) {
-      const rows = [];
-      for (const [name, versions] of Object.entries(names)) {
-        for (const [version, meta] of Object.entries(versions)) {
-          total++;
-          if (!passesFilter(filter, page, name)) continue;
-          visible++;
-          rows.push(renderEndpoint(page, name, version, meta || {}));
-        }
-      }
-      if (rows.length > 0) {
-        groups.push(\`
-          <div class="group">
-            <div class="group-header">\${escapeHtml(page)}</div>
-            \${rows.join('')}
-          </div>
-        \`);
-      }
-    }
-    summary.innerHTML = \`
-      <div class="summary-pill"><strong>\${visible}</strong> of <strong>\${total}</strong> endpoints</div>
-      <div class="summary-pill"><strong>\${Object.keys(apis).length}</strong> pages</div>
-    \`;
-    content.innerHTML = groups.join('') || '<div class="empty">No matches.</div>';
-    document.querySelectorAll('.endpoint').forEach((el) => {
-      el.addEventListener('click', () => {
-        const key = el.getAttribute('data-key');
-        const next = !el.classList.contains('open');
-        stateByKey.set(key, next);
-        el.classList.toggle('open');
-      });
-    });
-  };
-  let cachedData = null;
-  document.getElementById('filter').addEventListener('input', (e) => {
-    if (cachedData) render(cachedData, e.target.value);
-  });
-  fetch(JSON_PATH, { credentials: 'include' })
-    .then(r => r.ok ? r.json() : Promise.reject(new Error(String(r.status))))
-    .then(data => { cachedData = data; render(data, ''); })
-    .catch(err => {
-      document.getElementById('content').innerHTML =
-        '<div class="empty">Could not load API docs: ' + escapeHtml(err.message) + '</div>';
-    });
-</script>
-</body>
-</html>`;
-};
-var HTML_ESCAPE_MAP = {
-  "&": "&amp;",
-  "<": "&lt;",
-  ">": "&gt;",
-  '"': "&quot;",
-  "'": "&#39;"
-};
-var escapeHtml = (str) => str.replaceAll(/[&<>"']/g, (c) => HTML_ESCAPE_MAP[c] ?? c);
-// src/index.ts
-var mountDocsUi = (options = {}) => {
-  const routePath = options.routePath ?? "/_docs";
-  const jsonPath = `${routePath}/api.json`;
-  return async (req, res) => {
-    const url = req.url ?? "";
-    const [pathOnly] = url.split("?");
-    if (pathOnly !== routePath && pathOnly !== jsonPath) {
-      return false;
-    }
-    if (process.env.NODE_ENV === "production" && !options.enabledInProd) {
-      res.statusCode = 404;
-      res.setHeader("Content-Type", "text/plain");
-      res.end("Not Found");
-      return true;
-    }
-    if (req.method !== "GET") {
-      res.statusCode = 405;
-      res.setHeader("Content-Type", "text/plain");
-      res.end("Method Not Allowed");
-      return true;
-    }
-    if (pathOnly === jsonPath) {
-      const docsPath = options.apiDocsPath ?? getGeneratedApiDocsPath();
-      const [readError, content] = await tryCatch(() => fs.readFile(docsPath, "utf8"));
-      if (readError) {
-        res.statusCode = 404;
-        res.setHeader("Content-Type", "application/json");
-        res.end(JSON.stringify({
-          error: "apiDocs.generated.json not found",
-          expectedAt: docsPath,
-          hint: "Run `npm run generateArtifacts` to generate it."
-        }));
-      } else {
-        res.statusCode = 200;
-        res.setHeader("Content-Type", "application/json");
-        res.setHeader("Cache-Control", "no-store");
-        res.end(content);
-      }
-      return true;
-    }
-    const title = options.pageTitle ?? "LuckyStack \u2014 API docs";
-    const branding = options.branding ?? {};
-    res.statusCode = 200;
-    res.setHeader("Content-Type", "text/html; charset=utf-8");
-    res.setHeader("Cache-Control", "no-store");
-    const html = options.template ? options.template({ jsonPath, pageTitle: title, branding }) : renderDocsHtml(jsonPath, title, {
-      branding,
-      enableTryItOut: options.enableTryItOut ?? false
-    });
-    res.end(html);
-    return true;
-  };
-};
+import {
+  mountDocsUi
+} from "./chunk-IL5ERE5J.js";
 export {
   mountDocsUi
 };

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/index.ts","../src/docsHtml.ts"],"sourcesContent":["//? Dev-only API docs UI for LuckyStack.\r\n//?\r\n//? Mounts a single page at `/_docs` (configurable) that fetches the\r\n//? framework's `apiDocs.generated.json` and renders every API endpoint\r\n//? grouped by page, with method, auth, rate limit, input shape, and\r\n//? output shape.\r\n//?\r\n//? Usage:\r\n//? // luckystack/docs-ui/index.ts\r\n//? import { mountDocsUi } from '@luckystack/docs-ui';\r\n//? mountDocsUi(); // Auto-disables in production unless { enabledInProd: true }\r\n//?\r\n//? The mount function returns a `customRoutes` handler — pass it to\r\n//? `createLuckyStackServer({ customRoutes })` (or compose with another\r\n//? handler if you have one). It honors the request only when the URL\r\n//? matches the configured `routePath`; everything else falls through.\r\n\r\nimport fs from 'node:fs/promises';\r\nimport type { IncomingMessage, ServerResponse } from 'node:http';\r\nimport { getGeneratedApiDocsPath, tryCatch } from '@luckystack/core';\r\nimport { renderDocsHtml } from './docsHtml';\r\n\r\nexport interface DocsBranding {\r\n /** Logo URL shown in the header. PNG / SVG / data: URLs all accepted. /\r\n logoUrl?: string;\r\n /* CSS color for the header / accent (`#hex` or `rgb()` literal). /\r\n brandColor?: string;\r\n /* Web-safe font family for the page. /\r\n fontFamily?: string;\r\n}\r\n\r\n/\r\n Custom HTML builder. Receives the JSON-endpoint path the page should\r\n * fetch from + page title + branding; returns the full HTML document\r\n * (`<!doctype html>` + everything). Use to swap layout entirely (sidebar\r\n * vs tabs, dark/light theme, embedded auth-token field).\r\n /\r\nexport type DocsTemplateBuilder = (input: {\r\n jsonPath: string;\r\n pageTitle: string;\r\n branding: DocsBranding;\r\n}) => string;\r\n\r\nexport interface MountDocsUiOptions {\r\n /* Path the docs UI is served from. Default: `/_docs`. /\r\n routePath?: string;\r\n /\r\n Page title shown in the header + browser tab. Defaults to\r\n * \"LuckyStack — API docs\". Pass an explicit string to brand for a consumer.\r\n /\r\n pageTitle?: string;\r\n /\r\n Allow rendering the docs UI in production. Default: false. Useful only\r\n * when the docs are intentionally public (developer-portal, internal-only\r\n * deployment, etc.). When false, the route returns 404 in production.\r\n /\r\n enabledInProd?: boolean;\r\n /\r\n Override the path to `apiDocs.generated.json`. Defaults to whatever\r\n * `getGeneratedApiDocsPath()` resolves to via ProjectConfig.paths.\r\n /\r\n apiDocsPath?: string;\r\n /\r\n Optional branding inputs (logo, brand color, font). Applied by the\r\n * default template. Custom templates may ignore these.\r\n /\r\n branding?: DocsBranding;\r\n /\r\n Custom HTML template builder. When provided, the default `renderDocsHtml`\r\n * is bypassed entirely. Use for radically different layouts (sidebar,\r\n * tabs, dark mode, marketing-page-style). Receives a tested JSON path +\r\n * title + branding so your template doesn't need to know about\r\n * `getGeneratedApiDocsPath`.\r\n /\r\n template?: DocsTemplateBuilder;\r\n /\r\n Enable the inline \"try-it-out\" runner. When true, the default template\r\n * renders a request-input box + send button per endpoint that calls\r\n * `apiRequest` against the live server. Off by default because the\r\n * runner needs a logged-in session.\r\n /\r\n enableTryItOut?: boolean;\r\n}\r\n\r\nexport type DocsRouteHandler = (\r\n req: IncomingMessage,\r\n res: ServerResponse,\r\n) => Promise<boolean>;\r\n\r\n/\r\n Returns a route handler compatible with `createLuckyStackServer`'s\r\n * `customRoutes` option. The handler returns `true` (response sent) when\r\n * the URL matches the configured docs route, `false` otherwise.\r\n /\r\nexport const mountDocsUi = (options: MountDocsUiOptions = {}): DocsRouteHandler => {\r\n const routePath = options.routePath ?? '/_docs';\r\n const jsonPath = `${routePath}/api.json`;\r\n\r\n return async (req, res) => {\r\n const url = req.url ?? '';\r\n const [pathOnly] = url.split('?');\r\n\r\n if (pathOnly !== routePath && pathOnly !== jsonPath) {\r\n return false;\r\n }\r\n\r\n if (process.env.NODE_ENV === 'production' && !options.enabledInProd) {\r\n res.statusCode = 404;\r\n res.setHeader('Content-Type', 'text/plain');\r\n res.end('Not Found');\r\n return true;\r\n }\r\n\r\n if (req.method !== 'GET') {\r\n res.statusCode = 405;\r\n res.setHeader('Content-Type', 'text/plain');\r\n res.end('Method Not Allowed');\r\n return true;\r\n }\r\n\r\n if (pathOnly === jsonPath) {\r\n const docsPath = options.apiDocsPath ?? getGeneratedApiDocsPath();\r\n const [readError, content] = await tryCatch(() => fs.readFile(docsPath, 'utf8'));\r\n if (readError) {\r\n res.statusCode = 404;\r\n res.setHeader('Content-Type', 'application/json');\r\n res.end(JSON.stringify({\r\n error: 'apiDocs.generated.json not found',\r\n expectedAt: docsPath,\r\n hint: 'Run `npm run generateArtifacts` to generate it.',\r\n }));\r\n } else {\r\n res.statusCode = 200;\r\n res.setHeader('Content-Type', 'application/json');\r\n res.setHeader('Cache-Control', 'no-store');\r\n res.end(content);\r\n }\r\n return true;\r\n }\r\n\r\n //? Serve the HTML page itself. Title + branding + custom template\r\n //? layered: explicit `template` builder wins over the built-in renderer.\r\n //? Defaults render via `renderDocsHtml(jsonPath, title, { branding, enableTryItOut })`.\r\n const title = options.pageTitle ?? 'LuckyStack — API docs';\r\n const branding = options.branding ?? {};\r\n res.statusCode = 200;\r\n res.setHeader('Content-Type', 'text/html; charset=utf-8');\r\n res.setHeader('Cache-Control', 'no-store');\r\n const html = options.template\r\n ? options.template({ jsonPath, pageTitle: title, branding })\r\n : renderDocsHtml(jsonPath, title, {\r\n branding,\r\n enableTryItOut: options.enableTryItOut ?? false,\r\n });\r\n res.end(html);\r\n return true;\r\n };\r\n};\r\n","//? Embedded HTML for the docs page. Self-contained — no build-time bundler\r\n//? needed. Fetches `<routePath>/api.json` at runtime and renders the API\r\n//? catalog grouped by page. Style mirrors the framework's Tailwind tokens\r\n//? (background / container / muted / common) loosely so it doesn't look\r\n//? wildly out of place in projects that haven't customized them.\r\n\r\nexport interface RenderDocsHtmlOptions {\r\n branding?: {\r\n logoUrl?: string;\r\n brandColor?: string;\r\n fontFamily?: string;\r\n };\r\n /\r\n When true, the renderer injects an inline \"try-it-out\" form per\r\n * endpoint. The form calls `apiRequest` from `@luckystack/core` against\r\n * the live server. Disabled by default (requires a logged-in session).\r\n /\r\n enableTryItOut?: boolean;\r\n}\r\n\r\nexport const renderDocsHtml = (\r\n jsonPath: string,\r\n pageTitle: string,\r\n options: RenderDocsHtmlOptions = {},\r\n): string => {\r\n const branding = options.branding ?? {};\r\n const accent = branding.brandColor ?? '#58a6ff';\r\n const fontFamily = branding.fontFamily ?? `system-ui, -apple-system, \"Segoe UI\", Roboto, Helvetica, Arial, sans-serif`;\r\n const logoMarkup = branding.logoUrl\r\n ? `<img src=\"${escapeHtml(branding.logoUrl)}\" alt=\"logo\" style=\"height:32px;width:auto;margin-right:12px;\" />`\r\n : '';\r\n const tryItOutData = options.enableTryItOut ? 'true' : 'false';\r\n return `<!DOCTYPE html>\r\n<html lang=\"en\">\r\n<head>\r\n<meta charset=\"utf-8\" />\r\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\r\n<title>${escapeHtml(pageTitle)}</title>\r\n<style>\r\n :root {\r\n --bg: #0e1116;\r\n --container: #161b22;\r\n --container-hover: #1c232b;\r\n --border: #2a313c;\r\n --title: #e6edf3;\r\n --common: #c9d1d9;\r\n --muted: #8b949e;\r\n --accent: ${accent};\r\n --font-family: ${fontFamily};\r\n --get: #3fb950;\r\n --post: ${accent};\r\n --put: #d29922;\r\n --delete: #f85149;\r\n }\r\n @media (prefers-color-scheme: light) {\r\n :root {\r\n --bg: #ffffff;\r\n --container: #f6f8fa;\r\n --container-hover: #eaeef2;\r\n --border: #d0d7de;\r\n --title: #1f2328;\r\n --common: #1f2328;\r\n --muted: #59636e;\r\n }\r\n }\r\n { box-sizing: border-box; }\r\n body {\r\n margin: 0; padding: 0;\r\n font-family: var(--font-family);\r\n background: var(--bg); color: var(--common);\r\n line-height: 1.5;\r\n }\r\n .brand-row { display: flex; align-items: center; }\r\n .try-it-out { margin-top: 12px; padding: 12px; background: var(--container-hover); border: 1px solid var(--border); border-radius: 6px; }\r\n .try-it-out textarea { width: 100%; min-height: 80px; background: var(--bg); color: var(--common); border: 1px solid var(--border); padding: 6px; font-family: ui-monospace, monospace; font-size: 12px; }\r\n .try-it-out button { margin-top: 6px; padding: 6px 12px; background: var(--accent); color: white; border: 0; border-radius: 4px; cursor: pointer; }\r\n .try-it-out pre.result { margin-top: 8px; padding: 8px; background: var(--bg); border: 1px solid var(--border); border-radius: 4px; max-height: 240px; overflow: auto; font-size: 12px; }\r\n .layout {\r\n max-width: 1200px;\r\n margin: 0 auto;\r\n padding: 32px 24px 96px;\r\n }\r\n h1 { color: var(--title); margin: 0 0 4px; font-size: 28px; }\r\n .lead { color: var(--muted); margin: 0 0 32px; font-size: 14px; }\r\n .summary { display: flex; gap: 24px; margin-bottom: 24px; flex-wrap: wrap; }\r\n .summary-pill {\r\n background: var(--container);\r\n border: 1px solid var(--border);\r\n padding: 8px 14px;\r\n border-radius: 8px;\r\n font-size: 13px;\r\n }\r\n .summary-pill strong { color: var(--title); }\r\n .filter-bar {\r\n margin-bottom: 24px;\r\n display: flex;\r\n gap: 12px;\r\n align-items: center;\r\n }\r\n input[type=\"search\"] {\r\n flex: 1;\r\n background: var(--container);\r\n border: 1px solid var(--border);\r\n color: var(--common);\r\n padding: 10px 14px;\r\n border-radius: 8px;\r\n font-size: 14px;\r\n font-family: inherit;\r\n }\r\n input[type=\"search\"]:focus {\r\n outline: none;\r\n border-color: var(--accent);\r\n }\r\n .group {\r\n margin-bottom: 24px;\r\n background: var(--container);\r\n border: 1px solid var(--border);\r\n border-radius: 12px;\r\n overflow: hidden;\r\n }\r\n .group-header {\r\n padding: 12px 18px;\r\n background: var(--container-hover);\r\n font-size: 13px;\r\n font-weight: 600;\r\n color: var(--muted);\r\n text-transform: uppercase;\r\n letter-spacing: 0.04em;\r\n border-bottom: 1px solid var(--border);\r\n }\r\n .endpoint {\r\n padding: 14px 18px;\r\n border-bottom: 1px solid var(--border);\r\n font-family: ui-monospace, SFMono-Regular, \"SF Mono\", Consolas, monospace;\r\n font-size: 13px;\r\n cursor: pointer;\r\n transition: background 80ms;\r\n }\r\n .endpoint:last-child { border-bottom: none; }\r\n .endpoint:hover { background: var(--container-hover); }\r\n .endpoint-summary { display: flex; align-items: center; gap: 12px; }\r\n .method {\r\n display: inline-block;\r\n min-width: 56px;\r\n padding: 2px 8px;\r\n border-radius: 4px;\r\n font-size: 11px;\r\n font-weight: 700;\r\n text-align: center;\r\n color: #fff;\r\n }\r\n .method.GET { background: var(--get); }\r\n .method.POST { background: var(--post); }\r\n .method.PUT { background: var(--put); color: #1f2328; }\r\n .method.DELETE { background: var(--delete); }\r\n .endpoint-name { color: var(--title); font-weight: 500; }\r\n .endpoint-meta { margin-left: auto; color: var(--muted); font-size: 12px; }\r\n .endpoint-detail {\r\n margin-top: 12px;\r\n padding: 12px;\r\n background: var(--bg);\r\n border-radius: 8px;\r\n border: 1px solid var(--border);\r\n display: none;\r\n white-space: pre-wrap;\r\n word-break: break-word;\r\n }\r\n .endpoint.open .endpoint-detail { display: block; }\r\n .detail-section { margin-bottom: 12px; }\r\n .detail-section:last-child { margin-bottom: 0; }\r\n .detail-label {\r\n color: var(--muted);\r\n font-size: 11px;\r\n text-transform: uppercase;\r\n letter-spacing: 0.04em;\r\n margin-bottom: 4px;\r\n }\r\n pre {\r\n margin: 0;\r\n color: var(--common);\r\n font-size: 12px;\r\n overflow-x: auto;\r\n }\r\n .auth-tag {\r\n display: inline-block;\r\n padding: 1px 6px;\r\n border-radius: 4px;\r\n background: var(--container-hover);\r\n color: var(--muted);\r\n font-size: 11px;\r\n margin-right: 4px;\r\n }\r\n .empty {\r\n padding: 48px;\r\n text-align: center;\r\n color: var(--muted);\r\n }\r\n a.json-link { color: var(--accent); }\r\n</style>\r\n</head>\r\n<body>\r\n<div class=\"layout\">\r\n <div class=\"brand-row\">${logoMarkup}<h1>${escapeHtml(pageTitle)}</h1></div>\r\n <p class=\"lead\">Generated from <code>apiDocs.generated.json</code>. Raw JSON: <a class=\"json-link\" href=\"${escapeHtml(jsonPath)}\">${escapeHtml(jsonPath)}</a></p>\r\n <div class=\"summary\" id=\"summary\"></div>\r\n <div class=\"filter-bar\">\r\n <input type=\"search\" id=\"filter\" placeholder=\"Filter by route name…\" autofocus />\r\n </div>\r\n <div id=\"content\"></div>\r\n</div>\r\n<script>\r\n const JSON_PATH = ${JSON.stringify(jsonPath)};\r\n const ENABLE_TRY_IT_OUT = ${tryItOutData};\r\n const stateByKey = new Map();\r\n\r\n //? Inline runner: hits the live server using the same fetch transport\r\n //? that the framework apiRequest helper uses. Auth comes from the\r\n //? browser's existing session cookie or sessionStorage; no token prompt.\r\n const runEndpoint = async (button, route, version, dataField) => {\r\n let parsed;\r\n try {\r\n parsed = dataField.value.trim().length === 0 ? {} : JSON.parse(dataField.value);\r\n } catch (err) {\r\n const resultEl = button.parentElement.querySelector('pre.result');\r\n resultEl.textContent = 'JSON parse error: ' + err.message;\r\n return;\r\n }\r\n button.disabled = true;\r\n const resultEl = button.parentElement.querySelector('pre.result');\r\n resultEl.textContent = 'Sending...';\r\n try {\r\n const response = await fetch('/' + route + '?stream=false', {\r\n method: 'POST',\r\n headers: { 'Content-Type': 'application/json' },\r\n credentials: 'include',\r\n body: JSON.stringify(parsed),\r\n });\r\n const text = await response.text();\r\n try {\r\n resultEl.textContent = JSON.stringify(JSON.parse(text), null, 2);\r\n } catch {\r\n resultEl.textContent = text;\r\n }\r\n } catch (err) {\r\n resultEl.textContent = 'Network error: ' + err.message;\r\n } finally {\r\n button.disabled = false;\r\n }\r\n };\r\n\r\n const renderTryItOut = (route, version) => {\r\n if (!ENABLE_TRY_IT_OUT) return '';\r\n return '<div class=\"try-it-out\">' +\r\n '<div style=\"font-weight:600;font-size:12px;margin-bottom:4px;\">Try it out (live request)</div>' +\r\n '<textarea placeholder=\\\\'{\"key\":\"value\"}\\\\'>{}</textarea>' +\r\n '<button onclick=\"runEndpoint(this,\\\\'' + route + '\\\\',\\\\'' + version + '\\\\',this.previousElementSibling)\">Send</button>' +\r\n '<pre class=\"result\"></pre>' +\r\n '</div>';\r\n };\r\n\r\n const escapeHtml = (str) => String(str).replace(/[&<>\"']/g, (c) => ({\r\n '&': '&', '<': '<', '>': '>', '\"': '"', \"'\": '''\r\n })[c]);\r\n\r\n const renderAuth = (auth) => {\r\n if (!auth) return '<span class=\"auth-tag\">public</span>';\r\n const tags = [];\r\n if (auth.login) tags.push('login required');\r\n if (Array.isArray(auth.additional)) {\r\n for (const rule of auth.additional) {\r\n if (rule.key) tags.push(rule.key + (rule.value !== undefined ? '=' + JSON.stringify(rule.value) : ''));\r\n }\r\n }\r\n if (tags.length === 0) tags.push('public');\r\n return tags.map(t => '<span class=\"auth-tag\">' + escapeHtml(t) + '</span>').join('');\r\n };\r\n\r\n const renderEndpoint = (page, name, version, meta) => {\r\n const key = page + '/' + name + '@' + version;\r\n const method = (meta.method \|\| 'POST').toUpperCase();\r\n const rate = meta.rateLimit;\r\n const rateLabel = rate === false ? 'no rate limit' : rate === undefined ? 'default rate' : (rate + '/min');\r\n const isOpen = stateByKey.get(key) === true;\r\n const path = '/api/' + page + '/' + name + '/' + version;\r\n return \\`\r\n <div class=\"endpoint \\${isOpen ? 'open' : ''}\" data-key=\"\\${escapeHtml(key)}\">\r\n <div class=\"endpoint-summary\">\r\n <span class=\"method \\${method}\">\\${method}</span>\r\n <span class=\"endpoint-name\">\\${escapeHtml(path)}</span>\r\n <span class=\"endpoint-meta\">\\${escapeHtml(rateLabel)}</span>\r\n </div>\r\n <div class=\"endpoint-detail\">\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">auth</div>\r\n <div>\\${renderAuth(meta.auth)}</div>\r\n </div>\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">input</div>\r\n <pre>\\${escapeHtml(meta.input \|\| '{}')}</pre>\r\n </div>\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">output</div>\r\n <pre>\\${escapeHtml(meta.output \|\| 'unknown')}</pre>\r\n </div>\r\n \\${meta.stream ? \\`\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">stream</div>\r\n <pre>\\${escapeHtml(meta.stream)}</pre>\r\n </div>\r\n \\` : ''}\r\n \\${meta.owner ? \\`\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">owner</div>\r\n <div>\\${escapeHtml(meta.owner)}</div>\r\n </div>\r\n \\` : ''}\r\n \\${meta.tags && meta.tags.length ? \\`\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">tags</div>\r\n <div>\\${meta.tags.map(t => '<span class=\"badge\">' + escapeHtml(String(t)) + '</span>').join(' ')}</div>\r\n </div>\r\n \\` : ''}\r\n \\${meta.deprecated ? \\`\r\n <div class=\"detail-section\">\r\n <div class=\"detail-label\">deprecated</div>\r\n <div style=\"color:var(--delete);\">\\${escapeHtml(String(meta.deprecated))}</div>\r\n </div>\r\n \\` : ''}\r\n \\${renderTryItOut(page + '/' + name + '/' + version, version)}\r\n </div>\r\n </div>\r\n \\`;\r\n };\r\n\r\n const passesFilter = (filter, page, name) => {\r\n if (!filter) return true;\r\n const haystack = (page + '/' + name).toLowerCase();\r\n return haystack.includes(filter.toLowerCase());\r\n };\r\n\r\n const render = (data, filter) => {\r\n const summary = document.getElementById('summary');\r\n const content = document.getElementById('content');\r\n const apis = data && data.apis ? data.apis : data;\r\n if (!apis \|\| typeof apis !== 'object') {\r\n content.innerHTML = '<div class=\"empty\">No API docs available. Run <code>npm run generateArtifacts</code> to generate them.</div>';\r\n summary.innerHTML = '';\r\n return;\r\n }\r\n\r\n let total = 0;\r\n let visible = 0;\r\n const groups = [];\r\n for (const [page, names] of Object.entries(apis)) {\r\n const rows = [];\r\n for (const [name, versions] of Object.entries(names)) {\r\n for (const [version, meta] of Object.entries(versions)) {\r\n total++;\r\n if (!passesFilter(filter, page, name)) continue;\r\n visible++;\r\n rows.push(renderEndpoint(page, name, version, meta \|\| {}));\r\n }\r\n }\r\n if (rows.length > 0) {\r\n groups.push(\\`\r\n <div class=\"group\">\r\n <div class=\"group-header\">\\${escapeHtml(page)}</div>\r\n \\${rows.join('')}\r\n </div>\r\n \\`);\r\n }\r\n }\r\n\r\n summary.innerHTML = \\`\r\n <div class=\"summary-pill\"><strong>\\${visible}</strong> of <strong>\\${total}</strong> endpoints</div>\r\n <div class=\"summary-pill\"><strong>\\${Object.keys(apis).length}</strong> pages</div>\r\n \\`;\r\n content.innerHTML = groups.join('') \|\| '<div class=\"empty\">No matches.</div>';\r\n\r\n document.querySelectorAll('.endpoint').forEach((el) => {\r\n el.addEventListener('click', () => {\r\n const key = el.getAttribute('data-key');\r\n const next = !el.classList.contains('open');\r\n stateByKey.set(key, next);\r\n el.classList.toggle('open');\r\n });\r\n });\r\n };\r\n\r\n let cachedData = null;\r\n document.getElementById('filter').addEventListener('input', (e) => {\r\n if (cachedData) render(cachedData, e.target.value);\r\n });\r\n\r\n fetch(JSON_PATH, { credentials: 'include' })\r\n .then(r => r.ok ? r.json() : Promise.reject(new Error(String(r.status))))\r\n .then(data => { cachedData = data; render(data, ''); })\r\n .catch(err => {\r\n document.getElementById('content').innerHTML =\r\n '<div class=\"empty\">Could not load API docs: ' + escapeHtml(err.message) + '</div>';\r\n });\r\n</script>\r\n</body>\r\n</html>`;\r\n};\r\n\r\nconst HTML_ESCAPE_MAP: Record<string, string> = {\r\n '&': '&',\r\n '<': '<',\r\n '>': '>',\r\n '\"': '"',\r\n \"'\": ''',\r\n};\r\n\r\nconst escapeHtml = (str: string): string =>\r\n str.replaceAll(/[&<>\"']/g, (c) => HTML_ESCAPE_MAP[c] ?? c);\r\n"],"mappings":";AAiBA,OAAO,QAAQ;AAEf,SAAS,yBAAyB,gBAAgB;;;ACC3C,IAAM,iBAAiB,CAC5B,UACA,WACA,UAAiC,CAAC,MACvB;AACX,QAAM,WAAW,QAAQ,YAAY,CAAC;AACtC,QAAM,SAAS,SAAS,cAAc;AACtC,QAAM,aAAa,SAAS,cAAc;AAC1C,QAAM,aAAa,SAAS,UACxB,aAAa,WAAW,SAAS,OAAO,CAAC,sEACzC;AACJ,QAAM,eAAe,QAAQ,iBAAiB,SAAS;AACvD,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA,SAKA,WAAW,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAUd,MAAM;AAAA,qBACD,UAAU;AAAA;AAAA,cAEjB,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAwJO,UAAU,OAAO,WAAW,SAAS,CAAC;AAAA,6GAC4C,WAAW,QAAQ,CAAC,KAAK,WAAW,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAQpI,KAAK,UAAU,QAAQ,CAAC;AAAA,8BAChB,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgM1C;AAEA,IAAM,kBAA0C;AAAA,EAC9C,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AACP;AAEA,IAAM,aAAa,CAAC,QAClB,IAAI,WAAW,YAAY,CAAC,MAAM,gBAAgB,CAAC,KAAK,CAAC;;;ADjUpD,IAAM,cAAc,CAAC,UAA8B,CAAC,MAAwB;AACjF,QAAM,YAAY,QAAQ,aAAa;AACvC,QAAM,WAAW,GAAG,SAAS;AAE7B,SAAO,OAAO,KAAK,QAAQ;AACzB,UAAM,MAAM,IAAI,OAAO;AACvB,UAAM,CAAC,QAAQ,IAAI,IAAI,MAAM,GAAG;AAEhC,QAAI,aAAa,aAAa,aAAa,UAAU;AACnD,aAAO;AAAA,IACT;AAEA,QAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,QAAQ,eAAe;AACnE,UAAI,aAAa;AACjB,UAAI,UAAU,gBAAgB,YAAY;AAC1C,UAAI,IAAI,WAAW;AACnB,aAAO;AAAA,IACT;AAEA,QAAI,IAAI,WAAW,OAAO;AACxB,UAAI,aAAa;AACjB,UAAI,UAAU,gBAAgB,YAAY;AAC1C,UAAI,IAAI,oBAAoB;AAC5B,aAAO;AAAA,IACT;AAEA,QAAI,aAAa,UAAU;AACzB,YAAM,WAAW,QAAQ,eAAe,wBAAwB;AAChE,YAAM,CAAC,WAAW,OAAO,IAAI,MAAM,SAAS,MAAM,GAAG,SAAS,UAAU,MAAM,CAAC;AAC/E,UAAI,WAAW;AACb,YAAI,aAAa;AACjB,YAAI,UAAU,gBAAgB,kBAAkB;AAChD,YAAI,IAAI,KAAK,UAAU;AAAA,UACrB,OAAO;AAAA,UACP,YAAY;AAAA,UACZ,MAAM;AAAA,QACR,CAAC,CAAC;AAAA,MACJ,OAAO;AACL,YAAI,aAAa;AACjB,YAAI,UAAU,gBAAgB,kBAAkB;AAChD,YAAI,UAAU,iBAAiB,UAAU;AACzC,YAAI,IAAI,OAAO;AAAA,MACjB;AACA,aAAO;AAAA,IACT;AAKA,UAAM,QAAQ,QAAQ,aAAa;AACnC,UAAM,WAAW,QAAQ,YAAY,CAAC;AACtC,QAAI,aAAa;AACjB,QAAI,UAAU,gBAAgB,0BAA0B;AACxD,QAAI,UAAU,iBAAiB,UAAU;AACzC,UAAM,OAAO,QAAQ,WACjB,QAAQ,SAAS,EAAE,UAAU,WAAW,OAAO,SAAS,CAAC,IACzD,eAAe,UAAU,OAAO;AAAA,MAC9B;AAAA,MACA,gBAAgB,QAAQ,kBAAkB;AAAA,IAC5C,CAAC;AACL,QAAI,IAAI,IAAI;AACZ,WAAO;AAAA,EACT;AACF;","names":[]}
1	+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/register.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+
2	+ export { }

package/dist/register.js ADDED Viewed

@@ -0,0 +1,8 @@
+import {
+  mountDocsUi
+} from "./chunk-IL5ERE5J.js";
+// src/register.ts
+import { registerCustomRoute } from "@luckystack/server";
+registerCustomRoute(mountDocsUi());
+//# sourceMappingURL=register.js.map

package/dist/register.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/register.ts"],"sourcesContent":["//? Side-effect `./register` entry for @luckystack/docs-ui. Auto-imported at boot\n//? by @luckystack/server's `bootstrapLuckyStack` (BEFORE `createLuckyStackServer`\n//? reads the custom-route registry) when this package is installed, so the dev\n//? API docs page mounts at `/_docs` with NO consumer code edit — `npm i\n//? @luckystack/docs-ui` + restart is enough.\n//?\n//? `mountDocsUi()` auto-disables in production (returns 404) unless mounted with\n//? `{ enabledInProd: true }`. Consumers who want custom branding / routePath can\n//? still mount their own via a `luckystack/docs-ui/index.ts` overlay.\n//?\n//? This file statically imports `@luckystack/server` for `registerCustomRoute`,\n//? so @luckystack/docs-ui builds AFTER @luckystack/server in `buildPackages.mjs`.\n//? At runtime the importer IS @luckystack/server, so the dependency is always\n//? satisfied.\n\nimport { registerCustomRoute } from '@luckystack/server';\nimport { mountDocsUi } from './index';\n\nregisterCustomRoute(mountDocsUi());\n"],"mappings":";;;;;AAeA,SAAS,2BAA2B;AAGpC,oBAAoB,YAAY,CAAC;","names":[]}

package/docs/html-generation.md CHANGED Viewed

@@ -129,23 +129,26 @@ Both map `&`, `<`, `>`, `"`, `'` to their HTML entity equivalents. The renderer
 Enabled by `options.enableTryItOut === true`. When on:
 - `ENABLE_TRY_IT_OUT` is `true` inside the inline script.
-- `renderTryItOut(route, version)` appends a `<div class="try-it-out">` containing a `<textarea>` (default content `{}`), a `Send` button, and an empty `<pre class="result">`.
-- The Send click invokes `runEndpoint(button, route, version, dataField)`.
+- `renderTryItOut(route, method)` appends a `<div class="try-it-out">` containing a `<textarea>` (default content `{}`), a `Send` button, and an empty `<pre class="result">`.
+- The Send click invokes `runEndpoint(button, route, method, dataField)`.
 `runEndpoint` performs:
 ```js
+const httpMethod = (method || 'POST').toUpperCase();
+const hasBody = httpMethod !== 'GET' && httpMethod !== 'DELETE';
 fetch('/' + route + '?stream=false', {
-  method: 'POST',
-  headers: { 'Content-Type': 'application/json' },
+  method: httpMethod,
+  headers: hasBody ? { 'Content-Type': 'application/json' } : {},
   credentials: 'include',
-  body: JSON.stringify(parsed),
+  body: hasBody ? JSON.stringify(parsed) : undefined,
 })
 ```
 Behavior:
-- `dataField.value.trim()` empty ⇒ posts `{}`. Otherwise the textarea value is parsed with `JSON.parse`. A parse error is shown in the result pane and no request is sent.
+- The endpoint's declared HTTP method is threaded through (the framework returns `405` on a method mismatch, so a hardcoded `POST` would break every documented GET/PUT/DELETE route). For `GET`/`DELETE` the JSON body and `Content-Type` header are omitted.
+- `dataField.value.trim()` empty ⇒ sends `{}` (for body-bearing methods). Otherwise the textarea value is parsed with `JSON.parse`. A parse error is shown in the result pane and no request is sent.
 - The button is disabled during flight and re-enabled in `finally`.
 - The response body is parsed as JSON when possible (pretty-printed via `JSON.stringify(..., null, 2)`) and otherwise displayed as raw text — this keeps non-JSON error pages readable.
 - `?stream=false` instructs the HTTP API surface to return the full final payload instead of a streamed chunked response, which is what the textarea-and-pre UI is built for.

package/package.json CHANGED Viewed

@@ -1,9 +1,10 @@
 {
   "name": "@luckystack/docs-ui",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "private": false,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "type": "module",
   "description": "Dev-only API docs UI for LuckyStack. Mounts a Swagger-style page at /_docs that reads `apiDocs.generated.json` and renders every API route, its inputs/outputs, auth, and rate-limit metadata.",
@@ -34,6 +35,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./register": {
+      "types": "./dist/register.d.ts",
+      "import": "./dist/register.js"
     }
   },
   "files": [
@@ -50,6 +55,14 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@luckystack/core": "^0.1.9"
+    "@luckystack/core": "^0.2.0"
+  },
+  "peerDependencies": {
+    "@luckystack/server": "^0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@luckystack/server": {
+      "optional": true
+    }
   }
 }