doc-codec 0.0.0 → 1.0.0

package/dist/prop/chp.js

@@ -0,0 +1,171 @@
+import { DocFormatError } from "../errors.js";
+import { readUint16LE, readUint8 } from "../bytes.js";
+import { SGC } from "./sprm.js";
+//#region src/prop/chp.ts
+/** sprmCFBold: a ToggleOperand switching bold. */
+const SPRM_C_F_BOLD = 2101;
+/** sprmCFItalic. */
+const SPRM_C_F_ITALIC = 2102;
+/** sprmCFStrike. */
+const SPRM_C_F_STRIKE = 2103;
+/** sprmCKul: a Kul value giving the underline style; anything but 0x00 is some kind of underline. */
+const SPRM_C_KUL = 10814;
+/** sprmCHps: "an unsigned 2-byte integer, in half-points", so points are the operand halved. */
+const SPRM_C_HPS = 19011;
+/** sprmCIstd: the istd of a character style to apply. */
+const SPRM_C_ISTD = 18992;
+/** sprmCIco: an Ico value, an index into [MS-DOC] 2.9.126's fixed 17-entry palette. */
+const SPRM_C_ICO = 10818;
+/** sprmCCv: a COLORREF, the richer colour sprm that supersedes sprmCIco where both appear. */
+const SPRM_C_CV = 26736;
+/** ToggleOperand, [MS-DOC] 2.9.336. 0x80 and 0x81 are relative to the style's own value rather than absolute. */
+const TOGGLE_OFF = 0;
+const TOGGLE_ON = 1;
+const TOGGLE_INHERIT_FROM_STYLE = 128;
+const TOGGLE_INVERT_STYLE = 129;
+const HALF_POINTS_PER_POINT = 2;
+const COLOR_COMPONENT_MAX = 255;
+const ICO_PALETTE = [
+	void 0,
+	[
+		0,
+		0,
+		0
+	],
+	[
+		0,
+		0,
+		255
+	],
+	[
+		0,
+		255,
+		255
+	],
+	[
+		0,
+		255,
+		0
+	],
+	[
+		255,
+		0,
+		255
+	],
+	[
+		255,
+		0,
+		0
+	],
+	[
+		255,
+		255,
+		0
+	],
+	[
+		255,
+		255,
+		255
+	],
+	[
+		0,
+		0,
+		128
+	],
+	[
+		0,
+		128,
+		128
+	],
+	[
+		0,
+		128,
+		0
+	],
+	[
+		128,
+		0,
+		128
+	],
+	[
+		128,
+		0,
+		128
+	],
+	[
+		128,
+		128,
+		0
+	],
+	[
+		128,
+		128,
+		128
+	],
+	[
+		192,
+		192,
+		192
+	]
+];
+function toggle(operand, current) {
+	const value = readUint8(operand, 0);
+	switch (value) {
+		case TOGGLE_OFF: return false;
+		case TOGGLE_ON: return true;
+		case TOGGLE_INHERIT_FROM_STYLE: return current ?? false;
+		case TOGGLE_INVERT_STYLE: return !(current ?? false);
+		default: throw new DocFormatError(`ToggleOperand value 0x${value.toString(16)} is none of the four [MS-DOC] 2.9.336 defines (0x00, 0x01, 0x80, 0x81)`);
+	}
+}
+function icoColor(value) {
+	if (value >= ICO_PALETTE.length) throw new DocFormatError(`Ico value 0x${value.toString(16)} is not less than 0x11, the bound [MS-DOC] 2.9.126 places on the palette`);
+	const entry = ICO_PALETTE[value];
+	if (entry === void 0) return void 0;
+	const [r, g, b] = entry;
+	return {
+		r: r / COLOR_COMPONENT_MAX,
+		g: g / COLOR_COMPONENT_MAX,
+		b: b / COLOR_COMPONENT_MAX
+	};
+}
+function colorRefColor(operand) {
+	if (readUint8(operand, 3) !== 0) return void 0;
+	return {
+		r: readUint8(operand, 0) / COLOR_COMPONENT_MAX,
+		g: readUint8(operand, 1) / COLOR_COMPONENT_MAX,
+		b: readUint8(operand, 2) / COLOR_COMPONENT_MAX
+	};
+}
+function applyCharacterSprms(prls, into) {
+	for (const prl of prls) {
+		if (prl.sprm.sgc !== SGC.character) continue;
+		switch (prl.sprm.value) {
+			case SPRM_C_F_BOLD:
+				into.bold = toggle(prl.operand, into.bold);
+				break;
+			case SPRM_C_F_ITALIC:
+				into.italic = toggle(prl.operand, into.italic);
+				break;
+			case SPRM_C_F_STRIKE:
+				into.strike = toggle(prl.operand, into.strike);
+				break;
+			case SPRM_C_KUL:
+				into.underline = readUint8(prl.operand, 0) !== 0;
+				break;
+			case SPRM_C_HPS:
+				into.sizePt = readUint16LE(prl.operand, 0) / HALF_POINTS_PER_POINT;
+				break;
+			case SPRM_C_ISTD:
+				into.istd = readUint16LE(prl.operand, 0);
+				break;
+			case SPRM_C_ICO:
+				into.color = icoColor(readUint8(prl.operand, 0));
+				break;
+			case SPRM_C_CV: into.color = colorRefColor(prl.operand);
+		}
+	}
+	return into;
+}
+//#endregion
+export { applyCharacterSprms };

