@gct-paas/word 0.1.14 → 0.1.16

package/dist/core/model/headers/Wheader.d.ts

@@ -0,0 +1,40 @@
+import { ModelGroup, ModelNode, ModelGroupOptions } from '../base';
+import { DocModel } from '../DocModel';
+import { RawElement } from '../types';
+export type WheaderXmlJson = RawElement & {
+    name: 'w:hdr';
+    '@Relationship': {
+        Type: string;
+        Target: string;
+        Id: string;
+    };
+};
+/**
+ * 页眉类
+ */
+export declare class Wheader extends ModelGroup<ModelNode> {
+    /** 节点名称 */
+    name: 'w:hdr';
+    /** 节点类型 */
+    type: "element";
+    /** 原始 XML JSON 数据 */
+    raw?: WheaderXmlJson;
+    /** 关系 ID（rId） */
+    relId?: string;
+    parent?: DocModel;
+    constructor(options: ModelGroupOptions<ModelNode> & {
+        raw: WheaderXmlJson;
+    });
+    /**
+     * 从原始 XML JSON 转换为 Wheader 实例
+     *
+     * @param json - 原始 XML JSON 数据
+     * @returns Wheader 实例
+     */
+    static fromXmlJson(json: WheaderXmlJson): Wheader;
+    /**
+     * 转换为 XML JSON
+     */
+    toXmlJson(): WheaderXmlJson;
+    static fromTemplate(index: string): Wheader;
+}

package/dist/core/model/headers/Wheaders.d.ts

@@ -0,0 +1,45 @@
+import { Wheader, WheaderXmlJson } from './Wheader';
+import { DocModel } from '../DocModel';
+import { WsecPr } from '../document';
+/**
+ * 页眉集合类
+ */
+export declare class Wheaders {
+    raw?: WheaderXmlJson[];
+    headers: Wheader[];
+    parent?: DocModel;
+    HEADER_SLOT_COUNT: number;
+    constructor(raw: WheaderXmlJson[], parent?: DocModel);
+    /**
+     * 批量从 JSON 转换
+     */
+    static fromXmlJsonArray(json: WheaderXmlJson[], parent?: DocModel): Wheaders;
+    /**
+     * 转为 XML JSON 数组
+     */
+    toXmlJson(): WheaderXmlJson[];
+    /**
+     * 根据 relId 查找页眉
+     */
+    getByRelId(rId: string): Wheader | null;
+    /**
+     * 获取当前所有页眉的 relId
+     */
+    getRefIds(): string[];
+    /**
+     * 计算下一个页眉序号
+     */
+    private getNextHeaderIndex;
+    /**
+     * headers 重建回 raw
+     */
+    private syncRaw;
+    /**
+     * 补齐页眉槽位，并同步 raw
+     */
+    ensureComplete(): void;
+    /**
+     * 统一修复所有 section 的页眉引用
+     */
+    syncSectionRefs(sections: WsecPr[]): void;
+}

package/dist/core/model/logic/CheckTableRegion.d.ts

@@ -0,0 +1,44 @@
+import { Wtbl } from '../document';
+import { Region, RegionOptions } from './Region';
+import { RegionJson } from '../types';
+import { DataGroup2DRegion, DataGroup2DRegionOptions } from './DataGroup2DRegion';
+export type CheckTableWidgetPropsMeta = {
+    /** 引用填充（撑满固定表）*/
+    autoFill: boolean;
+    refColField: string | undefined;
+    refRowField: string | undefined;
+    [key: string]: any;
+};
+export type CheckTableWidgetMeta = {
+    props: CheckTableWidgetPropsMeta;
+};
+export type CheckTableRegionOptions = RegionOptions & {
+    name: string;
+    valuePath: string;
+    widgetMeta: CheckTableWidgetMeta;
+    itemRegion?: DataGroup2DRegion;
+};
+export type CheckTableRegionJson = RegionJson & {
+    name: string;
+    valuePath: string;
+    widgetMeta: CheckTableWidgetMeta;
+    itemRegion?: any;
+};
+export declare class CheckTableRegion extends Region {
+    type: "check-table";
+    name: string;
+    valuePath: string;
+    widgetMeta: CheckTableWidgetMeta;
+    itemRegion?: DataGroup2DRegion;
+    constructor(options: CheckTableRegionOptions);
+    /**
+     * 序列化为 JSON 对象
+     */
+    toJSON(): CheckTableRegionJson;
+    /**
+     * 从 JSON 对象还原
+     */
+    static fromJSON(json: CheckTableRegionJson, table: Wtbl): CheckTableRegion;
+    setItemRegion(options: Omit<DataGroup2DRegionOptions, 'table'>): DataGroup2DRegion;
+    removeItemRegion(): void;
+}

