@netless/appliance-plugin 1.1.19-beta.1 → 1.1.19-beta.2

package/dist/plugin/applianceMultiPlugin.d.ts

@@ -1,5 +1,5 @@
 import { InvisiblePlugin } from "./external";
-import { Room, Displayer, AppliancePluginAttributes, AppliancePluginOptions, AppliancePluginInstance, Logger, ApplianceAdaptor } from "./types";
+import { Room, Displayer, AppliancePluginAttributes, AppliancePluginInstance, Logger, ApplianceAdaptor, RequiredAppliancePluginOptions } from "./types";
 import type { WindowManager } from "./multi/applianceMultiManager";
 import { ApplianceMultiManager } from "./multi/applianceMultiManager";
 /**
@@ -9,11 +9,10 @@ export declare class ApplianceMultiPlugin extends InvisiblePlugin<AppliancePlugi
     static readonly kind: string;
     static currentManager?: ApplianceMultiManager;
     static logger: Logger;
-    static options: AppliancePluginOptions;
     static getInstance(remake: WindowManager, adaptor: ApplianceAdaptor): Promise<AppliancePluginInstance>;
     static onCreate(plugin: InvisiblePlugin<AppliancePluginAttributes, any>): void;
     static createApplianceMultiPlugin(d: Room, kind: string): Promise<ApplianceMultiPlugin>;
-    static createCurrentManager: (remake: WindowManager, options: AppliancePluginOptions, plugin: ApplianceMultiPlugin) => void;
+    static createCurrentManager: (remake: WindowManager, options: RequiredAppliancePluginOptions, plugin: ApplianceMultiPlugin) => void;
     private get isReplay();
     private get callbackName();
     init(displayer: Displayer): void;

package/dist/plugin/applianceSinglePlugin.d.ts

@@ -1,5 +1,5 @@
 import { InvisiblePlugin } from "./external";
-import { CursorAdapter, Room, AppliancePluginAttributes, AppliancePluginOptions, AppliancePluginInstance, Logger, ApplianceAdaptor, Displayer } from "./types";
+import { CursorAdapter, Room, AppliancePluginAttributes, AppliancePluginInstance, Logger, ApplianceAdaptor, Displayer, RequiredAppliancePluginOptions, Player } from "./types";
 import { ApplianceSingleManager } from "./single/applianceSingleManager";
 /**
  * 单白板教具
@@ -9,11 +9,10 @@ export declare class ApplianceSinglePlugin extends InvisiblePlugin<AppliancePlug
     static cursorAdapter?: CursorAdapter;
     static currentManager?: ApplianceSingleManager;
     static logger: Logger;
-    static options: AppliancePluginOptions;
-    static getInstance(remake: Displayer, adaptor: ApplianceAdaptor): Promise<AppliancePluginInstance>;
+    static getInstance(remake: Player | Room, adaptor: ApplianceAdaptor): Promise<AppliancePluginInstance>;
     static onCreate(plugin: InvisiblePlugin<AppliancePluginAttributes, any>): void;
     static createAppliancePlugin(d: Room, kind: string): Promise<ApplianceSinglePlugin>;
-    static createCurrentManager: (displayer: Displayer, options: AppliancePluginOptions, plugin?: ApplianceSinglePlugin) => void;
+    static createCurrentManager: (displayer: Displayer, options: RequiredAppliancePluginOptions, plugin?: ApplianceSinglePlugin) => void;
     /**
      * 房间实例化时，将当前实例对displayer外部API的添加内部处理逻辑;
      * @param displayer

package/dist/plugin/baseApplianceManager.d.ts

@@ -1,9 +1,9 @@
 import EventEmitter2 from "eventemitter2";
-import { MemberState, AppliancePluginLike, AppliancePluginOptions } from "./types";
+import { MemberState, AppliancePluginLike } from "./types";
 import { Collector, ViewId } from "../collector";
 import { RoomMemberManager } from "../members";
 import { TextEditorManager } from "../component/textEditor";
-import type { Camera, Displayer, DisplayerCallbacks, IconifyInformation, Player, PriorityType, Rectangle, Room, RoomMember, _ArrayTrue } from "./types";
+import type { Camera, Displayer, DisplayerCallbacks, IconifyInformation, Player, PriorityType, Rectangle, RequiredAppliancePluginOptions, Room, RoomMember, _ArrayTrue } from "./types";
 import { CursorManager } from "../cursors";
 import { ViewContainerManager } from "./baseViewContainerManager";
 import { MasterControlForWorker } from "../core/mainEngine";
@@ -17,7 +17,7 @@ import { PluginManager, Plugin } from "../core/plugin";
 export interface BaseApplianceManagerProps {
     displayer: Displayer<DisplayerCallbacks>;
     plugin?: AppliancePluginLike;
-    options: AppliancePluginOptions;
+    options: RequiredAppliancePluginOptions;
 }
 /** 插件管理器 */
 export declare abstract class BaseApplianceManager {
@@ -38,7 +38,7 @@ export declare abstract class BaseApplianceManager {
     priority: PriorityType;
     effectResolve?: (value: boolean) => void;
     readonly hotkeyManager: HotkeyManager;
-    readonly pluginOptions: AppliancePluginOptions;
+    readonly pluginOptions: RequiredAppliancePluginOptions;
     readonly roomMember: RoomMemberManager;
     readonly cursor: CursorManager;
     readonly textEditorManager: TextEditorManager;

package/dist/plugin/baseViewContainerManager.d.ts

@@ -114,6 +114,8 @@ export declare abstract class AppViewDisplayerManager {
         x: any;
         y: any;
     };
+    get isBezier(): boolean;
+    get maxDrawCount(): number;
     private checkConsumeCount;
     protected mousedown: (e: MouseEvent) => void;
     protected mousemove: (e: MouseEvent) => void;
@@ -175,6 +177,8 @@ export declare abstract class MainViewDisplayerManager {
         x: any;
         y: any;
     };
+    get isBezier(): boolean;
+    get maxDrawCount(): number;
     /** 检查是否超过最大绘制数量 */
     private checkConsumeCount;
     protected mousedown: (e: MouseEvent) => void;

package/dist/plugin/const.d.ts

@@ -1,38 +1,5 @@
+import { RequiredExtrasOptions } from "./types";
 export declare const pkg_version: string;
 export declare const pkg_name: string;
 export declare const Use_WorkSpace: string;
-export declare const DefaultAppliancePluginOptions: {
-    syncOpt: {
-        interval: number;
-    };
-    cdn: {
-        subWorkerUrl: string;
-        fullWorkerUrl: string;
-    };
-    cursor: {
-        expirationTime: number;
-    };
-    bufferSize: {
-        full: number;
-        sub: number;
-    };
-    bezier: {
-        maxDrawCount: number;
-        combineUnitTime: number;
-    };
-    pencilEraser: {
-        useBitMap: boolean;
-        maxImageWidth: number;
-        maxImageHeight: number;
-        maxCombineTime: number;
-    };
-    strokeWidth: {
-        min: number;
-        max: number;
-    };
-    textEditor: {
-        showFloatBar: boolean;
-        canSelectorSwitch: boolean;
-        rightBoundBreak: boolean;
-    };
-};
+export declare const DefaultAppliancePluginExtrasOptions: Required<Omit<RequiredExtrasOptions, "canvasOpt">>;

package/dist/plugin/types.d.ts

@@ -290,9 +290,12 @@ export type Logger = {
     readonly warn: (...messages: any[]) => void;
     readonly error: (...messages: any[]) => void;
 };
-export type AppliancePluginOptions = {
-    /** cdn配置项 */
-    cdn: CdnOpt;
+export type ExtrasOptions = {
+    /** 是否使用 worker, 默认值为 ``auto``
+     * auto: 自动选择(如果浏览器支持 offscreenCanvas 则使用 webWorker, 否则使用主线程)
+     * mainThread: 使用主线程
+     */
+    useWorker?: UseWorkerType;
     /** 同步数据配置项 */
     syncOpt?: SyncOpt;
     /** 画布配置项 */
@@ -310,6 +313,29 @@ export type AppliancePluginOptions = {
     /** 文字编辑器配置项 */
     textEditor?: TextEditorOpt;
 };
+export type AppliancePluginOptions = {
+    /** cdn配置项 */
+    cdn: CdnOpt;
+    /** 额外配置项 */
+    extras?: ExtrasOptions;
+};
+export type RequiredExtrasOptions = {
+    useWorker: Required<UseWorkerType>;
+    syncOpt: Required<SyncOpt>;
+    canvasOpt: Required<CanvasOpt>;
+    cursor: Required<CursorOpt>;
+    bufferSize: Required<BufferSizeOpt>;
+    bezier: Required<BezierOpt>;
+    pencilEraser: Required<PencilEraserOpt>;
+    strokeWidth: Required<StrokeWidthOpt>;
+    textEditor: Required<TextEditorOpt>;
+};
+export type RequiredAppliancePluginOptions = {
+    cdn: CdnOpt;
+    extras: Required<Omit<ExtrasOptions, "canvasOpt">> & {
+        canvasOpt?: CanvasOpt;
+    };
+};
 export interface AppliancePluginAttributes {
     [key: string]: ISerializableStorageViewData | ISerializableEventData;
 }
@@ -352,7 +378,9 @@ export type SyncOpt = {
      * 默认值：200 (每秒同步5次)
      *
      */
-    interval?: number;
+    interval: number;
+    /** 是否开启平滑同步, 默认开启 */
+    smoothSync?: boolean;
 };
 export type CanvasOpt = {
     /** 指定画布上下文类型 */
@@ -364,15 +392,12 @@ export type CdnOpt = {
     fullWorkerUrl?: string;
     /** sub worker url 地址, 绘制一帧数据的线程 */
     subWorkerUrl?: string;
-    /** 是否使用 worker, 默认值为 ``auto``
-     * auto: 自动选择(如果浏览器支持 offscreenCanvas 则使用 webWorker, 否则使用主线程)
-     * mainThread: 使用主线程
-     */
-    useWorker?: UseWorkerType;
 };
 export type CursorOpt = {
+    /** 是否启用指针 */
+    enable: boolean;
     /** 指针消失过期时间 */
-    expirationTime: number;
+    expirationTime?: number;
 };
 export type BufferSizeOpt = {
     /** 分配给绘制完整数据cancanvas 缓存大小 */
@@ -381,20 +406,22 @@ export type BufferSizeOpt = {
     sub: number;
 };
 export type BezierOpt = {
+    /** 是否开启贝塞尔曲线 */
+    enable: boolean;
     /** 合并处理贝塞尔曲线的单位时间，单位：毫秒 */
-    combineUnitTime: number;
-    /** 贝塞尔曲线最大绘制数量 */
-    maxDrawCount: number;
+    combineUnitTime?: number;
+    /** 贝塞尔曲线最大绘制点数 */
+    maxDrawCount?: number;
 };
 export type PencilEraserOpt = {
     /** 是否使用位图方式局部橡皮擦 */
     useBitMap: boolean;
     /** 最大图片宽度 */
-    maxImageWidth: number;
+    maxImageWidth?: number;
     /** 最大图片高度 */
-    maxImageHeight: number;
+    maxImageHeight?: number;
     /** 最长合并橡皮擦处理时间间隔，单位：毫秒 */
-    maxCombineTime: number;
+    maxCombineTime?: number;
 };
 export type TextEditorOpt = {
     /** 是否显示浮动栏 */