@interopio/workspaces-api 4.2.4 → 4.3.0

package/workspaces.d.ts

@@ -105,6 +105,8 @@ export namespace IOConnectWorkspaces {
         title?: string;
         /** The context of the window used when restoring the window */
         context?: any;
+        /** Id used for correlating window instances to layout objects */
+        instanceId?: string;
     }
 
     /** An object describing a window definition in a workspace layout. */
@@ -304,11 +306,11 @@ export namespace IOConnectWorkspaces {
     }
 
     /**
-    * The loading strategy used to open new workspaces.
-    * "direct" will cause all windows to start loading at the same time as soon as the workspace loads
-    * "delayed" will cause all visible/active/selected windows to start loading at the same time as soon as the workspace loads. The rest will be loaded gradually at a specific interval.
-    * "lazy" will cause all visible/active/selected windows to start loading at the same time as soon as the workspace loads. The rest will start loading when the user selects them and not before that.
-   /** The loading strategy used to open new workspaces. "direct" will cause all windows to start loading at the same time, "delayed" */
+     * The loading strategy for opening new Workspaces.
+     * Use `"direct"` to make all windows participating in the Workspace to start loading at the same time as soon as the Workspace loads.
+     * Use `"delayed"` to make only the visible, active, and selected windows to start loading when the Workspace loads. The rest of the windows will be loaded gradually after that.
+     * Use `"lazy"` to make only the visible, active, and selected windows to start loading when the Workspace loads. The rest of the windows will start loading only when the user selects them.
+     */
     export type LoadingStrategy = "direct" | "delayed" | "lazy";
 
     /** An object which represent a workspace element. This is an element can be a box or a workspace window. */
@@ -746,18 +748,30 @@ export namespace IOConnectWorkspaces {
         icon?: string;
     }
 
-    /** An object describing the possible options when defining a new workspace */
+    /**
+     * Describes a Workspace to be created.
+     */
     export interface WorkspaceDefinition {
-        /** An array of all the workspace's children which will also be opened. */
+
+        /**
+         * Array of objects describing the Workspace windows and box elements (rows, columns, groups) that the Workspace will contain.
+         */
         children?: Array<WorkspaceWindowDefinition | BoxDefinition>;
 
-        /** An object which will be set as the window context of all windows inside this workspace. */
+        /**
+         * Context object for the Workspace. Can contain any data relevant to the Workspace
+         * which the Workspace or the apps loaded in it can use after the Workspace has been created.
+         */
         context?: any;
 
-        /** Workspace-specific options. */
+        /**
+         * Configuration for the new Workspace.
+         */
         config?: WorkspaceConfig;
 
-        /** Options regarding the frame where this workspace will be opened in. */
+        /**
+         * Options for targeting a Workspaces App instance that will host the newly created Workspace.
+         */
         frame?: FrameTargetingOptions;
     }
 
@@ -2555,3 +2569,4 @@ export namespace IOConnectWorkspaces {
 
 
 
+

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Tick42
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.