@syncfusion/ej2-docx 0.0.0-stage → 35.1.40

package/src/features/sections/page-size.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Page size dimensions in points (`CT_PageSz` width/height only).
+ *
+ * Canonical interface lives in core; re-exported for the sections surface.
+ * Orientation is owned by {@link PageSetup}, not by size values.
+ *
+ * @public
+ */
+export { SizeF } from '../document/page-setup';
+import { SizeF } from '../document/page-setup';
+/**
+ * Immutable page-size presets (points).
+ *
+ * Assigning a preset to {@link PageSetup.pageSize} copies width/height and never
+ * mutates the static preset.
+ *
+ * @public
+ */
+export declare class PageSize {
+    /** A3 — 842 × 1190 pt. */
+    static readonly A3: SizeF;
+    /** A4 — 595 × 842 pt. */
+    static readonly A4: SizeF;
+    /** A5 — 421 × 595 pt. */
+    static readonly A5: SizeF;
+    /** A6 — 297 × 421 pt. */
+    static readonly A6: SizeF;
+    /** B4 — 709 × 1002 pt. */
+    static readonly B4: SizeF;
+    /** B5 — 501 × 709 pt. */
+    static readonly B5: SizeF;
+    /** B6 — 501 × 354 pt (landscape preset dimensions). */
+    static readonly B6: SizeF;
+    /** US Letter — 612 × 792 pt. */
+    static readonly Letter: SizeF;
+    /** Half letter — 396 × 612 pt. */
+    static readonly HalfLetter: SizeF;
+    /** 11×17 tabloid portrait dimensions — 792 × 1224 pt. */
+    static readonly Letter11x17: SizeF;
+    /** Envelope DL — 312 × 624 pt. */
+    static readonly EnvelopeDL: SizeF;
+    /** Quarto — 610 × 780 pt. */
+    static readonly Quarto: SizeF;
+    /** Statement — 396 × 612 pt. */
+    static readonly Statement: SizeF;
+    /** Ledger — 1224 × 792 pt. */
+    static readonly Ledger: SizeF;
+    /** Tabloid — 792 × 1224 pt. */
+    static readonly Tabloid: SizeF;
+    /** Note — 540 × 720 pt. */
+    static readonly Note: SizeF;
+    /** Legal — 612 × 1008 pt. */
+    static readonly Legal: SizeF;
+    /** Flsa — 612 × 936 pt. */
+    static readonly Flsa: SizeF;
+    /** Executive — 522 × 756 pt. */
+    static readonly Executive: SizeF;
+    private constructor();
+}

package/src/features/sections/page-size.js

@@ -0,0 +1,68 @@
+/**
+ * Page size dimensions in points (`CT_PageSz` width/height only).
+ *
+ * Canonical interface lives in core; re-exported for the sections surface.
+ * Orientation is owned by {@link PageSetup}, not by size values.
+ *
+ * @public
+ */
+export { SizeF } from '../document/page-setup';
+import { SizeF } from '../document/page-setup';
+function freezeSize(width, height) {
+    // Presets are SizeF instances; PageSetup.pageSize copies width/height and
+    // never mutates the static preset identity.
+    return new SizeF(width, height);
+}
+/**
+ * Immutable page-size presets (points).
+ *
+ * Assigning a preset to {@link PageSetup.pageSize} copies width/height and never
+ * mutates the static preset.
+ *
+ * @public
+ */
+var PageSize = /** @class */ (function () {
+    function PageSize() {
+        /* static presets only */
+    }
+    /** A3 — 842 × 1190 pt. */
+    PageSize.A3 = freezeSize(842, 1190);
+    /** A4 — 595 × 842 pt. */
+    PageSize.A4 = freezeSize(595, 842);
+    /** A5 — 421 × 595 pt. */
+    PageSize.A5 = freezeSize(421, 595);
+    /** A6 — 297 × 421 pt. */
+    PageSize.A6 = freezeSize(297, 421);
+    /** B4 — 709 × 1002 pt. */
+    PageSize.B4 = freezeSize(709, 1002);
+    /** B5 — 501 × 709 pt. */
+    PageSize.B5 = freezeSize(501, 709);
+    /** B6 — 501 × 354 pt (landscape preset dimensions). */
+    PageSize.B6 = freezeSize(501, 354);
+    /** US Letter — 612 × 792 pt. */
+    PageSize.Letter = freezeSize(612, 792);
+    /** Half letter — 396 × 612 pt. */
+    PageSize.HalfLetter = freezeSize(396, 612);
+    /** 11×17 tabloid portrait dimensions — 792 × 1224 pt. */
+    PageSize.Letter11x17 = freezeSize(792, 1224);
+    /** Envelope DL — 312 × 624 pt. */
+    PageSize.EnvelopeDL = freezeSize(312, 624);
+    /** Quarto — 610 × 780 pt. */
+    PageSize.Quarto = freezeSize(610, 780);
+    /** Statement — 396 × 612 pt. */
+    PageSize.Statement = freezeSize(396, 612);
+    /** Ledger — 1224 × 792 pt. */
+    PageSize.Ledger = freezeSize(1224, 792);
+    /** Tabloid — 792 × 1224 pt. */
+    PageSize.Tabloid = freezeSize(792, 1224);
+    /** Note — 540 × 720 pt. */
+    PageSize.Note = freezeSize(540, 720);
+    /** Legal — 612 × 1008 pt. */
+    PageSize.Legal = freezeSize(612, 1008);
+    /** Flsa — 612 × 936 pt. */
+    PageSize.Flsa = freezeSize(612, 936);
+    /** Executive — 522 × 756 pt. */
+    PageSize.Executive = freezeSize(522, 756);
+    return PageSize;
+}());
+export { PageSize };

