@interopio/workspaces-api 4.3.0 → 4.5.0-next.1

package/changelog.md

@@ -1,4 +1,18 @@
-4.2.1
+## 4.4.0
+
+## 4.5.0-next.1
+
+### Minor Changes
+
+- f9022d0: feat: Added the WorkspacesFrame.setOnTop method
+
+### Minor Changes
+
+- 3ba192c: feat: implemented the saveWindowContexts flag for workspace layouts
+
+### Patch Changes
+
+- 3a52c8d: feature: Added support for the TabReordered event for Workspace and WorkspaceWindow tabs
 
 ## 4.3.0
 
@@ -9,6 +23,7 @@
 ### Patch Changes
 
 - ff2a338: chore: prerelease 4.3 snapshot
+  4.2.1
   chore: G4E-10143 Changed the timeout for the showDialog method
   feat: G4E-9244 Added option to blur the Frame instance that has displayed the dialog
   4.2.0

package/dist/workspaces.es.js

@@ -1143,7 +1143,7 @@ const streamRequestArgumentsDecoder = object({
     type: eventTypeDecoder,
     branch: nonEmptyStringDecoder
 });
-const workspaceEventActionDecoder = oneOf(constant("opened"), constant("closing"), constant("closed"), constant("focus"), constant("added"), constant("loaded"), constant("removed"), constant("childrenUpdate"), constant("containerChange"), constant("maximized"), constant("restored"), constant("minimized"), constant("normal"), constant("selected"), constant("lock-configuration-changed"), constant("hibernated"), constant("resumed"));
+const workspaceEventActionDecoder = oneOf(constant("opened"), constant("closing"), constant("closed"), constant("focus"), constant("added"), constant("loaded"), constant("removed"), constant("childrenUpdate"), constant("containerChange"), constant("maximized"), constant("restored"), constant("minimized"), constant("normal"), constant("selected"), constant("lock-configuration-changed"), constant("hibernated"), constant("resumed"), constant("tab-reordered"));
 const workspaceConfigResultDecoder = object({
     frameId: nonEmptyStringDecoder,
     title: nonEmptyStringDecoder,
@@ -1439,7 +1439,14 @@ const workspaceLayoutSaveConfigDecoder = object({
     workspaceId: nonEmptyStringDecoder,
     saveContext: optional(boolean()),
     allowMultiple: optional(boolean()),
-    metadata: optional(object())
+    metadata: optional(object()),
+    saveWindowContexts: optional(boolean())
+});
+const saveLayoutConfigDecoder = object({
+    saveContext: optional(boolean()),
+    allowMultiple: optional(boolean()),
+    metadata: optional(object()),
+    saveWindowContexts: optional(boolean())
 });
 const workspaceLockConfigDecoder = object({
     allowDrop: optional(boolean()),
@@ -1623,6 +1630,13 @@ const showFrameDialogConfigDecoder = object({
     frameId: nonEmptyStringDecoder,
     options: frameDialogOptionsDecoder
 });
+const frameSetOnTopOptionsDecoder = object({
+    onTop: boolean()
+});
+const setFrameOnTopConfigDecoder = object({
+    frameId: nonEmptyStringDecoder,
+    onTop: boolean()
+});
 
 const webPlatformMethodName = "T42.Web.Platform.Control";
 const webPlatformWspStreamName = "T42.Web.Platform.WSP.Stream";
@@ -1706,7 +1720,8 @@ const OPERATIONS = {
     showPopup: { name: "showPopup", argsDecoder: ShowPopupConfigDecoder, resultDecoder: voidResultDecoder },
     changeFrameVisibility: { name: "changeFrameVisibility", argsDecoder: changeFrameVisibilityConfigDecoder, resultDecoder: voidResultDecoder },
     getFrameVisibility: { name: "getFrameVisibility", argsDecoder: simpleItemConfigDecoder, resultDecoder: frameVisibilityResultDecoder },
-    showFrameDialog: { name: "showFrameDialog", argsDecoder: showFrameDialogConfigDecoder, resultDecoder: anyJson() }
+    showFrameDialog: { name: "showFrameDialog", argsDecoder: showFrameDialogConfigDecoder, resultDecoder: anyJson() },
+    setFrameOnTop: { name: "setFrameOnTop", argsDecoder: setFrameOnTopConfigDecoder, resultDecoder: voidResultDecoder }
 };
 
 class PromiseWrapper {
@@ -2860,7 +2875,10 @@ class Workspace {
     }
     async saveLayout(name, config) {
         nonEmptyStringDecoder.runWithException(name);
-        await getData$3(this).controller.saveLayout({ name, workspaceId: this.id, saveContext: config?.saveContext, metadata: config?.metadata, allowMultiple: config?.allowMultiple });
+        if (config) {
+            saveLayoutConfigDecoder.runWithException(config);
+        }
+        await getData$3(this).controller.saveLayout({ name, workspaceId: this.id, saveContext: config?.saveContext, metadata: config?.metadata, allowMultiple: config?.allowMultiple, saveWindowContexts: config?.saveWindowContexts });
     }
     async setTitle(title) {
         nonEmptyStringDecoder.runWithException(title);
@@ -3123,6 +3141,57 @@ class Workspace {
         const unsubscribe = await getData$3(this).controller.processLocalSubscription(config, id);
         return unsubscribe;
     }
+    async onLockConfigurationChanged(callback) {
+        checkThrowCallback(callback);
+        const id = getData$3(this).id;
+        const wrappedCallback = async () => {
+            await this.refreshReference();
+            callback({
+                allowDrop: this.allowDrop,
+                allowDropLeft: this.allowDropLeft,
+                allowDropTop: this.allowDropTop,
+                allowDropRight: this.allowDropRight,
+                allowDropBottom: this.allowDropBottom,
+                allowSystemHibernation: this.allowSystemHibernation,
+                allowExtract: this.allowExtract,
+                allowSplitters: this.allowSplitters,
+                allowWindowReorder: this.allowWindowReorder,
+                allowWorkspaceTabExtract: this.allowWorkspaceTabExtract,
+                allowWorkspaceTabReorder: this.allowWorkspaceTabReorder,
+                showAddWindowButtons: this.showAddWindowButtons,
+                showCloseButton: this.showCloseButton,
+                showEjectButtons: this.showEjectButtons,
+                showSaveButton: this.showSaveButton,
+                showWindowCloseButtons: this.showWindowCloseButtons
+            });
+        };
+        const config = {
+            action: "lock-configuration-changed",
+            eventType: "workspace",
+            scope: "workspace",
+            scopeId: id,
+            callback: wrappedCallback
+        };
+        const unsubscribe = await getData$3(this).controller.processLocalSubscription(config, id);
+        return unsubscribe;
+    }
+    async onTabReordered(callback) {
+        checkThrowCallback(callback);
+        const id = getData$3(this).id;
+        const wrappedCallback = async () => {
+            await this.refreshReference();
+            callback();
+        };
+        const config = {
+            action: "tab-reordered",
+            eventType: "workspace",
+            scope: "workspace",
+            scopeId: id,
+            callback: wrappedCallback
+        };
+        const unsubscribe = await getData$3(this).controller.processLocalSubscription(config, id);
+        return unsubscribe;
+    }
     async onWindowAdded(callback) {
         checkThrowCallback(callback);
         const id = getData$3(this).id;
@@ -3245,33 +3314,20 @@ class Workspace {
         const unsubscribe = await getData$3(this).controller.processLocalSubscription(config, id);
         return unsubscribe;
     }
-    async onLockConfigurationChanged(callback) {
+    async onWindowTabReordered(callback) {
         checkThrowCallback(callback);
         const id = getData$3(this).id;
-        const wrappedCallback = async () => {
+        const wrappedCallback = async (payload) => {
             await this.refreshReference();
-            callback({
-                allowDrop: this.allowDrop,
-                allowDropLeft: this.allowDropLeft,
-                allowDropTop: this.allowDropTop,
-                allowDropRight: this.allowDropRight,
-                allowDropBottom: this.allowDropBottom,
-                allowSystemHibernation: this.allowSystemHibernation,
-                allowExtract: this.allowExtract,
-                allowSplitters: this.allowSplitters,
-                allowWindowReorder: this.allowWindowReorder,
-                allowWorkspaceTabExtract: this.allowWorkspaceTabExtract,
-                allowWorkspaceTabReorder: this.allowWorkspaceTabReorder,
-                showAddWindowButtons: this.showAddWindowButtons,
-                showCloseButton: this.showCloseButton,
-                showEjectButtons: this.showEjectButtons,
-                showSaveButton: this.showSaveButton,
-                showWindowCloseButtons: this.showWindowCloseButtons
+            const windowParent = this.getBox((parent) => parent.id === payload.windowSummary.parentId);
+            const foundWindow = windowParent.children.find((child) => {
+                return child.type === "window" && child.elementId === payload.windowSummary.itemId;
             });
+            callback(foundWindow);
         };
         const config = {
-            action: "lock-configuration-changed",
-            eventType: "workspace",
+            action: "tab-reordered",
+            eventType: "window",
             scope: "workspace",
             scopeId: id,
             callback: wrappedCallback
@@ -3505,6 +3561,22 @@ class Window {
         const unsubscribe = await getData$2(this).controller.processLocalSubscription(config, id);
         return unsubscribe;
     }
+    async onTabReordered(callback) {
+        checkThrowCallback(callback);
+        const id = getData$2(this).id;
+        const wrappedCallback = async () => {
+            await this.workspace.refreshReference();
+            callback();
+        };
+        const config = {
+            callback: wrappedCallback,
+            action: "tab-reordered",
+            eventType: "window",
+            scope: "window"
+        };
+        const unsubscribe = await getData$2(this).controller.processLocalSubscription(config, id);
+        return unsubscribe;
+    }
 }
 
 const data$1 = new WeakMap();
@@ -3660,6 +3732,13 @@ class Frame {
         frameDialogOptionsDecoder.runWithException(options);
         return getData$1(this).controller.showFrameDialog(this.id, options);
     }
+    async setOnTop(options) {
+        if (!isDesktop()) {
+            throw new Error("The setOnTop operation is not supported in IO Connect Browser");
+        }
+        frameSetOnTopOptionsDecoder.runWithException(options);
+        return getData$1(this).controller.setFrameOnTop(this.id, options);
+    }
     async onClosing(callback) {
         if (!isDesktop()) {
             throw new Error("Frame closing operations are not supported in io.Connect Browser");
@@ -4600,6 +4679,9 @@ class BaseController {
         const result = await this.bridge.send(OPERATIONS.showFrameDialog.name, { frameId, options }, { timeout: ONE_DAY_MS });
         return result;
     }
+    async setFrameOnTop(frameId, options) {
+        return this.bridge.send(OPERATIONS.setFrameOnTop.name, { frameId, onTop: options.onTop });
+    }
     async isOperationSupported(operation) {
         if (isDesktop()) {
             return { isSupported: true };
@@ -4975,6 +5057,9 @@ class MainController {
     async showFrameDialog(frameId, options) {
         return this.base.showFrameDialog(frameId, options);
     }
+    async setFrameOnTop(frameId, options) {
+        return this.base.setFrameOnTop(frameId, options);
+    }
     async handleCoreLocalSubscription(config, levelId) {
         await this.bridge.createCoreEventSubscription();
         config.scopeId = config.scopeId || levelId;
@@ -5279,7 +5364,7 @@ class IoC {
     }
 }
 
-var version = "4.3.0";
+var version = "4.5.0-next.1";
 
 const composeAPI = (glue, ioc) => {
     const controller = ioc.controller;
@@ -5448,6 +5533,15 @@ const composeAPI = (glue, ioc) => {
         const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "workspace", "resumed");
         return unsubscribe;
     };
+    const onWorkspaceTabReordered = async (callback) => {
+        checkThrowCallback(callback);
+        const wrappedCallback = async (payload) => {
+            const workspace = await controller.transformStreamPayloadToWorkspace(payload);
+            callback(workspace);
+        };
+        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "workspace", "tab-reordered");
+        return unsubscribe;
+    };
     const onWindowAdded = async (callback) => {
         checkThrowCallback(callback);
         const wrappedCallback = async (payload) => {
@@ -5541,6 +5635,23 @@ const composeAPI = (glue, ioc) => {
         const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "selected");
         return unsubscribe;
     };
+    const onWindowTabReordered = async (callback) => {
+        checkThrowCallback(callback);
+        const wrappedCallback = async (payload) => {
+            const snapshot = (await controller.getSnapshot(payload.windowSummary.config.workspaceId, "workspace"));
+            const frameConfig = {
+                summary: snapshot.frameSummary
+            };
+            const frame = ioc.getModel("frame", frameConfig);
+            const workspaceConfig = { frame, snapshot };
+            const workspace = ioc.getModel("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);
+        };
+        const unsubscribe = await controller.processGlobalSubscription(wrappedCallback, "window", "tab-reordered");
+        return unsubscribe;
+    };
     const waitForFrame = async (id) => {
         nonEmptyStringDecoder.runWithException(id);
         return new Promise((res, rej) => {
@@ -5587,6 +5698,8 @@ const composeAPI = (glue, ioc) => {
         onWorkspaceClosed,
         onWorkspaceHibernated,
         onWorkspaceResumed,
+        onWorkspaceTabReordered,
+        onWindowTabReordered,
         onWindowAdded,
         onWindowLoaded,
         onWindowRemoved,