doc-codec 0.0.0 → 1.0.0

package/dist/fib/offsets.d.cts

@@ -0,0 +1,47 @@
+//#region src/fib/offsets.d.ts
+/** FibBase, [MS-DOC] 2.5.2 -- the fixed 32-byte head of every Fib. csw, the count of 16-bit values in FibRgW97, sits immediately after it, so this doubles as csw's own offset. */
+declare const FIB_BASE_SIZE = 32;
+/** csw MUST be 0x000E, fixing FibRgW97 at 28 bytes and every offset after it. */
+declare const FIB_CSW_REQUIRED = 14;
+/** FibRgW97, [MS-DOC] 2.5.3 -- 14 16-bit values, none of which this reader needs. */
+declare const FIB_RG_W_OFFSET: number;
+declare const FIB_RG_W_SIZE: number;
+/** cslw, the count of 32-bit values in FibRgLw97. MUST be 0x0016. */
+declare const FIB_CSLW_OFFSET: number;
+declare const FIB_CSLW_REQUIRED = 22;
+/** FibRgLw97, [MS-DOC] 2.5.4 -- 22 32-bit values holding cbMac and the per-subdocument CP counts. */
+declare const FIB_RG_LW_OFFSET: number;
+declare const FIB_RG_LW_SIZE: number;
+/** cbRgFcLcb, the count of 64-bit values in FibRgFcLcbBlob. Varies by nFib (0x005D for 0x00C1 through 0x00B7 for 0x0112), so it is read rather than assumed. */
+declare const FIB_CB_RG_FC_LCB_OFFSET: number;
+/** FibRgFcLcb97, [MS-DOC] 2.5.5 -- the flat array of paired file offsets and lengths locating every other structure in the Table stream. */
+declare const FIB_FC_LCB_BLOB_OFFSET: number;
+declare const LW_OFFSET: {
+  readonly cbMac: 0;
+  readonly ccpText: 12;
+  readonly ccpFtn: 16;
+  readonly ccpHdd: 20;
+  readonly ccpAtn: 28;
+  readonly ccpEdn: 32;
+  readonly ccpTxbx: 36;
+  readonly ccpHdrTxbx: 40;
+};
+declare const FC_LCB_VALUE_INDEX: {
+  readonly fcStshf: 2;
+  readonly lcbStshf: 3;
+  readonly fcPlcfBteChpx: 24;
+  readonly lcbPlcfBteChpx: 25;
+  readonly fcPlcfBtePapx: 26;
+  readonly lcbPlcfBtePapx: 27;
+  readonly fcClx: 66;
+  readonly lcbClx: 67;
+};
+declare const FIB_BASE_FLAG: {
+  readonly fComplex: 4;
+  readonly fEncrypted: 256;
+  readonly fWhichTblStm: 512;
+  readonly fObfuscated: 32768;
+};
+declare const FIB_W_IDENT = 42476;
+//#endregion
+export { FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, LW_OFFSET };

package/dist/fib/offsets.d.ts

