@arbidocs/blocks 0.4.98 → 0.4.99

package/dist/{chunk-FIEAWH4K.js → chunk-4ZTIMQ7Z.js}

@@ -9,7 +9,7 @@ import { AiMarkdown, Dialog, DialogContent, DialogHeader, DialogTitle, DialogDes
 import { MessageSquarePlus, MessageSquare, PencilLine, ChevronLeft, ChevronRight, X, ChevronUp, ChevronDown, CheckCheck, RotateCcw, CircleCheck, Trash2, Check, SendHorizontal, Type, Ellipsis, RefreshCw, WifiOff, Download, Save, BookA, ListRestart, Blocks, Superscript, NotebookText } from 'lucide-react';
 import { jsxs, jsx, Fragment } from 'react/jsx-runtime';
 import { createPortal } from 'react-dom';
-import { defaultLegalTemplate, listBuildingBlocks, attachedTemplateOf, linkedLevelStyles, styleDivergence, buildingBlockFragment, fragmentClipboardHtml, newFromTemplate } from '@arbidocs/coedit/template';
+import { defaultLegalTemplate, listBuildingBlocks, attachedTemplateOf, linkedLevelStyles, styleDivergence, buildingBlockFragment, fragmentClipboardHtml, trackInsertion, newFromTemplate } from '@arbidocs/coedit/template';
 import { renderToStaticMarkup } from 'react-dom/server';
 import * as Y from 'yjs';
 import { DOCUMENT_COLLABORATION_VERSIONS, collaborationModule } from '@arbidocs/coedit';
@@ -1260,8 +1260,6 @@ function DocxMentions({
     }
   ) });
 }
