@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/document/element-type.d.ts

@@ -0,0 +1,68 @@
+import { BodyItem } from './body-item';
+import { ParagraphItem } from './text-range';
+/**
+ * Coarse public kind for a body child when walking {@link BodyItem} lists
+ * (`Body.items`, `Header.items`, table cells, note bodies, …).
+ *
+ * Prefer this with {@link elementTypeOf} for `switch` branching; use
+ * {@link isTableBlock} / {@link isBlockContentControl} to narrow feature payloads.
+ *
+ * @public
+ */
+export declare type ElementType = 'paragraph' | 'table' | 'blockContentControl' | 'opaque' | 'feature';
+/**
+ * Classify a {@link BodyItem} for switch-friendly type discrimination.
+ *
+ * - Paragraph instance → `'paragraph'`
+ * - Table feature block / instance → `'table'`
+ * - Block content control → `'blockContentControl'`
+ * - Other modeled feature blocks → `'feature'`
+ * - Preserved unmodeled markup → `'opaque'`
+ *
+ * Always-on tables and content-controls register before consumers walk body
+ * items from the main entry; unregistered domains still return `'feature'` or
+ * `'opaque'` rather than throwing.
+ *
+ * Public {@link BodyItem} is an instance union (no wrapper `type` tags).
+ * Discriminate with {@link isParagraphBodyItem} and feature guards.
+ *
+ * @param item - Body child from any body-shaped list.
+ * @returns Coarse {@link ElementType} tag.
+ *
+ * @public
+ */
+export declare function elementTypeOf(item: BodyItem): ElementType;
+/**
+ * Public kind for a paragraph child when walking {@link Paragraph.items}.
+ *
+ * Feature-owned payloads (images, hyperlinks, fields, …) are classified by
+ * registered {@link registerParagraphElementClassifier} handlers or by their
+ * known feature id fallbacks — never as a public `'feature'` tag.
+ *
+ * @public
+ */
+export declare type ParagraphElementType = 'textRange' | 'break' | 'tab' | 'carriageReturn' | 'symbol' | 'image' | 'hyperlink' | 'field' | 'bookmark' | 'shape' | 'inlineContentControl' | 'comment' | 'editableRange' | 'ole' | 'revision' | 'note' | 'opaque' | 'unknown';
+declare type ParagraphElementClassifier = (item: ParagraphItem) => ParagraphElementType | undefined;
+/**
+ * Register a feature-provided classifier used by {@link paragraphElementTypeOf}.
+ * Classifiers run in registration order; the first non-undefined result wins.
+ *
+ * @private
+ */
+export declare function registerParagraphElementClassifier(classifier: ParagraphElementClassifier): void;
+/** @private Test hook */
+export declare function resetParagraphElementClassifiersForTests(): void;
+/**
+ * Classify a {@link ParagraphItem} for switch-friendly type discrimination.
+ *
+ * Built-in tags cover text, breaks, tabs, symbols, and opaque markup. Feature
+ * modules map their payloads (image, hyperlink, …) via registered classifiers
+ * or known feature-id fallbacks. There is no public `'feature'` tag.
+ *
+ * @param item - Child of {@link Paragraph.items}.
+ * @returns Coarse {@link ParagraphElementType} tag.
+ *
+ * @public
+ */
+export declare function paragraphElementTypeOf(item: ParagraphItem): ParagraphElementType;
+export {};

package/src/features/document/element-type.js

