@atlaskit/rovo-agent-analytics 0.17.0 → 0.19.0

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

@@ -0,0 +1,24 @@
+/**
+ * Action Group: editing
+ *
+ * Agent editing/mutation events — fired when an agent's configuration is saved or modified.
+ * 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
+ *    (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 declare const ACTION_GROUP: "editing";
+export declare enum AgentEditingActions {
+    UPDATED = "updated"
+}
+export type EditingActionAttributes = {
+    [AgentEditingActions.UPDATED]: BaseAgentAnalyticsAttributes & {
+        agentType: string;
+        field: string;
+    };
+};

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

@@ -0,0 +1,38 @@
+/**
+ * Action Group: tools
+ *
+ * Actions related to agent tool execution during chat
+ * (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
+ *    (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 declare const ACTION_GROUP: "tools";
+export declare enum AgentToolActions {
+    TOOLS_EXECUTION_CONFIRMED = "toolsExecutionConfirmed",
+    TOOLS_EXECUTION_STREAM_STOPPED = "toolsExecutionStreamStopped",
+    TOOLS_EXECUTION_RESULT_VIEWED = "toolsExecutionResultViewed",
+    TOOLS_EXECUTION_RESULT_ERROR = "toolsExecutionResultError"
+}
+export type ToolsExecutionAttributes = BaseAgentAnalyticsAttributes & {
+    tools: {
+        toolId: string;
+        toolSource: string;
+        resolutionType: string;
+    }[];
+    singleInstrumentationId: string | undefined;
+};
+export type ToolsExecutionResultAttributes = ToolsExecutionAttributes & {
+    scenarioId: string | null | undefined;
+};
+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;
+};

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

@@ -1,52 +1,22 @@
-import type { BaseAgentAnalyticsAttributes, RemainingRequired } from '../common/types';
-import type { AgentToolActions, ToolsExecutionAttributes } from './tool-actions';
-export declare enum AgentDebugActions {
-    VIEW = "debugView",
-    COPY_ALL = "debugCopyAll",
-    COPY = "debugCopy",
-    TOGGLE_SKILL_INFO = "debugToggleSkillInfo"
-}
-export declare enum AgentCommonActions {
-    VIEW = "view",
-    EDIT = "edit",
-    UPDATED = "updated",
-    COPY_LINK = "copyLink",
-    DELETE = "delete",
-    DUPLICATE = "duplicate",
-    STAR = "star",
-    CHAT = "chat",
-    VERIFY = "verify",
-    UNVERIFY = "unverify"
-}
-type EmptyAttributes = {};
-type ActionAttributes = {
-    [AgentCommonActions.VIEW]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.EDIT]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.UPDATED]: BaseAgentAnalyticsAttributes & {
-        agentType: string;
-        field: string;
-    };
-    [AgentCommonActions.COPY_LINK]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.DELETE]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.DUPLICATE]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.STAR]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.CHAT]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.VERIFY]: BaseAgentAnalyticsAttributes;
-    [AgentCommonActions.UNVERIFY]: BaseAgentAnalyticsAttributes;
-    [AgentDebugActions.COPY_ALL]: EmptyAttributes;
-    [AgentDebugActions.COPY]: EmptyAttributes;
-    [AgentDebugActions.TOGGLE_SKILL_INFO]: {
-        toolId: string;
-        isExpanded: boolean;
-    };
-    [AgentDebugActions.VIEW]: EmptyAttributes;
-    [AgentToolActions.TOOLS_EXECUTION_CONFIRMED]: ToolsExecutionAttributes;
-    [AgentToolActions.TOOLS_EXECUTION_STREAM_STOPPED]: ToolsExecutionAttributes;
-    [AgentToolActions.TOOLS_EXECUTION_RESULT_VIEWED]: ToolsExecutionAttributes;
-    [AgentToolActions.TOOLS_EXECUTION_RESULT_ERROR]: ToolsExecutionAttributes;
+import type { RemainingRequired } from '../common/types';
+import { AgentInteractionActions } from './groups/agent-interactions';
+import { AgentDebugActions as AgentDebugActionsEnum } from './groups/debug';
+import { AgentEditingActions } from './groups/editing';
+import type { ActionAttributes } from './registry';
+export declare const AgentCommonActions: {
+    readonly UPDATED: AgentEditingActions.UPDATED;
+    readonly VIEW: AgentInteractionActions.VIEW;
+    readonly EDIT: AgentInteractionActions.EDIT;
+    readonly COPY_LINK: AgentInteractionActions.COPY_LINK;
+    readonly DELETE: AgentInteractionActions.DELETE;
+    readonly DUPLICATE: AgentInteractionActions.DUPLICATE;
+    readonly STAR: AgentInteractionActions.STAR;
+    readonly CHAT: AgentInteractionActions.CHAT;
+    readonly VERIFY: AgentInteractionActions.VERIFY;
+    readonly UNVERIFY: AgentInteractionActions.UNVERIFY;
 };
+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;
     trackAgentActionError: <A extends keyof ActionAttributes>(action: A, error: Error, attributes?: RemainingRequired<ActionAttributes[A], T>) => void;
 };
-export {};

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

@@ -0,0 +1,16 @@
+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';
+/**
+ * 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`.
+ *
+ * When you add a new group, add it here too.
+ */
+export declare const ACTION_TO_GROUP: Record<string, string>;

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

