@interopio/workspaces-api 3.2.2 → 3.3.0

package/src/models/frame.ts

@@ -1,368 +0,0 @@
-import { checkThrowCallback, nonEmptyStringDecoder, restoreWorkspaceConfigDecoder, workspaceDefinitionDecoder, workspaceBuilderCreateConfigDecoder, resizeConfigDecoder, moveConfigDecoder, frameInitConfigDecoder } from "../shared/decoders";
-import { SubscriptionConfig } from "../types/subscription";
-import { PrivateDataManager } from "../shared/privateDataManager";
-import { FrameStreamData, WorkspaceStreamData, WindowStreamData } from "../types/protocol";
-import { IOConnectWorkspaces } from "../../workspaces.d";
-import { FramePrivateData } from "../types/privateData";
-import { UnsubscribeFunction } from "callback-registry";
-
-interface PrivateData {
-    manager: PrivateDataManager;
-}
-
-const data = new WeakMap<Frame, PrivateData>();
-
-const getData = (model: Frame): FramePrivateData => {
-    return data.get(model).manager.getFrameData(model);
-};
-
-export class Frame implements IOConnectWorkspaces.Frame {
-
-    constructor(dataManager: PrivateDataManager) {
-        data.set(this, { manager: dataManager });
-    }
-
-    public async registerShortcut(shortcut: string, callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        nonEmptyStringDecoder.runWithException(shortcut);
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-        const unsubscribe = await getData(this).controller.registerShortcut(shortcut, myId, callback);
-        return unsubscribe;
-    }
-
-    public get id(): string {
-        return getData(this).summary.id;
-    }
-
-    public get isInitialized(): boolean {
-        return getData(this).summary.isInitialized;
-    }
-
-    public getBounds(): Promise<IOConnectWorkspaces.FrameBounds> {
-        const myId = getData(this).summary.id;
-
-        return getData(this).controller.getFrameBounds(myId);
-    }
-
-    public async resize(config: IOConnectWorkspaces.ResizeConfig): Promise<void> {
-        const validatedConfig = resizeConfigDecoder.runWithException(config);
-        const myId = getData(this).summary.id;
-
-        return getData(this).controller.resizeItem(myId, validatedConfig);
-    }
-
-    public async move(config: IOConnectWorkspaces.MoveConfig): Promise<void> {
-        const validatedConfig = moveConfigDecoder.runWithException(config);
-
-        const myId = getData(this).summary.id;
-        return getData(this).controller.moveFrame(myId, validatedConfig);
-    }
-
-    public focus(): Promise<void> {
-        const myId = getData(this).summary.id;
-        return getData(this).controller.focusItem(myId);
-    }
-
-    public async state(): Promise<IOConnectWorkspaces.FrameState> {
-        const desktopGlobal = (window as any).glue42gd || (window as any).iodesktop;
-
-        if (!desktopGlobal) {
-            throw new Error("State operations are not supported in IO Connect Browser");
-        }
-        const myId = getData(this).summary.id;
-        return getData(this).controller.getFrameState(myId);
-    }
-
-    public async minimize(): Promise<void> {
-        const desktopGlobal = (window as any).glue42gd || (window as any).iodesktop;
-
-        if (!desktopGlobal) {
-            throw new Error("State operations are not supported in IO Connect Browser");
-        }
-        const myId = getData(this).summary.id;
-        return getData(this).controller.changeFrameState(myId, "minimized");
-    }
-
-    public async maximize(): Promise<void> {
-        const desktopGlobal = (window as any).glue42gd || (window as any).iodesktop;
-
-        if (!desktopGlobal) {
-            throw new Error("State operations are not supported in IO Connect Browser");
-        }
-        const myId = getData(this).summary.id;
-        return getData(this).controller.changeFrameState(myId, "maximized");
-    }
-
-    public async restore(): Promise<void> {
-        const desktopGlobal = (window as any).glue42gd || (window as any).iodesktop;
-
-        if (!desktopGlobal) {
-            throw new Error("State operations are not supported in IO Connect Browser");
-        }
-        const myId = getData(this).summary.id;
-        return getData(this).controller.changeFrameState(myId, "normal");
-    }
-
-    public close(): Promise<void> {
-        const myId = getData(this).summary.id;
-        return getData(this).controller.closeItem(myId);
-    }
-
-    public snapshot(): Promise<IOConnectWorkspaces.FrameSnapshot> {
-        const myId = getData(this).summary.id;
-        return getData(this).controller.getSnapshot(myId, "frame") as Promise<IOConnectWorkspaces.FrameSnapshot>;
-    }
-
-    public async workspaces(): Promise<IOConnectWorkspaces.Workspace[]> {
-        const controller = getData(this).controller;
-        return controller.getWorkspacesByFrameId(this.id);
-    }
-
-    public async getConstraints(): Promise<IOConnectWorkspaces.FrameConstraints> {
-        const controller = getData(this).controller;
-        const myId = getData(this).summary.id;
-
-        return controller.getFrameConstraints(myId);
-    }
-
-    public async restoreWorkspace(name: string, options?: IOConnectWorkspaces.RestoreWorkspaceConfig): Promise<IOConnectWorkspaces.Workspace> {
-        nonEmptyStringDecoder.runWithException(name);
-        const validatedOptions = restoreWorkspaceConfigDecoder.runWithException(options);
-
-        return getData(this).controller.restoreWorkspace(name, validatedOptions);
-    }
-
-    public createWorkspace(definition: IOConnectWorkspaces.WorkspaceDefinition, config?: IOConnectWorkspaces.WorkspaceCreateConfig): Promise<IOConnectWorkspaces.Workspace> {
-        const validatedDefinition = workspaceDefinitionDecoder.runWithException(definition);
-        const validatedConfig = workspaceBuilderCreateConfigDecoder.runWithException(config);
-
-        return getData(this).controller.createWorkspace(validatedDefinition, validatedConfig);
-    }
-
-    public async init(config: IOConnectWorkspaces.FrameInitializationConfig): Promise<void> {
-        frameInitConfigDecoder.runWithException(config);
-
-        if (getData(this).summary.isInitialized) {
-            throw new Error("The frame has already been initialized");
-        }
-        return getData(this).controller.initFrame(this.id, config);
-    }
-
-    public async onClosed(callback: (closed: IOConnectWorkspaces.FrameClosedData) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = (payload: FrameStreamData): void => {
-            callback({ frameId: payload.frameSummary.id, frameBounds: payload.frameBounds });
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "closed",
-            eventType: "frame",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onMaximized(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = (): void => {
-            callback();
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "maximized",
-            eventType: "frame",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onMinimized(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = (): void => {
-            callback();
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "minimized",
-            eventType: "frame",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onNormal(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = (): void => {
-            callback();
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "normal",
-            eventType: "frame",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onWorkspaceOpened(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = async (payload: WorkspaceStreamData): Promise<void> => {
-            const workspace = await getData(this).controller.transformStreamPayloadToWorkspace(payload);
-            callback(workspace);
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "opened",
-            eventType: "workspace",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onWorkspaceSelected(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = async (payload: WorkspaceStreamData): Promise<void> => {
-            const workspace = await getData(this).controller.getWorkspaceById(payload.workspaceSummary.id);
-            callback(workspace);
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "selected",
-            eventType: "workspace",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onWorkspaceClosed(callback: (closed: IOConnectWorkspaces.WorkspaceClosedData) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = (payload: WorkspaceStreamData): void => {
-            callback({ frameId: payload.frameSummary.id, workspaceId: payload.workspaceSummary.id, frameBounds: payload.frameBounds });
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "closed",
-            eventType: "workspace",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onWindowAdded(callback: (window: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const foundParent = await getData(this).controller.getParent((parent) => parent.id === payload.windowSummary.parentId);
-            const foundWindow = foundParent.children.find((child) => child.type === "window" && child.positionIndex === payload.windowSummary.config.positionIndex);
-            callback(foundWindow as IOConnectWorkspaces.WorkspaceWindow);
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "added",
-            eventType: "window",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onWindowRemoved(callback: (removed: { windowId?: string; workspaceId: string; frameId: string }) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = (payload: WindowStreamData): void => {
-            const { windowId, workspaceId, frameId } = payload.windowSummary.config;
-            callback({ windowId, workspaceId, frameId });
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "removed",
-            eventType: "window",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onWindowLoaded(callback: (window: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myId = getData(this).summary.id;
-
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const foundParent = await getData(this).controller.getParent((parent) => {
-                return parent.id === payload.windowSummary.parentId;
-            });
-            const foundWindow = foundParent.children.find((child) => child.type === "window" && child.positionIndex === payload.windowSummary.config.positionIndex);
-            callback(foundWindow as IOConnectWorkspaces.WorkspaceWindow);
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "loaded",
-            eventType: "window",
-            scope: "frame"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, myId);
-        return unsubscribe;
-    }
-
-    public async onInitializationRequested(callback: (context?: IOConnectWorkspaces.FrameInitializationContext) => void): Promise<UnsubscribeFunction> {
-        checkThrowCallback(callback);
-
-        if (!this.isInitialized) {
-            callback(getData(this).summary.initializationContext);
-        }
-
-        return () => {};
-    }
-
-    public async onFocusChanged(callback: (data: IOConnectWorkspaces.FrameFocusChangedData) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const myData = getData(this);
-        const { id } = myData.summary;
-
-        const wrappedCallback = (args: FrameStreamData): void => {
-            callback({ isFocused: args.frameSummary.isFocused });
-        };
-
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "focus",
-            eventType: "frame",
-            scope: "frame"
-        };
-        const unsubscribe = await myData.controller.processLocalSubscription(config, id);
-        return unsubscribe;
-    }
-}

package/src/models/group.ts

@@ -1,237 +0,0 @@
-import { Base } from "./base/base";
-import { IOConnectWorkspaces } from "../../workspaces.d";
-import { checkThrowCallback, elementResizeConfigDecoder, groupLockConfigDecoder } from "../shared/decoders";
-import { SubscriptionConfig } from "../types/subscription";
-
-interface PrivateData {
-    base: Base;
-}
-
-const privateData = new WeakMap<Group, PrivateData>();
-
-const getBase = (model: Group): Base => {
-    return privateData.get(model).base;
-};
-
-export class Group implements IOConnectWorkspaces.Group {
-
-    constructor(base: Base) {
-        privateData.set(this, { base });
-    }
-
-    public get type(): "group" {
-        return "group";
-    }
-
-    public get id(): string {
-        return getBase(this).getId(this);
-    }
-
-    public get frameId(): string {
-        return getBase(this).getFrameId(this);
-    }
-
-    public get workspaceId(): string {
-        return getBase(this).getWorkspaceId(this);
-    }
-
-    public get positionIndex(): number {
-        return getBase(this).getPositionIndex(this);
-    }
-
-    public get children(): IOConnectWorkspaces.WorkspaceElement[] {
-        return getBase(this).getAllChildren(this);
-    }
-
-    public get parent(): IOConnectWorkspaces.Workspace | IOConnectWorkspaces.WorkspaceBox {
-        return getBase(this).getMyParent(this);
-    }
-
-    public get frame(): IOConnectWorkspaces.Frame {
-        return getBase(this).getMyFrame(this);
-    }
-
-    public get workspace(): IOConnectWorkspaces.Workspace {
-        return getBase(this).getMyWorkspace(this);
-    }
-
-    public get allowExtract(): boolean {
-        return getBase(this).getAllowExtract(this);
-    }
-
-    public get allowReorder(): boolean {
-        return getBase(this).getAllowReorder(this);
-    }
-
-    public get allowDropLeft(): boolean {
-        return getBase(this).getAllowDropLeft(this);
-    }
-
-    public get allowDropRight(): boolean {
-        return getBase(this).getAllowDropRight(this);
-    }
-
-    public get allowDropTop(): boolean {
-        return getBase(this).getAllowDropTop(this);
-    }
-
-    public get allowDropBottom(): boolean {
-        return getBase(this).getAllowDropBottom(this);
-    }
-
-    public get allowDropHeader(): boolean {
-        return getBase(this).getAllowDropHeader(this);
-    }
-
-    public get allowDrop(): boolean {
-        return getBase(this).getAllowDrop(this);
-    }
-
-    public get showMaximizeButton(): boolean {
-        return getBase(this).getShowMaximizeButton(this);
-    }
-
-    public get showEjectButton(): boolean {
-        return getBase(this).getShowEjectButton(this);
-    }
-
-    public get showAddWindowButton(): boolean {
-        return getBase(this).getShowAddWindowButton(this);
-    }
-
-    public get minWidth(): number {
-        return getBase(this).getMinWidth(this);
-    }
-
-    public get minHeight(): number {
-        return getBase(this).getMinHeight(this);
-    }
-
-    public get maxWidth(): number {
-        return getBase(this).getMaxWidth(this);
-    }
-
-    public get maxHeight(): number {
-        return getBase(this).getMaxHeight(this);
-    }
-
-    public get width(): number {
-        return getBase(this).getWidthInPx(this);
-    }
-
-    public get height(): number {
-        return getBase(this).getHeightInPx(this);
-    }
-
-    public get isMaximized(): boolean {
-        return getBase(this).getIsMaximized(this);
-    }
-
-    public addWindow(definition: IOConnectWorkspaces.WorkspaceWindowDefinition): Promise<IOConnectWorkspaces.WorkspaceWindow> {
-        return getBase(this).addWindow(this, definition, "group");
-    }
-
-    public async addGroup(): Promise<Group> {
-        throw new Error("Adding groups as group child is not supported");
-    }
-
-    public async addColumn(): Promise<IOConnectWorkspaces.Column> {
-        throw new Error("Adding columns as group child is not supported");
-    }
-
-    public async addRow(): Promise<IOConnectWorkspaces.Row> {
-        throw new Error("Adding rows as group child is not supported");
-    }
-
-    public removeChild(predicate: (child: IOConnectWorkspaces.WorkspaceElement) => boolean): Promise<void> {
-        return getBase(this).removeChild(this, predicate);
-    }
-
-    public maximize(): Promise<void> {
-        return getBase(this).maximize(this);
-    }
-
-    public restore(): Promise<void> {
-        return getBase(this).restore(this);
-    }
-
-    public close(): Promise<void> {
-        return getBase(this).close(this);
-    }
-
-    public lock(config?: IOConnectWorkspaces.GroupLockConfig | ((config: IOConnectWorkspaces.GroupLockConfig) => IOConnectWorkspaces.GroupLockConfig)): Promise<void> {
-        let lockConfigResult = undefined;
-
-        if (typeof config === "function") {
-            const currentLockConfig = {
-                allowDrop: this.allowDrop,
-                allowDropHeader: this.allowDropHeader,
-                allowDropLeft: this.allowDropLeft,
-                allowDropRight: this.allowDropRight,
-                allowDropTop: this.allowDropTop,
-                allowDropBottom: this.allowDropBottom,
-                allowExtract: this.allowExtract,
-                allowReorder: this.allowReorder,
-                showAddWindowButton: this.showAddWindowButton,
-                showEjectButton: this.showEjectButton,
-                showMaximizeButton: this.showMaximizeButton
-            };
-
-            lockConfigResult = config(currentLockConfig);
-        } else {
-            lockConfigResult = config;
-        }
-        const verifiedConfig = lockConfigResult === undefined ? undefined : groupLockConfigDecoder.runWithException(lockConfigResult);
-        return getBase(this).lockContainer(this, verifiedConfig);
-    }
-
-    public async setSize(config: IOConnectWorkspaces.ElementResizeConfig): Promise<void> {
-        const verifiedConfig = elementResizeConfigDecoder.runWithException(config);
-
-        if (!verifiedConfig.width && !verifiedConfig.height) {
-            throw new Error("Expected either width or height to be passed.");
-        }
-
-
-        return getBase(this).setSize(this, config.width, config.height);
-    }
-
-    public async bundleToRow(): Promise<void> {
-        await getBase(this).bundleTo(this, "row");
-        await this.workspace.refreshReference();
-    }
-
-    public async bundleToColumn(): Promise<void> {
-        await getBase(this).bundleTo(this, "column");
-        await this.workspace.refreshReference();
-    }
-
-    public async onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.GroupLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (): Promise<void> => {
-            await this.workspace.refreshReference();
-            callback({
-                allowDrop: this.allowDrop,
-                allowDropHeader: this.allowDropHeader,
-                allowDropLeft: this.allowDropLeft,
-                allowDropTop: this.allowDropTop,
-                allowDropRight: this.allowDropRight,
-                allowDropBottom: this.allowDropBottom,
-                allowExtract: this.allowExtract,
-                allowReorder: this.allowReorder,
-                showAddWindowButton: this.showAddWindowButton,
-                showEjectButton: this.showEjectButton,
-                showMaximizeButton: this.showMaximizeButton
-            });
-        };
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "lock-configuration-changed",
-            eventType: "container",
-            scope: "container"
-        };
-        const unsubscribe = await getBase(this).processLocalSubscription(this, config);
-        return unsubscribe;
-    }
-
-}