@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/images/layout-types.d.ts

@@ -0,0 +1,232 @@
+/**
+ * Drawing host placement (`wp:inline` vs `wp:anchor`).
+ *
+ * @private
+ */
+export declare const PicturePlacement: {
+    Inline: string;
+    Anchored: string;
+};
+/**
+ * @private
+ */
+export declare type PicturePlacement = (typeof PicturePlacement)[keyof typeof PicturePlacement];
+/**
+ * Text wrapping style for picture hosts.
+ *
+ * - `inline` — `wp:inline` host (in-line with text).
+ * - `none` — `wp:wrapNone` on an anchor.
+ * - `square` — `wp:wrapSquare`.
+ * - `tight` — `wp:wrapTight` (wrapPolygon preserved when loaded).
+ * - `through` — `wp:wrapThrough` (wrapPolygon preserved when loaded).
+ * - `topAndBottom` — `wp:wrapTopAndBottom`.
+ *
+ * @public
+ */
+export declare const TextWrappingStyle: {
+    Inline: string;
+    None: string;
+    Square: string;
+    Tight: string;
+    Through: string;
+    TopAndBottom: string;
+};
+/** @public */
+export declare type TextWrappingStyle = (typeof TextWrappingStyle)[keyof typeof TextWrappingStyle];
+/**
+ * Horizontal origin for `wp:positionH/@relativeFrom` (`ST_RelFromH`).
+ *
+ * @public
+ */
+export declare const HorizontalOrigin: {
+    Margin: string;
+    Page: string;
+    Column: string;
+    Character: string;
+    LeftMargin: string;
+    RightMargin: string;
+    InsideMargin: string;
+    OutsideMargin: string;
+};
+/** @public */
+export declare type HorizontalOrigin = (typeof HorizontalOrigin)[keyof typeof HorizontalOrigin];
+/**
+ * Vertical origin for `wp:positionV/@relativeFrom` (`ST_RelFromV`).
+ *
+ * @public
+ */
+export declare const VerticalOrigin: {
+    Margin: string;
+    Page: string;
+    Paragraph: string;
+    Line: string;
+    TopMargin: string;
+    BottomMargin: string;
+    InsideMargin: string;
+    OutsideMargin: string;
+};
+/** @public */
+export declare type VerticalOrigin = (typeof VerticalOrigin)[keyof typeof VerticalOrigin];
+/**
+ * Horizontal alignment for `wp:positionH/wp:align` (`ST_AlignH`).
+ *
+ * Mutually exclusive with horizontal position offset on the same axis.
+ * `None` and `Unknown` are model-only (not schema tokens) and are never
+ * written as `wp:align` text.
+ *
+ * @public
+ */
+export declare const HorizontalAlignment: {
+    Left: "left";
+    Right: "right";
+    Center: "center";
+    Inside: "inside";
+    Outside: "outside";
+    /** Model-only: axis uses posOffset (no wp:align). Not a schema token. */
+    None: "none";
+    /** Model-only: residual align token was unrecognized. Not a schema token. */
+    Unknown: "unknown";
+};
+/** @public */
+export declare type HorizontalAlignment = (typeof HorizontalAlignment)[keyof typeof HorizontalAlignment];
+/** Schema ST_AlignH wire tokens (excludes model-only None/Unknown). @private */
+export declare const HORIZONTAL_ALIGNMENT_WIRE_VALUES: ReadonlyArray<HorizontalAlignment>;
+/** Closed set of public HorizontalAlignment values. @public */
+export declare const HORIZONTAL_ALIGNMENT_VALUES: ReadonlyArray<"left" | "right" | "none" | "center" | "unknown" | "inside" | "outside">;
+/**
+ * Vertical alignment for `wp:positionV/wp:align` (`ST_AlignV`).
+ *
+ * Mutually exclusive with vertical position offset on the same axis.
+ * `None` and `Unknown` are model-only (not schema tokens) and are never
+ * written as `wp:align` text.
+ *
+ * @public
+ */
+export declare const VerticalAlignment: {
+    Top: "top";
+    Bottom: "bottom";
+    Center: "center";
+    Inside: "inside";
+    Outside: "outside";
+    /** Model-only: axis uses posOffset (no wp:align). Not a schema token. */
+    None: "none";
+    /** Model-only: residual align token was unrecognized. Not a schema token. */
+    Unknown: "unknown";
+};
+/** @public */
+export declare type VerticalAlignment = (typeof VerticalAlignment)[keyof typeof VerticalAlignment];
+/** Schema ST_AlignV wire tokens (excludes model-only None/Unknown). @private */
+export declare const VERTICAL_ALIGNMENT_WIRE_VALUES: ReadonlyArray<VerticalAlignment>;
+/** Closed set of public VerticalAlignment values. @public */
+export declare const VERTICAL_ALIGNMENT_VALUES: ReadonlyArray<"none" | "center" | "top" | "bottom" | "unknown" | "inside" | "outside">;
+/**
+ * @private
+ */
+export declare function isPicturePlacement(value: string): value is PicturePlacement;
+/**
+ * @public
+ */
+export declare function isTextWrappingStyle(value: string): value is TextWrappingStyle;
+/**
+ * @public
+ */
+export declare function isHorizontalOrigin(value: string): value is HorizontalOrigin;
+/**
+ * @public
+ */
+export declare function isVerticalOrigin(value: string): value is VerticalOrigin;
+/**
+ * @public
+ */
+export declare function isHorizontalAlignment(value: string): value is HorizontalAlignment;
+/**
+ * Whether value is a serializable ST_AlignH token (excludes None/Unknown).
+ *
+ * @private
+ */
+export declare function isHorizontalAlignmentWire(value: string): boolean;
+/**
+ * @public
+ */
+export declare function isVerticalAlignment(value: string): value is VerticalAlignment;
+/**
+ * Whether value is a serializable ST_AlignV token (excludes None/Unknown).
+ *
+ * @private
+ */
+export declare function isVerticalAlignmentWire(value: string): boolean;
+/**
+ * Throws {@link RangeError} when `value` is not a known enum member.
+ *
+ * @private
+ */
+export declare function assertEnumMember(label: string, value: string, allowed: ReadonlySet<string>): void;
+/**
+ * @private
+ */
+export declare const PICTURE_PLACEMENT_SET: Set<string>;
+/**
+ * @private
+ */
+export declare const TEXT_WRAPPING_STYLE_SET: Set<string>;
+/**
+ * @private
+ */
+export declare const HORIZONTAL_ORIGIN_SET: Set<string>;
+/**
+ * @private
+ */
+export declare const VERTICAL_ORIGIN_SET: Set<string>;
+/**
+ * Full public set including model-only None/Unknown (type guard / getters).
+ *
+ * @private
+ */
+export declare const HORIZONTAL_ALIGNMENT_SET: Set<string>;
+/**
+ * Schema-only ST_AlignH tokens for authoring setters that reject model-only values.
+ *
+ * @private
+ */
+export declare const HORIZONTAL_ALIGNMENT_WIRE_SET: Set<string>;
+/**
+ * Full public set including model-only None/Unknown (type guard / getters).
+ *
+ * @private
+ */
+export declare const VERTICAL_ALIGNMENT_SET: Set<string>;
+/**
+ * Schema-only ST_AlignV tokens for authoring setters that reject model-only values.
+ *
+ * @private
+ */
+export declare const VERTICAL_ALIGNMENT_WIRE_SET: Set<string>;
+/**
+ * Wrap side behavior for anchored square/tight/through hosts (`wp:wrap* @wrapText`).
+ *
+ * `Unknown` is model-only (not a schema token) and is never written as `@wrapText`.
+ *
+ * @public
+ */
+export declare const TextWrappingType: {
+    Both: "bothSides";
+    Left: "left";
+    Right: "right";
+    Largest: "largest";
+    /** Model-only: residual wrapText was unrecognized. Not a schema token. */
+    Unknown: "unknown";
+};
+/** @public */
+export declare type TextWrappingType = (typeof TextWrappingType)[keyof typeof TextWrappingType];
+/** Closed set of public TextWrappingType values. @public */
+export declare const TEXT_WRAPPING_TYPE_VALUES: ReadonlyArray<"left" | "right" | "unknown" | "bothSides" | "largest">;
+/** Schema wrapText tokens (excludes model-only Unknown). @private */
+export declare const TEXT_WRAPPING_TYPE_WIRE_VALUES: ("left" | "right" | "unknown" | "bothSides" | "largest")[];
+/** Full public set including Unknown (type guard / getters). @private */
+export declare const TEXT_WRAPPING_TYPE_SET: ReadonlySet<string>;
+/** Schema-only wrapText tokens for authoring setters. @private */
+export declare const TEXT_WRAPPING_TYPE_WIRE_SET: ReadonlySet<string>;
+/** @public */
+export declare function isTextWrappingType(value: string): value is TextWrappingType;
+/** Whether value is a serializable wrapText token (excludes Unknown). @private */
+export declare function isTextWrappingTypeWire(value: string): boolean;

