xls-codec 4.3.0 → 4.5.0

package/dist/workbook/sheet.js

@@ -1,4 +1,4 @@
-import "../biff/record-types.js";
+import { RECORD_CONDFMT12 } from "../biff/record-types.js";
 import { BiffFormatError } from "../biff/records.js";
 import { columnWidthToPoints, inchesToPoints, twipsToPoints } from "../units.js";
 import { unpackSetupFlags } from "../biff/print-setup.js";
@@ -8,6 +8,8 @@ import { readXLUnicodeString } from "../biff/strings.js";
 import { errorTextOf } from "../biff/errors.js";
 import { parseFormulaText, readPtgExpBase } from "../biff/ptg.js";
 import { decodeRkNumber } from "../biff/rk.js";
+import { readCondFmtGroup } from "./conditional-format.js";
+import { readCondFmt12Group } from "./conditional-format-12.js";
 import { readDv } from "./data-validation.js";
 //#region src/workbook/sheet.ts
 /** Row record flag bits, in the 32-bit field following unused1 ([MS-XLS] 2.4.221). */
@@ -111,6 +113,8 @@ function readSheetRecords(records, sharedStrings, formulaSheets = EMPTY_FORMULA_
 	const columns = [];
 	const merges = [];
 	const dataValidations = [];
+	const conditionalFormats = [];
+	const conditionalFormats12 = [];
 	let usedRange;
 	const marginsPt = {};
 	const rowBreaks = [];
@@ -140,6 +144,18 @@ function readSheetRecords(records, sharedStrings, formulaSheets = EMPTY_FORMULA_
 				if (validation !== void 0) dataValidations.push(validation);
 				break;
 			}
+			case 432: {
+				const group = readCondFmtGroup(records, index, formulaSheets);
+				conditionalFormats.push(...group.formats);
+				index += group.recordsConsumed - 1;
+				break;
+			}
+			case RECORD_CONDFMT12: {
+				const group = readCondFmt12Group(records, index, formulaSheets);
+				conditionalFormats12.push(...group.formats);
+				index += group.recordsConsumed - 1;
+				break;
+			}
 			case 513:
 				cells.push(readBlank(record));
 				break;
@@ -214,6 +230,8 @@ function readSheetRecords(records, sharedStrings, formulaSheets = EMPTY_FORMULA_
 		columns,
 		merges,
 		dataValidations,
+		conditionalFormats,
+		conditionalFormats12,
 		print
 	} : {
 		cells,
@@ -221,6 +239,8 @@ function readSheetRecords(records, sharedStrings, formulaSheets = EMPTY_FORMULA_
 		columns,
 		merges,
 		dataValidations,
+		conditionalFormats,
+		conditionalFormats12,
 		usedRange,
 		print
 	};

package/dist/{xf-colors--5oxSeI1.d.ts → xf-colors-d3OvRw76.d.ts}

@@ -49,6 +49,12 @@ declare const DEFAULT_PALETTE_HEX_TO_ICV: ReadonlyMap<string, number>;
  * `palette`, when given, is the workbook's own Palette record contents (56 entries, icv 8 first); when undefined, icv 8-63 resolve through the fixed default table instead -- [MS-XLS] "Icv"'s own documented fallback for a file carrying no Palette record.
  */
 declare function resolveIcvColor(icv: number, palette: readonly Color[] | undefined): Color | undefined;
+/**
+ * Applies Excel's own "TintAndShade" colour model to an already-resolved colour: a single -1.0..1.0 value shading a colour toward black (negative) or tinting it toward white (positive), the model CFColor's own numTint field ([MS-XLS] 2.4, https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xls/fd8e679d-069f-486b-ab48-2382cc167305) carries -- distinct from DrawingML's own separate shade/tint elements (ooxml.js's typed/shared/color.ts), which apply in linear light rather than adjusting HSL lightness directly.
+ *
+ * The formula itself -- Lum' = Lum*(1+tint) for a negative tint, Lum' = Lum*(1-tint) + tint for a positive one -- is Microsoft's own documented Color.TintAndShade algorithm, cross-checked against Apache POI's XSSFColor#getTint/#setTint javadoc (a completely independent implementation carrying the identical formula) rather than trusted from memory alone.
+ */
+declare function applyTint(color: Color, tint: number): Color;
 /** One border edge's own raw fields, as the CellXF/StyleXF trailing payload packs them: a BorderStyle line-style token and a 7-bit icv colour index. */
 interface XfBorderEdge {
   readonly style: number;
@@ -95,4 +101,4 @@ declare function readLongRgbColor(cursor: BlockCursor): Color;
 /** The inverse of readLongRgbColor: a colour's own red/green/blue/reserved bytes, rounded to the nearest byte (the same rounding colorToRgbHex applies) -- exact for any colour this package itself constructed via rgbHexToColor, which is what write.ts's own palette-colour interning does. */
 declare function longRgbBytesOf(color: Color): readonly [number, number, number, number];
 //#endregion
-export { packXfDecorationWords as A, UNDECORATED_XF_FIELDS as C, borderStyleTokenFor as D, XfDecorationFields as E, resolveIcvColor as F, resolveVerticalAlignment as I, unpackXfAlignment as L, resolveBorderEdge as M, resolveFillBackground as N, horizAlignTokenFor as O, resolveHorizontalAlignment as P, unpackXfDecoration as R, PATTERN_TYPE_TO_FILL_PATTERN as S, XfBorderEdge as T, FILL_PATTERN_SOLID as _, BORDER_STYLE_DOUBLE as a, PALETTE_BASE_ICV as b, BORDER_STYLE_MEDIUM_DASHDOT as c, BORDER_STYLE_NONE as d, BORDER_STYLE_SLANT_DASHDOT as f, FILL_PATTERN_NONE as g, DEFAULT_PALETTE_HEX_TO_ICV as h, BORDER_STYLE_DOTTED as i, readLongRgbColor as j, longRgbBytesOf as k, BORDER_STYLE_MEDIUM_DASHDOTDOT as l, BORDER_STYLE_THIN as m, BORDER_STYLE_DASHDOTDOT as n, BORDER_STYLE_HAIR as o, BORDER_STYLE_THICK as p, BORDER_STYLE_DASHED as r, BORDER_STYLE_MEDIUM as s, BORDER_STYLE_DASHDOT as t, BORDER_STYLE_MEDIUM_DASHED as u, ICV_AUTOMATIC_BACKGROUND as v, XfAlignmentFields as w, PALETTE_ENTRY_COUNT as x, ICV_AUTOMATIC_FOREGROUND as y, vertAlignTokenFor as z };
+export { longRgbBytesOf as A, vertAlignTokenFor as B, UNDECORATED_XF_FIELDS as C, applyTint as D, XfDecorationFields as E, resolveHorizontalAlignment as F, resolveIcvColor as I, resolveVerticalAlignment as L, readLongRgbColor as M, resolveBorderEdge as N, borderStyleTokenFor as O, resolveFillBackground as P, unpackXfAlignment as R, PATTERN_TYPE_TO_FILL_PATTERN as S, XfBorderEdge as T, FILL_PATTERN_SOLID as _, BORDER_STYLE_DOUBLE as a, PALETTE_BASE_ICV as b, BORDER_STYLE_MEDIUM_DASHDOT as c, BORDER_STYLE_NONE as d, BORDER_STYLE_SLANT_DASHDOT as f, FILL_PATTERN_NONE as g, DEFAULT_PALETTE_HEX_TO_ICV as h, BORDER_STYLE_DOTTED as i, packXfDecorationWords as j, horizAlignTokenFor as k, BORDER_STYLE_MEDIUM_DASHDOTDOT as l, BORDER_STYLE_THIN as m, BORDER_STYLE_DASHDOTDOT as n, BORDER_STYLE_HAIR as o, BORDER_STYLE_THICK as p, BORDER_STYLE_DASHED as r, BORDER_STYLE_MEDIUM as s, BORDER_STYLE_DASHDOT as t, BORDER_STYLE_MEDIUM_DASHED as u, ICV_AUTOMATIC_BACKGROUND as v, XfAlignmentFields as w, PALETTE_ENTRY_COUNT as x, ICV_AUTOMATIC_FOREGROUND as y, unpackXfDecoration as z };

package/dist/{xf-colors-BB5MKq6R.d.cts → xf-colors-mqerVt2O.d.cts}

@@ -49,6 +49,12 @@ declare const DEFAULT_PALETTE_HEX_TO_ICV: ReadonlyMap<string, number>;
  * `palette`, when given, is the workbook's own Palette record contents (56 entries, icv 8 first); when undefined, icv 8-63 resolve through the fixed default table instead -- [MS-XLS] "Icv"'s own documented fallback for a file carrying no Palette record.
  */
 declare function resolveIcvColor(icv: number, palette: readonly Color[] | undefined): Color | undefined;
+/**
+ * Applies Excel's own "TintAndShade" colour model to an already-resolved colour: a single -1.0..1.0 value shading a colour toward black (negative) or tinting it toward white (positive), the model CFColor's own numTint field ([MS-XLS] 2.4, https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xls/fd8e679d-069f-486b-ab48-2382cc167305) carries -- distinct from DrawingML's own separate shade/tint elements (ooxml.js's typed/shared/color.ts), which apply in linear light rather than adjusting HSL lightness directly.
+ *
+ * The formula itself -- Lum' = Lum*(1+tint) for a negative tint, Lum' = Lum*(1-tint) + tint for a positive one -- is Microsoft's own documented Color.TintAndShade algorithm, cross-checked against Apache POI's XSSFColor#getTint/#setTint javadoc (a completely independent implementation carrying the identical formula) rather than trusted from memory alone.
+ */
+declare function applyTint(color: Color, tint: number): Color;
 /** One border edge's own raw fields, as the CellXF/StyleXF trailing payload packs them: a BorderStyle line-style token and a 7-bit icv colour index. */
 interface XfBorderEdge {
   readonly style: number;
@@ -95,4 +101,4 @@ declare function readLongRgbColor(cursor: BlockCursor): Color;
 /** The inverse of readLongRgbColor: a colour's own red/green/blue/reserved bytes, rounded to the nearest byte (the same rounding colorToRgbHex applies) -- exact for any colour this package itself constructed via rgbHexToColor, which is what write.ts's own palette-colour interning does. */
 declare function longRgbBytesOf(color: Color): readonly [number, number, number, number];
 //#endregion
-export { packXfDecorationWords as A, UNDECORATED_XF_FIELDS as C, borderStyleTokenFor as D, XfDecorationFields as E, resolveIcvColor as F, resolveVerticalAlignment as I, unpackXfAlignment as L, resolveBorderEdge as M, resolveFillBackground as N, horizAlignTokenFor as O, resolveHorizontalAlignment as P, unpackXfDecoration as R, PATTERN_TYPE_TO_FILL_PATTERN as S, XfBorderEdge as T, FILL_PATTERN_SOLID as _, BORDER_STYLE_DOUBLE as a, PALETTE_BASE_ICV as b, BORDER_STYLE_MEDIUM_DASHDOT as c, BORDER_STYLE_NONE as d, BORDER_STYLE_SLANT_DASHDOT as f, FILL_PATTERN_NONE as g, DEFAULT_PALETTE_HEX_TO_ICV as h, BORDER_STYLE_DOTTED as i, readLongRgbColor as j, longRgbBytesOf as k, BORDER_STYLE_MEDIUM_DASHDOTDOT as l, BORDER_STYLE_THIN as m, BORDER_STYLE_DASHDOTDOT as n, BORDER_STYLE_HAIR as o, BORDER_STYLE_THICK as p, BORDER_STYLE_DASHED as r, BORDER_STYLE_MEDIUM as s, BORDER_STYLE_DASHDOT as t, BORDER_STYLE_MEDIUM_DASHED as u, ICV_AUTOMATIC_BACKGROUND as v, XfAlignmentFields as w, PALETTE_ENTRY_COUNT as x, ICV_AUTOMATIC_FOREGROUND as y, vertAlignTokenFor as z };
+export { longRgbBytesOf as A, vertAlignTokenFor as B, UNDECORATED_XF_FIELDS as C, applyTint as D, XfDecorationFields as E, resolveHorizontalAlignment as F, resolveIcvColor as I, resolveVerticalAlignment as L, readLongRgbColor as M, resolveBorderEdge as N, borderStyleTokenFor as O, resolveFillBackground as P, unpackXfAlignment as R, PATTERN_TYPE_TO_FILL_PATTERN as S, XfBorderEdge as T, FILL_PATTERN_SOLID as _, BORDER_STYLE_DOUBLE as a, PALETTE_BASE_ICV as b, BORDER_STYLE_MEDIUM_DASHDOT as c, BORDER_STYLE_NONE as d, BORDER_STYLE_SLANT_DASHDOT as f, FILL_PATTERN_NONE as g, DEFAULT_PALETTE_HEX_TO_ICV as h, BORDER_STYLE_DOTTED as i, packXfDecorationWords as j, horizAlignTokenFor as k, BORDER_STYLE_MEDIUM_DASHDOTDOT as l, BORDER_STYLE_THIN as m, BORDER_STYLE_DASHDOTDOT as n, BORDER_STYLE_HAIR as o, BORDER_STYLE_THICK as p, BORDER_STYLE_DASHED as r, BORDER_STYLE_MEDIUM as s, BORDER_STYLE_DASHDOT as t, BORDER_STYLE_MEDIUM_DASHED as u, ICV_AUTOMATIC_BACKGROUND as v, XfAlignmentFields as w, PALETTE_ENTRY_COUNT as x, ICV_AUTOMATIC_FOREGROUND as y, unpackXfDecoration as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xls-codec",
-  "version": "4.3.0",
+  "version": "4.5.0",
   "description": "Hand-written reader for the legacy Excel Binary File Format (.xls, BIFF8) as specified by [MS-XLS], mapping a workbook's record stream onto the shared document-schema.js spreadsheet model - the .xls codec for the documents.js family.",
   "type": "module",
   "repository": {