@json-to-office/core-docx 0.13.0 → 0.14.0

package/dist/plugin/example/index.js

@@ -225,7 +225,7 @@ var init_minimal_docx_theme = __esm({
           size: 11
         },
         mono: {
-          family: "SF Mono",
+          family: "Menlo",
           size: 10
         },
         light: {
@@ -543,7 +543,7 @@ var init_modern_docx_theme = __esm({
       fonts: {
         heading: { family: "Helvetica", size: 28 },
         body: { family: "Helvetica", size: 11 },
-        mono: { family: "SF Mono", size: 10 },
+        mono: { family: "Menlo", size: 10 },
         light: { family: "Helvetica", size: 28 }
       },
       page: {
@@ -2203,7 +2203,8 @@ async function processDocument(document, theme, themeName) {
     metadata,
     sections,
     theme: effectiveTheme,
-    themeName
+    themeName,
+    trackRevisions: document.props.trackRevisions
   };
 }
 function createDocumentMetadata(props) {
@@ -2662,7 +2663,7 @@ Suggestion: ${suggestion}`
 import {
   Document,
   Paragraph as Paragraph7,
-  TextRun as TextRun5,
+  TextRun as TextRun6,
   AlignmentType as AlignmentType5,
   BookmarkStart as BookmarkStart2,
   BookmarkEnd as BookmarkEnd2
@@ -3995,6 +3996,99 @@ var CacheKeyGenerator = class {
   }
 };
 
+// src/utils/revisionUtils.ts
+import { TextRun as TextRun3, InsertedTextRun, DeletedTextRun } from "docx";
+var DEFAULT_REVISION_AUTHOR = "json-to-office";
+var DEFAULT_REVISION_DATE = "1970-01-01T00:00:00Z";
+var RevisionIdRegistry = class {
+  counter = 0;
+  next() {
+    this.counter += 1;
+    return this.counter;
+  }
+  /** Test-only: deterministic ids for snapshot assertions. */
+  clear() {
+    this.counter = 0;
+  }
+};
+var globalRevisionIdRegistry = new RevisionIdRegistry();
+var PLACEHOLDER_PATTERN = /\{[^}]+\}/;
+function segmentRuns(text, makeRun) {
+  const lines = text.split("\n");
+  return lines.map(
+    (line, index) => makeRun(index === 0 ? { text: line } : { text: line, break: 1 })
+  );
+}
+function createRevisionRuns(revision, baseStyle) {
+  const author = revision.author || DEFAULT_REVISION_AUTHOR;
+  const date = revision.date || DEFAULT_REVISION_DATE;
+  const runs = [];
+  for (const segment of revision.segments) {
+    if (!segment.text) continue;
+    const text = normalizeUnicodeText(segment.text);
+    if (segment.type === "insert") {
+      runs.push(
+        ...segmentRuns(
+          text,
+          (options) => new InsertedTextRun({
+            ...options,
+            ...baseStyle,
+            id: globalRevisionIdRegistry.next(),
+            author,
+            date
+          })
+        )
+      );
+    } else if (segment.type === "delete") {
+      runs.push(
+        ...segmentRuns(
+          text,
+          (options) => new DeletedTextRun({
+            ...options,
+            ...baseStyle,
+            id: globalRevisionIdRegistry.next(),
+            author,
+            date
+          })
+        )
+      );
+    } else if (PLACEHOLDER_PATTERN.test(text)) {
+      runs.push(
+        ...processTextWithPlaceholders(text, baseStyle, {})
+      );
+    } else {
+      runs.push(
+        ...segmentRuns(
+          text,
+          (options) => new TextRun3({ ...options, ...baseStyle })
+        )
+      );
+    }
+  }
+  return runs;
+}
+function componentHasRevision(component) {
+  const props = component.props;
+  if (props) {
+    if (props.revision) return true;
+    const items = props.items;
+    if (Array.isArray(items)) {
+      if (items.some(
+        (item) => typeof item === "object" && item !== null && "revision" in item && item.revision
+      )) {
+        return true;
+      }
+    }
+  }
+  const children = component.children;
+  if (Array.isArray(children)) {
+    return children.some(
+      (child) => typeof child === "object" && child !== null && componentHasRevision(child)
+    );
+  }
+  return false;
+}
+
 // src/core/cached-render.ts
 import { createHash as createHash2 } from "crypto";
 var componentCache = null;
@@ -4034,7 +4128,7 @@ function initializeComponentCache(cache) {
   }
 }
 async function renderComponentWithCache(component, theme, themeName, context, bypassCache = false) {
-  const forceBypassForType = component.name === "toc" || component.name === "section";
+  const forceBypassForType = component.name === "toc" || component.name === "section" || componentHasRevision(component);
   if (!componentCache) {
     initializeComponentCache();
   }
@@ -4073,7 +4167,7 @@ async function renderComponentWithCache(component, theme, themeName, context, by
 // src/core/content.ts
 import {
   Paragraph,
-  TextRun as TextRun3,
+  TextRun as TextRun4,
   Table,
   TableRow,
   TableCell,
@@ -4223,24 +4317,43 @@ function createText(content, theme, themeName, options = {}) {
       underline: options.underline ? { type: "single" } : void 0
     }
   };
-  const textRuns = parseTextWithDecorators(normalizedContent, baseTextStyle, {
-    boldColor: options.boldColor,
-    enableHyperlinks: true
-  });
-  if (options.bookmarkId) {
-    globalBookmarkRegistry.register(
-      options.bookmarkId,
-      normalizedContent,
-      "paragraph"
-    );
-    children.push(
-      new Bookmark({
-        id: options.bookmarkId,
-        children: textRuns
-      })
-    );
+  if (options.revision) {
+    const revisionRuns = createRevisionRuns(options.revision, baseTextStyle);
+    if (options.bookmarkId) {
+      globalBookmarkRegistry.register(
+        options.bookmarkId,
+        normalizedContent,
+        "paragraph"
+      );
+      children.push(
+        new Bookmark({
+          id: options.bookmarkId,
+          children: revisionRuns
+        })
+      );
+    } else {
+      children.push(...revisionRuns);
+    }
   } else {
-    children.push(...textRuns);
+    const textRuns = parseTextWithDecorators(normalizedContent, baseTextStyle, {
+      boldColor: options.boldColor,
+      enableHyperlinks: true
+    });
+    if (options.bookmarkId) {
+      globalBookmarkRegistry.register(
+        options.bookmarkId,
+        normalizedContent,
+        "paragraph"
+      );
+      children.push(
+        new Bookmark({
+          id: options.bookmarkId,
+          children: textRuns
+        })
+      );
+    } else {
+      children.push(...textRuns);
+    }
   }
   const isFloating = !!options.floating;
   const frameOptions = isFloating && options.floating ? mapFrameOptions(options.floating, theme, themeName) : void 0;
@@ -4361,7 +4474,24 @@ function createHeading(text, level, theme, _themeName, options = {}) {
       underline: options.underline ? { type: "single" } : void 0
     }
   };
-  if (options.bookmarkId) {
+  if (options.revision) {
+    const revisionRuns = createRevisionRuns(options.revision, baseTextStyle);
+    if (options.bookmarkId) {
+      globalBookmarkRegistry.register(
+        options.bookmarkId,
+        normalizedText,
+        "heading"
+      );
+      children.push(
+        new Bookmark({
+          id: options.bookmarkId,
+          children: revisionRuns
+        })
+      );
+    } else {
+      children.push(...revisionRuns);
+    }
+  } else if (options.bookmarkId) {
     globalBookmarkRegistry.register(
       options.bookmarkId,
       normalizedText,
@@ -4376,7 +4506,7 @@ function createHeading(text, level, theme, _themeName, options = {}) {
       headingTextChildren.push(...textRuns);
     } else {
       headingTextChildren.push(
-        new TextRun3({ text: normalizedText, ...baseTextStyle })
+        new TextRun4({ text: normalizedText, ...baseTextStyle })
       );
     }
     children.push(
@@ -4393,7 +4523,7 @@ function createHeading(text, level, theme, _themeName, options = {}) {
       });
       children.push(...textRuns);
     } else {
-      children.push(new TextRun3({ text: normalizedText, ...baseTextStyle }));
+      children.push(new TextRun4({ text: normalizedText, ...baseTextStyle }));
     }
   }
   return new Paragraph({
@@ -4533,10 +4663,11 @@ function createList(items, _theme, _themeName, options = {}) {
   items.forEach((item, index) => {
     const itemText = typeof item === "string" ? item : item.text;
     const itemLevel = typeof item === "object" ? item.level || 0 : 0;
-    if (!itemText.trim()) {
+    const itemRevision = typeof item === "object" ? item.revision : void 0;
+    if (!itemText.trim() && !itemRevision) {
       return;
     }
-    const textRuns = parseTextWithDecorators(
+    const textRuns = itemRevision ? createRevisionRuns(itemRevision, {}) : parseTextWithDecorators(
       itemText,
       {},
       {
@@ -4949,7 +5080,7 @@ async function createTable(columns, tableConfig, theme, themeName, _options = {}
         } catch (error) {
           const imageSource = imageComp.props.base64 || imageComp.props.path || "unknown";
           cellChildren = [
-            new TextRun3({
+            new TextRun4({
               text: `[IMAGE: ${imageSource.substring(0, 50)}${imageSource.length > 50 ? "..." : ""}]`,
               font: mergedStyle.font,
               size: mergedStyle.size,
@@ -4959,7 +5090,7 @@ async function createTable(columns, tableConfig, theme, themeName, _options = {}
         }
       } else {
         cellChildren = [
-          new TextRun3({
+          new TextRun4({
             text: `[Unsupported component type: ${cell.name}]`,
             font: mergedStyle.font,
             size: mergedStyle.size,
@@ -5356,7 +5487,9 @@ function renderHeadingComponent(component, theme, themeName) {
       keepNext: config.keepNext,
       keepLines: config.keepLines,
       // Bookmark ID for internal linking
-      bookmarkId
+      bookmarkId,
+      // Tracked-change segments (rendered as native Word revisions)
+      revision: config.revision
     }
   );
   return [header];
@@ -5400,7 +5533,7 @@ function parseMarkdownList(text) {
 function renderParagraphComponent(component, theme, themeName) {
   if (!isParagraphComponent(component)) return [];
   const resolvedConfig = component.props;
-  const listData = parseMarkdownList(resolvedConfig.text);
+  const listData = resolvedConfig.revision ? null : parseMarkdownList(resolvedConfig.text);
   if (listData) {
     const reference = globalNumberingRegistry.generateReference("markdown-list");
     const levels = [];
@@ -5477,7 +5610,9 @@ function renderParagraphComponent(component, theme, themeName) {
     // Pass keepLines property
     keepLines: resolvedConfig.keepLines,
     // Pass bookmark ID for internal linking
-    bookmarkId: resolvedConfig.id
+    bookmarkId: resolvedConfig.id,
+    // Tracked-change segments (rendered as native Word revisions)
+    revision: resolvedConfig.revision
   });
   return [text];
 }
@@ -6107,7 +6242,7 @@ import {
   Paragraph as Paragraph6,
   TableOfContents,
   AlignmentType as AlignmentType4,
-  TextRun as TextRun4,
+  TextRun as TextRun5,
   StyleLevel
 } from "docx";
 function parseDepthRange(rawDepth, fieldName, defaultFrom = 1, defaultTo = 3) {
@@ -6162,7 +6297,7 @@ function renderTocComponent(component, theme, context) {
     paragraphs.push(
       new Paragraph6({
         children: [
-          new TextRun4({
+          new TextRun5({
             text: componentProps.title,
             bold: true,
             size: 28
@@ -6460,8 +6595,10 @@ async function renderDocument(structure, layout, options) {
     styles: createWordStyles(structure.theme),
     sections,
     features: {
-      updateFields: true
+      updateFields: true,
       // Required for TOC fields to update correctly
+      // Word opens the document in review mode (further edits are tracked)
+      ...structure.trackRevisions && { trackRevisions: true }
     },
     // Add numbering configurations if any lists were rendered
     ...numberingConfigs.length > 0 && {
@@ -6506,7 +6643,7 @@ async function renderHeaderFooterComponents(components, theme, themeName, _conte
         elements.push(
           new Paragraph7({
             children: [
-              new TextRun5({
+              new TextRun6({
                 text: "[IMAGE: Missing path or base64 property]",
                 font: getThemeFonts(theme).body.family,
                 size: 20,
@@ -6588,7 +6725,7 @@ async function renderHeaderFooterComponents(components, theme, themeName, _conte
         elements.push(
           new Paragraph7({
             children: [
-              new TextRun5({
+              new TextRun6({
                 text: `[IMAGE: ${imageComp.props.path}]`,
                 font: getThemeFonts(theme).body.family,
                 size: 20,