@interopio/workspaces-api 3.2.2 → 3.2.3

package/src/main.ts

@@ -1,415 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { IoC } from "./shared/ioc";
-import { checkThrowCallback, nonEmptyStringDecoder, workspaceLayoutDecoder, workspaceDefinitionDecoder, workspaceBuilderCreateConfigDecoder, builderConfigDecoder, restoreWorkspaceConfigDecoder, workspaceLayoutSaveConfigDecoder, emptyFrameDefinitionDecoder } from "./shared/decoders";
-import { FrameStreamData, WorkspaceStreamData, WorkspaceSnapshotResult, WindowStreamData } from "./types/protocol";
-import { FrameCreateConfig, WorkspaceIoCCreateConfig } from "./types/ioc";
-import { IOConnectWorkspaces } from "./../workspaces";
-import { WorkspacesController } from "./types/controller";
-import { version } from "../package.json";
-import { API } from "../temp";
-
-export const composeAPI = (glue: any, ioc: IoC): API => {
-
-    const controller: WorkspacesController = ioc.controller;
-
-    const inWorkspace = (): Promise<boolean> => {
-        const myId: string = glue.windows.my().id;
-
-        if (!myId) {
-            throw new Error("Cannot get my frame, because my id is undefined.");
-        }
-
-        return controller.checkIsInSwimlane(myId);
-    };
-
-    const getBuilder = (config: IOConnectWorkspaces.BuilderConfig): IOConnectWorkspaces.WorkspaceBuilder | IOConnectWorkspaces.BoxBuilder => {
-        const validatedConfig = builderConfigDecoder.runWithException(config);
-
-        return ioc.getBuilder(validatedConfig);
-    };
-
-    const getMyFrame = async (): Promise<IOConnectWorkspaces.Frame> => {
-        const windowId: string = glue.windows.my().id;
-
-        if (!windowId) {
-            throw new Error("Cannot get my frame, because my id is undefined.");
-        }
-
-        const isInSwimlane = await controller.checkIsInSwimlane(windowId);
-
-        if (!isInSwimlane) {
-            throw new Error("Cannot fetch your frame, because this window is not in a workspace");
-        }
-
-        return controller.getFrame({ windowId });
-    };
-
-    const getFrame = async (predicate: (frame: IOConnectWorkspaces.Frame) => boolean): Promise<IOConnectWorkspaces.Frame> => {
-        checkThrowCallback(predicate);
-
-        return controller.getFrame({ predicate });
-    };
-
-    const getAllFrames = async (predicate?: (frame: IOConnectWorkspaces.Frame) => boolean): Promise<IOConnectWorkspaces.Frame[]> => {
-        checkThrowCallback(predicate, true);
-
-        return controller.getFrames(predicate);
-    };
-
-    const getAllWorkspacesSummaries = (): Promise<IOConnectWorkspaces.WorkspaceSummary[]> => {
-        return controller.getAllWorkspaceSummaries();
-    };
-
-    const getMyWorkspace = async (): Promise<IOConnectWorkspaces.Workspace> => {
-        const myId: string = glue.windows.my().id;
-
-        if (!myId) {
-            throw new Error("Cannot get my workspace, because my id is undefined.");
-        }
-
-        const isInSwimlane = await controller.checkIsInSwimlane(myId);
-
-        if (!isInSwimlane) {
-            throw new Error("Cannot fetch your workspace, because this window is not in a workspace");
-        }
-
-        return await controller.getWorkspaceByWindowId(myId);
-    };
-
-    const getWorkspace = async (predicate: (workspace: IOConnectWorkspaces.Workspace) => boolean): Promise<IOConnectWorkspaces.Workspace> => {
-        checkThrowCallback(predicate);
-        return (await controller.getWorkspaces(predicate))[0];
-    };
-
-    const getWorkspaceById = async (workspaceId: string): Promise<IOConnectWorkspaces.Workspace> => {
-        nonEmptyStringDecoder.runWithException(workspaceId);
-
-        return controller.getWorkspaceById(workspaceId);
-    };
-
-    const getAllWorkspaces = (predicate?: (workspace: IOConnectWorkspaces.Workspace) => boolean): Promise<IOConnectWorkspaces.Workspace[]> => {
-        checkThrowCallback(predicate, true);
-        return controller.getWorkspaces(predicate);
-    };
-
-    const getWindow = async (predicate: (swimlaneWindow: IOConnectWorkspaces.WorkspaceWindow) => boolean): Promise<IOConnectWorkspaces.WorkspaceWindow> => {
-        checkThrowCallback(predicate);
-        return controller.getWindow(predicate);
-    };
-
-    const getParent = async (predicate: (parent: IOConnectWorkspaces.WorkspaceBox) => boolean): Promise<IOConnectWorkspaces.WorkspaceBox> => {
-        checkThrowCallback(predicate);
-        return controller.getParent(predicate);
-    };
-
-    const restoreWorkspace = async (name: string, options?: IOConnectWorkspaces.RestoreWorkspaceConfig): Promise<IOConnectWorkspaces.Workspace> => {
-        nonEmptyStringDecoder.runWithException(name);
-        const validatedOptions = restoreWorkspaceConfigDecoder.runWithException(options);
-        return controller.restoreWorkspace(name, validatedOptions);
-    };
-
-    const createWorkspace = async (definition: IOConnectWorkspaces.WorkspaceDefinition, saveConfig?: IOConnectWorkspaces.WorkspaceCreateConfig): Promise<IOConnectWorkspaces.Workspace> => {
-        const validatedDefinition = workspaceDefinitionDecoder.runWithException(definition);
-        const validatedConfig = workspaceBuilderCreateConfigDecoder.runWithException(saveConfig);
-
-        return controller.createWorkspace(validatedDefinition, validatedConfig);
-    };
-
-    const createEmptyFrame = async (definition?: IOConnectWorkspaces.EmptyFrameDefinition): Promise<IOConnectWorkspaces.Frame> => {
-        const validatedDefinition = emptyFrameDefinitionDecoder.runWithException(definition);
-
-        return controller.createEmptyFrame(validatedDefinition ?? {});
-    };
-
-    const layouts = {
-        getSummaries: (): Promise<IOConnectWorkspaces.WorkspaceLayoutSummary[]> => {
-            return controller.getLayoutSummaries();
-        },
-        delete: async (name: string): Promise<void> => {
-            nonEmptyStringDecoder.runWithException(name);
-            return controller.deleteLayout(name);
-        },
-        export: async (predicate?: (layout: IOConnectWorkspaces.WorkspaceLayout) => boolean): Promise<IOConnectWorkspaces.WorkspaceLayout[]> => {
-            checkThrowCallback(predicate, true);
-            return controller.exportLayout(predicate);
-        },
-        import: async (layouts: IOConnectWorkspaces.WorkspaceLayout[], mode: "replace" | "merge" = "replace"): Promise<void> => {
-
-            if (!Array.isArray(layouts)) {
-                throw new Error(`The provided layouts argument is not an array: ${JSON.stringify(layouts)}`);
-            }
-
-            layouts.forEach((layout) => workspaceLayoutDecoder.runWithException(layout));
-            return controller.importLayouts(layouts, mode);
-        },
-        save: async (config: IOConnectWorkspaces.WorkspaceLayoutSaveConfig): Promise<IOConnectWorkspaces.WorkspaceLayout> => {
-            const verifiedConfig = workspaceLayoutSaveConfigDecoder.runWithException(config);
-            return controller.saveLayout(verifiedConfig);
-        },
-        onSaved: async (callback: (layout: IOConnectWorkspaces.WorkspaceLayout) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-            checkThrowCallback(callback);
-
-            return controller.handleOnSaved(callback);
-        },
-        onRemoved: async (callback: (layout: IOConnectWorkspaces.WorkspaceLayout) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-            checkThrowCallback(callback);
-
-            return controller.handleOnRemoved(callback);
-        }
-    };
-
-    const onFrameOpened = async (callback: (frame: IOConnectWorkspaces.Frame) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-
-        const wrappedCallback = (payload: FrameStreamData): void => {
-            const frameConfig: FrameCreateConfig = {
-                summary: payload.frameSummary
-            };
-            const frame = ioc.getModel<"frame">("frame", frameConfig);
-            callback(frame);
-        };
-
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "frame", "opened");
-        return unsubscribe;
-    };
-
-    const onFrameClosed = async (callback: (closed: IOConnectWorkspaces.FrameClosedData) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = (payload: FrameStreamData): void => {
-            callback({ frameId: payload.frameSummary.id, frameBounds: payload.frameBounds });
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "frame", "closed");
-        return unsubscribe;
-    };
-
-    const onWorkspaceOpened = async (callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-
-        checkThrowCallback(callback);
-        const wrappedCallback = async (payload: WorkspaceStreamData): Promise<void> => {
-            const workspace = await controller.transformStreamPayloadToWorkspace(payload);
-
-            callback(workspace);
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "workspace", "opened");
-        return unsubscribe;
-    };
-
-    const onWorkspaceClosed = async (callback: (closed: IOConnectWorkspaces.WorkspaceClosedData) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-
-        const wrappedCallback = (payload: WorkspaceStreamData): void => {
-            callback({ frameId: payload.frameSummary.id, workspaceId: payload.workspaceSummary.id, frameBounds: payload.frameBounds });
-        };
-
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "workspace", "closed");
-        return unsubscribe;
-    };
-
-    const onWorkspaceHibernated = async (callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-
-        const wrappedCallback = async (payload: WorkspaceStreamData): Promise<void> => {
-            const workspace = await controller.transformStreamPayloadToWorkspace(payload);
-
-            callback(workspace);
-        };
-
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "workspace", "hibernated");
-        return unsubscribe;
-    };
-
-    const onWorkspaceResumed = async (callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-
-        const wrappedCallback = async (payload: WorkspaceStreamData):  Promise<void> => {
-            const workspace = await controller.transformStreamPayloadToWorkspace(payload);
-
-            callback(workspace);
-        };
-
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "workspace", "resumed");
-        return unsubscribe;
-    };
-
-    const onWindowAdded = async (callback: (swimlaneWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const snapshot = (await controller.getSnapshot(payload.windowSummary.config.workspaceId, "workspace")) as WorkspaceSnapshotResult;
-
-            const frameConfig: FrameCreateConfig = {
-                summary: snapshot.frameSummary
-            };
-            const frame = ioc.getModel<"frame">("frame", frameConfig);
-
-            const workspaceConfig: WorkspaceIoCCreateConfig = { frame, snapshot };
-
-            const workspace = ioc.getModel<"workspace">("workspace", workspaceConfig);
-
-            const windowParent = workspace.getBox((parent) => parent.id === payload.windowSummary.parentId);
-            const foundWindow = windowParent.children.find((child) => child.type === "window" && child.elementId === payload.windowSummary.itemId);
-
-            callback(foundWindow as IOConnectWorkspaces.WorkspaceWindow);
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "added");
-        return unsubscribe;
-    };
-
-    const onWindowLoaded = async (callback: (swimlaneWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const snapshot = (await controller.getSnapshot(payload.windowSummary.config.workspaceId, "workspace")) as WorkspaceSnapshotResult;
-
-            const frameConfig: FrameCreateConfig = {
-                summary: snapshot.frameSummary
-            };
-            const frame = ioc.getModel<"frame">("frame", frameConfig);
-
-            const workspaceConfig: WorkspaceIoCCreateConfig = { frame, snapshot };
-
-            const workspace = ioc.getModel<"workspace">("workspace", workspaceConfig);
-
-            const foundWindow = workspace.getWindow((win) => win.id && win.id === payload.windowSummary.config.windowId);
-
-            callback(foundWindow);
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "loaded");
-        return unsubscribe;
-    };
-
-    const onWindowRemoved = async (callback: (removed: { windowId: string; workspaceId: string; frameId: string }) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = (payload: WindowStreamData): void => {
-            const { windowId, workspaceId, frameId } = payload.windowSummary.config;
-            callback({ windowId, workspaceId, frameId });
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "removed");
-        return unsubscribe;
-    };
-
-    const onWindowMaximized = async (callback: (swimlaneWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const snapshot = (await controller.getSnapshot(payload.windowSummary.config.workspaceId, "workspace")) as WorkspaceSnapshotResult;
-
-            const frameConfig: FrameCreateConfig = {
-                summary: snapshot.frameSummary
-            };
-            const frame = ioc.getModel<"frame">("frame", frameConfig);
-
-            const workspaceConfig: WorkspaceIoCCreateConfig = { frame, snapshot };
-
-            const workspace = ioc.getModel<"workspace">("workspace", workspaceConfig);
-
-            const windowParent = workspace.getBox((parent) => parent.id === payload.windowSummary.parentId);
-            const foundWindow = windowParent.children.find((child) => child.type === "window" && child.elementId === payload.windowSummary.itemId);
-
-            callback(foundWindow as IOConnectWorkspaces.WorkspaceWindow);
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "maximized");
-        return unsubscribe;
-    };
-
-    const onWindowRestored = async (callback: (swimlaneWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const snapshot = (await controller.getSnapshot(payload.windowSummary.config.workspaceId, "workspace")) as WorkspaceSnapshotResult;
-
-            const frameConfig: FrameCreateConfig = {
-                summary: snapshot.frameSummary
-            };
-            const frame = ioc.getModel<"frame">("frame", frameConfig);
-
-            const workspaceConfig: WorkspaceIoCCreateConfig = { frame, snapshot };
-
-            const workspace = ioc.getModel<"workspace">("workspace", workspaceConfig);
-
-            const windowParent = workspace.getBox((parent) => parent.id === payload.windowSummary.parentId);
-            const foundWindow = windowParent.children.find((child) => child.type === "window" && child.elementId === payload.windowSummary.itemId);
-
-            callback(foundWindow as IOConnectWorkspaces.WorkspaceWindow);
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "restored");
-        return unsubscribe;
-    };
-
-
-    const onWindowSelected = async (callback: (swimlaneWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe> => {
-        checkThrowCallback(callback);
-        const wrappedCallback = async (payload: WindowStreamData): Promise<void> => {
-            const snapshot = (await controller.getSnapshot(payload.windowSummary.config.workspaceId, "workspace")) as WorkspaceSnapshotResult;
-
-            const frameConfig: FrameCreateConfig = {
-                summary: snapshot.frameSummary
-            };
-            const frame = ioc.getModel<"frame">("frame", frameConfig);
-
-            const workspaceConfig: WorkspaceIoCCreateConfig = { frame, snapshot };
-
-            const workspace = ioc.getModel<"workspace">("workspace", workspaceConfig);
-
-            const windowParent = workspace.getBox((parent) => parent.id === payload.windowSummary.parentId);
-            const foundWindow = windowParent.children.find((child) => child.type === "window" && child.elementId === payload.windowSummary.itemId);
-
-            callback(foundWindow as IOConnectWorkspaces.WorkspaceWindow);
-        };
-        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "selected");
-        return unsubscribe;
-    };
-
-    const waitForFrame = async (id: string): Promise<IOConnectWorkspaces.Frame> => {
-        nonEmptyStringDecoder.runWithException(id);
-        return new Promise<IOConnectWorkspaces.Frame>((res, rej) => {
-            let unsub: IOConnectWorkspaces.Unsubscribe = () => {
-                // do nothing
-            };
-            onFrameOpened((f) => {
-                if (f.id === id) {
-                    res(f);
-                    unsub();
-                }
-            }).then((u) => {
-                unsub = u;
-                return getAllFrames();
-            }).then((frames) => {
-                const myFrame = frames.find((f) => f.id === id);
-                if (myFrame) {
-                    res(myFrame);
-                    unsub();
-                }
-            }).catch(rej);
-        });
-    };
-
-    return {
-        inWorkspace,
-        getBuilder,
-        getMyFrame,
-        getFrame,
-        getAllFrames,
-        getAllWorkspacesSummaries,
-        getMyWorkspace,
-        getWorkspace,
-        getWorkspaceById,
-        getAllWorkspaces,
-        getWindow,
-        getBox: getParent,
-        restoreWorkspace,
-        createWorkspace,
-        createEmptyFrame,
-        waitForFrame,
-        layouts,
-        onFrameOpened,
-        onFrameClosed,
-        onWorkspaceOpened,
-        onWorkspaceClosed,
-        onWorkspaceHibernated,
-        onWorkspaceResumed,
-        onWindowAdded,
-        onWindowLoaded,
-        onWindowRemoved,
-        onWindowMaximized,
-        onWindowRestored,
-        onWindowSelected,
-        version
-    };
-};