xls-codec 1.0.1 → 2.0.0

package/dist/biff/ptg.js

@@ -0,0 +1,318 @@
+import { BlockCursor } from "./cursor.js";
+import { readShortXLUnicodeString } from "./strings.js";
+import { errorTextOf } from "./errors.js";
+import { FTAB_FIXED_ARITY, FTAB_NAMES } from "./ptg-functions.js";
+import { columnIndexToLetters } from "document-schema.js";
+//#region src/biff/ptg.ts
+const PRECEDENCE_COMPARISON = 1;
+const PRECEDENCE_CONCAT = 2;
+const PRECEDENCE_ADD_SUB = 3;
+const PRECEDENCE_MUL_DIV = 4;
+const PRECEDENCE_POWER = 5;
+const PRECEDENCE_PERCENT = 6;
+const PRECEDENCE_UNARY = 7;
+const PRECEDENCE_ATOMIC = 8;
+function pushAtomic(stack, text) {
+	stack.push({
+		text,
+		precedence: PRECEDENCE_ATOMIC
+	});
+}
+function wrapBelow(operand, minimum) {
+	return operand.precedence < minimum ? `(${operand.text})` : operand.text;
+}
+function wrapAtOrBelow(operand, minimum) {
+	return operand.precedence <= minimum ? `(${operand.text})` : operand.text;
+}
+/** Pops two operands and pushes their combination -- the left wrapped only if its own precedence is strictly lower than this operator's, the right wrapped if its precedence is lower than or equal to it (see the module comment for why the same rule is correct for every operator here). Returns false, changing nothing, when fewer than two operands are on the stack -- a malformed token stream this reader declines to guess at rather than reading past. */
+function applyBinary(stack, symbol, precedence) {
+	const right = stack.pop();
+	const left = stack.pop();
+	if (left === void 0 || right === void 0) return false;
+	stack.push({
+		text: `${wrapBelow(left, precedence)}${symbol}${wrapAtOrBelow(right, precedence)}`,
+		precedence
+	});
+	return true;
+}
+function applyPrefix(stack, symbol) {
+	const operand = stack.pop();
+	if (operand === void 0) return false;
+	stack.push({
+		text: `${symbol}${wrapBelow(operand, PRECEDENCE_UNARY)}`,
+		precedence: PRECEDENCE_UNARY
+	});
+	return true;
+}
+function applyPercent(stack) {
+	const operand = stack.pop();
+	if (operand === void 0) return false;
+	stack.push({
+		text: `${wrapBelow(operand, PRECEDENCE_PERCENT)}%`,
+		precedence: PRECEDENCE_PERCENT
+	});
+	return true;
+}
+/** PtgParen ([MS-XLS] 2.5.198.80): a pure display token restating parentheses the formula's own author typed, regardless of whether the grouping they express is otherwise necessary. Wrapped unconditionally rather than through precedence comparison, since the point is to reproduce exactly what was there, not to decide afresh whether it was needed. */
+function applyParen(stack) {
+	const operand = stack.pop();
+	if (operand === void 0) return false;
+	stack.push({
+		text: `(${operand.text})`,
+		precedence: PRECEDENCE_ATOMIC
+	});
+	return true;
+}
+/** Pops exactly `arity` operands (in argument order) and pushes `name(arg1,arg2,...)`. A function call's own arguments never need wrapping regardless of what built them -- the parentheses already bound them unambiguously -- so every argument is taken as its bare text. */
+function applyFunctionCall(stack, name, arity) {
+	if (stack.length < arity) return false;
+	const args = stack.splice(stack.length - arity, arity);
+	stack.push({
+		text: `${name}(${args.map((operand) => operand.text).join(",")})`,
+		precedence: PRECEDENCE_ATOMIC
+	});
+	return true;
+}
+/** PtgAttrSum ([MS-XLS] 2.5.198.41): the optimisation a real producer emits in place of a PtgFuncVar call to SUM with a single reference-class argument, wrapping whatever is already on top of the stack. */
+function applySum(stack) {
+	return applyFunctionCall(stack, "SUM", 1);
+}
+function quoteStringLiteral(value) {
+	return `"${value.replaceAll("\"", "\"\"")}"`;
+}
+const COLUMN_INDEX_MASK = 16383;
+const COLUMN_RELATIVE_BIT = 16384;
+const ROW_RELATIVE_BIT = 32768;
+function pointFrom(row, columnField) {
+	return {
+		row,
+		column: columnField & COLUMN_INDEX_MASK,
+		columnAbsolute: (columnField & COLUMN_RELATIVE_BIT) === 0,
+		rowAbsolute: (columnField & ROW_RELATIVE_BIT) === 0
+	};
+}
+function formatPoint(point) {
+	return `${`${point.columnAbsolute ? "$" : ""}${columnIndexToLetters(point.column)}`}${`${point.rowAbsolute ? "$" : ""}${point.row + 1}`}`;
+}
+/** RgceLoc ([MS-XLS] 2.5.198.109): a single cell reference, as PtgRef/PtgRef3d carry it -- a plain row then a ColRelU column field. */
+function readLoc(cursor) {
+	return pointFrom(cursor.u16(), cursor.u16());
+}
+/** RgceArea ([MS-XLS] 2.5.198.105): a rectangular range, as PtgArea/PtgArea3d carry it -- both row bounds, then both corners' own ColRelU column fields. */
+function readArea(cursor) {
+	const rowFirst = cursor.u16();
+	const rowLast = cursor.u16();
+	const columnFirstField = cursor.u16();
+	const columnLastField = cursor.u16();
+	return [pointFrom(rowFirst, columnFirstField), pointFrom(rowLast, columnLastField)];
+}
+const SIMPLE_SHEET_NAME_RE = /^[A-Za-z_][A-Za-z0-9_.]*$/;
+function quoteSheetLabel(label) {
+	return SIMPLE_SHEET_NAME_RE.test(label) ? label : `'${label.replaceAll("'", "''")}'`;
+}
+/** The `'Sheet'!` or `'First:Last'!` prefix a 3D reference's own ixti resolves to, or undefined when this reader does not resolve it (see WorkbookGlobals.sheetRanges) -- an unresolved ixti aborts the whole formula's parse, the same as any other unsupported token. */
+function resolveSheetLabel(ixti, context) {
+	const range = context.sheetRanges[ixti];
+	if (range === void 0) return;
+	const first = context.sheets[range.firstSheetIndex]?.name;
+	const last = context.sheets[range.lastSheetIndex]?.name;
+	if (first === void 0 || last === void 0) return;
+	return `${quoteSheetLabel(range.firstSheetIndex === range.lastSheetIndex ? first : `${first}:${last}`)}!`;
+}
+const PTG_ADD = 3;
+const PTG_SUB = 4;
+const PTG_MUL = 5;
+const PTG_DIV = 6;
+const PTG_POWER = 7;
+const PTG_CONCAT = 8;
+const PTG_LT = 9;
+const PTG_LE = 10;
+const PTG_EQ = 11;
+const PTG_GE = 12;
+const PTG_GT = 13;
+const PTG_NE = 14;
+const PTG_UPLUS = 18;
+const PTG_UMINUS = 19;
+const PTG_PERCENT = 20;
+const PTG_PAREN = 21;
+const PTG_MISSARG = 22;
+const PTG_STR = 23;
+const PTG_ERR = 28;
+const PTG_BOOL = 29;
+const PTG_INT = 30;
+const PTG_NUM = 31;
+const PTG_FUNC_REF = 33;
+const PTG_FUNC_VALUE = 65;
+const PTG_FUNC_ARRAY = 97;
+const PTG_FUNCVAR_REF = 34;
+const PTG_FUNCVAR_VALUE = 66;
+const PTG_FUNCVAR_ARRAY = 98;
+const PTG_REF_REF = 36;
+const PTG_REF_VALUE = 68;
+const PTG_REF_ARRAY = 100;
+const PTG_AREA_REF = 37;
+const PTG_AREA_VALUE = 69;
+const PTG_AREA_ARRAY = 101;
+const PTG_REF3D_REF = 58;
+const PTG_REF3D_VALUE = 90;
+const PTG_REF3D_ARRAY = 122;
+const PTG_AREA3D_REF = 59;
+const PTG_AREA3D_VALUE = 91;
+const PTG_AREA3D_ARRAY = 123;
+const PTG_ATTR_OPCODE = 25;
+const PTG_ATTR_SEMI = 1;
+const PTG_ATTR_IF = 2;
+const PTG_ATTR_CHOOSE = 4;
+const PTG_ATTR_GOTO = 8;
+const PTG_ATTR_SUM = 16;
+const PTG_ATTR_BAXCEL_A = 32;
+const PTG_ATTR_BAXCEL_B = 33;
+const PTG_ATTR_SPACE = 64;
+const PTG_ATTR_SPACE_SEMI = 65;
+/** The four bytes every PtgAttr subtype but PtgAttrChoose occupies: the shared opcode, the subtype flag byte (already consumed by the caller), and two more this module never inspects. */
+const PTG_ATTR_TRAILING_BYTES = 2;
+/**
+* Parses a Formula record's compiled expression into the text a spreadsheet application would show, or returns undefined for a token this reader does not resolve -- a shared formula's PtgExp, an array constant's PtgArray, a defined name, a natural-language reference, or a 3D reference into a genuinely external workbook (see the module comment for the full list). The caller leaves ContentSheetCell.formula absent in that case, exactly as for any other unsupported construct.
+*
+* `rgce` is the formula's own token bytes, already sliced to their declared length (CellParsedFormula.cce) by the caller -- this function reads exactly that many bytes and nothing past them.
+*/
+function parseFormulaText(rgce, context) {
+	const cursor = new BlockCursor([rgce]);
+	const stack = [];
+	while (cursor.remainingInBlock() > 0) switch (cursor.u8()) {
+		case PTG_ADD:
+			if (!applyBinary(stack, "+", PRECEDENCE_ADD_SUB)) return void 0;
+			break;
+		case PTG_SUB:
+			if (!applyBinary(stack, "-", PRECEDENCE_ADD_SUB)) return void 0;
+			break;
+		case PTG_MUL:
+			if (!applyBinary(stack, "*", PRECEDENCE_MUL_DIV)) return void 0;
+			break;
+		case PTG_DIV:
+			if (!applyBinary(stack, "/", PRECEDENCE_MUL_DIV)) return void 0;
+			break;
+		case PTG_POWER:
+			if (!applyBinary(stack, "^", PRECEDENCE_POWER)) return void 0;
+			break;
+		case PTG_CONCAT:
+			if (!applyBinary(stack, "&", PRECEDENCE_CONCAT)) return void 0;
+			break;
+		case PTG_LT:
+			if (!applyBinary(stack, "<", PRECEDENCE_COMPARISON)) return void 0;
+			break;
+		case PTG_LE:
+			if (!applyBinary(stack, "<=", PRECEDENCE_COMPARISON)) return void 0;
+			break;
+		case PTG_EQ:
+			if (!applyBinary(stack, "=", PRECEDENCE_COMPARISON)) return void 0;
+			break;
+		case PTG_GE:
+			if (!applyBinary(stack, ">=", PRECEDENCE_COMPARISON)) return void 0;
+			break;
+		case PTG_GT:
+			if (!applyBinary(stack, ">", PRECEDENCE_COMPARISON)) return void 0;
+			break;
+		case PTG_NE:
+			if (!applyBinary(stack, "<>", PRECEDENCE_COMPARISON)) return void 0;
+			break;
+		case PTG_UPLUS:
+			if (!applyPrefix(stack, "+")) return void 0;
+			break;
+		case PTG_UMINUS:
+			if (!applyPrefix(stack, "-")) return void 0;
+			break;
+		case PTG_PERCENT:
+			if (!applyPercent(stack)) return void 0;
+			break;
+		case PTG_PAREN:
+			if (!applyParen(stack)) return void 0;
+			break;
+		case PTG_MISSARG:
+			pushAtomic(stack, "");
+			break;
+		case PTG_STR:
+			pushAtomic(stack, quoteStringLiteral(readShortXLUnicodeString(cursor)));
+			break;
+		case PTG_ERR: {
+			const text = errorTextOf(cursor.u8());
+			if (text === void 0) return void 0;
+			pushAtomic(stack, text);
+			break;
+		}
+		case PTG_BOOL:
+			pushAtomic(stack, cursor.u8() !== 0 ? "TRUE" : "FALSE");
+			break;
+		case PTG_INT:
+			pushAtomic(stack, String(cursor.u16()));
+			break;
+		case PTG_NUM:
+			pushAtomic(stack, String(cursor.f64()));
+			break;
+		case PTG_REF_REF:
+		case PTG_REF_VALUE:
+		case PTG_REF_ARRAY:
+			pushAtomic(stack, formatPoint(readLoc(cursor)));
+			break;
+		case PTG_AREA_REF:
+		case PTG_AREA_VALUE:
+		case PTG_AREA_ARRAY: {
+			const [start, end] = readArea(cursor);
+			pushAtomic(stack, `${formatPoint(start)}:${formatPoint(end)}`);
+			break;
+		}
+		case PTG_REF3D_REF:
+		case PTG_REF3D_VALUE:
+		case PTG_REF3D_ARRAY: {
+			const ixti = cursor.u16();
+			const point = readLoc(cursor);
+			const label = resolveSheetLabel(ixti, context);
+			if (label === void 0) return void 0;
+			pushAtomic(stack, `${label}${formatPoint(point)}`);
+			break;
+		}
+		case PTG_AREA3D_REF:
+		case PTG_AREA3D_VALUE:
+		case PTG_AREA3D_ARRAY: {
+			const ixti = cursor.u16();
+			const [start, end] = readArea(cursor);
+			const label = resolveSheetLabel(ixti, context);
+			if (label === void 0) return void 0;
+			pushAtomic(stack, `${label}${formatPoint(start)}:${formatPoint(end)}`);
+			break;
+		}
+		case PTG_FUNC_REF:
+		case PTG_FUNC_VALUE:
+		case PTG_FUNC_ARRAY: {
+			const iftab = cursor.u16();
+			const name = FTAB_NAMES.get(iftab);
+			const arity = FTAB_FIXED_ARITY.get(iftab);
+			if (name === void 0 || arity === void 0) return void 0;
+			if (!applyFunctionCall(stack, name, arity)) return void 0;
+			break;
+		}
+		case PTG_FUNCVAR_REF:
+		case PTG_FUNCVAR_VALUE:
+		case PTG_FUNCVAR_ARRAY: {
+			const cparams = cursor.u8();
+			const iftab = cursor.u16();
+			const name = FTAB_NAMES.get(iftab);
+			if (name === void 0) return void 0;
+			if (!applyFunctionCall(stack, name, cparams)) return void 0;
+			break;
+		}
+		case PTG_ATTR_OPCODE: {
+			const subtype = cursor.u8();
+			if (subtype === PTG_ATTR_CHOOSE) return;
+			cursor.skip(PTG_ATTR_TRAILING_BYTES);
+			if (subtype === PTG_ATTR_SUM) {
+				if (!applySum(stack)) return void 0;
+			} else if (subtype !== PTG_ATTR_SEMI && subtype !== PTG_ATTR_IF && subtype !== PTG_ATTR_GOTO && subtype !== PTG_ATTR_BAXCEL_A && subtype !== PTG_ATTR_BAXCEL_B && subtype !== PTG_ATTR_SPACE && subtype !== PTG_ATTR_SPACE_SEMI) return;
+			break;
+		}
+		default: return;
+	}
+	return stack.length === 1 ? stack[0]?.text : void 0;
+}
+//#endregion
+export { parseFormulaText };

