@netless/window-manager 1.0.0-canary.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/LICENSE.txt +21 -0
  2. package/README.md +90 -64
  3. package/README.zh-cn.md +224 -0
  4. package/dist/index.d.ts +1133 -40
  5. package/dist/index.js +62 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/{index.es.js → index.mjs} +9480 -6984
  8. package/dist/index.mjs.map +1 -0
  9. package/dist/style.css +1 -1
  10. package/docs/advanced.md +55 -55
  11. package/docs/api.md +124 -113
  12. package/docs/app-context.md +248 -209
  13. package/docs/basic.md +25 -26
  14. package/docs/camera.md +19 -20
  15. package/docs/cn/advanced.md +137 -0
  16. package/docs/cn/api.md +309 -0
  17. package/docs/cn/app-context.md +369 -0
  18. package/docs/cn/basic.md +64 -0
  19. package/docs/cn/camera.md +53 -0
  20. package/docs/cn/concept.md +9 -0
  21. package/docs/cn/custom-max-bar.md +31 -0
  22. package/docs/cn/develop-app.md +94 -0
  23. package/docs/cn/export-pdf.md +48 -0
  24. package/docs/cn/migrate.md +60 -0
  25. package/docs/cn/replay.md +40 -0
  26. package/docs/concept.md +6 -5
  27. package/docs/custom-max-bar.md +31 -0
  28. package/docs/develop-app.md +22 -19
  29. package/docs/export-pdf.md +48 -0
  30. package/docs/migrate.md +25 -27
  31. package/docs/quickstart.md +50 -0
  32. package/docs/replay.md +20 -20
  33. package/package.json +32 -22
  34. package/src/App/AppContext.ts +105 -73
  35. package/src/App/AppPageStateImpl.ts +6 -25
  36. package/src/App/AppProxy.ts +41 -166
  37. package/src/App/MagixEvent/index.ts +38 -38
  38. package/src/App/Storage/StorageEvent.ts +13 -13
  39. package/src/App/Storage/index.ts +269 -245
  40. package/src/App/Storage/typings.ts +4 -2
  41. package/src/App/Storage/utils.ts +3 -3
  42. package/src/App/index.ts +0 -1
  43. package/src/AppListener.ts +8 -8
  44. package/src/AppManager.ts +88 -77
  45. package/src/AttributesDelegate.ts +42 -22
  46. package/src/BoxEmitter.ts +12 -6
  47. package/src/BoxManager.ts +128 -108
  48. package/src/ContainerResizeObserver.ts +75 -0
  49. package/src/Cursor/Cursor.svelte +16 -5
  50. package/src/Cursor/Cursor.svelte.d.ts +21 -0
  51. package/src/Cursor/Cursor.ts +77 -13
  52. package/src/Cursor/icons.ts +6 -0
  53. package/src/Cursor/icons2.ts +66 -0
  54. package/src/Cursor/index.ts +127 -26
  55. package/src/Helper.ts +94 -14
  56. package/src/InternalEmitter.ts +2 -7
  57. package/src/Page/index.ts +1 -1
  58. package/src/PageState.ts +6 -5
  59. package/src/ReconnectRefresher.ts +9 -4
  60. package/src/RedoUndo.ts +3 -3
  61. package/src/Register/index.ts +22 -17
  62. package/src/Register/loader.ts +26 -22
  63. package/src/Register/storage.ts +13 -13
  64. package/src/Utils/Common.ts +18 -14
  65. package/src/Utils/Reactive.ts +26 -25
  66. package/src/Utils/RoomHacker.ts +4 -4
  67. package/src/Utils/error.ts +0 -1
  68. package/src/View/IframeBridge.ts +680 -0
  69. package/src/View/MainView.ts +127 -53
  70. package/src/callback.ts +21 -1
  71. package/src/constants.ts +0 -2
  72. package/src/image/pencil-eraser-1.svg +3 -0
  73. package/src/image/pencil-eraser-2.svg +3 -0
  74. package/src/image/pencil-eraser-3.svg +3 -0
  75. package/src/index.ts +220 -83
  76. package/src/style.css +27 -10
  77. package/src/typings.ts +20 -10
  78. package/.prettierignore +0 -7
  79. package/.prettierrc.json +0 -9
  80. package/CHANGELOG.md +0 -196
  81. package/__mocks__/white-web-sdk.ts +0 -50
  82. package/dist/App/AppContext.d.ts +0 -76
  83. package/dist/App/AppPageStateImpl.d.ts +0 -21
  84. package/dist/App/AppProxy.d.ts +0 -86
  85. package/dist/App/AppViewSync.d.ts +0 -11
  86. package/dist/App/MagixEvent/index.d.ts +0 -29
  87. package/dist/App/Storage/StorageEvent.d.ts +0 -8
  88. package/dist/App/Storage/index.d.ts +0 -39
  89. package/dist/App/Storage/typings.d.ts +0 -22
  90. package/dist/App/Storage/utils.d.ts +0 -5
  91. package/dist/App/WhiteboardView.d.ts +0 -22
  92. package/dist/App/index.d.ts +0 -3
  93. package/dist/AppListener.d.ts +0 -21
  94. package/dist/AppManager.d.ts +0 -107
  95. package/dist/AttributesDelegate.d.ts +0 -80
  96. package/dist/BoxEmitter.d.ts +0 -34
  97. package/dist/BoxManager.d.ts +0 -99
  98. package/dist/BuiltinApps.d.ts +0 -5
  99. package/dist/Cursor/Cursor.d.ts +0 -39
  100. package/dist/Cursor/icons.d.ts +0 -3
  101. package/dist/Cursor/index.d.ts +0 -46
  102. package/dist/Helper.d.ts +0 -17
  103. package/dist/InternalEmitter.d.ts +0 -39
  104. package/dist/Page/PageController.d.ts +0 -21
  105. package/dist/Page/index.d.ts +0 -3
  106. package/dist/PageState.d.ts +0 -9
  107. package/dist/ReconnectRefresher.d.ts +0 -24
  108. package/dist/RedoUndo.d.ts +0 -18
  109. package/dist/Register/index.d.ts +0 -28
  110. package/dist/Register/loader.d.ts +0 -4
  111. package/dist/Register/storage.d.ts +0 -8
  112. package/dist/Utils/AppCreateQueue.d.ts +0 -15
  113. package/dist/Utils/Common.d.ts +0 -23
  114. package/dist/Utils/Reactive.d.ts +0 -6
  115. package/dist/Utils/RoomHacker.d.ts +0 -3
  116. package/dist/Utils/error.d.ts +0 -27
  117. package/dist/Utils/log.d.ts +0 -1
  118. package/dist/View/CameraSynchronizer.d.ts +0 -16
  119. package/dist/View/MainView.d.ts +0 -47
  120. package/dist/View/ViewManager.d.ts +0 -13
  121. package/dist/callback.d.ts +0 -24
  122. package/dist/constants.d.ts +0 -49
  123. package/dist/index.cjs.js +0 -46
  124. package/dist/index.umd.js +0 -46
  125. package/dist/typings.d.ts +0 -82
  126. package/jest.config.js +0 -27
  127. package/pnpm-lock.yaml +0 -6302
  128. package/src/App/AppViewSync.ts +0 -68
  129. package/src/App/WhiteboardView.ts +0 -83
  130. package/src/View/CameraSynchronizer.ts +0 -56
  131. package/vite.config.js +0 -51
  132. /package/docs/{qickstart.md → cn/quickstart.md} +0 -0