@@ -0,0 +1,47 @@
+//#region src/fib/offsets.d.ts
+/** FibBase, [MS-DOC] 2.5.2 -- the fixed 32-byte head of every Fib. csw, the count of 16-bit values in FibRgW97, sits immediately after it, so this doubles as csw's own offset. */
+declare const FIB_BASE_SIZE = 32;
+/** csw MUST be 0x000E, fixing FibRgW97 at 28 bytes and every offset after it. */
+declare const FIB_CSW_REQUIRED = 14;
+/** FibRgW97, [MS-DOC] 2.5.3 -- 14 16-bit values, none of which this reader needs. */
+declare const FIB_RG_W_OFFSET: number;
+declare const FIB_RG_W_SIZE: number;
+/** cslw, the count of 32-bit values in FibRgLw97. MUST be 0x0016. */
+declare const FIB_CSLW_OFFSET: number;
+declare const FIB_CSLW_REQUIRED = 22;
+/** FibRgLw97, [MS-DOC] 2.5.4 -- 22 32-bit values holding cbMac and the per-subdocument CP counts. */
+declare const FIB_RG_LW_OFFSET: number;
+declare const FIB_RG_LW_SIZE: number;
+/** cbRgFcLcb, the count of 64-bit values in FibRgFcLcbBlob. Varies by nFib (0x005D for 0x00C1 through 0x00B7 for 0x0112), so it is read rather than assumed. */
+declare const FIB_CB_RG_FC_LCB_OFFSET: number;
+/** FibRgFcLcb97, [MS-DOC] 2.5.5 -- the flat array of paired file offsets and lengths locating every other structure in the Table stream. */
+declare const FIB_FC_LCB_BLOB_OFFSET: number;
+declare const LW_OFFSET: {
+  readonly cbMac: 0;
+  readonly ccpText: 12;
+  readonly ccpFtn: 16;
+  readonly ccpHdd: 20;
+  readonly ccpAtn: 28;
+  readonly ccpEdn: 32;
+  readonly ccpTxbx: 36;
+  readonly ccpHdrTxbx: 40;
+};
+declare const FC_LCB_VALUE_INDEX: {
+  readonly fcStshf: 2;
+  readonly lcbStshf: 3;
+  readonly fcPlcfBteChpx: 24;
+  readonly lcbPlcfBteChpx: 25;
+  readonly fcPlcfBtePapx: 26;
+  readonly lcbPlcfBtePapx: 27;
+  readonly fcClx: 66;
+  readonly lcbClx: 67;
+};
+declare const FIB_BASE_FLAG: {
+  readonly fComplex: 4;
+  readonly fEncrypted: 256;
+  readonly fWhichTblStm: 512;
+  readonly fObfuscated: 32768;
+};
+declare const FIB_W_IDENT = 42476;
+//#endregion
+export { FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, LW_OFFSET };

package/dist/fib/offsets.js

@@ -0,0 +1,47 @@
+//#region src/fib/offsets.ts
+/** FibBase, [MS-DOC] 2.5.2 -- the fixed 32-byte head of every Fib. csw, the count of 16-bit values in FibRgW97, sits immediately after it, so this doubles as csw's own offset. */
+const FIB_BASE_SIZE = 32;
+/** csw MUST be 0x000E, fixing FibRgW97 at 28 bytes and every offset after it. */
+const FIB_CSW_REQUIRED = 14;
+/** FibRgW97, [MS-DOC] 2.5.3 -- 14 16-bit values, none of which this reader needs. */
+const FIB_RG_W_OFFSET = 34;
+const FIB_RG_W_SIZE = 28;
+/** cslw, the count of 32-bit values in FibRgLw97. MUST be 0x0016. */
+const FIB_CSLW_OFFSET = 62;
+const FIB_CSLW_REQUIRED = 22;
+/** FibRgLw97, [MS-DOC] 2.5.4 -- 22 32-bit values holding cbMac and the per-subdocument CP counts. */
+const FIB_RG_LW_OFFSET = 64;
+const FIB_RG_LW_SIZE = 88;
+/** cbRgFcLcb, the count of 64-bit values in FibRgFcLcbBlob. Varies by nFib (0x005D for 0x00C1 through 0x00B7 for 0x0112), so it is read rather than assumed. */
+const FIB_CB_RG_FC_LCB_OFFSET = 152;
+/** FibRgFcLcb97, [MS-DOC] 2.5.5 -- the flat array of paired file offsets and lengths locating every other structure in the Table stream. */
+const FIB_FC_LCB_BLOB_OFFSET = 154;
+const LW_OFFSET = {
+	cbMac: 0,
+	ccpText: 12,
+	ccpFtn: 16,
+	ccpHdd: 20,
+	ccpAtn: 28,
+	ccpEdn: 32,
+	ccpTxbx: 36,
+	ccpHdrTxbx: 40
+};
+const FC_LCB_VALUE_INDEX = {
+	fcStshf: 2,
+	lcbStshf: 3,
+	fcPlcfBteChpx: 24,
+	lcbPlcfBteChpx: 25,
+	fcPlcfBtePapx: 26,
+	lcbPlcfBtePapx: 27,
+	fcClx: 66,
+	lcbClx: 67
+};
+const FIB_BASE_FLAG = {
+	fComplex: 4,
+	fEncrypted: 256,
+	fWhichTblStm: 512,
+	fObfuscated: 32768
+};
+const FIB_W_IDENT = 42476;
+//#endregion
+export { FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, LW_OFFSET };

