@netless/window-manager 1.0.0-canary.24 → 1.0.0-canary.27

package/dist/src/constants.d.ts

@@ -0,0 +1,51 @@
+export declare enum Events {
+    AppMove = "AppMove",
+    AppFocus = "AppFocus",
+    AppResize = "AppResize",
+    AppBoxStateChange = "AppBoxStateChange",
+    GetAttributes = "GetAttributes",
+    UpdateWindowManagerWrapper = "UpdateWindowManagerWrapper",
+    WindowCreated = "WindowCreated",
+    SetMainViewScenePath = "SetMainViewScenePath",
+    SetMainViewSceneIndex = "SetMainViewSceneIndex",
+    SetAppFocusIndex = "SetAppFocusIndex",
+    SwitchViewsToFreedom = "SwitchViewsToFreedom",
+    CursorMove = "CursorMove",
+    RootDirRemoved = "RootDirRemoved",
+    Refresh = "Refresh",
+    InitMainViewCamera = "InitMainViewCamera"
+}
+export declare const MagixEventName = "__WindowManger";
+export declare const EnsureReconnectEvent = "__WindowMangerEnsureReconnected__";
+export declare enum AppAttributes {
+    Size = "size",
+    Position = "position",
+    SceneIndex = "SceneIndex",
+    ZIndex = "zIndex",
+    Visible = "visible",
+    Ratio = "ratio",
+    StageRatio = "stageRatio",
+    Draggable = "draggable",
+    Resizable = "resizable"
+}
+export declare enum AppEvents {
+    setBoxSize = "setBoxSize",
+    setBoxMinSize = "setBoxMinSize",
+    destroy = "destroy"
+}
+export declare enum AppStatus {
+    StartCreate = "StartCreate"
+}
+export declare enum CursorState {
+    Leave = "leave",
+    Normal = "normal"
+}
+export declare const REQUIRE_VERSION = "2.16.1";
+export declare const MIN_WIDTH: number;
+export declare const MIN_HEIGHT: number;
+export declare const SET_SCENEPATH_DELAY = 100;
+export declare const DEFAULT_CONTAINER_RATIO: number;
+export declare const ROOT_DIR = "/";
+export declare const INIT_DIR = "/init";
+export declare const SETUP_APP_DELAY = 50;
+export declare const MAX_PAGE_SIZE = 500;

package/dist/src/image.d.ts

@@ -0,0 +1,19 @@
+declare module "*.svg" {
+    const content: string;
+    export default content;
+}
+
+declare module "*.jpg" {
+    const content: string;
+    export default content;
+}
+
+declare module "*.png" {
+    const content: string;
+    export default content;
+}
+
+declare module "*.gif" {
+    const content: string;
+    export default content;
+}

package/dist/src/index.d.ts