package/src/features/images/layout-types.js

@@ -0,0 +1,294 @@
+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;
+};
+/**
+ * Picture layout and transform domain types (WordprocessingDrawing + DrawingML).
+ *
+ * Enumerations are taken from Transitional `dml-wordprocessingDrawing.xsd`
+ * (`ST_RelFromH`, `ST_RelFromV`, `ST_AlignH`, `ST_AlignV`) and picture host
+ * placement conventions. Do not invent tokens.
+ *
+ * @packageDocumentation
+ */
+import { objectValues } from '../../core/compat/object-compat';
+/**
+ * Drawing host placement (`wp:inline` vs `wp:anchor`).
+ *
+ * @private
+ */
+export var PicturePlacement = {
+    Inline: 'inline',
+    Anchored: 'anchored',
+};
+/**
+ * Text wrapping style for picture hosts.
+ *
+ * - `inline` — `wp:inline` host (in-line with text).
+ * - `none` — `wp:wrapNone` on an anchor.
+ * - `square` — `wp:wrapSquare`.
+ * - `tight` — `wp:wrapTight` (wrapPolygon preserved when loaded).
+ * - `through` — `wp:wrapThrough` (wrapPolygon preserved when loaded).
+ * - `topAndBottom` — `wp:wrapTopAndBottom`.
+ *
+ * @public
+ */
+export var TextWrappingStyle = {
+    Inline: 'inline',
+    None: 'none',
+    Square: 'square',
+    Tight: 'tight',
+    Through: 'through',
+    TopAndBottom: 'topAndBottom',
+};
+/**
+ * Horizontal origin for `wp:positionH/@relativeFrom` (`ST_RelFromH`).
+ *
+ * @public
+ */
+export var HorizontalOrigin = {
+    Margin: 'margin',
+    Page: 'page',
+    Column: 'column',
+    Character: 'character',
+    LeftMargin: 'leftMargin',
+    RightMargin: 'rightMargin',
+    InsideMargin: 'insideMargin',
+    OutsideMargin: 'outsideMargin',
+};
+/**
+ * Vertical origin for `wp:positionV/@relativeFrom` (`ST_RelFromV`).
+ *
+ * @public
+ */
+export var VerticalOrigin = {
+    Margin: 'margin',
+    Page: 'page',
+    Paragraph: 'paragraph',
+    Line: 'line',
+    TopMargin: 'topMargin',
+    BottomMargin: 'bottomMargin',
+    InsideMargin: 'insideMargin',
+    OutsideMargin: 'outsideMargin',
+};
+/**
+ * Horizontal alignment for `wp:positionH/wp:align` (`ST_AlignH`).
+ *
+ * Mutually exclusive with horizontal position offset on the same axis.
+ * `None` and `Unknown` are model-only (not schema tokens) and are never
+ * written as `wp:align` text.
+ *
+ * @public
+ */
+export var HorizontalAlignment = {
+    Left: 'left',
+    Right: 'right',
+    Center: 'center',
+    Inside: 'inside',
+    Outside: 'outside',
+    /** Model-only: axis uses posOffset (no wp:align). Not a schema token. */
+    None: 'none',
+    /** Model-only: residual align token was unrecognized. Not a schema token. */
+    Unknown: 'unknown',
+};
+/** Schema ST_AlignH wire tokens (excludes model-only None/Unknown). @private */
+export var HORIZONTAL_ALIGNMENT_WIRE_VALUES = [
+    HorizontalAlignment.Left,
+    HorizontalAlignment.Right,
+    HorizontalAlignment.Center,
+    HorizontalAlignment.Inside,
+    HorizontalAlignment.Outside,
+];
+/** Closed set of public HorizontalAlignment values. @public */
+export var HORIZONTAL_ALIGNMENT_VALUES = objectValues(HorizontalAlignment);
+/**
+ * Vertical alignment for `wp:positionV/wp:align` (`ST_AlignV`).
+ *
+ * Mutually exclusive with vertical position offset on the same axis.
+ * `None` and `Unknown` are model-only (not schema tokens) and are never
+ * written as `wp:align` text.
+ *
+ * @public
+ */
+export var VerticalAlignment = {
+    Top: 'top',
+    Bottom: 'bottom',
+    Center: 'center',
+    Inside: 'inside',
+    Outside: 'outside',
+    /** Model-only: axis uses posOffset (no wp:align). Not a schema token. */
+    None: 'none',
+    /** Model-only: residual align token was unrecognized. Not a schema token. */
+    Unknown: 'unknown',
+};
+/** Schema ST_AlignV wire tokens (excludes model-only None/Unknown). @private */
+export var VERTICAL_ALIGNMENT_WIRE_VALUES = [
+    VerticalAlignment.Top,
+    VerticalAlignment.Bottom,
+    VerticalAlignment.Center,
+    VerticalAlignment.Inside,
+    VerticalAlignment.Outside,
+];
+/** Closed set of public VerticalAlignment values. @public */
+export var VERTICAL_ALIGNMENT_VALUES = objectValues(VerticalAlignment);
+var PICTURE_PLACEMENT_VALUES = new Set(objectValues(PicturePlacement));
+var TEXT_WRAPPING_STYLE_VALUES = new Set(objectValues(TextWrappingStyle));
+var HORIZONTAL_ORIGIN_VALUES = new Set(objectValues(HorizontalOrigin));
+var VERTICAL_ORIGIN_VALUES = new Set(objectValues(VerticalOrigin));
+var HORIZONTAL_ALIGNMENT_ALL_SET = new Set(HORIZONTAL_ALIGNMENT_VALUES);
+var VERTICAL_ALIGNMENT_ALL_SET = new Set(VERTICAL_ALIGNMENT_VALUES);
+var HORIZONTAL_ALIGNMENT_WIRE_SET_INTERNAL = new Set(HORIZONTAL_ALIGNMENT_WIRE_VALUES);
+var VERTICAL_ALIGNMENT_WIRE_SET_INTERNAL = new Set(VERTICAL_ALIGNMENT_WIRE_VALUES);
+/**
+ * @private
+ */
+export function isPicturePlacement(value) {
+    return PICTURE_PLACEMENT_VALUES.has(value);
+}
+/**
+ * @public
+ */
+export function isTextWrappingStyle(value) {
+    return TEXT_WRAPPING_STYLE_VALUES.has(value);
+}
+/**
+ * @public
+ */
+export function isHorizontalOrigin(value) {
+    return HORIZONTAL_ORIGIN_VALUES.has(value);
+}
+/**
+ * @public
+ */
+export function isVerticalOrigin(value) {
+    return VERTICAL_ORIGIN_VALUES.has(value);
+}
+/**
+ * @public
+ */
+export function isHorizontalAlignment(value) {
+    return HORIZONTAL_ALIGNMENT_ALL_SET.has(value);
+}
+/**
+ * Whether value is a serializable ST_AlignH token (excludes None/Unknown).
+ *
+ * @private
+ */
+export function isHorizontalAlignmentWire(value) {
+    return HORIZONTAL_ALIGNMENT_WIRE_SET_INTERNAL.has(value);
+}
+/**
+ * @public
+ */
+export function isVerticalAlignment(value) {
+    return VERTICAL_ALIGNMENT_ALL_SET.has(value);
+}
+/**
+ * Whether value is a serializable ST_AlignV token (excludes None/Unknown).
+ *
+ * @private
+ */
+export function isVerticalAlignmentWire(value) {
+    return VERTICAL_ALIGNMENT_WIRE_SET_INTERNAL.has(value);
+}
+/**
+ * Throws {@link RangeError} when `value` is not a known enum member.
+ *
+ * @private
+ */
+export function assertEnumMember(label, value, allowed) {
+    if (!allowed.has(value)) {
+        throw new RangeError("Invalid " + label + " value \"" + value + "\"; expected one of: " + __spread(allowed).join(', '));
+    }
+}
+/**
+ * @private
+ */
+export var PICTURE_PLACEMENT_SET = PICTURE_PLACEMENT_VALUES;
+/**
+ * @private
+ */
+export var TEXT_WRAPPING_STYLE_SET = TEXT_WRAPPING_STYLE_VALUES;
+/**
+ * @private
+ */
+export var HORIZONTAL_ORIGIN_SET = HORIZONTAL_ORIGIN_VALUES;
+/**
+ * @private
+ */
+export var VERTICAL_ORIGIN_SET = VERTICAL_ORIGIN_VALUES;
+/**
+ * Full public set including model-only None/Unknown (type guard / getters).
+ *
+ * @private
+ */
+export var HORIZONTAL_ALIGNMENT_SET = HORIZONTAL_ALIGNMENT_ALL_SET;
+/**
+ * Schema-only ST_AlignH tokens for authoring setters that reject model-only values.
+ *
+ * @private
+ */
+export var HORIZONTAL_ALIGNMENT_WIRE_SET = HORIZONTAL_ALIGNMENT_WIRE_SET_INTERNAL;
+/**
+ * Full public set including model-only None/Unknown (type guard / getters).
+ *
+ * @private
+ */
+export var VERTICAL_ALIGNMENT_SET = VERTICAL_ALIGNMENT_ALL_SET;
+/**
+ * Schema-only ST_AlignV tokens for authoring setters that reject model-only values.
+ *
+ * @private
+ */
+export var VERTICAL_ALIGNMENT_WIRE_SET = VERTICAL_ALIGNMENT_WIRE_SET_INTERNAL;
+/**
+ * Wrap side behavior for anchored square/tight/through hosts (`wp:wrap* @wrapText`).
+ *
+ * `Unknown` is model-only (not a schema token) and is never written as `@wrapText`.
+ *
+ * @public
+ */
+export var TextWrappingType = {
+    Both: 'bothSides',
+    Left: 'left',
+    Right: 'right',
+    Largest: 'largest',
+    /** Model-only: residual wrapText was unrecognized. Not a schema token. */
+    Unknown: 'unknown',
+};
+/** Closed set of public TextWrappingType values. @public */
+export var TEXT_WRAPPING_TYPE_VALUES = objectValues(TextWrappingType);
+/** Schema wrapText tokens (excludes model-only Unknown). @private */
+export var TEXT_WRAPPING_TYPE_WIRE_VALUES = TEXT_WRAPPING_TYPE_VALUES.filter(function (v) {
+    return v !== TextWrappingType.Unknown;
+});
+var TEXT_WRAPPING_TYPE_ALL_SET = new Set(TEXT_WRAPPING_TYPE_VALUES);
+var TEXT_WRAPPING_TYPE_WIRE_SET_INTERNAL = new Set(TEXT_WRAPPING_TYPE_WIRE_VALUES);
+/** Full public set including Unknown (type guard / getters). @private */
+export var TEXT_WRAPPING_TYPE_SET = TEXT_WRAPPING_TYPE_ALL_SET;
+/** Schema-only wrapText tokens for authoring setters. @private */
+export var TEXT_WRAPPING_TYPE_WIRE_SET = TEXT_WRAPPING_TYPE_WIRE_SET_INTERNAL;
+/** @public */
+export function isTextWrappingType(value) {
+    return TEXT_WRAPPING_TYPE_ALL_SET.has(value);
+}
+/** Whether value is a serializable wrapText token (excludes Unknown). @private */
+export function isTextWrappingTypeWire(value) {
+    return TEXT_WRAPPING_TYPE_WIRE_SET_INTERNAL.has(value);
+}

