@netless/window-manager 0.4.0-canary.3 → 0.4.0-canary.33

package/src/App/Storage/index.ts

@@ -0,0 +1,289 @@
+import type { AkkoObjectUpdatedProperty } from "white-web-sdk";
+import { get, has, mapValues, isObject, size, noop } from "lodash";
+import { SideEffectManager } from "side-effect-manager";
+import type { AppContext } from "../../AppContext";
+import { safeListenPropsUpdated } from "../../Utils/Reactive";
+import { isRef, makeRef, plainObjectKeys } from "./utils";
+import type { Diff, MaybeRefValue, RefValue, StorageStateChangedEvent, StorageStateChangedListener, StorageStateChangedListenerDisposer } from "./typings";
+import { StorageEvent } from "./StorageEvent";
+
+export * from './typings';
+
+export const STORAGE_NS = "_WM-STORAGE_";
+
+export class Storage<TState extends Record<string, any> = any> implements Storage<TState> {
+  readonly id: string | null;
+
+  private readonly _context: AppContext;
+  private readonly _sideEffect = new SideEffectManager();
+  private _state: TState;
+  private _destroyed = false;
+
+  private _refMap = new WeakMap<any, RefValue>();
+
+  /**
+   * `setState` alters local state immediately before sending to server. This will cache the old value for onStateChanged diffing.
+   */
+  private _lastValue = new Map<string | number | symbol, TState[Extract<keyof TState, string>]>();
+
+  constructor(context: AppContext, id?: string, defaultState?: TState) {
+    if (defaultState && !isObject(defaultState)) {
+      throw new Error(`Default state for Storage ${id} is not an object.`);
+    }
+
+    this._context = context;
+    this.id = id || null;
+
+    this._state = {} as TState;
+    const rawState = this._getRawState(this._state);
+
+    if (this.id !== null && this._context.getIsWritable()) {
+      if (rawState === this._state || !isObject(rawState)) {
+        if (!get(this._context.getAttributes(), [STORAGE_NS])) {
+          this._context.updateAttributes([STORAGE_NS], {});
+        }
+        this._context.updateAttributes([STORAGE_NS, this.id], this._state);
+      }
+      if (defaultState) {
+        this.setState(defaultState);
+      }
+    }
+
+    // strip mobx
+    plainObjectKeys(rawState).forEach(key => {
+      if (this.id === null && key === STORAGE_NS) {
+        return;
+      }
+      try {
+        const rawValue = isObject(rawState[key]) ? JSON.parse(JSON.stringify(rawState[key])) : rawState[key];
+        if (isRef<TState[Extract<keyof TState, string>]>(rawValue)) {
+          this._state[key] = rawValue.v;
+          if (isObject(rawValue.v)) {
+            this._refMap.set(rawValue.v, rawValue);
+          }
+        } else {
+          this._state[key] = rawValue;
+        }
+      } catch (e) {
+        console.error(e);
+      }
+    });
+
+    this._sideEffect.addDisposer(
+      safeListenPropsUpdated(
+        () => this.id === null ? context.getAttributes() : get(context.getAttributes(), [STORAGE_NS, this.id]),
+        this._updateProperties.bind(this),
+        this.destroy.bind(this)
+      )
+    );
+  }
+
+  get state(): Readonly<TState> {
+    if (this._destroyed) {
+      console.warn(`Accessing state on destroyed Storage "${this.id}"`)
+    }
+    return this._state;
+  }
+
+  readonly onStateChanged = new StorageEvent<StorageStateChangedEvent<TState>>();
+  
+  addStateChangedListener(handler: StorageStateChangedListener<TState>): StorageStateChangedListenerDisposer {
+    this.onStateChanged.addListener(handler);
+    return () => this.onStateChanged.removeListener(handler);
+  }
+
+  ensureState(state: Partial<TState>): void {
+    return this.setState(
+      plainObjectKeys(state).reduce((payload, key) => {
+        if (!has(this._state, key)) {
+          payload[key] = state[key];
+        }
+        return payload;
+      }, {} as Partial<TState>)
+    );
+  }
+
+  setState(state: Partial<TState>): void {
+    if (this._destroyed) {
+      console.error(new Error(`Cannot call setState on destroyed Storage "${this.id}".`));
+      return;
+    }
+
+    if (!this._context.getIsWritable()) {
+      console.error(new Error(`Cannot setState on Storage "${this.id}" without writable access`), state);
+      return;
+    }
+
+    const keys = plainObjectKeys(state);
+    if (keys.length > 0) {
+      keys.forEach(key => {
+        const value = state[key];
+        if (value === this._state[key]) {
+          return;
+        }
+
+        if (value === void 0) {
+          this._lastValue.set(key, this._state[key]);
+          delete this._state[key];
+          this._setRawState(key, value);
+        } else {
+          this._lastValue.set(key, this._state[key]);
+          this._state[key] = value as TState[Extract<keyof TState, string>];
+
+          let payload: MaybeRefValue<typeof value> = value;
+          if (isObject(value)) {
+            let refValue = this._refMap.get(value);
+            if (!refValue) {
+              refValue = makeRef(value);
+              this._refMap.set(value, refValue);
+            }
+            payload = refValue;
+          }
+
+          this._setRawState(key, payload)
+        }
+      });
+    }
+  }
+
+  /**
+   * Empty storage data.
+   */
+  emptyStorage(): void {
+    if (size(this._state) <= 0) {
+      return;
+    }
+
+    if (this._destroyed) {
+      console.error(new Error(`Cannot empty destroyed Storage "${this.id}".`));
+      return;
+    }
+
+    if (!this._context.getIsWritable()) {
+      console.error(new Error(`Cannot empty Storage "${this.id}" without writable access.`));
+      return;
+    }
+
+    this.setState(mapValues(this._state, noop as () => undefined));
+  }
+
+  /**
+   * Delete storage index with all of its data and destroy the Storage instance.
+   */
+  deleteStorage(): void {
+    if (this.id === null) {
+      throw new Error(`Cannot delete main Storage`);
+    }
+
+    if (!this._context.getIsWritable()) {
+      console.error(new Error(`Cannot delete Storage "${this.id}" without writable access.`));
+      return;
+    }
+
+    this.destroy();
+
+    this._context.updateAttributes([STORAGE_NS, this.id], void 0);
+  }
+
+  get destroyed(): boolean {
+    return this._destroyed;
+  }
+
+  /**
+   * Destroy the Storage instance. The data will be kept.
+   */
+  destroy() {
+    this._destroyed = true;
+    this._sideEffect.flushAll();
+  }
+
+  private _getRawState(): TState | undefined
+  private _getRawState(defaultValue: TState): TState
+  private _getRawState(defaultValue?: TState): TState | undefined {
+    if (this.id === null) {
+      return get(this._context.getAttributes(), [], defaultValue);
+    } else {
+      return get(this._context.getAttributes(), [STORAGE_NS, this.id], defaultValue);
+    }
+  }
+
+  private _setRawState(key: string, value: any): void {
+    if (this.id === null) {
+      if (key === STORAGE_NS) {
+        throw new Error(`Cannot set attribute internal filed "${STORAGE_NS}"`)
+      }
+      return this._context.updateAttributes([key], value);
+    } else {
+      return this._context.updateAttributes([STORAGE_NS, this.id, key], value);
+    }
+  }
+
+  private _updateProperties(actions: ReadonlyArray<AkkoObjectUpdatedProperty<TState, string>>): void {
+    if (this._destroyed) {
+      console.error(new Error(`Cannot call _updateProperties on destroyed Storage "${this.id}".`));
+      return;
+    }
+
+    if (actions.length > 0) {
+      const diffs: Diff<TState> = {};
+
+      for (let i = 0; i < actions.length; i++) {
+        try {
+          const action = actions[i]
+          const key = action.key as Extract<keyof TState, string>;
+
+          if (this.id === null && key === STORAGE_NS) {
+            continue
+          }
+
+          const value = isObject(action.value) ? JSON.parse(JSON.stringify(action.value)) : action.value;
+          let oldValue: TState[Extract<keyof TState, string>] | undefined;
+          if (this._lastValue.has(key)) {
+            oldValue = this._lastValue.get(key);
+            this._lastValue.delete(key);
+          }
+
+          switch (action.kind) {
+            case 2: {
+              // Removed
+              if (has(this._state, key)) {
+                oldValue = this._state[key];
+                delete this._state[key];
+              }
+              diffs[key] = { oldValue };
+              break;
+            }
+            default: {
+              let newValue = value;
+
+              if (isRef<TState[Extract<keyof TState, string>]>(value)) {
+                const { k, v } = value;
+                const curValue = this._state[key];
+                if (isObject(curValue) && this._refMap.get(curValue)?.k === k) {
+                  newValue = curValue;
+                } else {
+                  newValue = v;
+                  if (isObject(v)) {
+                    this._refMap.set(v, value);
+                  }
+                }
+              }
+
+              if (newValue !== this._state[key]) {
+                oldValue = this._state[key];
+                this._state[key] = newValue;
+              }
+
+              diffs[key] = { newValue, oldValue };
+              break;
+            }
+          }
+        } catch (e) {
+          console.error(e)
+        }
+      }
+
+      this.onStateChanged.dispatch(diffs);
+    }
+  }
+}

