@json-to-office/core-docx 2.7.0 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@json-to-office/core-docx",
-  "version": "2.7.0",
+  "version": "3.1.0",
   "description": "Core DOCX document generation engine",
   "type": "module",
   "main": "dist/index.js",
@@ -24,9 +24,9 @@
     "adm-zip": "0.5.16",
     "date-fns": "3.6.0",
     "probe-image-size": "7.2.3",
-    "@json-to-office/quality": "^2.6.0",
-    "@json-to-office/shared": "^2.6.0",
-    "@json-to-office/shared-docx": "^2.7.0"
+    "@json-to-office/quality": "^3.0.0",
+    "@json-to-office/shared": "^3.1.0",
+    "@json-to-office/shared-docx": "^3.0.0"
   },
   "peerDependencies": {
     "docx": "9.7.1"

package/dist/blocks/cover.d.ts

@@ -1,22 +0,0 @@
-/**
- * The `cover` block, lowered to primitives.
- *
- * A logo where the theme's `logoSlot` puts it, the cover rule from the
- * `chrome.cover` recipe a third of the way down the page, the client as an
- * eyebrow, the title in the recipe's type role, the subtitle in the theme's
- * subtitle style, and a meta line — date and confidentiality — under it. The
- * drop to the title is the block's own share of the body height the theme's
- * page leaves — a proportion resolved against the theme, never a coordinate,
- * and not a recipe key. Every colour, weight and role is the recipe's, with
- * fallbacks that hold on a theme that declares no recipe at all.
- *
- * The block does not break the page after itself: a paragraph can only break
- * before, and a break before the first paragraph of a new section is a blank
- * page. Put the cover in a section of its own and the report proper starts
- * on a fresh page with its own running head.
- */
-import type { CoverProps } from '@json-to-office/shared-docx';
-import type { ThemeConfig } from '../styles';
-import type { BlockCompilation } from './types';
-export declare function compileCover(props: CoverProps, theme: ThemeConfig): BlockCompilation;
-//# sourceMappingURL=cover.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"cover.d.ts","sourceRoot":"","sources":["../../src/blocks/cover.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAS7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAgBhD,wBAAgB,YAAY,CAC1B,KAAK,EAAE,UAAU,EACjB,KAAK,EAAE,WAAW,GACjB,gBAAgB,CA4HlB"}

package/dist/blocks/keyTakeaways.d.ts

@@ -1,20 +0,0 @@
-/**
- * The `key-takeaways` block, lowered to primitives.
- *
- * A rule in the theme's accent, a label in the theme's label role, the
- * takeaways as a list the theme's list defaults already style, and a hairline
- * to close the box. Nothing here is a coordinate or a colour of its own:
- * every value is read from the resolved theme's `chrome.keyTakeaways` recipe,
- * with defaults that hold on a theme that declares none, so the same block
- * looks like the house on `consulting` and like itself on any other theme.
- *
- * The compiled children carry a source map back to the slots — the label to
- * `/props/label`, the list items to `/props/items` — so a finding on a
- * compiled paragraph is reported at the takeaway the author can patch.
- */
-import type { KeyTakeawaysProps } from '@json-to-office/shared-docx';
-import type { ThemeConfig } from '../styles';
-import type { BlockCompilation } from './types';
-export declare const KEY_TAKEAWAYS_DEFAULT_LABEL = "Key takeaways";
-export declare function compileKeyTakeaways(props: KeyTakeawaysProps, theme: ThemeConfig): BlockCompilation;
-//# sourceMappingURL=keyTakeaways.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"keyTakeaways.d.ts","sourceRoot":"","sources":["../../src/blocks/keyTakeaways.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAG7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,eAAO,MAAM,2BAA2B,kBAAkB,CAAC;AAU3D,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,iBAAiB,EACxB,KAAK,EAAE,WAAW,GACjB,gBAAgB,CA+DlB"}

package/dist/blocks/recipe.d.ts

@@ -1,31 +0,0 @@
-/**
- * What every block reads from the theme, and how it falls back.
- *
- * A block never states a size, a colour or a coordinate of its own: it names a
- * type role and a chrome recipe, and the resolved theme supplies the values.
- * On a theme that declares neither, the block still has to draw — so each
- * helper here carries the plain fallback that holds anywhere: a named style
- * when the theme resolved one, explicit run formatting when it did not.
- */
-import type { ThemeConfig } from '../styles';
-/** What a block's rule may weigh: the `divider` component's whole range. */
-export declare const MIN_RULE_PT = 0.25;
-export declare const MAX_RULE_PT = 12;
-export declare function clampRule(weightPt: number): number;
-/** The eyebrow a theme without the role gets: small, bold, accent, caps. */
-export declare const FALLBACK_EYEBROW_FONT: {
-    readonly size: 9;
-    readonly bold: true;
-    readonly color: "accent";
-    readonly case: "upper";
-};
-/** Whether the resolved theme carries a named style for `role`. */
-export declare function hasStyle(theme: ThemeConfig, role: string): boolean;
-/**
- * The paragraph props that set text in `role`: `themeStyle` when the theme
- * resolved that role, else the explicit `font` the caller falls back to. A
- * recipe colour, when given, is stated either way — it is the theme's own
- * word on the matter.
- */
-export declare function roleProps(theme: ThemeConfig, role: string, fallbackFont: Record<string, unknown>, color?: string): Record<string, unknown>;
-//# sourceMappingURL=recipe.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"recipe.d.ts","sourceRoot":"","sources":["../../src/blocks/recipe.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,4EAA4E;AAC5E,eAAO,MAAM,WAAW,OAAO,CAAC;AAChC,eAAO,MAAM,WAAW,KAAK,CAAC;AAE9B,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,4EAA4E;AAC5E,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX,mEAAmE;AACnE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAGlE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,KAAK,CAAC,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB"}

package/dist/blocks/runningHead.d.ts

@@ -1,69 +0,0 @@
-/**
- * The `running-head` block, lowered to page chrome.
- *
- * Unlike the flow blocks, this one lowers to nothing where it stands: its
- * output is a header and a footer for the section it sits in and every later
- * section that authors no chrome of its own. The header is the document
- * title on the left and the section tracker on the right, set in the
- * `chrome.runningHead` recipe's role with a rule beneath; the footer is a
- * rule, then the confidentiality line, the page as `n / N` and the date, set
- * in the `chrome.confidentialFooter` recipe's role. Two or three parts sit
- * on tab stops at the section's measure, so the tracker is flush with the
- * right margin and the page number centred whatever the text around it. A
- * lone page number stays centred; a lone text part takes the recipe's
- * `alignment`.
- *
- * `{PAGE}` and `{TOTAL_PAGES}` are the pipeline's own placeholders: they
- * lower to Word fields, which is the only way a page can know its number.
- * Word counts from the first page of the document, cover included.
- */
-import type { RunningHeadProps } from '@json-to-office/shared-docx';
-import type { ThemeConfig } from '../styles';
-import type { BlockCompilation } from './types';
-/** What one section tells the running head about itself. */
-export interface RunningHeadScope {
-    /** Authored pointer of the block, where chrome findings land by default. */
-    block: string;
-    /** The document's `metadata.title`, the header's left text by default. */
-    documentTitle?: string;
-    /**
-     * The section's own tracker, from its `section-opener`, with the absolute
-     * authored pointer of the slot it came from.
-     */
-    opener?: {
-        text: string;
-        slot: string;
-    };
-    /** The section's `props.page` override, if it has one. */
-    page?: SectionPage;
-}
-/** The part of a section's `props.page` the measure depends on. */
-export interface SectionPage {
-    size?: 'A4' | 'A3' | 'LETTER' | 'LEGAL' | {
-        width: number;
-        height: number;
-    };
-    margins?: {
-        left?: number;
-        right?: number;
-    };
-}
-/** Header and footer, each as a compilation relative to its own array. */
-export interface RunningHeadCompilation {
-    header: BlockCompilation;
-    footer: BlockCompilation;
-}
-export declare const PAGE_OF_TOTAL = "{PAGE} / {TOTAL_PAGES}";
-/**
- * The text measure a section's chrome is laid out on: the theme's page,
- * unless the section overrides its size or side margins.
- */
-export declare function sectionMeasureTwips(theme: ThemeConfig, page?: SectionPage): number;
-/**
- * Lower a running head for one section. Every emitted pointer maps to the
- * slot whose text it carries — the opener's tracker when one set it, else
- * this block's own slot — so a finding on the compiled chrome lands where the
- * author can patch it.
- */
-export declare function compileRunningHead(props: RunningHeadProps, theme: ThemeConfig, scope: RunningHeadScope): RunningHeadCompilation;
-//# sourceMappingURL=runningHead.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"runningHead.d.ts","sourceRoot":"","sources":["../../src/blocks/runningHead.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAK7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB;IAC/B,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED,mEAAmE;AACnE,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,GAAG,OAAO,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5E,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C;AAED,0EAA0E;AAC1E,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,gBAAgB,CAAC;IACzB,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AASD,eAAO,MAAM,aAAa,2BAA2B,CAAC;AAEtD;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,WAAW,EAClB,IAAI,CAAC,EAAE,WAAW,GACjB,MAAM,CAWR;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,gBAAgB,EACvB,KAAK,EAAE,WAAW,EAClB,KAAK,EAAE,gBAAgB,GACtB,sBAAsB,CA2GxB"}

package/dist/blocks/sectionOpener.d.ts

@@ -1,26 +0,0 @@
-/**
- * The `section-opener` block, lowered to primitives.
- *
- * The number as an eyebrow in the theme's `eyebrow` role, then the title as
- * a level-1 heading — a real heading, so the table of contents, heading
- * numbering and cross-references all see the section the way Word does. The
- * tracker is not drawn in the flow at all: it is what the running head in
- * force reads for the enclosing section, resolved by {@link sectionTracker}.
- */
-import type { SectionOpenerProps } from '@json-to-office/shared-docx';
-import type { ThemeConfig } from '../styles';
-import type { BlockCompilation } from './types';
-export declare function compileSectionOpener(props: SectionOpenerProps, theme: ThemeConfig): BlockCompilation;
-/**
- * The tracker a section shows in its running head: the first enabled
- * `section-opener` among its direct children, its `tracker` or, failing that,
- * its `title`. Returns the authored pointer of the slot the text came from,
- * relative to the section, so chrome findings can point at it.
- */
-export declare function sectionTracker(section: {
-    children?: unknown;
-}): {
-    text: string;
-    slot: string;
-} | undefined;
-//# sourceMappingURL=sectionOpener.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sectionOpener.d.ts","sourceRoot":"","sources":["../../src/blocks/sectionOpener.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAG7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,kBAAkB,EACzB,KAAK,EAAE,WAAW,GACjB,gBAAgB,CAiClB;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAqB7C"}

package/dist/blocks/types.d.ts

@@ -1,15 +0,0 @@
-import type { ComponentDefinition } from '../types';
-/**
- * What lowering one block produces: the primitives, in flow order, and a
- * source map from each emitted pointer to the authored one it came from.
- *
- * Pointers are relative to the block node. A value of `''` maps an emitted
- * node to the block itself; a slot pointer such as `/props/items` maps an
- * emitted region onto the authored slot, and anything beneath it (`/props/
- * items/2`) carries the remainder across unchanged.
- */
-export interface BlockCompilation {
-    children: ComponentDefinition[];
-    sourceMap: Readonly<Record<string, string>>;
-}
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/blocks/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC7C"}