reamkit 1.22.0 → 1.23.0

package/dist/esm/pptx/ppt/ppt-text.d.ts

@@ -1,6 +1,8 @@
 /** A run of uniformly-formatted text within a paragraph (PPT-2). */
 export interface PptRun {
     readonly text: string;
+    /** The typeface the run names, resolved through the deck's font collection. */
+    readonly fontFamily?: string;
     readonly bold?: boolean;
     readonly italic?: boolean;
     readonly underline?: boolean;
@@ -20,6 +22,12 @@ export interface PptParagraph {
     readonly align?: number;
     /** The 0-based outline/indent level. */
     readonly level?: number;
+    /**
+     * §2.9.20 — the bullet character this paragraph is marked with, already
+     * translated out of whatever symbol font stated it. Absent when the paragraph
+     * carries none.
+     */
+    readonly bullet?: string;
 }
 /**
  * An embedded picture referenced by a slide shape — the raw image bytes pulled
@@ -80,6 +88,35 @@ export interface PptAutoShape {
     readonly fillColorHex?: string;
     /** The resolved line colour as 6-hex RGB, when present. */
     readonly lineColorHex?: string;
+    /**
+     * MS-ODRAW §2.3.7.1 — the two-colour sweep a `fillType` of 4..8 asks for.
+     * `fillColor` is one end and `fillBackColor` the other; `fillAngle` is where
+     * it runs. Read as its fillColor alone, 41246-2's title slide came out a flat
+     * teal where every reader fades it to white.
+     */
+    readonly gradient?: {
+        readonly fromHex: string;
+        readonly toHex: string;
+        readonly angleDeg: number;
+        readonly radial: boolean;
+    };
+    /**
+     * §2.3.7.1 MSOFILLTYPE 3 — a picture stretched over the shape, its blip named
+     * by `fillBlip`. A `.ppt` table is a group of cell rectangles, and a cell with
+     * a picture background states it exactly this way.
+     */
+    readonly image?: PptImage;
+    /** §2.3.7.1 MSOFILLTYPE 2 — the picture REPEATS at its own size, not stretched. */
+    readonly imageTiled?: boolean;
+    /**
+     * §2.3.7.11/.12 `fillWidth` / `fillHeight` — the size one copy occupies, in
+     * points, when the shape states it rather than leaving the tile at the
+     * picture's own size.
+     */
+    readonly tileSizePt?: {
+        readonly widthPt: number;
+        readonly heightPt: number;
+    };
     readonly geometry?: PptCustomGeometry;
 }
 /**
@@ -89,13 +126,41 @@ export interface PptAutoShape {
  */
 export interface PptShape {
     readonly rectPt?: PptRect;
+    /**
+     * §2.3.22 — the shape IS a piece of WordArt: its text is the shape, centred
+     * in its box rather than flowed from the top. Drawn as an autoshape it was a
+     * coloured rectangle where the reference has a word.
+     */
+    readonly wordArt?: boolean;
+    /**
+     * Whether the shape is a placeholder (§2.9.24). On a MASTER that means it is
+     * a prototype, not decoration: drawn on the slides that follow it, every one
+     * of them would carry "Click to edit Master title style".
+     */
+    readonly placeholder?: boolean;
     readonly paragraphs?: ReadonlyArray<PptParagraph>;
     readonly image?: PptImage;
     readonly autoShape?: PptAutoShape;
 }
-/** One slide: its shapes in document order. */
+/**
+ * A slide's background (PPT-12) — the fill on the shape MS-ODRAW marks with
+ * `fBackground`. A `.ppt` states it as a shape like any other; drawn as one it
+ * would be a rectangle among the content, and dropped it leaves a black slide
+ * white.
+ */
+export interface PptBackground {
+    /** A solid fill's colour, as 6-hex RGB. */
+    readonly fillColorHex?: string;
+    /** A shaded fill, in the same terms an autoshape's is (PPT-9). */
+    readonly gradient?: PptAutoShape['gradient'];
+    /** A picture fill, stretched over the slide (or tiled across it). */
+    readonly image?: PptImage;
+    readonly imageTiled?: boolean;
+}
+/** One slide: its shapes in document order, over its background. */
 export interface PptSlide {
     readonly shapes: ReadonlyArray<PptShape>;
+    readonly background?: PptBackground;
 }
 /** The extracted content of a `.ppt`: its slides, deck page size and encryption flag. */
 export interface PptContent {