@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/settings/footnote-properties.js

@@ -0,0 +1,591 @@
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spread = (this && this.__spread) || function () {
+    for (var ar = [], i = 0; i < arguments.length; i++) ar = ar.concat(__read(arguments[i]));
+    return ar;
+};
+var __values = (this && this.__values) || function (o) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator], i = 0;
+    if (m) return m.call(o);
+    return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+};
+/**
+ * WordDocument-level footnote/endnote properties (`w:footnotePr` / `w:endnotePr`).
+ *
+ * Models `CT_FtnDocProps` / `CT_EdnDocProps` (extends `CT_FtnProps` / `CT_EdnProps`)
+ * from Transitional `wml.xsd`: optional `pos`, `numFmt`, `numStart`, `numRestart`,
+ * plus residual children (separator refs) and leftover root attributes.
+ *
+ * Standards: ECMA-376-1 §17.11; `ST_NumberFormat`, `ST_FtnPos`, `ST_EdnPos`,
+ * `ST_RestartNumber` in `specs/schemas/xsd/OfficeOpenXML-XMLSchema-Transitional/wml.xsd`.
+ *
+ * @public
+ */
+import { WML_TRANSITIONAL_NAMESPACE } from '../../core/xml/index';
+import { elementChildren, isWml, wmlAttr, wmlElement, wValAttribute } from '../document/wml';
+/** Closed `ST_NumberFormat` token set from Transitional `wml.xsd`. */
+var ST_NUMBER_FORMAT = new Set([
+    'decimal',
+    'upperRoman',
+    'lowerRoman',
+    'upperLetter',
+    'lowerLetter',
+    'ordinal',
+    'cardinalText',
+    'ordinalText',
+    'hex',
+    'chicago',
+    'ideographDigital',
+    'japaneseCounting',
+    'aiueo',
+    'iroha',
+    'decimalFullWidth',
+    'decimalHalfWidth',
+    'japaneseLegal',
+    'japaneseDigitalTenThousand',
+    'decimalEnclosedCircle',
+    'decimalFullWidth2',
+    'aiueoFullWidth',
+    'irohaFullWidth',
+    'decimalZero',
+    'bullet',
+    'ganada',
+    'chosung',
+    'decimalEnclosedFullstop',
+    'decimalEnclosedParen',
+    'decimalEnclosedCircleChinese',
+    'ideographEnclosedCircle',
+    'ideographTraditional',
+    'ideographZodiac',
+    'ideographZodiacTraditional',
+    'taiwaneseCounting',
+    'ideographLegalTraditional',
+    'taiwaneseCountingThousand',
+    'taiwaneseDigital',
+    'chineseCounting',
+    'chineseLegalSimplified',
+    'chineseCountingThousand',
+    'koreanDigital',
+    'koreanCounting',
+    'koreanLegal',
+    'koreanDigital2',
+    'vietnameseCounting',
+    'russianLower',
+    'russianUpper',
+    'none',
+    'numberInDash',
+    'hebrew1',
+    'hebrew2',
+    'arabicAlpha',
+    'arabicAbjad',
+    'hindiVowels',
+    'hindiConsonants',
+    'hindiNumbers',
+    'hindiCounting',
+    'thaiLetters',
+    'thaiNumbers',
+    'thaiCounting',
+    'bahtText',
+    'dollarText',
+    'custom',
+]);
+function isFootnotePosition(value) {
+    return (value === 'pageBottom' ||
+        value === 'beneathText' ||
+        value === 'sectEnd' ||
+        value === 'docEnd');
+}
+function isEndnotePosition(value) {
+    return value === 'sectEnd' || value === 'docEnd';
+}
+function isNoteNumberingRestart(value) {
+    return value === 'continuous' || value === 'eachSect' || value === 'eachPage';
+}
+function isNumberFormatToken(value) {
+    return ST_NUMBER_FORMAT.has(value);
+}
+function parseDecimalVal(raw) {
+    if (raw === undefined || !/^-?\d+$/.test(raw)) {
+        return undefined;
+    }
+    return Number.parseInt(raw, 10);
+}
+function isWmlValAttribute(attribute) {
+    return (attribute.localName === 'val' &&
+        (attribute.namespaceUri === WML_TRANSITIONAL_NAMESPACE || attribute.namespaceUri === ''));
+}
+function requireNumberFormat(value) {
+    if (!isNumberFormatToken(value)) {
+        throw new RangeError("numberFormat is not a supported NoteNumberFormat: " + value);
+    }
+}
+function requireFootnotePosition(value) {
+    if (!isFootnotePosition(value)) {
+        throw new RangeError("position is not a supported FootnotePosition: " + value);
+    }
+}
+function requireEndnotePosition(value) {
+    if (!isEndnotePosition(value)) {
+        throw new RangeError("position is not a supported EndnotePosition: " + value);
+    }
+}
+function requireRestart(value) {
+    if (!isNoteNumberingRestart(value)) {
+        throw new RangeError("numberingRestart is not a supported NoteNumberingRestart: " + value);
+    }
+}
+function emptySharedState(onDirty) {
+    return {
+        numberFormat: undefined,
+        numberingStart: undefined,
+        numberingRestart: undefined,
+        numFmtExtraAttributes: [],
+        numFmtChildren: [],
+        numFmtNamespaceDeclarations: [],
+        residualChildren: [],
+        leftoverAttributes: [],
+        namespaceDeclarations: [],
+        onDirty: onDirty,
+    };
+}
+/**
+ * Parse shared CT_FtnProps / CT_EdnProps children.
+ * `tryConsumePos` returns true when the pos child is fully consumed (known token).
+ * Returning false places the child in residual (unknown pos, or duplicate).
+ */
+function parseSharedFromElement(element, onDirty, tryConsumePos) {
+    var e_1, _a;
+    var state = emptySharedState(onDirty);
+    state.leftoverAttributes = __spread(element.attributes);
+    state.namespaceDeclarations = element.namespaceDeclarations;
+    var sawPos = false;
+    var sawNumFmt = false;
+    var sawNumStart = false;
+    var sawNumRestart = false;
+    try {
+        for (var _b = __values(elementChildren(element)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            if (isWml(child, 'pos') && !sawPos) {
+                sawPos = true;
+                if (tryConsumePos(wValAttribute(child))) {
+                    continue;
+                }
+                state.residualChildren.push(child);
+                continue;
+            }
+            if (isWml(child, 'numFmt') && !sawNumFmt) {
+                sawNumFmt = true;
+                var raw = wValAttribute(child);
+                if (raw !== undefined && isNumberFormatToken(raw)) {
+                    state.numberFormat = raw;
+                    state.numFmtExtraAttributes = child.attributes.filter(function (a) { return !isWmlValAttribute(a); });
+                    state.numFmtChildren = __spread(child.children);
+                    state.numFmtNamespaceDeclarations = child.namespaceDeclarations;
+                    continue;
+                }
+                state.residualChildren.push(child);
+                continue;
+            }
+            if (isWml(child, 'numStart') && !sawNumStart) {
+                sawNumStart = true;
+                var n = parseDecimalVal(wValAttribute(child));
+                if (n !== undefined) {
+                    state.numberingStart = n;
+                    continue;
+                }
+                state.residualChildren.push(child);
+                continue;
+            }
+            if (isWml(child, 'numRestart') && !sawNumRestart) {
+                sawNumRestart = true;
+                var raw = wValAttribute(child);
+                if (raw !== undefined && isNoteNumberingRestart(raw)) {
+                    state.numberingRestart = raw;
+                    continue;
+                }
+                state.residualChildren.push(child);
+                continue;
+            }
+            state.residualChildren.push(child);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return state;
+}
+function serializeShared(localName, position, state) {
+    var e_2, _a;
+    var children = [];
+    if (position !== undefined) {
+        children.push(wmlElement('pos', { attributes: [wmlAttr('val', position)] }));
+    }
+    if (state.numberFormat !== undefined) {
+        children.push(wmlElement('numFmt', {
+            attributes: __spread([wmlAttr('val', state.numberFormat)], state.numFmtExtraAttributes),
+            namespaceDeclarations: state.numFmtNamespaceDeclarations,
+            children: state.numFmtChildren,
+        }));
+    }
+    if (state.numberingStart !== undefined) {
+        children.push(wmlElement('numStart', { attributes: [wmlAttr('val', String(state.numberingStart))] }));
+    }
+    if (state.numberingRestart !== undefined) {
+        children.push(wmlElement('numRestart', { attributes: [wmlAttr('val', state.numberingRestart)] }));
+    }
+    try {
+        for (var _b = __values(state.residualChildren), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            children.push(child);
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_2) throw e_2.error; }
+    }
+    return wmlElement(localName, {
+        attributes: state.leftoverAttributes,
+        namespaceDeclarations: state.namespaceDeclarations,
+        children: children,
+    });
+}
+/**
+ * First-class `w:footnotePr` node (`CT_FtnDocProps`).
+ *
+ * @public
+ */
+var FootnoteProperties = /** @class */ (function () {
+    function FootnoteProperties(position, state) {
+        this.positionValue = position;
+        this.state = state;
+    }
+    /**
+     * @private
+     */
+    FootnoteProperties.fromElement = function (element, onDirty) {
+        var position;
+        var state = parseSharedFromElement(element, onDirty, function (raw) {
+            if (raw !== undefined && isFootnotePosition(raw)) {
+                position = raw;
+                return true;
+            }
+            return false;
+        });
+        return new FootnoteProperties(position, state);
+    };
+    /**
+     * @private
+   * Empty node for create path. */
+    FootnoteProperties.create = function (onDirty) {
+        return new FootnoteProperties(undefined, emptySharedState(onDirty));
+    };
+    /**
+     * @private
+   * Bind dirty callback after SettingsPart wraps the node. */
+    FootnoteProperties.prototype.bindDirty = function (onDirty) {
+        this.state.onDirty = onDirty;
+    };
+    FootnoteProperties.prototype.markDirty = function () {
+        this.state.onDirty == null ? undefined : this.state.onDirty();
+    };
+    Object.defineProperty(FootnoteProperties.prototype, "numberFormat", {
+        /**
+         * Display format for automatic footnote numbers (for example `decimal` or
+         * `lowerRoman`). `undefined` when the document does not specify a format.
+         *
+         * @public
+         */
+        get: function () {
+            return this.state.numberFormat;
+        },
+        /**
+         * Set or clear the footnote number format.
+         *
+         * @throws RangeError when `value` is not a supported {@link NoteNumberFormat}.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined) {
+                requireNumberFormat(value);
+            }
+            this.state.numberFormat = value;
+            if (value === undefined) {
+                this.state.numFmtExtraAttributes = [];
+                this.state.numFmtChildren = [];
+                this.state.numFmtNamespaceDeclarations = [];
+            }
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(FootnoteProperties.prototype, "position", {
+        /**
+         * Where footnotes appear relative to body text and sections.
+         * `undefined` when the document does not specify a placement.
+         *
+         * @public
+         */
+        get: function () {
+            return this.positionValue;
+        },
+        /**
+         * Set or clear footnote placement.
+         *
+         * @throws RangeError when `value` is not a supported {@link FootnotePosition}.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined) {
+                requireFootnotePosition(value);
+            }
+            this.positionValue = value;
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(FootnoteProperties.prototype, "initialNoteNumber", {
+        /**
+         * Starting value for automatic footnote numbering.
+         * `undefined` when the document uses the application default (typically `1`).
+         *
+         * @public
+         */
+        get: function () {
+            return this.state.numberingStart;
+        },
+        /**
+         * Set or clear the starting footnote number.
+         *
+         * @throws RangeError when `value` is not a finite integer.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined && (!Number.isInteger(value) || !Number.isFinite(value))) {
+                throw new RangeError("initialNoteNumber must be a finite integer, got " + String(value));
+            }
+            this.state.numberingStart = value;
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(FootnoteProperties.prototype, "numberingRestart", {
+        /**
+         * When automatic footnote numbering restarts (`continuous`, `eachSect`, or
+         * `eachPage`). `undefined` when the document does not specify a restart rule.
+         *
+         * @public
+         */
+        get: function () {
+            return this.state.numberingRestart;
+        },
+        /**
+         * Set or clear the footnote numbering restart rule.
+         *
+         * @throws RangeError when `value` is not a supported {@link NoteNumberingRestart}.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined) {
+                requireRestart(value);
+            }
+            this.state.numberingRestart = value;
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    /**
+     * @private
+     */
+    FootnoteProperties.prototype.serialize = function () {
+        return serializeShared('footnotePr', this.positionValue, this.state);
+    };
+    return FootnoteProperties;
+}());
+export { FootnoteProperties };
+/**
+ * First-class `w:endnotePr` node (`CT_EdnDocProps`).
+ *
+ * @public
+ */
+var EndnoteProperties = /** @class */ (function () {
+    function EndnoteProperties(position, state) {
+        this.positionValue = position;
+        this.state = state;
+    }
+    /**
+     * @private
+     */
+    EndnoteProperties.fromElement = function (element, onDirty) {
+        var position;
+        var state = parseSharedFromElement(element, onDirty, function (raw) {
+            if (raw !== undefined && isEndnotePosition(raw)) {
+                position = raw;
+                return true;
+            }
+            return false;
+        });
+        return new EndnoteProperties(position, state);
+    };
+    /**
+     * @private
+   * Empty node for create path. */
+    EndnoteProperties.create = function (onDirty) {
+        return new EndnoteProperties(undefined, emptySharedState(onDirty));
+    };
+    /**
+     * @private
+     */
+    EndnoteProperties.prototype.bindDirty = function (onDirty) {
+        this.state.onDirty = onDirty;
+    };
+    EndnoteProperties.prototype.markDirty = function () {
+        this.state.onDirty == null ? undefined : this.state.onDirty();
+    };
+    Object.defineProperty(EndnoteProperties.prototype, "numberFormat", {
+        /**
+         * Display format for automatic endnote numbers (for example `decimal` or
+         * `upperRoman`). `undefined` when the document does not specify a format.
+         *
+         * @public
+         */
+        get: function () {
+            return this.state.numberFormat;
+        },
+        /**
+         * Set or clear the endnote number format.
+         *
+         * @throws RangeError when `value` is not a supported {@link NoteNumberFormat}.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined) {
+                requireNumberFormat(value);
+            }
+            this.state.numberFormat = value;
+            if (value === undefined) {
+                this.state.numFmtExtraAttributes = [];
+                this.state.numFmtChildren = [];
+                this.state.numFmtNamespaceDeclarations = [];
+            }
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(EndnoteProperties.prototype, "position", {
+        /**
+         * Where endnotes appear relative to sections and the document end.
+         * `undefined` when the document does not specify a placement.
+         *
+         * @public
+         */
+        get: function () {
+            return this.positionValue;
+        },
+        /**
+         * Set or clear endnote placement.
+         *
+         * @throws RangeError when `value` is not a supported {@link EndnotePosition}.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined) {
+                requireEndnotePosition(value);
+            }
+            this.positionValue = value;
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(EndnoteProperties.prototype, "initialNoteNumber", {
+        /**
+         * Starting value for automatic endnote numbering.
+         * `undefined` when the document uses the application default (typically `1`).
+         *
+         * @public
+         */
+        get: function () {
+            return this.state.numberingStart;
+        },
+        /**
+         * Set or clear the starting endnote number.
+         *
+         * @throws RangeError when `value` is not a finite integer.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined && (!Number.isInteger(value) || !Number.isFinite(value))) {
+                throw new RangeError("initialNoteNumber must be a finite integer, got " + String(value));
+            }
+            this.state.numberingStart = value;
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(EndnoteProperties.prototype, "numberingRestart", {
+        /**
+         * When automatic endnote numbering restarts (`continuous` or `eachSect`).
+         * `undefined` when the document does not specify a restart rule.
+         *
+         * @public
+         */
+        get: function () {
+            return this.state.numberingRestart;
+        },
+        /**
+         * Set or clear the endnote numbering restart rule.
+         *
+         * @throws RangeError when `value` is not a supported {@link NoteNumberingRestart}.
+         * @public
+         */
+        set: function (value) {
+            if (value !== undefined) {
+                requireRestart(value);
+            }
+            this.state.numberingRestart = value;
+            this.markDirty();
+        },
+        enumerable: true,
+        configurable: true
+    });
+    /**
+     * @private
+     */
+    EndnoteProperties.prototype.serialize = function () {
+        return serializeShared('endnotePr', this.positionValue, this.state);
+    };
+    return EndnoteProperties;
+}());
+export { EndnoteProperties };