@interopio/workspaces-api 3.2.2 → 3.3.0

package/src/types/protocol.ts

@@ -1,453 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Decoder } from "decoder-validate";
-import { IOConnectWorkspaces } from "../../workspaces";
-
-export interface StreamOperation {
-    name: string;
-    payloadDecoder: Decoder<any>;
-}
-
-export interface ControlOperation {
-    name: string;
-    resultDecoder: Decoder<any>;
-    argsDecoder?: Decoder<any>;
-}
-
-// #region incoming
-export interface IsWindowInSwimlaneResult {
-    inWorkspace: boolean;
-}
-
-export interface WorkspaceConfigResult {
-    frameId: string;
-    title: string;
-    name: string;
-    positionIndex: number;
-    layoutName: string | undefined;
-    isHibernated?: boolean;
-    allowSplitters?: boolean;
-    allowDrop?: boolean;
-    allowDropLeft?: boolean;
-    allowDropTop?: boolean;
-    allowDropRight?: boolean;
-    allowDropBottom?: boolean;
-    allowSystemHibernation?: boolean;
-    allowExtract?: boolean;
-    allowWindowReorder?: boolean;
-    showCloseButton?: boolean;
-    showSaveButton?: boolean;
-    allowWorkspaceTabReorder?: boolean;
-    allowWorkspaceTabExtract?: boolean;
-    minWidth?: number;
-    maxWidth?: number;
-    minHeight?: number;
-    maxHeight?: number;
-    showWindowCloseButtons?: boolean;
-    showAddWindowButtons?: boolean;
-    showEjectButtons?: boolean;
-    widthInPx?: number;
-    heightInPx?: number;
-    isSelected?: boolean;
-    isPinned?: boolean;
-}
-
-export interface BaseChildSnapshotConfig {
-    frameId: string;
-    workspaceId: string;
-    positionIndex: number;
-    minWidth?: number;
-    maxWidth?: number;
-    minHeight?: number;
-    maxHeight?: number;
-}
-
-export type ParentSnapshotConfig = RowSnapshotConfig | ColumnSnapshotConfig | GroupSnapshotConfig;
-
-export interface RowSnapshotConfig extends BaseChildSnapshotConfig {
-    type?: "row";
-    allowDrop?: boolean;
-    allowSplitters?: boolean;
-    widthInPx?: number;
-    heightInPx?: number;
-    isPinned?: boolean;
-    isMaximized?: boolean;
-    maximizationBoundary?: boolean
-}
-
-export interface ColumnSnapshotConfig extends BaseChildSnapshotConfig {
-    type?: "column";
-    allowDrop?: boolean;
-    allowSplitters?: boolean;
-    widthInPx?: number;
-    heightInPx?: number;
-    isPinned?: boolean;
-    isMaximized?: boolean;
-    maximizationBoundary?: boolean
-}
-
-export interface GroupSnapshotConfig extends BaseChildSnapshotConfig {
-    type?: "group";
-    allowDrop?: boolean;
-    allowDropLeft?: boolean;
-    allowDropRight?: boolean;
-    allowDropTop?: boolean;
-    allowDropBottom?: boolean;
-    allowDropHeader?: boolean;
-    allowExtract?: boolean;
-    allowReorder?: boolean;
-    showMaximizeButton?: boolean;
-    showEjectButton?: boolean;
-    showAddWindowButton?: boolean;
-    widthInPx?: number;
-    heightInPx?: number;
-    isMaximized?: boolean;
-}
-
-export interface SwimlaneWindowSnapshotConfig extends BaseChildSnapshotConfig {
-    windowId?: string;
-    isMaximized: boolean;
-    isFocused: boolean;
-    isSelected?: boolean;
-    appName?: string;
-    title?: string;
-    allowExtract?: boolean;
-    allowReorder?: boolean;
-    showCloseButton?: boolean;
-    widthInPx?: number;
-    heightInPx?: number;
-    context?: any;
-}
-
-export interface WindowSnapshotResult {
-    id: string;
-    type: "window";
-    config: SwimlaneWindowSnapshotConfig;
-}
-
-export interface SubParentSnapshotResult {
-    id: string;
-    type: "row" | "column" | "group";
-    children: ChildSnapshotResult[];
-    config: ParentSnapshotConfig;
-}
-export type ChildSnapshotResult = WindowSnapshotResult | SubParentSnapshotResult;
-
-export interface FrameSnapshotResult {
-    id: string;
-    config: any;
-    workspaces: WorkspaceSnapshotResult[];
-}
-
-export interface FrameSummaryResult {
-    id: string;
-    isFocused?: boolean;
-    isInitialized?: boolean;
-    initializationContext?: IOConnectWorkspaces.FrameInitializationContext;
-}
-
-export interface FrameSummariesResult {
-    summaries: FrameSummaryResult[];
-}
-
-export interface WorkspaceSnapshotResult {
-    id: string;
-    config: WorkspaceConfigResult;
-    children: ChildSnapshotResult[];
-    frameSummary: FrameSummaryResult;
-    context?: any;
-}
-
-export interface WorkspaceSummaryResult {
-    id: string;
-    config: WorkspaceConfigResult;
-}
-
-export interface WorkspaceSummariesResult {
-    summaries: WorkspaceSummaryResult[];
-}
-
-export interface LayoutSummary {
-    name: string;
-    applicationName?: string;
-}
-
-export interface LayoutSummariesResult {
-    summaries: LayoutSummary[];
-}
-
-export interface ContainerSummaryResult {
-    itemId: string;
-    config: ParentSnapshotConfig;
-}
-
-export interface ExportedLayoutsResult {
-    layouts: IOConnectWorkspaces.WorkspaceLayout[];
-}
-
-export interface SimpleWindowOperationSuccessResult {
-    windowId: string;
-}
-
-export interface AddItemResult {
-    itemId: string;
-    windowId?: string;
-}
-
-export interface PingResult {
-    live: boolean;
-}
-
-export interface FrameStateResult {
-    state: IOConnectWorkspaces.FrameState;
-}
-
-export interface FrameBounds {
-    top: number;
-    left: number;
-    width: number;
-    height: number;
-}
-
-export interface FrameBoundsResult {
-    bounds: FrameBounds;
-}
-
-export interface GetWorkspaceIconResult {
-    icon: string;
-}
-
-export interface GetPlatformFrameIdResult {
-    id?: string;
-}
-
-export interface OperationCheckResult {
-    isSupported: boolean;
-}
-
-
-// #endregion
-
-// #region outgoing
-
-export interface WorkspaceCreateConfigProtocol extends IOConnectWorkspaces.WorkspaceDefinition {
-    saveConfig?: IOConnectWorkspaces.WorkspaceCreateConfig;
-}
-
-export interface FrameInitializationConfigProtocol extends IOConnectWorkspaces.FrameInitializationConfig {
-    frameId: string;
-}
-
-export interface GetFrameSummaryConfig {
-    itemId: string;
-}
-
-export interface OpenWorkspaceConfig {
-    name: string;
-    options?: IOConnectWorkspaces.RestoreWorkspaceConfig;
-}
-
-export interface DeleteLayoutConfig {
-    name: string;
-}
-
-export interface SimpleItemConfig {
-    itemId: string;
-}
-
-export interface FrameSnapshotConfig extends SimpleItemConfig {
-    excludeIds?: boolean;
-}
-
-export interface FrameStateConfig {
-    frameId: string;
-    requestedState?: IOConnectWorkspaces.FrameState;
-}
-
-export interface ResizeItemConfig {
-    itemId: string;
-    width?: number;
-    height?: number;
-    relative?: boolean;
-}
-
-export interface SetMaximizationBoundaryConfig {
-    itemId: string;
-    enabled: boolean;
-}
-
-export interface LoadingAnimationConfig {
-    itemId: string;
-    type: "workspace";
-}
-
-export interface OperationCheckConfig {
-    operation: string;
-}
-
-export interface MoveFrameConfig {
-    itemId: string;
-    top?: number;
-    left?: number;
-    relative?: boolean;
-}
-
-export interface SetItemTitleConfig {
-    itemId: string;
-    title: string;
-}
-
-export interface MoveWindowConfig {
-    itemId: string;
-    containerId: string;
-}
-
-export interface AddWindowConfig {
-    definition: IOConnectWorkspaces.WorkspaceWindowDefinition;
-    parentId: string;
-    parentType: "row" | "column" | "group" | "workspace";
-}
-
-export interface AddContainerConfig {
-    definition: IOConnectWorkspaces.BoxDefinition;
-    parentId: string;
-    parentType: "row" | "column" | "group" | "workspace";
-}
-
-export interface BundleWorkspaceConfig {
-    type: "row" | "column";
-    workspaceId: string;
-}
-
-export interface ItemBundleConfig {
-    type: "row" | "column";
-    itemId: string;
-}
-
-export interface WindowSelector {
-    windowPlacementId: string;
-}
-
-export interface ItemSelector {
-    itemId: string;
-}
-
-export interface WorkspaceSelector {
-    workspaceId: string;
-}
-
-// #endregion
-
-// #region stream incoming
-export interface FrameStreamData {
-    frameSummary: FrameSummaryResult;
-    frameBounds?: FrameBounds;
-}
-
-// the optional workspaceSnapshot is expected only when the last workspace in a Core platform-frame is being closed, which triggers the creation of a default workspace 
-// reason: explicit snapshot in this case will make sure that even if new new workspace was quickly closed (spamming of the close button), the event will provide correct data
-export interface WorkspaceStreamData {
-    workspaceSummary: WorkspaceSummaryResult;
-    frameSummary: FrameSummaryResult;
-    workspaceSnapshot?: WorkspaceSnapshotResult;
-    frameBounds?: FrameBounds;
-}
-
-export interface ContainerStreamData {
-    containerSummary: ContainerSummaryResult;
-}
-
-export interface WindowStreamData {
-    windowSummary: {
-        itemId: string;
-        parentId: string;
-        config: SwimlaneWindowSnapshotConfig;
-    };
-}
-
-export interface LockWindowConfig {
-    windowPlacementId: string;
-    config?: {
-        allowExtract?: boolean;
-        allowReorder?: boolean;
-        showCloseButton?: boolean;
-    };
-}
-
-export interface LockRowConfig {
-    itemId: string;
-    type: "row";
-    config?: {
-        allowDrop?: boolean;
-        allowSplitters?: boolean;
-    };
-}
-
-export interface LockColumnConfig {
-    itemId: string;
-    type: "column";
-    config?: {
-        allowDrop?: boolean;
-        allowSplitters?: boolean;
-    };
-}
-
-export interface LockGroupConfig {
-    itemId: string;
-    type: "group";
-    config?: {
-        allowExtract?: boolean;
-        allowReorder?: boolean;
-        allowDrop?: boolean;
-        allowDropLeft?: boolean;
-        allowDropRight?: boolean;
-        allowDropTop?: boolean;
-        allowDropBottom?: boolean;
-        allowDropHeader?: boolean;
-        showMaximizeButton?: boolean;
-        showEjectButton?: boolean;
-        showAddWindowButton?: boolean;
-    };
-}
-
-export type LockContainerConfig = LockGroupConfig | LockColumnConfig | LockRowConfig;
-
-export interface LockWorkspaceConfig {
-    workspaceId: string;
-    config?: {
-        allowDrop?: boolean;
-        allowDropLeft?: boolean;
-        allowDropTop?: boolean;
-        allowDropRight?: boolean;
-        allowDropBottom?: boolean;
-        allowSystemHibernation?: boolean;
-        allowExtract?: boolean;
-        allowWindowReorder?: boolean;
-        allowSplitters?: boolean;
-        showCloseButton?: boolean;
-        showSaveButton?: boolean;
-        allowWorkspaceTabReorder?: boolean;
-        allowWorkspaceTabExtract?: boolean;
-    };
-}
-
-export interface PinWorkspaceConfig {
-    workspaceId: string;
-    icon?: string;
-}
-
-export interface SetWorkspaceIconConfig {
-    workspaceId: string;
-    icon?: string;
-}
-
-export interface ShortcutConfig {
-    shortcut: string;
-    frameId: string;
-}
-
-export interface ShortcutClickedData {
-    shortcut: string;
-    frameId: string;
-}
-
-// #endregion

