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

package/types/form.d.ts

@@ -0,0 +1,3027 @@
+export declare abstract class AbstractedEditorFileUploader {
+    /**
+     * 开始上传
+     * @param options
+     */
+    abstract start(options: EditorUploadStartOptions): EditorUploadTaskInfo[];
+    /**
+     * 暂停上传，不传参数则取消所有上传任务
+     * @param taskIds
+     */
+    abstract pause(taskIds?: string[]): void;
+    /**
+     * 暂停上传，不传参数则暂停所有上传任务
+     * @param taskIds
+     */
+    abstract abort(taskIds?: string[]): void;
+    /**
+     * 恢复上传，不传参数则恢复所有上传任务
+     * @param taskIds
+     */
+    abstract resume(taskIds?: string[]): void;
+}
+
+export declare abstract class AbstractedFormSDK extends EditorSDK {
+    /**
+     * 监听表单标题的变化
+     * @param listener 在表单内部标题被修改时触发 listener 回调
+     * @returns 返回一个取消监听的函数
+     */
+    abstract addTitleChangeListener(listener: (newTitle: string) => void): () => void;
+    /**
+     * 主动修改表单的标题
+     * @param title title 不能为空字符串或者全部由空格或空白字符组成
+     */
+    abstract setTitle(title: string): void;
+    /**
+     * 打印表单
+     */
+    abstract print(): Promise<void>;
+    /**
+     * 更新表单的权限，目前只需要用到是否可编辑
+     * @param options
+     */
+    abstract updatePermissions(options: {
+        editable: boolean;
+    }): void;
+}
+
+/**
+ * 协作者信息接口
+ */
+export declare interface CollaboratorInfo {
+    /** 协作者唯一标识 */
+    id: number;
+    /** 协作者名称 */
+    name: string;
+    /** 协作者头像URL */
+    avatar: string;
+}
+
+export declare interface ConfirmButtonConfig {
+    /**
+     * 按钮文本
+     */
+    label?: string;
+    /**
+     * 是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 按钮点击回调
+     */
+    onClick?: () => void;
+}
+
+/**
+ * 匿名用户信息
+ * 当前用户信息未知时的缺省值
+ */
+export declare interface EditorAnonymousOptions {
+    /**
+     * 匿名用户默认显示名称
+     */
+    name: string;
+    /**
+     * 匿名用户默认头像
+     */
+    avatar: string;
+}
+
+/**
+ * 编辑器内部资源请求配置
+ */
+export declare interface EditorAssetsOptions {
+    /**
+     * 通用资源请求代理配置，
+     * 用于套件内部资源请求时代理请求
+     */
+    proxy: HTTPProxy;
+    /**
+     * 资源文件 URL 转换和解析
+     */
+    resolver: EditorAssetsResolver;
+    /**
+     * 图片处理器
+     */
+    imageProcessing: EditorAssetsOssImageProcessing;
+}
+
+/**
+ * 基于对象存储的图片处理抽象
+ */
+export declare interface EditorAssetsOssImageProcessing {
+    /**
+     * 压缩图片的方法
+     * @param imageUrl 图片的 URL
+     * @param compressOptions 压缩配置，例如质量、最大宽度和最大高度
+     * @returns 压缩后的图片 URL
+     */
+    compress: (imageUrl: string, compressOptions?: {
+        quality?: number;
+        maxWidth?: number;
+        maxHeight?: number;
+    }) => string;
+    /**
+     * 裁切图片的方法
+     * @param imageUrl 图片的 URL
+     * @param cropOptions 裁切配置，例如宽度、高度和起始点
+     * @returns 裁切后的图片 URL
+     */
+    crop: (imageUrl: string, cropOptions: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+        g: EditorImageCropPoint;
+    }) => string;
+}
+
+export declare interface EditorAssetsResolver {
+    /**
+     * 将资源文件 ID 转换为 URL 的方法
+     * @param assetId 资源文件 ID
+     * @returns 转换后的资源 URL ，如果无法转换则返回 null
+     */
+    resolveUrl: (assetId: string) => string | null;
+    /**
+     * 从 URL 中解析资源文件 ID 的方法
+     * @param url 资源 URL
+     * @returns 解析出的资源文件 ID
+     */
+    parseId: (url: string) => string | null;
+    /**
+     * 检查资源文件 ID 对应的文件是否准备就绪，
+     * 在部分环境中，资源文件需要异步导入，在编辑器加载的时候可能还未准备就绪
+     * @param assetId 资源文件 ID
+     * @returns
+     */
+    checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
+}
+
+/**
+ * 编辑器附件下载配置
+ */
+export declare interface EditorAttachmentDownloadOptions {
+    /**
+     * 是否禁用下载
+     */
+    disabled?: boolean;
+    /**
+     * 是否跳过验证
+     */
+    skipValidate?: boolean;
+    /**
+     * 下载附件
+     */
+    download?: (url: string) => void;
+    /**
+     * 获取附件下载地址
+     */
+    getDownloadUrl?: (url: string) => Promise<string>;
+}
+
+/**
+ * 编辑器附件限制配置,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 {
+    /**
+     * 附件选择器
+     */
+    picker?: EditorFilePicker;
+    /**
+     * 附件上传器
+     */
+    uploader?: AbstractedEditorFileUploader;
+    /**
+     * 下载
+     * @deprecated, 使用不同类型附件的download配置
+     */
+    download?: (url: string) => void;
+    /**
+     * 预览
+     * @deprecated, 使用不同类型附件的preview配置
+     */
+    preview?: (url: string) => void;
+    /**
+     * 图片附件相关配置
+     */
+    image?: {
+        /**
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
+         */
+        maxSize?: EditorAttachmentMaxSizeOptions;
+        /**
+         * 支持的图片格式列表，例如jpg,png等
+         */
+        supportTypes?: string[];
+        /**
+         * 图片附件的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+        /**
+         * 禁止预览
+         * @deprecated 使用preview.disabled代替
+         */
+        disablePreview?: boolean;
+        /**
+         * 预览
+         */
+        preview?: EditorAttachmentPreviewOptions;
+        /**
+         * 下载
+         */
+        download?: EditorAttachmentDownloadOptions;
+        /**
+         * 是否禁用缩略图
+         * 桌面客户端/极速sdk需要禁用
+         */
+        disableThumbnail?: boolean;
+    };
+    /**
+     * 附件相关配置
+     */
+    attachment?: {
+        /**
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
+         */
+        maxSize?: EditorAttachmentMaxSizeOptions;
+        /**
+         * 支持的附件格式列表，例如doc,docx等
+         */
+        supportTypes?: string[];
+        /**
+         * 附件的限制配置
+         */
+        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;
+}
+
+/**
+ * 基础文件属性
+ */
+export declare interface EditorBaseUploadableFile {
+    secretly?: boolean;
+    bucket: 'images' | 'attachments';
+    encrypt: string;
+    fileGuid: string;
+}
+
+/**
+ * 品牌设置
+ */
+export declare interface EditorBrandOptions {
+    enable: boolean;
+    getSettings: () => Promise<EditorBrandSetting | null>;
+}
+
+/**
+ * 品牌相关设置，
+ * 用于在套件中展示品牌外露信息
+ */
+export declare interface EditorBrandSetting {
+    /**
+     * 需要显示在品牌展示位的内容，按数组顺序显示
+     */
+    content: Array<{
+        type: 'image';
+        src: string;
+    } | {
+        type: 'text';
+        content: string;
+        color?: string;
+    }>;
+    /**
+     * 品牌展示位的布局信息
+     */
+    layout: {
+        width: string;
+        height: string;
+    };
+}
+
+export declare interface EditorCollaborationOptions {
+    /**
+     * 是否允许离线编辑
+     */
+    offlineEditable: boolean;
+    /**
+     * 保存状态外部接口委托
+     */
+    saveStatus: SaveStatusDelegation;
+    /**
+     * 同步状态外部接口委托(部分套件不支持离线编辑)
+     */
+    syncStatus?: SyncStatusDelegation;
+    /**
+     * 是否使用严格的长度校验规则，默认关闭，在开启后如果出现长度校验失败会立刻禁止编辑器继续编写，并将保存状态设置为错误状态
+     */
+    strictCLC?: boolean;
+    /**
+     * 版本号, 需通过内容接口response header获取
+     */
+    rev: MaybePromiseValue<number>;
+}
+
+/**
+ * 编辑器协作者管理接口
+ */
+export declare interface EditorCollaborators {
+    /**
+     * 获取当前所有协作者列表
+     * @returns  返回所有协作者信息数组
+     */
+    getCollaborators: () => CollaboratorInfo[];
+    /**
+     * 开始监听协作者状态变化
+     * 调用此方法后，将开始接收协作者进入/离开的事件
+     */
+    start: () => void;
+    /**
+     * 停止监听协作者状态变化
+     * 调用此方法后，将不再接收协作者进入/离开的事件
+     */
+    quit: () => void;
+    /**
+     * 监听事件
+     */
+    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;
+}
+
+export declare interface EditorCollaboratorsOptions {
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 推送协作者socket 对象
+     * 实际类型为socketIO.client
+     * TODO: 抽象为接口
+     */
+    socket?: EditorSocket;
+}
+
+/**
+ * 单条评论数据
+ */
+export declare interface EditorCommentItem {
+    /**
+     * 评论 ID
+     */
+    id: string;
+    /**
+     * 评论用户信息
+     */
+    user: {
+        id: string;
+        name: string;
+    };
+    content: {
+        text: string;
+    };
+}
+
+export declare interface EditorComments {
+    /**
+     * 检查是否有评论
+     * @returns
+     */
+    hasAny: () => Promise<boolean>;
+    /**
+     * 获取评论列表
+     * @returns
+     */
+    getAll: () => Promise<EditorCommentItem[]>;
+    /**
+     * 获取单个评论
+     * @param commentId
+     * @returns
+     */
+    getOne: (commentId: string) => Promise<EditorCommentItem | null>;
+    /**
+     * 添加内容
+     * @param options
+     * @returns
+     */
+    add: (options: {
+        /**
+         * 评论内容
+         */
+        text: string;
+        /**
+         * 默认评论是添加到当前选区上，也可以指定一个区域
+         */
+        range?: string;
+    }) => Promise<string | null>;
+    /**
+     * 删除所有评论
+     * @returns
+     */
+    deleteAll: () => Promise<boolean>;
+    /**
+     * 删除单条评论
+     */
+    deleteOne: (commentId: string) => Promise<boolean>;
+    /**
+     * 显示评论（侧边栏或其他形式）
+     */
+    show?: () => void;
+    /**
+     * 隐藏评论（侧边栏或其他形式）
+     */
+    hide?: () => void;
+}
+
+/**
+ * 编辑器评论初始化配置
+ */
+export declare interface EditorCommentsOptions extends EditorFeatureConfig {
+    /**
+     * 评论作者信息，如果这里的信息为空，将会使用 user 信息
+     */
+    author?: {
+        /**
+         * 评论作者 ID
+         */
+        id: string;
+        /**
+         * 评论作者信息
+         */
+        name: string;
+        /**
+         * 评论作者头像
+         */
+        avatar?: string;
+    };
+    /**
+     * 显示的视图配置
+     */
+    view?: {
+        /**
+         * 评论显示模式，
+         * none: 不显示评论，默认值。
+         * card: 评论以卡片形式显示。
+         */
+        mode: 'none' | 'card';
+    };
+    /**
+     * 推送评论的 socket 对象
+     */
+    socket?: EditorSocket;
+    /**
+     * 评论相关功能配置
+     */
+    features?: {
+        /**
+         * 添加评论
+         */
+        addComment?: EditorFeatureConfig;
+        /**
+         * 评论列表
+         */
+        commentList?: EditorFeatureConfig;
+    };
+}
+
+export declare interface EditorContent<Delta = EditorDelta> {
+    /**
+     * 设置编辑器内容
+     * @param content
+     */
+    setContent: (content: string | ArrayBuffer) => Promise<void>;
+    /**
+     * 获取编辑器内容
+     */
+    getContent: () => Promise<Delta>;
+    /**
+     * 添加监听，当内容发生变化时触发监听，传入 Delta
+     * @param listener
+     */
+    addChangeListener: (listener: (change: Delta) => void) => () => void;
+}
+
+/**
+ * 右键菜单栏相关配置
+ * 右键菜单栏是指的编辑器中点击右键弹出的菜单栏。目前等于菜单栏配置，可扩展
+ */
+export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
+
+/**
+ * 粘贴相关设置
+ */
+export declare type EditorCopyOptions = EditorLogicFeatureConfig;
+
+/**
+ * 编辑器解密选项接口
+ * 用于配置编辑器中需要解密的内容的相关选项
+ */
+export declare interface EditorDecryptionOptions {
+    /**
+     * 图片附件解密函数
+     * @param buffer - 需要解密的二进制数据
+     * @returns 解密后的二进制数据
+     */
+    decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
+}
+
+export declare interface EditorDelta {
+    compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
+    transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
+    stringify: () => string;
+    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;
+
+/**
+ * 编辑器嵌入对象
+ */
+export declare interface EditorEmbeddedObject {
+    /**
+     * 嵌入的对象 url
+     */
+    url: string;
+    /**
+     * 嵌入对象的类型描述
+     */
+    type?: string;
+    /**
+     * 嵌入对象的名
+     */
+    name?: string;
+}
+
+/**
+ * 编辑器嵌入对象抽象类
+ */
+export declare interface EditorEmbeddedObjectOptions {
+    /**
+     * 执行打开嵌入对象操作，
+     * 如果已经处理了打开操作，返回 true，否则返回 false，
+     * 如果返回 false，编辑器会继续后续默认的打开操作。
+     * @param object
+     * @returns
+     */
+    open: (object: EditorEmbeddedObject) => Promise<boolean>;
+    /**
+     * 嵌入对象的页面功能
+     */
+    ui?: {
+        /**
+         * 预览功能
+         */
+        preview?: {
+            disabled?: boolean;
+        };
+        /**
+         * 下载功能
+         */
+        download?: {
+            disabled?: boolean;
+        };
+    };
+}
+
+export declare interface EditorExportOptions extends EditorFeatureConfig {
+    /**
+     * 可导出类型, undefined 表示对可导出类型无限制
+     * 导出由接口 + 本地实现
+     */
+    types?: string[];
+    /**
+     * 接口支持的导出类型
+     */
+    supportedTypes?: string[];
+    /**
+     * 导出文件，调用接口实现
+     */
+    exportFile?: (type: string) => Promise<void>;
+}
+
+export declare interface EditorFeatureConfig {
+    /**
+     * 功能是否被禁用（入口还在）
+     */
+    disabled?: boolean;
+    /**
+     * 功能入口是否被隐藏
+     */
+    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
+     */
+    guid: string;
+    /**
+     * 文件名
+     */
+    name?: string;
+    /**
+     * 创建者,以id标识
+     */
+    creator?: number;
+    /**
+     * 创建时间, 毫秒级时间戳
+     */
+    createdAt?: number;
+    /**
+     * 文件限制
+     */
+    limitations?: EditorFileLimitationOptions;
+}
+
+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 | undefined;
+    /**
+     * 添加跟随状态变化的监听器
+     * @param listener 状态变化时的回调函数
+     * @returns 返回一个用于移除监听器的函数
+     */
+    addChangedListener: (listener: () => void) => () => void;
+}
+
+export declare interface EditorFollowModeOptions extends EditorFeatureConfig {
+    /**
+     * 推送跟随消息的 socket 对象
+     * 实际类型为socketIO.client
+     * TODO: 抽象为接口
+     */
+    socket?: EditorSocket;
+}
+
+export declare interface EditorFontFace {
+    /**
+     * 字体的名称，用于在用户界面上显示的名称
+     */
+    name: string;
+    /**
+     * 字体族
+     */
+    family: string;
+    /**
+     * 用于加载字体的 URL
+     */
+    url?: string;
+    /**
+     * 是否为受版权保护的字体，如果是在用户界面上会有所标识。
+     */
+    isCopyrightProtected: boolean;
+    /**
+     * 字体元数据
+     */
+    meta: EditorFontMeta;
+}
+
+/**
+ * 字体元数据
+ */
+export declare interface EditorFontMeta {
+    head: {
+        unitsPerEm: number;
+    };
+    hhea: {
+        ascender: number;
+        descender: number;
+        lineGap: number;
+    };
+    vhea?: {
+        ascender: number;
+        descender: number;
+        lineGap: number;
+    };
+    os2: {
+        usWeightClass?: number;
+        usWidthClass?: number;
+        italic?: boolean;
+        isSymbol?: boolean;
+        ulCodePageRange: [number, number];
+    };
+    /**
+     * opentype中没有强制要求必须有en条目，只能确定name下的value的类型是对象
+     */
+    name: {
+        preferredFamily?: Record<string, string>;
+        preferredSubfamily?: Record<string, string>;
+        fontFamily?: Record<string, string>;
+        fontSubfamily?: Record<string, string>;
+        fullName?: Record<string, string>;
+        postScriptName?: Record<string, string>;
+    };
+}
+
+/**
+ * 字体列表
+ */
+export declare interface EditorFontsList {
+    /**
+     * 返回解析为字体的列表的 Promise。
+     */
+    getAll: () => Promise<EditorFontFace[]>;
+}
+
+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 {
+    /**
+     * 显示历史记录（侧边栏或其他形式）
+     */
+    show: () => void;
+    /**
+     * 隐藏历史记录（侧边栏或其他形式）
+     */
+    hide: () => void;
+}
+
+export declare type EditorHistoryOptions = EditorFeatureConfig;
+
+/**
+ * i18n 相关设置
+ */
+export declare interface EditorI18nOptions {
+    /**
+     * 语言，默认使用浏览器当前环境中的语言
+     */
+    language?: string;
+    /**
+     * 文本方向，默认根据语言自动适配
+     */
+    direction?: 'ltr' | 'rtl';
+}
+
+export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
+
+export declare interface EditorImportOptions {
+    /**
+     * 当前文件是否正在导入中
+     * 用于初始化时判断是否需要显示导入进度
+     */
+    isImporting?: boolean;
+    /**
+     * 获取当前文件导入状态，没有contentUrl时需要显示导入进度
+     * 待导入完成后再渲染
+     */
+    getImportStatus?: () => Promise<{
+        /**
+         * 导入进度
+         */
+        progress: number;
+        /**
+         * 导入中
+         */
+        status: 'importing';
+    } | {
+        /**
+         * 导入完成
+         */
+        status: 'completed';
+        /**
+         * 导入完成后的内容URL
+         */
+        contentUrl: string;
+    } | {
+        /**
+         * 导入失败
+         */
+        status: 'failed';
+        /**
+         * 导入失败报错
+         */
+        error?: unknown;
+    }>;
+}
+
+/**
+ * 链接配置，抽象打开链接等操作
+ */
+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>;
+    /**
+     * 根据文件guid以及其他参数生成链接
+     */
+    generate?: (params: FileLinkParams) => Promise<string>;
+    /**
+     * 从文档链接中解析得到文件guid等参数
+     */
+    parse?: (url: string) => Promise<FileLinkParams | undefined>;
+    /**
+     * 生成sdk2.0内部链接
+     * 使用场景：专业表格跨表格引用
+     */
+    generateInternal?: (params: FileLinkParams) => Promise<string>;
+}
+
+/**
+ * 可上传文件
+ */
+export declare interface EditorLocalUploadableFile extends EditorBaseUploadableFile {
+    name: string;
+    size: number;
+    mime: string;
+    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;
+}
+
+/**
+ * 基础菜单项配置，所有菜单项类型都包含这些属性
+ */
+export declare interface EditorMenuBaseMenuItemConfig<TName extends string> {
+    /**
+     * 菜单项的唯一标识，用以确定配置的是哪个菜单
+     */
+    name: TName;
+    /**
+     * 菜单项类型
+     */
+    type: EditorMenuItemType;
+}
+
+/**
+ * 按钮菜单项配置
+ */
+export declare interface EditorMenuButtonMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'button';
+    /**
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
+     */
+    disabled?: boolean;
+    /**
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
+     */
+    label?: string;
+    /**
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
+     */
+    icon?: string;
+    /**
+     * 菜单项点击事件，接受一个函数，可以自定义点击事件
+     */
+    callback?: () => void;
+}
+
+/**
+ * 编辑器菜单配置类型
+ * 根据 TName 类型的不同返回不同的菜单配置类型:
+ * 1. 当 TName 是对象类型时（如 {pasteMenu: [...]})，会自动提取对象的键作为菜单名称
+ * 2. 当 TName 是字符串时，返回普通菜单项配置
+ */
+export declare type EditorMenuEntryConfig<TName extends EditorMenuName> = TName extends Record<string, EditorMenuName[]> ? EditorMenuEntryMenuItemConfig<string & keyof TName, TName[keyof TName]> : TName extends string ? EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName, never> : never;
+
+/**
+ * 子菜单入口配置
+ * TName: 菜单项名称（字符串类型）
+ * TChildName: 子菜单项名称数组类型，用于配置下一级菜单项
+ */
+export declare interface EditorMenuEntryMenuItemConfig<TName extends string, TChildName extends EditorMenuName[]> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'entry';
+    /**
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
+     */
+    disabled?: boolean;
+    /**
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
+     */
+    label?: string;
+    /**
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
+     */
+    icon?: string;
+    /**
+     * 下一级菜单配置，下一级菜单配置项和上一级相同
+     * 如果下一级仍然是 entry 类型，可以无限向下扩展
+     * 只有当 TName 是对象类型时才应有子菜单
+     */
+    children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
+}
+
+/**
+ * 菜单功能按钮配置
+ */
+export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
+    /**
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
+     */
+    label?: string;
+    /**
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     */
+    icon?: string;
+    /**
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
+     */
+    callback?: () => void;
+    /**
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
+     */
+    tooltip?: string;
+    /**
+     * 按钮在工具栏中位置，不设置则按照默认位置
+     */
+    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;
+}
+
+/**
+ * 隐藏菜单项配置
+ */
+export declare interface EditorMenuHiddenMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'hidden';
+}
+
+/**
+ * 菜单项类型
+ */
+export declare type EditorMenuItemType = 'hidden' | 'button' | 'link' | 'entry';
+
+/**
+ * 链接菜单项配置
+ */
+export declare interface EditorMenuLinkMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'link';
+    /**
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
+     */
+    disabled?: boolean;
+    /**
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
+     */
+    text?: string;
+    /**
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
+     */
+    icon?: string;
+    /**
+     * 跳转链接地址
+     */
+    url?: string;
+}
+
+/**
+ * 菜单项名称类型
+ * 可以是字符串或包含子菜单数组的对象
+ * 如: 'copy' 或 { pasteMenu: ['pasteAll', 'pasteHead', 'pasteValueOnly'] }
+ */
+export declare type EditorMenuName = string | Record<string, EditorMenuName[]>;
+
+/**
+ * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
+ * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
+ */
+export declare interface EditorMenuOptions<TName extends EditorMenuName> {
+    /**
+     * 菜单栏是否隐藏，设置为true, 则整个菜单栏不显示
+     */
+    hidden?: boolean;
+    /**
+     * 是否禁用菜单栏所有功能。设置为true，菜单栏依旧显示，但所有菜单项为灰色不可点击
+     */
+    disabled?: boolean;
+    /**
+     * 菜单栏一级菜单配置，指显示在菜单栏上的菜单项。
+     * 支持普通菜单项和嵌套菜单项
+     */
+    entries?: EditorMenuEntryConfig<TName>[];
+    /**
+     * 菜单栏功能按钮配置
+     * 更加间接的配置项
+     * 仅在 TName 为字符串类型时有效
+     */
+    features?: [TName] extends [string] ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
+    /**
+     * 自定义按钮配置
+     */
+    custom?: (EditorMenuButtonMenuItemConfig<string> | EditorMenuLinkMenuItemConfig<string>)[];
+}
+
+/**
+ * 编辑器基础模式接口
+ */
+export declare interface EditorMode {
+    /**
+     * 获取当前编辑器模式
+     */
+    getModeType: () => EditorModeType;
+    /**
+     * 设置编辑器权限模式，仅在 `standard` 模式下有效
+     * @param permission
+     */
+    setStandardRole: (standardRole: EditorStandardRole) => Promise<void>;
+    /**
+     * 获取当前编辑器权限模式，仅在 `standard` 模式下有效
+     */
+    getStandardRole: () => EditorStandardRole;
+}
+
+/**
+ * 编辑器初始化的时相关的模式配置
+ */
+export declare type EditorModeOptions = {
+    type: 'standard';
+    /**
+     * 当 mode 为 `standard` 时，可以设置当前编辑器的权限模式
+     */
+    role?: EditorStandardRole;
+} | {
+    /**
+     * 预览模式
+     */
+    type: 'preview';
+} | {
+    /**
+     * 演示模式
+     */
+    type: 'presentation';
+} | {
+    /**
+     * 历史模式
+     */
+    type: 'history';
+} | {
+    /**
+     * 嵌入模式
+     */
+    type: 'embedded';
+};
+
+/**
+ * 编辑器模式
+ * - `standard` 标准模式，会根据用户权限配置不同的功能
+ * - `preview` 预览模式，只能查看内容
+ * - `presentation` 演示模式，用作演示场景，演示模式下部分套件可以进行一些简单的编辑操作
+ * - `history` 历史模式，用作查看历史版本场景
+ */
+export declare type EditorModeType = 'standard' | 'preview' | 'presentation' | 'history' | 'embedded';
+
+/**
+ * 编辑器初始化通用参数
+ */
+export declare interface EditorOptions {
+    /**
+     * 编辑器初始化内容，可以是 string 或者 ArrayBuffer，
+     * 也可以通过异步 Promise 加载
+     */
+    content: MaybePromiseValue<string | ArrayBuffer>;
+    /**
+     * 初始化时的编辑模式，默认为 `preview`
+     */
+    mode?: EditorModeOptions;
+    /**
+     * 当前操作编辑器的用户信息
+     */
+    user?: EditorUserOptions;
+    /**
+     * 匿名用户的缺省信息
+     */
+    anonymous?: EditorAnonymousOptions;
+    /**
+     * 当前文件信息 & 配置
+     */
+    file?: EditorFileOptions;
+    /**
+     * i18n 相关设置
+     */
+    i18n?: EditorI18nOptions;
+    /**
+     * 品牌相关设置
+     */
+    brand?: EditorBrandOptions;
+    /**
+     * 编辑器内部资源请求配置
+     */
+    assets?: EditorAssetsOptions;
+    /**
+     * 编辑器链接相关配置
+     */
+    link?: EditorLinkOptions;
+    /**
+     * 嵌入对象相关配置
+     */
+    embeddedObject?: EditorEmbeddedObjectOptions;
+    /**
+     * 初始化水印配置
+     */
+    watermark?: EditorWatermarkOptions;
+    /**
+     * 编辑器打印设置
+     */
+    print?: EditorPrintOptions;
+    /**
+     * 编辑器评论设置
+     */
+    comments?: EditorCommentsOptions;
+    /**
+     * 附件设置
+     */
+    attachment?: EditorAttachmentOptions;
+    /**
+     * 导出设置
+     */
+    export?: EditorExportOptions;
+    /**
+     * 导入相关设置
+     */
+    import?: EditorImportOptions;
+    /**
+     * 解密设置
+     */
+    decryption?: EditorDecryptionOptions;
+    /**
+     * 网络请求设置
+     */
+    http?: HTTPProxy;
+    /**
+     * 编辑器 UI 相关
+     */
+    ui?: EditorUiOptions;
+    /**
+     * 编辑器工具箱设置
+     */
+    toolbox?: EditorToolboxOptions;
+    /**
+     * 编辑器历史设置
+     */
+    history?: EditorHistoryOptions;
+    /**
+     * 编辑器协作相关
+     */
+    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;
+}
+
+/**
+ * 大纲目录接口
+ */
+export declare interface EditorOutline<Content = unknown> {
+    /**
+     * 设置大纲目录是否可见
+     * @param visible 是否可见
+     */
+    setVisible: (visible: boolean) => void;
+    /**
+     * 获取目录信息
+     * @returns 目录信息
+     */
+    getContent: () => Promise<EditorOutlineItem<Content>[]>;
+    /**
+     * 添加目录信息改变时的监听器
+     * @param listener 监听器
+     * @returns 取消监听器的函数
+     */
+    addChangedListener: (listener: (content: EditorOutlineItem<Content>[]) => void) => () => void;
+    /**
+     * 跳转到指定条目对应的正文位置
+     * @param id 条目id
+     * @returns 跳转是否成功
+     */
+    goto: (id: string) => Promise<boolean>;
+}
+
+/**
+ * 大纲目录项条目
+ */
+export declare interface EditorOutlineItem<Content = unknown> {
+    /**
+     * 目录项 ID
+     */
+    id: string;
+    /**
+     * 目录项层级
+     */
+    level: number;
+    /**
+     * 目录项内容
+     */
+    content: Content;
+}
+
+/**
+ * 大纲目录初始化参数，
+ * 用于配置大纲目录的行为和外观。
+ */
+export declare interface EditorOutlineOptions extends EditorLogicFeatureConfig {
+    /**
+     * 初始化编辑器时是否显示大纲目录，
+     * 默认为 false。
+     */
+    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 {
+    /**
+     * 文件大小
+     */
+    size: number;
+    /**
+     * 文件名
+     */
+    name: string;
+    /**
+     * 文件路径，仅显示有意义的相对路径，可用在上传文件夹和识别文件使用
+     */
+    path?: string;
+    /**
+     * 文件类型，mime-type
+     */
+    type: string;
+    /**
+     * 文件原始数据，用于给上传控件使用
+     */
+    raw: File;
+}
+
+export declare interface EditorPresentation {
+    /**
+     * 进入演示模式
+     */
+    start: () => Promise<void>;
+    /**
+     * 退出演示模式
+     */
+    quit: () => Promise<void>;
+}
+
+/**
+ * 编辑器打印设置
+ */
+export declare interface EditorPrintOptions extends EditorFeatureConfig {
+    /**
+     * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
+     * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
+     */
+    fallback?: {
+        message: string;
+    };
+}
+
+/**
+ * 远程文件上传
+ */
+export declare interface EditorRemoteUploadableFile extends EditorBaseUploadableFile {
+    src: string;
+    name?: never;
+    size?: never;
+    mime?: never;
+    raw?: never;
+}
+
+export declare interface EditorRenderOptions {
+    /**
+     * 用于定位的锚点
+     */
+    hash?: string;
+}
+
+/**
+ * 编辑器通用接口
+ */
+export declare abstract class EditorSDK {
+    protected options: EditorOptions;
+    constructor(options: EditorOptions);
+    /**
+     * 初始化编辑器、加载插件等操作。
+     */
+    abstract init(): Promise<void>;
+    /**
+     * 销毁编辑器
+     */
+    abstract destroy(): Promise<void>;
+    /**
+     * 将编辑器挂载到指定的根节点上，并渲染，
+     * mount 应该在 init 之后调用。
+     * @param root
+     */
+    abstract mount(root: HTMLElement): Promise<void>;
+    /**
+     * 从根节点卸载编辑器，对应 `mount` 操作
+     */
+    abstract unmount(): Promise<void>;
+    /**
+     * 编辑器内容相关接口
+     */
+    abstract get content(): EditorContent;
+    /**
+     * 编辑器模式相关接口
+     */
+    abstract get mode(): EditorMode;
+    /**
+     * 编辑器评论相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get comments(): EditorComments | undefined;
+    /**
+     * 编辑器协作者相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get collaborators(): EditorCollaborators | undefined;
+    /**
+     * 编辑器历史相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    abstract get history(): EditorHistory | undefined;
+    /**
+     * 编辑器版本相关接口
+     * 部分环境不存在，如离线客户端
+     */
+    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;
+}
+
+/**
+ * 编辑器在 `standard` 模式下的权限模式
+ * - `editor` 编辑模式
+ * - `viewer` 阅读模式
+ * - `reviewer` 评论模式
+ */
+export declare type EditorStandardRole = 'editor' | 'viewer' | 'reviewer';
+
+/**
+ * 上传任务回调
+ */
+export declare interface EditorTaskCallbacks {
+    /**
+     * 上传进度回调
+     * @param taskId
+     * @param loaded
+     * @param total
+     * @param progress
+     * @param data
+     * @returns
+     */
+    onProgress?: (taskId: string, loaded: number, total: number, progress: number, data?: unknown) => void;
+    /**
+     * 上传错误回调
+     * @param taskId
+     * @param error
+     * @returns
+     */
+    onError?: (taskId: string, error: Error) => void;
+    /**
+     * 上传暂停回调
+     * @param taskId
+     * @returns
+     */
+    onPause?: (taskId: string) => void;
+    /**
+     * 上传取消
+     * @param taskId
+     * @returns
+     */
+    onAbort?: (taskId: string) => void;
+    /**
+     * 上传恢复
+     * @param taskId
+     * @returns
+     */
+    onResume?: (taskId: string) => void;
+    /**
+     * 上传完成回调
+     * @param taskId
+     * @param status
+     * @param data
+     * @returns
+     */
+    onEnd?: (taskId: string, status: 'Error' | 'Finished' | 'Canceled', data: unknown) => void;
+}
+
+/**
+ * 文本格式接口，
+ * 包括设置、读取选区内文本的 BIUS、family、大小、颜色等
+ */
+export declare interface EditorText<Color = string, TRangeValue = unknown> {
+    /**
+     * 获取当前选区或指定选区内的文本格式状态
+     */
+    get: (range?: TRangeValue) => Partial<EditorTextFormat<Color>>;
+    /**
+     * 将文本的格式应用到当前选区或指定选区上，
+     * 传入的非空字段会覆盖对应的属性，其他没有传入的属性会保持不变。
+     * @param range
+     * @param format
+     * @returns
+     */
+    apply: (format: Partial<EditorTextFormat<Color>>, range?: TRangeValue) => Partial<EditorTextFormat<Color>>;
+    /**
+     * 清空当前选区或指定选区内文本的格式，将文本格式恢复到默认状态
+     * @param range
+     * @returns
+     */
+    clear: (range: TRangeValue) => void;
+}
+
+/**
+ * 文本格式状态
+ */
+export declare interface EditorTextFormat<Color = string> {
+    /**
+     * 粗体
+     */
+    bold: boolean;
+    /**
+     * 斜体
+     */
+    italic: boolean;
+    /**
+     * 下划线
+     */
+    underline: boolean;
+    /**
+     * 删除线
+     */
+    strike: boolean;
+    /**
+     * 文本颜色
+     */
+    color: Color;
+    /**
+     * 文本背景高亮颜色
+     */
+    highlight: Color;
+    /**
+     * 文本大小
+     */
+    size: number | string;
+    /**
+     * 文本名称
+     */
+    family: string;
+}
+
+/**
+ * 文本格式初始化选项
+ */
+export declare interface EditorTextOptions<Color = string> {
+    /**
+     * 当前编辑器默认的文本格式
+     */
+    defaultFormat?: Partial<EditorTextFormat<Color>>;
+}
+
+/**
+ * 工具栏功能按钮配置(包括内置按钮和自定义按钮)
+ */
+export declare interface EditorToolbarFeatureButton<TName extends string> extends EditorFeatureConfig {
+    /**
+     * 按钮的唯一标识，用以确定配置的是哪个按钮。
+     */
+    name?: TName;
+    /**
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
+     */
+    label?: string;
+    /**
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     */
+    icon?: string;
+    /**
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
+     */
+    callback?: () => void;
+    /**
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
+     */
+    tooltip?: string;
+    /**
+     * 按钮在工具栏中位置，不设置则按照默认位置
+     */
+    index?: number;
+}
+
+/**
+ * 工具栏内置功能按钮配置
+ */
+export declare type EditorToolbarFeatureButtonConfig<TName extends string> = {
+    [key in TName]?: EditorToolbarFeatureButton<key>;
+};
+
+/**
+ * 工具栏相关设置，可以控制工具栏的显示内容
+ */
+export declare interface EditorToolbarOptions<TName extends string> {
+    /**
+     * 控制工具栏显隐状态
+     */
+    hidden?: boolean;
+    /**
+     * 是否禁用工具栏所有功能
+     */
+    disabled?: boolean;
+    /**
+     * 现有按钮的功能配置
+     */
+    features?: EditorToolbarFeatureButtonConfig<TName>;
+    /**
+     * 自定义按钮
+     */
+    custom?: EditorToolbarFeatureButtonConfig<string>;
+    /**
+     * 工具栏挂载的容器dom，配置后则挂载到指定的容器上
+     *
+     * 如果不配置则按照套件的默认方式挂载。
+     */
+    container?: HTMLElement;
+}
+
+/**
+ * 编辑器工具箱配置选项接口
+ */
+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 | undefined>;
+    };
+    notification?: {
+        /**
+         * 渲染通知条
+         */
+        render?: (params: RenderNotificationProps) => void;
+        /**
+         * 是否禁用通知条
+         */
+        disabled?: boolean;
+    };
+    /**
+     * 用户名片
+     */
+    userCard?: {
+        /**
+         * 需要排除的用户卡片字段（不会在用户卡片中展示）
+         */
+        excludeFields?: string[];
+        /**
+         * 渲染用户卡片
+         */
+        render?: (params: RenderUserCardProps) => RenderUserCardResult;
+        /**
+         * 是否禁用用户卡片
+         * jd需要禁用
+         */
+        disabled?: boolean;
+    };
+    /**
+     * 登录提示
+     */
+    loginNotice?: {
+        /**
+         * 显示登录提示
+         */
+        show?: () => void;
+    };
+    /**
+     * toast
+     */
+    toast?: {
+        /**
+         * 显示自定义toast
+         */
+        show?: (options: ShowToastOptions) => void;
+        /**
+         * 是否禁用toast
+         */
+        disabled?: boolean;
+        /**
+         * 自定义toast提示文本配置
+         */
+        tips?: ToastTipsConfig;
+    };
+    /**
+     * confirm
+     */
+    confirm?: {
+        /**
+         * 显示自定义confirm
+         */
+        show?: (options: ShowConfirmOptions) => void;
+        /**
+         * 是否禁用confirm
+         */
+        disabled?: boolean;
+    };
+    /**
+     * 全屏配置
+     */
+    fullscreen?: EditorFeatureConfig;
+    /**
+     * 演示模式配置
+     */
+    presentation?: EditorFeatureConfig;
+    /**
+     * 帮助中心配置
+     */
+    helpCenter?: EditorFeatureConfig;
+    /**
+     * 新功能提醒相关配置
+     */
+    newFeature?: {
+        /**
+         * 是否不展示新功能提醒(包括任何形式的)
+         */
+        hidden?: boolean;
+    };
+    /**
+     * 图片查看器配置
+     */
+    imageViewer?: {
+        /**
+         * 右键菜单配置
+         */
+        contextMenu?: EditorMenuOptions<'copy' | 'download'>;
+        /**
+         * 操作配置
+         */
+        operations?: {
+            /**
+             * 下载图片
+             */
+            download: EditorFeatureConfig;
+        };
+    };
+}
+
+export declare type EditorUploadableFile = EditorLocalUploadableFile | EditorRemoteUploadableFile;
+
+/**
+ * 文件开始上传入参
+ */
+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;
+}
+
+/**
+ * 操作当前编辑器的用户信息
+ */
+export declare interface EditorUserOptions {
+    /**
+     * 用户 ID，用于标识用户
+     */
+    uid: string;
+    /**
+     * 用户名
+     */
+    name: string;
+    /**
+     * 用户头像
+     */
+    avatar?: string;
+    /**
+     * 用户默认头像，当用户未设置头像时显示
+     */
+    defaultAvatar?: string;
+}
+
+export declare interface EditorVersion {
+    /**
+     * 保存版本
+     * @param name 版本名称
+     */
+    createRevision: (name?: string) => void;
+    /**
+     * 显示版本(侧边栏或其他形式)
+     * 区别于历史侧边栏，在应用表格里表现为打开历史侧边栏切换到版本 tab
+     */
+    show?: () => void;
+    /**
+     * 隐藏版本(侧边栏或其他形式)
+     * 区别于历史侧边栏，在应用表格里表现为打开历史侧边栏切换到版本 tab
+     */
+    hide?: () => void;
+}
+
+export declare type EditorVersionOptions = EditorFeatureConfig;
+
+/**
+ * 编辑器外部水印信息
+ */
+export declare interface EditorWatermarkOptions {
+    /**
+     * 获取用作初始化使用的默认水印
+     */
+    getWatermark?: () => MaybePromiseValue<EditorWatermarkResource | null>;
+    /**
+     * 获取文件导出水印
+     * @param exportType 导出类型 图片/pdf/纯图pdf
+     */
+    getExportWatermark?: (exportType: 'image' | 'pdf' | 'image_pdf') => Promise<string[] | undefined>;
+    /**
+     * 是否必须，如果为 true，编辑器将在初始化时强制渲染水印，
+     * 水印配置信息加载失败将导致编辑器初始化失败
+     */
+    required?: boolean;
+}
+
+export declare type EditorWatermarkResource = {
+    type: 'data-url';
+    url: string;
+} | {
+    type: 'object-url';
+    url: string;
+};
+
+export declare interface FileLinkParams {
+    /**
+     * 文件guid
+     */
+    fileGuid: string;
+    /**
+     * 文件类型
+     */
+    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 interface FormFeatureOptions extends EditorFeaturesOptions {
+    /**
+     * 忽略功能试用（即能使用所有功能），私部环境为 true，其他环境忽略
+     */
+    ignoreTrial?: boolean;
+}
+
+/**
+ * 链接相关配置
+ */
+export declare interface FormLinkOptions extends EditorLinkOptions {
+    /**
+     * 生成表单填写页链接时不使用后缀（小尾巴），SDK环境为 true，其他环境忽略
+     */
+    ignoreTail?: boolean;
+}
+
+export declare interface FormSDKOptions extends EditorOptions {
+    /**
+     * 表单类型：普通表单；表格视图表单；测验表单。
+     * 未指定时默认为普通表单
+     */
+    formType?: FormType;
+    /**
+     * 表单发布相关设置
+     */
+    publish?: PublishOptions;
+    /**
+     * UI 相关配置
+     */
+    ui?: FormUIOptions;
+    /**
+     * 链接相关配置
+     */
+    link?: FormLinkOptions;
+    /**
+     * 功能点相关配置
+     */
+    features?: FormFeatureOptions;
+    /**
+     * 关联到专业表格
+     */
+    linkToSheet?: LinkSheetOptions;
+    /**
+     * 关联到应用表格
+     */
+    linkToTable?: LinkTableOptions;
+}
+
+export declare type FormType = 'normal' | 'table' | 'quiz';
+
+/**
+ * UI 相关配置
+ */
+export declare interface FormUIOptions extends EditorUiOptions {
+    /**
+     * 编辑页相关UI配置
+     */
+    editPage?: {
+        /**
+         * 搜索文件时不支持「空间」，没有「空间」概念的环境设置为 true（如SDK）
+         */
+        noSpace?: boolean;
+        /**
+         * 隐藏通知相关的表单设置（填写提醒、订阅更新）
+         */
+        hiddenNotification?: boolean;
+    };
+    /**
+     * 填写页相关UI配置
+     */
+    fillPage?: {
+        /**
+         * 隐藏表单填写页的「下载App」按钮，除 SaaS 环境外都为 true，SaaS 环境可忽略
+         */
+        hiddenDownloadApp?: boolean;
+        /**
+         * 填写页未符合特定填写条件时不展示登录按钮，SDK为 true
+         */
+        hiddenFillLogin?: boolean;
+    };
+}
+
+/**
+ * 引导数据
+ */
+export declare interface GuideData {
+    type: number;
+    id: number;
+}
+
+/**
+ * 请求、响应头
+ */
+export declare type HTTPHeaders = Record<string, string | number | boolean | undefined>;
+
+/**
+ * 请求方法
+ */
+export declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
+
+/**
+ * HTTP 代理，用于抽象 HTTP 请求，
+ * 将请求代理编辑器外部
+ */
+export declare interface HTTPProxy {
+    /**
+     * 发送请求，如果需要做请求、响应拦截，需要在 proxy.interceptors 中实现，
+     * 套件内使用 proxy 发送请求的方式应该为类似如下方式:
+     * ```ts
+     * const raw = await proxy.request(proxy.interceptors?.request?.intercept(requestConfig) ?? requestConfig);
+     * const response = proxy.interceptors?.response?.intercept(raw) ?? raw;
+     * ```
+     *
+     * 套件内如果需要通过其他方式发送请求，比如通过浏览器的 Image API 加载，可以使用 proxy.interceptors?.request?.intercept(requestConfig) 处理请求配置
+     * @param config
+     * @returns
+     */
+    request: <D = unknown, T = unknown>(config: HTTPRequestConfig<D>) => Promise<HTTPResponse<T>>;
+    /**
+     * 请求、响应拦截器，
+     *
+     */
+    interceptors?: {
+        request?: {
+            /**
+             * 请求拦截器，传入请求配置，返回处理后的请求配置
+             * @param requestConfig 请求配置
+             * @returns
+             */
+            intercept: <D = unknown>(requestConfig: HTTPRequestConfig<D>) => HTTPRequestConfig<D>;
+        };
+        response?: {
+            /**
+             * 响应拦截器，传入响应，返回处理后的响应
+             * @param response
+             * @returns
+             */
+            intercept: <T = unknown>(response: HTTPResponse<T>) => HTTPResponse<T>;
+        };
+    };
+    /**
+     * 创建一个新的 HTTP 代理，用于为不同请求场景创建不同的代理
+     * @param id
+     * @returns
+     */
+    create: (id: string) => Promise<HTTPProxy>;
+}
+
+/**
+ * 请求配置
+ */
+export declare interface HTTPRequestConfig<Data = unknown> {
+    /**
+     * 请求地址
+     */
+    url: string;
+    /**
+     * 请求方法
+     */
+    method?: HTTPMethod;
+    /**
+     * 请求携带数据，主要是 POST、PUT、PATCH 等方法的请求数据
+     */
+    data?: Data;
+    /**
+     * 期望的响应数据类型
+     */
+    responseType?: HTTPResponseType;
+    /**
+     * 请求头
+     */
+    headers?: HTTPHeaders;
+}
+
+/**
+ * 响应数据
+ */
+export declare interface HTTPResponse<Data = unknown> {
+    /**
+     * 响应数据 body
+     */
+    data: Data;
+    /**
+     * 响应状态码
+     */
+    status: number;
+    /**
+     * 响应头
+     */
+    headers: HTTPHeaders;
+}
+
+/**
+ * 请求返回类型
+ */
+export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+
+/**
+ * 关联到专业表格相关配置
+ */
+export declare interface LinkSheetOptions {
+    /**
+     * 功能是否可用
+     * @returns
+     */
+    isEnabled: () => boolean;
+    /**
+     * 创建待关联的表格文件
+     * @param name 文件名称
+     * @param content 文件的初始内容
+     * @returns
+     */
+    createFile: (name: string, content: string) => Promise<EditorFileOptions>;
+    /**
+     * 关联到表格
+     * @param formGuid 表单 guid
+     * @param spreadGuid 关联表格 guid
+     * @param sheetGuid 表格所在工作表 guid
+     * @returns
+     */
+    link: (formGuid: string, spreadGuid: string, sheetGuid: string) => Promise<void>;
+    /**
+     * 取消关联表格（同时取消双侧关联：表单->表格， 表格->表单）
+     * @param formGuid 表单 guid
+     * @returns
+     */
+    unlink: (formGuid: string) => Promise<void>;
+}
+
+/**
+ * 关联到应用表格相关配置
+ */
+export declare interface LinkTableOptions {
+    /**
+     * 和应用表格关联后，表单编辑页要实时监听应用表格字段的增删改，这些改动通过socket消息传递。
+     */
+    socket?: EditorSocket;
+    /**
+     * 功能是否可用
+     * @returns
+     */
+    isEnabled: () => boolean;
+    /**
+     * 创建关联应用表格
+     * @param formGuid 表单 guid
+     * @param transformedPublishedFormContent 转换后的已发布表单的内容
+     * @returns
+     */
+    link: (formGuid: string, transformedPublishedFormContent: string) => Promise<{
+        tablesGuid: string;
+        tableGuid: string;
+    }>;
+    /**
+     * 取消关联应用表格
+     * @param formGuid 表单 guid
+     * @returns
+     */
+    unlink: (formGuid: string) => Promise<void>;
+}
+
+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区域宽度
+     */
+    width?: number;
+    /**
+     * mention区域高度
+     */
+    height?: number;
+    /**
+     * mention区域左上角距离页面左边的距离
+     */
+    left?: number;
+    /**
+     * mention区域左上角距离页面顶部的距离
+     */
+    top?: number;
+}
+
+/**
+ * 升级弹窗类型
+ * 个人版或企业版
+ */
+export declare type OpenType = 'personal' | 'enterprise' | 'pendingOrder';
+
+export declare interface OperationToastConfig {
+    /**
+     * 成功提示文本
+     */
+    success?: string;
+    /**
+     * 失败提示文本
+     */
+    failed?: string;
+    /**
+     * 权限不足提示文本
+     * 桌面客户端安全模式下需要提供【当前账号未获得此项能力授权。】
+     */
+    noPermission?: string;
+}
+
+/**
+ * 表单发布相关设置
+ */
+export declare interface PublishOptions {
+    /**
+     * 新建表单时将表单设置成默认“仅企业用户可填”，私部环境为 true，其他环境忽略
+     */
+    enterpriseDefault?: boolean;
+    /**
+     * 不支持「仅企业用户可填」，没有企业概念的环境设置为 true（如SDK）
+     */
+    noEnterprise?: boolean;
+}
+
+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' | 'right_bottom' | '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 ShortcutConfig {
+    /**
+     * 快捷键，例如保存快捷键windows为ctrl+s, mac系统则为meta+s
+     * 如果不想区分系统则为mod+s
+     */
+    key: string;
+    /**
+     * 快捷键回调
+     */
+    callback: () => 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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 工具箱工具项接口
+ */
+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 declare interface UnauthedFormSDK {
+    on: (event: string, handler: (payload: any) => any) => any;
+    once: (event: string, handler: (payload: any) => any) => any;
+    off: (event: string, handler: (payload: any) => any) => any;
+    emit: (...args: any) => void;
+    removeAllListeners: () => void;
+    [K: string]: any;
+}
+
+export declare interface UnauthedFormSDKOption {
+    container: HTMLElement;
+    filePicker?: EditorAttachmentOptions['picker'];
+    fileUploader?: EditorAttachmentOptions['uploader'];
+    /** 填写页无图片/附件的预览、下载等操作，也不存在权限判断，仅有对文件类型的限制，故简化配置项 */
+    uploadLimitations?: Pick<EditorAttachmentOptions, 'image' | 'attachment' | 'video' | 'audio' | 'cloudFile'>;
+    http?: HTTPProxy;
+    ui?: Pick<FormUIOptions, 'fillPage'>;
+    generateUrl?: EditorLinkOptions['generate'];
+    parseUrl?: EditorLinkOptions['parse'];
+    /** 设置微信分享卡片样式，SaaS的填写页需要传入，其他页面不需要 */
+    updateWechatSnippet?: (snippet: {
+        title: string;
+        link: string;
+        desc: string;
+        imgUrl: string;
+    }) => void;
+}
+
+export { }