@interopio/desktop 6.13.1 → 6.14.0

package/changelog.md

@@ -1,3 +1,11 @@
+6.14.0
+- feat: windows - add dragMove method
+- feat: windows - add clearPlacement method
+- feat: windows - configure method now accepts a new option - showInTaskbar
+- feat: layouts - add onDefaultGlobalChanged event
+- feat: layouts - onRenamed event now receives the old name as a second argument
+- feat: layouts - add new options to the save method - ignoreContexts
+- bugfix: appManager - fix hangs on initialization with appManager: "full" outside platform
 6.13.1
 - fix: windows - group.onClosing throws an unhandledrejection error when the group is closed before the event is subscribed
 6.13.0

package/desktop.d.ts

@@ -1651,6 +1651,8 @@ export declare namespace IOConnectDesktop {
             activityType?: string;
             /** If `true`, multiple instances of the app can be started. */
             allowMultiple?: boolean;
+            /** Whether to register the iodesktop object in the global window context. */
+            registerIoDesktop?: boolean;
         }
 
         /** @ignore */
@@ -2116,11 +2118,20 @@ export declare namespace IOConnectDesktop {
              */
             onChanged(callback: (layout: Layout) => void): UnsubscribeFunction;
 
+            /**
+             * Notifies when a new default Global Layout has been selected or when the current one has been cleared.
+             * @param callback Callback function for handling the event. Receives as an argument an object with a `name` property
+             * holding the name of the newly selected default Global Layout. If the default Global Layout has been cleared, the argument will be `undefined`.
+             */
+            onDefaultGlobalChanged(callback: (layout?: { name: string }) => void): UnsubscribeFunction;
+
             /**
              * Notifies when a Layout is renamed.
              * @param callback Callback function for handling the event.
+             * Receives as a first argument the `Layout` object describing the renamed Layout.
+             * Receives as a second argument an object with a `name` property holding the previous Layout name.
              */
-            onRenamed(callback: (layout: Layout) => void): UnsubscribeFunction;
+            onRenamed(callback: (layout: Layout, previous: { name: string }) => void): UnsubscribeFunction;
 
             /**
              * Notifies when a Layout is restored.
@@ -2403,6 +2414,14 @@ export declare namespace IOConnectDesktop {
              * @ignore
              */
             ignoreMyInstance?: boolean;
+
+            /**
+             * If `true`, the context objects of individual io.Connect Windows and Workspaces participating in the Global Layout won't be saved when the Layout is saved.
+             * You can still use the `context` property to provide context data to be saved for the Global Layout itself.
+             * Valid only for Global Layouts.
+             * *Available since io.Connect Desktop 9.9.*
+             */
+            ignoreContexts?: boolean;
         }
 
         /**
@@ -3865,6 +3884,24 @@ export declare namespace IOConnectDesktop {
              * @default "onDemand"
              */
             buttonsVisibility?: "off" | "onDemand" | "always" | "onFocus";
+
+            /**
+             * If `true`, the window icon will appear in the taskbar.",
+             * @since io.Connect Desktop 9.9
+             */
+            showInTaskbar?: boolean;
+
+            /**
+             * Settings for searching in web apps.
+             * @since io.Connect Desktop 9.9
+             */
+            search?: {
+                /**
+                 * If `true`, will enable searching in web apps with `CTRL + F`.
+                 * @default true
+                 */
+                enabled?: boolean;
+            };
         }
 
         /**
@@ -4090,6 +4127,13 @@ export declare namespace IOConnectDesktop {
              */
             snapped: boolean;
 
+            /**
+             * If `true`, the last known bounds of the io.Connect Window will be saved unless the window has already been snapped.
+             * This allows the window to be restored using these saved bounds when clearing the placement settings for the window via the `clearPlacement()` method.
+             * @since io.Connect Desktop 9.9
+             */
+            saveBounds?: boolean;
+
             /**
              * Vertical alignment for the placed window. If `horizontalAlignment` is set, then `verticalAlignment` will default to "stretch".
              */
@@ -4142,6 +4186,21 @@ export declare namespace IOConnectDesktop {
             display?: IOConnectDesktop.Displays.Display | "current";
         }
 
+        /**
+         * Settings for clearing the window placement.
+         */
+        export interface ClearPlacementSettings {
+            /**
+             * If `true`, the io.Connect Window will be restored to its last known bounds saved in the `place()` method if `saveBounds` has been set to `true`.
+             */
+            restoreBounds?: boolean;
+
+            /**
+             * New bounds for the io.Connect Window. If this is provided, the `restoreBounds` property will be ignored.
+             */
+            newBounds?: Partial<Bounds>;
+        }
+
         /**
          * Modes for flashing the window icon in the taskbar:
          * - `"auto"` - the icon will flash only if the window isn't on focus and will stop flashing when the window is activated;
@@ -4661,7 +4720,24 @@ export declare namespace IOConnectDesktop {
              */
             value?: string;
         }
