@erdemtuna/doc-review 0.7.0 → 0.8.0

package/src/serialize.js

@@ -9,20 +9,6 @@
 export const UI_ATTR = "data-eh-ui";
 export const MARK_ATTR = "data-eh-mark";
 
-/** Keep a hydrated app editable even if its framework removes the attribute. */
-export function keepBodyEditable(body) {
-  const enforce = () => {
-    if (body.getAttribute("contenteditable") !== "true") {
-      body.setAttribute("contenteditable", "true");
-    }
-  };
-  enforce();
-  const Observer = body.ownerDocument.defaultView.MutationObserver;
-  const observer = new Observer(enforce);
-  observer.observe(body, { attributes: true, attributeFilter: ["contenteditable"] });
-  return observer;
-}
-
 /** Serialize a document to the HTML that should live on disk. */
 export function serializeDocument(doc) {
   const clone = doc.documentElement.cloneNode(true);

package/src/server.js

@@ -4,6 +4,7 @@ import path from "node:path";
 import crypto from "node:crypto";
 import { fileURLToPath } from "node:url";
 import { atomicWrite, Store, resolveAsset } from "./state.js";
+import { normalizeCommentAnchor } from "./comment-anchor.js";
 import { injectSdk, stripSdk } from "./html-transform.js";
 import { isMarkdown, renderMarkdownPage } from "./markdown.js";
 import { canonicalTarget, ensureStateDir, localUrl, SERVER_PROTOCOL, serverPath, stateDir, targetKey } from "./paths.js";
@@ -274,7 +275,7 @@ export function createServer({ store: suppliedStore, storeOptions, owner = null,
           id: c.id,
           kind: c.kind,
           quote: c.quote,
-          anchor: c.anchor,
+          anchor: c.anchor == null ? c.anchor : normalizeCommentAnchor(c.kind, c.anchor),
           feedback: c.feedback,
           ...(c.correction ? { correction: true, correction_of: c.correctionOf } : {}),
         })),
@@ -562,6 +563,10 @@ export function createServer({ store: suppliedStore, storeOptions, owner = null,
       if (route === "/chrome.css") return serveFile(res, path.join(here, "chrome.css"));
       if (route === "/chrome.js") return serveFile(res, path.join(here, "chrome-client.js"));
       if (route === "/chrome-session.js") return serveFile(res, path.join(here, "chrome-session.js"));
+      if (route === "/icons.js") return serveFile(res, path.join(here, "icons.js"), opaqueModuleCors(req));
+      if (route === "/positioning.js") return serveFile(res, path.join(here, "positioning.js"), opaqueModuleCors(req));
+      if (route === "/review-mode.js") return serveFile(res, path.join(here, "review-mode.js"), opaqueModuleCors(req));
+      if (route === "/comment-target.js") return serveFile(res, path.join(here, "comment-target.js"), opaqueModuleCors(req));
       if (route === "/sdk.js") return serveFile(res, path.join(here, "sdk.js"), opaqueModuleCors(req));
       if (route === "/editing.js") return serveFile(res, path.join(here, "editing.js"), opaqueModuleCors(req));
       if (route === "/anchor-text.js") return serveFile(res, path.join(here, "anchor-text.js"), opaqueModuleCors(req));
@@ -829,15 +834,21 @@ export function createServer({ store: suppliedStore, storeOptions, owner = null,
 
         if (action === "comment" && req.method === "POST") {
           const body = await readBody(req);
+          const kind = body.kind === "element" ? "element" : "selection";
+          const feedback = String(body.feedback || "").trim();
           const comment = {
             id: uid("c"),
-            kind: body.kind === "element" ? "element" : "selection",
+            kind,
             quote: String(body.quote || ""),
-            anchor: body.anchor || null,
-            feedback: String(body.feedback || ""),
+            anchor: normalizeCommentAnchor(
+              kind,
+              body.anchor || (kind === "selection" ? { quote: String(body.quote || "") } : null)
+            ),
+            feedback,
             createdAt: Date.now(),
           };
           if (!comment.feedback) return json(res, 400, { error: "empty feedback" });
+          if (!comment.anchor) return json(res, 400, { error: "invalid comment anchor" });
           store.addComment(key, comment);
           return json(res, 200, { comment, page: pageState(key) });
         }

package/src/state.js

@@ -1,6 +1,7 @@
 import crypto from "node:crypto";
 import fs from "node:fs";
 import path from "node:path";
+import { normalizeCommentAnchor } from "./comment-anchor.js";
 import { canonicalTarget, ensureStateDir, pageKey, realFile, statePath, targetKey } from "./paths.js";
 
 /** Anything untouched this long is review debris, not work in progress. */
@@ -46,6 +47,17 @@ function normalizeState(parsed, makeBatchId) {
     receipts: parsed.receipts && typeof parsed.receipts === "object" ? parsed.receipts : {},
   };
   let changed = !parsed.batches || !parsed.receipts;
+  const normalizeAnchor = (comment) => {
+    if (!comment || comment.anchor == null) return;
+    const normalized = normalizeCommentAnchor(comment.kind === "element" ? "element" : "selection", comment.anchor);
+    if (JSON.stringify(normalized) !== JSON.stringify(comment.anchor)) {
+      comment.anchor = normalized;
+      changed = true;
+    }
+  };
+  for (const page of Object.values(data.pages)) {
+    for (const comment of page?.comments || []) normalizeAnchor(comment);
+  }
   for (const record of Object.values(data.batches)) {
     if (!record || typeof record !== "object" || !record.batch || !Array.isArray(record.cleanup)) {
       throw new Error("Invalid doc-review state: malformed feedback batch.");
@@ -73,6 +85,9 @@ function normalizeState(parsed, makeBatchId) {
     if (!DELIVERY_STATES.has(record.delivery_state)) {
       throw new Error(`Invalid doc-review state: unknown delivery state ${record.delivery_state}.`);
     }
+    for (const page of record.batch.pages || []) {
+      for (const comment of page.comments || []) normalizeAnchor(comment);
+    }
   }
   return { data, changed };
 }
@@ -234,8 +249,12 @@ export class Store {
   }
 
   addComment(key, comment) {
+    const anchor = comment.anchor == null
+      ? comment.anchor
+      : normalizeCommentAnchor(comment.kind === "element" ? "element" : "selection", comment.anchor);
+    if (comment.anchor != null && !anchor) throw new Error("Invalid comment anchor.");
     return this.update(key, (page) => {
-      page.comments.push(comment);
+      page.comments.push({ ...comment, ...(comment.anchor !== undefined ? { anchor } : {}) });
     });
   }