@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/styles/styles-with-effects.js

@@ -0,0 +1,180 @@
+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 };
+        }
+    };
+};
+import { DocxError } from '../../core/errors/docx-error';
+import { elementChildren, isWml } from '../document/wml';
+import { partName } from '../../core/opc/part-name';
+import { featureId, registerFeature, registerFeaturePartHandler, } from '../../core/registry/index';
+import { parseXml, WML_TRANSITIONAL_NAMESPACE } from '../../core/xml/index';
+var STYLES_WITH_EFFECTS = featureId('styles-with-effects');
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.1 stylesWithEffects relationship. */
+export var STYLES_WITH_EFFECTS_RELATIONSHIP_TYPE = 'http://schemas.microsoft.com/office/2007/relationships/stylesWithEffects';
+/**
+ * @private
+ * `[MS-DOCX]` stylesWithEffects content type (ooxmlsdk StylesWithEffectsPart). */
+export var STYLES_WITH_EFFECTS_CONTENT_TYPE = 'application/vnd.ms-word.stylesWithEffects+xml';
+/**
+ * @private
+ */
+export var STYLES_WITH_EFFECTS_PART_NAME = partName('/word/stylesWithEffects.xml');
+var utf8Decoder = new TextDecoder('utf-8');
+function styleIdAttribute(element) {
+    var found = element.attributes.find(function (attribute) { return attribute.localName === 'styleId' &&
+        (attribute.namespaceUri === WML_TRANSITIONAL_NAMESPACE || attribute.namespaceUri === ''); });
+    return found == null ? undefined : found.value;
+}
+function parseStyleIds(root) {
+    var e_1, _a;
+    if (!isWml(root, 'styles')) {
+        return [];
+    }
+    var styleIds = [];
+    try {
+        for (var _b = __values(elementChildren(root)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            if (!isWml(child, 'style')) {
+                continue;
+            }
+            var styleId = styleIdAttribute(child);
+            if (styleId !== undefined && styleId.length > 0) {
+                styleIds.push(styleId);
+            }
+        }
+    }
+    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 styleIds;
+}
+function parseStyleIdsFromBytes(bytes) {
+    if (bytes.byteLength === 0) {
+        return [];
+    }
+    try {
+        var root = parseXml(utf8Decoder.decode(bytes));
+        return parseStyleIds(root);
+    }
+    catch (_e) {
+        return [];
+    }
+}
+/**
+ * In-memory stylesWithEffects part (`word/stylesWithEffects.xml`).
+ *
+ * @private
+ */
+var StylesWithEffectsPart = /** @class */ (function () {
+    /**
+     * @private
+     */
+    function StylesWithEffectsPart(bytes, styleIdList, dirty) {
+        this.bytes = bytes;
+        this.styleIdList = styleIdList;
+        this.dirty = dirty;
+    }
+    /**
+     * Whether the stylesWithEffects part was present in the package.
+     *
+     * @public
+     */
+    StylesWithEffectsPart.prototype.present = function () {
+        return this.bytes !== undefined;
+    };
+    /**
+     * `w:style/@w:styleId` values in document order.
+     *
+     * @public
+     */
+    StylesWithEffectsPart.prototype.styleIds = function () {
+        return this.styleIdList;
+    };
+    /**
+     * Count of readable style ids.
+     *
+     * @public
+     */
+    StylesWithEffectsPart.prototype.styleCount = function () {
+        return this.styleIdList.length;
+    };
+    /**
+     * @private
+     */
+    StylesWithEffectsPart.prototype.isDirty = function () {
+        return this.dirty;
+    };
+    /**
+     * @private
+     */
+    StylesWithEffectsPart.prototype.serialize = function () {
+        if (this.bytes !== undefined) {
+            return this.bytes;
+        }
+        return new Uint8Array(0);
+    };
+    return StylesWithEffectsPart;
+}());
+export { StylesWithEffectsPart };
+function loadStylesWithEffectsPart(part) {
+    if (part === undefined) {
+        return new StylesWithEffectsPart(undefined, [], false);
+    }
+    var styleIdList = parseStyleIdsFromBytes(part.data);
+    return new StylesWithEffectsPart(part.data, styleIdList, false);
+}
+var stylesWithEffectsRegistered = false;
+/**
+ * @private
+ * Test hook */
+export function resetStylesWithEffectsFeatureForTests() {
+    stylesWithEffectsRegistered = false;
+}
+/**
+ * @private
+ * Register the stylesWithEffects package-part handler. Idempotent. */
+export function registerStylesWithEffectsFeature() {
+    if (stylesWithEffectsRegistered) {
+        return;
+    }
+    stylesWithEffectsRegistered = true;
+    registerFeature({ id: STYLES_WITH_EFFECTS });
+    registerFeaturePartHandler({
+        featureId: STYLES_WITH_EFFECTS,
+        relationshipTypes: [STYLES_WITH_EFFECTS_RELATIONSHIP_TYPE],
+        defaultRelativeTarget: 'stylesWithEffects.xml',
+        partName: STYLES_WITH_EFFECTS_PART_NAME,
+        contentType: STYLES_WITH_EFFECTS_CONTENT_TYPE,
+        loadPart: function (part, ctx) {
+            void ctx;
+            return loadStylesWithEffectsPart(part);
+        },
+    });
+}
+/**
+ * stylesWithEffects part for a document. Requires {@link registerStylesFeature} or
+ * {@link registerStylesWithEffectsFeature}.
+ *
+ * @throws DocxError `UNKNOWN_FEATURE` when the handler was not registered before load.
+ *
+ * @private
+ */
+export function stylesWithEffectsFor(document) {
+    registerStylesWithEffectsFeature();
+    var part = document.featurePart(STYLES_WITH_EFFECTS);
+    if (part === undefined || !(part instanceof StylesWithEffectsPart)) {
+        throw new DocxError('feature/not-registered', 'stylesWithEffects part was not loaded; call registerStylesFeature() before WordDocument.open');
+    }
+    return part;
+}

package/src/features/styles/table-style.d.ts

@@ -0,0 +1,272 @@
+/**
+ * Table style live model (`w:style/@w:type="table"`).
+ *
+ * Owns character/paragraph format facades, base table/row/cell property bags,
+ * and conditional formatting styles (`w:tblStylePr`). Mutations rewrite the
+ * DocxStyle shell and notify the styles host.
+ *
+ * @public
+ */
+import { CharacterFormat, CharacterFormatHost } from '../document/character-format';
+import { Color } from '../document/color';
+import { ParagraphFormat, ParagraphFormatHost, ParagraphFormatSnapshot } from '../document/paragraph-format';
+import { OpenXmlChild, OpenXmlElement } from '../../core/xml/index';
+import { TableShading, TableWidth, TableAlignment, TableLayout } from '../tables/tbl-pr';
+import { TableCellVerticalAlignment, TableCellTextDirection, VerticalMerge } from '../tables/tc-pr';
+import { Borders } from '../tables/borders';
+import { Paddings } from '../tables/paddings';
+import { DocxStyle } from './style';
+import { Style } from './style-base';
+/** Conditional formatting type tokens (`w:tblStylePr/@w:type`). */
+export declare const ConditionalFormattingType: {
+    WholeTable: "wholeTable";
+    FirstRow: "firstRow";
+    LastRow: "lastRow";
+    FirstColumn: "firstColumn";
+    LastColumn: "lastColumn";
+    OddColumnBand: "band1Vert";
+    EvenColumnBand: "band2Vert";
+    OddRowBand: "band1Horz";
+    EvenRowBand: "band2Horz";
+    TopLeftCell: "nwCell";
+    TopRightCell: "neCell";
+    BottomLeftCell: "swCell";
+    BottomRightCell: "seCell";
+};
+export declare type ConditionalFormattingType = (typeof ConditionalFormattingType)[keyof typeof ConditionalFormattingType];
+/**
+ * Host notified when table-style structure mutates.
+ *
+ * @private
+ */
+export interface TableStyleHost {
+    notifyTableStyleMutation(): void;
+}
+/**
+ * Base table properties on a table style (`w:tblPr` under `w:style`).
+ *
+ * @public
+ */
+export declare class TableStyleTableProperties {
+    private readonly owner;
+    private bordersInstance;
+    private paddingsInstance;
+    /** @private */
+    constructor(owner: TableStyle);
+    private readTblPr;
+    private writeTblPr;
+    readonly borders: Borders;
+    cellSpacing: number | undefined;
+    leftIndent: number | undefined;
+    readonly paddings: Paddings;
+    /** @private */
+    preferredWidth: TableWidth | undefined;
+    /** @private */
+    alignment: TableAlignment | undefined;
+    /** @private */
+    layout: TableLayout | undefined;
+    /** @private */
+    shading: TableShading | undefined;
+    /**
+     * Rows per horizontal band on the table style (`w:tblStyleRowBandSize/@w:val`).
+     * Styles.xml only; does not write document-body tblPr. Absent → `undefined`.
+     * Non-finite values throw `RangeError`.
+     *
+     * @public
+     */
+    rowStripe: number | undefined;
+    /**
+     * Columns per vertical band on the table style (`w:tblStyleColBandSize/@w:val`).
+     * Styles.xml only; does not write document-body tblPr. Absent → `undefined`.
+     * Non-finite values throw `RangeError`.
+     *
+     * @public
+     */
+    columnStripe: number | undefined;
+}
+/**
+ * Row properties on a table style (`w:trPr`).
+ *
+ * @public
+ */
+export declare class TableStyleRowProperties {
+    private readonly owner;
+    private readonly isConditional;
+    /** @private */
+    constructor(owner: TableStyle | ConditionalFormattingStyle, isConditional?: boolean);
+    private readTrPr;
+    private writeTrPr;
+    height: number | undefined;
+    allowBreakAcrossPages: boolean;
+    isHeader: boolean;
+}
+/**
+ * Cell properties on a table style (`w:tcPr`).
+ *
+ * @public
+ */
+export declare class TableStyleCellProperties {
+    private readonly owner;
+    private readonly isConditional;
+    private bordersInstance;
+    private paddingsInstance;
+    /** @private */
+    constructor(owner: TableStyle | ConditionalFormattingStyle, isConditional?: boolean);
+    private readTcPr;
+    private writeTcPr;
+    readonly borders: Borders;
+    readonly paddings: Paddings;
+    backgroundColor: Color | undefined;
+    verticalAlignment: TableCellVerticalAlignment | undefined;
+    textDirection: TableCellTextDirection | undefined;
+    /** @private */
+    preferredWidth: TableWidth | undefined;
+    /** @private style-level only; does not mutate body grid merges. */
+    horizontalMerge: VerticalMerge | undefined;
+    /** @private */
+    verticalMerge: VerticalMerge | undefined;
+}
+/**
+ * One conditional formatting block (`w:tblStylePr`).
+ *
+ * @public
+ */
+export declare class ConditionalFormattingStyle implements CharacterFormatHost, ParagraphFormatHost {
+    private readonly parent;
+    private typeValue;
+    private element;
+    private characterFormatInstance;
+    private paragraphFormatInstance;
+    private rowPropertiesInstance;
+    private cellPropertiesInstance;
+    private tablePropertiesInstance;
+    /** @private */
+    constructor(parent: TableStyle, type: ConditionalFormattingType, element: OpenXmlElement);
+    readonly conditionalFormattingType: ConditionalFormattingType;
+    readonly characterFormat: CharacterFormat;
+    readonly paragraphFormat: ParagraphFormat;
+    readonly rowProperties: TableStyleRowProperties;
+    readonly cellProperties: TableStyleCellProperties;
+    /** Conditional table properties (`w:tblPr` inside tblStylePr). */
+    readonly tableProperties: TableStyleTablePropertiesBridge;
+    /** @private */
+    notifyCharacterFormatMutation(): void;
+    /** @private */
+    notifyParagraphFormatMutation(): void;
+    /** @private */
+    notifyStructureMutation(): void;
+    private syncFormatsToElement;
+    /** @private */
+    readChild(localName: string): OpenXmlElement | undefined;
+    /**
+     * Replace/remove a property child and keep OOXML child order.
+     * @private
+     */
+    writeChild(localName: string, next: OpenXmlElement | undefined): void;
+    private writeChildInternal;
+    /** @private */
+    toElement(): OpenXmlElement;
+}
+/**
+ * Minimal table-props bridge for conditional blocks (borders/shading subset).
+ *
+ * @public
+ */
+export declare class TableStyleTablePropertiesBridge {
+    private readonly owner;
+    private bordersInstance;
+    /** @private */
+    constructor(owner: ConditionalFormattingStyle);
+    private readTblPr;
+    private writeTblPr;
+    readonly borders: Borders;
+    shading: TableShading | undefined;
+}
+/**
+ * Collection of conditional formatting styles on a TableStyle.
+ *
+ * @public
+ */
+export declare class ConditionalFormattingStyleCollection {
+    private readonly owner;
+    /** @private */
+    constructor(owner: TableStyle);
+    readonly count: number;
+    item(index: number): ConditionalFormattingStyle;
+    findByType(type: ConditionalFormattingType): ConditionalFormattingStyle | undefined;
+    add(type: ConditionalFormattingType): ConditionalFormattingStyle;
+    clear(): void;
+}
+/**
+ * Live table style (`w:style` type=table).
+ *
+ * @public
+ */
+export declare class TableStyle extends Style implements CharacterFormatHost, ParagraphFormatHost {
+    private host;
+    /** Base-style paragraph format (`w:pPr`); character format uses Style base facade. */
+    private readonly paragraphFormatValue;
+    private tablePropertiesInstance;
+    private rowPropertiesInstance;
+    private cellPropertiesInstance;
+    private conditionalCollection;
+    private conditionalCache;
+    /** @private */
+    constructor(shell: DocxStyle, host?: TableStyleHost);
+    /** @private */
+    bindHost(host: TableStyleHost): void;
+    /**
+     * Style-level paragraph formatting (`w:pPr`). Stable facade identity.
+     *
+     * @public
+     */
+    readonly paragraphFormat: ParagraphFormat;
+    readonly tableProperties: TableStyleTableProperties;
+    readonly rowProperties: TableStyleRowProperties;
+    readonly cellProperties: TableStyleCellProperties;
+    /**
+     * Conditional table formatting styles (`w:tblStylePr`).
+     *
+     * @public
+     */
+    readonly conditionalFormattingStyles: ConditionalFormattingStyleCollection;
+    /**
+     * @private
+     */
+    protected hydrateParagraphFormat(snapshot: ParagraphFormatSnapshot): void;
+    /**
+     * @private
+     */
+    protected serializeParagraphProperties(out: OpenXmlChild[]): void;
+    /**
+     * Table styles require schema order: meta → pPr → rPr → tblPr → trPr → tcPr → tblStylePr*.
+     * Base {@link Style.serialize} emits opaque children before pPr/rPr; reorder here.
+     *
+     * @private
+     */
+    serialize(): OpenXmlElement;
+    /** @private */
+    notifyCharacterFormatMutation(): void;
+    /** @private */
+    notifyParagraphFormatMutation(): void;
+    private notifyHost;
+    /**
+     * @private
+     * Read a base property child from the style shell (pPr/rPr/tblPr/trPr/tcPr).
+     */
+    readBaseChild(localName: string): OpenXmlElement | undefined;
+    /**
+     * @private
+     * Replace a base property child and rewrite the DocxStyle shell.
+     */
+    writeBaseChild(localName: string, next: OpenXmlElement | undefined): void;
+    private replaceShellFromChildren;
+    /** @private */
+    listConditional(): ConditionalFormattingStyle[];
+    /** @private */
+    addConditionalElement(type: ConditionalFormattingType, el: OpenXmlElement): ConditionalFormattingStyle;
+    /** @private */
+    replaceConditionalElement(type: ConditionalFormattingType, el: OpenXmlElement): void;
+    /** @private */
+    clearConditionals(): void;
+}