odf.js 1.12.0 → 1.13.0

package/dist/styles/registry.js

@@ -0,0 +1,209 @@
+import { el } from "../xml/fragment.js";
+import { encodeXmlText } from "../xml/entities.js";
+import { parseStyleElementProperties } from "./properties.js";
+import { buildStylePropertyElements, canonicalPropertiesString } from "./serialize.js";
+//#region src/styles/registry.ts
+const STYLE_FAMILIES = [
+	"paragraph",
+	"text",
+	"table",
+	"table-column",
+	"table-row",
+	"table-cell",
+	"graphic"
+];
+function isStyleFamily(value) {
+	return value === "paragraph" || value === "text" || value === "table" || value === "table-column" || value === "table-row" || value === "table-cell" || value === "graphic";
+}
+const CONTENT_PREFIXES = {
+	paragraph: "P",
+	text: "T",
+	table: "ta",
+	"table-column": "co",
+	"table-row": "ro",
+	"table-cell": "ce",
+	graphic: "fr"
+};
+const STYLES_PREFIXES = {
+	paragraph: "PS",
+	text: "TS",
+	table: "taS",
+	"table-column": "coS",
+	"table-row": "roS",
+	"table-cell": "ceS",
+	graphic: "frS"
+};
+function prefixesForPart(partPath) {
+	const baseName = partPath.slice(partPath.lastIndexOf("/") + 1);
+	if (baseName === "content.xml") return CONTENT_PREFIXES;
+	if (baseName === "styles.xml") return STYLES_PREFIXES;
+	throw new Error(`StyleRegistry.forPart: expected a part named "content.xml" or "styles.xml" (by base name), got "${partPath}"`);
+}
+function emptyFamilySets() {
+	return {
+		paragraph: /* @__PURE__ */ new Set(),
+		text: /* @__PURE__ */ new Set(),
+		table: /* @__PURE__ */ new Set(),
+		"table-column": /* @__PURE__ */ new Set(),
+		"table-row": /* @__PURE__ */ new Set(),
+		"table-cell": /* @__PURE__ */ new Set(),
+		graphic: /* @__PURE__ */ new Set()
+	};
+}
+function attrValue(element, name) {
+	return element.attributes.find((attribute) => attribute.name === name)?.value;
+}
+function findDirectChild(nodes, tag) {
+	for (const node of nodes) if (node.type === "element" && node.tag === tag) return node;
+}
+function findRootElement(nodes) {
+	const root = nodes.find((node) => node.type === "element");
+	if (root === void 0) throw new Error("StyleRegistry: part has no root XML element -- construct the part's minimal root (office:document-content/office:document-styles) before building a StyleRegistry for it");
+	return root;
+}
+function ensureAutomaticStyles(root) {
+	const existing = findDirectChild(root.children, "office:automatic-styles");
+	if (existing !== void 0) return existing;
+	const created = el("office:automatic-styles");
+	const insertBeforeTags = /* @__PURE__ */ new Set([
+		"office:body",
+		"office:master-styles",
+		"office:settings"
+	]);
+	const insertIndex = root.children.findIndex((node) => node.type === "element" && insertBeforeTags.has(node.tag));
+	if (insertIndex === -1) root.children.push(created);
+	else root.children.splice(insertIndex, 0, created);
+	return created;
+}
+function reserveStyleNames(container, reserved) {
+	for (const child of container.children) {
+		if (child.type !== "element" || child.tag !== "style:style") continue;
+		const name = attrValue(child, "style:name");
+		const family = attrValue(child, "style:family");
+		if (name === void 0 || family === void 0 || !isStyleFamily(family)) continue;
+		reserved[family].add(name);
+	}
+}
+const FINGERPRINT_SEPARATOR = "\0";
+const NO_PARENT_SENTINEL = "
";
+function computeFingerprint(family, properties, parentStyleName) {
+	const parentComponent = parentStyleName ?? NO_PARENT_SENTINEL;
+	return [
+		family,
+		canonicalPropertiesString(properties),
+		parentComponent
+	].join(FINGERPRINT_SEPARATOR);
+}
+var StyleRegistry = class StyleRegistry {
+	automaticStyles;
+	prefixes;
+	reservedByFamily;
+	knownStyles = /* @__PURE__ */ new Map();
+	fingerprintToName = /* @__PURE__ */ new Map();
+	nameToFingerprint = /* @__PURE__ */ new Map();
+	familyCounters = {
+		paragraph: 1,
+		text: 1,
+		table: 1,
+		"table-column": 1,
+		"table-row": 1,
+		"table-cell": 1,
+		graphic: 1
+	};
+	constructor(automaticStyles, prefixes, reservedByFamily) {
+		this.automaticStyles = automaticStyles;
+		this.prefixes = prefixes;
+		this.reservedByFamily = reservedByFamily;
+	}
+	static forPart(pkg, partPath, options = {}) {
+		const part = pkg.parts[partPath];
+		if (part?.kind !== "xml") throw new Error(`StyleRegistry.forPart: "${partPath}" is not an XML part of the given package`);
+		const prefixes = prefixesForPart(partPath);
+		const root = findRootElement(part.nodes);
+		const automaticStyles = ensureAutomaticStyles(root);
+		const reservedByFamily = emptyFamilySets();
+		const registry = new StyleRegistry(automaticStyles, prefixes, reservedByFamily);
+		for (const child of automaticStyles.children) {
+			if (child.type !== "element" || child.tag !== "style:style") continue;
+			const name = attrValue(child, "style:name");
+			const family = attrValue(child, "style:family");
+			if (name === void 0 || family === void 0 || !isStyleFamily(family)) continue;
+			registry.knownStyles.set(name, child);
+			reservedByFamily[family].add(name);
+			const parsed = parseStyleElementProperties(child);
+			if (!parsed.hasUnknown) {
+				const parentStyleName = attrValue(child, "style:parent-style-name");
+				const fingerprint = computeFingerprint(family, parsed.properties, parentStyleName);
+				if (!registry.fingerprintToName.has(fingerprint)) {
+					registry.fingerprintToName.set(fingerprint, name);
+					registry.nameToFingerprint.set(name, fingerprint);
+				}
+			}
+		}
+		const ownStyles = findDirectChild(root.children, "office:styles");
+		if (ownStyles !== void 0) reserveStyleNames(ownStyles, reservedByFamily);
+		if (options.otherPart !== void 0) {
+			const otherPart = options.otherPart.pkg.parts[options.otherPart.partPath];
+			if (otherPart?.kind === "xml") {
+				const otherRoot = findRootElement(otherPart.nodes);
+				const otherAutomatic = findDirectChild(otherRoot.children, "office:automatic-styles");
+				if (otherAutomatic !== void 0) reserveStyleNames(otherAutomatic, reservedByFamily);
+				const otherStyles = findDirectChild(otherRoot.children, "office:styles");
+				if (otherStyles !== void 0) reserveStyleNames(otherStyles, reservedByFamily);
+			}
+		}
+		if (options.additionalReservedNames !== void 0) for (const family of STYLE_FAMILIES) for (const name of options.additionalReservedNames) reservedByFamily[family].add(name);
+		return registry;
+	}
+	fingerprint(request) {
+		return computeFingerprint(request.family, request.properties, request.parentStyleName);
+	}
+	intern(request) {
+		const fingerprint = this.fingerprint(request);
+		const existingName = this.fingerprintToName.get(fingerprint);
+		if (existingName !== void 0) return existingName;
+		const name = this.mintName(request.family);
+		const attributes = {
+			"style:name": name,
+			"style:family": request.family
+		};
+		if (request.parentStyleName !== void 0) attributes["style:parent-style-name"] = encodeXmlText(request.parentStyleName);
+		const styleElement = el("style:style", attributes, buildStylePropertyElements(request.properties));
+		this.automaticStyles.children.push(styleElement);
+		this.knownStyles.set(name, styleElement);
+		this.reservedByFamily[request.family].add(name);
+		this.fingerprintToName.set(fingerprint, name);
+		this.nameToFingerprint.set(name, fingerprint);
+		return name;
+	}
+	mintName(family) {
+		const prefix = this.prefixes[family];
+		const reserved = this.reservedByFamily[family];
+		let counter = this.familyCounters[family];
+		while (reserved.has(`${prefix}${counter}`)) counter += 1;
+		const name = `${prefix}${counter}`;
+		this.familyCounters[family] = counter + 1;
+		return name;
+	}
+	names() {
+		return [...this.knownStyles.keys()];
+	}
+	gc(referenced) {
+		let removed = 0;
+		for (const [name, element] of [...this.knownStyles]) {
+			if (referenced.has(name)) continue;
+			const index = this.automaticStyles.children.indexOf(element);
+			if (index !== -1) this.automaticStyles.children.splice(index, 1);
+			this.knownStyles.delete(name);
+			const fingerprint = this.nameToFingerprint.get(name);
+			if (fingerprint !== void 0) {
+				this.fingerprintToName.delete(fingerprint);
+				this.nameToFingerprint.delete(name);
+			}
+			removed += 1;
+		}
+		return removed;
+	}
+};
+//#endregion
+export { STYLE_FAMILIES, StyleRegistry, isStyleFamily };

