docx 9.8.0 → 9.8.1

package/dist/index.cjs

@@ -8223,12 +8223,6 @@ var ImportedRootElementAttributes = class extends XmlComponent {
 	}
 };
 //#endregion
-//#region src/file/xml-components/xmlable-object.ts
-/**
-* @ignore
-*/
-var WORKAROUND3 = "";
-//#endregion
 //#region src/file/xml-components/initializable-xml-component.ts
 /**
 * Initializable XML Component module.
@@ -19217,6 +19211,28 @@ var MathText = class extends XmlComponent {
 	}
 };
 //#endregion
+//#region \0@oxc-project+runtime@0.150.0/helpers/esm/objectWithoutPropertiesLoose.js
+function _objectWithoutPropertiesLoose(r, e) {
+	if (null == r) return {};
+	var t = {};
+	for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
+		if (e.includes(n)) continue;
+		t[n] = r[n];
+	}
+	return t;
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.150.0/helpers/esm/objectWithoutProperties.js
+function _objectWithoutProperties(e, t) {
+	if (null == e) return {};
+	var o, r, i = _objectWithoutPropertiesLoose(e, t);
+	if (Object.getOwnPropertySymbols) {
+		var s = Object.getOwnPropertySymbols(e);
+		for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]);
+	}
+	return i;
+}
+//#endregion
 //#region src/file/paragraph/math/math-run.ts
 /**
 * Math Run module for Office MathML.
@@ -19227,6 +19243,33 @@ var MathText = class extends XmlComponent {
 *
 * @module
 */
