@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/settings/settings-children.d.ts

@@ -0,0 +1,151 @@
+import { OpenXmlElement } from '../../core/xml/index';
+import { AttachedTemplate } from './attached-template';
+import { CompatSettings } from './compat-settings';
+import { DocumentProtection } from './document-protection';
+import { CharacterSpacingControl } from './document-settings-values';
+import { EndnoteProperties, FootnoteProperties } from './footnote-properties';
+import { ZoomSettings } from './zoom';
+/**
+ * `ST_View` wire tokens for `w:view/@w:val` (Transitional `wml.xsd`).
+ *
+ * @public
+ */
+export declare enum DocumentViewType {
+    /** No special view preference. */
+    None = "none",
+    /** Print layout view. */
+    PrintLayout = "print",
+    /** Outline view. */
+    Outline = "outline",
+    /** Master pages view. */
+    MasterPages = "masterPages",
+    /** Normal / draft view. */
+    Normal = "normal",
+    /** Web layout view. */
+    Web = "web"
+}
+/** @private Known `ST_View` wire tokens. */
+export declare type DocumentViewTypeWire = 'none' | 'print' | 'outline' | 'masterPages' | 'normal' | 'web';
+/**
+ * @private
+ * `CT_Settings` sequence local names (Transitional `wml.xsd`).
+ * Used only for insert order when a child is absent.
+ */
+export declare const SETTINGS_CHILD_ORDER: ReadonlyArray<string>;
+/**
+ * Modeled `w:view` child (`CT_View`, `w:val` required on wire).
+ *
+ * Unknown loaded `@w:val` tokens are preserved until an explicit public assignment.
+ *
+ * @private
+ */
+export declare class SettingsViewChild {
+    readonly localName = "view";
+    /** Known ST_View token, or raw loaded string when unsupported. */
+    private value;
+    constructor(value: string);
+    static tryFromElement(element: OpenXmlElement): SettingsViewChild | undefined;
+    read(): string;
+    write(value: string): void;
+    /**
+     * Public enum when the stored token is a known ST_View value; otherwise undefined
+     * (unsupported token preserved until explicit assignment).
+     */
+    asDocumentViewType(): DocumentViewType | undefined;
+    serialize(): OpenXmlElement;
+}
+/** Modeled `w:zoom` child (`CT_Zoom`). */
+export declare class SettingsZoomChild {
+    readonly localName = "zoom";
+    private node;
+    constructor(node: ZoomSettings);
+    static tryFromElement(element: OpenXmlElement): SettingsZoomChild | undefined;
+    zoom(): ZoomSettings;
+    setZoom(node: ZoomSettings): void;
+    serialize(): OpenXmlElement;
+}
+/** Modeled `w:defaultTabStop` child (`CT_TwipsMeasure` on wire; value stored in plain points). */
+export declare class SettingsDefaultTabStopChild {
+    readonly localName = "defaultTabStop";
+    /** Plain points (wire unit is twips). */
+    private value;
+    constructor(value: number);
+    static tryFromElement(element: OpenXmlElement): SettingsDefaultTabStopChild | undefined;
+    read(): number;
+    write(value: number): void;
+    serialize(): OpenXmlElement;
+}
+/** Modeled `w:characterSpacingControl` child (`ST_CharacterSpacing`). */
+export declare class SettingsCharacterSpacingControlChild {
+    readonly localName = "characterSpacingControl";
+    private value;
+    constructor(value: CharacterSpacingControl);
+    static tryFromElement(element: OpenXmlElement): SettingsCharacterSpacingControlChild | undefined;
+    read(): CharacterSpacingControl;
+    write(value: CharacterSpacingControl): void;
+    serialize(): OpenXmlElement;
+}
+/** Opaque-backed shell for unmodeled / unknown `CT_Settings` children. */
+export declare class SettingsOpaqueChild {
+    readonly localName: string;
+    private readonly element;
+    constructor(element: OpenXmlElement);
+    serialize(): OpenXmlElement;
+}
+/** Modeled `CT_OnOff` settings child (MVP: evenAndOdd / trackRevisions / displayBackgroundShape). */
+export declare class SettingsOnOffChild {
+    readonly localName: string;
+    private value;
+    constructor(localName: string, value: boolean);
+    static tryFromElement(element: OpenXmlElement): SettingsOnOffChild | undefined;
+    read(): boolean;
+    write(value: boolean): void;
+    serialize(): OpenXmlElement;
+}
+/** Modeled documentProtection wrapper in the ordered graph. */
+export declare class SettingsDocumentProtectionChild {
+    readonly localName = "documentProtection";
+    private node;
+    constructor(node: DocumentProtection);
+    protection(): DocumentProtection;
+    setProtection(node: DocumentProtection): void;
+    serialize(): OpenXmlElement;
+}
+/** Modeled attachedTemplate wrapper. */
+export declare class SettingsAttachedTemplateChild {
+    readonly localName = "attachedTemplate";
+    private readonly node;
+    constructor(node: AttachedTemplate);
+    template(): AttachedTemplate;
+    serialize(): OpenXmlElement;
+}
+/** Modeled compat wrapper. */
+export declare class SettingsCompatChild {
+    readonly localName = "compat";
+    private readonly node;
+    constructor(node: CompatSettings);
+    compat(): CompatSettings;
+    serialize(): OpenXmlElement;
+}
+/** Modeled footnotePr wrapper. */
+export declare class SettingsFootnotePrChild {
+    readonly localName = "footnotePr";
+    private readonly node;
+    constructor(node: FootnoteProperties);
+    props(): FootnoteProperties;
+    serialize(): OpenXmlElement;
+}
+/** Modeled endnotePr wrapper. */
+export declare class SettingsEndnotePrChild {
+    readonly localName = "endnotePr";
+    private readonly node;
+    constructor(node: EndnoteProperties);
+    props(): EndnoteProperties;
+    serialize(): OpenXmlElement;
+}
+export declare type SettingsChild = SettingsOnOffChild | SettingsViewChild | SettingsZoomChild | SettingsDefaultTabStopChild | SettingsCharacterSpacingControlChild | SettingsDocumentProtectionChild | SettingsAttachedTemplateChild | SettingsCompatChild | SettingsFootnotePrChild | SettingsEndnotePrChild | SettingsOpaqueChild;
+export declare function parseSettingsChild(element: OpenXmlElement): SettingsChild;
+export declare function childLocalName(child: SettingsChild): string;
+export declare function findChildIndex(children: ReadonlyArray<SettingsChild>, localName: string): number;
+export declare function replaceOrInsertChild(children: SettingsChild[], localName: string, next: SettingsChild | undefined): void;
+export declare function serializeSettingsChildren(children: ReadonlyArray<SettingsChild>): OpenXmlElement[];

