@interopio/desktop 6.7.0 → 6.8.0

package/changelog.md

@@ -1,3 +1,5 @@
+6.8.0
+- feat: introduces onChannelRestrictionsChanged, isPinned, pin, unpin, executeCode, clearMany, setStates, snoozeMany
 6.7.0
 - feat: Extend channels methods with fdc3 options
 6.6.0
@@ -44,7 +46,7 @@
 - feat: intens - pass caller as a second arg to io.intents.register handler
 - feat: windows - introduce dock method and onDockingChanged
 - feat: windows - introduce autoArrange method
-- feat: notifications - add support for updating notification data field and listening for updates
+- feat: notifications - add support for updating notification data field and listening for updates 
 - fix: windows - fix isHibernated to return the correct value
 - fix: windows - memory leak
 - chore: notifications - add prefix to the logger

package/desktop.d.ts

@@ -5215,6 +5215,13 @@ export declare namespace IOConnectDesktop {
              */
             allowWorkspaceDrop: boolean;
 
+            /**
+             * Flag indicating whether the tab of the current window is pinned. Pinned tabs are placed before the regular tab windows and they contain only the window title.
+             * Pinned tab windows don't have a "Close" button, effectively preventing the user from closing them. Available only for tab windows in web groups.
+             * @since io.Connect Desktop 9.5
+             */
+            isPinned: boolean;
+
             /**
              * Attaches a tab window to the current tab window.
              * @param tab The instance or the name of the tab window to attach.
@@ -5935,11 +5942,38 @@ export declare namespace IOConnectDesktop {
              */
             onDockingChanged(callback: (window: IOConnectDesktop.Windows.IOConnectWindow, dockingPlacement: DockingPlacement) => void): UnsubscribeFunction
 
+            /**
+             * Notifies when the restrictions for any existing Channel have changed. Returns an unsubscribe function.
+             * @param callback Callback function for handling the event.
+             * @since io.Connect Desktop 9.5
+             */
+            onChannelRestrictionsChanged(callback: (restrictions: IOConnectDesktop.Channels.Restrictions) => void): () => void;
+
             /**
              * Duplicates the current io.Connect Window.
              * @param options Optional start options that will override the default start options when cloning the window.
              */
             clone(options?: IOConnectDesktop.AppManager.ApplicationStartOptions): Promise<IOConnectWindow>
+
+            /**
+             * Pins the tab of the current window. Pinned tabs are placed before the regular tab windows and contain only the window title.
+             * Pinned tab windows don't have a "Close"  button preventing the user from closing them. Available only for tab windows in web groups.
+             * @since io.Connect Desktop 9.5
+             */
+            pin(): Promise<void>;
+
+            /**
+             * Unpins the tab of the current window. The previously pinned tab reverts to a normal tab window containing a "Close" button. Available only for tab windows in web groups.
+             * @since io.Connect Desktop 9.5
+             */
+            unpin(): Promise<void>;
+
+            /**
+             * Executes code in the context of the io.Connect Window.
+             * @param code Code to be executed in the context of the window. The code must be supplied as a string.
+             * @since io.Connect Desktop 9.5
+             */
+            executeCode(code: string): Promise<any>
         }
 
         /**
@@ -6921,6 +6955,13 @@ export declare namespace IOConnectDesktop {
              */
             clear(id: string): Promise<void>;
 
+            /**
+             * Clears multiple notifications using a list of IDs.
+             * @param notifications List of IDs of the notifications to clear.
+             * @since io.Connect Desktop 9.5
+             */
+            clearMany(notifications: string[]): Promise<void>;
+
             /**
              * Clicks programmatically a notification or a notification action.
              * @param id ID of the notification to click.
@@ -6936,6 +6977,14 @@ export declare namespace IOConnectDesktop {
              */
             setState(id: string, state: State): Promise<void>;
 
+            /**
+             * Sets multiple notifications to the same notification state.
+             * @param notifications List of IDs of the notifications whose state to set.
+             * @param state Value for the new notification state.
+             * @since io.Connect Desktop 9.5
+             */
+            setStates(notifications: string[], state: IOConnectDesktop.Notifications.State): Promise<void>;
+
             /**
              * Sets or updates the arbitrary data associated with the notification which is available in the `data` property of the notification.
              * @param id ID of the notification whose data to update.
@@ -6950,6 +6999,14 @@ export declare namespace IOConnectDesktop {
              */
             snooze(id: string, duration: number): Promise<void>;
 