package/dist/index.cjs

@@ -0,0 +1,79 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("./errors.cjs");
+const require_bytes = require("./bytes.cjs");
+const require_fib_offsets = require("./fib/offsets.cjs");
+const require_detect = require("./detect.cjs");
+const require_plc = require("./plc.cjs");
+const require_fib_fib = require("./fib/fib.cjs");
+const require_text_piece_table = require("./text/piece-table.cjs");
+const require_text_characters = require("./text/characters.cjs");
+const require_text_special = require("./text/special.cjs");
+const require_prop_sprm = require("./prop/sprm.cjs");
+const require_prop_fkp = require("./prop/fkp.cjs");
+const require_prop_chp = require("./prop/chp.cjs");
+const require_prop_pap = require("./prop/pap.cjs");
+const require_style_stsh = require("./style/stsh.cjs");
+const require_read = require("./read.cjs");
+exports.ANNOTATION_REFERENCE = require_text_special.ANNOTATION_REFERENCE;
+exports.CELL_MARK = require_text_special.CELL_MARK;
+exports.COMPRESSED_CHARACTER_MAP = require_text_characters.COMPRESSED_CHARACTER_MAP;
+exports.DRAWN_OBJECT = require_text_special.DRAWN_OBJECT;
+exports.DocFormatError = require_errors.DocFormatError;
+exports.DocUnsupportedError = require_errors.DocUnsupportedError;
+exports.FC_LCB_VALUE_INDEX = require_fib_offsets.FC_LCB_VALUE_INDEX;
+exports.FIB_BASE_FLAG = require_fib_offsets.FIB_BASE_FLAG;
+exports.FIB_BASE_SIZE = require_fib_offsets.FIB_BASE_SIZE;
+exports.FIB_CB_RG_FC_LCB_OFFSET = require_fib_offsets.FIB_CB_RG_FC_LCB_OFFSET;
+exports.FIB_CSLW_OFFSET = require_fib_offsets.FIB_CSLW_OFFSET;
+exports.FIB_CSLW_REQUIRED = require_fib_offsets.FIB_CSLW_REQUIRED;
+exports.FIB_CSW_REQUIRED = require_fib_offsets.FIB_CSW_REQUIRED;
+exports.FIB_FC_LCB_BLOB_OFFSET = require_fib_offsets.FIB_FC_LCB_BLOB_OFFSET;
+exports.FIB_RG_LW_OFFSET = require_fib_offsets.FIB_RG_LW_OFFSET;
+exports.FIB_RG_LW_SIZE = require_fib_offsets.FIB_RG_LW_SIZE;
+exports.FIB_RG_W_OFFSET = require_fib_offsets.FIB_RG_W_OFFSET;
+exports.FIB_RG_W_SIZE = require_fib_offsets.FIB_RG_W_SIZE;
+exports.FIB_W_IDENT = require_fib_offsets.FIB_W_IDENT;
+exports.FIELD_BEGIN = require_text_special.FIELD_BEGIN;
+exports.FIELD_END = require_text_special.FIELD_END;
+exports.FIELD_SEPARATOR = require_text_special.FIELD_SEPARATOR;
+exports.FKP_PAGE_SIZE = require_prop_fkp.FKP_PAGE_SIZE;
+exports.FOOTNOTE_REFERENCE = require_text_special.FOOTNOTE_REFERENCE;
+exports.INLINE_PICTURE = require_text_special.INLINE_PICTURE;
+exports.LINE_BREAK = require_text_special.LINE_BREAK;
+exports.LW_OFFSET = require_fib_offsets.LW_OFFSET;
+exports.PARAGRAPH_MARK = require_text_special.PARAGRAPH_MARK;
+exports.PropertyBinTable = require_prop_fkp.PropertyBinTable;
+exports.SECTION_MARK = require_text_special.SECTION_MARK;
+exports.SGC = require_prop_sprm.SGC;
+exports.STI_USER_DEFINED = require_style_stsh.STI_USER_DEFINED;
+exports.STK = require_style_stsh.STK;
+exports.SYMBOL_ANCHOR = require_text_special.SYMBOL_ANCHOR;
+exports.WORD_DOCUMENT_STREAM = require_detect.WORD_DOCUMENT_STREAM;
+exports.applyCharacterSprms = require_prop_chp.applyCharacterSprms;
+exports.applyParagraphSprms = require_prop_pap.applyParagraphSprms;
+exports.characterOffset = require_text_piece_table.characterOffset;
+exports.characterSize = require_text_piece_table.characterSize;
+exports.decodeSprm = require_prop_sprm.decodeSprm;
+exports.endsParagraph = require_text_special.endsParagraph;
+exports.findLargestAtMost = require_plc.findLargestAtMost;
+exports.headingLevelFromIstd = require_style_stsh.headingLevelFromIstd;
+exports.isAnchorOnly = require_text_special.isAnchorOnly;
+exports.isDocBytes = require_detect.isDocBytes;
+exports.operandSize = require_prop_sprm.operandSize;
+exports.parseChpxFkp = require_prop_fkp.parseChpxFkp;
+exports.parseClx = require_text_piece_table.parseClx;
+exports.parseFib = require_fib_fib.parseFib;
+exports.parsePapxFkp = require_prop_fkp.parsePapxFkp;
+exports.parsePlc = require_plc.parsePlc;
+exports.parseStsh = require_style_stsh.parseStsh;
+exports.readDocContent = require_read.readDocContent;
+exports.readDocStreams = require_read.readDocStreams;
+exports.readGrpprl = require_prop_sprm.readGrpprl;
+exports.readInt16LE = require_bytes.readInt16LE;
+exports.readInt32LE = require_bytes.readInt32LE;
+exports.readTextRange = require_text_characters.readTextRange;
+exports.readUint16LE = require_bytes.readUint16LE;
+exports.readUint32LE = require_bytes.readUint32LE;
+exports.readUint8 = require_bytes.readUint8;
+exports.slice = require_bytes.slice;
+exports.tableStreamName = require_fib_fib.tableStreamName;

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+import { readInt16LE, readInt32LE, readUint16LE, readUint32LE, readUint8, slice } from "./bytes.cjs";
+import { WORD_DOCUMENT_STREAM, isDocBytes } from "./detect.cjs";
+import { DocFormatError, DocUnsupportedError } from "./errors.cjs";
+import { Fib, parseFib, tableStreamName } from "./fib/fib.cjs";
+import { FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, LW_OFFSET } from "./fib/offsets.cjs";
+import { Plc, findLargestAtMost, parsePlc } from "./plc.cjs";
+import { Piece, PieceTable, characterOffset, characterSize, parseClx } from "./text/piece-table.cjs";
+import { COMPRESSED_CHARACTER_MAP, TextRange, readTextRange } from "./text/characters.cjs";
+import { ANNOTATION_REFERENCE, CELL_MARK, DRAWN_OBJECT, FIELD_BEGIN, FIELD_END, FIELD_SEPARATOR, FOOTNOTE_REFERENCE, INLINE_PICTURE, LINE_BREAK, PARAGRAPH_MARK, SECTION_MARK, SYMBOL_ANCHOR, endsParagraph, isAnchorOnly } from "./text/special.cjs";
+import { Prl, SGC, Sprm, decodeSprm, operandSize, readGrpprl } from "./prop/sprm.cjs";
+import { ChpxFkp, FKP_PAGE_SIZE, PapxFkp, PapxLookup, PapxRecord, PropertyBinTable, parseChpxFkp, parsePapxFkp } from "./prop/fkp.cjs";
+import { CharacterProperties, applyCharacterSprms } from "./prop/chp.cjs";
+import { ParagraphProperties, applyParagraphSprms } from "./prop/pap.cjs";
+import { STI_USER_DEFINED, STK, Style, StyleSheet, headingLevelFromIstd, parseStsh } from "./style/stsh.cjs";
+import { DocStreams, readDocContent, readDocStreams } from "./read.cjs";
+export { ANNOTATION_REFERENCE, CELL_MARK, COMPRESSED_CHARACTER_MAP, CharacterProperties, ChpxFkp, DRAWN_OBJECT, DocFormatError, DocStreams, DocUnsupportedError, FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, FIELD_BEGIN, FIELD_END, FIELD_SEPARATOR, FKP_PAGE_SIZE, FOOTNOTE_REFERENCE, Fib, INLINE_PICTURE, LINE_BREAK, LW_OFFSET, PARAGRAPH_MARK, PapxFkp, PapxLookup, PapxRecord, ParagraphProperties, Piece, PieceTable, Plc, Prl, PropertyBinTable, SECTION_MARK, SGC, STI_USER_DEFINED, STK, SYMBOL_ANCHOR, Sprm, Style, StyleSheet, TextRange, WORD_DOCUMENT_STREAM, applyCharacterSprms, applyParagraphSprms, characterOffset, characterSize, decodeSprm, endsParagraph, findLargestAtMost, headingLevelFromIstd, isAnchorOnly, isDocBytes, operandSize, parseChpxFkp, parseClx, parseFib, parsePapxFkp, parsePlc, parseStsh, readDocContent, readDocStreams, readGrpprl, readInt16LE, readInt32LE, readTextRange, readUint16LE, readUint32LE, readUint8, slice, tableStreamName };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { readInt16LE, readInt32LE, readUint16LE, readUint32LE, readUint8, slice } from "./bytes.js";
+import { WORD_DOCUMENT_STREAM, isDocBytes } from "./detect.js";
+import { DocFormatError, DocUnsupportedError } from "./errors.js";
+import { Fib, parseFib, tableStreamName } from "./fib/fib.js";
+import { FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, LW_OFFSET } from "./fib/offsets.js";
+import { Plc, findLargestAtMost, parsePlc } from "./plc.js";
+import { Piece, PieceTable, characterOffset, characterSize, parseClx } from "./text/piece-table.js";
+import { COMPRESSED_CHARACTER_MAP, TextRange, readTextRange } from "./text/characters.js";
+import { ANNOTATION_REFERENCE, CELL_MARK, DRAWN_OBJECT, FIELD_BEGIN, FIELD_END, FIELD_SEPARATOR, FOOTNOTE_REFERENCE, INLINE_PICTURE, LINE_BREAK, PARAGRAPH_MARK, SECTION_MARK, SYMBOL_ANCHOR, endsParagraph, isAnchorOnly } from "./text/special.js";
+import { Prl, SGC, Sprm, decodeSprm, operandSize, readGrpprl } from "./prop/sprm.js";
+import { ChpxFkp, FKP_PAGE_SIZE, PapxFkp, PapxLookup, PapxRecord, PropertyBinTable, parseChpxFkp, parsePapxFkp } from "./prop/fkp.js";
+import { CharacterProperties, applyCharacterSprms } from "./prop/chp.js";
+import { ParagraphProperties, applyParagraphSprms } from "./prop/pap.js";
+import { STI_USER_DEFINED, STK, Style, StyleSheet, headingLevelFromIstd, parseStsh } from "./style/stsh.js";
+import { DocStreams, readDocContent, readDocStreams } from "./read.js";
+export { ANNOTATION_REFERENCE, CELL_MARK, COMPRESSED_CHARACTER_MAP, CharacterProperties, ChpxFkp, DRAWN_OBJECT, DocFormatError, DocStreams, DocUnsupportedError, FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, FIELD_BEGIN, FIELD_END, FIELD_SEPARATOR, FKP_PAGE_SIZE, FOOTNOTE_REFERENCE, Fib, INLINE_PICTURE, LINE_BREAK, LW_OFFSET, PARAGRAPH_MARK, PapxFkp, PapxLookup, PapxRecord, ParagraphProperties, Piece, PieceTable, Plc, Prl, PropertyBinTable, SECTION_MARK, SGC, STI_USER_DEFINED, STK, SYMBOL_ANCHOR, Sprm, Style, StyleSheet, TextRange, WORD_DOCUMENT_STREAM, applyCharacterSprms, applyParagraphSprms, characterOffset, characterSize, decodeSprm, endsParagraph, findLargestAtMost, headingLevelFromIstd, isAnchorOnly, isDocBytes, operandSize, parseChpxFkp, parseClx, parseFib, parsePapxFkp, parsePlc, parseStsh, readDocContent, readDocStreams, readGrpprl, readInt16LE, readInt32LE, readTextRange, readUint16LE, readUint32LE, readUint8, slice, tableStreamName };