@@ -1,24 +1,26 @@
+import { AddToolsPromptActions } from '../actions/groups/add-tools-prompt';
+import { CreateFlowActions } from '../actions/groups/create-flow';
+export declare const AgentCreateActions: {
+    readonly SHOWN: AddToolsPromptActions.SHOWN;
+    readonly BROWSE: AddToolsPromptActions.BROWSE;
+    readonly DISMISS: AddToolsPromptActions.DISMISS;
+    readonly START: CreateFlowActions.START;
+    readonly SKIP_NL: CreateFlowActions.SKIP_NL;
+    readonly REVIEW_NL: CreateFlowActions.REVIEW_NL;
+    readonly ACTIVATE: CreateFlowActions.ACTIVATE;
+    readonly RESTART: CreateFlowActions.RESTART;
+    readonly ERROR: CreateFlowActions.ERROR;
+    readonly LAND: CreateFlowActions.LAND;
+    readonly DISCARD: CreateFlowActions.DISCARD;
+    readonly SA_DRAFT: CreateFlowActions.SA_DRAFT;
+};
 type CommonAnalyticsAttributes = {
     touchPoint?: string;
 } & Record<string, any>;
-export declare enum AgentCreateActions {
-    START = "createFlowStart",
-    SKIP_NL = "createFlowSkipNL",
-    REVIEW_NL = "createFlowReviewNL",
-    ACTIVATE = "createFlowActivate",
-    RESTART = "createFlowRestart",
-    ERROR = "createFlowError",
-    LAND = "createLandInStudio",
-    DISCARD = "createDiscard",
-    SHOW_NO_SKILLS_MODAL = "showNoSkillsModal",
-    BROWSE_CLICK_NO_SKILLS_MODAL = "browseClickNoSkillsModal",
-    DISCARD_NO_SKILLS_MODAL = "discardNoSkillsModal",
-    SA_DRAFT = "saDraft"
-}
 export declare const useRovoAgentCreateAnalytics: (commonAttributes: CommonAnalyticsAttributes) => readonly [
     string | null,
     {
-        readonly trackCreateSession: (action: Omit<AgentCreateActions, AgentCreateActions.START>, attributes?: CommonAnalyticsAttributes) => void;
+        readonly trackCreateSession: (action: (typeof AgentCreateActions)[keyof typeof AgentCreateActions], attributes?: CommonAnalyticsAttributes) => void;
         readonly trackCreateSessionStart: (attributes?: CommonAnalyticsAttributes) => void;
         readonly trackCreateSessionError: (error: Error, attributes?: CommonAnalyticsAttributes) => void;
         readonly refreshCSID: () => `${string}-${string}-${string}-${string}-${string}`;

package/package.json

@@ -75,7 +75,7 @@
 		}
 	},
 	"name": "@atlaskit/rovo-agent-analytics",
-	"version": "0.17.0",
+	"version": "0.19.0",
 	"description": "Rovo Agents analytics",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/dist/types/actions/tool-actions/index.d.ts

@@ -1,14 +0,0 @@
-import type { BaseAgentAnalyticsAttributes } from '../../common/types';
-export declare enum AgentToolActions {
-    TOOLS_EXECUTION_CONFIRMED = "toolsExecutionConfirmed",
-    TOOLS_EXECUTION_STREAM_STOPPED = "toolsExecutionStreamStopped",
-    TOOLS_EXECUTION_RESULT_VIEWED = "toolsExecutionResultViewed",
-    TOOLS_EXECUTION_RESULT_ERROR = "toolsExecutionResultError"
-}
-export type ToolsExecutionAttributes = BaseAgentAnalyticsAttributes & {
-    tools: {
-        toolId: string;
-        toolSource: string;
-        resolutionType: string;
-    }[];
-};

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

@@ -1,14 +0,0 @@
-import type { BaseAgentAnalyticsAttributes } from '../../common/types';
-export declare enum AgentToolActions {
-    TOOLS_EXECUTION_CONFIRMED = "toolsExecutionConfirmed",
-    TOOLS_EXECUTION_STREAM_STOPPED = "toolsExecutionStreamStopped",
-    TOOLS_EXECUTION_RESULT_VIEWED = "toolsExecutionResultViewed",
-    TOOLS_EXECUTION_RESULT_ERROR = "toolsExecutionResultError"
-}
-export type ToolsExecutionAttributes = BaseAgentAnalyticsAttributes & {
-    tools: {
-        toolId: string;
-        toolSource: string;
-        resolutionType: string;
-    }[];
-};