@knime/hub-features 1.27.0 → 1.28.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/hub-features
 
+## 1.28.0
+
+### Minor Changes
+
+- 2908385: - split returned events based on event source (editor/cloudhome)
+  - add secret created event (cloudhome)
+  - introduce page property to interaction property (only for cloudhome events)
+
+### Patch Changes
+
+- a2f988b: add cloudhome events for creating and sharing deployments
+
 ## 1.27.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.27.0",
+  "version": "1.28.0",
   "description": "Vue components & composables for shared hub features",
   "repository": {
     "type": "git",
@@ -39,8 +39,8 @@
     "lodash-es": "4.18.1",
     "ofetch": "^1.4.1",
     "typescript": "^5.9.3",
-    "@knime/components": "1.46.6",
     "@knime/styles": "1.15.1",
+    "@knime/components": "1.46.6",
     "@knime/utils": "1.11.0"
   },
   "peerDependencies": {

package/src/analytics/analytics.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import * as functions from "./schema/event-functions";
+import * as cloudHomeFunctions from "./schema/cloudhome-event-functions";
+import * as editorFunctions from "./schema/editor-event-functions";
 import type {
   AnalyticsEvent,
   AnalyticsEventSender,
@@ -22,26 +23,51 @@ type UnwrapFunction<T> = T extends (ctx: DefaultContext) => infer R
     : never
   : never;
 
-type FunctionMap = typeof functions;
-type Names = keyof FunctionMap;
-type BuilderFunctions = {
-  [K in Names]: UnwrapFunction<(typeof functions)[K]>;
+type EditorFunctionMap = typeof editorFunctions;
+type CloudHomeFunctionMap = typeof cloudHomeFunctions;
+
+type EditorBuilderFunctions = {
+  [K in keyof EditorFunctionMap]: UnwrapFunction<EditorFunctionMap[K]>;
+};
+type CloudHomeBuilderFunctions = {
+  [K in keyof CloudHomeFunctionMap]: UnwrapFunction<CloudHomeFunctionMap[K]>;
 };
 
-type SenderFunctions = {
-  [K in Names]: (...args: Parameters<BuilderFunctions[K]>) => void;
+type EditorSenderFunctions = {
+  [K in keyof EditorBuilderFunctions]: (
+    ...args: Parameters<EditorBuilderFunctions[K]>
+  ) => void;
+};
+type CloudHomeSenderFunctions = {
+  [K in keyof CloudHomeBuilderFunctions]: (
+    ...args: Parameters<CloudHomeBuilderFunctions[K]>
+  ) => void;
 };
 
+type BuilderFunctions<T extends DefaultContext> =
+  T["eventSource"] extends "editor"
+    ? EditorBuilderFunctions
+    : CloudHomeBuilderFunctions;
+
+type SenderFunctions<T extends DefaultContext> =
+  T["eventSource"] extends "editor"
+    ? EditorSenderFunctions
+    : CloudHomeSenderFunctions;
+
 /**
  * This function creates an event builder, which lets you construct correct and strongly-typed
  * event payloads according to the current schema used by this package
  * @param context
  * @returns
  */
-function eventBuilder<T extends DefaultContext>(context: T) {
+function eventBuilder<T extends DefaultContext>(
+  context: T,
+): BuilderFunctions<T> {
   const unwrapped = Object.fromEntries(
-    Object.entries(functions).map(([name, fn]) => [name, fn(context)]),
-  ) as BuilderFunctions;
+    Object.entries(
+      context.eventSource === "editor" ? editorFunctions : cloudHomeFunctions,
+    ).map(([name, fn]) => [name, fn(context)]),
+  ) as BuilderFunctions<T>;
 
   return { ...unwrapped };
 }
@@ -67,12 +93,12 @@ export const analyticsEvents = Object.freeze({
 
     type AnyFn = (...args: any[]) => any;
 
-    const wrapper: SenderFunctions = {} as SenderFunctions;
+    const wrapper = {} as SenderFunctions<T>;
 
     // keep all the same functions of the builder but wrap around them for extra behavior
     Object.keys(builder).forEach((fnName) => {
-      const key = fnName as keyof SenderFunctions;
-      wrapper[key] = (...args: any[]) => {
+      const key = fnName as keyof SenderFunctions<T>;
+      (wrapper as any)[key] = (...args: any[]) => {
         // TS issue:
         // ```A spread argument must either have a tuple type or be passed to a rest parameter.```
         // This happens because when calling the methods generically, TS tries to join all function signatures

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

@@ -0,0 +1,247 @@
+ 
+/* eslint-disable camelcase */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// AUTO-GENERATED FILE. DO NOT EDIT.
+import type { AnalyticsEvent, DefaultContext, EventFunctionArgs, GeneratedStaticFields, SchemaStaticFields } from "../types";
+import { toSnakeCaseDeep } from "../utils/toSnakeCaseDeep";
+
+/**
+ * Fired when the user clicks Run from the deployments page
+ */
+export const adHocExecutionStartedDeploymentsPage = <T extends DefaultContext>(ctx: T) => (): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "adhoc_execution_started",
+    event_source: "cloudhome",
+    event_display_name: "Ad Hoc Execution Started",
+    interaction: {
+      location: "main_area",
+      page: "deployments",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData } };
+
+  return event;
+};
+
+/**
+ * Fired when the user clicks Run in the ad hoc execution panel
+ */
+export const adHocExecutionStartedExecutionPanel = <T extends DefaultContext>(ctx: T) => (): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "adhoc_execution_started",
+    event_source: "cloudhome",
+    event_display_name: "Ad Hoc Execution Started",
+    interaction: {
+      location: "contextual_side_panel",
+      page: "workflow_details",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData } };
+
+  return event;
+};
+
+/**
+ * Fired when the user clicks Run from the workflow page
+ */
+export const adHocExecutionStartedWorkflowPage = <T extends DefaultContext>(ctx: T) => (): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "adhoc_execution_started",
+    event_source: "cloudhome",
+    event_display_name: "Ad Hoc Execution Started",
+    interaction: {
+      location: "main_area",
+      page: "workflow_details",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData } };
+
+  return event;
+};
+
+/**
+ * Fired when the user creates a new secret by clicking Create in the side panel on the team secrets page
+ */
+export const secretCreatedTeamSecrets = <T extends DefaultContext>(ctx: T) => (): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "secret_created",
+    event_source: "cloudhome",
+    event_display_name: "Secret Created",
+    interaction: {
+      location: "contextual_side_panel",
+      page: "secrets",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData } };
+
+  return event;
+};
+
+/**
+ * Fired when the user creates a new secret by clicking Create in the side panel on the personal secrets page
+ */
+export const secretCreatedMySecrets = <T extends DefaultContext>(ctx: T) => (): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "secret_created",
+    event_source: "cloudhome",
+    event_display_name: "Secret Created",
+    interaction: {
+      location: "contextual_side_panel",
+      page: "my_secrets",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData } };
+
+  return event;
+};
+
+/**
+ * Fired when the user clicks the Create button in the deployment creation side panel
+ */
+export const deploymentCreated = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentCreated">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "deployment_created",
+    event_source: "cloudhome",
+    event_display_name: "Deployment Created",
+    interaction: {
+      location: "contextual_side_panel",
+      page: "deployments",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+
+/**
+ * Fired when the user shares a deployment via the access management side panel on the deployments page
+ */
+export const deploymentSharedDeploymentsAccessPanel = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentSharedDeploymentsAccessPanel">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "deployment_shared",
+    event_source: "cloudhome",
+    event_display_name: "Deployment Shared",
+    interaction: {
+      location: "contextual_side_panel",
+      page: "deployments",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+
+/**
+ * Fired when the user shares a deployment via the sharing popup on the deployments page
+ */
+export const deploymentSharedDeploymentsSharingPopup = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentSharedDeploymentsSharingPopup">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "deployment_shared",
+    event_source: "cloudhome",
+    event_display_name: "Deployment Shared",
+    interaction: {
+      location: "module",
+      page: "deployments",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+
+/**
+ * Fired when the user shares a deployment via the access management side panel on the workflow page
+ */
+export const deploymentSharedWorkflowAccessPanel = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentSharedWorkflowAccessPanel">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "deployment_shared",
+    event_source: "cloudhome",
+    event_display_name: "Deployment Shared",
+    interaction: {
+      location: "contextual_side_panel",
+      page: "workflow_details",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+
+/**
+ * Fired when the user shares a deployment via the sharing popup on the workflow page
+ */
+export const deploymentSharedWorkflowSharingPopup = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"deploymentSharedWorkflowSharingPopup">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "deployment_shared",
+    event_source: "cloudhome",
+    event_display_name: "Deployment Shared",
+    interaction: {
+      location: "module",
+      page: "workflow_details",
+      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/code-generator.js

@@ -4,7 +4,11 @@ import { fileURLToPath } from "node:url";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const schemaPath = path.join(__dirname, "schema.json");
-const outputPath = path.join(__dirname, "event-functions.ts");
+const editorOutputPath = path.join(__dirname, "editor-event-functions.ts");
+const cloudHomeOutputPath = path.join(
+  __dirname,
+  "cloudhome-event-functions.ts",
+);
 
 const schema = JSON.parse(fs.readFileSync(schemaPath, "utf8"));
 const events = schema.properties.events.properties;
@@ -25,7 +29,8 @@ const HEADER_LINES = [
   `import type { ${Object.values(TYPE_HELPERS).join(", ")} } from "../types";`,
   'import { toSnakeCaseDeep } from "../utils/toSnakeCaseDeep";',
 ];
-const result = [];
+const editorResult = [];
+const cloudHomeResult = [];
 
 /**
  * Generic event definition, read from the schema.json.
@@ -137,11 +142,17 @@ for (const [fnName, eventDef] of Object.entries(events)) {
     fn = `${jsdoc}\n${fn}`;
   }
 
-  result.push(fn);
+  if (eventDef.properties.event_source.const === "editor") {
+    editorResult.push(fn);
+  } else if (eventDef.properties.event_source.const === "cloudhome") {
+    cloudHomeResult.push(fn);
+  }
 }
 
-const fileContent = `${HEADER_LINES.join("\n")}\n\n${result.join("")}`;
+const editorFileContent = `${HEADER_LINES.join("\n")}\n\n${editorResult.join("")}`;
+const cloudHomeFileContent = `${HEADER_LINES.join("\n")}\n\n${cloudHomeResult.join("")}`;
 
-fs.writeFileSync(outputPath, fileContent, "utf8");
+fs.writeFileSync(editorOutputPath, editorFileContent, "utf8");
+fs.writeFileSync(cloudHomeOutputPath, cloudHomeFileContent, "utf8");
 // eslint-disable-next-line no-console
 console.log("Generated static data based on the Events JSON Schema.");

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

@@ -422,6 +422,42 @@ export interface AnalyticsEventSchema {
       };
       payload: EmptyPayload;
     };
+    adHocExecutionStartedDeploymentsPage: {
+      event_name: "adhoc_execution_started";
+      event_source: "cloudhome";
+      event_display_name: "Ad Hoc Execution Started";
+      interaction: {
+        location: "main_area";
+        page: "deployments";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: EmptyPayload;
+    };
+    adHocExecutionStartedExecutionPanel: {
+      event_name: "adhoc_execution_started";
+      event_source: "cloudhome";
+      event_display_name: "Ad Hoc Execution Started";
+      interaction: {
+        location: "contextual_side_panel";
+        page: "workflow_details";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: EmptyPayload;
+    };
+    adHocExecutionStartedWorkflowPage: {
+      event_name: "adhoc_execution_started";
+      event_source: "cloudhome";
+      event_display_name: "Ad Hoc Execution Started";
+      interaction: {
+        location: "main_area";
+        page: "workflow_details";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: EmptyPayload;
+    };
     actionRedoneToolbar: {
       event_name: "action_redone";
       event_source: "editor";
@@ -455,6 +491,30 @@ export interface AnalyticsEventSchema {
       };
       payload: EmptyPayload;
     };
+    secretCreatedTeamSecrets: {
+      event_name: "secret_created";
+      event_source: "cloudhome";
+      event_display_name: "Secret Created";
+      interaction: {
+        location: "contextual_side_panel";
+        page: "secrets";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: EmptyPayload;
+    };
+    secretCreatedMySecrets: {
+      event_name: "secret_created";
+      event_source: "cloudhome";
+      event_display_name: "Secret Created";
+      interaction: {
+        location: "contextual_side_panel";
+        page: "my_secrets";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: EmptyPayload;
+    };
     sessionEnded: {
       event_name: "session_ended";
       event_source: "editor";
@@ -612,6 +672,66 @@ export interface AnalyticsEventSchema {
       };
       payload: ContainerNodeTypePayload;
     };
+    deploymentCreated: {
+      event_name: "deployment_created";
+      event_source: "cloudhome";
+      event_display_name: "Deployment Created";
+      interaction: {
+        location: "contextual_side_panel";
+        page: "deployments";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: DeploymentCreatedPayload;
+    };
+    deploymentSharedDeploymentsAccessPanel: {
+      event_name: "deployment_shared";
+      event_source: "cloudhome";
+      event_display_name: "Deployment Shared";
+      interaction: {
+        location: "contextual_side_panel";
+        page: "deployments";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: DeploymentSharedPayload;
+    };
+    deploymentSharedDeploymentsSharingPopup: {
+      event_name: "deployment_shared";
+      event_source: "cloudhome";
+      event_display_name: "Deployment Shared";
+      interaction: {
+        location: "module";
+        page: "deployments";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: DeploymentSharedPayload;
+    };
+    deploymentSharedWorkflowAccessPanel: {
+      event_name: "deployment_shared";
+      event_source: "cloudhome";
+      event_display_name: "Deployment Shared";
+      interaction: {
+        location: "contextual_side_panel";
+        page: "workflow_details";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: DeploymentSharedPayload;
+    };
+    deploymentSharedWorkflowSharingPopup: {
+      event_name: "deployment_shared";
+      event_source: "cloudhome";
+      event_display_name: "Deployment Shared";
+      interaction: {
+        location: "module";
+        page: "workflow_details";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: DeploymentSharedPayload;
+    };
     nodeCreatedCanvasDragDropFile: {
       event_name: "node_created";
       event_source: "editor";
@@ -687,7 +807,6 @@ export interface SearchPayload {
 }
 export interface SessionEndedPayload {
   type: "timedout" | "user_closed";
-  [k: string]: unknown;
 }
 export interface ContainerNodeCreatedPayload {
   nodeType: "component" | "metanode";
@@ -706,3 +825,10 @@ export interface ConfigurationCompletedPayload {
 export interface ContainerNodeTypePayload {
   nodeType: "component" | "metanode";
 }
+export interface DeploymentCreatedPayload {
+  deploymentType: "dataApp" | "schedule" | "service";
+}
+export interface DeploymentSharedPayload {
+  deploymentType: "dataApp" | "service";
+  sharingMethod: "invite" | "copy_link";
+}