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

package/{docx.d.ts → index.d.ts}

@@ -1,16 +1,38 @@
-export declare abstract class AbstractedDocxSDK extends EditorSDK {
+/**
+ *  抽象 Diagram 接口
+ */
+export declare abstract class AbstractedDiagramSDK {
+    protected options: DiagramSDKOptions;
+    constructor(options: DiagramSDKOptions);
     /**
-     * 打印文档
+     * 初始化 Diagram 、加载插件等操作。
      */
-    abstract print(): Promise<void>;
+    abstract init(): Promise<void>;
     /**
-     * 跳转到某个位置
+     * 销毁 Diagram
      */
-    abstract goto(options: DocxGotoOptions): boolean;
+    abstract destroy(): Promise<void>;
     /**
-     * 文档缩放接口
-     * @param scale
+     * 将 Diagram 挂载到指定的根节点上，并渲染，
+     * mount 应该在 init 之后调用。
+     * @param root
+     */
+    abstract mount(root: HTMLElement): Promise<void>;
+    /**
+     * 从根节点卸载 Diagram ，对应 `mount` 操作
+     */
+    abstract unmount(): Promise<void>;
+}
+
+export declare abstract class AbstractedDocxSDK extends EditorSDK {
+    /**
+     * 文档准备就绪
+     */
+    abstract ready(): Promise<void>;
+    /**
+     * 打印文档
      */
+    abstract print(): Promise<void>;
     /**
      * 文档目录集合接口，
      * 一个文档中可以存在多个目录，这个接口是用来管理文档中的所有目录的。
@@ -46,6 +68,165 @@ export declare abstract class AbstractedDocxSDK extends EditorSDK {
     abstract get search(): DocxSearch;
 }
 
+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;
+}
+
+/**
+ *  抽象 Pdf 接口
+ */
+export declare abstract class AbstractedPdfSDK {
+    protected options: PdfSDKOptions;
+    constructor(options: PdfSDKOptions);
+    /**
+     * 初始化 Pdf 、加载插件等操作。
+     */
+    abstract init(): Promise<void>;
+    /**
+     * 销毁 Pdf
+     */
+    abstract destroy(): Promise<void>;
+    /**
+     * 将 Pdf 挂载到指定的根节点上，并渲染，
+     * mount 应该在 init 之后调用。
+     * @param root
+     */
+    abstract mount(root: HTMLElement): Promise<void>;
+    /**
+     * 从根节点卸载 pdf ，对应 `mount` 操作
+     */
+    abstract unmount(): Promise<void>;
+    /**
+     * pdf 页面操作接口
+     */
+    abstract get pages(): PdfPages;
+    /**
+     * pdf 选区接口
+     */
+    abstract get selection(): PdfSelection;
+    /**
+     * pdf 目录接口
+     */
+    abstract get outline(): PdfOutline;
+}
+
+export declare abstract class AbstractedPresentationSDK extends EditorSDK {
+    /**
+     * 幻灯片准备就绪
+     */
+    abstract ready(): Promise<void>;
+    /**
+     * 打印幻灯片
+     */
+    abstract print(): Promise<void>;
+    /**
+     * 幻灯片集合接口
+     */
+    abstract get slides(): PresentationSlides;
+    /**
+     * 幻灯片选区接口，用于获取、操作当前 slide 的选区
+     */
+    abstract get selection(): PresentationSelection;
+    /**
+     * 幻灯片缩放接口
+     * @param scale
+     */
+    abstract get zoom(): PresentationZoom;
+    /**
+     * 文本格式接口
+     */
+    abstract get text(): PresentationText;
+}
+
+export declare abstract class AbstractedSheetSDK extends EditorSDK {
+    /**
+     * 表格准备就绪
+     */
+    abstract ready(): Promise<void>;
+    /**
+     * 打印文档
+     */
+    abstract print(): Promise<void>;
+    /**
+     * 工作簿接口
+     */
+    abstract get workbook(): SheetWorkbook;
+    /**
+     * 当前活跃工作表对象
+     */
+    abstract get activeSheet(): SheetWorksheet;
+    /**
+     * 当前活动单元格
+     */
+    abstract get activeCell(): SheetCell | null;
+    /**
+     * 获取当前选区
+     */
+    abstract get selections(): SheetSelection[] | null;
+    /**
+     * 文本格式接口
+     */
+    abstract get text(): SheetText;
+}
+
+/**
+ *  Diagram 初始化参数
+ */
+export declare interface DiagramSDKOptions {
+    /**
+     *  Diagram 初始化内容，可以是 string 或者 ArrayBuffer，
+     * 也可以通过异步 Promise 加载
+     */
+    content: MaybePromiseValue<string | ArrayBuffer>;
+    /**
+     * 当前操作 Diagram 的用户信息
+     */
+    user?: EditorUserOptions;
+    /**
+     * i18n 相关设置
+     */
+    i18n?: EditorI18nOptions;
+    /**
+     * 品牌相关设置
+     */
+    brand?: EditorBrandOptions;
+    /**
+     *  Diagram 内部资源请求配置
+     */
+    assets?: EditorAssetsOptions;
+    /**
+     *  Diagram 内部超链接设置
+     */
+    link?: EditorLinkOptions;
+    /**
+     * 初始化水印配置
+     */
+    watermark?: EditorWatermarkOptions;
+    /**
+     *  Diagram 打印设置
+     */
+    print?: EditorPrintOptions;
+}
+
 export declare type DocxFontFace = Omit<EditorFontFace, 'meta'> & {
     meta: DocxFontMeta;
 };
@@ -117,40 +298,6 @@ export declare interface DocxFontsOptions {
     list: DocxFontsList;
 }
 
-export declare type DocxGotoOptions = {
-    /**
-     * 区域，跳转到对应区域位置
-     */
-    type: 'range';
-    /**
-     * 区域值，这个值可以通过 DocxSelection 的 getRange 方法拿到
-     */
-    range: string;
-} | {
-    /**
-     * 页码，跳转到对应页码位置
-     */
-    type: 'page';
-    /**
-     * 页码
-     */
-    page: number;
-} | {
-    /**
-     * 顶部，跳转到文档顶部
-     */
-    type: 'top';
-} | {
-    /**
-     * 跳转到某个评论
-     */
-    type: 'comment';
-    /**
-     * 评论 ID
-     */
-    commentId: string;
-};
-
 /**
  * 图片水印属性值
  */
@@ -180,6 +327,8 @@ export declare interface DocxInfoOptions {
         time?: number;
         author?: string;
     };
+    id: string;
+    name: string;
 }
 
 /**
@@ -817,12 +966,21 @@ export declare type DocxWatermarkOptions = EditorWatermarkOptions;
  * 文档窗口接口
  */
 export declare interface DocxWindow {
+    /**
+     * 获取当前文档滚动位置，
+     * 返回值为当前文档滚动位置的偏移量，
+     * 这个偏移量是基于文档的左上角为原点，向右向下为正方向
+     * @returns
+     */
+    getScrollPosition: () => {
+        x: number;
+        y: number;
+    };
     /**
      * 滚动到指定位置
-     * @param x
-     * @param y
+     * @param params 滚动参数
      */
-    scrollTo: (x: number, y: number) => void;
+    scrollTo: (params: DocxWindowScrollParams) => void;
     /**
      * 滚动到指定页面
      * @param page
@@ -843,6 +1001,65 @@ export declare interface DocxWindow {
     }) => void) => () => void;
 }
 
+export declare type DocxWindowScrollParams = {
+    /**
+     * 区域，跳转到对应区域位置
+     */
+    type: 'range';
+    /**
+     * 区域值，这个值可以通过 DocxSelection 的 getRange 方法拿到
+     */
+    range: string;
+} | {
+    /**
+     * 页码，跳转到对应页码位置
+     */
+    type: 'page';
+    /**
+     * 页码
+     */
+    page: number;
+} | {
+    /**
+     * 顶部，跳转到文档顶部
+     */
+    type: 'top';
+} | {
+    /**
+     * 滚动到某个位置，
+     * 这个位置是基于文档的左上角为原点，向右向下为正方向
+     */
+    type: 'position';
+    /**
+     * 位置
+     */
+    position: {
+        x: number;
+        y: number;
+    };
+} | {
+    /**
+     * 偏移量，跳转到对应偏移量位置
+     */
+    type: 'offset';
+    /**
+     * 偏移量
+     */
+    offset: {
+        x: number;
+        y: number;
+    };
+} | {
+    /**
+     * 跳转到某个评论
+     */
+    type: 'comment';
+    /**
+     * 评论 ID
+     */
+    commentId: string;
+};
+
 /**
  * 文档缩放接口
  */
@@ -884,7 +1101,7 @@ export declare interface DocxZoom {
 /**
  * 编辑器内部资源请求配置
  */
-declare interface EditorAssetsOptions {
+export declare interface EditorAssetsOptions {
     /**
      * 通用资源请求代理配置，
      * 用于套件内部资源请求时代理请求
@@ -903,7 +1120,7 @@ declare interface EditorAssetsOptions {
 /**
  * 基于对象存储的图片处理抽象
  */
-declare interface EditorAssetsOssImageProcessing {
+export declare interface EditorAssetsOssImageProcessing {
     /**
      * 压缩图片的方法
      * @param imageUrl 图片的 URL
@@ -930,7 +1147,7 @@ declare interface EditorAssetsOssImageProcessing {
     }) => Promise<string>;
 }
 
-declare interface EditorAssetsResolver {
+export declare interface EditorAssetsResolver {
     /**
      * 将资源文件 ID 转换为 URL 的方法
      * @param assetId 资源文件 ID
@@ -952,11 +1169,29 @@ declare interface EditorAssetsResolver {
     checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
 }
 
+/**
+ * 编辑器附件信息
+ */
+export declare interface EditorAttachmentOptions {
+    uploader: AbstractedEditorFileUploader;
+    download: (url: string) => void;
+}
+
+/**
+ * 基础文件属性
+ */
+export declare interface EditorBaseUploadableFile {
+    secretly?: boolean;
+    bucket: 'images' | 'attachments';
+    encrypt: string;
+    fileGuid: string;
+}
+
 /**
  * 品牌相关设置，
  * 用于在套件中展示品牌外露信息
  */
-declare interface EditorBrandOptions {
+export declare interface EditorBrandOptions {
     /**
      * 需要显示在品牌展示位的内容，按数组顺序显示
      */
@@ -980,7 +1215,7 @@ declare interface EditorBrandOptions {
 /**
  * 单条评论数据
  */
-declare interface EditorCommentItem {
+export declare interface EditorCommentItem {
     /**
      * 评论 ID
      */
@@ -997,7 +1232,7 @@ declare interface EditorCommentItem {
     };
 }
 
-declare interface EditorComments {
+export declare interface EditorComments {
     /**
      * 检查是否有评论
      * @returns
@@ -1043,7 +1278,7 @@ declare interface EditorComments {
 /**
  * 编辑器评论初始化配置
  */
-declare interface EditorCommentsOptions {
+export declare interface EditorCommentsOptions {
     /**
      * 评论作者信息，如果这里的信息为空，将会使用 user 信息
      */
@@ -1074,7 +1309,7 @@ declare interface EditorCommentsOptions {
     };
 }
 
-declare interface EditorContent {
+export declare interface EditorContent {
     /**
      * 设置编辑器内容
      * @param content
@@ -1091,7 +1326,7 @@ declare interface EditorContent {
     addChangeListener: (listener: (change: EditorDelta) => void) => () => void;
 }
 
-declare interface EditorDelta {
+export declare interface EditorDelta {
     compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
     transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
     stringify: () => string;
@@ -1101,7 +1336,7 @@ declare interface EditorDelta {
 /**
  * 编辑器嵌入对象
  */
-declare interface EditorEmbeddedObject {
+export declare interface EditorEmbeddedObject {
     /**
      * 嵌入的对象 url
      */
@@ -1119,7 +1354,7 @@ declare interface EditorEmbeddedObject {
 /**
  * 编辑器嵌入对象抽象类
  */
-declare interface EditorEmbeddedObjectOptions {
+export declare interface EditorEmbeddedObjectOptions {
     /**
      * 执行打开嵌入对象操作，
      * 如果已经处理了打开操作，返回 true，否则返回 false，
@@ -1147,7 +1382,20 @@ declare interface EditorEmbeddedObjectOptions {
     };
 }
 
-declare interface EditorFontFace {
+export declare interface EditorExportOptions {
+    /**
+     * 可导出类型
+     * @description
+     */
+    supportedTypes?: string[];
+    /**
+     * 导出文件
+     * @description
+     */
+    exportFile: (type: string) => Promise<void>;
+}
+
+export declare interface EditorFontFace {
     /**
      * 字体的名称，用于在用户界面上显示的名称
      */
@@ -1173,7 +1421,7 @@ declare interface EditorFontFace {
 /**
  * 字体元数据
  */
-declare interface EditorFontMeta {
+export declare interface EditorFontMeta {
     head: {
         unitsPerEm: number;
     };
@@ -1207,10 +1455,28 @@ declare interface EditorFontMeta {
     };
 }
 
+/**
+ * 字体列表
+ */
+export declare interface EditorFontsList {
+    /**
+     * 返回解析为字体的列表的 Promise。
+     */
+    getAll: () => Promise<EditorFontFace[]>;
+}
+
+export declare interface EditorFontsOptions {
+    /**
+     * 服务器字体列表，用于获取服务器端配置的字体列表，
+     * 并提供可用于字体的加载 URL 和字体元数据。
+     */
+    list: EditorFontsList;
+}
+
 /**
  * i18n 相关设置
  */
-declare interface EditorI18nOptions {
+export declare interface EditorI18nOptions {
     /**
      * 语言，默认使用浏览器当前环境中的语言
      */
@@ -1221,12 +1487,12 @@ declare interface EditorI18nOptions {
     direction?: 'ltr' | 'rtl';
 }
 
-declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
+export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
 
 /**
  * 链接配置，抽象打开链接等操作
  */
-declare interface EditorLinkOptions {
+export declare interface EditorLinkOptions {
     /**
      * 打开链接，如果取消了打开链接操作，返回 false
      * @param url
@@ -1236,10 +1502,20 @@ declare interface EditorLinkOptions {
     open: (url: string, target: string) => Promise<boolean>;
 }
 
+/**
+ * 可上传文件
+ */
+export declare interface EditorLocalUploadableFile extends EditorBaseUploadableFile {
+    name: string;
+    size: number;
+    mime: string;
+    raw: File;
+}
+
 /**
  * 菜单栏自定义按钮配置
  */
-declare type EditorMenuCustomButton = {
+export declare type EditorMenuCustomButton = {
     /**
      * 按钮名称
      */
@@ -1282,7 +1558,7 @@ declare type EditorMenuCustomButton = {
 /**
  * 菜单栏二级以下的菜单入口
  */
-declare interface EditorMenuEntryButton {
+export declare interface EditorMenuEntryButton {
     type: 'entry';
     /**
      * 菜单名称
@@ -1298,7 +1574,7 @@ declare interface EditorMenuEntryButton {
  * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
  * 一级菜单在鼠标悬停时展示二级列表
  */
-declare interface EditorMenuEntryConfig<TName extends string> {
+export declare interface EditorMenuEntryConfig<TName extends string> {
     /**
      * 一级菜单名称
      */
@@ -1314,7 +1590,7 @@ declare interface EditorMenuEntryConfig<TName extends string> {
 /**
  * 菜单栏功能按钮配置
  */
-declare type EditorMenuFeatureButton<TName extends string> = {
+export declare type EditorMenuFeatureButton<TName extends string> = {
     /**
      * 隐藏按钮，用作在需要隐藏菜单栏时定义
      */
@@ -1342,13 +1618,13 @@ declare type EditorMenuFeatureButton<TName extends string> = {
 /**
  * 菜单栏按钮配置
  */
-declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
+export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
 
 /**
  * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
  * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
  */
-declare interface EditorMenuOptions<TName extends string> {
+export declare interface EditorMenuOptions<TName extends string> {
     /**
      * 菜单栏是否显示
      */
@@ -1374,7 +1650,7 @@ declare interface EditorMenuOptions<TName extends string> {
 /**
  * 编辑器基础模式接口
  */
-declare interface EditorMode {
+export declare interface EditorMode {
     /**
      * 获取当前编辑器模式
      */
@@ -1393,7 +1669,7 @@ declare interface EditorMode {
 /**
  * 编辑器初始化的时相关的模式配置
  */
-declare type EditorModeOptions = {
+export declare type EditorModeOptions = {
     type: 'standard';
     /**
      * 当 mode 为 `standard` 时，可以设置当前编辑器的权限模式
@@ -1411,12 +1687,12 @@ declare type EditorModeOptions = {
  * - `preview` 预览模式，只能查看内容
  * - `presentation` 演示模式，用作演示场景，演示模式下部分套件可以进行一些简单的编辑操作
  */
-declare type EditorModeType = 'standard' | 'preview' | 'presentation';
+export declare type EditorModeType = 'standard' | 'preview' | 'presentation';
 
 /**
  * 编辑器初始化通用参数
  */
-declare interface EditorOptions {
+export declare interface EditorOptions {
     /**
      * 编辑器初始化内容，可以是 string 或者 ArrayBuffer，
      * 也可以通过异步 Promise 加载
@@ -1466,12 +1742,20 @@ declare interface EditorOptions {
      * 编辑器评论设置
      */
     comments?: EditorCommentsOptions;
+    /**
+     * 附件设置
+     */
+    attachment?: EditorAttachmentOptions;
+    /**
+     * 导出设置
+     */
+    export?: EditorExportOptions;
 }
 
 /**
  * 大纲目录接口
  */
-declare interface EditorOutline<Content = unknown> {
+export declare interface EditorOutline<Content = unknown> {
     /**
      * 设置大纲目录是否可见
      * @param visible 是否可见
@@ -1499,7 +1783,7 @@ declare interface EditorOutline<Content = unknown> {
 /**
  * 大纲目录项条目
  */
-declare interface EditorOutlineItem<Content = unknown> {
+export declare interface EditorOutlineItem<Content = unknown> {
     /**
      * 目录项 ID
      */
@@ -1518,7 +1802,7 @@ declare interface EditorOutlineItem<Content = unknown> {
  * 大纲目录初始化参数，
  * 用于配置大纲目录的行为和外观。
  */
-declare interface EditorOutlineOptions {
+export declare interface EditorOutlineOptions {
     /**
      * 初始化编辑器时是否显示大纲目录，
      * 默认为 false。
@@ -1529,7 +1813,7 @@ declare interface EditorOutlineOptions {
 /**
  * 编辑器打印设置
  */
-declare interface EditorPrintOptions {
+export declare interface EditorPrintOptions {
     /**
      * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
      * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
@@ -1543,10 +1827,21 @@ declare interface EditorPrintOptions {
     disabled?: boolean;
 }
 
+/**
+ * 远程文件上传
+ */
+export declare interface EditorRemoteUploadableFile extends EditorBaseUploadableFile {
+    src: string;
+    name?: never;
+    size?: never;
+    mime?: never;
+    raw?: never;
+}
+
 /**
  * 编辑器通用接口
  */
-declare abstract class EditorSDK {
+export declare abstract class EditorSDK {
     protected options: EditorOptions;
     constructor(options: EditorOptions);
     /**
@@ -1587,15 +1882,64 @@ declare abstract class EditorSDK {
  * - `viewer` 阅读模式
  * - `reviewer` 评论模式
  */
-declare type EditorStandardRole = 'editor' | 'viewer' | 'reviewer';
+export declare type EditorStandardRole = 'editor' | 'viewer' | 'reviewer';
 
 /**
- * 文本格式接口，
- * 包括设置、读取选区内文本的 BIUS、family、大小、颜色等
+ * 上传任务回调
  */
-declare interface EditorText<Color = string, TRangeValue = unknown> {
+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>>;
     /**
@@ -1617,7 +1961,7 @@ declare interface EditorText<Color = string, TRangeValue = unknown> {
 /**
  * 文本格式状态
  */
-declare interface EditorTextFormat<Color = string> {
+export declare interface EditorTextFormat<Color = string> {
     /**
      * 粗体
      */
@@ -1655,7 +1999,7 @@ declare interface EditorTextFormat<Color = string> {
 /**
  * 文本格式初始化选项
  */
-declare interface EditorTextOptions<Color = string> {
+export declare interface EditorTextOptions<Color = string> {
     /**
      * 当前编辑器默认的文本格式
      */
@@ -1665,7 +2009,7 @@ declare interface EditorTextOptions<Color = string> {
 /**
  * 工具栏自定义按钮配置
  */
-declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
+export declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
     /**
      * 自定义按钮名称
      */
@@ -1683,7 +2027,7 @@ declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureBut
 /**
  * 工具栏自定义按钮配置
  */
-declare interface EditorToolbarCustomButtonConfig {
+export declare interface EditorToolbarCustomButtonConfig {
     /**
      * 按钮配置
      */
@@ -1693,7 +2037,7 @@ declare interface EditorToolbarCustomButtonConfig {
 /**
  * 工具栏内置功能按钮配置
  */
-declare interface EditorToolbarFeatureButton {
+export declare interface EditorToolbarFeatureButton {
     /**
      * 按钮类型
      */
@@ -1719,14 +2063,14 @@ declare interface EditorToolbarFeatureButton {
 /**
  * 工具栏内置功能按钮配置
  */
-declare type EditorToolbarFeatureButtonConfig = {
+export declare type EditorToolbarFeatureButtonConfig = {
     [key in EditorToolbarFeatureButtonName]?: EditorToolbarFeatureButton;
 };
 
 /**
  * 工具栏内置功能按钮
  */
-declare type EditorToolbarFeatureButtonName = 
+export declare type EditorToolbarFeatureButtonName = 
 /**
 * 加粗
 */
@@ -1759,7 +2103,7 @@ declare type EditorToolbarFeatureButtonName =
 /**
  * 工具栏相关设置，可以控制工具栏的显示内容
  */
-declare interface EditorToolbarOptions {
+export declare interface EditorToolbarOptions {
     /**
      * 控制工具栏显隐状态
      */
@@ -1778,10 +2122,51 @@ declare interface EditorToolbarOptions {
     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;
+}
+
 /**
  * 操作当前编辑器的用户信息
  */
-declare interface EditorUserOptions {
+export declare interface EditorUserOptions {
     /**
      * 用户 ID，用于标识用户
      */
@@ -1799,7 +2184,7 @@ declare interface EditorUserOptions {
 /**
  * 编辑器外部水印信息
  */
-declare interface EditorWatermarkOptions {
+export declare interface EditorWatermarkOptions {
     /**
      * 获取用作初始化使用的默认水印
      */
@@ -1811,7 +2196,7 @@ declare interface EditorWatermarkOptions {
     required?: boolean;
 }
 
-declare type EditorWatermarkResource = {
+export declare type EditorWatermarkResource = {
     type: 'data-url';
     url: string;
 } | {
@@ -1822,18 +2207,18 @@ declare type EditorWatermarkResource = {
 /**
  * 请求、响应头
  */
-declare type HTTPHeaders = Record<string, string | number | boolean | undefined>;
+export declare type HTTPHeaders = Record<string, string | number | boolean | undefined>;
 
 /**
  * 请求方法
  */
-declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
+export declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
 
 /**
  * HTTP 代理，用于抽象 HTTP 请求，
  * 将请求代理编辑器外部
  */
-declare interface HTTPProxy {
+export declare interface HTTPProxy {
     /**
      * 发送请求，如果需要做请求、响应拦截，需要在 proxy.interceptors 中实现，
      * 套件内使用 proxy 发送请求的方式应该为类似如下方式:
@@ -1880,7 +2265,7 @@ declare interface HTTPProxy {
 /**
  * 请求配置
  */
-declare interface HTTPRequestConfig<Data = unknown> {
+export declare interface HTTPRequestConfig<Data = unknown> {
     /**
      * 请求地址
      */
@@ -1906,7 +2291,7 @@ declare interface HTTPRequestConfig<Data = unknown> {
 /**
  * 响应数据
  */
-declare interface HTTPResponse<Data = unknown> {
+export declare interface HTTPResponse<Data = unknown> {
     /**
      * 响应数据 body
      */
@@ -1924,8 +2309,846 @@ declare interface HTTPResponse<Data = unknown> {
 /**
  * 请求返回类型
  */
-declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+
+export declare type MaybePromiseValue<T> = T | Promise<T>;
+
+/**
+ * pdf 工具栏一级菜单
+ */
+export declare type PdfMenuEntryConfig = EditorMenuEntryConfig<PdfMenuFeatureButtonName>;
+
+/**
+ * 传统文档工具栏功能按钮
+ */
+export declare type PdfMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<PdfMenuFeatureButtonName>;
+
+/**
+ * pdf 工具栏内置功能按钮
+ */
+export declare type PdfMenuFeatureButtonName = 'selectAll';
+
+export declare type PdfMenuOptions = EditorMenuOptions<PdfMenuFeatureButtonName>;
+
+/**
+ * pdf 目录大纲项接口
+ */
+export declare type PdfOutline = EditorOutline<{
+    text: string;
+}>;
+
+/**
+ * pdf 目录大纲项信息，用于描述 pdf 中的目录项信息。
+ */
+export declare type PdfOutlineItem = EditorOutlineItem<{
+    text: string;
+}>;
+
+export declare type PdfOutlineOptions = EditorOutlineOptions;
+
+/**
+ * pdf 页面实例，
+ * 可以通过实例对对应页面进行操作。
+ */
+export declare interface PdfPage {
+    /**
+     * 获取当前页码
+     */
+    readonly pageNumber: number;
+    /**
+     * 获取当前页面的大小
+     * @returns
+     */
+    getPageSize: () => {
+        width: number;
+        height: number;
+    };
+}
+
+/**
+ * pdf 页面集合操作接口，
+ * 该接口和 PdfPage 负责不同的功能，
+ * PdfPage 是一个页面的抽象，而 PdfPages 是对整个 pdf 文件中所有页面的操作。
+ */
+export declare interface PdfPages {
+    /**
+     * 获取当前页码
+     * @returns
+     */
+    getCurrentPageNumber: () => number;
+    /**
+     * 设置当前页码并跳转至对应页面
+     * @param page
+     */
+    setCurrentPage: (page: number) => void;
+    /**
+     * 获取总页数
+     * @returns
+     */
+    getPagesCount: () => number;
+    /**
+     * 获取指定页面
+     */
+    getPage: (page: number) => Promise<PdfPage | null>;
+}
+
+/**
+ * 区域（Range）
+ * 区域对象，表示文件中的一个连续区域，每个 Range 对象包含起始字符位置和终止字符位置。
+ */
+/**
+ * Pdf 区域对象，
+ * 用于表示 Pdf 中的一个连续区域，
+ * 每个选区值包含了起始位置和结束位置信息。
+ */
+export declare interface PdfRange {
+    /**
+     * 区域的开始位置。
+     */
+    readonly start: string;
+    /**
+     * 区域的结束位置。
+     */
+    readonly end: string;
+    /**
+     * 获取该区域对应的纯文本信息。
+     * @returns
+     */
+    getText: () => string;
+    /**
+     * 将区域中的内容以 HTML 格式返回。
+     * @returns
+     */
+    getHtml: () => string;
+    /**
+     * 获取选区在当前屏幕上的位置信息
+     * @returns
+     */
+    getBounding: () => PdfRangeBounding | null;
+}
+
+/**
+ * 记录选区在屏幕上的矩形位置信息，
+ * 包含整个选区包围盒的四个边界值（top, right, bottom, left），
+ * 以及第一行开始和最后一行结束的横向坐标。
+ * 这些信息是选区中所有 ClientRects 的集合范围。
+ */
+export declare interface PdfRangeBounding {
+    /**
+     * 区域的上边界值，
+     * 表示所有选区中最上方的 Y 坐标。
+     */
+    top: number;
+    /**
+     * 区域的右边界值，
+     * 表示所有选区中最右侧的 X 坐标。
+     */
+    right: number;
+    /**
+     * 区域的下边界值，
+     * 表示所有选区中最下方的 Y 坐标。
+     */
+    bottom: number;
+    /**
+     * 区域的左边界值，
+     * 表示所有选区中最左侧的 X 坐标。
+     */
+    left: number;
+    /**
+     * 第一行选区的起始 X 坐标。
+     */
+    start: number;
+    /**
+     * 最后一行选区的结束 X 坐标。
+     */
+    end: number;
+}
+
+export declare interface PdfRangeValue {
+    start: string;
+    end: string;
+}
+
+/**
+ *  Pdf 初始化参数
+ */
+export declare interface PdfSDKOptions {
+    /**
+     *  Pdf 初始化内容，可以是 string 或者 ArrayBuffer，
+     * 也可以通过异步 Promise 加载
+     */
+    content: MaybePromiseValue<string | ArrayBuffer>;
+    /**
+     * 当前操作 Pdf 的用户信息
+     */
+    user?: EditorUserOptions;
+    /**
+     * i18n 相关设置
+     */
+    i18n?: EditorI18nOptions;
+    /**
+     * 品牌相关设置
+     */
+    brand?: EditorBrandOptions;
+    /**
+     *  Pdf 内部资源请求配置
+     */
+    assets?: EditorAssetsOptions;
+    /**
+     *  Pdf 内部超链接设置
+     */
+    link?: EditorLinkOptions;
+    /**
+     * 初始化水印配置
+     */
+    watermark?: EditorWatermarkOptions;
+    /**
+     *  Pdf 打印设置
+     */
+    print?: EditorPrintOptions;
+    /**
+     *  Pdf 大纲目录设置
+     */
+    outline?: PdfOutlineOptions;
+    /**
+     *  Pdf 菜单栏设置
+     */
+    menu?: PdfMenuOptions;
+}
+
+/**
+ * 选区（Selection）
+ * 表示窗口或窗格中的当前选定内容。
+ */
+export declare interface PdfSelection {
+    /**
+     * 获取选区的区域范围，
+     * 如果没有指定范围，则返回当前选区的范围。
+     * 如果指定了范围，则返回指定范围的选区。
+     * 如果选区不存在，则返回 null。
+     * @returns
+     */
+    getRange: (value?: PdfRangeValue) => PdfRange | null;
+    /**
+     * 设置选区的区域范围，
+     * 设置后，选区会自动选中指定范围。
+     * 如果设置为 null，则清空选区。
+     * @param bounds
+     */
+    setRange: (vale: PdfRangeValue | null) => void;
+    /**
+     * 添加选区变化监听器，当选区发生变化时，会触发回调。
+     * @param listener
+     * @returns
+     */
+    addRangeListener: (listener: (value: PdfRangeValue | null) => void) => void;
+    /**
+     * 获取 pdf 全部选区范围。
+     * @returns
+     */
+    getWholeRange: () => PdfRange;
+}
+
+export declare type PresentationFontFace = EditorFontFace;
+
+export declare type PresentationFontMeta = EditorFontMeta;
+
+export declare interface PresentationFontsList {
+    getAll: () => Promise<PresentationFontFace[]>;
+}
+
+export declare interface PresentationFontsOptions {
+    list: PresentationFontsList;
+}
+
+/**
+ * 幻灯片工具栏一级菜单
+ */
+export declare type PresentationMenuEntryConfig = EditorMenuEntryConfig<PresentationMenuFeatureButtonName>;
+
+/**
+ * 幻灯片工具栏功能按钮
+ */
+export declare type PresentationMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<PresentationMenuFeatureButtonName>;
+
+/**
+ * 幻灯片工具栏内置功能按钮
+ */
+export declare type PresentationMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll';
+
+export declare type PresentationMenuOptions = EditorMenuOptions<PresentationMenuFeatureButtonName>;
+
+export declare interface PresentationSDKOptions extends EditorOptions {
+    /**
+     * 字体配置
+     */
+    fonts?: PresentationFontsOptions;
+    /**
+     * 菜单栏相关设置
+     */
+    menu?: PresentationMenuOptions;
+    /**
+     * 文本格式相关设置
+     */
+    text?: PresentationTextOptions;
+}
 
-declare type MaybePromiseValue<T> = T | Promise<T>;
+/**
+ * 选区（Selection）
+ * 表示窗口中的当前选定内容。
+ * 选定内容表示幻灯片中的选定（或突出显示）区域，或者代表插入点（如果未选择幻灯片中的任何内容）。
+ */
+export declare interface PresentationSelection {
+    /**
+     * 获取选区的区域范围，
+     * 如果没有指定范围，则返回当前选区的范围。
+     * 如果指定了范围，则返回指定范围的选区。
+     * 如果选区不存在，则返回 null。
+     * @returns
+     */
+    getTextRange: (value?: PresentationTextRangeValue) => PresentationTextRange | null;
+    /**
+     * 设置选区的区域范围，
+     * 设置后，选区会自动选中指定范围。
+     * 如果设置为 null，则清空选区。
+     * @param value
+     */
+    setTextRange: (value: PresentationTextRangeValue | null) => void;
+    /**
+     * 获取当前选中的形状，
+     * 如果没有选中形状，则返回 null。
+     * 如果指定了 value，则返回指定形状。
+     * @param ids 指定的形状 id
+     * @returns
+     */
+    getSelectedShapes: (ids?: string[]) => PresentationShape[] | null;
+    /**
+     * 选中指定的形状，选中形状后会清空文字选区。
+     * 如果 value 为 null，则清空选中的形状。
+     * @param ids 指定的形状 id
+     * @returns
+     */
+    setSelectedShapes: (ids: string[] | null) => void;
+    /**
+     * 添加选区变化监听器，当选区发生变化时，会触发回调。
+     * @param listener
+     * @returns
+     */
+    addRangeListener: (listener: (value: PresentationTextRangeValue | null) => void) => void;
+}
+
+/**
+ * 幻灯片形状(Shape)接口
+ */
+export declare interface PresentationShape {
+    /**
+     * 获取形状的 id
+     */
+    readonly id: string;
+}
+
+/**
+ * 幻灯片页面(Slide)对象，
+ * 是幻灯片的基础操作单元，包含幻灯片的基本信息和操作方法。
+ */
+export declare interface PresentationSlide {
+    /**
+     * 当前幻灯片的 id
+     */
+    readonly id: string;
+    /**
+     * 获取当前幻灯片在所有幻灯片中的索引
+     * @returns
+     */
+    getIndex: () => number;
+    /**
+     * 获取当前页面所有的形状
+     * @returns
+     */
+    getShapes: () => PresentationShape[];
+}
+
+/**
+ * 幻灯片集合对象，
+ * 该接口和 PresentationSlide 负责不同的功能，
+ * PresentationSlide 是一个幻灯片页面的抽象，而 PresentationSlides 是对整个文件中所有页面的操作。
+ */
+export declare interface PresentationSlides {
+    /**
+     * 获取当前幻灯片
+     */
+    getCurrentSlide: () => PresentationSlide;
+    /**
+     * 切换当前幻灯片
+     * @param slideId
+     */
+    setCurrentSlideIndex: (slideId: string) => void;
+    /**
+     * 获取幻灯片索引
+     * @param slideId
+     * @returns
+     */
+    getSlideIndex: (slideId: string) => number;
+    /**
+     * 获取幻灯片总数
+     */
+    getSlidesCount: () => number;
+    /**
+     * 获取所有幻灯片
+     * @returns
+     */
+    getSlides: () => PresentationSlide[];
+    /**
+     * 获取指定幻灯片
+     * @param slideId
+     */
+    getSlideById: (slideId: string) => PresentationSlide;
+    /**
+     * 获取当前选中的幻灯片。
+     * 至少存在一个选中的幻灯片。
+     * @returns
+     */
+    getSelectedSlides: (ids?: string[]) => PresentationSlide[];
+    /**
+     * 设置
+     * @param ids
+     * @returns
+     */
+    setSelectedSlides: (ids: string[]) => void;
+}
+
+/**
+ * 演示文稿文本接口
+ */
+export declare type PresentationText = EditorText<string, PresentationTextRangeValue>;
+
+/**
+ * 演示文稿文本格式
+ */
+export declare type PresentationTextFormat = EditorTextFormat;
+
+/**
+ * 演示文稿文本格式初始化选项
+ */
+export declare type PresentationTextOptions = EditorTextOptions<string>;
+
+/**
+ * 区域（Range）
+ * 区域对象，表示幻灯片页面中的一个连续的文字区域，每个 Range 对象包含起始字符位置和终止字符位置。
+ * 区域信息是一个临时状态，当内容发生变化后，或切换了幻灯片 slide 区域信息可能会失效。
+ */
+/**
+ * 幻灯片区域对象，
+ * 用于表示页面中的一个连续区域，
+ * 每个选区值包含了起始位置和结束位置信息的字符串。
+ */
+export declare interface PresentationTextRange {
+    /**
+     * 区域的开始位置，
+     * 当内容发生变化后，区域的标识可能会失效。
+     */
+    readonly start: string;
+    /**
+     * 区域的结束位置，
+     * 当内容发生变化后，区域的标识可能会失效。
+     */
+    readonly end: string;
+    /**
+     * 获取该区域对应的纯文本信息。
+     * @returns
+     */
+    getText: () => string;
+    /**
+     * 设置该区域的内容
+     * @param text 内容
+     */
+    setText: (text: string) => void;
+    /**
+     * 将区域中的内容以 HTML 格式返回
+     */
+    getHtml: () => string;
+    /**
+     * 设置该区域的内容为 HTML 格式
+     * @param html 内容
+     */
+    setHtml: (html: string) => void;
+}
+
+export declare interface PresentationTextRangeValue {
+    start: string;
+    end: string;
+}
+
+/**
+ * 幻灯片缩放接口
+ */
+export declare interface PresentationZoom {
+    /**
+     * 获取当前缩放比例。
+     * @returns
+     */
+    getPercentage: () => number;
+    /**
+     * 设置缩放比例，
+     * 有效范围 10 ~ 500。
+     * @param percentage
+     */
+    setPercentage: (percentage: number) => void;
+    /**
+     * 设置自动缩放模式，
+     * none: 不自动缩放，默认值。
+     * window: 根据窗口宽度自动缩放，页面宽度随着窗口宽度变化而变化
+     * @param mode 缩放模式，可以是 'window'
+     */
+    setFitMode: (mode: 'none' | 'window') => void;
+    /**
+     * 获取当前缩放模式。
+     * @returns
+     */
+    getFitMode: () => 'none' | 'window';
+    /**
+     * 放大。
+     */
+    zoomIn: () => void;
+    /**
+     * 缩小。
+     */
+    zoomOut: () => void;
+}
+
+/**
+ * 表格单元格对象
+ */
+export declare interface SheetCell {
+    /**
+     * 单元格所在的行号
+     */
+    row: number;
+    /**
+     * 单元格所在的列号
+     */
+    column: number;
+    /**
+     * 单元格所在的工作表 ID
+     */
+    sheetId: string;
+    /**
+     * 获取单元格的文本
+     */
+    getCellText: () => string;
+    /**
+     * 获取单元格的值
+     */
+    getCellValue: () => SheetCellValue | null;
+}
+
+/**
+ * 单元格值类型
+ */
+export declare type SheetCellValue = {
+    type: 'primitive';
+    value: string | number | boolean;
+} | {
+    type: 'date';
+    value: number;
+} | {
+    type: 'calcError';
+    value: {
+        error: string;
+    };
+};
+
+/**
+ * 电子表格工具栏一级菜单
+ */
+export declare type SheetMenuEntryConfig = EditorMenuEntryConfig<SheetMenuFeatureButtonName>;
+
+/**
+ * 电子表格工具栏功能按钮
+ */
+export declare type SheetMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<SheetMenuFeatureButtonName>;
+
+/**
+ * 电子表格工具栏内置功能按钮
+ */
+export declare type SheetMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll';
+
+export declare type SheetMenuOptions = EditorMenuOptions<SheetMenuFeatureButtonName>;
+
+/**
+ * 表格区域对象，
+ * 用于表示表格中被选中的单元格区域，
+ * 可以是一个单元格、一行、一列、或某个区域。
+ */
+export declare interface SheetRange {
+    /**
+     * 区域类型
+     */
+    type: `${SheetRangeType}`;
+    /**
+     * 区域的行开始位置
+     */
+    readonly row: number;
+    /**
+     * 区域的列开始位置
+     */
+    readonly column: number;
+    /**
+     * 区域的行数
+     */
+    readonly rowCount: number;
+    /**
+     * 区域的列数
+     */
+    readonly columnCount: number;
+    /**
+     * 获取该区域对应的纯文本信息。
+     * @returns
+     */
+    getText: () => string;
+    /**
+     * 设置该区域的内容
+     * @param text 内容
+     */
+    setText: (text: string) => void;
+    /**
+     * 将区域中的内容以 HTML 格式返回
+     */
+    getHtml: () => string;
+    /**
+     * 设置该区域的内容为 HTML 格式
+     * @param html 内容
+     */
+    setHtml: (html: string) => void;
+}
+
+/**
+ * 区域（Range）
+ * 区域对象，表示表格中的一个单元格区域，每个 Range 对象包含了一个或多个单元格、行、列信息。
+ */
+/**
+ * 选区类型
+ */
+export declare enum SheetRangeType {
+    /**
+     * 选中一个或多个单元格
+     */
+    Cells = "cells",
+    /**
+     * 选中一行或多行
+     */
+    Rows = "rows",
+    /**
+     * 选中一列或多列
+     */
+    Columns = "columns",
+    /**
+     * 选中整个工作表
+     */
+    Sheet = "sheet"
+}
+
+export declare type SheetRangeValue = {
+    /**
+     * 单个或多个单元格
+     */
+    type: `${SheetRangeType.Cells}`;
+    /**
+     * 起始单元格的行号
+     */
+    row: number;
+    /**
+     * 总计行数
+     */
+    rowCount: number;
+    /**
+     * 起始单元格的列号
+     */
+    column: number;
+    /**
+     * 总计列数
+     */
+    columnCount: number;
+} | {
+    /**
+     * 一列或多列
+     */
+    type: `${SheetRangeType.Rows}`;
+    /**
+     * 起始列号
+     */
+    row: number;
+    /**
+     * 总计行数
+     */
+    rowCount: number;
+} | {
+    /**
+     * 一行或多行
+     */
+    type: `${SheetRangeType.Columns}`;
+    /**
+     * 起始行号
+     */
+    column: number;
+    /**
+     * 总计列数
+     */
+    columnCount: number;
+} | {
+    /**
+     * 整个工作表
+     */
+    type: `${SheetRangeType.Sheet}`;
+};
+
+export declare interface SheetSDKOptions extends EditorOptions {
+    /**
+     * 字体配置
+     */
+    fonts?: EditorFontsOptions;
+    /**
+     * 菜单栏相关设置
+     */
+    menu?: SheetMenuOptions;
+    /**
+     * 文本格式相关设置
+     */
+    text?: SheetTextOptions;
+}
+
+/**
+ * 选区（Selection）
+ * 表示窗口或窗格中的当前选定内容。
+ * 选定内容表示表格中的选定（或突出显示）的单元格区域。
+ */
+export declare interface SheetSelection {
+    /**
+     * 获取选区的区域范围，
+     * 如果没有指定范围，则返回当前选区的范围。
+     * 如果指定了范围，则返回指定范围的选区。
+     * 如果选区不存在，则返回 null。
+     */
+    getRange: (value?: SheetRangeValue) => SheetRange | null;
+    /**
+     * 设置选区的区域范围，
+     * 设置后，选区会自动选中指定范围。
+     * 如果设置为 null，则清空选区。
+     */
+    setRange: (value: SheetRangeValue | null) => void;
+}
+
+/**
+ * 电子表格文本接口
+ */
+export declare type SheetText = EditorText<string, SheetRangeValue>;
+
+/**
+ * 电子表格文本格式
+ */
+export declare type SheetTextFormat = EditorTextFormat;
+
+/**
+ * 电子表格文本格式初始化选项
+ */
+export declare type SheetTextOptions = EditorTextOptions<string>;
+
+/**
+ * 工作表集合对象
+ */
+export declare interface SheetWorkbook {
+    /**
+     * 获取所有工作表
+     * @returns
+     */
+    getWorksheets: () => SheetWorksheet[];
+    /**
+     * 获取指定的工作表
+     * @param sheetId
+     * @returns
+     */
+    getWorksheetById: (sheetId: string) => SheetWorksheet | null;
+    /**
+     * 获取当前活动的工作表
+     * TODO: 是否存在返回空的场景
+     * @returns
+     */
+    getActiveWorksheet: () => SheetWorksheet;
+    /**
+     * 激活指定的工作表
+     * @param sheetId
+     */
+    setActiveWorksheet: (sheetId: string) => void;
+}
+
+/**
+ * 工作表对象
+ */
+export declare interface SheetWorksheet {
+    /**
+     * 工作表对应编号
+     */
+    get id(): string;
+    /**
+     * 获取当前工作表名称
+     */
+    get name(): string;
+    /**
+     * 这个工作表是否为当前活动的工作表
+     */
+    get isActive(): boolean;
+    /**
+     * 获取工作表的所有选区
+     * @returns
+     */
+    getSelections: () => SheetSelection[] | null;
+    /**
+     * 获取选区的物理位置（相对于浏览器窗口），如果选区完全不在工作表的可视区域内，返回 null。
+     * 其中选区超出可视区域的部分会被截断处理。
+     *
+     * 当工作表存在冻结行列时，可视区域将被分成四个部分（如果仅存在冻结行或冻结列则被分为两个部分），
+     * 此时需要计算出选区在**视觉上**与可视区域的交集。
+     */
+    getPhysicalPosition: (range: SheetRangeValue) => {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+    } | null;
+    /**
+     * 添加选区变化监听器，当选区发生变化时，会触发回调。
+     * @param listener
+     * @returns 用于移除监听的回调
+     */
+    addRangeListener: (listener: (range: {
+        sheet: string;
+        ranges: SheetRangeValue[] | null;
+    }) => void) => () => void;
+    /**
+     * 获取工作表中指定区域的单元格对象
+     * @returns
+     */
+    getCell: (row: number, column: number) => SheetCell | null;
+    /**
+     * 获取工作表中选中的单元格对象
+     * @returns
+     */
+    getActiveCell: () => SheetCell | null;
+    /**
+     * 激活工作表中某个单元格
+     * @param cell 单元格对象，需要传入行和列的索引值
+     * @returns
+     */
+    setActiveCell: (cell: {
+        row: number;
+        column: number;
+    }) => void;
+    /**
+     * 定位到单元格所在位置
+     * @param row 单元格所在行
+     * @param column 单元格所在列
+     */
+    locateCell: (row: number, column: number) => void;
+}
 
 export { }