@interopio/desktop 6.17.0 → 6.18.0

package/changelog.md

@@ -1,3 +1,9 @@
+6.18.0
+- feat: apps - inMemoryAppStore - remove method now accepts an array of app names for batch removal
+- fix: apps - inMemoryAppStore - add input validation (non-empty strings, at least one name) to remove method
+- fix: layouts - restore method timeout deprecated
+- chore: apps - inMemoryAppStore - improve error message handling and add error cause chaining in import, remove, and clear methods
+- chore: update core to 6.8.1
 6.17.0
 - feat: intents - add customConfig in intent's app definition
 - fix: layouts - restore method timeout removed
@@ -11,9 +17,9 @@
 6.16.1
 - fix: apps: if the method is not available, do not initialize the apps API
 - fix: prefs - when calling `io.prefs.get()`, the returned object looks like an unparsed fetch response
+- chore: update core to 6.7.3
 6.16.0
 - feat: layouts - restoreWorkspacesByReference option added
-
 - chore: reconnect logic improvement
 6.15.0
 - fix: channels - creation inconsistency - G4E-9871

package/desktop.d.ts

@@ -1018,7 +1018,7 @@ export declare namespace IOConnectDesktop {
              * Notifies when io.Connect will shut down or restart. If the callback is asynchronous, it will be awaited up to 60 seconds before shutdown continues.
              * @param callback Callback function for handling the event.
              */
-            onShuttingDown(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean }>): UnsubscribeFunction;
+            onShuttingDown(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean }>): void;
         }
 
         /**
@@ -1910,8 +1910,20 @@ export declare namespace IOConnectDesktop {
             has(name: string): Promise<boolean>;
 
             /**
-             * Removes an app definition from the in-memory store.
-             * @param options Options for removing an app definition.
+             * Removes one or more app definitions from the in-memory store.
+             * @param options Options for removing one or more app definitions.
+             *
+             * @example
+             * ```javascript
+             * // Removing a single app.
+             * await io.apps.registry.inMemory.remove({ name: "my-app" });
+             *
+             * // Removing multiple apps at a time.
+             * await io.apps.registry.inMemory.remove({ name: ["my-app", "my-other-app"] })
+             *
+             * // Removing multiple apps and stopping all their instances.
+             * await io.apps.registry.inMemory.remove({ name: ["my-app", "my-other-app"], stopInstances: true });
+             * ```
              */
             remove(options: RemoveAppOptions): Promise<void>;
 
@@ -2362,17 +2374,17 @@ export declare namespace IOConnectDesktop {
         }
 
         /**
-         * Options for removing and app definition from the in-memory store.
+         * Options for removing app definitions from the in-memory store.
          */
         export interface RemoveAppOptions {
 
             /**
-             * Name of the app whose definition to remove.
+             * Name of the app whose definition to remove or an array of app names if you want to remove multiple apps at a time.
              */
-            readonly name: string;
+            readonly name: string | string[];
 
             /**
-             * If `true`, all currently running instances of the app will be stopped.
+             * If `true`, all currently running instances of the removed apps will be stopped.
              * @default false
              */
             readonly stopInstances?: boolean;
@@ -2506,7 +2518,7 @@ export declare namespace IOConnectDesktop {
              * before the platform shuts down or restarts. The available time for the execution of your code is 60 seconds.
              * To prevent the platform shutdown or restart, the callback must resolve with an object with a `prevent` property set to `true`.
              */
-            onShuttingDown(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean }>): UnsubscribeFunction;
+            onShuttingDown(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean }>): () => void;
         }
 
         /**
@@ -3322,6 +3334,13 @@ export declare namespace IOConnectDesktop {
              */
             context?: unknown;
 