package/dist/biff/record-types.cjs

@@ -18,8 +18,18 @@ const RECORD_XF = 224;
 const RECORD_FONT = 49;
 /** Which of the two date epochs this workbook's serials count from ([MS-XLS] 2.4.77). */
 const RECORD_DATE1904 = 34;
+/** Names one of the fifteen built-in cell-style XF records the writer emits before any cell XF ([MS-XLS] 2.4.269). Not read: this reader's XF table is flat and does not distinguish a cell style from a cell format. */
+const RECORD_STYLE = 659;
 /** Present only in an encrypted workbook, where every record after it is ciphertext ([MS-XLS] 2.4.117). */
 const RECORD_FILEPASS = 47;
+/** A collection of XTI structures resolving a formula's ixti to a sheet range, for a 3D reference ([MS-XLS] 2.4.106). */
+const RECORD_EXTERNSHEET = 23;
+/** The beginning of a supporting-link's own record collection: another workbook, a DDE/OLE data source, an add-in, or -- the one case this reader resolves -- this same workbook, self-referencing ([MS-XLS] 2.4.271). */
+const RECORD_SUPBOOK = 430;
+/** The workbook's custom colour table ([MS-XLS] 2.4.188): a fixed 56-entry override of the default palette every icv 8-63 an XF's fill/border colour fields name resolves through when this record is absent. */
+const RECORD_PALETTE = 146;
+/** A defined name ([MS-XLS] 2.4.150). Read and written only for the two BUILT-IN names a sheet's print settings live in -- Print_Area and Print_Titles; see workbook/print-names.ts. */
+const RECORD_LBL = 24;
 /** The sheet's used range ([MS-XLS] 2.4.90). */
 const RECORD_DIMENSIONS = 512;
 /** A single row's height, hidden state, and formatting ([MS-XLS] 2.4.221). */
