@officesdk/editor-sdk-core 0.0.0-11 → 0.0.0-13

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

@@ -1,29 +1,3 @@
-/**
- *  抽象 Diagram 接口
- */
-export declare abstract class AbstractedDiagramSDK {
-    protected options: DiagramSDKOptions;
-    constructor(options: DiagramSDKOptions);
-    /**
-     * 初始化 Diagram 、加载插件等操作。
-     */
-    abstract init(): Promise<void>;
-    /**
-     * 销毁 Diagram
-     */
-    abstract destroy(): Promise<void>;
-    /**
-     * 将 Diagram 挂载到指定的根节点上，并渲染，
-     * mount 应该在 init 之后调用。
-     * @param root
-     */
-    abstract mount(root: HTMLElement): Promise<void>;
-    /**
-     * 从根节点卸载 Diagram ，对应 `mount` 操作
-     */
-    abstract unmount(): Promise<void>;
-}
-
 export declare abstract class AbstractedDocxSDK extends EditorSDK {
     /**
      * 文档准备就绪
@@ -92,140 +66,43 @@ export declare abstract class AbstractedEditorFileUploader {
 }
 
 /**
- *  抽象 Pdf 接口
+ * 传统文档右键菜单功能按钮
  */
-export declare abstract class AbstractedPdfSDK {
-    protected options: PdfSDKOptions;
-    constructor(options: PdfSDKOptions);
-    /**
-     * 初始化 Pdf 、加载插件等操作。
-     */
-    abstract init(): Promise<void>;
-    /**
-     * 销毁 Pdf
-     */
-    abstract destroy(): Promise<void>;
-    /**
-     * 将 Pdf 挂载到指定的根节点上，并渲染，
-     * mount 应该在 init 之后调用。
-     * @param root
-     */
-    abstract mount(root: HTMLElement): Promise<void>;
-    /**
-     * 从根节点卸载 pdf ，对应 `mount` 操作
-     */
-    abstract unmount(): Promise<void>;
-    /**
-     * pdf 页面操作接口
-     */
-    abstract get pages(): PdfPages;
-    /**
-     * pdf 选区接口
-     */
-    abstract get selection(): PdfSelection;
-    /**
-     * pdf 目录接口
-     */
-    abstract get outline(): PdfOutline;
-}
-
-export declare abstract class AbstractedPresentationSDK extends EditorSDK {
-    /**
-     * 幻灯片准备就绪
-     */
-    abstract ready(): Promise<void>;
-    /**
-     * 打印幻灯片
-     */
-    abstract print(): Promise<void>;
-    /**
-     * 幻灯片集合接口
-     */
-    abstract get slides(): PresentationSlides;
-    /**
-     * 幻灯片选区接口，用于获取、操作当前 slide 的选区
-     */
-    abstract get selection(): PresentationSelection;
-    /**
-     * 幻灯片缩放接口
-     * @param scale
-     */
-    abstract get zoom(): PresentationZoom;
-    /**
-     * 文本格式接口
-     */
-    abstract get text(): PresentationText;
-}
-
-export declare abstract class AbstractedSheetSDK extends EditorSDK {
-    /**
-     * 表格准备就绪
-     */
-    abstract ready(): Promise<void>;
-    /**
-     * 打印文档
-     */
-    abstract print(): Promise<void>;
-    /**
-     * 工作簿接口
-     */
-    abstract get workbook(): SheetWorkbook;
-    /**
-     * 当前活跃工作表对象
-     */
-    abstract get activeSheet(): SheetWorksheet;
-    /**
-     * 当前活动单元格
-     */
-    abstract get activeCell(): SheetCell | null;
-    /**
-     * 获取当前选区
-     */
-    abstract get selections(): SheetSelection[] | null;
-    /**
-     * 文本格式接口
-     */
-    abstract get text(): SheetText;
-}
-
+export declare type DocxContextMenuFeatureButtonName = 
 /**
- *  Diagram 初始化参数
- */
-export declare interface DiagramSDKOptions {
-    /**
-     *  Diagram 初始化内容，可以是 string 或者 ArrayBuffer，
-     * 也可以通过异步 Promise 加载
-     */
-    content: MaybePromiseValue<string | ArrayBuffer>;
-    /**
-     * 当前操作 Diagram 的用户信息
-     */
-    user?: EditorUserOptions;
-    /**
-     * i18n 相关设置
-     */
-    i18n?: EditorI18nOptions;
-    /**
-     * 品牌相关设置
-     */
-    brand?: EditorBrandOptions;
-    /**
-     *  Diagram 内部资源请求配置
-     */
-    assets?: EditorAssetsOptions;
-    /**
-     *  Diagram 内部超链接设置
-     */
-    link?: EditorLinkOptions;
-    /**
-     * 初始化水印配置
-     */
-    watermark?: EditorWatermarkOptions;
-    /**
-     *  Diagram 打印设置
-     */
-    print?: EditorPrintOptions;
-}
+* 剪切
+*/
+'cut'
+/**
+* 复制
+*/
+| 'copy'
+/**
+* 粘贴
+*/
+| 'paste'
+/**
+* 删除
+*/
+| 'delete'
+/**
+* 字体
+*/
+| 'font'
+/**
+* 段落
+*/
+| 'paragraph'
+/**
+* 下载附件
+*/
+| 'downloadAttachment'
+/**
+* 转换PDF
+*/
+| 'transformPDF';
+
+export declare type DocxContextMenuOptions = EditorContextMenuOptions<DocxContextMenuFeatureButtonName>;
 
 export declare type DocxFontFace = Omit<EditorFontFace, 'meta'> & {
     meta: DocxFontMeta;
@@ -332,20 +209,18 @@ export declare interface DocxInfoOptions {
 }
 
 /**
- * 传统文档工具栏一级菜单
+ * 传统文档菜单栏一级菜单
  */
 export declare type DocxMenuEntryConfig = EditorMenuEntryConfig<DocxMenuFeatureButtonName>;
 
 /**
- * 传统文档工具栏功能按钮
+ * 传统文档菜单栏内置功能按钮
  */
-export declare type DocxMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<DocxMenuFeatureButtonName>;
+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 DocxMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'attachment' | 'cloudFile' | 'signature' | 'image';
-
 export declare type DocxMenuOptions = EditorMenuOptions<DocxMenuFeatureButtonName>;
 
 /**
@@ -512,6 +387,10 @@ export declare interface DocxSDKOptions extends EditorOptions {
      * 菜单栏相关设置
      */
     menu?: DocxMenuOptions;
+    /**
+     * 右键菜单相关设置
+     */
+    contextMenu?: DocxContextMenuOptions;
     /**
      *  Pdf 大纲目录设置
      */
@@ -635,6 +514,19 @@ export declare interface DocxSelection {
      * @returns
      */
     getWholeRange: () => DocxRange;
+    /**
+     * 向当前选区位置插入文本，
+     * 返回插入后当前选区位置
+     * @param text
+     * @returns
+     */
+    insertText: (text: string) => DocxRangeValue;
+    /**
+     * 向当前选区位置插入 HTML 内容，
+     * 返回插入后当前选区位置
+     * @param html
+     */
+    insertHtml: (html: string) => DocxRangeValue;
 }
 
 /**
@@ -720,9 +612,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>;
 }
@@ -990,7 +882,7 @@ export declare interface DocxWindow {
      * 将传入的区域滚动到可视区域
      * @param range
      */
-    scrollIntoView: (range: DocxRangeValue) => void;
+    scrollIntoView: (range: DocxRangeValue, options?: DocxWindowScrollIntoViewOptions) => void;
     /**
      * 添加滚动监听器
      * @param listener
@@ -1001,13 +893,27 @@ 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 方法拿到
+     * 区域值，这个值可以通过 DocxSelection 的 getRange 方法拿到，取start或者end
      */
     range: string;
 } | {
@@ -1098,6 +1004,21 @@ export declare interface DocxZoom {
     zoomOut: () => void;
 }
 
+/**
+ * 匿名用户信息
+ * 当前用户信息未知时的缺省值
+ */
+export declare interface EditorAnonymousOptions {
+    /**
+     * 匿名用户默认显示名称
+     */
+    name: string;
+    /**
+     * 匿名用户默认头像
+     */
+    avatar: string;
+}
+
 /**
  * 编辑器内部资源请求配置
  */
@@ -1169,12 +1090,104 @@ export 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;
+    };
 }
 
 /**
@@ -1309,7 +1322,7 @@ export declare interface EditorCommentsOptions {
     };
 }
 
-export declare interface EditorContent {
+export declare interface EditorContent<Delta = EditorDelta> {
     /**
      * 设置编辑器内容
      * @param content
@@ -1318,14 +1331,20 @@ export declare interface EditorContent {
     /**
      * 获取编辑器内容
      */