@@ -0,0 +1,267 @@
+import { AppManager } from "./AppManager";
+import { CursorManager } from "./Cursor";
+import { InvisiblePlugin, ViewMode } from "white-web-sdk";
+import { ReconnectRefresher } from "./ReconnectRefresher";
+import { Val } from "value-enhancer";
+import type { TELE_BOX_STATE } from "./BoxManager";
+import type { Apps, Position, ICamera, ISize } from "./AttributesDelegate";
+import type { Displayer, SceneDefinition, View, Room, InvisiblePluginContext, Camera, CameraBound, Point, CameraState, Player, ImageInformation, SceneState, Rectangle } from "white-web-sdk";
+import type { AppListeners } from "./AppListener";
+import type { ApplianceIcons, NetlessApp, RegisterParams } from "./typings";
+import type { TeleBoxColorScheme, TeleBoxState } from "@netless/telebox-insider";
+import type { AppProxy } from "./App";
+import type { PublicEvent } from "./callback";
+import type Emittery from "emittery";
+import type { PageController, AddPageParams, PageState } from "./Page";
+export declare type WindowMangerAttributes = {
+    modelValue?: string;
+    boxState: TELE_BOX_STATE;
+    maximized?: boolean;
+    minimized?: boolean;
+    [key: string]: any;
+};
+export declare type apps = {
+    [key: string]: NetlessApp;
+};
+export declare type AddAppOptions = {
+    scenePath?: string;
+    title?: string;
+    scenes?: SceneDefinition[];
+};
+export declare type setAppOptions = AddAppOptions & {
+    appOptions?: any;
+};
+export declare type AddAppParams<TAttributes = any> = {
+    kind: string;
+    src?: string;
+    options?: AddAppOptions;
+    attributes?: TAttributes;
+};
+export declare type BaseInsertParams = {
+    kind: string;
+    src?: string;
+    options?: AddAppOptions;
+    attributes?: any;
+    isDynamicPPT?: boolean;
+};
+export declare type AppSyncAttributes = {
+    kind: string;
+    src?: string;
+    options: any;
+    state?: any;
+    isDynamicPPT?: boolean;
+    fullPath?: string;
+    createdAt?: number;
+    camera?: ICamera;
+    size?: ISize;
+};
+export declare type AppInitState = {
+    id: string;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    focus?: boolean;
+    maximized?: boolean;
+    minimized?: boolean;
+    sceneIndex?: number;
+    boxState?: TeleBoxState;
+    zIndex?: number;
+    visible?: boolean;
+    stageRatio?: number;
+    resizable?: boolean;
+    draggable?: boolean;
+    ratio?: number;
+};
+export declare type CursorMovePayload = {
+    uid: string;
+    state?: "leave";
+    position: Position;
+};
+export declare type MountParams = {
+    room: Room | Player;
+    container?: HTMLElement;
+    /** 白板高宽比例, 默认为 9 / 16 */
+    containerSizeRatio?: number;
+    /** @deprecated */
+    chessboard?: boolean;
+    /** 是否高亮显示同步区域, 默认为 true */
+    highlightStage?: boolean;
+    collectorContainer?: HTMLElement;
+    collectorStyles?: Partial<CSSStyleDeclaration>;
+    overwriteStyles?: string;
+    containerStyle?: string;
+    stageStyle?: string;
+    cursor?: boolean;
+    debug?: boolean;
+    disableCameraTransform?: boolean;
+    prefersColorScheme?: TeleBoxColorScheme;
+    applianceIcons?: ApplianceIcons;
+};
+export declare const reconnectRefresher: ReconnectRefresher;
+export declare class WindowManager extends InvisiblePlugin<WindowMangerAttributes> implements PageController {
+    static kind: string;
+    static displayer: Displayer;
+    static playground?: HTMLElement;
+    static container?: HTMLElement;
+    static debug: boolean;
+    static containerSizeRatio: number;
+    private static isCreated;
+    version: string;
+    dependencies: Record<string, string>;
+    appListeners?: AppListeners;
+    readonly?: boolean;
+    emitter: Emittery<PublicEvent>;
+    appManager?: AppManager;
+    cursorManager?: CursorManager;
+    viewMode: ViewMode;
+    viewMode$: Val<ViewMode, any>;
+    isReplay: boolean;
+    private _pageState?;
+    private boxManager?;
+    private static params?;
+    containerSizeRatio: number;
+    constructor(context: InvisiblePluginContext);
+    static mount(params: MountParams): Promise<WindowManager>;
+    private static initManager;
+    private static initContainer;
+    static get registered(): Map<string, RegisterParams<any, any, any>>;
+    bindContainer(container: HTMLElement): void;
+    bindCollectorContainer(container: HTMLElement): void;
+    /**
+     * 注册插件
+     */
+    static register<AppOptions = any, SetupResult = any, Attributes = any>(params: RegisterParams<AppOptions, SetupResult, Attributes>): Promise<void>;
+    /**
+     * 注销插件
+     */
+    static unregister(kind: string): void;
+    /**
+     * 创建一个 app 至白板
+     */
+    addApp<T = any>(params: AddAppParams<T>): Promise<string | undefined>;
+    private _addApp;
+    private setupScenePath;
+    /**
+     * 设置 mainView 的 ScenePath, 并且切换白板为可写状态
+     */
+    setMainViewScenePath(scenePath: string): Promise<void>;
+    /**
+     * 设置 mainView 的 SceneIndex, 并且切换白板为可写状态
+     */
+    setMainViewSceneIndex(index: number): Promise<void>;
+    nextPage(): Promise<boolean>;
+    prevPage(): Promise<boolean>;
+    jumpPage(index: number): Promise<boolean>;
+    addPage(params?: AddPageParams): Promise<void>;
+    /**
+     * 删除一页
+     * 默认删除当前页, 可以删除指定 index 页
+     * 最低保留一页
+     */
+    removePage(index?: number): Promise<boolean>;
+    /**
+     * 返回 mainView 的 ScenePath
+     */
+    getMainViewScenePath(): string | undefined;
+    /**
+     * 返回 mainView 的 SceneIndex
+     */
+    getMainViewSceneIndex(): number;
+    /**
+     * 设置所有 app 的 readonly 模式
+     */
+    setReadonly(readonly: boolean): void;
+    /**
+     * 切换 mainView 为可写
+     */
+    switchMainViewToWriter(): Promise<void> | undefined;
+    /**
+     * app destroy 回调
+     */
+    onAppDestroy(kind: string, listener: (error: Error) => void): void;
+    /**
+     * 设置 ViewMode
+     */
+    setViewMode(mode: ViewMode): void;
+    setBoxState(boxState: TeleBoxState): void;
+    setMaximized(maximized: boolean): void;
+    setMinimized(minimized: boolean): void;
+    get mainView(): View;
+    get camera(): Camera;
+    get baseCamera$(): Val<{
+        id: string;
+        centerX: number | null;
+        centerY: number | null;
+        scale: number;
+    } | undefined, any>;
+    get baseSize$(): Val<ISize | undefined, any>;
+    get cameraState(): CameraState;
+    get apps(): Apps | undefined;
+    get boxState(): TeleBoxState | undefined;
+    get darkMode(): boolean;
+    get prefersColorScheme(): TeleBoxColorScheme | undefined;
+    get focused(): string | undefined;
+    get focusedView(): View | undefined;
+    get mainViewSceneIndex(): number;
+    get mainViewSceneDir(): string;
+    get topApp(): string | undefined;
+    get mainViewScenesLength(): number;
+    get canRedoSteps(): number;
+    get canUndoSteps(): number;
+    get sceneState(): SceneState;
+    get pageState(): PageState;
+    /**
+     * 查询所有的 App
+     */
+    queryAll(): AppProxy[];
+    /**
+     * 查询单个 App
+     */
+    queryOne(appId: string): AppProxy | undefined;
+    /**
+     * 关闭 APP
+     */
+    closeApp(appId: string): Promise<void>;
+    moveCamera(camera: Partial<Camera>): void;
+    moveCameraToContain(rectangle: Rectangle): void;
+    convertToPointInWorld(point: Point): Point;
+    setCameraBound(cameraBound: CameraBound): void;
+    onDestroy(): void;
+    destroy(): void;
+    private _destroy;
+    private bindMainView;
+    get canOperate(): boolean;
+    get room(): Room;
+    safeSetAttributes(attributes: any): void;
+    safeUpdateAttributes(keys: string[], value: any): void;
+    setPrefersColorScheme(scheme: TeleBoxColorScheme): void;
+    cleanCurrentScene(): void;
+    redo(): number;
+    undo(): number;
+    delete(): void;
+    copy(): void;
+    paste(): void;
+    duplicate(): void;
+    insertText(x: number, y: number, text: string | undefined): string;
+    insertImage(info: ImageInformation): void;
+    completeImageUpload(uuid: string, url: string): void;
+    lockImage(uuid: string, locked: boolean): void;
+    lockImages(locked: boolean): void;
+    refresh(): void;
+    /** @inner */
+    _refresh(): void;
+    setContainerSizeRatio(ratio: number): void;
+    setContainerStyle(style: string): void;
+    setStageStyle(style: string): void;
+    createPPTHandler(): {
+        onPageJumpTo: (_pptUUID: string, index: number) => void;
+        onPageToNext: () => void;
+        onPageToPrev: () => void;
+    };
+    private isDynamicPPT;
+    private ensureAttributes;
+}
+export * from "./typings";
+export { BuiltinApps, BuiltinAppsMap } from "./BuiltinApps";
+export type { PublicEvent } from "./callback";