@@ -32,6 +42,36 @@ const RECORD_DEFCOLWIDTH = 85;
 const RECORD_DEFAULTROWHEIGHT = 549;
 /** Merged cell ranges ([MS-XLS] 2.4.168). */
 const RECORD_MERGECELLS = 229;
+/** Whether the row and column headers are printed ([MS-XLS] 2.4.203). */
+const RECORD_PRINTROWCOL = 42;
+/** Whether the gridlines are printed ([MS-XLS] 2.4.202). */
+const RECORD_PRINTGRID = 43;
+/** Sheet-level flags, of which only fFitToPage -- whether the sheet prints scaled to a page count rather than to a percentage -- is read or written ([MS-XLS] 2.4.351). */
+const RECORD_WSBOOL = 129;
+/** Explicit row page breaks ([MS-XLS] 2.4.142). */
+const RECORD_HORIZONTALPAGEBREAKS = 27;
+/** Explicit column page breaks ([MS-XLS] 2.4.343). */
+const RECORD_VERTICALPAGEBREAKS = 26;
+/** The left page margin, an Xnum of inches ([MS-XLS] 2.4.151). */
+const RECORD_LEFTMARGIN = 38;
+/** The right page margin ([MS-XLS] 2.4.219). */
+const RECORD_RIGHTMARGIN = 39;
+/** The top page margin ([MS-XLS] 2.4.328). */
+const RECORD_TOPMARGIN = 40;
+/** The bottom page margin ([MS-XLS] 2.4.27). */
+const RECORD_BOTTOMMARGIN = 41;
+/** Paper size, print scale, fit-to-page counts, page order, and orientation ([MS-XLS] 2.4.257). */
+const RECORD_SETUP = 161;
+/** The iteration count for iterative calculation ([MS-XLS] 2.4.31). */
+const RECORD_CALCCOUNT = 12;
+/** The reference style, A1 or R1C1 ([MS-XLS] 2.4.36). */
+const RECORD_CALCREFMODE = 15;
+/** Whether iterative calculation is enabled ([MS-XLS] 2.4.33). */
+const RECORD_CALCITER = 17;
+/** The minimum value change iterative calculation continues for ([MS-XLS] 2.4.32). */
+const RECORD_CALCDELTA = 16;
+/** Whether the workbook is recalculated before saving in manual calculation mode ([MS-XLS] 2.4.37). */
+const RECORD_CALCSAVERECALC = 95;
 /** An empty cell carrying only formatting ([MS-XLS] 2.4.20). */
 const RECORD_BLANK = 513;
 /** A run of empty cells in one row ([MS-XLS] 2.4.174). */
