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

package/{docx.d.ts → types/docx.d.ts}

@@ -1,16 +1,12 @@
 export declare abstract class AbstractedDocxSDK extends EditorSDK {
     /**
-     * 打印文档
-     */
-    abstract print(): Promise<void>;
-    /**
-     * 跳转到某个位置
+     * 文档准备就绪
      */
-    abstract goto(options: DocxGotoOptions): boolean;
+    abstract ready(): Promise<void>;
     /**
-     * 文档缩放接口
-     * @param scale
+     * 打印文档
      */
+    abstract print(): Promise<void>;
     /**
      * 文档目录集合接口，
      * 一个文档中可以存在多个目录，这个接口是用来管理文档中的所有目录的。
@@ -46,6 +42,105 @@ export declare abstract class AbstractedDocxSDK extends EditorSDK {
     abstract get search(): DocxSearch;
 }
 
+export declare abstract class AbstractedEditorFileUploader {
+    /**
+     * 开始上传
+     * @param options
+     */
+    abstract start(options: EditorUploadStartOptions): EditorUploadTaskInfo[];
+    /**
+     * 暂停上传，不传参数则取消所有上传任务
+     * @param taskIds
+     */
+    abstract pause(taskIds?: string[]): void;
+    /**
+     * 暂停上传，不传参数则暂停所有上传任务
+     * @param taskIds
+     */
+    abstract abort(taskIds?: string[]): void;
+    /**
+     * 恢复上传，不传参数则恢复所有上传任务
+     * @param taskIds
+     */
+    abstract resume(taskIds?: string[]): void;
+}
+
+export declare type CheckLimitationResult = {
+    status: 'limited';
+    /**
+     * 被限制原因
+     */
+    reason?: string;
+} | {
+    status: 'unlimited';
+};
+
+/**
+ * 协作者信息接口
+ */
+export declare interface CollaboratorInfo {
+    /** 协作者唯一标识 */
+    id: number;
+    /** 协作者名称 */
+    name: string;
+    /** 协作者头像URL */
+    avatar: string;
+}
+
+export declare interface ConfirmButtonConfig {
+    /**
+     * 按钮文本
+     */
+    label?: string;
+    /**
+     * 是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 按钮点击回调
+     */
+    onClick?: () => void;
+}
+
+/**
+ * 传统文档右键菜单功能按钮
+ */
+export declare type DocxContextMenuFeatureButtonName = 
+/**
+* 剪切
+*/
+'cut'
+/**
+* 复制
+*/
+| 'copy'
+/**
+* 粘贴
+*/
+| 'paste'
+/**
+* 删除
+*/
+| 'delete'
+/**
+* 字体
+*/
+| 'font'
+/**
+* 段落
+*/
+| 'paragraph'
+/**
+* 下载附件
+*/
+| 'downloadAttachment'
+/**
+* 转换PDF
+*/
+| 'transformPDF';
+
+export declare type DocxContextMenuOptions = EditorContextMenuOptions<DocxContextMenuFeatureButtonName>;
+
 export declare type DocxFontFace = Omit<EditorFontFace, 'meta'> & {
     meta: DocxFontMeta;
 };
@@ -117,40 +212,6 @@ export declare interface DocxFontsOptions {
     list: DocxFontsList;
 }
 
-export declare type DocxGotoOptions = {
-    /**
-     * 区域，跳转到对应区域位置
-     */
-    type: 'range';
-    /**
-     * 区域值，这个值可以通过 DocxSelection 的 getRange 方法拿到
-     */
-    range: string;
-} | {
-    /**
-     * 页码，跳转到对应页码位置
-     */
-    type: 'page';
-    /**
-     * 页码
-     */
-    page: number;
-} | {
-    /**
-     * 顶部，跳转到文档顶部
-     */
-    type: 'top';
-} | {
-    /**
-     * 跳转到某个评论
-     */
-    type: 'comment';
-    /**
-     * 评论 ID
-     */
-    commentId: string;
-};
-
 /**
  * 图片水印属性值
  */
@@ -180,23 +241,36 @@ export declare interface DocxInfoOptions {
         time?: number;
         author?: string;
     };
+    id: string;
+    name: string;
 }
 
 /**
- * 传统文档工具栏一级菜单
+ * 传统文档菜单栏自定义菜单
+ * 可以通过指定泛型T来指定自定义菜单的类型，自定义菜单目前只支持button和link两种类型
  */
-export declare type DocxMenuEntryConfig = EditorMenuEntryConfig<DocxMenuFeatureButtonName>;
+export declare type DocxMenuCustomConfig<T extends 'button' | 'link' = 'button' | 'link'> = (EditorMenuButtonMenuItemConfig<string> | EditorMenuLinkMenuItemConfig<string>) & {
+    type: T;
+};
 
 /**
- * 传统文档工具栏功能按钮
+ * 传统文档菜单栏一级菜单
+ * 可以通过指定泛型T来指定一级菜单的类型，例如DocxMenuEntryConfig<'button'>，不指定则默认为所有类型都有可能
  */
-export declare type DocxMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<DocxMenuFeatureButtonName>;
+export declare type DocxMenuEntryConfig<T extends EditorMenuItemType = EditorMenuItemType> = EditorMenuEntryConfig<DocxMenuFeatureButtonName> & {
+    type: T;
+};
 
 /**
- * 传统文档工具栏内置功能按钮
+ * 传统文档菜单栏内置功能按钮
  */
-export declare type DocxMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'attachment' | 'cloudFile' | 'signature' | 'image';
+export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'insert' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertFilesFromDrive' | 'insertSignature' | 'insertImage' | 'insertImageFromLocal' | 'insertImageFromUrl';
 
+export declare type DocxMenuFeatureConfig = EditorMenuFeatureConfig;
+
+/**
+ * 传统文档菜单栏相关配置，目前菜单栏不是所有套件都支持，
+ */
 export declare type DocxMenuOptions = EditorMenuOptions<DocxMenuFeatureButtonName>;
 
 /**
@@ -363,6 +437,10 @@ export declare interface DocxSDKOptions extends EditorOptions {
      * 菜单栏相关设置
      */
     menu?: DocxMenuOptions;
+    /**
+     * 右键菜单相关设置
+     */
+    contextMenu?: DocxContextMenuOptions;
     /**
      *  Pdf 大纲目录设置
      */
@@ -379,6 +457,10 @@ export declare interface DocxSDKOptions extends EditorOptions {
      * 主题字体相关配置
      */
     theme?: DocxThemeOptions;
+    /**
+     * 工具栏设置
+     */
+    toolbar?: DocxToolbarOptions;
 }
 
 /**
@@ -481,6 +563,24 @@ export declare interface DocxSelection {
      * @returns
      */
     addRangeListener: (listener: (value: DocxRangeValue | null) => void) => void;
+    /**
+     * 获取文档全部选区范围。
+     * @returns
+     */
+    getWholeRange: () => DocxRange;
+    /**
+     * 向当前选区位置插入文本，
+     * 返回插入后当前选区位置
+     * @param text
+     * @returns
+     */
+    insertText: (text: string) => DocxRangeValue;
+    /**
+     * 向当前选区位置插入 HTML 内容，
+     * 返回插入后当前选区位置
+     * @param html
+     */
+    insertHtml: (html: string) => DocxRangeValue;
 }
 
 /**
@@ -566,9 +666,11 @@ export declare interface DocxThemeFontsSchemeItem {
      * 其他单独字体配置
      * key 表示script值
      * 例如：
-     * <a:font script="Hans" typeface="黑体"/>
-     * <a:font script="Jpan" typeface="HG明朝B"/>
-     * <a:font script="Arab" typeface="Times New Roman"/>
+     * ```xml
+     * <a:font script="Hans" typeface="黑体"/\>
+     * <a:font script="Jpan" typeface="HG明朝B"/\>
+     * <a:font script="Arab" typeface="Times New Roman"/\>
+     * ```
      */
     font: Record<string, DocxThemeFont>;
 }