@@ -1,6 +0,0 @@
1
- import { UpdateEventKind } from "white-web-sdk";
2
- import type { AkkoObjectUpdatedListener } from "white-web-sdk";
3
- export declare const onObjectByEvent: (event: UpdateEventKind) => (object: any, func: () => void) => (() => void) | undefined;
4
- export declare const safeListenPropsUpdated: <T>(getProps: () => T, callback: AkkoObjectUpdatedListener<T>, onDestroyed?: ((props: unknown) => void) | undefined) => () => void;
5
- export declare const onObjectRemoved: (object: any, func: () => void) => (() => void) | undefined;
6
- export declare const onObjectInserted: (object: any, func: () => void) => (() => void) | undefined;
@@ -1,3 +0,0 @@
1
- import type { WindowManager } from "../index";
2
- import type { Room, Player } from "white-web-sdk";
3
- export declare const replaceRoomFunction: (room: Room | Player, manager: WindowManager) => void;
@@ -1,27 +0,0 @@
1
- export declare class AppCreateError extends Error {
2
- message: string;
3
- }
4
- export declare class AppNotRegisterError extends Error {
5
- constructor(kind: string);
6
- }
7
- export declare class AppManagerNotInitError extends Error {
8
- message: string;
9
- }
10
- export declare class WhiteWebSDKInvalidError extends Error {
11
- constructor(version: string);
12
- }
13
- export declare class ParamsInvalidError extends Error {
14
- message: string;
15
- }
16
- export declare class BoxNotCreatedError extends Error {
17
- message: string;
18
- }
19
- export declare class InvalidScenePath extends Error {
20
- message: string;
21
- }
22
- export declare class BoxManagerNotFoundError extends Error {
23
- message: string;
24
- }
25
- export declare class BindContainerRoomPhaseInvalidError extends Error {
26
- message: string;
27
- }
@@ -1 +0,0 @@
1
- export declare const log: (...args: any[]) => void;
@@ -1,16 +0,0 @@
1
- import type { TeleBoxRect } from "@netless/telebox-insider";
2
- import type { Camera, View } from "white-web-sdk";
3
- import type { ISize } from "../AttributesDelegate";
4
- export declare type SaveCamera = (camera: Camera) => void;
5
- export declare class CameraSynchronizer {
6
- protected saveCamera: SaveCamera;
7
- remoteCamera?: Camera;
8
- remoteSize?: ISize;
9
- protected rect?: TeleBoxRect;
10
- protected view?: View;
11
- constructor(saveCamera: SaveCamera);
12
- setRect(rect: TeleBoxRect): void;
13
- setView(view: View): void;
14
- onRemoteUpdate: import("lodash").DebouncedFunc<(camera: Camera, size: ISize) => void>;
15
- onLocalCameraUpdate(camera: Camera): void;
16
- }
@@ -1,47 +0,0 @@
1
- import type { Size, View } from "white-web-sdk";
2
- import type { AppManager } from "../AppManager";
3
- export declare class MainViewProxy {
4
- private manager;
5
- private started;
6
- private mainViewIsAddListener;
7
- private mainView;
8
- private store;
9
- private synchronizer;
10
- private sideEffectManager;
11
- constructor(manager: AppManager);
12
- private startListenWritableChange;
13
- ensureCameraAndSize(): void;
14
- private get mainViewCamera();
15
- private get mainViewSize();
16
- private get didRelease();
17
- private moveCameraSizeByAttributes;
18
- start(): void;
19
- addCameraReaction: () => void;
20
- setCameraAndSize(): void;
21
- private cameraReaction;
22
- onUpdateContainerSizeRatio: () => void;
23
- get view(): View;
24
- get cameraState(): {
25
- width: number;
26
- height: number;
27
- centerX: number;
28
- centerY: number;
29
- scale: number;
30
- };
31
- createMainView(): View;
32
- onReconnect(): void;
33
- setFocusScenePath(path: string | undefined): View | undefined;
34
- rebind(): void;
35
- private onCameraUpdatedByDevice;
36
- private getStageSize;
37
- addMainViewListener(): void;
38
- removeMainViewListener(): void;
39
- private mainViewClickListener;
40
- mainViewClickHandler(): Promise<void>;
41
- setMainViewSize: import("lodash").DebouncedFunc<(size: Size) => void>;
42
- private addCameraListener;
43
- private removeCameraListener;
44
- private onCameraOrSizeUpdated;
45
- stop(): void;
46
- destroy(): void;
47
- }
@@ -1,13 +0,0 @@
1
- import type { View, Displayer } from "white-web-sdk";
2
- export declare class ViewManager {
3
- private displayer;
4
- views: Map<string, View>;
5
- constructor(displayer: Displayer);
6
- createView(id: string): View;
7
- getView(id: string): View | undefined;
8
- destroyView(id: string): void;
9
- setViewScenePath(id: string, scenePath: string): void;
10
- destroy(): void;
11
- }
12
- export declare const createView: (displayer: Displayer) => View;
13
- export declare const setDefaultCameraBound: (view: View) => void;
@@ -1,24 +0,0 @@
1
- import Emittery from "emittery";
2
- import type { TeleBoxColorScheme, TELE_BOX_STATE } from "@netless/telebox-insider";
3
- import type { CameraState, SceneState, ViewVisionMode } from "white-web-sdk";
4
- import type { LoadAppEvent } from "./Register";
5
- import type { PageState } from "./Page";
6
- export declare type PublicEvent = {
7
- mainViewModeChange: ViewVisionMode;
8
- boxStateChange: `${TELE_BOX_STATE}`;
9
- darkModeChange: boolean;
10
- prefersColorSchemeChange: TeleBoxColorScheme;
11
- cameraStateChange: CameraState;
12
- mainViewScenePathChange: string;
13
- mainViewSceneIndexChange: number;
14
- focusedChange: string | undefined;
15
- mainViewScenesLengthChange: number;
16
- canRedoStepsChange: number;
17
- canUndoStepsChange: number;
18
- loadApp: LoadAppEvent;
19
- ready: undefined;
20
- sceneStateChange: SceneState;
21
- pageStateChange: PageState;
22
- };
23
- export declare type CallbacksType = Emittery<PublicEvent>;
24
- export declare const callbacks: CallbacksType;
@@ -1,49 +0,0 @@
1
- export declare enum Events {
2
- AppMove = "AppMove",
3
- AppFocus = "AppFocus",
4
- AppResize = "AppResize",
5
- AppBoxStateChange = "AppBoxStateChange",
6
- GetAttributes = "GetAttributes",
7
- UpdateWindowManagerWrapper = "UpdateWindowManagerWrapper",
8
- InitReplay = "InitReplay",
9
- WindowCreated = "WindowCreated",
10
- SetMainViewScenePath = "SetMainViewScenePath",
11
- SetMainViewSceneIndex = "SetMainViewSceneIndex",
12
- SetAppFocusIndex = "SetAppFocusIndex",
13
- SwitchViewsToFreedom = "SwitchViewsToFreedom",
14
- MoveCamera = "MoveCamera",
15
- MoveCameraToContain = "MoveCameraToContain",
16
- CursorMove = "CursorMove",
17
- RootDirRemoved = "RootDirRemoved",
18
- Refresh = "Refresh",
19
- InitMainViewCamera = "InitMainViewCamera"
20
- }
21
- export declare const MagixEventName = "__WindowManger";
22
- export declare const EnsureReconnectEvent = "__WindowMangerEnsureReconnected__";
23
- export declare enum AppAttributes {
24
- Size = "size",
25
- Position = "position",
26
- SceneIndex = "SceneIndex",
27
- ZIndex = "zIndex"
28
- }
29
- export declare enum AppEvents {
30
- setBoxSize = "setBoxSize",
31
- setBoxMinSize = "setBoxMinSize",
32
- destroy = "destroy"
33
- }
34
- export declare enum AppStatus {
35
- StartCreate = "StartCreate"
36
- }
37
- export declare enum CursorState {
38
- Leave = "leave",
39
- Normal = "normal"
40
- }
41
- export declare const REQUIRE_VERSION = "2.16.1";
42
- export declare const MIN_WIDTH: number;
43
- export declare const MIN_HEIGHT: number;
44
- export declare const SET_SCENEPATH_DELAY = 100;
45
- export declare const DEFAULT_CONTAINER_RATIO: number;
46
- export declare const ROOT_DIR = "/";
47
- export declare const INIT_DIR = "/init";
48
- export declare const SETUP_APP_DELAY = 50;
49
- export declare const MAX_PAGE_SIZE = 500;