reamkit 1.23.0 → 1.25.0

package/dist/esm/pptx/ppt/ppt-reader.js

@@ -1,6 +1,7 @@
 import { pt } from "../../core/ir/units.js";
 import { ResourceStore } from "../../core/ir/resources.js";
 import { FEATURES } from "../../core/ir/features.js";
+import { knockOutColor } from "../../core/images.js";
 import { isEmf } from "../../core/metafile/emf.js";
 import { isWmf } from "../../core/metafile/wmf.js";
 import { EMPTY_STYLE_SHEET, resolveBodyStyles } from "../../core/style-cascade/resolver.js";
@@ -136,8 +137,9 @@ function bulletedRuns(para) {
 	const runs = para.runs.map(toRun);
 	if (para.bullet === void 0) return runs;
 	const { bold: _b, italic: _i, ...rest } = runs[0]?.properties ?? {};
+	const gap = hangs(para) ? "	" : " ";
 	return [{
-		text: `${para.bullet} `,
+		text: `${para.bullet}${gap}`,
 		properties: rest
 	}, ...runs];
 }
@@ -175,16 +177,13 @@ function backdropFill(bg, resources) {
 	if (bg.image) return {
 		kind: "picture",
 		imageResource: resources.put(bg.image.bytes),
-		...bg.imageTiled ? { tiled: true } : {}
+		...bg.imageTiled ? {
+			tiled: true,
+			tileFromCentre: true
+		} : {}
 	};
 	if (bg.gradient) {
-		const stops = [{
-			offset: 0,
-			colorHex: bg.gradient.fromHex
-		}, {
-			offset: 1,
-			colorHex: bg.gradient.toHex
-		}];
+		const stops = gradientStops(bg.gradient);
 		return {
 			kind: "gradient",
 			gradient: bg.gradient.radial ? {
@@ -242,9 +241,10 @@ function positionedImage(rect, image, resources) {
 		kind: "image",
 		image: {
 			float: floatAt(rect),
-			resource: resources.put(image.bytes),
+			resource: resources.put(drawnBytes(image)),
 			width: pt(rect.w),
 			height: pt(rect.h),
+			...image.crop ? { crop: image.crop } : {},
 			paragraphProperties: {}
 		}
 	};
@@ -290,34 +290,72 @@ function toCustomGeometry(g) {
 		commands
 	};
 }
+/**
+* §2.3.7.6 `fillFocus` — the stops a shaded fill's two colours make.
+*
+* A focus of zero is the plain ramp everyone expects: the first colour at one
+* end, the second at the other. Any other value means the sweep runs OUT from
+* one of them — a focus of 50 puts the first colour halfway along with the
+* second at BOTH ends, which is what 23884's every slide asks for and why its
+* background read as a flat wash into violet where the reference is blue
+* across the middle and dark only at the corners.
+*
+* @param g The gradient as the `.ppt` states it.
+* @returns The stops, in order.
+*/
+function gradientStops(g) {
+	const focus = g.focusPct ?? 0;
+	if (focus === 0) return [{
+		offset: 0,
+		colorHex: g.fromHex
+	}, {
+		offset: 1,
+		colorHex: g.toHex
+	}];
+	if (Math.abs(focus) >= 100) return [{
+		offset: 0,
+		colorHex: g.toHex
+	}, {
+		offset: 1,
+		colorHex: g.fromHex
+	}];
+	const peak = focus > 0 ? g.fromHex : g.toHex;
+	const ends = focus > 0 ? g.toHex : g.fromHex;
+	const at = focus > 0 ? focus / 100 : 1 + focus / 100;
+	return [
+		{
+			offset: 0,
+			colorHex: ends
+		},
+		{
+			offset: at,
+			colorHex: peak
+		},
+		{
+			offset: 1,
+			colorHex: ends
+		}
+	];
+}
 function positionedAutoShape(rect, auto, resources) {
 	const line = isLineShape(auto.shapeType);
 	const fill = line ? { kind: "none" } : auto.image ? {
 		kind: "picture",
 		imageResource: resources.put(auto.image.bytes),
-		...auto.imageTiled ? { tiled: true } : {},
+		...auto.imageTiled ? {
+			tiled: true,
+			tileFromCentre: true
+		} : {},
 		...auto.tileSizePt ? { tileSizePt: auto.tileSizePt } : {}
 	} : auto.gradient ? {
 		kind: "gradient",
 		gradient: auto.gradient.radial ? {
 			kind: "radial",
-			stops: [{
-				offset: 0,
-				colorHex: auto.gradient.fromHex
-			}, {
-				offset: 1,
-				colorHex: auto.gradient.toHex
-			}]
+			stops: gradientStops(auto.gradient)
 		} : {
 			kind: "linear",
 			angle: auto.gradient.angleDeg,
-			stops: [{
-				offset: 0,
-				colorHex: auto.gradient.fromHex
-			}, {
-				offset: 1,
-				colorHex: auto.gradient.toHex
-			}]
+			stops: gradientStops(auto.gradient)
 		}
 	} : auto.fillColorHex ? {
 		kind: "solid",
@@ -353,13 +391,30 @@ function inFlowImage(image, resources) {
 	return {
 		kind: "image",
 		image: {
-			resource: resources.put(image.bytes),
+			resource: resources.put(drawnBytes(image)),
 			width: pt(size.w * .75),
 			height: pt(size.h * .75),
+			...image.crop ? { crop: image.crop } : {},
 			paragraphProperties: {}
 		}
 	};
 }
+/**
+* The bytes a picture is actually DRAWN from.
+*
+* §2.3.23 `pictureTransparent` names a colour the picture is drawn without, and
+* a raster carries no alpha channel to say so — so the knock-out is baked into
+* bytes of its own. The resource store hashes content, so two shapes knocking
+* different colours out of the same blip stay two resources by themselves, and
+* one that knocks out nothing keeps the bytes it arrived with.
+*
+* @param image The picture as the shape states it.
+* @returns The bytes to store, knocked out where the shape asks for it.
+*/
+function drawnBytes(image) {
+	if (image.transparentHex === void 0 || isMetafile(image.bytes)) return image.bytes;
+	return knockOutColor(image.bytes, image.transparentHex) ?? image.bytes;
+}
 function isMetafile(d) {
 	return isEmf(d) || isWmf(d);
 }
@@ -418,12 +473,25 @@ function toRun(r) {
 function toParaProperties(p, breakBefore) {
 	const alignment = p.align !== void 0 ? alignmentFrom(p.align) : void 0;
 	const level = p.level ?? 0;
+	const leftPt = p.leftMarginPt ?? (level > 0 ? level * LEVEL_INDENT_PT : void 0);
+	const firstPt = p.indentPt !== void 0 ? p.indentPt - (leftPt ?? 0) : void 0;
 	return {
 		...breakBefore ? { pageBreakBefore: true } : {},
 		...alignment ? { alignment } : {},
-		...level > 0 ? { indentLeft: pt(level * LEVEL_INDENT_PT) } : {}
+		...leftPt !== void 0 ? { indentLeft: pt(leftPt) } : {},
+		...firstPt !== void 0 && firstPt !== 0 ? { indentFirstLine: pt(firstPt) } : {},
+		...p.spaceBeforePt !== void 0 ? { spacingBefore: pt(p.spaceBeforePt) } : {},
+		...p.spaceAfterPt !== void 0 ? { spacingAfter: pt(p.spaceAfterPt) } : {},
+		...p.lineSpacing !== void 0 && p.lineSpacing > 0 ? {
+			spacingLineRule: "auto",
+			spacingLine: pt(p.lineSpacing / 100 * 12)
+		} : {}
 	};
 }
+/** Whether the paragraph's first line starts LEFT of its body — a hanging bullet. */
+function hangs(p) {
+	return p.indentPt !== void 0 && p.leftMarginPt !== void 0 && p.indentPt < p.leftMarginPt;
+}
 function alignmentFrom(a) {
 	switch (a) {
 		case 1: return "center";

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

@@ -28,6 +28,18 @@ export interface PptParagraph {
      * carries none.
      */
     readonly bullet?: string;
+    /**
+     * §2.9.20 `leftMargin` — where the paragraph's BODY sits, in points from the
+     * text box's own left edge.
+     */
+    readonly leftMarginPt?: number;
+    /** §2.9.20 `indent` — where its FIRST line starts. Left of the body ⇒ hanging. */
+    readonly indentPt?: number;
+    /** §2.9.32 `lineSpacing`, as a PERCENTAGE of the line's height — 100 is single. */
+    readonly lineSpacing?: number;
+    /** §2.9.32 `spaceBefore` / `spaceAfter`, in points. */
+    readonly spaceBeforePt?: number;
+    readonly spaceAfterPt?: number;
 }
 /**
  * An embedded picture referenced by a slide shape — the raw image bytes pulled
@@ -35,6 +47,22 @@ export interface PptParagraph {
  */
 export interface PptImage {
     readonly bytes: Uint8Array;
+    /**
+     * §2.3.23 `cropFrom*` — the fraction of each edge of the SOURCE cut away
+     * before it is fitted to the shape's box. Absent ⇒ the whole picture.
+     */
+    readonly crop?: {
+        readonly left: number;
+        readonly top: number;
+        readonly right: number;
+        readonly bottom: number;
+    };
+    /**
+     * §2.3.23 `pictureTransparent` — the colour the picture is drawn WITHOUT,
+     * 6-hex and no leading `#`. Clip art of this age states its ground here
+     * rather than carrying an alpha channel.
+     */
+    readonly transparentHex?: string;
 }
 /** A shape's rectangle on the slide, in points (from the OfficeArtClientAnchor). */
 export interface PptRect {
@@ -99,6 +127,12 @@ export interface PptAutoShape {
         readonly toHex: string;
         readonly angleDeg: number;
         readonly radial: boolean;
+        /**
+         * §2.3.7.6 `fillFocus` — where along the sweep the FIRST colour peaks, as a
+         * percentage. Zero is a plain ramp; 50 puts it in the middle with the
+         * second colour at both ends, which is a different picture entirely.
+         */
+        readonly focusPct?: number;
     };
     /**
      * §2.3.7.1 MSOFILLTYPE 3 — a picture stretched over the shape, its blip named
@@ -138,6 +172,13 @@ export interface PptShape {
      * of them would carry "Click to edit Master title style".
      */
     readonly placeholder?: boolean;
+    /**
+     * §2.9.51 `OEPlaceholderAtom.placeholderId` — WHICH placeholder it is. The
+     * three a master keeps for the slide's furniture — 7 the date, 8 the slide
+     * number, 9 the footer — are the only ones whose text does not live in the
+     * shape at all (§2.4.15).
+     */
+    readonly placeholderId?: number;
     readonly paragraphs?: ReadonlyArray<PptParagraph>;
     readonly image?: PptImage;
     readonly autoShape?: PptAutoShape;