-    getContent: () => Promise<EditorDelta>;
+    getContent: () => Promise<Delta>;
     /**
      * 添加监听，当内容发生变化时触发监听，传入 Delta
      * @param listener
      */
-    addChangeListener: (listener: (change: EditorDelta) => void) => () => void;
+    addChangeListener: (listener: (change: Delta) => void) => () => void;
 }
 
+/**
+ * 右键菜单栏相关配置
+ * 右键菜单栏是指的编辑器中点击右键弹出的菜单栏。目前等于菜单栏配置，可扩展
+ */
+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;
@@ -1513,138 +1532,136 @@ export declare interface EditorLocalUploadableFile extends EditorBaseUploadableF
 }
 
 /**
- * 菜单栏自定义按钮配置
+ * 基础菜单项配置，所有菜单项类型都包含这些属性
  */
-export declare type EditorMenuCustomButton = {
+declare interface EditorMenuBaseMenuItemConfig<TName extends string> {
     /**
-     * 按钮名称
+     * 菜单项的唯一标识，用以确定配置的是哪个菜单
      */
-    name: string;
+    name: TName;
+    /**
+     * 菜单项类型
+     */
+    type?: EditorMenuItemType;
+}
+
+/**
+ * 按钮菜单项配置
+ */
+export declare interface EditorMenuButtonMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type?: 'button';
     /**
-     * 链接
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    type: 'link';
+    disabled?: boolean;
     /**
-     * 按钮文本
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
      */
-    text: string;
+    label?: string;
     /**
-     * 链接地址
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
-    url: string;
-} | {
+    icon?: string;
     /**
-     * 按钮名称
+     * 菜单项点击事件，接受一个函数，可以自定义点击事件
      */
-    name: string;
+    callback?: () => void;
+}
+
+/**
+ * 编辑器菜单配置类型
+ * 联合类型，表示可以是任意一种菜单项配置
+ */
+export declare type EditorMenuEntryConfig<TName extends string> = EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName>;
+
+/**
+ * 子菜单入口配置
+ */
+export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type?: 'entry';
     /**
-     * 按钮，点击后触发 callback 回调
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    type: 'button';
+    disabled?: boolean;
     /**
-     * 按钮文本
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
      */
