@atlaskit/teams-app-internal-analytics 1.24.2 → 1.25.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/teams-app-internal-analytics
 
+## 1.25.0
+
+### Minor Changes
+
+- [`8204a3c66c06b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8204a3c66c06b) -
+  Add analytics for starred mutations
+
 ## 1.24.2
 
 ### Patch Changes

package/analytics.spec.yaml

@@ -3166,7 +3166,8 @@ events:
         <<: *NewUserProfileAttribute
   - userProfileWorkingWithMe viewed:
       type: screen
-      description: fired when user profile working with me section is viewed (only when section has content)
+      description:
+        fired when user profile working with me section is viewed (only when section has content)
   - teamAgentsPanel viewed:
       type: screen
       description: fired when team agents panel is viewed
@@ -3325,3 +3326,22 @@ events:
           required: false
           type: number
           description: The number of times the user has tried to add requested containers
+  - starred succeeded (team):
+      type: track
+      description: fired when a team is starred or unstarred succeeds
+      attributes:
+        <<: *PackageMetaDataContext
+        starred:
+          type: boolean
+          description: Whether the team is starred or not
+  - starred failed (team):
+      type: track
+      description: fired when starring or unstarring a team fails
+      attributes:
+        <<: *PackageMetaDataContext
+        starred:
+          type: boolean
+          description: Whether the action was to star or unstar the team
+        errorMessage:
+          type: string
+          description: The error message describing why the action failed

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::404bdf7d30df1f4487b74a9e3c00c09d>>
+ * @codegen <<SignedSource::eb14794ea55d11eab670651d5ba76de8>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
  */
 export type PackageMetaDataType = {
@@ -1495,6 +1495,13 @@ export type RequestedContainersFailedAttributesType = {
     teamId: string;
     tryAgainCount: number | null;
 };
+export type StarredSucceededTeamAttributesType = {
+    starred: boolean;
+};
+export type StarredFailedTeamAttributesType = {
+    starred: boolean;
+    errorMessage: string;
+};
 export type AnalyticsEventAttributes = {
     /**
      * fired when the teams-app-internal-analytics example button is clicked */
@@ -2525,5 +2532,11 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when the user fails to add requested containers */
     'track.requestedContainers.failed': RequestedContainersFailedAttributesType;
+    /**
+     * fired when a team is starred or unstarred succeeds */
+    'track.starred.succeeded.team': StarredSucceededTeamAttributesType;
+    /**
+     * fired when starring or unstarring a team fails */
+    'track.starred.failed.team': StarredFailedTeamAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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::404bdf7d30df1f4487b74a9e3c00c09d>>
+ * @codegen <<SignedSource::eb14794ea55d11eab670651d5ba76de8>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
  */
 export type PackageMetaDataType = {
@@ -1495,6 +1495,13 @@ export type RequestedContainersFailedAttributesType = {
     teamId: string;
     tryAgainCount: number | null;
 };
+export type StarredSucceededTeamAttributesType = {
+    starred: boolean;
+};
+export type StarredFailedTeamAttributesType = {
+    starred: boolean;
+    errorMessage: string;
+};
 export type AnalyticsEventAttributes = {
     /**
      * fired when the teams-app-internal-analytics example button is clicked */
@@ -2525,5 +2532,11 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when the user fails to add requested containers */
     'track.requestedContainers.failed': RequestedContainersFailedAttributesType;
+    /**
+     * fired when a team is starred or unstarred succeeds */
+    'track.starred.succeeded.team': StarredSucceededTeamAttributesType;
+    /**
+     * fired when starring or unstarring a team fails */
+    'track.starred.failed.team': StarredFailedTeamAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

package/package.json

@@ -84,7 +84,7 @@
 		}
 	},
 	"name": "@atlaskit/teams-app-internal-analytics",
-	"version": "1.24.2",
+	"version": "1.25.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",