@office-open/core 0.3.2 → 0.3.4

package/dist/chart/index.d.mts

@@ -69,7 +69,7 @@ interface IChartTypeOptions {
   readonly series: readonly IChartSeriesData[];
   readonly categories: readonly string[];
 }
-declare const createChartType: (options: IChartTypeOptions) => ScatterChart | BarChart | LineChart | PieChart | AreaChart;
+declare const createChartType: (options: IChartTypeOptions) => BarChart | LineChart | PieChart | AreaChart | ScatterChart;
 //#endregion
 //#region src/chart/series/series-data.d.ts
 declare const createStrRef: (values: string | readonly string[]) => XmlComponent;

package/dist/index.d.mts

@@ -83,10 +83,35 @@ interface OutputByType {
   readonly nodebuffer: Buffer;
 }
 type OutputType = keyof OutputByType;
+declare const OoxmlMimeType: {
+  readonly DOCX: "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+  readonly PPTX: "application/vnd.openxmlformats-officedocument.presentationml.presentation";
+};
+declare const convertOutput: <T extends OutputType>(data: Uint8Array, type: T, mimeType?: string) => OutputByType[T];
+//#endregion
+//#region src/packer.d.ts
+/**
+ * Shared packer utilities for OOXML document generation.
+ *
+ * @module
+ */
+interface IXmlifyedFile {
+  readonly path: string;
+  readonly data: string | Uint8Array;
+}
+declare const PrettifyType: {
+  readonly NONE: "";
+  readonly WITH_2_BLANKS: "  ";
+  readonly WITH_4_BLANKS: "    ";
+  readonly WITH_TAB: "\t";
+};
+declare const convertPrettifyType: (prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]) => (typeof PrettifyType)[keyof typeof PrettifyType] | undefined;
 //#endregion
 //#region src/opc/app-properties.d.ts
