@atlaskit/rovo-agent-analytics 1.7.0 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/rovo-agent-analytics
 
+## 1.9.0
+
+### Minor Changes
+
+- [`5ad26dd7ae450`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5ad26dd7ae450) -
+  Make `agentType` optional and add required `subagentId: string | null` attribute to
+  `EditingEventPayload`. Use `subagentId` to differentiate events fired at the scenario/subagent
+  level vs the agent level.
+
+## 1.8.0
+
+### Minor Changes
+
+- [`0cf21efc19163`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0cf21efc19163) -
+  Added 'ModelPreferencesEventPayload' as a new event type
+
 ## 1.7.0
 
 ### Minor Changes

package/dist/cjs/actions/groups/model-preferences.js

@@ -0,0 +1 @@
+"use strict";

package/dist/types/actions/groups/editing.d.ts

@@ -14,7 +14,14 @@ export type EditingEventPayload = {
     actionSubject: 'rovoAgent';
     action: 'updated';
     attributes: VersionedAgentAttributes & {
-        agentType: string;
+        agentType?: string;
         field: string;
+        /**
+         * Identifies the subagent (formerly "scenario") whose configuration was updated.
+         * Pass the scenario/subagent id when the analytics event is fired at the
+         * scenario/subagent level. Pass `null` when the event is fired at the agent
+         * level (i.e. not scoped to any specific subagent).
+         */
+        subagentId: string | null;
     };
 };

package/dist/types/actions/groups/model-preferences.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Action Group: modelPreferences
+ *
+ * Events fired when a user changes execution tier or model selection
+ * in the model preferences field.
+ *
+ * ## Adding a new action
+ * 1. Add a new variant to the `ModelPreferencesEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit model preferences, create a new group file instead
+ *    (see other files in this directory for the template)
+ */
+export type ModelPreferencesEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'executionTierChanged';
+    attributes: {
+        executionTier: string;
+    };
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'executionModelChanged';
+    attributes: {
+        modelId: string | null;
+        executionTier: string;
+    };
+};

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

@@ -4,6 +4,7 @@ import type { EditingEventPayload } from '../actions/groups/editing';
 import type { EvaluationEventPayload } from '../actions/groups/evaluation';
 import type { InsightsEventPayload } from '../actions/groups/insights';
 import type { KnowledgeFiltersEventPayload } from '../actions/groups/knowledge-filters';
+import type { ModelPreferencesEventPayload } from '../actions/groups/model-preferences';
 import type { SubagentInteractionsEventPayload } from '../actions/groups/subagent-interactions';
 import type { ToolsEventPayload } from '../actions/groups/tools';
 export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;
@@ -51,4 +52,4 @@ export type ErrorEventPayload = {
  * Union of all event payload types.
  * Use with `trackAgentEvent()` for typed event tracking.
  */
-export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | SubagentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload | KnowledgeFiltersEventPayload;
+export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | SubagentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload | KnowledgeFiltersEventPayload | ModelPreferencesEventPayload;

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

@@ -14,7 +14,14 @@ export type EditingEventPayload = {
     actionSubject: 'rovoAgent';
     action: 'updated';
     attributes: VersionedAgentAttributes & {
-        agentType: string;
+        agentType?: string;
         field: string;
+        /**
+         * Identifies the subagent (formerly "scenario") whose configuration was updated.
+         * Pass the scenario/subagent id when the analytics event is fired at the
+         * scenario/subagent level. Pass `null` when the event is fired at the agent
+         * level (i.e. not scoped to any specific subagent).
+         */
+        subagentId: string | null;
     };
 };

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

@@ -0,0 +1,25 @@
+/**
+ * Action Group: modelPreferences
+ *
+ * Events fired when a user changes execution tier or model selection
+ * in the model preferences field.
+ *
+ * ## Adding a new action
+ * 1. Add a new variant to the `ModelPreferencesEventPayload` union type below with a data-portal link
+ * 2. If this action doesn't fit model preferences, create a new group file instead
+ *    (see other files in this directory for the template)
+ */
+export type ModelPreferencesEventPayload = {
+    actionSubject: 'rovoAgent';
+    action: 'executionTierChanged';
+    attributes: {
+        executionTier: string;
+    };
+} | {
+    actionSubject: 'rovoAgent';
+    action: 'executionModelChanged';
+    attributes: {
+        modelId: string | null;
+        executionTier: string;
+    };
+};

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

@@ -4,6 +4,7 @@ import type { EditingEventPayload } from '../actions/groups/editing';
 import type { EvaluationEventPayload } from '../actions/groups/evaluation';
 import type { InsightsEventPayload } from '../actions/groups/insights';
 import type { KnowledgeFiltersEventPayload } from '../actions/groups/knowledge-filters';
+import type { ModelPreferencesEventPayload } from '../actions/groups/model-preferences';
 import type { SubagentInteractionsEventPayload } from '../actions/groups/subagent-interactions';
 import type { ToolsEventPayload } from '../actions/groups/tools';
 export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;
@@ -51,4 +52,4 @@ export type ErrorEventPayload = {
  * Union of all event payload types.
  * Use with `trackAgentEvent()` for typed event tracking.
  */
-export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | SubagentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload | KnowledgeFiltersEventPayload;
+export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | SubagentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload | KnowledgeFiltersEventPayload | ModelPreferencesEventPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-agent-analytics",
-	"version": "1.7.0",
+	"version": "1.9.0",
 	"description": "Rovo Agents analytics",
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-monorepo",
 	"atlassian": {
@@ -39,7 +39,7 @@
 		"*.compiled.css"
 	],
 	"dependencies": {
-		"@atlaskit/analytics-listeners": "^10.0.0",
+		"@atlaskit/analytics-listeners": "^10.1.0",
 		"@atlaskit/analytics-next": "^11.2.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0"
@@ -50,6 +50,7 @@
 		"@atlaskit/ssr": "workspace:^",
 		"@atlassian/react-compiler-gating": "workspace:^",
 		"@testing-library/react": "^16.3.0",
+		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"peerDependencies": {