@plaso-infi/whiteboard-sdk 0.1.8 → 0.2.0

package/dist/cjs/index.d.ts

@@ -1,11 +1,31 @@
-import { GridType } from '@plasosdk/upime-sdk';
-import React$1 from 'react';
+import React$1, { FC, CSSProperties } from 'react';
 
 type DocumentType = 'ppt' | 'pdf' | 'excel' | 'word';
 type FileType = 'image' | 'document' | 'video' | 'audio';
 
 type WebsdkEngineType = {
     customFoldableTools?: SdkPluginSlotType[];
+    customBottomRightTools?: SdkBottomRightPluginSlotType[];
+};
+type ComponentProps = {
+    iconClassName?: string;
+};
+/**
+ *  提供给外部放置右下方自定义工具的插件，可参考该声明书写你的代码
+ */
+type SdkBottomRightPluginSlotType = {
+    /** 插件 key，需要保证唯一 */
+    key: string;
+    /** 插件名称，会给予 hover tooltip 展示字段名，不存在则不展示 */
+    name?: string;
+    /** 图标，可以是自定义组件也可以是画布提供的 svg  */
+    icon: string | FC<ComponentProps>;
+    /** 点击行为 */
+    onClick?: CB;
+    /** 类名 */
+    className?: string;
+    /** 样式 */
+    style?: CSSProperties;
 };
 /** 在使用画布插件提供给外部的插件 UI 容器，如果需要插件在画布右上方出现功能入口，可以参考本类型声明来书写你的插件代码 */
 type SdkPluginSlotType = {
@@ -38,6 +58,16 @@ type InfiWebSdkPlugin = {
     beforeInit?: (plugin: InfiSdkPluginType) => void;
 };
 
+declare enum GridType {
+    NONE = 0,
+    LINE = 1,
+    DOT = 2
+}
+type PreDownloadInfo = any;
+type DownloadConfigT = {
+    enable: boolean;
+    preCheck?: (event: string) => Promise<PreDownloadInfo>;
+};
 type Viewbox = {
     left: number;
     top: number;
@@ -53,8 +83,6 @@ type ViewRect = {
 };
 /** websdk 实例类型声明接口 */
 interface InfiWebsdkInstanceType {
-    /** 白板背景类型 */
-    gridType: GridType;
     /**
      * 设置是否可以编辑
      * @param couldEdit true: 可编辑; false: 只读
@@ -102,7 +130,7 @@ interface InfiWebsdkInstanceType {
      */
     insertAudio: (url: string, name: string) => void;
     /** 获取当前白板的画布视野信息 */
-    getCurrentViewData: () => Viewbox;
+    getCurrentViewData: () => Viewbox | undefined;
     /**
      * 启用/关闭演讲者模式
      * @param en 启用/关闭
@@ -147,7 +175,7 @@ interface InfiWebsdkInstanceType {
      */
     requestShadowUserViewData(loginName: string): Promise<ShadowViewDataT | null>;
     /** 销毁白板 sdk 实例 */
-    destroy: () => void;
+    destroy: () => Promise<void>;
 }
 type ShadowViewDataT = {
     viewData?: [number, number, number, number];
@@ -169,8 +197,6 @@ type WebsdkEventTypeMap = {
     resource_ready: void;
     /** 演讲模式状态更新 */
     presentation_change: boolean;
-    /** 白板背景更新 */
-    grid_type_change: GridType;
 };
 /** 当前白板的用户信息 */
 interface UserInfoT {
@@ -205,6 +231,8 @@ type ToolBarWidgetsConfigsT = Partial<FullToolBarWidgetsConfigs>;
 interface GetSdkInstanceConfigs {
     /** 获取画布连接参数的请求函数，画布连接参数为初始化 & 链接服务器使用的加密字符串, 内含应用、白板、用户等信息 */
     getQueryString: () => Promise<string>;
+    /** 获取AI 鉴权所必要参数 boardId, userId, appid, ts, sign, key */
+    getAiCheckInfo?: () => Promise<AiCheckInfo>;
     /**
      * 启用画布影子链接能力，影子链接会额外建立一条链接，用以将其他 recordId 对应画布内的内容同步到当前的画布中
      * 但需要注意的是，通过影子链接同步过来的元素全部都都处于静止状态，无法选中，无法编辑，但是可以进行文档翻页等
@@ -217,6 +245,8 @@ interface GetSdkInstanceConfigs {
     containerDom: HTMLDivElement;
     /** 基于 loginName 获取该用户的用户名与头像 url 的方法，由用户提供，方法返回的用户信息用以于白板内作展示 */
     getUsersInfo: (loginNames: string[]) => Promise<UserInfoT[]>;
+    /** 是否应用上一次用户偏好（背景设置、工具栏顺序、视野、颜料色板） */
+    preferenceConfigs?: object;
     /** 画布天然提供若干 UI 插槽，分别位于画布页面的左上角与右上角，目前仅支持基于 React 实现 */
     uiSlots?: {
         /**
@@ -250,6 +280,10 @@ interface GetSdkInstanceConfigs {
      * - toolbarConfig:用于配置左侧工具栏中显示的工具，不配置时显示默认工具
      */
     toolbarWidgetsConfigs?: ToolBarWidgetsConfigsT;
+    /**
+     * 文件下载配置，enable表示文件下载功能是否开启，preCheck用于获取自定义的文件下载签名
+     */
+    downloadConfig?: DownloadConfigT;
     /** 向画布内注入拆件能力，插件可以在画布内部显示， */
     plugins?: InfiWebSdkPlugin[];
     /**
@@ -291,6 +325,44 @@ interface InfiWebSdkType {
     getSdkInstance: (configs: GetSdkInstanceConfigs) => GetSdkInstanceReturnType;
     readonly version: string;
 }
+interface AiCheckInfo {
+    /** AI操作次数 */
+    inPackageRemain: number;
+    /** 其他来源AI操作次数，比如团队购买次数 */
+    outPackageRemain: number;
+    /** 鉴权信息,boardId,userId,appid,ts,sign,key,modal?,event? */
+    extraInfo: AiCheckExtraInfo | {
+        [x: string]: unknown;
+    };
+}
+type AiCheckExtraInfo = {
+    /**
+     * 应用 ID，可于开发者门户/应用管理中查看 appId。使用白板 sdk 的必要参数之一。如若错误则不能使用白板
+     *
+     * **注：**
+     * 此信息为敏感信息，请尽量不要写在前端项目中
+     */
+    appId: string;
+    /** 登入的用户 ID，同一 userId，画布侧会视为同一个用户 */
+    userId: string;
+    /** 白板 ID，用于唯一标识画布  */
+    boardId: string;
+    /** 当前时间戳。*/
+    ts: number;
+    /** 16 位 uuid，用于标识本次操作 */
+    key: string;
+    /**
+     * 通过加密算法加密的 AI 鉴权所需参数
+     *
+     * **注：**
+     * 请尽量让服务端生成该参数，在前端代码中生成该参数相当于直接暴露了加密算法
+     **/
+    sign: string;
+    /** 事件类型，AI 鉴权场景就是默认值 'ai' */
+    event: string;
+    /** 大数据模型，当前默认值 wenxin' */
+    model: string;
+};
 
 declare const InfiWebsdk: InfiWebSdkType;
 
@@ -321,10 +393,33 @@ type PropT = {
 };
 declare const SvgIcon: React$1.FC<PropT>;
 
+type HoverTipPropsT = {
+    content: string;
+    placement?: 'top' | 'left' | 'bottom' | 'right' | 'leftBottom';
+    /** hoverTip 的样式数据 */
+    className?: string;
+    rootClass?: string;
+    /** 是否允许显示，默认为 true */
+    allowShow?: boolean;
+    customStyle?: CSSProperties;
+    tipContainerStyle?: CSSProperties;
+    children: React$1.ReactNode;
+};
+type HoverTipRefT = {
+    rootRef: HTMLDivElement | null;
+};
+/** 注意：仅在pc端使用 */
+declare const HoverTip: React$1.ForwardRefExoticComponent<HoverTipPropsT & React$1.RefAttributes<HoverTipRefT>>;
+
 interface Icon {
     [key: string]: string;
 }
 declare class SvgManager {
+    /**
+     * 一般用于在项目初始化的时候统一加载资源，功能跟 add 方法一样
+     * 存在的意义是增加语义化
+     * @param icons svg 的id和内容的map
+     */
     static load(icons: Icon): void;
     /**
      * 批量添加svg资源，如果在当前 svgContainer 发现 id 相等的<symbol>内容会被替换
@@ -340,6 +435,11 @@ declare class SvgManager {
      * @returns undefined
      */
     static replace(icons: Icon, svgContainer?: SVGElement): void;
+    /**
+     * 生成 symbol map
+     * @param icons icons svg 的id和内容的map
+     * @returns Icon
+     */
     static createSymbolMap(icons: {
         [type: string]: string;
     }): {};
@@ -347,6 +447,7 @@ declare class SvgManager {
     private static _createSvgContainer;
     private static _createDomByHtmlString;
     private static _findBodySvgContainer;
+    private static _isSymbol;
 }
 
-export { type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, type InfiSdkPluginType, type InfiWebSdkPlugin, type InfiWebsdkInstanceType, type SdkPluginSlotType, Setting, SvgIcon, SvgManager, type ToolBarType, type WebsdkEngineType, InfiWebsdk as default, getDocumentType, getFileType };
+export { type ComponentProps, type CustomizeUploader, FULL_TOOLBAR_CONFIG, type GetSdkInstanceConfigs, HoverTip, type InfiSdkPluginType, 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-1d264621.js");require("react"),require("react-dom"),exports.FULL_TOOLBAR_CONFIG=e.FULL_TOOLBAR_CONFIG,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-f96b4a50.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;