@@ -0,0 +1,133 @@
+import { isParagraphBodyItem } from './body-item';
+import { isTableBlock } from '../tables/index';
+import { isBlockContentControl } from '../content-controls/index';
+import { Break, CarriageReturn, FeatureInlineParagraphItem, FeatureRunParagraphItem, OpaqueParagraphItem, OpaqueRunItem, Symbol, Tab, TextRange, } from './text-range';
+/**
+ * Classify a {@link BodyItem} for switch-friendly type discrimination.
+ *
+ * - Paragraph instance → `'paragraph'`
+ * - Table feature block / instance → `'table'`
+ * - Block content control → `'blockContentControl'`
+ * - Other modeled feature blocks → `'feature'`
+ * - Preserved unmodeled markup → `'opaque'`
+ *
+ * Always-on tables and content-controls register before consumers walk body
+ * items from the main entry; unregistered domains still return `'feature'` or
+ * `'opaque'` rather than throwing.
+ *
+ * Public {@link BodyItem} is an instance union (no wrapper `type` tags).
+ * Discriminate with {@link isParagraphBodyItem} and feature guards.
+ *
+ * @param item - Body child from any body-shaped list.
+ * @returns Coarse {@link ElementType} tag.
+ *
+ * @public
+ */
+export function elementTypeOf(item) {
+    if (isParagraphBodyItem(item)) {
+        return 'paragraph';
+    }
+    if (isTableBlock(item)) {
+        return 'table';
+    }
+    if (isBlockContentControl(item)) {
+        return 'blockContentControl';
+    }
+    return 'feature';
+}
+var paragraphElementClassifiers = [];
+/**
+ * Register a feature-provided classifier used by {@link paragraphElementTypeOf}.
+ * Classifiers run in registration order; the first non-undefined result wins.
+ *
+ * @private
+ */
+export function registerParagraphElementClassifier(classifier) {
+    paragraphElementClassifiers.push(classifier);
+}
+/** @private Test hook */
+export function resetParagraphElementClassifiersForTests() {
+    paragraphElementClassifiers.length = 0;
+}
+function featureIdOf(item) {
+    if (item instanceof FeatureRunParagraphItem || item instanceof FeatureInlineParagraphItem) {
+        return item.featureId;
+    }
+    return undefined;
+}
+/**
+ * Classify a {@link ParagraphItem} for switch-friendly type discrimination.
+ *
+ * Built-in tags cover text, breaks, tabs, symbols, and opaque markup. Feature
+ * modules map their payloads (image, hyperlink, …) via registered classifiers
+ * or known feature-id fallbacks. There is no public `'feature'` tag.
+ *
+ * @param item - Child of {@link Paragraph.items}.
+ * @returns Coarse {@link ParagraphElementType} tag.
+ *
+ * @public
+ */
+export function paragraphElementTypeOf(item) {
+    if (item instanceof TextRange) {
+        return 'textRange';
+    }
+    if (item instanceof Break) {
+        return 'break';
+    }
+    if (item instanceof Tab) {
+        return 'tab';
+    }
+    if (item instanceof CarriageReturn) {
+        return 'carriageReturn';
+    }
+    if (item instanceof Symbol) {
+        return 'symbol';
+    }
+    if (item instanceof OpaqueParagraphItem || item instanceof OpaqueRunItem) {
+        return 'opaque';
+    }
+    for (var i = 0; i < paragraphElementClassifiers.length; i += 1) {
+        var hit = paragraphElementClassifiers[i](item);
+        if (hit !== undefined) {
+            return hit;
+        }
+    }
+    var id = featureIdOf(item);
+    if (id !== undefined) {
+        var key = String(id);
+        if (key === 'images') {
+            return 'image';
+        }
+        if (key === 'hyperlinks') {
+            return 'hyperlink';
+        }
+        if (key === 'fields') {
+            return 'field';
+        }
+        if (key === 'bookmarks') {
+            return 'bookmark';
+        }
+        if (key === 'drawing') {
+            return 'shape';
+        }
+        if (key === 'content-controls') {
+            return 'inlineContentControl';
+        }
+        if (key === 'comments') {
+            return 'comment';
+        }
+        if (key === 'editable-ranges') {
+            return 'editableRange';
+        }
+        if (key === 'ole-object' || key === 'ole') {
+            return 'ole';
+        }
+        if (key === 'revisions') {
+            return 'revision';
+        }
+        if (key === 'notes' || key === 'footnotes' || key === 'endnotes') {
+            return 'note';
+        }
+    }
+    return 'unknown';
+}