package/dist/core/model/logic/DataGroup2DRegion.d.ts

@@ -0,0 +1,12 @@
+import { Region, RegionOptions } from './Region';
+import { CheckTableRegion } from './CheckTableRegion';
+import { _2DTableRegion } from './_2DTableRegion';
+export type DataGroup2DRegionOptions = RegionOptions & {
+    parent?: CheckTableRegion | _2DTableRegion;
+};
+export declare class DataGroup2DRegion extends Region {
+    type: "dataGroup2D";
+    parent?: CheckTableRegion | _2DTableRegion;
+    constructor(options: DataGroup2DRegionOptions);
+    remove(): void;
+}

package/dist/core/model/logic/SubTableHeaderRegion.d.ts

@@ -0,0 +1,22 @@
+import { Wtbl } from '../document';
+import { Region, RegionOptions } from './Region';
+import { RegionJson } from '../types';
+export type SubTableHeaderRegionOptions = RegionOptions & {
+    name: string;
+    subTableId: string;
+};
+export type SubTableRegionJson = RegionJson & {
+    name: string;
+    subTableId: string;
+};
+export declare class SubTableHeaderRegion extends Region {
+    type: "sub-table-header";
+    name: string;
+    subTableId: SubTableHeaderRegionOptions['subTableId'];
+    constructor(options: SubTableHeaderRegionOptions);
+    /**
+     * 序列化为 JSON 对象
+     */
+    toJSON(): SubTableRegionJson;
+    static fromJSON(json: SubTableRegionJson, table: Wtbl): SubTableHeaderRegion;
+}

package/dist/core/model/logic/TableHeaderRegion.d.ts

@@ -0,0 +1,16 @@
+import { Wtbl } from '../document';
+import { Region, RegionOptions } from './Region';
+import { RegionJson } from '../types';
+export type TableHeaderRegionOptions = RegionOptions & {
+    name: string;
+};
+export type TableRegionJson = RegionJson & {
+    name: string;
+};
+export declare class TableHeaderRegion extends Region {
+    type: "table-header";
+    name: string;
+    constructor(options: TableHeaderRegionOptions);
+    toJSON(): TableRegionJson;
+    static fromJSON(json: TableRegionJson, table: Wtbl): TableHeaderRegion;
+}

package/dist/core/model/logic/_2DTableRegion.d.ts

@@ -0,0 +1,44 @@
+import { Wtbl } from '../document';
+import { Region, RegionOptions } from './Region';
+import { RegionJson } from '../types';
+import { DataGroup2DRegion, DataGroup2DRegionOptions } from './DataGroup2DRegion';
+export type _2DTableWidgetPropsMeta = {
+    /** 引用填充（撑满固定表）*/
+    autoFill: boolean;
+    refColField: string | undefined;
+    refRowField: string | undefined;
+    [key: string]: any;
+};
+export type _2DTableWidgetMeta = {
+    props: _2DTableWidgetPropsMeta;
+};
+export type _2DTableRegionOptions = RegionOptions & {
+    name: string;
+    valuePath: string;
+    widgetMeta: _2DTableWidgetMeta;
+    itemRegion?: DataGroup2DRegion;
+};
+export type _2DTableRegionJson = RegionJson & {
+    name: string;
+    valuePath: string;
+    widgetMeta: _2DTableWidgetMeta;
+    itemRegion?: any;
+};
+export declare class _2DTableRegion extends Region {
+    type: "2d-table";
+    name: string;
+    valuePath: string;
+    widgetMeta: _2DTableWidgetMeta;
+    itemRegion?: DataGroup2DRegion;
+    constructor(options: _2DTableRegionOptions);
+    /**
+     * 序列化为 JSON 对象
+     */
+    toJSON(): _2DTableRegionJson;
+    /**
+     * 从 JSON 对象还原
+     */
+    static fromJSON(json: _2DTableRegionJson, table: Wtbl): _2DTableRegion;
+    setItemRegion(options: Omit<DataGroup2DRegionOptions, 'table'>): DataGroup2DRegion;
+    removeItemRegion(): void;
+}

package/dist/core/model/logic/index.d.ts

@@ -1,9 +1,22 @@
 import { RepeatingRegion } from './RepeatingRegion';
 import { BoundedRegion } from './BoundedRegion';