package/src/App/Storage/typings.ts

@@ -0,0 +1,23 @@
+import type { StorageEventListener } from "./StorageEvent";
+
+export type RefValue<TValue = any> = { k: string; v: TValue; __isRef: true };
+
+export type ExtractRawValue<TValue> = TValue extends RefValue<infer TRefValue> ? TRefValue : TValue;
+
+export type AutoRefValue<TValue> = RefValue<ExtractRawValue<TValue>>;
+
+export type MaybeRefValue<TValue> = TValue | AutoRefValue<TValue>;
+
+export type DiffOne<T> = { oldValue?: T; newValue?: T };
+
+export type Diff<T> = { [K in keyof T]?: DiffOne<T[K]> };
+
+export type StorageOnSetStatePayload<TState = unknown> = {
+  [K in keyof TState]?: MaybeRefValue<TState[K]>;
+};
+
+export type StorageStateChangedEvent<TState = any> = Diff<TState>;
+
+export type StorageStateChangedListener<TState = any> = StorageEventListener<StorageStateChangedEvent<TState>>;
+
+export type StorageStateChangedListenerDisposer = () => void;

package/src/App/Storage/utils.ts

@@ -0,0 +1,17 @@
+import { has } from "lodash";
+import { genUID } from "side-effect-manager";
+import type { AutoRefValue, ExtractRawValue, RefValue } from "./typings";
+
+export const plainObjectKeys = Object.keys as <T>(o: T) => Array<Extract<keyof T, string>>;
+
+export function isRef<TValue = unknown>(e: unknown): e is RefValue<TValue> {
+  return Boolean(has(e, '__isRef'));
+}
+
+export function makeRef<TValue>(v: TValue): RefValue<TValue> {
+  return { k: genUID(), v, __isRef: true };
+}
+
+export function makeAutoRef<TValue>(v: TValue): AutoRefValue<TValue> {
+  return isRef<ExtractRawValue<TValue>>(v) ? v : makeRef(v as ExtractRawValue<TValue>);
+}