@@ -719,6 +821,94 @@ export declare interface DocxTOCs {
     }) => Promise<boolean>;
 }
 
+/**
+ * 传统文档工具栏功能按钮
+ */
+export declare type DocxToolbarFeatureButton = EditorToolbarFeatureButton<DocxToolbarFeatureButtonName>;
+
+/**
+ * 传统文档工具栏功能按钮配置
+ */
+export declare type DocxToolbarFeatureButtonConfig = EditorToolbarFeatureButtonConfig<DocxToolbarFeatureButtonName>;
+
+/**
+ * Docx 工具栏按钮名称类型
+ */
+export declare type DocxToolbarFeatureButtonName = 
+/** 撤销 */
+'undo'
+/** 重做 */
+| 'redo'
+/** 格式刷 */
+| 'formatPainter'
+/** 清除格式 */
+| 'clearFormat'
+/** 缩放 */
+| 'zoom'
+/** 样式 */
+| 'styles'
+/** 字体 */
+| 'font'
+/** 字号 */
+| 'fontSize'
+/** 增加字号 */
+| 'increaseFontSize'
+/** 减少字号 */
+| 'decreaseFontSize'
+/** 粗体 */
+| 'bold'
+/** 斜体 */
+| 'italic'
+/** 下划线 */
+| 'underline'
+/** 删除线 */
+| 'strikeThrough'
+/** 文字颜色 */
+| 'textColor'
+/** 高亮颜色 */
+| 'highlightColor'
+/** 上标 */
+| 'superScript'
+/** 下标 */
+| 'subScript'
+/** 左对齐 */
+| 'leftAlign'
+/** 居中 */
+| 'center'
+/** 右对齐 */
+| 'rightAlign'
+/** 两端对齐 */
+| 'justify'
+/** 编号列表 */
+| 'numberedList'
+/** 项目符号列表 */
+| 'bulletedList'
+/** 增加缩进 */
+| 'increaseIndent'
+/** 减少缩进 */
+| 'decreaseIndent'
+/** 行距 */
+| 'lineSpacing'
+/** 插入图片 */
+| 'insertImage'
+/** 插入图片-从本地 */
+| 'insertImageFromLocal'
+/** 插入图片-来自链接 */
+| 'insertImageFromURL'
+/** 插入表格 */
+| 'insertTable'
+/** 链接 */
+| 'insertLink'
+/** 开启限制编辑 */
+| 'enableEditingRestriction'
+/** 添加评论 */
+| 'addComments';
+
+/**
+ * 传统文档工具栏配置
+ */
+export declare type DocxToolbarOptions = EditorToolbarOptions<DocxToolbarFeatureButtonName>;
+
 /**
  * 文本水印操作接口，
  * 水印属于文档的一种特殊业务，水印是 OOXML 是形状的一种业务形态封装，
@@ -812,12 +1002,21 @@ export declare type DocxWatermarkOptions = EditorWatermarkOptions;
  * 文档窗口接口
  */
 export declare interface DocxWindow {
+    /**
+     * 获取当前文档滚动位置，
+     * 返回值为当前文档滚动位置的偏移量，
+     * 这个偏移量是基于文档的左上角为原点，向右向下为正方向
+     * @returns
+     */
+    getScrollPosition: () => {
+        x: number;
+        y: number;
+    };
     /**
      * 滚动到指定位置
-     * @param x
-     * @param y
+     * @param params 滚动参数
      */
-    scrollTo: (x: number, y: number) => void;
+    scrollTo: (params: DocxWindowScrollParams) => void;
     /**
      * 滚动到指定页面
      * @param page
@@ -827,7 +1026,7 @@ export declare interface DocxWindow {
      * 将传入的区域滚动到可视区域
      * @param range
      */
-    scrollIntoView: (range: DocxRangeValue) => void;
+    scrollIntoView: (range: DocxRangeValue, options?: DocxWindowScrollIntoViewOptions) => void;
     /**
      * 添加滚动监听器
      * @param listener
@@ -838,6 +1037,79 @@ export declare interface DocxWindow {
     }) => void) => () => void;
 }
 
+/**
+ * 滚动到指定区域的选项
+ */
+export declare interface DocxWindowScrollIntoViewOptions {
+    /**
+     * 滚动到指定区域的位置，默认是start
+     */
+    position?: 'start' | 'end';
+    /**
+     * 是否将滚动到的区域置于文档可见范围的顶部。默认为bottom
+     */
+    alignment?: 'top' | 'bottom';
+}
+
+export declare type DocxWindowScrollParams = {
+    /**
+     * 区域，跳转到对应区域位置
+     */
+    type: 'range';
+    /**
+     * 区域值，这个值可以通过 DocxSelection 的 getRange 方法拿到，取start或者end
+     */
+    range: string;
+} | {
+    /**
+     * 页码，跳转到对应页码位置
+     */
+    type: 'page';
+    /**
+     * 页码
+     */
+    page: number;
+} | {
+    /**
+     * 顶部，跳转到文档顶部
+     */
+    type: 'top';
+} | {
+    /**
+     * 滚动到某个位置，
+     * 这个位置是基于文档的左上角为原点，向右向下为正方向
+     */
+    type: 'position';
+    /**
+     * 位置
+     */
+    position: {
+        x: number;
+        y: number;
+    };
+} | {
+    /**
+     * 偏移量，跳转到对应偏移量位置
+     */
+    type: 'offset';
+    /**
+     * 偏移量
+     */
+    offset: {
+        x: number;
+        y: number;
+    };
+} | {
+    /**
+     * 跳转到某个评论
+     */
+    type: 'comment';
+    /**
+     * 评论 ID
+     */
+    commentId: string;
+};
+
 /**
  * 文档缩放接口
  */
@@ -876,10 +1148,25 @@ export declare interface DocxZoom {
     zoomOut: () => void;
 }
 
+/**
+ * 匿名用户信息
+ * 当前用户信息未知时的缺省值
+ */
+export declare interface EditorAnonymousOptions {
+    /**
+     * 匿名用户默认显示名称
+     */
+    name: string;
+    /**
+     * 匿名用户默认头像
+     */
+    avatar: string;
+}
+
 /**
  * 编辑器内部资源请求配置
  */
-declare interface EditorAssetsOptions {
+export declare interface EditorAssetsOptions {
     /**
      * 通用资源请求代理配置，
      * 用于套件内部资源请求时代理请求
@@ -898,7 +1185,7 @@ declare interface EditorAssetsOptions {
 /**
  * 基于对象存储的图片处理抽象
  */
-declare interface EditorAssetsOssImageProcessing {
+export declare interface EditorAssetsOssImageProcessing {
     /**
      * 压缩图片的方法
      * @param imageUrl 图片的 URL
@@ -925,7 +1212,7 @@ declare interface EditorAssetsOssImageProcessing {
     }) => Promise<string>;
 }
 
-declare interface EditorAssetsResolver {
+export declare interface EditorAssetsResolver {
     /**
      * 将资源文件 ID 转换为 URL 的方法
      * @param assetId 资源文件 ID
@@ -948,82 +1235,267 @@ declare interface EditorAssetsResolver {
 }
 
 /**
- * 品牌相关设置，
- * 用于在套件中展示品牌外露信息
+ * 编辑器附件限制配置,sdk中会使用在不同的场景下使用不同的限制规则组合
  */
-declare interface EditorBrandOptions {
+export declare interface EditorAttachmentLimitationOptions {
     /**
-     * 需要显示在品牌展示位的内容，按数组顺序显示
+     * 检查附件大小的规则
+     * @param file
+     * @returns
      */
-    content: Array<{
-        type: 'image';
-        src: string;
+    checkFile: (params: EditorAttachmentLimitationOptionsCheckFunctionParams) => Promise<{
+        limited: true;
+        message: string;
     } | {
-        type: 'text';
-        content: string;
-        color?: string;
+        limited: false;
     }>;
-    /**
-     * 品牌展示位的布局信息
-     */
-    layout: {
-        width: string;
-        height: string;
-    };
 }
 
 /**
- * 单条评论数据
+ * 编辑器附件限制配置检查函数参数
  */
-declare interface EditorCommentItem {
+export declare interface EditorAttachmentLimitationOptionsCheckFunctionParams {
     /**
-     * 评论 ID
+     * 文件名称，带后缀名
      */
-    id: string;
+    name: string;
     /**
-     * 评论用户信息
+     * 文件大小，单位为Byte
      */
-    user: {
-        id: string;
-        name: string;
-    };
-    content: {
-        text: string;
-    };
-}
-
-declare interface EditorComments {
+    size: number;
     /**
-     * 检查是否有评论
-     * @returns
+     * 文件的mime类型，例如image/jpeg、application/vnd.ms-excel等
      */
-    hasAny: () => Promise<boolean>;
+    mime?: string;
+}
+
+/**
+ * 编辑器附件限制配置
+ * @deprecated 使用limitations代替
+ */
+export declare interface EditorAttachmentMaxSizeOptions {
     /**
-     * 获取评论列表
-     * @returns
+     * 图片大小上限值，单位为Byte
+     * 设置为Infinity时表示不限制图片大小
      */
-    getAll: () => Promise<EditorCommentItem[]>;
+    value?: number;
     /**
-     * 获取单个评论
-     * @param commentId
-     * @returns
+     * 超限警告相关配置
      */
-    getOne: (commentId: string) => Promise<EditorCommentItem | null>;
+    warning?: {
+        /**
+         * 超限警告文本
+         */
+        text?: string;
+    };
+}
+
+/**
+ * 编辑器附件信息
+ */
+export declare interface EditorAttachmentOptions {
+    picker?: EditorFilePicker;
+    uploader?: AbstractedEditorFileUploader;
+    download?: (url: string) => void;
     /**
-     * 添加内容
-     * @param options
-     * @returns
+     * 图片附件相关配置
      */
-    add: (options: {
+    image?: {
         /**
-         * 评论内容
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
          */
-        text: string;
+        maxSize?: EditorAttachmentMaxSizeOptions;
         /**
-         * 默认评论是添加到当前选区上，也可以指定一个区域
+         * 支持的图片格式列表，例如jpg,png等
          */
-        range?: string;
-    }) => Promise<string | null>;
+        supportTypes?: string[];
+        /**
+         * 图片附件的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+    };
+    /**
+     * 其他附件相关配置
+     */
+    attachment?: {
+        /**
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
+         */
+        maxSize?: EditorAttachmentMaxSizeOptions;
+        /**
+         * 支持的附件格式列表，例如doc,docx等
+         */
+        supportTypes?: string[];
+        /**
+         * 附件的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+    };
+}
+
+/**
+ * 基础文件属性
+ */
+export declare interface EditorBaseUploadableFile {
+    secretly?: boolean;
+    bucket: 'images' | 'attachments';
+    encrypt: string;
+    fileGuid: string;
+}
+
+/**
+ * 品牌相关设置，
+ * 用于在套件中展示品牌外露信息
+ */
+export declare interface EditorBrandOptions {
+    /**
+     * 需要显示在品牌展示位的内容，按数组顺序显示
+     */
+    content: Array<{
+        type: 'image';
+        src: string;
+    } | {
+        type: 'text';
+        content: string;
+        color?: string;
+    }>;
+    /**
+     * 品牌展示位的布局信息
+     */
+    layout: {
+        width: string;
+        height: string;
+    };
+}
+
+export declare interface EditorCheckpointsOptions {
+    /**
+     * 获取功能卡点限制
+     * undefined代表无限制
+     */
+    getFeatureLimitation?: (key: string) => Limitation | undefined;
+    /**
+     * 检查是否超限
+     * @param key 功能卡点key
+     * @param value 功能卡点检查值，如文件大小/行列数量等
+     */
+    checkFeatureLimitation?: (key: string, value: number) => CheckLimitationResult;
+    /**
+     * 获取功能卡点状态，如某功能入口是否开启
+     */
+    getFeatureStatus?: (key: string) => FeatureStatus;
+}
+
+export declare interface EditorCollaborationOptions {
+    /**
+     * 是否允许离线编辑
+     */
+    offlineEditable: boolean;
+    /**
+     * 保存状态外部接口委托
+     */
+    saveStatus: SaveStatusDelegation;
+    /**
+     * 同步状态外部接口委托(部分套件不支持离线编辑)
+     */
+    syncStatus?: SyncStatusDelegation;
+    /**
+     * 是否使用严格的长度校验规则，默认关闭，在开启后如果出现长度校验失败会立刻禁止编辑器继续编写，并将保存状态设置为错误状态
+     */
+    strictCLC?: boolean;
+}
+
+/**
+ * 编辑器协作者管理接口
+ */
+export declare interface EditorCollaborators {
+    /**
+     * 获取当前所有协作者列表
+     * @returns  返回所有协作者信息数组
+     */
+    getCollaborators: () => CollaboratorInfo[];
+    /**
+     * 开始监听协作者状态变化
+     * 调用此方法后，将开始接收协作者进入/离开的事件
+     */
+    start: () => void;
+    /**
+     * 停止监听协作者状态变化
+     * 调用此方法后，将不再接收协作者进入/离开的事件
+     */
+    stop: () => void;
+    /**
+     * 添加协作者进入事件监听器
+     * @param listener - 监听器回调函数，参数如下：
+     *   - allUsers: 当前所有协作者列表
+     *   - enteredUsers: 新进入的协作者列表
+     * @returns 返回一个函数，调用该函数可以移除监听器
+     */
+    addUserEnterListener: (listener: (allUsers: CollaboratorInfo[], enteredUsers: CollaboratorInfo[]) => void) => () => void;
+    /**
+     * 添加协作者离开事件监听器
+     * @param listener - 监听器回调函数
+     *   - allUsers: 当前所有协作者列表
+     *   - leftUsers: 离开的协作者列表
+     * @returns 返回一个函数，调用该函数可以移除监听器
+     */
+    addUserLeaveListener: (listener: (allUsers: CollaboratorInfo[], leftUsers: CollaboratorInfo[]) => void) => () => void;
+}
+
+/**
+ * 单条评论数据
+ */
+export declare interface EditorCommentItem {
+    /**
+     * 评论 ID
+     */
+    id: string;
+    /**
+     * 评论用户信息
+     */
+    user: {
+        id: string;
+        name: string;
+    };
+    content: {
+        text: string;
+    };
+}
+
+export declare interface EditorComments {
+    /**
+     * 检查是否有评论
+     * @returns
+     */
+    hasAny: () => Promise<boolean>;
+    /**
+     * 获取评论列表
+     * @returns
+     */
+    getAll: () => Promise<EditorCommentItem[]>;
+    /**
+     * 获取单个评论
+     * @param commentId
+     * @returns
+     */
+    getOne: (commentId: string) => Promise<EditorCommentItem | null>;
+    /**
+     * 添加内容
+     * @param options
+     * @returns
+     */
+    add: (options: {
+        /**
+         * 评论内容
+         */
+        text: string;
+        /**
+         * 默认评论是添加到当前选区上，也可以指定一个区域
+         */
+        range?: string;
+    }) => Promise<string | null>;
     /**
      * 删除所有评论
      * @returns
@@ -1038,7 +1510,7 @@ declare interface EditorComments {
 /**
  * 编辑器评论初始化配置
  */
-declare interface EditorCommentsOptions {
+export declare interface EditorCommentsOptions extends EditorFeatureConfig {
     /**
      * 评论作者信息，如果这里的信息为空，将会使用 user 信息
      */
@@ -1067,9 +1539,15 @@ declare interface EditorCommentsOptions {
          */
         mode: 'none' | 'card';
     };
+    /**
+     * 评论变化监听
+     * @param listener
+     * @returns 返回一个函数，调用该函数可以移除监听器
+     */
+    addChangedListener?: (listener: (type: 'create' | 'update' | 'close', data: EditorCommentItem) => void) => () => void;
 }
 
-declare interface EditorContent {
+export declare interface EditorContent<Delta = EditorDelta> {
     /**
      * 设置编辑器内容
      * @param content
@@ -1078,15 +1556,34 @@ declare interface EditorContent {
     /**
      * 获取编辑器内容
      */
-    getContent: () => Promise<EditorDelta>;
+    getContent: () => Promise<Delta>;
     /**
      * 添加监听，当内容发生变化时触发监听，传入 Delta
      * @param listener
      */
-    addChangeListener: (listener: (change: EditorDelta) => void) => () => void;
+    addChangeListener: (listener: (change: Delta) => void) => () => void;
 }
 
-declare interface EditorDelta {
+/**
+ * 右键菜单栏相关配置
+ * 右键菜单栏是指的编辑器中点击右键弹出的菜单栏。目前等于菜单栏配置，可扩展
+ */
+export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
+
+/**
+ * 编辑器解密选项接口
+ * 用于配置编辑器中需要解密的内容的相关选项
+ */
+export declare interface EditorDecryptionOptions {
+    /**
+     * 图片附件解密函数
+     * @param buffer - 需要解密的二进制数据
+     * @returns 解密后的二进制数据
+     */
+    decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
+}
+
+export declare interface EditorDelta {
     compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
     transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
     stringify: () => string;
@@ -1096,7 +1593,7 @@ declare interface EditorDelta {
 /**
  * 编辑器嵌入对象
  */
-declare interface EditorEmbeddedObject {
+export declare interface EditorEmbeddedObject {
     /**
      * 嵌入的对象 url
      */
@@ -1114,7 +1611,7 @@ declare interface EditorEmbeddedObject {
 /**
  * 编辑器嵌入对象抽象类
  */
-declare interface EditorEmbeddedObjectOptions {
+export declare interface EditorEmbeddedObjectOptions {
     /**
      * 执行打开嵌入对象操作，
      * 如果已经处理了打开操作，返回 true，否则返回 false，
@@ -1142,7 +1639,85 @@ declare interface EditorEmbeddedObjectOptions {
     };
 }
 
-declare interface EditorFontFace {
+export declare interface EditorExportOptions {
+    /**
+     * 可导出类型
+     */
+    supportedTypes?: string[];
+    /**
+     * 导出文件
+     */
+    exportFile: (type: string) => Promise<void>;
+}
+
+export declare interface EditorFeatureConfig {
+    /**
+     * 功能是否被禁用（入口还在）
+     */
+    disabled?: boolean;
+    /**
+     * 功能入口是否被隐藏
+     */
+    hidden?: boolean;
+}
+
+export declare interface EditorFileOptions {
+    /**
+     * 文件guid
+     */
+    guid: string;
+    /**
+     * 文件名
+     */
+    name?: string;
+}
+
+export declare interface EditorFilePicker {
+    open: (option: EditorFilePickerOpenOptions) => Promise<EditorPickedFile[]>;
+}
+
+export declare interface EditorFilePickerOpenOptions {
+    mimeTypes?: string[];
+    maxSize?: number;
+    extensions?: string[];
+    multiple?: boolean;
+    directory?: boolean;
+}
+
+export declare interface EditorFollowMode {
+    /**
+     * 演讲者/跟随者进入跟随模式
+     * 当演讲者调用此方法时，其他用户将可以开始跟随该演讲者
+     */
+    enter: () => void;
+    /**
+     * 当前是否处于跟随模式
+     * @returns 返回布尔值，true表示正在跟随，false表示未在跟随
+     */
+    isFollowModeActive: () => boolean;
+    /**
+     * 获取当前演讲者信息
+     * @returns 返回包含演讲者ID、姓名和头像信息的对象
+     */
+    getSpeaker: () => Speaker;
+    /**
+     * 添加跟随状态变化的监听器
+     * @param listener 状态变化时的回调函数
+     * @returns 返回一个用于移除监听器的函数
+     */
+    addChangedListener: (listener: () => void) => () => void;
+}
+
+export declare interface EditorFollowModeOptions extends EditorFeatureConfig {
+    /**
+     * 推送跟随消息的 socket 对象
+     * 实际类型为socketIO.client
+     * TODO: 抽象为接口
+     */
+    socket?: unknown;
+}
+
+export declare interface EditorFontFace {
     /**
      * 字体的名称，用于在用户界面上显示的名称
      */
@@ -1168,7 +1743,7 @@ declare interface EditorFontFace {
 /**
  * 字体元数据
  */
-declare interface EditorFontMeta {
+export declare interface EditorFontMeta {
     head: {
         unitsPerEm: number;
     };
@@ -1202,10 +1777,41 @@ declare interface EditorFontMeta {
     };
 }
 
+/**
+ * 字体列表
+ */
+export declare interface EditorFontsList {
+    /**
+     * 返回解析为字体的列表的 Promise。
+     */
+    getAll: () => Promise<EditorFontFace[]>;
+}
+
+export declare interface EditorFontsOptions {
+    /**
+     * 服务器字体列表，用于获取服务器端配置的字体列表，
+     * 并提供可用于字体的加载 URL 和字体元数据。
+     */
+    list: EditorFontsList;
+}
+
+export declare interface EditorHistory {
+    /**
+     * 显示历史记录侧边栏
+     */
+    showSidebar: () => void;
+    /**
+     * 隐藏历史记录侧边栏
+     */
+    hideSidebar: () => void;
+}
+
+export declare type EditorHistoryOptions = EditorFeatureConfig;
+
 /**
  * i18n 相关设置
  */
-declare interface EditorI18nOptions {
+export declare interface EditorI18nOptions {
     /**
      * 语言，默认使用浏览器当前环境中的语言
      */
@@ -1216,160 +1822,220 @@ declare interface EditorI18nOptions {
     direction?: 'ltr' | 'rtl';
 }
 
-declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
+export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
 
 /**
  * 链接配置，抽象打开链接等操作
  */
-declare interface EditorLinkOptions {
+export declare interface EditorLinkOptions {
+    /**
+     * 链接识别配置
+     */
+    detection?: {
+        /**
+         * 支持识别的链接格式
+         */
+        pattern?: string | RegExp | (string | RegExp)[];
+        /**
+         * 是否启用链接识别，默认关闭
+         */
+        enabled?: boolean;
+    };
     /**
      * 打开链接，如果取消了打开链接操作，返回 false
      * @param url
      * @param target
      * @returns
      */
-    open: (url: string, target: string) => Promise<boolean>;
-}
-
-/**
- * 菜单栏自定义按钮配置
- */
-declare type EditorMenuCustomButton = {
+    open?: (url: string, target: string) => Promise<boolean>;
     /**
-     * 按钮名称
+     * 根据文件guid以及其他参数生成链接
      */
-    name: string;
+    generate?: (params: FileLinkParams) => Promise<string>;
     /**
-     * 链接
+     * 从文档链接中解析得到文件guid等参数
      */
-    type: 'link';
+    parse?: (url: string) => Promise<FileLinkParams | undefined>;
     /**
-     * 按钮文本
+     * 生成sdk2.0内部链接
+     * 使用场景：专业表格跨表格引用
      */
-    text: string;
+    generateInternal?: (params: FileLinkParams) => Promise<string>;
+}
+
+/**
+ * 可上传文件
+ */
+export declare interface EditorLocalUploadableFile extends EditorBaseUploadableFile {
+    name: string;
+    size: number;
+    mime: string;
+    raw: File;
+}
+
+/**
+ * 基础菜单项配置，所有菜单项类型都包含这些属性
+ */
+export declare interface EditorMenuBaseMenuItemConfig<TName extends string> {
     /**
-     * 链接地址
+     * 菜单项的唯一标识，用以确定配置的是哪个菜单
      */
-    url: string;
-} | {
+    name: TName;
     /**
-     * 按钮名称
+     * 菜单项类型
      */
-    name: string;
+    type: EditorMenuItemType;
+}
+
+/**
+ * 按钮菜单项配置
+ */
+export declare interface EditorMenuButtonMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'button';
     /**
-     * 按钮，点击后触发 callback 回调
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    type: 'button';
+    disabled?: boolean;
     /**
-     * 按钮文本
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
      */
-    label: string;
+    label?: string;
     /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
     icon?: string;
     /**
-     * 按钮点击事件
+     * 菜单项点击事件，接受一个函数，可以自定义点击事件
      */
-    callback: () => void;
-};
+    callback?: () => void;
+}
+
+/**
+ * 编辑器菜单配置类型
+ * 联合类型，表示可以是任意一种菜单项配置
+ */
+export declare type EditorMenuEntryConfig<TName extends string> = EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName>;
 
 /**
- * 菜单栏二级以下的菜单入口
+ * 子菜单入口配置
  */
-declare interface EditorMenuEntryButton {
+export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
     type: 'entry';
     /**
-     * 菜单名称
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    name: string;
+    disabled?: boolean;
+    /**
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
+     */
+    label?: string;
     /**
-     * 菜单图标
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
     icon?: string;
+    /**
+     * 下一级菜单配置，下一级菜单配置项和上一级相同
+     * 如果下一级仍然是 entry 类型，可以无限向下扩展
+     */
+    children?: EditorMenuEntryConfig<TName>[];
 }
 
 /**
- * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
- * 一级菜单在鼠标悬停时展示二级列表
+ * 菜单功能按钮配置
  */
-declare interface EditorMenuEntryConfig<TName extends string> {
+export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
     /**
-     * 一级菜单名称
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
-    name: string;
+    label?: string;
     /**
-     * 二级菜单定义，定一个二维数组，用于定义二级菜单的结构，
-     * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
-     * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
-    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton>[];
+    icon?: string;
+    /**
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
+     */
+    callback?: () => void;
+    /**
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
+     */
+    tooltip?: string;
+    /**
+     * 按钮在工具栏中位置，不设置则按照默认位置
+     */
+    index?: number;
 }
 
 /**
- * 菜单栏功能按钮配置
+ * 隐藏菜单项配置
  */
-declare type EditorMenuFeatureButton<TName extends string> = {
-    /**
-     * 隐藏按钮，用作在需要隐藏菜单栏时定义
-     */
+export declare interface EditorMenuHiddenMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
     type: 'hidden';
+}
+
+/**
+ * 菜单项类型
+ */
+export declare type EditorMenuItemType = 'hidden' | 'button' | 'link' | 'entry';
+
+/**
+ * 链接菜单项配置
+ */
+export declare interface EditorMenuLinkMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'link';
     /**
-     * 按钮名称
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    name: TName;
-} | {
-    type: 'button';
+    disabled?: boolean;
     /**
-     * 按钮名称
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
      */
-    name: TName;
+    text?: string;
     /**
-     * 按钮标签（显示文本）
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
-    label: string;
+    icon?: string;
     /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     * 跳转链接地址
      */
-    icon?: string;
-};
-
-/**
- * 菜单栏按钮配置
- */
-declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
+    url?: string;
+}
 
 /**
  * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
  * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
  */
-declare interface EditorMenuOptions<TName extends string> {
+export declare interface EditorMenuOptions<TName extends string> {
     /**
-     * 菜单栏是否显示
+     * 菜单栏是否隐藏，设置为true, 则整个菜单栏不显示
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
-     * 是否禁用菜单栏所有功能
+     * 是否禁用菜单栏所有功能。设置为true，菜单栏依旧显示，但所有菜单项为灰色不可点击
      */
     disabled?: boolean;
     /**
-     * 菜单栏一级菜单配置
+     * 菜单栏一级菜单配置，指显示在菜单栏上的菜单项。
      */
     entries?: EditorMenuEntryConfig<TName>[];
     /**
      * 菜单栏功能按钮配置
+     * 更加间接的配置项
      */
-    features?: Partial<EditorMenuFeatureButtonConfig<TName>>;
+    features?: Partial<Record<TName, EditorMenuFeatureConfig>>;
     /**
      * 自定义按钮配置
      */
-    custom?: EditorMenuCustomButton[];
+    custom?: (EditorMenuButtonMenuItemConfig<string> | EditorMenuLinkMenuItemConfig<string>)[];
 }
 
 /**
  * 编辑器基础模式接口
  */
-declare interface EditorMode {
+export declare interface EditorMode {
     /**
      * 获取当前编辑器模式
      */
@@ -1388,7 +2054,7 @@ declare interface EditorMode {
 /**
  * 编辑器初始化的时相关的模式配置
  */
-declare type EditorModeOptions = {
+export declare type EditorModeOptions = {
     type: 'standard';
     /**
      * 当 mode 为 `standard` 时，可以设置当前编辑器的权限模式
@@ -1406,12 +2072,12 @@ declare type EditorModeOptions = {
  * - `preview` 预览模式，只能查看内容
  * - `presentation` 演示模式，用作演示场景，演示模式下部分套件可以进行一些简单的编辑操作
  */
-declare type EditorModeType = 'standard' | 'preview' | 'presentation';
+export declare type EditorModeType = 'standard' | 'preview' | 'presentation';
 
 /**
  * 编辑器初始化通用参数
  */
-declare interface EditorOptions {
+export declare interface EditorOptions {
     /**
      * 编辑器初始化内容，可以是 string 或者 ArrayBuffer，
      * 也可以通过异步 Promise 加载
@@ -1425,6 +2091,14 @@ declare interface EditorOptions {
      * 当前操作编辑器的用户信息
      */
     user?: EditorUserOptions;
+    /**
+     * 匿名用户的缺省信息
+     */
+    anonymous?: EditorAnonymousOptions;
+    /**
+     * 当前文件信息
+     */
+    file?: EditorFileOptions;
     /**
      * i18n 相关设置
      */
@@ -1432,17 +2106,13 @@ declare interface EditorOptions {
     /**
      * 品牌相关设置
      */
-    brand?: EditorBrandOptions;
-    /**
-     * 工具栏相关设置
-     */
-    toolbar?: EditorToolbarOptions;
+    brand?: MaybePromiseValue<EditorBrandOptions>;
     /**
      * 编辑器内部资源请求配置
      */
     assets?: EditorAssetsOptions;
     /**
-     * 编辑器内部超链接设置
+     * 编辑器链接相关配置
      */
     link?: EditorLinkOptions;
     /**
@@ -1461,12 +2131,52 @@ declare interface EditorOptions {
      * 编辑器评论设置
      */
     comments?: EditorCommentsOptions;
+    /**
+     * 附件设置
+     */
+    attachment?: EditorAttachmentOptions;
+    /**
+     * 导出设置
+     */
+    export?: EditorExportOptions;
+    /**
+     * 解密设置
+     */
+    decryption?: EditorDecryptionOptions;
+    /**
+     * 网络请求设置
+     */
+    http?: HTTPProxy;
+    /**
+     * 编辑器渲染设置项
+     */
+    render?: EditorRenderOptions;
+    /**
+     * 编辑器 UI 相关
+     */
+    ui?: EditorUiOptions;
+    /**
+     * 编辑器卡点限制
+     */
+    checkpoints?: EditorCheckpointsOptions;
+    /**
+     * 编辑器工具箱设置
+     */
+    toolbox?: EditorToolboxOptions;
+    /**
+     * 编辑器历史设置
+     */
+    history?: EditorHistoryOptions;
+    /**
+     * 编辑器协作相关
+     */
+    collaboration?: EditorCollaborationOptions;
 }
 
 /**
  * 大纲目录接口
  */
-declare interface EditorOutline<Content = unknown> {
+export declare interface EditorOutline<Content = unknown> {
     /**
      * 设置大纲目录是否可见
      * @param visible 是否可见
@@ -1494,7 +2204,7 @@ declare interface EditorOutline<Content = unknown> {
 /**
  * 大纲目录项条目
  */
-declare interface EditorOutlineItem<Content = unknown> {
+export declare interface EditorOutlineItem<Content = unknown> {
     /**
      * 目录项 ID
      */
@@ -1513,7 +2223,7 @@ declare interface EditorOutlineItem<Content = unknown> {
  * 大纲目录初始化参数，
  * 用于配置大纲目录的行为和外观。
  */
-declare interface EditorOutlineOptions {
+export declare interface EditorOutlineOptions {
     /**
      * 初始化编辑器时是否显示大纲目录，
      * 默认为 false。
@@ -1521,10 +2231,33 @@ declare interface EditorOutlineOptions {
     visible?: boolean;
 }
 
+export declare interface EditorPickedFile {
+    /**
+     * 文件大小
+     */
+    size: number;
+    /**
+     * 文件名
+     */
+    name: string;
+    /**
+     * 文件路径，仅显示有意义的相对路径，可用在上传文件夹和识别文件使用
+     */
+    path?: string;
+    /**
+     * 文件类型，mime-type
+     */
+    type: string;
+    /**
+     * 文件原始数据，用于给上传控件使用
+     */
+    raw: File;
+}
+
 /**
  * 编辑器打印设置
  */
-declare interface EditorPrintOptions {
+export declare interface EditorPrintOptions extends EditorFeatureConfig {
     /**
      * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
      * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
@@ -1532,16 +2265,30 @@ declare interface EditorPrintOptions {
     fallback?: {
         message: string;
     };
+}
+
+/**
+ * 远程文件上传
+ */
+export declare interface EditorRemoteUploadableFile extends EditorBaseUploadableFile {
+    src: string;
+    name?: never;
+    size?: never;
+    mime?: never;
+    raw?: never;
+}
+
+export declare interface EditorRenderOptions {
     /**
-     * 是否禁用打印功能
+     * 渲染的容器
      */
-    disabled?: boolean;
+    container?: HTMLElement;
 }
 
 /**
  * 编辑器通用接口
  */
-declare abstract class EditorSDK {
+export declare abstract class EditorSDK {
     protected options: EditorOptions;
     constructor(options: EditorOptions);
     /**
@@ -1557,38 +2304,103 @@ declare abstract class EditorSDK {
      * mount 应该在 init 之后调用。
      * @param root
      */
-    abstract mount(root: HTMLElement): Promise<void>;
+    abstract mount(root: HTMLElement): Promise<void>;
+    /**
+     * 从根节点卸载编辑器，对应 `mount` 操作
+     */
+    abstract unmount(): Promise<void>;
+    /**
+     * 编辑器内容相关接口
+     */
+    abstract get content(): EditorContent;
+    /**
+     * 编辑器模式相关接口
+     */
+    abstract get mode(): EditorMode;
+    /**
+     * 编辑器评论相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get comments(): EditorComments | undefined;
+    /**
+     * 编辑器协作者相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get collaborators(): EditorCollaborators | undefined;
+    /**
+     * 编辑器历史相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get history(): EditorHistory | undefined;
+    /**
+     * 编辑器版本相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get version(): EditorVersion | undefined;
+}
+
+/**
+ * 编辑器在 `standard` 模式下的权限模式
+ * - `editor` 编辑模式
+ * - `viewer` 阅读模式
+ * - `reviewer` 评论模式
+ */
+export declare type EditorStandardRole = 'editor' | 'viewer' | 'reviewer';
+
+/**
+ * 上传任务回调
+ */
+export declare interface EditorTaskCallbacks {
+    /**
+     * 上传进度回调
+     * @param taskId
+     * @param loaded
+     * @param total
+     * @param progress
+     * @param data
+     * @returns
+     */
+    onProgress?: (taskId: string, loaded: number, total: number, progress: number, data?: unknown) => void;
+    /**
+     * 上传错误回调
+     * @param taskId
+     * @param error
+     * @returns
+     */
+    onError?: (taskId: string, error: Error) => void;
     /**
-     * 从根节点卸载编辑器，对应 `mount` 操作
+     * 上传暂停回调
+     * @param taskId
+     * @returns
      */
-    abstract unmount(): Promise<void>;
+    onPause?: (taskId: string) => void;
     /**
-     * 编辑器内容相关接口
+     * 上传取消
+     * @param taskId
+     * @returns
      */
-    abstract get content(): EditorContent;
+    onAbort?: (taskId: string) => void;
     /**
-     * 编辑器模式相关接口
+     * 上传恢复
+     * @param taskId
+     * @returns
      */
-    abstract get mode(): EditorMode;
+    onResume?: (taskId: string) => void;
     /**
-     * 编辑器评论相关接口
+     * 上传完成回调
+     * @param taskId
+     * @param status
+     * @param data
+     * @returns
      */
-    abstract get comments(): EditorComments;
+    onEnd?: (taskId: string, status: 'Error' | 'Finished' | 'Canceled', data: unknown) => void;
 }
 
-/**
- * 编辑器在 `standard` 模式下的权限模式
- * - `editor` 编辑模式
- * - `viewer` 阅读模式
- * - `reviewer` 评论模式
- */
-declare type EditorStandardRole = 'editor' | 'viewer' | 'reviewer';
-
 /**
  * 文本格式接口，
  * 包括设置、读取选区内文本的 BIUS、family、大小、颜色等
  */
-declare interface EditorText<Color = string, TRangeValue = unknown> {
+export declare interface EditorText<Color = string, TRangeValue = unknown> {
     /**
      * 获取当前选区或指定选区内的文本格式状态
      */
@@ -1612,7 +2424,7 @@ declare interface EditorText<Color = string, TRangeValue = unknown> {
 /**
  * 文本格式状态
  */
-declare interface EditorTextFormat<Color = string> {
+export declare interface EditorTextFormat<Color = string> {
     /**
      * 粗体
      */
@@ -1650,7 +2462,7 @@ declare interface EditorTextFormat<Color = string> {
 /**
  * 文本格式初始化选项
  */
-declare interface EditorTextOptions<Color = string> {
+export declare interface EditorTextOptions<Color = string> {
     /**
      * 当前编辑器默认的文本格式
      */
@@ -1658,43 +2470,15 @@ declare interface EditorTextOptions<Color = string> {
 }
 
 /**
- * 工具栏自定义按钮配置
- */
-declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
-    /**
-     * 自定义按钮名称
-     */
-    name: string;
-    /**
-     * 按钮点击事件
-     */
-    callback: () => void;
-    /**
-     * 按钮在工具栏中的位置，默认添加到工具栏所有按钮后面
-     */
-    index?: number;
-}
-
-/**
- * 工具栏自定义按钮配置
- */
-declare interface EditorToolbarCustomButtonConfig {
-    /**
-     * 按钮配置
-     */
-    [key: string]: EditorToolbarCustomButton;
-}
-
-/**
- * 工具栏内置功能按钮配置
+ * 工具栏功能按钮配置(包括内置按钮和自定义按钮)
  */
-declare interface EditorToolbarFeatureButton {
+export declare interface EditorToolbarFeatureButton<TName extends string> extends EditorFeatureConfig {
     /**
-     * 按钮类型
+     * 按钮的唯一标识，用以确定配置的是哪个按钮。
      */
-    name: EditorToolbarFeatureButtonName;
+    name?: TName;
     /**
-     * 按钮标签（显示文本）
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
     label?: string;
     /**
@@ -1702,63 +2486,34 @@ declare interface EditorToolbarFeatureButton {
      */
     icon?: string;
     /**
-     * 按钮是否禁用
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
      */
-    disabled?: boolean;
+    callback?: () => void;
     /**
-     * 按钮提示文本
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
      */
     tooltip?: string;
+    /**
+     * 按钮在工具栏中位置，不设置则按照默认位置
+     */
+    index?: number;
 }
 
 /**
  * 工具栏内置功能按钮配置
  */
-declare type EditorToolbarFeatureButtonConfig = {
-    [key in EditorToolbarFeatureButtonName]?: EditorToolbarFeatureButton;
+export declare type EditorToolbarFeatureButtonConfig<TName extends string> = {
+    [key in TName]?: EditorToolbarFeatureButton<key>;
 };
 
-/**
- * 工具栏内置功能按钮
- */
-declare type EditorToolbarFeatureButtonName = 
-/**
-* 加粗
-*/
-'bold'
-/**
-* 斜体
-*/
-| 'italic'
-/**
-* 下划线
-*/
-| 'underline'
-/**
-* 删除线
-*/
-| 'strikethrough'
-/**
-* 插入图片
-*/
-| 'insertImage'
-/**
-* 插入链接
-*/
-| 'insertLink'
-/**
-* 限制编辑
-*/
-| 'restriction';
-
 /**
  * 工具栏相关设置，可以控制工具栏的显示内容
  */
-declare interface EditorToolbarOptions {
+export declare interface EditorToolbarOptions<TName extends string> {
     /**
      * 控制工具栏显隐状态
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
      * 是否禁用工具栏所有功能
      */
@@ -1766,17 +2521,142 @@ declare interface EditorToolbarOptions {
     /**
      * 现有按钮的功能配置
      */
-    features?: EditorToolbarFeatureButtonConfig;
+    features?: EditorToolbarFeatureButtonConfig<TName>;
     /**
      * 自定义按钮
      */
-    custom?: EditorToolbarCustomButtonConfig;
+    custom?: EditorToolbarFeatureButtonConfig<string>;
+}
+
+/**
+ * 编辑器工具箱配置选项接口
+ */
+export declare interface EditorToolboxOptions {
+    /**
+     * 获取工具箱配置
+     * @param attachGuidList - 附件GUID列表
+     * @returns 返回工具箱工具项列表
+     */
+    getToolbox?: (attachGuidList: string[]) => Promise<{
+        tools: ToolboxToolItem[];
+    }>;
+}
+
+/**
+ * 编辑器UI选项接口
+ * 定义了编辑器可以使用的UI相关功能
+ */
+export declare interface EditorUiOptions {
+    /**
+     * 侧边栏
+     */
+    sidebar?: {
+        /**
+         * 打开使用指南/快捷键侧边栏
+         */
+        open?: (activeKey: 'userGuide' | 'shortcut') => void;
+    };
+    /**
+     * 升级弹窗
+     */
+    upgrade?: {
+        /**
+         * 显示升级弹窗
+         */
+        showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse>;
+    };
+    notification?: {
+        /**
+         * 渲染通知条
+         */
+        render?: (params: RenderNotificationProps) => void;
+    };
+    /**
+     * 用户名片
+     */
+    userCard?: {
+        /**
+         * 需要排除的用户卡片字段（不会在用户卡片中展示）
+         */
+        excludeFields?: string[];
+        /**
+         * 渲染用户卡片
+         */
+        render?: (params: RenderUserCardProps) => RenderUserCardResult;
+    };
+    /**
+     * toast
+     */
+    toast?: {
+        /**
+         * 显示自定义toast
+         */
+        show?: (options: ShowToastOptions) => void;
+        /**
+         * 是否禁用toast
+         */
+        disabled?: boolean;
+    };
+    /**
+     * confirm
+     */
+    confirm?: {
+        /**
+         * 显示自定义confirm
+         */
+        show?: (options: ShowConfirmOptions) => void;
+        /**
+         * 是否禁用confirm
+         */
+        disabled?: boolean;
+    };
+}
+
+export declare type EditorUploadableFile = EditorLocalUploadableFile;
+
+/**
+ * 文件开始上传入参
+ */
+export declare interface EditorUploadStartOptions extends EditorUploadTaskCallbacks {
+    files: EditorUploadableFile[];
+}
+
+/**
+ * 上传状态
+ */
+export declare enum EditorUploadStatus {
+    Waiting = "Waiting",
+    Uploading = "Uploading",
+    Paused = "Paused",
+    Canceled = "Canceled",
+    Error = "Error",
+    Finished = "Finished"
+}
+
+export declare type EditorUploadTaskCallbacks = Omit<EditorTaskCallbacks, 'onEnd'> & {
+    onLoadend: (results: {
+        taskId: string;
+        status: 'Error' | 'Finished' | 'Canceled';
+        data?: unknown;
+    }[]) => void;
+};
+
+/**
+ * 上传任务信息
+ */
+export declare interface EditorUploadTaskInfo {
+    taskId: string;
+    fileInfo: EditorUploadableFile;
+    total: number;
+    readonly loaded: number;
+    readonly progress: number;
+    readonly status: EditorUploadStatus;
 }
 
 /**
  * 操作当前编辑器的用户信息
  */
-declare interface EditorUserOptions {
+export declare interface EditorUserOptions {
     /**
      * 用户 ID，用于标识用户
      */
@@ -1789,12 +2669,23 @@ declare interface EditorUserOptions {
      * 用户头像
      */
     avatar?: string;
+    /**
+     * 用户默认头像，当用户未设置头像时显示
+     */
+    defaultAvatar?: string;
+}
+
+export declare interface EditorVersion {
+    /**
+     * 保存版本
+     */
+    createRevision: () => void;
 }
 
 /**
  * 编辑器外部水印信息
  */
-declare interface EditorWatermarkOptions {
+export declare interface EditorWatermarkOptions {
     /**
      * 获取用作初始化使用的默认水印
      */
@@ -1806,7 +2697,7 @@ declare interface EditorWatermarkOptions {
     required?: boolean;
 }
 
-declare type EditorWatermarkResource = {
+export declare type EditorWatermarkResource = {
     type: 'data-url';
     url: string;
 } | {
@@ -1814,21 +2705,101 @@ declare type EditorWatermarkResource = {
     url: string;
 };
 
+export declare enum FeatureStatus {
+    /**
+     * 隐藏
+     */
+    Hidden = 0,
+    /**
+     * 正常
+     */
+    Normal = 1,
+    /**
+     * 禁用
+     */
+    Disabled = 2
+}
+
+export declare interface FileLinkParams {
+    /**
+     * 文件guid
+     */
+    fileGuid: string;
+    /**
+     * 文件类型，如docs，sheets
+     */
+    type: string;
+    /**
+     * 用于定位到 mention、评论等位置。
+     */
+    hash?: string;
+    /**
+     * 其他自定义字段
+     */
+    [key: string]: unknown;
+}
+
+/**
+ * 文件子类型枚举
+ */
+export declare enum FileSubtype {
+    /** 专业版幻灯片 */
+    ProSlide = -10,
+    /** 白板 */
+    Whiteboard = -9,
+    /** 表单 */
+    Form = -8,
+    /** 思维导图 */
+    Mind = -7,
+    /** 专业文档 */
+    ProDoc = -6,
+    /** 幻灯片 */
+    Slide = -5,
+    /** 新表格 */
+    NewSheet = -4,
+    /** 老表格 */
+    Sheet = -3,
+    /** 新文档 */
+    NewDoc = -2,
+    /** 老老表格 */
+    OldSheet = -1,
+    /** 旧文档 */
+    OldDoc = 0,
+    /** 文件夹 */
+    Folder = 1,
+    /** 协作 */
+    Collaboration = 2
+}
+
+/**
+ * 文件类型枚举
+ */
+export declare enum FileType {
+    /** 未知类型 */
+    Unknown = 0,
+    /** 文件夹或空间 */
+    FolderOrSpace = 1,
+    /** 石墨文件 */
+    ShimoFile = 2,
+    /** 云文件 */
+    CloudFile = 3
+}
+
 /**
  * 请求、响应头
  */
-declare type HTTPHeaders = Record<string, string | number | boolean | undefined>;
+export declare type HTTPHeaders = Record<string, string | number | boolean | undefined>;
 
 /**
  * 请求方法
  */
-declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
+export declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
 
 /**
  * HTTP 代理，用于抽象 HTTP 请求，
  * 将请求代理编辑器外部
  */
-declare interface HTTPProxy {
+export declare interface HTTPProxy {
     /**
      * 发送请求，如果需要做请求、响应拦截，需要在 proxy.interceptors 中实现，
      * 套件内使用 proxy 发送请求的方式应该为类似如下方式:
@@ -1875,7 +2846,7 @@ declare interface HTTPProxy {
 /**
  * 请求配置
  */
-declare interface HTTPRequestConfig<Data = unknown> {
+export declare interface HTTPRequestConfig<Data = unknown> {
     /**
      * 请求地址
      */
@@ -1901,7 +2872,7 @@ declare interface HTTPRequestConfig<Data = unknown> {
 /**
  * 响应数据
  */
-declare interface HTTPResponse<Data = unknown> {
+export declare interface HTTPResponse<Data = unknown> {
     /**
      * 响应数据 body
      */
@@ -1919,8 +2890,262 @@ declare interface HTTPResponse<Data = unknown> {
 /**
  * 请求返回类型
  */
-declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+
+export declare interface Limitation {
+    /**
+     * 限制原因（错误码）
+     */
+    code?: number;
+    /**
+     * 单位（不参与计算，仅作显示）
+     * minutes、MB
+     */
+    unit?: string;
+    /**
+     * 描述
+     */
+    desc?: string;
+    /**
+     * min/max int64 默认表示 MB/个/分钟/行
+     */
+    max?: number;
+    min?: number;
+}
+
+export declare type MaybePromiseValue<T> = T | Promise<T>;
+
+/**
+ * 升级弹窗类型
+ * 个人版或企业版
+ */
+export declare type OpenType = 'personal' | 'enterprise';
+
+export declare interface RenderNotificationProps {
+    /**
+     * 渲染的容器
+     */
+    container: HTMLElement;
+    /**
+     * 自定义样式，实际类型为React.CSSProperties
+     */
+    style?: Record<string, string | number>;
+}
+
+export declare interface RenderUserCardProps {
+    uid: string | number;
+    rect: {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+        hasReducedHeaderHeight?: boolean;
+    };
+    position?: 'top' | 'left' | 'right' | 'bottom' | 'left_top' | 'left_bottom' | 'right_top' | 'bottom_top' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right';
+    trigger: 'hover' | 'click';
+}
+
+export declare interface RenderUserCardResult {
+    /**
+     * 关闭用户卡片
+     */
+    close: (force?: boolean) => void;
+}
+
+/**
+ * 升级操作结果类型枚举
+ */
+export declare enum ResultType {
+    /** 操作成功 */
+    Success = "success",
+    /** 用户取消操作 */
+    Cancel = "cancel",
+    /** 发生错误 */
+    Error = "error",
+    /** 跳转（目前仅在企业版用户过期时返回） */
+    Redirect = "redirect"
+}
+
+export declare interface SaveContext {
+    clientId: string;
+}
+
+export declare interface SaveStatusDelegation {
+    /**
+     * 保存状态发生变化时触发回调
+     * @param state
+     * @returns
+     */
+    onChangeState: (state: unknown, context: SaveContext) => void;
+    /**
+     * 出现致命错误时触发回调，出现致命错误后，编辑器将无法继续编辑
+     * @param error
+     * @returns
+     */
+    onError: (error: unknown, context: SaveContext) => void;
+}
+
+/**
+ * 付费场景类型
+ */
+export declare type Scene = 'history' | 'version' | 'public' | 'search' | 'attachments';
+
+export declare interface ShowConfirmOptions {
+    /**
+     * 确认框标题
+     */
+    title: string;
+    /**
+     * 确认框描述
+     */
+    description: string;
+    /**
+     * 确认按钮配置
+     */
+    confirmButton?: ConfirmButtonConfig;
+    /**
+     * 取消按钮配置
+     */
+    cancelButton?: ConfirmButtonConfig;
+}
+
+export declare interface ShowToastOptions {
+    /**
+     * toast标题
+     */
+    title: string;
+    /**
+     * toast类型
+     */
+    type: 'success' | 'error' | 'warn' | 'info';
+    /**
+     * 显示时长，默认3s
+     */
+    duration?: number;
+    /**
+     * 是否自动隐藏，默认true
+     */
+    autoHide?: boolean;
+}
+
+/**
+ * 升级弹窗配置选项接口
+ */
+export declare interface ShowUpgradeModalProps {
+    /** 打开个人升级弹窗还是企业弹窗 */
+    openType: OpenType;
+    /** 触发功能的Key值 */
+    serviceKey: string;
+    /** 文件类型（如果业务能够获取到则为必传） */
+    fileType?: FileType;
+    /** 文件子类型（如果业务能够获取到则为必传） */
+    fileSubtype?: FileSubtype;
+    /** 付费场景，用于升级弹窗的定制化文案显示 */
+    scene?: Scene;
+}
+
+/**
+ * 升级弹窗响应接口
+ */
+export declare interface ShowUpgradeModalResponse {
+    /** 操作结果 */
+    result: ResultType;
+    /** 错误信息（供开发人员查看） */
+    errorMsg?: string;
+}
+
+/**
+ * 演讲者信息接口
+ * 包含演讲者的基本信息
+ */
+export declare interface Speaker {
+    /** 演讲者ID */
+    id: number;
+    /** 演讲者姓名 */
+    name: string;
+    /** 演讲者头像URL */
+    avatar: string;
+}
+
+export declare interface SyncContext {
+    clientId: string;
+    timestamp: number;
+}
+
+export declare interface SyncStatusDelegation {
+    /**
+     * 同步状态发生变化时触发回调
+     * @param state
+     * @param context
+     * @returns
+     */
+    onChangeState: (state: unknown, context: SyncContext) => void;
+    /**
+     * 出现致命错误时触发回调，出现致命错误后，编辑器将无法继续编辑
+     * @param error
+     * @param context
+     * @returns
+     */
+    onError: (error: unknown, context: SyncContext) => void;
+}
+
+/**
+ * 工具箱工具项接口
+ */
+export declare interface ToolboxToolItem {
+    /** 工具类型 */
+    type: ToolTypes;
+    /** 工具名称 */
+    name: string;
+    /** 工具图标 */
+    icon: string;
+    /** 工具分组 */
+    group: ToolGroupTypes;
+    /** 分组名称 */
+    groupName: string;
+    /** 是否为测试版功能 */
+    isBeta: boolean;
+    /** 工具回调函数 */
+    callback: () => Promise<{
+        result: 'success' | 'failed';
+        error?: unknown;
+    }>;
+}
+
+/**
+ * 工具分组类型枚举
+ */
+export declare enum ToolGroupTypes {
+    /** 转换工具组 */
+    Convert = "convert",
+    /** 处理工具组 */
+    Processing = "processing",
+    /** 智能工具组 */
+    Intelligent = "intelligent"
+}
 
-declare type MaybePromiseValue<T> = T | Promise<T>;
+/**
+ * 工具类型枚举
+ */
+export declare enum ToolTypes {
+    /** PDF转Word */
+    PdfToWord = "pdfToWord",
+    /** PDF转Excel */
+    PdfToExcel = "pdfToExcel",
+    /** PDF转PPT */
+    PdfToPpt = "pdfToPpt",
+    /** 图片转PDF */
+    ImgToPdf = "imgToPdf",
+    /** PDF合并 */
+    PdfMerge = "pdfMerge",
+    /** PDF拆分 */
+    PdfSplit = "pdfSplit",
+    /** 文件内容提取 */
+    FileContentExtraction = "fileContentExtraction",
+    /** 图片转文字 */
+    COR = "imgToText",
+    /** 音频转文字 */
+    STT = "audioToText"
+}
 
 export { }