package/src/types/subscription.ts

@@ -1,31 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Subscription } from "./glue";
-import { FrameStreamData, WorkspaceStreamData, ContainerStreamData, WindowStreamData } from "./protocol";
-
-export type WorkspaceEventType = "frame" | "workspace" | "container" | "window";
-export type WorkspaceEventScope = "global" | "frame" | "workspace" | "container" | "window";
-export type WorkspaceEventAction = "opened" | "closing" | "closed" | "focus" | "added" | "loaded" | "removed" | "childrenUpdate" | "containerChange" | "maximized" | "restored" | "minimized" | "normal" | "selected" | "lock-configuration-changed"| "hibernated"|"resumed";
-export type WorkspacePayload = FrameStreamData | WorkspaceStreamData | ContainerStreamData | WindowStreamData;
-
-export interface SubscriptionConfig {
-    eventType: WorkspaceEventType;
-    scope: WorkspaceEventScope;
-    action: WorkspaceEventAction;
-    callback: (args?: any) => void | Promise<void>;
-    scopeId?: string;
-}
-
-export interface ActiveSubscription {
-    streamType: WorkspaceEventType;
-    level: WorkspaceEventScope;
-    levelId?: string;
-    callbacksCount: number;
-    gdSub: Subscription;
-}
-
-export interface PendingSubscription {
-    streamType: WorkspaceEventType;
-    level: WorkspaceEventScope;
-    levelId?: string;
-    promise: Promise<void>;
-}

