@interopio/desktop 6.16.3 → 6.18.0

package/changelog.md

@@ -1,3 +1,15 @@
+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
+- fix: channels - prevent callback replay after handler invocation
+- chore: intents - validations for add intent listener method - register
+- chore: increase the timeout for streams in io.CD from 30 to 90 seconds
 6.16.3
 - chore: prefs: lastUpdate type to Date
 6.16.2
@@ -5,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: increase the timeout for streams in io.CD from 30 to 90 seconds
 - chore: reconnect logic improvement
 6.15.0
 - fix: channels - creation inconsistency - G4E-9871

package/desktop.d.ts

@@ -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;
@@ -3325,6 +3337,7 @@ export declare namespace IOConnectDesktop {
             /**
              * 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;
 
@@ -7936,6 +7949,12 @@ export declare namespace IOConnectDesktop {
              * The type of predefined data structure which the Intent handler returns.
              */
             resultType?: string;
+
+            /**
+             * Object containing custom configuration for the Intent handler.
+             * @since io.Connect Desktop 10.0.4
+             */
+            customConfig?: { [key: string]: any };
         }
 
         /**
@@ -8109,6 +8128,12 @@ export declare namespace IOConnectDesktop {
              * The type of predefined data structure which the Intent handler returns.
              */
             resultType?: string;
