docxodus 10.0.0 → 11.0.0

package/dist/embed.iife.js

@@ -127,7 +127,6 @@ var Docxodus = (() => {
     AnchorRenderMode: () => AnchorRenderMode,
     AnnotationLabelMode: () => AnnotationLabelMode,
     CommentRenderMode: () => CommentRenderMode,
-    ComparisonEngine: () => ComparisonEngine,
     ComparisonLogCodes: () => ComparisonLogCodes,
     ComparisonLogLevel: () => ComparisonLogLevel,
     ConflictResolution: () => ConflictResolution,
@@ -157,8 +156,6 @@ var Docxodus = (() => {
     clearPageCitationHighlight: () => clearPageCitationHighlight,
     compareDocuments: () => compareDocuments,
     compareDocumentsToHtml: () => compareDocumentsToHtml,
-    compareDocumentsToHtmlWithLog: () => compareDocumentsToHtmlWithLog,
-    compareDocumentsWithLog: () => compareDocumentsWithLog,
     computeDocumentHash: () => computeDocumentHash,
     convertDocxToHtml: () => convertDocxToHtml,
     convertDocxToHtmlWithExternalAnnotations: () => convertDocxToHtmlWithExternalAnnotations,
@@ -173,6 +170,7 @@ var Docxodus = (() => {
     createViewer: () => createViewer,
     docxDiffAcceptRevisions: () => docxDiffAcceptRevisions,
     docxDiffCompare: () => docxDiffCompare,
+    docxDiffCompareBatch: () => docxDiffCompareBatch,
     docxDiffCompareProducts: () => docxDiffCompareProducts,
     docxDiffConsolidate: () => docxDiffConsolidate,
     docxDiffGetConflicts: () => docxDiffGetConflicts,
@@ -185,7 +183,6 @@ var Docxodus = (() => {
     exportToOpenContract: () => exportToOpenContract,
     findElementById: () => findElementById,
     findElementsByType: () => findElementsByType,
-    findMovePair: () => findMovePair,
     findTextOccurrences: () => findTextOccurrences,
     fitScale: () => fitScale,
     generateAnnotationCss: () => generateAnnotationCss,
@@ -207,8 +204,6 @@ var Docxodus = (() => {
     isInitialized: () => isInitialized,
     isInsertion: () => isInsertion,
     isMove: () => isMove,
-    isMoveDestination: () => isMoveDestination,
-    isMoveSource: () => isMoveSource,
     mountRibbon: () => mountRibbon,
     navigateToPageCitation: () => navigateToPageCitation,
     openDocxSession: () => openDocxSession2,
@@ -294,11 +289,6 @@ var Docxodus = (() => {
     RevisionType2["FormatChanged"] = "FormatChanged";
     return RevisionType2;
   })(RevisionType || {});
-  var ComparisonEngine = /* @__PURE__ */ ((ComparisonEngine2) => {
-    ComparisonEngine2[ComparisonEngine2["WmlComparer"] = 0] = "WmlComparer";
-    ComparisonEngine2[ComparisonEngine2["DocxDiff"] = 1] = "DocxDiff";
-    return ComparisonEngine2;
-  })(ComparisonEngine || {});
   var CommentRenderMode = /* @__PURE__ */ ((CommentRenderMode2) => {
     CommentRenderMode2[CommentRenderMode2["Disabled"] = -1] = "Disabled";
     CommentRenderMode2[CommentRenderMode2["EndnoteStyle"] = 0] = "EndnoteStyle";
@@ -335,30 +325,16 @@ var Docxodus = (() => {
     return ConflictResolution2;
   })(ConflictResolution || {});
   function isInsertion(revision) {
-    return revision.revisionType === "Inserted" /* Inserted */;
+    return revision.family === "content_insert";
   }
   function isDeletion(revision) {
-    return revision.revisionType === "Deleted" /* Deleted */;
+    return revision.family === "content_delete";
   }
   function isMove(revision) {
-    return revision.revisionType === "Moved" /* Moved */;
+    return revision.family === "move";
   }
   function isFormatChange(revision) {
-    return revision.revisionType === "FormatChanged" /* FormatChanged */;
-  }
-  function isMoveSource(revision) {
-    return isMove(revision) && revision.isMoveSource === true;
-  }
-  function isMoveDestination(revision) {
-    return isMove(revision) && revision.isMoveSource === false;
-  }
-  function findMovePair(revision, allRevisions) {
-    if (!isMove(revision) || revision.moveGroupId === void 0) {
-      return void 0;
-    }
-    return allRevisions.find(
-      (r) => r.moveGroupId === revision.moveGroupId && r.isMoveSource !== revision.isMoveSource
-    );
+    return revision.family === "properties_change";
   }
   var PlaceholderKinds = {
     BlankFill: 1,
@@ -1155,6 +1131,58 @@ var Docxodus = (() => {
         this.wasm.SetPageNumbering(this.handle, anchorId, JSON.stringify(op))
       );
     }
+    /**
+     * Insert a **table of contents** before or after `anchorId` (issue #607). The field is written
+     * dirty and the document asks for a field update on open, so Word paginates and fills the table
+     * itself — nothing here ships a cached result that is stale the moment anything above it moves.
+     *
+     * The table is wrapped in the `w:sdt` content control Word puts around one, which is what gives
+     * it the *Update Table* control in Word's UI. Word's `TOCHeading` and `TOC1` styles are
+     * find-or-created; a document that already defines them keeps its own.
+     *
+     * Body anchors only, and refused under tracked-change recording: a generated table is regenerated
+     * wholesale on every field update, so there is no reversible way to redline it.
+     */
+    insertTableOfContents(anchorId, pos = "before", options) {
+      return JSON.parse(
+        this.wasm.InsertTableOfContents(
+          this.handle,
+          anchorId,
+          pos,
+          options ? JSON.stringify(options) : ""
+        )
+      );
+    }
+    /**
+     * Insert a **table of figures** — the captions carrying `options.captionLabel` and their page
+     * numbers. Same field mechanics as {@link insertTableOfContents}; Word writes this one as a bare
+     * paragraph rather than inside a content control, so this does too.
+     */
+    insertTableOfFigures(anchorId, pos = "before", options) {
+      return JSON.parse(
+        this.wasm.InsertTableOfFigures(
+          this.handle,
+          anchorId,
+          pos,
+          options ? JSON.stringify(options) : ""
+        )
+      );
+    }
+    /**
+     * Insert a **table of authorities** — the cases, statutes or other authorities marked in the
+     * document, grouped by `options.category`. The table lists entries the document has MARKED with
+     * `TA` fields; a document with no marked citations produces a table that is correct and empty.
+     */
+    insertTableOfAuthorities(anchorId, pos = "before", options) {
+      return JSON.parse(
+        this.wasm.InsertTableOfAuthorities(
+          this.handle,
+          anchorId,
+          pos,
+          options ? JSON.stringify(options) : ""
+        )
+      );
+    }
     /**
      * Remove the section's page-numbering start/format: it reverts to continuing the previous
      * section's numbering in Word's default `1, 2, 3`. Chapter-numbering attributes
@@ -11501,7 +11529,7 @@ var Docxodus = (() => {
   };
 
   // src/ribbon-chrome.ts
-  var RIBBON_STYLE_VERSION = "8";
+  var RIBBON_STYLE_VERSION = "9";
   var RIBBON_STYLE_ATTR = "data-docxodus-ribbon-styles";
   var RIBBON_CSS = `
 .dxr {
@@ -11564,6 +11592,27 @@ var Docxodus = (() => {
 /* Touch devices get bigger hit targets everywhere the token is used. */
 @media (pointer: coarse) { .dxr { --dxr-tap: 40px; } }
 
+/* \u2500\u2500 Scroll-edge affordances \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
+   The chrome's strips (title bar, tabs, panels, rail) scroll horizontally
+   rather than squashing or wrapping \u2014 the compact rule is "no command is
+   removed, the strip scrolls". But a hard clip mid-control reads as a broken
+   layout, especially on a phone, so ribbon.ts measures every strip and stamps
+   data-fade with the edges that hide more content ("l", "r", or both). The
+   mask dissolves content at exactly those edges \u2014 the horizontal twin of
+   .dxr-scroll's gradient veils \u2014 and lifts entirely once the strip fits, so
+   nothing is ever faded unless there is more behind it. */
+.dxr-titlebar, .dxr-tabs, .dxr-panel, .dxr-rail { --dxr-fade-l: 0px; --dxr-fade-r: 0px; }
+.dxr [data-fade] {
+  -webkit-mask-image: linear-gradient(to right,
+    transparent, #000 var(--dxr-fade-l),
+    #000 calc(100% - var(--dxr-fade-r)), transparent);
+  mask-image: linear-gradient(to right,
+    transparent, #000 var(--dxr-fade-l),
+    #000 calc(100% - var(--dxr-fade-r)), transparent);
+}
+.dxr [data-fade~="l"] { --dxr-fade-l: 28px; }
+.dxr [data-fade~="r"] { --dxr-fade-r: 28px; }
+
 /* \u2500\u2500 Chrome shell \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 */
 .dxr-chrome {
   position: sticky;
@@ -11574,12 +11623,17 @@ var Docxodus = (() => {
   border-bottom: 1px solid var(--dxr-rule);
 }
 
+/* Scrolls in EVERY density (compact just tightens it): the fade affordance
+   marks any overflowing strip as scrollable, so it must actually be. */
 .dxr-titlebar {
   display: flex;
   align-items: center;
   gap: 10px;
   padding: 6px 10px 0;
+  overflow-x: auto;
+  scrollbar-width: none;
 }
+.dxr-titlebar::-webkit-scrollbar { display: none; }
 .dxr-brand {
   display: flex;
   align-items: baseline;
@@ -12009,10 +12063,7 @@ var Docxodus = (() => {
 .dxr[data-chrome="compact"] .dxr-titlebar {
   gap: 6px;
   padding: 5px 8px 0;
-  overflow-x: auto;
-  scrollbar-width: none;
 }
-.dxr[data-chrome="compact"] .dxr-titlebar::-webkit-scrollbar { display: none; }
 .dxr[data-chrome="compact"] .dxr-brandname { display: none; }
 .dxr[data-chrome="compact"] .dxr-brand { flex: 0 1 auto; }
 /* A filename clipped to "do..." tells you less than no filename at all, so it keeps a
@@ -12678,6 +12729,8 @@ var Docxodus = (() => {
       this.featureTimer = null;
       this.featureIndex = 0;
       this.resizeObserver = null;
+      this.strips = [];
+      this.stripObserver = null;
       this.lastAnchorText = "";
       this.selectionFrame = null;
       this.options = options;
@@ -12708,6 +12761,7 @@ var Docxodus = (() => {
       this.applyStaticOptions();
       this.buildGrid();
       this.wire();
+      this.wireScrollFades();
       this.applyChrome();
       this.loader = this.createLoaderController();
       if (this.loaderOptions) this.loader.show();
@@ -12787,6 +12841,38 @@ var Docxodus = (() => {
       this.density = next;
       this.element.dataset.chrome = next;
       this.closePicker();
+      this.syncAllStripFades();
+    }
+    // ── scroll-edge affordances ─────────────────────────────────────────────────
+    /**
+     * The chrome's strips scroll horizontally instead of squashing ("no command
+     * is removed in compact"), so each one reports which edges hide more content
+     * via `data-fade` and the stylesheet dissolves content at exactly those
+     * edges. Without this a strip hard-clips mid-control and reads as broken.
+     */
+    syncStripFade(strip) {
+      const max = strip.scrollWidth - strip.clientWidth;
+      const tokens = max <= 1 ? "" : `${strip.scrollLeft > 1 ? "l " : ""}${strip.scrollLeft < max - 1 ? "r" : ""}`.trim();
+      if (tokens) strip.setAttribute("data-fade", tokens);
+      else strip.removeAttribute("data-fade");
+    }
+    syncAllStripFades() {
+      for (const strip of this.strips) this.syncStripFade(strip);
+    }
+    wireScrollFades() {
+      this.strips = Array.from(
+        this.element.querySelectorAll(".dxr-titlebar, .dxr-tabs, .dxr-panel, .dxr-rail")
+      );
+      if (typeof ResizeObserver !== "undefined") {
+        this.stripObserver = new ResizeObserver((entries) => {
+          for (const entry of entries) this.syncStripFade(entry.target);
+        });
+      }
+      for (const strip of this.strips) {
+        strip.addEventListener("scroll", () => this.syncStripFade(strip), { passive: true });
+        this.stripObserver?.observe(strip);
+        this.syncStripFade(strip);
+      }
     }
     // ── status ──────────────────────────────────────────────────────────────────
     /** Publish the lifecycle on the root, where CSS and host pages can key off it. */
@@ -12880,6 +12966,8 @@ var Docxodus = (() => {
       doc.removeEventListener("mousedown", this.onDocumentMouseDown);
       this.resizeObserver?.disconnect();
       this.resizeObserver = null;
+      this.stripObserver?.disconnect();
+      this.stripObserver = null;
       if (this.selectionFrame != null) cancelAnimationFrame(this.selectionFrame);
       this.selectionFrame = null;
       this.stopRotation();
@@ -13164,6 +13252,8 @@ var Docxodus = (() => {
         }
         host.appendChild(row);
       }
+      const panel = this.element.querySelector('.dxr-panel[data-panel="review"]');
+      if (panel) this.syncStripFade(panel);
     }
     // ── selection-driven state ──────────────────────────────────────────────────
     selectionElement() {
@@ -13598,22 +13688,18 @@ var Docxodus = (() => {
     const modifiedBytes = await toBytes(modified);
     await yieldToMain();
     let result;
-    const engine = options?.engine ?? 1 /* DocxDiff */;
-    if (options?.detailThreshold !== void 0 || options?.caseInsensitive) {
+    if (options?.caseInsensitive) {
       result = exports.DocumentComparer.CompareDocumentsWithOptions(
         originalBytes,
         modifiedBytes,
         options?.authorName ?? "Docxodus",
-        options?.detailThreshold ?? 0.15,
-        options?.caseInsensitive ?? false,
-        engine
+        options.caseInsensitive
       );
     } else {
       result = exports.DocumentComparer.CompareDocuments(
         originalBytes,
         modifiedBytes,
-        options?.authorName ?? "Docxodus",
-        engine
+        options?.authorName ?? "Docxodus"
       );
     }
     if (result.length === 0) {
@@ -13627,25 +13713,21 @@ var Docxodus = (() => {
     const modifiedBytes = await toBytes(modified);
     await yieldToMain();
     const renderTrackedChanges = options?.renderTrackedChanges ?? true;
-    const engine = options?.engine ?? 1 /* DocxDiff */;
     let result;
-    if (options?.detailThreshold !== void 0 || options?.caseInsensitive !== void 0) {
+    if (options?.caseInsensitive !== void 0) {
       result = exports.DocumentComparer.CompareDocumentsToHtmlFull(
         originalBytes,
         modifiedBytes,
         options?.authorName ?? "Docxodus",
-        options?.detailThreshold ?? 0.15,
-        options?.caseInsensitive ?? false,
-        renderTrackedChanges,
-        engine
+        options.caseInsensitive,
+        renderTrackedChanges
       );
     } else {
       result = exports.DocumentComparer.CompareDocumentsToHtmlWithOptions(
         originalBytes,
         modifiedBytes,
         options?.authorName ?? "Docxodus",
-        renderTrackedChanges,
-        engine
+        renderTrackedChanges
       );
     }
     if (isErrorResponse(result)) {
@@ -13654,93 +13736,16 @@ var Docxodus = (() => {
     }
     return result;
   }
-  async function compareDocumentsWithLog(original, modified, options) {
-    const exports = ensureInitialized();
-    const originalBytes = await toBytes(original);
-    const modifiedBytes = await toBytes(modified);
-    await yieldToMain();
-    const result = exports.DocumentComparer.CompareDocumentsWithLog(
-      originalBytes,
-      modifiedBytes,
-      options?.authorName ?? "Docxodus",
-      options?.detailThreshold ?? 0.15,
-      options?.caseInsensitive ?? false
-    );
-    const parsed = JSON.parse(result);
-    return {
-      success: parsed.Success ?? parsed.success ?? false,
-      document: parsed.DocumentBase64 || parsed.documentBase64 ? Uint8Array.from(atob(parsed.DocumentBase64 || parsed.documentBase64), (c) => c.charCodeAt(0)) : void 0,
-      error: parsed.Error ?? parsed.error,
-      log: convertLogEntries(parsed.Log || parsed.log || []),
-      hasWarnings: parsed.HasWarnings ?? parsed.hasWarnings ?? false,
-      hasErrors: parsed.HasErrors ?? parsed.hasErrors ?? false
-    };
-  }
-  async function compareDocumentsToHtmlWithLog(original, modified, options) {
-    const exports = ensureInitialized();
-    const originalBytes = await toBytes(original);
-    const modifiedBytes = await toBytes(modified);
-    await yieldToMain();
-    const result = exports.DocumentComparer.CompareDocumentsToHtmlWithLog(
-      originalBytes,
-      modifiedBytes,
-      options?.authorName ?? "Docxodus",
-      options?.detailThreshold ?? 0.15,
-      options?.caseInsensitive ?? false,
-      options?.renderTrackedChanges ?? true
-    );
-    const parsed = JSON.parse(result);
-    return {
-      success: parsed.Success ?? parsed.success ?? false,
-      html: parsed.Html ?? parsed.html,
-      error: parsed.Error ?? parsed.error,
-      log: convertLogEntries(parsed.Log || parsed.log || []),
-      hasWarnings: parsed.HasWarnings ?? parsed.hasWarnings ?? false,
-      hasErrors: parsed.HasErrors ?? parsed.hasErrors ?? false
-    };
-  }
-  function convertLogEntries(entries) {
-    return entries.map((e) => ({
-      level: e.Level ?? e.level ?? "Info",
-      code: e.Code ?? e.code ?? "",
-      message: e.Message ?? e.message ?? "",
-      details: e.Details ?? e.details,
-      location: e.Location ?? e.location
-    }));
-  }
-  async function getRevisions(document2, options) {
+  async function getRevisions(document2) {
     const exports = ensureInitialized();
     const bytes = await toBytes(document2);
     await yieldToMain();
-    const detectMoves = options?.detectMoves ?? true;
-    const moveSimilarityThreshold = options?.moveSimilarityThreshold ?? 0.8;
-    const moveMinimumWordCount = options?.moveMinimumWordCount ?? 3;
-    const caseInsensitive = options?.caseInsensitive ?? false;
-    const result = exports.DocumentComparer.GetRevisionsJsonWithOptions(
-      bytes,
-      detectMoves,
-      moveSimilarityThreshold,
-      moveMinimumWordCount,
-      caseInsensitive
-    );
+    const result = exports.DocumentComparer.GetRevisionsJson(bytes);
     if (isErrorResponse(result)) {
       const error = parseError(result);
       throw new Error(`Failed to get revisions: ${error.error}`);
     }
-    const parsed = JSON.parse(result);
-    return (parsed.Revisions || parsed.revisions || []).map((r) => ({
-      author: r.Author || r.author,
-      date: r.Date || r.date,
-      revisionType: r.RevisionType || r.revisionType,
-      text: r.Text || r.text,
-      moveGroupId: r.MoveGroupId ?? r.moveGroupId,
-      isMoveSource: r.IsMoveSource ?? r.isMoveSource,
-      formatChange: r.FormatChange || r.formatChange ? {
-        oldProperties: r.FormatChange?.OldProperties || r.formatChange?.oldProperties,
-        newProperties: r.FormatChange?.NewProperties || r.formatChange?.newProperties,
-        changedPropertyNames: r.FormatChange?.ChangedPropertyNames || r.formatChange?.changedPropertyNames
-      } : void 0
-    }));
+    return JSON.parse(result);
   }
   function docxDiffSettingsJson(settings) {
     return settings ? JSON.stringify(settings) : "";
@@ -13800,6 +13805,38 @@ var Docxodus = (() => {
       semanticChanges: parsed.semanticChanges !== void 0 ? parsed.semanticChanges : void 0
     };
   }
+  async function docxDiffCompareBatch(baseline, candidates, settings, products) {
+    const exports = ensureInitialized();
+    const baselineBytes = await toBytes(baseline);
+    const payload = [];
+    for (let i = 0; i < candidates.length; i++) {
+      const bytes = await toBytes(candidates[i].document);
+      payload.push({
+        name: candidates[i].name ?? String(i),
+        docB64: bytesToBase64(bytes)
+      });
+    }
+    await yieldToMain();
+    const result = exports.DocxDiffBridge.CompareBatchJson(
+      baselineBytes,
+      JSON.stringify(payload),
+      docxDiffSettingsJson(settings),
+      products ? JSON.stringify(products) : ""
+    );
+    if (isErrorResponse(result)) {
+      const error = parseError(result);
+      throw new Error(`Failed to compare batch: ${error.error}`);
+    }
+    const parsed = JSON.parse(result);
+    return (parsed.results ?? []).map((entry) => ({
+      name: String(entry.name ?? ""),
+      error: typeof entry.error === "string" ? entry.error : void 0,
+      redline: typeof entry.redlineB64 === "string" ? Uint8Array.from(atob(entry.redlineB64), (c) => c.charCodeAt(0)) : void 0,
+      revisions: Array.isArray(entry.revisions) ? entry.revisions.map(mapDocxDiffRevision) : void 0,
+      editScript: entry.editScript !== void 0 ? entry.editScript : void 0,
+      semanticChanges: entry.semanticChanges !== void 0 ? entry.semanticChanges : void 0
+    }));
+  }
   async function docxDiffGetEditScript(left2, right2, settings) {
     const exports = ensureInitialized();
     const leftBytes = await toBytes(left2);

package/dist/embed.js

@@ -7,7 +7,7 @@
  * ```html
  * <div id="doc"></div>
  * <script type="module">
- *   import { createViewer } from "https://cdn.jsdelivr.net/npm/docxodus@9.1.1/dist/embed.bundle.js";
+ *   import { createViewer } from "https://cdn.jsdelivr.net/npm/docxodus@10.0.0/dist/embed.bundle.js";
  *   await createViewer("#doc", "./contract.docx");
  * </script>
  * ```