package/dist/styles/serialize.cjs

@@ -0,0 +1,23 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_xml_fragment = require("../xml/fragment.cjs");
+const require_styles_properties = require("./properties.cjs");
+//#region src/styles/serialize.ts
+function attributesToRecord(attributes) {
+	const record = {};
+	for (const attribute of attributes) record[attribute.name] = attribute.value;
+	return record;
+}
+function buildStylePropertyElements(properties) {
+	const elements = [];
+	const paragraphAttributes = require_styles_properties.paragraphPropertiesToAttributes(properties);
+	if (paragraphAttributes.length > 0) elements.push(require_xml_fragment.el("style:paragraph-properties", attributesToRecord(paragraphAttributes)));
+	const textAttributes = require_styles_properties.textPropertiesToAttributes(properties);
+	if (textAttributes.length > 0) elements.push(require_xml_fragment.el("style:text-properties", attributesToRecord(textAttributes)));
+	return elements;
+}
+function canonicalPropertiesString(properties) {
+	return [...require_styles_properties.paragraphPropertiesToAttributes(properties), ...require_styles_properties.textPropertiesToAttributes(properties)].map((attribute) => `${attribute.name}=${attribute.value}`).join("|");
+}
+//#endregion
+exports.buildStylePropertyElements = buildStylePropertyElements;
+exports.canonicalPropertiesString = canonicalPropertiesString;

