@ascribed/review 0.1.2-next.2

package/dist/overlay/text.js

@@ -0,0 +1,200 @@
+/** `"1 comment"`, `"2 comments"`. */
+export function plural(count, one, many = `${one}s`) {
+    return `${count} ${count === 1 ? one : many}`;
+}
+/** The last segment of a content path. */
+export function fileName(path) {
+    return path.slice(path.lastIndexOf("/") + 1);
+}
+/** `rollouts.md:28`, or `rollouts.md:28-30`. */
+export function linesLabel(path, lines) {
+    const range = lines.first === lines.last ? `${lines.first}` : `${lines.first}-${lines.last}`;
+    return `${fileName(path)}:${range}`;
+}
+/** Where a thread is, for its card's header. */
+export function whereLabel(thread) {
+    const file = fileName(thread.path);
+    if (thread.detached === "file")
+        return `On ${file} as a whole`;
+    if (thread.detached === "line-gone") {
+        const line = thread.originalLine ?? thread.line;
+        const commit = thread.originalCommit?.slice(0, 7);
+        if (line === null)
+            return `Was on ${file}, since removed`;
+        return `Was on ${file}, line ${line}${commit ? ` at ${commit}` : ""}, since removed`;
+    }
+    if (thread.lines === undefined)
+        return file;
+    if (thread.detached === "no-block")
+        return `${linesLabel(thread.path, thread.lines)}, not on this page`;
+    if (thread.kind === "review" && thread.side === "LEFT")
+        return file;
+    return linesLabel(thread.path, thread.lines);
+}
+/** Where a thread is, for a list of them: shorter, and naming removed text. */
+export function listLabel(thread) {
+    const file = fileName(thread.path);
+    if (thread.detached !== undefined)
+        return `no block, was ${file}`;
+    if (thread.kind === "review" && thread.side === "LEFT")
+        return `removed text in ${file}`;
+    return thread.lines === undefined ? file : linesLabel(thread.path, thread.lines);
+}
+/** Whether the thread is on removed text. */
+export function onRemovedText(thread) {
+    return thread.kind === "review" && thread.side === "LEFT";
+}
+/** Whether any comment of the thread is unsent. */
+export function hasUnsent(thread) {
+    return thread.comments.some((comment) => comment.pending);
+}
+/** A comment's author's name, `"you"` for the viewer. */
+export function authorName(author, viewer) {
+    if (author === null)
+        return "ghost";
+    return author.login === viewer ? "you" : author.login;
+}
+/** Two letters standing for an author, for the avatar's place. */
+export function initials(author) {
+    return ((author?.login ?? "?")
+        .replace(/[^A-Za-z0-9]/g, "")
+        .slice(0, 2)
+        .toUpperCase() || "?");
+}
+/** `"just now"`, `"5 minutes ago"`, `"yesterday"`, or a date. */
+export function relativeTime(iso, now) {
+    const then = Date.parse(iso);
+    if (Number.isNaN(then))
+        return "";
+    const seconds = Math.max(0, Math.round((now - then) / 1000));
+    if (seconds < 60)
+        return "just now";
+    const minutes = Math.round(seconds / 60);
+    if (minutes < 60)
+        return `${plural(minutes, "minute")} ago`;
+    const hours = Math.round(minutes / 60);
+    if (hours < 24)
+        return `${plural(hours, "hour")} ago`;
+    const days = Math.round(hours / 24);
+    if (days === 1)
+        return "yesterday";
+    if (days < 30)
+        return `${days} days ago`;
+    return new Date(then).toISOString().slice(0, 10);
+}
+/** Elements whose text starts on a line of its own. */
+const BLOCK_TAGS = new Set([
+    "ADDRESS",
+    "ARTICLE",
+    "ASIDE",
+    "BLOCKQUOTE",
+    "DD",
+    "DETAILS",
+    "DIV",
+    "DL",
+    "DT",
+    "FIGCAPTION",
+    "FIGURE",
+    "FOOTER",
+    "H1",
+    "H2",
+    "H3",
+    "H4",
+    "H5",
+    "H6",
+    "HEADER",
+    "HR",
+    "LI",
+    "OL",
+    "P",
+    "PRE",
+    "SECTION",
+    "SUMMARY",
+    "TABLE",
+    "TR",
+    "UL",
+]);
+/** Classes that hide text from sight but not from screen readers. */
+const SCREEN_READER_ONLY = ["sr-only", "visually-hidden", "sl-sr-only"];
+/** Whether a reader can't see `el`. */
+function unseen(el) {
+    if (el.hasAttribute("hidden") ||
+        el.getAttribute("aria-hidden") === "true" ||
+        SCREEN_READER_ONLY.some((name) => el.classList.contains(name))) {
+        return true;
+    }
+    const style = el.ownerDocument.defaultView?.getComputedStyle(el);
+    return style?.display === "none" || style?.visibility === "hidden";
+}
+/**
+ * A block's text as a reader sees it, for quoting: links as their text, a
+ * line for each paragraph, list item, or row, numbered items with their
+ * numbers, images as their alt text, and code as written. What the marks and
+ * the overlay add is left out, but for the words a change inserted, and so
+ * is anything a reader can't see.
+ */
+export function blockText(block) {
+    // Each line, and whether it's code, which keeps its spaces.
+    const lines = [];
+    let line = "";
+    let linePre = false;
+    const breakLine = () => {
+        if (line.trim() !== "")
+            lines.push({ text: line, pre: linePre });
+        line = "";
+        linePre = false;
+    };
+    const walk = (node, pre) => {
+        if (node.nodeType === 3) {
+            const text = node.nodeValue ?? "";
+            if (!pre) {
+                line += text.replace(/\s+/g, " ");
+                return;
+            }
+            const [first = "", ...rest] = text.split("\n");
+            line += first;
+            linePre = true;
+            for (const next of rest) {
+                lines.push({ text: line, pre: true });
+                line = next;
+            }
+            return;
+        }
+        if (!(node instanceof Element))
+            return;
+        const tag = node.tagName.toUpperCase();
+        if (node.hasAttribute("data-ascribe-overlay") ||
+            (node.hasAttribute("data-ascribe-ui") && tag !== "INS") ||
+            ["SCRIPT", "STYLE", "TEMPLATE", "NOSCRIPT"].includes(tag) ||
+            unseen(node)) {
+            return;
+        }
+        if (tag === "BR") {
+            breakLine();
+            return;
+        }
+        if (tag === "IMG") {
+            line += node.getAttribute("alt") ?? "";
+            return;
+        }
+        const block = BLOCK_TAGS.has(tag);
+        if (block)
+            breakLine();
+        if ((tag === "TD" || tag === "TH") && node.previousElementSibling !== null)
+            line += " | ";
+        if (tag === "LI" && node.parentElement?.tagName.toUpperCase() === "OL") {
+            const list = node.parentElement;
+            const start = Number(list.getAttribute("start") ?? "1");
+            const items = Array.from(list.children).filter((c) => c.tagName.toUpperCase() === "LI");
+            line += `${(Number.isFinite(start) ? start : 1) + items.indexOf(node)}. `;
+        }
+        for (const child of Array.from(node.childNodes))
+            walk(child, pre || tag === "PRE");
+        if (block)
+            breakLine();
+    };
+    walk(block, false);
+    breakLine();
+    return lines.map(({ text, pre }) => (pre ? text.trimEnd() : text.trim())).join("\n");
+}
+//# sourceMappingURL=text.js.map