@@ -81,7 +121,13 @@ exports.RECORD_ARRAY = RECORD_ARRAY;
 exports.RECORD_BLANK = RECORD_BLANK;
 exports.RECORD_BOF = RECORD_BOF;
 exports.RECORD_BOOLERR = RECORD_BOOLERR;
+exports.RECORD_BOTTOMMARGIN = RECORD_BOTTOMMARGIN;
 exports.RECORD_BOUNDSHEET8 = RECORD_BOUNDSHEET8;
+exports.RECORD_CALCCOUNT = RECORD_CALCCOUNT;
+exports.RECORD_CALCDELTA = RECORD_CALCDELTA;
+exports.RECORD_CALCITER = RECORD_CALCITER;
+exports.RECORD_CALCREFMODE = RECORD_CALCREFMODE;
+exports.RECORD_CALCSAVERECALC = RECORD_CALCSAVERECALC;
 exports.RECORD_COLINFO = RECORD_COLINFO;
 exports.RECORD_CONTINUE = RECORD_CONTINUE;
 exports.RECORD_DATE1904 = RECORD_DATE1904;
@@ -89,20 +135,34 @@ exports.RECORD_DEFAULTROWHEIGHT = RECORD_DEFAULTROWHEIGHT;
 exports.RECORD_DEFCOLWIDTH = RECORD_DEFCOLWIDTH;
 exports.RECORD_DIMENSIONS = RECORD_DIMENSIONS;
 exports.RECORD_EOF = RECORD_EOF;
+exports.RECORD_EXTERNSHEET = RECORD_EXTERNSHEET;
 exports.RECORD_FILEPASS = RECORD_FILEPASS;
 exports.RECORD_FONT = RECORD_FONT;
 exports.RECORD_FORMAT = RECORD_FORMAT;
 exports.RECORD_FORMULA = RECORD_FORMULA;
+exports.RECORD_HORIZONTALPAGEBREAKS = RECORD_HORIZONTALPAGEBREAKS;
 exports.RECORD_LABEL = RECORD_LABEL;
 exports.RECORD_LABELSST = RECORD_LABELSST;
+exports.RECORD_LBL = RECORD_LBL;
+exports.RECORD_LEFTMARGIN = RECORD_LEFTMARGIN;
 exports.RECORD_MERGECELLS = RECORD_MERGECELLS;
 exports.RECORD_MULBLANK = RECORD_MULBLANK;
 exports.RECORD_MULRK = RECORD_MULRK;
 exports.RECORD_NUMBER = RECORD_NUMBER;
+exports.RECORD_PALETTE = RECORD_PALETTE;
+exports.RECORD_PRINTGRID = RECORD_PRINTGRID;
+exports.RECORD_PRINTROWCOL = RECORD_PRINTROWCOL;
+exports.RECORD_RIGHTMARGIN = RECORD_RIGHTMARGIN;
 exports.RECORD_RK = RECORD_RK;
 exports.RECORD_ROW = RECORD_ROW;
+exports.RECORD_SETUP = RECORD_SETUP;
 exports.RECORD_SHRFMLA = RECORD_SHRFMLA;
 exports.RECORD_SST = RECORD_SST;
 exports.RECORD_STRING = RECORD_STRING;
+exports.RECORD_STYLE = RECORD_STYLE;
+exports.RECORD_SUPBOOK = RECORD_SUPBOOK;
 exports.RECORD_TABLE = RECORD_TABLE;
+exports.RECORD_TOPMARGIN = RECORD_TOPMARGIN;
+exports.RECORD_VERTICALPAGEBREAKS = RECORD_VERTICALPAGEBREAKS;
+exports.RECORD_WSBOOL = RECORD_WSBOOL;
 exports.RECORD_XF = RECORD_XF;

package/dist/biff/record-types.d.cts

@@ -17,8 +17,18 @@ declare const RECORD_XF = 224;
 declare const RECORD_FONT = 49;
 /** Which of the two date epochs this workbook's serials count from ([MS-XLS] 2.4.77). */
 declare const RECORD_DATE1904 = 34;
+/** Names one of the fifteen built-in cell-style XF records the writer emits before any cell XF ([MS-XLS] 2.4.269). Not read: this reader's XF table is flat and does not distinguish a cell style from a cell format. */
+declare const RECORD_STYLE = 659;
 /** Present only in an encrypted workbook, where every record after it is ciphertext ([MS-XLS] 2.4.117). */
 declare const RECORD_FILEPASS = 47;
