reamkit 1.13.0 → 1.15.0

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

@@ -59,6 +59,10 @@ export interface ParsedWorksheet {
     readonly drawingRelId?: string;
     readonly conditionalFormats?: ReadonlyArray<ConditionalFormat>;
     readonly dataValidations?: ReadonlyArray<DataValidation>;
+    readonly hyperlinks?: ReadonlyArray<HyperlinkRef>;
+    readonly headerFooter?: HeaderFooter;
+    readonly formControls?: ReadonlyArray<FormControlRef>;
+    readonly oleObjects?: ReadonlyArray<OleObjectRef>;
     readonly sparklines?: ReadonlyArray<ParsedSparkline>;
     readonly tablePartRelIds?: ReadonlyArray<string>;
     readonly tables?: ReadonlyArray<ExcelTable>;
@@ -128,6 +132,9 @@ export interface XlsxBorder {
     readonly right?: XlsxBorderEdge;
     readonly bottom?: XlsxBorderEdge;
     readonly left?: XlsxBorderEdge;
+    readonly diagonal?: XlsxBorderEdge;
+    readonly diagonalUp?: boolean;
+    readonly diagonalDown?: boolean;
 }
 export type XlsxHorizontalAlign = 'left' | 'center' | 'right' | 'fill' | 'justify' | 'centerContinuous' | 'distributed';
 export type XlsxVerticalAlign = 'top' | 'center' | 'bottom' | 'justify' | 'distributed';
@@ -135,6 +142,9 @@ export interface XlsxCellAlignment {
     readonly horizontal?: XlsxHorizontalAlign;
     readonly vertical?: XlsxVerticalAlign;
     readonly wrapText?: boolean;
+    readonly indent?: number;
+    readonly textRotation?: number;
+    readonly shrinkToFit?: boolean;
 }
 export interface XlsxCellXf {
     readonly numFmtId: number;
@@ -199,11 +209,81 @@ export interface CfRuleIconSet {
     readonly cfvos: ReadonlyArray<Cfvo>;
     readonly reverse?: boolean;
 }
-export type CfRule = CfRuleCellIs | CfRuleColorScale | CfRuleDataBar | CfRuleIconSet;
+export interface CfRuleTop10 {
+    readonly type: 'top10';
+    readonly priority: number;
+    readonly rank: number;
+    readonly percent: boolean;
+    readonly bottom: boolean;
+    readonly dxfId: number;
+}
+export interface CfRuleAboveAverage {
+    readonly type: 'aboveAverage';
+    readonly priority: number;
+    readonly aboveAverage: boolean;
+    readonly equalAverage: boolean;
+    readonly stdDev?: number;
+    readonly dxfId: number;
+}
+export interface CfRuleDupUnique {
+    readonly type: 'duplicateValues' | 'uniqueValues';
+    readonly priority: number;
+    readonly dxfId: number;
+}
+export interface CfRuleText {
+    readonly type: 'containsText' | 'notContainsText' | 'beginsWith' | 'endsWith';
+    readonly priority: number;
+    readonly text: string;
+    readonly dxfId: number;
+    readonly formula?: string;
+}
+export interface CfRuleExpression {
+    readonly type: 'expression';
+    readonly priority: number;
+    readonly formula: string;
+    readonly dxfId: number;
+}
+export type TimePeriodKind = 'today' | 'yesterday' | 'tomorrow' | 'last7Days' | 'thisWeek' | 'lastWeek' | 'nextWeek' | 'thisMonth' | 'lastMonth' | 'nextMonth';
+export interface CfRuleTimePeriod {
+    readonly type: 'timePeriod';
+    readonly priority: number;
+    readonly timePeriod: TimePeriodKind;
+    readonly dxfId: number;
+    readonly formula?: string;
+}
+export type CfRule = CfRuleCellIs | CfRuleColorScale | CfRuleDataBar | CfRuleIconSet | CfRuleTop10 | CfRuleAboveAverage | CfRuleDupUnique | CfRuleText | CfRuleExpression | CfRuleTimePeriod;
 export interface ConditionalFormat {
     readonly ranges: ReadonlyArray<MergedRange>;
     readonly rules: ReadonlyArray<CfRule>;
 }
+export interface HyperlinkRef {
+    readonly ref: string;
+    readonly relId?: string;
+    readonly location?: string;
+    readonly display?: string;
+    readonly tooltip?: string;
+}
+export interface HeaderFooter {
+    readonly oddHeader?: string;
+    readonly oddFooter?: string;
+}
+export interface FormControlRef {
+    readonly name?: string;
+    readonly relId: string;
+}
+export interface OleObjectRef {
+    readonly progId?: string;
+    readonly relId: string;
+}
+export interface SheetRichRun {
+    readonly text: string;
+    readonly bold?: boolean;
+    readonly italic?: boolean;
+    readonly underline?: boolean;
+    readonly colorHex?: string;
+    readonly sizePt?: number;
+    readonly vertAlign?: 'superscript' | 'subscript';
+}
 export type DataValidationType = 'none' | 'whole' | 'decimal' | 'list' | 'date' | 'time' | 'textLength' | 'custom';
 export interface DataValidation {
     readonly type: DataValidationType;

package/dist/esm/excel/activex-parser.d.ts

@@ -0,0 +1,9 @@
+export interface ActiveXProps {
+    readonly caption?: string;
+    readonly value?: string;
+    readonly groupName?: string;
+}
+export declare function parseActiveX(data: Uint8Array): ActiveXProps;
+export declare function activeXType(progId: string | undefined): string;
+export declare function activeXBinRelId(xmlData: Uint8Array): string | undefined;
+export declare function parseActiveXBin(data: Uint8Array): ActiveXProps;

package/dist/esm/excel/activex-parser.js

@@ -0,0 +1,188 @@
+import { XMLParser } from "fast-xml-parser";
+//#region src/excel/activex-parser.ts
+var decoder = new TextDecoder("utf-8");
+var parser = new XMLParser({
+	ignoreAttributes: false,
+	attributeNamePrefix: "@_",
+	parseAttributeValue: false,
+	removeNSPrefix: true
+});
+function parseActiveX(data) {
+	const ocx = asObject(parser.parse(decoder.decode(data))["ocx"]);
+	if (!ocx) return {};
+	const props = /* @__PURE__ */ new Map();
+	for (const pr of toArray(ocx["ocxPr"])) {
+		const o = asObject(pr);
+		const name = o && strAttr(o, "name");
+		const value = o && strAttr(o, "value");
+		if (name) props.set(name.toLowerCase(), value ?? "");
+	}
+	const caption = props.get("caption");
+	const value = props.get("value");
+	const groupName = props.get("groupname");
+	return {
+		...caption !== void 0 ? { caption } : {},
+		...value !== void 0 ? { value } : {},
+		...groupName !== void 0 ? { groupName } : {}
+	};
+}
+function activeXType(progId) {
+	switch ((/Forms\.(\w+)\.\d+/i.exec(progId ?? "")?.[1] ?? "").toLowerCase()) {
+		case "checkbox": return "checkbox";
+		case "optionbutton": return "option";
+		case "commandbutton": return "button";
+		case "togglebutton": return "toggle";
+		case "textbox": return "textbox";
+		case "combobox": return "combo";
+		case "listbox": return "list";
+		case "label": return "label";
+		case "spinbutton": return "spin";
+		case "scrollbar": return "scroll";
+		case "frame": return "frame";
+		default: return "control";
+	}
+}
+function asObject(v) {
+	return v && typeof v === "object" && !Array.isArray(v) ? v : void 0;
+}
+function toArray(v) {
+	return Array.isArray(v) ? v : v !== void 0 && v !== null ? [v] : [];
+}
+function strAttr(obj, key) {
+	const v = obj[`@_${key}`];
+	return typeof v === "string" ? v : void 0;
+}
+function activeXBinRelId(xmlData) {
+	const ocx = asObject(parser.parse(decoder.decode(xmlData))["ocx"]);
+	if (!ocx) return void 0;
+	const persistence = strAttr(ocx, "persistence");
+	if (persistence !== "persistStreamInit" && persistence !== "persistStream" && persistence !== "persistStorage") return;
+	return strAttr(ocx, "id");
+}
+var CFB_MAGIC = [
+	208,
+	207,
+	17,
+	224,
+	161,
+	177,
+	26,
+	225
+];
+var MORPH_DATA_BLOCK_1 = [
+	[0, 4],
+	[1, 4],
+	[2, 4],
+	[3, 4],
+	[4, 1],
+	[5, 1],
+	[6, 1],
+	[7, 1],
+	[9, 2],
+	[10, 4],
+	[11, 2],
+	[12, 2],
+	[13, 2],
+	[14, 2],
+	[15, 2],
+	[16, 1],
+	[17, 1],
+	[18, 1],
+	[20, 1],
+	[21, 1]
+];
+var MORPH_DATA_BLOCK_2 = [
+	[24, 4],
+	[25, 4],
+	[26, 4],
+	[27, 2],
+	[28, 2],
+	[29, 2]
+];
+var BIT_F_SIZE = 8;
+var BIT_F_VALUE = 22;
+var BIT_F_CAPTION = 23;
+var BIT_F_GROUP_NAME = 32;
+var MORPH_MAJOR_VERSION = 2;
+var ONE_8 = new TextDecoder("windows-1252");
+var UTF16 = new TextDecoder("utf-16le");
+function u16le(d, i) {
+	return d[i] | d[i + 1] << 8;
+}
+function u32le(d, i) {
+	return (d[i] | d[i + 1] << 8 | d[i + 2] << 16 | d[i + 3] << 24) >>> 0;
+}
+function parseActiveXBin(data) {
+	if (data.length >= 8 && CFB_MAGIC.every((b, i) => data[i] === b)) return {};
+	let off;
+	if (data.length >= 18 && data[16] === 0 && data[17] === MORPH_MAJOR_VERSION) off = 16;
+	else if (data.length >= 2 && data[0] === 0 && data[1] === MORPH_MAJOR_VERSION) off = 0;
+	if (off === void 0) return {};
+	let p = off + 2;
+	if (p + 10 > data.length) return {};
+	const cb = u16le(data, p);
+	p += 2;
+	const blockEnd = Math.min(data.length, p + cb);
+	const propLo = u32le(data, p);
+	const propHi = u32le(data, p + 4);
+	p += 8;
+	const dataStart = p;
+	const bit = (b) => (b < 32 ? propLo >>> b & 1 : propHi >>> b - 32 & 1) === 1;
+	const align = (n) => {
+		p += (n - (p - dataStart) % n) % n;
+	};
+	for (const [b, size] of MORPH_DATA_BLOCK_1) if (bit(b)) {
+		align(size);
+		p += size;
+	}
+	const readCount = () => {
+		align(4);
+		if (p + 4 > blockEnd) return void 0;
+		const v = u32le(data, p);
+		p += 4;
+		return v;
+	};
+	let valueCount;
+	let captionCount;
+	let groupCount;
+	if (bit(BIT_F_VALUE)) {
+		valueCount = readCount();
+		if (valueCount === void 0) return {};
+	}
+	if (bit(BIT_F_CAPTION)) {
+		captionCount = readCount();
+		if (captionCount === void 0) return {};
+	}
+	for (const [b, size] of MORPH_DATA_BLOCK_2) if (bit(b)) {
+		align(size);
+		p += size;
+	}
+	if (bit(BIT_F_GROUP_NAME)) {
+		groupCount = readCount();
+		if (groupCount === void 0) return {};
+	}
+	if (bit(BIT_F_SIZE)) {
+		align(4);
+		p += 8;
+	}
+	const readString = (count) => {
+		if (count === void 0) return void 0;
+		align(4);
+		const len = count & 2147483647;
+		if (len === 0) return "";
+		if (p + len > blockEnd) return void 0;
+		const slice = data.subarray(p, p + len);
+		p += len;
+		return (count & 2147483648) !== 0 ? ONE_8.decode(slice) : UTF16.decode(slice);
+	};
+	const value = readString(valueCount);
+	const caption = readString(captionCount);
+	const groupName = readString(groupCount);
+	return {
+		...caption !== void 0 && caption !== "" ? { caption } : {},
+		...value !== void 0 && value !== "" ? { value } : {},
+		...groupName !== void 0 && groupName !== "" ? { groupName } : {}
+	};
+}
+//#endregion
+export { activeXBinRelId, activeXType, parseActiveX, parseActiveXBin };

package/dist/esm/excel/comments-parser.d.ts

@@ -0,0 +1,4 @@
+import { SheetComment } from '../core/ir/sheet.js';
+export declare function parseLegacyComments(data: Uint8Array): Array<SheetComment>;
+export declare function parsePersons(data: Uint8Array): Map<string, string>;
+export declare function parseThreadedComments(data: Uint8Array, persons: ReadonlyMap<string, string>): Array<SheetComment>;

package/dist/esm/excel/comments-parser.js

@@ -0,0 +1,104 @@
+import { XMLParser } from "fast-xml-parser";
+//#region src/excel/comments-parser.ts
+var decoder = new TextDecoder("utf-8");
+var parser = new XMLParser({
+	ignoreAttributes: false,
+	attributeNamePrefix: "@_",
+	textNodeName: "#text",
+	parseAttributeValue: false,
+	parseTagValue: false,
+	trimValues: false,
+	removeNSPrefix: true
+});
+function parseLegacyComments(data) {
+	const root = asObject(parser.parse(decoder.decode(data))["comments"]);
+	if (!root) return [];
+	const authors = toArray(asObject(root["authors"])?.["author"]).map((a) => textOf(a));
+	const out = [];
+	for (const c of toArray(asObject(root["commentList"])?.["comment"])) {
+		const obj = asObject(c);
+		if (!obj) continue;
+		const ref = strAttr(obj, "ref");
+		if (!ref) continue;
+		const authorIdx = Number(strAttr(obj, "authorId"));
+		const author = Number.isInteger(authorIdx) ? authors[authorIdx] : void 0;
+		const text = stripAuthorPrefix(richText(obj["text"]), author);
+		if (text.length === 0 && !author) continue;
+		out.push({
+			ref,
+			...author ? { author } : {},
+			text,
+			threaded: false
+		});
+	}
+	return out;
+}
+function parsePersons(data) {
+	const root = asObject(parser.parse(decoder.decode(data))["personList"]);
+	const map = /* @__PURE__ */ new Map();
+	if (!root) return map;
+	for (const p of toArray(root["person"])) {
+		const obj = asObject(p);
+		const id = obj ? strAttr(obj, "id") : void 0;
+		const name = obj ? strAttr(obj, "displayName") : void 0;
+		if (id && name) map.set(id, name);
+	}
+	return map;
+}
+function parseThreadedComments(data, persons) {
+	const root = asObject(parser.parse(decoder.decode(data))["ThreadedComments"]);
+	if (!root) return [];
+	const out = [];
+	for (const c of toArray(root["threadedComment"])) {
+		const obj = asObject(c);
+		if (!obj) continue;
+		const ref = strAttr(obj, "ref");
+		if (!ref) continue;
+		const personId = strAttr(obj, "personId");
+		const author = personId ? persons.get(personId) : void 0;
+		const text = textOf(obj["text"]);
+		if (text.length === 0) continue;
+		out.push({
+			ref,
+			...author ? { author } : {},
+			text,
+			threaded: true
+		});
+	}
+	return out;
+}
+function richText(node) {
+	const obj = asObject(node);
+	if (!obj) return textOf(node);
+	const direct = textOf(obj["t"]);
+	if (direct) return direct;
+	return toArray(obj["r"]).map((r) => textOf(asObject(r)?.["t"])).join("");
+}
+function stripAuthorPrefix(text, author) {
+	if (!author) return text;
+	const prefix = `${author}:`;
+	if (text.startsWith(prefix)) return text.slice(prefix.length).replace(/^\s+/, "");
+	return text;
+}
+function asObject(v) {
+	return v && typeof v === "object" && !Array.isArray(v) ? v : void 0;
+}
+function toArray(v) {
+	return Array.isArray(v) ? v : v !== void 0 ? [v] : [];
+}
+function strAttr(obj, key) {
+	const v = obj[`@_${key}`];
+	return typeof v === "string" ? v : void 0;
+}
+function textOf(node) {
+	if (typeof node === "string") return node;
+	if (typeof node === "number") return String(node);
+	const obj = asObject(node);
+	if (!obj) return "";
+	const inner = obj["#text"];
+	if (typeof inner === "string") return inner;
+	if (typeof inner === "number") return String(inner);
+	return "";
+}
+//#endregion
+export { parseLegacyComments, parsePersons, parseThreadedComments };

package/dist/esm/excel/conditional-format.d.ts

@@ -1,5 +1,5 @@
 import { CellIcon } from '../core/document-model/index.js';
-import { ConditionalFormat, WorksheetCell, XlsxStyles } from '../core/spreadsheet-model/index.js';
+import { ConditionalFormat, DefinedName, WorksheetCell, XlsxStyles } from '../core/spreadsheet-model/index.js';
 export interface CfOverride {
     readonly fillHex?: string;
     readonly fontColorHex?: string;
@@ -12,5 +12,7 @@ export interface CfOverride {
     };
     readonly icon?: CellIcon;
 }
-export type CellConditionalFormatter = (row: number, col: number, numericValue: number | undefined) => CfOverride | undefined;
-export declare function buildConditionalFormatter(conditionalFormats: ReadonlyArray<ConditionalFormat> | undefined, styles: XlsxStyles, cells: ReadonlyArray<WorksheetCell>): CellConditionalFormatter | undefined;
+export type CellConditionalFormatter = (row: number, col: number, numericValue: number | undefined, text: string | undefined) => CfOverride | undefined;
+export declare function buildConditionalFormatter(conditionalFormats: ReadonlyArray<ConditionalFormat> | undefined, styles: XlsxStyles, cells: ReadonlyArray<WorksheetCell>, resolveText?: (cell: WorksheetCell) => string, date1904?: boolean, now?: Date, sheetGrids?: ReadonlyMap<string, {
+    readonly cells: ReadonlyArray<WorksheetCell>;
+}>, currentSheet?: string, definedNames?: ReadonlyArray<DefinedName>): CellConditionalFormatter | undefined;