@interopio/workspaces-api 3.2.1 → 3.2.3

package/src/models/row.ts

@@ -1,188 +0,0 @@
-import { Base } from "./base/base";
-import { IOConnectWorkspaces } from "../../workspaces.d";
-import { checkThrowCallback, nonNegativeNumberDecoder, rowLockConfigDecoder, setMaximizationBoundaryAPIConfigDecoder } from "../shared/decoders";
-import { SubscriptionConfig } from "../types/subscription";
-
-interface PrivateData {
-    base: Base;
-}
-
-const privateData = new WeakMap<Row, PrivateData>();
-
-const getBase = (model: Row): Base => {
-    return privateData.get(model).base;
-};
-
-export class Row implements IOConnectWorkspaces.Row {
-
-    constructor(base: Base) {
-        privateData.set(this, { base });
-    }
-
-    public get type(): "row" {
-        return "row";
-    }
-
-    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 allowDrop(): boolean {
-        return getBase(this).getAllowDrop(this);
-    }
-
-    public get allowSplitters(): boolean {
-        return getBase(this).getAllowSplitters(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 isPinned(): boolean {
-        return getBase(this).getIsPinned(this);
-    }
-
-    public get isMaximized(): boolean {
-        return getBase(this).getIsMaximized(this);
-    }
-
-    public get maximizationBoundary(): boolean {
-        return getBase(this).getMaximizationBoundary(this);
-    }
-
-    public addWindow(definition: IOConnectWorkspaces.WorkspaceWindowDefinition): Promise<IOConnectWorkspaces.WorkspaceWindow> {
-        return getBase(this).addWindow(this, definition, "row");
-    }
-
-    public async addGroup(definition?: IOConnectWorkspaces.BoxDefinition): Promise<IOConnectWorkspaces.Group> {
-        if (definition?.type && definition.type !== "group") {
-            throw new Error(`Expected a group definition, but received ${definition.type}`);
-        }
-        return getBase(this).addParent<IOConnectWorkspaces.Group>(this, "group", "row", definition);
-    }
-
-    public async addColumn(definition?: IOConnectWorkspaces.BoxDefinition): Promise<IOConnectWorkspaces.Column> {
-        if (definition?.type && definition.type !== "column") {
-            throw new Error(`Expected a column definition, but received ${definition.type}`);
-        }
-        return getBase(this).addParent<IOConnectWorkspaces.Column>(this, "column", "row", definition);
-    }
-
-    public async addRow(): Promise<Row> {
-        throw new Error("Adding rows as row children 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.RowLockConfig | ((config: IOConnectWorkspaces.RowLockConfig) => IOConnectWorkspaces.RowLockConfig)): Promise<void> {
-        let lockConfigResult = undefined;
-
-        if (typeof config === "function") {
-            const currentLockConfig = {
-                allowDrop: this.allowDrop,
-                allowSplitters: this.allowSplitters
-            };
-
-            lockConfigResult = config(currentLockConfig);
-        } else {
-            lockConfigResult = config;
-        }
-
-        const verifiedConfig = lockConfigResult === undefined ? undefined : rowLockConfigDecoder.runWithException(lockConfigResult);
-
-        return getBase(this).lockContainer(this, verifiedConfig);
-    }
-
-    public async setHeight(height: number): Promise<void> {
-        nonNegativeNumberDecoder.runWithException(height);
-        return getBase(this).setHeight(this, height);
-    }
-
-
-    public async onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.RowLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (): Promise<void> => {
-            await this.workspace.refreshReference();
-            callback({
-                allowDrop: this.allowDrop,
-                allowSplitters: this.allowSplitters
-            });
-        };
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "lock-configuration-changed",
-            eventType: "container",
-            scope: "container"
-        };
-        const unsubscribe = await getBase(this).processLocalSubscription(this, config);
-        return unsubscribe;
-    }
-    public async setMaximizationBoundary(config: IOConnectWorkspaces.SetMaximizationBoundaryConfig): Promise<void> {
-        const validatedConfig = setMaximizationBoundaryAPIConfigDecoder.runWithException(config);
-        return getBase(this).setMaximizationBoundary(this, validatedConfig);
-    }
-
-}

package/src/models/window.ts

@@ -1,309 +0,0 @@
-import { checkThrowCallback, nonEmptyStringDecoder, windowLockConfigDecoder, elementResizeConfigDecoder } from "../shared//decoders";
-import { SubscriptionConfig } from "../types/subscription";
-import { PrivateDataManager } from "../shared/privateDataManager";
-import { WindowPrivateData } from "../types/privateData";
-import { IOConnectWorkspaces } from "../../workspaces";
-import { GDWindow } from "../types/glue";
-import { Row } from "./row";
-import { Column } from "./column";
-import { Group } from "./group";
-
-interface PrivateData {
-    manager: PrivateDataManager;
-}
-
-const data = new WeakMap<Window, PrivateData>();
-
-const getData = (model: Window): WindowPrivateData => {
-    return data.get(model).manager.getWindowData(model);
-};
-
-export class Window implements IOConnectWorkspaces.WorkspaceWindow {
-
-    constructor(dataManager: PrivateDataManager) {
-        data.set(this, { manager: dataManager });
-    }
-
-    public get id(): string {
-        return getData(this).config.windowId;
-    }
-
-    public get elementId(): string {
-        return getData(this).id;
-    }
-
-    public get type(): "window" {
-        return "window";
-    }
-
-    public get frameId(): string {
-        return getData(this).frame.id;
-    }
-
-    public get workspaceId(): string {
-        return getData(this).workspace.id;
-    }
-
-    public get positionIndex(): number {
-        return getData(this).config.positionIndex;
-    }
-
-    public get isMaximized(): boolean {
-        return getData(this).config.isMaximized;
-    }
-
-    public get isLoaded(): boolean {
-        return getData(this).controller.checkIsWindowLoaded(this.id);
-    }
-
-    public get isSelected(): boolean {
-        return getData(this).config.isSelected;
-    }
-
-    public get focused(): boolean {
-        return this.getGdWindow().isFocused;
-    }
-
-    public get title(): string {
-        return getData(this).config.title;
-    }
-
-    public get allowExtract(): boolean {
-        return getData(this).config.allowExtract;
-    }
-
-    public get allowReorder(): boolean {
-        return getData(this).config.allowReorder;
-    }
-
-    public get showCloseButton(): boolean {
-        return getData(this).config.showCloseButton;
-    }
-
-    public get width(): number {
-        return getData(this).config.widthInPx;
-    }
-
-    public get height(): number {
-        return getData(this).config.heightInPx;
-    }
-
-    public get minWidth(): number {
-        return getData(this).config.minWidth;
-    }
-
-    public get minHeight(): number {
-        return getData(this).config.minHeight;
-    }
-
-    public get maxWidth(): number {
-        return getData(this).config.maxWidth;
-    }
-
-    public get maxHeight(): number {
-        return getData(this).config.maxHeight;
-    }
-
-    public get workspace(): IOConnectWorkspaces.Workspace {
-        return getData(this).workspace;
-    }
-
-    public get frame(): IOConnectWorkspaces.Frame {
-        return getData(this).frame;
-    }
-
-    public get parent(): IOConnectWorkspaces.Workspace | IOConnectWorkspaces.Row | IOConnectWorkspaces.Column | IOConnectWorkspaces.Group {
-        return getData(this).parent;
-    }
-
-    public get appName(): string {
-        return getData(this).config.appName;
-    }
-
-    public async forceLoad(): Promise<void> {
-        if (this.isLoaded) {
-            return;
-        }
-        const controller = getData(this).controller;
-        const itemId = getData(this).id;
-
-        const windowId = await controller.forceLoadWindow(itemId);
-
-        getData(this).config.windowId = windowId;
-
-        await this.workspace.refreshReference();
-    }
-
-    public async focus(): Promise<void> {
-        const id = getData(this).id;
-        const controller = getData(this).controller;
-
-        await controller.focusItem(id);
-
-        await this.workspace.refreshReference();
-    }
-
-    public async close(): Promise<void> {
-        const id = getData(this).id;
-        const controller = getData(this).controller;
-
-        await controller.closeItem(id);
-
-        await getData(this)
-            .parent
-            .removeChild((child) => child.id === id);
-
-        await this.workspace.refreshReference();
-    }
-
-    public async setTitle(title: string): Promise<void> {
-        nonEmptyStringDecoder.runWithException(title);
-
-        const itemId = getData(this).id;
-        const controller = getData(this).controller;
-
-        await controller.setItemTitle(itemId, title);
-
-        await this.workspace.refreshReference();
-    }
-
-    public async maximize(): Promise<void> {
-        const id = getData(this).id;
-        const controller = getData(this).controller;
-
-        await controller.maximizeItem(id);
-
-        await this.workspace.refreshReference();
-    }
-
-    public async restore(): Promise<void> {
-        const id = getData(this).id;
-        const controller = getData(this).controller;
-
-        await controller.restoreItem(id);
-
-        await this.workspace.refreshReference();
-    }
-
-    public async eject(): Promise<GDWindow> {
-        if (!this.isLoaded) {
-            throw new Error("Cannot eject this window, because it is not loaded yet");
-        }
-        const itemId: string = getData(this).id;
-
-        const newWindowId: string = await getData(this).controller.ejectWindow(itemId);
-
-        getData(this).config.windowId = newWindowId;
-
-        await this.workspace.refreshReference();
-
-        return this.getGdWindow();
-    }
-
-    public getGdWindow(): GDWindow {
-        if (!this.isLoaded) {
-            throw new Error("Cannot fetch this GD window, because the window is not yet loaded");
-        }
-
-        const myId = getData(this).config.windowId;
-        const controller = getData(this).controller;
-
-        return controller.getGDWindow(myId);
-    }
-
-    public async moveTo(parent: IOConnectWorkspaces.Row | IOConnectWorkspaces.Column | IOConnectWorkspaces.Group): Promise<void> {
-        if (!(parent instanceof Row || parent instanceof Column || parent instanceof Group)) {
-            throw new Error("Cannot add to the provided parent, because the provided parent is not an instance of Row, Column or Group");
-        }
-
-        const myId = getData(this).id;
-        const controller = getData(this).controller;
-
-        const foundParent = await controller.getParent((p) => p.id === parent.id);
-
-        if (!foundParent) {
-            throw new Error("Cannot move the window to the selected parent, because this parent does not exist.");
-        }
-
-        await controller.moveWindowTo(myId, parent.id);
-
-        await this.workspace.refreshReference();
-    }
-
-    public async lock(config?: IOConnectWorkspaces.WorkspaceWindowLockConfig | ((config: IOConnectWorkspaces.WorkspaceWindowLockConfig) => IOConnectWorkspaces.WorkspaceWindowLockConfig)): Promise<void> {
-        let lockConfigResult = undefined;
-
-        if (typeof config === "function") {
-            const currentLockConfig = {
-                allowExtract: this.allowExtract,
-                allowReorder: this.allowReorder,
-                showCloseButton: this.showCloseButton
-            };
-            lockConfigResult = config(currentLockConfig);
-        } else {
-            lockConfigResult = config;
-        }
-
-        const verifiedConfig = lockConfigResult === undefined ? undefined : windowLockConfigDecoder.runWithException(lockConfigResult);
-        const windowPlacementId = getData(this).id;
-        await getData(this).controller.lockWindow(windowPlacementId, verifiedConfig);
-        await this.workspace.refreshReference();
-    }
-
-    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.");
-        }
-
-        const myId = getData(this).id;
-        const controller = getData(this).controller;
-
-        await controller.resizeItem(myId, {
-            height: verifiedConfig.height,
-            width: verifiedConfig.width,
-            relative: false
-        });
-
-        await this.workspace.refreshReference();
-    }
-
-    public async onRemoved(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe> {
-        checkThrowCallback(callback);
-        const id = getData(this).id;
-        const wrappedCallback = async (): Promise<void> => {
-            await this.workspace.refreshReference();
-            callback();
-        };
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "removed",
-            eventType: "window",
-            scope: "window"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, id);
-        return unsubscribe;
-    }
-
-    public async onLockConfigurationChanged(callback:(config:IOConnectWorkspaces.WorkspaceWindowLockConfig)=>void): Promise<IOConnectWorkspaces.Unsubscribe>{
-        checkThrowCallback(callback);
-        const id = getData(this).id;
-        const wrappedCallback = async (): Promise<void> => {
-            await this.workspace.refreshReference();
-            callback({
-                allowExtract: this.allowExtract,
-                allowReorder: this.allowReorder,
-                showCloseButton: this.showCloseButton
-            });
-        };
-        const config: SubscriptionConfig = {
-            callback: wrappedCallback,
-            action: "lock-configuration-changed",
-            eventType: "window",
-            scope: "window"
-        };
-        const unsubscribe = await getData(this).controller.processLocalSubscription(config, id);
-        return unsubscribe;
-    }
-}