package/src/features/sections/section-break-code.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Section break kind (`ST_SectionMark` mapped to public names).
+ *
+ * @public
+ */
+export declare enum SectionBreakCode {
+    /** Next section begins on a new page. */
+    NewPage = "NewPage",
+    /** Next section continues on the same page. */
+    Continuous = "Continuous",
+    /** Next section begins in the next column. */
+    NewColumn = "NewColumn",
+    /** Next section begins on the next even-numbered page. */
+    EvenPage = "EvenPage",
+    /** Next section begins on the next odd-numbered page. */
+    OddPage = "OddPage"
+}
+/** Wire `ST_SectionMark` values used in `w:type/@w:val`. */
+export declare type SectionMarkWire = 'newPage' | 'continuous' | 'nextColumn' | 'evenPage' | 'oddPage';
+/**
+ * @private
+ */
+export declare function breakCodeToWire(code: SectionBreakCode): SectionMarkWire;
+/**
+ * @private
+ */
+export declare function wireToBreakCode(wire: SectionMarkWire | undefined): SectionBreakCode;

package/src/features/sections/section-break-code.js

@@ -0,0 +1,60 @@
+/**
+ * Section break kind (`ST_SectionMark` mapped to public names).
+ *
+ * @public
+ */
+export var SectionBreakCode;
+(function (SectionBreakCode) {
+    /** Next section begins on a new page. */
+    SectionBreakCode["NewPage"] = "NewPage";
+    /** Next section continues on the same page. */
+    SectionBreakCode["Continuous"] = "Continuous";
+    /** Next section begins in the next column. */
+    SectionBreakCode["NewColumn"] = "NewColumn";
+    /** Next section begins on the next even-numbered page. */
+    SectionBreakCode["EvenPage"] = "EvenPage";
+    /** Next section begins on the next odd-numbered page. */
+    SectionBreakCode["OddPage"] = "OddPage";
+})(SectionBreakCode || (SectionBreakCode = {}));
+/**
+ * @private
+ */
+export function breakCodeToWire(code) {
+    switch (code) {
+        case SectionBreakCode.NewPage:
+            return 'newPage';
+        case SectionBreakCode.Continuous:
+            return 'continuous';
+        case SectionBreakCode.NewColumn:
+            return 'nextColumn';
+        case SectionBreakCode.EvenPage:
+            return 'evenPage';
+        case SectionBreakCode.OddPage:
+            return 'oddPage';
+        default: {
+            var _exhaustive = code;
+            void _exhaustive;
+            return 'newPage';
+        }
+    }
+}
+/**
+ * @private
+ */
+export function wireToBreakCode(wire) {
+    switch (wire) {
+        case undefined:
+        case 'newPage':
+            return SectionBreakCode.NewPage;
+        case 'continuous':
+            return SectionBreakCode.Continuous;
+        case 'nextColumn':
+            return SectionBreakCode.NewColumn;
+        case 'evenPage':
+            return SectionBreakCode.EvenPage;
+        case 'oddPage':
+            return SectionBreakCode.OddPage;
+        default:
+            return SectionBreakCode.NewPage;
+    }
+}

package/src/features/sections/section-document-association.d.ts

@@ -0,0 +1,18 @@
+import { WordDocument } from '../document/document';
+/**
+ * Record which document owns this page setup (for settings / header-footer bridges).
+ *
+ * @private
+ */
+export declare function associatePageSetupDocument(pageSetup: object, document: WordDocument): void;
+/**
+ * @private
+ * Bridge name kept while call sites migrate off `SectionProperties`.
+ */
+export declare function associateSectionPropertiesDocument(pageSetup: object, document: WordDocument): void;
+/**
+ * Document previously associated with this page setup, if any.
+ *
+ * @private
+ */
+export declare function ownerDocumentOf(pageSetup: object): WordDocument | undefined;

package/src/features/sections/section-document-association.js

