@knime/hub-features 1.22.4 → 1.24.0

package/src/analytics/schema/schema.json

@@ -0,0 +1,472 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "inmemory://schemas/analytics-events.json",
+  "title": "AnalyticsEventSchema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["version", "events"],
+  "properties": {
+    "version": {
+      "$comment": "Version of this document",
+      "type": "string",
+      "const": "v1.0"
+    },
+    "events": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kai_prompted",
+        "layouteditor_opened",
+        "annotation_created",
+        "workflow_saved",
+        "connection_created",
+        "node_created",
+        "qam_opened",
+        "node_searched",
+        "sidepanel_opened",
+        "action_undone",
+        "action_redone"
+      ],
+      "properties": {
+        "kai_prompted": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kaiqa_button_", "kaibuild_button_", "qam_button_"],
+          "properties": {
+            "kaiqa_button_": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "kaibuild_button_": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "qam_button_": {
+              "$ref": "#/definitions/KaiPromptedPayload"
+            }
+          }
+        },
+        "layouteditor_opened": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "canvas_ctxmenu_openlayouteditor",
+            "keyboard_shortcut_openlayouteditor",
+            "wftoolbar_button_openlayouteditor"
+          ],
+          "properties": {
+            "canvas_ctxmenu_openlayouteditor": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "keyboard_shortcut_openlayouteditor": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "wftoolbar_button_openlayouteditor": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        },
+        "annotation_created": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "canvas_ctxmenu_newannotation",
+            "canvas_ctxmenu_kaiexplain"
+          ],
+          "properties": {
+            "canvas_ctxmenu_newannotation": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "canvas_ctxmenu_kaiexplain": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        },
+        "workflow_saved": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["wftoolbar_button_save", "keyboard_shortcut_savewf"],
+          "properties": {
+            "wftoolbar_button_save": {
+              "$ref": "#/definitions/WorkflowSavedPayload"
+            },
+            "keyboard_shortcut_savewf": {
+              "$ref": "#/definitions/WorkflowSavedPayload"
+            }
+          }
+        },
+        "connection_created": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "port_dragdrop_fwd",
+            "port_dragdrop_bwd",
+            "keyboard_shortcut_connectnodes",
+            "keyboard_shortcut_connectflowvar",
+            "canvas_ctxmenu_connectnodes",
+            "canvas_ctxmenu_connectflowvar"
+          ],
+          "properties": {
+            "port_dragdrop_fwd": {
+              "$ref": "#/definitions/ConnectionCreatedPayload"
+            },
+            "port_dragdrop_bwd": {
+              "$ref": "#/definitions/ConnectionCreatedPayload"
+            },
+            "keyboard_shortcut_connectnodes": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "keyboard_shortcut_connectflowvar": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "canvas_ctxmenu_connectnodes": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "canvas_ctxmenu_connectflowvar": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        },
+        "node_created": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "noderepo_dragdrop_",
+            "noderepo_doubleclick_",
+            "noderepo_keyboard_enter",
+            "explorer_dragdrop_",
+            "qam_click_",
+            "qam_keyboard_enter",
+            "kaiqa_dragdrop_",
+            "kaiqa_keyboard_enter"
+          ],
+          "properties": {
+            "noderepo_dragdrop_": {
+              "$ref": "#/definitions/NodeCreated_Base"
+            },
+            "noderepo_doubleclick_": {
+              "$ref": "#/definitions/NodeCreated_WithOptionalConnectedTo"
+            },
+            "noderepo_keyboard_enter": {
+              "$ref": "#/definitions/NodeCreated_WithOptionalConnectedTo"
+            },
+            "explorer_dragdrop_": {
+              "$ref": "#/definitions/NodeCreated_Base"
+            },
+            "qam_click_": {
+              "$ref": "#/definitions/NodeCreated_WithOptionalConnectedToPorts"
+            },
+            "qam_keyboard_enter": {
+              "$ref": "#/definitions/NodeCreated_WithOptionalConnectedToPorts"
+            },
+            "kaiqa_dragdrop_": {
+              "$ref": "#/definitions/NodeCreated_Base"
+            },
+            "kaiqa_keyboard_enter": {
+              "$ref": "#/definitions/NodeCreated_Base"
+            }
+          }
+        },
+        "qam_opened": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "port_dragdrop_fwd",
+            "port_dragdrop_bwd",
+            "canvas_doubleclick_",
+            "keyboard_shortcut_",
+            "canvas_ctxmenu_quickaddnode"
+          ],
+          "properties": {
+            "port_dragdrop_fwd": {
+              "$ref": "#/definitions/QAMOpened_Payload"
+            },
+            "port_dragdrop_bwd": {
+              "$ref": "#/definitions/QAMOpened_Payload"
+            },
+            "canvas_doubleclick_": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "keyboard_shortcut_": {
+              "$ref": "#/definitions/QAMOpened_PartialPayload"
+            },
+            "canvas_ctxmenu_quickaddnode": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        },
+        "node_searched": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["noderepo_type_", "qam_type_"],
+          "properties": {
+            "noderepo_type_": {
+              "$ref": "#/definitions/SearchPayload"
+            },
+            "qam_type_": {
+              "$ref": "#/definitions/SearchPayload"
+            }
+          }
+        },
+        "sidepanel_opened": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "sidepanel_click_info",
+            "sidepanel_click_noderepo",
+            "sidepanel_click_explorer",
+            "sidepanel_click_kai",
+            "sidepanel_click_monitor",
+            "wftoolbar_dropdownmenu_versionhistory"
+          ],
+          "properties": {
+            "sidepanel_click_info": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "sidepanel_click_noderepo": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "sidepanel_click_explorer": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "sidepanel_click_kai": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "sidepanel_click_monitor": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "wftoolbar_dropdownmenu_versionhistory": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        },
+        "action_undone": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["wftoolbar_button_", "keyboard_shortcut_"],
+          "properties": {
+            "wftoolbar_button_": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "keyboard_shortcut_": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        },
+        "action_redone": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["wftoolbar_button_", "keyboard_shortcut_"],
+          "properties": {
+            "wftoolbar_button_": {
+              "$ref": "#/definitions/EmptyPayload"
+            },
+            "keyboard_shortcut_": {
+              "$ref": "#/definitions/EmptyPayload"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "EmptyPayload": {
+      "type": "null",
+      "additionalProperties": false,
+      "maxProperties": 0
+    },
+    "WorkflowSavedPayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["isAutosyncEnabled"],
+      "properties": {
+        "isAutosyncEnabled": {
+          "type": "boolean"
+        }
+      }
+    },
+    "ConnectionCreated_NodePayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeType", "nodePortIndex", "nodePortId"],
+      "properties": {
+        "nodeType": {
+          "type": "string",
+          "enum": ["node", "component", "metanode"]
+        },
+        "nodePortIndex": {
+          "type": "number"
+        },
+        "nodePortId": {
+          "type": "string"
+        },
+        "nodeFactoryId": {
+          "type": "string"
+        }
+      }
+    },
+    "ConnectionCreatedPayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["fromNode", "toNode"],
+      "properties": {
+        "fromNode": {
+          "$ref": "#/definitions/ConnectionCreated_NodePayload"
+        },
+        "toNode": {
+          "$ref": "#/definitions/ConnectionCreated_NodePayload"
+        }
+      }
+    },
+    "KaiPromptedPayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "nodeFactoryId": {
+          "type": "string"
+        },
+        "nodeType": {
+          "type": "string",
+          "enum": ["node", "component", "metanode"]
+        }
+      }
+    },
+    "NodeOrComponent": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "nodeFactoryId": {
+          "type": "string",
+          "$comment": "asdasd"
+        },
+        "nodeHubId": {
+          "type": "string"
+        }
+      }
+    },
+    "NodeCreated_Common": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeType"],
+      "properties": {
+        "nodeType": {
+          "type": "string",
+          "enum": ["node", "component"]
+        }
+      }
+    },
+    "ConnectedTo_Basic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeType", "nodeFactoryId"],
+      "properties": {
+        "nodeType": {
+          "type": "string",
+          "enum": ["node", "component", "metanode"]
+        },
+        "nodeFactoryId": {
+          "type": "string"
+        }
+      }
+    },
+    "ConnectedTo_WithPorts": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeType", "nodeFactoryId"],
+      "properties": {
+        "nodeType": {
+          "type": "string",
+          "enum": ["node", "component", "metanode"]
+        },
+        "nodeFactoryId": {
+          "type": "string"
+        },
+        "nodePortIndex": {
+          "type": "number"
+        },
+        "nodePortId": {
+          "type": "string"
+        }
+      }
+    },
+    "NodeCreated_Base": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/NodeCreated_Common"
+        },
+        {
+          "$ref": "#/definitions/NodeOrComponent"
+        }
+      ]
+    },
+    "NodeCreated_WithOptionalConnectedTo": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/NodeCreated_Common"
+        },
+        {
+          "$ref": "#/definitions/NodeOrComponent"
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "connectedTo": {
+              "$ref": "#/definitions/ConnectedTo_Basic"
+            }
+          }
+        }
+      ]
+    },
+    "NodeCreated_WithOptionalConnectedToPorts": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/NodeCreated_Common"
+        },
+        {
+          "$ref": "#/definitions/NodeOrComponent"
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "connectedTo": {
+              "$ref": "#/definitions/ConnectedTo_WithPorts"
+            }
+          }
+        }
+      ]
+    },
+    "QAMOpened_Payload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["connectedTo"],
+      "properties": {
+        "connectedTo": {
+          "$ref": "#/definitions/ConnectedTo_WithPorts"
+        }
+      }
+    },
+    "QAMOpened_PartialPayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "connectedTo": {
+          "$ref": "#/definitions/ConnectedTo_WithPorts"
+        }
+      }
+    },
+    "SearchPayload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["repoType", "keyword"],
+      "properties": {
+        "repoType": {
+          "type": "string",
+          "enum": ["node", "component"]
+        },
+        "keyword": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/src/analytics/types.ts

@@ -0,0 +1,62 @@
+import type { AnalyticsEventSchema } from "./schema/schema";
+
+export const SEPARATOR = "::";
+type Separator = typeof SEPARATOR;
+
+type EventDefinitions = AnalyticsEventSchema["events"];
+
+/**
+ * Group names (top-level keys in `events`, e.g. "kai_prompted").
+ */
+type GroupName = keyof EventDefinitions;
+
+/**
+ * Event names in the flattened "group::event" form. This makes event calls
+ * single keys using the `::` separator (for example "kai_prompted::kaiqa_button_prompt").
+ */
+export type EventNames = {
+  [G in GroupName]: `${G}${Separator}${keyof EventDefinitions[G] & string}`;
+}[GroupName];
+
+export type Metadata = Omit<AnalyticsEventSchema, "events">;
+
+export type Context = { jobId: string };
+
+/**
+ * Resolve the payload type for a flattened event name like
+ * "group::eventKey". If the referenced payload is `null`, the args are
+ * just the type; otherwise a payload must be provided.
+ */
+type PayloadFor<KN extends EventNames> =
+  KN extends `${infer G}${Separator}${infer E}`
+    ? G extends GroupName
+      ? E extends keyof EventDefinitions[G]
+        ? EventDefinitions[G][E]
+        : never
+      : never
+    : never;
+
+type EventArgs<K extends EventNames> =
+  PayloadFor<K> extends null
+    ? { id: K; payload?: never }
+    : { id: K; payload: PayloadFor<K> };
+
+export type AnalyticsPayload = {
+  id: string;
+  data: unknown;
+};
+
+export type CreateEventFn<TReturn = void> = <K extends EventNames>(
+  args: EventArgs<K>,
+) => TReturn;
+
+export interface AnalyticsAdapter {
+  /**
+   * Function to send the event according to the API the adapter is implementing
+   */
+  sendEvent: (params: {
+    idParser: (id: string) => { category: string; action: string };
+    event: AnalyticsPayload;
+    metadata: Metadata;
+  }) => void;
+}

package/src/analytics/utils/eventIds.ts

@@ -0,0 +1,35 @@
+import { SEPARATOR } from "../types";
+
+const isValid = (id: string) => id.includes(SEPARATOR);
+
+/**
+ * Parses the given event id, splitting it by a known separator. Each id is expected to have
+ * two components to it: The event category and a specific action within that category
+ * @returns
+ * @throws when id format is invalid
+ */
+const parse = (id: string): { category: string; action: string } => {
+  if (!isValid(id)) {
+    throw new Error(`Cannot parse event id. Invalid format found: ${id}`);
+  }
+
+  const out = id.split(SEPARATOR);
+
+  if (out.length !== 2) {
+    throw new Error(`Cannot parse event id. Invalid format found: ${id}`);
+  }
+
+  const [category, action] = out;
+  return { category, action };
+};
+
+export const eventID = (id: string) => ({
+  isValid: () => isValid(id),
+  /**
+   * Parses the given event id, splitting it by a known separator. Each id is expected to have
+   * two components to it: The event category and a specific action within that category
+   * @returns
+   * @throws when id format is invalid
+   */
+  parse: () => parse(id),
+});

package/src/analytics/utils/toSnakeCaseDeep.ts

@@ -0,0 +1,33 @@
+// eslint-disable-next-line depend/ban-dependencies
+import { snakeCase } from "lodash-es";
+
+const isPlainObject = (value: unknown): value is Record<string, unknown> => {
+  return (
+    typeof value === "object" &&
+    value !== null &&
+    Object.getPrototypeOf(value) === Object.prototype
+  );
+};
+
+/**
+ * Deeply converts all properties in the given object from camelCase to snake_case.
+ */
+export const toSnakeCaseDeep = (object: Partial<Record<string, unknown>>) =>
+  Object.entries(object).reduce(
+    (acc, [rawKey, rawValue]) => {
+      const key = rawKey.toString();
+
+      if (isPlainObject(rawValue)) {
+        acc[snakeCase(key)] = toSnakeCaseDeep(rawValue);
+      } else if (Array.isArray(rawValue)) {
+        acc[snakeCase(key)] = rawValue.map((v) =>
+          isPlainObject(v) ? toSnakeCaseDeep(v) : v,
+        );
+      } else {
+        acc[snakeCase(key)] = rawValue;
+      }
+
+      return acc;
+    },
+    {} as Record<string, unknown>,
+  );