@interopio/desktop 6.2.1 → 6.3.1

package/changelog.md

@@ -1,3 +1,14 @@
+6.3.1
+- chore: update core to 6.2.1 (was 6.1.0)
+6.3.0
+- feat: notifications - add support for snooze
+- feat: windows - add showPopup method to the group object
+- feat: windows - two new methods - create and close group
+- feat: appManager - introduce new method - instance.startedBy
+- feat: channels - introduce new methods - restrict, restrictAll, getRestrictions
+- chore: prefs - fix typings - getAll
+6.2.2
+- feat: notifications - click method now accepts a third optional argument - options
 6.2.1
 - fix: appManger - myApplication returns undefined in webGroups and workspaces
 6.2.0

package/desktop.d.ts

@@ -1513,6 +1513,12 @@ export declare namespace IOConnectDesktop {
              */
             getWindow(): Promise<Windows.IOConnectWindow>;
 
+            /**
+             * Retrieves information about how the current app instance was started, and about the identity of the initiator.
+             * @since io.Connect Desktop 9.3
+             */
+            startedBy(): Promise<StartedByInfo>;
+
             /**
              * Notifies when the Interop library is ready to be used.
              * @param callback Callback function for handling the event.
@@ -1533,6 +1539,26 @@ export declare namespace IOConnectDesktop {
             onStopped(callback: (instance: Instance) => any): UnsubscribeFunction;
         }
 
+        /**
+         * Describes how the current app instance was started and provides details about the app that started it.
+         */
+        export interface StartedByInfo {
+            /**
+             * Indicates how the current app instance was started. Apps can be started by other apps, by a raised Intent, or can be auto started by the system.
+             */
+            startedBy: "application" | "intent" | "autoStart";
+
+            /**
+             * Name of the app that started the current app instance.
+             */
+            applicationName: string;
+
+            /**
+             * ID of the app instance that started the current app instance.
+             */
+            instanceID: string;
+        }
+
         /**
          * @ignore
          */
@@ -1588,6 +1614,16 @@ export declare namespace IOConnectDesktop {
              * @default false
              */
             ignoreSavedLayout?: boolean;
+
+            /**
+             * Key/value pairs that will be merged with the `process.env` object when spawning a new process for an executable app from the Node.js environment.
+             */
+            env?: Record<string, (string)>;
+
+            /**
+             * Optional parameters that will be passed to the executable app that is to be started. The value will be used as is and no validation will be performed on it.
+             */
+            parameters?: string;
         }
 
         /**
@@ -2955,6 +2991,11 @@ export declare namespace IOConnectDesktop {
              * Base URL for files loaded by a data URL. Must end with a trailing path separator. This property is necessary only when the loaded URL is a data URL.
              */
             baseURLForDataURL?: string;
+
+            /**
+             * Query string that will be appended to the URL when starting the app. If the string doesn't start with a `?`, one will be prepended to it. Note that the query string must be URL encoded.
+             */
+            queryString?: string;
         }
 
         /**
@@ -4133,6 +4174,66 @@ export declare namespace IOConnectDesktop {
             showDialog?: boolean
         }
 
+        /**
+         * Options for creating window groups.
+         */
+        export interface CreateGroupsOptions {
+            /**
+             * List of window groups to be created.
+             */
+            groups: GroupDefinition[];
+            /**
+             * Context for the created window groups.
+             */
+            context?: unknown;
+        }
+
+        /**
+         * Describes a window group that will be created.
+         */
+        export interface GroupDefinition {
+            /**
+             * Title for the created window group.
+             */
+            title?: string;
+            /**
+             * State for the created window group.
+             */
+            state?: string;
+            /**
+             * List of window frames that will be part of the created window group.
+             */
+            frames: FrameDefinition[];
+        }
+
+        /**
+         * Describes a window frame that will be part of a created window group.
+         */
+        export interface FrameDefinition {
+            /**
+             * Bounds for the window frame.
+             */
+            bounds: Bounds;
+            /**
+             * Mode for the window frame.
+             */
+            mode?: WindowMode;
+            /**
+             * List of objects containing the names of the apps to be started and loaded in the window frames of the created window group, as well as additional app settings.
+             */
+            applications: CreateGroupApplicationOptions[];
+        }
+
+        /**
+         * Options for the app that will be started and loaded in a window frame of a created window group.
+         */
+        export interface CreateGroupApplicationOptions extends IOConnectDesktop.Windows.WindowSettings {
+            /**
+             * App name as specified in its definition.
+             */
+            name: string;
+        }
+
         /**
          * API for managing window groups.
          */
