ooxml.js 3.0.1 → 3.1.1

package/dist/typed/docx/constructs.cjs

@@ -0,0 +1,211 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_typed_util = require("../util.cjs");
+//#region src/typed/docx/constructs.ts
+const NON_CONTENT_PARAGRAPH_CHILDREN = /* @__PURE__ */ new Set([
+	"w:pPr",
+	"w:bookmarkStart",
+	"w:bookmarkEnd",
+	"w:commentRangeStart",
+	"w:commentRangeEnd",
+	"w:proofErr",
+	"w:permStart",
+	"w:permEnd",
+	"w:moveFromRangeStart",
+	"w:moveFromRangeEnd",
+	"w:moveToRangeStart",
+	"w:moveToRangeEnd"
+]);
+const INERT_RUN_CHILDREN = /* @__PURE__ */ new Set(["w:rPr", "w:lastRenderedPageBreak"]);
+function isContentBearingChild(child) {
+	if (NON_CONTENT_PARAGRAPH_CHILDREN.has(child.tag)) return false;
+	if (child.tag !== "w:r") return true;
+	return child.children.some((grandChild) => grandChild.type === "element" && !INERT_RUN_CHILDREN.has(grandChild.tag));
+}
+function indexParagraphContent(paragraph) {
+	const elements = [];
+	for (const child of paragraph.children) if (child.type === "element") elements.push(child);
+	let firstContentIndex = -1;
+	let lastContentIndex = -1;
+	elements.forEach((element, index) => {
+		if (!isContentBearingChild(element)) return;
+		if (firstContentIndex === -1) firstContentIndex = index;
+		lastContentIndex = index;
+	});
+	return {
+		elements,
+		firstContentIndex,
+		lastContentIndex
+	};
+}
+function contentBearingChildren(index) {
+	return index.elements.filter(isContentBearingChild);
+}
+function compareExtents(a, b) {
+	return a.startIndex - b.startIndex || b.endIndex - a.endIndex || a.order - b.order;
+}
+function acceptProperlyNested(extents) {
+	const sorted = [...extents].sort(compareExtents);
+	const accepted = [];
+	const open = [];
+	for (const extent of sorted) {
+		while (open.length > 0 && open[open.length - 1].endIndex <= extent.startIndex) open.pop();
+		const enclosing = open[open.length - 1];
+		if (enclosing !== void 0 && enclosing.endIndex < extent.endIndex) continue;
+		accepted.push(extent);
+		open.push(extent);
+	}
+	return accepted;
+}
+function insertConstructMarkers(blocks, extents) {
+	if (extents.length === 0) return [...blocks];
+	const nested = acceptProperlyNested(extents);
+	const openingAt = /* @__PURE__ */ new Map();
+	for (const extent of nested) {
+		const existing = openingAt.get(extent.startIndex);
+		if (existing === void 0) openingAt.set(extent.startIndex, [extent]);
+		else existing.push(extent);
+	}
+	const out = [];
+	const open = [];
+	for (let index = 0; index <= blocks.length; index++) {
+		while (open.length > 0 && open[open.length - 1].endIndex === index) {
+			open.pop();
+			out.push({ kind: "constructEnd" });
+		}
+		for (const extent of openingAt.get(index) ?? []) {
+			out.push({
+				kind: "constructStart",
+				descriptor: extent.descriptor
+			});
+			if (extent.endIndex === index) out.push({ kind: "constructEnd" });
+			else open.push(extent);
+		}
+		const block = blocks[index];
+		if (block !== void 0) out.push(block);
+	}
+	return out;
+}
+const CONTROL_TYPE_BY_TAG = /* @__PURE__ */ new Map([
+	["w:richText", "richText"],
+	["w:text", "plainText"],
+	["w:comboBox", "comboBox"],
+	["w:dropDownList", "dropDown"],
+	["w:date", "date"],
+	["w:picture", "picture"],
+	["w:group", "group"],
+	["w:checkbox", "checkbox"],
+	["w14:checkbox", "checkbox"],
+	["w:repeatingSection", "repeatingSection"],
+	["w15:repeatingSection", "repeatingSection"]
+]);
+const LOCK_BY_VALUE = /* @__PURE__ */ new Map([
+	["contentLocked", "content"],
+	["sdtLocked", "container"],
+	["sdtContentLocked", "both"]
+]);
+const TABLE_OF_CONTENTS_GALLERY = "Table of Contents";
+function readControlType(sdtPr) {
+	if (sdtPr === void 0) return "richText";
+	for (const child of sdtPr.children) {
+		if (child.type !== "element") continue;
+		const mapped = CONTROL_TYPE_BY_TAG.get(child.tag);
+		if (mapped !== void 0) return mapped;
+		if (child.tag === "w:docPartObj" || child.tag === "w:docPartList") {
+			const gallery = require_typed_util.childrenWithTag(child, "w:docPartGallery")[0];
+			return (gallery === void 0 ? void 0 : require_typed_util.attr(gallery, "w:val")) === "Table of Contents" ? "index" : "richText";
+		}
+	}
+	return "richText";
+}
+function readListItemOptions(sdtPr) {
+	const list = require_typed_util.childrenWithTag(sdtPr, "w:dropDownList")[0] ?? require_typed_util.childrenWithTag(sdtPr, "w:comboBox")[0];
+	if (list === void 0) return;
+	const options = [];
+	for (const item of require_typed_util.childrenWithTag(list, "w:listItem")) {
+		const value = require_typed_util.attr(item, "w:displayText") ?? require_typed_util.attr(item, "w:value");
+		if (value !== void 0) options.push(require_typed_util.decodeEntities(value));
+	}
+	return options.length === 0 ? void 0 : options;
+}
+function readCheckboxState(sdtPr) {
+	const checkbox = require_typed_util.childrenWithTag(sdtPr, "w14:checkbox")[0] ?? require_typed_util.childrenWithTag(sdtPr, "w:checkbox")[0];
+	if (checkbox === void 0) return;
+	const checked = require_typed_util.childrenWithTag(checkbox, "w14:checked")[0] ?? require_typed_util.childrenWithTag(checkbox, "w:checked")[0];
+	if (checked === void 0) return false;
+	const val = require_typed_util.attr(checked, "w14:val") ?? require_typed_util.attr(checked, "w:val");
+	return val === void 0 || val !== "0" && val !== "false" && val !== "off";
+}
+function readContentControlDescriptor(sdt) {
+	const sdtPr = require_typed_util.childrenWithTag(sdt, "w:sdtPr")[0];
+	const descriptor = {
+		kind: "contentControl",
+		controlType: readControlType(sdtPr)
+	};
+	if (sdtPr === void 0) return descriptor;
+	const tag = require_typed_util.childrenWithTag(sdtPr, "w:tag")[0];
+	const tagVal = tag === void 0 ? void 0 : require_typed_util.attr(tag, "w:val");
+	if (tagVal !== void 0) descriptor.tag = require_typed_util.decodeEntities(tagVal);
+	const alias = require_typed_util.childrenWithTag(sdtPr, "w:alias")[0];
+	const aliasVal = alias === void 0 ? void 0 : require_typed_util.attr(alias, "w:val");
+	if (aliasVal !== void 0) descriptor.alias = require_typed_util.decodeEntities(aliasVal);
+	const lock = require_typed_util.childrenWithTag(sdtPr, "w:lock")[0];
+	const lockVal = lock === void 0 ? void 0 : require_typed_util.attr(lock, "w:val");
+	const mappedLock = lockVal === void 0 ? void 0 : LOCK_BY_VALUE.get(lockVal);
+	if (mappedLock !== void 0) descriptor.lock = mappedLock;
+	const options = readListItemOptions(sdtPr);
+	if (options !== void 0) descriptor.options = options;
+	const checked = readCheckboxState(sdtPr);
+	if (checked !== void 0) descriptor.checked = checked;
+	const date = require_typed_util.childrenWithTag(sdtPr, "w:date")[0];
+	const fullDate = date === void 0 ? void 0 : require_typed_util.attr(date, "w:fullDate");
+	if (fullDate !== void 0) descriptor.value = require_typed_util.decodeEntities(fullDate);
+	return descriptor;
+}
+const PROVENANCE_CHANGE_BY_TAG = /* @__PURE__ */ new Map([
+	["w:ins", "insertion"],
+	["w:del", "deletion"],
+	["w:moveFrom", "moveFrom"],
+	["w:moveTo", "moveTo"]
+]);
+function isDeletedChange(change) {
+	return change === "deletion" || change === "moveFrom";
+}
+function readProvenanceDescriptor(element, change) {
+	const descriptor = {
+		kind: "provenance",
+		change
+	};
+	const author = require_typed_util.attr(element, "w:author");
+	if (author !== void 0) descriptor.author = require_typed_util.decodeEntities(author);
+	const date = require_typed_util.attr(element, "w:date");
+	if (date !== void 0) descriptor.dateIso = require_typed_util.decodeEntities(date);
+	return descriptor;
+}
+function bookmarkAnchorDescriptor(name) {
+	return {
+		kind: "anchor",
+		anchorType: "bookmark",
+		name
+	};
+}
+function runInstructionText(run) {
+	let text = "";
+	for (const child of run.children) if (child.type === "element" && (child.tag === "w:instrText" || child.tag === "w:delInstrText")) text += require_typed_util.textContent(child);
+	return text;
+}
+function fieldCharType(run) {
+	const fldChar = require_typed_util.childrenWithTag(run, "w:fldChar")[0];
+	return fldChar === void 0 ? void 0 : require_typed_util.attr(fldChar, "w:fldCharType");
+}
+//#endregion
+exports.PROVENANCE_CHANGE_BY_TAG = PROVENANCE_CHANGE_BY_TAG;
+exports.TABLE_OF_CONTENTS_GALLERY = TABLE_OF_CONTENTS_GALLERY;
+exports.bookmarkAnchorDescriptor = bookmarkAnchorDescriptor;
+exports.contentBearingChildren = contentBearingChildren;
+exports.fieldCharType = fieldCharType;
+exports.indexParagraphContent = indexParagraphContent;
+exports.insertConstructMarkers = insertConstructMarkers;
+exports.isDeletedChange = isDeletedChange;
+exports.readContentControlDescriptor = readContentControlDescriptor;
+exports.readProvenanceDescriptor = readProvenanceDescriptor;
+exports.runInstructionText = runInstructionText;