package/src/features/settings/settings-children.js

@@ -0,0 +1,505 @@
+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 };
+        }
+    };
+};
+/**
+ * Ordered `CT_Settings` child graph helpers.
+ *
+ * Known modeled nodes are first-class; every other child is an opaque shell that
+ * round-trips its `OpenXmlElement`. Insert order follows Transitional `wml.xsd`
+ * `CT_Settings` sequence (`SETTINGS_CHILD_ORDER`).
+ *
+ * @private
+ */
+import { parseOnOff, serializeOnOff } from '../document/on-off';
+import { isWml } from '../document/wml';
+import { AttachedTemplate } from './attached-template';
+import { CompatSettings } from './compat-settings';
+import { DocumentProtection } from './document-protection';
+import { parseDefaultTabStop, serializeDefaultTabStop, parseCharacterSpacingControl, serializeCharacterSpacingControl } from './document-settings-values';
+import { EndnoteProperties, FootnoteProperties } from './footnote-properties';
+import { ZoomSettings } from './zoom';
+import { WML_TRANSITIONAL_NAMESPACE } from '../../core/xml/index';
+import { wmlAttr, wmlElement } from '../document/wml';
+/**
+ * `ST_View` wire tokens for `w:view/@w:val` (Transitional `wml.xsd`).
+ *
+ * @public
+ */
+export var DocumentViewType;
+(function (DocumentViewType) {
+    /** No special view preference. */
+    DocumentViewType["None"] = "none";
+    /** Print layout view. */
+    DocumentViewType["PrintLayout"] = "print";
+    /** Outline view. */
+    DocumentViewType["Outline"] = "outline";
+    /** Master pages view. */
+    DocumentViewType["MasterPages"] = "masterPages";
+    /** Normal / draft view. */
+    DocumentViewType["Normal"] = "normal";
+    /** Web layout view. */
+    DocumentViewType["Web"] = "web";
+})(DocumentViewType || (DocumentViewType = {}));
+function isDocumentViewTypeWire(value) {
+    return (value === 'none' ||
+        value === 'print' ||
+        value === 'outline' ||
+        value === 'masterPages' ||
+        value === 'normal' ||
+        value === 'web');
+}
+/**
+ * @private
+ * `CT_Settings` sequence local names (Transitional `wml.xsd`).
+ * Used only for insert order when a child is absent.
+ */
+export var SETTINGS_CHILD_ORDER = [
+    'writeProtection',
+    'view',
+    'zoom',
+    'removePersonalInformation',
+    'removeDateAndTime',
+    'doNotDisplayPageBoundaries',
+    'displayBackgroundShape',
+    'printPostScriptOverText',
+    'printFractionalCharacterWidth',
+    'printFormsData',
+    'embedTrueTypeFonts',
+    'embedSystemFonts',
+    'saveSubsetFonts',
+    'saveFormsData',
+    'mirrorMargins',
+    'alignBordersAndEdges',
+    'bordersDoNotSurroundHeader',
+    'bordersDoNotSurroundFooter',
+    'gutterAtTop',
+    'hideSpellingErrors',
+    'hideGrammaticalErrors',
+    'activeWritingStyle',
+    'proofState',
+    'formsDesign',
+    'attachedTemplate',
+    'linkStyles',
+    'stylePaneFormatFilter',
+    'stylePaneSortMethod',
+    'documentType',
+    'mailMerge',
+    'revisionView',
+    'trackRevisions',
+    'doNotTrackMoves',
+    'doNotTrackFormatting',
+    'documentProtection',
+    'autoFormatOverride',
+    'styleLockTheme',
+    'styleLockQFSet',
+    'defaultTabStop',
+    'autoHyphenation',
+    'consecutiveHyphenLimit',
+    'hyphenationZone',
+    'doNotHyphenateCaps',
+    'showEnvelope',
+    'summaryLength',
+    'clickAndTypeStyle',
+    'defaultTableStyle',
+    'evenAndOddHeaders',
+    'bookFoldRevPrinting',
+    'bookFoldPrinting',
+    'bookFoldPrintingSheets',
+    'drawingGridHorizontalSpacing',
+    'drawingGridVerticalSpacing',
+    'displayHorizontalDrawingGridEvery',
+    'displayVerticalDrawingGridEvery',
+    'doNotUseMarginsForDrawingGridOrigin',
+    'drawingGridHorizontalOrigin',
+    'drawingGridVerticalOrigin',
+    'doNotShadeFormData',
+    'noPunctuationKerning',
+    'characterSpacingControl',
+    'printTwoOnOne',
+    'strictFirstAndLastChars',
+    'noLineBreaksAfter',
+    'noLineBreaksBefore',
+    'savePreviewPicture',
+    'doNotValidateAgainstSchema',
+    'saveInvalidXml',
+    'ignoreMixedContent',
+    'alwaysShowPlaceholderText',
+    'doNotDemarcateInvalidXml',
+    'saveXmlDataOnly',
+    'useXSLTWhenSaving',
+    'saveThroughXslt',
+    'showXMLTags',
+    'alwaysMergeEmptyNamespace',
+    'updateFields',
+    'hdrShapeDefaults',
+    'footnotePr',
+    'endnotePr',
+    'compat',
+    'docVars',
+    'rsids',
+    'mathPr',
+    'attachedSchema',
+    'themeFontLang',
+    'clrSchemeMapping',
+    'doNotIncludeSubdocsInStats',
+    'doNotAutoCompressPictures',
+    'forceUpgrade',
+    'captions',
+    'readModeInkLockDown',
+    'smartTagType',
+    'schemaLibrary',
+    'shapeDefaults',
+    'doNotEmbedSmartTags',
+    'decimalSymbol',
+    'listSeparator',
+];
+var MODELED_ON_OFF = new Set(['evenAndOddHeaders', 'trackRevisions', 'displayBackgroundShape']);
+/**
+ * Modeled `w:view` child (`CT_View`, `w:val` required on wire).
+ *
+ * Unknown loaded `@w:val` tokens are preserved until an explicit public assignment.
+ *
+ * @private
+ */
+var SettingsViewChild = /** @class */ (function () {
+    function SettingsViewChild(value) {
+        this.localName = 'view';
+        this.value = value;
+    }
+    SettingsViewChild.tryFromElement = function (element) {
+        var e_1, _a;
+        if (!isWml(element, 'view')) {
+            return undefined;
+        }
+        var val;
+        try {
+            for (var _b = __values(element.attributes), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var attr = _c.value;
+                if (attr.localName === 'val' &&
+                    (attr.namespaceUri === WML_TRANSITIONAL_NAMESPACE || attr.namespaceUri === '')) {
+                    val = attr.value;
+                    break;
+                }
+            }
+        }
+        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; }
+        }
+        // CT_View requires @w:val; absent val is not a modeled view child.
+        if (val === undefined) {
+            return undefined;
+        }
+        return new SettingsViewChild(val);
+    };
+    SettingsViewChild.prototype.read = function () {
+        return this.value;
+    };
+    SettingsViewChild.prototype.write = function (value) {
+        this.value = value;
+    };
+    /**
+     * Public enum when the stored token is a known ST_View value; otherwise undefined
+     * (unsupported token preserved until explicit assignment).
+     */
+    SettingsViewChild.prototype.asDocumentViewType = function () {
+        if (!isDocumentViewTypeWire(this.value)) {
+            return undefined;
+        }
+        switch (this.value) {
+            case 'none':
+                return DocumentViewType.None;
+            case 'print':
+                return DocumentViewType.PrintLayout;
+            case 'outline':
+                return DocumentViewType.Outline;
+            case 'masterPages':
+                return DocumentViewType.MasterPages;
+            case 'normal':
+                return DocumentViewType.Normal;
+            case 'web':
+                return DocumentViewType.Web;
+            default:
+                return undefined;
+        }
+    };
+    SettingsViewChild.prototype.serialize = function () {
+        return wmlElement('view', { attributes: [wmlAttr('val', this.value)] });
+    };
+    return SettingsViewChild;
+}());
+export { SettingsViewChild };
+/** Modeled `w:zoom` child (`CT_Zoom`). */
+var SettingsZoomChild = /** @class */ (function () {
+    function SettingsZoomChild(node) {
+        this.localName = 'zoom';
+        this.node = node;
+    }
+    SettingsZoomChild.tryFromElement = function (element) {
+        if (!isWml(element, 'zoom'))
+            return undefined;
+        return new SettingsZoomChild(ZoomSettings.fromElement(element));
+    };
+    SettingsZoomChild.prototype.zoom = function () {
+        return this.node;
+    };
+    SettingsZoomChild.prototype.setZoom = function (node) {
+        this.node = node;
+    };
+    SettingsZoomChild.prototype.serialize = function () {
+        return this.node.serialize();
+    };
+    return SettingsZoomChild;
+}());
+export { SettingsZoomChild };
+/** Modeled `w:defaultTabStop` child (`CT_TwipsMeasure` on wire; value stored in plain points). */
+var SettingsDefaultTabStopChild = /** @class */ (function () {
+    function SettingsDefaultTabStopChild(value) {
+        this.localName = 'defaultTabStop';
+        this.value = value;
+    }
+    SettingsDefaultTabStopChild.tryFromElement = function (element) {
+        if (!isWml(element, 'defaultTabStop'))
+            return undefined;
+        var v = parseDefaultTabStop(element);
+        if (v === undefined)
+            return undefined;
+        return new SettingsDefaultTabStopChild(v);
+    };
+    SettingsDefaultTabStopChild.prototype.read = function () {
+        return this.value;
+    };
+    SettingsDefaultTabStopChild.prototype.write = function (value) {
+        this.value = value;
+    };
+    SettingsDefaultTabStopChild.prototype.serialize = function () {
+        return serializeDefaultTabStop(this.value);
+    };
+    return SettingsDefaultTabStopChild;
+}());
+export { SettingsDefaultTabStopChild };
+/** Modeled `w:characterSpacingControl` child (`ST_CharacterSpacing`). */
+var SettingsCharacterSpacingControlChild = /** @class */ (function () {
+    function SettingsCharacterSpacingControlChild(value) {
+        this.localName = 'characterSpacingControl';
+        this.value = value;
+    }
+    SettingsCharacterSpacingControlChild.tryFromElement = function (element) {
+        if (!isWml(element, 'characterSpacingControl'))
+            return undefined;
+        var v = parseCharacterSpacingControl(element);
+        if (v === undefined)
+            return undefined;
+        return new SettingsCharacterSpacingControlChild(v);
+    };
+    SettingsCharacterSpacingControlChild.prototype.read = function () {
+        return this.value;
+    };
+    SettingsCharacterSpacingControlChild.prototype.write = function (value) {
+        this.value = value;
+    };
+    SettingsCharacterSpacingControlChild.prototype.serialize = function () {
+        return serializeCharacterSpacingControl(this.value);
+    };
+    return SettingsCharacterSpacingControlChild;
+}());
+export { SettingsCharacterSpacingControlChild };
+/** Opaque-backed shell for unmodeled / unknown `CT_Settings` children. */
+var SettingsOpaqueChild = /** @class */ (function () {
+    function SettingsOpaqueChild(element) {
+        this.localName = element.localName;
+        this.element = element;
+    }
+    SettingsOpaqueChild.prototype.serialize = function () {
+        return this.element;
+    };
+    return SettingsOpaqueChild;
+}());
+export { SettingsOpaqueChild };
+/** Modeled `CT_OnOff` settings child (MVP: evenAndOdd / trackRevisions / displayBackgroundShape). */
+var SettingsOnOffChild = /** @class */ (function () {
+    function SettingsOnOffChild(localName, value) {
+        this.localName = localName;
+        this.value = value;
+    }
+    SettingsOnOffChild.tryFromElement = function (element) {
+        if (!MODELED_ON_OFF.has(element.localName) || !isWml(element, element.localName)) {
+            return undefined;
+        }
+        var parsed = parseOnOff(element);
+        if (parsed === undefined) {
+            return undefined;
+        }
+        return new SettingsOnOffChild(element.localName, parsed);
+    };
+    SettingsOnOffChild.prototype.read = function () {
+        return this.value;
+    };
+    SettingsOnOffChild.prototype.write = function (value) {
+        this.value = value;
+    };
+    SettingsOnOffChild.prototype.serialize = function () {
+        return serializeOnOff(this.localName, this.value);
+    };
+    return SettingsOnOffChild;
+}());
+export { SettingsOnOffChild };
+/** Modeled documentProtection wrapper in the ordered graph. */
+var SettingsDocumentProtectionChild = /** @class */ (function () {
+    function SettingsDocumentProtectionChild(node) {
+        this.localName = 'documentProtection';
+        this.node = node;
+    }
+    SettingsDocumentProtectionChild.prototype.protection = function () {
+        return this.node;
+    };
+    SettingsDocumentProtectionChild.prototype.setProtection = function (node) {
+        this.node = node;
+    };
+    SettingsDocumentProtectionChild.prototype.serialize = function () {
+        return this.node.serialize();
+    };
+    return SettingsDocumentProtectionChild;
+}());
+export { SettingsDocumentProtectionChild };
+/** Modeled attachedTemplate wrapper. */
+var SettingsAttachedTemplateChild = /** @class */ (function () {
+    function SettingsAttachedTemplateChild(node) {
+        this.localName = 'attachedTemplate';
+        this.node = node;
+    }
+    SettingsAttachedTemplateChild.prototype.template = function () {
+        return this.node;
+    };
+    SettingsAttachedTemplateChild.prototype.serialize = function () {
+        return this.node.serialize();
+    };
+    return SettingsAttachedTemplateChild;
+}());
+export { SettingsAttachedTemplateChild };
+/** Modeled compat wrapper. */
+var SettingsCompatChild = /** @class */ (function () {
+    function SettingsCompatChild(node) {
+        this.localName = 'compat';
+        this.node = node;
+    }
+    SettingsCompatChild.prototype.compat = function () {
+        return this.node;
+    };
+    SettingsCompatChild.prototype.serialize = function () {
+        return this.node.serialize();
+    };
+    return SettingsCompatChild;
+}());
+export { SettingsCompatChild };
+/** Modeled footnotePr wrapper. */
+var SettingsFootnotePrChild = /** @class */ (function () {
+    function SettingsFootnotePrChild(node) {
+        this.localName = 'footnotePr';
+        this.node = node;
+    }
+    SettingsFootnotePrChild.prototype.props = function () {
+        return this.node;
+    };
+    SettingsFootnotePrChild.prototype.serialize = function () {
+        return this.node.serialize();
+    };
+    return SettingsFootnotePrChild;
+}());
+export { SettingsFootnotePrChild };
+/** Modeled endnotePr wrapper. */
+var SettingsEndnotePrChild = /** @class */ (function () {
+    function SettingsEndnotePrChild(node) {
+        this.localName = 'endnotePr';
+        this.node = node;
+    }
+    SettingsEndnotePrChild.prototype.props = function () {
+        return this.node;
+    };
+    SettingsEndnotePrChild.prototype.serialize = function () {
+        return this.node.serialize();
+    };
+    return SettingsEndnotePrChild;
+}());
+export { SettingsEndnotePrChild };
+export function parseSettingsChild(element) {
+    if (isWml(element, 'documentProtection')) {
+        return new SettingsDocumentProtectionChild(DocumentProtection.fromElement(element));
+    }
+    if (isWml(element, 'attachedTemplate')) {
+        return new SettingsAttachedTemplateChild(AttachedTemplate.fromElement(element));
+    }
+    if (isWml(element, 'compat')) {
+        return new SettingsCompatChild(CompatSettings.fromElement(element));
+    }
+    if (isWml(element, 'footnotePr')) {
+        return new SettingsFootnotePrChild(FootnoteProperties.fromElement(element));
+    }
+    if (isWml(element, 'endnotePr')) {
+        return new SettingsEndnotePrChild(EndnoteProperties.fromElement(element));
+    }
+    var view = SettingsViewChild.tryFromElement(element);
+    if (view !== undefined) {
+        return view;
+    }
+    var zoom = SettingsZoomChild.tryFromElement(element);
+    if (zoom !== undefined)
+        return zoom;
+    var tabStop = SettingsDefaultTabStopChild.tryFromElement(element);
+    if (tabStop !== undefined)
+        return tabStop;
+    var csc = SettingsCharacterSpacingControlChild.tryFromElement(element);
+    if (csc !== undefined)
+        return csc;
+    var onOff = SettingsOnOffChild.tryFromElement(element);
+    if (onOff !== undefined) {
+        return onOff;
+    }
+    return new SettingsOpaqueChild(element);
+}
+export function childLocalName(child) {
+    return child.localName;
+}
+export function findChildIndex(children, localName) {
+    return children.findIndex(function (child) { return child.localName === localName; });
+}
+export function replaceOrInsertChild(children, localName, next) {
+    var existing = findChildIndex(children, localName);
+    if (next === undefined) {
+        if (existing >= 0) {
+            children.splice(existing, 1);
+        }
+        return;
+    }
+    if (existing >= 0) {
+        children[existing] = next;
+        return;
+    }
+    var orderIndex = SETTINGS_CHILD_ORDER.indexOf(localName);
+    var insertAt = children.length;
+    for (var index = 0; index < children.length; index += 1) {
+        var child = children[index];
+        if (child === undefined) {
+            continue;
+        }
+        var other = SETTINGS_CHILD_ORDER.indexOf(child.localName);
+        if (other >= 0 && (orderIndex < 0 || other > orderIndex)) {
+            insertAt = index;
+            break;
+        }
+    }
+    children.splice(insertAt, 0, next);
+}
+export function serializeSettingsChildren(children) {
+    return children.map(function (child) { return child.serialize(); });
+}