+/** A collection of XTI structures resolving a formula's ixti to a sheet range, for a 3D reference ([MS-XLS] 2.4.106). */
+declare const RECORD_EXTERNSHEET = 23;
+/** The beginning of a supporting-link's own record collection: another workbook, a DDE/OLE data source, an add-in, or -- the one case this reader resolves -- this same workbook, self-referencing ([MS-XLS] 2.4.271). */
+declare const RECORD_SUPBOOK = 430;
+/** The workbook's custom colour table ([MS-XLS] 2.4.188): a fixed 56-entry override of the default palette every icv 8-63 an XF's fill/border colour fields name resolves through when this record is absent. */
+declare const RECORD_PALETTE = 146;
+/** A defined name ([MS-XLS] 2.4.150). Read and written only for the two BUILT-IN names a sheet's print settings live in -- Print_Area and Print_Titles; see workbook/print-names.ts. */
+declare const RECORD_LBL = 24;
 /** The sheet's used range ([MS-XLS] 2.4.90). */
 declare const RECORD_DIMENSIONS = 512;
 /** A single row's height, hidden state, and formatting ([MS-XLS] 2.4.221). */
@@ -31,6 +41,36 @@ declare const RECORD_DEFCOLWIDTH = 85;
 declare const RECORD_DEFAULTROWHEIGHT = 549;
 /** Merged cell ranges ([MS-XLS] 2.4.168). */
 declare const RECORD_MERGECELLS = 229;
+/** Whether the row and column headers are printed ([MS-XLS] 2.4.203). */
+declare const RECORD_PRINTROWCOL = 42;
+/** Whether the gridlines are printed ([MS-XLS] 2.4.202). */
+declare const RECORD_PRINTGRID = 43;
+/** Sheet-level flags, of which only fFitToPage -- whether the sheet prints scaled to a page count rather than to a percentage -- is read or written ([MS-XLS] 2.4.351). */
+declare const RECORD_WSBOOL = 129;
+/** Explicit row page breaks ([MS-XLS] 2.4.142). */
+declare const RECORD_HORIZONTALPAGEBREAKS = 27;
+/** Explicit column page breaks ([MS-XLS] 2.4.343). */
+declare const RECORD_VERTICALPAGEBREAKS = 26;
+/** The left page margin, an Xnum of inches ([MS-XLS] 2.4.151). */
+declare const RECORD_LEFTMARGIN = 38;
+/** The right page margin ([MS-XLS] 2.4.219). */
+declare const RECORD_RIGHTMARGIN = 39;
+/** The top page margin ([MS-XLS] 2.4.328). */
+declare const RECORD_TOPMARGIN = 40;
+/** The bottom page margin ([MS-XLS] 2.4.27). */
+declare const RECORD_BOTTOMMARGIN = 41;
+/** Paper size, print scale, fit-to-page counts, page order, and orientation ([MS-XLS] 2.4.257). */
+declare const RECORD_SETUP = 161;
+/** The iteration count for iterative calculation ([MS-XLS] 2.4.31). */
+declare const RECORD_CALCCOUNT = 12;
+/** The reference style, A1 or R1C1 ([MS-XLS] 2.4.36). */
+declare const RECORD_CALCREFMODE = 15;
+/** Whether iterative calculation is enabled ([MS-XLS] 2.4.33). */
+declare const RECORD_CALCITER = 17;
+/** The minimum value change iterative calculation continues for ([MS-XLS] 2.4.32). */
+declare const RECORD_CALCDELTA = 16;
+/** Whether the workbook is recalculated before saving in manual calculation mode ([MS-XLS] 2.4.37). */
+declare const RECORD_CALCSAVERECALC = 95;
 /** An empty cell carrying only formatting ([MS-XLS] 2.4.20). */
 declare const RECORD_BLANK = 513;
 /** A run of empty cells in one row ([MS-XLS] 2.4.174). */
@@ -70,4 +110,4 @@ declare const BIFF8_VERSION = 1536;
 /** [MS-XLS] 2.1.4: "The record size ... MUST be less than or equal to 8224." The ceiling a writer splits a record at, and the bound a reader can sanity-check a declared size against. */
 declare const MAX_RECORD_DATA_SIZE = 8224;
 //#endregion
-export { BIFF8_VERSION, BOF_TYPE_CHART, BOF_TYPE_MACRO, BOF_TYPE_WORKBOOK, BOF_TYPE_WORKSHEET, MAX_RECORD_DATA_SIZE, RECORD_ARRAY, RECORD_BLANK, RECORD_BOF, RECORD_BOOLERR, RECORD_BOUNDSHEET8, RECORD_COLINFO, RECORD_CONTINUE, RECORD_DATE1904, RECORD_DEFAULTROWHEIGHT, RECORD_DEFCOLWIDTH, RECORD_DIMENSIONS, RECORD_EOF, RECORD_FILEPASS, RECORD_FONT, RECORD_FORMAT, RECORD_FORMULA, RECORD_LABEL, RECORD_LABELSST, RECORD_MERGECELLS, RECORD_MULBLANK, RECORD_MULRK, RECORD_NUMBER, RECORD_RK, RECORD_ROW, RECORD_SHRFMLA, RECORD_SST, RECORD_STRING, RECORD_TABLE, RECORD_XF };
+export { BIFF8_VERSION, BOF_TYPE_CHART, BOF_TYPE_MACRO, BOF_TYPE_WORKBOOK, BOF_TYPE_WORKSHEET, MAX_RECORD_DATA_SIZE, RECORD_ARRAY, RECORD_BLANK, RECORD_BOF, RECORD_BOOLERR, RECORD_BOTTOMMARGIN, RECORD_BOUNDSHEET8, RECORD_CALCCOUNT, RECORD_CALCDELTA, RECORD_CALCITER, RECORD_CALCREFMODE, RECORD_CALCSAVERECALC, RECORD_COLINFO, RECORD_CONTINUE, RECORD_DATE1904, RECORD_DEFAULTROWHEIGHT, RECORD_DEFCOLWIDTH, RECORD_DIMENSIONS, RECORD_EOF, RECORD_EXTERNSHEET, RECORD_FILEPASS, RECORD_FONT, RECORD_FORMAT, RECORD_FORMULA, RECORD_HORIZONTALPAGEBREAKS, RECORD_LABEL, RECORD_LABELSST, RECORD_LBL, RECORD_LEFTMARGIN, RECORD_MERGECELLS, RECORD_MULBLANK, RECORD_MULRK, RECORD_NUMBER, RECORD_PALETTE, RECORD_PRINTGRID, RECORD_PRINTROWCOL, RECORD_RIGHTMARGIN, RECORD_RK, RECORD_ROW, RECORD_SETUP, RECORD_SHRFMLA, RECORD_SST, RECORD_STRING, RECORD_STYLE, RECORD_SUPBOOK, RECORD_TABLE, RECORD_TOPMARGIN, RECORD_VERTICALPAGEBREAKS, RECORD_WSBOOL, RECORD_XF };