@@ -0,0 +1,31 @@
+/**
+ * Owning document for a {@link PageSetup} instance (even/odd headers via settings).
+ * Soft association — does not imply package ownership of the properties object alone.
+ *
+ * Keyed by object identity with a structural type so this module does not import
+ * `page-setup.ts` (avoids a circular dependency under TS 3.3).
+ */
+var pageSetupOwnerDocuments = new WeakMap();
+/**
+ * Record which document owns this page setup (for settings / header-footer bridges).
+ *
+ * @private
+ */
+export function associatePageSetupDocument(pageSetup, document) {
+    pageSetupOwnerDocuments.set(pageSetup, document);
+}
+/**
+ * @private
+ * Bridge name kept while call sites migrate off `SectionProperties`.
+ */
+export function associateSectionPropertiesDocument(pageSetup, document) {
+    associatePageSetupDocument(pageSetup, document);
+}
+/**
+ * Document previously associated with this page setup, if any.
+ *
+ * @private
+ */
+export function ownerDocumentOf(pageSetup) {
+    return pageSetupOwnerDocuments.get(pageSetup);
+}

package/src/features/sections/section-validation.d.ts

@@ -0,0 +1,43 @@
+import { PageOrientation } from './page-orientation';
+import { PageNumberStyle } from './page-number-style';
+import { SectionBreakCode } from './section-break-code';
+/** Twips range for page size / margins (0–22 in). */
+export declare const TWIPS_MAX = 31680;
+/** Schema max for `w:cols/w:col` (`CT_Columns`). */
+export declare const TEXT_COLUMNS_MAX = 45;
+/** Default equal-column gap: 0.5 in (720 twips → points). */
+export declare const DEFAULT_COLUMN_SPACE: number;
+/**
+ * @private
+ */
+export declare function sectionsError(message: string): Error;
+/**
+ * Validate a section length in points against the 0…31680 twips range.
+ *
+ * @private
+ */
+export declare function validateSectionLength(value: number, label: string): number;
+/**
+ * @private
+ */
+export declare function validatePageOrientation(value: PageOrientation): PageOrientation;
+/**
+ * @private
+ */
+export declare function validateSectionBreakCode(value: SectionBreakCode): SectionBreakCode;
+/**
+ * @private
+ */
+export declare function validatePageNumberStyle(value: PageNumberStyle): PageNumberStyle;
+/**
+ * @private
+ */
+export declare function validatePositiveInteger(value: number, label: string): number;
+/**
+ * @private
+ */
+export declare function validateNonNegativeInteger(value: number, label: string): number;
+/**
+ * @private
+ */
+export declare function validateColumnCount(count: number): number;

package/src/features/sections/section-validation.js

@@ -0,0 +1,97 @@
+import { pointToTwips, twipsToPoint } from '../document/length';
+import { PageOrientation } from './page-orientation';
+import { isPageNumberStyleWire } from './page-number-style';
+import { SectionBreakCode } from './section-break-code';
+/** Twips range for page size / margins (0–22 in). */
+export var TWIPS_MAX = 31680;
+/** Schema max for `w:cols/w:col` (`CT_Columns`). */
+export var TEXT_COLUMNS_MAX = 45;
+/** Default equal-column gap: 0.5 in (720 twips → points). */
+export var DEFAULT_COLUMN_SPACE = twipsToPoint(720);
+/**
+ * @private
+ */
+export function sectionsError(message) {
+    return new Error("sections: " + message);
+}
+/**
+ * Validate a section length in points against the 0…31680 twips range.
+ *
+ * @private
+ */
+export function validateSectionLength(value, label) {
+    var twips = pointToTwips(value);
+    if (!Number.isFinite(twips) || twips < 0 || twips > TWIPS_MAX) {
+        throw sectionsError(label + " must be in 0\u2026" + String(TWIPS_MAX) + " twips (0\u201322 in)");
+    }
+    return value;
+}
+/**
+ * @private
+ */
+export function validatePageOrientation(value) {
+    switch (value) {
+        case PageOrientation.Portrait:
+        case PageOrientation.Landscape:
+            return value;
+        default: {
+            var _exhaustive = value;
+            void _exhaustive;
+            throw sectionsError("orientation must be PageOrientation.Portrait or PageOrientation.Landscape");
+        }
+    }
+}
+/**
+ * @private
+ */
+export function validateSectionBreakCode(value) {
+    switch (value) {
+        case SectionBreakCode.NewPage:
+        case SectionBreakCode.Continuous:
+        case SectionBreakCode.NewColumn:
+        case SectionBreakCode.EvenPage:
+        case SectionBreakCode.OddPage:
+            return value;
+        default: {
+            var _exhaustive = value;
+            void _exhaustive;
+            throw sectionsError("breakCode must be a valid SectionBreakCode value");
+        }
+    }
+}
+/**
+ * @private
+ */
+export function validatePageNumberStyle(value) {
+    if (!isPageNumberStyleWire(value)) {
+        throw sectionsError('pageNumberStyle is not a supported PageNumberStyle value');
+    }
+    return value;
+}
+/**
+ * @private
+ */
+export function validatePositiveInteger(value, label) {
+    if (!Number.isInteger(value) || value < 1) {
+        throw sectionsError(label + " must be an integer \u2265 1");
+    }
+    return value;
+}
+/**
+ * @private
+ */
+export function validateNonNegativeInteger(value, label) {
+    if (!Number.isInteger(value) || value < 0) {
+        throw sectionsError(label + " must be a non-negative integer");
+    }
+    return value;
+}
+/**
+ * @private
+ */
+export function validateColumnCount(count) {
+    if (!Number.isInteger(count) || count < 1 || count > TEXT_COLUMNS_MAX) {
+        throw sectionsError("columns.count must be an integer in 1\u2026" + String(TEXT_COLUMNS_MAX));
+    }
+    return count;
+}

