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

package/types/presentation.d.ts

@@ -347,6 +347,10 @@ export declare interface EditorCollaborationOptions {
      * 是否使用严格的长度校验规则，默认关闭，在开启后如果出现长度校验失败会立刻禁止编辑器继续编写，并将保存状态设置为错误状态
      */
     strictCLC?: boolean;
+    /**
+     * 版本号, 需通过内容接口response header获取
+     */
+    rev: MaybePromiseValue<number>;
 }
 
 /**
@@ -522,7 +526,7 @@ export declare interface EditorDecryptionOptions {
      * @param buffer - 需要解密的二进制数据
      * @returns 解密后的二进制数据
      */
-    decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
+    decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
 }
 
 export declare interface EditorDelta {
@@ -766,6 +770,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;
+    }>;
+}
+
 /**
  * 链接配置，抽象打开链接等操作
  */
@@ -855,14 +890,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';
     /**
      * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
@@ -880,8 +919,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
     /**
      * 下一级菜单配置，下一级菜单配置项和上一级相同
      * 如果下一级仍然是 entry 类型，可以无限向下扩展
+     * 只有当 TName 是对象类型时才应有子菜单
      */
-    children?: EditorMenuEntryConfig<TName>[];
+    children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
 }
 
 /**
@@ -946,11 +986,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, 则整个菜单栏不显示
      */
@@ -961,13 +1008,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;
     /**
      * 自定义按钮配置
      */
@@ -1081,6 +1130,10 @@ export declare interface EditorOptions {
      * 导出设置
      */
     export?: EditorExportOptions;
+    /**
+     * 导入相关设置
+     */
+    import?: EditorImportOptions;
     /**
      * 解密设置
      */
@@ -1089,10 +1142,6 @@ export declare interface EditorOptions {
      * 网络请求设置
      */
     http?: HTTPProxy;
-    /**
-     * 编辑器渲染设置项
-     */
-    render?: EditorRenderOptions;
     /**
      * 编辑器 UI 相关
      */
@@ -1220,13 +1269,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
-export declare interface EditorRenderOptions {
-    /**
-     * 渲染的容器
-     */
-    container?: HTMLElement;
-}
-
 /**
  * 编辑器通用接口
  */

package/types/shared.d.ts

@@ -315,6 +315,10 @@ export declare interface EditorCollaborationOptions {
      * 是否使用严格的长度校验规则，默认关闭，在开启后如果出现长度校验失败会立刻禁止编辑器继续编写，并将保存状态设置为错误状态
      */
     strictCLC?: boolean;
+    /**
+     * 版本号, 需通过内容接口response header获取
+     */
+    rev: MaybePromiseValue<number>;
 }
 
 /**
@@ -490,7 +494,7 @@ export declare interface EditorDecryptionOptions {
      * @param buffer - 需要解密的二进制数据
      * @returns 解密后的二进制数据
      */
-    decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
+    decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
 }
 
 export declare interface EditorDelta {
@@ -734,6 +738,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;
+    }>;
+}
+
 /**
  * 链接配置，抽象打开链接等操作
  */
@@ -823,14 +858,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';
     /**
      * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
@@ -848,8 +887,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
     /**
      * 下一级菜单配置，下一级菜单配置项和上一级相同
      * 如果下一级仍然是 entry 类型，可以无限向下扩展
+     * 只有当 TName 是对象类型时才应有子菜单
      */
-    children?: EditorMenuEntryConfig<TName>[];
+    children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
 }
 
 /**
@@ -914,11 +954,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, 则整个菜单栏不显示
      */
@@ -929,13 +976,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;
     /**
      * 自定义按钮配置
      */
