@interopio/desktop 6.5.1 → 6.6.1-next.0

package/changelog.md

@@ -1,3 +1,6 @@
+6.6.0
+- feat: layouts - add new methods - reset, getRestoredLayoutsInfo
+- feat: layouts - resume/restore methods now returns the restored instances
 6.5.1
 - chore: unified repo bump
 6.5.0

package/desktop.d.ts

@@ -2008,7 +2008,13 @@ export declare namespace IOConnectDesktop {
              * Restores a Layout.
              * @param options Options for restoring a Layout.
              */
-            restore(options: RestoreOptions): Promise<void>;
+            restore(options: RestoreOptions): Promise<RestoreResumeResult>;
+
+            /**
+             * Resets a Layout.
+             * @param options Options for resetting a Layout.
+             */
+            reset(options: ResetLayoutOptions): Promise<RestoreResumeResult>;
 
             /**
              * Removes a Layout
@@ -2035,6 +2041,11 @@ export declare namespace IOConnectDesktop {
              */
             getCurrentLayout(): Promise<Layout | undefined>;
 
+            /**
+             * Retrieves info about the currently active Layout (ID, type, name, participating app instances), as well as about any previously active Layouts that still have running instances of their participating apps.
+             */
+            getRestoredLayoutsInfo(): Promise<GetRestoredLayoutsInfoResult | undefined>;
+
             /**
              * Hibernates a Layout.
              * @param name Name of the Layout to hibernate.
@@ -2048,7 +2059,7 @@ export declare namespace IOConnectDesktop {
              * @param context Context for the Layout.
              * @param options Options for resuming a Layout.
              */
-            resume(name: string, context?: any, options?: IOConnectDesktop.Layouts.ResumeOptions): Promise<ResumeResult>;
+            resume(name: string, context?: any, options?: IOConnectDesktop.Layouts.ResumeOptions): Promise<RestoreResumeResult>;
 
             /**
              * Updates the context saved for your app in the currently loaded Layout.
@@ -2196,17 +2207,37 @@ export declare namespace IOConnectDesktop {
         }
 
         /**
-         * Describes the result returned from resuming a Layout.
+         * Describes the result returned from restoring or resuming a Layout.
          */
-        export interface ResumeResult extends LayoutResult {
+        export interface RestoreResumeResult extends LayoutResult {
             /**
-             * Array of objects describing all resumed app instances participating in the Layout.
-             * Each object contains the instance ID and the app name of the resumed app instance.
+             * Status of the Layout restore or resume operation.
              */
-            instances: {
-                instanceId: string,
-                appName: string
-            }[];
+            status: "Success" | "Failed";
+
+            /**
+             * ID of the Layout that was restored or resumed.
+             */
+            layoutId: string;
+
+            /**
+             * List of objects describing the app instances participating in the restored or resumed Layout.
+             */
+            instances: RestoredInstance[];
+        }
+
+        /**
+         * Describes an app instance participating in a restored or resumed Layout.
+         */
+        export interface RestoredInstance {
+            /**
+             * Name of the app within the io.Connect framework.
+             */
+            appName: string;
+            /**
+             * Unique ID of the app instance within the io.Connect framework.
+             */
+            instanceId: string;
         }
 
         /**
@@ -2223,6 +2254,48 @@ export declare namespace IOConnectDesktop {
             }[];
         }
 
+        /**
+         * Describes the currently active Layout (ID, type, name and participating app instances), as well as any previously active Layouts that still have running instances of their participating apps.
+         */
+        export interface GetRestoredLayoutsInfoResult {
+            /**
+             * List of objects each describing the currently active Layout or any previously active Layouts.
+             */
+            layoutInfo: RestoredLayoutDetails[];
+        }
+
+        /**
+         * Describes a currently active Layout, or a previously active Layout that may still have running instances of its participating apps.
+         */
+        export interface RestoredLayoutDetails {
+            /**
+             * ID of the Layout.
+             */
+            id: string;
+            /**
+             * Type of the Layout.
+             */
+            type: string;
+            /**
+             * Name of the Layout.
+             */
+            name: string;
+            /**
+             * List of objects each describing the app instances participating in the Layout.
+             */
+            instances: RestoredLayoutInstanceInfo[];
+        }
+
+        /**
+         * Describes an app instance participating in a Layout.
+         */
+        export interface RestoredLayoutInstanceInfo extends RestoredInstance {
+            /**
+             * Flag indicating whether the app instance has been stopped.
+             */
+            stopped: boolean;
+        }
+
         /**
          * Type of the Layout component - an activity or an app.
          * @ignore
@@ -2409,6 +2482,31 @@ export declare namespace IOConnectDesktop {
             splash?: RestoreSplashOptions;
         }
 
+        /**
+         * Options for resetting a Layout.
+         */
+        export interface ResetLayoutOptions {
+            /**
+             * ID of the Layout to reset.
+             */
+            layoutId: string
+            /**
+             * If `true`, will reset only the visible apps. Any apps that may have been hidden programmatically won't be included in the Layout reset process.
+             * @default false
+             */
+            visibleOnly?: boolean;
+            /**
+             * If `true`, will create any missing apps that may have been closed by the user or programmatically.
+             * @default true
+             */
+            createMissing?: boolean;
+            /**
+             * If `true`, will reset the Layout to its default state. Set to `false` to preserve any current app context or Channel selection.
+             * @default true
+             */
+            resetState?: boolean;
+        }
+
         /**
          * Options for hibernating Layouts.
          */
@@ -5961,9 +6059,9 @@ export declare namespace IOConnectDesktop {
             /**
              * Updates the context of the current or a specified Channel.
              * @param data Data object with which to update the Channel context.
-             * @param name The name of the Channel to update. If not provided, will update the current Channel.
+             * @param options The name of the Channel to update, or an object containing the name of the Channel to update and a flag indicating whether the published data is an FDC3 context. If no options are provided, the current Channel will be updated.
              */
-            publish(data: any, name?: string): Promise<void>;
+            publish(data: any, options?: string | PublishOptions): Promise<void>;
 
             /**
              * Sets a specified path within the Channel context to the provided value. If the path doesn't exist, it will be created.
@@ -6142,6 +6240,21 @@ export declare namespace IOConnectDesktop {
             data: any;
         }
 
+        /**
+         * Options for updating a Channel context with the `publish()` method.
+         */
+        export interface PublishOptions {
+            /**
+             * The name of the Channel to update. If not provided, the current Channel will be updated.
+             */
+            name?: string;
+
+            /**
+             * Flag indicating whether the published data is an FDC3 context. If so, it must contain a required `type` property.
+             */
+            fdc3?: boolean;
+        }
+
         /**
          * All restrictions applied to a window for publishing or subscribing to Channels.
          */
@@ -6306,6 +6419,11 @@ export declare namespace IOConnectDesktop {
              */
             getIntents(handler: IntentHandler): Promise<GetIntentsResult>;
 
+            /**
+             * Removes all saved Intent handlers for previously raised Intents.
+             */
+            clearSavedHandlers(): Promise<void>;
+
             /**
              * API for controlling the Intents Resolver UI app.
              */
@@ -6358,6 +6476,11 @@ export declare namespace IOConnectDesktop {
              */
             handlerFilter?: HandlerFilter;
 
+            /**
+             * Details about the app instance that opened the Intents Resolver UI.
+             */
+            caller?: ResolverCaller;
+
             /**
              * 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.
              */
@@ -6378,7 +6501,40 @@ export declare namespace IOConnectDesktop {
             /**
              * Sends the chosen Intent handler to the app which raised the Intent.
              */
-            sendResponse(handler: ResolverIntentHandler): Promise<IOConnectDesktop.Interop.InvocationResult | undefined>;
+            sendResponse(handler: ResolverIntentHandler, options?: SendResolverResponseOptions): Promise<IOConnectDesktop.Interop.InvocationResult | undefined>;
+        }
+
+        /**
+         * Describes the app instance that opened the Intents Resolver UI.
+         */
+        export interface ResolverCaller {
+            /**
+             * ID of the Interop instance of the app that opened the Intents Resolver UI.
+             */
+            id: string;
+            /**
+             * Name of the app that opened the Intents Resolver UI.
+             */
+            applicationName?: string;
+            /**
+             * Title of the app that opened the Intents Resolver UI.
+             */
+            applicationTitle?: string;
+        }
+
+        /**
+         * Options for sending the chosen Intent handler to the app that raised the Intent.
+         */
+        export interface SendResolverResponseOptions {
+            /**
+             * If `true`, the chosen Intent handler will be saved as a handler for the raised Intent. If the handler is saved, the next time the same Intent is raised, the Intents Resolver UI won't open and the saved handler will be used automatically.
+             * @default false
+             */
+            saveHandler: boolean;
+            /**
+             * Use this property to supply the name of the Intent when the Intents Resolver UI is opened via the `filterHandlers()` method and you want to save the Intent handler for that Intent. If the Intents Resolver UI is opened via the `raise()` method, it isn't necessary to explicitly provide the Intent name here, as specifying an Intent name is mandatory when using the `raise()` method.
+             */
+            intent?: string;
         }
 
         /**
@@ -6390,6 +6546,11 @@ export declare namespace IOConnectDesktop {
              */
             applicationName: string;
 
+            /**
+             * Title of the Intent handler.
+             */
+            applicationTitle?: string;
+
             /**
              * Icon of the Intent handler app.
              */
@@ -6625,6 +6786,12 @@ export declare namespace IOConnectDesktop {
              * @default false
              */
             readonly waitUserResponseIndefinitely?: boolean;
+
+            /**
+             * If `true`, the previously saved Intent handler for this Intent (if any) will be cleared.
+             * @default false
+             */
+            readonly clearSavedHandler?: boolean;
         }
 
         /**