@atlaskit/teams-app-internal-analytics 1.17.2 → 1.18.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/teams-app-internal-analytics
 
+## 1.18.0
+
+### Minor Changes
+
+- [`f2ea519415d68`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2ea519415d68) -
+  Migrated search page analytics from ptc-embeddable-directory to teams-app-internal-analytics
+
 ## 1.17.2
 
 ### Patch Changes

package/analytics.spec.yaml

@@ -2459,6 +2459,15 @@ events:
   - showMore clicked:
       type: ui
       description: fired when the show more button is clicked
+      attributes:
+        selectedUser:
+          type: boolean
+          required: false
+          description: whether the selected user is the current user
+        withSearchQuery:
+          type: boolean
+          required: false
+          description: whether the search query is present
   - teamCreateDialogTriggerButton clicked:
       type: ui
       description: fired when the team create dialog trigger button is clicked
@@ -2876,3 +2885,97 @@ events:
           type: boolean
           description: whether the user is verified
           required: false
+  - peopleHome viewed:
+      type: screen
+      description: fired when the people home is viewed
+  - userFilter selected:
+      type: ui
+      description: fired when a user filter is selected
+      attributes:
+        isCurrentUser:
+          type: boolean
+          description: whether the selected user is the current user
+  - teamElement clicked:
+      type: ui
+      description: fired when a team element is clicked
+      attributes:
+        entryIndex:
+          type: number
+          description: the index
+        withSearchQuery:
+          type: boolean
+          description: whether the search query is present
+        isCurrentUser:
+          type: boolean
+          description: whether the selected user is the current user
+  - suggestedCollaborators clicked:
+      type: ui
+      description: fired when a suggested collaborator is clicked
+      attributes:
+        entryIndex:
+          type: number
+          description: the index
+  - ViewDirectoryFiltersInAtlas clicked:
+      type: ui
+      description: fired when the view directory filters in atlas is clicked
+      attributes:
+        isAdmin:
+          type: boolean
+          description: whether the user is a site admin
+        product:
+          type: string
+          description: the product
+        workspaceUuid:
+          type: string
+          description: the workspace uuid
+          required: false
+  - yourTeams clicked:
+      type: ui
+      description: fired when the your teams is clicked
+      attributes:
+        entryIndex:
+          type: number
+          description: the index
+  - browseAllTeams clicked:
+      type: ui
+      description: fired when the browse all teams is clicked
+  - addPeopleButton clicked:
+      type: ui
+      description: fired when the add people button is clicked
+      attributes:
+        trigger:
+          type: string
+          description: the trigger
+  - teamSearchResult clicked:
+      type: ui
+      description: fired when the team search result is clicked
+      attributes:
+        entryIndex:
+          type: number
+          description: the index
+        withSearchQuery:
+          type: boolean
+          description: whether the search query is present
+  - recentCollaborator clicked:
+      type: ui
+      description: fired when the recent collaborator is clicked
+      attributes:
+        entryIndex:
+          type: number
+          description: the index
+        sessionId:
+          type: string
+          description: the session id
+        dataSource:
+          type: string
+          description: the data source
+  - peopleSearchResult clicked:
+      type: ui
+      description: fired when the people search result is clicked
+      attributes:
+        entryIndex:
+          type: number
+          description: the index
+        withSearchQuery:
+          type: boolean
+          description: whether the search query is present

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::a6b20df2d2f431cd63752ff404dab502>>
+ * @codegen <<SignedSource::cca058e42b3290c5e6cd84091c7e9308>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
  */
 export type PackageMetaDataType = {
@@ -1149,7 +1149,10 @@ export type PrivacyPolicyLinkClickedAttributesType = undefined;
 export type TeamProfileItemClickedAttributesType = {
     position: number;
 };
-export type ShowMoreClickedAttributesType = undefined;
+export type ShowMoreClickedAttributesType = {
+    selectedUser: boolean | null;
+    withSearchQuery: boolean | null;
+};
 export type TeamCreateDialogTriggerButtonClickedAttributesType = {
     trigger: string;
 };
@@ -1303,6 +1306,43 @@ export type TeamLinkEditedAttributesType = {
     orgAdminTriggered: boolean;
     isVerified: boolean | null;
 };
+export type PeopleHomeViewedAttributesType = undefined;
+export type UserFilterSelectedAttributesType = {
+    isCurrentUser: boolean;
+};
+export type TeamElementClickedAttributesType = {
+    entryIndex: number;
+    withSearchQuery: boolean;
+    isCurrentUser: boolean;
+};
+export type SuggestedCollaboratorsClickedAttributesType = {
+    entryIndex: number;
+};
+export type ViewDirectoryFiltersInAtlasClickedAttributesType = {
+    isAdmin: boolean;
+    product: string;
+    workspaceUuid: string | null;
+};
+export type YourTeamsClickedAttributesType = {
+    entryIndex: number;
+};
+export type BrowseAllTeamsClickedAttributesType = undefined;
+export type AddPeopleButtonClickedAttributesType = {
+    trigger: string;
+};
+export type TeamSearchResultClickedAttributesType = {
+    entryIndex: number;
+    withSearchQuery: boolean;
+};
+export type RecentCollaboratorClickedAttributesType = {
+    entryIndex: number;
+    sessionId: string;
+    dataSource: string;
+};
+export type PeopleSearchResultClickedAttributesType = {
+    entryIndex: number;
+    withSearchQuery: boolean;
+};
 export type AnalyticsEventAttributes = {
     /**
      * fired when the teams-app-internal-analytics example button is clicked */
@@ -2227,5 +2267,38 @@ export type AnalyticsEventAttributes = {
     /**
      * fired when a team link is successfully edited */
     'track.teamLink.edited': TeamLinkEditedAttributesType;
+    /**
+     * fired when the people home is viewed */
+    'screen.peopleHome.viewed': PeopleHomeViewedAttributesType;
+    /**
+     * fired when a user filter is selected */
+    'ui.userFilter.selected': UserFilterSelectedAttributesType;
+    /**
+     * fired when a team element is clicked */
+    'ui.teamElement.clicked': TeamElementClickedAttributesType;
+    /**
+     * fired when a suggested collaborator is clicked */
+    'ui.suggestedCollaborators.clicked': SuggestedCollaboratorsClickedAttributesType;
+    /**
+     * fired when the view directory filters in atlas is clicked */
+    'ui.ViewDirectoryFiltersInAtlas.clicked': ViewDirectoryFiltersInAtlasClickedAttributesType;
+    /**
+     * fired when the your teams is clicked */
+    'ui.yourTeams.clicked': YourTeamsClickedAttributesType;
+    /**
+     * fired when the browse all teams is clicked */
+    'ui.browseAllTeams.clicked': BrowseAllTeamsClickedAttributesType;
+    /**
+     * fired when the add people button is clicked */
+    'ui.addPeopleButton.clicked': AddPeopleButtonClickedAttributesType;
+    /**
+     * fired when the team search result is clicked */
+    'ui.teamSearchResult.clicked': TeamSearchResultClickedAttributesType;
+    /**
+     * fired when the recent collaborator is clicked */
+    'ui.recentCollaborator.clicked': RecentCollaboratorClickedAttributesType;
+    /**
+     * fired when the people search result is clicked */
+    'ui.peopleSearchResult.clicked': PeopleSearchResultClickedAttributesType;
 };
 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';
+export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen';

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::a6b20df2d2f431cd63752ff404dab502>>
+ * @codegen <<SignedSource::cca058e42b3290c5e6cd84091c7e9308>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
  */
 export type PackageMetaDataType = {
@@ -1149,7 +1149,10 @@ export type PrivacyPolicyLinkClickedAttributesType = undefined;
 export type TeamProfileItemClickedAttributesType = {
     position: number;
 };
-export type ShowMoreClickedAttributesType = undefined;
+export type ShowMoreClickedAttributesType = {
+    selectedUser: boolean | null;
+    withSearchQuery: boolean | null;
+};
 export type TeamCreateDialogTriggerButtonClickedAttributesType = {
     trigger: string;
 };
@@ -1303,6 +1306,43 @@ export type TeamLinkEditedAttributesType = {
     orgAdminTriggered: boolean;
     isVerified: boolean | null;
 };
+export type PeopleHomeViewedAttributesType = undefined;
+export type UserFilterSelectedAttributesType = {
+    isCurrentUser: boolean;
+};
+export type TeamElementClickedAttributesType = {
+    entryIndex: number;
+    withSearchQuery: boolean;
+    isCurrentUser: boolean;
+};
+export type SuggestedCollaboratorsClickedAttributesType = {
+    entryIndex: number;
+};
+export type ViewDirectoryFiltersInAtlasClickedAttributesType = {
+    isAdmin: boolean;
+    product: string;
+    workspaceUuid: string | null;
+};
+export type YourTeamsClickedAttributesType = {
+    entryIndex: number;
+};
+export type BrowseAllTeamsClickedAttributesType = undefined;
+export type AddPeopleButtonClickedAttributesType = {
+    trigger: string;
+};
+export type TeamSearchResultClickedAttributesType = {
+    entryIndex: number;
+    withSearchQuery: boolean;
+};
+export type RecentCollaboratorClickedAttributesType = {
+    entryIndex: number;
+    sessionId: string;
+    dataSource: string;
+};
+export type PeopleSearchResultClickedAttributesType = {
+    entryIndex: number;
+    withSearchQuery: boolean;
+};
 export type AnalyticsEventAttributes = {
     /**
      * fired when the teams-app-internal-analytics example button is clicked */
@@ -2227,5 +2267,38 @@ export type AnalyticsEventAttributes = {
     /**
      * fired when a team link is successfully edited */
     'track.teamLink.edited': TeamLinkEditedAttributesType;
+    /**
+     * fired when the people home is viewed */
+    'screen.peopleHome.viewed': PeopleHomeViewedAttributesType;
+    /**
+     * fired when a user filter is selected */
+    'ui.userFilter.selected': UserFilterSelectedAttributesType;
+    /**
+     * fired when a team element is clicked */
+    'ui.teamElement.clicked': TeamElementClickedAttributesType;
+    /**
+     * fired when a suggested collaborator is clicked */
+    'ui.suggestedCollaborators.clicked': SuggestedCollaboratorsClickedAttributesType;
+    /**
+     * fired when the view directory filters in atlas is clicked */
+    'ui.ViewDirectoryFiltersInAtlas.clicked': ViewDirectoryFiltersInAtlasClickedAttributesType;
+    /**
+     * fired when the your teams is clicked */
+    'ui.yourTeams.clicked': YourTeamsClickedAttributesType;
+    /**
+     * fired when the browse all teams is clicked */
+    'ui.browseAllTeams.clicked': BrowseAllTeamsClickedAttributesType;
+    /**
+     * fired when the add people button is clicked */
+    'ui.addPeopleButton.clicked': AddPeopleButtonClickedAttributesType;
+    /**
+     * fired when the team search result is clicked */
+    'ui.teamSearchResult.clicked': TeamSearchResultClickedAttributesType;
+    /**
+     * fired when the recent collaborator is clicked */
+    'ui.recentCollaborator.clicked': RecentCollaboratorClickedAttributesType;
+    /**
+     * fired when the people search result is clicked */
+    'ui.peopleSearchResult.clicked': PeopleSearchResultClickedAttributesType;
 };
 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';
+export type AnalyticsEventSource = 'userProfileScreen' | 'teamProfileAbout' | 'teamProfileScreen' | 'userMenu' | 'peopleHome' | 'avatarInitialsPicker' | 'peopleDirectorySearchPage' | 'peopleDirectorySearchResultsPage' | 'createTeamModal' | 'agentProfileScreen' | 'teamRestoreScreen' | 'teamsPage' | 'directoryScreen';

package/package.json

@@ -88,7 +88,7 @@
 		}
 	},
 	"name": "@atlaskit/teams-app-internal-analytics",
-	"version": "1.17.2",
+	"version": "1.18.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",