@netless/appliance-plugin 1.1.39 → 1.1.41

package/dist/plugin/backgroundImageQuery.d.ts

@@ -0,0 +1,4 @@
+import type { ISerializableStorageViewData } from "../collector/types";
+import type { HasBackgroundImageParams } from "./types";
+/** Returns whether the appliance provider contains the requested background. */
+export declare function hasApplianceBackgroundImage(storage: ISerializableStorageViewData | undefined, params: HasBackgroundImageParams): boolean;

package/dist/plugin/baseApplianceManager.d.ts

@@ -17,6 +17,8 @@ import { RenderCotrolImple } from "../core/renderCotrol";
 import { MiniMapManagerImpl } from "../component/miniMap/manager";
 import { PluginManager, Plugin } from "../core/plugin";
 import { SelectorApiManager } from "./selectorApi";
+import { BackgroundImageLoadCoordinator } from "../component/backgroundImageLoadCoordinator";
+import type { ReloadBackgroundImageParams, ReloadBackgroundImageResult } from "../component/backgroundImageLoadCoordinator";
 export interface BaseApplianceManagerProps {
     displayer: Displayer<DisplayerCallbacks>;
     plugin?: AppliancePluginLike;
@@ -25,6 +27,7 @@ export interface BaseApplianceManagerProps {
 }
 /** 插件管理器 */
 export declare abstract class BaseApplianceManager {
+    readonly backgroundImageLoadCoordinator: BackgroundImageLoadCoordinator;
     private toolChangePending;
     private toolChangePendingTimer?;
     private pendingSceneChecks;
@@ -198,6 +201,7 @@ export declare abstract class BaseApplianceManager {
     destroyMiniMap(viewId: string): Promise<void>;
     insertIconify(viewId: string, iconifyInfo: IconifyInformation): void;
     insertBackgroundSVG(viewId: string, svgInfo: ISVGUrlInformation): void;
+    reloadBackgroundImage(params: ReloadBackgroundImageParams): ReloadBackgroundImageResult;
     insertBackgroundMarkMap(viewId: string, svgInfo: ISVGMarkmapInformation): Promise<MarkmapId | undefined>;
     updateBackgroundMarkMap(viewId: string, markmapId: string, svgInfo: ISVGMarkmapInformation): void;
     usePlugin(plugin: Plugin): void | undefined;

package/dist/plugin/sceneChangeProgress.d.ts

@@ -0,0 +1,7 @@
+export declare function shouldContinueSceneChange({ previousScenePath, attemptedScenePath, getCurrentScenePath, getTargetScenePath, yieldToNextTask, }: {
+    previousScenePath: string;
+    attemptedScenePath: string;
+    getCurrentScenePath: () => string | undefined;
+    getTargetScenePath: () => string;
+    yieldToNextTask?: () => Promise<void>;
+}): Promise<boolean>;

package/dist/plugin/types.d.ts

@@ -15,6 +15,19 @@ import type { TextEditorInfo, FontWeightType, FontStyleType, TextAlignType, Vert
 import type { IMarkmapOptions } from "../component/svg/markmap-runtime";
 import type { AutoShapeKind, AutoShapeMetrics } from "../core/autoShape/types";
 import type { ShapeOptType } from "../displayer/types";
+import type { BackgroundImageLoadEvent, BackgroundImageLoadOptions, BackgroundImageSource, ReloadBackgroundImageParams, ReloadBackgroundImageResult } from "../component/backgroundImageLoadCoordinator";
+export type { BackgroundImageLoadEvent, BackgroundImageLoadOptions, BackgroundImageSource, ReloadBackgroundImageParams, ReloadBackgroundImageResult, };
+export type BackgroundImageQuerySource = "appliance" | "whiteSdk";
+export interface HasBackgroundImageParams {
+    /** Whiteboard view containing the scene. */
+    viewId: string;
+    /** Exact scene path to query. */
+    scenePath: string;
+    /** Exact background image URL to match. */
+    imageUrl: string;
+    /** Providers included in the aggregate query. */
+    sources: readonly BackgroundImageQuerySource[];
+}
 export type { Room, ImageInformation, Point, Size, Rectangle, RoomMember, RoomState, Player, HotKeys, Camera, Displayer, DisplayerCallbacks, CameraState, View, Cursor, CursorAdapter, RenderEngine, _MemberState, };
 export declare enum ApplianceNames {
     /**
@@ -152,7 +165,7 @@ export type ApplianceAdaptor = {
     cursorAdapter?: CursorAdapter;
     onInitLoadingChange?: (info: ApplianceInitLoadingChangeInfo) => void;
 };
-export type canBindMethodType = keyof Omit<AppliancePluginInstance, "displayer" | "windowManager" | "disableDeviceInputs" | "disableEraseImage" | "disableCameraTransform" | "injectMethodToObject" | "callbacksOn" | "callbacksOnce" | "callbacksOff" | "_injectTargetObject" | "createMiniMap" | "destroyMiniMap" | "filterRenderByUid" | "cancelFilterRender" | "addListener" | "removeListener" | "usePlugin" | "stopDraw" | "setViewLocalScenePathChange" | "getElements" | "hasElements" | "blurText" | "insertMarkmap" | "updateMarkmap" | "insertBackgroundImage" | "getSelectedElements" | "updateSelectedElements" | "copySelectedElements" | "deleteSelectedElements" | "getFloatbarContainer" | "getViewOffsetToContainer">;
+export type canBindMethodType = keyof Omit<AppliancePluginInstance, "displayer" | "windowManager" | "disableDeviceInputs" | "disableEraseImage" | "disableCameraTransform" | "injectMethodToObject" | "callbacksOn" | "callbacksOnce" | "callbacksOff" | "_injectTargetObject" | "createMiniMap" | "destroyMiniMap" | "filterRenderByUid" | "cancelFilterRender" | "addListener" | "removeListener" | "usePlugin" | "stopDraw" | "setViewLocalScenePathChange" | "getElements" | "hasElements" | "hasBackgroundImage" | "blurText" | "insertMarkmap" | "updateMarkmap" | "insertBackgroundImage" | "getSelectedElements" | "updateSelectedElements" | "copySelectedElements" | "deleteSelectedElements" | "getFloatbarContainer" | "getViewOffsetToContainer">;
 export interface AppliancePluginInstance {
     readonly displayer: Displayer;
     readonly currentManager?: ApplianceManagerLike;
@@ -308,6 +321,11 @@ export interface AppliancePluginInstance {
      * @returns 所有元素
      */
     getElements(scenePath?: string, filter?: (toolsType: EToolsKey) => boolean): BaseCollectorReducerAction[];
+    /**
+     * 判断指定 view 和场景中是否存在 URL 完全匹配的背景图。
+     * appliance 实现只在 sources 包含 `appliance` 时参与查询。
+     */
+    hasBackgroundImage(params: HasBackgroundImageParams): boolean;
     /** 停止Draw事件 */
     stopDraw(viewId: string): Promise<void>;
     /** 加载自定义字体，不阻塞插件初始化 */
@@ -328,6 +346,7 @@ export interface AppliancePluginInstance {
     updateMarkmap(viewId: string, markmapId: MarkmapId, markdownInfo: ISVGMarkmapInformation): Promise<void>;
     /** 插入背景图片 */
     insertBackgroundImage(viewId: string, imageInfo: ISVGUrlInformation): void;
+    reloadBackgroundImage(params: ReloadBackgroundImageParams): Promise<ReloadBackgroundImageResult>;
     /**
      * 获取当前 selector 选中元素的快照。
      * @param viewId 多白板下白板ID, 主白板ID为 `mainView`, 其他白板ID为 addApp() return 的 appID。省略时取当前 focuedView / mainView。
@@ -464,6 +483,10 @@ export type ExtrasOptions = {
     markmap?: MarkmapOpt;
     /** 覆盖 selector DOM 的内联样式 */
     overwriteSelectorStyles?: SelectorStyleOverrides;
+    /** 可见背景图片的超时与重试策略。 */
+    backgroundImageLoadOptions?: BackgroundImageLoadOptions;
+    /** Bridge 等集成层使用的背景图片加载事件入口。 */
+    onBackgroundImageLoadEvent?: (event: BackgroundImageLoadEvent) => void;
 };
 export type SelectorStyleOverrides = {
     /** `.appliance-plugin-highlight-box` 外框样式 */
@@ -558,6 +581,8 @@ export type RequiredExtrasOptions = {
     undoRedo: Required<UndoRedoOpt>;
     markmap: Required<MarkmapOpt>;
     overwriteSelectorStyles: SelectorStyleOverrides;
+    backgroundImageLoadOptions: Required<BackgroundImageLoadOptions>;
+    onBackgroundImageLoadEvent?: (event: BackgroundImageLoadEvent) => void;
 };
 export type RequiredAppliancePluginOptions = {
     cdn: CdnOpt;