-
+        /**
+         * Options for dragging a window.
+         */
+        export interface DragMoveOptions {
+            /**
+             * Location of the mouse cursor within the window at the time the dragging operation was initiated.
+             */
+            location?: {
+                /**
+                 * Horizontal coordinate of the mouse cursor within the window in pixels. Relative to the left border of the io.Connect Window.
+                 */
+                x: number;
+                /**
+                 * Vertical coordinate of the mouse cursor within the window in pixels. Relative to the top border of the io.Connect Window.
+                 */
+                y: number;
+            }
+        }
         /**
          * Describes a docked window.
          */
@@ -5491,6 +5567,16 @@ export declare namespace IOConnectDesktop {
              */
             snap(target: string | IOConnectWindow, options?: SnappingOptions | RelativeDirection, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): Promise<IOConnectWindow>;
 
+            /**
+             * This method can be used to start dragging the window with the mouse when the left mouse button is pressed.
+             * @param options Options for dragging the window. Use this argument to optionally provide the location of the mouse cursor within the window
+             * at the time the dragging operation was initiated. The platform will use that location to place the window under the mouse cursor when the mouse is moving
+             * (e.g., in case the mouse has already moved several pixels in any direction before the dragging operation has been initiated by the platform).
+             * If the starting mouse location isn't specified, its current position will be used.
+             * @since io.Connect Desktop 9.9
+             */
+            dragMove(options?: DragMoveOptions): Promise<void>;
+
             /**
              * Shows a loader animation for the window or updates the loader properties (animation type, background or text).
              * @param options Settings for the loader animation.
@@ -5728,6 +5814,14 @@ export declare namespace IOConnectDesktop {
              */
             place(options: PlacementSettings): Promise<void>;
 
+            /**
+             * Clears the window placement settings.
+             * This means that the window will no longer be automatically snapped to a specific position on the display in case of resolution, scaling, and monitor changes.
+             * @param options Settings for clearing the window placement.
+             * @since io.Connect Desktop 9.9
+             */
+            clearPlacement(options?: ClearPlacementSettings): Promise<void>;
+
             /**
              * Makes the window navigate back to the previous web page.
              */
@@ -7646,6 +7740,11 @@ export declare namespace IOConnectDesktop {
              * If `true`, will enable showing a notification badge on the tray menu icon, in the "Notifications" section of the io.Connect launcher, and on the taskbar icon of the io.Connect launcher (or your shell app).
              */
             showNotificationBadge?: boolean;
+
+            /**
+             * If `true`, the Notification Panel will be hidden automatically when it loses focus.
+             */
+            autoHidePanel?: boolean;
         }
 
         /**

package/dist/desktop.browser.js

@@ -11702,6 +11702,9 @@
               height: a.height
           };
       }
+      static isRunningInIoCdContext() {
+          return typeof window !== "undefined" && (window.glue42gd || window.iodesktop);
+      }
       static isNode() {
           if (typeof Utils._isNode !== "undefined") {
               return Utils._isNode;
@@ -12689,24 +12692,23 @@
                       .forEach((item) => entitlements.handleBranchesModified(item));
                   if (!initiated) {
                       initiated = true;
-                      const hasMyAppInSnapShot = onApplicationAddedEventArgs.some((a) => a.Name === agm.instance.application);
-                      const hasMyInstanceInSnapShot = onApplicationStartedEventArgs.some((i) => i.Id === agm.instance.instance);
-                      if (hasMyAppInSnapShot) {
-                          if (hasMyInstanceInSnapShot) {
-                              resolveFunc(configuration);
-                          }
-                          else {
-                              const un = applications.onInstanceStarted((i) => {
-                                  if (i.id === agm.instance.instance) {
-                                      un();
-                                      resolveFunc(configuration);
-                                  }
-                              });
-                          }
-                      }
-                      else {
+                      const myInstance = agm.instance;
+                      const hasMyAppInSnapShot = onApplicationAddedEventArgs.some((a) => a.Name === myInstance.application);
+                      const hasMyInstanceInSnapShot = onApplicationStartedEventArgs.some((i) => i.Id === myInstance.instance);
+                      if (!hasMyAppInSnapShot) {
                           resolveFunc(configuration);
+                          return;
+                      }
+                      if (!hasMyInstanceInSnapShot && (Utils.isNode() || Utils.isRunningInIoCdContext())) {
+                          const un = applications.onInstanceStarted((i) => {
+                              if (i.id === myInstance.instance) {
+                                  un();
+                                  resolveFunc(configuration);
+                              }
+                          });
+                          return;
                       }
+                      resolveFunc(configuration);
                   }
               });
               subscription.onFailed((err) => rejectFunc(err));
@@ -13511,6 +13513,9 @@
               return executor.snap(resultWindow, target, direction);
           }, success, error);
       }
+      function dragMove(dragMoveSettings) {
+          return executor.dragMove(resultWindow, dragMoveSettings);
+      }
       function attachTab(tab, opt, success, error) {
           return Utils.callbackifyPromise(() => {
               var _a;
@@ -13740,6 +13745,9 @@
       function place(placementSettings) {
           return executor.place(resultWindow, placementSettings);
       }
+      function clearPlacement(clearPlacementSettings) {
+          return executor.clearPlacement(resultWindow, clearPlacementSettings);
+      }
       function refresh(ignoreCache) {
           return executor.refresh(resultWindow, ignoreCache);
       }
@@ -14493,6 +14501,7 @@
           center,
           close,
           snap,
+          dragMove,
           showLoader,
           hideLoader,
           updateContext,
@@ -14523,6 +14532,7 @@
           print,
           printToPDF,
           place,
+          clearPlacement,
           ungroup,
           refresh,
           goBack,
@@ -15006,6 +15016,9 @@
           await this.execute("snap", { windowId: w.id, options: args }, "CompositionChanged", `CompositionChanged-${targetWindow.id}`);
           return w;
       }
+      dragMove(window, options) {
+          return this.execute("dragMove", { windowId: window.id, options });
+      }
       async attachTab(w, sourceWindow, options) {
           await this.execute("attachTab", {
               windowId: w.id,
@@ -15266,6 +15279,9 @@
           }
           return this.execute("place", { windowId: window.id, options: { ...copy } });
       }
+      async clearPlacement(window, options) {
+          return this.execute("clearPlacement", { windowId: window.id, options });
+      }
       async refresh(resultWindow, ignoreCache) {
           await this.execute("refresh", { windowId: resultWindow.id, options: { ignoreCache } });
           return resultWindow;
@@ -16928,7 +16944,8 @@
       }
       registerRequestMethods() {
           this.interop.register(SaveContextMethodName, (args) => {
-              const usersCbs = this.callbacks.execute("saveRequested", args);
+              const { ignoreContexts, ...cbArgs } = args;
+              const usersCbs = this.callbacks.execute("saveRequested", cbArgs);
               if ((usersCbs === null || usersCbs === void 0 ? void 0 : usersCbs.length) > 1) {
                   this.logger.warn(`Multiple subscriptions for "glue.layouts.onSaveRequested" - only the first one will be used`);
               }
@@ -16944,7 +16961,7 @@
               if (this.isActivityOwner()) {
                   result.activityContext = requestResult === null || requestResult === void 0 ? void 0 : requestResult.activityContext;
               }
-              return result;
+              return ignoreContexts ? { windowContext: undefined, activityContext: undefined } : result;
           });
       }
   }
@@ -17150,6 +17167,9 @@
                   if (typeof layout.setAsCurrent === "boolean") {
                       layoutObject.options.setAsCurrent = layout.setAsCurrent;
                   }
+                  if (typeof layout.ignoreContexts === "boolean") {
+                      layoutObject.options.ignoreContexts = layout.ignoreContexts;
+                  }
               }
               else {
                   return reject(new Error(`layout type ${layout.type} is not supported`));
@@ -17401,6 +17421,16 @@
       onChanged(callback) {
           return this.callbacks.add("changed", callback);
       }
+      onDefaultGlobalChanged(callback) {
+          if (typeof callback !== "function") {
+              throw new Error("callback must be a function");
+          }
+          this.getDefaultGlobal()
+              .then((layout) => callback(layout ? { name: layout.name } : undefined))
+              .catch(() => {
+          });
+          return this.callbacks.add("default-changed", callback);
+      }
       onRestored(callback) {
           return this.callbacks.add("restored", callback);
       }
@@ -17586,6 +17616,8 @@
                       this.changeLayouts(transform(data.OnLayoutChanged));
                       this.renameLayouts(transform(data.OnLayoutRenamed));
                       this.restoredLayout(transform(data.OnLayoutRestored));
+                      this.selectedDefaultLayout(transform(data.OnLayoutSelectedDefault), false);
+                      this.selectedDefaultLayout(transform(data.OnLayoutDeselectedDefault), true);
                       this.callbacks.execute("streamEvent", data);
                   });
                   subs.onFailed((err) => {
@@ -17620,7 +17652,7 @@
               });
               setTimeout(() => {
                   if (!done) {
-                      reject("timed out");
+                      reject(new Error(`Timeout waiting for token ${token}`));
                   }
               }, timeout);
           });
@@ -17686,7 +17718,7 @@
                   throw Error(`received rename event for unknown layout with type ${renamedLayout.type} and name ${renamedLayout.oldName}`);
               }
               existingLayout.name = renamedLayout.newName;
-              this.callbacks.execute("renamed", existingLayout);
+              this.callbacks.execute("renamed", existingLayout, { name: renamedLayout.oldName });
           });
       }
       compareLayouts(layout1, layout2) {
@@ -17707,6 +17739,17 @@
               this.callbacks.execute("restored", existingLayout);
           });
       }
+      selectedDefaultLayout(selectedDefaultLayouts, deselected) {
+          if (!selectedDefaultLayouts || selectedDefaultLayouts.length === 0) {
+              return;
+          }
+          if (deselected) {
+              this.callbacks.execute("default-changed", undefined);
+          }
+          else {
+              this.callbacks.execute("default-changed", selectedDefaultLayouts[0]);
+          }
+      }
   }
 
   function LayoutsFactory (config) {
@@ -19183,7 +19226,7 @@
       };
   }
 
-  var version = "6.13.1";
+  var version = "6.14.0";
 
   var prepareConfig = (options) => {
       function getLibConfig(value, defaultMode, trueMode) {