@interopio/desktop 6.3.1 → 6.5.0

package/changelog.md

@@ -1,3 +1,15 @@
+6.5.0
+- feat: contexts - add new methods - setPath,setPaths
+- fix: windows - activate/focus never resolves in certain cases
+- fix: appManager - when an is started, allow the timeout to be overridden
+6.4.1
+- fix: channels - listen to event for channel restrictions
+- chore: windows:  messageTitle should be optional in the windows
+- chore: fix types for the resolver
+6.4.0
+- feat: channels - add support for channel restrictions
+- chore: update types
+- chore: update schemas to 9.3.0 (was 9.2.0)
 6.3.1
 - chore: update core to 6.2.1 (was 6.1.0)
 6.3.0

package/desktop.d.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-shadow */
-import { ApplicationConfig } from "@glue42/schemas";
+import { ApplicationConfig } from "@interopio/schemas";
 import { IOConnectCore } from "@interopio/core";
 import { IOConnectWorkspaces } from "@interopio/workspaces-api";
 import { UnsubscribeFunction } from "callback-registry";
@@ -1070,7 +1070,7 @@ export declare namespace IOConnectDesktop {
              * Retrieves an app by name.
              * @param name Name of the desired app.
              */
-            application(name: string): Application;
+            application(name: string): Application | undefined;
 
             /**
              * Retrieves a collection of the available apps.
@@ -1624,6 +1624,11 @@ export declare namespace IOConnectDesktop {
              * 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;
+
+            /**
+             * Interval in seconds to wait for the app to initialize.
+             */
+            timeout?: number
         }
 
         /**
@@ -2662,16 +2667,23 @@ export declare namespace IOConnectDesktop {
             borderColor?: string;
 
             /**
-             * Name of the Channel which the window will join.
+             * Deprecated. Use `channelSelector` instead. Name of the Channel which the window will join.
+             * @ignore
              */
             channelId?: string;
 
             /**
-             * If `true`, Channels will be enabled for the window and it will show the Channel Selector.
+             * Deprecated. Use `channelSelector` instead. If `true`, Channels will be enabled for the window and it will show the Channel Selector.
              * @default false
+             * @ignore
              */
             allowChannels?: boolean;
 
+            /**
+             * Settings for the Channel Selector UI.
+             */
+            channelSelector?: ChannelSelector;
+
             /**
              * Defines the height of the window when collapsed.
              * @default -1
@@ -2962,6 +2974,36 @@ export declare namespace IOConnectDesktop {
             preloadScripts?: string[];
         }
 
+        /**
+         * Settings for the Channel Selector UI.
+         */
+        export interface ChannelSelector {
+            /**
+             * If `true`, will allow showing the Channel Selector.
+             * @default false
+             */
+            enabled?: boolean;
+
+            /**
+             * Type of the Channel Selector to show on the io.Connect Windows. A single Channel Selector (default) allows the window to join a single Channel
+             * to which it can subscribe and publish data unrestrictedly. A directional single Channel Selector allows the window to join a single Channel,
+             * but also enables the user to restrict the window from publishing or from subscribing to the current Channel.
+             * @default "single"
+             */
+            type?: "single" | "directionalSingle";
+
+            /**
+             * Name of the Channel to which the window will be joined by default when it's started.
+             */
+            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;
+        }
+
         /**
          * Options for loading a window URL.
          */