-
-// src/docx/definitions/fragment.ts
 var DEFINED_TERM_STYLE = "DefinedTerm";
 var FRAGMENT_STYLES = stylesXml(
   "",
@@ -1294,12 +1292,13 @@ function base64(bytes) {
     binary += String.fromCharCode(...bytes.subarray(i, i + 32768));
   return btoa(binary);
 }
-function fragmentHtml(body, covered2) {
-  const bytes = docxPackage({
+function fragmentHtml(body, covered2, revision) {
+  const untracked = docxPackage({
     document: documentXml(body),
     styles: FRAGMENT_STYLES,
     title: "Defined terms"
   });
+  const bytes = revision ? trackInsertion(untracked, revision, covered2) : untracked;
   return `<div data-docx-fragment="${base64(bytes)}" data-docx-fragment-end="${covered2 ? "covered" : "open"}"></div>`;
 }
 
@@ -1556,7 +1555,7 @@ function readParagraph(node, topLevel, bookmarks) {
     links
   };
 }
-function editorPort(editor) {
+function editorPort(editor, revision) {
   const surface = () => {
     const s = editor.surface;
     if (!s) throw new Error("The document is not open.");
@@ -1575,7 +1574,7 @@ function editorPort(editor) {
       surface().setSelection({ anchor: from, head: to });
       surface().deleteSelection();
     },
-    paste: (body, text, covered2) => editor.exec({ type: "paste", text, html: fragmentHtml(body, covered2) }).ok,
+    paste: (body, text, covered2) => editor.exec({ type: "paste", text, html: fragmentHtml(body, covered2, revision) }).ok,
     splitParagraph: () => surface().splitParagraph()
   };
 }
@@ -1618,6 +1617,70 @@ function holdCaret(editor, timeoutMs = 5e3) {
   const offSelection = editor.on("selectionChange", restore);
   const timer = setTimeout(stop, timeoutMs);
 }
+
+// src/docx/structural/trackedOrNoted.ts
+var revisionDate = (at = /* @__PURE__ */ new Date()) => at.toISOString().replace(/\.\d{3}Z$/, "Z");
+function trackedOrNoted(port, { label, author, insert, inserted = Boolean }) {
+  const mode = port.mode();
+  if (mode === "viewing") throw new Error("This document is read only.");
+  if (mode !== "suggesting") return { result: insert(null), how: "direct" };
+  const revision = { author, date: revisionDate() };
+  const before = port.caret();
+  const tracked = port.trackedBy(revision);
+  port.setMode("editing");
+  let result;
+  try {
+    result = insert(revision);
+  } finally {
+    port.setMode("suggesting");
+  }
+  if (!inserted(result) || port.trackedBy(revision) > tracked)
+    return { result, how: inserted(result) ? "tracked" : "direct" };
+  const after = port.caret();
+  if (before && after && port.comment(before, after, label)) return { result, how: "noted" };
+  return { result, how: "direct" };
+}
+var attr2 = (node, name) => node.attributes?.find((a) => a.localName === name)?.value;
+function structuralPort(editor) {
+  return {
+    mode: () => editor.getEditingMode(),
+    setMode: (mode) => void editor.setEditingMode(mode),
+    caret: () => {
+      const head = editor.surface?.state().selection?.head;
+      return head ? { paragraphId: head.paragraphId, offset: head.offset } : null;
+    },
+    // Read from the story's tree: the review pane merges adjacent insertions by one author into
+    // one card, so a card's date need not be this insert's.
+    trackedBy: ({ author, date }) => {
+      const root = editor.surface?.session.part().root;
+      let count = 0;
+      const visit = (node) => {
+        if (node.localName === "ins" && attr2(node, "author") === author && attr2(node, "date") === date)
+          count++;
+        node.children?.forEach(visit);
+      };
+      if (root) visit(root);
+      return count;
+    },
+    comment: (from, to, text) => {
+      const surface = editor.surface;
+      if (!surface) return false;
+      surface.setSelection({ anchor: from, head: to });
+      const ok2 = editor.addComment(text).ok;
+      surface.setSelection({ anchor: to, head: to });
+      return ok2;
+    }
+  };
+}
+var DocxAuthorContext = createContext("You");
+function useTrackedOrNoted() {
+  const editor = useDocxEditor();
+  const author = useContext(DocxAuthorContext);
+  return useCallback(
+    (spec) => editor ? trackedOrNoted(structuralPort(editor), { ...spec, author }) : void 0,
+    [editor, author]
+  );
+}
 var DEFINED_TERM_TRIGGER = "@@";
 var TRIGGER_QUERY = /(?:^|[\s([{"“‘'])@@([^@\n\t]{0,40})$/;
 var MAX_GROUPS = 8;
@@ -1661,6 +1724,7 @@ function DefinedTermsProvider({
   labels
 }) {
   const editor = useDocxEditor();
+  const track = useTrackedOrNoted();
   const l = useMemo(() => ({ ...DEFAULT_DEFINED_TERMS_LABELS, ...labels }), [labels]);
   const [sources, setSources] = useState(null);
   const loadedAt = useRef(0);
@@ -1717,35 +1781,46 @@ function DefinedTermsProvider({
   refreshRef.current = refresh;
   const firstHover = useCallback(() => void refreshRef.current(), []);
   const caretRect = () => container().querySelector(".docx-editor-one-surface__caret")?.getBoundingClientRect();
-  const run = useCallback(
+  const attempt = useCallback(
     (fn) => {
-      if (!editor) return void 0;
       try {
-        return withDirectEditing(editor, fn);
+        return fn();
       } catch (error) {
         notify?.(error instanceof Error ? error.message : "Could not change the document.", "error");
         return void 0;
       }
     },
-    [editor, notify]
+    [notify]
+  );
+  const run = useCallback(
+    (fn) => editor ? attempt(() => withDirectEditing(editor, fn)) : void 0,
+    [editor, attempt]
   );
   const pick = useCallback(
     (row) => {
       if (!editor || !picker || !row) return;
       const port = editorPort(editor);
-      const result = run(() => {
+      const placed = run(() => {
         if (picker.mode === "search" && picker.caret) port.setCaret(picker.caret);
-        return insertDefinedTerm(port, row.definition, {
-          replace: picker.mode === "typing" ? DEFINED_TERM_TRIGGER.length + picker.query.length : 0
-        });
+        const caret = port.caret();
+        if (!caret) throw new Error("Place the cursor where the term should go.");
+        const typed = picker.mode === "typing" ? DEFINED_TERM_TRIGGER.length + picker.query.length : 0;
+        if (typed) port.deleteRange({ ...caret, offset: Math.max(0, caret.offset - typed) }, caret);
+        return true;
       });
+      const result = placed ? attempt(
+        () => track({
+          label: `Inserted defined term: ${row.definition.term}`,
+          insert: (revision) => insertDefinedTerm(editorPort(editor, revision), row.definition)
+        })?.result
+      ) : void 0;
       setPicker(null);
       editor.surface?.focus();
       if (result) holdCaret(editor);
       if (result?.addedDefinition)
         notify?.(`\u201C${row.definition.term}\u201D added to the Definitions section.`, "success");
     },
-    [editor, picker, run, notify]
+    [editor, picker, run, attempt, track, notify]
   );
   const openPicker = useCallback(
     (anchor) => {
@@ -2149,6 +2224,7 @@ function HouseTemplateProvider({
   children
 }) {
   const editor = useDocxEditor();
+  const track = useTrackedOrNoted();
   const [template, setTemplate] = useState(builtinHouseTemplate);
   const [divergence, setDivergence] = useState(null);
   const [basedOnTemplate, setBasedOnTemplate] = useState(false);
@@ -2189,11 +2265,18 @@ function HouseTemplateProvider({
       const fragment = buildingBlockFragment(template.bytes, name);
       if (!fragment) return false;
       try {
-        const result = withDirectEditing(
-          editor,
-          () => editor.exec({ type: "paste", text: "", html: fragmentClipboardHtml(fragment) })
-        );
-        if (!result.ok) throw new Error(result.reason ?? "The block could not be inserted here.");
+        const result = track({
+          label: `Inserted Quick Part: ${name}`,
+          insert: (revision) => editor.exec({
+            type: "paste",
+            text: "",
+            html: fragmentClipboardHtml(
+              revision ? trackInsertion(fragment, revision, true) : fragment
+            )
+          }),
+          inserted: (r) => r.ok
+        })?.result;
+        if (!result?.ok) throw new Error(result?.reason ?? "The block could not be inserted here.");
         refresh();
         return true;
       } catch (failure) {
@@ -2204,7 +2287,7 @@ function HouseTemplateProvider({
         return false;
       }
     },
-    [editor, editable, template, notify, refresh]
+    [editor, editable, template, notify, refresh, track]
   );
   const setAsHouseTemplate = useMemo(
     () => host?.setFromDocument && documentId ? async () => {
@@ -3239,7 +3322,7 @@ function NativeDocxEditor({
               if (change.source !== "load") changed();
             },
             onFontError: (e) => setError(e.message),
-            children: /* @__PURE__ */ jsx(
+            children: /* @__PURE__ */ jsx(DocxAuthorContext.Provider, { value: ready.author, children: /* @__PURE__ */ jsx(
               DefinedTermsProvider,
               {
                 load: adapter.definitions,
@@ -3312,7 +3395,7 @@ function NativeDocxEditor({
                   }
                 )
               }
-            )
+            ) })
           }
         ) }, retry) }),
         /* @__PURE__ */ jsxs("div", { className: "native-docx-actions", children: [
@@ -3407,6 +3490,6 @@ async function loadFonts(baseUrl) {
   };
 }
 
-export { BUILTIN_TEMPLATE_NAME, DEFAULT_DEFINED_TERMS_LABELS, DEFINED_TERM_TRIGGER, DefinedTermsProvider, DocxCommentActivity, DocxEditorReview, DocxMentions, DocxParticipants, DocxRibbon, HouseTemplateProvider, NativeDocxEditor, builtinHouseTemplate, contentPath, editorPort, findDefinitionsSection, insertDefinedTerm, loadDocxFonts, normalizeDocxExport, resolveHouseTemplate, reviewModule, templateFileName, updateDefinitions, useDefinedTerms, useHouseTemplate, useReview, useReviewItem, withDirectEditing };
-//# sourceMappingURL=chunk-FIEAWH4K.js.map
-//# sourceMappingURL=chunk-FIEAWH4K.js.map
+export { BUILTIN_TEMPLATE_NAME, DEFAULT_DEFINED_TERMS_LABELS, DEFINED_TERM_TRIGGER, DefinedTermsProvider, DocxAuthorContext, DocxCommentActivity, DocxEditorReview, DocxMentions, DocxParticipants, DocxRibbon, HouseTemplateProvider, NativeDocxEditor, builtinHouseTemplate, contentPath, editorPort, findDefinitionsSection, insertDefinedTerm, loadDocxFonts, normalizeDocxExport, resolveHouseTemplate, reviewModule, structuralPort, templateFileName, trackedOrNoted, updateDefinitions, useDefinedTerms, useHouseTemplate, useReview, useReviewItem, useTrackedOrNoted, withDirectEditing };
+//# sourceMappingURL=chunk-4ZTIMQ7Z.js.map
+//# sourceMappingURL=chunk-4ZTIMQ7Z.js.map