package/src/features/document/entity-type.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Public document-entity discriminant (DocIO-aligned).
+ *
+ * Prefer {@link EntityType} on modeled objects and projected paragraph leaves
+ * instead of internal wrapper tags such as `'featureRun'`.
+ *
+ * @public
+ */
+export declare enum EntityType {
+    WordDocument = 0,
+    Section = 1,
+    TextBody = 2,
+    HeaderFooter = 3,
+    Paragraph = 4,
+    AlternateChunk = 5,
+    BlockContentControl = 6,
+    InlineContentControl = 7,
+    RowContentControl = 8,
+    CellContentControl = 9,
+    /**
+     * @deprecated Use {@link EntityType.BlockContentControl} instead.
+     */
+    StructureDocumentTag = 10,
+    /**
+     * @deprecated Use {@link EntityType.InlineContentControl} instead.
+     */
+    StructureDocumentTagInline = 11,
+    /**
+     * @deprecated Use {@link EntityType.RowContentControl} instead.
+     */
+    StructureDocumentTagRow = 12,
+    /**
+     * @deprecated Use {@link EntityType.CellContentControl} instead.
+     */
+    StructureDocumentTagCell = 13,
+    /**
+     * @deprecated Use {@link EntityType.BlockContentControl} instead.
+     */
+    SDTBlockContent = 14,
+    /**
+     * @deprecated Use {@link EntityType.InlineContentControl} instead.
+     */
+    SDTInlineContent = 15,
+    /**
+     * @deprecated Use {@link EntityType.RowContentControl} instead.
+     */
+    SDTRowContent = 16,
+    /**
+     * @deprecated Use {@link EntityType.CellContentControl} instead.
+     */
+    SDTCellContent = 17,
+    Table = 18,
+    TableRow = 19,
+    TableCell = 20,
+    TextRange = 21,
+    Picture = 22,
+    Field = 23,
+    FieldMark = 24,
+    MergeField = 25,
+    SeqField = 26,
+    EmbededField = 27,
+    ControlField = 28,
+    TextFormField = 29,
+    DropDownFormField = 30,
+    CheckBox = 31,
+    BookmarkStart = 32,
+    BookmarkEnd = 33,
+    Shape = 34,
+    Comment = 35,
+    Footnote = 36,
+    TextBox = 37,
+    Break = 38,
+    Symbol = 39,
+    TOC = 40,
+    XmlParaItem = 41,
+    Undefined = 42,
+    Chart = 43,
+    SmartArt = 44,
+    Canvas = 45,
+    CommentMark = 46,
+    CommentEnd = 47,
+    OleObject = 48,
+    AbsoluteTab = 49,
+    AutoShape = 50,
+    EditableRangeStart = 51,
+    EditableRangeEnd = 52,
+    GroupShape = 53,
+    ChildShape = 54,
+    ChildGroupShape = 55,
+    Math = 56,
+    Ink = 57
+}

package/src/features/document/entity-type.js

