@officesdk/editor-sdk-core 0.0.0-20 → 0.0.0-21

package/types/table.d.ts

@@ -76,6 +76,32 @@ export declare abstract class AbstractedTableSDK implements Omit<EditorSDK, 'con
     abstract get version(): EditorVersion;
 }
 
+/**
+ * 基础视图菜单项
+ */
+export declare type BaseMenuItemName = 
+/** 查看/展开记录 */
+'view'
+/** 复制记录 */
+| 'copy'
+/** 删除记录 */
+| 'remove'
+/** 添加评论 */
+| 'comment'
+/** 获取记录链接 */
+| 'link';
+
+/**
+ * 日历视图菜单项
+ */
+export declare type CalendarMenuItemName = 
+/** 查看/展开记录 */
+'view'
+/** 复制记录 */
+| 'copy'
+/** 删除记录 */
+| 'remove';
+
 export declare type CheckLimitationResult = {
     status: 'limited';
     /**
@@ -378,6 +404,10 @@ export declare interface EditorCollaborationOptions {
      * 是否使用严格的长度校验规则，默认关闭，在开启后如果出现长度校验失败会立刻禁止编辑器继续编写，并将保存状态设置为错误状态
      */
     strictCLC?: boolean;
+    /**
+     * 版本号, 需通过内容接口response header获取
+     */
+    rev: MaybePromiseValue<number>;
 }
 
 /**
@@ -553,7 +583,7 @@ export declare interface EditorDecryptionOptions {
      * @param buffer - 需要解密的二进制数据
      * @returns 解密后的二进制数据
      */
