@officesdk/editor-sdk-core 0.0.0-9 → 0.0.0-alpha.1

package/diagram.d.ts

@@ -1,358 +0,0 @@
-/**
- *  抽象 Diagram 接口
- */
-export declare abstract class AbstractedDiagramSDK {
-    protected options: DiagramSDKOptions;
-    constructor(options: DiagramSDKOptions);
-    /**
-     * 初始化 Diagram 、加载插件等操作。
-     */
-    abstract init(): Promise<void>;
-    /**
-     * 销毁 Diagram
-     */
-    abstract destroy(): Promise<void>;
-    /**
-     * 将 Diagram 挂载到指定的根节点上，并渲染，
-     * mount 应该在 init 之后调用。
-     * @param root
-     */
-    abstract mount(root: HTMLElement): Promise<void>;
-    /**
-     * 从根节点卸载 Diagram ，对应 `mount` 操作
-     */
-    abstract unmount(): Promise<void>;
-}
-
-/**
- *  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;
-}
-
-/**
- * 编辑器内部资源请求配置
- */
-declare interface EditorAssetsOptions {
-    /**
-     * 通用资源请求代理配置，
-     * 用于套件内部资源请求时代理请求
-     */
-    proxy: HTTPProxy;
-    /**
-     * 资源文件 URL 转换和解析
-     */
-    resolver: EditorAssetsResolver;
-    /**
-     * 图片处理器
-     */
-    imageProcessing: EditorAssetsOssImageProcessing;
-}
-
-/**
- * 基于对象存储的图片处理抽象
- */
-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>;
-}
-
-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;
-}
-
-/**
- * 品牌相关设置，
- * 用于在套件中展示品牌外露信息
- */
-declare interface EditorBrandOptions {
-    /**
-     * 需要显示在品牌展示位的内容，按数组顺序显示
-     */
-    content: Array<{
-        type: 'image';
-        src: string;
-    } | {
-        type: 'text';
-        content: string;
-        color?: string;
-    }>;
-    /**
-     * 品牌展示位的布局信息
-     */
-    layout: {
-        width: string;
-        height: string;
-    };
-}
-
-/**
- * i18n 相关设置
- */
-declare interface EditorI18nOptions {
-    /**
-     * 语言，默认使用浏览器当前环境中的语言
-     */
-    language?: string;
-    /**
-     * 文本方向，默认根据语言自动适配
-     */
-    direction?: 'ltr' | 'rtl';
-}
-
-declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
-
-/**
- * 链接配置，抽象打开链接等操作
- */
-declare interface EditorLinkOptions {
-    /**
-     * 打开链接，如果取消了打开链接操作，返回 false
-     * @param url
-     * @param target
-     * @returns
-     */
-    open: (url: string, target: string) => Promise<boolean>;
-}
-
-/**
- * 编辑器打印设置
- */
-declare interface EditorPrintOptions {
-    /**
-     * 部分套件如果绕过了编辑器预设的打印接口，直接通过拉起了浏览器的打印页面，这时打印页面无法获取到编辑器的内容，
-     * 这种情况下就会 fallback 到这个 options 上，显示一个提示信息。
-     */
-    fallback?: {
-        message: string;
-    };
-    /**
-     * 是否禁用打印功能
-     */
-    disabled?: boolean;
-}
-
-/**
- * 操作当前编辑器的用户信息
- */
-declare interface EditorUserOptions {
-    /**
-     * 用户 ID，用于标识用户
-     */
-    uid: string;
-    /**
-     * 用户名
-     */
-    name: string;
-    /**
-     * 用户头像
-     */
-    avatar?: string;
-}
-
-/**
- * 编辑器外部水印信息
- */
-declare interface EditorWatermarkOptions {
-    /**
-     * 获取用作初始化使用的默认水印
-     */
-    getWatermark: () => MaybePromiseValue<EditorWatermarkResource | null>;
-    /**
-     * 是否必须，如果为 true，编辑器将在初始化时强制渲染水印，
-     * 水印配置信息加载失败将导致编辑器初始化失败
-     */
-    required?: boolean;
-}
-
-declare type EditorWatermarkResource = {
-    type: 'data-url';
-    url: string;
-} | {
-    type: 'object-url';
-    url: string;
-};
-
-/**
- * 请求、响应头
- */
-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';
-
-/**
- * HTTP 代理，用于抽象 HTTP 请求，
- * 将请求代理编辑器外部
- */
-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>;
-}
-
-/**
- * 请求配置
- */
-declare interface HTTPRequestConfig<Data = unknown> {
-    /**
-     * 请求地址
-     */
-    url: string;
-    /**
-     * 请求方法
-     */
-    method?: HTTPMethod;
-    /**
-     * 请求携带数据，主要是 POST、PUT、PATCH 等方法的请求数据
-     */
-    data?: Data;
-    /**
-     * 期望的响应数据类型
-     */
-    responseType?: HTTPResponseType;
-    /**
-     * 请求头
-     */
-    headers?: HTTPHeaders;
-}
-
-/**
- * 响应数据
- */
-declare interface HTTPResponse<Data = unknown> {
-    /**
-     * 响应数据 body
-     */
-    data: Data;
-    /**
-     * 响应状态码
-     */
-    status: number;
-    /**
-     * 响应头
-     */
-    headers: HTTPHeaders;
-}
-
-/**
- * 请求返回类型
- */
-declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
-
-declare type MaybePromiseValue<T> = T | Promise<T>;
-
-export { }