@interopio/desktop 6.5.1 → 6.6.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.
          */

package/dist/desktop.browser.js

@@ -2933,7 +2933,7 @@
       }
   };
 
-  var version$1 = "6.3.3";
+  var version$1 = "6.3.4";
 
   function prepareConfig$1 (configuration, ext, glue42gd) {
       let nodeStartingContext;
@@ -6903,6 +6903,10 @@
           return unsubscribeFunc;
       }
       getServerById(id) {
+          const server = this.servers[id];
+          if (!server) {
+              return undefined;
+          }
           return this.hideServerMethodSystemFlags(this.servers[id]);
       }
       reset() {
@@ -7215,7 +7219,7 @@
       }
       handleAddInterest(msg) {
           const caller = this.repository.getServerById(msg.caller_id);
-          const instance = caller.instance;
+          const instance = caller?.instance ?? {};
           const requestContext = {
               msg,
               arguments: msg.arguments_kv || {},
@@ -7387,7 +7391,7 @@
           if (method === undefined) {
               return;
           }
-          const client = this.clientRepository.getServerById(callerId).instance;
+          const client = this.clientRepository.getServerById(callerId)?.instance;
           const invocationArgs = { args, instance: client };
           this.callbacks.execute("onInvoked", method, invocationId, invocationArgs);
       }
@@ -7400,9 +7404,15 @@
           return this.subscriptionData.params.arguments || {};
       }
       get servers() {
-          return this.subscriptionData.trackedServers
-              .filter((pair) => pair.subscriptionId)
-              .map((pair) => this.repository.getServerById(pair.serverId).instance);
+          return this.subscriptionData.trackedServers.reduce((servers, pair) => {
+              if (pair.subscriptionId) {
+                  const server = this.repository.getServerById(pair.serverId)?.instance;
+                  if (server) {
+                      servers.push(server);
+                  }
+              }
+              return servers;
+          }, []);
       }
       get serverInstance() {
           return this.servers[0];
@@ -7692,18 +7702,19 @@
           if (typeof subscription !== "object") {
               return;
           }
-          const trackedServersFound = subscription.trackedServers.filter((server) => {
-              return server.subscriptionId === msg.subscription_id;
+          const trackedServersFound = subscription.trackedServers.filter((s) => {
+              return s.subscriptionId === msg.subscription_id;
           });
           if (trackedServersFound.length !== 1) {
               return;
           }
           const isPrivateData = msg.oob;
           const sendingServerId = trackedServersFound[0].serverId;
+          const server = this.repository.getServerById(sendingServerId);
           const receivedStreamData = () => {
               return {
                   data: msg.data,
-                  server: this.repository.getServerById(sendingServerId).instance,
+                  server: server?.instance ?? {},
                   requestArguments: subscription.params.arguments,
                   message: undefined,
                   private: isPrivateData,
@@ -7757,7 +7768,7 @@
           const closingServerId = (closersCount > 0) ? subscription.queued.closers[closersCount - 1] : null;
           let closingServer;
           if (closingServerId !== undefined && typeof closingServerId === "string") {
-              closingServer = this.repository.getServerById(closingServerId).instance;
+              closingServer = this.repository.getServerById(closingServerId)?.instance ?? {};
           }
           subscription.handlers.onClosed.forEach((callback) => {
               if (typeof callback !== "function") {
@@ -7869,13 +7880,15 @@
           const serverId = msg.server_id;
           const methodIdList = msg.methods;
           const server = this.repository.getServerById(serverId);
-          const serverMethodKeys = Object.keys(server.methods);
-          serverMethodKeys.forEach((methodKey) => {
-              const method = server.methods[methodKey];
-              if (methodIdList.indexOf(method.gatewayId) > -1) {
-                  this.repository.removeServerMethod(serverId, methodKey);
-              }
-          });
+          if (server) {
+              const serverMethodKeys = Object.keys(server.methods);
+              serverMethodKeys.forEach((methodKey) => {
+                  const method = server.methods[methodKey];
+                  if (methodIdList.indexOf(method.gatewayId) > -1) {
+                      this.repository.removeServerMethod(serverId, methodKey);
+                  }
+              });
+          }
       }
       handleResultMessage(msg) {
           const invocationId = msg._tag.invocationId;
@@ -7885,7 +7898,7 @@
           return {
               invocationId,
               result,
-              instance: server.instance,
+              instance: server?.instance,
               status: InvokeStatus.Success,
               message: ""
           };
@@ -7901,7 +7914,7 @@
               return {
                   invocationId,
                   result: context,
-                  instance: server.instance,
+                  instance: server?.instance,
                   status: InvokeStatus.Error,
                   message
               };
@@ -16935,6 +16948,21 @@
               this.invokeMethodAndTrack("RestoreLayout", arg, resolve, reject, true);
           });
       }
+      reset(options) {
+          return new Promise((resolve, reject) => {
+              this.verifyNotSlimMode();
+              if (typeof options !== "object") {
+                  return reject(new Error("options argument is required"));
+              }
+              if (isNullOrWhiteSpace(options.layoutId)) {
+                  return reject(new Error("options.layoutId argument is required"));
+              }
+              const msg = {
+                  ...options
+              };
+              this.invokeMethodAndTrack("ResetLayout", msg, resolve, reject, true);
+          });
+      }
       remove(type, name) {
           return new Promise((resolve, reject) => {
               this.verifyNotSlimMode();
@@ -17064,6 +17092,17 @@
           }
           return layout;
       }
+      getRestoredLayoutsInfo() {
+          return new Promise((resolve, reject) => {
+              const methodName = "GetRestoredLayoutsInfo";
+              this.invokeMethodCore(methodName)
+                  .then((result) => {
+                  const restoredLayouts = result.returned;
+                  resolve(restoredLayouts);
+              })
+                  .catch(reject);
+          });
+      }
       onAdded(callback) {
           const result = this.callbacks.add("added", callback);
           if (store.all.length > 0) {
@@ -18245,7 +18284,7 @@
       };
   }
 
-  var version = "6.5.0";
+  var version = "6.5.1";
 
   var prepareConfig = (options) => {
       function getLibConfig(value, defaultMode, trueMode) {