@knime/hub-features 1.28.0 → 1.29.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @knime/hub-features
 
+## 1.29.1
+
+### Patch Changes
+
+- c9fed1d: adjust analytics events payload for cloudhome ad-hoc execution
+
+## 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.28.0",
+  "version": "1.29.1",
   "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": {
@@ -39,8 +39,8 @@
     "lodash-es": "4.18.1",
     "ofetch": "^1.4.1",
     "typescript": "^5.9.3",
-    "@knime/styles": "1.15.1",
     "@knime/components": "1.46.6",
+    "@knime/styles": "1.15.1",
     "@knime/utils": "1.11.0"
   },
   "peerDependencies": {
@@ -52,7 +52,7 @@
     "@vue/test-utils": "2.4.6",
     "consola": "3.4.2",
     "json-schema-to-typescript": "^15.0.4",
-    "vite": "^7.3.1",
+    "vite": "^7.3.5",
     "vite-svg-loader": "5.1.0",
     "vue-tsc": "3.0.4"
   },

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

@@ -1,6 +1,4 @@
- 
-/* 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";
@@ -17,7 +15,7 @@ export const adHocExecutionStartedDeploymentsPage = <T extends DefaultContext>(c
     event_source: "cloudhome",
     event_display_name: "Ad Hoc Execution Started",
     interaction: {
-      location: "main_area",
+      location: "contextual_side_panel",
       page: "deployments",
       trigger: "user",
       type: "click",
@@ -90,7 +88,7 @@ export const secretCreatedTeamSecrets = <T extends DefaultContext>(ctx: T) => ()
     event_display_name: "Secret Created",
     interaction: {
       location: "contextual_side_panel",
-      page: "secrets",
+      page: "team_secrets",
       trigger: "user",
       type: "click",
     },
@@ -104,7 +102,7 @@ export const secretCreatedTeamSecrets = <T extends DefaultContext>(ctx: T) => ()
 /**
  * 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 => {
+export const secretCreatedPersonalSecrets = <T extends DefaultContext>(ctx: T) => (): AnalyticsEvent => {
   const staticData = {
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
@@ -114,7 +112,7 @@ export const secretCreatedMySecrets = <T extends DefaultContext>(ctx: T) => ():
     event_display_name: "Secret Created",
     interaction: {
       location: "contextual_side_panel",
-      page: "my_secrets",
+      page: "personal_secrets",
       trigger: "user",
       type: "click",
     },
@@ -185,7 +183,7 @@ export const deploymentSharedDeploymentsSharingPopup = <T extends DefaultContext
     event_source: "cloudhome",
     event_display_name: "Deployment Shared",
     interaction: {
-      location: "module",
+      location: "popup",
       page: "deployments",
       trigger: "user",
       type: "click",
@@ -233,7 +231,7 @@ export const deploymentSharedWorkflowSharingPopup = <T extends DefaultContext>(c
     event_source: "cloudhome",
     event_display_name: "Deployment Shared",
     interaction: {
-      location: "module",
+      location: "popup",
       page: "workflow_details",
       trigger: "user",
       type: "click",

package/src/analytics/schema/code-generator.js

@@ -22,9 +22,7 @@ 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";',

package/src/analytics/schema/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",
     },

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

@@ -111,7 +111,7 @@ export interface AnalyticsEventSchema {
       payload: EmptyPayload;
     };
     annotationCreatedKaiExplain: {
-      event_name: "annotation_created";
+      event_name: "annotation_created_kai_explain";
       event_source: "editor";
       event_display_name: "Annotation Created";
       interaction: {
@@ -183,7 +183,7 @@ export interface AnalyticsEventSchema {
       event_source: "editor";
       event_display_name: "Node Created";
       interaction: {
-        location: "noderepository";
+        location: "node_repository";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "drag_drop";
       };
@@ -194,7 +194,7 @@ export interface AnalyticsEventSchema {
       event_source: "editor";
       event_display_name: "Node Created";
       interaction: {
-        location: "noderepository";
+        location: "node_repository";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "double_click";
       };
@@ -205,7 +205,7 @@ export interface AnalyticsEventSchema {
       event_source: "editor";
       event_display_name: "Node Created";
       interaction: {
-        location: "noderepository";
+        location: "node_repository";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "key_press";
       };
@@ -316,7 +316,7 @@ export interface AnalyticsEventSchema {
       event_source: "editor";
       event_display_name: "Node Searched";
       interaction: {
-        location: "noderepository";
+        location: "node_repository";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "key_press";
       };
@@ -349,7 +349,7 @@ export interface AnalyticsEventSchema {
       event_source: "editor";
       event_display_name: "Node Repository Opened";
       interaction: {
-        location: "noderepository";
+        location: "node_repository";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
       };
@@ -427,7 +427,7 @@ export interface AnalyticsEventSchema {
       event_source: "cloudhome";
       event_display_name: "Ad Hoc Execution Started";
       interaction: {
-        location: "main_area";
+        location: "contextual_side_panel";
         page: "deployments";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
@@ -497,19 +497,19 @@ export interface AnalyticsEventSchema {
       event_display_name: "Secret Created";
       interaction: {
         location: "contextual_side_panel";
-        page: "secrets";
+        page: "team_secrets";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
       };
       payload: EmptyPayload;
     };
-    secretCreatedMySecrets: {
+    secretCreatedPersonalSecrets: {
       event_name: "secret_created";
       event_source: "cloudhome";
       event_display_name: "Secret Created";
       interaction: {
         location: "contextual_side_panel";
-        page: "my_secrets";
+        page: "personal_secrets";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
       };
@@ -701,7 +701,7 @@ export interface AnalyticsEventSchema {
       event_source: "cloudhome";
       event_display_name: "Deployment Shared";
       interaction: {
-        location: "module";
+        location: "popup";
         page: "deployments";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
@@ -725,7 +725,7 @@ export interface AnalyticsEventSchema {
       event_source: "cloudhome";
       event_display_name: "Deployment Shared";
       interaction: {
-        location: "module";
+        location: "popup";
         page: "workflow_details";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";

package/src/analytics/schema/schema.json

@@ -57,7 +57,7 @@
         "actionRedoneToolbar",
         "actionRedoneKeyboard",
         "versionCreated",
-        "secretCreatedMySecrets",
+        "secretCreatedPersonalSecrets",
         "secretCreatedTeamSecrets",
         "sessionEnded",
         "sessionInterrupted",
@@ -573,7 +573,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "annotation_created"
+              "const": "annotation_created_kai_explain"
             },
             "event_source": {
               "type": "string",
@@ -952,7 +952,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "noderepository"
+                  "const": "node_repository"
                 },
                 "trigger": {
                   "allOf": [
@@ -1011,7 +1011,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "noderepository"
+                  "const": "node_repository"
                 },
                 "trigger": {
                   "allOf": [
@@ -1070,7 +1070,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "noderepository"
+                  "const": "node_repository"
                 },
                 "trigger": {
                   "allOf": [
@@ -1664,7 +1664,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "noderepository"
+                  "const": "node_repository"
                 },
                 "trigger": {
                   "allOf": [
@@ -1841,7 +1841,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "noderepository"
+                  "const": "node_repository"
                 },
                 "trigger": {
                   "allOf": [
@@ -2259,7 +2259,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "main_area"
+                  "const": "contextual_side_panel"
                 },
                 "page": {
                   "type": "string",
@@ -2632,7 +2632,7 @@
                 },
                 "page": {
                   "type": "string",
-                  "const": "secrets"
+                  "const": "team_secrets"
                 },
                 "trigger": {
                   "allOf": [
@@ -2661,7 +2661,7 @@
             }
           }
         },
-        "secretCreatedMySecrets": {
+        "secretCreatedPersonalSecrets": {
           "type": "object",
           "additionalProperties": false,
           "$comment": "Fired when the user creates a new secret by clicking Create in the side panel on the personal secrets page",
@@ -2696,7 +2696,7 @@
                 },
                 "page": {
                   "type": "string",
-                  "const": "my_secrets"
+                  "const": "personal_secrets"
                 },
                 "trigger": {
                   "allOf": [
@@ -3722,7 +3722,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "module"
+                  "const": "popup"
                 },
                 "page": {
                   "type": "string",
@@ -3850,7 +3850,7 @@
               "properties": {
                 "location": {
                   "type": "string",
-                  "const": "module"
+                  "const": "popup"
                 },
                 "page": {
                   "type": "string",

package/src/httpClient/constants.ts

@@ -0,0 +1 @@
+export const API_BASE_URL = "/_/api";

package/src/{common/ofetchClient.ts → httpClient/createHttpClient.ts}

@@ -1,9 +1,9 @@
 import { merge } from "lodash-es"; // eslint-disable-line depend/ban-dependencies
 import { type FetchOptions, ofetch } from "ofetch";
 
-import { DEFAULT_API_BASE_URL } from "./constants";
+import { API_BASE_URL } from "./constants";
 
-export const defaultConfig: FetchOptions = {
+const defaultConfig: FetchOptions = {
   headers: {
     "Content-Type": "application/json",
 
@@ -12,11 +12,12 @@ export const defaultConfig: FetchOptions = {
   },
 } as const;
 
-export const getFetchClient = (customOptions?: FetchOptions) => {
-  const { baseURL = DEFAULT_API_BASE_URL, ...otherCustomOptions } =
-    customOptions ?? {};
+const createHttpClient = (customOptions?: FetchOptions) => {
+  const { baseURL = API_BASE_URL, ...otherCustomOptions } = customOptions ?? {};
 
   return ofetch.create(
     merge({ baseURL, ...otherCustomOptions }, defaultConfig),
   );
 };
+
+export { type FetchOptions, defaultConfig, createHttpClient };

package/src/httpClient/index.ts

@@ -0,0 +1,2 @@
+export * from "./createHttpClient";
+export * from "./constants";

package/src/index.ts

@@ -4,3 +4,4 @@ export * from "./useDownloadArtifact";
 export * from "./components/avatars";
 export * from "./embeddingSDK";
 export * from "./authUtils";
+export * from "./httpClient";

package/src/useDownloadArtifact/useDownloadArtifact.ts

@@ -4,7 +4,7 @@ import { FetchError, type FetchOptions } from "ofetch";
 import type { DownloadItem as DownloadItemExternal } from "@knime/components";
 import { sleep } from "@knime/utils";
 
-import { getFetchClient } from "../common/ofetchClient";
+import { createHttpClient } from "../httpClient/createHttpClient";
 import { rfcErrors } from "../rfcErrors";
 
 const DEFAULT_MAX_RETRIES = null;
@@ -91,7 +91,7 @@ const isAbortError = (error: unknown) =>
 export const useDownloadArtifact = (
   options: UseDownloadArtifactOptions = {},
 ) => {
-  const $ofetch = getFetchClient(options.customFetchClientOptions);
+  const $ofetch = createHttpClient(options.customFetchClientOptions);
 
   const downloadItems = ref<Record<string, DownloadItem>>({});
   const abortControllers: Record<string, AbortController> = {};

package/src/useFileUpload/useFileUpload.ts

@@ -9,7 +9,7 @@ import {
   promise,
 } from "@knime/utils";
 
-import { getFetchClient } from "../common/ofetchClient";
+import { createHttpClient } from "../httpClient/createHttpClient";
 import { rfcErrors } from "../rfcErrors";
 
 const DEFAULT_MAX_UPLOAD_QUEUE_SIZE = 10;
@@ -120,7 +120,7 @@ type UseFileUploadOptions = {
  * ```
  */
 export const useFileUpload = (options: UseFileUploadOptions = {}) => {
-  const $ofetch = getFetchClient(options.customFetchClientOptions);
+  const $ofetch = createHttpClient(options.customFetchClientOptions);
 
   const prepareUpload = (
     parentId: string,

package/src/common/constants.ts

@@ -1 +0,0 @@
-export const DEFAULT_API_BASE_URL = "/_/api";

package/src/components/versions/components/CreateVersionForm.vue

@@ -1,155 +0,0 @@
-<script setup lang="ts">
-import { computed, nextTick, onMounted, ref } from "vue";
-import { useTextareaAutosize } from "@vueuse/core";
-
-import {
-  InputField,
-  Label,
-  SideDrawerControls,
-  SideDrawerHeader,
-  TextArea,
-} from "@knime/components";
-
-type Props = {
-  isCreationPending?: boolean;
-};
-
-withDefaults(defineProps<Props>(), { isCreationPending: false });
-
-const emit = defineEmits<{
-  create: [{ name: string; description: string }];
-  cancel: [hasUnsavedChanges: boolean];
-}>();
-
-const versionName = ref("");
-const versionDescription = ref("");
-
-const descriptionEditor = ref<InstanceType<typeof TextArea> | null>(null);
-
-onMounted(() => {
-  useTextareaAutosize({
-    element: descriptionEditor.value?.$el.getElementsByTagName("textarea")[0],
-    input: versionDescription,
-  });
-});
-
-const doValidate = ref(false);
-
-const isVersionNameInvalid = computed(() => {
-  return doValidate.value && versionName.value.length <= 0;
-});
-
-const hasUnsavedChanges = computed(() => {
-  return versionName.value !== "" || versionDescription.value !== "";
-});
-
-const onCreate = async () => {
-  doValidate.value = true;
-  await nextTick();
-
-  if (!isVersionNameInvalid.value) {
-    emit("create", {
-      name: versionName.value,
-      description: versionDescription.value,
-    });
-  }
-};
-</script>
-
-<template>
-  <div class="create-version-form">
-    <SideDrawerHeader
-      title="Create Version"
-      description="Give your version a name and description. Versions can be used to create a deployment.
-      "
-      :is-sub-drawer="true"
-      @close="$emit('cancel', hasUnsavedChanges)"
-    />
-    <div class="form-content">
-      <Label text="Version name">
-        <InputField
-          v-model="versionName"
-          type="text"
-          required
-          :is-valid="!isVersionNameInvalid"
-        />
-        <div v-if="isVersionNameInvalid" class="error">
-          Please enter at least 1 character.
-        </div>
-      </Label>
-      <Label text="Description">
-        <TextArea
-          ref="descriptionEditor"
-          v-model="versionDescription"
-          class="description"
-        />
-      </Label>
-      <div class="controls">
-        <SideDrawerControls
-          class="create-version-controls"
-          :edit-enabled="true"
-          :processing="isCreationPending"
-          action-label="Create"
-          :disabled="isVersionNameInvalid || isCreationPending"
-          @save="onCreate"
-          @cancel="$emit('cancel', hasUnsavedChanges)"
-        />
-      </div>
-    </div>
-  </div>
-</template>
-
-<style lang="postcss" scoped>
-.create-version-form {
-  display: flex;
-  flex-direction: column;
-  width: 100%;
-  height: 100%;
-  max-height: 100%;
-
-  & .form-content {
-    z-index: 1;
-    display: flex;
-    flex-direction: column;
-    gap: 30px;
-    height: 100%;
-    padding: 30px 30px 0;
-    overflow: auto;
-    overscroll-behavior: none;
-    background-color: var(--knime-gray-ultra-light);
-    isolation: isolate;
-
-    & .description {
-      display: flex;
-      width: 100%;
-      max-width: unset;
-
-      & :deep(textarea) {
-        box-sizing: content-box;
-        width: 100%;
-        max-height: 200px;
-        resize: none;
-      }
-    }
-
-    & .error {
-      position: absolute;
-      margin-top: 6px;
-      font-size: 13px;
-      font-weight: 300;
-      line-height: 18px;
-      color: var(--theme-color-error);
-      word-break: keep-all;
-    }
-
-    & .controls {
-      margin: 0 -30px;
-      margin-top: auto;
-    }
-
-    .create-version-controls {
-      margin: 0;
-    }
-  }
-}
-</style>