@commentray/render 0.0.2 → 0.0.4

package/dist/code-browser-embedded-payload.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Read base64-embedded raw source + commentray markdown from the static HTML shell.
+ *
+ * Older pages put `data-raw-*-b64` on `#code-pane`; current markup puts them on `#shell`.
+ */
+export declare function readEmbeddedRawB64Strings(shell: Pick<HTMLElement, "getAttribute">, codePane: Pick<HTMLElement, "getAttribute">): {
+    rawCodeB64: string;
+    rawMdB64: string;
+};
+//# sourceMappingURL=code-browser-embedded-payload.d.ts.map

package/dist/code-browser-embedded-payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-browser-embedded-payload.d.ts","sourceRoot":"","sources":["../src/code-browser-embedded-payload.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,EACxC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,GAC1C;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAU1C"}

package/dist/code-browser-embedded-payload.js

@@ -0,0 +1,18 @@
+/**
+ * Read base64-embedded raw source + commentray markdown from the static HTML shell.
+ *
+ * Older pages put `data-raw-*-b64` on `#code-pane`; current markup puts them on `#shell`.
+ */
+export function readEmbeddedRawB64Strings(shell, codePane) {
+    function pick(name) {
+        const fromShell = shell.getAttribute(name);
+        if (fromShell !== null && fromShell.trim() !== "")
+            return fromShell;
+        return codePane.getAttribute(name)?.trim() ?? "";
+    }
+    return {
+        rawCodeB64: pick("data-raw-code-b64"),
+        rawMdB64: pick("data-raw-md-b64"),
+    };
+}
+//# sourceMappingURL=code-browser-embedded-payload.js.map

package/dist/code-browser-embedded-payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-browser-embedded-payload.js","sourceRoot":"","sources":["../src/code-browser-embedded-payload.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,KAAwC,EACxC,QAA2C;IAE3C,SAAS,IAAI,CAAC,IAAY;QACxB,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,OAAO,SAAS,CAAC;QACpE,OAAO,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IACD,OAAO;QACL,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC;QACrC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC;KAClC,CAAC;AACJ,CAAC"}

package/dist/code-browser-encoding.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Decode base64 payload embedded in HTML attributes (UTF-8 bytes, as produced by Node
+ * `Buffer.from(str, "utf8").toString("base64")`).
+ *
+ * Avoids `decodeURIComponent(escape(atob(...)))`, which is fragile for some Unicode
+ * in modern browsers and can fail silently in edge cases.
+ */
+export declare function decodeBase64Utf8(b64: string): string;
+//# sourceMappingURL=code-browser-encoding.d.ts.map

package/dist/code-browser-encoding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-browser-encoding.d.ts","sourceRoot":"","sources":["../src/code-browser-encoding.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAapD"}

package/dist/code-browser-encoding.js

@@ -0,0 +1,24 @@
+/**
+ * Decode base64 payload embedded in HTML attributes (UTF-8 bytes, as produced by Node
+ * `Buffer.from(str, "utf8").toString("base64")`).
+ *
+ * Avoids `decodeURIComponent(escape(atob(...)))`, which is fragile for some Unicode
+ * in modern browsers and can fail silently in edge cases.
+ */
+export function decodeBase64Utf8(b64) {
+    const t = b64.trim();
+    if (t === "")
+        return "";
+    try {
+        const bin = atob(t);
+        const u8 = new Uint8Array(bin.length);
+        for (let i = 0; i < bin.length; i++) {
+            u8[i] = bin.charCodeAt(i);
+        }
+        return new TextDecoder("utf-8", { fatal: false }).decode(u8);
+    }
+    catch {
+        return "";
+    }
+}
+//# sourceMappingURL=code-browser-encoding.js.map

