@plaso-infi/whiteboard-sdk 0.0.3

package/dist/cjs/index.d.ts

@@ -0,0 +1,112 @@
+type PositionLike = {
+    x: number;
+    y: number;
+};
+type Viewbox = {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    scale: number;
+};
+/** websdk 实例类型声明接口 */
+interface InfiWebsdkInstanceType {
+    /**
+     * 设置是否可以编辑
+     * @param couldEdit true: 可编辑; false: 只读
+     */
+    enableEdit: (couldEdit: boolean) => void;
+    /**
+     * 变更白板的画布视野
+     * @param position 白板绘制区域左上角的坐标值
+     * @param scale 白板当前的画布显示缩放值
+     * @param time 显示变更所需时间，如果填入有效值，则画面会平滑过渡到目标视野, 如果填 0 ，则会立即完成视野变更
+     * @returns Promise fulfill 表示移动视野动作执行完成
+     */
+    slideToView: (position: PositionLike, scale: number, time: number) => Promise<void>;
+    /** 获取当前白板的画布视野信息 */
+    getCurrentViewData: () => Viewbox;
+    /**
+     * 于白板内显示 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;
+    /** 销毁白板 sdk 实例 */
+    destroy: () => void;
+}
+type WebsdkEventTypeMap = {
+    /** 白板未完成初始化 */
+    not_initialized: void;
+    /** 已连接至白板服务器 */
+    connected: void;
+    /** 白板服务器连接中 */
+    connecting: void;
+    /** 白板服务器连接失败 */
+    connect_failed: void;
+    /** 白板内部错误 */
+    internal_error: void;
+    /** 因当前白板未处于连接状态，api 调用无效 */
+    api_call_rejected: void;
+};
+/** 当前白板的用户信息 */
+interface UserInfoT {
+    loginName: string;
+    userName: string;
+    avatarUrl?: string;
+}
+/** 获取白板 websdk 实例的配置参数  */
+interface GetSdkInstanceConfigs {
+    /** 白板初始化 & 链接服务器使用的加密字符串, 内涵应用、白板、用户等信息， */
+    getQueryString: () => Promise<string>;
+    /** 当前白板的用户信息 */
+    userInfo: UserInfoT;
+    /** 用以挂载白板 DOM 的 HTML DOM 元素, 白板相关元素会自动 appendChild 至这个元素之内 */
+    containerDom: HTMLDivElement;
+    /** 初始状态下是否默认可编辑, 可基于 InfiWebsdkInstanceType.enableEdit API 进行后续控制 */
+    initEditable?: boolean;
+    /** 基于 loginName 获取该用户的用户名与头像 url 的方法，由用户提供，方法返回的用户信息用以于白板内作展示 */
+    getUsersInfo: (loginNames: string[]) => Promise<UserInfoT[]>;
+}
+/**
+ * 获取白板sdk对象方法的返回值类型，值为对象形式
+ * * 对象内 code 值如果为 0, 则表示白板初始化参数验证完毕， payload 为 websdk 的对象实例
+ * * 对象内 code 如果不为 0, 则表示白板初始化失败，payload 为错误提示消息
+ */
+type GetSdkInstanceReturnType = Promise<{
+    code: 0;
+    payload: InfiWebsdkInstanceType;
+} | {
+    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;
+}
+
+declare const InfiWebsdk: InfiWebSdkType;
+
+export { type InfiWebsdkInstanceType, InfiWebsdk as default };

package/dist/cjs/index.js

@@ -0,0 +1 @@
+"use strict";var e=require("./index-7d60a2b0.js");require("ali-oss"),module.exports=e.InfiWebsdk;