+import { CheckTableRegion } from './CheckTableRegion';
+import { TableHeaderRegion } from './TableHeaderRegion';
+import { SubTableHeaderRegion } from './SubTableHeaderRegion';
+import { _2DTableRegion } from './_2DTableRegion';
 export { Region } from './Region';
 export { RepeatingRegion } from './RepeatingRegion';
+export { _2DTableRegion } from './_2DTableRegion';
 export { BoundedRegion } from './BoundedRegion';
+export { CheckTableRegion } from './CheckTableRegion';
+export { TableHeaderRegion } from './TableHeaderRegion';
+export { SubTableHeaderRegion } from './SubTableHeaderRegion';
 export type { RegionOptions, CellPos } from './Region';
 export type { RepeatingRegionOptions } from './RepeatingRegion';
+export type { _2DTableRegionOptions } from './_2DTableRegion';
 export type { BoundedRegionOptions } from './BoundedRegion';
-export type TableRegion = RepeatingRegion | BoundedRegion;
+export type { CheckTableRegionOptions } from './CheckTableRegion';
+export type { TableHeaderRegionOptions } from './TableHeaderRegion';
+export type { SubTableHeaderRegionOptions } from './SubTableHeaderRegion';
+export type TableRegion = RepeatingRegion | _2DTableRegion | BoundedRegion | CheckTableRegion | TableHeaderRegion | SubTableHeaderRegion;
+export type SubTableRegion = RepeatingRegion | BoundedRegion;

package/dist/core/model/overlays/Wlayout.d.ts

@@ -0,0 +1,70 @@
+import { RawElement } from '../types';
+import { ModelGroup, ModelNode, ModelGroupOptions } from '../base';
+export type WlayoutXmlJson = RawElement & {
+    name: 'w:lyt';
+    /** 布局坐标信息 */
+    '@layout'?: {
+        x: number;
+        y: number;
+        width?: number;
+        height?: number;
+        zIndex?: number;
+    };
+};
+export interface WlayoutOptions extends ModelGroupOptions<ModelNode> {
+    raw?: WlayoutXmlJson;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    zIndex?: number;
+}
+/**
+ * 布局容器
+ */
+export declare class Wlayout extends ModelGroup<ModelNode> {
+    /** 节点名称 */
+    name: 'w:lyt';
+    /** 节点类型 */
+    type: "element";
+    /** 原始 XML */
+    raw?: WlayoutXmlJson;
+    x: number;
+    y: number;
+    width?: number;
+    height?: number;
+    zIndex: number;
+    parent?: ModelNode;
+    constructor(options: WlayoutOptions);
+    /**
+     * XML -> Wlayout
+     */
+    static fromXmlJson(json: WlayoutXmlJson): Wlayout;
+    /**
+     * XML JSON 输出
+     */
+    toXmlJson(): WlayoutXmlJson;
+    /** 获取组件信息 */
+    getWrPageWidget(): RawElement | ModelNode | undefined;
+    /**
+     * 调整容器尺寸
+     * @param width 新宽度
+     * @param height 新高度
+     */
+    resize(pos: {
+        x?: number;
+        y?: number;
+        width?: number;
+        height?: number;
+    }): void;
+    /**
+     * 从模板创建 layout
+     */
+    static fromTemplate(opts: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        zIndex: number;
+    }): Wlayout;
+}

package/dist/core/model/overlays/Woverlay.d.ts

@@ -0,0 +1,41 @@
+import { DocModel } from '../DocModel';
+import { RawElement } from '../types';
+import { ModelGroup, ModelNode, ModelGroupOptions } from '../base';
+export type WoverlayXmlJson = RawElement & {
+    name: 'w:ovl';
+    '@Relationship': {
+        Type: string;
+        Target: string;
+        Id: string;
+    };
+};
+/**
+ * 浮层类
+ * 每个 Woverlay 对应一个章节（Section），持有该章节内所有悬浮段落节点。
+ */
+export declare class Woverlay extends ModelGroup<ModelNode> {
+    /** 节点名称 */
+    name: 'w:ovl';
+    /** 节点类型 */
+    type: "element";
+    /** 原始 XML JSON 数据 */
+    raw?: WoverlayXmlJson;
+    /** 关系 ID（rId） */
+    relId?: string;
+    parent?: DocModel;
+    constructor(options: ModelGroupOptions<ModelNode> & {
+        raw: WoverlayXmlJson;
+    });
+    /**
+     * 从原始 XML JSON 转换为 Woverlay 实例
+     *
+     * @param json - 原始 XML JSON 数据
+     * @returns Woverlay 实例
+     */
+    static fromXmlJson(json: WoverlayXmlJson): Woverlay;
+    /**
+     * 转换为 XML JSON
+     */
+    toXmlJson(): WoverlayXmlJson;
+    static fromTemplate(index: string): Woverlay;
+}

