@json-to-office/core-docx 1.3.0 → 1.4.0

package/dist/ir/compiler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../../src/ir/compiler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAEL,KAAK,kBAAkB,EACxB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAKhE,OAAO,KAAK,EAAE,UAAU,EAAiB,MAAM,gBAAgB,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAuC3D,OAAO,KAAK,EAAE,cAAc,EAAe,MAAM,wBAAwB,CAAC;AAuC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAEL,KAAK,MAAM,EAmCZ,MAAM,SAAS,CAAC;AAiBjB,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,QAAQ,EAAE,SAAS,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IACrD,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B;;;;OAIG;IACH,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACrC;AAsFD,wBAAgB,eAAe,CAC7B,SAAS,EAAE,iBAAiB,EAC5B,MAAM,EAAE,UAAU,EAClB,QAAQ,GAAE,iBAAiB,EAAO,EAClC,MAAM,GAAE,cAA0B,EAClC,OAAO,GAAE;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAO,GACvC,iBAAiB,CAmGnB"}
+{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../../src/ir/compiler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAEL,KAAK,kBAAkB,EACxB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAKhE,OAAO,KAAK,EAAE,UAAU,EAAiB,MAAM,gBAAgB,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AA6C3D,OAAO,KAAK,EAAE,cAAc,EAAe,MAAM,wBAAwB,CAAC;AAuC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAEL,KAAK,MAAM,EAoCZ,MAAM,SAAS,CAAC;AAiBjB,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,QAAQ,EAAE,SAAS,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IACrD,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B;;;;OAIG;IACH,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACrC;AA8FD,wBAAgB,eAAe,CAC7B,SAAS,EAAE,iBAAiB,EAC5B,MAAM,EAAE,UAAU,EAClB,QAAQ,GAAE,iBAAiB,EAAO,EAClC,MAAM,GAAE,cAA0B,EAClC,OAAO,GAAE;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAO,GACvC,iBAAiB,CAgHnB"}

package/dist/plugin/example/index.js

@@ -355,8 +355,7 @@ var init_minimal_docx_theme = __esm({
         },
         list: {
           format: "bullet",
-          bullet: "\u2022",
-          indent: 3
+          bullet: "\u2022"
         },
         image: {
           alignment: "left"
@@ -480,8 +479,7 @@ var init_corporate_docx_theme = __esm({
         },
         list: {
           format: "bullet",
-          bullet: "\u2022",
-          indent: 3
+          bullet: "\u2022"
         },
         statistic: {
           alignment: "center"
@@ -594,8 +592,7 @@ var init_modern_docx_theme = __esm({
         },
         list: {
           format: "bullet",
-          bullet: "\u2013",
-          indent: 3
+          bullet: "\u2013"
         },
         image: {
           alignment: "center"
@@ -719,8 +716,7 @@ var init_apex_docx_theme = __esm({
         },
         list: {
           format: "bullet",
-          bullet: "\u2022",
-          indent: 3
+          bullet: "\u2022"
         },
         image: {
           alignment: "center"
@@ -852,8 +848,7 @@ var init_devportal_docx_theme = __esm({
         },
         list: {
           format: "bullet",
-          bullet: "\u2013",
-          indent: 3
+          bullet: "\u2013"
         },
         image: {
           alignment: "center"
@@ -2751,99 +2746,6 @@ var init_styles2 = __esm({
   }
 });
 
-// src/ir/features.ts
-var DOCX_FEATURES, ALL_DOCX_FEATURES;
-var init_features = __esm({
-  "src/ir/features.ts"() {
-    "use strict";
-    DOCX_FEATURES = [
-      /** Paragraphs and text runs — the floor of the format. */
-      "paragraphs",
-      /** Named paragraph and character styles in `styles.xml`. */
-      "styles",
-      /** Numbering definitions and numbered paragraphs. */
-      "numbering",
-      /** Multiple sections with their own page setup. */
-      "sections",
-      /** Multi-column section layout. */
-      "columns",
-      /** Header and footer parts, including first/even variants. */
-      "headers-footers",
-      "tables",
-      /** Merged table cells — column span or vertical merge. */
-      "table-merged-cells",
-      /** A table positioned out of the text flow. */
-      "floating-tables",
-      /** Inline images. */
-      "images",
-      /** Anchored images with text wrapping. */
-      "floating-images",
-      /** SVG images with a raster fallback. */
-      "svg-images",
-      /** A paragraph positioned as a floating frame. */
-      "text-frames",
-      /** Native shape text boxes. */
-      "text-boxes",
-      /**
-       * A DrawingML group: shapes, text boxes and pictures sharing one child
-       * coordinate space, drawn as a single anchored or inline object.
-       *
-       * Separate from `text-boxes` because a lone `wps:wsp` run is a far smaller
-       * ask than `wpg:wgp` with child transforms, preset geometry and grouped
-       * pictures — a backend can plausibly have the first and not the second.
-       */
-      "drawing-groups",
-      /**
-       * A native chart part: a `c:chartSpace` with its own embedded workbook.
-       *
-       * Separate from `images` because a chart is not a picture with extra data —
-       * it is its own part, its own relationship and its own workbook, and a
-       * backend either writes all three or writes none. docx.js has no chart
-       * primitive at all, which is what turns a `chart` component sent to that
-       * backend into a named capability error rather than a document missing a
-       * figure.
-       */
-      "charts",
-      /** A table-of-contents field. */
-      "toc",
-      /** TOC entries baked in so an unrefreshed reader still shows them. */
-      "cached-toc",
-      /** Arbitrary Word fields, e.g. PAGE, NUMPAGES, REF. */
-      "fields",
-      /** Field results cached for readers that never refresh. */
-      "cached-fields",
-      "hyperlinks",
-      "bookmarks",
-      /** Links and REF fields that target a bookmark. */
-      "cross-references",
-      "comments",
-      /** Threaded and resolvable comments. */
-      "comment-threads",
-      "footnotes",
-      "endnotes",
-      /** Inserted and deleted content. */
-      "revisions",
-      /** Page, column and line breaks. */
-      "breaks",
-      /** Paragraph and table shading. */
-      "shading",
-      /** Paragraph, table and page borders. */
-      "borders",
-      /** Tab stops. */
-      "tab-stops",
-      /** Per-run proofing language and no-proof. */
-      "proofing-language",
-      /** Custom document properties. */
-      "custom-properties",
-      /** Right-to-left paragraph direction. */
-      "rtl"
-    ];
-    ALL_DOCX_FEATURES = new Set(
-      DOCX_FEATURES
-    );
-  }
-});
-
 // src/utils/packageDocument.ts
 import AdmZip from "adm-zip";
 function resolveGenerationDate(options) {
@@ -3251,37 +3153,47 @@ function coreProperties(ir) {
     ...metadata.custom?.length ? { customProperties: metadata.custom } : {}
   };
 }
-var DOCXJS_RENDERER_ID, NOT_YET_EMITTED, DOCXJS_CAPABILITIES;
+var DOCXJS_RENDERER_ID, DOCXJS_CAPABILITIES;
 var init_docxjs = __esm({
   "src/renderers/docxjs/index.ts"() {
     "use strict";
     init_styles2();
     init_imageUtils();
-    init_features();
     init_packageDocument();
     init_fixFloatingImageIds();
     init_emit();
     init_units();
     DOCXJS_RENDERER_ID = "docxjs";
-    NOT_YET_EMITTED = /* @__PURE__ */ new Set([
-      "table-merged-cells",
-      "cached-fields",
-      "shading",
-      "borders",
-      "rtl",
-      // `drawing-groups` is the one exclusion that is a real backend gap rather
-      // than a slice boundary: docx.js has no `wpg:wgp`. Leaving it out is what
-      // turns a native `visual` sent to this backend into a named capability
-      // error instead of a document with the graphic missing.
-      "drawing-groups",
-      // `charts` is the second real backend gap: docx.js has no chart primitive at
-      // all, so a `chart` component sent here becomes a named capability error
-      // rather than a document missing a figure.
-      "charts"
+    DOCXJS_CAPABILITIES = /* @__PURE__ */ new Set([
+      "paragraphs",
+      "styles",
+      "numbering",
+      "sections",
+      "columns",
+      "headers-footers",
+      "tables",
+      "floating-tables",
+      "images",
+      "floating-images",
+      "svg-images",
+      "text-frames",
+      "text-boxes",
+      "toc",
+      "cached-toc",
+      "fields",
+      "hyperlinks",
+      "bookmarks",
+      "cross-references",
+      "comments",
+      "comment-threads",
+      "footnotes",
+      "endnotes",
+      "revisions",
+      "breaks",
+      "tab-stops",
+      "proofing-language",
+      "custom-properties"
     ]);
-    DOCXJS_CAPABILITIES = new Set(
-      [...ALL_DOCX_FEATURES].filter((feature) => !NOT_YET_EMITTED.has(feature))
-    );
   }
 });
 
@@ -4539,11 +4451,10 @@ function coreProperties2(ir) {
     ...metadata.custom?.length ? { customProperties: metadata.custom } : {}
   };
 }
-var OFFICE_OPEN_DOCX_RENDERER_ID, OFFICE_OPEN_DOCX, UNSUPPORTED, OFFICE_OPEN_CAPABILITIES;
+var OFFICE_OPEN_DOCX_RENDERER_ID, OFFICE_OPEN_DOCX, OFFICE_OPEN_CAPABILITIES;
 var init_office_open = __esm({
   "src/renderers/office-open/index.ts"() {
     "use strict";
-    init_features();
     init_chartParts();
     init_imageUtils();
     init_packageDocument();
@@ -4551,17 +4462,37 @@ var init_office_open = __esm({
     init_styles3();
     OFFICE_OPEN_DOCX_RENDERER_ID = "office-open";
     OFFICE_OPEN_DOCX = "@office-open/docx";
-    UNSUPPORTED = /* @__PURE__ */ new Set([
-      "cached-fields",
-      "comment-threads",
-      "table-merged-cells",
-      "shading",
-      "borders",
-      "rtl"
+    OFFICE_OPEN_CAPABILITIES = /* @__PURE__ */ new Set([
+      "paragraphs",
+      "styles",
+      "numbering",
+      "sections",
+      "columns",
+      "headers-footers",
+      "tables",
+      "floating-tables",
+      "images",
+      "floating-images",
+      "svg-images",
+      "text-frames",
+      "text-boxes",
+      "drawing-groups",
+      "charts",
+      "toc",
+      "cached-toc",
+      "fields",
+      "hyperlinks",
+      "bookmarks",
+      "cross-references",
+      "comments",
+      "footnotes",
+      "endnotes",
+      "revisions",
+      "breaks",
+      "tab-stops",
+      "proofing-language",
+      "custom-properties"
     ]);
-    OFFICE_OPEN_CAPABILITIES = new Set(
-      [...ALL_DOCX_FEATURES].filter((feature) => !UNSUPPORTED.has(feature))
-    );
   }
 });
 
@@ -6192,6 +6123,13 @@ init_themes();
 init_colorUtils();
 init_styleHelpers();
 var RIGHT_MARGIN_TAB_TWIPS = 9026 * 2;
+var STATISTIC_NUMBER_STYLE_ID = "StatisticNumber";
+var STATISTIC_DESCRIPTION_STYLE_ID = "StatisticDescription";
+var STATISTIC_SIZE_POINTS = {
+  small: 20,
+  medium: 28,
+  large: 40
+};
 function isValidStyleName(name) {
   return [
     "normal",
@@ -6830,6 +6768,67 @@ function createDocumentStyles(themeNameOrObject = "minimal", language) {
     }
   };
 }
+function createStatisticStyles(theme) {
+  const definitions = [
+    {
+      id: STATISTIC_NUMBER_STYLE_ID,
+      name: "Statistic Number",
+      font: "heading",
+      sizePoints: STATISTIC_SIZE_POINTS.medium,
+      color: theme.colors.primary,
+      bold: true,
+      // Space above separates the figure from whatever preceded it; none below,
+      // because the description is the other half of the same block.
+      spacing: { before: 12, after: 0 },
+      next: STATISTIC_DESCRIPTION_STYLE_ID,
+      // The figure and its caption are one unit; a page break between them
+      // reads as a number with no label.
+      keepNext: true
+    },
+    {
+      id: STATISTIC_DESCRIPTION_STYLE_ID,
+      name: "Statistic Description",
+      font: "body",
+      sizePoints: 10,
+      color: theme.colors.textMuted,
+      bold: false,
+      spacing: { before: 0, after: 12 },
+      next: "Normal",
+      keepNext: false
+    }
+  ];
+  return definitions.filter(
+    (definition) => !(theme.styles && Object.prototype.hasOwnProperty.call(theme.styles, definition.id))
+  ).map((definition) => {
+    const fontProps = resolveFontProperties(theme, definition.font);
+    return {
+      id: definition.id,
+      name: definition.name,
+      basedOn: "Normal",
+      next: definition.next,
+      quickFormat: true,
+      run: {
+        fontFamily: fontProps.family || "Arial",
+        // Pinned, not inherited: the whole point of the style is that the
+        // figure is not body text, so a theme's body size must not decide it.
+        sizeHalfPoints: definition.sizePoints * 2,
+        color: { hex: resolveColor(definition.color, theme) },
+        bold: definition.bold
+      },
+      paragraph: {
+        spacing: {
+          ...resolveSpacing(definition.spacing),
+          ...irLineSpacing(fontProps.lineSpacing)
+        },
+        // Centred, matching the compiler's own alignment default — a KPI
+        // reads as a block, and an author who wants otherwise says so on the
+        // component, which overrides this on the paragraph.
+        alignment: convertAlignment("center"),
+        keepNext: definition.keepNext
+      }
+    };
+  });
+}
 
 // src/ir/compiler.ts
 init_styleHelpers();
@@ -8140,6 +8139,7 @@ function compileDocument(structure, layout, warnings = [], images = /* @__PURE__
     resourcesByHash: /* @__PURE__ */ new Map(),
     nextBookmarkId: CONTENT_BOOKMARK_ID_BASE + 1,
     bookmarkNames: /* @__PURE__ */ new Set(),
+    usesStatistic: false,
     styleIds: /* @__PURE__ */ new Set([
       ...styles.paragraph.map((s) => s.id),
       ...styles.character.map((s) => s.id)
@@ -8188,7 +8188,17 @@ function compileDocument(structure, layout, warnings = [], images = /* @__PURE__
       trackRevisions: structure.trackRevisions === true,
       ...noProofWords(structure.theme) ? { noProofWords: noProofWords(structure.theme) } : {}
     },
-    styles,
+    // The statistic styles are appended rather than built with the rest: a
+    // document that uses no statistic must keep the exact style set it had
+    // before the component had styles, or every recorded golden moves for a
+    // component the document does not contain.
+    styles: ctx.usesStatistic ? {
+      ...styles,
+      paragraph: [
+        ...styles.paragraph,
+        ...createStatisticStyles(structure.theme)
+      ]
+    } : styles,
     numbering: ctx.numbering,
     resources: ctx.resources,
     sections,
@@ -8203,6 +8213,21 @@ function compileDocument(structure, layout, warnings = [], images = /* @__PURE__
     unsupported: ctx.unsupported
   };
 }
+var AFTER_TABLE_TWIPS = 120;
+var BODY_STYLE_IDS = /* @__PURE__ */ new Set([void 0, "Normal"]);
+function separateFromTables(blocks) {
+  for (let i = 1; i < blocks.length; i += 1) {
+    const block2 = blocks[i];
+    if (blocks[i - 1].kind !== "table") continue;
+    if (block2.kind !== "paragraph") continue;
+    if (!BODY_STYLE_IDS.has(block2.styleId)) continue;
+    if (block2.formatting?.spacing?.beforeTwips !== void 0) continue;
+    block2.formatting = {
+      ...block2.formatting,
+      spacing: { ...block2.formatting?.spacing, beforeTwips: AFTER_TABLE_TWIPS }
+    };
+  }
+}
 function collectOutline(layout, warnings) {
   try {
     return collectDocumentOutline(layout.sections);
@@ -8279,6 +8304,7 @@ function compileSection(section2, index, ordinal, chrome, ctx) {
       })
     );
   });
+  separateFromTables(children);
   const compiled = {
     id: `s${index}`,
     path: path3,
@@ -9049,35 +9075,83 @@ function compileToc(component, scope) {
   });
   return blocks;
 }
+var TREND_GLYPHS = {
+  up: "\u25B2",
+  down: "\u25BC",
+  neutral: "\u2013"
+};
 function compileStatistic(component, scope) {
-  const { path: path3 } = scope;
+  const { ctx, path: path3 } = scope;
   const props = component.props ?? {};
   const alignment2 = compileAlignment(props.alignment) ?? "center";
+  ctx.usesStatistic = true;
   const spacing = props.spacing ? {
     ...props.spacing.before !== void 0 ? { beforeTwips: props.spacing.before } : {},
     ...props.spacing.after !== void 0 ? { afterTwips: props.spacing.after } : {}
   } : void 0;
-  const line = (text, styleId, suffix, formatting) => {
-    const value = normalizeUnicodeText(String(text ?? ""));
-    return {
-      kind: "paragraph",
-      id: `${scope.id}:${suffix}`,
-      path: `${path3}.${suffix}`,
-      styleId,
-      formatting,
-      // Nothing to say is not the same as saying nothing: an empty statistic
-      // line is a styled blank paragraph, with no run inside it at all.
-      children: value ? [{ kind: "text", text: value }] : []
-    };
-  };
+  if (props.format !== void 0) {
+    warnOnce(
+      ctx,
+      "statistic",
+      'statistic "format" is not implemented and was ignored \u2014 format the value yourself and pass the result as "number".',
+      "W_STATISTIC_FORMAT_IGNORED"
+    );
+  }
+  const text = (value) => normalizeUnicodeText(String(value ?? ""));
+  const numberPoints = STATISTIC_SIZE_POINTS[String(props.size)] ?? STATISTIC_SIZE_POINTS.medium;
+  const resized = numberPoints !== STATISTIC_SIZE_POINTS.medium;
+  const suffixHalfPoints = Math.max(12, Math.round(numberPoints));
+  const numberRuns = [];
+  const numberText = text(props.number);
+  if (numberText) {
+    numberRuns.push({
+      kind: "text",
+      text: numberText,
+      ...resized ? { formatting: { sizeHalfPoints: numberPoints * 2 } } : {}
+    });
+  }
+  const unitText = text(props.unit);
+  if (unitText) {
+    numberRuns.push({
+      kind: "text",
+      text: unitText,
+      formatting: { sizeHalfPoints: suffixHalfPoints }
+    });
+  }
+  const glyph = typeof props.trend === "string" ? TREND_GLYPHS[props.trend] : void 0;
+  const trendValue = text(props.trendValue);
+  if (glyph || trendValue) {
+    numberRuns.push({
+      kind: "text",
+      text: `${numberRuns.length > 0 ? " " : ""}${[glyph, trendValue].filter(Boolean).join(" ")}`,
+      formatting: {
+        sizeHalfPoints: suffixHalfPoints,
+        color: irColor(resolveColor(ctx.theme.colors.textMuted, ctx.theme))
+      }
+    });
+  }
+  const line = (children, styleId, suffix, formatting) => ({
+    kind: "paragraph",
+    id: `${scope.id}:${suffix}`,
+    path: `${path3}.${suffix}`,
+    styleId,
+    formatting,
+    // Nothing to say is not the same as saying nothing: an empty statistic
+    // line is a styled blank paragraph, with no run inside it at all.
+    children
+  });
+  const descriptionText = text(props.description);
   return [
-    line(props.number, "StatisticNumber", "number", {
+    line(numberRuns, STATISTIC_NUMBER_STYLE_ID, "number", {
       alignment: alignment2,
       ...spacing ? { spacing } : {}
     }),
-    line(props.description, "StatisticDescription", "description", {
-      alignment: alignment2
-    })
+    line(
+      descriptionText ? [{ kind: "text", text: descriptionText }] : [],
+      STATISTIC_DESCRIPTION_STYLE_ID,
+      "description",
+      { alignment: alignment2 }
+    )
   ];
 }
 function compileList(component, scope, referencePrefix = "list", explicitLevels) {
@@ -9150,12 +9224,12 @@ function compileList(component, scope, referencePrefix = "list", explicitLevels)
 }
 function itemSpacing(spacing, index, count) {
   const out = {};
-  if (index === 0 && spacing?.before) {
+  if (index === 0 && spacing?.before !== void 0) {
     out.beforeTwips = pointsToTwips2(spacing.before);
   }
-  if (index === count - 1 && spacing?.after) {
+  if (index === count - 1 && spacing?.after !== void 0) {
     out.afterTwips = pointsToTwips2(spacing.after);
-  } else if (spacing?.item) {
+  } else if (spacing?.item !== void 0) {
     out.afterTwips = pointsToTwips2(spacing.item);
   }
   return out;
@@ -10626,7 +10700,9 @@ function warnOnce(ctx, component, message, code) {
 }
 
 // src/renderers/registry.ts
-import { RendererRegistry } from "@json-to-office/shared/rendering";
+import {
+  RendererRegistry
+} from "@json-to-office/shared/rendering";
 
 // src/renderers/types.ts
 import {