@interopio/desktop 6.9.2 → 6.10.1

package/changelog.md

@@ -1,7 +1,8 @@
-6.9.2
-- feat: io.CB 3.5
-6.9.1
-- chore: bump
+6.10.1
+- chore: latest core package with a fix for re-announcing contexts
+6.10.0
+- feat: channels - add support for multi channels
+- fix: windows - navigate method accepts timeout as a parameter
 6.9.0
 - feat: Enable executeJavaScript Method Access through External API
 - feat: Bulk update Notifications from Notification Panel

package/desktop.d.ts

@@ -122,7 +122,7 @@ export declare namespace IOConnectDesktop {
          * Initializes or disables the Channels API.
          * @default false
          */
-        channels?: boolean;
+        channels?: boolean | IOConnectDesktop.Channels.Configuration;
 
         /**
          * Initializes or disables the Displays API.
@@ -2947,7 +2947,7 @@ export declare namespace IOConnectDesktop {
             /**
              * ID of the window that will be used to relatively position the new window. Can be combined with `relativeDirection`.
              */
-            relativeTo?: string;
+            relativeTo?: string | IOConnectWindow;
 
             /**
              * Direction for positioning the window relatively to the window specified in the `relativeTo` property.
@@ -3100,13 +3100,13 @@ export declare namespace IOConnectDesktop {
             /**
              * Name of the Channel to which the window will be joined by default when it's started.
              */
-            channelId: string;
+            channelId?: string;
 
             /**
              * If `true`, the Channel Selector will be visible, but the user won't be able to switch between Channels from it.
              * @default false
              */
-            readOnly: boolean;
+            readOnly?: boolean;
         }
 
         /**
@@ -3142,6 +3142,13 @@ export declare namespace IOConnectDesktop {
              * 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;
+
+            /**
+             * Interval in seconds to wait for the window to navigate.
+             * @default 120
+             * @since io.Connect Desktop 9.7
+             */
+            timeout?: number;
         }
 
         /**
@@ -6080,6 +6087,32 @@ export declare namespace IOConnectDesktop {
      * The Channels API is accessible through the `io.channels` object.
      */
     namespace Channels {
+
+        /**
+         * Mode for the Channels API. Used internally, shouldn't be used by end user apps.
+         * @ignore
+         */
+        export const enum OperationMode {
+            Single = "single",
+            Multi = "multi"
+        }
+
+        /**
+         * Settings for the Channels API.
+         */
+        export interface Configuration {
+            /**
+             * If `true`, will enable the Channels API.
+             * @default false
+             */
+            enabled?: boolean;
+            /**
+             * Sets the mode for the Channels API. Used internally, shouldn't be used by end user apps.
+             * @default "single"
+             * @ignore
+             */
+            operationMode?: OperationMode;
+        }
         /**
          * Channels API.
          */
@@ -6139,6 +6172,7 @@ export declare namespace IOConnectDesktop {
 
             /**
              * Retrieves the context of the current Channel.
+             * It's recommended to use the `getMyChannels()` method instead, which can retrieve the contexts of the currently joined Channels both in single and in multi Channel mode.
              * @param options Settings for retrieving an FDC3 context published in the io.Connect Channel. *Available since io.Connect Desktop 9.6.*
              */
             getMy(options?: FDC3Options): Promise<ChannelContext>;
@@ -6151,19 +6185,26 @@ export declare namespace IOConnectDesktop {
             join(name: string, windowId?: string): Promise<void>;
 
             /**
-             * Leaves the current Channel.
-             * @param windowId ID of a window which to force to leave a Channel. If not provided, will force the current window to leave the current Channel.
+             * Removes the current or a specified window from the current or a specified Channel.
+             * @param options Options for leaving Channels. You can provide only the window ID, or an object holding the window ID and the name of the Channel to leave.
+             * In either case, if only a window ID is provided, the specified window will be removed from the current Channel if in single Channel mode,
+             * or from all currently joined Channels if in multi Channel mode.
+             * If you provide only the name of the Channel to leave, the current window will be removed from the specified Channel.
+             * If you don't provide an argument, the current window will be removed from the current Channel if in single Channel mode,
+             * or from all currently joined Channels if in multi Channel mode.
              */
-            leave(windowId?: string): Promise<void>;
+            leave(options?: string | { windowId?: string, channel?: string }): Promise<void>;
 
             /**
              * Retrieves the name of the current Channel.
+             * @deprecated
              * @ignore
              */
             current(): string;
 
             /**
              * Retrieves the name of the current Channel.
+             * It's recommended to use the `myChannels()` method instead, which can retrieve the names of the currently joined Channels both in single and in multi Channel mode.
              */
             my(): string;
 
@@ -6214,15 +6255,47 @@ export declare namespace IOConnectDesktop {
             /**
              * Notifies when a Channel is changed.
              * @param callback Callback function for handling the event.
+             * @deprecated use onChannelsChanged instead
              * @ignore
              */
             changed(callback: (channel: string) => void): () => void;
 
             /**
-             * Notifies when a Channel is changed. Returns an unsubscribe function.
-             * @param callback Callback function for handling the event.
+             * Notifies when the current window joins or leaves a Channel. Returns an unsubscribe function.
+             * It's recommended to use the `onChannelsChanged()` method instead, which can handle Channel changes both in single and in multi Channel mode.
+             * @param callback Callback function for handling the event. Receives as an argument the name of the Channel which the window has joined or left.
              */
             onChanged(callback: (channel: string) => void): () => void;
+
+            /**
+             * Retrieves a list with the contexts of the current Channels. Can be used both in single and in multi Channel mode.
+             * If used in single Channel mode, the returned array will always contain a single member if the window is joined to a Channel, or will be empty otherwise.
+             * @since io.Connect Desktop 9.7
+             */
+            getMyChannels(options?: FDC3Options): Promise<ChannelContext[]>;
+
+            /**
+             * Retrieves a list with the names of the current Channels. Can be used both in single and in multi Channel mode.
+             * If used in single Channel mode, the returned array will always contain a single member if the window is joined to a Channel, or will be empty otherwise.
+             * @since io.Connect Desktop 9.7
+             */
+            myChannels(): string[];
+
+            /**
+             * Notifies when the current window joins or leaves a Channel. Can be used both in single and in multi Channel mode.
+             * If used in single Channel mode, when the window joins a Channel, the array argument passed to the callback for handling the event
+             * will always contain a single member; when the window leaves the current Channel, the array will be empty. Returns an unsubscribe function.
+             * @param callback Callback function for handling the event. Receives a list with the names of the currently joined Channels as an argument.
+             * @since io.Connect Desktop 9.7
+             */
+            onChannelsChanged(callback: (channels: string[]) => void): () => void;
+
+            /**
+             * Retrieves the current Channel mode (single or multi Channel). Set by the io.Connect framework based on configuration.
+             * @default "single"
+             * @since io.Connect Desktop 9.7
+             */
+            mode: OperationMode;
         }
 
         /**
@@ -6466,7 +6539,7 @@ export declare namespace IOConnectDesktop {
              * @param callback Callback function for handling the event. Receives an object describing the removed Intent handler as an argument.
              * @since io.Connect Desktop 9.6
              */
-            onHandlerRemoved(callback: (handler: IOConnectDesktop.Intents.IntentHandler)=> void, intentName: string): UnsubscribeFunction;
+            onHandlerRemoved(callback: (handler: IOConnectDesktop.Intents.IntentHandler) => void, intentName: string): UnsubscribeFunction;
 
             /**
              * Registers an Intent handler. If your app is already registered as an Intent handler through its configuration,
@@ -6676,7 +6749,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
+        // eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type
         export interface IntentInfo extends AddIntentListenerRequest { }
 
         /**