package/dist/core/model/overlays/Woverlays.d.ts

@@ -0,0 +1,45 @@
+import { Woverlay, WoverlayXmlJson } from './Woverlay';
+import { DocModel } from '../DocModel';
+import { WsecPr } from '../document';
+/**
+ * 浮层集合类
+ */
+export declare class Woverlays {
+    raw?: WoverlayXmlJson[];
+    overlays: Woverlay[];
+    parent?: DocModel;
+    constructor(raw: WoverlayXmlJson[], parent?: DocModel);
+    /**
+     * 批量从 JSON 转换
+     */
+    static fromXmlJsonArray(json: WoverlayXmlJson[], parent?: DocModel): Woverlays;
+    /**
+     * 转为 XML JSON 数组
+     */
+    toXmlJson(): WoverlayXmlJson[];
+    /**
+     * 根据 relId 查找浮层
+     */
+    getByRelId(rId: string): Woverlay | null;
+    /**
+     * 获取当前所有悬浮层的 relId
+     */
+    getRefIds(): string[];
+    /**
+     * 计算下一个浮层序号
+     */
+    private getNextOverlayIndex;
+    /**
+     * overlays 重建回 raw
+     */
+    private syncRaw;
+    /**
+     * 根据章节补齐浮层槽位，并同步 raw
+     * 保证 overlays.length >= sections.length（一对一）
+     */
+    ensureComplete(sections: WsecPr[]): void;
+    /**
+     * 统一修复所有 section 的浮层引用
+     */
+    syncSectionRefs(sections: WsecPr[]): void;
+}

package/dist/core/model/settings/Wsettings.d.ts

@@ -0,0 +1,47 @@
+import { RawElement } from '../types/raw';
+/**
+ * w:settings 根元素的原始 JSON 类型
+ */
+type WsettingsXmlJson = RawElement & {
+    name: 'w:settings';
+};
+/**
+ * Word 文档全局设置（settings.xml）
+ */
+export declare class Wsettings {
+    type: 'settings';
+    raw: WsettingsXmlJson;
+    /**
+     * 是否启用奇偶页不同页眉页脚
+     * <w:evenAndOddHeaders/>
+     */
+    evenAndOddHeaders: boolean;
+    /**
+     * （兼容字段：部分文档可能在 settings 中也有 titlePg
+     * 实际优先级低于 section
+     */
+    titlePg: boolean;
+    constructor(raw: WsettingsXmlJson);
+    /**
+     * 从 XML JSON 转换
+     */
+    static fromXmlJson(json: WsettingsXmlJson): Wsettings;
+    /**
+     * 转回 XML JSON
+     * 保持原始结构
+     */
+    toXmlJson(): RawElement;
+    /**
+     * 是否启用奇偶页
+     */
+    isEvenAndOddEnabled(): boolean;
+    /**
+     * 是否首页特殊
+     */
+    hasTitlePg(): boolean;
+    /**
+     * 设置奇偶页不同页眉页脚，并同步回原始 settings.xml
+     */
+    setEvenAndOddHeaders(enabled: boolean): void;
+}
+export {};