package/dist/overlay/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/overlay/text.ts"],"names":[],"mappings":"AAKA,qCAAqC;AACrC,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,GAAW,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG;IACjE,OAAO,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAChD,CAAC;AAED,0CAA0C;AAC1C,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,KAAsC;IAC7E,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7F,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;AACtC,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,UAAU,CAAC,MAAqB;IAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM;QAAE,OAAO,MAAM,IAAI,aAAa,CAAC;IAC/D,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,UAAU,IAAI,iBAAiB,CAAC;QAC1D,OAAO,UAAU,IAAI,UAAU,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC;IACvF,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC5C,IAAI,MAAM,CAAC,QAAQ,KAAK,UAAU;QAChC,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACtE,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IACpE,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,SAAS,CAAC,MAAqB;IAC7C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,iBAAiB,IAAI,EAAE,CAAC;IAClE,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,mBAAmB,IAAI,EAAE,CAAC;IACzF,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;AACnF,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,aAAa,CAAC,MAAqB;IACjD,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC;AAC5D,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,SAAS,CAAC,MAAqB;IAC7C,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,UAAU,CAAC,MAAqB,EAAE,MAAc;IAC9D,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,OAAO,CAAC;IACpC,OAAO,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;AACxD,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,QAAQ,CAAC,MAAqB;IAC5C,OAAO,CACL,CAAC,MAAM,EAAE,KAAK,IAAI,GAAG,CAAC;SACnB,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;SAC5B,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;SACX,WAAW,EAAE,IAAI,GAAG,CACxB,CAAC;AACJ,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,GAAW;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC7D,IAAI,OAAO,GAAG,EAAE;QAAE,OAAO,UAAU,CAAC;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;IACzC,IAAI,OAAO,GAAG,EAAE;QAAE,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;IACvC,IAAI,KAAK,GAAG,EAAE;QAAE,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,CAAC;QAAE,OAAO,WAAW,CAAC;IACnC,IAAI,IAAI,GAAG,EAAE;QAAE,OAAO,GAAG,IAAI,WAAW,CAAC;IACzC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,SAAS;IACT,SAAS;IACT,OAAO;IACP,YAAY;IACZ,IAAI;IACJ,SAAS;IACT,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,YAAY;IACZ,QAAQ;IACR,QAAQ;IACR,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,QAAQ;IACR,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,GAAG;IACH,KAAK;IACL,SAAS;IACT,SAAS;IACT,OAAO;IACP,IAAI;IACJ,IAAI;CACL,CAAC,CAAC;AAEH,qEAAqE;AACrE,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;AAExE,uCAAuC;AACvC,SAAS,MAAM,CAAC,EAAW;IACzB,IACE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC;QACzB,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,MAAM;QACzC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAC9D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,gBAAgB,CAAC,EAAE,CAAC,CAAC;IACjE,OAAO,KAAK,EAAE,OAAO,KAAK,MAAM,IAAI,KAAK,EAAE,UAAU,KAAK,QAAQ,CAAC;AACrE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,4DAA4D;IAC5D,MAAM,KAAK,GAAqC,EAAE,CAAC;IACnD,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,MAAM,SAAS,GAAG,GAAS,EAAE;QAC3B,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QACjE,IAAI,GAAG,EAAE,CAAC;QACV,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,CAAC,IAAU,EAAE,GAAY,EAAQ,EAAE;QAC9C,IAAI,IAAI,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;YAClC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAClC,OAAO;YACT,CAAC;YACD,MAAM,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,IAAI,KAAK,CAAC;YACd,OAAO,GAAG,IAAI,CAAC;YACf,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBACtC,IAAI,GAAG,IAAI,CAAC;YACd,CAAC;YACD,OAAO;QACT,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,YAAY,OAAO,CAAC;YAAE,OAAO;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACvC,IACE,IAAI,CAAC,YAAY,CAAC,sBAAsB,CAAC;YACzC,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,GAAG,KAAK,KAAK,CAAC;YACvD,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YACzD,MAAM,CAAC,IAAI,CAAC,EACZ,CAAC;YACD,OAAO;QACT,CAAC;QACD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,SAAS,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YAClB,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,KAAK;YAAE,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,KAAK,IAAI;YAAE,IAAI,IAAI,KAAK,CAAC;QAC1F,IAAI,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC;YACvE,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC;YAChC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;YACxD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,CAAC;YACxF,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5E,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;YAAE,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC;QACnF,IAAI,KAAK;YAAE,SAAS,EAAE,CAAC;IACzB,CAAC,CAAC;IACF,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnB,SAAS,EAAE,CAAC;IACZ,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvF,CAAC"}

