@syncfusion/ej2-office-common 35.1.37

package/src/features/mathml/model/enums.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Schema-exact Office Math simple-type unions.
+ *
+ * Source: ECMA-376 Part 1 §22.1.3 / Part 4 Annex A.8.1 `shared-math.xsd`.
+ * Serializer emits only these tokens — never synthesize members.
+ */
+/**
+ * Math paragraph justification.
+ *
+ * Source: ECMA-376-1 §22.1.3.7 `ST_Jc`.
+ *
+ * @public
+ */
+export declare type MathJc = 'left' | 'right' | 'center' | 'centerGroup';
+/**
+ * Fraction type.
+ *
+ * Source: ECMA-376-1 §22.1.3.4 `ST_FType`.
+ *
+ * @public
+ */
+export declare type MathFractionType = 'bar' | 'skw' | 'lin' | 'noBar';
+/**
+ * Delimiter shape.
+ *
+ * Source: ECMA-376-1 §22.1.3.10 `ST_Shp` — `'centered' | 'match'` only
+ * (NOT `'distributed'`).
+ *
+ * @public
+ */
+export declare type MathShape = 'centered' | 'match';
+/**
+ * N-ary limit location.
+ *
+ * Source: ECMA-376-1 §22.1.3.8 `ST_LimLoc`.
+ *
+ * @public
+ */
+export declare type MathLimLoc = 'undOvr' | 'subSup';
+/**
+ * Top/bottom placement (bar, groupChr).
+ *
+ * Source: ECMA-376-1 §22.1.3.13 `ST_TopBot`.
+ *
+ * @public
+ */
+export declare type MathTopBot = 'top' | 'bot';
+/**
+ * Break on binary operator.
+ *
+ * Source: ECMA-376-1 §22.1.3.1 `ST_BreakBin`.
+ *
+ * @public
+ */
+export declare type MathBreakBin = 'before' | 'after' | 'repeat';
+/**
+ * Break-bin subscript alignment.
+ *
+ * Source: ECMA-376-1 §22.1.3.2 `ST_BreakBinSub`.
+ *
+ * @public
+ */
+export declare type MathBreakBinSub = '--' | '-+' | '+-';
+/**
+ * Math script (font family class).
+ *
+ * Source: ECMA-376-1 §22.1.3.9 `ST_Script`.
+ *
+ * @public
+ */
+export declare type MathScript = 'roman' | 'script' | 'fraktur' | 'double-struck' | 'sans-serif' | 'monospace';
+/**
+ * Math style (plain/bold/italic).
+ *
+ * Source: ECMA-376-1 §22.1.3.12 `ST_Style`.
+ *
+ * @public
+ */
+export declare type MathStyle = 'p' | 'b' | 'i' | 'bi';
+/**
+ * Spacing rule enumeration (0..4).
+ *
+ * Source: ECMA-376-1 §22.1.3.11 `ST_SpacingRule`.
+ *
+ * @public
+ */
+export declare type MathSpacingRule = 0 | 1 | 2 | 3 | 4;
+/** Members of {@link MathJc}. */
+export declare const MATH_JC_VALUES: string[];
+/** Members of {@link MathFractionType}. */
+export declare const MATH_FTYPE_VALUES: string[];
+/** Members of {@link MathShape} — centered|match only. */
+export declare const MATH_SHP_VALUES: string[];
+/** Members of {@link MathLimLoc}. */
+export declare const MATH_LIMLOC_VALUES: string[];
+/** Members of {@link MathTopBot}. */
+export declare const MATH_TOPBOT_VALUES: string[];
+/** Members of {@link MathBreakBin}. */
+export declare const MATH_BREAKBIN_VALUES: string[];
+/** Members of {@link MathBreakBinSub}. */
+export declare const MATH_BREAKBINSUB_VALUES: string[];
+/** Members of {@link MathScript}. */
+export declare const MATH_SCRIPT_VALUES: string[];
+/** Members of {@link MathStyle}. */
+export declare const MATH_STYLE_VALUES: string[];
+/** Members of {@link MathSpacingRule}. */
+export declare const MATH_SPACING_RULE_VALUES: number[];
+/** Parse ST_Jc; undefined when not a known token. */
+export declare function parseMathJc(value: string): MathJc | undefined;
+/** Parse ST_FType. */
+export declare function parseMathFractionType(value: string): MathFractionType | undefined;
+/** Parse ST_Shp. */
+export declare function parseMathShape(value: string): MathShape | undefined;
+/** Parse ST_LimLoc. */
+export declare function parseMathLimLoc(value: string): MathLimLoc | undefined;
+/** Parse ST_TopBot. */
+export declare function parseMathTopBot(value: string): MathTopBot | undefined;
+/** Parse ST_BreakBin. */
+export declare function parseMathBreakBin(value: string): MathBreakBin | undefined;
+/** Parse ST_BreakBinSub. */
+export declare function parseMathBreakBinSub(value: string): MathBreakBinSub | undefined;
+/** Parse ST_Script. */
+export declare function parseMathScript(value: string): MathScript | undefined;
+/** Parse ST_Style. */
+export declare function parseMathStyle(value: string): MathStyle | undefined;
+/**
+ * ST_Integer2 range −2..2 (argSz).
+ *
+ * Source: ECMA-376-1 §22.1.3.5.
+ */
+export declare function isInteger2(value: number): boolean;
+/**
+ * ST_Integer255 range 1..255.
+ *
+ * Source: ECMA-376-1 §22.1.3.6.
+ */
+export declare function isInteger255(value: number): boolean;
+/**
+ * ST_UnSignedInteger ≥ 0.
+ *
+ * Source: ECMA-376-1 §22.1.3.14.
+ */
+export declare function isUnSignedInteger(value: number): boolean;
+/**
+ * ST_SpacingRule 0..4.
+ *
+ * Source: ECMA-376-1 §22.1.3.11.
+ */
+export declare function isSpacingRule(value: number): value is MathSpacingRule;
+/** Parse OnOff-style val attribute (`1`/`true`/`on` → true). */
+export declare function parseOnOff(value: string | undefined): boolean | undefined;
+/** Emit OnOff as `'1'` / `'0'`. */
+export declare function emitOnOff(value: boolean): string;

