reamkit 1.7.0 → 1.9.0

package/README.md

@@ -177,7 +177,19 @@ encryption, digital signatures (PKCS#7/ECDSA/PAdES/RFC 3161), SVG page
 preview, flowed HTML export, and **docx + xlsx output** (write WordprocessingML
 / SpreadsheetML back out, incl. round-trips). Reads OOXML Transitional and Strict.
 
-See `handoff.md` for the full feature matrix and known limitations.
+**Reads PDF, too.** `Ream.parse` accepts a PDF and reconstructs a `FlowDoc` — a
+tagged PDF from its structure tree (headings, tables, lists, reading order), an
+untagged one heuristically from glyph positions (lines, paragraphs, headings,
+and a clean two-column split). It lifts back the text (via each font's
+`/ToUnicode`), raster images (JPEG verbatim; PNG/Flate/LZW/CCITT-fax decoded and
+re-encoded), `/Link` hyperlinks, form-XObject content, and filled / stroked /
+gradient vector shapes. It reads modern compressed files (cross-reference + object
+streams) and encrypted ones (RC4 / AES — the user password is passed to
+`Ream.parse(bytes, { password })`, defaulting to the permissions-only case).
+
+See [`CHANGELOG.md`](./CHANGELOG.md) for the release history; the docs
+[**Scope**](https://reamkit.dev/guides/scope/) guide has the full feature matrix
+and known limitations.
 
 ## License
 

package/dist/esm/core/converter/ream.d.ts

@@ -10,6 +10,7 @@ import { SignatureOptions, StyledRenderOptions } from '../../pdf/index.js';
 export type ReamTarget = 'pdf' | 'svg' | 'html' | 'docx' | 'xlsx';
 export interface ReamParseOptions {
     readonly readers?: ReadonlyArray<DocumentReader<SourceDoc>>;
+    readonly password?: string;
 }
 export interface ReamConvertOptions extends Omit<StyledRenderOptions, 'registry' | 'styles'> {
     readonly fonts?: FontBytesByVariant;

package/dist/esm/core/converter/ream.js

@@ -30,7 +30,7 @@ var Ream = class Ream {
 		const readers = options.readers ?? DEFAULT_READERS;
 		const reader = readers.find((r) => r.sniff(bytes));
 		if (!reader) throw new Error(`Unrecognized document format (readers: ${readers.map((r) => r.id).join(", ")})`);
-		const { doc, losses } = reader.read(bytes);
+		const { doc, losses } = reader.read(bytes, { password: options.password });
 		const sheet = doc.kind === "sheet" ? doc : void 0;
 		return new Ream(toFlowDoc(doc), sheet, losses, bytes, reader.id);
 	}

package/dist/esm/core/document-model/types.d.ts

@@ -1,4 +1,5 @@
 import { NativeBag, Pt, ResourceId } from '../ir/index.js';
+import { ShapeGradient } from '../vector.js';
 export type Alignment = 'left' | 'right' | 'center' | 'both' | 'distribute';
 export type UnderlineStyle = 'none' | 'single' | 'double' | 'thick' | 'dotted' | 'dottedHeavy' | 'dash' | 'dashHeavy' | 'wave';
 export type VerticalAlign = 'baseline' | 'superscript' | 'subscript';
@@ -346,10 +347,11 @@ export interface ShapeGeometry {
     readonly adjust?: ReadonlyMap<string, number>;
     readonly custom?: CustomGeometry;
 }
-export type ShapeFillKind = 'none' | 'solid';
+export type ShapeFillKind = 'none' | 'solid' | 'gradient';
 export interface ShapeFill {
     readonly kind: ShapeFillKind;
     readonly colorHex?: string;
+    readonly gradient?: ShapeGradient;
 }
 export type ShapeDash = 'solid' | 'dot' | 'dash' | 'dashDot' | 'lgDash' | 'lgDashDot' | 'sysDash' | 'sysDot';
 export interface ShapeLine {

package/dist/esm/core/drawingml/shape-render.d.ts

@@ -1,8 +1,10 @@
 import { ShapeGeometry, ShapeLine } from '../document-model/index.js';
-import { StrokeStyle, VectorPath } from '../vector.js';
+import { ShapeGradient, StrokeStyle, VectorPath } from '../vector.js';
 export declare const EMU_PER_PT = 12700;
 export declare const DEFAULT_INSET_LR_PT: number;
 export declare const DEFAULT_INSET_TB_PT: number;
 export declare function buildShapePaths(geometry: ShapeGeometry, widthPt: number, heightPt: number): Array<VectorPath>;
+export declare function gradientToSolid(gradient: ShapeGradient): string;
+export declare function gradientSvgDef(id: string, g: ShapeGradient): string;
 export declare function buildStroke(line: ShapeLine | undefined): StrokeStyle | undefined;
 export declare function buildShapeTransform(pageX: number, pageY: number, widthPt: number, heightPt: number, rotation60k: number, flipH: boolean, flipV: boolean): [number, number, number, number, number, number];

package/dist/esm/core/drawingml/shape-render.js

@@ -9,6 +9,32 @@ function buildShapePaths(geometry, widthPt, heightPt) {
 	if (geometry.custom) return customPaths(geometry.custom, widthPt, heightPt);
 	return [rectPath(widthPt, heightPt)];
 }
+function gradientToSolid(gradient) {
+	let r = 0;
+	let g = 0;
+	let b = 0;
+	let n = 0;
+	for (const stop of gradient.stops) {
+		const num = parseInt(stop.colorHex, 16);
+		if (Number.isNaN(num)) continue;
+		r += num >> 16 & 255;
+		g += num >> 8 & 255;
+		b += num & 255;
+		n++;
+	}
+	if (n === 0) return "000000";
+	const hx = (x) => Math.round(x / n).toString(16).padStart(2, "0");
+	return (hx(r) + hx(g) + hx(b)).toUpperCase();
+}
+function gradientSvgDef(id, g) {
+	const n = (x) => String(Math.round(x * 1e4) / 1e4);
+	const stops = g.stops.map((s) => `<stop offset="${n(s.offset)}" stop-color="#${s.colorHex}"/>`).join("");
+	if (g.kind === "radial") return `<radialGradient id="${id}">${stops}</radialGradient>`;
+	const rad = -(g.angle ?? 0) * Math.PI / 180;
+	const dx = Math.cos(rad) / 2;
+	const dy = Math.sin(rad) / 2;
+	return `<linearGradient id="${id}" x1="${n(.5 - dx)}" y1="${n(.5 - dy)}" x2="${n(.5 + dx)}" y2="${n(.5 + dy)}">${stops}</linearGradient>`;
+}
 function buildStroke(line) {
 	if (!line || line.fill === "none") return void 0;
 	const widthPt = line.width ?? DEFAULT_LINE_WIDTH_EMU / 12700;
@@ -68,4 +94,4 @@ function buildShapeTransform(pageX, pageY, widthPt, heightPt, rotation60k, flipH
 	];
 }
 //#endregion
-export { DEFAULT_INSET_LR_PT, DEFAULT_INSET_TB_PT, buildShapePaths, buildShapeTransform, buildStroke };
+export { DEFAULT_INSET_LR_PT, DEFAULT_INSET_TB_PT, buildShapePaths, buildShapeTransform, buildStroke, gradientSvgDef, gradientToSolid };

package/dist/esm/core/vector.d.ts

@@ -28,9 +28,19 @@ export interface StrokeStyle {
     readonly join?: 'miter' | 'round' | 'bevel';
     readonly dash?: ReadonlyArray<number>;
 }
+export interface GradientStop {
+    readonly offset: number;
+    readonly colorHex: string;
+}
+export interface ShapeGradient {
+    readonly kind: 'linear' | 'radial';
+    readonly angle?: number;
+    readonly stops: ReadonlyArray<GradientStop>;
+}
 export interface VectorShape {
     readonly paths: ReadonlyArray<VectorPath>;
     readonly fillColorHex?: string;
+    readonly fillGradient?: ShapeGradient;
     readonly stroke?: StrokeStyle;
     readonly transform: readonly [number, number, number, number, number, number];
 }

package/dist/esm/html/html-writer.js

@@ -6,7 +6,7 @@ import { PathBuilder, flipTransform, svgPathData } from "../core/vector.js";
 import { buildSparkline } from "../core/drawingml/sparkline-geometry.js";
 import { arcPoint, arcToBeziers } from "../core/arc-to-bezier.js";
 import { buildChartScene } from "../core/drawingml/chart-geometry.js";
-import { buildShapePaths, buildShapeTransform, buildStroke } from "../core/drawingml/shape-render.js";
+import { buildShapePaths, buildShapeTransform, buildStroke, gradientSvgDef } from "../core/drawingml/shape-render.js";
 import { sanitizeHref } from "../core/links.js";
 import { toBase64 } from "../core/bytes.js";
 //#region src/html/html-writer.ts
@@ -209,11 +209,13 @@ function emitShapeBlock(out, shape, ctx) {
 	const w = shape.width;
 	const h = shape.height;
 	const paths = buildShapePaths(shape.geometry, w, h);
-	const fill = shape.fill.kind === "solid" && shape.fill.colorHex ? `#${shape.fill.colorHex}` : "none";
+	const gradDef = shape.fill.kind === "gradient" && shape.fill.gradient ? gradientSvgDef("grad0", shape.fill.gradient) : void 0;
+	const fill = gradDef ? "url(#grad0)" : shape.fill.kind === "solid" && shape.fill.colorHex ? `#${shape.fill.colorHex}` : "none";
 	const stroke = strokeAttrs(buildStroke(shape.line));
 	const t = shape.transform;
 	const transform = ` transform="matrix(${flipTransform(buildShapeTransform(0, 0, w, h, t?.rotation60k ?? 0, t?.flipH ?? false, t?.flipV ?? false), h).map(fmt).join(" ")})"`;
 	const svg = [svgOpen(w, h, shape.altText)];
+	if (gradDef) svg.push(`<defs>${gradDef}</defs>`);
 	for (const path of paths) {
 		const rule = path.fillRule === "evenodd" ? " fill-rule=\"evenodd\"" : "";
 		svg.push(`<path d="${svgPathData(path.segments, fmt)}" fill="${fill}"${rule}${stroke}${transform}/>`);

package/dist/esm/layout/styled-layout.js

@@ -17,7 +17,7 @@ import { arcPoint, arcToBeziers } from "../core/arc-to-bezier.js";
 import { buildChartScene } from "../core/drawingml/chart-geometry.js";
 import { layoutMath, mathGlyphSegments, variantStyle } from "./math-layout.js";
 import { rectPath } from "../core/drawingml/preset-geometry.js";
-import { buildShapePaths, buildShapeTransform, buildStroke } from "../core/drawingml/shape-render.js";
+import { buildShapePaths, buildShapeTransform, buildStroke, gradientToSolid } from "../core/drawingml/shape-render.js";
 import { StructTreeBuilder } from "../pdf/struct-tree.js";
 //#region src/layout/styled-layout.ts
 function parsePdfAProfile(pdfA) {
@@ -454,7 +454,8 @@ function layoutShapeBlock(shape, options, fontResources, imageResources, content
 		heightPt = maxHeight;
 	}
 	const paths = buildShapePaths(shape.geometry, widthPt, heightPt);
-	const fillColorHex = shape.fill.kind === "solid" ? shape.fill.colorHex : void 0;
+	const fillGradient = shape.fill.kind === "gradient" ? shape.fill.gradient : void 0;
+	const fillColorHex = shape.fill.kind === "solid" ? shape.fill.colorHex : fillGradient ? gradientToSolid(fillGradient) : void 0;
 	const stroke = buildStroke(shape.line);
 	const t = shape.transform;
 	const pp = shape.paragraphProperties;
@@ -483,6 +484,7 @@ function layoutShapeBlock(shape, options, fontResources, imageResources, content
 		heightPt,
 		paths,
 		...fillColorHex ? { fillColorHex } : {},
+		...fillGradient ? { fillGradient } : {},
 		...stroke ? { stroke } : {},
 		rotation60k: t?.rotation60k ?? 0,
 		flipH: t?.flipH ?? false,
@@ -2013,6 +2015,7 @@ function paginateSections(blocks, sectionCtxs, builder, defaultLang = "en-US", n
 					shape: {
 						paths: block.paths,
 						...block.fillColorHex ? { fillColorHex: block.fillColorHex } : {},
+						...block.fillGradient ? { fillGradient: block.fillGradient } : {},
 						...block.stroke ? { stroke: block.stroke } : {},
 						transform
 					},

package/dist/esm/pdf/shading.d.ts

@@ -0,0 +1,12 @@
+import { ShapeGradient, VectorShape } from '../core/vector.js';
+import { PdfRef } from './objects.js';
+import { PdfDocument } from './writer.js';
+interface Bbox {
+    readonly minX: number;
+    readonly minY: number;
+    readonly maxX: number;
+    readonly maxY: number;
+}
+export declare function shapeBbox(shape: VectorShape): Bbox | undefined;
+export declare function buildGradientPattern(doc: PdfDocument, gradient: ShapeGradient, bbox: Bbox, ctm: readonly [number, number, number, number, number, number]): PdfRef;
+export {};

package/dist/esm/pdf/shading.js

@@ -0,0 +1,152 @@
+import { dict, name, ref } from "./objects.js";
+//#region src/pdf/shading.ts
+function shapeBbox(shape) {
+	let minX = Infinity;
+	let minY = Infinity;
+	let maxX = -Infinity;
+	let maxY = -Infinity;
+	const add = (x, y) => {
+		minX = Math.min(minX, x);
+		minY = Math.min(minY, y);
+		maxX = Math.max(maxX, x);
+		maxY = Math.max(maxY, y);
+	};
+	for (const path of shape.paths) for (const seg of path.segments) if (seg.op === "move" || seg.op === "line") add(seg.x, seg.y);
+	else if (seg.op === "cubic") {
+		add(seg.x1, seg.y1);
+		add(seg.x2, seg.y2);
+		add(seg.x, seg.y);
+	}
+	return Number.isFinite(minX) && maxX > minX && maxY > minY ? {
+		minX,
+		minY,
+		maxX,
+		maxY
+	} : void 0;
+}
+function buildGradientPattern(doc, gradient, bbox, ctm) {
+	const fnRef = doc.add(buildRamp(gradient.stops));
+	const shading = gradient.kind === "radial" ? radialShading(bbox, fnRef) : axialShading(gradient.angle ?? 0, bbox, fnRef);
+	return doc.add(dict({
+		Type: name("Pattern"),
+		PatternType: 2,
+		Shading: shading,
+		Matrix: [...ctm]
+	}));
+}
+function axialShading(angleDeg, b, fnRef) {
+	const rad = angleDeg * Math.PI / 180;
+	const dx = Math.cos(rad);
+	const dy = -Math.sin(rad);
+	const cx = (b.minX + b.maxX) / 2;
+	const cy = (b.minY + b.maxY) / 2;
+	const cproj = cx * dx + cy * dy;
+	let tmin = Infinity;
+	let tmax = -Infinity;
+	for (const [x, y] of [
+		[b.minX, b.minY],
+		[b.maxX, b.minY],
+		[b.minX, b.maxY],
+		[b.maxX, b.maxY]
+	]) {
+		const t = x * dx + y * dy;
+		tmin = Math.min(tmin, t);
+		tmax = Math.max(tmax, t);
+	}
+	return dict({
+		ShadingType: 2,
+		ColorSpace: name("DeviceRGB"),
+		Coords: [
+			cx + (tmin - cproj) * dx,
+			cy + (tmin - cproj) * dy,
+			cx + (tmax - cproj) * dx,
+			cy + (tmax - cproj) * dy
+		],
+		Function: ref(fnRef.id),
+		Extend: [true, true]
+	});
+}
+function radialShading(b, fnRef) {
+	const cx = (b.minX + b.maxX) / 2;
+	const cy = (b.minY + b.maxY) / 2;
+	const r = Math.hypot(b.maxX - b.minX, b.maxY - b.minY) / 2;
+	return dict({
+		ShadingType: 3,
+		ColorSpace: name("DeviceRGB"),
+		Coords: [
+			cx,
+			cy,
+			0,
+			cx,
+			cy,
+			r
+		],
+		Function: ref(fnRef.id),
+		Extend: [true, true]
+	});
+}
+function buildRamp(stopsIn) {
+	const stops = normalizeStops(stopsIn);
+	if (stops.length <= 2) return dict({
+		FunctionType: 2,
+		Domain: [0, 1],
+		C0: rgb01(stops[0].colorHex),
+		C1: rgb01(stops[stops.length - 1].colorHex),
+		N: 1
+	});
+	const functions = [];
+	const bounds = [];
+	const encode = [];
+	for (let i = 0; i < stops.length - 1; i++) {
+		functions.push(dict({
+			FunctionType: 2,
+			Domain: [0, 1],
+			C0: rgb01(stops[i].colorHex),
+			C1: rgb01(stops[i + 1].colorHex),
+			N: 1
+		}));
+		if (i > 0) bounds.push(stops[i].offset);
+		encode.push(0, 1);
+	}
+	return dict({
+		FunctionType: 3,
+		Domain: [0, 1],
+		Functions: functions,
+		Bounds: bounds,
+		Encode: encode
+	});
+}
+function normalizeStops(stops) {
+	const out = stops.map((s) => ({
+		offset: Math.max(0, Math.min(1, s.offset)),
+		colorHex: s.colorHex
+	})).sort((a, b) => a.offset - b.offset);
+	if (out.length === 0) return [{
+		offset: 0,
+		colorHex: "000000"
+	}];
+	out[0] = {
+		offset: 0,
+		colorHex: out[0].colorHex
+	};
+	out[out.length - 1] = {
+		offset: 1,
+		colorHex: out[out.length - 1].colorHex
+	};
+	return out;
+}
+function rgb01(hex) {
+	const n = parseInt(hex, 16);
+	if (Number.isNaN(n)) return [
+		0,
+		0,
+		0
+	];
+	return [
+		(n >> 16 & 255) / 255,
+		(n >> 8 & 255) / 255,
+		(n & 255) / 255
+	];
+}
+//#endregion
+export { buildGradientPattern, shapeBbox };

package/dist/esm/pdf/styled-page-emitter.js

@@ -6,6 +6,7 @@ import { reverseByCodePoint } from "../core/bidi/index.js";
 import "../layout/styled-layout.js";
 import { paintPlan } from "../layout/page-doc.js";
 import { emitVectorShape } from "./vector-graphics.js";
+import { buildGradientPattern, shapeBbox } from "./shading.js";
 import { sanitizeHref } from "../core/links.js";
 import { embedAssociatedFile } from "./embedded-file.js";
 import { buildSrgbIccProfile } from "./icc-profile.js";
@@ -49,9 +50,33 @@ function assembleStyledPdf(laid, options, doc) {
 	let annotParentCount = 0;
 	const fontResourceDict = buildFontResourceDict(laid.fontResources, embeddedFonts);
 	const xobjectResourceDict = buildXObjectResourceDict(laid.imageResources, embeddedImages);
+	const gradientNames = /* @__PURE__ */ new Map();
+	const patternEntries = {};
+	if (!pdfaProfile) for (const page of renderedPages) {
+		const ph = page.height;
+		for (const item of paintPlan(page.commands).shapes) {
+			const gradient = item.shape.fillGradient;
+			if (!gradient) continue;
+			const bbox = shapeBbox(item.shape);
+			if (!bbox) continue;
+			const t = item.shape.transform;
+			const ctm = [
+				t[0],
+				-t[1],
+				t[2],
+				-t[3],
+				t[4],
+				ph - t[5]
+			];
+			const nm = `Sh${gradientNames.size}`;
+			patternEntries[nm] = ref(buildGradientPattern(doc, gradient, bbox, ctm).id);
+			gradientNames.set(item.shape, nm);
+		}
+	}
 	const resourcesDict = dict({
 		Font: fontResourceDict,
-		...xobjectResourceDict ? { XObject: xobjectResourceDict } : {}
+		...xobjectResourceDict ? { XObject: xobjectResourceDict } : {},
+		...Object.keys(patternEntries).length > 0 ? { Pattern: dict(patternEntries) } : {}
 	});
 	let pdfaIccRef;
 	let transparencyGroup;
@@ -78,7 +103,7 @@ function assembleStyledPdf(laid, options, doc) {
 				tagFor: (structId) => builder.node(structId).type
 			};
 		}
-		const { content: contentBytes, links } = emitPageContent(page, pageTagging);
+		const { content: contentBytes, links } = emitPageContent(page, pageTagging, gradientNames);
 		const contentsRef = doc.add(stream({}, contentBytes));
 		const pageEntries = {
 			Type: name("Page"),
@@ -361,7 +386,7 @@ function emitTaggedRuns(out, cmds, tagging, body) {
 	}
 	close();
 }
-function emitPageContent(page, tagging) {
+function emitPageContent(page, tagging, gradientNames) {
 	const commands = page.commands;
 	const links = [];
 	if (commands.length === 0) return {
@@ -454,7 +479,7 @@ function emitPageContent(page, tagging) {
 				H - t[5]
 			]
 		};
-		for (const op of emitVectorShape(shape)) out.push(op);
+		for (const op of emitVectorShape(shape, gradientNames?.get(sh.shape))) out.push(op);
 	});
 	const lines = plan.lines;
 	if (lines.length > 0) {

package/dist/esm/pdf/vector-graphics.d.ts

@@ -1,4 +1,4 @@
 import { VectorShape } from '../core/vector.js';
 export type { PathSegment, StrokeStyle, VectorPath, VectorShape } from '../core/vector.js';
 export { PathBuilder } from '../core/vector.js';
-export declare function emitVectorShape(shape: VectorShape): Array<string>;
+export declare function emitVectorShape(shape: VectorShape, patternName?: string): Array<string>;

package/dist/esm/pdf/vector-graphics.js

@@ -1,6 +1,6 @@
 import "../core/vector.js";
 //#region src/pdf/vector-graphics.ts
-function emitVectorShape(shape) {
+function emitVectorShape(shape, patternName) {
 	const out = [];
 	out.push("q");
 	const [a, b, c, d, e, f] = shape.transform;
@@ -14,7 +14,9 @@ function emitVectorShape(shape) {
 		const [r, g, bl] = hexToRgb01(stroke.colorHex);
 		out.push(`${num(r)} ${num(g)} ${num(bl)} RG`);
 	}
-	if (shape.fillColorHex) {
+	const usePattern = patternName !== void 0 && shape.fillGradient !== void 0;
+	if (usePattern) out.push(`/Pattern cs /${patternName} scn`);
+	else if (shape.fillColorHex) {
 		const [r, g, bl] = hexToRgb01(shape.fillColorHex);
 		out.push(`${num(r)} ${num(g)} ${num(bl)} rg`);
 	}
@@ -23,7 +25,7 @@ function emitVectorShape(shape) {
 		if (path.fillRule === "evenodd") evenodd = true;
 		for (const seg of path.segments) out.push(emitSegment(seg));
 	}
-	out.push(paintOp(shape.fillColorHex !== void 0, stroke !== void 0, evenodd));
+	out.push(paintOp(usePattern || shape.fillColorHex !== void 0, stroke !== void 0, evenodd));
 	out.push("Q");
 	return out;
 }

package/dist/esm/pdf-reader/ccitt.d.ts

@@ -0,0 +1,15 @@
+export interface CcittParams {
+    readonly k: number;
+    readonly columns: number;
+    readonly rows: number;
+    readonly byteAlign: boolean;
+}
+export declare function decodeCcitt(data: Uint8Array, params: CcittParams): Uint8Array | undefined;
+export interface Mode {
+    readonly kind: 'pass' | 'horizontal' | 'vertical';
+    readonly d: number;
+}
+export declare const WHITE_CODES: ReadonlyArray<readonly [number, string]>;
+export declare const BLACK_CODES: ReadonlyArray<readonly [number, string]>;
+export declare const SHARED_MAKEUP: ReadonlyArray<readonly [number, string]>;
+export declare const MODE_CODES: ReadonlyArray<readonly [string, Mode]>;