+var _excluded$3 = [
+	"text",
+	"normalText",
+	"script",
+	"literal"
+];
+var STYLES = {
+	plain: "p",
+	bold: "b",
+	italic: "i",
+	boldItalic: "bi"
+};
+var SCRIPTS = {
+	roman: "roman",
+	script: "script",
+	fraktur: "fraktur",
+	doubleStruck: "double-struck",
+	sansSerif: "sans-serif",
+	monospace: "monospace"
+};
+var createValueElement = (name, value) => new BuilderElement({
+	name,
+	attributes: { value: {
+		key: "m:val",
+		value
+	} }
+});
 /**
 * Represents a run of text within a math equation.
 *
@@ -19255,24 +19298,28 @@ var MathText = class extends XmlComponent {
 * ```typescript
 * new MathRun("x + y");
 * new MathRun({ text: "if ", normalText: true });
+* new MathRun({ text: "R", script: "doubleStruck" });
+* new MathRun({ text: "d", style: "plain" });
 * ```
 */
 var MathRun = class extends XmlComponent {
 	constructor(options) {
+		var _rest$style;
 		super("m:r");
-		const { text, normalText } = typeof options === "string" ? {
-			text: options,
-			normalText: false
-		} : options;
-		if (normalText) this.root.push(new BuilderElement({
+		const _ref = typeof options === "string" ? { text: options } : options, { text, normalText, script, literal } = _ref;
+		const style = (_rest$style = _objectWithoutProperties(_ref, _excluded$3).style) !== null && _rest$style !== void 0 ? _rest$style : script === void 0 || script === "roman" ? void 0 : "plain";
+		if (normalText && (style !== void 0 || script !== void 0)) throw new Error("MathRun: normalText can't be given with style or script, which are for math. Give one or the other");
+		if (style !== void 0 && !Object.keys(STYLES).includes(style)) throw new Error(`MathRun: style is "${style}", which isn't one of ${Object.keys(STYLES).join(", ")}`);
+		if (script !== void 0 && !Object.keys(SCRIPTS).includes(script)) throw new Error(`MathRun: script is "${script}", which isn't one of ${Object.keys(SCRIPTS).join(", ")}`);
+		const properties = [
+			...literal ? [createValueElement("m:lit", 1)] : [],
+			...normalText ? [createValueElement("m:nor", 1)] : [],
+			...script === void 0 ? [] : [createValueElement("m:scr", SCRIPTS[script])],
+			...style === void 0 ? [] : [createValueElement("m:sty", STYLES[style])]
+		];
+		if (properties.length > 0) this.root.push(new BuilderElement({
 			name: "m:rPr",
-			children: [new BuilderElement({
-				name: "m:nor",
-				attributes: { on: {
-					key: "m:val",
-					value: 1
-				} }
-			})]
+			children: properties
 		}));
 		this.root.push(new MathText(text));
 	}
@@ -19328,6 +19375,12 @@ var MathNumerator = class extends XmlComponent {
 *
 * @module
 */
+var TYPES = {
+	stacked: "bar",
+	skewed: "skw",
+	linear: "lin",
+	noBar: "noBar"
+};
 /**
 * Represents a fraction in a math equation.
 *
@@ -19354,11 +19407,29 @@ var MathNumerator = class extends XmlComponent {
 *   numerator: [new MathRun("a + b")],
 *   denominator: [new MathRun("c")],
 * });
+*
+* // n over k, as a binomial coefficient, in brackets
+* new MathRoundBrackets({
+*   children: [new MathFraction({ numerator: [new MathRun("n")], denominator: [new MathRun("k")], type: "noBar" })],
+* });
 * ```
 */
 var MathFraction = class extends XmlComponent {
 	constructor(options) {
 		super("m:f");
+		if (options.type !== void 0) {
+			if (!Object.keys(TYPES).includes(options.type)) throw new Error(`MathFraction: type is "${options.type}", which isn't one of ${Object.keys(TYPES).join(", ")}`);
+			this.root.push(new BuilderElement({
+				name: "m:fPr",
+				children: [new BuilderElement({
+					name: "m:type",
+					attributes: { value: {
+						key: "m:val",
+						value: TYPES[options.type]
+					} }
+				})]
+			}));
+		}
 		this.root.push(new MathNumerator(options.numerator));
 		this.root.push(new MathDenominator(options.denominator));
 	}
@@ -19608,6 +19679,22 @@ var createMathSubScriptElement = ({ children }) => new BuilderElement({
 	children
 });
 //#endregion
+//#region src/file/paragraph/math/n-ary/limit-location-value.ts
+var LOCATIONS = {
+	aboveBelow: "undOvr",
+	side: "subSup"
+};
+/**
+* The value of `m:limLoc` for where limits go, or the default when none is given.
+*
+* @throws If the position isn't one of those allowed, for code that isn't type checked
+*/
+var limitLocationValue = (owner, limits, defaultValue) => {
+	if (limits === void 0) return defaultValue;
+	if (!Object.keys(LOCATIONS).includes(limits)) throw new Error(`${owner}: limits is "${limits}", which isn't one of ${Object.keys(LOCATIONS).join(", ")}`);
+	return LOCATIONS[limits];
+};
+//#endregion
 //#region src/file/paragraph/math/n-ary/math-super-script.ts
 /**
 * Math SuperScript Element module for Office MathML.
@@ -19690,7 +19777,8 @@ var MathSum = class extends XmlComponent {
 		this.root.push(createMathNAryProperties({
 			accent: "∑",
 			hasSuperScript: !!options.superScript,
-			hasSubScript: !!options.subScript
+			hasSubScript: !!options.subScript,
+			limitLocationVal: limitLocationValue("MathSum", options.limits, "undOvr")
 		}));
 		this.root.push(createMathSubScriptElement({ children: (_options$subScript = options.subScript) !== null && _options$subScript !== void 0 ? _options$subScript : [] }));
 		this.root.push(createMathSuperScriptElement({ children: (_options$superScript = options.superScript) !== null && _options$superScript !== void 0 ? _options$superScript : [] }));
@@ -19747,7 +19835,7 @@ var MathIntegral = class extends XmlComponent {
 			accent: "",
 			hasSuperScript: !!options.superScript,
 			hasSubScript: !!options.subScript,
-			limitLocationVal: "subSup"
+			limitLocationVal: limitLocationValue("MathIntegral", options.limits, "subSup")
 		}));
 		this.root.push(createMathSubScriptElement({ children: (_options$subScript = options.subScript) !== null && _options$subScript !== void 0 ? _options$subScript : [] }));
 		this.root.push(createMathSuperScriptElement({ children: (_options$superScript = options.superScript) !== null && _options$superScript !== void 0 ? _options$superScript : [] }));
@@ -20207,12 +20295,6 @@ var MathPreSubSuperScript = class extends BuilderElement {
 	}
 };
 //#endregion
-//#region src/file/paragraph/math/math-component.ts
-/**
-* @ignore
-*/
-var WORKAROUND4 = "";
-//#endregion
 //#region src/file/paragraph/math/radical/math-degree.ts
 /**
 * Math Degree module for Office MathML.
@@ -25967,12 +26049,6 @@ var Media = class {
 	}
 };
 //#endregion
-//#region src/file/media/data.ts
-/**
-* @ignore
-*/
-var WORKAROUND2 = "";
-//#endregion
 //#region src/file/numbering/level.ts
 /**
 * Numbering level definitions module for WordprocessingML documents.
@@ -29306,28 +29382,6 @@ var StructuredDocumentTagProperties = class extends XmlComponent {
 	}
 };
 //#endregion
-//#region \0@oxc-project+runtime@0.150.0/helpers/esm/objectWithoutPropertiesLoose.js
-function _objectWithoutPropertiesLoose(r, e) {
-	if (null == r) return {};
-	var t = {};
-	for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
-		if (e.includes(n)) continue;
-		t[n] = r[n];
-	}
-	return t;
-}
-//#endregion
-//#region \0@oxc-project+runtime@0.150.0/helpers/esm/objectWithoutProperties.js
-function _objectWithoutProperties(e, t) {
-	if (null == e) return {};
-	var o, r, i = _objectWithoutPropertiesLoose(e, t);
-	if (Object.getOwnPropertySymbols) {
-		var s = Object.getOwnPropertySymbols(e);
-		for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]);
-	}
-	return i;
-}
-//#endregion
 //#region src/file/table-of-contents/table-of-contents.ts
 /**
 * Table of Contents module for WordprocessingML documents.
@@ -36077,9 +36131,6 @@ exports.VerticalMergeRevisionType = VerticalMergeRevisionType;
 exports.VerticalMergeType = VerticalMergeType;
 exports.VerticalPositionAlign = VerticalPositionAlign;
 exports.VerticalPositionRelativeFrom = VerticalPositionRelativeFrom;
-exports.WORKAROUND2 = WORKAROUND2;
-exports.WORKAROUND3 = WORKAROUND3;
-exports.WORKAROUND4 = WORKAROUND4;
 exports.WidthType = WidthType;
 exports.WpgGroupRun = WpgGroupRun;
 exports.WpsShapeRun = WpsShapeRun;

package/dist/index.d.cts

@@ -5743,6 +5743,11 @@ export declare type IMathFractionOptions = {
     readonly numerator: readonly MathComponent[];
     /** Math components for the denominator (bottom) of the fraction */
     readonly denominator: readonly MathComponent[];
+    /**
+     * How the fraction is drawn: stacked, skewed, linear, or stacked with no bar.
+     * @default "stacked"
+     */
+    readonly type?: MathFractionType;
 };
 
 /**
@@ -5769,6 +5774,11 @@ export declare type IMathIntegralOptions = {
     readonly subScript?: readonly MathComponent[];
     /** Optional upper bound of integration */
     readonly superScript?: readonly MathComponent[];
+    /**
+     * Where the limits go: above and below the ∫, or to its right.
+     * @default "side"
+     */
+    readonly limits?: MathLimitsPosition;
 };
 
 /**
@@ -5869,6 +5879,11 @@ export declare type IMathSumOptions = {
     readonly subScript?: readonly MathComponent[];
     /** Optional upper bound (superscript) of the sum */
     readonly superScript?: readonly MathComponent[];
+    /**
+     * Where the limits go: above and below the ∑, or to its right.
+     * @default "aboveBelow"
+     */
+    readonly limits?: MathLimitsPosition;
 };
 
 /**
@@ -8289,12 +8304,27 @@ export declare class MathDenominator extends XmlComponent {
  *   numerator: [new MathRun("a + b")],
  *   denominator: [new MathRun("c")],
  * });
+ *
+ * // n over k, as a binomial coefficient, in brackets
+ * new MathRoundBrackets({
+ *   children: [new MathFraction({ numerator: [new MathRun("n")], denominator: [new MathRun("k")], type: "noBar" })],
+ * });
  * ```
  */
 export declare class MathFraction extends XmlComponent {
     constructor(options: IMathFractionOptions);
 }
 
+/**
+ * How a fraction is drawn (`m:type`):
+ *
+ * - `"stacked"`: the numerator over the denominator, with a bar between them;
+ * - `"skewed"`: the numerator up and to the left of a slash, and the denominator down and to the right, as ½;
+ * - `"linear"`: on one line, with a slash between them, as a/b;
+ * - `"noBar"`: stacked, with no bar between them, as in a binomial coefficient.
+ */
+export declare type MathFractionType = "stacked" | "skewed" | "linear" | "noBar";
+
 /**
  * Represents a mathematical function in a math equation.
  *
@@ -8479,6 +8509,14 @@ export declare class MathLimitLower extends XmlComponent {
     constructor(options: IMathLimitLowerOptions);
 }
 
+/**
+ * Where a large operator's limits go (`m:limLoc`):
+ *
+ * - `"aboveBelow"`: above and below it, as a sum's usually are;
+ * - `"side"`: to its right, as a superscript and subscript, as an integral's usually are.
+ */
+export declare type MathLimitsPosition = "aboveBelow" | "side";
+
 /**
  * Represents an upper limit structure in a math equation.
  *
@@ -8691,6 +8729,8 @@ export declare class MathRoundBrackets extends XmlComponent {
  * ```typescript
  * new MathRun("x + y");
  * new MathRun({ text: "if ", normalText: true });
+ * new MathRun({ text: "R", script: "doubleStruck" });
+ * new MathRun({ text: "d", style: "plain" });
  * ```
  */
 export declare class MathRun extends XmlComponent {
@@ -8705,12 +8745,54 @@ export declare type MathRunOptions = {
     readonly text: string;
     /**
      * Writes the text as ordinary text rather than math, as Word's "Normal Text" button does (`m:nor`): upright and in
-     * the document's font, with its spaces kept. For words in an equation, such as "if" and "otherwise" in cases.
+     * the document's font, with its spaces kept. For words in an equation, such as "if" and "otherwise" in cases. It
+     * can't be given with `style` or `script`, which are for math.
      * @default false
      */
     readonly normalText?: boolean;
+    /**
+     * How the letters are drawn: plain (upright), bold, italic or both (`m:sty`).
+     * @default "plain" with a `script` other than roman, as LaTeX draws its alphabets upright; otherwise none, and Word
+     * draws letters in italic
+     */
+    readonly style?: MathRunStyle;
+    /**
+     * The alphabet the letters are drawn in, such as double-struck for ℝ (`m:scr`).
+     */
+    readonly script?: MathRunScript;
+    /**
+     * Takes the text as it is (`m:lit`), rather than as something Word builds up or lines up, such as an `&` in a
+     * `MathEquationArray`, which would otherwise be a point the rows line up at.
+     * @default false
+     */
+    readonly literal?: boolean;
 };
 
+/**
+ * The alphabet a {@link MathRun}'s letters are drawn in (`m:scr`):
+ *
+ * - `"roman"`: the math font's own letters, as Word draws them unless a run has an alphabet;
+ * - `"script"`: 𝒜, as LaTeX's `\mathcal` and `\mathscr`;
+ * - `"fraktur"`: 𝔄, as `\mathfrak`;
+ * - `"doubleStruck"`: 𝔸, as `\mathbb`, for sets such as ℝ;
+ * - `"sansSerif"`: 𝖠, as `\mathsf`;
+ * - `"monospace"`: 𝙰, as `\mathtt`.
+ */
+export declare type MathRunScript = "roman" | "script" | "fraktur" | "doubleStruck" | "sansSerif" | "monospace";
+
+/**
+ * How a {@link MathRun}'s letters are drawn (`m:sty`):
+ *
+ * - `"plain"`: upright, as LaTeX's `\mathrm`;
+ * - `"bold"`: bold and upright, as `\mathbf`;
+ * - `"italic"`: italic, as `\mathit`;
+ * - `"boldItalic"`: bold and italic, as `\boldsymbol`.
+ *
+ * Word draws letters in italic, and digits and capital Greek letters upright, unless a run has a style. A run in an
+ * alphabet other than roman is plain unless given a style, as LaTeX draws its alphabets upright.
+ */
+export declare type MathRunStyle = "plain" | "bold" | "italic" | "boldItalic";
+
 /**
  * Represents square brackets in a math equation.
  *
@@ -13128,21 +13210,6 @@ declare type WithHexColors<T> = Omit<T, "borders" | "shading"> & {
     };
 };
 
-/**
- * @ignore
- */
-export declare const WORKAROUND2 = "";
-
-/**
- * @ignore
- */
-export declare const WORKAROUND3 = "";
-
-/**
- * @ignore
- */
-export declare const WORKAROUND4 = "";
-
 export declare type WpgCommonMediaData = {
     readonly outline?: OutlineOptions;
     readonly solidFill?: SolidFillOptions;

package/dist/index.d.ts

@@ -5743,6 +5743,11 @@ export declare type IMathFractionOptions = {
     readonly numerator: readonly MathComponent[];
     /** Math components for the denominator (bottom) of the fraction */
     readonly denominator: readonly MathComponent[];
+    /**
+     * How the fraction is drawn: stacked, skewed, linear, or stacked with no bar.
+     * @default "stacked"
+     */
+    readonly type?: MathFractionType;
 };
 
 /**
@@ -5769,6 +5774,11 @@ export declare type IMathIntegralOptions = {
     readonly subScript?: readonly MathComponent[];
     /** Optional upper bound of integration */
     readonly superScript?: readonly MathComponent[];
+    /**
+     * Where the limits go: above and below the ∫, or to its right.
+     * @default "side"
+     */
+    readonly limits?: MathLimitsPosition;
 };
 
 /**
@@ -5869,6 +5879,11 @@ export declare type IMathSumOptions = {
     readonly subScript?: readonly MathComponent[];
     /** Optional upper bound (superscript) of the sum */
     readonly superScript?: readonly MathComponent[];
+    /**
+     * Where the limits go: above and below the ∑, or to its right.
+     * @default "aboveBelow"
+     */
+    readonly limits?: MathLimitsPosition;
 };
 
 /**
@@ -8289,12 +8304,27 @@ export declare class MathDenominator extends XmlComponent {
  *   numerator: [new MathRun("a + b")],
  *   denominator: [new MathRun("c")],
  * });
+ *
+ * // n over k, as a binomial coefficient, in brackets
+ * new MathRoundBrackets({
+ *   children: [new MathFraction({ numerator: [new MathRun("n")], denominator: [new MathRun("k")], type: "noBar" })],
+ * });
  * ```
  */
 export declare class MathFraction extends XmlComponent {
     constructor(options: IMathFractionOptions);
 }
 
+/**
+ * How a fraction is drawn (`m:type`):
+ *
+ * - `"stacked"`: the numerator over the denominator, with a bar between them;
+ * - `"skewed"`: the numerator up and to the left of a slash, and the denominator down and to the right, as ½;
+ * - `"linear"`: on one line, with a slash between them, as a/b;
+ * - `"noBar"`: stacked, with no bar between them, as in a binomial coefficient.
+ */
+export declare type MathFractionType = "stacked" | "skewed" | "linear" | "noBar";
+
 /**
  * Represents a mathematical function in a math equation.
  *
@@ -8479,6 +8509,14 @@ export declare class MathLimitLower extends XmlComponent {
     constructor(options: IMathLimitLowerOptions);
 }
 
+/**
+ * Where a large operator's limits go (`m:limLoc`):
+ *
+ * - `"aboveBelow"`: above and below it, as a sum's usually are;
+ * - `"side"`: to its right, as a superscript and subscript, as an integral's usually are.
+ */
+export declare type MathLimitsPosition = "aboveBelow" | "side";
+
 /**
  * Represents an upper limit structure in a math equation.
  *
@@ -8691,6 +8729,8 @@ export declare class MathRoundBrackets extends XmlComponent {
  * ```typescript
  * new MathRun("x + y");
  * new MathRun({ text: "if ", normalText: true });
+ * new MathRun({ text: "R", script: "doubleStruck" });
+ * new MathRun({ text: "d", style: "plain" });
  * ```
  */
 export declare class MathRun extends XmlComponent {
@@ -8705,12 +8745,54 @@ export declare type MathRunOptions = {
     readonly text: string;
     /**
      * Writes the text as ordinary text rather than math, as Word's "Normal Text" button does (`m:nor`): upright and in
-     * the document's font, with its spaces kept. For words in an equation, such as "if" and "otherwise" in cases.
+     * the document's font, with its spaces kept. For words in an equation, such as "if" and "otherwise" in cases. It
+     * can't be given with `style` or `script`, which are for math.
      * @default false
      */
     readonly normalText?: boolean;
+    /**
+     * How the letters are drawn: plain (upright), bold, italic or both (`m:sty`).
+     * @default "plain" with a `script` other than roman, as LaTeX draws its alphabets upright; otherwise none, and Word
+     * draws letters in italic
+     */
+    readonly style?: MathRunStyle;
+    /**
+     * The alphabet the letters are drawn in, such as double-struck for ℝ (`m:scr`).
+     */
+    readonly script?: MathRunScript;
+    /**
+     * Takes the text as it is (`m:lit`), rather than as something Word builds up or lines up, such as an `&` in a
+     * `MathEquationArray`, which would otherwise be a point the rows line up at.
+     * @default false
+     */
+    readonly literal?: boolean;
 };
 
+/**
+ * The alphabet a {@link MathRun}'s letters are drawn in (`m:scr`):
+ *
+ * - `"roman"`: the math font's own letters, as Word draws them unless a run has an alphabet;
+ * - `"script"`: 𝒜, as LaTeX's `\mathcal` and `\mathscr`;
+ * - `"fraktur"`: 𝔄, as `\mathfrak`;
+ * - `"doubleStruck"`: 𝔸, as `\mathbb`, for sets such as ℝ;
+ * - `"sansSerif"`: 𝖠, as `\mathsf`;
+ * - `"monospace"`: 𝙰, as `\mathtt`.
+ */
+export declare type MathRunScript = "roman" | "script" | "fraktur" | "doubleStruck" | "sansSerif" | "monospace";
+
+/**
+ * How a {@link MathRun}'s letters are drawn (`m:sty`):
+ *
+ * - `"plain"`: upright, as LaTeX's `\mathrm`;
+ * - `"bold"`: bold and upright, as `\mathbf`;
+ * - `"italic"`: italic, as `\mathit`;
+ * - `"boldItalic"`: bold and italic, as `\boldsymbol`.
+ *
+ * Word draws letters in italic, and digits and capital Greek letters upright, unless a run has a style. A run in an
+ * alphabet other than roman is plain unless given a style, as LaTeX draws its alphabets upright.
+ */
+export declare type MathRunStyle = "plain" | "bold" | "italic" | "boldItalic";
+
 /**
  * Represents square brackets in a math equation.
  *
@@ -13128,21 +13210,6 @@ declare type WithHexColors<T> = Omit<T, "borders" | "shading"> & {
     };
 };
 
-/**
- * @ignore
- */
-export declare const WORKAROUND2 = "";
-
-/**
- * @ignore
- */
-export declare const WORKAROUND3 = "";
-
-/**
- * @ignore
- */
-export declare const WORKAROUND4 = "";
-
 export declare type WpgCommonMediaData = {
     readonly outline?: OutlineOptions;
     readonly solidFill?: SolidFillOptions;