package/src/features/mathml/model/enums.js

@@ -0,0 +1,133 @@
+/**
+ * Schema-exact Office Math simple-type unions.
+ *
+ * Source: ECMA-376 Part 1 §22.1.3 / Part 4 Annex A.8.1 `shared-math.xsd`.
+ * Serializer emits only these tokens — never synthesize members.
+ */
+/** Members of {@link MathJc}. */
+export var MATH_JC_VALUES = ['left', 'right', 'center', 'centerGroup'];
+/** Members of {@link MathFractionType}. */
+export var MATH_FTYPE_VALUES = ['bar', 'skw', 'lin', 'noBar'];
+/** Members of {@link MathShape} — centered|match only. */
+export var MATH_SHP_VALUES = ['centered', 'match'];
+/** Members of {@link MathLimLoc}. */
+export var MATH_LIMLOC_VALUES = ['undOvr', 'subSup'];
+/** Members of {@link MathTopBot}. */
+export var MATH_TOPBOT_VALUES = ['top', 'bot'];
+/** Members of {@link MathBreakBin}. */
+export var MATH_BREAKBIN_VALUES = ['before', 'after', 'repeat'];
+/** Members of {@link MathBreakBinSub}. */
+export var MATH_BREAKBINSUB_VALUES = ['--', '-+', '+-'];
+/** Members of {@link MathScript}. */
+export var MATH_SCRIPT_VALUES = [
+    'roman',
+    'script',
+    'fraktur',
+    'double-struck',
+    'sans-serif',
+    'monospace',
+];
+/** Members of {@link MathStyle}. */
+export var MATH_STYLE_VALUES = ['p', 'b', 'i', 'bi'];
+/** Members of {@link MathSpacingRule}. */
+export var MATH_SPACING_RULE_VALUES = [0, 1, 2, 3, 4];
+/** Parse ST_Jc; undefined when not a known token. */
+export function parseMathJc(value) {
+    return (MATH_JC_VALUES.indexOf(value) !== -1) ? value : undefined;
+}
+/** Parse ST_FType. */
+export function parseMathFractionType(value) {
+    return (MATH_FTYPE_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/** Parse ST_Shp. */
+export function parseMathShape(value) {
+    return (MATH_SHP_VALUES.indexOf(value) !== -1) ? value : undefined;
+}
+/** Parse ST_LimLoc. */
+export function parseMathLimLoc(value) {
+    return (MATH_LIMLOC_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/** Parse ST_TopBot. */
+export function parseMathTopBot(value) {
+    return (MATH_TOPBOT_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/** Parse ST_BreakBin. */
+export function parseMathBreakBin(value) {
+    return (MATH_BREAKBIN_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/** Parse ST_BreakBinSub. */
+export function parseMathBreakBinSub(value) {
+    return (MATH_BREAKBINSUB_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/** Parse ST_Script. */
+export function parseMathScript(value) {
+    return (MATH_SCRIPT_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/** Parse ST_Style. */
+export function parseMathStyle(value) {
+    return (MATH_STYLE_VALUES.indexOf(value) !== -1)
+        ? value
+        : undefined;
+}
+/**
+ * ST_Integer2 range −2..2 (argSz).
+ *
+ * Source: ECMA-376-1 §22.1.3.5.
+ */
+export function isInteger2(value) {
+    return Number.isInteger(value) && value >= -2 && value <= 2;
+}
+/**
+ * ST_Integer255 range 1..255.
+ *
+ * Source: ECMA-376-1 §22.1.3.6.
+ */
+export function isInteger255(value) {
+    return Number.isInteger(value) && value >= 1 && value <= 255;
+}
+/**
+ * ST_UnSignedInteger ≥ 0.
+ *
+ * Source: ECMA-376-1 §22.1.3.14.
+ */
+export function isUnSignedInteger(value) {
+    return Number.isInteger(value) && value >= 0;
+}
+/**
+ * ST_SpacingRule 0..4.
+ *
+ * Source: ECMA-376-1 §22.1.3.11.
+ */
+export function isSpacingRule(value) {
+    return Number.isInteger(value) && value >= 0 && value <= 4;
+}
+/** Parse OnOff-style val attribute (`1`/`true`/`on` → true). */
+export function parseOnOff(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    var v = value.toLowerCase();
+    if (v === '1' || v === 'true' || v === 'on') {
+        return true;
+    }
+    if (v === '0' || v === 'false' || v === 'off') {
+        return false;
+    }
+    return undefined;
+}
+/** Emit OnOff as `'1'` / `'0'`. */
+export function emitOnOff(value) {
+    return value ? '1' : '0';
+}

package/src/features/mathml/model/math-element.d.ts

@@ -0,0 +1,173 @@
+/**
+ * MathElement base hierarchy for OMML typed DOM.
+ *
+ * Source: mathml-spec §7; ECMA-376-4 Annex A.8.1.
+ */
+import { OpenXmlElement } from '../openxml';
+/**
+ * Discriminator for every typed math node (OMML local name or synthetic type).
+ *
+ * @public
+ */
+export declare type MathElementType = 'oMathPara' | 'oMath' | 'arg' | 't' | 'r' | 'acc' | 'bar' | 'box' | 'borderBox' | 'd' | 'eqArr' | 'f' | 'func' | 'groupChr' | 'limLow' | 'limUpp' | 'm' | 'mr' | 'nary' | 'phant' | 'rad' | 'sPre' | 'sSub' | 'sSubSup' | 'sSup' | 'unknown';
+/**
+
+ * @public
+ */
+export declare type MathElementKind = MathElementType;
+/**
+ * Abstract base for every OMML model node.
+ *
+ * @public
+ */
+export declare abstract class MathElement {
+    /**
+     * Math element type matching the OMML local name (or a synthetic type such as `unknown`).
+     */
+    abstract readonly type: MathElementType;
+    /** When true, mutation is blocked (preserve-only degradation). */
+    private _preserveOnly;
+    /** Original element retained for preserve-only / unknown nodes. */
+    private _preservedXml;
+    /** Optional dirty listener injected by docx host (document-agnostic). */
+    private _onMutate;
+    /**
+     * Whether this node is locked in preserve-only mode (mutations blocked; original OpenXML is re-emitted).
+     *
+     * @private
+     * Framework/parser state used for round-trip fidelity and host dirty tracking.
+     */
+    readonly preserveOnly: boolean;
+    /**
+     * Captured original OpenXML tree when the node is preserve-only or cannot be fully represented.
+     *
+     * @private
+     * Used by the serializer and hosts to round-trip unmodified structure.
+     */
+    readonly preservedXml: OpenXmlElement | undefined;
+    /**
+     * Registers an internal mutation callback for change tracking and document synchronization.
+     *
+     * @private
+     * Hosts (for example docx `MathInline`) inject dirty tracking; not part of the authoring API.
+     */
+    setMutationListener(listener: (() => void) | undefined): void;
+    /**
+     * Marks this node preserve-only and stores the original OpenXML for round-trip preservation.
+     *
+     * @private
+     * Used by the OMML parser for structural degradation and by document hosts to bubble a
+     * child-level preserve-only lock up to the equation root.
+     */
+    markPreserveOnly(xml: OpenXmlElement): void;
+    /**
+     * Attach preserved XML without locking mutation (UnknownMathElement).
+     *
+     * @private
+     */
+    attachPreservedXml(xml: OpenXmlElement): void;
+    /** Guard + notify after a successful mutation. */
+    protected notifyMutated(): void;
+    /** Throw if preserve-only before a mutation begins. */
+    protected assertMutable(): void;
+}
+/**
+ * Math text leaf (`m:t`) — literal character content inside a math run.
+ *
+ * Source: ECMA-376-1 §22.1.2.116 `CT_Text` — UTF-8 passthrough, no substitution.
+ *
+ * @public
+ */
+export declare class MathText extends MathElement {
+    /**
+     * Math element type for this text leaf (`t`).
+     */
+    readonly type = "t";
+    private _value;
+    private _xmlSpace;
+    constructor(value?: string, xmlSpace?: 'default' | 'preserve');
+    /**
+     * Raw text content of this math text element (full UTF-8, no substitution).
+     */
+    value: string;
+    /**
+     * Optional `xml:space` on `m:t` (`default` | `preserve`), same policy as Word `w:t`.
+     *
+     * @private
+     * Serialization attribute for whitespace fidelity; prefer setting text via {@link value}.
+     */
+    xmlSpace: 'default' | 'preserve' | undefined;
+}
+/**
+ * Argument-size property bag (`m:argPr` → `m:argSz`).
+ *
+ * Source: ECMA-376-4 Annex A.8.1 `CT_OMathArgPr` / `ST_Integer2` (−2..2).
+ *
+ * @public
+ */
+export interface MathArgProperties {
+    readonly argSz?: number;
+}
+/**
+ * Argument container that holds ordered math elements inside a larger structure.
+ *
+ * @public
+ */
+export declare class MathArgument extends MathElement {
+    /**
+     * Discriminator for this math argument container.
+     *
+     * @public
+     */
+    readonly type = "arg";
+    private _properties;
+    private _item;
+    private _ctrlPr;
+    constructor(properties?: MathArgProperties, item?: ReadonlyArray<MathElement>, ctrlPr?: OpenXmlElement);
+    /**
+     * Gets or sets argument properties such as script size.
+     *
+     * @throws MathmlValidationError when script size is outside the allowed integer range.
+     *
+     * @public
+     */
+    properties: Readonly<MathArgProperties>;
+    /**
+     * Gets or sets the ordered math elements inside this argument.
+     *
+     * @public
+     */
+    item: ReadonlyArray<MathElement>;
+    /**
+     * Opaque control properties (`m:ctrlPr`) carried on the argument, when present.
+     *
+     * @private
+     * Wire-fidelity carrier for WML run properties; not part of the public authoring API.
+     */
+    /**
+    * @private
+    */
+    ctrlPr: OpenXmlElement | undefined;
+    /**
+     * Appends one math element at the end of {@link MathArgument.item}.
+     */
+    appendItem(child: MathElement): MathElement;
+}
+/**
+ * Escape hatch for unrecognized `m:*` elements.
+ *
+ * Source: mathml-spec §8.5 — re-serializes verbatim.
+ *
+ * @public
+ */
+export declare class UnknownMathElement extends MathElement {
+    readonly type = "unknown";
+    readonly localName: string;
+    constructor(localName: string, xml: OpenXmlElement);
+}
+/**
+ * Convenience: build MathArgument from a list of elements.
+ *
+ * @private
+ */
+export declare function mathArg(...elements: MathElement[]): MathArgument;