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

package/changelog.md

@@ -1,3 +1,10 @@
+## 5.1.0-next.0
+
+### Minor Changes
+
+- 93a3b92: feat: G4E-10864 add a `positionIndex` setting to the window, group, row and column definition configs, so `addWindow()`, `addGroup()`, `addRow()` and `addColumn()` can insert the new element at a specific position among its siblings instead of always appending it
+- 7a3ed82: feat: G4E-10376 add preventable close of Workspace frames and windows in io.Connect Browser via `frame.onClosing()` and the `allowPrevent` / `showDialog` close options, including when closing from the Workspaces UI
+
 ## 5.0.0
 
 ### Major Changes

package/dist/workspaces.es.js

@@ -905,6 +905,7 @@ var lazy = Decoder.lazy;
 
 const nonEmptyStringDecoder = string().where((s) => s.length > 0, "Expected a non-empty string");
 const nonNegativeNumberDecoder = number().where((num) => num >= 0, "Expected a non-negative number");
+const nonNegativeIntegerDecoder = number().where((num) => Number.isInteger(num) && num >= 0, "Expected a non-negative integer");
 const positiveNumberDecoder = number().where((num) => num > 0, "Expected a positive number");
 const windowDragModeDecoder = oneOf(constant("keepInside"), constant("autoEject"));
 const isWindowInSwimlaneResultDecoder = object({
@@ -962,7 +963,8 @@ const windowDefinitionConfigDecoder = object({
     maxHeight: optional(number()),
     allowExtract: optional(boolean()),
     allowReorder: optional(boolean()),
-    showCloseButton: optional(boolean())
+    showCloseButton: optional(boolean()),
+    positionIndex: optional(nonNegativeIntegerDecoder)
 });
 const groupDefinitionConfigDecoder = object({
     minWidth: optional(number()),
@@ -979,7 +981,8 @@ const groupDefinitionConfigDecoder = object({
     allowDropBottom: optional(boolean()),
     showMaximizeButton: optional(boolean()),
     showEjectButton: optional(boolean()),
-    showAddWindowButton: optional(boolean())
+    showAddWindowButton: optional(boolean()),
+    positionIndex: optional(nonNegativeIntegerDecoder)
 });
 const rowDefinitionConfigDecoder = object({
     minHeight: optional(number()),
@@ -987,7 +990,8 @@ const rowDefinitionConfigDecoder = object({
     allowDrop: optional(boolean()),
     allowSplitters: optional(boolean()),
     isPinned: optional(boolean()),
-    maximizationBoundary: optional(boolean())
+    maximizationBoundary: optional(boolean()),
+    positionIndex: optional(nonNegativeIntegerDecoder)
 });
 const columnDefinitionConfigDecoder = object({
     minWidth: optional(number()),
@@ -995,7 +999,8 @@ const columnDefinitionConfigDecoder = object({
     allowDrop: optional(boolean()),
     allowSplitters: optional(boolean()),
     isPinned: optional(boolean()),
-    maximizationBoundary: optional(boolean())
+    maximizationBoundary: optional(boolean()),
+    positionIndex: optional(nonNegativeIntegerDecoder)
 });
 const swimlaneWindowDefinitionDecoder = object({
     type: optional(constant("window")),
@@ -2065,17 +2070,18 @@ class InteropTransport {
             await Promise.all(Object.values(OUTGOING_METHODS).map((method) => {
                 return this.verifyMethodLive(method.name);
             }));
-            await Promise.all(Object.keys(INCOMING_METHODS).map((method) => {
-                return this.registerMethod(method);
-            }));
-            return;
         }
-        const systemId = browserGlobal().communicationId;
-        await Promise.all([
-            this.verifyMethodLive(webPlatformMethodName, systemId),
-            this.verifyMethodLive(webPlatformWspStreamName, systemId)
-        ]);
-        await this.transmitControl("frameHello", { windowId: actualWindowId });
+        else {
+            const systemId = browserGlobal().communicationId;
+            await Promise.all([
+                this.verifyMethodLive(webPlatformMethodName, systemId),
+                this.verifyMethodLive(webPlatformWspStreamName, systemId)
+            ]);
+            await this.transmitControl("frameHello", { windowId: actualWindowId });
+        }
+        await Promise.all(Object.keys(INCOMING_METHODS).map((method) => {
+            return this.registerMethod(method);
+        }));
     }
     coreSubscriptionReady(eventCallback) {
         if (!this.coreEventMethodInitiated) {
@@ -3790,14 +3796,19 @@ class Frame {
         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");
-        }
         checkThrowCallback(callback);
         const wrappedCallback = async () => {
             let shouldPrevent = false;
             const preventClose = () => shouldPrevent = true;
-            await callback({ prevent: preventClose });
+            try {
+                await callback({ prevent: preventClose });
+            }
+            catch (error) {
+                if (isDesktop()) {
+                    throw error;
+                }
+                console.warn(`onClosing callback for frame "${this.id}" threw: ${error}`);
+            }
             return { prevent: shouldPrevent };
         };
         const unsubscribe = await getData$1(this).controller.registerFrameOnClosing(this.id, wrappedCallback);
@@ -5261,6 +5272,13 @@ class ClosingController {
         this.subscribeToFrameClosing();
     }
     async registerFrameOnClosing(frameId, callback) {
+        if (!isDesktop()) {
+            const { isSupported } = await this.bridge.send(OPERATIONS.operationCheck.name, { operation: OPERATIONS.subscribeToFrameClosing.name }).catch(() => ({ isSupported: false }));
+            if (!isSupported) {
+                console.warn(`onClosing for frame "${frameId}" is not supported by the current version of @interopio/browser-platform (requires 5.0.0+).`);
+                return () => { };
+            }
+        }
         await this.bridge.send(OPERATIONS.subscribeToFrameClosing.name, { itemId: frameId });
         return this.registry.add(frameId, callback);
     }
@@ -5459,7 +5477,7 @@ class IoC {
     }
 }
 
-var version = "5.0.0";
+var version = "5.1.0-next.0";
 
 const composeAPI = (glue, ioc) => {
     const controller = ioc.controller;