package/dist/index.js

@@ -0,0 +1,16 @@
+import { DocFormatError, DocUnsupportedError } from "./errors.js";
+import { readInt16LE, readInt32LE, readUint16LE, readUint32LE, readUint8, slice } from "./bytes.js";
+import { FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, LW_OFFSET } from "./fib/offsets.js";
+import { WORD_DOCUMENT_STREAM, isDocBytes } from "./detect.js";
+import { findLargestAtMost, parsePlc } from "./plc.js";
+import { parseFib, tableStreamName } from "./fib/fib.js";
+import { characterOffset, characterSize, parseClx } from "./text/piece-table.js";
+import { COMPRESSED_CHARACTER_MAP, readTextRange } from "./text/characters.js";
+import { ANNOTATION_REFERENCE, CELL_MARK, DRAWN_OBJECT, FIELD_BEGIN, FIELD_END, FIELD_SEPARATOR, FOOTNOTE_REFERENCE, INLINE_PICTURE, LINE_BREAK, PARAGRAPH_MARK, SECTION_MARK, SYMBOL_ANCHOR, endsParagraph, isAnchorOnly } from "./text/special.js";
+import { SGC, decodeSprm, operandSize, readGrpprl } from "./prop/sprm.js";
+import { FKP_PAGE_SIZE, PropertyBinTable, parseChpxFkp, parsePapxFkp } from "./prop/fkp.js";
+import { applyCharacterSprms } from "./prop/chp.js";
+import { applyParagraphSprms } from "./prop/pap.js";
+import { STI_USER_DEFINED, STK, headingLevelFromIstd, parseStsh } from "./style/stsh.js";
+import { readDocContent, readDocStreams } from "./read.js";
+export { ANNOTATION_REFERENCE, CELL_MARK, COMPRESSED_CHARACTER_MAP, DRAWN_OBJECT, DocFormatError, DocUnsupportedError, FC_LCB_VALUE_INDEX, FIB_BASE_FLAG, FIB_BASE_SIZE, FIB_CB_RG_FC_LCB_OFFSET, FIB_CSLW_OFFSET, FIB_CSLW_REQUIRED, FIB_CSW_REQUIRED, FIB_FC_LCB_BLOB_OFFSET, FIB_RG_LW_OFFSET, FIB_RG_LW_SIZE, FIB_RG_W_OFFSET, FIB_RG_W_SIZE, FIB_W_IDENT, FIELD_BEGIN, FIELD_END, FIELD_SEPARATOR, FKP_PAGE_SIZE, FOOTNOTE_REFERENCE, INLINE_PICTURE, LINE_BREAK, LW_OFFSET, PARAGRAPH_MARK, PropertyBinTable, SECTION_MARK, SGC, STI_USER_DEFINED, STK, SYMBOL_ANCHOR, WORD_DOCUMENT_STREAM, applyCharacterSprms, applyParagraphSprms, characterOffset, characterSize, decodeSprm, endsParagraph, findLargestAtMost, headingLevelFromIstd, isAnchorOnly, isDocBytes, operandSize, parseChpxFkp, parseClx, parseFib, parsePapxFkp, parsePlc, parseStsh, readDocContent, readDocStreams, readGrpprl, readInt16LE, readInt32LE, readTextRange, readUint16LE, readUint32LE, readUint8, slice, tableStreamName };

