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

package/pdf.d.ts

@@ -1,760 +0,0 @@
-/**
- *  抽象 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;
-}
-
-/**
- * 编辑器内部资源请求配置
- */
-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 type EditorMenuCustomButton = {
-    /**
-     * 按钮名称
-     */
-    name: string;
-    /**
-     * 链接
-     */
-    type: 'link';
-    /**
-     * 按钮文本
-     */
-    text: string;
-    /**
-     * 链接地址
-     */
-    url: string;
-} | {
-    /**
-     * 按钮名称
-     */
-    name: string;
-    /**
-     * 按钮，点击后触发 callback 回调
-     */
-    type: 'button';
-    /**
-     * 按钮文本
-     */
-    label: string;
-    /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
-     */
-    icon?: string;
-    /**
-     * 按钮点击事件
-     */
-    callback: () => void;
-};
-
-/**
- * 菜单栏二级以下的菜单入口
- */
-declare interface EditorMenuEntryButton {
-    type: 'entry';
-    /**
-     * 菜单名称
-     */
-    name: string;
-    /**
-     * 菜单图标
-     */
-    icon?: string;
-}
-
-/**
- * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
- * 一级菜单在鼠标悬停时展示二级列表
- */
-declare interface EditorMenuEntryConfig<TName extends string> {
-    /**
-     * 一级菜单名称
-     */
-    name: string;
-    /**
-     * 二级菜单定义，定一个二维数组，用于定义二级菜单的结构，
-     * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
-     * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
-     */
-    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton>[];
-}
-
-/**
- * 菜单栏功能按钮配置
- */
-declare type EditorMenuFeatureButton<TName extends string> = {
-    /**
-     * 隐藏按钮，用作在需要隐藏菜单栏时定义
-     */
-    type: 'hidden';
-    /**
-     * 按钮名称
-     */
-    name: TName;
-} | {
-    type: 'button';
-    /**
-     * 按钮名称
-     */
-    name: TName;
-    /**
-     * 按钮标签（显示文本）
-     */
-    label: string;
-    /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
-     */
-    icon?: string;
-};
-
-/**
- * 菜单栏按钮配置
- */
-declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
-
-/**
- * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
- * 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
- */
-declare interface EditorMenuOptions<TName extends string> {
-    /**
-     * 菜单栏是否显示
-     */
-    visible?: boolean;
-    /**
-     * 是否禁用菜单栏所有功能
-     */
-    disabled?: boolean;
-    /**
-     * 菜单栏一级菜单配置
-     */
-    entries?: EditorMenuEntryConfig<TName>[];
-    /**
-     * 菜单栏功能按钮配置
-     */
-    features?: Partial<EditorMenuFeatureButtonConfig<TName>>;
-    /**
-     * 自定义按钮配置
-     */
-    custom?: EditorMenuCustomButton[];
-}
-
-/**
- * 大纲目录接口
- */
-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>;
-}
-
-/**
- * 大纲目录项条目
- */
-declare interface EditorOutlineItem<Content = unknown> {
-    /**
-     * 目录项 ID
-     */
-    id: string;
-    /**
-     * 目录项层级
-     */
-    level: number;
-    /**
-     * 目录项内容
-     */
-    content: Content;
-}
-
-/**
- * 大纲目录初始化参数，
- * 用于配置大纲目录的行为和外观。
- */
-declare interface EditorOutlineOptions {
-    /**
-     * 初始化编辑器时是否显示大纲目录，
-     * 默认为 false。
-     */
-    visible?: 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>;
-
-/**
- * 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 { }