@knime/hub-features 1.26.2 → 1.27.0

package/src/analytics/types.ts

@@ -1,62 +1,35 @@
 import type { AnalyticsEventSchema } from "./schema/schema";
 
-export const SEPARATOR = "::";
-type Separator = typeof SEPARATOR;
-
-type EventDefinitions = AnalyticsEventSchema["events"];
+export type DefaultContext = Record<string, string | boolean | number>;
+export type Metadata = Omit<AnalyticsEventSchema, "events">;
 
-/**
- * Group names (top-level keys in `events`, e.g. "kai_prompted").
- */
-type GroupName = keyof EventDefinitions;
+type NewEvents = AnalyticsEventSchema["events"];
+type EventNames = keyof NewEvents;
 
 /**
- * Event names in the flattened "group::event" form. This makes event calls
- * single keys using the `::` separator (for example "kai_prompted::kaiqa_button_prompt").
+ * These are fields that are present on every event, but their values are generated at runtime
  */
-export type EventNames = {
-  [G in GroupName]: `${G}${Separator}${keyof EventDefinitions[G] & string}`;
-}[GroupName];
-
-export type Metadata = Omit<AnalyticsEventSchema, "events">;
-
-export type Context = { jobId: string };
+export type GeneratedStaticFields = {
+  unique_event_id: string;
+  timestamp: 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.
+ * These are fields that are present on every event, but their values are statically set for each
+ * event in the schema file
  */
-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 = {
+export type SchemaStaticFields = Omit<NewEvents[EventNames], "payload">;
+export type AnalyticsEvent = {
   id: string;
-  data: unknown;
+  data: SchemaStaticFields & { [key: string]: unknown };
 };
 
-export type CreateEventFn<TReturn = void> = <K extends EventNames>(
-  args: EventArgs<K>,
-) => TReturn;
-
-export interface AnalyticsAdapter {
+export interface AnalyticsEventSender {
   /**
    * 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;
+  send: (params: { event: AnalyticsEvent; metadata: Metadata }) => void;
 }
+
+export type EventFunctionArgs<T extends EventNames> =
+  NewEvents[T]["payload"] extends null ? never : NewEvents[T]["payload"];

package/src/analytics/utils/logger.ts

@@ -0,0 +1 @@
+export const logger = () => consola.withTag("AnalyticsEvents");

package/src/analytics/utils/eventIds.ts

@@ -1,35 +0,0 @@
-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),
-});