@@ -4142,6 +4243,21 @@ export declare namespace IOConnectDesktop {
              */
             my: Group;
 
+            /**
+             * Creates window groups.
+             * @param options Options for creating window groups.
+             * @since io.Connect Desktop 9.3
+             */
+            create(options: CreateGroupsOptions): Promise<Group[]>;
+
+            /**
+             * Closes a window group.
+             * @param group The `Group` object or the ID of the window group to be closed.
+             * @param options Options for closing the group that can be used to prevent closing the group and control whether to show a confirmation dialog before closing it.
+             * @since io.Connect Desktop 9.3
+             */
+            close(group: Group | string, options: CloseOptions): Promise<void>;
+
             /**
              * Lists all window groups.
              * @param success Callback function for handling the successfully returned result.
@@ -4162,6 +4278,12 @@ export declare namespace IOConnectDesktop {
              */
             waitForGroup(groupId: string): Promise<IOConnectDesktop.Windows.Group>;
 
+            /**
+             * Retrieves the current window group.
+             * @since io.Connect Desktop 9.3
+             */
+            getMyGroup(): Promise<IOConnectDesktop.Windows.Group>;
+
             /**
              * Hibernates a window group.
              * @param groupId ID of the window group to hibernate.
@@ -4492,7 +4614,6 @@ export declare namespace IOConnectDesktop {
              */
             capture(options?: CaptureOptions): Promise<string>;
 
-
             /**
              * Shows a previously hidden window group.
              * @param activate Flag indicating whether to activate the group and focus the last focused app window.
@@ -4504,6 +4625,20 @@ export declare namespace IOConnectDesktop {
              */
             hide(): Promise<void>;
 
+            /**
+             * Close a window group.
+             * @since 9.3.0
+             * @param options Options for closing the group that can be used to prevent closing the window and control whether to show a confirmation dialog before closing it.
+             */
+            close(options: CloseOptions): Promise<void>;
+
+            /**
+             * Creates a popup window.
+             * @param config Options for creating a popup window.
+             * @since io.Connect Desktop 9.3
+             */
+            showPopup(config: PopupOptions): Promise<void>;
+
             /**
              * Notifies when the visibility of the window group header is changed.
              * @param callback Callback function for handling the event.
@@ -5841,6 +5976,27 @@ export declare namespace IOConnectDesktop {
              */
             getWindowsWithChannels(filter?: WindowWithChannelFilter): Promise<WindowOnChannelInfo[]>;
 
+            /**
+             * Prevents or allows the current or another window to publish or subscribe to a specific Channel.
+             * @param restrictions Restrictions for publishing or subscribing to a specific Channel.
+             * @since io.Connect Desktop 9.3
+             */
+            restrict(restrictions: ChannelRestrictions): Promise<void>;
+
+            /**
+             * Prevents or allows the current or another window to publish or subscribe to all Channels.
+             * @param restrictions Restrictions for publishing or subscribing to all Channels.
+             * @since io.Connect Desktop 9.3
+             */
+            restrictAll(restrictions: RestrictionsConfig): Promise<void>;
+
+            /**
+             * Retrieves the restrictions applied to the current window for publishing or subscribing to Channels. Pass a window ID to retrieve the restrictions for the specified window.
+             * @param windowId ID of the window for which to retrieve the applied restrictions for publishing or subscribing to Channels.
+             * @since io.Connect Desktop 9.3
+             */
+            getRestrictions(windowId?: string): Promise<Restrictions>;
+
             /**
              * Notifies when a Channel is changed.
              * @param callback Callback function for handling the event.
@@ -5914,6 +6070,44 @@ export declare namespace IOConnectDesktop {
              */
             data: any;
         }
+
+        /**
+         * All restrictions applied to a window for publishing or subscribing to Channels.
+         */
+        export interface Restrictions {
+            /**
+             * List of restrictions for publishing or subscribing to Channels.
+             */
+            channels: ChannelRestrictions[];
+        }
+
+        /**
+         * Restrictions applied to a window for publishing or subscribing to a specific Channel.
+         */
+        export interface ChannelRestrictions extends RestrictionsConfig {
+            /**
+             * Name of the Channel for which the restrictions apply.
+             */
+            name: string;
+        }
+
+        /**
+         * Restrictions applied to a window for publishing or subscribing to all Channels.
+         */
+        export interface RestrictionsConfig {
+            /**
+             * If `true`, the window will be able to subscribe to the specified Channel.
+             */
+            read: boolean;
+            /**
+             * If `true`, the window will be able to publish to the specified Channel.
+             */
+            write: boolean;
+            /**
+             * ID of the window for which apply the restrictions for publishing or subscribing to Channels.
+             */
+            windowId?: string;
+        }
     }
 
     /**
@@ -6160,7 +6354,7 @@ export declare namespace IOConnectDesktop {
          * 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 {}
+        export interface IntentInfo extends AddIntentListenerRequest { }
 
         /**
          * Specifies the criteria for filtering the available Intent handlers when using the `filterHandlers()` method.
@@ -6478,8 +6672,9 @@ export declare namespace IOConnectDesktop {
              * Clicks programmatically a notification or a notification action.
              * @param id ID of the notification to click.
              * @param action ID of the action to click.
+             * @param options Options for the clicked notification.
              */
-            click(id: string, action?: string): Promise<void>;
+            click(id: string, action?: string, options?: ClickOptions): Promise<void>;
 
             /**
              * Sets the state of a notification.
@@ -6495,6 +6690,13 @@ export declare namespace IOConnectDesktop {
              */
             updateData(id: string, data: unknown): Promise<void>;
 
+            /**
+             * Snoozes a notification.
+             * @param id ID of the notification to snooze.
+             * @param duration Interval in milliseconds for which to snooze the notification.
+             */
+            snooze(id: string, duration: number): Promise<void>;
+
             /**
              * Notifies when a new notification is raised.
              * @param callback Callback function for handling the event.
@@ -6629,6 +6831,15 @@ export declare namespace IOConnectDesktop {
          */
         export type State = "Active" | "Acknowledged" | "Closed" | "Stale";
 
+        /**
+         * Options for the clicked notification.
+         */
+        export interface ClickOptions {
+            /**
+             * Flag indicating whether the clicked notification will be closed.
+             */
+            close?: boolean;
+        }
 
         /**
          * Describes a notification.
@@ -7058,7 +7269,7 @@ export declare namespace IOConnectDesktop {
             /**
              * Retrieves all preferences stored for the current user.
              */
-            getAll(): Promise<AppPreferences[]>;
+            getAll(): Promise<{ all: AppPreferences[]; }>;
 
             /**
              * Removes all preferences stored for the current user.
@@ -7096,7 +7307,7 @@ export declare namespace IOConnectDesktop {
             /**
              * Timestamp of the last update of the user preferences.
              */
-            lastUpdate: string;
+            lastUpdate?: string;
         }
     }