package/dist/code-browser-encoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-browser-encoding.js","sourceRoot":"","sources":["../src/code-browser-encoding.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IACrB,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IACxB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/code-browser-scroll-sync.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Static browser scroll helpers: proportional mirror plus block pickers from
+ * `@commentray/core/block-scroll-pickers` (small browser bundle entry).
+ */
+export type { BlockScrollLink } from "@commentray/core/block-scroll-pickers";
+export { pickCommentrayLineForSourceScroll, pickSourceLine0ForCommentrayScroll, } from "@commentray/core/block-scroll-pickers";
 /**
  * Maps one pane’s scroll position to the other for **proportional** scroll sync
  * (static code browser). Mirrors the ratio fallback used while editing when

package/dist/code-browser-scroll-sync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"code-browser-scroll-sync.d.ts","sourceRoot":"","sources":["../src/code-browser-scroll-sync.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,MAAM,EACvB,kBAAkB,EAAE,MAAM,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,kBAAkB,EAAE,MAAM,GACzB,MAAM,CAMR"}
+{"version":3,"file":"code-browser-scroll-sync.d.ts","sourceRoot":"","sources":["../src/code-browser-scroll-sync.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,YAAY,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EACL,iCAAiC,EACjC,kCAAkC,GACnC,MAAM,uCAAuC,CAAC;AAE/C;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,MAAM,EACvB,kBAAkB,EAAE,MAAM,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,kBAAkB,EAAE,MAAM,GACzB,MAAM,CAMR"}

package/dist/code-browser-scroll-sync.js

@@ -1,3 +1,4 @@
+export { pickCommentrayLineForSourceScroll, pickSourceLine0ForCommentrayScroll, } from "@commentray/core/block-scroll-pickers";
 /**
  * Maps one pane’s scroll position to the other for **proportional** scroll sync
  * (static code browser). Mirrors the ratio fallback used while editing when

package/dist/code-browser-scroll-sync.js.map

@@ -1 +1 @@
-{"version":3,"file":"code-browser-scroll-sync.js","sourceRoot":"","sources":["../src/code-browser-scroll-sync.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,eAAuB,EACvB,kBAA0B,EAC1B,kBAA0B,EAC1B,kBAA0B,EAC1B,kBAA0B;IAE1B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,CAAC,CAAC;IACvE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,CAAC,CAAC;IACvE,IAAI,SAAS,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,eAAe,GAAG,SAAS,CAAC;IAC1C,OAAO,KAAK,GAAG,SAAS,CAAC;AAC3B,CAAC"}
+{"version":3,"file":"code-browser-scroll-sync.js","sourceRoot":"","sources":["../src/code-browser-scroll-sync.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,iCAAiC,EACjC,kCAAkC,GACnC,MAAM,uCAAuC,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,eAAuB,EACvB,kBAA0B,EAC1B,kBAA0B,EAC1B,kBAA0B,EAC1B,kBAA0B;IAE1B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,CAAC,CAAC;IACvE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,CAAC,CAAC;IACvE,IAAI,SAAS,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,eAAe,GAAG,SAAS,CAAC;IAC1C,OAAO,KAAK,GAAG,SAAS,CAAC;AAC3B,CAAC"}

package/dist/code-browser-web-storage.d.ts

@@ -0,0 +1,7 @@
+/**
+ * `localStorage` / `sessionStorage` can throw on `file:` URLs and in hardened browsers
+ * (Safari, strict privacy). Treat failures as "no persisted value".
+ */
+export declare function readWebStorageItem(storage: Storage, key: string): string | null;
+export declare function writeWebStorageItem(storage: Storage, key: string, value: string): void;
+//# sourceMappingURL=code-browser-web-storage.d.ts.map

package/dist/code-browser-web-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-browser-web-storage.d.ts","sourceRoot":"","sources":["../src/code-browser-web-storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAM/E;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAMtF"}

package/dist/code-browser-web-storage.js

@@ -0,0 +1,21 @@
+/**
+ * `localStorage` / `sessionStorage` can throw on `file:` URLs and in hardened browsers
+ * (Safari, strict privacy). Treat failures as "no persisted value".
+ */
+export function readWebStorageItem(storage, key) {
+    try {
+        return storage.getItem(key);
+    }
+    catch {
+        return null;
+    }
+}
+export function writeWebStorageItem(storage, key, value) {
+    try {
+        storage.setItem(key, value);
+    }
+    catch {
+        // ignore — e.g. file://, private mode, quota
+    }
+}
+//# sourceMappingURL=code-browser-web-storage.js.map

