@atlaskit/rovo-agent-analytics 0.19.0 → 0.20.0

package/dist/types/common/types.d.ts

@@ -1,5 +1,19 @@
+import type { AddToolsPromptEventPayload } from '../actions/groups/add-tools-prompt';
+import type { AgentInteractionsEventPayload } from '../actions/groups/agent-interactions';
+import type { CreateFlowEventPayload } from '../actions/groups/create-flow';
+import type { DebugEventPayload } from '../actions/groups/debug';
+import type { EditingEventPayload } from '../actions/groups/editing';
+import type { EvaluationEventPayload } from '../actions/groups/evaluation';
+import type { ToolsEventPayload } from '../actions/groups/tools';
 export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;
 export type BaseAgentAnalyticsAttributes = {
     touchPoint: string;
     agentId: string;
 };
+/** Common library attribute injected into all events */
+export declare const LIBRARY_ATTRIBUTE: "agents-analytics";
+/**
+ * Union of all event payload types.
+ * Use with `trackAgentEvent()` for typed event tracking.
+ */
+export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | CreateFlowEventPayload | AddToolsPromptEventPayload;

package/dist/types-ts4.5/actions/groups/add-tools-prompt.d.ts

@@ -8,12 +8,30 @@
  * regardless of whether the prompt fires from the create flow or a future publish flow.
  *
  * ## Adding a new action
- * 1. Add the action to the `AddToolsPromptActions` enum below with a data-portal link
- * 2. Register this group in ../registry.ts (if this is a new group file)
- *
+ * 1. Add a new variant to the `AddToolsPromptEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit this group, consider creating a new group file instead
+ *    (see other files in this directory for the template)
+ */
+/**
+ * Discriminated union payload type for add tools prompt events.
+ * Use with `trackAgentEvent()`.
  */
-/** The group name sent as `attributes.actionGroup` in analytics events */
+export type AddToolsPromptEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'addToolsPromptShown';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'addToolsPromptBrowse';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'addToolsPromptDismiss';
+    attributes: {};
+};
+/** @deprecated Use AddToolsPromptEventPayload with trackAgentEvent() instead */
 export declare const ACTION_GROUP: "addToolsPrompt";
+/** @deprecated Use AddToolsPromptEventPayload with trackAgentEvent() instead */
 export declare enum AddToolsPromptActions {
     SHOWN = "addToolsPromptShown",
     BROWSE = "addToolsPromptBrowse",

package/dist/types-ts4.5/actions/groups/agent-interactions.d.ts

@@ -7,14 +7,55 @@
  * NOTE: This is about UI interactions, not backend "actions" (which are being replaced by "tools").
  *
  * ## Adding a new action
- * 1. Add the action to the `AgentInteractionActions` enum below with a data-portal link
- * 2. Add the corresponding attribute type in `AgentInteractionAttributes`
- * 3. If this action doesn't fit user interactions, create a new group file instead
+ * 1. Add a new variant to the `AgentInteractionsEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit user interactions, create a new group file instead
  *    (see other files in this directory for the template)
  */
 import type { BaseAgentAnalyticsAttributes } from '../../common/types';
-/** The group name sent as `attributes.actionGroup` in analytics events */
+/**
+ * Discriminated union payload type for agent interaction events.
+ * Use with `trackAgentEvent()`.
+ */
+export type AgentInteractionsEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'view';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'edit';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'copyLink';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'delete';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'duplicate';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'star';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'chat';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'verify';
+    attributes: BaseAgentAnalyticsAttributes;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'unverify';
+    attributes: BaseAgentAnalyticsAttributes;
+};
+/** @deprecated Use AgentInteractionsEventPayload with trackAgentEvent() instead */
 export declare const ACTION_GROUP: "agentInteractions";