package/dist/core/model/templates/footer.template.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 页脚模板 - TypeScript 版本
+ * 保留变量占位符位置：{{paraId}} {{embedId}} {{index}}
+ */
+export declare const FOOTER_TEMPLATE: {
+    '@attrs': {
+        'xmlns:o': string;
+        'xmlns:w10': string;
+        'xmlns:r': string;
+        'xmlns:w14': string;
+        'xmlns:wps': string;
+        'xmlns:w15': string;
+        'xmlns:wpi': string;
+        'xmlns:w': string;
+        'xmlns:v': string;
+        'mc:Ignorable': string;
+        'xmlns:wpg': string;
+        'xmlns:wne': string;
+        'xmlns:wpsCustomData': string;
+        'xmlns:wp': string;
+        'xmlns:wpc': string;
+        'xmlns:mc': string;
+        'xmlns:wp14': string;
+        'xmlns:m': string;
+    };
+    elements: {
+        '@attrs': {
+            'w14:paraId': string;
+        };
+        elements: {
+            elements: ({
+                '@attrs': {
+                    'w:val': string;
+                };
+                name: string;
+                type: string;
+                elements?: undefined;
+            } | {
+                elements: ({
+                    '@attrs': {
+                        'w:eastAsiaTheme': string;
+                        'w:hint': string;
+                        'w:val'?: undefined;
+                        'w:eastAsia'?: undefined;
+                    };
+                    name: string;
+                    type: string;
+                } | {
+                    '@attrs': {
+                        'w:val': string;
+                        'w:eastAsia': string;
+                        'w:eastAsiaTheme'?: undefined;
+                        'w:hint'?: undefined;
+                    };
+                    name: string;
+                    type: string;
+                })[];
+                name: string;
+                type: string;
+                '@attrs'?: undefined;
+            })[];
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    '@Relationship': {
+        Type: string;
+        Target: string;
+        Id: string;
+    };
+    type: string;
+};

package/dist/core/model/templates/header.template.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 页眉模板 - TypeScript 版本
+ * 保留变量占位符位置：{{paraId}} {{embedId}} {{index}}
+ */
+export declare const HEADER_TEMPLATE: {
+    '@attrs': {
+        'xmlns:o': string;
+        'xmlns:w10': string;
+        'xmlns:r': string;
+        'xmlns:w14': string;
+        'xmlns:wps': string;
+        'xmlns:w15': string;
+        'xmlns:wpi': string;
+        'xmlns:w': string;
+        'xmlns:v': string;
+        'mc:Ignorable': string;
+        'xmlns:wpg': string;
+        'xmlns:wne': string;
+        'xmlns:wpsCustomData': string;
+        'xmlns:wp': string;
+        'xmlns:wpc': string;
+        'xmlns:mc': string;
+        'xmlns:wp14': string;
+        'xmlns:m': string;
+    };
+    elements: {
+        '@attrs': {
+            'w14:paraId': string;
+        };
+        elements: {
+            elements: ({
+                '@attrs': {
+                    'w:val': string;
+                };
+                name: string;
+                type: string;
+                elements?: undefined;
+            } | {
+                elements: ({
+                    '@attrs': {
+                        'w:eastAsiaTheme': string;
+                        'w:hint': string;
+                        'w:val'?: undefined;
+                        'w:eastAsia'?: undefined;
+                    };
+                    name: string;
+                    type: string;
+                } | {
+                    '@attrs': {
+                        'w:val': string;
+                        'w:eastAsia': string;
+                        'w:eastAsiaTheme'?: undefined;
+                        'w:hint'?: undefined;
+                    };
+                    name: string;
+                    type: string;
+                })[];
+                name: string;
+                type: string;
+                '@attrs'?: undefined;
+            })[];
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    '@Relationship': {
+        Type: string;
+        Target: string;
+        Id: string;
+    };
+    type: string;
+};

package/dist/core/model/templates/layout.template.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 容器层模板 - TypeScript 版本
+ * 保留变量占位符位置：{{layoutId}} {{x}} {{y}} {{width}} {{height}} {{zIndex}} {{paraId}}
+ */
+export declare const LAYOUT_TEMPLATE: {
+    '@attrs': {
+        'xmlns:w': string;
+        'xmlns:r': string;
+        'xmlns:mc': string;
+        'xmlns:o': string;
+        'xmlns:v': string;
+        'mc:Ignorable': string;
+        'data-layout-id': string;
+    };
+    '@layout': {
+        x: string;
+        y: string;
+        width: string;
+        height: string;
+        zIndex: string;
+    };
+    elements: {
+        '@attrs': {
+            'w14:paraId': string;
+        };
+        elements: {
+            elements: ({
+                '@attrs': {
+                    'w:val': string;
+                };
+                name: string;
+                type: string;
+                elements?: undefined;
+            } | {
+                elements: ({
+                    '@attrs': {
+                        'w:eastAsiaTheme': string;
+                        'w:hint': string;
+                        'w:val'?: undefined;
+                        'w:eastAsia'?: undefined;
+                    };
+                    name: string;
+                    type: string;
+                } | {
+                    '@attrs': {
+                        'w:val': string;
+                        'w:eastAsia': string;
+                        'w:eastAsiaTheme'?: undefined;
+                        'w:hint'?: undefined;
+                    };
+                    name: string;
+                    type: string;
+                })[];
+                name: string;
+                type: string;
+                '@attrs'?: undefined;
+            })[];
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+};