@@ -0,0 +1,93 @@
+/**
+ * Public document-entity discriminant (DocIO-aligned).
+ *
+ * Prefer {@link EntityType} on modeled objects and projected paragraph leaves
+ * instead of internal wrapper tags such as `'featureRun'`.
+ *
+ * @public
+ */
+export var EntityType;
+(function (EntityType) {
+    EntityType[EntityType["WordDocument"] = 0] = "WordDocument";
+    EntityType[EntityType["Section"] = 1] = "Section";
+    EntityType[EntityType["TextBody"] = 2] = "TextBody";
+    EntityType[EntityType["HeaderFooter"] = 3] = "HeaderFooter";
+    EntityType[EntityType["Paragraph"] = 4] = "Paragraph";
+    EntityType[EntityType["AlternateChunk"] = 5] = "AlternateChunk";
+    EntityType[EntityType["BlockContentControl"] = 6] = "BlockContentControl";
+    EntityType[EntityType["InlineContentControl"] = 7] = "InlineContentControl";
+    EntityType[EntityType["RowContentControl"] = 8] = "RowContentControl";
+    EntityType[EntityType["CellContentControl"] = 9] = "CellContentControl";
+    /**
+     * @deprecated Use {@link EntityType.BlockContentControl} instead.
+     */
+    EntityType[EntityType["StructureDocumentTag"] = 10] = "StructureDocumentTag";
+    /**
+     * @deprecated Use {@link EntityType.InlineContentControl} instead.
+     */
+    EntityType[EntityType["StructureDocumentTagInline"] = 11] = "StructureDocumentTagInline";
+    /**
+     * @deprecated Use {@link EntityType.RowContentControl} instead.
+     */
+    EntityType[EntityType["StructureDocumentTagRow"] = 12] = "StructureDocumentTagRow";
+    /**
+     * @deprecated Use {@link EntityType.CellContentControl} instead.
+     */
+    EntityType[EntityType["StructureDocumentTagCell"] = 13] = "StructureDocumentTagCell";
+    /**
+     * @deprecated Use {@link EntityType.BlockContentControl} instead.
+     */
+    EntityType[EntityType["SDTBlockContent"] = 14] = "SDTBlockContent";
+    /**
+     * @deprecated Use {@link EntityType.InlineContentControl} instead.
+     */
+    EntityType[EntityType["SDTInlineContent"] = 15] = "SDTInlineContent";
+    /**
+     * @deprecated Use {@link EntityType.RowContentControl} instead.
+     */
+    EntityType[EntityType["SDTRowContent"] = 16] = "SDTRowContent";
+    /**
+     * @deprecated Use {@link EntityType.CellContentControl} instead.
+     */
+    EntityType[EntityType["SDTCellContent"] = 17] = "SDTCellContent";
+    EntityType[EntityType["Table"] = 18] = "Table";
+    EntityType[EntityType["TableRow"] = 19] = "TableRow";
+    EntityType[EntityType["TableCell"] = 20] = "TableCell";
+    EntityType[EntityType["TextRange"] = 21] = "TextRange";
+    EntityType[EntityType["Picture"] = 22] = "Picture";
+    EntityType[EntityType["Field"] = 23] = "Field";
+    EntityType[EntityType["FieldMark"] = 24] = "FieldMark";
+    EntityType[EntityType["MergeField"] = 25] = "MergeField";
+    EntityType[EntityType["SeqField"] = 26] = "SeqField";
+    EntityType[EntityType["EmbededField"] = 27] = "EmbededField";
+    EntityType[EntityType["ControlField"] = 28] = "ControlField";
+    EntityType[EntityType["TextFormField"] = 29] = "TextFormField";
+    EntityType[EntityType["DropDownFormField"] = 30] = "DropDownFormField";
+    EntityType[EntityType["CheckBox"] = 31] = "CheckBox";
+    EntityType[EntityType["BookmarkStart"] = 32] = "BookmarkStart";
+    EntityType[EntityType["BookmarkEnd"] = 33] = "BookmarkEnd";
+    EntityType[EntityType["Shape"] = 34] = "Shape";
+    EntityType[EntityType["Comment"] = 35] = "Comment";
+    EntityType[EntityType["Footnote"] = 36] = "Footnote";
+    EntityType[EntityType["TextBox"] = 37] = "TextBox";
+    EntityType[EntityType["Break"] = 38] = "Break";
+    EntityType[EntityType["Symbol"] = 39] = "Symbol";
+    EntityType[EntityType["TOC"] = 40] = "TOC";
+    EntityType[EntityType["XmlParaItem"] = 41] = "XmlParaItem";
+    EntityType[EntityType["Undefined"] = 42] = "Undefined";
+    EntityType[EntityType["Chart"] = 43] = "Chart";
+    EntityType[EntityType["SmartArt"] = 44] = "SmartArt";
+    EntityType[EntityType["Canvas"] = 45] = "Canvas";
+    EntityType[EntityType["CommentMark"] = 46] = "CommentMark";
+    EntityType[EntityType["CommentEnd"] = 47] = "CommentEnd";
+    EntityType[EntityType["OleObject"] = 48] = "OleObject";
+    EntityType[EntityType["AbsoluteTab"] = 49] = "AbsoluteTab";
+    EntityType[EntityType["AutoShape"] = 50] = "AutoShape";
+    EntityType[EntityType["EditableRangeStart"] = 51] = "EditableRangeStart";
+    EntityType[EntityType["EditableRangeEnd"] = 52] = "EditableRangeEnd";
+    EntityType[EntityType["GroupShape"] = 53] = "GroupShape";
+    EntityType[EntityType["ChildShape"] = 54] = "ChildShape";
+    EntityType[EntityType["ChildGroupShape"] = 55] = "ChildGroupShape";
+    EntityType[EntityType["Math"] = 56] = "Math";
+    EntityType[EntityType["Ink"] = 57] = "Ink";
+})(EntityType || (EntityType = {}));