package/dist/biff/record-types.d.ts

@@ -17,8 +17,18 @@ declare const RECORD_XF = 224;
 declare const RECORD_FONT = 49;
 /** Which of the two date epochs this workbook's serials count from ([MS-XLS] 2.4.77). */
 declare const RECORD_DATE1904 = 34;
+/** Names one of the fifteen built-in cell-style XF records the writer emits before any cell XF ([MS-XLS] 2.4.269). Not read: this reader's XF table is flat and does not distinguish a cell style from a cell format. */
+declare const RECORD_STYLE = 659;
 /** Present only in an encrypted workbook, where every record after it is ciphertext ([MS-XLS] 2.4.117). */
 declare const RECORD_FILEPASS = 47;
+/** A collection of XTI structures resolving a formula's ixti to a sheet range, for a 3D reference ([MS-XLS] 2.4.106). */
+declare const RECORD_EXTERNSHEET = 23;
+/** The beginning of a supporting-link's own record collection: another workbook, a DDE/OLE data source, an add-in, or -- the one case this reader resolves -- this same workbook, self-referencing ([MS-XLS] 2.4.271). */
+declare const RECORD_SUPBOOK = 430;
+/** The workbook's custom colour table ([MS-XLS] 2.4.188): a fixed 56-entry override of the default palette every icv 8-63 an XF's fill/border colour fields name resolves through when this record is absent. */
+declare const RECORD_PALETTE = 146;
+/** A defined name ([MS-XLS] 2.4.150). Read and written only for the two BUILT-IN names a sheet's print settings live in -- Print_Area and Print_Titles; see workbook/print-names.ts. */
+declare const RECORD_LBL = 24;
 /** The sheet's used range ([MS-XLS] 2.4.90). */
 declare const RECORD_DIMENSIONS = 512;
 /** A single row's height, hidden state, and formatting ([MS-XLS] 2.4.221). */
@@ -31,6 +41,36 @@ declare const RECORD_DEFCOLWIDTH = 85;
 declare const RECORD_DEFAULTROWHEIGHT = 549;
 /** Merged cell ranges ([MS-XLS] 2.4.168). */
 declare const RECORD_MERGECELLS = 229;
+/** Whether the row and column headers are printed ([MS-XLS] 2.4.203). */
+declare const RECORD_PRINTROWCOL = 42;
+/** Whether the gridlines are printed ([MS-XLS] 2.4.202). */
+declare const RECORD_PRINTGRID = 43;
+/** Sheet-level flags, of which only fFitToPage -- whether the sheet prints scaled to a page count rather than to a percentage -- is read or written ([MS-XLS] 2.4.351). */
+declare const RECORD_WSBOOL = 129;
+/** Explicit row page breaks ([MS-XLS] 2.4.142). */
+declare const RECORD_HORIZONTALPAGEBREAKS = 27;
+/** Explicit column page breaks ([MS-XLS] 2.4.343). */
+declare const RECORD_VERTICALPAGEBREAKS = 26;
+/** The left page margin, an Xnum of inches ([MS-XLS] 2.4.151). */
+declare const RECORD_LEFTMARGIN = 38;
+/** The right page margin ([MS-XLS] 2.4.219). */
+declare const RECORD_RIGHTMARGIN = 39;
+/** The top page margin ([MS-XLS] 2.4.328). */
+declare const RECORD_TOPMARGIN = 40;
+/** The bottom page margin ([MS-XLS] 2.4.27). */
+declare const RECORD_BOTTOMMARGIN = 41;
+/** Paper size, print scale, fit-to-page counts, page order, and orientation ([MS-XLS] 2.4.257). */
+declare const RECORD_SETUP = 161;
+/** The iteration count for iterative calculation ([MS-XLS] 2.4.31). */
+declare const RECORD_CALCCOUNT = 12;
+/** The reference style, A1 or R1C1 ([MS-XLS] 2.4.36). */
+declare const RECORD_CALCREFMODE = 15;
+/** Whether iterative calculation is enabled ([MS-XLS] 2.4.33). */
+declare const RECORD_CALCITER = 17;
+/** The minimum value change iterative calculation continues for ([MS-XLS] 2.4.32). */
+declare const RECORD_CALCDELTA = 16;
+/** Whether the workbook is recalculated before saving in manual calculation mode ([MS-XLS] 2.4.37). */
+declare const RECORD_CALCSAVERECALC = 95;
 /** An empty cell carrying only formatting ([MS-XLS] 2.4.20). */
 declare const RECORD_BLANK = 513;
 /** A run of empty cells in one row ([MS-XLS] 2.4.174). */
@@ -70,4 +110,4 @@ declare const BIFF8_VERSION = 1536;
 /** [MS-XLS] 2.1.4: "The record size ... MUST be less than or equal to 8224." The ceiling a writer splits a record at, and the bound a reader can sanity-check a declared size against. */
 declare const MAX_RECORD_DATA_SIZE = 8224;
 //#endregion