package/dist/styles/serialize.d.cts

@@ -0,0 +1,7 @@
+import { l as XmlElement } from "../node-CkBWRjNR.cjs";
+import { StyleProperties } from "./properties.cjs";
+//#region src/styles/serialize.d.ts
+declare function buildStylePropertyElements(properties: StyleProperties): XmlElement[];
+declare function canonicalPropertiesString(properties: StyleProperties): string;
+//#endregion
+export { buildStylePropertyElements, canonicalPropertiesString };

package/dist/styles/serialize.d.ts

@@ -0,0 +1,7 @@
+import { l as XmlElement } from "../node-CkBWRjNR.js";
+import { StyleProperties } from "./properties.js";
+//#region src/styles/serialize.d.ts
+declare function buildStylePropertyElements(properties: StyleProperties): XmlElement[];
+declare function canonicalPropertiesString(properties: StyleProperties): string;
+//#endregion
+export { buildStylePropertyElements, canonicalPropertiesString };

package/dist/styles/serialize.js

@@ -0,0 +1,21 @@
+import { el } from "../xml/fragment.js";
+import { paragraphPropertiesToAttributes, textPropertiesToAttributes } from "./properties.js";
+//#region src/styles/serialize.ts
+function attributesToRecord(attributes) {
+	const record = {};
+	for (const attribute of attributes) record[attribute.name] = attribute.value;
+	return record;
+}
+function buildStylePropertyElements(properties) {
+	const elements = [];
+	const paragraphAttributes = paragraphPropertiesToAttributes(properties);
+	if (paragraphAttributes.length > 0) elements.push(el("style:paragraph-properties", attributesToRecord(paragraphAttributes)));
+	const textAttributes = textPropertiesToAttributes(properties);
+	if (textAttributes.length > 0) elements.push(el("style:text-properties", attributesToRecord(textAttributes)));
+	return elements;
+}
+function canonicalPropertiesString(properties) {
+	return [...paragraphPropertiesToAttributes(properties), ...textPropertiesToAttributes(properties)].map((attribute) => `${attribute.name}=${attribute.value}`).join("|");
+}
+//#endregion
+export { buildStylePropertyElements, canonicalPropertiesString };

package/dist/styles/span.cjs