package/dist/overlay/types.d.ts

@@ -0,0 +1,60 @@
+import type { CommentTarget, PendingReview, ReviewEvent } from "../github/session.js";
+import type { Anchor } from "../place/anchor.js";
+import type { LocatedThread, PlacedThreads } from "../place/place.js";
+import type { Thread, ThreadComment } from "../shared/types.js";
+export type { Anchor, CommentTarget, LocatedThread, PendingReview, PlacedThreads, ReviewEvent };
+/** What the overlay draws for the page it's on. */
+export interface OverlayData {
+    /** The pull request: its number names it ("#128"). */
+    pullRequest: {
+        number: number;
+        url: string;
+    };
+    /** The page's threads, placed on its blocks (`ReviewSession.threads`). */
+    threads: PlacedThreads;
+    /** The viewer's pending review: what's unsent. */
+    pending: PendingReview;
+    /** The signed-in viewer's login. */
+    viewer: string;
+}
+/** A thread on the pull request, and the pages it's on. */
+export interface ThreadSummary {
+    thread: LocatedThread;
+    /** The pages that show it, by content path; empty when no page is known to. */
+    pages: {
+        path: string;
+        title: string | null;
+    }[];
+}
+/** A failure the host reports: `message` is a sentence to show; `code` is a `ReviewError` code. */
+export interface HostError {
+    message: string;
+    code?: string;
+}
+/**
+ * Where the overlay gets its data and sends what the reviewer does. A host
+ * keeps GitHub to itself: the overlay never sees a token or makes a request.
+ */
+export interface OverlayHost {
+    load(): Promise<OverlayData>;
+    /** How a comment on the block would go: as a thread, in the review's summary, or not yet. */
+    commentTarget(anchor: Anchor): Promise<CommentTarget>;
+    /** Comments on a block. `quote` is the block's text as the page shows it. */
+    comment(anchor: Anchor, body: string, quote?: string): Promise<Thread>;
+    reply(threadId: string, body: string, when: "now" | "withReview"): Promise<ThreadComment>;
+    /** Every thread on the pull request's pages, with the pages each is on. */
+    allThreads(): Promise<ThreadSummary[]>;
+    resolve(threadId: string, resolved: boolean): Promise<void>;
+    submit(event: ReviewEvent, body?: string): Promise<void>;
+    /** Deletes the pending review and everything in it. */
+    discard(): Promise<void>;
+    openSource(anchor: Anchor): void;
+    /** Shows a thread that's on another page: the host opens that page, and its overlay goes to the thread. */
+    openThread(threadId: string, page: string): void;
+    /** Opens a link from a comment. Without it, the link opens as the page would open it. */
+    openLink?(url: string): void;
+    /** Tells the reviewer something that happened, as the host shows notices. */
+    notify?(message: string): void;
+    /** Calls `listener` when the page re-rendered or the threads changed. */
+    onDidChange(listener: () => void): void;
+}