package/dist/plc.cjs

@@ -0,0 +1,44 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("./errors.cjs");
+const require_bytes = require("./bytes.cjs");
+//#region src/plc.ts
+function parsePlc(bytes, elementSize, what) {
+	if (!Number.isInteger(elementSize) || elementSize < 0) throw new require_errors.DocFormatError(`${what} was parsed with an element size of ${elementSize}, which is not a non-negative integer`);
+	if (bytes.length < 4) throw new require_errors.DocFormatError(`${what} is ${bytes.length} bytes, too short to hold even the single terminating CP every PLC ends with`);
+	const count = (bytes.length - 4) / (4 + elementSize);
+	if (!Number.isInteger(count)) throw new require_errors.DocFormatError(`${what} is ${bytes.length} bytes, which does not yield a whole number of ${elementSize}-byte data elements: (${bytes.length} - 4) / (4 + ${elementSize}) = ${count}`);
+	const keys = [];
+	for (let index = 0; index <= count; index += 1) {
+		const key = require_bytes.readUint32LE(bytes, index * 4);
+		const previous = keys[index - 1];
+		if (previous !== void 0 && key < previous) throw new require_errors.DocFormatError(`${what} key ${index} is ${key}, which is less than the preceding key ${previous}; a PLC's keys must be in ascending order`);
+		keys.push(key);
+	}
+	const dataStart = (count + 1) * 4;
+	return {
+		keys,
+		count,
+		element(index) {
+			if (!Number.isInteger(index) || index < 0 || index >= count) throw new require_errors.DocFormatError(`${what} has ${count} data elements; element ${index} was requested`);
+			return require_bytes.slice(bytes, dataStart + index * elementSize, elementSize, `${what} element ${index}`);
+		}
+	};
+}
+function findLargestAtMost(keys, value) {
+	let low = 0;
+	let high = keys.length - 1;
+	let found;
+	while (low <= high) {
+		const middle = low + high >> 1;
+		const key = keys[middle];
+		if (key === void 0) throw new require_errors.DocFormatError(`PLC key ${middle} is absent from a ${keys.length}-key array`);
+		if (key <= value) {
+			found = middle;
+			low = middle + 1;
+		} else high = middle - 1;
+	}
+	return found === void 0 || found >= keys.length - 1 ? void 0 : found;
+}
+//#endregion
+exports.findLargestAtMost = findLargestAtMost;
+exports.parsePlc = parsePlc;

