@knime/hub-features 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/hub-features
 
+## 2.2.0
+
+### Minor Changes
+
+- a10caa6: Add `applyAndExecuteNodeConfigKeyboard` analytics event — a keyboard-shortcut variant of `applyAndExecuteNodeConfig` (same `node_executed` event with `interaction.type` set to `shortcut` instead of `click`).
+
+## 2.1.2
+
+### Patch Changes
+
+- fd37cd4: adjust casing for event payload properties
+
 ## 2.1.1
 
 ### Patch Changes

package/package.json

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

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

@@ -959,6 +959,30 @@ export const applyAndExecuteNodeConfig = <T extends DefaultContext>(ctx: T) => (
   return event;
 };
 
+/**
+ * Fired when the user triggers Apply and Execute in the node configuration panel via keyboard shortcut
+ */
+export const applyAndExecuteNodeConfigKeyboard = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"applyAndExecuteNodeConfigKeyboard">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "node_executed",
+    event_source: "editor",
+    event_display_name: "Node executed",
+    interaction: {
+      location: "node_configuration",
+      specification: "apply_and_execute",
+      trigger: "user",
+      type: "shortcut",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+
 /**
  * Fired when the user clicks Execute in the node configuration panel
  */

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

@@ -629,6 +629,18 @@ export interface AnalyticsEventSchema {
       };
       payload: NodeExecutionPayload;
     };
+    applyAndExecuteNodeConfigKeyboard: {
+      event_name: "node_executed";
+      event_source: "editor";
+      event_display_name: "Node executed";
+      interaction: {
+        location: "node_configuration";
+        specification?: "apply_and_execute";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "shortcut";
+      };
+      payload: NodeExecutionPayload;
+    };
     executeNodeConfig: {
       event_name: "node_executed";
       event_source: "editor";
@@ -1181,11 +1193,11 @@ export interface HintIdPayload {
   hintId: string;
 }
 export interface NodeExecutionPayload {
-  nodes_executed: {
+  nodesExecuted: {
     nodeType: "node" | "component" | "metanode";
     nodeFactoryId?: string;
   }[];
-  total_executed_nodes: number;
+  totalExecutedNodes: number;
 }
 export interface ConfigurationCompletedPayload {
   nodeFactoryId?: string;

package/src/analytics/schema/schema.json

@@ -16,6 +16,7 @@
       "additionalProperties": false,
       "required": [
         "applyAndExecuteNodeConfig",
+        "applyAndExecuteNodeConfigKeyboard",
         "executeNodeConfig",
         "kaiPromptedQA",
         "kaiPromptedBuild",
@@ -3364,6 +3365,70 @@
             }
           }
         },
+        "applyAndExecuteNodeConfigKeyboard": {
+          "type": "object",
+          "additionalProperties": false,
+          "$comment": "Fired when the user triggers Apply and Execute in the node configuration panel via keyboard shortcut",
+          "required": [
+            "event_name",
+            "event_source",
+            "event_display_name",
+            "interaction",
+            "payload"
+          ],
+          "properties": {
+            "event_name": {
+              "type": "string",
+              "const": "node_executed"
+            },
+            "event_source": {
+              "type": "string",
+              "const": "editor"
+            },
+            "event_display_name": {
+              "type": "string",
+              "const": "Node executed"
+            },
+            "interaction": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["location", "trigger", "type"],
+              "properties": {
+                "location": {
+                  "type": "string",
+                  "const": "node_configuration"
+                },
+                "specification": {
+                  "type": "string",
+                  "const": "apply_and_execute"
+                },
+                "trigger": {
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/InteractionTrigger"
+                    },
+                    {
+                      "const": "user"
+                    }
+                  ]
+                },
+                "type": {
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/InteractionType"
+                    },
+                    {
+                      "const": "shortcut"
+                    }
+                  ]
+                }
+              }
+            },
+            "payload": {
+              "$ref": "#/definitions/NodeExecutionPayload"
+            }
+          }
+        },
         "executeNodeConfig": {
           "type": "object",
           "additionalProperties": false,
@@ -6340,9 +6405,9 @@
     "NodeExecutionPayload": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["nodes_executed", "total_executed_nodes"],
+      "required": ["nodesExecuted", "totalExecutedNodes"],
       "properties": {
-        "nodes_executed": {
+        "nodesExecuted": {
           "type": "array",
           "items": {
             "type": "object",
@@ -6359,7 +6424,7 @@
             }
           }
         },
-        "total_executed_nodes": {
+        "totalExecutedNodes": {
           "type": "number"
         }
       }