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

package/{shared.d.ts → types/shared.d.ts}

@@ -1,3 +1,41 @@
+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 EditorAnonymousOptions {
+    /**
+     * 匿名用户默认显示名称
+     */
+    name: string;
+    /**
+     * 匿名用户默认头像
+     */
+    avatar: string;
+}
+
 /**
  * 编辑器内部资源请求配置
  */
@@ -69,6 +107,116 @@ export declare interface EditorAssetsResolver {
     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;
+}
+
 /**
  * 品牌相关设置，
  * 用于在套件中展示品牌外露信息
@@ -191,7 +339,7 @@ export declare interface EditorCommentsOptions {
     };
 }
 
-export declare interface EditorContent {
+export declare interface EditorContent<Delta = EditorDelta> {
     /**
      * 设置编辑器内容
      * @param content
@@ -200,14 +348,41 @@ export declare interface EditorContent {
     /**
      * 获取编辑器内容
      */
-    getContent: () => Promise<EditorDelta>;
+    getContent: () => Promise<Delta>;
     /**
      * 添加监听，当内容发生变化时触发监听，传入 Delta
      * @param listener
      */
-    addChangeListener: (listener: (change: EditorDelta) => void) => () => void;
+    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;
@@ -264,6 +439,19 @@ export declare interface EditorEmbeddedObjectOptions {
     };
 }
 
+export declare interface EditorExportOptions {
+    /**
+     * 可导出类型
+     * @description
+     */
+    supportedTypes?: string[];
+    /**
+     * 导出文件
+     * @description
+     */
+    exportFile: (type: string) => Promise<void>;
+}
+
 export declare interface EditorFontFace {
     /**
      * 字体的名称，用于在用户界面上显示的名称
@@ -371,6 +559,16 @@ export declare interface EditorLinkOptions {
     open: (url: string, target: string) => Promise<boolean>;
 }
 
+/**
+ * 可上传文件
+ */
+export declare interface EditorLocalUploadableFile extends EditorBaseUploadableFile {
+    name: string;
+    size: number;
+    mime: string;
+    raw: File;
+}
+
 /**
  * 菜单栏自定义按钮配置
  */
@@ -417,7 +615,7 @@ export declare type EditorMenuCustomButton = {
 /**
  * 菜单栏二级以下的菜单入口
  */
-export declare interface EditorMenuEntryButton {
+export declare interface EditorMenuEntryButton<TName extends string> {
     type: 'entry';
     /**
      * 菜单名称
@@ -427,6 +625,10 @@ export declare interface EditorMenuEntryButton {
      * 菜单图标
      */
     icon?: string;
+    /**
+     * 下一级子菜单
+     */
+    children?: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
 }
 
 /**
@@ -443,7 +645,11 @@ export declare interface EditorMenuEntryConfig<TName extends string> {
      * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
      * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
      */
-    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton>[];
+    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
+    /**
+     * 是否隐藏一级菜单
+     */
+    type?: 'hidden';
 }
 
 /**
@@ -485,9 +691,9 @@ export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record
  */
 export declare interface EditorMenuOptions<TName extends string> {
     /**
-     * 菜单栏是否显示
+     * 菜单栏是否隐藏
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
      * 是否禁用菜单栏所有功能
      */
@@ -565,6 +771,10 @@ export declare interface EditorOptions {
      * 当前操作编辑器的用户信息
      */
     user?: EditorUserOptions;
+    /**
+     * 匿名用户的缺省信息
+     */
+    anonymous?: EditorAnonymousOptions;
     /**
      * i18n 相关设置
      */
@@ -573,10 +783,6 @@ export declare interface EditorOptions {
      * 品牌相关设置
      */
     brand?: EditorBrandOptions;
-    /**
-     * 工具栏相关设置
-     */
-    toolbar?: EditorToolbarOptions;
     /**
      * 编辑器内部资源请求配置
      */
@@ -601,6 +807,14 @@ export declare interface EditorOptions {
      * 编辑器评论设置
      */
     comments?: EditorCommentsOptions;
+    /**
+     * 附件设置
+     */
+    attachment?: EditorAttachmentOptions;
+    /**
+     * 导出设置
+     */
+    export?: EditorExportOptions;
 }
 
 /**
@@ -678,6 +892,17 @@ export declare interface EditorPrintOptions {
     disabled?: boolean;
 }
 
+/**
+ * 远程文件上传
+ */
+export declare interface EditorRemoteUploadableFile extends EditorBaseUploadableFile {
+    src: string;
+    name?: never;
+    size?: never;
+    mime?: never;
+    raw?: never;
+}
+
 /**
  * 编辑器通用接口
  */
@@ -724,6 +949,55 @@ export declare abstract class EditorSDK {
  */
 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、大小、颜色等
@@ -828,11 +1102,11 @@ export declare interface EditorToolbarCustomButtonConfig {
 /**
  * 工具栏内置功能按钮配置
  */
-export declare interface EditorToolbarFeatureButton {
+export declare interface EditorToolbarFeatureButton<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
     /**
      * 按钮类型
      */
-    name: EditorToolbarFeatureButtonName;
+    name: ToolButtonName;
     /**
      * 按钮标签（显示文本）
      */
@@ -841,6 +1115,10 @@ export declare interface EditorToolbarFeatureButton {
      * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
      */
     icon?: string;
+    /**
+     * 按钮是否隐藏
+     */
+    hidden?: boolean;
     /**
      * 按钮是否禁用
      */
@@ -854,8 +1132,8 @@ export declare interface EditorToolbarFeatureButton {
 /**
  * 工具栏内置功能按钮配置
  */
-export declare type EditorToolbarFeatureButtonConfig = {
-    [key in EditorToolbarFeatureButtonName]?: EditorToolbarFeatureButton;
+export declare type EditorToolbarFeatureButtonConfig<ToolButtonName extends string> = {
+    [key in ToolButtonName]?: EditorToolbarFeatureButton<ToolButtonName>;
 };
 
 /**
@@ -894,11 +1172,11 @@ export declare type EditorToolbarFeatureButtonName =
 /**
  * 工具栏相关设置，可以控制工具栏的显示内容
  */
-export declare interface EditorToolbarOptions {
+export declare interface EditorToolbarOptions<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
     /**
      * 控制工具栏显隐状态
      */
-    visible?: boolean;
+    hidden?: boolean;
     /**
      * 是否禁用工具栏所有功能
      */
@@ -906,13 +1184,54 @@ export declare interface EditorToolbarOptions {
     /**
      * 现有按钮的功能配置
      */
-    features?: EditorToolbarFeatureButtonConfig;
+    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;
+}
+
 /**
  * 操作当前编辑器的用户信息
  */
@@ -929,6 +1248,10 @@ export declare interface EditorUserOptions {
      * 用户头像
      */
     avatar?: string;
+    /**
+     * 用户默认头像，当用户未设置头像时显示
+     */
+    defaultAvatar?: string;
 }
 
 /**