-    label: string;
+    label?: string;
     /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
     icon?: string;
     /**
-     * 按钮点击事件
+     * 下一级菜单配置，下一级菜单配置项和上一级相同
+     * 如果下一级仍然是 entry 类型，可以无限向下扩展
      */
-    callback: () => void;
-};
+    children?: EditorMenuEntryConfig<TName>[];
+}
 
 /**
- * 菜单栏二级以下的菜单入口
+ * 隐藏菜单项配置
  */
-export declare interface EditorMenuEntryButton {
-    type: 'entry';
-    /**
-     * 菜单名称
-     */
-    name: string;
-    /**
-     * 菜单图标
-     */
-    icon?: string;
+export declare interface EditorMenuHiddenMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type?: 'hidden';
 }
 
 /**
- * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
- * 一级菜单在鼠标悬停时展示二级列表
+ * 菜单项类型
+ */
+export declare type EditorMenuItemType = 'hidden' | 'button' | 'link' | 'entry';
+
+/**
+ * 链接菜单项配置
  */
-export declare interface EditorMenuEntryConfig<TName extends string> {
+export declare interface EditorMenuLinkMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type?: 'link';
     /**
-     * 一级菜单名称
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    name: string;
+    disabled?: boolean;
+    /**
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
+     */
+    label?: string;
+    /**
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
+     */
+    icon?: string;
     /**
-     * 二级菜单定义，定一个二维数组，用于定义二级菜单的结构，
-     * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
-     * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
+     * 跳转链接地址
      */
-    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton>[];
+    url?: string;
 }
 
 /**
- * 菜单栏功能按钮配置
+ * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
+ * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
  */