@@ -1049,6 +1098,10 @@ export declare interface EditorOptions {
      * 导出设置
      */
     export?: EditorExportOptions;
+    /**
+     * 导入相关设置
+     */
+    import?: EditorImportOptions;
     /**
      * 解密设置
      */
@@ -1057,10 +1110,6 @@ export declare interface EditorOptions {
      * 网络请求设置
      */
     http?: HTTPProxy;
-    /**
-     * 编辑器渲染设置项
-     */
-    render?: EditorRenderOptions;
     /**
      * 编辑器 UI 相关
      */
@@ -1188,13 +1237,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
-export declare interface EditorRenderOptions {
-    /**
-     * 渲染的容器
-     */
-    container?: HTMLElement;
-}
-
 /**
  * 编辑器通用接口
  */

package/types/sheet.d.ts

@@ -39,9 +39,9 @@ export declare abstract class AbstractedSheetSDK extends EditorSDK {
      */
     abstract endDemonstration(): Promise<void>;
     /**
-     * 导出为图片/pdf
+     * 导出接口
      */
-    abstract export(type: 'pdf' | 'image'): Promise<void>;
+    abstract export(type: string): Promise<void>;
     /**
      * 工作簿接口
      */
@@ -414,6 +414,10 @@ export declare interface EditorCollaborationOptions {
      * 是否使用严格的长度校验规则，默认关闭，在开启后如果出现长度校验失败会立刻禁止编辑器继续编写，并将保存状态设置为错误状态
      */
     strictCLC?: boolean;
+    /**
+     * 版本号, 需通过内容接口response header获取
+     */
+    rev: MaybePromiseValue<number>;
 }
 
 /**
@@ -453,6 +457,15 @@ export declare interface EditorCollaborators {
     addUserLeaveListener: (listener: (allUsers: CollaboratorInfo[], leftUsers: CollaboratorInfo[]) => void) => () => void;
 }
 
+export declare interface EditorCollaboratorsOptions {
+    /**
+     * 推送协作者socket 对象
+     * 实际类型为socketIO.client
+     * TODO: 抽象为接口
+     */
+    socket?: unknown;
+}
+
 /**
  * 单条评论数据
  */
@@ -589,7 +602,7 @@ export declare interface EditorDecryptionOptions {
      * @param buffer - 需要解密的二进制数据
      * @returns 解密后的二进制数据
      */
-    decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
+    decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
 }
 
 export declare interface EditorDelta {
@@ -833,6 +846,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;
+    }>;
+}
+
 /**
  * 链接配置，抽象打开链接等操作
  */
@@ -922,14 +966,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';
     /**
      * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
@@ -947,8 +995,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
     /**
      * 下一级菜单配置，下一级菜单配置项和上一级相同
      * 如果下一级仍然是 entry 类型，可以无限向下扩展
+     * 只有当 TName 是对象类型时才应有子菜单
      */
-    children?: EditorMenuEntryConfig<TName>[];
+    children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
 }
 
 /**
@@ -1013,11 +1062,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, 则整个菜单栏不显示
      */
@@ -1028,13 +1084,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;
     /**
      * 自定义按钮配置
      */
@@ -1148,6 +1206,10 @@ export declare interface EditorOptions {
      * 导出设置
      */
     export?: EditorExportOptions;
+    /**
+     * 导入相关设置
+     */
+    import?: EditorImportOptions;
     /**
      * 解密设置
      */
@@ -1156,10 +1218,6 @@ export declare interface EditorOptions {
      * 网络请求设置
      */
     http?: HTTPProxy;
-    /**
-     * 编辑器渲染设置项
-     */
-    render?: EditorRenderOptions;
     /**
      * 编辑器 UI 相关
      */
@@ -1295,13 +1353,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
-export declare interface EditorRenderOptions {
-    /**
-     * 渲染的容器
-     */
-    container?: HTMLElement;
-}
-
 /**
  * 编辑器通用接口
  */
@@ -2215,11 +2266,11 @@ export declare interface SheetComments extends EditorComments {
 
 export declare interface SheetExportOptions extends EditorExportOptions {
     /**
-     * 导出表格的方法
+     * 导出单个sheet的方法
      * @param type - 导出类型，支持 'csv' 或 'xlsx' 格式
-     * @param sheetId - 可选的表格ID，用于指定要导出的特定表格
+     * @param sheetId - 表格ID，用于指定要导出的特定表格
      */
-    exportSheet?: (type: 'csv' | 'xlsx', sheetId?: string) => Promise<void>;
+    exportSheet?: (type: 'csv' | 'xlsx', sheetId: string) => Promise<void>;
 }
 
 export declare interface SheetFontsOptions extends EditorFontsOptions {
@@ -2236,7 +2287,14 @@ export declare interface SheetFormOptions extends EditorFeatureConfig {
     getFormPagePath?: () => string;
 }
 
-export declare interface SheetImportFormulaOptions extends EditorFeatureConfig {
+export declare interface SheetFormulaOptions {
+    /**
+     * 是否有公式缓存，需通过内容接口response header获取
+     */
+    hasFormulaCache?: MaybePromiseValue<boolean>;
+}
+
+export declare interface SheetImportRangeOptions extends EditorFeatureConfig {
     /**
      * 注册一个监听器，用于在跨表格引用结果发生变化时触发
      * @param listener - 回调函数，参数 guidList 表示发生变化的 guid 列表，可以是字符串或字符串数组。
@@ -2448,7 +2506,7 @@ export declare type SheetRangeValue = {
     type: `${SheetRangeType.Sheet}`;
 };
 
-export declare interface SheetRenderOptions extends EditorRenderOptions {
+export declare interface SheetRenderOptions {
     /**
      * 激活的工作表 ID
      */
@@ -2493,7 +2551,7 @@ export declare interface SheetSDKOptions extends EditorOptions {
     /**
      * 跨表格引用设置
      */
-    importFormula?: SheetImportFormulaOptions;
+    importRange?: SheetImportRangeOptions;
     /**
      * 锁定设置
      */
@@ -2526,6 +2584,14 @@ export declare interface SheetSDKOptions extends EditorOptions {
      * 性能指标设置
      */
     performance?: EditorPerformanceOptions;
+    /**
+     * 协作者设置
+     */
+    collaborators?: EditorCollaboratorsOptions;
+    /**
+     * 公式
+     */
+    formula?: SheetFormulaOptions;
 }
 
 /**