package/temp.d.ts

@@ -1,49 +0,0 @@
-import { IOConnectWorkspaces } from "./workspaces";
-
-export interface API extends IOConnectWorkspaces.API {
-    /**
-     * Notifies when a workspace is hibernated in any frame and returns an unsubscribe function.
-     * @param callback Callback function to handle the event. Receives the hibernated workspace as a parameter.
-     */
-    onWorkspaceHibernated(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
-
-    /**
-     * Notifies when a workspace is resumed in any frame and returns an unsubscribe function.
-     * @param callback Callback function to handle the event. Receives the resumed workspace as a parameter.
-     */
-    onWorkspaceResumed(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
-}
-
-export interface RestoreWorkspaceConfig extends IOConnectWorkspaces.RestoreWorkspaceConfig {
-    /** Controls the users ability to automatically hibernate the workspace */
-    allowSystemHibernation?: boolean;
-}
-
-export interface WorkspaceConfig extends IOConnectWorkspaces.WorkspaceConfig {
-    /** Controls the users ability to automatically hibernate the workspace */
-    allowSystemHibernation?: boolean;
-}
-
-export interface WorkspaceLockConfig extends IOConnectWorkspaces.WorkspaceLockConfig {
-    /** Controls the users ability to automatically hibernate the workspace */
-    allowSystemHibernation?: boolean;
-}
-
-export interface WorkspaceSummary extends IOConnectWorkspaces.WorkspaceSummary {
-    /** Controls the users ability to automatically hibernate the workspace */
-    allowSystemHibernation?: boolean;
-}
-
-export interface Workspace extends IOConnectWorkspaces.Workspace {
-    /**
-     * Notifies when this workspace is hibernated and returns an unsubscribe function.
-     * @param callback Callback function to handle the event.
-     */
-    onHibernated(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
-
-    /**
-     * Notifies when this workspace is resumed and returns an unsubscribe function.
-     * @param callback Callback function to handle the event.
-     */
-    onResumed(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-    "extends": "../../tsconfig.json",
-    "include": [
-        "./src/**/*.ts"
-, "temp.ts"    ],
-    "exclude": [
-        "node_modules",
-        "dist"
-    ]
-}