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

package/types/diagram.d.ts

@@ -47,16 +47,6 @@ export declare abstract class AbstractedEditorFileUploader {
     abstract resume(taskIds?: string[]): void;
 }
 
-export declare type CheckLimitationResult = {
-    status: 'limited';
-    /**
-     * 被限制原因
-     */
-    reason?: string;
-} | {
-    status: 'unlimited';
-};
-
 /**
  * 协作者信息接口
  */
@@ -171,7 +161,7 @@ export declare interface EditorAssetsOssImageProcessing {
         quality?: number;
         maxWidth?: number;
         maxHeight?: number;
-    }) => Promise<string>;
+    }) => string;
     /**
      * 裁切图片的方法
      * @param imageUrl 图片的 URL
@@ -179,12 +169,12 @@ export declare interface EditorAssetsOssImageProcessing {
      * @returns 裁切后的图片 URL
      */
     crop: (imageUrl: string, cropOptions: {
-        x?: number;
-        y?: number;
+        x: number;
+        y: number;
         w: number;
         h: number;
-        g?: EditorImageCropPoint;
-    }) => Promise<string>;
+        g: EditorImageCropPoint;
+    }) => string;
 }
 
 export declare interface EditorAssetsResolver {
@@ -193,13 +183,13 @@ export declare interface EditorAssetsResolver {
      * @param assetId 资源文件 ID
      * @returns 转换后的资源 URL ，如果无法转换则返回 null
      */
-    resolveUrl: (assetId: string) => Promise<string | null>;
+    resolveUrl: (assetId: string) => string | null;
     /**
      * 从 URL 中解析资源文件 ID 的方法
      * @param url 资源 URL
      * @returns 解析出的资源文件 ID
      */
-    parseId: (url: string) => Promise<string | null>;
+    parseId: (url: string) => string | null;
     /**
      * 检查资源文件 ID 对应的文件是否准备就绪，
      * 在部分环境中，资源文件需要异步导入，在编辑器加载的时候可能还未准备就绪
@@ -209,6 +199,28 @@ export declare interface EditorAssetsResolver {
     checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
 }
 
+/**
+ * 编辑器附件下载配置
+ */
+export declare interface EditorAttachmentDownloadOptions {
+    /**
+     * 是否禁用下载
+     */
+    disabled?: boolean;
+    /**
+     * 是否跳过验证
+     */
+    skipValidate?: boolean;
+    /**
+     * 下载附件
+     */
+    download?: (url: string) => void;
+    /**
+     * 获取附件下载地址
+     */
+    getDownloadUrl?: (url: string) => Promise<string>;
+}
+
 /**
  * 编辑器附件限制配置,sdk中会使用在不同的场景下使用不同的限制规则组合
  */
@@ -218,9 +230,9 @@ export declare interface EditorAttachmentLimitationOptions {
      * @param file
      * @returns
      */
-    checkFile: (params: EditorAttachmentLimitationOptionsCheckFunctionParams) => Promise<{
+    checkFile?: (params: EditorAttachmentLimitationOptionsCheckFunctionParams) => Promise<{
         limited: true;
-        message: string;
+        message?: string;
     } | {
         limited: false;
     }>;
@@ -269,9 +281,24 @@ export declare interface EditorAttachmentMaxSizeOptions {
  * 编辑器附件信息
  */
 export declare interface EditorAttachmentOptions {
+    /**
+     * 附件选择器
+     */
     picker?: EditorFilePicker;
+    /**
+     * 附件上传器
+     */
     uploader?: AbstractedEditorFileUploader;
+    /**
+     * 下载
+     * @deprecated, 使用不同类型附件的download配置
+     */
     download?: (url: string) => void;
+    /**
+     * 预览
+     * @deprecated, 使用不同类型附件的preview配置
+     */
+    preview?: (url: string) => void;
     /**
      * 图片附件相关配置
      */
@@ -289,9 +316,27 @@ export declare interface EditorAttachmentOptions {
          * 图片附件的限制配置
          */
         limitations?: EditorAttachmentLimitationOptions;
+        /**
+         * 禁止预览
+         * @deprecated 使用preview.disabled代替
+         */
+        disablePreview?: boolean;
+        /**
+         * 预览
+         */
+        preview?: EditorAttachmentPreviewOptions;
+        /**
+         * 下载
+         */
+        download?: EditorAttachmentDownloadOptions;
+        /**
+         * 是否禁用缩略图
+         * 桌面客户端/极速sdk需要禁用
+         */
+        disableThumbnail?: boolean;
     };
     /**
-     * 其他附件相关配置
+     * 附件相关配置
      */
     attachment?: {
         /**
@@ -307,9 +352,94 @@ export declare interface EditorAttachmentOptions {
          * 附件的限制配置
          */
         limitations?: EditorAttachmentLimitationOptions;
+        /**
+         * 禁止预览
+         * @deprecated 使用preview.disabled代替
+         */
+        disablePreview?: boolean;
+        /**
+         * 预览
+         */
+        preview?: EditorAttachmentPreviewOptions;
+        /**
+         * 下载
+         */
+        download?: EditorAttachmentDownloadOptions;
+    };
+    /**
+     * 视频相关配置
+     */
+    video?: {
+        /**
+         * 支持的视频格式
+         */
+        supportTypes?: string[];
+        /**
+         * 视频的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+        /**
+         * 预览
+         */
+        preview?: EditorAttachmentPreviewOptions;
+        /**
+         * 下载
+         */
+        download?: EditorAttachmentDownloadOptions;
+    };
+    /**
+     * 音频相关配置
+     */
+    audio?: {
+        /**
+         * 支持的音频
+         */
+        supportTypes?: string[];
+        /**
+         * 音频的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+        /**
+         * 预览
+         */
+        preview?: EditorAttachmentPreviewOptions;
+        /**
+         * 下载
+         */
+        download?: EditorAttachmentDownloadOptions;
+    };
+    /**
+     * 云文件附件相关配置
+     */
+    cloudFile?: {
+        /**
+         * 是否禁用云文件
+         */
+        disabled?: boolean;
     };
 }
 
+/**
+ * 编辑器附件预览配置
+ */
+export declare interface EditorAttachmentPreviewOptions {
+    /**
+     * 预览附件
+     * app, 桌面客户端需提供
+     */
+    preview?: (url: string) => void;
+    /**
+     * 获取附件预览url，saas、sdk、极速sdk需要提供
+     * @param id 文件url
+     * @returns 预览url
+     */
+    getPreviewUrl?: (url: string) => Promise<string>;
+    /**
+     * 是否禁用预览
+     */
+    disabled?: boolean;
+}
+
 /**
  * 基础文件属性
  */
@@ -320,11 +450,19 @@ export declare interface EditorBaseUploadableFile {
     fileGuid: string;
 }
 
+/**
+ * 品牌设置
+ */
+export declare interface EditorBrandOptions {
+    enable: boolean;
+    getSettings: () => Promise<EditorBrandSetting | null>;
+}
+
 /**
  * 品牌相关设置，
  * 用于在套件中展示品牌外露信息
  */
-export declare interface EditorBrandOptions {
+export declare interface EditorBrandSetting {
     /**
      * 需要显示在品牌展示位的内容，按数组顺序显示
      */
@@ -345,24 +483,6 @@ 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 {
     /**
      * 是否允许离线编辑
@@ -404,23 +524,36 @@ export declare interface EditorCollaborators {
      * 停止监听协作者状态变化
      * 调用此方法后，将不再接收协作者进入/离开的事件
      */
-    stop: () => void;
+    quit: () => void;
+    /**
+     * 监听事件
+     */
+    on: (event: string, callback: (...args: unknown[]) => void) => unknown;
     /**
-     * 添加协作者进入事件监听器
-     * @param listener - 监听器回调函数，参数如下：
-     *   - allUsers: 当前所有协作者列表
-     *   - enteredUsers: 新进入的协作者列表
-     * @returns 返回一个函数，调用该函数可以移除监听器
+     * 监听事件, 只监听一次
      */
-    addUserEnterListener: (listener: (allUsers: CollaboratorInfo[], enteredUsers: CollaboratorInfo[]) => void) => () => void;
+    once: (event: string, callback: (...args: unknown[]) => void) => unknown;
     /**
-     * 添加协作者离开事件监听器
-     * @param listener - 监听器回调函数
-     *   - allUsers: 当前所有协作者列表
-     *   - leftUsers: 离开的协作者列表
-     * @returns 返回一个函数，调用该函数可以移除监听器
+     * 移除事件
+     */
+    off: (event: string, callback: (...args: unknown[]) => void) => unknown;
+    /**
+     * 发送事件
+     */
+    emit: (event: string, ...args: unknown[]) => unknown;
+}
+
+export declare interface EditorCollaboratorsOptions {
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 推送协作者socket 对象
+     * 实际类型为socketIO.client
+     * TODO: 抽象为接口
      */
-    addUserLeaveListener: (listener: (allUsers: CollaboratorInfo[], leftUsers: CollaboratorInfo[]) => void) => () => void;
+    socket?: EditorSocket;
 }
 
 /**
@@ -484,6 +617,14 @@ export declare interface EditorComments {
      * 删除单条评论
      */
     deleteOne: (commentId: string) => Promise<boolean>;
+    /**
+     * 显示评论（侧边栏或其他形式）
+     */
+    show?: () => void;
+    /**
+     * 隐藏评论（侧边栏或其他形式）
+     */
+    hide?: () => void;
 }
 
 /**
@@ -519,11 +660,22 @@ export declare interface EditorCommentsOptions extends EditorFeatureConfig {
         mode: 'none' | 'card';
     };
     /**
-     * 评论变化监听
-     * @param listener
-     * @returns 返回一个函数，调用该函数可以移除监听器
+     * 推送评论的 socket 对象
+     */
+    socket?: EditorSocket;
+    /**
+     * 评论相关功能配置
      */
-    addChangedListener?: (listener: (type: 'create' | 'update' | 'close', data: EditorCommentItem) => void) => () => void;
+    features?: {
+        /**
+         * 添加评论
+         */
+        addComment?: EditorFeatureConfig;
+        /**
+         * 评论列表
+         */
+        commentList?: EditorFeatureConfig;
+    };
 }
 
 export declare interface EditorContent<Delta = EditorDelta> {
@@ -549,6 +701,11 @@ export declare interface EditorContent<Delta = EditorDelta> {
  */
 export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
 
+/**
+ * 粘贴相关设置
+ */
+export declare type EditorCopyOptions = EditorLogicFeatureConfig;
+
 /**
  * 编辑器解密选项接口
  * 用于配置编辑器中需要解密的内容的相关选项
@@ -569,6 +726,28 @@ export declare interface EditorDelta {
     length: number;
 }
 
+export declare type EditorDeviceMode = 'desktop' | 'mobile' | 'tablet';
+
+/**
+ * 编辑器设备相关设置
+ */
+export declare interface EditorDeviceOptions {
+    /**
+     * 设备模式
+     */
+    mode?: EditorDeviceMode;
+}
+
+/**
+ * 编辑器拖放配置
+ */
+export declare type EditorDragNDropOptions = EditorFeatureConfig;
+
+/**
+ * 编辑器创建副本配置
+ */
+export declare type EditorDuplicateOptions = EditorFeatureConfig;
+
 /**
  * 编辑器嵌入对象
  */
@@ -618,15 +797,20 @@ export declare interface EditorEmbeddedObjectOptions {
     };
 }
 
-export declare interface EditorExportOptions {
+export declare interface EditorExportOptions extends EditorFeatureConfig {
+    /**
+     * 可导出类型, undefined 表示对可导出类型无限制
+     * 导出由接口 + 本地实现
+     */
+    types?: string[];
     /**
-     * 可导出类型
+     * 接口支持的导出类型
      */
     supportedTypes?: string[];
     /**
-     * 导出文件
+     * 导出文件，调用接口实现
      */
-    exportFile: (type: string) => Promise<void>;
+    exportFile?: (type: string) => Promise<void>;
 }
 
 export declare interface EditorFeatureConfig {
@@ -640,6 +824,28 @@ export declare interface EditorFeatureConfig {
     hidden?: boolean;
 }
 
+export declare interface EditorFeaturesOptions {
+    /**
+     * 禁用特性入口
+     */
+    disabled?: boolean;
+    /**
+     * 对应/features接口，返回所有功能key
+     */
+    getFeatures?: () => Promise<string[]>;
+}
+
+/**
+ * 文件限制
+ */
+export declare interface EditorFileLimitationOptions {
+    /**
+     * 获取最大文件大小，单位为MB
+     * 超过该上限后禁止编辑
+     */
+    getMaxFileSize?: () => number | undefined;
+}
+
 export declare interface EditorFileOptions {
     /**
      * 文件guid
@@ -649,6 +855,18 @@ export declare interface EditorFileOptions {
      * 文件名
      */
     name?: string;
+    /**
+     * 创建者,以id标识
+     */
+    creator?: number;
+    /**
+     * 创建时间, 毫秒级时间戳
+     */
+    createdAt?: number;
+    /**
+     * 文件限制
+     */
+    limitations?: EditorFileLimitationOptions;
 }
 
 export declare interface EditorFilePicker {
@@ -678,7 +896,7 @@ export declare interface EditorFollowMode {
      * 获取当前演讲者信息
      * @returns 返回包含演讲者ID、姓名和头像信息的对象
      */
-    getSpeaker: () => Speaker;
+    getSpeaker: () => Speaker | undefined;
     /**
      * 添加跟随状态变化的监听器
      * @param listener 状态变化时的回调函数
@@ -693,7 +911,7 @@ export declare interface EditorFollowModeOptions extends EditorFeatureConfig {
      * 实际类型为socketIO.client
      * TODO: 抽象为接口
      */
-    socket?: unknown;
+    socket?: EditorSocket;
 }
 
 export declare interface EditorFontFace {
@@ -772,17 +990,35 @@ export declare interface EditorFontsOptions {
      * 并提供可用于字体的加载 URL 和字体元数据。
      */
     list: EditorFontsList;
+    /**
+     * 是否只使用本地字体，如果为 true，则不会从服务器获取字体列表。
+     */
+    useLocalFontsOnly?: boolean;
+}
+
+/**
+ * 功能引导设置
+ */
+export declare interface EditorGuidesOptions {
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 获取引导数据
+     */
+    data?: <T = GuideData>() => Promise<T>;
 }
 
 export declare interface EditorHistory {
     /**
-     * 显示历史记录侧边栏
+     * 显示历史记录（侧边栏或其他形式）
      */
-    showSidebar: () => void;
+    show: () => void;
     /**
-     * 隐藏历史记录侧边栏
+     * 隐藏历史记录（侧边栏或其他形式）
      */
-    hideSidebar: () => void;
+    hide: () => void;
 }
 
 export declare type EditorHistoryOptions = EditorFeatureConfig;
@@ -805,7 +1041,12 @@ export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'cen
 
 export declare interface EditorImportOptions {
     /**
-     * 获取导入状态，没有contentUrl时需要显示导入进度
+     * 当前文件是否正在导入中
+     * 用于初始化时判断是否需要显示导入进度
+     */
+    isImporting?: boolean;
+    /**
+     * 获取当前文件导入状态，没有contentUrl时需要显示导入进度
      * 待导入完成后再渲染
      */
     getImportStatus?: () => Promise<{
@@ -822,15 +1063,19 @@ export declare interface EditorImportOptions {
          * 导入完成
          */
         status: 'completed';
+        /**
+         * 导入完成后的内容URL
+         */
+        contentUrl: string;
     } | {
         /**
          * 导入失败
          */
         status: 'failed';
         /**
-         * 导入失败错误信息
+         * 导入失败报错
          */
-        errorMessage?: string;
+        error?: unknown;
     }>;
 }
 
@@ -883,6 +1128,74 @@ export declare interface EditorLocalUploadableFile extends EditorBaseUploadableF
     raw: File;
 }
 
+/**
+ * 纯逻辑功能配置。
+ * 不包含 UI 相关配置，仅用于逻辑判断。
+ * 如：权限判断、功能开关等。
+ * 所以不需要hidden,只使用disabled来判断
+ */
+export declare type EditorLogicFeatureConfig = Omit<EditorFeatureConfig, 'hidden'>;
+
+export declare interface EditorLogsOptions {
+    /**
+     * 是否禁用审计日志
+     * sdk2.0需要禁用
+     */
+    isAuditLogDisabled?: boolean;
+    /**
+     * 是否禁用日志
+     */
+    disabled?: boolean;
+}
+
+export declare interface EditorMentionOptions extends EditorFeatureConfig {
+    /**
+     * mention api url前缀
+     * @shimo/mention-suggestion 需要用到
+     * 对应环境变量 SDK_V2_PATH_PREFIX
+     */
+    apiUrlPrefix?: string;
+    /**
+     * mention文件卡片禁用设置
+     */
+    disableFileCard?: boolean;
+    /**
+     * mention日期卡片禁用设置
+     */
+    disableDateCard?: boolean;
+    /**
+     * mention用户卡片禁用设置
+     */
+    disableUserCard?: boolean;
+    /**
+     * mention点击回调
+     */
+    onMentionClick?: (payload: MentionEventPayload) => void;
+    /**
+     * mention文件选择弹窗支持的tab类型
+     */
+    mentionFilePanelTabs?: ('mine' | 'recent' | 'space')[];
+    /**
+     * mention弹窗底部支持的tab类型
+     */
+    mentionPopoverTabs?: ('contacts' | 'file' | 'calendar')[];
+    /**
+     * 是否禁止检查组织架构成员可见性
+     * 该属性需要各套件对接最新版本@shimo/mention-suggestion（没用到的话可忽略）
+     */
+    disableCheckStaffVisibility?: boolean;
+}
+
+/**
+ * 编辑器菜单api
+ */
+export declare interface EditorMenu {
+    /**
+     * 菜单功能api
+     */
+    features: EditorMenuFeatures;
+}
+
 /**
  * 基础菜单项配置，所有菜单项类型都包含这些属性
  */
@@ -983,6 +1296,38 @@ export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
     index?: number;
 }
 
+/**
+ * 编辑器菜单功能api
+ *
+ * 提供对菜单项的显示、隐藏、启用和禁用等操作
+ */
+export declare interface EditorMenuFeatures {
+    /**
+     * 显示菜单项
+     * @param name 菜单项名称
+     */
+    showFeature: (name: string) => void;
+    /**
+     * 隐藏菜单项
+     * @param name 菜单项名称
+     */
+    hideFeature: (name: string) => void;
+    /**
+     * 启用菜单项
+     * @param name 菜单项名称
+     */
+    enableFeature: (name: string) => void;
+    /**
+     * 禁用菜单项
+     * @param name 菜单项名称
+     */
+    disableFeature: (name: string) => void;
+    /**
+     * 恢复菜单项到默认状态，即根据配置项确定如何渲染菜单项。
+     */
+    resetFeature: (name: string) => void;
+}
+
 /**
  * 隐藏菜单项配置
  */
@@ -1049,7 +1394,7 @@ export declare interface EditorMenuOptions<TName extends EditorMenuName> {
      * 更加间接的配置项
      * 仅在 TName 为字符串类型时有效
      */
-    features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
+    features?: [TName] extends [string] ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
     /**
      * 自定义按钮配置
      */
@@ -1085,9 +1430,25 @@ export declare type EditorModeOptions = {
      */
     role?: EditorStandardRole;
 } | {
+    /**
+     * 预览模式
+     */
     type: 'preview';
 } | {
+    /**
+     * 演示模式
+     */
     type: 'presentation';
+} | {
+    /**
+     * 历史模式
+     */
+    type: 'history';
+} | {
+    /**
+     * 嵌入模式
+     */
+    type: 'embedded';
 };
 
 /**
@@ -1095,8 +1456,9 @@ export declare type EditorModeOptions = {
  * - `standard` 标准模式，会根据用户权限配置不同的功能
  * - `preview` 预览模式，只能查看内容
  * - `presentation` 演示模式，用作演示场景，演示模式下部分套件可以进行一些简单的编辑操作
+ * - `history` 历史模式，用作查看历史版本场景
  */
-export declare type EditorModeType = 'standard' | 'preview' | 'presentation';
+export declare type EditorModeType = 'standard' | 'preview' | 'presentation' | 'history' | 'embedded';
 
 /**
  * 编辑器初始化通用参数
@@ -1120,7 +1482,7 @@ export declare interface EditorOptions {
      */
     anonymous?: EditorAnonymousOptions;
     /**
-     * 当前文件信息
+     * 当前文件信息 & 配置
      */
     file?: EditorFileOptions;
     /**
@@ -1130,7 +1492,7 @@ export declare interface EditorOptions {
     /**
      * 品牌相关设置
      */
-    brand?: MaybePromiseValue<EditorBrandOptions>;
+    brand?: EditorBrandOptions;
     /**
      * 编辑器内部资源请求配置
      */
@@ -1179,10 +1541,6 @@ export declare interface EditorOptions {
      * 编辑器 UI 相关
      */
     ui?: EditorUiOptions;
-    /**
-     * 编辑器卡点限制
-     */
-    checkpoints?: EditorCheckpointsOptions;
     /**
      * 编辑器工具箱设置
      */
@@ -1195,6 +1553,54 @@ export declare interface EditorOptions {
      * 编辑器协作相关
      */
     collaboration?: EditorCollaborationOptions;
+    /**
+     * 编辑器功能相关设置
+     */
+    features?: EditorFeaturesOptions;
+    /**
+     * 编辑器版本相关设置
+     */
+    version?: EditorVersionOptions;
+    /**
+     * 编辑器日志相关设置
+     */
+    logs?: EditorLogsOptions;
+    /**
+     * 编辑器快捷键相关设置
+     */
+    shortcuts?: EditorShortcutOptions;
+    /**
+     * 提及相关设置
+     */
+    mention?: EditorMentionOptions;
+    /**
+     * 编辑器拖放相关配置
+     */
+    dragNDrop?: EditorDragNDropOptions;
+    /**
+     * 编辑器引导相关设置
+     */
+    guides?: EditorGuidesOptions;
+    /**
+     * 编辑器复制相关设置
+     */
+    copy?: EditorCopyOptions;
+    /**
+     * 编辑器粘贴相关设置
+     */
+    paste?: EditorPasteOptions;
+    /**
+     * 编辑器设备信息相关设置
+     */
+    device?: EditorDeviceOptions;
+    /**
+     * 编辑器副本相关配置
+     */
+    duplicate?: EditorDuplicateOptions;
+    /**
+     * 分享相关接口
+     */
+    share?: EditorShareOptions;
 }
 
 /**
@@ -1247,7 +1653,7 @@ export declare interface EditorOutlineItem<Content = unknown> {
  * 大纲目录初始化参数，
  * 用于配置大纲目录的行为和外观。
  */
-export declare interface EditorOutlineOptions {
+export declare interface EditorOutlineOptions extends EditorLogicFeatureConfig {
     /**
      * 初始化编辑器时是否显示大纲目录，
      * 默认为 false。
@@ -1255,6 +1661,50 @@ export declare interface EditorOutlineOptions {
     visible?: boolean;
 }
 
+export declare interface EditorPasteLimitationOptions {
+    /**
+     * 检查粘贴内容的规则
+     * @param content
+     * @returns
+     */
+    checkContent?: (params: EditorPasteLimitationOptionsCheckFunctionParams) => Promise<{
+        limited: true;
+        message: string;
+    } | {
+        limited: false;
+    }>;
+    /**
+     * 获取最大粘贴数据大小，单位为MB
+     */
+    getMaxDataSize?: () => Promise<number | undefined>;
+}
+
+export declare interface EditorPasteLimitationOptionsCheckFunctionParams {
+    content: string;
+}
+
+/**
+ * 粘贴相关设置
+ */
+export declare interface EditorPasteOptions extends EditorFeatureConfig {
+    /**
+     * 是否禁用远程图片粘贴, turbo暂时不支持远程图片粘贴
+     */
+    isRemoteImgDisabled?: boolean;
+    /**
+     * 粘贴内容限制规则
+     */
+    limitations?: EditorPasteLimitationOptions;
+}
+
+export declare interface EditorPerformanceOptions {
+    /**
+     * 记录性能指标
+     * @param mark 性能指标名称
+     */
+    record?: (mark: 'first_page' | 'first_editable_page') => void;
+}
+
 export declare interface EditorPickedFile {
     /**
      * 文件大小
@@ -1278,6 +1728,17 @@ export declare interface EditorPickedFile {
     raw: File;
 }
 
+export declare interface EditorPresentation {
+    /**
+     * 进入演示模式
+     */
+    start: () => Promise<void>;
+    /**
+     * 退出演示模式
+     */
+    quit: () => Promise<void>;
+}
+
 /**
  * 编辑器打印设置
  */
@@ -1302,6 +1763,13 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
+export declare interface EditorRenderOptions {
+    /**
+     * 用于定位的锚点
+     */
+    hash?: string;
+}
+
 /**
  * 编辑器通用接口
  */
@@ -1354,6 +1822,62 @@ export declare abstract class EditorSDK {
      * 部分环境不存在，如离线客户端
      */
     abstract get version(): EditorVersion | undefined;
+    /**
+     * 编辑器菜单栏相关接口
+     */
+    abstract get menu(): EditorMenu | undefined;
+    /**
+     * 编辑器演示模式相关接口
+     */
+    abstract get presentation(): EditorPresentation | undefined;
+}
+
+export declare interface EditorShareOptions extends EditorLogicFeatureConfig {
+    /**
+     * 当前文件是否为共享文件
+     */
+    isShared?: boolean;
+}
+
+export declare interface EditorShortcutOptions {
+    /**
+     * 自定义快捷键
+     */
+    customShortcuts?: ShortcutConfig[];
+    /**
+     * 禁用的快捷键
+     * 桌面客户端需要禁用ctrl+s，ctrl+shift+s
+     * 极速sdk需要禁用ctrl+s
+     * sdk2.0需要禁用ctrl+shift+e
+     */
+    disabledShortcuts?: string[];
+}
+
+/**
+ * 编辑器 socket 接口, 用于评论、跟随模式、远程演示等场景
+ * 实际类型为 socketIO.client
+ */
+export declare interface EditorSocket {
+    /**
+     * 监听事件
+     */
+    on: (event: string, callback: (...args: unknown[]) => void) => unknown;
+    /**
+     * 监听事件, 只监听一次
+     */
+    once: (event: string, callback: (...args: unknown[]) => void) => unknown;
+    /**
+     * 移除事件
+     */
+    off: (event: string, callback: (...args: unknown[]) => void) => unknown;
+    /**
+     * 发送事件
+     */
+    emit: (event: string, ...args: unknown[]) => unknown;
+    /**
+     * 断开连接
+     */
+    disconnect: () => unknown;
 }
 
 /**
@@ -1543,6 +2067,12 @@ export declare interface EditorToolbarOptions<TName extends string> {
      * 自定义按钮
      */
     custom?: EditorToolbarFeatureButtonConfig<string>;
+    /**
+     * 工具栏挂载的容器dom，配置后则挂载到指定的容器上
+     *
+     * 如果不配置则按照套件的默认方式挂载。
+     */
+    container?: HTMLElement;
 }
 
 /**
@@ -1580,13 +2110,17 @@ export declare interface EditorUiOptions {
         /**
          * 显示升级弹窗
          */
-        showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse>;
+        showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse | undefined>;
     };
     notification?: {
         /**
          * 渲染通知条
          */
         render?: (params: RenderNotificationProps) => void;
+        /**
+         * 是否禁用通知条
+         */
+        disabled?: boolean;
     };
     /**
      * 用户名片
@@ -1600,6 +2134,20 @@ export declare interface EditorUiOptions {
          * 渲染用户卡片
          */
         render?: (params: RenderUserCardProps) => RenderUserCardResult;
+        /**
+         * 是否禁用用户卡片
+         * jd需要禁用
+         */
+        disabled?: boolean;
+    };
+    /**
+     * 登录提示
+     */
+    loginNotice?: {
+        /**
+         * 显示登录提示
+         */
+        show?: () => void;
     };
     /**
      * toast
@@ -1613,6 +2161,10 @@ export declare interface EditorUiOptions {
          * 是否禁用toast
          */
         disabled?: boolean;
+        /**
+         * 自定义toast提示文本配置
+         */
+        tips?: ToastTipsConfig;
     };
     /**
      * confirm
@@ -1627,9 +2179,48 @@ export declare interface EditorUiOptions {
          */
         disabled?: boolean;
     };
+    /**
+     * 全屏配置
+     */
+    fullscreen?: EditorFeatureConfig;
+    /**
+     * 演示模式配置
+     */
+    presentation?: EditorFeatureConfig;
+    /**
+     * 帮助中心配置
+     */
+    helpCenter?: EditorFeatureConfig;
+    /**
+     * 新功能提醒相关配置
+     */
+    newFeature?: {
+        /**
+         * 是否不展示新功能提醒(包括任何形式的)
+         */
+        hidden?: boolean;
+    };
+    /**
+     * 图片查看器配置
+     */
+    imageViewer?: {
+        /**
+         * 右键菜单配置
+         */
+        contextMenu?: EditorMenuOptions<'copy' | 'download'>;
+        /**
+         * 操作配置
+         */
+        operations?: {
+            /**
+             * 下载图片
+             */
+            download: EditorFeatureConfig;
+        };
+    };
 }
 
-export declare type EditorUploadableFile = EditorLocalUploadableFile;
+export declare type EditorUploadableFile = EditorLocalUploadableFile | EditorRemoteUploadableFile;
 
 /**
  * 文件开始上传入参
@@ -1695,10 +2286,23 @@ export declare interface EditorUserOptions {
 export declare interface EditorVersion {
     /**
      * 保存版本
+     * @param name 版本名称
+     */
+    createRevision: (name?: string) => void;
+    /**
+     * 显示版本(侧边栏或其他形式)
+     * 区别于历史侧边栏，在应用表格里表现为打开历史侧边栏切换到版本 tab
+     */
+    show?: () => void;
+    /**
+     * 隐藏版本(侧边栏或其他形式)
+     * 区别于历史侧边栏，在应用表格里表现为打开历史侧边栏切换到版本 tab
      */
-    createRevision: () => void;
+    hide?: () => void;
 }
 
+export declare type EditorVersionOptions = EditorFeatureConfig;
+
 /**
  * 编辑器外部水印信息
  */
@@ -1706,7 +2310,12 @@ export declare interface EditorWatermarkOptions {
     /**
      * 获取用作初始化使用的默认水印
      */
-    getWatermark: () => MaybePromiseValue<EditorWatermarkResource | null>;
+    getWatermark?: () => MaybePromiseValue<EditorWatermarkResource | null>;
+    /**
+     * 获取文件导出水印
+     * @param exportType 导出类型 图片/pdf/纯图pdf
+     */
+    getExportWatermark?: (exportType: 'image' | 'pdf' | 'image_pdf') => Promise<string[] | undefined>;
     /**
      * 是否必须，如果为 true，编辑器将在初始化时强制渲染水印，
      * 水印配置信息加载失败将导致编辑器初始化失败
@@ -1722,28 +2331,13 @@ 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;
     /**
@@ -1802,6 +2396,14 @@ export declare enum FileType {
     CloudFile = 3
 }
 
+/**
+ * 引导数据
+ */
+export declare interface GuideData {
+    type: number;
+    id: number;
+}
+
 /**
  * 请求、响应头
  */
@@ -1909,34 +2511,67 @@ export declare interface HTTPResponse<Data = unknown> {
  */
 export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 
-export declare interface Limitation {
+export declare type MaybePromiseValue<T> = T | Promise<T>;
+
+export declare interface MentionEventPayload {
+    /**
+     * 距离页面左边的距离
+     */
+    x: number;
+    /**
+     * 距离页面顶部的距离
+     */
+    y: number;
+    /**
+     * mention信息
+     */
+    mentionInfo: MentionInfo;
+}
+
+export declare interface MentionInfo {
+    /** 用户 Id */
+    userId?: number;
+    /** 文件 Id */
+    fileId?: string;
     /**
-     * 限制原因（错误码）
+     * mention区域宽度
      */
-    code?: number;
+    width?: number;
     /**
-     * 单位（不参与计算，仅作显示）
-     * minutes、MB
+     * mention区域高度
      */
-    unit?: string;
+    height?: number;
     /**
-     * 描述
+     * mention区域左上角距离页面左边的距离
      */
-    desc?: string;
+    left?: number;
     /**
-     * min/max int64 默认表示 MB/个/分钟/行
+     * mention区域左上角距离页面顶部的距离
      */
-    max?: number;
-    min?: number;
+    top?: number;
 }
 
-export declare type MaybePromiseValue<T> = T | Promise<T>;
-
 /**
  * 升级弹窗类型
  * 个人版或企业版
  */
-export declare type OpenType = 'personal' | 'enterprise';
+export declare type OpenType = 'personal' | 'enterprise' | 'pendingOrder';
+
+export declare interface OperationToastConfig {
+    /**
+     * 成功提示文本
+     */
+    success?: string;
+    /**
+     * 失败提示文本
+     */
+    failed?: string;
+    /**
+     * 权限不足提示文本
+     * 桌面客户端安全模式下需要提供【当前账号未获得此项能力授权。】
+     */
+    noPermission?: string;
+}
 
 export declare interface RenderNotificationProps {
     /**
@@ -1958,15 +2593,15 @@ export declare interface RenderUserCardProps {
         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';
+    position?: 'top' | 'left' | 'right' | 'bottom' | 'left_top' | 'left_bottom' | 'right_top' | 'right_bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right';
+    trigger?: 'hover' | 'click';
 }
 
 export declare interface RenderUserCardResult {
     /**
      * 关闭用户卡片
      */
-    close: (force?: boolean) => void;
+    close?: (force?: boolean) => void;
 }
 
 /**
@@ -2007,6 +2642,18 @@ export declare interface SaveStatusDelegation {
  */
 export declare type Scene = 'history' | 'version' | 'public' | 'search' | 'attachments';
 
+export declare interface ShortcutConfig {
+    /**
+     * 快捷键，例如保存快捷键windows为ctrl+s, mac系统则为meta+s
+     * 如果不想区分系统则为mod+s
+     */
+    key: string;
+    /**
+     * 快捷键回调
+     */
+    callback: () => void;
+}
+
 export declare interface ShowConfirmOptions {
     /**
      * 确认框标题
@@ -2106,6 +2753,67 @@ export declare interface SyncStatusDelegation {
     onError: (error: unknown, context: SyncContext) => void;
 }
 
+/**
+ * Toast提示文本配置接口
+ */
+export declare interface ToastTipsConfig {
+    /**
+     * 复制相关提示文本
+     */
+    copy?: OperationToastConfig;
+    /**
+     * 粘贴相关提示文本
+     */
+    paste?: OperationToastConfig;
+    /**
+     * 剪切相关提示文本
+     */
+    cut?: OperationToastConfig;
+    /**
+     * 打印相关提示文本
+     */
+    print?: OperationToastConfig;
+    /**
+     * 导出相关提示文本
+     */
+    export?: OperationToastConfig;
+    /**
+     * 编辑相关提示文本
+     */
+    edit?: OperationToastConfig;
+    /**
+     * 下载相关提示文本
+     */
+    download?: {
+        /**
+         * 图片下载提示文本
+         */
+        image?: OperationToastConfig;
+        /**
+         * 附件下载提示文本
+         */
+        attachment?: OperationToastConfig;
+    };
+    /**
+     * 预览相关提示文本
+     */
+    preview?: {
+        /**
+         * 图片预览提示文本
+         */
+        image?: OperationToastConfig;
+        /**
+         * 附件预览提示文本
+         */
+        attachment?: OperationToastConfig;
+    };
+    /**
+     * 创建版本相关提示文本
+     * sdk2.0需要提供
+     */
+    createVersion?: OperationToastConfig;
+}
+
 /**
  * 工具箱工具项接口
  */