package/dist/code-browser-web-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-browser-web-storage.js","sourceRoot":"","sources":["../src/code-browser-web-storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAgB,EAAE,GAAW;IAC9D,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAgB,EAAE,GAAW,EAAE,KAAa;IAC9E,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,6CAA6C;IAC/C,CAAC;AACH,CAAC"}

package/dist/code-browser.d.ts

@@ -1,3 +1,4 @@
+import { type CommentrayIndex } from "@commentray/core";
 import { type CommentrayOutputUrlOptions } from "./markdown-pipeline.js";
 export type CodeBrowserPageOptions = {
     title?: string;
@@ -37,6 +38,52 @@ export type CodeBrowserPageOptions = {
      * Free-form label for `<meta name="generator">` (e.g. package versions). Omitted when unset.
      */
     generatorLabel?: string;
+    /**
+     * When set and index blocks align with `<!-- commentray:block id=… -->` markers,
+     * emits a two-column **blame-style** table: **one row per block** (plus gap rows for
+     * unmapped lines). Code and commentary cells share the **same row height** (the taller
+     * side wins; the shorter side is top-aligned with natural padding below). One shell
+     * scroll keeps both columns aligned.
+     */
+    blockStretchRows?: {
+        index: CommentrayIndex;
+        sourceRelative: string;
+        commentrayPathRel: string;
+    };
+    /**
+     * `auto` (default): when `blockStretchRows` is set and a block-stretch table can be built,
+     * use the stretch layout; otherwise dual panes.
+     * `dual`: always use side-by-side panes (skips stretch), so block markers + index can drive
+     * **block-aware** scroll sync and separator lines in the commentray pane.
+     */
+    codeBrowserLayout?: "auto" | "dual";
+    /**
+     * `full` (default): in-page search indexes every source line and every commentray line.
+     * `commentray-and-paths`: search only **toolbar path labels** plus commentray Markdown (no code-body line corpus).
+     */
+    staticSearchScope?: "full" | "commentray-and-paths";
+    /** Repo-relative companion Markdown path; used with `staticSearchScope: "commentray-and-paths"` for path labels. */
+    commentrayPathForSearch?: string;
+    /**
+     * GitHub **blob** URL for the primary `filePath` (static hub). Shown in the toolbar when set
+     * (`http`/`https` only).
+     */
+    sourceOnGithubUrl?: string;
+    /**
+     * GitHub **blob** URL for the companion commentray Markdown (same constraints as `sourceOnGithubUrl`).
+     */
+    commentrayOnGithubUrl?: string;
+    /**
+     * Relative URL to a nav JSON document (e.g. `./commentray-nav-search.json`) that includes
+     * `documentedPairs` — enables the **Documented files** tree in the toolbar.
+     */
+    documentedNavJsonUrl?: string;
+    /**
+     * Base64 UTF-8 JSON array of documented pairs (same shape as `documentedPairs` in the nav JSON).
+     * When set on `#shell`, the tree loads **without** fetching `documentedNavJsonUrl` — works offline
+     * and with `file://` where `fetch` to a sidecar JSON is unavailable.
+     */
+    documentedPairsEmbeddedB64?: string;
 };
 /**
  * Static HTML shell for a minimal “code browser”: code + rendered commentray,

package/dist/code-browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"code-browser.d.ts","sourceRoot":"","sources":["../src/code-browser.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,KAAK,0BAA0B,EAGhC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,0BAA0B,CAAC;IAClD;;;OAGG;IACH,gBAAgB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAsVF;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CA0CzF"}
+{"version":3,"file":"code-browser.d.ts","sourceRoot":"","sources":["../src/code-browser.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EACL,KAAK,0BAA0B,EAGhC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,0BAA0B,CAAC;IAClD;;;OAGG;IACH,gBAAgB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE;QACjB,KAAK,EAAE,eAAe,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,oHAAoH;IACpH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC,CAAC;AAwoBF;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CA+CzF"}