+/** @deprecated Use AgentInteractionsEventPayload with trackAgentEvent() instead */
 export declare enum AgentInteractionActions {
     VIEW = "view",
     EDIT = "edit",
@@ -26,6 +67,7 @@ export declare enum AgentInteractionActions {
     VERIFY = "verify",
     UNVERIFY = "unverify"
 }
+/** @deprecated Use AgentInteractionsEventPayload with trackAgentEvent() instead */
 export type AgentInteractionAttributes = {
     [AgentInteractionActions.VIEW]: BaseAgentAnalyticsAttributes;
     [AgentInteractionActions.EDIT]: BaseAgentAnalyticsAttributes;

package/dist/types-ts4.5/actions/groups/create-flow.d.ts

@@ -4,11 +4,54 @@
  * Create agent funnel steps — from clicking "Create agent" through to activation or discard,
  *
  * ## Adding a new action
- * 1. Add the action to the `CreateFlowActions` enum below with a data-portal link
- * 2. Register this group in ../registry.ts (if this is a new group file)
+ * 1. Add a new variant to the `CreateFlowEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit this group, consider creating a new group file instead
+ *    (see other files in this directory for the template)
  */
-/** The group name sent as `attributes.actionGroup` in analytics events */
+/**
+ * Discriminated union payload type for create flow events.
+ * Use with `trackAgentEvent()`.
+ */
+export type CreateFlowEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'createFlowStart';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createFlowSkipNL';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createFlowReviewNL';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createFlowActivate';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createFlowRestart';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createFlowError';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createLandInStudio';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'createDiscard';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'saDraft';
+    attributes: {};
+};
+/** @deprecated Use CreateFlowEventPayload with trackAgentEvent() instead */
 export declare const ACTION_GROUP: "createFlow";
+/** @deprecated Use CreateFlowEventPayload with trackAgentEvent() instead */
 export declare enum CreateFlowActions {
     START = "createFlowStart",
     SKIP_NL = "createFlowSkipNL",

package/dist/types-ts4.5/actions/groups/debug.d.ts

@@ -4,13 +4,37 @@
  * Actions related to the agent debug modal (viewing, copying debug data, toggling skill info).
  *
  * ## Adding a new action
- * 1. Add the action to the `AgentDebugActions` enum below with a data-portal link
- * 2. Add the corresponding attribute type in `DebugActionAttributes`
- * 3. If this action doesn't fit this group, consider creating a new group file instead
+ * 1. Add a new variant to the `DebugEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit this group, consider creating a new group file instead
  *    (see other files in this directory for the template)
  */
-/** The group name sent as `attributes.actionGroup` in analytics events */
+/**
+ * Discriminated union payload type for debug events.
+ * Use with `trackAgentEvent()`.
+ */
+export type DebugEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'debugView';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'debugCopyAll';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'debugCopy';
+    attributes: {};
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'debugToggleSkillInfo';
+    attributes: {
+        toolId: string;
+        isExpanded: boolean;
+    };
+};
+/** @deprecated Use DebugEventPayload with trackAgentEvent() instead */
 export declare const ACTION_GROUP: "debug";
+/** @deprecated Use DebugEventPayload with trackAgentEvent() instead */
 export declare enum AgentDebugActions {
     VIEW = "debugView",
     COPY_ALL = "debugCopyAll",
@@ -18,6 +42,7 @@ export declare enum AgentDebugActions {
     TOGGLE_SKILL_INFO = "debugToggleSkillInfo"
 }
 type EmptyAttributes = {};
+/** @deprecated Use DebugEventPayload with trackAgentEvent() instead */
 export type DebugActionAttributes = {
     [AgentDebugActions.COPY_ALL]: EmptyAttributes;
     [AgentDebugActions.COPY]: EmptyAttributes;

package/dist/types-ts4.5/actions/groups/editing.d.ts

@@ -5,17 +5,26 @@
  * Unlike agentInteractions (user clicks), these track actual data changes.
  *
  * ## Adding a new action
- * 1. Add the action to the `AgentEditingActions` enum below with a data-portal link
- * 2. Add the corresponding attribute type in `EditingActionAttributes`
- * 3. If this action doesn't fit editing/mutation events, create a new group file instead
+ * 1. Add a new variant to the `EditingEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit editing/mutation events, create a new group file instead
  *    (see other files in this directory for the template)
  */
 import type { BaseAgentAnalyticsAttributes } from '../../common/types';
-/** The group name sent as `attributes.actionGroup` in analytics events */
+export type EditingEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'updated';
+    attributes: BaseAgentAnalyticsAttributes & {
+        agentType: string;
+        field: string;
+    };
+};
+/** @deprecated Use EditingEventPayload with trackAgentEvent() instead */
 export declare const ACTION_GROUP: "editing";
+/** @deprecated Use EditingEventPayload with trackAgentEvent() instead */
 export declare enum AgentEditingActions {
     UPDATED = "updated"
 }
+/** @deprecated Use EditingEventPayload with trackAgentEvent() instead */
 export type EditingActionAttributes = {
     [AgentEditingActions.UPDATED]: BaseAgentAnalyticsAttributes & {
         agentType: string;

package/dist/types-ts4.5/actions/groups/evaluation.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Action Group: evaluation
+ *
+ * Batch evaluation events — dataset CRUD, job lifecycle, and validation UI events
+ * fired from the shared `agent-evaluation` package.
+ *
+ * ## Adding a new action
+ * 1. Add a new variant to the `EvaluationEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit this group, consider creating a new group file instead
+ *    (see other files in this directory for the template)
+ */
+type EvalAttributesBase = {
+    objectType?: string;
+    objectId?: string;
+    containerType?: string;
+    containerId?: string;
+    actionSubjectId?: string;
+};
+export type EvaluationEventPayload = ({
+    actionSubject: 'batchEvaluationDataset';
+    action: 'created';
+    attributes: {
+        totalQuestions: number;
+    };
+} & EvalAttributesBase) | ({
+    actionSubject: 'batchEvaluationJob';
+    action: 'created';
+    attributes: {
+        datasetSize: number;
+        isDraftAgent: boolean;
+        judgeMode: string | undefined;
+    };
+} & EvalAttributesBase) | ({
+    actionSubject: 'batchEvaluationDataset';
+    action: 'deleted';
+    attributes: {};
+} & EvalAttributesBase) | ({
+    actionSubject: 'batchEvaluationDatasetQuestion';
+    action: 'deleted';
+    attributes: {};
+} & EvalAttributesBase) | ({
+    actionSubject: 'evalResultsModal';
+    action: 'viewed';
+    attributes: {
+        trigger: 'row_action' | 'flag_action';
+    };
+} & EvalAttributesBase) | ({
+    actionSubject: 'batchEvaluationJob';
+    action: 'completed';
+    attributes: {
+        status: string | null;
+        durationMs: number | null;
+        datasetSize: number | null | undefined;
+    };
+} & EvalAttributesBase);
+export {};

package/dist/types-ts4.5/actions/groups/tools.d.ts

@@ -5,20 +5,48 @@
  * (confirming, streaming, viewing results, errors).
  *
  * ## Adding a new action
- * 1. Add the action to the `AgentToolActions` enum below with a data-portal link
- * 2. Add the corresponding attribute type in `ToolsActionAttributes`
- * 3. If this action doesn't fit this group, consider creating a new group file instead
+ * 1. Add a new variant to the `ToolsEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit this group, consider creating a new group file instead
  *    (see other files in this directory for the template)
  */
 import type { BaseAgentAnalyticsAttributes } from '../../common/types';
-/** The group name sent as `attributes.actionGroup` in analytics events */
+type ToolsExecutionAttributesBase = BaseAgentAnalyticsAttributes & {
+    tools: {
+        toolId: string;
+        toolSource: string;
+        resolutionType: string;
+    }[];
+    singleInstrumentationId: string | undefined;
+};
+export type ToolsEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'toolsExecutionConfirmed';
+    attributes: ToolsExecutionAttributesBase;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'toolsExecutionStreamStopped';
+    attributes: ToolsExecutionAttributesBase;
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'toolsExecutionResultViewed';
+    attributes: ToolsExecutionAttributesBase & {
+        scenarioId: string | null | undefined;
+    };
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'toolsExecutionResultError';
+    attributes: ToolsExecutionAttributesBase;
+};
+/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
 export declare const ACTION_GROUP: "tools";
+/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
 export declare enum AgentToolActions {
     TOOLS_EXECUTION_CONFIRMED = "toolsExecutionConfirmed",
     TOOLS_EXECUTION_STREAM_STOPPED = "toolsExecutionStreamStopped",
     TOOLS_EXECUTION_RESULT_VIEWED = "toolsExecutionResultViewed",
     TOOLS_EXECUTION_RESULT_ERROR = "toolsExecutionResultError"
 }
+/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
 export type ToolsExecutionAttributes = BaseAgentAnalyticsAttributes & {
     tools: {
         toolId: string;
@@ -27,12 +55,15 @@ export type ToolsExecutionAttributes = BaseAgentAnalyticsAttributes & {
     }[];
     singleInstrumentationId: string | undefined;
 };
+/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
 export type ToolsExecutionResultAttributes = ToolsExecutionAttributes & {
     scenarioId: string | null | undefined;
 };
+/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
 export type ToolsActionAttributes = {
     [AgentToolActions.TOOLS_EXECUTION_CONFIRMED]: ToolsExecutionAttributes;
     [AgentToolActions.TOOLS_EXECUTION_STREAM_STOPPED]: ToolsExecutionAttributes;
     [AgentToolActions.TOOLS_EXECUTION_RESULT_VIEWED]: ToolsExecutionResultAttributes;
     [AgentToolActions.TOOLS_EXECUTION_RESULT_ERROR]: ToolsExecutionAttributes;
 };
+export {};

package/dist/types-ts4.5/actions/index.d.ts

@@ -1,4 +1,4 @@
-import type { RemainingRequired } from '../common/types';
+import { type EventPayload, type RemainingRequired } from '../common/types';
 import { AgentInteractionActions } from './groups/agent-interactions';
 import { AgentDebugActions as AgentDebugActionsEnum } from './groups/debug';
 import { AgentEditingActions } from './groups/editing';
@@ -18,5 +18,6 @@ export declare const AgentCommonActions: {
 export declare const AgentDebugActions: typeof AgentDebugActionsEnum;
 export declare const useRovoAgentActionAnalytics: <T extends {}>(commonAttributes: T) => {
     trackAgentAction: <A extends keyof ActionAttributes>(action: A, attributes: RemainingRequired<ActionAttributes[A], T>) => void;
+    trackAgentEvent: (payload: EventPayload) => void;
     trackAgentActionError: <A extends keyof ActionAttributes>(action: A, error: Error, attributes?: RemainingRequired<ActionAttributes[A], T>) => void;
 };

package/dist/types-ts4.5/actions/registry.d.ts

@@ -1,16 +1,23 @@
+/**
+ * Action Registry (Backwards Compatibility)
+ *
+ * This file contains deprecated exports for backwards compatibility
+ * with consumers using `trackAgentAction()`.
+ *
+ * For new code, use the payload types from each group file directly
+ * with `trackAgentEvent()`.
+ *
+ * @deprecated The registry pattern is deprecated. Use EventPayload from types.ts instead.
+ */
 import { type AgentInteractionAttributes } from './groups/agent-interactions';
 import { type DebugActionAttributes } from './groups/debug';
 import { type EditingActionAttributes } from './groups/editing';
 import { type ToolsActionAttributes } from './groups/tools';
+export declare const DefaultActionSubject = "rovoAgent";
 /**
- * Combined attribute map for action-hook groups (type-safe attributes).
- * Create-flow groups are excluded — they use a looser attribute type via the create hook.
- */
-export type ActionAttributes = AgentInteractionAttributes & EditingActionAttributes & DebugActionAttributes & ToolsActionAttributes;
-/**
- * Runtime lookup: action value → group name.
- * Used by ALL analytics hooks to auto-inject `attributes.actionGroup`.
+ * Combined attribute map (union of all groups).
+ * Used by the backward-compatible `trackAgentAction` helper.
  *
- * When you add a new group, add it here too.
+ * @deprecated Use EventPayload with trackAgentEvent() instead
  */
-export declare const ACTION_TO_GROUP: Record<string, string>;
+export type ActionAttributes = AgentInteractionAttributes & EditingActionAttributes & DebugActionAttributes & ToolsActionAttributes;

package/dist/types-ts4.5/common/types.d.ts

@@ -1,5 +1,19 @@
+import type { AddToolsPromptEventPayload } from '../actions/groups/add-tools-prompt';
+import type { AgentInteractionsEventPayload } from '../actions/groups/agent-interactions';
+import type { CreateFlowEventPayload } from '../actions/groups/create-flow';
+import type { DebugEventPayload } from '../actions/groups/debug';
+import type { EditingEventPayload } from '../actions/groups/editing';
+import type { EvaluationEventPayload } from '../actions/groups/evaluation';
+import type { ToolsEventPayload } from '../actions/groups/tools';
 export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;
 export type BaseAgentAnalyticsAttributes = {
     touchPoint: string;
     agentId: string;
 };
+/** Common library attribute injected into all events */
+export declare const LIBRARY_ATTRIBUTE: "agents-analytics";
+/**
+ * Union of all event payload types.
+ * Use with `trackAgentEvent()` for typed event tracking.
+ */
+export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | CreateFlowEventPayload | AddToolsPromptEventPayload;

package/package.json

@@ -27,7 +27,7 @@
 		"@atlaskit/analytics-listeners": "^10.0.0",
 		"@atlaskit/analytics-next": "^11.1.0",
 		"@babel/runtime": "^7.0.0",
-		"@compiled/react": "^0.18.6"
+		"@compiled/react": "^0.20.0"
 	},
 	"peerDependencies": {
 		"react": "^18.2.0"
@@ -75,7 +75,7 @@
 		}
 	},
 	"name": "@atlaskit/rovo-agent-analytics",
-	"version": "0.19.0",
+	"version": "0.20.0",
 	"description": "Rovo Agents analytics",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",