package/dist/plc.d.cts

@@ -0,0 +1,12 @@
+//#region src/plc.d.ts
+interface Plc {
+  /** The (count + 1) keys, ascending. keys[i] and keys[i + 1] bracket element i. */
+  readonly keys: readonly number[];
+  readonly count: number;
+  /** The bytes of data element i, a view into the PLC's own bytes rather than a copy. */
+  element(index: number): Uint8Array;
+}
+declare function parsePlc(bytes: Uint8Array, elementSize: number, what: string): Plc;
+declare function findLargestAtMost(keys: readonly number[], value: number): number | undefined;
+//#endregion
+export { Plc, findLargestAtMost, parsePlc };

package/dist/plc.d.ts

@@ -0,0 +1,12 @@
+//#region src/plc.d.ts
+interface Plc {
+  /** The (count + 1) keys, ascending. keys[i] and keys[i + 1] bracket element i. */
+  readonly keys: readonly number[];
+  readonly count: number;
+  /** The bytes of data element i, a view into the PLC's own bytes rather than a copy. */
+  element(index: number): Uint8Array;
+}
+declare function parsePlc(bytes: Uint8Array, elementSize: number, what: string): Plc;
+declare function findLargestAtMost(keys: readonly number[], value: number): number | undefined;
+//#endregion
+export { Plc, findLargestAtMost, parsePlc };

