@officesdk/editor-sdk-core 0.0.0-10 → 0.0.0-12

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

@@ -1,16 +1,12 @@
 export declare abstract class AbstractedDocxSDK extends EditorSDK {
     /**
-     * 打印文档
+     * 文档准备就绪
      */
-    abstract print(): Promise<void>;
+    abstract ready(): Promise<void>;
     /**
-     * 跳转到某个位置
-     */
-    abstract goto(options: DocxGotoOptions): boolean;
-    /**
-     * 文档缩放接口
-     * @param scale
+     * 打印文档
      */
+    abstract print(): Promise<void>;
     /**
      * 文档目录集合接口，
      * 一个文档中可以存在多个目录，这个接口是用来管理文档中的所有目录的。
@@ -46,6 +42,46 @@ 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 DocxContextMenuEntryConfig = EditorContextMenuEntryConfig<DocxContextMenuFeatureButtonName>;
+
+/**
+ * 传统文档工具栏功能按钮
+ */
+export declare type DocxContextMenuFeatureButtonConfig = EditorContextMenuFeatureButtonConfig<DocxContextMenuFeatureButtonName>;
+
+/**
+ * 传统文档右键菜单功能按钮
+ */
+export declare type DocxContextMenuFeatureButtonName = 'cut' | 'copy' | 'paste' | 'delete' | 'font' | 'paragraph' | 'downloadAttachment' | 'transformPDF';
+
+export declare type DocxContextMenuOptions = EditorContextMenuOptions<DocxContextMenuFeatureButtonName>;
+
 export declare type DocxFontFace = Omit<EditorFontFace, 'meta'> & {
     meta: DocxFontMeta;
 };
@@ -117,40 +153,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,6 +182,8 @@ export declare interface DocxInfoOptions {
         time?: number;
         author?: string;
     };
+    id: string;
+    name: string;
 }
 
 /**
@@ -195,7 +199,7 @@ export declare type DocxMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<
 /**
  * 传统文档工具栏内置功能按钮
  */
-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' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertCloudFile' | 'insertSignature' | 'insertImageFromUrl';
 
 export declare type DocxMenuOptions = EditorMenuOptions<DocxMenuFeatureButtonName>;
 
@@ -363,6 +367,10 @@ export declare interface DocxSDKOptions extends EditorOptions {
      * 菜单栏相关设置
      */
     menu?: DocxMenuOptions;
+    /**
+     * 右键菜单相关设置
+     */
+    contextMenu?: DocxContextMenuOptions;
     /**
      *  Pdf 大纲目录设置
      */
@@ -486,6 +494,19 @@ export declare interface DocxSelection {
      * @returns
      */
     getWholeRange: () => DocxRange;
+    /**
+     * 向当前选区位置插入文本，
+     * 返回插入后当前选区位置
+     * @param text
+     * @returns
+     */
+    insertText: (text: string) => DocxRangeValue;
+    /**
+     * 向当前选区位置插入 HTML 内容，
+     * 返回插入后当前选区位置
+     * @param html
+     */
+    insertHtml: (html: string) => DocxRangeValue;
 }
 
 /**
@@ -571,9 +592,9 @@ 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"/>
+     * <a:font script="Hans" typeface="黑体"/\>
+     * <a:font script="Jpan" typeface="HG明朝B"/\>
+     * <a:font script="Arab" typeface="Times New Roman"/\>
      */
     font: Record<string, DocxThemeFont>;
 }
