npm - @emeryld/rrroutes-contract - Versions diffs - 2.7.1 → 2.7.3 - Mend

@emeryld/rrroutes-contract 2.7.1 → 2.7.3

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 (10) hide show

package/README.md +92 -0
package/dist/export/defaultViewerTemplate.d.ts +1 -0
package/dist/export/exportFinalizedLeaves.d.ts +13 -1
package/dist/export/index.d.ts +1 -0
package/dist/index.cjs +179 -3
package/dist/index.cjs.map +1 -1
package/dist/index.mjs +178 -3
package/dist/index.mjs.map +1 -1
package/package.json +3 -2
package/tools/finalized-leaves-viewer.html +739 -0

package/dist/index.mjs CHANGED Viewed

@@ -677,6 +677,79 @@ function flattenLeafSchemas(leaf) {
 // src/export/exportFinalizedLeaves.ts
 import fs from "fs/promises";
 import path from "path";
+import { spawn } from "child_process";
+// src/export/defaultViewerTemplate.ts
+var DEFAULT_VIEWER_TEMPLATE = `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Finalized Leaves Viewer</title>
+    <style>
+      :root {
+        --bg: #f5f7fb;
+        --surface: #ffffff;
+        --border: #d6ddea;
+        --text: #172033;
+        --muted: #5b6680;
+        --accent: #1858c6;
+      }
+      body {
+        margin: 0;
+        font-family: 'Iosevka Web', 'SFMono-Regular', Menlo, Consolas, monospace;
+        color: var(--text);
+        background: linear-gradient(180deg, var(--bg), #eef2fa);
+      }
+      .wrap { max-width: 1100px; margin: 0 auto; padding: 20px; }
+      .card { background: var(--surface); border: 1px solid var(--border); border-radius: 12px; padding: 14px; }
+      .meta { color: var(--muted); font-size: 12px; }
+      #results { margin-top: 12px; display: grid; gap: 8px; }
+      details { background: var(--surface); border: 1px solid var(--border); border-radius: 10px; padding: 8px 10px; }
+      summary { cursor: pointer; font-weight: 700; color: var(--accent); }
+      pre { margin: 10px 0 0; overflow: auto; border: 1px solid var(--border); border-radius: 8px; padding: 10px; background: #fafcff; }
+    </style>
+  </head>
+  <body>
+    <div class="wrap">
+      <h1>Finalized Leaves Viewer (Baked)</h1>
+      <div class="card">
+        <div id="status" class="meta">Waiting for baked payload...</div>
+      </div>
+      <div id="results"></div>
+    </div>
+    <!--__FINALIZED_LEAVES_BAKED_PAYLOAD__-->
+    <script>
+      const statusEl = document.getElementById('status')
+      const resultsEl = document.getElementById('results')
+      const payload = window.__FINALIZED_LEAVES_PAYLOAD
+      if (!payload || !Array.isArray(payload.leaves)) {
+        statusEl.textContent = 'No baked payload found in this HTML file.'
+      } else {
+        statusEl.textContent =           'Loaded baked payload with ' + payload.leaves.length + ' routes.'
+        payload.leaves.forEach((leaf) => {
+          const details = document.createElement('details')
+          const summary = document.createElement('summary')
+          summary.textContent = String(leaf.method || '').toUpperCase() + ' ' + (leaf.path || '')
+          const pre = document.createElement('pre')
+          pre.textContent = JSON.stringify(leaf, null, 2)
+          details.appendChild(summary)
+          details.appendChild(pre)
+          resultsEl.appendChild(details)
+        })
+      }
+    </script>
+  </body>
+</html>
+`;
+// src/export/exportFinalizedLeaves.ts
 function isRegistry(value) {
   return typeof value === "object" && value !== null && "all" in value && "byKey" in value;
 }
@@ -722,13 +795,109 @@ function buildMeta() {
     }
   };
 }
