xlvane 1.0.0 → 1.1.0

package/dist/{options-B7UhudO_.js → options-CwSp2pA4.js}

@@ -5830,6 +5830,7 @@ function parseWorkbookPart(xml, ctx) {
 		location: { part: ctx.part },
 		hint: "Every workbook must list its sheets. Re-save the file in a spreadsheet application."
 	});
+	const seenIds = /* @__PURE__ */ new Set();
 	const sheets = childrenNamed(sheetsElement, ns, "sheet").map((el) => {
 		const name = decodeXstring(el.attrs.get("name") ?? "");
 		const rawState = el.attrs.get("state") ?? "visible";
@@ -5842,9 +5843,22 @@ function parseWorkbookPart(xml, ctx) {
 			state = "visible";
 		}
 		const rawId = el.attrs.get("sheetId");
+		let sheetId = rawId !== void 0 && /^\d{1,10}$/.test(rawId.trim()) ? Number(rawId.trim()) : null;
+		if (sheetId !== null && sheetId > 4294967295) sheetId = null;
+		if (sheetId === null) ctx.warnings.add("XLV_W_INVALID_VALUE", rawId === void 0 ? `Sheet "${name}" has no sheetId.` : `Sheet "${name}" has the invalid sheetId "${rawId.slice(0, 20)}".`, {
+			part: ctx.part,
+			sheet: name
+		});
+		else if (seenIds.has(sheetId)) {
+			ctx.warnings.add("XLV_W_INVALID_VALUE", `Sheet "${name}" repeats the sheetId ${String(sheetId)} of an earlier sheet; its sheetId is read as null.`, {
+				part: ctx.part,
+				sheet: name
+			});
+			sheetId = null;
+		} else seenIds.add(sheetId);
 		return {
 			name,
-			sheetId: rawId !== void 0 && /^\d{1,10}$/.test(rawId) ? Number(rawId) : null,
+			sheetId,
 			state,
 			relId: el.attrs.get(relIdKey) ?? null
 		};
@@ -6598,6 +6612,7 @@ function sheetHead(sheet, selected, dimension, xfOf) {
 		xml += "><pane";
 		if (split.x > 0) xml += attr("xSplit", split.x * 20);
 		if (split.y > 0) xml += attr("ySplit", split.y * 20);
+		if (split.topLeftCell !== void 0) xml += attr("topLeftCell", split.topLeftCell);
 		xml += `${attr("activePane", pane)} state="split"/>`;
 		const active = sheet.view?.activeCell;
 		xml += active ? `<selection${attr("pane", pane)}${attr("activeCell", active)}${attr("sqref", active)}/></sheetView>` : "</sheetView>";
@@ -7156,6 +7171,21 @@ function nameTitles(definedNames) {
 		return n.sheet === null ? name : `${quoteSheetName(n.sheet)}!${name}`;
 	});
 }
+/**
+* The sheet ids to write: the given ones, and the lowest unused ids for the other sheets in sheet
+* order, so that sheets without given ids get 1, 2, 3, … (unique, as E-09 requires; D-F03).
+*/
+function sheetIds(sheets) {
+	const used = /* @__PURE__ */ new Set();
+	for (const s of sheets) if (typeof s.sheetId === "number") used.add(s.sheetId);
+	let next = 1;
+	return sheets.map((s) => {
+		if (typeof s.sheetId === "number") return s.sheetId;
+		while (used.has(next)) next++;
+		used.add(next);
+		return next;
+	});
+}
 /** The workbook part: date system, book view, sheets, and the autofilter and user defined names. */
 function workbookXml(sheets, dateSystem, definedNames = [], protection = null, extras = {}) {
 	const active = sheets.findIndex((s) => s.state === "visible");
@@ -7180,8 +7210,9 @@ function workbookXml(sheets, dateSystem, definedNames = [], protection = null, e
 		workbook += "</bookViews>";
 	}
 	workbook += "<sheets>";
+	const ids = sheetIds(sheets);
 	sheets.forEach((sheet, i) => {
-		workbook += `<sheet${attr("name", encodeXstring(sheet.name))}${attr("sheetId", i + 1)}`;
+		workbook += `<sheet${attr("name", encodeXstring(sheet.name))}${attr("sheetId", ids[i] ?? i + 1)}`;
 		if (sheet.state !== "visible") workbook += attr("state", sheet.state);
 		workbook += `${attr("r:id", `rId${String(i + 1)}`)}/>`;
 	});
@@ -7838,6 +7869,8 @@ const X14_NS = "http://schemas.microsoft.com/office/spreadsheetml/2009/9/main";
 const XM_NS = "http://schemas.microsoft.com/office/excel/2006/main";
 /** `ext@uri` of the worksheet extension with `x14:conditionalFormattings` ([MS-XLSX] §2.2.4.12). */
 const X14_CF_URI = "{78C0D931-6437-407D-A8EE-F0AAD7539E65}";
+/** `ext@uri` of the worksheet extension with `x14:dataValidations` (§2.2.4.12). */
+const X14_DV_URI = "{CCE6A557-97BC-4B89-ADB6-D9C93CAAB3DF}";
 /** `ext@uri` of the cfRule extension with `x14:id` (§2.2.4.12). */
 const X14_ID_URI = "{B025F937-C7B1-47D3-B67F-A62EFF666E3E}";
 const parseBool = (raw, dflt) => {
@@ -9694,9 +9727,14 @@ function parseSplit(attrs, warn) {
 	const x = position("xSplit");
 	const y = position("ySplit");
 	if (x === null || y === null || x === 0 && y === 0) return null;
-	return Object.freeze({
+	const topLeft = parseCellRef((attrs.get("topLeftCell") ?? "").trim());
+	return Object.freeze(topLeft === null ? {
 		x,
 		y
+	} : {
+		x,
+		y,
+		topLeftCell: formatCellRef(topLeft.row, topLeft.col)
 	});
 }
 /**
@@ -10270,6 +10308,7 @@ var ReadSheet = class {
 	state;
 	part;
 	data;
+	sheetId;
 	hyperlinks;
 	notes;
 	names;
@@ -10279,13 +10318,14 @@ var ReadSheet = class {
 	backgroundImage = null;
 	/** Tables of the sheet (TD-01). */
 	tables = [];
-	constructor(name, index, kind, state, part, data, hyperlinks = [], notes = [], names = []) {
+	constructor(name, index, kind, state, part, data, sheetId, hyperlinks = [], notes = [], names = []) {
 		this.name = name;
 		this.index = index;
 		this.kind = kind;
 		this.state = state;
 		this.part = part;
 		this.data = data;
+		this.sheetId = sheetId;
 		this.hyperlinks = hyperlinks;
 		this.notes = notes;
 		this.names = names;
@@ -10483,7 +10523,7 @@ function readWorkbook(data, options) {
 		const links = data === null || entry.part === null ? [] : resolveHyperlinks(pkg, entry.part, entry.name, data, warnings);
 		const notes = data === null || entry.part === null ? [] : readNotes(pkg, entry.part, entry.name, limits, warnings);
 		if (data !== null) attachNotes(data.rows, notes);
-		const sheet = new ReadSheet(entry.name, entry.index, entry.kind, entry.state, entry.part, data, links, notes, book.definedNames);
+		const sheet = new ReadSheet(entry.name, entry.index, entry.kind, entry.state, entry.part, data, entry.sheetId, links, notes, book.definedNames);
 		if (data !== null && entry.part !== null) sheet.tables = readTables(pkg, entry.part, entry.name, limits, warnings);
 		if (data !== null && entry.part !== null) {
 			const drawing = readSheetDrawing(pkg, entry.part, entry.name, {
@@ -10747,6 +10787,7 @@ function analyzeWorkbook(pkg, limits, warnings) {
 			return {
 				name: entry.name,
 				index,
+				sheetId: entry.sheetId,
 				kind,
 				state: entry.state,
 				part: null
@@ -10755,6 +10796,7 @@ function analyzeWorkbook(pkg, limits, warnings) {
 		return {
 			name: entry.name,
 			index,
+			sheetId: entry.sheetId,
 			kind,
 			state: entry.state,
 			part: rel.target
@@ -11012,6 +11054,7 @@ function inspectSheet(sheet, options, warnings) {
 	const base = {
 		name: sheet.name,
 		index: sheet.index,
+		sheetId: sheet.sheetId,
 		kind: sheet.kind,
 		state: sheet.state,
 		dimension: sheet.dimension,
@@ -11242,6 +11285,8 @@ function readOutline(o, current, what) {
 }
 /** Largest split position accepted, in points: an implementation bound, not a documented limit. */
 const MAX_SPLIT_POINTS = 1e6;
+/** Office uses sheet ids from 1 to 65534 ([MS-OI29500] §2.1.578; W2-20). */
+const MAX_SHEET_ID = 65534;
 /** Most characters a cell can contain (Excel specifications and limits, W-04). */
 const MAX_CELL_TEXT = 32767;
 /** Widest column, in characters (Excel specifications and limits, W-04). */
@@ -11364,6 +11409,8 @@ var NewSheet = class {
 	book;
 	/** Visibility of the sheet. */
 	state;
+	/** The id given to {@link NewWorkbook.addSheet}, or `null` when the lowest unused id is taken when writing. */
+	sheetId;
 	/** @internal */
 	cellMap = /* @__PURE__ */ new Map();
 	/** @internal */
@@ -11408,10 +11455,11 @@ var NewSheet = class {
 	tableList = [];
 	count = 0;
 	/** @internal Use {@link NewWorkbook.addSheet}. */
-	constructor(name, state, book) {
+	constructor(name, state, book, sheetId = null) {
 		this.name = name;
 		this.book = book;
 		this.state = state;
+		this.sheetId = sheetId;
 	}
 	/** Number of cells that have a value or a style. */
 	get cellCount() {
@@ -11819,7 +11867,11 @@ var NewSheet = class {
 				const split = o.get("split");
 				if (split === null) next.split = null;
 				else {
-					const p = readOptions$1(split, ["x", "y"], "view option \"split\"");
+					const p = readOptions$1(split, [
+						"x",
+						"y",
+						"topLeftCell"
+					], "view option \"split\"");
 					const at = (key) => {
 						const v = p.get(key) ?? 0;
 						if (typeof v !== "number" || !Number.isFinite(v) || v < 0 || v > MAX_SPLIT_POINTS) throw invalidOption(`The split position "${key}" must be a number of points from 0 to ${String(MAX_SPLIT_POINTS)}.`, "For example { split: { x: 100, y: 50 } }.");
@@ -11828,10 +11880,20 @@ var NewSheet = class {
 					const x = at("x");
 					const y = at("y");
 					if (x === 0 && y === 0) throw invalidOption("A split needs \"x\" or \"y\" greater than 0.", "For example { split: { y: 50 } }, or { split: null } to remove it.");
-					next.split = {
+					const corner = p.get("topLeftCell");
+					if (corner === void 0 || corner === null) next.split = {
 						x,
 						y
 					};
+					else {
+						const cell = typeof corner === "string" ? parseCellRef(corner.toUpperCase()) : null;
+						if (cell === null) throw invalidOption("The split option \"topLeftCell\" must be a cell reference such as \"F20\".", "For example { split: { x: 100, y: 50, topLeftCell: \"F20\" } }: the first column shown right of the vertical bar and the first row below the horizontal bar.");
+						next.split = {
+							x,
+							y,
+							topLeftCell: formatCellRef(cell.row, cell.col)
+						};
+					}
 					unfreeze = true;
 				}
 			}
@@ -12218,6 +12280,7 @@ var NewSheet = class {
 		return {
 			name: this.name,
 			state: this.state,
+			sheetId: this.sheetId,
 			cells: this.cellMap,
 			columns: this.columnMap,
 			rows: this.rowMap,
@@ -12690,11 +12753,12 @@ var NewWorkbook = class {
 	*
 	* const workbook = createWorkbook();
 	* workbook.addSheet('Data');
-	* workbook.addSheet('Lookup', { state: 'hidden' });
+	* workbook.addSheet('Lookup', { state: 'hidden', sheetId: 5 });
 	* ```
 	*/
 	addSheet(name, options) {
-		const state = readOptions$1(options, ["state"], "sheet options").get("state") ?? "visible";
+		const o = readOptions$1(options, ["state", "sheetId"], "sheet options");
+		const state = o.get("state") ?? "visible";
 		if (state !== "visible" && state !== "hidden" && state !== "veryHidden") throw invalidOption(`Sheet state ${JSON.stringify(String(state).slice(0, 40))} is not valid.`, "Use \"visible\", \"hidden\" or \"veryHidden\".");
 		const checked = checkSheetName(name);
 		const lower = checked.toLowerCase();
@@ -12706,7 +12770,18 @@ var NewWorkbook = class {
 				existing: existing.name
 			}
 		});
-		const sheet = new NewSheet(checked, state, this);
+		let sheetId = null;
+		if (o.has("sheetId")) {
+			const id = o.get("sheetId");
+			if (typeof id !== "number" || !Number.isInteger(id) || id < 1 || id > MAX_SHEET_ID) throw invalidOption(`The sheet option "sheetId" must be a whole number from 1 to ${String(MAX_SHEET_ID)}.`, "For example { sheetId: 3 }, or leave it out to take the lowest unused id.", { name: checked });
+			const owner = this.list.find((s) => s.sheetId === id);
+			if (owner) throw invalidOption(`Sheet "${owner.name}" already has the sheetId ${String(id)}.`, "Sheet ids must be unique in the workbook. Give another id, or leave it out to take the lowest unused id.", {
+				name: checked,
+				existing: owner.name
+			});
+			sheetId = id;
+		}
+		const sheet = new NewSheet(checked, state, this, sheetId);
 		this.list.push(sheet);
 		return sheet;
 	}
@@ -13001,4 +13076,4 @@ function openInput(input, limits, onWarning) {
 	if (onWarning !== void 0) for (const warning of workbook.warnings) onWarning(warning);
 	return workbook;
 }
-export { nameTitles as $, MAX_COLUMNS as $t, limitExceeded as A, mergeStyles as At, tokenize as B, hashPassword as Bt, Bytes as C, isXlvError as Cn, normalizeTable as Ct, TAIL_BYTES as D, parseStyles as Dt, NotLoaded as E, EMPTY_STYLES as Et, validateLocalHeaders as F, resolveLimits as Ft, buildStyles as G, MediaParts as Gt, SheetRels as H, verifyPassword as Ht, WarningCollector as I, suggest as It, createSharedStrings as J, metricsOf as Jt, cellXml as K, drawingParts as Kt, sheetNotFound as L, printNames as Lt, openZip as M, stableKey as Mt, readCentralDirectory as N, isDateFormat as Nt, checkSource as O, READING_ORDERS as Ot, unsupported as P, DEFAULT_READ_LIMITS as Pt, hyperlinksXml as Q, relationshipTypes as Qt, createWorksheetParser as R, printXml as Rt, workbookPartsToLoad as S, XlvError as Sn, TABLE_CONTENT_TYPE as St, HEAD_BYTES as T, checkUniqueName as Tt, attr as U, DRAWING_CONTENT_TYPE as Ut, DEFAULT_FONT as V, legacyPasswordHash as Vt, borderXml as W, IMAGE_CONTENT_TYPES as Wt, fontXml as X, SML_NS as Xt, fillXml as Y, resolveImage as Yt, formatNumber as Z, classifyRelationship as Zt, isoDate as _, encodeXstring as _n, parseSharedStrings as _t, DATE_FORMAT as a, parseRange as an, sheetRelsPartName as at, readWorkbook as b, ERROR_CODES as bn, partKey as bt, NewSheet as c, appPropertiesXml as cn, stringItemXml as ct, convertCellInput as d, childrenNamed as dn, workbookRelsXml as dt, MAX_ROWS as en, noteParts as et, createWorkbook as f, parseXmlTree as fn, workbookXml as ft, inspect as g, parseXml as gn, parseIsoDateTime as gt, detectHeader as h, normalizeLineEnds as hn, crc32 as ht, readOptions as i, parseCellRef as in, sheetHead as it, locateCentralDirectory as j, normalizeStyle as jt, corrupt as k, checkStyleCount as kt, NewWorkbook as l, corePropertiesXml as ln, tableParts as lt, writeWorkbook as m, decodeXml as mn, writeZip as mt, oneOfOption as n, formatCellRef as nn, rootRelsXml as nt, DATE_TIME_FORMAT as o, APP_PROPERTIES_PART as on, sheetRulesXml as ot, sortedNotes as p, createXmlByteStreamParser as pn, FormulaGroups as pt, contentTypesXml as q, imageFormat as qt, openInput as r, formatRange as rn, rowStart as rt, ERROR_VALUES as s, CORE_PROPERTIES_PART as sn, sheetTail as st, booleanOption as t, columnLetters as tn, reusableBuiltinNumFmt as tt, checkBookViews as u, childNamed as un, textElement as ut, analyzeWorkbook as v, escapeAttr as vn, openPackage as vt, CORRUPT_HINT as w, checkDefinedName as wt, toBytes as x, WARNING_CODES as xn, zipNameToPartName as xt, readNotes as y, escapeText as yn, relationshipsPartName as yt, shiftFormula as z, sheetProtectionXml as zt };
+export { fillXml as $, resolveImage as $t, limitExceeded as A, EMPTY_STYLES as At, tokenize as B, suggest as Bt, Bytes as C, escapeText as Cn, relationshipsPartName as Ct, TAIL_BYTES as D, isXlvError as Dn, normalizeTable as Dt, NotLoaded as E, XlvError as En, TABLE_CONTENT_TYPE as Et, validateLocalHeaders as F, normalizeStyle as Ft, DEFAULT_FONT as G, legacyPasswordHash as Gt, X14_DV_URI as H, printXml as Ht, WarningCollector as I, stableKey as It, borderXml as J, IMAGE_CONTENT_TYPES as Jt, SheetRels as K, verifyPassword as Kt, sheetNotFound as L, isDateFormat as Lt, openZip as M, READING_ORDERS as Mt, readCentralDirectory as N, checkStyleCount as Nt, checkSource as O, checkDefinedName as Ot, unsupported as P, mergeStyles as Pt, createSharedStrings as Q, metricsOf as Qt, createWorksheetParser as R, DEFAULT_READ_LIMITS as Rt, workbookPartsToLoad as S, escapeAttr as Sn, openPackage as St, HEAD_BYTES as T, WARNING_CODES as Tn, zipNameToPartName as Tt, X14_NS as U, sheetProtectionXml as Ut, X14_CF_URI as V, printNames as Vt, XM_NS as W, hashPassword as Wt, cellXml as X, drawingParts as Xt, buildStyles as Y, MediaParts as Yt, contentTypesXml as Z, imageFormat as Zt, isoDate as _, createXmlByteStreamParser as _n, FormulaGroups as _t, DATE_FORMAT as a, columnLetters as an, reusableBuiltinNumFmt as at, readWorkbook as b, parseXml as bn, parseIsoDateTime as bt, NewSheet as c, parseCellRef as cn, sheetHead as ct, convertCellInput as d, CORE_PROPERTIES_PART as dn, sheetTail as dt, SML_NS as en, fontXml as et, createWorkbook as f, appPropertiesXml as fn, stringItemXml as ft, inspect as g, parseXmlTree as gn, workbookXml as gt, detectHeader as h, childrenNamed as hn, workbookRelsXml as ht, readOptions as i, MAX_ROWS as in, noteParts as it, locateCentralDirectory as j, parseStyles as jt, corrupt as k, checkUniqueName as kt, NewWorkbook as l, parseRange as ln, sheetRelsPartName as lt, writeWorkbook as m, childNamed as mn, textElement as mt, oneOfOption as n, relationshipTypes as nn, hyperlinksXml as nt, DATE_TIME_FORMAT as o, formatCellRef as on, rootRelsXml as ot, sortedNotes as p, corePropertiesXml as pn, tableParts as pt, attr as q, DRAWING_CONTENT_TYPE as qt, openInput as r, MAX_COLUMNS as rn, nameTitles as rt, ERROR_VALUES as s, formatRange as sn, rowStart as st, booleanOption as t, classifyRelationship as tn, formatNumber as tt, checkBookViews as u, APP_PROPERTIES_PART as un, sheetRulesXml as ut, analyzeWorkbook as v, decodeXml as vn, writeZip as vt, CORRUPT_HINT as w, ERROR_CODES as wn, partKey as wt, toBytes as x, encodeXstring as xn, parseSharedStrings as xt, readNotes as y, normalizeLineEnds as yn, crc32 as yt, shiftFormula as z, resolveLimits as zt };