@officesdk/editor-sdk-core 0.0.0-14 → 0.0.0-16

package/types/sheet.d.ts

@@ -30,6 +30,18 @@ export declare abstract class AbstractedSheetSDK extends EditorSDK {
      * 打印文档
      */
     abstract print(): Promise<void>;
+    /**
+     * 进入演示模式
+     */
+    abstract startDemonstration(): Promise<void>;
+    /**
+     * 退出演示模式
+     */
+    abstract endDemonstration(): Promise<void>;
+    /**
+     * 导出为图片/pdf
+     */
+    abstract export(type: 'pdf' | 'image'): Promise<void>;
     /**
      * 工作簿接口
      */
@@ -50,6 +62,99 @@ export declare abstract class AbstractedSheetSDK extends EditorSDK {
      * 文本格式接口
      */
     abstract get text(): SheetText;
+    /**
+     * 评论接口
+     */
+    abstract get comments(): SheetComments | undefined;
+    /**
+     * 锁定接口
+     */
+    abstract get locks(): SheetLocks | undefined;
+    /**
+     * 表格提及接口
+     */
+    abstract get mention(): SheetMention | undefined;
+    /**
+     * 跟随模式接口
+     */
+    abstract get followMode(): EditorFollowMode | undefined;
+}
+
+export declare interface AddRangeLockParams {
+    ranges?: SheetCellRange[];
+    sheetId?: string;
+    description?: string;
+    userPermissions: PermissionDict;
+    departmentPermissions?: PermissionDict;
+    visitorPermission?: PermissionLevel;
+}
+
+export declare interface AddSheetLockParams {
+    sheetId?: string;
+    description?: string;
+    userPermissions: PermissionDict;
+    departmentPermissions?: PermissionDict;
+    visitorPermission?: PermissionLevel;
+}
+
+export declare type CheckLimitationResult = {
+    status: 'limited';
+    /**
+     * 被限制原因
+     */
+    reason?: string;
+} | {
+    status: 'unlimited';
+};
+
+export declare interface ClipboardPasteParams {
+    /**
+     * 粘贴的html内容
+     */
+    html: string;
+    /**
+     * 粘贴的文本内容
+     */
+    text: string;
+    /**
+     * 粘贴的base64文件
+     */
+    base64File?: string;
+    /**
+     * 是否删除末尾空白行
+     */
+    removeTrailingEmptyRows?: boolean;
+    /**
+     * 是否删除末尾空白列
+     */
+    removeTrailingEmptyColumns?: boolean;
+}
+
+/**
+ * 协作者信息接口
+ */
+export declare interface CollaboratorInfo {
+    /** 协作者唯一标识 */
+    id: number;
+    /** 协作者名称 */
+    name: string;
+    /** 协作者头像URL */
+    avatar: string;
+}
+
+export declare interface ConfirmButtonConfig {
+    /**
+     * 按钮文本
+     */
+    label?: string;
+    /**
+     * 是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 按钮点击回调
+     */
+    onClick?: () => void;
 }
 
 /**
@@ -198,8 +303,9 @@ export declare interface EditorAttachmentMaxSizeOptions {
  * 编辑器附件信息
  */
 export declare interface EditorAttachmentOptions {
-    uploader: AbstractedEditorFileUploader;
-    download: (url: string) => void;
+    picker?: EditorFilePicker;
+    uploader?: AbstractedEditorFileUploader;
+    download?: (url: string) => void;
     /**
      * 图片附件相关配置
      */
@@ -273,6 +379,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;
+}
+
 /**
  * 单条评论数据
  */
@@ -339,7 +519,7 @@ export declare interface EditorComments {
 /**
  * 编辑器评论初始化配置
  */
-export declare interface EditorCommentsOptions {
+export declare interface EditorCommentsOptions extends EditorFeatureConfig {
     /**
      * 评论作者信息，如果这里的信息为空，将会使用 user 信息
      */
@@ -368,6 +548,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> {
@@ -393,6 +579,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;
@@ -452,16 +651,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 {
     /**
      * 字体的名称，用于在用户界面上显示的名称
@@ -540,6 +804,19 @@ export declare interface EditorFontsOptions {
     list: EditorFontsList;
 }
 
+export declare interface EditorHistory {
+    /**
+     * 显示历史记录侧边栏
+     */
+    showSidebar: () => void;
+    /**
+     * 隐藏历史记录侧边栏
+     */
+    hideSidebar: () => void;
+}
+
+export declare type EditorHistoryOptions = EditorFeatureConfig;
+
 /**
  * i18n 相关设置
  */
@@ -560,13 +837,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>;
 }
 
 /**
@@ -651,29 +954,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;
+    /**
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
+     */
+    tooltip?: string;
     /**
-     * 是否禁用菜单项，设置为true则变为灰色不可点击
+     * 按钮在工具栏中位置，不设置则按照默认位置
      */
-    disabled?: boolean;
+    index?: number;
 }
 
 /**
@@ -731,9 +1032,9 @@ export declare interface EditorMenuOptions<TName extends string> {
     entries?: EditorMenuEntryConfig<TName>[];
     /**
      * 菜单栏功能按钮配置
-     * TODO 此配置目前没有用到，后续看是保留还是和custom合并
+     * 更加间接的配置项
      */
-    features?: Record<TName, EditorMenuFeatureConfig>;
+    features?: Partial<Record<TName, EditorMenuFeatureConfig>>;
     /**
      * 自定义按钮配置
      */
@@ -803,6 +1104,10 @@ export declare interface EditorOptions {
      * 匿名用户的缺省信息
      */
     anonymous?: EditorAnonymousOptions;
+    /**
+     * 当前文件信息
+     */
+    file?: EditorFileOptions;
     /**
      * i18n 相关设置
      */
@@ -810,13 +1115,13 @@ export declare interface EditorOptions {
     /**
      * 品牌相关设置
      */
-    brand?: EditorBrandOptions;
+    brand?: MaybePromiseValue<EditorBrandOptions>;
     /**
      * 编辑器内部资源请求配置
      */
     assets?: EditorAssetsOptions;
     /**
-     * 编辑器内部超链接设置
+     * 编辑器链接相关配置
      */
     link?: EditorLinkOptions;
     /**
@@ -843,6 +1148,38 @@ export declare interface EditorOptions {
      * 导出设置
      */
     export?: EditorExportOptions;
+    /**
+     * 解密设置
+     */
+    decryption?: EditorDecryptionOptions;
+    /**
+     * 网络请求设置
+     */
+    http?: HTTPProxy;
+    /**
+     * 编辑器渲染设置项
+     */
+    render?: EditorRenderOptions;
+    /**
+     * 编辑器 UI 相关
+     */
+    ui?: EditorUiOptions;
+    /**
+     * 编辑器卡点限制
+     */
+    checkpoints?: EditorCheckpointsOptions;
+    /**
+     * 编辑器工具箱设置
+     */
+    toolbox?: EditorToolboxOptions;
+    /**
+     * 编辑器历史设置
+     */
+    history?: EditorHistoryOptions;
+    /**
+     * 编辑器协作相关
+     */
+    collaboration?: EditorCollaborationOptions;
 }
 
 /**
@@ -903,10 +1240,41 @@ export declare interface EditorOutlineOptions {
     visible?: boolean;
 }
 
+export declare interface EditorPerformanceOptions {
+    /**
+     * 记录性能指标
+     * @param mark 性能指标名称
+     */
+    record?: (mark: 'first_page' | 'first_editable_page') => void;
+}
+
+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 上，显示一个提示信息。
@@ -914,10 +1282,6 @@ export declare interface EditorPrintOptions {
     fallback?: {
         message: string;
     };
-    /**
-     * 是否禁用打印功能
-     */
-    disabled?: boolean;
 }
 
 /**
@@ -931,6 +1295,13 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
     raw?: never;
 }
 
+export declare interface EditorRenderOptions {
+    /**
+     * 渲染的容器
+     */
+    container?: HTMLElement;
+}
+
 /**
  * 编辑器通用接口
  */
@@ -965,8 +1336,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;
 }
 
 /**
@@ -1102,11 +1489,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;
     /**
      * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
@@ -1115,14 +1502,6 @@ export declare interface EditorToolbarFeatureButton<TName extends string> {
      * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
     icon?: string;
-    /**
-     * 按钮是否隐藏，设置为true则隐藏按钮
-     */
-    hidden?: boolean;
-    /**
-     * 按钮是否禁用，设置为true则变为灰色不可点击
-     */
-    disabled?: boolean;
     /**
      * 按钮点击事件.接受一个函数，可以自定义点击事件。
      */
@@ -1166,42 +1545,126 @@ export declare interface EditorToolbarOptions<TName extends string> {
     custom?: EditorToolbarFeatureButtonConfig<string>;
 }
 
-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 interface EditorToolboxOptions {
+    /**
+     * 获取工具箱配置
+     * @param attachGuidList - 附件GUID列表
+     * @returns 返回工具箱工具项列表
+     */
+    getToolbox?: (attachGuidList: string[]) => Promise<{
+        tools: ToolboxToolItem[];
+    }>;
 }
 
-export declare type EditorUploadTaskCallbacks = Omit<EditorTaskCallbacks, 'onEnd'> & {
-    onLoadend: (results: {
-        taskId: string;
-        status: 'Error' | 'Finished' | 'Canceled';
-        data?: unknown;
-    }[]) => void;
-};
-
 /**
- * 上传任务信息
+ * 编辑器UI选项接口
+ * 定义了编辑器可以使用的UI相关功能
  */
-export declare interface EditorUploadTaskInfo {
-    taskId: string;
-    fileInfo: EditorUploadableFile;
-    total: number;
+export declare interface EditorUiOptions {
+    /**
+     * 侧边栏
+     */
+    sidebar?: {
+        /**
+         * 打开使用指南/快捷键侧边栏
+         */
+        open?: (activeKey: 'userGuide' | 'shortcut') => void;
+    };
+    /**
+     * 升级弹窗
+     */
+    upgrade?: {
+        /**
+         * 显示升级弹窗
+         */
+        showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse>;
+    };
+    notification?: {
+        /**
+         * 渲染通知条
+         */
+        render?: (params: RenderNotificationProps) => void;
+    };
+    /**
+     * 用户名片
+     */
+    userCard?: {
+        /**
+         * 需要排除的用户卡片字段（不会在用户卡片中展示）
+         */
+        excludeFields?: string[];
+        /**
+         * 渲染用户卡片
+         */
+        render?: (params: RenderUserCardProps) => RenderUserCardResult;
+    };
+    /**
+     * toast
+     */
+    toast?: {
+        /**
+         * 显示自定义toast
+         */
+        show?: (options: ShowToastOptions) => void;
+        /**
+         * 是否禁用toast
+         */
+        disabled?: boolean;
+    };
+    /**
+     * confirm
+     */
+    confirm?: {
+        /**
+         * 显示自定义confirm
+         */
+        show?: (options: ShowConfirmOptions) => void;
+        /**
+         * 是否禁用confirm
+         */
+        disabled?: boolean;
+    };
+}
+
+export declare type EditorUploadableFile = EditorLocalUploadableFile;
+
+/**
+ * 文件开始上传入参
+ */
+export declare interface EditorUploadStartOptions extends EditorUploadTaskCallbacks {
+    files: EditorUploadableFile[];
+}
+
+/**
+ * 上传状态
+ */
+export declare enum EditorUploadStatus {
+    Waiting = "Waiting",
+    Uploading = "Uploading",
+    Paused = "Paused",
+    Canceled = "Canceled",
+    Error = "Error",
+    Finished = "Finished"
+}
+
+export declare type EditorUploadTaskCallbacks = Omit<EditorTaskCallbacks, 'onEnd'> & {
+    onLoadend: (results: {
+        taskId: string;
+        status: 'Error' | 'Finished' | 'Canceled';
+        data?: unknown;
+    }[]) => void;
+};
+
+/**
+ * 上传任务信息
+ */
+export declare interface EditorUploadTaskInfo {
+    taskId: string;
+    fileInfo: EditorUploadableFile;
+    total: number;
     readonly loaded: number;
     readonly progress: number;
     readonly status: EditorUploadStatus;
@@ -1229,6 +1692,13 @@ export declare interface EditorUserOptions {
     defaultAvatar?: string;
 }
 
+export declare interface EditorVersion {
+    /**
+     * 保存版本
+     */
+    createRevision: () => void;
+}
+
 /**
  * 编辑器外部水印信息
  */
@@ -1252,6 +1722,113 @@ 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
+}
+
+export declare enum FormatCategory {
+    /** 常规 */
+    Auto = "auto",
+    /** 纯文本 */
+    Text = "text",
+    /** 数字 */
+    Number = "number",
+    /** 百分比 */
+    Percent = "percent",
+    /** 货币 */
+    Currency = "currency",
+    /** 会计 */
+    Accounting = "accounting",
+    /** 日期 */
+    Date = "date",
+    /** 时间 */
+    Time = "time",
+    /** 分数 */
+    Fraction = "fraction",
+    /** 科学计数 */
+    Scientific = "scientific",
+    /** 特殊 */
+    Special = "special",
+    /** 自定义 */
+    Custom = "custom"
+}
+
 /**
  * 请求、响应头
  */
@@ -1359,8 +1936,168 @@ 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 enum MentionTypes {
+    Comment = "comment",
+    Mention = "mention_at",
+    DateMention = "date_mention"
+}
+
+/**
+ * 升级弹窗类型
+ * 个人版或企业版
+ */
+export declare type OpenType = 'personal' | 'enterprise';
+
+export declare interface PermissionDict {
+    [id: number]: PermissionLevel;
+}
+
+/** 权限等级 */
+export declare enum PermissionLevel {
+    /** 可以编辑 */
+    Editable = 0,
+    /** 只读 */
+    ReadOnly = 1,
+    /** 禁止查看 */
+    Private = 2
+}
+
+export declare interface RemoveRangeLocksParams {
+    sheetId?: string;
+    ranges?: SheetCellRange[];
+}
+
+export declare interface RemoveSheetLockParams {
+    sheetId?: string;
+}
+
+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 SearchMatch {
+    /**
+     * 单元格所在行号
+     */
+    row: number;
+    /**
+     * 单元格所在列号
+     */
+    column: number;
+    /**
+     * 单元格的text
+     */
+    text: string;
+    /**
+     * 是否是链接单元格
+     */
+    isLinkCell?: boolean;
+    /**
+     * 单元格公式信息
+     */
+    formulaInfo?: {
+        /**
+         * 公式文本
+         */
+        formulaText: string;
+        /**
+         * 是否包含公式
+         */
+        hasFormula: boolean;
+    };
+}
+
 /**
  * 表格单元格对象
  */
@@ -1385,8 +2122,42 @@ export declare interface SheetCell {
      * 获取单元格的值
      */
     getCellValue: () => SheetCellValue | null;
+    /**
+     * 获取单元格数据
+     */
+    getCellData: () => SheetCellData;
+}
+
+export declare interface SheetCellData extends SheetCellMeta {
+    /**
+     * 单元格值
+     */
+    value: SheetCellValue | null;
+}
+
+export declare interface SheetCellMeta {
+    /**
+     * 单元格格式
+     */
+    format: string | undefined;
+    /**
+     * 合并单元格范围
+     */
+    span: SheetCellRange | undefined;
+    /**
+     * 单元格格式类型
+     */
+    formatCategory: FormatCategory;
+    /**
+     * 单元格数字精度
+     */
+    precision: number | undefined;
 }
 
+export declare type SheetCellRange = Omit<Extract<SheetRangeValue, {
+    type: `${SheetRangeType.Cells}`;
+}>, 'type'>;
+
 /**
  * 单元格值类型
  */
@@ -1403,6 +2174,132 @@ export declare type SheetCellValue = {
     };
 };
 
+export declare interface SheetChartOptions extends EditorFeatureConfig {
+    /**
+     * 外部（其他套件）插入图表参数
+     * 默认从url search params上获取
+     */
+    externalChartOptions?: {
+        /** 表格识别这个参数，进入「选择图表模式」 */
+        action: 'selectChart';
+        /** 模式 */
+        mode: 'insert' | 'edit' | 'refresh';
+        /** 选中的图表id，编辑模式下需传该参数，多个可用逗号分割 */
+        selected?: string;
+    };
+}
+
+export declare type SheetChecklistOptions = EditorFeatureConfig;
+
+export declare interface SheetCombineSheetsOptions extends EditorFeatureConfig {
+    /**
+     * 是否隐藏通过链接进行合并的入口
+     */
+    isCombineByUrlHidden?: boolean;
+    /**
+     * 是否隐藏生成合并工作表的位置配置入口
+     */
+    isCombinedLocationHidden?: boolean;
+}
+
+export declare interface SheetComments extends EditorComments {
+    /**
+     * 显示评论侧边栏
+     */
+    showSidebar: () => void;
+    /**
+     * 隐藏评论侧边栏
+     */
+    hideSidebar: () => void;
+}
+
+export declare interface SheetExportOptions extends EditorExportOptions {
+    /**
+     * 导出表格的方法
+     * @param type - 导出类型，支持 'csv' 或 'xlsx' 格式
+     * @param sheetId - 可选的表格ID，用于指定要导出的特定表格
+     */
+    exportSheet?: (type: 'csv' | 'xlsx', sheetId?: string) => Promise<void>;
+}
+
+export declare interface SheetFontsOptions extends EditorFontsOptions {
+    /**
+     * 禁用不支持下载且本地未安装的字体
+     */
+    disableUnavailableFonts?: boolean;
+}
+
+export declare interface SheetFormOptions extends EditorFeatureConfig {
+    /**
+     * 获取表单预览和填写页路径
+     */
+    getFormPagePath?: () => string;
+}
+
+export declare interface SheetImportFormulaOptions extends EditorFeatureConfig {
+    /**
+     * 注册一个监听器，用于在跨表格引用结果发生变化时触发
+     * @param listener - 回调函数，参数 guidList 表示发生变化的 guid 列表，可以是字符串或字符串数组。
+     * @returns 一个函数，用于移除当前注册的监听器。
+     */
+    addChangedListener?: (listener: (guidList: string | string[]) => void) => () => void;
+}
+
+export declare interface SheetLockOptions extends EditorFeatureConfig {
+    /**
+     * 添加锁定列表的占位文案
+     */
+    lockListInputPlaceholder?: string;
+    /**
+     * 是否隐藏批量锁定入口
+     */
+    isBatchLockHidden?: boolean;
+    /**
+     * 是否禁止通过手机号查找锁定名单
+     */
+    isSearchByPhoneNumberDisabled?: boolean;
+    /**
+     * 是否以最低权限来渲染，用于缩略图场景，确保每个人看到的内容一致
+     */
+    isLowestPermissionMode?: boolean;
+}
+
+export declare interface SheetLocks {
+    /**
+     * 显示锁定侧边栏
+     */
+    showSidebar: () => void;
+    /**
+     * 隐藏锁定侧边栏
+     */
+    hideSidebar: () => void;
+    /**
+     * 添加单元格锁定
+     */
+    addRangeLock: (params: AddRangeLockParams) => void;
+    /**
+     * 添加工作表锁定
+     */
+    addSheetLock: (params: AddSheetLockParams) => void;
+    /**
+     * 移除单元格锁定
+     */
+    removeRangeLocksInRanges: (params: RemoveRangeLocksParams) => void;
+    /**
+     * 移除工作表锁定
+     */
+    removeSheetLock: (params: RemoveSheetLockParams) => void;
+}
+
+export declare interface SheetMention {
+    /**
+     * 通过通知的guid定位单元格
+     * @param guid 通知的guid
+     * @param mentionType 通知类型
+     */
+    locateCellByGuid: (guid: string, mentionType: MentionTypes) => void;
+}
+
 /**
  * 专业表格工具栏一级菜单
  */
@@ -1465,12 +2362,16 @@ export declare interface SheetRange {
      * @param html 内容
      */
     setHtml: (html: string) => void;
+    /**
+     * 获取该区域的单元格值
+     */
+    getValue: () => (SheetCellValue | null)[][];
+    /**
+     * 获取该区域的单元格数据
+     */
+    getData: () => SheetCellData[][];
 }
 
-/**
- * 区域（Range）
- * 区域对象，表示表格中的一个单元格区域，每个 Range 对象包含了一个或多个单元格、行、列信息。
- */
 /**
  * 选区类型
  */
@@ -1547,11 +2448,22 @@ export declare type SheetRangeValue = {
     type: `${SheetRangeType.Sheet}`;
 };
 
+export declare interface SheetRenderOptions extends EditorRenderOptions {
+    /**
+     * 激活的工作表 ID
+     */
+    sheetId?: string;
+    /**
+     * 是否显示表格标题（oppo tt移动端专用）
+     */
+    showSheetTitle?: boolean;
+}
+
 export declare interface SheetSDKOptions extends EditorOptions {
     /**
      * 字体配置
      */
-    fonts?: EditorFontsOptions;
+    fonts?: SheetFontsOptions;
     /**
      * 菜单栏相关设置
      */
@@ -1564,6 +2476,56 @@ export declare interface SheetSDKOptions extends EditorOptions {
      * 文本格式相关设置
      */
     text?: SheetTextOptions;
+    /**
+     * @override
+     * 渲染设置
+     */
+    render?: SheetRenderOptions;
+    /**
+     * @override
+     * 导出设置
+     */
+    export?: SheetExportOptions;
+    /**
+     * 合并工作表设置
+     */
+    combineSheets?: SheetCombineSheetsOptions;
+    /**
+     * 跨表格引用设置
+     */
+    importFormula?: SheetImportFormulaOptions;
+    /**
+     * 锁定设置
+     */
+    lock?: SheetLockOptions;
+    /**
+     * 表单设置
+     */
+    form?: SheetFormOptions;
+    /**
+     * 表格转应用表格设置
+     */
+    sheet2Table?: SheetToTableOptions;
+    /**
+     * 表格任务清单设置
+     */
+    checklist?: SheetChecklistOptions;
+    /**
+     * 表格隐藏列内容设置
+     */
+    sensitization?: SheetSensitizationOptions;
+    /**
+     * 跟随模式设置
+     */
+    followMode?: EditorFollowModeOptions;
+    /**
+     * 图表设置
+     */
+    chart?: SheetChartOptions;
+    /**
+     * 性能指标设置
+     */
+    performance?: EditorPerformanceOptions;
 }
 
 /**
@@ -1587,6 +2549,13 @@ export declare interface SheetSelection {
     setRange: (value: SheetRangeValue | null) => void;
 }
 
+export declare interface SheetSensitizationOptions extends EditorFeatureConfig {
+    /**
+     * 是否以最低权限来渲染，用于缩略图场景，确保每个人看到的内容一致
+     */
+    isLowestPermissionMode?: boolean;
+}
+
 /**
  * 电子表格文本接口
  */
@@ -1622,6 +2591,8 @@ export declare type SheetToolbarFeatureButtonName = 'undo' | 'redo' | 'print' |
  */
 export declare type SheetToolbarOptions = EditorToolbarOptions<SheetToolbarFeatureButtonName>;
 
+export declare type SheetToTableOptions = EditorFeatureConfig;
+
 /**
  * 工作表集合对象
  */
@@ -1666,6 +2637,18 @@ export declare interface SheetWorksheet {
      * 这个工作表是否为当前活动的工作表
      */
     get isActive(): boolean;
+    /**
+     * 获取工作表是否可见
+     */
+    get visible(): boolean;
+    /**
+     * 获取工作表的行数
+     */
+    get rowCount(): number;
+    /**
+     * 获取工作表的列数
+     */
+    get columnCount(): number;
     /**
      * 获取工作表的所有选区
      * @returns
@@ -1718,6 +2701,185 @@ export declare interface SheetWorksheet {
      * @param column 单元格所在列
      */
     locateCell: (row: number, column: number) => void;
+    /**
+     * 搜索文本
+     * @param text 搜索文本
+     * @param range 搜索范围
+     */
+    search: (text: string, range?: SheetRangeValue | SheetRangeValue[]) => void;
+    /**
+     * 取消搜索
+     */
+    cancelSearch: () => void;
+    /**
+     * 获取工作表视图区域大小, 不包含空白区域
+     */
+    getViewportSize: () => {
+        width: number;
+        height: number;
+    };
+    /**
+     * 粘贴
+     */
+    paste: (params: ClipboardPasteParams) => void;
+}
+
+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 { }