@knime/hub-features 1.29.2 → 1.29.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @knime/hub-features
 
+## 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.29.3",
   "description": "Vue components & composables for shared hub features",
   "repository": {
     "type": "git",

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

@@ -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

@@ -79,7 +79,8 @@
         "deploymentSharedWorkflowAccessPanel",
         "deploymentSharedWorkflowSharingPopup",
         "nodeCreatedCanvasDragDropFile",
-        "nodeCreatedFloatingToolsAddByFile"
+        "nodeCreatedFloatingToolsAddByFile",
+        "nodeConfigFeedbackSubmitted"
       ],
       "properties": {
         "kaiPromptedQA": {
@@ -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"
+        }
+      }
     }
   }
 }