package/dist/prop/fkp.cjs

@@ -0,0 +1,141 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("../errors.cjs");
+const require_bytes = require("../bytes.cjs");
+const require_plc = require("../plc.cjs");
+//#region src/prop/fkp.ts
+/** Every FKP is exactly one 512-byte page, whatever the compound file's own sector size. */
+const FKP_PAGE_SIZE = 512;
+/** ChpxFkp.crun "MUST be at least 0x01, and MUST NOT exceed 0x65". */
+const MAX_CRUN = 101;
+/** PapxFkp.cpara "MUST be at least 0x01, and MUST NOT exceed 0x1D". */
+const MAX_CPARA = 29;
+/** BxPap is a 1-byte bOffset followed by a 12-byte PHE the specification says SHOULD be zero and SHOULD be ignored. */
+const BX_PAP_SIZE = 13;
+/** PnFkpChpx/PnFkpPapx: "pn (22 bits)" then 10 unused, and "the ChpxFkp structure begins at an offset of pn x 512". */
+const PN_MASK = 4194303;
+function checkPage(page, what) {
+	if (page.length !== 512) throw new require_errors.DocFormatError(`${what} is ${page.length} bytes rather than the fixed 512 every formatted disk page occupies`);
+}
+function readRgfc(page, count) {
+	const rgfc = [];
+	for (let index = 0; index <= count; index += 1) rgfc.push(require_bytes.readUint32LE(page, index * 4));
+	return rgfc;
+}
+function parseChpxFkp(page) {
+	checkPage(page, "ChpxFkp");
+	const crun = require_bytes.readUint8(page, 511);
+	if (crun < 1 || crun > MAX_CRUN) throw new require_errors.DocFormatError(`ChpxFkp declares crun ${crun}, outside the 0x01..0x${MAX_CRUN.toString(16).toUpperCase()} range [MS-DOC] permits`);
+	const rgfc = readRgfc(page, crun);
+	const rgbStart = (crun + 1) * 4;
+	return {
+		rgfc,
+		grpprl(index) {
+			if (!Number.isInteger(index) || index < 0 || index >= crun) throw new require_errors.DocFormatError(`ChpxFkp covers ${crun} runs; run ${index} was requested`);
+			const halfOffset = require_bytes.readUint8(page, rgbStart + index);
+			if (halfOffset === 0) return void 0;
+			const chpxAt = halfOffset * 2;
+			const cb = require_bytes.readUint8(page, chpxAt);
+			return require_bytes.slice(page, chpxAt + 1, cb, `Chpx for ChpxFkp run ${index}`);
+		}
+	};
+}
+function parsePapxFkp(page) {
+	checkPage(page, "PapxFkp");
+	const cpara = require_bytes.readUint8(page, 511);
+	if (cpara < 1 || cpara > MAX_CPARA) throw new require_errors.DocFormatError(`PapxFkp declares cpara ${cpara}, outside the 0x01..0x${MAX_CPARA.toString(16).toUpperCase()} range [MS-DOC] permits`);
+	const rgfc = readRgfc(page, cpara);
+	const rgbxStart = (cpara + 1) * 4;
+	return {
+		rgfc,
+		papx(index) {
+			if (!Number.isInteger(index) || index < 0 || index >= cpara) throw new require_errors.DocFormatError(`PapxFkp covers ${cpara} paragraphs; paragraph ${index} was requested`);
+			const bOffset = require_bytes.readUint8(page, rgbxStart + index * BX_PAP_SIZE);
+			if (bOffset === 0) return void 0;
+			const papxAt = bOffset * 2;
+			const cb = require_bytes.readUint8(page, papxAt);
+			let grpPrlAndIstdAt;
+			let grpPrlAndIstdSize;
+			if (cb !== 0) {
+				grpPrlAndIstdAt = papxAt + 1;
+				grpPrlAndIstdSize = 2 * cb - 1;
+			} else {
+				const cbPrime = require_bytes.readUint8(page, papxAt + 1);
+				if (cbPrime < 1) throw new require_errors.DocFormatError(`PapxInFkp for paragraph ${index} has cb 0 and cb' 0, but [MS-DOC] requires cb' to be at least 1`);
+				grpPrlAndIstdAt = papxAt + 2;
+				grpPrlAndIstdSize = 2 * cbPrime;
+			}
+			if (grpPrlAndIstdSize < 2) throw new require_errors.DocFormatError(`PapxInFkp for paragraph ${index} declares a ${grpPrlAndIstdSize}-byte GrpPrlAndIstd, too short for the 2-byte istd it must begin with`);
+			return {
+				istd: require_bytes.readUint16LE(page, grpPrlAndIstdAt),
+				grpprl: require_bytes.slice(page, grpPrlAndIstdAt + 2, grpPrlAndIstdSize - 2, `grpprl of PapxInFkp for paragraph ${index}`)
+			};
+		}
+	};
+}
+var PropertyBinTable = class {
+	#wordDocument;
+	#keys;
+	#pageNumbers;
+	#chpxPages = /* @__PURE__ */ new Map();
+	#papxPages = /* @__PURE__ */ new Map();
+	constructor(wordDocument, plc, what) {
+		this.#wordDocument = wordDocument;
+		const parsed = require_plc.parsePlc(plc, 4, what);
+		this.#keys = parsed.keys;
+		const pageNumbers = [];
+		for (let index = 0; index < parsed.count; index += 1) pageNumbers.push(require_bytes.readUint32LE(parsed.element(index), 0) & PN_MASK);
+		this.#pageNumbers = pageNumbers;
+	}
+	#pageBytes(fc) {
+		const index = require_plc.findLargestAtMost(this.#keys, fc);
+		if (index === void 0) return void 0;
+		const pageNumber = this.#pageNumbers[index];
+		if (pageNumber === void 0) throw new require_errors.DocFormatError(`bin table entry ${index} names no formatted-disk-page number`);
+		return require_bytes.slice(this.#wordDocument, pageNumber * 512, 512, `formatted disk page ${pageNumber}`);
+	}
+	#pageNumberFor(fc) {
+		const index = require_plc.findLargestAtMost(this.#keys, fc);
+		return index === void 0 ? void 0 : this.#pageNumbers[index];
+	}
+	/** The direct character-formatting grpprl covering `fc`, or undefined when the offset is outside the table or its run carries no exception. */
+	chpxGrpprl(fc) {
+		const pageNumber = this.#pageNumberFor(fc);
+		if (pageNumber === void 0) return void 0;
+		let fkp = this.#chpxPages.get(pageNumber);
+		if (fkp === void 0) {
+			const bytes = this.#pageBytes(fc);
+			if (bytes === void 0) return void 0;
+			fkp = parseChpxFkp(bytes);
+			this.#chpxPages.set(pageNumber, fkp);
+		}
+		const run = require_plc.findLargestAtMost(fkp.rgfc, fc);
+		return run === void 0 ? void 0 : fkp.grpprl(run);
+	}
+	/** The direct paragraph-formatting record covering `fc`, or undefined when the offset is outside the table or its paragraph carries no exception. */
+	papx(fc) {
+		const pageNumber = this.#pageNumberFor(fc);
+		if (pageNumber === void 0) return void 0;
+		let fkp = this.#papxPages.get(pageNumber);
+		if (fkp === void 0) {
+			const bytes = this.#pageBytes(fc);
+			if (bytes === void 0) return void 0;
+			fkp = parsePapxFkp(bytes);
+			this.#papxPages.set(pageNumber, fkp);
+		}
+		const index = require_plc.findLargestAtMost(fkp.rgfc, fc);
+		if (index === void 0) return void 0;
+		const record = fkp.papx(index);
+		if (record === void 0) return void 0;
+		const fcLim = fkp.rgfc[index + 1];
+		if (fcLim === void 0) throw new require_errors.DocFormatError(`PapxFkp paragraph ${index} has no bracketing end offset, so its extent is undefined`);
+		return {
+			...record,
+			fcLim
+		};
+	}
+};
+//#endregion
+exports.FKP_PAGE_SIZE = FKP_PAGE_SIZE;
+exports.PropertyBinTable = PropertyBinTable;
+exports.parseChpxFkp = parseChpxFkp;
+exports.parsePapxFkp = parsePapxFkp;

package/dist/prop/fkp.d.cts

@@ -0,0 +1,33 @@
+//#region src/prop/fkp.d.ts
+/** Every FKP is exactly one 512-byte page, whatever the compound file's own sector size. */
+declare const FKP_PAGE_SIZE = 512;
+interface ChpxFkp {
+  readonly rgfc: readonly number[];
+  /** The Chpx's grpprl for run `index`, or undefined when the run's rgb entry is zero and it carries no exception. */
+  grpprl(index: number): Uint8Array | undefined;
+}
+interface PapxRecord {
+  readonly istd: number;
+  readonly grpprl: Uint8Array;
+}
+interface PapxFkp {
+  readonly rgfc: readonly number[];
+  /** The PapxInFkp for paragraph `index`, or undefined when its BxPap.bOffset is zero and the paragraph takes the defaults. */
+  papx(index: number): PapxRecord | undefined;
+}
+declare function parseChpxFkp(page: Uint8Array): ChpxFkp;
+declare function parsePapxFkp(page: Uint8Array): PapxFkp;
+interface PapxLookup extends PapxRecord {
+  /** The byte offset one past the end of the paragraph this record covers -- PapxFkp.rgfc[k + 1], the paragraph boundary [MS-DOC] 2.4.2 derives its own from. */
+  readonly fcLim: number;
+}
+declare class PropertyBinTable {
+  #private;
+  constructor(wordDocument: Uint8Array, plc: Uint8Array, what: string);
+  /** The direct character-formatting grpprl covering `fc`, or undefined when the offset is outside the table or its run carries no exception. */
+  chpxGrpprl(fc: number): Uint8Array | undefined;
+  /** The direct paragraph-formatting record covering `fc`, or undefined when the offset is outside the table or its paragraph carries no exception. */
+  papx(fc: number): PapxLookup | undefined;
+}
+//#endregion
+export { ChpxFkp, FKP_PAGE_SIZE, PapxFkp, PapxLookup, PapxRecord, PropertyBinTable, parseChpxFkp, parsePapxFkp };

package/dist/prop/fkp.d.ts

@@ -0,0 +1,33 @@
+//#region src/prop/fkp.d.ts
+/** Every FKP is exactly one 512-byte page, whatever the compound file's own sector size. */
+declare const FKP_PAGE_SIZE = 512;
+interface ChpxFkp {
+  readonly rgfc: readonly number[];
+  /** The Chpx's grpprl for run `index`, or undefined when the run's rgb entry is zero and it carries no exception. */
+  grpprl(index: number): Uint8Array | undefined;
+}
+interface PapxRecord {
+  readonly istd: number;
+  readonly grpprl: Uint8Array;
+}
+interface PapxFkp {
+  readonly rgfc: readonly number[];
+  /** The PapxInFkp for paragraph `index`, or undefined when its BxPap.bOffset is zero and the paragraph takes the defaults. */
+  papx(index: number): PapxRecord | undefined;
+}
+declare function parseChpxFkp(page: Uint8Array): ChpxFkp;
+declare function parsePapxFkp(page: Uint8Array): PapxFkp;
+interface PapxLookup extends PapxRecord {
+  /** The byte offset one past the end of the paragraph this record covers -- PapxFkp.rgfc[k + 1], the paragraph boundary [MS-DOC] 2.4.2 derives its own from. */
+  readonly fcLim: number;
+}
+declare class PropertyBinTable {
+  #private;
+  constructor(wordDocument: Uint8Array, plc: Uint8Array, what: string);
+  /** The direct character-formatting grpprl covering `fc`, or undefined when the offset is outside the table or its run carries no exception. */
+  chpxGrpprl(fc: number): Uint8Array | undefined;
+  /** The direct paragraph-formatting record covering `fc`, or undefined when the offset is outside the table or its paragraph carries no exception. */
+  papx(fc: number): PapxLookup | undefined;
+}
+//#endregion
+export { ChpxFkp, FKP_PAGE_SIZE, PapxFkp, PapxLookup, PapxRecord, PropertyBinTable, parseChpxFkp, parsePapxFkp };

package/dist/prop/fkp.js

@@ -0,0 +1,137 @@
+import { DocFormatError } from "../errors.js";
+import { readUint16LE, readUint32LE, readUint8, slice } from "../bytes.js";
+import { findLargestAtMost, parsePlc } from "../plc.js";
+//#region src/prop/fkp.ts
+/** Every FKP is exactly one 512-byte page, whatever the compound file's own sector size. */
+const FKP_PAGE_SIZE = 512;
+/** ChpxFkp.crun "MUST be at least 0x01, and MUST NOT exceed 0x65". */
+const MAX_CRUN = 101;
+/** PapxFkp.cpara "MUST be at least 0x01, and MUST NOT exceed 0x1D". */
+const MAX_CPARA = 29;
+/** BxPap is a 1-byte bOffset followed by a 12-byte PHE the specification says SHOULD be zero and SHOULD be ignored. */
+const BX_PAP_SIZE = 13;
+/** PnFkpChpx/PnFkpPapx: "pn (22 bits)" then 10 unused, and "the ChpxFkp structure begins at an offset of pn x 512". */
+const PN_MASK = 4194303;
+function checkPage(page, what) {
+	if (page.length !== 512) throw new DocFormatError(`${what} is ${page.length} bytes rather than the fixed 512 every formatted disk page occupies`);
+}
+function readRgfc(page, count) {
+	const rgfc = [];
+	for (let index = 0; index <= count; index += 1) rgfc.push(readUint32LE(page, index * 4));
+	return rgfc;
+}
+function parseChpxFkp(page) {
+	checkPage(page, "ChpxFkp");
+	const crun = readUint8(page, 511);
+	if (crun < 1 || crun > MAX_CRUN) throw new DocFormatError(`ChpxFkp declares crun ${crun}, outside the 0x01..0x${MAX_CRUN.toString(16).toUpperCase()} range [MS-DOC] permits`);
+	const rgfc = readRgfc(page, crun);
+	const rgbStart = (crun + 1) * 4;
+	return {
+		rgfc,
+		grpprl(index) {
+			if (!Number.isInteger(index) || index < 0 || index >= crun) throw new DocFormatError(`ChpxFkp covers ${crun} runs; run ${index} was requested`);
+			const halfOffset = readUint8(page, rgbStart + index);
+			if (halfOffset === 0) return void 0;
+			const chpxAt = halfOffset * 2;
+			const cb = readUint8(page, chpxAt);
+			return slice(page, chpxAt + 1, cb, `Chpx for ChpxFkp run ${index}`);
+		}
+	};
+}
+function parsePapxFkp(page) {
+	checkPage(page, "PapxFkp");
+	const cpara = readUint8(page, 511);
+	if (cpara < 1 || cpara > MAX_CPARA) throw new DocFormatError(`PapxFkp declares cpara ${cpara}, outside the 0x01..0x${MAX_CPARA.toString(16).toUpperCase()} range [MS-DOC] permits`);
+	const rgfc = readRgfc(page, cpara);
+	const rgbxStart = (cpara + 1) * 4;
+	return {
+		rgfc,
+		papx(index) {
+			if (!Number.isInteger(index) || index < 0 || index >= cpara) throw new DocFormatError(`PapxFkp covers ${cpara} paragraphs; paragraph ${index} was requested`);
+			const bOffset = readUint8(page, rgbxStart + index * BX_PAP_SIZE);
+			if (bOffset === 0) return void 0;
+			const papxAt = bOffset * 2;
+			const cb = readUint8(page, papxAt);
+			let grpPrlAndIstdAt;
+			let grpPrlAndIstdSize;
+			if (cb !== 0) {
+				grpPrlAndIstdAt = papxAt + 1;
+				grpPrlAndIstdSize = 2 * cb - 1;
+			} else {
+				const cbPrime = readUint8(page, papxAt + 1);
+				if (cbPrime < 1) throw new DocFormatError(`PapxInFkp for paragraph ${index} has cb 0 and cb' 0, but [MS-DOC] requires cb' to be at least 1`);
+				grpPrlAndIstdAt = papxAt + 2;
+				grpPrlAndIstdSize = 2 * cbPrime;
+			}
+			if (grpPrlAndIstdSize < 2) throw new DocFormatError(`PapxInFkp for paragraph ${index} declares a ${grpPrlAndIstdSize}-byte GrpPrlAndIstd, too short for the 2-byte istd it must begin with`);
+			return {
+				istd: readUint16LE(page, grpPrlAndIstdAt),
+				grpprl: slice(page, grpPrlAndIstdAt + 2, grpPrlAndIstdSize - 2, `grpprl of PapxInFkp for paragraph ${index}`)
+			};
+		}
+	};
+}
+var PropertyBinTable = class {
+	#wordDocument;
+	#keys;
+	#pageNumbers;
+	#chpxPages = /* @__PURE__ */ new Map();
+	#papxPages = /* @__PURE__ */ new Map();
+	constructor(wordDocument, plc, what) {
+		this.#wordDocument = wordDocument;
+		const parsed = parsePlc(plc, 4, what);
+		this.#keys = parsed.keys;
+		const pageNumbers = [];
+		for (let index = 0; index < parsed.count; index += 1) pageNumbers.push(readUint32LE(parsed.element(index), 0) & PN_MASK);
+		this.#pageNumbers = pageNumbers;
+	}
+	#pageBytes(fc) {
+		const index = findLargestAtMost(this.#keys, fc);
+		if (index === void 0) return void 0;
+		const pageNumber = this.#pageNumbers[index];
+		if (pageNumber === void 0) throw new DocFormatError(`bin table entry ${index} names no formatted-disk-page number`);
+		return slice(this.#wordDocument, pageNumber * 512, 512, `formatted disk page ${pageNumber}`);
+	}
+	#pageNumberFor(fc) {
+		const index = findLargestAtMost(this.#keys, fc);
+		return index === void 0 ? void 0 : this.#pageNumbers[index];
+	}
+	/** The direct character-formatting grpprl covering `fc`, or undefined when the offset is outside the table or its run carries no exception. */
+	chpxGrpprl(fc) {
+		const pageNumber = this.#pageNumberFor(fc);
+		if (pageNumber === void 0) return void 0;
+		let fkp = this.#chpxPages.get(pageNumber);
+		if (fkp === void 0) {
+			const bytes = this.#pageBytes(fc);
+			if (bytes === void 0) return void 0;
+			fkp = parseChpxFkp(bytes);
+			this.#chpxPages.set(pageNumber, fkp);
+		}
+		const run = findLargestAtMost(fkp.rgfc, fc);
+		return run === void 0 ? void 0 : fkp.grpprl(run);
+	}
+	/** The direct paragraph-formatting record covering `fc`, or undefined when the offset is outside the table or its paragraph carries no exception. */
+	papx(fc) {
+		const pageNumber = this.#pageNumberFor(fc);
+		if (pageNumber === void 0) return void 0;
+		let fkp = this.#papxPages.get(pageNumber);
+		if (fkp === void 0) {
+			const bytes = this.#pageBytes(fc);
+			if (bytes === void 0) return void 0;
+			fkp = parsePapxFkp(bytes);
+			this.#papxPages.set(pageNumber, fkp);
+		}
+		const index = findLargestAtMost(fkp.rgfc, fc);
+		if (index === void 0) return void 0;
+		const record = fkp.papx(index);
+		if (record === void 0) return void 0;
+		const fcLim = fkp.rgfc[index + 1];
+		if (fcLim === void 0) throw new DocFormatError(`PapxFkp paragraph ${index} has no bracketing end offset, so its extent is undefined`);
+		return {
+			...record,
+			fcLim
+		};
+	}
+};
+//#endregion
+export { FKP_PAGE_SIZE, PropertyBinTable, parseChpxFkp, parsePapxFkp };

package/dist/prop/pap.cjs

@@ -0,0 +1,134 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_bytes = require("../bytes.cjs");
+const require_prop_sprm = require("./sprm.cjs");
+//#region src/prop/pap.ts
+/** sprmPIstd: the istd of the paragraph style. */
+const SPRM_P_ISTD = 17920;
+/** sprmPJc80: physical justification, six values. */
+const SPRM_P_JC_80 = 9219;
+/** sprmPJc: logical justification, ten values aligned with ECMA-376's ST_Jc. */
+const SPRM_P_JC = 9313;
+/** sprmPFPageBreakBefore: a Bool8. */
+const SPRM_P_F_PAGE_BREAK_BEFORE = 9223;
+/** sprmPDxaLeft80 / sprmPDxaLeft: the left indent in twips. */
+const SPRM_P_DXA_LEFT_80 = 33807;
+const SPRM_P_DXA_LEFT = 33886;
+/** sprmPDxaRight80 / sprmPDxaRight: the right indent in twips. */
+const SPRM_P_DXA_RIGHT_80 = 33806;
+const SPRM_P_DXA_RIGHT = 33885;
+/** sprmPDxaLeft180 / sprmPDxaLeft1: the first line's indent relative to the rest of the paragraph. */
+const SPRM_P_DXA_LEFT1_80 = 33809;
+const SPRM_P_DXA_LEFT1 = 33888;
+/** sprmPDyaBefore / sprmPDyaAfter: spacing in twips. */
+const SPRM_P_DYA_BEFORE = 42003;
+const SPRM_P_DYA_AFTER = 42004;
+/** sprmPDyaLine: an LSPD. */
+const SPRM_P_DYA_LINE = 25618;
+/** sprmPOutLvl: the zero-based outline level, or 0x9 for body text. */
+const SPRM_P_OUT_LVL = 9792;
+/** sprmPFInTable: a Bool8 that "MUST be 1 any time the table depth is greater than zero". */
+const SPRM_P_F_IN_TABLE = 9238;
+/** sprmPFTtp: marks a cell mark as a table-terminating-paragraph mark, i.e. the end of a row. */
+const SPRM_P_F_TTP = 9239;
+/** sprmPIlvl: the zero-based list level, or 0xC for a paragraph the list skips. */
+const SPRM_P_ILVL = 9738;
+/** sprmPIlfo: which list the paragraph is in, as an index into PlfLfo.rgLfo. */
+const SPRM_P_ILFO = 17931;
+const TWIPS_PER_POINT = 20;
+/** LSPD: "The spacing multiplier is dyaLine/240." */
+const LSPD_MULTIPLE_DIVISOR = 240;
+/** LSPD.dyaLine's multiplier form applies only "when dyaLine is between 0x0000 and 0x7BC0". */
+const LSPD_MAX_MULTIPLE_DYA_LINE = 31680;
+/** sprmPOutLvl's "0x9 - The paragraph at any outline level; instead, the paragraph is body text." */
+const OUT_LVL_BODY_TEXT = 9;
+/** sprmPIlvl's "0xC - The list skips this paragraph and does not include it in its numbering." */
+const ILVL_SKIPPED = 12;
+/** sprmPIlfo's two "not in a list" values: "0x0000 - This paragraph is not in a list" and "0xF801 - This paragraph is not in a list." */
+const ILFO_NOT_IN_LIST = 0;
+const ILFO_NOT_IN_LIST_ALT = -2047;
+function twipsToPoints(twips) {
+	return twips / TWIPS_PER_POINT;
+}
+function alignmentFromJc(value) {
+	switch (value) {
+		case 0: return "left";
+		case 1: return "center";
+		case 2: return "right";
+		case 3:
+		case 4:
+		case 5:
+		case 7:
+		case 8:
+		case 9: return "justify";
+		default: return;
+	}
+}
+function lineSpacingFromLspd(operand) {
+	const dyaLine = require_bytes.readInt16LE(operand, 0);
+	if (require_bytes.readUint16LE(operand, 2) !== 1) return void 0;
+	if (dyaLine < 0 || dyaLine > LSPD_MAX_MULTIPLE_DYA_LINE) return void 0;
+	const multiple = dyaLine / LSPD_MULTIPLE_DIVISOR;
+	return multiple > 0 ? multiple : void 0;
+}
+function applyParagraphSprms(prls, into) {
+	for (const prl of prls) {
+		if (prl.sprm.sgc !== require_prop_sprm.SGC.paragraph) continue;
+		switch (prl.sprm.value) {
+			case SPRM_P_ISTD:
+				into.istd = require_bytes.readUint16LE(prl.operand, 0);
+				break;
+			case SPRM_P_JC_80:
+			case SPRM_P_JC:
+				into.alignment = alignmentFromJc(require_bytes.readUint8(prl.operand, 0));
+				break;
+			case SPRM_P_F_PAGE_BREAK_BEFORE:
+				into.pageBreakBefore = require_bytes.readUint8(prl.operand, 0) !== 0;
+				break;
+			case SPRM_P_DXA_LEFT_80:
+			case SPRM_P_DXA_LEFT:
+				into.indentLeftPt = twipsToPoints(require_bytes.readInt16LE(prl.operand, 0));
+				break;
+			case SPRM_P_DXA_RIGHT_80:
+			case SPRM_P_DXA_RIGHT:
+				into.indentRightPt = twipsToPoints(require_bytes.readInt16LE(prl.operand, 0));
+				break;
+			case SPRM_P_DXA_LEFT1_80:
+			case SPRM_P_DXA_LEFT1:
+				into.indentFirstLinePt = twipsToPoints(require_bytes.readInt16LE(prl.operand, 0));
+				break;
+			case SPRM_P_DYA_BEFORE:
+				into.spacingBeforePt = twipsToPoints(require_bytes.readUint16LE(prl.operand, 0));
+				break;
+			case SPRM_P_DYA_AFTER:
+				into.spacingAfterPt = twipsToPoints(require_bytes.readUint16LE(prl.operand, 0));
+				break;
+			case SPRM_P_DYA_LINE:
+				into.lineSpacing = lineSpacingFromLspd(prl.operand);
+				break;
+			case SPRM_P_OUT_LVL: {
+				const level = require_bytes.readUint8(prl.operand, 0);
+				into.outlineLevel = level === OUT_LVL_BODY_TEXT ? void 0 : level;
+				break;
+			}
+			case SPRM_P_F_IN_TABLE:
+				into.inTable = require_bytes.readUint8(prl.operand, 0) !== 0;
+				break;
+			case SPRM_P_F_TTP:
+				into.tableRowEnd = require_bytes.readUint8(prl.operand, 0) !== 0;
+				break;
+			case SPRM_P_ILVL: {
+				const level = require_bytes.readUint8(prl.operand, 0);
+				into.listLevel = level === ILVL_SKIPPED ? void 0 : level;
+				break;
+			}
+			case SPRM_P_ILFO: {
+				const ilfo = require_bytes.readInt16LE(prl.operand, 0);
+				into.listId = ilfo === ILFO_NOT_IN_LIST || ilfo === ILFO_NOT_IN_LIST_ALT ? void 0 : Math.abs(ilfo);
+				break;
+			}
+		}
+	}
+	return into;
+}
+//#endregion
+exports.applyParagraphSprms = applyParagraphSprms;

package/dist/prop/pap.d.cts

@@ -0,0 +1,25 @@
+import { Prl } from "./sprm.cjs";
+import { Alignment } from "document-schema.js";
+//#region src/prop/pap.d.ts
+interface ParagraphProperties {
+  istd?: number;
+  alignment?: Alignment;
+  indentLeftPt?: number;
+  indentRightPt?: number;
+  indentFirstLinePt?: number;
+  spacingBeforePt?: number;
+  spacingAfterPt?: number;
+  lineSpacing?: number;
+  pageBreakBefore?: boolean;
+  /** sprmPOutLvl's zero-based level, present only when the paragraph is genuinely in an outline level rather than body text. */
+  outlineLevel?: number;
+  inTable?: boolean;
+  /** True on the cell mark that terminates a table row. */
+  tableRowEnd?: boolean;
+  listLevel?: number;
+  /** The list identifier (sprmPIlfo), present only when the paragraph is in a list at all. */
+  listId?: number;
+}
+declare function applyParagraphSprms(prls: readonly Prl[], into: ParagraphProperties): ParagraphProperties;
+//#endregion
+export { ParagraphProperties, applyParagraphSprms };