+            /**
+             * Timeout in milliseconds for restoring the Layout.
+             * If the time limit is hit, all apps opened up to this point will be closed and an error will be thrown.
+             * @deprecated
+             */
+            timeout?: number;
+
             /**
              * Only if the type is `"Activity"`. If `true`, will try to reuse existing windows when restoring the Layout.
              * @default true

package/dist/desktop.browser.js

@@ -1224,6 +1224,13 @@
                           }
                           seen.add(value);
                       }
+                      if (value instanceof Error) {
+                          return {
+                              message: value.message,
+                              name: value.name,
+                              stack: value.stack
+                          };
+                      }
                       return value;
                   };
                   reason = JSON.stringify(err, replacer);
@@ -1468,6 +1475,7 @@
           this.notifyStatusChanged(true);
       }
       close() {
+          this.logger.debug(`closing connection - clientId: ${this.myClientId}, windowId: ${this.identity?.windowId || "unknown"}, client connected: ${this.iAmConnected}`);
           const message = {
               glue42core: {
                   type: this.messages.gatewayDisconnect.name,
@@ -1540,7 +1548,7 @@
                       selfAssignedWindowId: this.selfAssignedWindowId
                   }
               };
-              this.logger.debug("sending connection request");
+              this.logger.debug(`sending connection request - clientId: ${this.myClientId}`);
               if (this.extContentConnecting) {
                   request.glue42core.clientType = "child";
                   request.glue42core.bridgeInstanceId = this.myClientId;
@@ -1567,6 +1575,7 @@
               this.logger.debug("skipping generic message listener, because this is an internal client");
               return;
           }
+          this.logger.debug("setting up window message listener");
           window.addEventListener("message", (event) => {
               const data = event.data?.glue42core;
               if (!data || this.rejected) {
@@ -1591,6 +1600,7 @@
               this.logger.debug("skipping unload event listener, because this is an internal client");
               return;
           }
+          this.logger.debug("setting up unload event listeners");
           window.addEventListener("beforeunload", () => {
               if (this._connectionProtocolVersion) {
                   return;
@@ -1608,6 +1618,7 @@
           if (this.extContentConnected) {
               return;
           }
+          this.logger.debug(`signaling client disappearing for clientId: ${this.myClientId}`);
           const message = {
               glue42core: {
                   type: this.messages.clientUnload.name,
@@ -1742,6 +1753,7 @@
           source.postMessage(message, event.origin);
       }
       setupPlatformUnloadListener() {
+          this.logger.debug("setting up platform unload listener");
           this.onMessage((msg) => {
               if (msg.type === "platformUnload") {
                   this.logger.debug("detected a web platform unload");
@@ -1751,6 +1763,7 @@
           });
       }
       handleManualUnload() {
+          this.logger.debug("handling manual unload");
           const message = {
               glue42core: {
                   type: this.messages.clientUnload.name,
@@ -1769,6 +1782,7 @@
           return;
       }
       notifyStatusChanged(status, reason) {
+          this.logger.debug(`status changed - connected: ${status}, reason: ${reason || "none"}`);
           this.iAmConnected = status;
           this.registry.execute("onConnectedChanged", status, reason);
       }
@@ -2738,7 +2752,7 @@
           return authentication;
       }
       async logoutCore() {
-          this.logger.debug("logging out...");
+          this.logger.debug("core logging out...");
           this.shouldTryLogin = false;
           if (this.pingTimer) {
               clearTimeout(this.pingTimer);
@@ -2969,7 +2983,7 @@
       }
   };
 
-  var version$1 = "6.7.3";
+  var version$1 = "6.8.1";
 
   function prepareConfig$1 (configuration, ext, glue42gd) {
       let nodeStartingContext;
@@ -6752,7 +6766,6 @@
   };
   const nonEmptyStringDecoder$1 = string$1().where((s) => s.length > 0, "Expected a non-empty string");
   const nonNegativeNumberDecoder$1 = number$1().where((num) => num >= 0, "Expected a non-negative number or 0");
-  const positiveNumberDecoder = number$1().where((num) => num > 0, "Expected a positive number");
   const methodDefinitionDecoder = object$1({
       name: nonEmptyStringDecoder$1,
       objectTypes: optional$1(array$1(nonEmptyStringDecoder$1)),
@@ -6785,8 +6798,8 @@
   });
   const targetDecoder = union(constant$1("best"), constant$1("all"), constant$1("skipMine"), instanceDecoder, array$1(instanceDecoder));
   const invokeOptionsDecoder = object$1({
-      waitTimeoutMs: optional$1(positiveNumberDecoder),
-      methodResponseTimeoutMs: optional$1(positiveNumberDecoder)
+      waitTimeoutMs: optional$1(nonNegativeNumberDecoder$1),
+      methodResponseTimeoutMs: optional$1(nonNegativeNumberDecoder$1)
   });
 
   var InvokeStatus;
@@ -20467,7 +20480,7 @@
       }
   }
 
-  var version = "6.17.0";
+  var version = "6.18.0";
 
   var prepareConfig = (options) => {
       function getLibConfig(value, defaultMode, trueMode) {
@@ -24438,9 +24451,10 @@
               };
           }
           catch (error) {
-              const msg = `Failed to import app definitions: ${error.message}`;
+              const errorMessage = error instanceof Error ? error.message : String(error);
+              const msg = `Failed to import app definitions: ${errorMessage}`;
               this.logger.error(msg, error);
-              throw new Error(msg);
+              throw new Error(msg, { cause: error });
           }
       }
       async has(name) {
@@ -24451,18 +24465,40 @@
           return result.returned.result !== undefined ? result.returned.result : false;
       }
       async remove(options) {
-          if (!(options === null || options === void 0 ? void 0 : options.name)) {
+          if ((options === null || options === void 0 ? void 0 : options.name) === undefined) {
               throw new Error("App name is required for removal");
           }
-          this.logger.debug(`Removing app definition: ${options.name}`);
+          const names = Array.isArray(options.name) ? options.name : [options.name];
+          if (names.length === 0) {
+              throw new Error("At least one app name is required for removal");
+          }
+          const invalidEntries = [];
+          names.forEach((entry, index) => {
+              if (typeof entry !== 'string') {
+                  invalidEntries.push(`index ${index}: expected string, got ${typeof entry}`);
+              }
+              else if (entry.trim() === '') {
+                  invalidEntries.push(`index ${index}: empty or whitespace-only string`);
+              }
+          });
+          if (invalidEntries.length > 0) {
+              throw new Error(`Invalid app name(s) for removal: ${invalidEntries.join('; ')}`);
+          }
+          const maxSampleSize = 10;
+          const sampleNames = names.slice(0, maxSampleSize);
+          const displayNames = Array.isArray(options.name)
+              ? `[${sampleNames.join(", ")}${names.length > maxSampleSize ? ", ..." : ""}] (total ${names.length})`
+              : options.name;
+          this.logger.debug(`Removing app definition(s): ${displayNames}`);
           try {
               await invokeAppsCommand(this.interop, "in-memory-remove", options);
-              this.logger.debug(`Removed app definition: ${options.name}`);
+              this.logger.debug(`Removed app definition(s): ${displayNames}`);
           }
           catch (error) {
-              const msg = `Failed to remove app definition: ${options.name}`;
+              const errorMessage = error instanceof Error ? error.message : String(error);
+              const msg = `Failed to remove app definition(s): ${displayNames}. ${errorMessage}`;
               this.logger.error(msg, error);
-              throw new Error(msg);
+              throw new Error(msg, { cause: error });
           }
       }
       async clear(options) {
@@ -24471,9 +24507,10 @@
               await invokeAppsCommand(this.interop, "in-memory-clear", options);
           }
           catch (error) {
-              const msg = `Failed to clear in-memory app definitions: ${error.message}`;
+              const errorMessage = error instanceof Error ? error.message : String(error);
+              const msg = `Failed to clear in-memory app definitions: ${errorMessage}`;
               this.logger.error(msg, error);
-              throw new Error(msg);
+              throw new Error(msg, { cause: error });
           }
       }
   }