@atlaskit/teams-app-internal-analytics 1.20.3 → 1.22.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/teams-app-internal-analytics
 
+## 1.22.0
+
+### Minor Changes
+
+- [`b1ec68ffd476e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b1ec68ffd476e) -
+  Added new method attribute value to the team profile card triggered event
+
+## 1.21.0
+
+### Minor Changes
+
+- [`671ce2af0ccd5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/671ce2af0ccd5) -
+  Added analytics context support for team profilecard
+
 ## 1.20.3
 
 ### Patch Changes

package/analytics.spec.yaml

@@ -1707,7 +1707,7 @@ events:
       attributes:
         <<: [*PackageMetaDataContext, *ProfileCardAttributes]
         method:
-          type: ['hover', 'click']
+          type: ['hover', 'click', 'keyboard']
           description: the method of the profilecard
         teamId:
           type: string
@@ -3126,3 +3126,89 @@ events:
         consumer:
           type: string
           description: The consumer of the team
+  - invitePrompt eligibilityChecked:
+      type: operational
+      description: Fired when eligibility check is performed for twcg_640_invite_prompt_on_teams_page_links
+      attributes:
+        isEligible:
+          type: boolean
+          description: If the user turns out to be eligible or not
+        ineligibilityReason:
+          type: string
+          description: Optional parameter in case the user is not eligible for the experiment
+  - invitePrompt eligibilityCheckFailed:
+      type: operational
+      description: Fired when eligibility check is for twcg_640_invite_prompt_on_teams_page_links failes for whatever reason
+      attributes:
+        error:
+          type: string
+          description: The error that was thrown
+  - invitePrompt shown (flag):
+      type: ui
+      description: Fired when the invite prompt flag is displayed to the user
+      attributes:
+        inviteesCount:
+          type: number
+          description: Number of possible members to be invited
+        targetApp:
+          type: string
+          description: Target app we'll invite the invitees to
+  - invitePrompt clicked (inviteButton):
+      type: ui
+      description: Fired when the user clicks on Invite X team members / Invite X
+      attributes:
+        inviteesCount:
+          type: number
+          description: Number of possible members being invited
+        targetApp:
+          type: string
+          description: Target app we'll invite the invitees to
+  - invitePrompt shown (successFlag):
+      type: ui
+      description: Fired when the invitation action is successfully completed and the success flag is shown to the user
+      attributes:
+        invitedCount:
+          type: number
+          description: Number of users invited to target app
+        requestedAccessCount:
+          type: number
+          description: Number of users whose access have been requested for target app
+        variant:
+          type: string
+          description: Which version of the flag was displayed
+        targetApp:
+          type: string
+          description: Target app to which users have been RAd or invited
+  - invitePrompt shown (failedFlag):
+      type: ui
+      description: Fired when the invite action fails and we shown an error flag to the user
+      attributes:
+        invitedCount:
+          type: number
+          description: Number of members we successfully invited or RAd
+        failedCount:
+          type: number
+          description: Number of members we failed to invited
+        totalCount:
+          type: number
+          description: Total number of members we tried to invite
+  - invitePrompt clicked (dismissButton):
+      type: ui
+      description: Fired when the users dismisses the invite prompt flag
+      attributes:
+        inviteesCount:
+          type: number
+          description: Number of possible members being invited
+        targetApp:
+          type: string
+          description: Target app to which users would have been invited to
+  - feature exposed:
+      type: track
+      description: Fired when a flag is exposed to a user
+      attributes:
+        flagKey:
+          type: string
+          description: The feature flag/experiment key on Switcheroo
+        cohort:
+          type: string
+          description: To which cohort was the user exposed to

