@json-to-office/core-docx 4.4.4 → 4.5.0

package/dist/blocks/document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/blocks/document.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAMlB,sBAAsB,EAEtB,KAAK,qBAAqB,EAG3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC1E,YAAY,EACV,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAO7C,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACnC,eAAO,MAAM,iBAAiB,+BAAyB,CAAC;AAExD,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG,kBAAkB,EAAE,CA0B3E;AAED,qFAAqF;AACrF,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,kBAAkB,EAAE,GACrC,GAAG,CAuCL;AAED,2EAA2E;AAC3E,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,SAAS,kBAAkB,EAAE,GACrC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAOxB;AAED,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,WAAW,EAClB,KAAK,GAAE,OAAO,CAAC,qBAAqB,CAAM,EAC1C,OAAO,GAAE,SAAS,kBAAkB,EAAkC,GACrE,kBAAkB,CAWpB;AAED,wBAAgB,YAAY,CAAC,CAAC,EAC5B,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,WAAW,GACjB,cAAc,CAAC,CAAC,CAAC,CAkBnB;AA8ID,8EAA8E;AAC9E,wBAAsB,uBAAuB,CAAC,CAAC,EAC7C,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,EAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,EAC5D,QAAQ,GAAE,WAAW,CAAC,MAAM,CAAa,GACxC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC,CA+C/C"}
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/blocks/document.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAMlB,sBAAsB,EAEtB,KAAK,qBAAqB,EAG3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC1E,YAAY,EACV,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAO7C,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACnC,eAAO,MAAM,iBAAiB,+BAAyB,CAAC;AAExD,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG,kBAAkB,EAAE,CA0B3E;AAED,qFAAqF;AACrF,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,kBAAkB,EAAE,GACrC,GAAG,CAuCL;AAED,2EAA2E;AAC3E,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,SAAS,kBAAkB,EAAE,GACrC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAOxB;AAED,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,WAAW,EAClB,KAAK,GAAE,OAAO,CAAC,qBAAqB,CAAM,EAC1C,OAAO,GAAE,SAAS,kBAAkB,EAAkC,GACrE,kBAAkB,CAWpB;AAED,wBAAgB,YAAY,CAAC,CAAC,EAC5B,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,WAAW,GACjB,cAAc,CAAC,CAAC,CAAC,CAkBnB;AAoJD,8EAA8E;AAC9E,wBAAsB,uBAAuB,CAAC,CAAC,EAC7C,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,EAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,EAC5D,QAAQ,GAAE,WAAW,CAAC,MAAM,CAAa,GACxC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC,CA+C/C"}

package/dist/index.js

@@ -12322,6 +12322,7 @@ function finishDocxBlocks(expanded, document, theme, evaluator, effects, sources
       }
       const props = isBlockRecord(section2.props) ? { ...section2.props } : {};
       if (chrome) {
+        const declaring = local.includes(chrome);
         const environment = {
           ...chrome.environment,
           context: {
@@ -12344,7 +12345,7 @@ function finishDocxBlocks(expanded, document, theme, evaluator, effects, sources
           );
           props[part] = evaluator.expand(compiled, `${path4}/props/${part}`);
         }
-        if (props.pageBreak === void 0)
+        if (props.pageBreak === void 0 && declaring)
           props.pageBreak = chrome.settings.pageBreak ?? true;
       }
       for (const effect of local)
@@ -14631,6 +14632,39 @@ var docxRequiredChromeRule = {
     }));
   }
 };