package/src/features/settings/attached-template.d.ts

@@ -0,0 +1,35 @@
+/**
+ * `w:attachedTemplate` DOM (`CT_Rel`, Transitional `wml.xsd`).
+ *
+ * Holds the relationship id (`r:id`) and preserves other attributes/children.
+ * Target resolution stays on the package relationships (no network fetch).
+ *
+ * @public
+ */
+import { OpenXmlElement } from '../../core/xml/index';
+/**
+ * First-class `w:attachedTemplate` node.
+ *
+ * @private
+ */
+export declare class AttachedTemplate {
+    private relationshipId;
+    private readonly otherAttributes;
+    private readonly elementChildren;
+    private readonly namespaceDeclarations;
+    private constructor();
+    /**
+     * @private
+     */
+    static fromElement(element: OpenXmlElement): AttachedTemplate;
+    /**
+     * Relationship id (`r:id`), or `undefined` when absent.
+     *
+     * @public
+     */
+    id(): string | undefined;
+    /**
+     * @private
+     */
+    serialize(): OpenXmlElement;
+}

package/src/features/settings/attached-template.js

@@ -0,0 +1,98 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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;
+};
+import { wmlElement } from '../document/wml';
+var OFFICE_RELATIONSHIPS_NAMESPACE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships';
+function relationshipIdAttribute(element) {
+    var found = element.attributes.find(function (attribute) { return attribute.localName === 'id' &&
+        (attribute.namespaceUri === OFFICE_RELATIONSHIPS_NAMESPACE ||
+            attribute.prefix === 'r' ||
+            attribute.namespaceUri === ''); });
+    return found == null ? undefined : found.value;
+}
+/**
+ * First-class `w:attachedTemplate` node.
+ *
+ * @private
+ */
+var AttachedTemplate = /** @class */ (function () {
+    function AttachedTemplate(relationshipId, otherAttributes, elementChildren, namespaceDeclarations) {
+        this.relationshipId = relationshipId;
+        this.otherAttributes = otherAttributes;
+        this.elementChildren = elementChildren;
+        this.namespaceDeclarations = namespaceDeclarations;
+    }
+    /**
+     * @private
+     */
+    AttachedTemplate.fromElement = function (element) {
+        var id = relationshipIdAttribute(element);
+        var other = element.attributes.filter(function (attribute) {
+            if (attribute.localName !== 'id') {
+                return true;
+            }
+            return !(attribute.namespaceUri === OFFICE_RELATIONSHIPS_NAMESPACE ||
+                attribute.prefix === 'r' ||
+                attribute.namespaceUri === '');
+        });
+        var idAttr = element.attributes.find(function (attribute) {
+            if (attribute.localName !== 'id') {
+                return false;
+            }
+            return (attribute.namespaceUri === OFFICE_RELATIONSHIPS_NAMESPACE ||
+                attribute.prefix === 'r' ||
+                attribute.namespaceUri === '');
+        });
+        var attrs = __spread(other);
+        if (idAttr !== undefined) {
+            attrs.unshift(idAttr);
+        }
+        return new AttachedTemplate(id, attrs, __spread(element.children), element.namespaceDeclarations);
+    };
+    /**
+     * Relationship id (`r:id`), or `undefined` when absent.
+     *
+     * @public
+     */
+    AttachedTemplate.prototype.id = function () {
+        return this.relationshipId;
+    };
+    /**
+     * @private
+     */
+    AttachedTemplate.prototype.serialize = function () {
+        return wmlElement('attachedTemplate', __assign({ attributes: this.otherAttributes, children: this.elementChildren }, (this.namespaceDeclarations.length > 0
+            ? { namespaceDeclarations: this.namespaceDeclarations }
+            : {})));
+    };
+    return AttachedTemplate;
+}());
+export { AttachedTemplate };