@knime/hub-features 1.29.2 → 1.30.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/hub-features
 
+## 1.30.0
+
+### Minor Changes
+
+- 90a327b: Adjust cloudhome events
+
+## 1.29.3
+
+### Patch Changes
+
+- bd3fa29: Add event for node config feedback submission
+
 ## 1.29.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.29.2",
+  "version": "1.30.0",
   "description": "Vue components & composables for shared hub features",
   "repository": {
     "type": "git",
@@ -39,9 +39,9 @@
     "lodash-es": "4.18.1",
     "ofetch": "^1.4.1",
     "typescript": "^5.9.3",
-    "@knime/components": "1.46.7",
+    "@knime/utils": "1.11.1",
     "@knime/styles": "1.15.1",
-    "@knime/utils": "1.11.1"
+    "@knime/components": "1.46.7"
   },
   "peerDependencies": {
     "consola": "3.x",

package/src/analytics/schema/cloudhome-event-functions.ts

@@ -124,9 +124,9 @@ export const secretCreatedPersonalSecrets = <T extends DefaultContext>(ctx: T) =
 };
 
 /**
- * Fired when the user clicks the Create button in the deployment creation side panel
+ * Fired when the user clicks the Create button in the deployment creation side panel on the workflow details page
  */
-export const deploymentCreated = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentCreated">): AnalyticsEvent => {
+export const deploymentCreatedFromWorkflowDetails = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentCreatedFromWorkflowDetails">): AnalyticsEvent => {
   const staticData = {
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
@@ -136,7 +136,7 @@ export const deploymentCreated = <T extends DefaultContext>(ctx: T) => (eventDat
     event_display_name: "Deployment Created",
     interaction: {
       location: "contextual_side_panel",
-      page: "deployments",
+      page: "workflow_details",
       trigger: "user",
       type: "click",
     },

package/src/analytics/schema/editor-event-functions.ts

@@ -1117,3 +1117,26 @@ export const nodeCreatedFloatingToolsAddByFile = <T extends DefaultContext>(ctx:
   return event;
 };
 
+/**
+ * Fired when the user submits feedback for a node
+ */
+export const nodeConfigFeedbackSubmitted = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"nodeConfigFeedbackSubmitted">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "node_feedback_submitted",
+    event_source: "editor",
+    event_display_name: "Node Feedback Submitted",
+    interaction: {
+      location: "node_configuration",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+

package/src/analytics/schema/schema.d.ts

@@ -672,13 +672,13 @@ export interface AnalyticsEventSchema {
       };
       payload: ContainerNodeTypePayload;
     };
-    deploymentCreated: {
+    deploymentCreatedFromWorkflowDetails: {
       event_name: "deployment_created";
       event_source: "cloudhome";
       event_display_name: "Deployment Created";
       interaction: {
         location: "contextual_side_panel";
-        page: "deployments";
+        page: "workflow_details";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
       };
@@ -754,6 +754,17 @@ export interface AnalyticsEventSchema {
       };
       payload: NodeCreated_Base;
     };
+    nodeConfigFeedbackSubmitted: {
+      event_name: "node_feedback_submitted";
+      event_source: "editor";
+      event_display_name: "Node Feedback Submitted";
+      interaction: {
+        location: "node_configuration";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: NodeConfigFeedbackPayload;
+    };
   };
 }
 export interface KaiPromptedPayload {
@@ -832,3 +843,8 @@ export interface DeploymentSharedPayload {
   deploymentType: "dataApp" | "service";
   sharingMethod: "invite" | "copy_link";
 }
+export interface NodeConfigFeedbackPayload {
+  nodeFactoryId: string;
+  rating: number;
+  message?: string;
+}

package/src/analytics/schema/schema.json

@@ -73,13 +73,14 @@
         "containerNodeEnteredCtxMenu",
         "containerNodeExitedKeyboard",
         "containerNodeExitedToolbar",
-        "deploymentCreated",
+        "deploymentCreatedFromWorkflowDetails",
         "deploymentSharedDeploymentsAccessPanel",
         "deploymentSharedDeploymentsSharingPopup",
         "deploymentSharedWorkflowAccessPanel",
         "deploymentSharedWorkflowSharingPopup",
         "nodeCreatedCanvasDragDropFile",
-        "nodeCreatedFloatingToolsAddByFile"
+        "nodeCreatedFloatingToolsAddByFile",
+        "nodeConfigFeedbackSubmitted"
       ],
       "properties": {
         "kaiPromptedQA": {
@@ -3563,10 +3564,10 @@
             }
           }
         },
-        "deploymentCreated": {
+        "deploymentCreatedFromWorkflowDetails": {
           "type": "object",
           "additionalProperties": false,
-          "$comment": "Fired when the user clicks the Create button in the deployment creation side panel",
+          "$comment": "Fired when the user clicks the Create button in the deployment creation side panel on the workflow details page",
           "required": [
             "event_name",
             "event_source",
@@ -3598,7 +3599,7 @@
                 },
                 "page": {
                   "type": "string",
-                  "const": "deployments"
+                  "const": "workflow_details"
                 },
                 "trigger": {
                   "allOf": [
@@ -4000,6 +4001,66 @@
               "$ref": "#/definitions/NodeCreated_Base"
             }
           }
+        },
+        "nodeConfigFeedbackSubmitted": {
+          "type": "object",
+          "additionalProperties": false,
+          "$comment": "Fired when the user submits feedback for a node",
+          "required": [
+            "event_name",
+            "event_source",
+            "event_display_name",
+            "interaction",
+            "payload"
+          ],
+          "properties": {
+            "event_name": {
+              "type": "string",
+              "const": "node_feedback_submitted"
+            },
+            "event_source": {
+              "type": "string",
+              "const": "editor"
+            },
+            "event_display_name": {
+              "type": "string",
+              "const": "Node Feedback Submitted"
+            },
+            "interaction": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["location", "trigger", "type"],
+              "properties": {
+                "location": {
+                  "type": "string",
+                  "const": "node_configuration"
+                },
+                "trigger": {
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/InteractionTrigger"
+                    },
+                    {
+                      "const": "user"
+                    }
+                  ]
+                },
+                "type": {
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/InteractionType"
+                    },
+                    {
+                      "const": "click"
+                    }
+                  ]
+                }
+              }
+            },
+            "payload": {
+              "$ref": "#/definitions/NodeConfigFeedbackPayload"
+            }
+          }
         }
       }
     }
@@ -4336,6 +4397,24 @@
           "enum": ["timedout", "user_closed"]
         }
       }
+    },
+    "NodeConfigFeedbackPayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeFactoryId", "rating"],
+      "properties": {
+        "nodeFactoryId": {
+          "type": "string"
+        },
+        "rating": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 5
+        },
+        "message": {
+          "type": "string"
+        }
+      }
     }
   }
 }