@plaso-infi/whiteboard-sdk 0.2.1 → 0.2.4

package/dist/cjs/index.d.ts

@@ -1,5 +1,24 @@
 import React$1, { FC, CSSProperties } from 'react';
 
+type PositionLike = {
+    x: number;
+    y: number;
+};
+type Viewbox = {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    scale: number;
+};
+type ViewRect = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+type BorderBox = Omit<Viewbox, 'scale'>;
+
 type DocumentType = 'ppt' | 'pdf' | 'excel' | 'word';
 type FileType = 'image' | 'document' | 'video' | 'audio';
 
@@ -58,10 +77,11 @@ type InfiWebSdkPlugin = {
     beforeInit?: (plugin: InfiSdkPluginType) => void;
 };
 
-declare enum GridType {
-    NONE = 0,
-    LINE = 1,
-    DOT = 2
+type ToolBarType = 'sticker' | 'template' | 'shapes' | 'upload' | 'stickyNote' | 'draw' | 'frame' | 'connectLine' | 'table' | 'timer' | 'mindMap' | 'text' | 'comment' | 'webpage' | 'kanban';
+interface InfiUserInfoT {
+    loginName: string;
+    userName: string;
+    avatarUrl?: string;
 }
 type PreDownloadInfo = any;
 type DownloadConfigT = {
@@ -70,152 +90,6 @@ type DownloadConfigT = {
     imageEnable?: boolean;
     preCheck?: (event: string) => Promise<PreDownloadInfo>;
 };
-type Viewbox = {
-    left: number;
-    top: number;
-    right: number;
-    bottom: number;
-    scale: number;
-};
-type ViewRect = {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-};
-/** websdk 实例类型声明接口 */
-interface InfiWebsdkInstanceType {
-    /**
-     * 设置是否可以编辑
-     * @param couldEdit true: 可编辑; false: 只读
-     */
-    enableEdit: (couldEdit: boolean) => void;
-    /**
-     * 变更白板的画布视野
-     * @param view 白板绘制区域
-     * @param option 变更视野配置项
-     * @description
-     * - left、right、top、bottom：视野左右上下最小边距
-     * - duration：显示变更所需时间，如果填入有效值，则画面会平滑过渡到目标视野, 如果填 0 ，则会立即完成视野变更
-     * @returns {Promise<boolean>} 表示视野变更完成,返回值为false表示当前为强制跟随视野状态，无法主动变更视野
-     */
-    slideToView: (view: ViewRect, option?: {
-        left?: number;
-        top?: number;
-        right?: number;
-        bottom?: number;
-        duration?: number;
-    }) => Promise<boolean>;
-    /**
-     * 向白板中插入图片
-     * @param url 图片文件url地址
-     * @param name 图片文件名称
-     */
-    insertImage: (url: string, name: string) => void;
-    /**
-     * 向白板中插入文档，支持ppt、pdf、excel、word类型
-     * @param url 文档文件url地址
-     * @param name 文档文件名称
-     * @param docType 文档类型, 包括："ppt" | "pdf" | "excel" | "word"
-     */
-    insertDocument: (url: string, name: string, docType: DocumentType) => void;
-    /**
-     * 向白板中插入视频
-     * @param url 视频文件url地址
-     * @param name 视频文件名称
-     */
-    insertVideo: (url: string, name: string) => void;
-    /**
-     * 向白板中插入音频
-     * @param url 音频文件url
-     * @param name 音频文件名称
-     */
-    insertAudio: (url: string, name: string) => void;
-    /** 获取当前白板的画布视野信息 */
-    getCurrentViewData: () => Viewbox | undefined;
-    /**
-     * 启用/关闭演讲者模式
-     * @param en 启用/关闭
-     */
-    enablePresentation: (en?: boolean) => void;
-    /**
-     * 启用/关闭激光笔
-     * @param en 启用/关闭
-     * @returns
-     */
-    enableLaser: (en?: boolean) => void;
-    /** 启用/关闭帧框列表 */
-    toggleFrameListPanel: () => void;
-    /** 唤出历史记录面板 */
-    toggleHistoryPanel: () => void;
-    /** 修改画板背景 */
-    changeGridType: (gridType: GridType) => void;
-    /** 设置跳转元素 */
-    setAnchorElement: (anchorElement?: string) => void;
-    /**
-     * 于白板内显示 toast 消息
-     * @param message 消息
-     * @param duration 显示时长，经过该时长后 toast 消息消失
-     * @return Promise fulfill 表示消息已经消失
-     */
-    showToast: (message: string, duration: number) => Promise<void>;
-    /**
-     * 注册白板事件监听器
-     * TBD： 初期先暴露一些基本事件，比如白板已初始化完毕、白板已销毁完毕等事件
-     * @param evtName 事件名
-     * @param cb 回调函数
-     * @returns 取消注册执行函数
-     */
-    on: <T extends keyof WebsdkEventTypeMap>(evtName: T, cb: (param: WebsdkEventTypeMap[T]) => void) => () => void;
-    /**
-     * 取消注册白板事件监听器
-     * @param evtName 事件名
-     * @param cb 回调函数
-     */
-    off: <T extends keyof WebsdkEventTypeMap>(evtName: T, cb: (param: WebsdkEventTypeMap[T]) => void) => void;
-    /**
-     * 基于影子链接能力获取一次其他画布内用户的视野信息
-     * 注：使用此能力需要首先启用影子链接能力
-     */
-    requestShadowUserViewData(loginName: string): Promise<ShadowViewDataT | null>;
-    /** 销毁白板 sdk 实例 */
-    destroy: () => Promise<void>;
-}
-type ShadowViewDataT = {
-    viewData?: [number, number, number, number];
-};
-type HistoryType = 'browser' | 'hash';
-type RouteConfigT = {
-    /** 设置路由history的类型（默认为browser）*/
-    historyType: HistoryType;
-    /** 路由中指定标识画布唯一性的字段，用于判断是否是跳转至本画布内的其他元素*/
-    boardCompositeKey?: string[];
-};
-type WebsdkEventTypeMap = {
-    /** 白板未完成初始化 */
-    not_initialized: void;
-    /** 已连接至白板服务器 */
-    connected: void;
-    /** 白板服务器连接中 */
-    connecting: void;
-    /** 白板服务器连接失败 */
-    connect_failed: void;
-    /** 白板内部错误 */
-    internal_error: void;
-    /** 因当前白板未处于连接状态，api 调用无效 */
-    api_call_rejected: void;
-    /** 白板资源准备完成，可以进行工具操作 */
-    resource_ready: void;
-    /** 演讲模式状态更新 */
-    presentation_change: boolean;
-};
-/** 当前白板的用户信息 */
-interface InfiUserInfoT {
-    loginName: string;
-    userName: string;
-    avatarUrl?: string;
-}
-type ToolBarType = 'sticker' | 'template' | 'shapes' | 'upload' | 'stickyNote' | 'draw' | 'frame' | 'connectLine' | 'table' | 'timer' | 'mindMap' | 'text' | 'comment' | 'webpage' | 'kanban';
 type FullToolBarWidgetsConfigs = {
     meeting: boolean;
     boardMemberList: boolean;
@@ -237,25 +111,21 @@ type FullToolBarWidgetsConfigs = {
     bottomRightBarVisible?: boolean;
     toolbarConfig?: Partial<Record<ToolBarType, boolean>>;
 };
+type HistoryType = 'browser' | 'hash';
+type RouteConfigT = {
+    /** 设置路由history的类型（默认为browser）*/
+    historyType: HistoryType;
+    /** 路由中指定标识画布唯一性的字段，用于判断是否是跳转至本画布内的其他元素*/
+    boardCompositeKey?: string[];
+};
 type ToolBarWidgetsConfigsT = Partial<FullToolBarWidgetsConfigs>;
 /** 获取白板 websdk 实例的配置参数  */
 interface GetSdkInstanceConfigs {
-    /** 获取画布连接参数的请求函数，画布连接参数为初始化 & 链接服务器使用的加密字符串, 内含应用、白板、用户等信息 */
-    getQueryString: () => Promise<string>;
-    /** 获取AI 鉴权所必要参数 boardId, userId, appid, ts, sign, key */
-    getAiCheckInfo?: () => Promise<AiCheckInfo>;
-    /**
-     * 启用画布影子链接能力，影子链接会额外建立一条链接，用以将其他 recordId 对应画布内的内容同步到当前的画布中
-     * 但需要注意的是，通过影子链接同步过来的元素全部都都处于静止状态，无法选中，无法编辑，但是可以进行文档翻页等
-     * 非常基本的交互
-     */
-    getShadowBoardQuery?: () => Promise<string>;
     /** 当前白板的用户信息 */
     userInfo: InfiUserInfoT;
+    editable?: boolean;
     /** 用以挂载白板 DOM 的 HTML DOM 元素, 白板相关元素会自动 appendChild 至这个元素之内 */
     containerDom: HTMLDivElement;
-    /** 基于 loginName 获取该用户的用户名与头像 url 的方法，由用户提供，方法返回的用户信息用以于白板内作展示 */
-    getUsersInfo: (loginNames: string[]) => Promise<InfiUserInfoT[]>;
     /** 是否应用上一次用户偏好（背景设置、工具栏顺序、视野、颜料色板） */
     preferenceConfigs?: object;
     /** 画布天然提供若干 UI 插槽，分别位于画布页面的左上角与右上角，目前仅支持基于 React 实现 */
@@ -278,6 +148,8 @@ interface GetSdkInstanceConfigs {
         presentationMode?: boolean;
         /** 默认启用激光笔 */
         laserMode?: boolean;
+        /** 默认的画布网格设置，会被用户自己的使用习惯数据覆盖 */
+        defaultGrid?: GridType;
     };
     /** 进入画布时，如果给入该值，则会向 x:0, y:0 处插入模板内容，并尝试移动视野至该位置 */
     initTemplate?: string | {
@@ -295,6 +167,13 @@ interface GetSdkInstanceConfigs {
      * 文件下载配置，enable表示文件下载功能是否开启，preCheck用于获取自定义的文件下载签名
      */
     downloadConfig?: DownloadConfigT;
+    /**
+     * 文件上传配置
+     */
+    uploadConfig?: {
+        /** 是否启用动态ppt */
+        enableDynamicPPT?: boolean;
+    };
     /** 向画布内注入拆件能力，插件可以在画布内部显示， */
     plugins?: InfiWebSdkPlugin[];
     /**
@@ -302,13 +181,25 @@ interface GetSdkInstanceConfigs {
      * 尚提供可以切换不同的画布侧环境的配置项入口。后期会移除该配置项，websdk 仅能使用线上环境
      */
     env?: 'prod' | 'dev' | 'test';
-    getElementLink?: (id: string) => string;
+    getElementLink?: (encodeId: string, id: string) => string;
     /** 链接跳转，返回值为string表示跳转元素id */
     gotoLink?: (link: string) => string | undefined;
     /**
-     * 路由配置，包括设置路由history的类型（默认为browser）、标识画布唯一性的search字段（默认为所有search字段）等
+     * 路由配置，包括设置路由history的类型（默认为browser）、标识画布唯一性的search联合字段（默认为所有search字段）等
      */
     routeConfig?: RouteConfigT;
+    /** 获取画布连接参数的请求函数，画布连接参数为初始化 & 链接服务器使用的加密字符串, 内含应用、白板、用户等信息 */
+    getQueryString: () => Promise<string>;
+    /** 获取AI 鉴权所必要参数 boardId, userId, appid, ts, sign, key */
+    getAiCheckInfo?: () => Promise<AiCheckInfo>;
+    /**
+     * 启用画布影子链接能力，影子链接会额外建立一条链接，用以将其他 recordId 对应画布内的内容同步到当前的画布中
+     * 但需要注意的是，通过影子链接同步过来的元素全部都都处于静止状态，无法选中，无法编辑，但是可以进行文档翻页等
+     * 非常基本的交互
+     */
+    getShadowBoardQuery?: () => Promise<string>;
+    /** 基于 loginName 获取该用户的用户名与头像 url 的方法，由用户提供，方法返回的用户信息用以于白板内作展示 */
+    getUsersInfo: (loginNames: string[]) => Promise<InfiUserInfoT[]>;
 }
 type CustomizeUploader = {
     loaders: {
@@ -332,17 +223,6 @@ type GetSdkInstanceReturnType = Promise<{
     code: 1;
     payload: string;
 }>;
-/** Infi 白板 websdk 全局对象，引入 min.js 后即会挂载至 window 对象上 */
-interface InfiWebSdkType {
-    /**
-     * 获取白板sdk对象
-     * @param getQueryString 白板初始化 & 链接服务器使用的加密字符串, 内涵应用、白板、用户等信息，
-     * 推荐于服务端进行生成，当链接重连但是被白板服务器拒绝后，会自动使用 getQueryString 方法生成新的 queryString 并发起重连
-     * @param configs 白板初始化所需要的配置参数
-     */
-    getSdkInstance: (configs: GetSdkInstanceConfigs) => GetSdkInstanceReturnType;
-    readonly version: string;
-}
 interface AiCheckInfo {
     /** AI操作次数 */
     inPackageRemain: number;
@@ -382,6 +262,183 @@ type AiCheckExtraInfo = {
     model: string;
 };
 
+declare enum GridType {
+    NONE = 0,
+    LINE = 1,
+    DOT = 2
+}
+type ElementMetaData = {
+    id: string;
+    elementType: number;
+    position: PositionLike;
+    size: {
+        width: number;
+        height: number;
+    };
+    scale: number;
+};
+type InsertImageType = {
+    /** 图片文件 */
+    file: File;
+    /** 屏幕位置 */
+    screenPosition?: PositionLike;
+    /** 文件大小 */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /** 是否根据画布比例自动缩放 */
+    autoSize?: boolean;
+};
+/** websdk 实例类型声明接口 */
+interface InfiWebsdkInstanceType {
+    /**
+     * 设置是否可以编辑
+     * @param couldEdit true: 可编辑; false: 只读
+     */
+    enableEdit: (couldEdit: boolean) => void;
+    /**
+     * 变更白板的画布视野
+     * @param view 白板绘制区域
+     * @param option 变更视野配置项
+     * @description
+     * - left、right、top、bottom：视野左右上下最小边距
+     * - duration：显示变更所需时间，如果填入有效值，则画面会平滑过渡到目标视野, 如果填 0 ，则会立即完成视野变更
+     * @returns {Promise<boolean>} 表示视野变更完成,返回值为false表示当前为强制跟随视野状态，无法主动变更视野
+     */
+    slideToView: (view: ViewRect, option?: {
+        left?: number;
+        top?: number;
+        right?: number;
+        bottom?: number;
+        duration?: number;
+    }) => Promise<boolean>;
+    /**
+     * 向白板中插入图片
+     * @param url 图片文件url地址
+     * @param name 图片文件名称
+     */
+    insertImage(url: string, name: string): void;
+    /**
+     * 向白板中插入图片文件
+     * @param imageInfo 图片文件信息
+     * @return 插入成功后返回元素id
+     */
+    insertImage(imageInfo: InsertImageType): Promise<string | null | undefined>;
+    /**
+     * 向白板中插入文档，支持ppt、pdf、excel、word类型
+     * @param url 文档文件url地址
+     * @param name 文档文件名称
+     * @param docType 文档类型, 包括："ppt" | "pdf" | "excel" | "word"
+     */
+    insertDocument: (url: string, name: string, docType: DocumentType) => void;
+    /**
+     * 向白板中插入视频
+     * @param url 视频文件url地址
+     * @param name 视频文件名称
+     */
+    insertVideo: (url: string, name: string) => void;
+    /**
+     * 向白板中插入音频
+     * @param url 音频文件url
+     * @param name 音频文件名称
+     */
+    insertAudio: (url: string, name: string) => void;
+    /** 获取当前白板的画布视野信息 */
+    getCurrentViewData: () => Viewbox | undefined;
+    /**
+     * 启用/关闭演讲者模式
+     * @param en 启用/关闭
+     */
+    enablePresentation: (en?: boolean) => void;
+    /**
+     * 启用/关闭激光笔
+     * @param en 启用/关闭
+     */
+    enableLaser: (en?: boolean) => void;
+    /** 启用/关闭帧框列表 */
+    toggleFrameListPanel: () => void;
+    /** 唤出历史记录面板 */
+    toggleHistoryPanel: () => void;
+    /** 修改画板背景 */
+    changeGridType: (gridType: GridType) => void;
+    /** 设置跳转元素 */
+    setAnchorElement: (anchorElement?: string) => void;
+    /**
+     * 于白板内显示 toast 消息
+     * @param message 消息
+     * @param duration 显示时长，经过该时长后 toast 消息消失
+     * @return Promise fulfill 表示消息已经消失
+     */
+    showToast: (message: string, duration: number) => Promise<void>;
+    /**
+     * 注册白板事件监听器
+     * TBD： 初期先暴露一些基本事件，比如白板已初始化完毕、白板已销毁完毕等事件
+     * @param evtName 事件名
+     * @param cb 回调函数
+     * @returns 取消注册执行函数
+     */
+    on: <T extends keyof WebsdkEventTypeMap>(evtName: T, cb: (param: WebsdkEventTypeMap[T]) => void) => () => void;
+    /**
+     * 取消注册白板事件监听器
+     * @param evtName 事件名
+     * @param cb 回调函数
+     */
+    off: <T extends keyof WebsdkEventTypeMap>(evtName: T, cb: (param: WebsdkEventTypeMap[T]) => void) => void;
+    /**
+     * 基于影子链接能力获取一次其他画布内用户的视野信息
+     * 注：使用此能力需要首先启用影子链接能力
+     */
+    requestShadowUserViewData(loginName: string): Promise<ShadowViewDataT | null>;
+    /** 设置画布的可见区域, 区域外的元素全部不可见 */
+    setViewClip(rect: ViewRect): void;
+    /** 设置画布的聚焦区域，聚焦后，画布的移动和缩放都会在聚焦区域内执行，而不是随意改变 */
+    focusBorderBox(box: BorderBox): void;
+    /** 获取当前画布中全体元素的元数据信息，包括位置、大小等 */
+    getElementsMetaData(): ElementMetaData[] | undefined;
+    /**
+     * 基于文档元素 id 导出 pdf
+     * @description**注: 给入的元素 id 务必是文档类元素的 id （elementType === 8)**
+     * 导出的 pdf 文件会携带画布内的编辑信息，如图形、文本、便签等
+     * @param {string} [cornerWatermark] 文档元素每页右下角的角标图片 url （非必填）
+     */
+    exportPdfFromDocElement(id: string, cornerWatermark: string): Promise<void>;
+    /** 销毁白板 sdk 实例 */
+    destroy: () => Promise<void>;
+}
+type ShadowViewDataT = {
+    viewData?: [number, number, number, number];
+};
+type WebsdkEventTypeMap = {
+    /** 白板未完成初始化 */
+    not_initialized: void;
+    /** 已连接至白板服务器 */
+    connected: void;
+    /** 白板服务器连接中 */
+    connecting: void;
+    /** 白板服务器连接失败 */
+    connect_failed: void;
+    /** 白板内部错误 */
+    internal_error: void;
+    /** 因当前白板未处于连接状态，api 调用无效 */
+    api_call_rejected: void;
+    /** 白板资源准备完成，可以进行工具操作 */
+    resource_ready: void;
+    /** 演讲模式状态更新 */
+    presentation_change: boolean;
+};
+/** Infi 白板 websdk 全局对象，引入 min.js 后即会挂载至 window 对象上 */
+interface InfiWebSdkType {
+    /**
+     * 获取白板sdk对象
+     * @param getQueryString 白板初始化 & 链接服务器使用的加密字符串, 内涵应用、白板、用户等信息，
+     * 推荐于服务端进行生成，当链接重连但是被白板服务器拒绝后，会自动使用 getQueryString 方法生成新的 queryString 并发起重连
+     * @param configs 白板初始化所需要的配置参数
+     */
+    getSdkInstance: (configs: GetSdkInstanceConfigs) => GetSdkInstanceReturnType;
+    readonly version: string;
+}
+
 declare const InfiWebsdk: InfiWebSdkType;
 
 /**
@@ -468,4 +525,4 @@ declare class SvgManager {
     private static _isSymbol;
 }
 
-export { type ComponentProps, type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, HoverTip, type InfiSdkPluginType, type InfiUserInfoT, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type SdkBottomRightPluginSlotType, type SdkPluginSlotType, Setting, SvgIcon, SvgManager, type ToolBarType, type WebsdkEngineType, InfiWebsdk as default, getDocumentType, getFileType };
+export { type ComponentProps, type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, GridType, HoverTip, type InfiSdkPluginType, type InfiUserInfoT, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type SdkBottomRightPluginSlotType, type SdkPluginSlotType, Setting, SvgIcon, SvgManager, type ToolBarType, type WebsdkEngineType, InfiWebsdk as default, getDocumentType, getFileType };

package/dist/cjs/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./index-2d9fe749.js");require("react"),require("react-dom"),require("agora-rtc-sdk-ng"),exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,exports.HoverTip=e.HoverTip,exports.Setting=e.Setting,exports.SvgIcon=e.SvgIcon,exports.SvgManager=e.SvgManager,exports.default=e.InfiWebsdk,exports.getDocumentType=e.getDocumentType,exports.getFileType=e.getFileType;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./index-bcb005e9.js");require("react"),require("react-dom"),require("agora-rtc-sdk-ng"),exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,Object.defineProperty(exports,"GridType",{enumerable:!0,get:function(){return e.GridType}}),exports.HoverTip=e.HoverTip,exports.Setting=e.Setting,exports.SvgIcon=e.SvgIcon,exports.SvgManager=e.SvgManager,exports.default=e.InfiWebsdk,exports.getDocumentType=e.getDocumentType,exports.getFileType=e.getFileType;