@atlaskit/rovo-agent-analytics 1.5.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/cjs/actions/groups/knowledge-filters.js +5 -0
- package/dist/cjs/actions/groups/subagent-interactions.js +5 -0
- package/dist/es2019/actions/groups/knowledge-filters.js +1 -0
- package/dist/es2019/actions/groups/subagent-interactions.js +1 -0
- package/dist/esm/actions/groups/knowledge-filters.js +1 -0
- package/dist/esm/actions/groups/subagent-interactions.js +1 -0
- package/dist/types/actions/groups/agent-interactions.d.ts +8 -0
- package/dist/types/actions/groups/knowledge-filters.d.ts +33 -0
- package/dist/types/actions/groups/subagent-interactions.d.ts +39 -0
- package/dist/types/common/types.d.ts +3 -1
- package/dist/types-ts4.5/actions/groups/agent-interactions.d.ts +8 -0
- package/dist/types-ts4.5/actions/groups/knowledge-filters.d.ts +33 -0
- package/dist/types-ts4.5/actions/groups/subagent-interactions.d.ts +39 -0
- package/dist/types-ts4.5/common/types.d.ts +3 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @atlaskit/rovo-agent-analytics
|
|
2
2
|
|
|
3
|
+
## 1.7.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`b72d0152846b8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b72d0152846b8) -
|
|
8
|
+
Fire knowledgeFilters analytics events: 'saved' on successful update and 'closed' on cancel from
|
|
9
|
+
ConnectorFilters; 'updated' from SelectFilter when the selection changes (filterOrControlId as
|
|
10
|
+
filter id, comma-joined option values).
|
|
11
|
+
|
|
12
|
+
## 1.6.0
|
|
13
|
+
|
|
14
|
+
### Minor Changes
|
|
15
|
+
|
|
16
|
+
- [`1382e455b2661`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1382e455b2661) -
|
|
17
|
+
Add subagent analytics tracking events for create, delete, edit tools and tool configuration
|
|
18
|
+
actions
|
|
19
|
+
|
|
3
20
|
## 1.5.0
|
|
4
21
|
|
|
5
22
|
### Minor Changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -52,4 +52,12 @@ export type AgentInteractionsEventPayload = {
|
|
|
52
52
|
actionSubject: 'rovoAgent';
|
|
53
53
|
action: 'unverify';
|
|
54
54
|
attributes: BaseAgentAnalyticsAttributes;
|
|
55
|
+
} | {
|
|
56
|
+
actionSubject: 'rovoAgent';
|
|
57
|
+
action: 'editTools';
|
|
58
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
59
|
+
} | {
|
|
60
|
+
actionSubject: 'rovoAgent';
|
|
61
|
+
action: 'editToolConfiguration';
|
|
62
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
55
63
|
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { BaseAgentAnalyticsAttributes } from '../../common/types';
|
|
2
|
+
type FilterAttributes = {
|
|
3
|
+
id: string;
|
|
4
|
+
selectedOptionsCount: number;
|
|
5
|
+
};
|
|
6
|
+
type KnowledgeSourceAttributes = BaseAgentAnalyticsAttributes & {
|
|
7
|
+
productKey: string;
|
|
8
|
+
};
|
|
9
|
+
export type KnowledgeFiltersEventPayload = {
|
|
10
|
+
actionSubject: 'rovoAgent';
|
|
11
|
+
action: 'knowledgeFiltersOpened';
|
|
12
|
+
attributes: KnowledgeSourceAttributes;
|
|
13
|
+
} | {
|
|
14
|
+
actionSubject: 'rovoAgent';
|
|
15
|
+
action: 'knowledgeFiltersClosed';
|
|
16
|
+
attributes: KnowledgeSourceAttributes;
|
|
17
|
+
} | {
|
|
18
|
+
actionSubject: 'rovoAgent';
|
|
19
|
+
action: 'knowledgeFiltersSaved';
|
|
20
|
+
attributes: KnowledgeSourceAttributes & {
|
|
21
|
+
filterCount: number;
|
|
22
|
+
filters: {
|
|
23
|
+
[key: string]: Omit<FilterAttributes, 'id'>;
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
} | {
|
|
27
|
+
actionSubject: 'rovoAgent';
|
|
28
|
+
action: 'knowledgeFiltersUpdated';
|
|
29
|
+
attributes: KnowledgeSourceAttributes & {
|
|
30
|
+
filter: FilterAttributes;
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export {};
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Action Group: agentInteractions
|
|
3
|
+
*
|
|
4
|
+
* User-initiated interactions with an agent — typically from the overflow menu ("...")
|
|
5
|
+
* or agent profile surfaces (viewing, editing, deleting, duplicating, starring, sharing, verifying).
|
|
6
|
+
*
|
|
7
|
+
* NOTE: This is about UI interactions, not backend "actions" (which are being replaced by "tools").
|
|
8
|
+
*
|
|
9
|
+
* ## Adding a new action
|
|
10
|
+
* 1. Add a new variant to the `AgentInteractionsEventPayload` union type below with a data-portal link
|
|
11
|
+
* 2. If this action doesn't fit user interactions, create a new group file instead
|
|
12
|
+
* (see other files in this directory for the template)
|
|
13
|
+
*/
|
|
14
|
+
import type { BaseAgentAnalyticsAttributes } from '../../common/types';
|
|
15
|
+
/**
|
|
16
|
+
* Discriminated union payload type for agent interaction events.
|
|
17
|
+
* Use with `trackAgentEvent()`.
|
|
18
|
+
*/
|
|
19
|
+
export type SubagentInteractionsEventPayload = {
|
|
20
|
+
actionSubject: 'rovoAgent';
|
|
21
|
+
action: 'subagentCreate';
|
|
22
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
23
|
+
} | {
|
|
24
|
+
actionSubject: 'rovoAgent';
|
|
25
|
+
action: 'subagentEdit';
|
|
26
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
27
|
+
} | {
|
|
28
|
+
actionSubject: 'rovoAgent';
|
|
29
|
+
action: 'subagentDelete';
|
|
30
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
31
|
+
} | {
|
|
32
|
+
actionSubject: 'rovoAgent';
|
|
33
|
+
action: 'subagentEditTools';
|
|
34
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
35
|
+
} | {
|
|
36
|
+
actionSubject: 'rovoAgent';
|
|
37
|
+
action: 'subagentEditToolConfiguration';
|
|
38
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
39
|
+
};
|
|
@@ -3,6 +3,8 @@ import type { DebugEventPayload } from '../actions/groups/debug';
|
|
|
3
3
|
import type { EditingEventPayload } from '../actions/groups/editing';
|
|
4
4
|
import type { EvaluationEventPayload } from '../actions/groups/evaluation';
|
|
5
5
|
import type { InsightsEventPayload } from '../actions/groups/insights';
|
|
6
|
+
import type { KnowledgeFiltersEventPayload } from '../actions/groups/knowledge-filters';
|
|
7
|
+
import type { SubagentInteractionsEventPayload } from '../actions/groups/subagent-interactions';
|
|
6
8
|
import type { ToolsEventPayload } from '../actions/groups/tools';
|
|
7
9
|
export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;
|
|
8
10
|
export type BaseAgentAnalyticsAttributes = {
|
|
@@ -49,4 +51,4 @@ export type ErrorEventPayload = {
|
|
|
49
51
|
* Union of all event payload types.
|
|
50
52
|
* Use with `trackAgentEvent()` for typed event tracking.
|
|
51
53
|
*/
|
|
52
|
-
export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload;
|
|
54
|
+
export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | SubagentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload | KnowledgeFiltersEventPayload;
|
|
@@ -52,4 +52,12 @@ export type AgentInteractionsEventPayload = {
|
|
|
52
52
|
actionSubject: 'rovoAgent';
|
|
53
53
|
action: 'unverify';
|
|
54
54
|
attributes: BaseAgentAnalyticsAttributes;
|
|
55
|
+
} | {
|
|
56
|
+
actionSubject: 'rovoAgent';
|
|
57
|
+
action: 'editTools';
|
|
58
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
59
|
+
} | {
|
|
60
|
+
actionSubject: 'rovoAgent';
|
|
61
|
+
action: 'editToolConfiguration';
|
|
62
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
55
63
|
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { BaseAgentAnalyticsAttributes } from '../../common/types';
|
|
2
|
+
type FilterAttributes = {
|
|
3
|
+
id: string;
|
|
4
|
+
selectedOptionsCount: number;
|
|
5
|
+
};
|
|
6
|
+
type KnowledgeSourceAttributes = BaseAgentAnalyticsAttributes & {
|
|
7
|
+
productKey: string;
|
|
8
|
+
};
|
|
9
|
+
export type KnowledgeFiltersEventPayload = {
|
|
10
|
+
actionSubject: 'rovoAgent';
|
|
11
|
+
action: 'knowledgeFiltersOpened';
|
|
12
|
+
attributes: KnowledgeSourceAttributes;
|
|
13
|
+
} | {
|
|
14
|
+
actionSubject: 'rovoAgent';
|
|
15
|
+
action: 'knowledgeFiltersClosed';
|
|
16
|
+
attributes: KnowledgeSourceAttributes;
|
|
17
|
+
} | {
|
|
18
|
+
actionSubject: 'rovoAgent';
|
|
19
|
+
action: 'knowledgeFiltersSaved';
|
|
20
|
+
attributes: KnowledgeSourceAttributes & {
|
|
21
|
+
filterCount: number;
|
|
22
|
+
filters: {
|
|
23
|
+
[key: string]: Omit<FilterAttributes, 'id'>;
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
} | {
|
|
27
|
+
actionSubject: 'rovoAgent';
|
|
28
|
+
action: 'knowledgeFiltersUpdated';
|
|
29
|
+
attributes: KnowledgeSourceAttributes & {
|
|
30
|
+
filter: FilterAttributes;
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export {};
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Action Group: agentInteractions
|
|
3
|
+
*
|
|
4
|
+
* User-initiated interactions with an agent — typically from the overflow menu ("...")
|
|
5
|
+
* or agent profile surfaces (viewing, editing, deleting, duplicating, starring, sharing, verifying).
|
|
6
|
+
*
|
|
7
|
+
* NOTE: This is about UI interactions, not backend "actions" (which are being replaced by "tools").
|
|
8
|
+
*
|
|
9
|
+
* ## Adding a new action
|
|
10
|
+
* 1. Add a new variant to the `AgentInteractionsEventPayload` union type below with a data-portal link
|
|
11
|
+
* 2. If this action doesn't fit user interactions, create a new group file instead
|
|
12
|
+
* (see other files in this directory for the template)
|
|
13
|
+
*/
|
|
14
|
+
import type { BaseAgentAnalyticsAttributes } from '../../common/types';
|
|
15
|
+
/**
|
|
16
|
+
* Discriminated union payload type for agent interaction events.
|
|
17
|
+
* Use with `trackAgentEvent()`.
|
|
18
|
+
*/
|
|
19
|
+
export type SubagentInteractionsEventPayload = {
|
|
20
|
+
actionSubject: 'rovoAgent';
|
|
21
|
+
action: 'subagentCreate';
|
|
22
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
23
|
+
} | {
|
|
24
|
+
actionSubject: 'rovoAgent';
|
|
25
|
+
action: 'subagentEdit';
|
|
26
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
27
|
+
} | {
|
|
28
|
+
actionSubject: 'rovoAgent';
|
|
29
|
+
action: 'subagentDelete';
|
|
30
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
31
|
+
} | {
|
|
32
|
+
actionSubject: 'rovoAgent';
|
|
33
|
+
action: 'subagentEditTools';
|
|
34
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
35
|
+
} | {
|
|
36
|
+
actionSubject: 'rovoAgent';
|
|
37
|
+
action: 'subagentEditToolConfiguration';
|
|
38
|
+
attributes: BaseAgentAnalyticsAttributes;
|
|
39
|
+
};
|
|
@@ -3,6 +3,8 @@ import type { DebugEventPayload } from '../actions/groups/debug';
|
|
|
3
3
|
import type { EditingEventPayload } from '../actions/groups/editing';
|
|
4
4
|
import type { EvaluationEventPayload } from '../actions/groups/evaluation';
|
|
5
5
|
import type { InsightsEventPayload } from '../actions/groups/insights';
|
|
6
|
+
import type { KnowledgeFiltersEventPayload } from '../actions/groups/knowledge-filters';
|
|
7
|
+
import type { SubagentInteractionsEventPayload } from '../actions/groups/subagent-interactions';
|
|
6
8
|
import type { ToolsEventPayload } from '../actions/groups/tools';
|
|
7
9
|
export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;
|
|
8
10
|
export type BaseAgentAnalyticsAttributes = {
|
|
@@ -49,4 +51,4 @@ export type ErrorEventPayload = {
|
|
|
49
51
|
* Union of all event payload types.
|
|
50
52
|
* Use with `trackAgentEvent()` for typed event tracking.
|
|
51
53
|
*/
|
|
52
|
-
export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload;
|
|
54
|
+
export type EventPayload = EditingEventPayload | AgentInteractionsEventPayload | SubagentInteractionsEventPayload | DebugEventPayload | ToolsEventPayload | EvaluationEventPayload | InsightsEventPayload | ErrorEventPayload | KnowledgeFiltersEventPayload;
|