@@ -2982,8 +3024,7 @@ export declare namespace IOConnectDesktop {
             extraHeaders?: string;
 
             /**
-             * Data for the POST request. Either an array of `UploadFile` objects describing the location and other properties of the file to upload,
-             * or an array of `UploadBase64Data` objects containing data encoded as a Base64 string.
+             * Data for the POST request. The list can contain both `UploadFile` objects (describing the location and other properties of the file to upload) and `UploadBase64Data` objects (containing data encoded as a Base64 string).
              */
             postData?: ((UploadBase64Data) | (UploadFile))[];
 
@@ -4256,7 +4297,7 @@ export declare namespace IOConnectDesktop {
              * @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>;
+            close(group: Group | string, options?: CloseOptions): Promise<void>;
 
             /**
              * Lists all window groups.
@@ -4376,6 +4417,11 @@ export declare namespace IOConnectDesktop {
              */
             message: string;
 
+            /**
+             * Title for the message that will be displayed in the dialog.
+             */
+            messageTitle?: string;
+
             /**
              * If `true`, the user will be able to move the dialog.
              * @default true
@@ -4389,7 +4435,7 @@ export declare namespace IOConnectDesktop {
             transparent?: boolean;
 
             /**
-             * Title for the dialog to show.
+             * Title for the dialog that will be displayed in the dialog header.
              */
             title?: string;
 
@@ -4567,7 +4613,7 @@ export declare namespace IOConnectDesktop {
              * @param window Window ID or a window object by which to find a window in the group.
              * @param success Callback function for handling the successfully returned result.
              */
-            find(window: string | IOConnectWindow, success?: (window: IOConnectWindow) => void): IOConnectWindow;
+            find(window: string | IOConnectWindow, success?: (window: IOConnectWindow) => void): IOConnectWindow | undefined;
 
             /**
              * Restores a window group.
@@ -4626,11 +4672,11 @@ 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.
+             * Closes the window group.
+             * @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(options: CloseOptions): Promise<void>;
+            close(options?: CloseOptions): Promise<void>;
 
             /**
              * Creates a popup window.
@@ -4683,7 +4729,7 @@ export declare namespace IOConnectDesktop {
             /**
              * Retrieves the current window.
              */
-            my(): IOConnectWindow;
+            my(): IOConnectWindow | undefined;
 
             /**
              * Opens a new io.Connect Window.
@@ -4701,7 +4747,7 @@ export declare namespace IOConnectDesktop {
              * @param success Callback function for handling the successfully returned result.
              * @param error Callback function for handling errors.
              */
-            find(name: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): IOConnectWindow;
+            find(name: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): IOConnectWindow | undefined;
 
             /**
              * Finds a window by ID.
@@ -4709,7 +4755,7 @@ export declare namespace IOConnectDesktop {
              * @param success Callback function for handling the successfully returned result.
              * @param error Callback function for handling errors.
              */
-            findById(id: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): IOConnectWindow;
+            findById(id: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): IOConnectWindow | undefined;
 
             /**
              * Lists all windows.
@@ -5908,6 +5954,20 @@ export declare namespace IOConnectDesktop {
              */
             publish(data: any, name?: string): Promise<void>;
 
+            /**
+             * Sets a specified path within the Channel context to the provided value. If the path doesn't exist, it will be created.
+             * @param path Object containing the path to update and the value with which to update it. The path must be specified as a dot-separated string (e.g., `"prop1.prop2"`).
+             * @param name Name of the Channel to update. If not specified, will update the current Channel.
+             */
+            setPath(path: IOConnectDesktop.Contexts.PathValue, name?: string): Promise<void>;
+
+            /**
+             * Sets a list of specified paths within the Channel context to the provided values. If a path doesn't exist, it will be created.
+             * @param paths List of objects each containing a path to update and the value with which to update it. The path must be specified as a dot-separated string (e.g., `"prop1.prop2"`).
+             * @param name Name of the Channel to update. If not specified, will update the current Channel.
+             */
+            setPaths(paths: IOConnectDesktop.Contexts.PathValue[], name?: string): Promise<void>;
+
             /**
              * Retrieves a list of all Channel names.
              */
@@ -6275,7 +6335,22 @@ export declare namespace IOConnectDesktop {
             /**
              * Name of the raised Intent.
              */
-            intent: string;
+            intent?: string | IntentRequest;
+
+            /**
+             * Version of the Intents Resolver API.
+             */
+            version: string;
+
+            /**
+             * Criteria for filtering the available Intent handlers. Available only if the `filterHandlers()` method was used to open the Intents Resolver UI.
+             */
+            handlerFilter?: HandlerFilter;
+
+            /**
+             * Retrieves the title for the search operation. Available only if the `filterHandlers()` method was used to open the Intents Resolver UI and the `title` property of the `HandlerFilter` object was set.
+             */
+            getTitle(): string | undefined;
 
             /**
              * Notifies when a handler for the current Intent is added. Replays already existing handlers.
@@ -6822,15 +6897,16 @@ export declare namespace IOConnectDesktop {
         }
 
         /**
-         * Notification state.
-         * - `"Active"` - based on configuration, the notification is either visible as a toast, or is raised only in the Notification Panel, but the user hasn't seen it yet.
-         * When the toast is hidden, the user clicks on the toast, or sees the notification in the Notification Panel, the state will change;
-         * - `"Acknowledged"` - the user has seen the notification in the Notification Panel;
-         * - `"Closed"` - the notification has either been closed from its "Close" button, or the user has clicked on it or on an action in it;
-         * - `"Stale"` - the time specified in `toastExpiry` has elapsed;
+         * Notification states that are used by the platform when handling notifications. These states can also be used in your custom logic for processing notifications on the client or on the server side. Defaults to `"Active"`.
+         * - `"Active"` - a notification can be marked as active when it is raised, but the user hasn't seen it, or interacted in any way with it yet;
+         * - `"Acknowledged"` - a notification can be marked as acknowledged when the user has interacted with it by clicking on the notification or on an action in it;
+         * - `"Seen"` - a notification can be marked as seen when the user has seen it (e.g., by opening the Notification Panel);
+         * - `"Closed"` - a notification can be marked as closed when the user has closed the notification in the Notification Panel;
+         * - `"Stale"` - a notification can be marked as stale after a predefined period of time;
+         * - `"Snoozed"` - a notification can be marked as snoozed when the user snoozes it from the UI;
+         * - `"Processing"` - a notification can be marked as `"Processing"` when its state is in the process of changing (e.g., the user interacts with a notification from the UI, you make a request to a remote service to update the notification state, and you are still waiting for a response);
          */
-        export type State = "Active" | "Acknowledged" | "Closed" | "Stale";
-
+        export type State = "Active" | "Acknowledged" | "Seen" | "Closed" | "Stale" | "Snoozed" | "Processing";
         /**
          * Options for the clicked notification.
          */