@interopio/desktop 6.16.2 → 6.17.0

package/changelog.md

@@ -1,3 +1,11 @@
+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
 - chore: apps: fix types and documentation
 6.16.1
@@ -5,7 +13,7 @@
 - fix: prefs - when calling `io.prefs.get()`, the returned object looks like an unparsed fetch response
 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

@@ -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 }>): void;
+            onShuttingDown(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean }>): UnsubscribeFunction;
         }
 
         /**
@@ -2506,7 +2506,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 }>): () => void;
+            onShuttingDown(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean }>): UnsubscribeFunction;
         }
 
         /**
@@ -3322,12 +3322,6 @@ 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.
-             */
-            timeout?: number;
-
             /**
              * Only if the type is `"Activity"`. If `true`, will try to reuse existing windows when restoring the Layout.
              * @default true
@@ -7936,6 +7930,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 +8109,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 };
         }
 
         /**
@@ -9013,7 +9019,7 @@ export declare namespace IOConnectDesktop {
             /**
              * Timestamp of the last update of the user preferences.
              */
-            lastUpdate?: string;
+            lastUpdate?: Date;
         }
     }
 

package/dist/desktop.browser.js

@@ -13650,7 +13650,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 +16881,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 +18453,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 +18467,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 +18603,7 @@
               const request = {
                   name,
                   type: "Global",
+                  timeout: INTEROP_METHOD_MAX_TIMEOUT_MS,
                   context,
                   ...options
               };
@@ -18750,7 +18752,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 +18841,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 +19522,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 +19554,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 +20093,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 +20106,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 +20467,7 @@
       }
   }
 
-  var version = "6.16.2";
+  var version = "6.17.0";
 
   var prepareConfig = (options) => {
       function getLibConfig(value, defaultMode, trueMode) {
@@ -21076,7 +21086,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 +21120,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 +22874,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 +23004,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 +23086,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 +23789,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 +23803,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
           };
       }
   }