-export declare type EditorMenuFeatureButton<TName extends string> = {
+export declare interface EditorMenuOptions<TName extends string> {
     /**
-     * 隐藏按钮，用作在需要隐藏菜单栏时定义
+     * 菜单栏是否隐藏，设置为true, 则整个菜单栏不显示
      */
-    type: 'hidden';
+    hidden?: boolean;
     /**
-     * 按钮名称
+     * 是否禁用菜单栏所有功能。设置为true，菜单栏依旧显示，但所有菜单项为灰色不可点击
      */
-    name: TName;
-} | {
-    type: 'button';
+    disabled?: boolean;
     /**
-     * 按钮名称
-     */
-    name: TName;
-    /**
-     * 按钮标签（显示文本）
-     */
-    label: string;
-    /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
-     */
-    icon?: string;
-};
-
-/**
- * 菜单栏按钮配置
- */
-export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
-
-/**
- * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
- * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
- */
-export declare interface EditorMenuOptions<TName extends string> {
-    /**
-     * 菜单栏是否显示
-     */
-    visible?: boolean;
-    /**
-     * 是否禁用菜单栏所有功能
-     */
-    disabled?: boolean;
-    /**
-     * 菜单栏一级菜单配置
+     * 菜单栏一级菜单配置，指显示在菜单栏上的菜单项。
      */
     entries?: EditorMenuEntryConfig<TName>[];
     /**
      * 菜单栏功能按钮配置
+     * TODO 此配置目前没有用到，后续看是保留还是和custom合并
      */
-    features?: Partial<EditorMenuFeatureButtonConfig<TName>>;
+    features?: EditorMenuEntryConfig<TName>[];
     /**
      * 自定义按钮配置
      */
-    custom?: EditorMenuCustomButton[];
+    custom?: EditorMenuEntryConfig<TName>[];
 }
 
 /**
@@ -1706,6 +1723,10 @@ export declare interface EditorOptions {
      * 当前操作编辑器的用户信息
      */
     user?: EditorUserOptions;
+    /**
+     * 匿名用户的缺省信息
+     */
+    anonymous?: EditorAnonymousOptions;
     /**
      * i18n 相关设置
      */
@@ -1714,10 +1735,6 @@ export declare interface EditorOptions {
      * 品牌相关设置
      */
     brand?: EditorBrandOptions;
-    /**
-     * 工具栏相关设置
-     */
-    toolbar?: EditorToolbarOptions;
     /**
      * 编辑器内部资源请求配置
      */
@@ -2007,107 +2024,58 @@ export declare interface EditorTextOptions<Color = string> {
 }
 
 /**
- * 工具栏自定义按钮配置
+ * 工具栏功能按钮配置(包括内置按钮和自定义按钮)
  */
-export declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
+export declare interface EditorToolbarFeatureButton<TName extends string> {
     /**
-     * 自定义按钮名称
+     * 按钮的唯一标识，用以确定配置的是哪个按钮。
      */
-    name: string;
-    /**
-     * 按钮点击事件
-     */
-    callback: () => void;
+    name: TName;
     /**
-     * 按钮在工具栏中的位置，默认添加到工具栏所有按钮后面
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
-    index?: number;
-}
-
-/**
- * 工具栏自定义按钮配置
- */
-export declare interface EditorToolbarCustomButtonConfig {
+    label?: string;
     /**
-     * 按钮配置
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
-    [key: string]: EditorToolbarCustomButton;
-}
-
-/**
- * 工具栏内置功能按钮配置
- */
-export declare interface EditorToolbarFeatureButton {
+    icon?: string;
     /**
-     * 按钮类型
+     * 按钮是否隐藏，设置为true则隐藏按钮
      */
-    name: EditorToolbarFeatureButtonName;
+    hidden?: boolean;
     /**
-     * 按钮标签（显示文本）
+     * 按钮是否禁用，设置为true则变为灰色不可点击
      */
-    label?: string;
+    disabled?: boolean;
     /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
      */
-    icon?: string;
+    callback?: () => void;
     /**
-     * 按钮是否禁用
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
      */
-    disabled?: boolean;
+    tooltip?: string;
     /**
-     * 按钮提示文本
+     * 按钮在工具栏中位置，不设置则按照默认位置
      */
-    tooltip?: string;
+    index?: number;
 }
 
 /**
  * 工具栏内置功能按钮配置
  */
-export declare type EditorToolbarFeatureButtonConfig = {
-    [key in EditorToolbarFeatureButtonName]?: EditorToolbarFeatureButton;
+export declare type EditorToolbarFeatureButtonConfig<TName extends string> = {
+    [key in TName]?: EditorToolbarFeatureButton<key>;
 };
 
-/**
- * 工具栏内置功能按钮
- */
-export declare type EditorToolbarFeatureButtonName = 
-/**
-* 加粗
-*/
-'bold'
-/**
-* 斜体
-*/
-| 'italic'
-/**
-* 下划线
-*/
-| 'underline'
-/**
-* 删除线
-*/
-| 'strikethrough'
-/**
-* 插入图片
-*/
-| 'insertImage'
-/**
-* 插入链接
-*/
-| 'insertLink'
-/**
-* 限制编辑
-*/
-| 'restriction';
-
 /**
  * 工具栏相关设置，可以控制工具栏的显示内容
  */
-export declare interface EditorToolbarOptions {
+export declare interface EditorToolbarOptions<TName extends string> {
     /**
      * 控制工具栏显隐状态
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
      * 是否禁用工具栏所有功能
      */
@@ -2115,11 +2083,11 @@ export declare interface EditorToolbarOptions {
     /**
      * 现有按钮的功能配置
      */
-    features?: EditorToolbarFeatureButtonConfig;
+    features?: EditorToolbarFeatureButtonConfig<TName>;
     /**
      * 自定义按钮
      */
-    custom?: EditorToolbarCustomButtonConfig;
+    custom?: EditorToolbarFeatureButtonConfig<string>;
 }
 
 export declare type EditorUploadableFile = EditorLocalUploadableFile;
@@ -2179,6 +2147,10 @@ export declare interface EditorUserOptions {
      * 用户头像
      */
     avatar?: string;
+    /**
+     * 用户默认头像，当用户未设置头像时显示
+     */
+    defaultAvatar?: string;
 }
 
 /**
@@ -2313,842 +2285,4 @@ export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'js
 
 export declare type MaybePromiseValue<T> = T | Promise<T>;
 
-/**
- * pdf 工具栏一级菜单
- */
-export declare type PdfMenuEntryConfig = EditorMenuEntryConfig<PdfMenuFeatureButtonName>;
-
-/**
- * 传统文档工具栏功能按钮
- */
-export declare type PdfMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<PdfMenuFeatureButtonName>;
-
-/**
- * pdf 工具栏内置功能按钮
- */
-export declare type PdfMenuFeatureButtonName = 'selectAll';
-
-export declare type PdfMenuOptions = EditorMenuOptions<PdfMenuFeatureButtonName>;
-
-/**
- * pdf 目录大纲项接口
- */
-export declare type PdfOutline = EditorOutline<{
-    text: string;
-}>;
-
-/**
- * pdf 目录大纲项信息，用于描述 pdf 中的目录项信息。
- */
-export declare type PdfOutlineItem = EditorOutlineItem<{
-    text: string;
-}>;
-
-export declare type PdfOutlineOptions = EditorOutlineOptions;
-
-/**
- * pdf 页面实例，
- * 可以通过实例对对应页面进行操作。
- */
-export declare interface PdfPage {
-    /**
-     * 获取当前页码
-     */
-    readonly pageNumber: number;
-    /**
-     * 获取当前页面的大小
-     * @returns
-     */
-    getPageSize: () => {
-        width: number;
-        height: number;
-    };
-}
-
-/**
- * pdf 页面集合操作接口，
- * 该接口和 PdfPage 负责不同的功能，
- * PdfPage 是一个页面的抽象，而 PdfPages 是对整个 pdf 文件中所有页面的操作。
- */
-export declare interface PdfPages {
-    /**
-     * 获取当前页码
-     * @returns
-     */
-    getCurrentPageNumber: () => number;
-    /**
-     * 设置当前页码并跳转至对应页面
-     * @param page
-     */
-    setCurrentPage: (page: number) => void;
-    /**
-     * 获取总页数
-     * @returns
-     */
-    getPagesCount: () => number;
-    /**
-     * 获取指定页面
-     */
-    getPage: (page: number) => Promise<PdfPage | null>;
-}
-
-/**
- * 区域（Range）
- * 区域对象，表示文件中的一个连续区域，每个 Range 对象包含起始字符位置和终止字符位置。
- */
-/**
- * Pdf 区域对象，
- * 用于表示 Pdf 中的一个连续区域，
- * 每个选区值包含了起始位置和结束位置信息。
- */
-export declare interface PdfRange {
-    /**
-     * 区域的开始位置。
-     */
-    readonly start: string;
-    /**
-     * 区域的结束位置。
-     */
-    readonly end: string;
-    /**
-     * 获取该区域对应的纯文本信息。
-     * @returns
-     */
-    getText: () => string;
-    /**
-     * 将区域中的内容以 HTML 格式返回。
-     * @returns
-     */
-    getHtml: () => string;
-    /**
-     * 获取选区在当前屏幕上的位置信息
-     * @returns
-     */
-    getBounding: () => PdfRangeBounding | null;
-}
-
-/**
- * 记录选区在屏幕上的矩形位置信息，
- * 包含整个选区包围盒的四个边界值（top, right, bottom, left），
- * 以及第一行开始和最后一行结束的横向坐标。
- * 这些信息是选区中所有 ClientRects 的集合范围。
- */
-export declare interface PdfRangeBounding {
-    /**
-     * 区域的上边界值，
-     * 表示所有选区中最上方的 Y 坐标。
-     */
-    top: number;
-    /**
-     * 区域的右边界值，
-     * 表示所有选区中最右侧的 X 坐标。
-     */
-    right: number;
-    /**
-     * 区域的下边界值，
-     * 表示所有选区中最下方的 Y 坐标。
-     */
-    bottom: number;
-    /**
-     * 区域的左边界值，
-     * 表示所有选区中最左侧的 X 坐标。
-     */
-    left: number;
-    /**
-     * 第一行选区的起始 X 坐标。
-     */
-    start: number;
-    /**
-     * 最后一行选区的结束 X 坐标。
-     */
-    end: number;
-}
-
-export declare interface PdfRangeValue {
-    start: string;
-    end: string;
-}
-
-/**
- *  Pdf 初始化参数
- */
-export declare interface PdfSDKOptions {
-    /**
-     *  Pdf 初始化内容，可以是 string 或者 ArrayBuffer，
-     * 也可以通过异步 Promise 加载
-     */
-    content: MaybePromiseValue<string | ArrayBuffer>;
-    /**
-     * 当前操作 Pdf 的用户信息
-     */
-    user?: EditorUserOptions;
-    /**
-     * i18n 相关设置
-     */
-    i18n?: EditorI18nOptions;
-    /**
-     * 品牌相关设置
-     */
-    brand?: EditorBrandOptions;
-    /**
-     *  Pdf 内部资源请求配置
-     */
-    assets?: EditorAssetsOptions;
-    /**
-     *  Pdf 内部超链接设置
-     */
-    link?: EditorLinkOptions;
-    /**
-     * 初始化水印配置
-     */
-    watermark?: EditorWatermarkOptions;
-    /**
-     *  Pdf 打印设置
-     */
-    print?: EditorPrintOptions;
-    /**
-     *  Pdf 大纲目录设置
-     */
-    outline?: PdfOutlineOptions;
-    /**
-     *  Pdf 菜单栏设置
-     */
-    menu?: PdfMenuOptions;
-}
-
-/**
- * 选区（Selection）
- * 表示窗口或窗格中的当前选定内容。
- */
-export declare interface PdfSelection {
-    /**
-     * 获取选区的区域范围，
-     * 如果没有指定范围，则返回当前选区的范围。
-     * 如果指定了范围，则返回指定范围的选区。
-     * 如果选区不存在，则返回 null。
-     * @returns
-     */
-    getRange: (value?: PdfRangeValue) => PdfRange | null;
-    /**
-     * 设置选区的区域范围，
-     * 设置后，选区会自动选中指定范围。
-     * 如果设置为 null，则清空选区。
-     * @param bounds
-     */
-    setRange: (vale: PdfRangeValue | null) => void;
-    /**
-     * 添加选区变化监听器，当选区发生变化时，会触发回调。
-     * @param listener
-     * @returns
-     */
-    addRangeListener: (listener: (value: PdfRangeValue | null) => void) => void;
-    /**
-     * 获取 pdf 全部选区范围。
-     * @returns
-     */
-    getWholeRange: () => PdfRange;
-}
-
-export declare type PresentationFontFace = EditorFontFace;
-
-export declare type PresentationFontMeta = EditorFontMeta;
-
-export declare interface PresentationFontsList {
-    getAll: () => Promise<PresentationFontFace[]>;
-}
-
-export declare interface PresentationFontsOptions {
-    list: PresentationFontsList;
-}
-
-/**
- * 幻灯片工具栏一级菜单
- */
-export declare type PresentationMenuEntryConfig = EditorMenuEntryConfig<PresentationMenuFeatureButtonName>;
-
-/**
- * 幻灯片工具栏功能按钮
- */
-export declare type PresentationMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<PresentationMenuFeatureButtonName>;
-
-/**
- * 幻灯片工具栏内置功能按钮
- */
-export declare type PresentationMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll';
-
-export declare type PresentationMenuOptions = EditorMenuOptions<PresentationMenuFeatureButtonName>;
-
-export declare interface PresentationSDKOptions extends EditorOptions {
-    /**
-     * 字体配置
-     */
-    fonts?: PresentationFontsOptions;
-    /**
-     * 菜单栏相关设置
-     */
-    menu?: PresentationMenuOptions;
-    /**
-     * 文本格式相关设置
-     */
-    text?: PresentationTextOptions;
-}
-
-/**
- * 选区（Selection）
- * 表示窗口中的当前选定内容。
- * 选定内容表示幻灯片中的选定（或突出显示）区域，或者代表插入点（如果未选择幻灯片中的任何内容）。
- */
-export declare interface PresentationSelection {
-    /**
-     * 获取选区的区域范围，
-     * 如果没有指定范围，则返回当前选区的范围。
-     * 如果指定了范围，则返回指定范围的选区。
-     * 如果选区不存在，则返回 null。
-     * @returns
-     */
-    getTextRange: (value?: PresentationTextRangeValue) => PresentationTextRange | null;
-    /**
-     * 设置选区的区域范围，
-     * 设置后，选区会自动选中指定范围。
-     * 如果设置为 null，则清空选区。
-     * @param value
-     */
-    setTextRange: (value: PresentationTextRangeValue | null) => void;
-    /**
-     * 获取当前选中的形状，
-     * 如果没有选中形状，则返回 null。
-     * 如果指定了 value，则返回指定形状。
-     * @param ids 指定的形状 id
-     * @returns
-     */
-    getSelectedShapes: (ids?: string[]) => PresentationShape[] | null;
-    /**
-     * 选中指定的形状，选中形状后会清空文字选区。
-     * 如果 value 为 null，则清空选中的形状。
-     * @param ids 指定的形状 id
-     * @returns
-     */
-    setSelectedShapes: (ids: string[] | null) => void;
-    /**
-     * 添加选区变化监听器，当选区发生变化时，会触发回调。
-     * @param listener
-     * @returns
-     */
-    addRangeListener: (listener: (value: PresentationTextRangeValue | null) => void) => void;
-}
-
-/**
- * 幻灯片形状(Shape)接口
- */
-export declare interface PresentationShape {
-    /**
-     * 获取形状的 id
-     */
-    readonly id: string;
-}
-
-/**
- * 幻灯片页面(Slide)对象，
- * 是幻灯片的基础操作单元，包含幻灯片的基本信息和操作方法。
- */
-export declare interface PresentationSlide {
-    /**
-     * 当前幻灯片的 id
-     */
-    readonly id: string;
-    /**
-     * 获取当前幻灯片在所有幻灯片中的索引
-     * @returns
-     */
-    getIndex: () => number;
-    /**
-     * 获取当前页面所有的形状
-     * @returns
-     */
-    getShapes: () => PresentationShape[];
-}
-
-/**
- * 幻灯片集合对象，
- * 该接口和 PresentationSlide 负责不同的功能，
- * PresentationSlide 是一个幻灯片页面的抽象，而 PresentationSlides 是对整个文件中所有页面的操作。
- */
-export declare interface PresentationSlides {
-    /**
-     * 获取当前幻灯片
-     */
-    getCurrentSlide: () => PresentationSlide;
-    /**
-     * 切换当前幻灯片
-     * @param slideId
-     */
-    setCurrentSlideIndex: (slideId: string) => void;
-    /**
-     * 获取幻灯片索引
-     * @param slideId
-     * @returns
-     */
-    getSlideIndex: (slideId: string) => number;
-    /**
-     * 获取幻灯片总数
-     */
-    getSlidesCount: () => number;
-    /**
-     * 获取所有幻灯片
-     * @returns
-     */
-    getSlides: () => PresentationSlide[];
-    /**
-     * 获取指定幻灯片
-     * @param slideId
-     */
-    getSlideById: (slideId: string) => PresentationSlide;
-    /**
-     * 获取当前选中的幻灯片。
-     * 至少存在一个选中的幻灯片。
-     * @returns
-     */
-    getSelectedSlides: (ids?: string[]) => PresentationSlide[];
-    /**
-     * 设置
-     * @param ids
-     * @returns
-     */
-    setSelectedSlides: (ids: string[]) => void;
-}
-
-/**
- * 演示文稿文本接口
- */
-export declare type PresentationText = EditorText<string, PresentationTextRangeValue>;
-
-/**
- * 演示文稿文本格式
- */
-export declare type PresentationTextFormat = EditorTextFormat;
-
-/**
- * 演示文稿文本格式初始化选项
- */
-export declare type PresentationTextOptions = EditorTextOptions<string>;
-
-/**
- * 区域（Range）
- * 区域对象，表示幻灯片页面中的一个连续的文字区域，每个 Range 对象包含起始字符位置和终止字符位置。
- * 区域信息是一个临时状态，当内容发生变化后，或切换了幻灯片 slide 区域信息可能会失效。
- */
-/**
- * 幻灯片区域对象，
- * 用于表示页面中的一个连续区域，
- * 每个选区值包含了起始位置和结束位置信息的字符串。
- */
-export declare interface PresentationTextRange {
-    /**
-     * 区域的开始位置，
-     * 当内容发生变化后，区域的标识可能会失效。
-     */
-    readonly start: string;
-    /**
-     * 区域的结束位置，
-     * 当内容发生变化后，区域的标识可能会失效。
-     */
-    readonly end: string;
-    /**
-     * 获取该区域对应的纯文本信息。
-     * @returns
-     */
-    getText: () => string;
-    /**
-     * 设置该区域的内容
-     * @param text 内容
-     */
-    setText: (text: string) => void;
-    /**
-     * 将区域中的内容以 HTML 格式返回
-     */
-    getHtml: () => string;
-    /**
-     * 设置该区域的内容为 HTML 格式
-     * @param html 内容
-     */
-    setHtml: (html: string) => void;
-}
-
-export declare interface PresentationTextRangeValue {
-    start: string;
-    end: string;
-}
-
-/**
- * 幻灯片缩放接口
- */
-export declare interface PresentationZoom {
-    /**
-     * 获取当前缩放比例。
-     * @returns
-     */
-    getPercentage: () => number;
-    /**
-     * 设置缩放比例，
-     * 有效范围 10 ~ 500。
-     * @param percentage
-     */
-    setPercentage: (percentage: number) => void;
-    /**
-     * 设置自动缩放模式，
-     * none: 不自动缩放，默认值。
-     * window: 根据窗口宽度自动缩放，页面宽度随着窗口宽度变化而变化
-     * @param mode 缩放模式，可以是 'window'
-     */
-    setFitMode: (mode: 'none' | 'window') => void;
-    /**
-     * 获取当前缩放模式。
-     * @returns
-     */
-    getFitMode: () => 'none' | 'window';
-    /**
-     * 放大。
-     */
-    zoomIn: () => void;
-    /**
-     * 缩小。
-     */
-    zoomOut: () => void;
-}
-
-/**
- * 表格单元格对象
- */
-export declare interface SheetCell {
-    /**
-     * 单元格所在的行号
-     */
-    row: number;
-    /**
-     * 单元格所在的列号
-     */
-    column: number;
-    /**
-     * 单元格所在的工作表 ID
-     */
-    sheetId: string;
-    /**
-     * 获取单元格的文本
-     */
-    getCellText: () => string;
-    /**
-     * 获取单元格的值
-     */
-    getCellValue: () => SheetCellValue | null;
-}
-
-/**
- * 单元格值类型
- */
-export declare type SheetCellValue = {
-    type: 'primitive';
-    value: string | number | boolean;
-} | {
-    type: 'date';
-    value: number;
-} | {
-    type: 'calcError';
-    value: {
-        error: string;
-    };
-};
-
-/**
- * 电子表格工具栏一级菜单
- */
-export declare type SheetMenuEntryConfig = EditorMenuEntryConfig<SheetMenuFeatureButtonName>;
-
-/**
- * 电子表格工具栏功能按钮
- */
-export declare type SheetMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<SheetMenuFeatureButtonName>;
-
-/**
- * 电子表格工具栏内置功能按钮
- */
-export declare type SheetMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll';
-
-export declare type SheetMenuOptions = EditorMenuOptions<SheetMenuFeatureButtonName>;
-
-/**
- * 表格区域对象，
- * 用于表示表格中被选中的单元格区域，
- * 可以是一个单元格、一行、一列、或某个区域。
- */
-export declare interface SheetRange {
-    /**
-     * 区域类型
-     */
-    type: `${SheetRangeType}`;
-    /**
-     * 区域的行开始位置
-     */
-    readonly row: number;
-    /**
-     * 区域的列开始位置
-     */
-    readonly column: number;
-    /**
-     * 区域的行数
-     */
-    readonly rowCount: number;
-    /**
-     * 区域的列数
-     */
-    readonly columnCount: number;
-    /**
-     * 获取该区域对应的纯文本信息。
-     * @returns
-     */
-    getText: () => string;
-    /**
-     * 设置该区域的内容
-     * @param text 内容
-     */
-    setText: (text: string) => void;
-    /**
-     * 将区域中的内容以 HTML 格式返回
-     */
-    getHtml: () => string;
-    /**
-     * 设置该区域的内容为 HTML 格式
-     * @param html 内容
-     */
-    setHtml: (html: string) => void;
-}
-
-/**
- * 区域（Range）
- * 区域对象，表示表格中的一个单元格区域，每个 Range 对象包含了一个或多个单元格、行、列信息。
- */
-/**
- * 选区类型
- */
-export declare enum SheetRangeType {
-    /**
-     * 选中一个或多个单元格
-     */
-    Cells = "cells",
-    /**
-     * 选中一行或多行
-     */
-    Rows = "rows",
-    /**
-     * 选中一列或多列
-     */
-    Columns = "columns",
-    /**
-     * 选中整个工作表
-     */
-    Sheet = "sheet"
-}
-
-export declare type SheetRangeValue = {
-    /**
-     * 单个或多个单元格
-     */
-    type: `${SheetRangeType.Cells}`;
-    /**
-     * 起始单元格的行号
-     */
-    row: number;
-    /**
-     * 总计行数
-     */
-    rowCount: number;
-    /**
-     * 起始单元格的列号
-     */
-    column: number;
-    /**
-     * 总计列数
-     */
-    columnCount: number;
-} | {
-    /**
-     * 一列或多列
-     */
-    type: `${SheetRangeType.Rows}`;
-    /**
-     * 起始列号
-     */
-    row: number;
-    /**
-     * 总计行数
-     */
-    rowCount: number;
-} | {
-    /**
-     * 一行或多行
-     */
-    type: `${SheetRangeType.Columns}`;
-    /**
-     * 起始行号
-     */
-    column: number;
-    /**
-     * 总计列数
-     */
-    columnCount: number;
-} | {
-    /**
-     * 整个工作表
-     */
-    type: `${SheetRangeType.Sheet}`;
-};
-
-export declare interface SheetSDKOptions extends EditorOptions {
-    /**
-     * 字体配置
-     */
-    fonts?: EditorFontsOptions;
-    /**
-     * 菜单栏相关设置
-     */
-    menu?: SheetMenuOptions;
-    /**
-     * 文本格式相关设置
-     */
-    text?: SheetTextOptions;
-}
-
-/**
- * 选区（Selection）
- * 表示窗口或窗格中的当前选定内容。
- * 选定内容表示表格中的选定（或突出显示）的单元格区域。
- */
-export declare interface SheetSelection {
-    /**
-     * 获取选区的区域范围，
-     * 如果没有指定范围，则返回当前选区的范围。
-     * 如果指定了范围，则返回指定范围的选区。
-     * 如果选区不存在，则返回 null。
-     */
-    getRange: (value?: SheetRangeValue) => SheetRange | null;
-    /**
-     * 设置选区的区域范围，
-     * 设置后，选区会自动选中指定范围。
-     * 如果设置为 null，则清空选区。
-     */
-    setRange: (value: SheetRangeValue | null) => void;
-}
-
-/**
- * 电子表格文本接口
- */
-export declare type SheetText = EditorText<string, SheetRangeValue>;
-
-/**
- * 电子表格文本格式
- */
-export declare type SheetTextFormat = EditorTextFormat;
-
-/**
- * 电子表格文本格式初始化选项
- */
-export declare type SheetTextOptions = EditorTextOptions<string>;
-
-/**
- * 工作表集合对象
- */
-export declare interface SheetWorkbook {
-    /**
-     * 获取所有工作表
-     * @returns
-     */
-    getWorksheets: () => SheetWorksheet[];
-    /**
-     * 获取指定的工作表
-     * @param sheetId
-     * @returns
-     */
-    getWorksheetById: (sheetId: string) => SheetWorksheet | null;
-    /**
-     * 获取当前活动的工作表
-     * TODO: 是否存在返回空的场景
-     * @returns
-     */
-    getActiveWorksheet: () => SheetWorksheet;
-    /**
-     * 激活指定的工作表
-     * @param sheetId
-     */
-    setActiveWorksheet: (sheetId: string) => void;
-}
-
-/**
- * 工作表对象
- */
-export declare interface SheetWorksheet {
-    /**
-     * 工作表对应编号
-     */
-    get id(): string;
-    /**
-     * 获取当前工作表名称
-     */
-    get name(): string;
-    /**
-     * 这个工作表是否为当前活动的工作表
-     */
-    get isActive(): boolean;
-    /**
-     * 获取工作表的所有选区
-     * @returns
-     */
-    getSelections: () => SheetSelection[] | null;
-    /**
-     * 获取选区的物理位置（相对于浏览器窗口），如果选区完全不在工作表的可视区域内，返回 null。
-     * 其中选区超出可视区域的部分会被截断处理。
-     *
-     * 当工作表存在冻结行列时，可视区域将被分成四个部分（如果仅存在冻结行或冻结列则被分为两个部分），
-     * 此时需要计算出选区在**视觉上**与可视区域的交集。
-     */
-    getPhysicalPosition: (range: SheetRangeValue) => {
-        left: number;
-        top: number;
-        width: number;
-        height: number;
-    } | null;
-    /**
-     * 添加选区变化监听器，当选区发生变化时，会触发回调。
-     * @param listener
-     * @returns 用于移除监听的回调
-     */
-    addRangeListener: (listener: (range: {
-        sheet: string;
-        ranges: SheetRangeValue[] | null;
-    }) => void) => () => void;
-    /**
-     * 获取工作表中指定区域的单元格对象
-     * @returns
-     */
-    getCell: (row: number, column: number) => SheetCell | null;
-    /**
-     * 获取工作表中选中的单元格对象
-     * @returns
-     */
-    getActiveCell: () => SheetCell | null;
-    /**
-     * 激活工作表中某个单元格
-     * @param cell 单元格对象，需要传入行和列的索引值
-     * @returns
-     */
-    setActiveCell: (cell: {
-        row: number;
-        column: number;
-    }) => void;
-    /**
-     * 定位到单元格所在位置
-     * @param row 单元格所在行
-     * @param column 单元格所在列
-     */
-    locateCell: (row: number, column: number) => void;
-}
-
 export { }