+
+            /**
+             * Object containing custom configuration for the Intent handler provided via the app definition or dynamically.
+             * @since io.Connect Desktop 10.0.4
+             */
+            customConfig?: { [key: string]: any };
         }
 
         /**

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;
@@ -13650,7 +13663,11 @@
               resolveFunc = resolve;
               rejectFunc = reject;
           });
-          agm.subscribe(OnEventMethodName, { arguments: { skipIcon: skipIcons }, waitTimeoutMs: 10000 })
+          agm.subscribe(OnEventMethodName, {
+              arguments: { skipIcon: skipIcons },
+              waitTimeoutMs: INTEROP_METHOD_WAIT_TIMEOUT_MS,
+              methodResponseTimeout: INTEROP_METHOD_WAIT_TIMEOUT_MS
+          })
               .then((s) => {
               subscription = s;
               subscription.onData((streamData) => {
@@ -16877,6 +16894,8 @@
                       arguments: {
                           withConfig: true
                       },
+                      waitTimeoutMs: INTEROP_METHOD_WAIT_TIMEOUT_MS,
+                      methodResponseTimeout: INTEROP_METHOD_WAIT_TIMEOUT_MS,
                       onData: (streamData) => {
                           if (streamData.data.type === "Configuration") {
                               this._configuration = streamData.data;
@@ -18447,9 +18466,6 @@
               if (!isUndefinedOrNull(options.context) && !isObject(options.context)) {
                   return reject(new Error("`context` must hold an object value."));
               }
-              if (!isUndefinedOrNull(options.timeout) && typeof options.timeout !== "number") {
-                  return reject(new Error("`timeout` must hold an number value."));
-              }
               options.context = (_c = options.context) !== null && _c !== void 0 ? _c : {};
               const restoreOptions = {
                   activityToJoin: options.activityIdToJoin,
@@ -18464,11 +18480,9 @@
                   type: options.type,
                   name: options.name,
                   context: options.context,
-                  options: restoreOptions
+                  options: restoreOptions,
+                  timeout: INTEROP_METHOD_MAX_TIMEOUT_MS
               };
-              if (options.timeout) {
-                  arg.timeout = options.timeout;
-              }
               this.invokeMethodAndTrack("RestoreLayout", arg, resolve, reject, true);
           });
       }
@@ -18602,6 +18616,7 @@
               const request = {
                   name,
                   type: "Global",
+                  timeout: INTEROP_METHOD_MAX_TIMEOUT_MS,
                   context,
                   ...options
               };
@@ -18750,7 +18765,7 @@
               const err = Utils.typedError(error);
               reject(err);
           };
-          const methodResponseTimeoutMs = 120 * 1000;
+          const methodResponseTimeoutMs = ("timeout" in args && typeof args.timeout === "number") ? args.timeout : 120 * 1000;
           if (!skipStreamEvent) {
               this.stream.waitFor(token, methodResponseTimeoutMs)
                   .then(() => {
@@ -18839,7 +18854,7 @@
           }
           else {
               this.logger.trace(`subscribing to "${this.StreamName}" stream`);
-              this.agm.subscribe(this.StreamName, { waitTimeoutMs: 10000 })
+              this.agm.subscribe(this.StreamName, { waitTimeoutMs: INTEROP_METHOD_WAIT_TIMEOUT_MS, methodResponseTimeout: INTEROP_METHOD_WAIT_TIMEOUT_MS })
                   .then((subs) => {
                   this.logger.trace(`subscribed to "${this.StreamName}" stream`);
                   subs.onData((args) => {
@@ -19520,12 +19535,17 @@
               validateFdc3Options(options);
           }
           const id = Utils.generateId();
+          let handlerInvoked = false;
+          const markHandlerInvoked = () => { handlerInvoked = true; };
           const wrappedCallback = (options === null || options === void 0 ? void 0 : options.contextType)
-              ? this.getWrappedSubscribeCallbackWithFdc3Type(callback, id, options.contextType)
-              : this.getWrappedSubscribeCallback(callback, id);
+              ? this.getWrappedSubscribeCallbackWithFdc3Type(callback, id, options.contextType, markHandlerInvoked)
+              : this.getWrappedSubscribeCallback(callback, id, markHandlerInvoked);
           let timeoutIndex;
           if (this.lastUpdate) {
               timeoutIndex = setTimeout(() => {
+                  if (handlerInvoked) {
+                      return;
+                  }
                   wrappedCallback(this.lastUpdate.context.data, this.lastUpdate.context, {}, this.lastUpdate.updaterId);
               }, 0);
           }
@@ -19547,9 +19567,10 @@
               validateFdc3Options(options);
           }
           const id = Utils.generateId();
+          const markHandlerInvoked = () => { };
           const wrappedCallback = (options === null || options === void 0 ? void 0 : options.contextType)
-              ? this.getWrappedSubscribeCallbackWithFdc3Type(callback, id, options.contextType)
-              : this.getWrappedSubscribeCallback(callback, id);
+              ? this.getWrappedSubscribeCallbackWithFdc3Type(callback, id, options.contextType, markHandlerInvoked)
+              : this.getWrappedSubscribeCallback(callback, id, markHandlerInvoked);
           const unsub = await this.shared.subscribeFor(name, wrappedCallback);
           return () => {
               this.pendingRestrictionCallbacks.delete(id);
@@ -20085,8 +20106,9 @@
           const fdc3DataToPublish = { [`fdc3_${parsedType}`]: rest };
           return this.shared.updateData(channelName, fdc3DataToPublish);
       }
-      getWrappedSubscribeCallback(callback, id) {
+      getWrappedSubscribeCallback(callback, id, markHandlerInvoked) {
           const wrappedCallback = async (_, context, delta, updaterId) => {
+              markHandlerInvoked();
               const restrictionByChannel = await this.getRestrictionsByChannel(context.name);
               const channelData = this.getDataWithFdc3Encoding(context, delta);
               if (restrictionByChannel.read) {
@@ -20097,9 +20119,10 @@
           };
           return wrappedCallback;
       }
-      getWrappedSubscribeCallbackWithFdc3Type(callback, id, fdc3Type) {
+      getWrappedSubscribeCallbackWithFdc3Type(callback, id, fdc3Type, markHandlerInvoked) {
           const didReplay = { replayed: false };
           const wrappedCallback = async (_, context, delta, updaterId) => {
+              markHandlerInvoked();
               const restrictionByChannel = await this.getRestrictionsByChannel(context.name);
               const callbackWithTypesChecks = () => {
                   const { data, latest_fdc3_type } = context;
@@ -20457,7 +20480,7 @@
       }
   }
 
-  var version = "6.16.3";
+  var version = "6.18.0";
 
   var prepareConfig = (options) => {
       function getLibConfig(value, defaultMode, trueMode) {
@@ -21076,7 +21099,9 @@
                   arguments: {
                       sendDeltaOnly: true,
                       statesVersion2: true
-                  }
+                  },
+                  waitTimeoutMs: INTEROP_METHOD_WAIT_TIMEOUT_MS,
+                  methodResponseTimeout: INTEROP_METHOD_WAIT_TIMEOUT_MS
               })
                   .then((sub) => {
                   this.subscriptionForNotifications = sub;
@@ -21108,7 +21133,9 @@
                   .subscribe(this.NotificationsCounterStream, {
                   arguments: {
                       sendDeltaOnly: true
-                  }
+                  },
+                  waitTimeoutMs: INTEROP_METHOD_WAIT_TIMEOUT_MS,
+                  methodResponseTimeout: INTEROP_METHOD_WAIT_TIMEOUT_MS
               })
                   .then((sub) => {
                   this.subscriptionForCounter = sub;
@@ -22860,6 +22887,32 @@
           }
       });
   };
+  const validateAddIntentListenerRequest = (request) => {
+      if ((typeof request !== "string" && typeof request !== "object") || (typeof request === "object" && typeof request.intent !== "string")) {
+          throw new Error("Please provide the intent as a string or an object with an intent property!");
+      }
+      if (typeof request === "string") {
+          return;
+      }
+      if (typeof request.contextTypes !== "undefined" && (!Array.isArray(request.contextTypes) || request.contextTypes.some(ctx => typeof ctx !== "string"))) {
+          throw new Error("Please provide the 'contextTypes' as an array of strings!");
+      }
+      if (typeof request.resultType !== "undefined" && typeof request.resultType !== "string") {
+          throw new Error("Please provide the 'resultType' as a string!");
+      }
+      if (typeof request.displayName !== "undefined" && typeof request.displayName !== "string") {
+          throw new Error("Please provide the 'displayName' as a string!");
+      }
+      if (typeof request.icon !== "undefined" && typeof request.icon !== "string") {
+          throw new Error("Please provide the 'icon' as a string!");
+      }
+      if (typeof request.description !== "undefined" && typeof request.description !== "string") {
+          throw new Error("Please provide the 'description' as a string!");
+      }
+      if (typeof request.customConfig !== "undefined" && (typeof request.customConfig !== "object" || Array.isArray(request.customConfig))) {
+          throw new Error("Please provide the 'customConfig' as an object!");
+      }
+  };
 
   class Intents {
       constructor(interop, windows, logger, options, prefsController, appsController) {
@@ -22964,7 +23017,8 @@
                       contextTypes: intentDef.contexts,
                       applicationIcon: app.icon,
                       type: "app",
-                      resultType: intentDef.resultType
+                      resultType: intentDef.resultType,
+                      customConfig: intentDef === null || intentDef === void 0 ? void 0 : intentDef.customConfig,
                   };
                   intent.handlers.push(handler);
               }
@@ -23045,9 +23099,7 @@
           return result;
       }
       async register(intent, handler) {
-          if ((typeof intent !== "string" && typeof intent !== "object") || (typeof intent === "object" && typeof intent.intent !== "string")) {
-              throw new Error("Please provide the intent as a string or an object with an intent property!");
-          }
+          validateAddIntentListenerRequest(intent);
           if (typeof handler !== "function") {
               throw new Error("Please provide the handler as a function!");
           }
@@ -23750,7 +23802,8 @@
               contextTypes: info.contextTypes || (appIntent === null || appIntent === void 0 ? void 0 : appIntent.contexts),
               instanceTitle: title,
               type: "instance",
-              resultType: (appIntent === null || appIntent === void 0 ? void 0 : appIntent.resultType) || info.resultType
+              resultType: (appIntent === null || appIntent === void 0 ? void 0 : appIntent.resultType) || info.resultType,
+              customConfig: info === null || info === void 0 ? void 0 : info.customConfig
           };
           return handler;
       }
@@ -23763,7 +23816,8 @@
               contextTypes: intent.contexts,
               applicationIcon: app.icon,
               type: "app",
-              resultType: intent.resultType
+              resultType: intent.resultType,
+              customConfig: intent === null || intent === void 0 ? void 0 : intent.customConfig
           };
       }
   }
@@ -24397,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) {
@@ -24410,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) {
@@ -24430,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 });
           }
       }
   }