-    decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
+    decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
 }
 
 export declare interface EditorDelta {
@@ -797,6 +827,37 @@ export declare interface EditorI18nOptions {
 
 export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
 
+export declare interface EditorImportOptions {
+    /**
+     * 获取导入状态，没有contentUrl时需要显示导入进度
+     * 待导入完成后再渲染
+     */
+    getImportStatus?: () => Promise<{
+        /**
+         * 导入进度
+         */
+        progress: number;
+        /**
+         * 导入中
+         */
+        status: 'importing';
+    } | {
+        /**
+         * 导入完成
+         */
+        status: 'completed';
+    } | {
+        /**
+         * 导入失败
+         */
+        status: 'failed';
+        /**
+         * 导入失败错误信息
+         */
+        errorMessage?: string;
+    }>;
+}
+
 /**
  * 链接配置，抽象打开链接等操作
  */
@@ -886,14 +947,18 @@ export declare interface EditorMenuButtonMenuItemConfig<TName extends string> ex
 
 /**
  * 编辑器菜单配置类型
- * 联合类型，表示可以是任意一种菜单项配置
+ * 根据 TName 类型的不同返回不同的菜单配置类型:
+ * 1. 当 TName 是对象类型时（如 {pasteMenu: [...]})，会自动提取对象的键作为菜单名称
+ * 2. 当 TName 是字符串时，返回普通菜单项配置
  */
-export declare type EditorMenuEntryConfig<TName extends string> = EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName>;
+export declare type EditorMenuEntryConfig<TName extends EditorMenuName> = TName extends Record<string, EditorMenuName[]> ? EditorMenuEntryMenuItemConfig<string & keyof TName, TName[keyof TName]> : TName extends string ? EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName, never> : never;
 
 /**
  * 子菜单入口配置
+ * TName: 菜单项名称（字符串类型）
+ * TChildName: 子菜单项名称数组类型，用于配置下一级菜单项
  */
-export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+export declare interface EditorMenuEntryMenuItemConfig<TName extends string, TChildName extends EditorMenuName[]> extends EditorMenuBaseMenuItemConfig<TName> {
     type: 'entry';
     /**
      * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
@@ -911,8 +976,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
     /**
      * 下一级菜单配置，下一级菜单配置项和上一级相同
      * 如果下一级仍然是 entry 类型，可以无限向下扩展
+     * 只有当 TName 是对象类型时才应有子菜单
      */
-    children?: EditorMenuEntryConfig<TName>[];
+    children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
 }
 
 /**
@@ -977,11 +1043,18 @@ export declare interface EditorMenuLinkMenuItemConfig<TName extends string> exte
     url?: string;
 }
 
+/**
+ * 菜单项名称类型
+ * 可以是字符串或包含子菜单数组的对象
+ * 如: 'copy' 或 { pasteMenu: ['pasteAll', 'pasteHead', 'pasteValueOnly'] }
+ */
+export declare type EditorMenuName = string | Record<string, EditorMenuName[]>;
+
 /**
  * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
  * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
  */
-export declare interface EditorMenuOptions<TName extends string> {
+export declare interface EditorMenuOptions<TName extends EditorMenuName> {
     /**
      * 菜单栏是否隐藏，设置为true, 则整个菜单栏不显示
      */
@@ -992,13 +1065,15 @@ export declare interface EditorMenuOptions<TName extends string> {
     disabled?: boolean;
     /**
      * 菜单栏一级菜单配置，指显示在菜单栏上的菜单项。
+     * 支持普通菜单项和嵌套菜单项
      */
     entries?: EditorMenuEntryConfig<TName>[];
     /**
      * 菜单栏功能按钮配置
      * 更加间接的配置项
+     * 仅在 TName 为字符串类型时有效
      */
-    features?: Partial<Record<TName, EditorMenuFeatureConfig>>;
+    features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
     /**
      * 自定义按钮配置
      */
@@ -1112,6 +1187,10 @@ export declare interface EditorOptions {
      * 导出设置
      */
     export?: EditorExportOptions;
+    /**
+     * 导入相关设置
+     */
+    import?: EditorImportOptions;
     /**
      * 解密设置
      */
@@ -1120,10 +1199,6 @@ export declare interface EditorOptions {
      * 网络请求设置
      */
     http?: HTTPProxy;
-    /**
-     * 编辑器渲染设置项
-     */
-    render?: EditorRenderOptions;
     /**
      * 编辑器 UI 相关
      */
@@ -1251,13 +1326,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
-export declare interface EditorRenderOptions {
-    /**
-     * 渲染的容器
-     */
-    container?: HTMLElement;
-}
-
 /**
  * 编辑器通用接口
  */
@@ -1758,6 +1826,48 @@ export declare enum FileType {
     CloudFile = 3
 }
 
+/**
+ * 画廊视图菜单项
+ */
+export declare type GalleryMenuItemName = BaseMenuItemName | 'insert';
+
+/**
+ * 甘特图视图菜单项
+ */
+export declare type GanttMenuItemName = GridMenuItemName
+/** 设置为里程碑 */
+| 'milestone'
+/** 取消里程碑 */
+| 'cancelMilestone'
+/** 清除内容 */
+| 'clear';
+
+/**
+ * 网格视图菜单项
+ */
+export declare type GridMenuItemName = BaseMenuItemName
+/** 粘贴 */
+| 'pasteValue'
+/** 选择性粘贴 - 含子菜单 */
+| {
+    pasteMenu: [
+    /** 粘贴内容及表头 */
+    'pasteAll',
+    /** 仅粘贴表头 */
+    'pasteHead',
+    /** 仅粘贴内容 */
+    'pasteValueOnly'
+    ];
+}
+/** 向上插入记录 */
+| 'insertBefore'
+/** 向下插入记录 */
+| 'insertAfter'
+/** 新增子任务 */
+| 'newSubRecord'
+/** 展开父任务 */
+| 'parentRecord';
+
 /**
  * 请求、响应头
  */
@@ -1865,6 +1975,15 @@ export declare interface HTTPResponse<Data = unknown> {
  */
 export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 
+/**
+ * 看板视图菜单项
+ */
+export declare type KanbanMenuItemName = BaseMenuItemName
+/** 编辑分组 */
+| 'editGroup'
+/** 移除分组 */
+| 'removeGroup';
+
 export declare interface Limitation {
     /**
      * 限制原因（错误码）
@@ -1886,6 +2005,21 @@ export declare interface Limitation {
     min?: number;
 }
 
+/**
+ * 列表视图菜单项
+ */
+export declare type ListMenuItemName = BaseMenuItemName
+/** 向上插入记录 */
+| 'insertBefore'
+/** 向下插入记录 */
+| 'insertAfter'
+/** 新增子任务 */
+| 'newSubRecord'
+/** 展开父任务 */
+| 'parentRecord'
+/** 获取指向此记录的链接 */
+| 'copyRecordLink';
+
 export declare type MaybePromiseValue<T> = T | Promise<T>;
 
 /**
@@ -2186,6 +2320,49 @@ export declare type TableEditorDeltaActionName = 'CreateTable' | 'UpdateTableNam
  */
 export declare type TableEditorOptions = Omit<EditorOptions, 'content'>;
 
+export declare type TableFieldContextMenuEntryConfig = EditorMenuEntryConfig<TableFieldContextMenuFeatureButtonName>;
+
+export declare type TableFieldContextMenuFeatureButtonConfig = EditorMenuEntryConfig<TableFieldContextMenuFeatureButtonName>;
+
+export declare type TableFieldContextMenuFeatureButtonName = 
+/** 更新字段 */
+'updateField'
+/** 添加字段描述 */
+| 'addFieldDesc'
+/** 在左侧插入 */
+| 'insertLeft'
+/** 在右侧插入 */
+| 'insertRight'
+/** 复制字段 */
+| 'copyField'
+/** 升序排序 */
+| 'sortOrderAsc'
+/** 降序排序 */
+| 'sortOrderDesc'
+/** 过滤 */
+| 'filter'
+/** 分组 */
+| 'group'
+/** 隐藏 */
+| 'hide'
+/** 删除 */
+| 'delete';
+
+export declare type TableFieldContextMenuOptions = EditorMenuOptions<TableFieldContextMenuFeatureButtonName>;
+
+export declare type TableListBarButtonName = 'tableMenu' | 'addTable' | 'tabLeft' | 'tabRight' | 'exportToExcel';
+
+export declare type TableListBarCustomButtonConfig = Record<string, Omit<EditorToolbarFeatureButton<string>, 'label' | 'icon' | 'tooltip'> & {
+    icon: string;
+    tooltip: string;
+}>;
+
+export declare type TableListBarFeatureButtonConfig = EditorToolbarFeatureButtonConfig<TableListBarButtonName>;
+
+export declare type TableListBarOptions = Omit<EditorToolbarOptions<TableListBarButtonName>, 'custom'> & {
+    custom?: TableListBarCustomButtonConfig;
+};
+
 export declare interface TableSDKOptions extends TableEditorOptions {
     /**
      * 字体配置
@@ -2195,6 +2372,22 @@ export declare interface TableSDKOptions extends TableEditorOptions {
      * 接口资源配置
      */
     resourceConfig?: ResourceConfig;
+    /**
+     * 工具栏相关配置
+     */
+    toolbar?: TableToolbarOptions;
+    /**
+     * 列表栏相关配置
+     */
+    listBar?: TableListBarOptions;
+    /**
+     * 字段上下文菜单相关配置
+     */
+    fieldContextMenu?: TableFieldContextMenuOptions;
+    /**
+     * 表格上下文菜单相关配置
+     */
+    viewContextMenu?: TableViewContextMenuOptions;
 }
 
 export declare interface TableSelection {
@@ -2319,6 +2512,64 @@ export declare type TableSelectionValue = {
     columnCount: number;
 };
 
+export declare type TableToolbarCalendarButtonName = 'calendarSettings' | 'calendarPendingItems';
+
+export declare type TableToolbarCommonButtonName = 
+/** 撤销 */
+'undo'
+/** 重做 */
+| 'redo'
+/** 添加记录 */
+| 'addRecord'
+/** 排序 */
+| 'sort'
+/** 过滤 */
+| 'filter'
+/** 分组 */
+| 'group'
+/** 行高 */
+| 'rowHeight'
+/** 切换子任务 */
+| 'toggleSubtask'
+/** 字段管理 */
+| 'fieldManage'
+/** 评论 */
+| 'comment'
+/** 搜索 */
+| 'search'
+/** 历史 */
+| 'history'
+/** 全屏 */
+| 'fullscreen'
+/** 表单 */
+| 'form';
+
+export declare type TableToolbarFeatureButtonConfig = EditorToolbarFeatureButtonConfig<TableToolbarFeatureButtonName>;
+
+export declare type TableToolbarFeatureButtonName = TableToolbarCommonButtonName | TableToolbarKanbanButtonName | TableToolbarGanttButtonName | TableToolbarGalleryButtonName | TableToolbarCalendarButtonName | TableToolbarTimelineButtonName;
+
+export declare type TableToolbarGalleryButtonName = 'gallerySettings';
+
+export declare type TableToolbarGanttButtonName = 'ganttSettings';
+
+export declare type TableToolbarKanbanButtonName = 'kanbanSettings';
+
+export declare type TableToolbarOptions = Omit<EditorToolbarOptions<TableToolbarFeatureButtonName>, 'custom'>;
+
+export declare type TableToolbarTimelineButtonName = 'timelineSettings';
+
+export declare type TableViewContextMenuEntryConfig = EditorMenuEntryConfig<TableViewContextMenuFeatureButtonName>;
+
+export declare type TableViewContextMenuFeatureButtonConfig = EditorMenuEntryConfig<TableViewContextMenuFeatureButtonName>;
+
+/**
+ * 表格视图上下文菜单按钮特性名称
+ * 包含所有视图类型的菜单项
+ */
+export declare type TableViewContextMenuFeatureButtonName = GridMenuItemName | KanbanMenuItemName | GalleryMenuItemName | CalendarMenuItemName | GanttMenuItemName | ListMenuItemName;
+
+export declare type TableViewContextMenuOptions = EditorMenuOptions<TableViewContextMenuFeatureButtonName>;
+
 /**
  * 工具箱工具项接口
  */

package/cjs/shared/render.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVuZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcGFja2FnZXMvY29yZS9zcmMvc2hhcmVkL3JlbmRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBFZGl0b3JSZW5kZXJPcHRpb25zIHtcbiAgLyoqXG4gICAqIOa4suafk+eahOWuueWZqFxuICAgKi9cbiAgY29udGFpbmVyPzogSFRNTEVsZW1lbnQ7XG59XG4iXX0=

package/cjs/sheet/import-formula.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW1wb3J0LWZvcm11bGEuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9jb3JlL3NyYy9zaGVldC9pbXBvcnQtZm9ybXVsYS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBFZGl0b3JGZWF0dXJlQ29uZmlnIH0gZnJvbSAnLi4vc2hhcmVkJztcblxuZXhwb3J0IGludGVyZmFjZSBTaGVldEltcG9ydEZvcm11bGFPcHRpb25zIGV4dGVuZHMgRWRpdG9yRmVhdHVyZUNvbmZpZyB7XG4gIC8qKlxuICAgKiDms6jlhozkuIDkuKrnm5HlkKzlmajvvIznlKjkuo7lnKjot6jooajmoLzlvJXnlKjnu5Pmnpzlj5HnlJ/lj5jljJbml7bop6blj5FcbiAgICogQHBhcmFtIGxpc3RlbmVyIC0g5Zue6LCD5Ye95pWw77yM5Y+C5pWwIGd1aWRMaXN0IOihqOekuuWPkeeUn+WPmOWMlueahCBndWlkIOWIl+ihqO+8jOWPr+S7peaYr+Wtl+espuS4suaIluWtl+espuS4suaVsOe7hOOAglxuICAgKiBAcmV0dXJucyDkuIDkuKrlh73mlbDvvIznlKjkuo7np7vpmaTlvZPliY3ms6jlhoznmoTnm5HlkKzlmajjgIJcbiAgICovXG4gIGFkZENoYW5nZWRMaXN0ZW5lcj86IChsaXN0ZW5lcjogKGd1aWRMaXN0OiBzdHJpbmcgfCBzdHJpbmdbXSkgPT4gdm9pZCkgPT4gKCkgPT4gdm9pZDtcbn1cbiJdfQ==

package/esm/shared/render.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVuZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcGFja2FnZXMvY29yZS9zcmMvc2hhcmVkL3JlbmRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBFZGl0b3JSZW5kZXJPcHRpb25zIHtcbiAgLyoqXG4gICAqIOa4suafk+eahOWuueWZqFxuICAgKi9cbiAgY29udGFpbmVyPzogSFRNTEVsZW1lbnQ7XG59XG4iXX0=

package/esm/sheet/import-formula.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW1wb3J0LWZvcm11bGEuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9jb3JlL3NyYy9zaGVldC9pbXBvcnQtZm9ybXVsYS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBFZGl0b3JGZWF0dXJlQ29uZmlnIH0gZnJvbSAnLi4vc2hhcmVkJztcblxuZXhwb3J0IGludGVyZmFjZSBTaGVldEltcG9ydEZvcm11bGFPcHRpb25zIGV4dGVuZHMgRWRpdG9yRmVhdHVyZUNvbmZpZyB7XG4gIC8qKlxuICAgKiDms6jlhozkuIDkuKrnm5HlkKzlmajvvIznlKjkuo7lnKjot6jooajmoLzlvJXnlKjnu5Pmnpzlj5HnlJ/lj5jljJbml7bop6blj5FcbiAgICogQHBhcmFtIGxpc3RlbmVyIC0g5Zue6LCD5Ye95pWw77yM5Y+C5pWwIGd1aWRMaXN0IOihqOekuuWPkeeUn+WPmOWMlueahCBndWlkIOWIl+ihqO+8jOWPr+S7peaYr+Wtl+espuS4suaIluWtl+espuS4suaVsOe7hOOAglxuICAgKiBAcmV0dXJucyDkuIDkuKrlh73mlbDvvIznlKjkuo7np7vpmaTlvZPliY3ms6jlhoznmoTnm5HlkKzlmajjgIJcbiAgICovXG4gIGFkZENoYW5nZWRMaXN0ZW5lcj86IChsaXN0ZW5lcjogKGd1aWRMaXN0OiBzdHJpbmcgfCBzdHJpbmdbXSkgPT4gdm9pZCkgPT4gKCkgPT4gdm9pZDtcbn1cbiJdfQ==