package/dist/typed/docx/constructs.d.cts

@@ -0,0 +1,27 @@
+import { l as XmlElement } from "../../node-CkBWRjNR.cjs";
+import { AnchorDescriptor, ConstructDescriptor, ContentBlock, ContentControlDescriptor, ProvenanceChange, ProvenanceDescriptor } from "document-schema.js";
+//#region src/typed/docx/constructs.d.ts
+interface ParagraphContentIndex {
+  readonly elements: readonly XmlElement[];
+  readonly firstContentIndex: number;
+  readonly lastContentIndex: number;
+}
+declare function indexParagraphContent(paragraph: XmlElement): ParagraphContentIndex;
+declare function contentBearingChildren(index: ParagraphContentIndex): XmlElement[];
+interface ConstructExtent {
+  readonly startIndex: number;
+  readonly endIndex: number;
+  readonly order: number;
+  readonly descriptor: ConstructDescriptor;
+}
+declare function insertConstructMarkers(blocks: readonly ContentBlock[], extents: readonly ConstructExtent[]): ContentBlock[];
+declare const TABLE_OF_CONTENTS_GALLERY = "Table of Contents";
+declare function readContentControlDescriptor(sdt: XmlElement): ContentControlDescriptor;
+declare const PROVENANCE_CHANGE_BY_TAG: ReadonlyMap<string, ProvenanceChange>;
+declare function isDeletedChange(change: ProvenanceChange): boolean;
+declare function readProvenanceDescriptor(element: XmlElement, change: ProvenanceChange): ProvenanceDescriptor;
+declare function bookmarkAnchorDescriptor(name: string): AnchorDescriptor;
+declare function runInstructionText(run: XmlElement): string;
+declare function fieldCharType(run: XmlElement): string | undefined;
+//#endregion
+export { ConstructExtent, PROVENANCE_CHANGE_BY_TAG, ParagraphContentIndex, TABLE_OF_CONTENTS_GALLERY, bookmarkAnchorDescriptor, contentBearingChildren, fieldCharType, indexParagraphContent, insertConstructMarkers, isDeletedChange, readContentControlDescriptor, readProvenanceDescriptor, runInstructionText };