package/src/AppContext.ts

@@ -6,18 +6,20 @@ import {
     unlistenDisposed,
     unlistenUpdated,
     toJS
-    } from 'white-web-sdk';
+} from 'white-web-sdk';
 import { BoxNotCreatedError } from './Utils/error';
-import type { Room, SceneDefinition, View } from "white-web-sdk";
+import type { Room, SceneDefinition, View, EventListener as WhiteEventListener } from "white-web-sdk";
 import type { ReadonlyTeleBox } from "@netless/telebox-insider";
 import type Emittery from "emittery";
 import type { BoxManager } from "./BoxManager";
 import type { AppEmitterEvent } from "./index";
 import type { AppManager } from "./AppManager";
 import type { AppProxy } from "./AppProxy";
+import { Storage } from './App/Storage';
+import type { MagixEventAddListener, MagixEventDispatcher, MagixEventRemoveListener } from './App/MagixEvent';
 
-export class AppContext<TAttrs extends Record<string, any>, AppOptions = any> {
-    public readonly emitter: Emittery<AppEmitterEvent<TAttrs>>;
+export class AppContext<TAttributes = any, TMagixEventPayloads = any, TAppOptions = any> {
+    public readonly emitter: Emittery<AppEmitterEvent<TAttributes>>;
     public readonly mobxUtils = {
         autorun,
         reaction,
@@ -39,45 +41,45 @@ export class AppContext<TAttrs extends Record<string, any>, AppOptions = any> {
         private boxManager: BoxManager,
         public appId: string,
         private appProxy: AppProxy,
-        private appOptions?: AppOptions | (() => AppOptions),
+        private appOptions?: TAppOptions | (() => TAppOptions),
     ) {
         this.emitter = appProxy.appEmitter;
         this.isAddApp = appProxy.isAddApp;
     }
 
-    public getDisplayer() {
+    public getDisplayer = () => {
         return this.manager.displayer;
     }
 
-    public getAttributes(): TAttrs | undefined {
+    /** @deprecated Use context.storage.state instead. */
+    public getAttributes = (): TAttributes | undefined => {
         return this.appProxy.attributes;
     }
 
-    public getScenes(): SceneDefinition[] | undefined {
+    public getScenes = (): SceneDefinition[] | undefined => {
         const appAttr = this.store.getAppAttributes(this.appId);
         if (appAttr?.isDynamicPPT) {
-            const appProxy = this.manager.appProxies.get(this.appId);
-            if (appProxy) {
-                return appProxy.scenes;
-            }
+            return this.appProxy.scenes;
         } else {
             return appAttr?.options["scenes"];
         }
     }
 
-    public getView(): View | undefined {
+    public getView = (): View | undefined => {
         return this.appProxy.view;
     }
 
-    public getInitScenePath() {
+    public getInitScenePath = () => {
         return this.manager.getAppInitPath(this.appId);
     }
 
-    public getIsWritable(): boolean {
+    /** Get App writable status. */
+    public getIsWritable = (): boolean => {
         return this.manager.canOperate;
     }
 
-    public getBox(): ReadonlyTeleBox {
+    /** Get the App Window UI box. */
+    public getBox = (): ReadonlyTeleBox => {
         const box = this.boxManager.getBox(this.appId);
         if (box) {
             return box;
@@ -86,27 +88,30 @@ export class AppContext<TAttrs extends Record<string, any>, AppOptions = any> {
         }
     }
 
-    public getRoom(): Room | undefined {
+    public getRoom = (): Room | undefined => {
         return this.manager.room;
     }
 
-    public setAttributes(attributes: TAttrs) {
+    /** @deprecated Use context.storage.setState instead. */
+    public setAttributes = (attributes: TAttributes) => {
         this.manager.safeSetAttributes({ [this.appId]: attributes });
     }
 
-    public updateAttributes(keys: string[], value: any) {
+    /** @deprecated Use context.storage.setState instead. */
+    public updateAttributes = (keys: string[], value: any) => {
         if (this.manager.attributes[this.appId]) {
             this.manager.safeUpdateAttributes([this.appId, ...keys], value);
         }
     }
 
-    public async setScenePath(scenePath: string): Promise<void> {
+    public setScenePath = async (scenePath: string): Promise<void> => {
         if (!this.appProxy.box) return;
         this.appProxy.setFullPath(scenePath);
-        this.appProxy.context.switchAppToWriter(this.appId);
+        // 兼容 15 版本 SDK 的切页
+        this.getRoom()?.setScenePath(scenePath);
     }
 
-    public mountView(dom: HTMLDivElement): void {
+    public mountView = (dom: HTMLDivElement): void => {
         const view = this.getView();
         if (view) {
             view.divElement = dom;
@@ -117,7 +122,47 @@ export class AppContext<TAttrs extends Record<string, any>, AppOptions = any> {
         }
     }
 
-    public getAppOptions(): AppOptions | undefined {
-        return typeof this.appOptions === 'function' ? (this.appOptions as () => AppOptions)() : this.appOptions
+    /** Get the local App options. */
+    public getAppOptions = (): TAppOptions | undefined => {
+        return typeof this.appOptions === 'function' ? (this.appOptions as () => TAppOptions)() : this.appOptions
     }
+
+    private _storage?: Storage<TAttributes>
+
+    /** Main Storage for attributes. */
+    public get storage(): Storage<TAttributes> {
+        if (!this._storage) {
+            this._storage = new Storage(this);
+        }
+        return this._storage;
+    }
+
+    /**
+     * Create separated storages for flexible state management.
+     * @param storeId Namespace for the storage. Storages of the same namespace share the same data.
+     * @param defaultState Default state for initial storage creation.
+     * @returns 
+     */
+    public createStorage = <TState>(storeId: string, defaultState?: TState): Storage<TState> => {
+        const storage = new Storage(this, storeId, defaultState);
+        this.emitter.on("destroy", () => {
+            storage.destroy();
+        });
+        return storage;
+    }
+
+    /** Dispatch events to other clients (and self). */
+    public dispatchMagixEvent: MagixEventDispatcher<TMagixEventPayloads> = (...args) => {
+        // can't dispatch events on replay mode
+        return this.manager.room?.dispatchMagixEvent(...args);
+    }
+
+    /** Listen to events from others clients (and self messages). */
+    public addMagixEventListener: MagixEventAddListener<TMagixEventPayloads> = (event, handler, options) => {
+        this.manager.displayer.addMagixEventListener(event, handler as WhiteEventListener, options);
+        return () => this.manager.displayer.removeMagixEventListener(event, handler as WhiteEventListener);
+    }
+
+    /** Remove a Magix event listener. */
+    public removeMagixEventListener = this.manager.displayer.removeMagixEventListener.bind(this.manager.displayer) as MagixEventRemoveListener<TMagixEventPayloads>
 }

package/src/AppListener.ts

@@ -1,10 +1,10 @@
-import { callbacks } from './index';
-import { Events, MagixEventName } from './constants';
-import type { Event } from "white-web-sdk";
+import { callbacks, emitter } from "./index";
+import { Events, MagixEventName } from "./constants";
+import { isEqual, omit } from "lodash";
+import { setViewFocusScenePath } from "./Utils/Common";
+import type { AnimationMode, Camera, Event } from "white-web-sdk";
 import type { AppManager } from "./AppManager";
 import type { TeleBoxState } from "@netless/telebox-insider";
-import { setViewFocusScenePath } from './Utils/Common';
-
 export class AppListeners {
     private displayer = this.manager.displayer;
 
@@ -34,10 +34,6 @@ export class AppListeners {
                     this.appResizeHandler(data.payload);
                     break;
                 }
-                case Events.SwitchViewsToFreedom: {
-                    this.switchViewsToFreedomHandler();
-                    break;
-                }
                 case Events.AppBoxStateChange: {
                     this.boxStateChangeHandler(data.payload);
                     break;
@@ -46,10 +42,18 @@ export class AppListeners {
                     this.setMainViewScenePathHandler(data.payload);
                     break;
                 }
+                case Events.MoveCamera: {
+                    this.moveCameraHandler(data.payload);
+                    break;
+                }
                 case Events.MoveCameraToContain: {
                     this.moveCameraToContainHandler(data.payload);
                     break;
                 }
+                case Events.CursorMove: {
+                    this.cursorMoveHandler(data.payload);
+                    break;
+                }
                 default:
                     break;
             }
@@ -65,19 +69,27 @@ export class AppListeners {
         this.manager.room?.refreshViewSize();
     };
 
-    private switchViewsToFreedomHandler = () => {
-        this.manager.viewManager.freedomAllViews();
-    };
-
     private boxStateChangeHandler = (state: TeleBoxState) => {
         callbacks.emit("boxStateChange", state);
-    }
+    };
 
     private setMainViewScenePathHandler = ({ nextScenePath }: { nextScenePath: string }) => {
         setViewFocusScenePath(this.manager.mainView, nextScenePath);
-    }
+        callbacks.emit("mainViewScenePathChange", nextScenePath);
+    };
+
+    private moveCameraHandler = (
+        payload: Camera & { animationMode?: AnimationMode | undefined }
+    ) => {
+        if (isEqual(omit(payload, ["animationMode"]), { ...this.manager.mainView.camera })) return;
+        this.manager.mainView.moveCamera(payload);
+    };
 
     private moveCameraToContainHandler = (payload: any) => {
         this.manager.mainView.moveCameraToContain(payload);
-    }
+    };
+
+    private cursorMoveHandler = (payload: any) => {
+        emitter.emit("cursorMove", payload);
+    };
 }