@@ -817,12 +838,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
@@ -832,7 +862,7 @@ export declare interface DocxWindow {
      * 将传入的区域滚动到可视区域
      * @param range
      */
-    scrollIntoView: (range: DocxRangeValue) => void;
+    scrollIntoView: (range: DocxRangeValue, options?: DocxWindowScrollIntoViewOptions) => void;
     /**
      * 添加滚动监听器
      * @param listener
@@ -843,6 +873,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;
+};
+
 /**
  * 文档缩放接口
  */
@@ -881,10 +984,25 @@ export declare interface DocxZoom {
     zoomOut: () => void;
 }
 
+/**
+ * 匿名用户信息
+ * 当前用户信息未知时的缺省值
+ */
+export declare interface EditorAnonymousOptions {
+    /**
+     * 匿名用户默认显示名称
+     */
+    name: string;
+    /**
+     * 匿名用户默认头像
+     */
+    avatar: string;
+}
+
 /**
  * 编辑器内部资源请求配置
  */
-declare interface EditorAssetsOptions {
+export declare interface EditorAssetsOptions {
     /**
      * 通用资源请求代理配置，
      * 用于套件内部资源请求时代理请求
@@ -903,7 +1021,7 @@ declare interface EditorAssetsOptions {
 /**
  * 基于对象存储的图片处理抽象
  */
-declare interface EditorAssetsOssImageProcessing {
+export declare interface EditorAssetsOssImageProcessing {
     /**
      * 压缩图片的方法
      * @param imageUrl 图片的 URL
@@ -930,7 +1048,7 @@ declare interface EditorAssetsOssImageProcessing {
     }) => Promise<string>;
 }
 
-declare interface EditorAssetsResolver {
+export declare interface EditorAssetsResolver {
     /**
      * 将资源文件 ID 转换为 URL 的方法
      * @param assetId 资源文件 ID
@@ -952,11 +1070,121 @@ declare interface EditorAssetsResolver {
     checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
 }
 
+/**
+ * 编辑器附件限制配置,sdk中会使用在不同的场景下使用不同的限制规则组合
+ */
+export declare interface EditorAttachmentLimitationOptions {
+    /**
+     * 检查附件大小的规则
+     * @param file
+     * @returns
+     */
+    checkFile: (params: EditorAttachmentLimitationOptionsCheckFunctionParams) => Promise<{
+        limited: true;
+        message: string;
+    } | {
+        limited: false;
+    }>;
+}
+
+/**
+ * 编辑器附件限制配置检查函数参数
+ */
+export declare interface EditorAttachmentLimitationOptionsCheckFunctionParams {
+    /**
+     * 文件名称，带后缀名
+     */
+    name: string;
+    /**
+     * 文件大小，单位为Byte
+     */
+    size: number;
+    /**
+     * 文件的mime类型，例如image/jpeg、application/vnd.ms-excel等
+     */
+    mime?: string;
+}
+
+/**
+ * 编辑器附件限制配置
+ * @deprecated 使用limitations代替
+ */
+export declare interface EditorAttachmentMaxSizeOptions {
+    /**
+     * 图片大小上限值，单位为Byte
+     * 设置为Infinity时表示不限制图片大小
+     */
+    value?: number;
+    /**
+     * 超限警告相关配置
+     */
+    warning?: {
+        /**
+         * 超限警告文本
+         */
+        text?: string;
+    };
+}
+
+/**
+ * 编辑器附件信息
+ */
+export declare interface EditorAttachmentOptions {
+    uploader: AbstractedEditorFileUploader;
+    download: (url: string) => void;
+    /**
+     * 图片附件相关配置
+     */
+    image?: {
+        /**
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
+         */
+        maxSize?: EditorAttachmentMaxSizeOptions;
+        /**
+         * 支持的图片格式列表，例如jpg,png等
+         */
+        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;
+}
+
 /**
  * 品牌相关设置，
  * 用于在套件中展示品牌外露信息
  */
-declare interface EditorBrandOptions {
+export declare interface EditorBrandOptions {
     /**
      * 需要显示在品牌展示位的内容，按数组顺序显示
      */
@@ -980,7 +1208,7 @@ declare interface EditorBrandOptions {
 /**
  * 单条评论数据
  */
-declare interface EditorCommentItem {
+export declare interface EditorCommentItem {
     /**
      * 评论 ID
      */
@@ -997,7 +1225,7 @@ declare interface EditorCommentItem {
     };
 }
 
-declare interface EditorComments {
+export declare interface EditorComments {
     /**
      * 检查是否有评论
      * @returns
@@ -1043,7 +1271,7 @@ declare interface EditorComments {
 /**
  * 编辑器评论初始化配置
  */
-declare interface EditorCommentsOptions {
+export declare interface EditorCommentsOptions {
     /**
      * 评论作者信息，如果这里的信息为空，将会使用 user 信息
      */
@@ -1074,7 +1302,7 @@ declare interface EditorCommentsOptions {
     };
 }
 
-declare interface EditorContent {
+export declare interface EditorContent<Delta = EditorDelta> {
     /**
      * 设置编辑器内容
      * @param content
@@ -1083,15 +1311,42 @@ 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 EditorContextMenuEntryButton<TName extends string> = EditorMenuEntryButton<TName>;
+
+/**
+ * 右键菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
+ * 右键菜单栏一级菜单指点击右键弹出菜单时的菜单项
+ */
+export declare type EditorContextMenuEntryConfig<TName extends string> = EditorMenuEntryConfig<TName>;
+
+/**
+ * 右键菜单栏功能按钮配置
+ */
+export declare type EditorContextMenuFeatureButton<TName extends string> = EditorMenuFeatureButton<TName>;
+
+/**
+ * 右键菜单栏按钮配置
+ */
+export declare type EditorContextMenuFeatureButtonConfig<TName extends string> = EditorMenuFeatureButtonConfig<TName>;
+
+/**
+ * 右键菜单栏相关配置
+ * 右键菜单栏是指的编辑器中点击右键弹出的菜单栏。目前等于菜单栏配置，可扩展
+ */
+export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
+
+export declare interface EditorDelta {
     compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
     transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
     stringify: () => string;
@@ -1101,7 +1356,7 @@ declare interface EditorDelta {
 /**
  * 编辑器嵌入对象
  */
-declare interface EditorEmbeddedObject {
+export declare interface EditorEmbeddedObject {
     /**
      * 嵌入的对象 url
      */
@@ -1119,7 +1374,7 @@ declare interface EditorEmbeddedObject {
 /**
  * 编辑器嵌入对象抽象类
  */
-declare interface EditorEmbeddedObjectOptions {
+export declare interface EditorEmbeddedObjectOptions {
     /**
      * 执行打开嵌入对象操作，
      * 如果已经处理了打开操作，返回 true，否则返回 false，
@@ -1147,7 +1402,20 @@ declare interface EditorEmbeddedObjectOptions {
     };
 }
 
-declare interface EditorFontFace {
+export declare interface EditorExportOptions {
+    /**
+     * 可导出类型
+     * @description
+     */
+    supportedTypes?: string[];
+    /**
+     * 导出文件
+     * @description
+     */
+    exportFile: (type: string) => Promise<void>;
+}
+
+export declare interface EditorFontFace {
     /**
      * 字体的名称，用于在用户界面上显示的名称
      */
@@ -1173,7 +1441,7 @@ declare interface EditorFontFace {
 /**
  * 字体元数据
  */
-declare interface EditorFontMeta {
+export declare interface EditorFontMeta {
     head: {
         unitsPerEm: number;
     };
@@ -1207,10 +1475,28 @@ declare interface EditorFontMeta {
     };
 }
 
+/**
+ * 字体列表
+ */
+export declare interface EditorFontsList {
+    /**
+     * 返回解析为字体的列表的 Promise。
+     */
+    getAll: () => Promise<EditorFontFace[]>;
+}
+
+export declare interface EditorFontsOptions {
+    /**
+     * 服务器字体列表，用于获取服务器端配置的字体列表，
+     * 并提供可用于字体的加载 URL 和字体元数据。
+     */
+    list: EditorFontsList;
+}
+
 /**
  * i18n 相关设置
  */
-declare interface EditorI18nOptions {
+export declare interface EditorI18nOptions {
     /**
      * 语言，默认使用浏览器当前环境中的语言
      */
@@ -1221,12 +1507,12 @@ 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 {
     /**
      * 打开链接，如果取消了打开链接操作，返回 false
      * @param url
@@ -1236,10 +1522,20 @@ declare interface EditorLinkOptions {
     open: (url: string, target: string) => Promise<boolean>;
 }
 
+/**
+ * 可上传文件
+ */
+export declare interface EditorLocalUploadableFile extends EditorBaseUploadableFile {
+    name: string;
+    size: number;
+    mime: string;
+    raw: File;
+}
+
 /**
  * 菜单栏自定义按钮配置
  */
-declare type EditorMenuCustomButton = {
+export declare type EditorMenuCustomButton = {
     /**
      * 按钮名称
      */
@@ -1282,7 +1578,7 @@ declare type EditorMenuCustomButton = {
 /**
  * 菜单栏二级以下的菜单入口
  */
-declare interface EditorMenuEntryButton {
+export declare interface EditorMenuEntryButton<TName extends string> {
     type: 'entry';
     /**
      * 菜单名称
@@ -1292,13 +1588,17 @@ declare interface EditorMenuEntryButton {
      * 菜单图标
      */
     icon?: string;
+    /**
+     * 下一级子菜单
+     */
+    children?: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
 }
 
 /**
  * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
  * 一级菜单在鼠标悬停时展示二级列表
  */
-declare interface EditorMenuEntryConfig<TName extends string> {
+export declare interface EditorMenuEntryConfig<TName extends string> {
     /**
      * 一级菜单名称
      */
@@ -1308,13 +1608,17 @@ declare interface EditorMenuEntryConfig<TName extends string> {
      * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
      * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
      */
-    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton>[];
+    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
+    /**
+     * 是否隐藏一级菜单
+     */
+    type?: 'hidden';
 }
 
 /**
  * 菜单栏功能按钮配置
  */
-declare type EditorMenuFeatureButton<TName extends string> = {
+export declare type EditorMenuFeatureButton<TName extends string> = {
     /**
      * 隐藏按钮，用作在需要隐藏菜单栏时定义
      */
@@ -1342,17 +1646,17 @@ declare type EditorMenuFeatureButton<TName extends string> = {
 /**
  * 菜单栏按钮配置
  */
-declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
+export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
 
 /**
  * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
  * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
  */
-declare interface EditorMenuOptions<TName extends string> {
+export declare interface EditorMenuOptions<TName extends string> {
     /**
-     * 菜单栏是否显示
+     * 菜单栏是否隐藏
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
      * 是否禁用菜单栏所有功能
      */
@@ -1374,7 +1678,7 @@ declare interface EditorMenuOptions<TName extends string> {
 /**
  * 编辑器基础模式接口
  */
-declare interface EditorMode {
+export declare interface EditorMode {
     /**
      * 获取当前编辑器模式
      */
@@ -1393,7 +1697,7 @@ declare interface EditorMode {
 /**
  * 编辑器初始化的时相关的模式配置
  */
-declare type EditorModeOptions = {
+export declare type EditorModeOptions = {
     type: 'standard';
     /**
      * 当 mode 为 `standard` 时，可以设置当前编辑器的权限模式
@@ -1411,12 +1715,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 加载
@@ -1430,6 +1734,10 @@ declare interface EditorOptions {
      * 当前操作编辑器的用户信息
      */
     user?: EditorUserOptions;
+    /**
+     * 匿名用户的缺省信息
+     */
+    anonymous?: EditorAnonymousOptions;
     /**
      * i18n 相关设置
      */
@@ -1438,10 +1746,6 @@ declare interface EditorOptions {
      * 品牌相关设置
      */
     brand?: EditorBrandOptions;
-    /**
-     * 工具栏相关设置
-     */
-    toolbar?: EditorToolbarOptions;
     /**
      * 编辑器内部资源请求配置
      */
@@ -1466,12 +1770,20 @@ declare interface EditorOptions {
      * 编辑器评论设置
      */
     comments?: EditorCommentsOptions;
+    /**
+     * 附件设置
+     */
+    attachment?: EditorAttachmentOptions;
+    /**
+     * 导出设置
+     */
+    export?: EditorExportOptions;
 }
 
 /**
  * 大纲目录接口
  */
-declare interface EditorOutline<Content = unknown> {
+export declare interface EditorOutline<Content = unknown> {
     /**
      * 设置大纲目录是否可见
      * @param visible 是否可见
@@ -1499,7 +1811,7 @@ declare interface EditorOutline<Content = unknown> {
 /**
  * 大纲目录项条目
  */
-declare interface EditorOutlineItem<Content = unknown> {
+export declare interface EditorOutlineItem<Content = unknown> {
     /**
      * 目录项 ID
      */
@@ -1518,7 +1830,7 @@ declare interface EditorOutlineItem<Content = unknown> {
  * 大纲目录初始化参数，
  * 用于配置大纲目录的行为和外观。
  */
-declare interface EditorOutlineOptions {
+export declare interface EditorOutlineOptions {
     /**
      * 初始化编辑器时是否显示大纲目录，
      * 默认为 false。
@@ -1529,7 +1841,7 @@ declare interface EditorOutlineOptions {
 /**
  * 编辑器打印设置
  */
-declare interface EditorPrintOptions {
+export declare interface EditorPrintOptions {
     /**
      * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
      * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
@@ -1543,10 +1855,21 @@ declare interface EditorPrintOptions {
     disabled?: boolean;
 }
 
+/**
+ * 远程文件上传
+ */
+export declare interface EditorRemoteUploadableFile extends EditorBaseUploadableFile {
+    src: string;
+    name?: never;
+    size?: never;
+    mime?: never;
+    raw?: never;
+}
+
 /**
  * 编辑器通用接口
  */
-declare abstract class EditorSDK {
+export declare abstract class EditorSDK {
     protected options: EditorOptions;
     constructor(options: EditorOptions);
     /**
@@ -1587,13 +1910,62 @@ declare abstract class EditorSDK {
  * - `viewer` 阅读模式
  * - `reviewer` 评论模式
  */
-declare type EditorStandardRole = '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;
+    /**
+     * 上传暂停回调
+     * @param taskId
+     * @returns
+     */
+    onPause?: (taskId: string) => void;
+    /**
+     * 上传取消
+     * @param taskId
+     * @returns
+     */
+    onAbort?: (taskId: string) => void;
+    /**
+     * 上传恢复
+     * @param taskId
+     * @returns
+     */
+    onResume?: (taskId: string) => void;
+    /**
+     * 上传完成回调
+     * @param taskId
+     * @param status
+     * @param data
+     * @returns
+     */
+    onEnd?: (taskId: string, status: 'Error' | 'Finished' | 'Canceled', data: unknown) => void;
+}
 
 /**
  * 文本格式接口，
  * 包括设置、读取选区内文本的 BIUS、family、大小、颜色等
  */
-declare interface EditorText<Color = string, TRangeValue = unknown> {
+export declare interface EditorText<Color = string, TRangeValue = unknown> {
     /**
      * 获取当前选区或指定选区内的文本格式状态
      */
@@ -1617,7 +1989,7 @@ declare interface EditorText<Color = string, TRangeValue = unknown> {
 /**
  * 文本格式状态
  */
-declare interface EditorTextFormat<Color = string> {
+export declare interface EditorTextFormat<Color = string> {
     /**
      * 粗体
      */
@@ -1655,7 +2027,7 @@ declare interface EditorTextFormat<Color = string> {
 /**
  * 文本格式初始化选项
  */
-declare interface EditorTextOptions<Color = string> {
+export declare interface EditorTextOptions<Color = string> {
     /**
      * 当前编辑器默认的文本格式
      */
@@ -1665,7 +2037,7 @@ declare interface EditorTextOptions<Color = string> {
 /**
  * 工具栏自定义按钮配置
  */
-declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
+export declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
     /**
      * 自定义按钮名称
      */
@@ -1683,7 +2055,7 @@ declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureBut
 /**
  * 工具栏自定义按钮配置
  */
-declare interface EditorToolbarCustomButtonConfig {
+export declare interface EditorToolbarCustomButtonConfig {
     /**
      * 按钮配置
      */
@@ -1693,11 +2065,11 @@ declare interface EditorToolbarCustomButtonConfig {
 /**
  * 工具栏内置功能按钮配置
  */
-declare interface EditorToolbarFeatureButton {
+export declare interface EditorToolbarFeatureButton<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
     /**
      * 按钮类型
      */
-    name: EditorToolbarFeatureButtonName;
+    name: ToolButtonName;
     /**
      * 按钮标签（显示文本）
      */
@@ -1706,6 +2078,10 @@ declare interface EditorToolbarFeatureButton {
      * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
     icon?: string;
+    /**
+     * 按钮是否隐藏
+     */
+    hidden?: boolean;
     /**
      * 按钮是否禁用
      */
@@ -1719,14 +2095,14 @@ declare interface EditorToolbarFeatureButton {
 /**
  * 工具栏内置功能按钮配置
  */
-declare type EditorToolbarFeatureButtonConfig = {
-    [key in EditorToolbarFeatureButtonName]?: EditorToolbarFeatureButton;
+export declare type EditorToolbarFeatureButtonConfig<ToolButtonName extends string> = {
+    [key in ToolButtonName]?: EditorToolbarFeatureButton<ToolButtonName>;
 };
 
 /**
  * 工具栏内置功能按钮
  */
-declare type EditorToolbarFeatureButtonName = 
+export declare type EditorToolbarFeatureButtonName = 
 /**
 * 加粗
 */
@@ -1759,11 +2135,11 @@ declare type EditorToolbarFeatureButtonName =
 /**
  * 工具栏相关设置，可以控制工具栏的显示内容
  */
-declare interface EditorToolbarOptions {
+export declare interface EditorToolbarOptions<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
     /**
      * 控制工具栏显隐状态
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
      * 是否禁用工具栏所有功能
      */
@@ -1771,17 +2147,58 @@ declare interface EditorToolbarOptions {
     /**
      * 现有按钮的功能配置
      */
-    features?: EditorToolbarFeatureButtonConfig;
+    features?: EditorToolbarFeatureButtonConfig<ToolButtonName>;
     /**
      * 自定义按钮
      */
     custom?: EditorToolbarCustomButtonConfig;
 }
 
+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，用于标识用户
      */
@@ -1794,12 +2211,16 @@ declare interface EditorUserOptions {
      * 用户头像
      */
     avatar?: string;
+    /**
+     * 用户默认头像，当用户未设置头像时显示
+     */
+    defaultAvatar?: string;
 }
 
 /**
  * 编辑器外部水印信息
  */
-declare interface EditorWatermarkOptions {
+export declare interface EditorWatermarkOptions {
     /**
      * 获取用作初始化使用的默认水印
      */
@@ -1811,7 +2232,7 @@ declare interface EditorWatermarkOptions {
     required?: boolean;
 }
 
-declare type EditorWatermarkResource = {
+export declare type EditorWatermarkResource = {
     type: 'data-url';
     url: string;
 } | {
@@ -1822,18 +2243,18 @@ declare type EditorWatermarkResource = {
 /**
  * 请求、响应头
  */
-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 发送请求的方式应该为类似如下方式:
@@ -1880,7 +2301,7 @@ declare interface HTTPProxy {
 /**
  * 请求配置
  */
-declare interface HTTPRequestConfig<Data = unknown> {
+export declare interface HTTPRequestConfig<Data = unknown> {
     /**
      * 请求地址
      */
@@ -1906,7 +2327,7 @@ declare interface HTTPRequestConfig<Data = unknown> {
 /**
  * 响应数据
  */
-declare interface HTTPResponse<Data = unknown> {
+export declare interface HTTPResponse<Data = unknown> {
     /**
      * 响应数据 body
      */
@@ -1924,8 +2345,8 @@ declare interface HTTPResponse<Data = unknown> {
 /**
  * 请求返回类型
  */
-declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 
-declare type MaybePromiseValue<T> = T | Promise<T>;
+export declare type MaybePromiseValue<T> = T | Promise<T>;
 
 export { }