+            /**
+             * Snoozes multiple notifications for the same duration.
+             * @param notifications List of IDs of the notifications to snooze.
+             * @param duration Interval in milliseconds for which to snooze the notifications.
+             * @since io.Connect Desktop 9.5
+             */
+            snoozeMany(notifications: string[], duration: number): Promise<void>;
+
             /**
              * Notifies when a new notification is raised.
              * @param callback Callback function for handling the event.
@@ -7813,4 +7870,4 @@ export declare namespace IOConnectDesktop {
             value: string;
         }
     }
-}
+}

package/dist/desktop.browser.js

@@ -2933,7 +2933,7 @@
       }
   };
 
-  var version$1 = "6.4.0";
+  var version$1 = "6.4.1";
 
   function prepareConfig$1 (configuration, ext, glue42gd) {
       let nodeStartingContext;
@@ -13161,6 +13161,7 @@
       let _frameId = options.frameId;
       let _isLocked = options.isLocked;
       let _allowWorkspaceDrop = options.allowWorkspaceDrop;
+      let _isPinned = options.isPinned;
       let _group;
       let _frameButtons = (_d = options.frameButtons) !== null && _d !== void 0 ? _d : [];
       let _zoomFactor = options.zoomFactor;
@@ -13280,6 +13281,12 @@
           }
           return executor.setAllowWorkspaceDrop(resultWindow, allowWorkspaceDrop);
       }
+      function pin() {
+          return executor.pin(resultWindow);
+      }
+      function unpin() {
+          return executor.unpin(resultWindow);
+      }
       function moveResize(bounds, success, error) {
           return Utils.callbackifyPromise(() => {
               if (isUndefinedOrNull(bounds)) {
@@ -13647,6 +13654,16 @@
       async function clone(cloneOptions) {
           return executor.clone(resultWindow, cloneOptions);
       }
+      async function executeCode(code) {
+          if (!code) {
+              throw new Error("Code argument is missing");
+          }
+          if (typeof code !== "string") {
+              throw new Error("Code argument must be a valid string");
+          }
+          const response = await executor.executeCode(resultWindow, code);
+          return response.result;
+      }
       function onTitleChanged(callback) {
           if (!isFunction(callback)) {
               throw new Error("callback should be a function");
@@ -13759,6 +13776,12 @@
       function onTabSelectionChanged(callback) {
           return onEventCore("tab-selection-changed", callback);
       }
+      function onChannelRestrictionsChanged(callback) {
+          if (!isFunction(callback)) {
+              throw new Error("callback must be a function");
+          }
+          return onEventCore("channel-restrictions-changed", callback);
+      }
       function onClosing(callback) {
           if (!isFunction(callback)) {
               throw new Error("callback must be a function");
@@ -13863,6 +13886,7 @@
           _frameId = updated.frameId;
           _isLocked = updated.isLocked;
           _allowWorkspaceDrop = updated.allowWorkspaceDrop;
+          _isPinned = updated.isPinned;
           _zoomFactor = updated.zoomFactor;
           _placementSettings = updated.placementSettings;
       }
@@ -13986,6 +14010,10 @@
           _allowWorkspaceDrop = allowWorkspaceDrop;
           _registry.execute("allow-workspace-drop-changed", resultWindow);
       }
+      function handleIsPinnedChanged(isPinned) {
+          _isPinned = isPinned;
+          _registry.execute("is-pinned-changed", resultWindow);
+      }
       function handleGroupHeaderVisibilityChanged(isGroupHeaderVisible) {
           _isGroupHeaderVisible = isGroupHeaderVisible;
       }
@@ -14078,6 +14106,9 @@
               claimScreenArea: data.claimScreenArea
           });
       }
+      function handleChannelRestrictionsChanged(data) {
+          _registry.execute("channel-restrictions-changed", data);
+      }
       function handleGroupChanged(newGroup, oldGroup) {
           _group = newGroup;
           _groupId = newGroup === null || newGroup === void 0 ? void 0 : newGroup.id;
@@ -14326,6 +14357,9 @@
           get allowWorkspaceDrop() {
               return _allowWorkspaceDrop;
           },
+          get isPinned() {
+              return _isPinned;
+          },
           maximize,
           restore,
           minimize,
@@ -14377,6 +14411,8 @@
           flashTab,
           setSticky,
           setAllowWorkspaceDrop,
+          pin,
+          unpin,
           print,
           printToPDF,
           place,
@@ -14390,6 +14426,7 @@
           getDockingPlacement,
           dock,
           clone,
+          executeCode,
           getChannel: async () => {
               var _a;
               const wins = await getChannels().getWindowsWithChannels({ windowIds: [_id] });
@@ -14429,6 +14466,7 @@
           onNeighboursChanged,
           onDockingChanged,
           onNavigating,
+          onChannelRestrictionsChanged,
           get tabs() {
               return getAllTabs();
           },
@@ -14509,6 +14547,7 @@
           handleFrameSelectionChanged,
           handleCompositionChanged,
           handleAllowWorkspaceDropChanged,
+          handleIsPinnedChanged,
           handleGroupHeaderVisibilityChanged,
           handleTabHeaderVisibilityChanged,
           handleGroupChanged,
@@ -14519,7 +14558,8 @@
           handleZoomFactorChanged,
           handleIsStickyChanged,
           handlePlacementSettingsChanged,
-          handleDockingChanged
+          handleDockingChanged,
+          handleChannelRestrictionsChanged
       };
       const groupArgs = {
           get isGroupHibernated() {
@@ -14730,6 +14770,20 @@
           await this.execute("setAllowWorkspaceDrop", options);
           return w;
       }
+      async pin(windowToPin) {
+          const options = {
+              windowId: windowToPin.id
+          };
+          await this.execute("pinTab", options);
+          return windowToPin;
+      }
+      async unpin(pinnedWindow) {
+          const options = {
+              windowId: pinnedWindow.id
+          };
+          await this.execute("unpinTab", options);
+          return pinnedWindow;
+      }
       async moveResize(w, bounds) {
           if (typeof window !== "undefined" && window.glueDesktop.versionNum < 31200) {
               return new Promise(async (res, rej) => {
@@ -15246,6 +15300,15 @@
           const win = await windowStore.waitFor(result.id);
           return win.API;
       }
+      async executeCode(targetWindow, code) {
+          const args = {
+              windowId: targetWindow.id,
+              options: {
+                  code
+              }
+          };
+          return this.execute("executeCode", args);
+      }
       async goBack(resultWindow) {
           await this.execute("goBack", { windowId: resultWindow.id });
       }
@@ -15781,6 +15844,12 @@
           if (windowInfo.type === "AllowWorkspaceDropChanged") {
               theWindowEvents.handleAllowWorkspaceDropChanged(windowInfo.data);
           }
+          if (windowInfo.type === "IsPinnedChanged") {
+              theWindowEvents.handleIsPinnedChanged(windowInfo.data);
+          }
+          if (windowInfo.type === "WindowChannelRestrictionsChanged") {
+              theWindowEvents.handleChannelRestrictionsChanged(windowInfo.data);
+          }
           this._registry.execute("window-event", extendedStreamEvent);
       }
       createWindow(windowId, options) {
@@ -15837,7 +15906,8 @@
               frameButtons: args.frameButtons,
               jumpListOptions: args.jumpList,
               applicationName: args.applicationName,
-              allowWorkspaceDrop: args.allowWorkspaceDrop
+              allowWorkspaceDrop: args.allowWorkspaceDrop,
+              isPinned: args.isPinned
           };
       }
       mapToGroupCreationArgs(args) {
@@ -18356,7 +18426,7 @@
       };
   }
 
-  var version = "6.6.0";
+  var version = "6.8.0";
 
   var prepareConfig = (options) => {
       function getLibConfig(value, defaultMode, trueMode) {
@@ -18691,12 +18761,26 @@
           }
           await this.interop.invoke(this.NotificationsExecuteMethod, { command: "clear", data: { id } });
       }
+      async clearMany(notifications) {
+          this.validateNotificationsArr(notifications);
+          await this.interop.invoke(this.NotificationsExecuteMethod, { command: "clearMany", data: { notifications } });
+      }
       async click(id, action, options) {
           await this.interop.invoke(this.NotificationsExecuteMethod, { command: "click", data: { id, action, options } });
       }
       async snooze(id, duration) {
           await this.interop.invoke(this.NotificationsExecuteMethod, { command: "snooze", data: { id, duration } });
       }
+      async snoozeMany(notifications, duration) {
+          if (!duration) {
+              throw new Error("The 'duration' argument cannot be null or undefined");
+          }
+          if (typeof duration !== "number") {
+              throw new Error("The 'duration' argument must be a valid number");
+          }
+          this.validateNotificationsArr(notifications);
+          await this.interop.invoke(this.NotificationsExecuteMethod, { command: "snoozeMany", data: { notifications, duration } });
+      }
       async setState(id, state) {
           if (!id) {
               throw new Error("The 'id' argument cannot be null or undefined");
@@ -18710,6 +18794,16 @@
           this.validateState(state);
           await this.interop.invoke(this.NotificationsExecuteMethod, { command: "updateState", data: { id, state } });
       }
+      async setStates(notifications, state) {
+          if (!state) {
+              throw new Error("The 'state' argument cannot be null or undefined");
+          }
+          if (typeof state !== "string") {
+              throw new Error("The 'state' argument must be a valid string");
+          }
+          this.validateNotificationsArr(notifications);
+          await this.interop.invoke(this.NotificationsExecuteMethod, { command: "updateStates", data: { notifications, state } });
+      }
       toAPI() {
           return {
               maxActions: this.maxActions,
@@ -18732,7 +18826,10 @@
               click: this.click.bind(this),
               setState: this.setState.bind(this),
               updateData: this.updateData.bind(this),
-              snooze: this.snooze.bind(this)
+              snooze: this.snooze.bind(this),
+              snoozeMany: this.snoozeMany.bind(this),
+              clearMany: this.clearMany.bind(this),
+              setStates: this.setStates.bind(this)
           };
       }
       onStreamEventCore(key, callback) {
@@ -19114,6 +19211,14 @@
               this.subscriptionForCounter = undefined;
           }
       }
+      validateNotificationsArr(notifications) {
+          if (!Array.isArray(notifications)) {
+              throw new Error("The 'notifications' argument must be an array with valid notification IDs");
+          }
+          if (notifications.some((n) => typeof n !== "string")) {
+              throw new Error("The 'notifications' argument must contain only valid string notification IDs");
+          }
+      }
   }
 
   const ThemesConfigurationMethodName = "T42.Themes.Configuration";