package/src/features/document/feature-block.d.ts

@@ -0,0 +1,16 @@
+import { OpenXmlElement } from '../../core/xml/index';
+/**
+ * Serializable body block provided by an optional feature module.
+ *
+ * Required on the public surface: feature body items and
+ * {@link AltChunkAnchor} implement this type under `stripInternal`.
+ *
+ * @private
+ */
+export interface FeatureBlock {
+    toOpenXml(): OpenXmlElement;
+    /**
+      * @private
+      * Release nested modeled content when the parent body detaches the block. */
+    releaseContent?(): void;
+}

package/src/features/document/feature-inline.d.ts

@@ -0,0 +1,13 @@
+import { OpenXmlElement } from '../../core/xml/index';
+/**
+ * Serializable paragraph inline content provided by an optional feature module.
+ *
+ * @public
+ */
+export interface FeatureInline {
+    toOpenXml(): OpenXmlElement;
+    /**
+     * @private
+   * Release nested modeled content when the parent paragraph detaches. */
+    releaseContent?(): void;
+}

package/src/features/document/feature-multi-package-part.d.ts

@@ -0,0 +1,19 @@
+import { OpcPackage } from '../../core/opc/package';
+import { PartName } from '../../core/opc/part-name';
+/**
+ * Optional feature-owned state spanning multiple OPC parts (for example headers).
+ *
+ * @public
+ */
+export interface FeatureMultiPackagePart {
+    /** Whether serialized output must replace or add package parts on save. */
+    isDirty(): boolean;
+    /** Apply dirty part payloads and relationships to the package. */
+    applyToPackage(pkg: OpcPackage, mainPartName: PartName): OpcPackage;
+}
+/**
+ * @private
+ */
+export declare function isFeatureMultiPackagePart(value: {
+    isDirty(): boolean;
+}): value is FeatureMultiPackagePart;

package/src/features/document/feature-multi-package-part.js

@@ -0,0 +1,8 @@
+/**
+ * @private
+ */
+export function isFeatureMultiPackagePart(value) {
+    return ('applyToPackage' in value &&
+        typeof value.applyToPackage === 'function' &&
+        value.applyToPackage.length >= 2);
+}

package/src/features/document/feature-package-level-part.d.ts

@@ -0,0 +1,18 @@
+import { OpcPackage } from '../../core/opc/package';
+/**
+ * Optional feature-owned state for OPC parts linked from package relationships.
+ *
+ * @public
+ */
+export interface FeaturePackageLevelPart {
+    /** Whether serialized output must replace or add package parts on save. */
+    isDirty(): boolean;
+    /** Apply dirty part payloads and package relationships. */
+    applyToPackage(pkg: OpcPackage): OpcPackage;
+}
+/**
+ * @private
+ */
+export declare function isFeaturePackageLevelPart(value: {
+    isDirty(): boolean;
+}): value is FeaturePackageLevelPart;

package/src/features/document/feature-package-level-part.js

@@ -0,0 +1,8 @@
+/**
+ * @private
+ */
+export function isFeaturePackageLevelPart(value) {
+    return ('applyToPackage' in value &&
+        typeof value.applyToPackage === 'function' &&
+        value.applyToPackage.length === 1);
+}

package/src/features/document/feature-package-part.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Optional feature-owned OPC package part state.
+ *
+ * Required on the public surface under `stripInternal` because document
+ * package-part wiring and related exports reference this type.
+ *
+ * @private
+ */
+export interface FeaturePackagePart {
+    /** Whether serialized output must replace the part on save. */
+    isDirty(): boolean;
+    /** UTF-8 payload for the package part. */
+    serialize(): Uint8Array;
+}

package/src/features/document/feature-run-leaf.d.ts

@@ -0,0 +1,9 @@
+import { OpenXmlElement } from '../../core/xml/index';
+/**
+ * Serializable run inner content provided by an optional feature module.
+ *
+ * @public
+ */
+export interface FeatureRunLeaf {
+    toOpenXml(): OpenXmlElement;
+}