package/dist/overlay/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/overlay/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/overlay/types.ts"],"names":[],"mappings":""}

package/dist/place/anchor.d.ts

@@ -0,0 +1,23 @@
+/** Where a rendered block came from: its `data-ascribe-source` and `data-ascribe-via`. */
+export interface Anchor {
+    /** `<path>:<first>-<last>`. */
+    source: string;
+    /** The includes it came through, outermost first, each `<path>:<line>`. */
+    via: string[];
+}
+/** A block's source, parsed. `path` is decoded. */
+export interface SourceRange {
+    path: string;
+    first: number;
+    last: number;
+}
+/** Parses `<path>:<first>-<last>`, or returns `undefined` if it isn't one. */
+export declare function parseSource(source: string): SourceRange | undefined;
+/** Writes a block's source for a decoded content path. */
+export declare function formatSource(range: SourceRange): string;
+/** Percent-encodes each segment of a `/`-separated path, as anchors do. */
+export declare function encodePath(path: string): string;
+/** The inverse of `encodePath`. */
+export declare function decodePath(path: string): string;
+/** A string that identifies an anchor, `via` included. */
+export declare function anchorKey(anchor: Anchor): string;

package/dist/place/anchor.js

@@ -0,0 +1,49 @@
+// Source anchors: `<path>:<first>-<last>` for a block, `<path>:<line>` for an
+// include. The path is a content path, `/`-separated, each segment
+// percent-encoded except for ASCII letters, digits, `-`, `.`, `_`, and `~`.
+/** Parses `<path>:<first>-<last>`, or returns `undefined` if it isn't one. */
+export function parseSource(source) {
+    const colon = source.lastIndexOf(":");
+    if (colon <= 0)
+        return undefined;
+    const match = /^(\d+)-(\d+)$/.exec(source.slice(colon + 1));
+    if (match === null)
+        return undefined;
+    const first = Number(match[1]);
+    const last = Number(match[2]);
+    if (first < 1 || last < first)
+        return undefined;
+    let path;
+    try {
+        path = decodePath(source.slice(0, colon));
+    }
+    catch {
+        return undefined;
+    }
+    return { path, first, last };
+}
+/** Writes a block's source for a decoded content path. */
+export function formatSource(range) {
+    return `${encodePath(range.path)}:${range.first}-${range.last}`;
+}
+/** Percent-encodes each segment of a `/`-separated path, as anchors do. */
+export function encodePath(path) {
+    return path
+        .split("/")
+        .map((segment) => Array.from(new TextEncoder().encode(segment), (byte) => {
+        const char = String.fromCharCode(byte);
+        return /[A-Za-z0-9\-._~]/.test(char)
+            ? char
+            : `%${byte.toString(16).toUpperCase().padStart(2, "0")}`;
+    }).join(""))
+        .join("/");
+}
+/** The inverse of `encodePath`. */
+export function decodePath(path) {
+    return path.split("/").map(decodeURIComponent).join("/");
+}
+/** A string that identifies an anchor, `via` included. */
+export function anchorKey(anchor) {
+    return [anchor.source, ...anchor.via].join(" ");
+}
+//# sourceMappingURL=anchor.js.map