-export { BIFF8_VERSION, BOF_TYPE_CHART, BOF_TYPE_MACRO, BOF_TYPE_WORKBOOK, BOF_TYPE_WORKSHEET, MAX_RECORD_DATA_SIZE, RECORD_ARRAY, RECORD_BLANK, RECORD_BOF, RECORD_BOOLERR, RECORD_BOUNDSHEET8, RECORD_COLINFO, RECORD_CONTINUE, RECORD_DATE1904, RECORD_DEFAULTROWHEIGHT, RECORD_DEFCOLWIDTH, RECORD_DIMENSIONS, RECORD_EOF, RECORD_FILEPASS, RECORD_FONT, RECORD_FORMAT, RECORD_FORMULA, RECORD_LABEL, RECORD_LABELSST, RECORD_MERGECELLS, RECORD_MULBLANK, RECORD_MULRK, RECORD_NUMBER, RECORD_RK, RECORD_ROW, RECORD_SHRFMLA, RECORD_SST, RECORD_STRING, RECORD_TABLE, RECORD_XF };
+export { BIFF8_VERSION, BOF_TYPE_CHART, BOF_TYPE_MACRO, BOF_TYPE_WORKBOOK, BOF_TYPE_WORKSHEET, MAX_RECORD_DATA_SIZE, RECORD_ARRAY, RECORD_BLANK, RECORD_BOF, RECORD_BOOLERR, RECORD_BOTTOMMARGIN, RECORD_BOUNDSHEET8, RECORD_CALCCOUNT, RECORD_CALCDELTA, RECORD_CALCITER, RECORD_CALCREFMODE, RECORD_CALCSAVERECALC, RECORD_COLINFO, RECORD_CONTINUE, RECORD_DATE1904, RECORD_DEFAULTROWHEIGHT, RECORD_DEFCOLWIDTH, RECORD_DIMENSIONS, RECORD_EOF, RECORD_EXTERNSHEET, RECORD_FILEPASS, RECORD_FONT, RECORD_FORMAT, RECORD_FORMULA, RECORD_HORIZONTALPAGEBREAKS, RECORD_LABEL, RECORD_LABELSST, RECORD_LBL, RECORD_LEFTMARGIN, RECORD_MERGECELLS, RECORD_MULBLANK, RECORD_MULRK, RECORD_NUMBER, RECORD_PALETTE, RECORD_PRINTGRID, RECORD_PRINTROWCOL, RECORD_RIGHTMARGIN, RECORD_RK, RECORD_ROW, RECORD_SETUP, RECORD_SHRFMLA, RECORD_SST, RECORD_STRING, RECORD_STYLE, RECORD_SUPBOOK, RECORD_TABLE, RECORD_TOPMARGIN, RECORD_VERTICALPAGEBREAKS, RECORD_WSBOOL, RECORD_XF };

package/dist/biff/record-types.js

@@ -17,8 +17,18 @@ const RECORD_XF = 224;
 const RECORD_FONT = 49;
 /** Which of the two date epochs this workbook's serials count from ([MS-XLS] 2.4.77). */
 const RECORD_DATE1904 = 34;
+/** Names one of the fifteen built-in cell-style XF records the writer emits before any cell XF ([MS-XLS] 2.4.269). Not read: this reader's XF table is flat and does not distinguish a cell style from a cell format. */
+const RECORD_STYLE = 659;
 /** Present only in an encrypted workbook, where every record after it is ciphertext ([MS-XLS] 2.4.117). */
 const RECORD_FILEPASS = 47;
+/** A collection of XTI structures resolving a formula's ixti to a sheet range, for a 3D reference ([MS-XLS] 2.4.106). */
+const RECORD_EXTERNSHEET = 23;
+/** The beginning of a supporting-link's own record collection: another workbook, a DDE/OLE data source, an add-in, or -- the one case this reader resolves -- this same workbook, self-referencing ([MS-XLS] 2.4.271). */
+const RECORD_SUPBOOK = 430;
+/** The workbook's custom colour table ([MS-XLS] 2.4.188): a fixed 56-entry override of the default palette every icv 8-63 an XF's fill/border colour fields name resolves through when this record is absent. */
+const RECORD_PALETTE = 146;
+/** A defined name ([MS-XLS] 2.4.150). Read and written only for the two BUILT-IN names a sheet's print settings live in -- Print_Area and Print_Titles; see workbook/print-names.ts. */
+const RECORD_LBL = 24;
 /** The sheet's used range ([MS-XLS] 2.4.90). */
 const RECORD_DIMENSIONS = 512;
 /** A single row's height, hidden state, and formatting ([MS-XLS] 2.4.221). */
@@ -31,6 +41,36 @@ const RECORD_DEFCOLWIDTH = 85;
 const RECORD_DEFAULTROWHEIGHT = 549;
 /** Merged cell ranges ([MS-XLS] 2.4.168). */
 const RECORD_MERGECELLS = 229;
+/** Whether the row and column headers are printed ([MS-XLS] 2.4.203). */
+const RECORD_PRINTROWCOL = 42;
+/** Whether the gridlines are printed ([MS-XLS] 2.4.202). */
+const RECORD_PRINTGRID = 43;
+/** Sheet-level flags, of which only fFitToPage -- whether the sheet prints scaled to a page count rather than to a percentage -- is read or written ([MS-XLS] 2.4.351). */
+const RECORD_WSBOOL = 129;
+/** Explicit row page breaks ([MS-XLS] 2.4.142). */
+const RECORD_HORIZONTALPAGEBREAKS = 27;
+/** Explicit column page breaks ([MS-XLS] 2.4.343). */
+const RECORD_VERTICALPAGEBREAKS = 26;
+/** The left page margin, an Xnum of inches ([MS-XLS] 2.4.151). */
+const RECORD_LEFTMARGIN = 38;
+/** The right page margin ([MS-XLS] 2.4.219). */
+const RECORD_RIGHTMARGIN = 39;
+/** The top page margin ([MS-XLS] 2.4.328). */
+const RECORD_TOPMARGIN = 40;
+/** The bottom page margin ([MS-XLS] 2.4.27). */
+const RECORD_BOTTOMMARGIN = 41;
+/** Paper size, print scale, fit-to-page counts, page order, and orientation ([MS-XLS] 2.4.257). */
+const RECORD_SETUP = 161;
+/** The iteration count for iterative calculation ([MS-XLS] 2.4.31). */
+const RECORD_CALCCOUNT = 12;
+/** The reference style, A1 or R1C1 ([MS-XLS] 2.4.36). */
+const RECORD_CALCREFMODE = 15;
+/** Whether iterative calculation is enabled ([MS-XLS] 2.4.33). */
+const RECORD_CALCITER = 17;
+/** The minimum value change iterative calculation continues for ([MS-XLS] 2.4.32). */
+const RECORD_CALCDELTA = 16;
+/** Whether the workbook is recalculated before saving in manual calculation mode ([MS-XLS] 2.4.37). */
+const RECORD_CALCSAVERECALC = 95;
 /** An empty cell carrying only formatting ([MS-XLS] 2.4.20). */
 const RECORD_BLANK = 513;
 /** A run of empty cells in one row ([MS-XLS] 2.4.174). */
