@netless/appliance-plugin 1.1.40 → 1.1.41

package/README.md

@@ -789,6 +789,37 @@ plugin.insertBackgroundImage(viewId, {
 })
 ```
 
+##### Query Background Image
+
+Query whether an appliance background image with the exact persisted URL exists
+in a specific view and scene. This API does not depend on the internally
+generated UUID.
+
+```ts
+const exists = plugin.hasBackgroundImage({
+    viewId: 'mainView',
+    scenePath: '/init',
+    imageUrl: 'https://example.com/background.png',
+    sources: ['appliance'],
+});
+
+if (!exists) {
+    plugin.insertBackgroundImage('mainView', {
+        src: 'https://example.com/background.png',
+        uuid: `background-image-${Date.now()}`,
+        centerX: 0,
+        centerY: 0,
+        width: 200,
+        height: 200,
+        locked: true,
+    });
+}
+```
+
+`imageUrl` is compared with the stored original `src` using strict string
+equality, including query parameters and fragments. The appliance provider only
+participates when `sources` contains `"appliance"`.
+
 ##### Handwriting graphics automatic association function:`autoDraw`, need to combine [@netless/appliance-extend-auto-draw-plugin](https://www.npmjs.com/package/@netless/appliance-extend-auto-draw-plugin)
 ```js
 export interface AutoDrawOptions {

package/dist/appliance-plugin.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-DoIyQYzA.js");exports.ActiveContainerType=e.ActiveContainerType;exports.ApplianceMultiPlugin=e.ApplianceMultiPlugin;exports.ApplianceNames=e.ApplianceNames;exports.AppliancePluginCursorNames=e.AppliancePluginCursorNames;exports.ApplianceSigleWrapper=e.ApplianceSigleWrapper;exports.ApplianceSinglePlugin=e.ApplianceSinglePlugin;exports.Cursor_Hover_Id=e.Cursor_Hover_Id;exports.ECanvasShowType=e.ECanvasShowType;exports.EDataType=e.EDataType;exports.EForceStopReason=e.EForceStopReason;exports.EImageType=e.EImageType;exports.EMatrixrRelationType=e.EMatrixrRelationType;exports.EOperationType=e.EOperationType;exports.EPostMessageType=e.EPostMessageType;exports.ERenderFilterType=e.ERenderFilterType;exports.ESVGType=e.ESVGType;exports.EScaleType=e.EScaleType;exports.EStrokeType=e.EStrokeType;exports.EToolsKey=e.EToolsKey;exports.ElayerType=e.ElayerType;exports.EmitEventType=e.EmitEventType;exports.EventMessageType=e.EventMessageType;exports.EventWorkState=e.EventWorkState;exports.EvevtWorkState=e.EventWorkState;exports.InternalMsgEmitterType=e.InternalMsgEmitterType;exports.Main_View_Id=e.Main_View_Id;exports.Plugin=e.Plugin;exports.ShapeType=e.ShapeType;exports.Task_Time_Interval=e.Task_Time_Interval;exports.WorkerCanvasContextBlacklistLevel=e.WorkerCanvasContextBlacklistLevel;exports.WorkerImageBitmapFeatureBlacklistLevel=e.WorkerImageBitmapFeatureBlacklistLevel;exports.WorkerMaskTextureFormatBlacklistLevel=e.WorkerMaskTextureFormatBlacklistLevel;exports.WorkerMaskTextureUploadBlacklistLevel=e.WorkerMaskTextureUploadBlacklistLevel;exports.WorkerRenderModeBlacklistLevel=e.WorkerRenderModeBlacklistLevel;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-DrGUJkFH.js");exports.ActiveContainerType=e.ActiveContainerType;exports.ApplianceMultiPlugin=e.ApplianceMultiPlugin;exports.ApplianceNames=e.ApplianceNames;exports.AppliancePluginCursorNames=e.AppliancePluginCursorNames;exports.ApplianceSigleWrapper=e.ApplianceSigleWrapper;exports.ApplianceSinglePlugin=e.ApplianceSinglePlugin;exports.Cursor_Hover_Id=e.Cursor_Hover_Id;exports.ECanvasShowType=e.ECanvasShowType;exports.EDataType=e.EDataType;exports.EForceStopReason=e.EForceStopReason;exports.EImageType=e.EImageType;exports.EMatrixrRelationType=e.EMatrixrRelationType;exports.EOperationType=e.EOperationType;exports.EPostMessageType=e.EPostMessageType;exports.ERenderFilterType=e.ERenderFilterType;exports.ESVGType=e.ESVGType;exports.EScaleType=e.EScaleType;exports.EStrokeType=e.EStrokeType;exports.EToolsKey=e.EToolsKey;exports.ElayerType=e.ElayerType;exports.EmitEventType=e.EmitEventType;exports.EventMessageType=e.EventMessageType;exports.EventWorkState=e.EventWorkState;exports.EvevtWorkState=e.EventWorkState;exports.InternalMsgEmitterType=e.InternalMsgEmitterType;exports.Main_View_Id=e.Main_View_Id;exports.Plugin=e.Plugin;exports.ShapeType=e.ShapeType;exports.Task_Time_Interval=e.Task_Time_Interval;exports.WorkerCanvasContextBlacklistLevel=e.WorkerCanvasContextBlacklistLevel;exports.WorkerImageBitmapFeatureBlacklistLevel=e.WorkerImageBitmapFeatureBlacklistLevel;exports.WorkerMaskTextureFormatBlacklistLevel=e.WorkerMaskTextureFormatBlacklistLevel;exports.WorkerMaskTextureUploadBlacklistLevel=e.WorkerMaskTextureUploadBlacklistLevel;exports.WorkerRenderModeBlacklistLevel=e.WorkerRenderModeBlacklistLevel;

