@interopio/desktop 6.1.0 → 6.2.0

package/changelog.md

@@ -1,3 +1,12 @@
+6.2.0
+- feat: notifications - allow user to change the notification panel and toasts position
+- feat: windows: add new method - clone
+- feat: intents - filterIntents method added
+- chore: notifications - fix typings - onDataChanged
+- chore: notifications - fix typings - onclose
+- chore: prefs - fix typings - lastUpdate
+- chore: remove shortid dependency
+- chore: update core to 6.1.0
 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

package/desktop.d.ts

@@ -4527,6 +4527,12 @@ export declare namespace IOConnectDesktop {
              * @param callback Callback function for handling the event.
              */
             onVisibilityChanged(callback: (group: Group) => void): UnsubscribeFunction;
+
+            /**
+             * Notifies when the window group is about to be closed.
+             * @param callback Callback function for handling the event. Returns a `Promise` that will be awaited before the window group is closed. The timeout for waiting is 30 seconds. A function for preventing the closing is passed to the callback as a parameter.
+             */
+            onClosing(callback: (prevent: (options?: PreventClosingOptions) => void) => Promise<void>): void;
         }
 
         /**
@@ -5340,7 +5346,7 @@ export declare namespace IOConnectDesktop {
 
             /**
              * Refreshes the current window.
-             * @param ignoreCache Flag indicating whether to refresh the page with or without cache. Defaults to `false`.
+             * @param ignoreCache Flag indicating whether to use the Chromium cache (if `false`), or the server cache (if `true`) when refreshing the web page. Defaults to `false`.
              */
             refresh(ignoreCache: boolean): Promise<IOConnectWindow>;
 
@@ -5638,6 +5644,12 @@ export declare namespace IOConnectDesktop {
              * @since io.Connect Desktop 9.1.0
              */
             onDockingChanged(callback: (window: IOConnectDesktop.Windows.IOConnectWindow, dockingPlacement: DockingPlacement) => void): UnsubscribeFunction
+
+            /**
+             * 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>
         }
 
         /**
@@ -6017,6 +6029,18 @@ export declare namespace IOConnectDesktop {
              */
             find(intentFilter?: string | IntentFilter): Promise<Intent[]>;
 
+            /**
+             * Filters Intent handlers by specified criteria. If there are more than one valid Intent handlers and the Intents Resolver UI is enabled, it will open and display the available handlers.
+             * @param handlerFilter Filter for the list of Intent handlers to return.
+             */
+            filterHandlers(handlerFilter: HandlerFilter): Promise<FilterHandlersResult>;
+
+            /**
+             * Retrieves all Intents associated with an Intent handler.
+             * @param handler Intent handler whose Intents to retrieve.
+             */
+            getIntents(handler: IntentHandler): Promise<GetIntentsResult>;
+
             /**
              * API for controlling the Intents Resolver UI app.
              */
@@ -6131,6 +6155,55 @@ export declare namespace IOConnectDesktop {
              */
             resultType?: string;
         }
+
+        /**
+         * Provides additional information about an Intent (e.g., when an Intent is retrieved with the `getIntents()` method).
+         */
+        // eslint-disable-next-line @typescript-eslint/no-empty-interface
+        export interface IntentInfo extends AddIntentListenerRequest {}
+
+        /**
+         * Specifies the criteria for filtering the available Intent handlers when using the `filterHandlers()` method.
+         */
+        export interface HandlerFilter {
+            /**
+             * Title for the search operation that will be provided to the Intents Resolver UI.
+             */
+            title?: string;
+
+            /**
+             * Flag indicating whether the Intents Resolver UI will open to provide the user with the list of valid Intent handlers.
+             * @default true
+             */
+            openResolver?: boolean;
+
+            /**
+             * Interval in milliseconds to wait for the `filterHandlers()` method to resolve if more than one Intent handler is available and the Intents Resolver UI is enabled.
+             * @default 90000
+             */
+            timeout?: number;
+
+            /**
+             * Intent name to be used as a filter criterion.
+             */
+            intent?: string;
+
+            /**
+             * List of context types with which the Intent handlers work to be used as filter criteria.
+             */
+            contextTypes?: string[];
+
+            /**
+             * Result type returned by the Intent handlers to be used as a filter criterion.
+             */
+            resultType?: string;
+
+            /**
+             * List of app names which will be used as a filter criteria.
+             */
+            applicationNames?: string[];
+        }
+
         /**
          * Filter for retrieving Intents.
          */
@@ -6308,6 +6381,26 @@ export declare namespace IOConnectDesktop {
              */
             result?: any;
         }
+
+        /**
+         * Describes the result returned by the `filterHandlers()` method.
+         */
+        export interface FilterHandlersResult {
+            /**
+             * List of Intent handlers that satisfy the filter criteria.
+             */
+            handlers: IntentHandler[];
+        }
+
+        /**
+         * Describes the result returned by the `getIntents()` method.
+         */
+        export interface GetIntentsResult {
+            /**
+             * List of objects describing the Intents associated with the specified Intent handler.
+             */
+            intents: IntentInfo[];
+        }
     }
 
     /**
@@ -6436,7 +6529,7 @@ export declare namespace IOConnectDesktop {
              * 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
+            onDataChanged<T>(callback: (notification: { id: string }, data: T) => void): UnsubscribeFunction
         }
 
         /**
@@ -6596,6 +6689,11 @@ export declare namespace IOConnectDesktop {
              */
             onerror: (event: ErrorEvent) => void;
 
+            /**
+             * Notifies when the notification is closed.
+             */
+            onclose: (() => void);
+
             /**
              * Closes the notification.
              */
@@ -6817,6 +6915,28 @@ export declare namespace IOConnectDesktop {
                  */
                 stackBy?: "severity" | "application";
             }
+
+            /**
+             * Describes the placement settings for the Notification Panel and the notification toasts.
+             */
+            placement?: NotificationPlacement;
+        }
+
+
+        /**
+         * Settings for placing the Notification Panel and the notification toasts.
+         */
+        export interface NotificationPlacement {
+            /**
+             * Defines the position of the Notification Panel on the screen.
+             * @default "right"
+             */
+            panel?: "left" | "right";
+            /**
+             * Defines the position of the notification toasts on the screen.
+             * @default "bottom-right"
+             */
+            toasts?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
         }
     }
 
@@ -6976,7 +7096,7 @@ export declare namespace IOConnectDesktop {
             /**
              * Timestamp of the last update of the user preferences.
              */
-            lastUpdate: Date;
+            lastUpdate: string;
         }
     }