package/dist/plc.js

@@ -0,0 +1,42 @@
+import { DocFormatError } from "./errors.js";
+import { readUint32LE, slice } from "./bytes.js";
+//#region src/plc.ts
+function parsePlc(bytes, elementSize, what) {
+	if (!Number.isInteger(elementSize) || elementSize < 0) throw new DocFormatError(`${what} was parsed with an element size of ${elementSize}, which is not a non-negative integer`);
+	if (bytes.length < 4) throw new DocFormatError(`${what} is ${bytes.length} bytes, too short to hold even the single terminating CP every PLC ends with`);
+	const count = (bytes.length - 4) / (4 + elementSize);
+	if (!Number.isInteger(count)) throw new DocFormatError(`${what} is ${bytes.length} bytes, which does not yield a whole number of ${elementSize}-byte data elements: (${bytes.length} - 4) / (4 + ${elementSize}) = ${count}`);
+	const keys = [];
+	for (let index = 0; index <= count; index += 1) {
+		const key = readUint32LE(bytes, index * 4);
+		const previous = keys[index - 1];
+		if (previous !== void 0 && key < previous) throw new DocFormatError(`${what} key ${index} is ${key}, which is less than the preceding key ${previous}; a PLC's keys must be in ascending order`);
+		keys.push(key);
+	}
+	const dataStart = (count + 1) * 4;
+	return {
+		keys,
+		count,
+		element(index) {
+			if (!Number.isInteger(index) || index < 0 || index >= count) throw new DocFormatError(`${what} has ${count} data elements; element ${index} was requested`);
+			return slice(bytes, dataStart + index * elementSize, elementSize, `${what} element ${index}`);
+		}
+	};
+}
+function findLargestAtMost(keys, value) {
+	let low = 0;
+	let high = keys.length - 1;
+	let found;
+	while (low <= high) {
+		const middle = low + high >> 1;
+		const key = keys[middle];
+		if (key === void 0) throw new DocFormatError(`PLC key ${middle} is absent from a ${keys.length}-key array`);
+		if (key <= value) {
+			found = middle;
+			low = middle + 1;
+		} else high = middle - 1;
+	}
+	return found === void 0 || found >= keys.length - 1 ? void 0 : found;
+}
+//#endregion
+export { findLargestAtMost, parsePlc };