package/dist/appliance-plugin.mjs

@@ -1,4 +1,4 @@
-import { I as s, J as r, K as t, L as l, N as p, P as i, C as n, p as o, b as T, Q as E, w as y, z as k, R as v, a as c, U as g, d as u, W as m, X as S, c as M, Y as W, E as d, Z as C, e as I, e as _, _ as A, u as B, $ as L, a0 as P, T as x, a1 as R, a2 as F, a3 as w, a4 as N, a5 as h } from "./index-GpA_9BZu.mjs";
+import { I as s, J as r, K as t, L as l, N as p, P as i, C as n, p as o, b as T, Q as E, w as y, z as k, R as v, a as c, U as g, d as u, W as m, X as S, c as M, Y as W, E as d, Z as C, e as I, e as _, _ as A, u as B, $ as L, a0 as P, T as x, a1 as R, a2 as F, a3 as w, a4 as N, a5 as h } from "./index-WMF2MmW5.mjs";
 export {
   s as ActiveContainerType,
   r as ApplianceMultiPlugin,

package/dist/{bridge-b23MKtwT.mjs → bridge-BNKS_R2l.mjs}

@@ -54,7 +54,7 @@ class g {
   }
 }
 async function d(i) {
-  return c(i), import("./index-rhSRO8Tb.mjs").then((t) => t.J);
+  return c(i), import("./index-COQOIflN.mjs").then((t) => t.J);
 }
 export {
   g as P,

package/dist/{bridge-DLEmhE7Y.js → bridge-BxkfdTkq.js}

@@ -1 +1 @@
-"use strict";var l=Object.defineProperty;var o=(i,e,t)=>e in i?l(i,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):i[e]=t;var n=(i,e,t)=>o(i,typeof e!="symbol"?e+"":e,t);let r;function c(i){r=i}function u(){if(!r)throw new Error("[@netless/appliance-plugin/bridge] white-web-sdk runtime has not been bound yet.");return r}class h{constructor(){n(this,"control");n(this,"_listeners",{})}_inject(e){this.control=e}_onEvent(e,t){this._listeners[e]&&this._listeners[e](...t)}callbacks(e,t){this._listeners[e]=t}removeCallback(e){delete this._listeners[e]}}class g{constructor(e){n(this,"control");n(this,"worker");n(this,"publicMsgEmitter");n(this,"plugins",new Map);const{control:t,publicMsgEmitter:s}=e;this.control=t,this.publicMsgEmitter=s,this.worker=t.worker}use(e){this.plugins.set(e.kind,e),e._inject(this.control),e.onCreate()}destroy(){this.plugins.forEach(e=>{this.plugins.delete(e.kind),e.onDestroy()})}dispatchPluginEvent(e,...t){this.plugins.forEach(s=>{s._onEvent(e,t)})}}async function a(i){return c(i),Promise.resolve().then(()=>require("./index-RKd-OVPO.js")).then(e=>e.index)}exports.Plugin=h;exports.PluginManager=g;exports.getWhiteWebSdkBridgeRuntime=u;exports.loadAppliancePluginBridge=a;
+"use strict";var l=Object.defineProperty;var o=(i,e,t)=>e in i?l(i,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):i[e]=t;var n=(i,e,t)=>o(i,typeof e!="symbol"?e+"":e,t);let r;function c(i){r=i}function u(){if(!r)throw new Error("[@netless/appliance-plugin/bridge] white-web-sdk runtime has not been bound yet.");return r}class h{constructor(){n(this,"control");n(this,"_listeners",{})}_inject(e){this.control=e}_onEvent(e,t){this._listeners[e]&&this._listeners[e](...t)}callbacks(e,t){this._listeners[e]=t}removeCallback(e){delete this._listeners[e]}}class g{constructor(e){n(this,"control");n(this,"worker");n(this,"publicMsgEmitter");n(this,"plugins",new Map);const{control:t,publicMsgEmitter:s}=e;this.control=t,this.publicMsgEmitter=s,this.worker=t.worker}use(e){this.plugins.set(e.kind,e),e._inject(this.control),e.onCreate()}destroy(){this.plugins.forEach(e=>{this.plugins.delete(e.kind),e.onDestroy()})}dispatchPluginEvent(e,...t){this.plugins.forEach(s=>{s._onEvent(e,t)})}}async function a(i){return c(i),Promise.resolve().then(()=>require("./index-DjDB-MYx.js")).then(e=>e.index)}exports.Plugin=h;exports.PluginManager=g;exports.getWhiteWebSdkBridgeRuntime=u;exports.loadAppliancePluginBridge=a;

package/dist/bridge.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./bridge-DLEmhE7Y.js");exports.Plugin=e.Plugin;exports.loadAppliancePluginBridge=e.loadAppliancePluginBridge;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./bridge-BxkfdTkq.js");exports.Plugin=e.Plugin;exports.loadAppliancePluginBridge=e.loadAppliancePluginBridge;