package/src/features/images/public-entry.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Public images feature entry (`@syncfusion/ej2-docx/images`).
+ *
+ * Re-exports the always-on images surface and loads caption authoring, which
+ * reuses fields + styles. The main `@syncfusion/ej2-docx` entry only side-effect-imports
+ * `./index.js` so optional fields/styles stay out of `dist/index.js`.
+ */
+export * from './index';
+import './captions';

package/src/features/images/public-entry.js

@@ -0,0 +1,9 @@
+/**
+ * Public images feature entry (`@syncfusion/ej2-docx/images`).
+ *
+ * Re-exports the always-on images surface and loads caption authoring, which
+ * reuses fields + styles. The main `@syncfusion/ej2-docx` entry only side-effect-imports
+ * `./index.js` so optional fields/styles stay out of `dist/index.js`.
+ */
+export * from './index';
+import './captions';

package/src/features/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Feature-domain folder barrel, matching `src/feature/index.ts`
+ * folder-entry pattern.
+ *
+ */
+export * from './bibliography/index';
+export * from './bookmarks/index';
+export * from './comments/index';
+export * from './content-controls/index';
+export * from './custom-xml/index';
+export * from './document/index';
+export * from './drawing/index';
+export * from './editable-ranges/index';
+export * from './fields/index';
+export * from './font-table/index';
+export * from './glossary/index';
+export * from './headers-footers/index';
+export * from './hyperlinks/index';
+export * from './images/index';
+export * from './mail-merge/index';
+export * from './notes/index';
+export * from './numbering/index';
+export * from './ole-object/index';
+export * from './properties/index';
+export * from './revisions/index';
+export * from './sections/index';
+export * from './settings/index';
+export * from './styles/index';
+export * from './tables/index';
+export * from './watermark/index';
+export { VerticalAlignment } from './images/index';
+export { VerticalAlignment as PageVerticalAlignment } from './sections/index';
+export { Hyperlink } from './fields/index';
+export { PageBorder, PageBorders, PageSetup } from './sections/index';
+export { ImageType } from './images/index';