package/dist/place/anchor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"anchor.js","sourceRoot":"","sources":["../../src/place/anchor.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,mEAAmE;AACnE,4EAA4E;AAiB5E,8EAA8E;AAC9E,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,KAAK,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACjC,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5D,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,KAAK,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK;QAAE,OAAO,SAAS,CAAC;IAChD,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC/B,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,YAAY,CAAC,KAAkB;IAC7C,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;AAClE,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,OAAO,IAAI;SACR,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACf,KAAK,CAAC,IAAI,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE;QACrD,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;YAClC,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CACZ;SACA,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,mCAAmC;AACnC,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,SAAS,CAAC,MAAc;IACtC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC"}

package/dist/place/index.d.ts

@@ -0,0 +1,4 @@
+export { anchorKey, decodePath, encodePath, formatSource, parseSource, type Anchor, type SourceRange, } from "./anchor.js";
+export { lineHunks, lineMap, linesAt, parseHunks, shiftLine, type Hunk, type LineMap, type Shifted, type Sides, } from "./lines.js";
+export { locateThreads, placeOnPage, type DetachReason, type LocateContext, type LocatedThread, type PageRef, type PlacedThreads, } from "./place.js";
+export type { Author, Side, Thread, ThreadComment } from "../shared/types.js";

package/dist/place/index.js

@@ -0,0 +1,6 @@
+// Placing review threads on rendered blocks: source anchors, moving lines
+// between a commit and the working tree, and matching threads to a page.
+export { anchorKey, decodePath, encodePath, formatSource, parseSource, } from "./anchor.js";
+export { lineHunks, lineMap, linesAt, parseHunks, shiftLine, } from "./lines.js";
+export { locateThreads, placeOnPage, } from "./place.js";
+//# sourceMappingURL=index.js.map

package/dist/place/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/place/index.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,yEAAyE;AACzE,OAAO,EACL,SAAS,EACT,UAAU,EACV,UAAU,EACV,YAAY,EACZ,WAAW,GAGZ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,SAAS,EACT,OAAO,EACP,OAAO,EACP,UAAU,EACV,SAAS,GAKV,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,aAAa,EACb,WAAW,GAMZ,MAAM,YAAY,CAAC"}

package/dist/place/lines.d.ts

@@ -0,0 +1,56 @@
+/** One hunk of a unified diff: lines `oldStart`.. on one side became `newStart`.. on the other. */
+export interface Hunk {
+    oldStart: number;
+    oldCount: number;
+    newStart: number;
+    newCount: number;
+}
+/** The hunks of a unified diff of one file, in order. */
+export declare function parseHunks(diff: string): Hunk[];
+/** Where a line is on the other side of a diff. */
+export interface Shifted {
+    line: number;
+    /** Whether the diff replaced the line: its text changed, and `line` is where the new text is. */
+    replaced: boolean;
+}
+/** The text of both sides of a diff, line by line, for telling replaced lines from deleted ones. */
+export interface Sides {
+    old: readonly string[];
+    new: readonly string[];
+}
+/**
+ * Where line `line` of the old side is on the new side. A line the diff
+ * replaced maps onto the line that replaced it, with `replaced` set; a line it
+ * only deleted maps to `undefined`. Hunks come from a diff with no context
+ * lines.
+ *
+ * Old lines pair with new ones by position, clamped to the last new line.
+ * But a hunk with fewer new lines than old can have deleted some lines and
+ * reworded others, so with `sides` each of its old lines pairs with the new
+ * line most like it, in order, and an old line like none of them was deleted.
+ * When none of them pairs (the text was rewritten), or the hunk is too large
+ * to compare, it's by position again.
+ */
+export declare function shiftLine(hunks: readonly Hunk[], line: number, sides?: Sides): Shifted | undefined;
+/** Maps line numbers of a file from one side to the other. */
+export interface LineMap {
+    /** Where the line is on the other side, or `undefined` if it was deleted. */
+    map(line: number): Shifted | undefined;
+    /** Whether the file is the same on both sides. */
+    identity: boolean;
+}
+/**
+ * A map of the lines of the repository-relative `file` between `commit` and
+ * the working tree, in the direction given. Every line maps to nothing when
+ * the commit isn't in the repository or the file is missing on either side.
+ */
+export declare function lineMap(root: string, commit: string, file: string, direction: "to-worktree" | "to-commit"): Promise<LineMap>;
+/** Lines `first`..`last` of the repository-relative `file` at `commit`, or `undefined`. */
+export declare function linesAt(root: string, commit: string, file: string, first: number, last: number): Promise<string | undefined>;
+/**
+ * The hunks that turn `before` into `after`, line by line, as
+ * `git diff --unified=0` would report them: for text in hand, such as a file
+ * and an editor's unsaved copy of it. Lines common to both ends are skipped
+ * first; a middle too large to compare line by line is one hunk.
+ */
+export declare function lineHunks(before: string, after: string): Hunk[];