@officesdk/editor-sdk-core 0.0.0-15 → 0.0.0-17

package/types/docx.d.ts

@@ -65,6 +65,43 @@ export declare abstract class AbstractedEditorFileUploader {
     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;
+}
+
 /**
  * 传统文档右键菜单功能按钮
  */
@@ -208,15 +245,28 @@ export declare interface DocxInfoOptions {
     name: string;
 }
 
+/**
+ * 传统文档菜单栏自定义菜单
+ * 可以通过指定泛型T来指定自定义菜单的类型，自定义菜单目前只支持button和link两种类型
+ */
+export declare type DocxMenuCustomConfig<T extends 'button' | 'link' = 'button' | 'link'> = (EditorMenuButtonMenuItemConfig<string> | EditorMenuLinkMenuItemConfig<string>) & {
+    type: T;
+};
+
 /**
  * 传统文档菜单栏一级菜单
+ * 可以通过指定泛型T来指定一级菜单的类型，例如DocxMenuEntryConfig<'button'>，不指定则默认为所有类型都有可能
  */
-export declare type DocxMenuEntryConfig = EditorMenuEntryConfig<DocxMenuFeatureButtonName>;
+export declare type DocxMenuEntryConfig<T extends EditorMenuItemType = EditorMenuItemType> = EditorMenuEntryConfig<DocxMenuFeatureButtonName> & {
+    type: T;
+};
 
 /**
  * 传统文档菜单栏内置功能按钮
  */
-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 = '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;
 
 /**
  * 传统文档菜单栏相关配置，目前菜单栏不是所有套件都支持，
@@ -407,6 +457,10 @@ export declare interface DocxSDKOptions extends EditorOptions {
      * 主题字体相关配置
      */
     theme?: DocxThemeOptions;
+    /**
+     * 工具栏设置
+     */
+    toolbar?: DocxToolbarOptions;
 }
 
 /**
@@ -612,9 +666,11 @@ export declare interface DocxThemeFontsSchemeItem {
      * 其他单独字体配置
      * key 表示script值
      * 例如：
+     * ```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>;
 }
@@ -765,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 是形状的一种业务形态封装，
@@ -1150,8 +1294,9 @@ export declare interface EditorAttachmentMaxSizeOptions {
  * 编辑器附件信息
  */
 export declare interface EditorAttachmentOptions {
-    uploader: AbstractedEditorFileUploader;
-    download: (url: string) => void;
+    picker?: EditorFilePicker;
+    uploader?: AbstractedEditorFileUploader;
+    download?: (url: string) => void;
     /**
      * 图片附件相关配置
      */
@@ -1225,6 +1370,80 @@ export declare interface EditorBrandOptions {
     };
 }
 
+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;
+}
+
 /**
  * 单条评论数据
  */