package/dist/typed/docx/constructs.d.ts

@@ -0,0 +1,27 @@
+import { l as XmlElement } from "../../node-CkBWRjNR.js";
+import { AnchorDescriptor, ConstructDescriptor, ContentBlock, ContentControlDescriptor, ProvenanceChange, ProvenanceDescriptor } from "document-schema.js";
+//#region src/typed/docx/constructs.d.ts
+interface ParagraphContentIndex {
+  readonly elements: readonly XmlElement[];
+  readonly firstContentIndex: number;
+  readonly lastContentIndex: number;
+}
+declare function indexParagraphContent(paragraph: XmlElement): ParagraphContentIndex;
+declare function contentBearingChildren(index: ParagraphContentIndex): XmlElement[];
+interface ConstructExtent {
+  readonly startIndex: number;
+  readonly endIndex: number;
+  readonly order: number;
+  readonly descriptor: ConstructDescriptor;
+}
+declare function insertConstructMarkers(blocks: readonly ContentBlock[], extents: readonly ConstructExtent[]): ContentBlock[];
+declare const TABLE_OF_CONTENTS_GALLERY = "Table of Contents";
+declare function readContentControlDescriptor(sdt: XmlElement): ContentControlDescriptor;
+declare const PROVENANCE_CHANGE_BY_TAG: ReadonlyMap<string, ProvenanceChange>;
+declare function isDeletedChange(change: ProvenanceChange): boolean;
+declare function readProvenanceDescriptor(element: XmlElement, change: ProvenanceChange): ProvenanceDescriptor;
+declare function bookmarkAnchorDescriptor(name: string): AnchorDescriptor;
+declare function runInstructionText(run: XmlElement): string;
+declare function fieldCharType(run: XmlElement): string | undefined;
+//#endregion
+export { ConstructExtent, PROVENANCE_CHANGE_BY_TAG, ParagraphContentIndex, TABLE_OF_CONTENTS_GALLERY, bookmarkAnchorDescriptor, contentBearingChildren, fieldCharType, indexParagraphContent, insertConstructMarkers, isDeletedChange, readContentControlDescriptor, readProvenanceDescriptor, runInstructionText };