package/dist/prop/chp.cjs

@@ -0,0 +1,172 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("../errors.cjs");
+const require_bytes = require("../bytes.cjs");
+const require_prop_sprm = require("./sprm.cjs");
+//#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 = require_bytes.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 require_errors.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 require_errors.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 (require_bytes.readUint8(operand, 3) !== 0) return void 0;
+	return {
+		r: require_bytes.readUint8(operand, 0) / COLOR_COMPONENT_MAX,
+		g: require_bytes.readUint8(operand, 1) / COLOR_COMPONENT_MAX,
+		b: require_bytes.readUint8(operand, 2) / COLOR_COMPONENT_MAX
+	};
+}
+function applyCharacterSprms(prls, into) {
+	for (const prl of prls) {
+		if (prl.sprm.sgc !== require_prop_sprm.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 = require_bytes.readUint8(prl.operand, 0) !== 0;
+				break;
+			case SPRM_C_HPS:
+				into.sizePt = require_bytes.readUint16LE(prl.operand, 0) / HALF_POINTS_PER_POINT;
+				break;
+			case SPRM_C_ISTD:
+				into.istd = require_bytes.readUint16LE(prl.operand, 0);
+				break;
+			case SPRM_C_ICO:
+				into.color = icoColor(require_bytes.readUint8(prl.operand, 0));
+				break;
+			case SPRM_C_CV: into.color = colorRefColor(prl.operand);
+		}
+	}
+	return into;
+}
+//#endregion
+exports.applyCharacterSprms = applyCharacterSprms;

package/dist/prop/chp.d.cts

@@ -0,0 +1,16 @@
+import { Prl } from "./sprm.cjs";
+import { Color } from "document-schema.js";
+//#region src/prop/chp.d.ts
+interface CharacterProperties {
+  bold?: boolean;
+  italic?: boolean;
+  underline?: boolean;
+  strike?: boolean;
+  sizePt?: number;
+  color?: Color;
+  /** The istd of a character style applied by sprmCIstd, carried so a caller can resolve the style's own name. */
+  istd?: number;
+}
+declare function applyCharacterSprms(prls: readonly Prl[], into: CharacterProperties): CharacterProperties;
+//#endregion
+export { CharacterProperties, applyCharacterSprms };

package/dist/prop/chp.d.ts

@@ -0,0 +1,16 @@
+import { Prl } from "./sprm.js";
+import { Color } from "document-schema.js";
+//#region src/prop/chp.d.ts
+interface CharacterProperties {
+  bold?: boolean;
+  italic?: boolean;
+  underline?: boolean;
+  strike?: boolean;
+  sizePt?: number;
+  color?: Color;
+  /** The istd of a character style applied by sprmCIstd, carried so a caller can resolve the style's own name. */
+  istd?: number;
+}
+declare function applyCharacterSprms(prls: readonly Prl[], into: CharacterProperties): CharacterProperties;
+//#endregion
+export { CharacterProperties, applyCharacterSprms };