-async function writeFinalizedLeavesExport(payload, outFile) {
+var BAKED_PAYLOAD_MARKER = "<!--__FINALIZED_LEAVES_BAKED_PAYLOAD__-->";
+function escapePayloadForInlineScript(payload) {
+  return JSON.stringify(payload).replace(/<\//g, "<\\/").replace(/<!--/g, "<\\!--");
+}
+function injectPayloadIntoViewerHtml(htmlTemplate, payload) {
+  const payloadScript = `${BAKED_PAYLOAD_MARKER}
+<script id="finalized-leaves-baked-payload">window.__FINALIZED_LEAVES_PAYLOAD = ${escapePayloadForInlineScript(
+    payload
+  )};</script>`;
+  if (htmlTemplate.includes(BAKED_PAYLOAD_MARKER)) {
+    return htmlTemplate.replace(BAKED_PAYLOAD_MARKER, payloadScript);
+  }
+  if (htmlTemplate.includes("</body>")) {
+    return htmlTemplate.replace("</body>", `${payloadScript}
+</body>`);
+  }
+  return `${payloadScript}
+${htmlTemplate}`;
+}
+async function resolveViewerTemplatePath(viewerTemplateFile) {
+  if (viewerTemplateFile) {
+    const resolved = path.resolve(viewerTemplateFile);
+    await fs.access(resolved);
+    return resolved;
+  }
+  const candidates = [
+    path.resolve(
+      process.cwd(),
+      "node_modules/@emeryld/rrroutes-contract/tools/finalized-leaves-viewer.html"
+    ),
+    path.resolve(
+      process.cwd(),
+      "tools/finalized-leaves-viewer.html"
+    ),
+    path.resolve(
+      process.cwd(),
+      "packages/contract/tools/finalized-leaves-viewer.html"
+    )
+  ];
+  for (const candidate of candidates) {
+    try {
+      await fs.access(candidate);
+      return candidate;
+    } catch {
+    }
+  }
+  return void 0;
+}
+async function writeJsonExport(payload, outFile) {
   const resolved = path.resolve(outFile);
   await fs.mkdir(path.dirname(resolved), { recursive: true });
   await fs.writeFile(resolved, `${JSON.stringify(payload, null, 2)}
 `, "utf8");
   return resolved;
 }
+async function writeBakedHtmlExport(payload, htmlFile, viewerTemplateFile) {
+  const templatePath = await resolveViewerTemplatePath(viewerTemplateFile);
+  const template = templatePath ? await fs.readFile(templatePath, "utf8") : DEFAULT_VIEWER_TEMPLATE;
+  const baked = injectPayloadIntoViewerHtml(template, payload);
+  const resolved = path.resolve(htmlFile);
+  await fs.mkdir(path.dirname(resolved), { recursive: true });
+  await fs.writeFile(resolved, baked, "utf8");
+  return resolved;
+}
+async function openHtmlInBrowser(filePath) {
+  const resolved = path.resolve(filePath);
+  const platform = process.platform;
+  if (platform === "darwin") {
+    spawn("open", [resolved], { detached: true, stdio: "ignore" }).unref();
+    return;
+  }
+  if (platform === "win32") {
+    spawn("cmd", ["/c", "start", "", resolved], {
+      detached: true,
+      stdio: "ignore"
+    }).unref();
+    return;
+  }
+  spawn("xdg-open", [resolved], { detached: true, stdio: "ignore" }).unref();
+}
+async function writeFinalizedLeavesExport(payload, outFileOrOptions) {
+  const options = typeof outFileOrOptions === "string" ? { outFile: outFileOrOptions } : outFileOrOptions;
+  const written = {};
+  if (options.outFile) {
+    written.outFile = await writeJsonExport(payload, options.outFile);
+  }
+  if (options.htmlFile) {
+    written.htmlFile = await writeBakedHtmlExport(
+      payload,
+      options.htmlFile,
+      options.viewerTemplateFile
+    );
+  }
+  if (options.openOnFinish) {
+    if (!written.htmlFile) {
+      throw new Error(
+        "openOnFinish requires htmlFile. Provide htmlFile to open the baked viewer."
+      );
+    }
+    await openHtmlInBrowser(written.htmlFile);
+  }
+  return written;
+}
 async function exportFinalizedLeaves(input, options = {}) {
   const leaves = getLeaves(input);
   const serializedLeaves = serializeLeavesContract(leaves, options);
@@ -740,8 +909,13 @@ async function exportFinalizedLeaves(input, options = {}) {
     leaves: serializedLeaves,
     schemaFlatByLeaf
   };
-  if (options.outFile) {
-    await writeFinalizedLeavesExport(payload, options.outFile);
+  if (options.outFile || options.htmlFile) {
+    await writeFinalizedLeavesExport(payload, {
+      outFile: options.outFile,
+      htmlFile: options.htmlFile,
+      viewerTemplateFile: options.viewerTemplateFile,
+      openOnFinish: options.openOnFinish
+    });
   }
   return payload;
 }
@@ -794,6 +968,7 @@ async function runExportFinalizedLeavesCli(argv) {
   };
 }
 export {
+  DEFAULT_VIEWER_TEMPLATE,
   buildCacheKey,
   buildLowProfileLeaf,
   clearSchemaIntrospectionHandlers,