package/dist/types/common/utils/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::342c7a0cbb4be6a44fd40226c94247f7>>
+ * @codegen <<SignedSource::beeb7e237687a19ef573366721734994>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
  */
 export type PackageMetaDataType = {
@@ -757,7 +757,7 @@ export type RovoAgentProfilecardTriggeredAttributesType = {
 };
 export type TeamProfileCardTriggeredAttributesType = {
     firedAt: number;
-    method: 'hover' | 'click';
+    method: 'hover' | 'click' | 'keyboard';
     teamId: string;
 };
 export type UserTriggeredAttributesType = {
@@ -1390,6 +1390,40 @@ export type TeamAssignedTypePickerClickedAttributesType = {
     teamProfileTabIndex: number;
     consumer: string;
 };
+export type InvitePromptEligibilityCheckedAttributesType = {
+    isEligible: boolean;
+    ineligibilityReason: string;
+};
+export type InvitePromptEligibilityCheckFailedAttributesType = {
+    error: string;
+};
+export type InvitePromptShownFlagAttributesType = {
+    inviteesCount: number;
+    targetApp: string;
+};
+export type InvitePromptClickedInviteButtonAttributesType = {
+    inviteesCount: number;
+    targetApp: string;
+};
+export type InvitePromptShownSuccessFlagAttributesType = {
+    invitedCount: number;
+    requestedAccessCount: number;
+    variant: string;
+    targetApp: string;
+};
+export type InvitePromptShownFailedFlagAttributesType = {
+    invitedCount: number;
+    failedCount: number;
+    totalCount: number;
+};
+export type InvitePromptClickedDismissButtonAttributesType = {
+    inviteesCount: number;
+    targetApp: string;
+};
+export type FeatureExposedAttributesType = {
+    flagKey: string;
+    cohort: string;
+};
 export type AnalyticsEventAttributes = {
     /**
      * fired when the teams-app-internal-analytics example button is clicked */
@@ -2374,5 +2408,29 @@ export type AnalyticsEventAttributes = {
     /**
      * fired when team assigned type picker is clicked */
     'ui.teamAssignedTypePicker.clicked': TeamAssignedTypePickerClickedAttributesType;
+    /**
+     * Fired when eligibility check is performed for twcg_640_invite_prompt_on_teams_page_links */
+    'operational.invitePrompt.eligibilityChecked': InvitePromptEligibilityCheckedAttributesType;
+    /**
+     * Fired when eligibility check is for twcg_640_invite_prompt_on_teams_page_links failes for whatever reason */
+    'operational.invitePrompt.eligibilityCheckFailed': InvitePromptEligibilityCheckFailedAttributesType;
+    /**
+     * Fired when the invite prompt flag is displayed to the user */
+    'ui.invitePrompt.shown.flag': InvitePromptShownFlagAttributesType;
+    /**
+     * Fired when the user clicks on Invite X team members / Invite X */
+    'ui.invitePrompt.clicked.inviteButton': InvitePromptClickedInviteButtonAttributesType;
+    /**
+     * Fired when the invitation action is successfully completed and the success flag is shown to the user */
+    'ui.invitePrompt.shown.successFlag': InvitePromptShownSuccessFlagAttributesType;
+    /**
+     * Fired when the invite action fails and we shown an error flag to the user */
+    'ui.invitePrompt.shown.failedFlag': InvitePromptShownFailedFlagAttributesType;
+    /**
+     * Fired when the users dismisses the invite prompt flag */
+    'ui.invitePrompt.clicked.dismissButton': InvitePromptClickedDismissButtonAttributesType;
+    /**
+     * Fired when a flag is exposed to a user */
+    'track.feature.exposed': FeatureExposedAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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

@@ -1,4 +1,4 @@
 import type { EventKey } from './generated/analytics.types';
 import type createEventPayload from './generated/create-event-payload';
 export type FireEventType = <K extends EventKey>(...params: Parameters<typeof createEventPayload<K>>) => void;
-export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen';
+export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen' | 'teamProfileCard';

package/dist/types-ts4.5/common/utils/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::342c7a0cbb4be6a44fd40226c94247f7>>
+ * @codegen <<SignedSource::beeb7e237687a19ef573366721734994>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
  */
 export type PackageMetaDataType = {
@@ -757,7 +757,7 @@ export type RovoAgentProfilecardTriggeredAttributesType = {
 };
 export type TeamProfileCardTriggeredAttributesType = {
     firedAt: number;
-    method: 'hover' | 'click';
+    method: 'hover' | 'click' | 'keyboard';
     teamId: string;
 };
 export type UserTriggeredAttributesType = {
@@ -1390,6 +1390,40 @@ export type TeamAssignedTypePickerClickedAttributesType = {
     teamProfileTabIndex: number;
     consumer: string;
 };
+export type InvitePromptEligibilityCheckedAttributesType = {
+    isEligible: boolean;
+    ineligibilityReason: string;
+};
+export type InvitePromptEligibilityCheckFailedAttributesType = {
+    error: string;
+};
+export type InvitePromptShownFlagAttributesType = {
+    inviteesCount: number;
+    targetApp: string;
+};
+export type InvitePromptClickedInviteButtonAttributesType = {
+    inviteesCount: number;
+    targetApp: string;
+};
+export type InvitePromptShownSuccessFlagAttributesType = {
+    invitedCount: number;
+    requestedAccessCount: number;
+    variant: string;
+    targetApp: string;
+};
+export type InvitePromptShownFailedFlagAttributesType = {
+    invitedCount: number;
+    failedCount: number;
+    totalCount: number;
+};
+export type InvitePromptClickedDismissButtonAttributesType = {
+    inviteesCount: number;
+    targetApp: string;
+};
+export type FeatureExposedAttributesType = {
+    flagKey: string;
+    cohort: string;
+};
 export type AnalyticsEventAttributes = {
     /**
      * fired when the teams-app-internal-analytics example button is clicked */
@@ -2374,5 +2408,29 @@ export type AnalyticsEventAttributes = {
     /**
      * fired when team assigned type picker is clicked */
     'ui.teamAssignedTypePicker.clicked': TeamAssignedTypePickerClickedAttributesType;
+    /**
+     * Fired when eligibility check is performed for twcg_640_invite_prompt_on_teams_page_links */
+    'operational.invitePrompt.eligibilityChecked': InvitePromptEligibilityCheckedAttributesType;
+    /**
+     * Fired when eligibility check is for twcg_640_invite_prompt_on_teams_page_links failes for whatever reason */
+    'operational.invitePrompt.eligibilityCheckFailed': InvitePromptEligibilityCheckFailedAttributesType;
+    /**
+     * Fired when the invite prompt flag is displayed to the user */
+    'ui.invitePrompt.shown.flag': InvitePromptShownFlagAttributesType;
+    /**
+     * Fired when the user clicks on Invite X team members / Invite X */
+    'ui.invitePrompt.clicked.inviteButton': InvitePromptClickedInviteButtonAttributesType;
+    /**
+     * Fired when the invitation action is successfully completed and the success flag is shown to the user */
+    'ui.invitePrompt.shown.successFlag': InvitePromptShownSuccessFlagAttributesType;
+    /**
+     * Fired when the invite action fails and we shown an error flag to the user */
+    'ui.invitePrompt.shown.failedFlag': InvitePromptShownFailedFlagAttributesType;
+    /**
+     * Fired when the users dismisses the invite prompt flag */
+    'ui.invitePrompt.clicked.dismissButton': InvitePromptClickedDismissButtonAttributesType;
+    /**
+     * Fired when a flag is exposed to a user */
+    'track.feature.exposed': FeatureExposedAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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

@@ -1,4 +1,4 @@
 import type { EventKey } from './generated/analytics.types';
 import type createEventPayload from './generated/create-event-payload';
 export type FireEventType = <K extends EventKey>(...params: Parameters<typeof createEventPayload<K>>) => void;
-export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen';
+export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen' | 'teamProfileCard';

package/package.json

@@ -85,7 +85,7 @@
 		}
 	},
 	"name": "@atlaskit/teams-app-internal-analytics",
-	"version": "1.20.3",
+	"version": "1.22.0",
 	"description": "A package used by the teams app and platform packages to handle people and teams analytics",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",