@@ -70,4 +110,4 @@ const BIFF8_VERSION = 1536;
 /** [MS-XLS] 2.1.4: "The record size ... MUST be less than or equal to 8224." The ceiling a writer splits a record at, and the bound a reader can sanity-check a declared size against. */
 const MAX_RECORD_DATA_SIZE = 8224;
 //#endregion
-export { BIFF8_VERSION, BOF_TYPE_CHART, BOF_TYPE_MACRO, BOF_TYPE_WORKBOOK, BOF_TYPE_WORKSHEET, MAX_RECORD_DATA_SIZE, RECORD_ARRAY, RECORD_BLANK, RECORD_BOF, RECORD_BOOLERR, RECORD_BOUNDSHEET8, RECORD_COLINFO, RECORD_CONTINUE, RECORD_DATE1904, RECORD_DEFAULTROWHEIGHT, RECORD_DEFCOLWIDTH, RECORD_DIMENSIONS, RECORD_EOF, RECORD_FILEPASS, RECORD_FONT, RECORD_FORMAT, RECORD_FORMULA, RECORD_LABEL, RECORD_LABELSST, RECORD_MERGECELLS, RECORD_MULBLANK, RECORD_MULRK, RECORD_NUMBER, RECORD_RK, RECORD_ROW, RECORD_SHRFMLA, RECORD_SST, RECORD_STRING, RECORD_TABLE, RECORD_XF };
+export { BIFF8_VERSION, BOF_TYPE_CHART, BOF_TYPE_MACRO, BOF_TYPE_WORKBOOK, BOF_TYPE_WORKSHEET, MAX_RECORD_DATA_SIZE, RECORD_ARRAY, RECORD_BLANK, RECORD_BOF, RECORD_BOOLERR, RECORD_BOTTOMMARGIN, RECORD_BOUNDSHEET8, RECORD_CALCCOUNT, RECORD_CALCDELTA, RECORD_CALCITER, RECORD_CALCREFMODE, RECORD_CALCSAVERECALC, RECORD_COLINFO, RECORD_CONTINUE, RECORD_DATE1904, RECORD_DEFAULTROWHEIGHT, RECORD_DEFCOLWIDTH, RECORD_DIMENSIONS, RECORD_EOF, RECORD_EXTERNSHEET, RECORD_FILEPASS, RECORD_FONT, RECORD_FORMAT, RECORD_FORMULA, RECORD_HORIZONTALPAGEBREAKS, RECORD_LABEL, RECORD_LABELSST, RECORD_LBL, RECORD_LEFTMARGIN, RECORD_MERGECELLS, RECORD_MULBLANK, RECORD_MULRK, RECORD_NUMBER, RECORD_PALETTE, RECORD_PRINTGRID, RECORD_PRINTROWCOL, RECORD_RIGHTMARGIN, RECORD_RK, RECORD_ROW, RECORD_SETUP, RECORD_SHRFMLA, RECORD_SST, RECORD_STRING, RECORD_STYLE, RECORD_SUPBOOK, RECORD_TABLE, RECORD_TOPMARGIN, RECORD_VERTICALPAGEBREAKS, RECORD_WSBOOL, RECORD_XF };

package/dist/biff/record-writer.cjs

@@ -0,0 +1,29 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_biff_record_types = require("./record-types.cjs");
+const require_biff_write_errors = require("./write-errors.cjs");
+//#region src/biff/record-writer.ts
+const HEADER_SIZE = 4;
+/** Wraps one record's data in its type/size header. Throws BiffWriteError if the data exceeds the single-record maximum, rather than splitting it across Continue records. */
+function writeRecord(type, data) {
+	if (data.length > 8224) throw new require_biff_write_errors.BiffWriteError(`record 0x${type.toString(16)} would carry ${data.length} bytes of data, above the ${require_biff_record_types.MAX_RECORD_DATA_SIZE}-byte maximum a single record can hold ([MS-XLS] 2.1.4); this writer does not split oversized records into Continue chains`);
+	const out = new Uint8Array(HEADER_SIZE + data.length);
+	const view = new DataView(out.buffer);
+	view.setUint16(0, type, true);
+	view.setUint16(2, data.length, true);
+	out.set(data, HEADER_SIZE);
+	return out;
+}
+/** Concatenates already-framed records (or any byte sequences) into one stream, in the order given. */
+function concatRecords(...parts) {
+	const total = parts.reduce((sum, part) => sum + part.length, 0);
+	const out = new Uint8Array(total);
+	let offset = 0;
+	for (const part of parts) {
+		out.set(part, offset);
+		offset += part.length;
+	}
+	return out;
+}
+//#endregion
+exports.concatRecords = concatRecords;
+exports.writeRecord = writeRecord;

package/dist/biff/record-writer.d.cts

@@ -0,0 +1,7 @@
+//#region src/biff/record-writer.d.ts
+/** Wraps one record's data in its type/size header. Throws BiffWriteError if the data exceeds the single-record maximum, rather than splitting it across Continue records. */
+declare function writeRecord(type: number, data: Uint8Array<ArrayBuffer>): Uint8Array<ArrayBuffer>;
+/** Concatenates already-framed records (or any byte sequences) into one stream, in the order given. */
+declare function concatRecords(...parts: readonly Uint8Array<ArrayBuffer>[]): Uint8Array<ArrayBuffer>;
+//#endregion
+export { concatRecords, writeRecord };

package/dist/biff/record-writer.d.ts

@@ -0,0 +1,7 @@
+//#region src/biff/record-writer.d.ts
+/** Wraps one record's data in its type/size header. Throws BiffWriteError if the data exceeds the single-record maximum, rather than splitting it across Continue records. */
+declare function writeRecord(type: number, data: Uint8Array<ArrayBuffer>): Uint8Array<ArrayBuffer>;
+/** Concatenates already-framed records (or any byte sequences) into one stream, in the order given. */
+declare function concatRecords(...parts: readonly Uint8Array<ArrayBuffer>[]): Uint8Array<ArrayBuffer>;
+//#endregion
+export { concatRecords, writeRecord };