package/src/features/index.js

@@ -0,0 +1,36 @@
+/**
+ * Feature-domain folder barrel, matching `src/feature/index.ts`
+ * folder-entry pattern.
+ *
+ */
+export * from './bibliography/index';
+export * from './bookmarks/index';
+export * from './comments/index';
+export * from './content-controls/index';
+export * from './custom-xml/index';
+export * from './document/index';
+export * from './drawing/index';
+export * from './editable-ranges/index';
+export * from './fields/index';
+export * from './font-table/index';
+export * from './glossary/index';
+export * from './headers-footers/index';
+export * from './hyperlinks/index';
+export * from './images/index';
+export * from './mail-merge/index';
+export * from './notes/index';
+export * from './numbering/index';
+export * from './ole-object/index';
+export * from './properties/index';
+export * from './revisions/index';
+export * from './sections/index';
+export * from './settings/index';
+export * from './styles/index';
+export * from './tables/index';
+export * from './watermark/index';
+// Explicit re-exports resolve names exported by more than one feature barrel
+// (TS2308). Choices mirror `src/all.ts`.
+export { VerticalAlignment } from './images/index';
+export { VerticalAlignment as PageVerticalAlignment } from './sections/index';
+export { Hyperlink } from './fields/index';
+export { PageBorder, PageBorders, PageSetup } from './sections/index';