package/dist/typed/docx/constructs.js

@@ -0,0 +1,200 @@
+import { attr, childrenWithTag, decodeEntities, textContent } from "../util.js";
+//#region src/typed/docx/constructs.ts
+const NON_CONTENT_PARAGRAPH_CHILDREN = /* @__PURE__ */ new Set([
+	"w:pPr",
+	"w:bookmarkStart",
+	"w:bookmarkEnd",
+	"w:commentRangeStart",
+	"w:commentRangeEnd",
+	"w:proofErr",
+	"w:permStart",
+	"w:permEnd",
+	"w:moveFromRangeStart",
+	"w:moveFromRangeEnd",
+	"w:moveToRangeStart",
+	"w:moveToRangeEnd"
+]);
+const INERT_RUN_CHILDREN = /* @__PURE__ */ new Set(["w:rPr", "w:lastRenderedPageBreak"]);
+function isContentBearingChild(child) {
+	if (NON_CONTENT_PARAGRAPH_CHILDREN.has(child.tag)) return false;
+	if (child.tag !== "w:r") return true;
+	return child.children.some((grandChild) => grandChild.type === "element" && !INERT_RUN_CHILDREN.has(grandChild.tag));
+}
+function indexParagraphContent(paragraph) {
+	const elements = [];
+	for (const child of paragraph.children) if (child.type === "element") elements.push(child);
+	let firstContentIndex = -1;
+	let lastContentIndex = -1;
+	elements.forEach((element, index) => {
+		if (!isContentBearingChild(element)) return;
+		if (firstContentIndex === -1) firstContentIndex = index;
+		lastContentIndex = index;
+	});
+	return {
+		elements,
+		firstContentIndex,
+		lastContentIndex
+	};
+}
+function contentBearingChildren(index) {
+	return index.elements.filter(isContentBearingChild);
+}
+function compareExtents(a, b) {
+	return a.startIndex - b.startIndex || b.endIndex - a.endIndex || a.order - b.order;
+}
+function acceptProperlyNested(extents) {
+	const sorted = [...extents].sort(compareExtents);
+	const accepted = [];
+	const open = [];
+	for (const extent of sorted) {
+		while (open.length > 0 && open[open.length - 1].endIndex <= extent.startIndex) open.pop();
+		const enclosing = open[open.length - 1];
+		if (enclosing !== void 0 && enclosing.endIndex < extent.endIndex) continue;
+		accepted.push(extent);
+		open.push(extent);
+	}
+	return accepted;
+}
+function insertConstructMarkers(blocks, extents) {
+	if (extents.length === 0) return [...blocks];
+	const nested = acceptProperlyNested(extents);
+	const openingAt = /* @__PURE__ */ new Map();
+	for (const extent of nested) {
+		const existing = openingAt.get(extent.startIndex);
+		if (existing === void 0) openingAt.set(extent.startIndex, [extent]);
+		else existing.push(extent);
+	}
+	const out = [];
+	const open = [];
+	for (let index = 0; index <= blocks.length; index++) {
+		while (open.length > 0 && open[open.length - 1].endIndex === index) {
+			open.pop();
+			out.push({ kind: "constructEnd" });
+		}
+		for (const extent of openingAt.get(index) ?? []) {
+			out.push({
+				kind: "constructStart",
+				descriptor: extent.descriptor
+			});
+			if (extent.endIndex === index) out.push({ kind: "constructEnd" });
+			else open.push(extent);
+		}
+		const block = blocks[index];
+		if (block !== void 0) out.push(block);
+	}
+	return out;
+}
+const CONTROL_TYPE_BY_TAG = /* @__PURE__ */ new Map([
+	["w:richText", "richText"],
+	["w:text", "plainText"],
+	["w:comboBox", "comboBox"],
+	["w:dropDownList", "dropDown"],
+	["w:date", "date"],
+	["w:picture", "picture"],
+	["w:group", "group"],
+	["w:checkbox", "checkbox"],
+	["w14:checkbox", "checkbox"],
+	["w:repeatingSection", "repeatingSection"],
+	["w15:repeatingSection", "repeatingSection"]
+]);
+const LOCK_BY_VALUE = /* @__PURE__ */ new Map([
+	["contentLocked", "content"],
+	["sdtLocked", "container"],
+	["sdtContentLocked", "both"]
+]);
+const TABLE_OF_CONTENTS_GALLERY = "Table of Contents";
+function readControlType(sdtPr) {
+	if (sdtPr === void 0) return "richText";
+	for (const child of sdtPr.children) {
+		if (child.type !== "element") continue;
+		const mapped = CONTROL_TYPE_BY_TAG.get(child.tag);
+		if (mapped !== void 0) return mapped;
+		if (child.tag === "w:docPartObj" || child.tag === "w:docPartList") {
+			const gallery = childrenWithTag(child, "w:docPartGallery")[0];
+			return (gallery === void 0 ? void 0 : attr(gallery, "w:val")) === "Table of Contents" ? "index" : "richText";
+		}
+	}
+	return "richText";
+}
+function readListItemOptions(sdtPr) {
+	const list = childrenWithTag(sdtPr, "w:dropDownList")[0] ?? childrenWithTag(sdtPr, "w:comboBox")[0];
+	if (list === void 0) return;
+	const options = [];
+	for (const item of childrenWithTag(list, "w:listItem")) {
+		const value = attr(item, "w:displayText") ?? attr(item, "w:value");
+		if (value !== void 0) options.push(decodeEntities(value));
+	}
+	return options.length === 0 ? void 0 : options;
+}
+function readCheckboxState(sdtPr) {
+	const checkbox = childrenWithTag(sdtPr, "w14:checkbox")[0] ?? childrenWithTag(sdtPr, "w:checkbox")[0];
+	if (checkbox === void 0) return;
+	const checked = childrenWithTag(checkbox, "w14:checked")[0] ?? childrenWithTag(checkbox, "w:checked")[0];
+	if (checked === void 0) return false;
+	const val = attr(checked, "w14:val") ?? attr(checked, "w:val");
+	return val === void 0 || val !== "0" && val !== "false" && val !== "off";
+}
+function readContentControlDescriptor(sdt) {
+	const sdtPr = childrenWithTag(sdt, "w:sdtPr")[0];
+	const descriptor = {
+		kind: "contentControl",
+		controlType: readControlType(sdtPr)
+	};
+	if (sdtPr === void 0) return descriptor;
+	const tag = childrenWithTag(sdtPr, "w:tag")[0];
+	const tagVal = tag === void 0 ? void 0 : attr(tag, "w:val");
+	if (tagVal !== void 0) descriptor.tag = decodeEntities(tagVal);
+	const alias = childrenWithTag(sdtPr, "w:alias")[0];
+	const aliasVal = alias === void 0 ? void 0 : attr(alias, "w:val");
+	if (aliasVal !== void 0) descriptor.alias = decodeEntities(aliasVal);
+	const lock = childrenWithTag(sdtPr, "w:lock")[0];
+	const lockVal = lock === void 0 ? void 0 : attr(lock, "w:val");
+	const mappedLock = lockVal === void 0 ? void 0 : LOCK_BY_VALUE.get(lockVal);
+	if (mappedLock !== void 0) descriptor.lock = mappedLock;
+	const options = readListItemOptions(sdtPr);
+	if (options !== void 0) descriptor.options = options;
+	const checked = readCheckboxState(sdtPr);
+	if (checked !== void 0) descriptor.checked = checked;
+	const date = childrenWithTag(sdtPr, "w:date")[0];
+	const fullDate = date === void 0 ? void 0 : attr(date, "w:fullDate");
+	if (fullDate !== void 0) descriptor.value = decodeEntities(fullDate);
+	return descriptor;
+}
+const PROVENANCE_CHANGE_BY_TAG = /* @__PURE__ */ new Map([
+	["w:ins", "insertion"],
+	["w:del", "deletion"],
+	["w:moveFrom", "moveFrom"],
+	["w:moveTo", "moveTo"]
+]);
+function isDeletedChange(change) {
+	return change === "deletion" || change === "moveFrom";
+}
+function readProvenanceDescriptor(element, change) {
+	const descriptor = {
+		kind: "provenance",
+		change
+	};
+	const author = attr(element, "w:author");
+	if (author !== void 0) descriptor.author = decodeEntities(author);
+	const date = attr(element, "w:date");
+	if (date !== void 0) descriptor.dateIso = decodeEntities(date);
+	return descriptor;
+}
+function bookmarkAnchorDescriptor(name) {
+	return {
+		kind: "anchor",
+		anchorType: "bookmark",
+		name
+	};
+}
+function runInstructionText(run) {
+	let text = "";
+	for (const child of run.children) if (child.type === "element" && (child.tag === "w:instrText" || child.tag === "w:delInstrText")) text += textContent(child);
+	return text;
+}
+function fieldCharType(run) {
+	const fldChar = childrenWithTag(run, "w:fldChar")[0];
+	return fldChar === void 0 ? void 0 : attr(fldChar, "w:fldCharType");
+}
+//#endregion
+export { PROVENANCE_CHANGE_BY_TAG, TABLE_OF_CONTENTS_GALLERY, bookmarkAnchorDescriptor, contentBearingChildren, fieldCharType, indexParagraphContent, insertConstructMarkers, isDeletedChange, readContentControlDescriptor, readProvenanceDescriptor, runInstructionText };