package/dist/src/shim.d.ts

@@ -0,0 +1,11 @@
+import type { SvelteComponent } from "svelte";
+
+declare module "*.svelte" {
+    const app: SvelteComponent;
+    export default app;
+}
+
+declare global {
+    const __APP_VERSION__: string;
+    const __APP_DEPENDENCIES__: Record<string, string>;
+}

package/dist/src/typings.d.ts

@@ -0,0 +1,88 @@
+import type Emittery from "emittery";
+import type { AnimationMode, ApplianceNames, Displayer, DisplayerState, Player, Room, SceneDefinition, SceneState, View } from "white-web-sdk";
+import type { AppContext } from "./App";
+import type { ReadonlyTeleBox, TeleBoxRect } from "@netless/telebox-insider";
+import type { PageState } from "./Page";
+import type { Member } from "./Helper";
+export interface NetlessApp<Attributes = any, MagixEventPayloads = any, AppOptions = any, SetupResult = any> {
+    kind: string;
+    config?: {
+        /** Box width relative to whiteboard. 0~1. Default 0.5. */
+        width?: number;
+        /** Box height relative to whiteboard. 0~1. Default 0.5. */
+        height?: number;
+        /** Minimum box width relative to whiteboard. 0~1. Default 340 / 720. */
+        minwidth?: number;
+        /** Minimum box height relative to whiteboard. 0~1. Default 340 / 720. */
+        minheight?: number;
+        /** App only single instance. */
+        singleton?: boolean;
+        /** App box enableShadowDom. Default true */
+        enableShadowDOM?: boolean;
+    };
+    setup: (context: AppContext<Attributes, MagixEventPayloads, AppOptions>) => SetupResult;
+}
+export declare type AppEmitterEvent<T = any> = {
+    /**
+     *  before plugin destroyed
+     */
+    destroy: {
+        error?: Error;
+    };
+    attributesUpdate: T | undefined;
+    /**
+     * room isWritable change or box blur
+     */
+    writableChange: boolean;
+    sceneStateChange: SceneState;
+    setBoxSize: {
+        width: number;
+        height: number;
+    };
+    setBoxMinSize: {
+        minwidth: number;
+        minheight: number;
+    };
+    setBoxTitle: {
+        title: string;
+    };
+    containerRectUpdate: TeleBoxRect;
+    roomStateChange: Partial<DisplayerState>;
+    focus: boolean;
+    reconnected: void;
+    seek: number;
+    pageStateChange: PageState;
+    roomMembersChange: Member[];
+};
+export declare type RegisterEventData = {
+    appId: string;
+};
+export declare type RegisterEvents<SetupResult = any> = {
+    created: RegisterEventData & {
+        result: SetupResult;
+    };
+    destroy: RegisterEventData;
+    focus: RegisterEventData;
+};
+export declare type RegisterParams<AppOptions = any, SetupResult = any, Attributes = any> = {
+    kind: string;
+    src: NetlessApp<Attributes, SetupResult> | string | (() => Promise<NetlessApp<Attributes, SetupResult>>);
+    appOptions?: AppOptions | (() => AppOptions);
+    addHooks?: (emitter: Emittery<RegisterEvents<SetupResult>>) => void;
+    /** dynamic load app package name */
+    name?: string;
+    contentStyles?: string;
+};
+export declare type AppListenerKeys = keyof AppEmitterEvent;
+export declare type ApplianceIcons = Partial<Record<ApplianceNames, string>>;
+export declare type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export type { AppContext } from "./App/AppContext";
+export type { WhiteBoardView } from "./App";
+export type { ReadonlyTeleBox, TeleBoxRect };
+export type { SceneState, SceneDefinition, View, AnimationMode, Displayer, Room, Player };
+export type { Storage, StorageStateChangedEvent, StorageStateChangedListener } from "./App/Storage";
+export * from "./Page";
+export * from "./Utils/error";
+export type { Member } from "./Helper";