package/dist/bridge.mjs

@@ -1,4 +1,4 @@
-import { a as i, l as e } from "./bridge-b23MKtwT.mjs";
+import { a as i, l as e } from "./bridge-BNKS_R2l.mjs";
 export {
   i as Plugin,
   e as loadAppliancePluginBridge

package/dist/component/backgroundImageLoadCoordinator.d.ts

@@ -0,0 +1,61 @@
+export type BackgroundImageSource = "appliance" | "whiteSdk";
+export interface BackgroundImageLoadOptions {
+    maxRetries?: number;
+    timeoutMs?: number;
+    retryIntervalMs?: number;
+}
+export interface BackgroundImageLoadEvent {
+    name: "backgroundImageLoad";
+    state: "success" | "failed" | "cancelled";
+    source: BackgroundImageSource;
+    resourceId: string;
+    resourceUrl: string;
+    viewId: string;
+    scenePath: string;
+}
+export interface ReloadBackgroundImageParams {
+    source: BackgroundImageSource;
+    viewId: string;
+    scenePath?: string;
+    url?: string;
+}
+export interface ReloadBackgroundImageResult {
+    accepted: boolean;
+    reloadedCount: number;
+    reason?: "viewNotFound" | "sceneNotFocused" | "resourceNotFound" | "alreadyLoading";
+}
+export interface BackgroundImageLoadTask {
+    viewId: string;
+    scenePath: string;
+    resourceId: string;
+    src: string;
+    image: HTMLImageElement;
+    isActive: () => boolean;
+    onReloadUrl?: (url: string) => void;
+}
+export declare function normalizeBackgroundImageLoadOptions(options?: BackgroundImageLoadOptions): Required<BackgroundImageLoadOptions>;
+export declare class BackgroundImageLoadCoordinator {
+    private readonly onEvent?;
+    private readonly tasks;
+    private readonly failedTasks;
+    private readonly options;
+    private readonly queue;
+    private activeAttempts;
+    private readonly maxActiveAttempts;
+    constructor(options?: BackgroundImageLoadOptions, onEvent?: ((event: BackgroundImageLoadEvent) => void) | undefined);
+    load(task: BackgroundImageLoadTask): Promise<void>;
+    cancelByViewScene(viewId: string, scenePath?: string): void;
+    cancelResource(viewId: string, scenePath: string, resourceId: string): void;
+    cancelAll(): void;
+    reload(params: ReloadBackgroundImageParams & {
+        scenePath: string;
+    }): ReloadBackgroundImageResult;
+    private keyOf;
+    private attempt;
+    private enqueue;
+    private drain;
+    private loadImage;
+    private canRun;
+    private cancel;
+    private emit;
+}

package/dist/component/svg/base.d.ts

@@ -27,4 +27,6 @@ export declare function getShapeInstanceForBackgroundThread(param: {
     toolsOpt: ISVGOptions;
     vNodes: VBackgroundNodeManager;
     manager: BackgroundThreadEngineImpl | BackgroundSnapshotThreadImpl;
+    scenePath: string;
+    trackBackgroundImageLoad?: boolean;
 }): ISvgElement | undefined;

package/dist/component/svg/svgElemt.d.ts

@@ -14,9 +14,11 @@ export declare class ISvgElement {
     private isDestroyed;
     private element;
     readonly manager: BackgroundThreadEngineImpl | BackgroundSnapshotThreadImpl;
+    readonly scenePath: string;
+    private readonly trackBackgroundImageLoad;
+    private reloadSourceUrl?;
     get fullLayer(): HTMLDivElement;
     get collector(): Collector | undefined;
-    get scenePath(): string | undefined;
     constructor(props: ISVGElementToolProps);
     init(): Promise<void>;
     private createElement;

package/dist/component/svg/types.d.ts

@@ -7,4 +7,6 @@ export interface ISVGElementToolProps {
     toolsOpt: ISVGOptions;
     vNodes: VBackgroundNodeManager;
     manager: BackgroundThreadEngineImpl | BackgroundSnapshotThreadImpl;
+    scenePath: string;
+    trackBackgroundImageLoad?: boolean;
 }

package/dist/core/currentSceneGuard.d.ts

@@ -6,3 +6,9 @@ export declare function shouldDispatchSceneTask(task: {
     viewId?: string;
     scenePath?: string;
 }, getCurrentScenePath: CurrentScenePathGetter): boolean;
+export declare function getViewTaskDispatchState(task: {
+    isService: boolean;
+    isAllViews: boolean;
+    viewId?: string;
+    scenePath?: string;
+}, isViewInitAck: (viewId: string) => boolean, getCurrentScenePath: CurrentScenePathGetter): "dispatch" | "pending" | "discard";

package/dist/core/initReadyBarrier.d.ts

@@ -0,0 +1,8 @@
+export declare class InitReadyBarrier {
+    private state;
+    private readonly waiters;
+    wait(timeoutMs?: number): Promise<"ready" | "cancelled" | "timeout">;
+    begin(): void;
+    markReady(): void;
+    cancel(): void;
+}

package/dist/core/mainEngine.d.ts

@@ -194,6 +194,7 @@ export declare class MasterControlForWorker extends MasterController {
     private readonly fontFaceManager;
     private isLocalWorkActive;
     private hasMainViewInitAck;
+    private readonly mainViewInitReady;
     private serviceSyncReadyViews;
     private mainViewInitAckCallbacks;
     private readonly initAckedViewIds;
@@ -212,13 +213,14 @@ export declare class MasterControlForWorker extends MasterController {
     get Logger(): import("..").Logger;
     afterMainViewInitAck(callback: () => void): void;
     get isMainViewInitAck(): boolean;
+    waitForMainViewInitAck(timeoutMs?: number): Promise<"ready" | "cancelled" | "timeout">;
     isViewInitAck(viewId: string): boolean;
     private ackMainViewInit;
     private flushPendingTransportInitMessages;
     private getPendingInitMessageKey;
     private pullLatestServiceDataAfterInit;
     private assertMarkmapRuntimeRegistered;
-    destroy(): void;
+    destroy(preserveInitReady?: boolean): void;
     private get consumeCount();
     private set consumeCount(value);
     private acceptConsumeAck;
@@ -397,7 +399,7 @@ export declare class MasterControlForWorker extends MasterController {
     blurCursor(viewId: string): void;
     sendCursorEvent(p: [number | undefined, number | undefined], viewId: string): void;
     getBoundingRect(scenePath: string): Promise<IRectType> | undefined;
-    getSnapshot(scenePath: string, width?: number, height?: number, camera?: Pick<ICameraOpt, "centerX" | "centerY" | "scale">): Promise<(ImageBitmap | HTMLImageElement | null)[]> | undefined;
+    getSnapshot(scenePath: string, width?: number, height?: number, camera?: Pick<ICameraOpt, "centerX" | "centerY" | "scale">): Promise<(HTMLImageElement | ImageBitmap | null)[]> | undefined;
     queryTaskBatchData(query: IqueryTask): IWorkerMessage[];
     insertIconify(viewId: string, iconifyInfo: IconifyInformation & {
         strokeColor?: string;

package/dist/core/mainThread/base.d.ts

@@ -68,8 +68,8 @@ export declare class MainThreadEngineImpl implements MainThreadEngine {
     private cacheImages;
     private imageResolveMap;
     constructor(viewId: string, opt: IMainThreadInitOption);
-    getCachedImages(imageSrc: string): ImageBitmap | HTMLImageElement | undefined;
-    getCachedImagesByWorkId(workId: string): ImageBitmap | HTMLImageElement | undefined;
+    getCachedImages(imageSrc: string): HTMLImageElement | ImageBitmap | undefined;
+    getCachedImagesByWorkId(workId: string): HTMLImageElement | ImageBitmap | undefined;
     deleteCachedImagesByWorkId(workId: string): void;
     clearCacheImages(): void;
     clearImageResolveMap(): void;
@@ -77,7 +77,7 @@ export declare class MainThreadEngineImpl implements MainThreadEngine {
     updateDpr(dpr: number): void;
     on(msg: IWorkerMessage): Promise<void>;
     private getIconSize;
-    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<ImageBitmap | HTMLImageElement | undefined>;
+    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<HTMLImageElement | ImageBitmap | undefined>;
     private removeNode;
     consumeFull(type: EDataType, data: IWorkerMessage): Promise<void>;
     setCameraOpt(cameraOpt: ICameraOpt): void;

package/dist/core/mainThread/snapshotThread.d.ts

@@ -18,15 +18,15 @@ export declare class SnapshotThreadImpl {
     private cacheImages;
     private imageResolveMap;
     constructor(viewId: string, opt: IMainThreadInitOption);
-    getCachedImages(imageSrc: string): ImageBitmap | HTMLImageElement | undefined;
-    getCachedImagesByWorkId(workId: string): ImageBitmap | HTMLImageElement | undefined;
+    getCachedImages(imageSrc: string): HTMLImageElement | ImageBitmap | undefined;
+    getCachedImagesByWorkId(workId: string): HTMLImageElement | ImageBitmap | undefined;
     deleteCachedImagesByWorkId(workId: string): void;
     clearCacheImages(): void;
     clearImageResolveMap(): void;
     post(msg: Omit<IBatchMainMessage, "render">): void;
     on(msg: IWorkerMessage): Promise<void>;
     private getIconSize;
-    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<ImageBitmap | HTMLImageElement | undefined>;
+    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<HTMLImageElement | ImageBitmap | undefined>;
     createWorkShapeNode(opt: IActiveToolsDataType & {
         workId: string;
     }): TextShape | import("../tools").ArrowShape | import("../tools").PencilShape | import("../tools/straight").StraightShape | import("../tools").EllipseShape | import("../tools").PolygonShape | import("../tools").StarShape | import("../tools").RectangleShape | import("../tools").SpeechBalloonShape | import("../tools").LaserPenShape | import("../tools").EraserShape | import("../tools").BitMapEraserShape | import("../tools/pencilEraser").PencilEraserShape | import("../tools").SelectorShape | ImageShape | ISvgShadowShape | undefined;

package/dist/core/mainThread/subLocalThread.d.ts

@@ -71,7 +71,7 @@ export declare class SubLocalMainThreadImpl implements SubLocalThread {
     private combineDrawActiveId?;
     private readonly eraserBatchScheduler;
     constructor(opt: ISubThreadInitOption);
-    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<ImageBitmap | HTMLImageElement | undefined>;
+    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<HTMLImageElement | ImageBitmap | undefined>;
     createLocalWork(data: IWorkerMessage): void;
     updateSelector(params: IUpdateSelectorPropsType & {
         callback?: ((props: {

package/dist/core/mainThread/subServiceThread.d.ts

@@ -22,7 +22,7 @@ export declare class SubServiceMainThreadImpl implements SubServiceThread {
     private animationId?;
     private syncUnitTime;
     constructor(opt: ISubThreadInitOption);
-    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<ImageBitmap | HTMLImageElement | undefined>;
+    loadImageBitMap(msg: Pick<IWorkerMessage, "toolsType" | "opt" | "workId">): Promise<HTMLImageElement | ImageBitmap | undefined>;
     destroy(): void;
     clearAll(): void;
     private runEffect;