@knime/hub-features 1.27.0 → 1.29.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @knime/hub-features
 
+## 1.29.0
+
+### Minor Changes
+
+- da43d97: Migrate from versions:
+
+  - `ManageVersions` component -> KDS `VersionHistory` component
+  - `CreateVersionForm` component -> KDS `CreateVersionForm` component
+  - `useVersionsApi` composable -> knime-ui `useVersionsApi` composable
+
+  Add new export to `hub-features` - `httpClient` - moved from `hub-features/common`.
+
+### Patch Changes
+
+- ee02850: Minor changes to analytics event:
+
+  - rename from "my" secrets to "personal" secrets in cloud home events
+  - made the location value `noderepository` into `node_repository` in editor events to be more consistent with others
+  - deambiguate events for annotation created and annotation explain via kai
+
+## 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.29.0",
   "description": "Vue components & composables for shared hub features",
   "repository": {
     "type": "git",
@@ -24,11 +24,11 @@
     ".": {
       "import": "./src/index.ts"
     },
-    "./versions": {
-      "import": "./src/components/versions/index.ts"
-    },
     "./analytics": {
       "import": "./src/analytics/index.ts"
+    },
+    "./http-client": {
+      "import": "./src/httpClient/index.ts"
     }
   },
   "dependencies": {

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,245 @@
+/* eslint-disable */
+// 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: "team_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 secretCreatedPersonalSecrets = <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: "personal_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: "popup",
+      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: "popup",
+      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;
@@ -18,14 +22,13 @@ const TYPE_HELPERS = {
 };
 
 const HEADER_LINES = [
-  "/* eslint-disable max-lines */",
-  "/* eslint-disable camelcase */",
-  "/* eslint-disable @typescript-eslint/no-explicit-any */",
+  "/* eslint-disable */",
   "// AUTO-GENERATED FILE. DO NOT EDIT.",
   `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 +140,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/{event-functions.ts → editor-event-functions.ts}

@@ -1,6 +1,4 @@
-/* eslint-disable max-lines */
-/* eslint-disable camelcase */
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable */
 // AUTO-GENERATED FILE. DO NOT EDIT.
 import type { AnalyticsEvent, DefaultContext, EventFunctionArgs, GeneratedStaticFields, SchemaStaticFields } from "../types";
 import { toSnakeCaseDeep } from "../utils/toSnakeCaseDeep";
@@ -177,7 +175,7 @@ export const annotationCreatedKaiExplain = <T extends DefaultContext>(ctx: T) =>
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "annotation_created",
+    event_name: "annotation_created_kai_explain",
     event_source: "editor",
     event_display_name: "Annotation Created",
     interaction: {
@@ -303,7 +301,7 @@ export const nodeCreatedNodeRepoDragDrop = <T extends DefaultContext>(ctx: T) =>
     event_source: "editor",
     event_display_name: "Node Created",
     interaction: {
-      location: "noderepository",
+      location: "node_repository",
       trigger: "user",
       type: "drag_drop",
     },
@@ -323,7 +321,7 @@ export const nodeCreatedNodeRepoDoubleClick = <T extends DefaultContext>(ctx: T)
     event_source: "editor",
     event_display_name: "Node Created",
     interaction: {
-      location: "noderepository",
+      location: "node_repository",
       trigger: "user",
       type: "double_click",
     },
@@ -343,7 +341,7 @@ export const nodeCreatedNodeRepoKeyboard = <T extends DefaultContext>(ctx: T) =>
     event_source: "editor",
     event_display_name: "Node Created",
     interaction: {
-      location: "noderepository",
+      location: "node_repository",
       trigger: "user",
       type: "key_press",
     },
@@ -544,7 +542,7 @@ export const nodeSearchedNodeRepo = <T extends DefaultContext>(ctx: T) => (event
     event_source: "editor",
     event_display_name: "Node Searched",
     interaction: {
-      location: "noderepository",
+      location: "node_repository",
       trigger: "user",
       type: "key_press",
     },
@@ -604,7 +602,7 @@ export const nodeRepositoryOpened = <T extends DefaultContext>(ctx: T) => (): An
     event_source: "editor",
     event_display_name: "Node Repository Opened",
     interaction: {
-      location: "noderepository",
+      location: "node_repository",
       trigger: "user",
       type: "click",
     },