+var docxExhibitRequiredRule = {
+  id: "docx/exhibit-required",
+  description: "Fewer data exhibits \u2014 charts, or tables of two or more columns \u2014 than a profile or policy expects. Off until one sets a minimum.",
+  code: QUALITY_CODES.EXHIBIT_MISSING,
+  category: "composition",
+  defaultSeverity: "warning",
+  defaultCertainty: "deterministic",
+  formats: ["docx"],
+  defaultEnabled: false,
+  defaultParameters: { minimumExhibits: 1 },
+  evaluate: ({ facts, configuration, profile }) => {
+    const minimum = numberParameter(
+      configuration.parameters,
+      "minimumExhibits",
+      1
+    );
+    if (minimum <= 0) return [];
+    const charts = facts.filter((fact) => fact.kind === "docx/chart").length;
+    const tables = facts.filter(
+      (fact) => fact.kind === "docx/table" && fact.columns.length >= 2
+    ).length;
+    const exhibits = charts + tables;
+    if (exhibits >= minimum) return [];
+    return [
+      {
+        path: themeFact(facts)?.path ?? "/props",
+        message: exhibits === 0 ? `The document carries no data exhibit \u2014 no chart, no table of two or more columns; the ${profile?.id ?? "selected"} profile expects at least ${minimum}.` : `The document carries ${exhibits} data exhibit(s); the ${profile?.id ?? "selected"} profile expects at least ${minimum}.`,
+        suggestion: "Put the numbers the argument leans on into a chart-figure or a data-table block, with a takeaway and a source, where the text discusses them. A kpi-row summarises; it does not count.",
+        context: { charts, tables, minimum }
+      }
+    ];
+  }
+};
 var SECTION_CHROME_PARTS = ["header", "footer", "pageNumber"];
 var docxRunningHeadRule = {
   id: "docx/running-head",
@@ -14660,7 +14694,7 @@ var docxRunningHeadRule = {
         {
           path: fact.path,
           message: `Section ${fact.index + 1} carries no ${parts}; the ${profile?.id ?? "selected"} profile expects a running head on every section after the cover.`,
-          suggestion: "Invoke a running-head block at the top of the first body section: its section effect fills every later section with the tracker and n / N.",
+          suggestion: "Invoke a running-head block at the top of the first body section: its section effect fills every later section with the title and n / N.",
           context: { section: fact.index, missing }
         }
       ];
@@ -14848,6 +14882,7 @@ var DOCX_QUALITY_RULES = {
     docxPaletteRule,
     docxRequiredChromeRule,
     docxRunningHeadRule,
+    docxExhibitRequiredRule,
     docxTypeScaleRule,
     docxSizeCountRule,
     docxRoleDriftRule
@@ -14857,7 +14892,7 @@ var DOCX_QUALITY_PROFILES = {
   "client-report": {
     id: "client-report",
     formats: ["docx"],
-    description: "Client or public-administration report: a running head with page numbers on every section after the cover, a takeaway and a source wherever a block declares them, no heading skipped, every size on the theme scale with at most eight in play, and no page rendered empty or left half blank under the running head.",
+    description: "Client or public-administration report: a running head with page numbers on every section after the cover, a takeaway and a source wherever a block declares them, no heading skipped, every size on the theme scale with at most eight in play, no page rendered empty or left half blank under the running head, and at least one chart or table.",
     rules: {
       "docx/required-chrome": {
         parameters: { required: ["takeaway", "source"] }
@@ -14879,7 +14914,9 @@ var DOCX_QUALITY_PROFILES = {
       "rendered/empty-page": { severity: "warning" },
       // A section that ends early on its own page reads as unfinished; the
       // judge calls a page two-thirds blank a defect.
-      "rendered/page-underfilled": { severity: "warning" }
+      "rendered/page-underfilled": { severity: "warning" },
+      // A client report argues numbers: at least one chart or real table.
+      "docx/exhibit-required": { enabled: true }
     }
   },
   "executive-report": {
@@ -15140,8 +15177,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "01",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15198,8 +15234,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "02",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15271,8 +15306,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "03",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15325,8 +15359,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "04",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15347,7 +15380,7 @@ var client_report_docx_blueprint_default = {
       ]
     },
     narrative: {
-      description: "Argument-led: takeaways, then three sections of prose with one KPI row and one note as evidence, next steps last.",
+      description: "Argument-led: takeaways, then three sections of prose with one KPI row and one note as evidence, next steps last; one data table in the analysis section carries the numbers the argument leans on.",
       whenToUse: "The brief is a position, an assessment or a recommendation with few numbers; the reader follows an argument.",
       pages: {
         min: 3,
@@ -15397,8 +15430,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "01",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15438,8 +15470,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "02",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15476,8 +15507,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "03",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },
@@ -15487,6 +15517,28 @@ var client_report_docx_blueprint_default = {
                 text: "{{Body: two or three short paragraphs of evidence for the section title, each opening with its claim}}"
               }
             },
+            {
+              name: "block",
+              props: {
+                ref: "data-table",
+                slots: {
+                  title: "{{Table title: what it compares, and the period}}",
+                  labelHeader: "{{Row label}}",
+                  labels: ["{{Row 1}}", "{{Row 2}}", "{{Row 3}}"],
+                  columns: [
+                    {
+                      header: "{{Measure (unit)}}",
+                      cells: ["{{0.0}}", "{{0.0}}", "{{0.0}}"]
+                    },
+                    {
+                      header: "{{Change}}",
+                      cells: ["{{0.0}}", "{{0.0}}", "{{0.0}}"]
+                    }
+                  ],
+                  source: "{{Source: system or document, date}}"
+                }
+              }
+            },
             {
               name: "block",
               props: {
@@ -15527,8 +15579,7 @@ var client_report_docx_blueprint_default = {
                 ref: "section-opener",
                 slots: {
                   number: "04",
-                  title: "{{Section title: the finding, as a statement}}",
-                  tracker: "{{Tracker: one word}}"
+                  title: "{{Section title: the finding, as a statement}}"
                 }
               }
             },