@interopio/workspaces-api 4.5.0 → 5.0.0-next.0

package/workspaces.d.ts

@@ -20,7 +20,10 @@ export namespace IOConnectWorkspaces {
 
     /** An object describing a workspace layout. */
     export interface WorkspaceLayout {
-        /** An unique string name and identifier of the layout */
+        /** A unique string identifier of the layout */
+        id?: string;
+
+        /** name of the layout */
         name: string;
 
         /** The type of the workspace element. */
@@ -185,6 +188,10 @@ export namespace IOConnectWorkspaces {
         allowSystemHibernation?: boolean;
     }
 
+    export interface RestoreWorkspaceByIdConfig extends RestoreWorkspaceConfig {
+        layoutId: string;
+    }
+
     /**
      * Settings for showing a previously hidden Workspaces Frame instance.
      */
@@ -480,6 +487,22 @@ export namespace IOConnectWorkspaces {
          * @default true
          */
         allowSystemHibernation?: boolean;
+
+        appRestrictions?: AppRestrictions | undefined;
+    }
+
+    export interface AppRestrictionRule {
+        allowInApplicationPopup?: boolean;
+        allowDrop?: boolean;
+    }
+
+    export interface AppRestrictionEntry extends AppRestrictionRule {
+        appName: string;
+    }
+
+    export interface AppRestrictions {
+        apps?: AppRestrictionEntry[];
+        default?: AppRestrictionRule;
     }
 
     /** A config object which provides fine grain control when locking a workspace */
@@ -775,6 +798,18 @@ export namespace IOConnectWorkspaces {
         frame?: FrameTargetingOptions;
     }
 
+    export interface RestoreWorkspaceByIdDefinition {
+        /**
+        * The id of a saved workspace layout, which will be restored.
+        */
+        id: string;
+
+        /**
+        * An optional object containing various workspace restore options.
+        */
+        restoreOptions?: RestoreWorkspaceConfig;
+    }
+
     /** An object describing the possible options when restoring a workspace */
     export interface RestoreWorkspaceDefinition {
         /**
@@ -843,6 +878,8 @@ export namespace IOConnectWorkspaces {
 
     /** An object describing a workspace layout without the underlying structure */
     export interface WorkspaceLayoutSummary {
+        id?: string;
+
         /** An unique string name and identifier of the layout */
         name: string;
 
@@ -880,7 +917,7 @@ export namespace IOConnectWorkspaces {
         /**
          * Array of workspace definitions with which the frame should be opened
          */
-        workspaces: Array<IOConnectWorkspaces.WorkspaceDefinition | RestoreWorkspaceDefinition>;
+        workspaces: Array<IOConnectWorkspaces.WorkspaceDefinition | RestoreWorkspaceDefinition | RestoreWorkspaceByIdDefinition>;
     }
 
     export interface FrameInitializationContext {
@@ -980,11 +1017,11 @@ export namespace IOConnectWorkspaces {
     }
 
     /**
-     * Options for setting the on-top state of a Workspaces Frame.
+     * Settings for placing a Workspaces App instance on top of the z-order.
      */
     export interface FrameSetOnTopOptions {
         /**
-         * If `true`, the Frame will be set on top of other windows.
+         * If `true`, the Workspaces App instance will be set on top of the z-order.
          */
         onTop: boolean;
     }
@@ -1287,9 +1324,11 @@ export namespace IOConnectWorkspaces {
         showDialog<T>(options: FrameDialogOptions): Promise<T>;
 
         /**
-         * Sets the on-top state of the Frame.
+         * Sets a Workspaces App instance on top of the z-order.
          * *Available only in **io.Connect Desktop**.*
-         * @param options Options for setting the on-top state.
+         * @param options Settings for placing the Workspaces App instance on top of the z-order.
+         * @since io.Connect Desktop 10.3
+         * @since @interopio/workspaces-api 4.5
          */
         setOnTop(options: FrameSetOnTopOptions): Promise<void>;
 
@@ -1397,6 +1436,9 @@ export namespace IOConnectWorkspaces {
         /** The name of the originating layout of the current workspace if any */
         layoutName: string | undefined;
 
+        /** The id of the originating layout of the current workspace if any. Can be undefined if using with an older version of **io.Connect Desktop** or **io.Connect Browser**. */
+        layoutId?: string;
+
         /** Indicates if the workspace is hibernated */
         isHibernated?: boolean;
 
@@ -1480,6 +1522,8 @@ export namespace IOConnectWorkspaces {
          * This setting doesn't apply to programmatic hibernation via the `hibernate()` method of a `Workspace` instance.
          */
         allowSystemHibernation?: boolean;
+
+        appRestrictions?: AppRestrictions;
     }
 
     export type SaveLayoutConfig = Omit<Omit<IOConnectWorkspaces.WorkspaceLayoutSaveConfig, "name">, "workspaceId">;
@@ -1714,19 +1758,21 @@ export namespace IOConnectWorkspaces {
          */
         onResumed(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
-       /**
-        * Notifies when the Workspace tab has been reordered. Returns an unsubscribe function.
-        * @param callback Callback function for handling the event.
-        * *Available only in **io.Connect Browser**.*
-        * @since io.Connect Browser 4.4
-        */
+        /**
+         * Notifies when the Workspace tab has been reordered. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event.
+         * @since io.Connect Desktop 10.3
+         * @since io.Connect Browser 4.4
+         * @since @interopio/workspaces-api 4.4
+         */
         onTabReordered(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
          * Notifies when the tab of a window participating in the Workspace has been reordered. Returns an unsubscribe function.
          * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the window whose tab has been reordered.
-         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Desktop 10.3
          * @since io.Connect Browser 4.4
+         * @since @interopio/workspaces-api 4.4
          */
         onWindowTabReordered(callback: (window: WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
@@ -2213,8 +2259,9 @@ export namespace IOConnectWorkspaces {
         /**
          * Notifies when the tab of the Workspace window has been reordered. Returns an unsubscribe function.
          * @param callback Callback function for handling the event.
-         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Desktop 10.3
          * @since io.Connect Browser 4.4
+         * @since @interopio/workspaces-api 4.4
          */
         onTabReordered(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
     }
@@ -2286,6 +2333,7 @@ export namespace IOConnectWorkspaces {
 
     /** A configuration object used to save a current workspace as a layout */
     export interface WorkspaceLayoutSaveConfig {
+        id?: string;
         /**
          * A string used as name (doubles as id) of the layout, which is later used when restoring it.
          */
@@ -2321,6 +2369,14 @@ export namespace IOConnectWorkspaces {
         saveWindowContexts?: boolean;
     }
 
+    /** A configuration object used to overwrite an existing workspace layout, identified by its id */
+    export interface WorkspaceLayoutSaveByIdConfig extends WorkspaceLayoutSaveConfig {
+        /**
+         * The id of the layout to overwrite.
+         */
+        id?: string;
+    }
+
     export interface SetMaximizationBoundaryConfig {
         /**
          * Represents the new value of the maximizationBoundary property
@@ -2397,6 +2453,12 @@ export namespace IOConnectWorkspaces {
          */
         delete(name: string): Promise<void>;
 
+        /**
+         * Deletes a previously saved layout by its id.
+         * @param layoutId The id of the layout to delete.
+         */
+        deleteById(layoutId: string): Promise<void>;
+
         /**
          * Returns all layouts which satisfy the predicate. This collection of all saved layouts includes the layouts structure. If no predicate is provided, it returns all saved layouts.
          * @param predicate A filtering function (predicate) called for each saved layout.
@@ -2415,6 +2477,13 @@ export namespace IOConnectWorkspaces {
          */
         save(config: WorkspaceLayoutSaveConfig): Promise<WorkspaceLayout>;
 
+        /**
+         * Overwrites the layout with the specified id with the structure of an existing, open workspace.
+         * Prefer this over `save()` when layout names aren't guaranteed to be unique (e.g. when layout sharing is enabled).
+         * @param config An object describing the id of the layout to overwrite, the layout name and the id of the workspace, whose structure will be saved.
+         */
+        saveById(config: WorkspaceLayoutSaveByIdConfig): Promise<WorkspaceLayout>;
+
         /**
          * Notifies when a layouts has been saved. This event is fired when a new layout has been saved and an existing layout has been updated.
          * @param callback Callback function to handle the event. Receives the saved layout as a parameter.
@@ -2512,6 +2581,12 @@ export namespace IOConnectWorkspaces {
          */
         restoreWorkspace(name: string, options?: RestoreWorkspaceConfig): Promise<Workspace>;
 
+        /**
+         * Opens a new workspace by restoring a previously saved workspace layout by its id.
+         * @param options An object containing the id of the layout to restore and various workspace restore options.
+         */
+        restoreWorkspaceById(options: RestoreWorkspaceByIdConfig): Promise<Workspace>;
+
         /**
          * Opens a new workspace based on the provided definition.
          * @param definition An object describing the shape and options of the workspace.
@@ -2581,8 +2656,9 @@ export namespace IOConnectWorkspaces {
         /**
          * Notifies when the tab of any Workspace in any Workspaces App has been reordered. Returns an unsubscribe function.
          * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the Workspace whose tab has been reordered.
-         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Desktop 10.3
          * @since io.Connect Browser 4.4
+         * @since @interopio/workspaces-api 4.4
          */
         onWorkspaceTabReordered(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
         /**
@@ -2628,8 +2704,9 @@ export namespace IOConnectWorkspaces {
         /**
          * Notifies when the tab of a Workspace window participating in any Workspace in any Workspaces App has been reordered. Returns an unsubscribe function.
          * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the Workspace window whose tab has been reordered.
-         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Desktop 10.3
          * @since io.Connect Browser 4.4
+         * @since @interopio/workspaces-api 4.4
          */
         onWindowTabReordered(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;