@@ -0,0 +1,114 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_xml_fragment = require("../xml/fragment.cjs");
+const require_xml_entities = require("../xml/entities.cjs");
+const require_typed_shared_text = require("../typed/shared/text.cjs");
+//#region src/styles/span.ts
+function ensureSpan(paragraph, start, end, styleName) {
+	if (!Number.isInteger(start) || !Number.isInteger(end) || start < 0 || end < start) throw new Error(`ensureSpan: invalid range [${start}, ${end})`);
+	const total = require_typed_shared_text.sumOdfNodeLength(paragraph.children);
+	if (end > total) throw new Error(`ensureSpan: range end ${end} exceeds the container's total character length ${total}`);
+	const { before, after: rest } = splitChildrenAt(paragraph.children, start);
+	const { before: middle, after } = splitChildrenAt(rest, end - start);
+	let span;
+	const soleChild = middle.length === 1 ? middle[0] : void 0;
+	if (soleChild?.type === "element" && soleChild.tag === "text:span") {
+		span = soleChild;
+		setStyleName(span, styleName);
+	} else span = require_xml_fragment.el("text:span", { "text:style-name": require_xml_entities.encodeXmlText(styleName) }, middle);
+	paragraph.children = [
+		...before,
+		span,
+		...after
+	];
+	return span;
+}
+function cloneAttributes(attributes) {
+	return attributes.map((attribute) => ({ ...attribute }));
+}
+function setStyleName(span, styleName) {
+	const encoded = require_xml_entities.encodeXmlText(styleName);
+	const existing = span.attributes.find((attribute) => attribute.name === "text:style-name");
+	if (existing !== void 0) {
+		existing.value = encoded;
+		return;
+	}
+	span.attributes.push({
+		name: "text:style-name",
+		value: encoded
+	});
+}
+function buildSpaceRun(count) {
+	return count === 1 ? require_xml_fragment.el("text:s") : require_xml_fragment.el("text:s", { "text:c": String(count) });
+}
+function splitNode(node, offset) {
+	if (node.type === "text") return {
+		left: {
+			type: "text",
+			value: node.value.slice(0, offset)
+		},
+		right: {
+			type: "text",
+			value: node.value.slice(offset)
+		}
+	};
+	if (node.type === "element" && node.tag === "text:s") {
+		const count = require_typed_shared_text.getOdfSpaceCount(node);
+		return {
+			left: buildSpaceRun(offset),
+			right: buildSpaceRun(count - offset)
+		};
+	}
+	if (node.type === "element" && node.tag === "text:span") {
+		const inner = splitChildrenAt(node.children, offset);
+		return {
+			left: inner.before.length === 0 ? void 0 : {
+				...node,
+				attributes: cloneAttributes(node.attributes),
+				children: inner.before
+			},
+			right: inner.after.length === 0 ? void 0 : {
+				...node,
+				attributes: cloneAttributes(node.attributes),
+				children: inner.after
+			}
+		};
+	}
+	const label = node.type === "element" ? node.tag : node.type;
+	throw new Error(`ensureSpan: cannot split "${label}" at a fractional offset -- this indicates a character-length computation bug, since every node type with length 1 or 0 should never reach this branch`);
+}
+function splitChildrenAt(children, offset) {
+	if (offset <= 0) return {
+		before: [],
+		after: [...children]
+	};
+	const before = [];
+	let remaining = offset;
+	for (let index = 0; index < children.length; index += 1) {
+		if (remaining === 0) return {
+			before,
+			after: children.slice(index)
+		};
+		const node = children[index];
+		const length = require_typed_shared_text.measureOdfNodeLength(node);
+		if (remaining >= length) {
+			before.push(node);
+			remaining -= length;
+			continue;
+		}
+		const { left, right } = splitNode(node, remaining);
+		const after = [];
+		if (left !== void 0) before.push(left);
+		if (right !== void 0) after.push(right);
+		after.push(...children.slice(index + 1));
+		return {
+			before,
+			after
+		};
+	}
+	return {
+		before,
+		after: []
+	};
+}
+//#endregion
+exports.ensureSpan = ensureSpan;

package/dist/styles/span.d.cts

@@ -0,0 +1,5 @@
+import { l as XmlElement } from "../node-CkBWRjNR.cjs";
+//#region src/styles/span.d.ts
+declare function ensureSpan(paragraph: XmlElement, start: number, end: number, styleName: string): XmlElement;
+//#endregion
+export { ensureSpan };

