@atlaskit/teams-app-internal-analytics 1.22.0 → 1.23.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 +7 -0
- package/analytics.spec.yaml +43 -3
- package/dist/types/common/utils/generated/analytics.types.d.ts +22 -1
- package/dist/types/common/utils/types.d.ts +1 -1
- package/dist/types-ts4.5/common/utils/generated/analytics.types.d.ts +22 -1
- package/dist/types-ts4.5/common/utils/types.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @atlaskit/teams-app-internal-analytics
|
|
2
2
|
|
|
3
|
+
## 1.23.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`5092f69c488d8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5092f69c488d8) -
|
|
8
|
+
Implemented analytics for team profilecard package
|
|
9
|
+
|
|
3
10
|
## 1.22.0
|
|
4
11
|
|
|
5
12
|
### Minor Changes
|
package/analytics.spec.yaml
CHANGED
|
@@ -248,6 +248,9 @@ events:
|
|
|
248
248
|
numberOfMembers:
|
|
249
249
|
type: number
|
|
250
250
|
description: The number of members
|
|
251
|
+
numberOfSuggestedMembers:
|
|
252
|
+
type: number
|
|
253
|
+
description: The number of suggested members
|
|
251
254
|
defaultTeamType:
|
|
252
255
|
type: ['OPEN', 'MEMBER_INVITE', 'EXTERNAL', 'ORG_ADMIN_MANAGED']
|
|
253
256
|
required: false
|
|
@@ -329,6 +332,27 @@ events:
|
|
|
329
332
|
type: []
|
|
330
333
|
required: false
|
|
331
334
|
description: the errors
|
|
335
|
+
- teamSuggestionsRecommendedUsers succeeded:
|
|
336
|
+
type: operational
|
|
337
|
+
description: fired when the team suggestions recommended users API call succeeded
|
|
338
|
+
attributes:
|
|
339
|
+
<<: *PackageMetaDataContext
|
|
340
|
+
recommendedUsers:
|
|
341
|
+
type: number
|
|
342
|
+
description: the number of recommended users returned
|
|
343
|
+
- teamSuggestionsRecommendedUsers failed:
|
|
344
|
+
type: operational
|
|
345
|
+
description: fired when the team suggestions recommended users API call failed
|
|
346
|
+
attributes:
|
|
347
|
+
<<: *PackageMetaDataContext
|
|
348
|
+
recommendedUsers:
|
|
349
|
+
type: number
|
|
350
|
+
description: the number of recommended users (0 on failure)
|
|
351
|
+
errors:
|
|
352
|
+
type: []
|
|
353
|
+
required: false
|
|
354
|
+
description: error details from the failed API call
|
|
355
|
+
|
|
332
356
|
- invitedTeamMembers added:
|
|
333
357
|
type: track
|
|
334
358
|
description: fired when the invited team members are added
|
|
@@ -1920,6 +1944,10 @@ events:
|
|
|
1920
1944
|
gateway:
|
|
1921
1945
|
type: boolean
|
|
1922
1946
|
description: whether the request is a gateway request
|
|
1947
|
+
errorStack:
|
|
1948
|
+
type: string
|
|
1949
|
+
required: false
|
|
1950
|
+
description: The error stack trace from the failure
|
|
1923
1951
|
- rovoAgentProfilecard succeeded (request):
|
|
1924
1952
|
type: operational
|
|
1925
1953
|
description: fired when the rovo agent profilecard request is succeeded
|
|
@@ -3128,7 +3156,8 @@ events:
|
|
|
3128
3156
|
description: The consumer of the team
|
|
3129
3157
|
- invitePrompt eligibilityChecked:
|
|
3130
3158
|
type: operational
|
|
3131
|
-
description:
|
|
3159
|
+
description:
|
|
3160
|
+
Fired when eligibility check is performed for twcg_640_invite_prompt_on_teams_page_links
|
|
3132
3161
|
attributes:
|
|
3133
3162
|
isEligible:
|
|
3134
3163
|
type: boolean
|
|
@@ -3138,7 +3167,9 @@ events:
|
|
|
3138
3167
|
description: Optional parameter in case the user is not eligible for the experiment
|
|
3139
3168
|
- invitePrompt eligibilityCheckFailed:
|
|
3140
3169
|
type: operational
|
|
3141
|
-
description:
|
|
3170
|
+
description:
|
|
3171
|
+
Fired when eligibility check is for twcg_640_invite_prompt_on_teams_page_links failes for
|
|
3172
|
+
whatever reason
|
|
3142
3173
|
attributes:
|
|
3143
3174
|
error:
|
|
3144
3175
|
type: string
|
|
@@ -3165,7 +3196,9 @@ events:
|
|
|
3165
3196
|
description: Target app we'll invite the invitees to
|
|
3166
3197
|
- invitePrompt shown (successFlag):
|
|
3167
3198
|
type: ui
|
|
3168
|
-
description:
|
|
3199
|
+
description:
|
|
3200
|
+
Fired when the invitation action is successfully completed and the success flag is shown to
|
|
3201
|
+
the user
|
|
3169
3202
|
attributes:
|
|
3170
3203
|
invitedCount:
|
|
3171
3204
|
type: number
|
|
@@ -3212,3 +3245,10 @@ events:
|
|
|
3212
3245
|
cohort:
|
|
3213
3246
|
type: string
|
|
3214
3247
|
description: To which cohort was the user exposed to
|
|
3248
|
+
- invitePrompt showContainerAddedFlagFailed:
|
|
3249
|
+
type: operational
|
|
3250
|
+
description: Fired when something fails horribly inside of showContainerAddedFlagFailed
|
|
3251
|
+
attributes:
|
|
3252
|
+
error:
|
|
3253
|
+
type: string
|
|
3254
|
+
description: The error that was thrown
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Generates Typescript types for analytics events from analytics.spec.yaml
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::765b2b92134fbe5e83d238edaf99e6b9>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
|
|
8
8
|
*/
|
|
9
9
|
export type PackageMetaDataType = {
|
|
@@ -52,6 +52,7 @@ export type TeamCreateDialogClickedTeamLinkSuccessFlagAttributesType = {
|
|
|
52
52
|
export type TeamCreateDialogSucceededAttributesType = {
|
|
53
53
|
teamId: string;
|
|
54
54
|
numberOfMembers: number;
|
|
55
|
+
numberOfSuggestedMembers: number;
|
|
55
56
|
defaultTeamType: 'OPEN' | 'MEMBER_INVITE' | 'EXTERNAL' | 'ORG_ADMIN_MANAGED' | null;
|
|
56
57
|
chosenTeamType: 'OPEN' | 'MEMBER_INVITE' | 'EXTERNAL' | 'ORG_ADMIN_MANAGED';
|
|
57
58
|
teamTypeChoiceEnabled: boolean | null;
|
|
@@ -78,6 +79,13 @@ export type AddToTeamServiceFailedAttributesType = {
|
|
|
78
79
|
errorsCount: number | null;
|
|
79
80
|
errors: unknown[] | null;
|
|
80
81
|
};
|
|
82
|
+
export type TeamSuggestionsRecommendedUsersSucceededAttributesType = {
|
|
83
|
+
recommendedUsers: number;
|
|
84
|
+
};
|
|
85
|
+
export type TeamSuggestionsRecommendedUsersFailedAttributesType = {
|
|
86
|
+
recommendedUsers: number;
|
|
87
|
+
errors: unknown[] | null;
|
|
88
|
+
};
|
|
81
89
|
export type InvitedTeamMembersAddedAttributesType = {
|
|
82
90
|
numberOfMembers: number;
|
|
83
91
|
members: unknown[];
|
|
@@ -882,6 +890,7 @@ export type TeamProfileCardFailedRequestAttributesType = {
|
|
|
882
890
|
errorNumber: number | null;
|
|
883
891
|
isSLOFailure: boolean;
|
|
884
892
|
gateway: boolean;
|
|
893
|
+
errorStack: string | null;
|
|
885
894
|
};
|
|
886
895
|
export type RovoAgentProfilecardSucceededRequestAttributesType = {
|
|
887
896
|
firedAt: number;
|
|
@@ -1424,6 +1433,9 @@ export type FeatureExposedAttributesType = {
|
|
|
1424
1433
|
flagKey: string;
|
|
1425
1434
|
cohort: string;
|
|
1426
1435
|
};
|
|
1436
|
+
export type InvitePromptShowContainerAddedFlagFailedAttributesType = {
|
|
1437
|
+
error: string;
|
|
1438
|
+
};
|
|
1427
1439
|
export type AnalyticsEventAttributes = {
|
|
1428
1440
|
/**
|
|
1429
1441
|
* fired when the teams-app-internal-analytics example button is clicked */
|
|
@@ -1491,6 +1503,12 @@ export type AnalyticsEventAttributes = {
|
|
|
1491
1503
|
/**
|
|
1492
1504
|
* fired when the add to team service failed */
|
|
1493
1505
|
'track.addToTeamService.failed': AddToTeamServiceFailedAttributesType;
|
|
1506
|
+
/**
|
|
1507
|
+
* fired when the team suggestions recommended users API call succeeded */
|
|
1508
|
+
'operational.teamSuggestionsRecommendedUsers.succeeded': TeamSuggestionsRecommendedUsersSucceededAttributesType;
|
|
1509
|
+
/**
|
|
1510
|
+
* fired when the team suggestions recommended users API call failed */
|
|
1511
|
+
'operational.teamSuggestionsRecommendedUsers.failed': TeamSuggestionsRecommendedUsersFailedAttributesType;
|
|
1494
1512
|
/**
|
|
1495
1513
|
* fired when the invited team members are added */
|
|
1496
1514
|
'track.invitedTeamMembers.added': InvitedTeamMembersAddedAttributesType;
|
|
@@ -2432,5 +2450,8 @@ export type AnalyticsEventAttributes = {
|
|
|
2432
2450
|
/**
|
|
2433
2451
|
* Fired when a flag is exposed to a user */
|
|
2434
2452
|
'track.feature.exposed': FeatureExposedAttributesType;
|
|
2453
|
+
/**
|
|
2454
|
+
* Fired when something fails horribly inside of showContainerAddedFlagFailed */
|
|
2455
|
+
'operational.invitePrompt.showContainerAddedFlagFailed': InvitePromptShowContainerAddedFlagFailedAttributesType;
|
|
2435
2456
|
};
|
|
2436
2457
|
export type EventKey = keyof AnalyticsEventAttributes;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { EventKey } from './generated/analytics.types';
|
|
2
2
|
import type createEventPayload from './generated/create-event-payload';
|
|
3
3
|
export type FireEventType = <K extends EventKey>(...params: Parameters<typeof createEventPayload<K>>) => void;
|
|
4
|
-
export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen' | 'teamProfileCard';
|
|
4
|
+
export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen' | 'teamProfileCard' | 'teamProfileCardTrigger';
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Generates Typescript types for analytics events from analytics.spec.yaml
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::765b2b92134fbe5e83d238edaf99e6b9>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
|
|
8
8
|
*/
|
|
9
9
|
export type PackageMetaDataType = {
|
|
@@ -52,6 +52,7 @@ export type TeamCreateDialogClickedTeamLinkSuccessFlagAttributesType = {
|
|
|
52
52
|
export type TeamCreateDialogSucceededAttributesType = {
|
|
53
53
|
teamId: string;
|
|
54
54
|
numberOfMembers: number;
|
|
55
|
+
numberOfSuggestedMembers: number;
|
|
55
56
|
defaultTeamType: 'OPEN' | 'MEMBER_INVITE' | 'EXTERNAL' | 'ORG_ADMIN_MANAGED' | null;
|
|
56
57
|
chosenTeamType: 'OPEN' | 'MEMBER_INVITE' | 'EXTERNAL' | 'ORG_ADMIN_MANAGED';
|
|
57
58
|
teamTypeChoiceEnabled: boolean | null;
|
|
@@ -78,6 +79,13 @@ export type AddToTeamServiceFailedAttributesType = {
|
|
|
78
79
|
errorsCount: number | null;
|
|
79
80
|
errors: unknown[] | null;
|
|
80
81
|
};
|
|
82
|
+
export type TeamSuggestionsRecommendedUsersSucceededAttributesType = {
|
|
83
|
+
recommendedUsers: number;
|
|
84
|
+
};
|
|
85
|
+
export type TeamSuggestionsRecommendedUsersFailedAttributesType = {
|
|
86
|
+
recommendedUsers: number;
|
|
87
|
+
errors: unknown[] | null;
|
|
88
|
+
};
|
|
81
89
|
export type InvitedTeamMembersAddedAttributesType = {
|
|
82
90
|
numberOfMembers: number;
|
|
83
91
|
members: unknown[];
|
|
@@ -882,6 +890,7 @@ export type TeamProfileCardFailedRequestAttributesType = {
|
|
|
882
890
|
errorNumber: number | null;
|
|
883
891
|
isSLOFailure: boolean;
|
|
884
892
|
gateway: boolean;
|
|
893
|
+
errorStack: string | null;
|
|
885
894
|
};
|
|
886
895
|
export type RovoAgentProfilecardSucceededRequestAttributesType = {
|
|
887
896
|
firedAt: number;
|
|
@@ -1424,6 +1433,9 @@ export type FeatureExposedAttributesType = {
|
|
|
1424
1433
|
flagKey: string;
|
|
1425
1434
|
cohort: string;
|
|
1426
1435
|
};
|
|
1436
|
+
export type InvitePromptShowContainerAddedFlagFailedAttributesType = {
|
|
1437
|
+
error: string;
|
|
1438
|
+
};
|
|
1427
1439
|
export type AnalyticsEventAttributes = {
|
|
1428
1440
|
/**
|
|
1429
1441
|
* fired when the teams-app-internal-analytics example button is clicked */
|
|
@@ -1491,6 +1503,12 @@ export type AnalyticsEventAttributes = {
|
|
|
1491
1503
|
/**
|
|
1492
1504
|
* fired when the add to team service failed */
|
|
1493
1505
|
'track.addToTeamService.failed': AddToTeamServiceFailedAttributesType;
|
|
1506
|
+
/**
|
|
1507
|
+
* fired when the team suggestions recommended users API call succeeded */
|
|
1508
|
+
'operational.teamSuggestionsRecommendedUsers.succeeded': TeamSuggestionsRecommendedUsersSucceededAttributesType;
|
|
1509
|
+
/**
|
|
1510
|
+
* fired when the team suggestions recommended users API call failed */
|
|
1511
|
+
'operational.teamSuggestionsRecommendedUsers.failed': TeamSuggestionsRecommendedUsersFailedAttributesType;
|
|
1494
1512
|
/**
|
|
1495
1513
|
* fired when the invited team members are added */
|
|
1496
1514
|
'track.invitedTeamMembers.added': InvitedTeamMembersAddedAttributesType;
|
|
@@ -2432,5 +2450,8 @@ export type AnalyticsEventAttributes = {
|
|
|
2432
2450
|
/**
|
|
2433
2451
|
* Fired when a flag is exposed to a user */
|
|
2434
2452
|
'track.feature.exposed': FeatureExposedAttributesType;
|
|
2453
|
+
/**
|
|
2454
|
+
* Fired when something fails horribly inside of showContainerAddedFlagFailed */
|
|
2455
|
+
'operational.invitePrompt.showContainerAddedFlagFailed': InvitePromptShowContainerAddedFlagFailedAttributesType;
|
|
2435
2456
|
};
|
|
2436
2457
|
export type EventKey = keyof AnalyticsEventAttributes;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { EventKey } from './generated/analytics.types';
|
|
2
2
|
import type createEventPayload from './generated/create-event-payload';
|
|
3
3
|
export type FireEventType = <K extends EventKey>(...params: Parameters<typeof createEventPayload<K>>) => void;
|
|
4
|
-
export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen' | 'teamProfileCard';
|
|
4
|
+
export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen' | 'teamProfileCard' | 'teamProfileCardTrigger';
|
package/package.json
CHANGED
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
}
|
|
86
86
|
},
|
|
87
87
|
"name": "@atlaskit/teams-app-internal-analytics",
|
|
88
|
-
"version": "1.
|
|
88
|
+
"version": "1.23.0",
|
|
89
89
|
"description": "A package used by the teams app and platform packages to handle people and teams analytics",
|
|
90
90
|
"author": "Atlassian Pty Ltd",
|
|
91
91
|
"license": "Apache-2.0",
|