@@ -1291,7 +1510,7 @@ export declare interface EditorComments {
 /**
  * 编辑器评论初始化配置
  */
-export declare interface EditorCommentsOptions {
+export declare interface EditorCommentsOptions extends EditorFeatureConfig {
     /**
      * 评论作者信息，如果这里的信息为空，将会使用 user 信息
      */
@@ -1320,6 +1539,12 @@ export declare interface EditorCommentsOptions {
          */
         mode: 'none' | 'card';
     };
+    /**
+     * 评论变化监听
+     * @param listener
+     * @returns 返回一个函数，调用该函数可以移除监听器
+     */
+    addChangedListener?: (listener: (type: 'create' | 'update' | 'close', data: EditorCommentItem) => void) => () => void;
 }
 
 export declare interface EditorContent<Delta = EditorDelta> {
@@ -1345,6 +1570,19 @@ export declare interface EditorContent<Delta = 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;
@@ -1404,16 +1642,81 @@ export declare interface EditorEmbeddedObjectOptions {
 export declare interface EditorExportOptions {
     /**
      * 可导出类型
-     * @description
      */
     supportedTypes?: string[];
     /**
      * 导出文件
-     * @description
      */
     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 {
     /**
      * 字体的名称，用于在用户界面上显示的名称
@@ -1492,6 +1795,19 @@ export declare interface EditorFontsOptions {
     list: EditorFontsList;
 }
 
+export declare interface EditorHistory {
+    /**
+     * 显示历史记录侧边栏
+     */
+    showSidebar: () => void;
+    /**
+     * 隐藏历史记录侧边栏
+     */
+    hideSidebar: () => void;
+}
+
+export declare type EditorHistoryOptions = EditorFeatureConfig;
+
 /**
  * i18n 相关设置
  */
@@ -1512,13 +1828,39 @@ export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'cen
  * 链接配置，抽象打开链接等操作
  */
 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>;
+    open?: (url: string, target: string) => Promise<boolean>;
+    /**
+     * 根据文件guid以及其他参数生成链接
+     */
+    generate?: (params: FileLinkParams) => Promise<string>;
+    /**
+     * 从文档链接中解析得到文件guid等参数
+     */
+    parse?: (url: string) => Promise<FileLinkParams | undefined>;
+    /**
+     * 生成sdk2.0内部链接
+     * 使用场景：专业表格跨表格引用
+     */
+    generateInternal?: (params: FileLinkParams) => Promise<string>;
 }
 
 /**
@@ -1603,29 +1945,27 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
 /**
  * 菜单功能按钮配置
  */
-export declare interface EditorMenuFeatureConfig {
+export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
     /**
-     * 是否隐藏菜单项，设置为true则隐藏菜单项
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
-    hidden?: boolean;
+    label?: string;
     /**
-     * 是否禁用菜单项，设置为true则变为灰色不可点击
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
-    disabled?: boolean;
-}
-
-/**
- * 菜单功能按钮配置
- */
-export declare interface EditorMenuFeatureConfig {
+    icon?: string;
     /**
-     * 是否隐藏菜单项，设置为true则隐藏菜单项
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
      */
-    hidden?: boolean;
+    callback?: () => void;
     /**
-     * 是否禁用菜单项，设置为true则变为灰色不可点击
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
      */
-    disabled?: boolean;
+    tooltip?: string;
+    /**
+     * 按钮在工具栏中位置，不设置则按照默认位置
+     */
+    index?: number;
 }
 
 /**
@@ -1683,9 +2023,9 @@ export declare interface EditorMenuOptions<TName extends string> {
     entries?: EditorMenuEntryConfig<TName>[];
     /**
      * 菜单栏功能按钮配置
-     * TODO 此配置目前没有用到，后续看是保留还是和custom合并
+     * 更加间接的配置项
      */
-    features?: Record<TName, EditorMenuFeatureConfig>;
+    features?: Partial<Record<TName, EditorMenuFeatureConfig>>;
     /**
      * 自定义按钮配置
      */
@@ -1755,6 +2095,10 @@ export declare interface EditorOptions {
      * 匿名用户的缺省信息
      */
     anonymous?: EditorAnonymousOptions;
+    /**
+     * 当前文件信息
+     */
+    file?: EditorFileOptions;
     /**
      * i18n 相关设置
      */
@@ -1762,13 +2106,13 @@ export declare interface EditorOptions {
     /**
      * 品牌相关设置
      */
-    brand?: EditorBrandOptions;
+    brand?: MaybePromiseValue<EditorBrandOptions>;
     /**
      * 编辑器内部资源请求配置
      */
     assets?: EditorAssetsOptions;
     /**
-     * 编辑器内部超链接设置
+     * 编辑器链接相关配置
      */
     link?: EditorLinkOptions;
     /**
@@ -1795,6 +2139,38 @@ export declare interface EditorOptions {
      * 导出设置
      */
     export?: EditorExportOptions;
+    /**
+     * 解密设置
+     */
+    decryption?: EditorDecryptionOptions;
+    /**
+     * 网络请求设置
+     */
+    http?: HTTPProxy;
+    /**
+     * 编辑器渲染设置项
+     */
+    render?: EditorRenderOptions;
+    /**
+     * 编辑器 UI 相关
+     */
+    ui?: EditorUiOptions;
+    /**
+     * 编辑器卡点限制
+     */
+    checkpoints?: EditorCheckpointsOptions;
+    /**
+     * 编辑器工具箱设置
+     */
+    toolbox?: EditorToolboxOptions;
+    /**
+     * 编辑器历史设置
+     */
+    history?: EditorHistoryOptions;
+    /**
+     * 编辑器协作相关
+     */
+    collaboration?: EditorCollaborationOptions;
 }
 
 /**
@@ -1855,10 +2231,33 @@ export declare interface EditorOutlineOptions {
     visible?: boolean;
 }
 
+export declare interface EditorPickedFile {
+    /**
+     * 文件大小
+     */
+    size: number;
+    /**
+     * 文件名
+     */
+    name: string;
+    /**
+     * 文件路径，仅显示有意义的相对路径，可用在上传文件夹和识别文件使用
+     */
+    path?: string;
+    /**
+     * 文件类型，mime-type
+     */
+    type: string;
+    /**
+     * 文件原始数据，用于给上传控件使用
+     */
+    raw: File;
+}
+
 /**
  * 编辑器打印设置
  */
-export declare interface EditorPrintOptions {
+export declare interface EditorPrintOptions extends EditorFeatureConfig {
     /**
      * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
      * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
@@ -1866,10 +2265,6 @@ export declare interface EditorPrintOptions {
     fallback?: {
         message: string;
     };
-    /**
-     * 是否禁用打印功能
-     */
-    disabled?: boolean;
 }
 
 /**
@@ -1883,6 +2278,13 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
+export declare interface EditorRenderOptions {
+    /**
+     * 渲染的容器
+     */
+    container?: HTMLElement;
+}
+
 /**
  * 编辑器通用接口
  */
@@ -1917,8 +2319,24 @@ export declare abstract class EditorSDK {
     abstract get mode(): EditorMode;
     /**
      * 编辑器评论相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get comments(): EditorComments | undefined;
+    /**
+     * 编辑器协作者相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get collaborators(): EditorCollaborators | undefined;
+    /**
+     * 编辑器历史相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get history(): EditorHistory | undefined;
+    /**
+     * 编辑器版本相关接口
+     * 部分环境不存在，如离线客户端
      */
-    abstract get comments(): EditorComments;
+    abstract get version(): EditorVersion | undefined;
 }
 
 /**
@@ -2054,11 +2472,11 @@ export declare interface EditorTextOptions<Color = string> {
 /**
  * 工具栏功能按钮配置(包括内置按钮和自定义按钮)
  */
-export declare interface EditorToolbarFeatureButton<TName extends string> {
+export declare interface EditorToolbarFeatureButton<TName extends string> extends EditorFeatureConfig {
     /**
      * 按钮的唯一标识，用以确定配置的是哪个按钮。
      */
-    name: TName;
+    name?: TName;
     /**
      * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
@@ -2067,14 +2485,6 @@ export declare interface EditorToolbarFeatureButton<TName extends string> {
      * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
     icon?: string;
-    /**
-     * 按钮是否隐藏，设置为true则隐藏按钮
-     */
-    hidden?: boolean;
-    /**
-     * 按钮是否禁用，设置为true则变为灰色不可点击
-     */
-    disabled?: boolean;
     /**
      * 按钮点击事件.接受一个函数，可以自定义点击事件。
      */
@@ -2118,6 +2528,90 @@ export declare interface EditorToolbarOptions<TName extends string> {
     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;
 
 /**
@@ -2181,6 +2675,13 @@ export declare interface EditorUserOptions {
     defaultAvatar?: string;
 }
 
+export declare interface EditorVersion {
+    /**
+     * 保存版本
+     */
+    createRevision: () => void;
+}
+
 /**
  * 编辑器外部水印信息
  */
@@ -2204,6 +2705,86 @@ export 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
+}
+
 /**
  * 请求、响应头
  */
@@ -2311,6 +2892,260 @@ export declare interface HTTPResponse<Data = unknown> {
  */
 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"
+}
+
+/**
+ * 工具类型枚举
+ */
+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 { }