-declare class AppProperties extends XmlComponent {
+declare class AppProperties extends ImportedXmlComponent {
+  private static instance;
   constructor();
+  prepForXml(): Readonly<Record<string, any>> | undefined;
 }
 //#endregion
 //#region src/opc/relationships.d.ts
@@ -156,26 +181,31 @@ declare class RawPassthrough extends BaseXmlComponent {
 //#endregion
 //#region src/placeholder.d.ts
 /**
- * Placeholder detection utilities for compiler post-processing optimization.
+ * Placeholder detection and replacement utilities for compiler post-processing.
  *
  * Both DOCX and PPTX compilers use placeholder tokens (e.g. `{chart:key}`)
  * in XML strings to defer relationship ID assignment. This module provides
- * fast pre-check utilities to avoid unnecessary regex scans when no placeholders exist.
- */
-/**
- * Check if an XML string contains any placeholder tokens.
- * Uses a simple `{` character check which is O(n) but much cheaper
- * than running multiple regex scans.
+ * fast pre-check utilities and shared replacement functions.
  */
+type IdFormat = "rId" | "plain";
+declare const formatId: (offset: number, index: number, style: IdFormat) => string;
+declare function escapeRegex(str: string): string;
 declare function hasPlaceholders(xml: string): boolean;
-/**
- * Collect all unique placeholder keys with a given prefix from an XML string.
- * Single-pass scan using indexOf, avoiding RegExp overhead.
- *
- * @param xml - The XML string to scan
- * @param prefix - The placeholder prefix (e.g. "chart:", "smartart:", "hlink:")
- * @returns Array of unique keys found after the prefix
- */
 declare function collectPlaceholderKeys(xml: string, prefix: string): string[];
+declare function replaceImagePlaceholders(xml: string, mediaData: readonly {
+  readonly fileName: string;
+}[], offset: number, idFormat?: IdFormat): string;
+declare function getReferencedMedia(xml: string, mediaArray: readonly {
+  readonly fileName: string;
+}[]): readonly {
+  readonly fileName: string;
+}[];
+declare function replaceChartPlaceholders(xml: string, chartKeys: readonly string[], offset: number, idFormat?: IdFormat): string;
+interface SmartArtRelOptions {
+  readonly pathPrefix: string;
+  readonly styleRelType: RelationshipType;
+}
+declare function replaceSmartArtPlaceholders(xml: string, keys: readonly string[], dataOffset: number, idFormat?: IdFormat): string;
+declare function addSmartArtRelationships(keys: readonly string[], addRel: (id: number, type: RelationshipType, target: string, targetMode?: string) => void, baseOffset: number, globalStartIndex: number, options: SmartArtRelOptions): void;
 //#endregion
-export { AppProperties, AttributeData, AttributeMap, AttributePayload, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, CoreProperties, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IContext, ISmartArtData, ITreeNode, IXmlAttribute, IXmlableObject, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, MixedChildren, NextAttributeComponent, NumberValueElement, OnOffElement, OutputByType, OutputType, Percentage, Point, PositivePercentage, PositiveUniversalMeasure, RawElement, RawPassthrough, Relationship, type RelationshipType, Relationships, RelativeMeasure, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, UniqueNumericIdCreator, UniversalMeasure, XmlAttributeComponent, XmlComponent, chartAttr, collectPlaceholderKeys, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertPixelsToEmu, convertPointsToEmu, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, elementToXml, findRel, findRelsByType, getImageType, hasPlaceholders, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, isRaw, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl, zipToBuffer };
+export { AppProperties, AttributeData, AttributeMap, AttributePayload, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, CoreProperties, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IContext, ISmartArtData, ITreeNode, IXmlAttribute, IXmlableObject, IXmlifyedFile, IdFormat, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, MixedChildren, NextAttributeComponent, NumberValueElement, OnOffElement, OoxmlMimeType, OutputByType, OutputType, Percentage, Point, PositivePercentage, PositiveUniversalMeasure, PrettifyType, RawElement, RawPassthrough, Relationship, type RelationshipType, Relationships, RelativeMeasure, STYLE_CATEGORIES, SmartArtCollection, SmartArtRelOptions, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, UniqueNumericIdCreator, UniversalMeasure, XmlAttributeComponent, XmlComponent, addSmartArtRelationships, chartAttr, collectPlaceholderKeys, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertOutput, convertPixelsToEmu, convertPointsToEmu, convertPrettifyType, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, elementToXml, escapeRegex, findRel, findRelsByType, formatId, getImageType, getReferencedMedia, hasPlaceholders, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, isRaw, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, replaceChartPlaceholders, replaceImagePlaceholders, replaceSmartArtPlaceholders, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl, zipToBuffer };

package/dist/index.mjs

@@ -4,20 +4,50 @@ import { a as convertEmuToInches, c as convertInchesToEmu, d as convertPixelsToE
 import { COLOR_CATEGORIES, Connection, DataModel, LAYOUT_CATEGORIES, Point, STYLE_CATEGORIES, SmartArtCollection, TransPoint, createDataModel } from "./smartart/index.mjs";
 import { elementToXml, findRel, findRelsByType, getImageType, listFiles, parseRels, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, uint8ToBase64, unzipToMap, zipToBuffer } from "./archive.mjs";
 import { textOf } from "@office-open/xml";
-//#region src/opc/app-properties.ts
-var AppPropertiesAttributes = class extends XmlAttributeComponent {
-	xmlKeys = {
-		vt: "xmlns:vt",
-		xmlns: "xmlns"
-	};
+import { strFromU8 } from "fflate";
+//#region src/output-type.ts
+/**
+* Output type definitions for OOXML document export.
+*
+* @module
+*/
+const OoxmlMimeType = {
+	DOCX: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+	PPTX: "application/vnd.openxmlformats-officedocument.presentationml.presentation"
 };
-var AppProperties = class extends XmlComponent {
+const convertOutput = (data, type, mimeType = OoxmlMimeType.DOCX) => {
+	switch (type) {
+		case "nodebuffer": return Buffer.from(data);
+		case "blob": return new Blob([data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength)], { type: mimeType });
+		case "arraybuffer": return data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength);
+		case "uint8array": return data;
+		case "base64": return btoa(strFromU8(data, true));
+		case "string":
+		case "text":
+		case "binarystring": return strFromU8(data, true);
+		case "array": return [...data];
+		default: return data;
+	}
+};
+//#endregion
+//#region src/packer.ts
+const PrettifyType = {
+	NONE: "",
+	WITH_2_BLANKS: "  ",
+	WITH_4_BLANKS: "    ",
+	WITH_TAB: "	"
+};
+const convertPrettifyType = (prettify) => prettify === true ? PrettifyType.WITH_2_BLANKS : prettify === false ? void 0 : prettify;
+//#endregion
+//#region src/opc/app-properties.ts
+const APP_PROPS_XML = "<Properties xmlns=\"http://schemas.openxmlformats.org/officeDocument/2006/extended-properties\" xmlns:vt=\"http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes\"/>";
+var AppProperties = class AppProperties extends ImportedXmlComponent {
+	static instance = ImportedXmlComponent.fromXmlString(APP_PROPS_XML);
 	constructor() {
 		super("Properties");
-		this.root.push(new AppPropertiesAttributes({
-			vt: "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes",
-			xmlns: "http://schemas.openxmlformats.org/officeDocument/2006/extended-properties"
-		}));
+	}
+	prepForXml() {
+		return AppProperties.instance.prepForXml({ stack: [] });
 	}
 };
 //#endregion
@@ -163,29 +193,13 @@ var RawPassthrough = class extends BaseXmlComponent {
 };
 //#endregion
 //#region src/placeholder.ts
-/**
-* Placeholder detection utilities for compiler post-processing optimization.
-*
-* Both DOCX and PPTX compilers use placeholder tokens (e.g. `{chart:key}`)
-* in XML strings to defer relationship ID assignment. This module provides
-* fast pre-check utilities to avoid unnecessary regex scans when no placeholders exist.
-*/
-/**
-* Check if an XML string contains any placeholder tokens.
-* Uses a simple `{` character check which is O(n) but much cheaper
-* than running multiple regex scans.
-*/
+const formatId = (offset, index, style) => style === "rId" ? `rId${offset + index}` : `${offset + index}`;
+function escapeRegex(str) {
+	return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
 function hasPlaceholders(xml) {
 	return xml.includes("{");
 }
-/**
-* Collect all unique placeholder keys with a given prefix from an XML string.
-* Single-pass scan using indexOf, avoiding RegExp overhead.
-*
-* @param xml - The XML string to scan
-* @param prefix - The placeholder prefix (e.g. "chart:", "smartart:", "hlink:")
-* @returns Array of unique keys found after the prefix
-*/
 function collectPlaceholderKeys(xml, prefix) {
 	const keys = [];
 	const search = `{${prefix}`;
@@ -200,5 +214,51 @@ function collectPlaceholderKeys(xml, prefix) {
 	}
 	return keys;
 }
+function replaceImagePlaceholders(xml, mediaData, offset, idFormat = "rId") {
+	let result = xml;
+	mediaData.forEach((image, i) => {
+		result = result.replace(new RegExp(`\\{${escapeRegex(image.fileName)}\\}`, "g"), formatId(offset, i, idFormat));
+	});
+	return result;
+}
+function getReferencedMedia(xml, mediaArray) {
+	return mediaArray.filter((image) => xml.includes(`{${image.fileName}}`));
+}
+function replaceChartPlaceholders(xml, chartKeys, offset, idFormat = "rId") {
+	let result = xml;
+	chartKeys.forEach((key, i) => {
+		result = result.replace(new RegExp(`\\{chart:${escapeRegex(key)}\\}`, "g"), formatId(offset, i, idFormat));
+	});
+	return result;
+}
+function replaceSmartArtPlaceholders(xml, keys, dataOffset, idFormat = "rId") {
+	let result = xml;
+	const count = keys.length;
+	const loOffset = dataOffset + count;
+	const qsOffset = loOffset + count;
+	const csOffset = qsOffset + count;
+	keys.forEach((key, i) => {
+		result = result.replace(new RegExp(`\\{smartart:${escapeRegex(key)}\\}`, "g"), formatId(dataOffset, i, idFormat));
+		result = result.replace(new RegExp(`\\{smartart-lo:${escapeRegex(key)}\\}`, "g"), formatId(loOffset, i, idFormat));
+		result = result.replace(new RegExp(`\\{smartart-qs:${escapeRegex(key)}\\}`, "g"), formatId(qsOffset, i, idFormat));
+		result = result.replace(new RegExp(`\\{smartart-cs:${escapeRegex(key)}\\}`, "g"), formatId(csOffset, i, idFormat));
+	});
+	return result;
+}
+function addSmartArtRelationships(keys, addRel, baseOffset, globalStartIndex, options) {
+	const { pathPrefix, styleRelType } = options;
+	const count = keys.length;
+	const loOffset = baseOffset + count;
+	const qsOffset = loOffset + count;
+	const csOffset = qsOffset + count;
+	keys.forEach((_key, i) => {
+		const gi = globalStartIndex + i;
+		addRel(baseOffset + i, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramData", `${pathPrefix}diagrams/data${gi + 1}.xml`);
+		addRel(loOffset + i, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramLayout", `${pathPrefix}diagrams/layout${gi + 1}.xml`);
+		addRel(qsOffset + i, styleRelType, `${pathPrefix}diagrams/quickStyle${gi + 1}.xml`);
+		addRel(csOffset + i, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramColors", `${pathPrefix}diagrams/colors${gi + 1}.xml`);
+		addRel(csOffset + count + i, "http://schemas.microsoft.com/office/2007/relationships/diagramDrawing", `${pathPrefix}diagrams/drawing${gi + 1}.xml`);
+	});
+}
 //#endregion
-export { AppProperties, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, NextAttributeComponent, NumberValueElement, OnOffElement, Point, RawPassthrough, Relationships, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, XmlAttributeComponent, XmlComponent, chartAttr, collectPlaceholderKeys, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertPixelsToEmu, convertPointsToEmu, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, elementToXml, findRel, findRelsByType, getImageType, hasPlaceholders, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, isRaw, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl, zipToBuffer };
+export { AppProperties, BaseXmlComponent, BuilderElement, COLOR_CATEGORIES, Connection, DataModel, EMPTY_OBJECT, EmptyElement, Formatter, HpsMeasureElement, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, LAYOUT_CATEGORIES, NextAttributeComponent, NumberValueElement, OnOffElement, OoxmlMimeType, Point, PrettifyType, RawPassthrough, Relationships, STYLE_CATEGORIES, SmartArtCollection, StringContainer, StringEnumValueElement, StringValueElement, TargetModeType, ThemeColor, ThemeFont, TransPoint, XmlAttributeComponent, XmlComponent, addSmartArtRelationships, chartAttr, collectPlaceholderKeys, convertEmuToInches, convertEmuToPixels, convertEmuToPoints, convertInchesToEmu, convertInchesToTwip, convertMillimetersToTwip, convertOutput, convertPixelsToEmu, convertPointsToEmu, convertPrettifyType, convertToXmlComponent, createDataModel, dateTimeValue, decimalNumber, eighthPointMeasureValue, elementToXml, escapeRegex, findRel, findRelsByType, formatId, getImageType, getReferencedMedia, hasPlaceholders, hashedId, hexColorValue, hpsMeasureObj, hpsMeasureValue, isRaw, listFiles, longHexNumber, measurementOrPercentValue, numberValObj, onOffObj, parseCoreProperties, parseRels, percentageValue, pointMeasureValue, positiveUniversalMeasureValue, readAllXmlParts, readBinaryFromZip, readTextFromZip, readXmlFromZip, replaceChartPlaceholders, replaceImagePlaceholders, replaceSmartArtPlaceholders, shortHexNumber, signedHpsMeasureValue, signedTwipsMeasureValue, stringContainerObj, stringEnumValObj, stringValObj, twipsMeasureValue, uCharHexNumber, uint8ToBase64, uniqueId, uniqueNumericIdCreator, uniqueUuid, universalMeasureValue, unsignedDecimalNumber, unzipToMap, wrapEl, zipToBuffer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@office-open/core",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Shared OOXML infrastructure: XmlComponent, value validators, unit converters",
   "keywords": [
     "core",
@@ -59,7 +59,7 @@
     "fflate": "0.8.2",
     "hash.js": "1.1.7",
     "nanoid": "5.1.9",
-    "@office-open/xml": "0.3.2"
+    "@office-open/xml": "0.3.4"
   },
   "scripts": {
     "dev": "basis build --stub",