reamkit 1.15.4 → 1.17.0

package/dist/esm/layout/styled-layout.d.ts

@@ -1,12 +1,12 @@
-import { BodyElement, Chart, Comment, DocumentInfo, Numbering, Section, SectionProperties, StyleSheet } from '../core/document-model/index.js';
+import { BodyElement, Chart, Comment, DocumentInfo, Numbering, Section, SectionProperties, ShapeFill, StyleSheet } from '../core/document-model/index.js';
 import { FontRegistry } from '../core/font/index.js';
 import { FamilyKey } from '../core/fonts/index.js';
 import { Hyphenator } from '../core/hyphenation/index.js';
+import { Pt, ResourceStore } from '../core/ir/index.js';
 import { LaidOutDocument, PageItem } from './page-doc.js';
 import { AttachedFile } from '../pdf/embedded-file.js';
 import { SignaturePlaceholder } from '../pdf/signature.js';
 import { PdfEncryptOptions } from '../pdf/encryption.js';
-import { ResourceStore } from '../core/ir/index.js';
 import { StructTreeBuilder } from '../pdf/struct-tree.js';
 /**
  * PDF/A conformance string: part 1 (ISO 19005-1, PDF 1.4) / 2 (ISO 19005-2) / 3
@@ -75,6 +75,12 @@ export interface StyledRenderOptions {
      * `body[sections[N-1].endIndex..sections[N].endIndex)`).
      */
     readonly sections?: ReadonlyArray<Section>;
+    /**
+     * §17.6.5 — the pitch of the document grid the text is laid on. Set by the
+     * layout itself, per section (see {@link SectionRenderCtx.options}); callers
+     * state it on the section, not here.
+     */
+    readonly gridLinePitchPt?: Pt;
     /** Header/footer body content keyed by relationship id. */
     readonly headersFooters?: ReadonlyMap<string, ReadonlyArray<BodyElement>>;
     /**
@@ -149,6 +155,24 @@ export interface StyledRenderOptions {
      * converter fills this from the document's default `w:lang`.
      */
     readonly language?: string;
+    /**
+     * ECMA-376 §17.15.1.35 `w:doNotExpandShiftReturn` — when set, a justified
+     * line that ends at a soft line break (`w:br`) is drawn at its natural width
+     * instead of being stretched out to the measure.
+     */
+    readonly doNotExpandShiftReturn?: boolean;
+    /**
+     * ECMA-376 §17.2.1 `w:background` — the colour every page is painted before
+     * anything else is drawn on it. Absent ⇒ the paper's own white.
+     */
+    readonly pageBackgroundColorHex?: string;
+    /** §17.2.1 — the background's gradient or picture, when it has one. */
+    readonly pageBackgroundFill?: ShapeFill;
+    /**
+     * ECMA-376 §17.15.1.38 `w:gutterAtTop` — the binding space belongs to the
+     * TOP margin, not the left.
+     */
+    readonly gutterAtTop?: boolean;
     /**
      * §7.6 PDF encryption (AES-256, R6). Only honoured on the ASYNC conversion
      * path (WebCrypto); mutually exclusive with `pdfA` (ISO 19005 forbids
@@ -175,6 +199,12 @@ export type { DocumentInfo } from '../core/document-model/index.js';
 export declare const A4_WIDTH = 595;
 /** A4 page height in points (the page-geometry fallback). */
 export declare const A4_HEIGHT = 842;
+/**
+ * How far a space may be squeezed below its natural width — the shrink the
+ * line breaker offers when it weighs a line, and therefore the shrink the
+ * emitter owes it back when it draws one.
+ */
+export declare const GLUE_SHRINK_RATIO = 0.3;
 /**
  * §17.13.6.2 — a bookmark's GoTo destination: the page (0-based) and the y-up
  * top of the anchoring paragraph's first line.
@@ -274,10 +304,24 @@ export interface SectionRenderCtx {
     readonly footerSet: HeaderFooterSet;
     readonly titlePg: boolean;
     readonly evenAndOddHeaders: boolean;
+    /**
+     * §17.6.22 — the section begins on the page already in hand, at the point the
+     * one before it stopped, rather than on a fresh one.
+     */
+    readonly continuous: boolean;
+    /**
+     * The render options this section's content is laid out with: `options` plus
+     * whatever the section itself decides for its text — today only §17.6.5's
+     * document grid, which is a property of the SECTION and is needed by every
+     * paragraph in it. Absent on a bare context built outside a layout run.
+     */
+    readonly options?: StyledRenderOptions;
 }
 interface HfBandEntry {
     readonly commands: Array<PageItem>;
     readonly renderDynamic?: (pageNumber: number, totalPages: number) => Array<PageItem>;
+    /** Laid-out height of the band, so the body can be kept clear of it. */
+    readonly heightPt?: number;
 }
 interface HeaderFooterSet {
     readonly default: HfBandEntry;