@interopio/desktop 6.0.2 → 6.1.0

package/changelog.md

@@ -1,18 +1,24 @@
-6.0.2
-  - fix: windows - memory leak
-  - chore: remove postinstall script
+6.1.0
+- feat: layouts - when saving a layout, setAsCurrent option is added
+- 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
+- fix: windows - fix isHibernated to return the correct value
+- fix: windows - memory leak
+- chore: notifications - add prefix to the logger
 6.0.1
-  - fix: version 6 should work with Glue42 3.X
+- fix: version 6 should work with Glue42 3.X
 6.0.0
- - chore: Rebranding to interop.io
- - fix: layouts - check for old methods for calling the new ones
- - fix: notifications - click interop method doesn't work if the raiser is closed
+- chore: Rebranding to interop.io
+- fix: layouts - check for old methods for calling the new ones
+- fix: notifications - click interop method doesn't work if the raiser is closed
 5.23.1
- - fix: windows - update types for DialogResult
- - fix: windows - autoSave is optional in ExitOpts interface
- - fix: channels - subscribe throws error in particular case
- - fix: notifications - click action is working even if the raiser of the notification is closed
- - fix: notifications - expose toasts option in the configure method
+- fix: windows - update types for DialogResult
+- fix: windows - autoSave is optional in ExitOpts interface
+- fix: channels - subscribe throws error in particular case
+- fix: notifications - click action is working even if the raiser of the notification is closed
+- fix: notifications - expose toasts option in the configure method
 5.23.0
 - fix: intents - fix for intents resolver to work from a hidden window
 - fix: notifications - add validation when raising a notification - severity, panelExpiry and toastExpiry

package/desktop.d.ts