package/dist/styles/span.d.ts

@@ -0,0 +1,5 @@
+import { l as XmlElement } from "../node-CkBWRjNR.js";
+//#region src/styles/span.d.ts
+declare function ensureSpan(paragraph: XmlElement, start: number, end: number, styleName: string): XmlElement;
+//#endregion
+export { ensureSpan };

package/dist/styles/span.js

@@ -0,0 +1,113 @@
+import { el } from "../xml/fragment.js";
+import { encodeXmlText } from "../xml/entities.js";
+import { getOdfSpaceCount, measureOdfNodeLength, sumOdfNodeLength } from "../typed/shared/text.js";
+//#region src/styles/span.ts
+function ensureSpan(paragraph, start, end, styleName) {
+	if (!Number.isInteger(start) || !Number.isInteger(end) || start < 0 || end < start) throw new Error(`ensureSpan: invalid range [${start}, ${end})`);
+	const total = sumOdfNodeLength(paragraph.children);
+	if (end > total) throw new Error(`ensureSpan: range end ${end} exceeds the container's total character length ${total}`);
+	const { before, after: rest } = splitChildrenAt(paragraph.children, start);
+	const { before: middle, after } = splitChildrenAt(rest, end - start);
+	let span;
+	const soleChild = middle.length === 1 ? middle[0] : void 0;
+	if (soleChild?.type === "element" && soleChild.tag === "text:span") {
+		span = soleChild;
+		setStyleName(span, styleName);
+	} else span = el("text:span", { "text:style-name": encodeXmlText(styleName) }, middle);
+	paragraph.children = [
+		...before,
+		span,
+		...after
+	];
+	return span;
+}
+function cloneAttributes(attributes) {
+	return attributes.map((attribute) => ({ ...attribute }));
+}
+function setStyleName(span, styleName) {
+	const encoded = encodeXmlText(styleName);
+	const existing = span.attributes.find((attribute) => attribute.name === "text:style-name");
+	if (existing !== void 0) {
+		existing.value = encoded;
+		return;
+	}
+	span.attributes.push({
+		name: "text:style-name",
+		value: encoded
+	});
+}
+function buildSpaceRun(count) {
+	return count === 1 ? el("text:s") : el("text:s", { "text:c": String(count) });
+}
+function splitNode(node, offset) {
+	if (node.type === "text") return {
+		left: {
+			type: "text",
+			value: node.value.slice(0, offset)
+		},
+		right: {
+			type: "text",
+			value: node.value.slice(offset)
+		}
+	};
+	if (node.type === "element" && node.tag === "text:s") {
+		const count = getOdfSpaceCount(node);
+		return {
+			left: buildSpaceRun(offset),
+			right: buildSpaceRun(count - offset)
+		};
+	}
+	if (node.type === "element" && node.tag === "text:span") {
+		const inner = splitChildrenAt(node.children, offset);
+		return {
+			left: inner.before.length === 0 ? void 0 : {
+				...node,
+				attributes: cloneAttributes(node.attributes),
+				children: inner.before
+			},
+			right: inner.after.length === 0 ? void 0 : {
+				...node,
+				attributes: cloneAttributes(node.attributes),
+				children: inner.after
+			}
+		};
+	}
+	const label = node.type === "element" ? node.tag : node.type;
+	throw new Error(`ensureSpan: cannot split "${label}" at a fractional offset -- this indicates a character-length computation bug, since every node type with length 1 or 0 should never reach this branch`);
+}
+function splitChildrenAt(children, offset) {
+	if (offset <= 0) return {
+		before: [],
+		after: [...children]
+	};
+	const before = [];
+	let remaining = offset;
+	for (let index = 0; index < children.length; index += 1) {
+		if (remaining === 0) return {
+			before,
+			after: children.slice(index)
+		};
+		const node = children[index];
+		const length = measureOdfNodeLength(node);
+		if (remaining >= length) {
+			before.push(node);
+			remaining -= length;
+			continue;
+		}
+		const { left, right } = splitNode(node, remaining);
+		const after = [];
+		if (left !== void 0) before.push(left);
+		if (right !== void 0) after.push(right);
+		after.push(...children.slice(index + 1));
+		return {
+			before,
+			after
+		};
+	}
+	return {
+		before,
+		after: []
+	};
+}
+//#endregion
+export { ensureSpan };