@knime/hub-features 1.17.1 → 1.18.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/hub-features
 
+## 1.18.1
+
+### Patch Changes
+
+- d9aeb5f: add property to embedding context to determine if analytics can be used
+
+## 1.18.0
+
+### Minor Changes
+
+- 22473f0: Add analytics generic event to embedding SDK
+
 ## 1.17.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.17.1",
+  "version": "1.18.1",
   "description": "Vue components & composables for shared hub features",
   "repository": {
     "type": "git",

package/src/embeddingSDK/guest.ts

@@ -53,6 +53,8 @@ const defaultvalidator: EmbeddingContextValidator = () => ({
   error: null,
 });
 
+const PARENT_ORIGIN = "*";
+
 /**
  * Wait for host application to send a message containing the embedding context
  */
@@ -98,19 +100,25 @@ export const waitForContext = (
 
   // send message to parent after postmessage listener has been set-up
   logger().info("Awaiting to receive embedding context");
-  window.parent.postMessage({ type: MESSAGES.AWAITING_EMBEDDING_CONTEXT }, "*");
+  window.parent.postMessage(
+    { type: MESSAGES.AWAITING_EMBEDDING_CONTEXT },
+    PARENT_ORIGIN,
+  );
 
   return promise;
 };
 
 export const sendEmbeddingFailureMessage = (error: unknown) => {
-  window.parent.postMessage({ type: MESSAGES.EMBEDDING_FAILED, error }, "*");
+  window.parent.postMessage(
+    { type: MESSAGES.EMBEDDING_FAILED, error },
+    PARENT_ORIGIN,
+  );
 };
 
 export const dispatchGenericEventToHost = (event: GenericEvent) => {
   window.parent.postMessage(
     { type: MESSAGES.GENERIC_EVENT, payload: event },
-    "*",
+    PARENT_ORIGIN,
   );
 };
 
@@ -119,6 +127,6 @@ export const notifyActivityChange = (userActivityInfo: UserActivityInfo) => {
 
   window.parent.postMessage(
     { type: MESSAGES.USER_ACTIVITY, payload: userActivityInfo },
-    "*",
+    PARENT_ORIGIN,
   );
 };

package/src/embeddingSDK/types.ts

@@ -8,7 +8,9 @@ export type EmbeddingContext = {
   wsConnectionUri: string;
   /**
    * @deprecated URI of the WS used by the embedded application.
-   * Last used in AP 5.8.0
+   * Last used in AP 5.8.0. From 5.9.0 and onwards `wsConnectionUri` is preferred.
+   * Although, the AP still references the url for compatibility with older embedders
+   * that don't use the new property `wsConnectionUri`
    */
   url?: string;
   /**
@@ -32,6 +34,10 @@ export type EmbeddingContext = {
    * are being made on the page
    */
   userIdleTimeout?: number;
+  /**
+   * Whether the embedded application can send analytic and tracking events
+   */
+  enableAnalytics?: boolean;
 };
 
 type ShowNotificationEvent = {
@@ -56,10 +62,20 @@ type HostNavigationRequestEvent = {
     | { intent: "navigate"; href: string; openIn: "_blank" | "_parent" };
 };
 
+type AnalyticsEvent = {
+  kind: "analytics";
+  payload: {
+    category: string;
+    name: string;
+    data: unknown;
+  };
+};
+
 export type GenericEvent =
   | ShowNotificationEvent
   | ClearNotificationEvent
-  | HostNavigationRequestEvent;
+  | HostNavigationRequestEvent
+  | AnalyticsEvent;
 
 export type GenericEventByKind<K extends GenericEvent["kind"]> = Extract<
   GenericEvent,