@@ -76,6 +76,7 @@ export declare namespace IOConnectDesktop {
     export import Logger = IOConnectCore.Logger;
     export import Metrics = IOConnectCore.Metrics;
     export import Auth = IOConnectCore.Auth;
+    export import FeedbackInfo = IOConnectCore.FeedbackInfo;
     export import Channels = IOConnectDesktop.Channels.API;
     export import ChannelContext = IOConnectDesktop.Channels.ChannelContext;
     export import Interop = IOConnectCore.Interop;
@@ -1455,7 +1456,7 @@ export declare namespace IOConnectDesktop {
             /**
              * Title of the app instance.
              */
-            title: string;
+            title: string | undefined;
 
             /**
              * Whether the app instance is an activity instance.
@@ -2232,6 +2233,11 @@ export declare namespace IOConnectDesktop {
              */
             type?: LayoutType;
 
+            /**
+             * If `true`, will set the saved Layout as the current Global Layout.
+             */
+            setAsCurrent?: boolean;
+
             /**
              * Context to be saved with the Layout.
              */
@@ -4372,6 +4378,38 @@ export declare namespace IOConnectDesktop {
             value?: string;
         }
 
+        /**
+         * Describes a docked window.
+         */
+        export interface DockingPlacement {
+            /**
+             * If `true`, the window is docked.
+             */
+            docked: boolean;
+            /**
+             * Position of the docked window on the screen - top, bottom, left or right.
+             */
+            position?: string;
+            /**
+             * If `true`, the docked window claims the area it occupies on the screen, in effect, reducing the working area of the screen.
+             */
+            claimScreenArea?: boolean;
+        }
+
+        /**
+         * Options for docking a window.
+         */
+        export interface DockingOptions {
+            /**
+             * Position of the docked window on the screen - top, bottom, left or right.
+             */
+            position: "top" | "bottom" | "left" | "right";
+            /**
+             * If `true`, the docked window will claim the area it occupies on the screen, in effect, reducing the working area of the screen.
+             */
+            claimScreenArea?: boolean;
+        }
+
         /**
          * Describes a window group.
          */
@@ -4558,6 +4596,14 @@ export declare namespace IOConnectDesktop {
              */
             configure(options: WindowsConfiguration): Promise<void>;
 
+            /**
+             * Arranges the io.Connect Windows automatically in a grid on the specified display using the entire working area of the display.
+             * If called a second time, and the user hasn't broken manually the window arrangement, the windows will be restored to their previous state.
+             * @param displayId ID of the display on which to arrange the windows.
+             */
+            autoArrange(displayId?: number): Promise<void>;
+
+
             /**
              * Notifies when the Window Management library has been fully initialized.
              */
@@ -4619,6 +4665,15 @@ export declare namespace IOConnectDesktop {
              */
             onWindowLostFocus(callback: (window: IOConnectWindow) => void): UnsubscribeFunction;
 
+            /**
+             * Notifies when io.Connect Windows are arranged automatically or restored to their previous state using the `autoArrange()` method.
+             * The event will fire also when the user manually breaks the automatic window arrangement.
+             * @param callback Callback function for handling the event. Receives an object with `areWindowsArranged` and `displayId` properties.
+             * The `areWindowsArranged` flag will be set to `true` if the `autoArrange()` method is called initially for arranging the windows.
+             * When the method is called a second time for restoring the windows to their previous state, or the user manually breaks the window arrangement, the flag will be `false`.
+             */
+            onArrangementChanged(callback: (data: { areWindowsArranged: boolean; displayId: number; }) => void): UnsubscribeFunction;
+
             /**
              * Generic event handler.
              * @ignore
@@ -5374,6 +5429,19 @@ export declare namespace IOConnectDesktop {
              */
             showDialog<T>(options: DialogOptions): Promise<T | DialogResult>
 
+            /**
+             * Retrieves the docking placement information for the current window.
+             * @since io.Connect Desktop 9.1.0
+             */
+            getDockingPlacement(): Promise<DockingPlacement>;
+
+            /**
+             * Docks the window at the specified position.
+             * @param options Options for docking the window.
+             * @since io.Connect Desktop 9.1.0
+             */
+            dock(options: DockingOptions): Promise<DockingPlacement>;
+
             /**
              * Notifies when a window is attached to the current window.
              * @param callback Callback function for handling the event.
@@ -5563,6 +5631,13 @@ export declare namespace IOConnectDesktop {
              * @param callback Callback function for handling the event.
              */
             onNavigating(callback: (args: { newUrl: string }) => Promise<void>): void;
+
+            /**
+             * Notifies when the window docking placement is changed.
+             * @param callback Callback function for handling the event.
+             * @since io.Connect Desktop 9.1.0
+             */
+            onDockingChanged(callback: (window: IOConnectDesktop.Windows.IOConnectWindow, dockingPlacement: DockingPlacement) => void): UnsubscribeFunction
         }
 
         /**
@@ -5932,9 +6007,9 @@ export declare namespace IOConnectDesktop {
              * use this method to supply a handler for the specified Intent. Otherwise, you can use it to register your app as an Intent handler
              * dynamically at runtime. Dynamically registered Intent handlers share the life span of the respective app instance.
              * @param intent The name of the Intent to be handled, or an object specifying the Intent name and additional settings for handling the Intent.
-             * @param handler Handler function for the raised Intent.
+             * @param handler The callback that will handle a raised intent. Will be called with an IntentContext if it is provided by the raising application and caller - the Interop Instance which raised the intent
              */
-            register(intent: string | AddIntentListenerRequest, handler: (context: IntentContext) => any): Promise<{ unsubscribe: UnsubscribeFunction }>;
+            register(intent: string | AddIntentListenerRequest, handler: (context: IntentContext, caller?: IOConnectDesktop.Interop.Instance) => any): Promise<{ unsubscribe: UnsubscribeFunction }>;
 
             /**
              * Retrieves Intents by a specified filter. If no filter is supplied, all available Intents will be retrieved.
@@ -6320,6 +6395,13 @@ export declare namespace IOConnectDesktop {
              */
             setState(id: string, state: 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.
+             * @param data New notification data.
+             */
+            updateData(id: string, data: unknown): Promise<void>;
+
             /**
              * Notifies when a new notification is raised.
              * @param callback Callback function for handling the event.
@@ -6342,13 +6424,19 @@ export declare namespace IOConnectDesktop {
              * Notifies when the global notification settings are changed.
              * @param callback Callback function for handling the event.
              */
-            onConfigurationChanged(callback: (config: Configuration, apps: number) => void): UnsubscribeFunction;
+            onConfigurationChanged(callback: (config: Configuration) => void): UnsubscribeFunction;
 
             /**
              * Notifies when the notification counter is changed.
              * @param callback Callback function for handling the event.
              */
             onCounterChanged(callback: (info: { count: number }) => void): UnsubscribeFunction;
+
+            /**
+             * Notifies when the arbitrary data associated with the notification (available in the `data` property of the notification) is changed.
+             * @param callback Callback function for handling the event.
+             */
+            onDataChanged<T>(callback: (data: T) => void): UnsubscribeFunction
         }
 
         /**
@@ -6454,7 +6542,7 @@ export declare namespace IOConnectDesktop {
          */
         export interface NotificationData extends IOConnectNotificationOptions {
             /**
-             * ID of the notification.
+             * ID for the notification.
              */
             id: string;
 
@@ -6592,6 +6680,11 @@ export declare namespace IOConnectDesktop {
          * Options for raising an io.Connect notification.
          */
         export interface IOConnectNotificationOptions extends NotificationDefinition {
+            /**
+             * Id for the notification.
+             */
+            id?: string;
+
             /**
              * Title for the notification.
              */
@@ -6617,6 +6710,12 @@ export declare namespace IOConnectDesktop {
              */
             severity?: "Low" | "Medium" | "High" | "Critical" | "None";
 
+            /**
+             * Notification state.
+             * @default "Active"
+             */
+            state?: State;
+
             /**
              * Can be used for overwriting the name of the actual notification source.
              */