@officesdk/editor-sdk-core 0.0.0-10 → 0.0.0-12

package/types/docs.d.ts

@@ -0,0 +1,1581 @@
+export declare abstract class AbstractedDocsSDK extends EditorSDK {
+    /**
+     * 文档准备就绪
+     */
+    abstract ready(): Promise<void>;
+    /**
+     * 文档选区接口
+     */
+    abstract get selection(): DocsSelection;
+}
+
+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 interface DocsInfoOptions {
+    views?: {
+        count?: number;
+    };
+    created?: {
+        time?: number;
+        author?: string;
+    };
+    id: string;
+    name: string;
+}
+
+/**
+ * 区域（Range）
+ * 区域对象，表示文档中的一个连续区域，每个 Range 对象包含起始字符位置和终止字符位置。
+ */
+/**
+ * 文档区域对象，
+ * 用于表示文档中的一个连续区域，
+ * 每个选区值包含了起始位置和结束位置信息的字符串。
+ */
+export declare interface DocsRange {
+    /**
+     * 区域的开始位置，
+     * 当文档发生变化后，区域的标识可能会失效。
+     */
+    readonly start: string;
+    /**
+     * 区域的结束位置，
+     * 当文档发生变化后，区域的标识可能会失效。
+     */
+    readonly end: string;
+    /**
+     * 是否为光标。
+     */
+    readonly isCaret: boolean;
+    /**
+     * 获取该区域对应的纯文本信息。
+     * @returns
+     */
+    getText: () => string;
+    /**
+     * 将区域中的内容以 HTML 格式返回。
+     * @returns
+     */
+    getHtml: () => string;
+    /**
+     * 将区域内的文本设置为指定的文本，
+     * 如果文本为空，则清空区域内的文本。
+     * 如果区域为
+     * @param text
+     */
+    setText: (text: string) => void;
+    /**
+     * 将区域内的文本设置为指定的 HTML 内容，
+     * 如果内容为空，则清空区域内的内容。
+     * 如果区域为光标，则会将光标位置的文本替换为指定的 HTML 格式。
+     * @param html
+     */
+    setHtml: (html: string) => void;
+    /**
+     * 获取选区在当前屏幕上的位置信息
+     * @returns
+     */
+    getBounding: () => DocsRangeBounding | null;
+}
+
+/**
+ * 记录区域在屏幕上的位置信息，
+ * 包含了区域的四个边界值，以及开始和结束位置。
+ * 因为选区是由多个矩形区域组成的，
+ * 所以这里的位置信息是一个矩形区域的边界值。
+ */
+export declare interface DocsRangeBounding {
+    /**
+     * 区域的左边界值，
+     * 代表区域的最左边的 X 坐标，
+     * 也就是区域的最左边的矩形区域的左边界值。
+     */
+    top: number;
+    /**
+     * 区域的上边界值，
+     * 代表区域的最上边的 Y 坐标，
+     * 也就是区域的最上边的矩形区域的上边界值。
+     */
+    right: number;
+    /**
+     * 区域的右边界值，
+     * 代表区域的最右边的 X 坐标，
+     * 也就是区域的最右边的矩形区域的右边界值。
+     */
+    bottom: number;
+    /**
+     * 区域的下边界值，
+     * 代表区域的最下边的 Y 坐标，
+     * 也就是区域的最下边的矩形区域的下边界值。
+     */
+    left: number;
+    /**
+     * 第一行的开始 X 坐标，
+     */
+    start: number;
+    /**
+     * 最后一行的结束 X 坐标，
+     */
+    end: number;
+}
+
+/**
+ * 区域值，
+ * 包含了区域的开始位置和结束位置。
+ */
+export declare interface DocsRangeValue {
+    /**
+     * 开始位置
+     */
+    start: string;
+    /**
+     * 结束位置
+     */
+    end: string;
+}
+
+export declare interface DocsSDKOptions extends EditorOptions {
+    /**
+     * 文档信息配置
+     */
+    info?: DocsInfoOptions;
+}
+
+/**
+ * 选区（Selection）
+ * 表示窗口中的当前选定内容。
+ * 选定内容表示文档中的选定（或突出显示）区域，或者代表插入点（如果未选择文档中的任何内容）。
+ */
+export declare interface DocsSelection {
+    /**
+     * 获取选区的区域范围，
+     * 如果没有指定范围，则返回当前选区的范围。
+     * 如果指定了范围，则返回指定范围的选区。
+     * 如果选区不存在，则返回 null。
+     * @returns
+     */
+    getRange: (value?: DocsRangeValue) => DocsRange | null;
+    /**
+     * 设置选区的区域范围，
+     * 设置后，选区会自动选中指定范围。
+     * 如果设置为 null，则清空选区。
+     * 注意：设置取消之前需要确认该选区是否属于当前页面。
+     * @param value
+     */
+    setRange: (value: DocsRangeValue | null) => void;
+    /**
+     * 添加选区变化监听器，当选区发生变化时，会触发回调。
+     * @param listener
+     * @returns
+     */
+    addRangeListener: (listener: (value: DocsRangeValue | null) => void) => void;
+    /**
+     * 获取文档全部选区范围。
+     * @returns
+     */
+    getWholeRange: () => DocsRange;
+    /**
+     * 向当前选区位置插入文本，
+     * 返回插入后当前选区位置
+     * @param text
+     * @returns
+     */
+    insertText: (text: string) => DocsRangeValue;
+    /**
+     * 向当前选区位置插入 HTML 内容，
+     * 返回插入后当前选区位置
+     * @param html
+     */
+    insertHtml: (html: string) => DocsRangeValue;
+}
+
+/**
+ * 匿名用户信息
+ * 当前用户信息未知时的缺省值
+ */
+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;
+    }) => Promise<string>;
+    /**
+     * 裁切图片的方法
+     * @param imageUrl 图片的 URL
+     * @param cropOptions 裁切配置，例如宽度、高度和起始点
+     * @returns 裁切后的图片 URL
+     */
+    crop: (imageUrl: string, cropOptions: {
+        x?: number;
+        y?: number;
+        w: number;
+        h: number;
+        g?: EditorImageCropPoint;
+    }) => Promise<string>;
+}
+
+export declare interface EditorAssetsResolver {
+    /**
+     * 将资源文件 ID 转换为 URL 的方法
+     * @param assetId 资源文件 ID
+     * @returns 转换后的资源 URL ，如果无法转换则返回 null
+     */
+    resolveUrl: (assetId: string) => Promise<string | null>;
+    /**
+     * 从 URL 中解析资源文件 ID 的方法
+     * @param url 资源 URL
+     * @returns 解析出的资源文件 ID
+     */
+    parseId: (url: string) => Promise<string | null>;
+    /**
+     * 检查资源文件 ID 对应的文件是否准备就绪，
+     * 在部分环境中，资源文件需要异步导入，在编辑器加载的时候可能还未准备就绪
+     * @param assetId 资源文件 ID
+     * @returns
+     */
+    checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
+}
+
+/**
+ * 编辑器附件限制配置,sdk中会使用在不同的场景下使用不同的限制规则组合
+ */
+export declare interface EditorAttachmentLimitationOptions {
+    /**
+     * 检查附件大小的规则
+     * @param file
+     * @returns
+     */
+    checkFile: (params: EditorAttachmentLimitationOptionsCheckFunctionParams) => Promise<{
+        limited: true;
+        message: string;
+    } | {
+        limited: false;
+    }>;
+}
+
+/**
+ * 编辑器附件限制配置检查函数参数
+ */
+export declare interface EditorAttachmentLimitationOptionsCheckFunctionParams {
+    /**
+     * 文件名称，带后缀名
+     */
+    name: string;
+    /**
+     * 文件大小，单位为Byte
+     */
+    size: number;
+    /**
+     * 文件的mime类型，例如image/jpeg、application/vnd.ms-excel等
+     */
+    mime?: string;
+}
+
+/**
+ * 编辑器附件限制配置
+ * @deprecated 使用limitations代替
+ */
+export declare interface EditorAttachmentMaxSizeOptions {
+    /**
+     * 图片大小上限值，单位为Byte
+     * 设置为Infinity时表示不限制图片大小
+     */
+    value?: number;
+    /**
+     * 超限警告相关配置
+     */
+    warning?: {
+        /**
+         * 超限警告文本
+         */
+        text?: string;
+    };
+}
+
+/**
+ * 编辑器附件信息
+ */
+export declare interface EditorAttachmentOptions {
+    uploader: AbstractedEditorFileUploader;
+    download: (url: string) => void;
+    /**
+     * 图片附件相关配置
+     */
+    image?: {
+        /**
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
+         */
+        maxSize?: EditorAttachmentMaxSizeOptions;
+        /**
+         * 支持的图片格式列表，例如jpg,png等
+         */
+        supportTypes?: string[];
+        /**
+         * 图片附件的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+    };
+    /**
+     * 其他附件相关配置
+     */
+    attachment?: {
+        /**
+         * 图片大小上限相关配置
+         * @deprecated 使用limitations代替
+         */
+        maxSize?: EditorAttachmentMaxSizeOptions;
+        /**
+         * 支持的附件格式列表，例如doc,docx等
+         */
+        supportTypes?: string[];
+        /**
+         * 附件的限制配置
+         */
+        limitations?: EditorAttachmentLimitationOptions;
+    };
+}
+
+/**
+ * 基础文件属性
+ */
+export declare interface EditorBaseUploadableFile {
+    secretly?: boolean;
+    bucket: 'images' | 'attachments';
+    encrypt: string;
+    fileGuid: string;
+}
+
+/**
+ * 品牌相关设置，
+ * 用于在套件中展示品牌外露信息
+ */
+export declare interface EditorBrandOptions {
+    /**
+     * 需要显示在品牌展示位的内容，按数组顺序显示
+     */
+    content: Array<{
+        type: 'image';
+        src: string;
+    } | {
+        type: 'text';
+        content: string;
+        color?: string;
+    }>;
+    /**
+     * 品牌展示位的布局信息
+     */
+    layout: {
+        width: string;
+        height: string;
+    };
+}
+
+/**
+ * 单条评论数据
+ */
+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>;
+}
+
+/**
+ * 编辑器评论初始化配置
+ */
+export declare interface EditorCommentsOptions {
+    /**
+     * 评论作者信息，如果这里的信息为空，将会使用 user 信息
+     */
+    author?: {
+        /**
+         * 评论作者 ID
+         */
+        id: string;
+        /**
+         * 评论作者信息
+         */
+        name: string;
+        /**
+         * 评论作者头像
+         */
+        avatar?: string;
+    };
+    /**
+     * 显示的视图配置
+     */
+    view?: {
+        /**
+         * 评论显示模式，
+         * none: 不显示评论，默认值。
+         * card: 评论以卡片形式显示。
+         */
+        mode: 'none' | 'card';
+    };
+}
+
+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 EditorContextMenuEntryButton<TName extends string> = EditorMenuEntryButton<TName>;
+
+/**
+ * 右键菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
+ * 右键菜单栏一级菜单指点击右键弹出菜单时的菜单项
+ */
+export declare type EditorContextMenuEntryConfig<TName extends string> = EditorMenuEntryConfig<TName>;
+
+/**
+ * 右键菜单栏功能按钮配置
+ */
+export declare type EditorContextMenuFeatureButton<TName extends string> = EditorMenuFeatureButton<TName>;
+
+/**
+ * 右键菜单栏按钮配置
+ */
+export declare type EditorContextMenuFeatureButtonConfig<TName extends string> = EditorMenuFeatureButtonConfig<TName>;
+
+/**
+ * 右键菜单栏相关配置
+ * 右键菜单栏是指的编辑器中点击右键弹出的菜单栏。目前等于菜单栏配置，可扩展
+ */
+export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
+
+export declare interface EditorDelta {
+    compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
+    transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
+    stringify: () => string;
+    length: number;
+}
+
+/**
+ * 编辑器嵌入对象
+ */
+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 {
+    /**
+     * 可导出类型
+     * @description
+     */
+    supportedTypes?: string[];
+    /**
+     * 导出文件
+     * @description
+     */
+    exportFile: (type: string) => Promise<void>;
+}
+
+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;
+}
+
+/**
+ * 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 EditorLinkOptions {
+    /**
+     * 打开链接，如果取消了打开链接操作，返回 false
+     * @param url
+     * @param target
+     * @returns
+     */
+    open: (url: string, target: string) => Promise<boolean>;
+}
+
+/**
+ * 可上传文件
+ */
+export declare interface EditorLocalUploadableFile extends EditorBaseUploadableFile {
+    name: string;
+    size: number;
+    mime: string;
+    raw: File;
+}
+
+/**
+ * 菜单栏自定义按钮配置
+ */
+export declare type EditorMenuCustomButton = {
+    /**
+     * 按钮名称
+     */
+    name: string;
+    /**
+     * 链接
+     */
+    type: 'link';
+    /**
+     * 按钮文本
+     */
+    text: string;
+    /**
+     * 链接地址
+     */
+    url: string;
+} | {
+    /**
+     * 按钮名称
+     */
+    name: string;
+    /**
+     * 按钮，点击后触发 callback 回调
+     */
+    type: 'button';
+    /**
+     * 按钮文本
+     */
+    label: string;
+    /**
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     */
+    icon?: string;
+    /**
+     * 按钮点击事件
+     */
+    callback: () => void;
+};
+
+/**
+ * 菜单栏二级以下的菜单入口
+ */
+export declare interface EditorMenuEntryButton<TName extends string> {
+    type: 'entry';
+    /**
+     * 菜单名称
+     */
+    name: string;
+    /**
+     * 菜单图标
+     */
+    icon?: string;
+    /**
+     * 下一级子菜单
+     */
+    children?: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
+}
+
+/**
+ * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
+ * 一级菜单在鼠标悬停时展示二级列表
+ */
+export declare interface EditorMenuEntryConfig<TName extends string> {
+    /**
+     * 一级菜单名称
+     */
+    name: string;
+    /**
+     * 二级菜单定义，定一个二维数组，用于定义二级菜单的结构，
+     * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
+     * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
+     */
+    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
+    /**
+     * 是否隐藏一级菜单
+     */
+    type?: 'hidden';
+}
+
+/**
+ * 菜单栏功能按钮配置
+ */
+export declare type EditorMenuFeatureButton<TName extends string> = {
+    /**
+     * 隐藏按钮，用作在需要隐藏菜单栏时定义
+     */
+    type: 'hidden';
+    /**
+     * 按钮名称
+     */
+    name: TName;
+} | {
+    type: 'button';
+    /**
+     * 按钮名称
+     */
+    name: TName;
+    /**
+     * 按钮标签（显示文本）
+     */
+    label: string;
+    /**
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     */
+    icon?: string;
+};
+
+/**
+ * 菜单栏按钮配置
+ */
+export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
+
+/**
+ * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
+ * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
+ */
+export declare interface EditorMenuOptions<TName extends string> {
+    /**
+     * 菜单栏是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 是否禁用菜单栏所有功能
+     */
+    disabled?: boolean;
+    /**
+     * 菜单栏一级菜单配置
+     */
+    entries?: EditorMenuEntryConfig<TName>[];
+    /**
+     * 菜单栏功能按钮配置
+     */
+    features?: Partial<EditorMenuFeatureButtonConfig<TName>>;
+    /**
+     * 自定义按钮配置
+     */
+    custom?: EditorMenuCustomButton[];
+}
+
+/**
+ * 编辑器基础模式接口
+ */
+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';
+};
+
+/**
+ * 编辑器模式
+ * - `standard` 标准模式，会根据用户权限配置不同的功能
+ * - `preview` 预览模式，只能查看内容
+ * - `presentation` 演示模式，用作演示场景，演示模式下部分套件可以进行一些简单的编辑操作
+ */
+export declare type EditorModeType = 'standard' | 'preview' | 'presentation';
+
+/**
+ * 编辑器初始化通用参数
+ */
+export declare interface EditorOptions {
+    /**
+     * 编辑器初始化内容，可以是 string 或者 ArrayBuffer，
+     * 也可以通过异步 Promise 加载
+     */
+    content: MaybePromiseValue<string | ArrayBuffer>;
+    /**
+     * 初始化时的编辑模式，默认为 `preview`
+     */
+    mode?: EditorModeOptions;
+    /**
+     * 当前操作编辑器的用户信息
+     */
+    user?: EditorUserOptions;
+    /**
+     * 匿名用户的缺省信息
+     */
+    anonymous?: EditorAnonymousOptions;
+    /**
+     * i18n 相关设置
+     */
+    i18n?: EditorI18nOptions;
+    /**
+     * 品牌相关设置
+     */
+    brand?: EditorBrandOptions;
+    /**
+     * 编辑器内部资源请求配置
+     */
+    assets?: EditorAssetsOptions;
+    /**
+     * 编辑器内部超链接设置
+     */
+    link?: EditorLinkOptions;
+    /**
+     * 嵌入对象相关配置
+     */
+    embeddedObject?: EditorEmbeddedObjectOptions;
+    /**
+     * 初始化水印配置
+     */
+    watermark?: EditorWatermarkOptions;
+    /**
+     * 编辑器打印设置
+     */
+    print?: EditorPrintOptions;
+    /**
+     * 编辑器评论设置
+     */
+    comments?: EditorCommentsOptions;
+    /**
+     * 附件设置
+     */
+    attachment?: EditorAttachmentOptions;
+    /**
+     * 导出设置
+     */
+    export?: EditorExportOptions;
+}
+
+/**
+ * 大纲目录接口
+ */
+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 {
+    /**
+     * 初始化编辑器时是否显示大纲目录，
+     * 默认为 false。
+     */
+    visible?: boolean;
+}
+
+/**
+ * 编辑器打印设置
+ */
+export declare interface EditorPrintOptions {
+    /**
+     * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
+     * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
+     */
+    fallback?: {
+        message: string;
+    };
+    /**
+     * 是否禁用打印功能
+     */
+    disabled?: boolean;
+}
+
+/**
+ * 远程文件上传
+ */
+export declare interface EditorRemoteUploadableFile extends EditorBaseUploadableFile {
+    src: string;
+    name?: never;
+    size?: never;
+    mime?: never;
+    raw?: never;
+}
+
+/**
+ * 编辑器通用接口
+ */
+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;
+}
+
+/**
+ * 编辑器在 `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 EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
+    /**
+     * 自定义按钮名称
+     */
+    name: string;
+    /**
+     * 按钮点击事件
+     */
+    callback: () => void;
+    /**
+     * 按钮在工具栏中的位置，默认添加到工具栏所有按钮后面
+     */
+    index?: number;
+}
+
+/**
+ * 工具栏自定义按钮配置
+ */
+export declare interface EditorToolbarCustomButtonConfig {
+    /**
+     * 按钮配置
+     */
+    [key: string]: EditorToolbarCustomButton;
+}
+
+/**
+ * 工具栏内置功能按钮配置
+ */
+export declare interface EditorToolbarFeatureButton<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
+    /**
+     * 按钮类型
+     */
+    name: ToolButtonName;
+    /**
+     * 按钮标签（显示文本）
+     */
+    label?: string;
+    /**
+     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     */
+    icon?: string;
+    /**
+     * 按钮是否隐藏
+     */
+    hidden?: boolean;
+    /**
+     * 按钮是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 按钮提示文本
+     */
+    tooltip?: string;
+}
+
+/**
+ * 工具栏内置功能按钮配置
+ */
+export declare type EditorToolbarFeatureButtonConfig<ToolButtonName extends string> = {
+    [key in ToolButtonName]?: EditorToolbarFeatureButton<ToolButtonName>;
+};
+
+/**
+ * 工具栏内置功能按钮
+ */
+export declare type EditorToolbarFeatureButtonName = 
+/**
+* 加粗
+*/
+'bold'
+/**
+* 斜体
+*/
+| 'italic'
+/**
+* 下划线
+*/
+| 'underline'
+/**
+* 删除线
+*/
+| 'strikethrough'
+/**
+* 插入图片
+*/
+| 'insertImage'
+/**
+* 插入链接
+*/
+| 'insertLink'
+/**
+* 限制编辑
+*/
+| 'restriction';
+
+/**
+ * 工具栏相关设置，可以控制工具栏的显示内容
+ */
+export declare interface EditorToolbarOptions<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
+    /**
+     * 控制工具栏显隐状态
+     */
+    hidden?: boolean;
+    /**
+     * 是否禁用工具栏所有功能
+     */
+    disabled?: boolean;
+    /**
+     * 现有按钮的功能配置
+     */
+    features?: EditorToolbarFeatureButtonConfig<ToolButtonName>;
+    /**
+     * 自定义按钮
+     */
+    custom?: EditorToolbarCustomButtonConfig;
+}
+
+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;
+}
+
+/**
+ * 操作当前编辑器的用户信息
+ */
+export declare interface EditorUserOptions {
+    /**
+     * 用户 ID，用于标识用户
+     */
+    uid: string;
+    /**
+     * 用户名
+     */
+    name: string;
+    /**
+     * 用户头像
+     */
+    avatar?: string;
+    /**
+     * 用户默认头像，当用户未设置头像时显示
+     */
+    defaultAvatar?: string;
+}
+
+/**
+ * 编辑器外部水印信息
+ */
+export declare interface EditorWatermarkOptions {
+    /**
+     * 获取用作初始化使用的默认水印
+     */
+    getWatermark: () => MaybePromiseValue<EditorWatermarkResource | null>;
+    /**
+     * 是否必须，如果为 true，编辑器将在初始化时强制渲染水印，
+     * 水印配置信息加载失败将导致编辑器初始化失败
+     */
+    required?: boolean;
+}
+
+export declare type EditorWatermarkResource = {
+    type: 'data-url';
+    url: string;
+} | {
+    type: 'object-url';
+    url: string;
+};
+
+/**
+ * 请求、响应头
+ */
+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 type MaybePromiseValue<T> = T | Promise<T>;
+
+export { }