@atlaskit/teams-app-internal-analytics 1.9.0 → 1.10.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 CHANGED
@@ -1,5 +1,12 @@
1
1
  # @atlaskit/teams-app-internal-analytics
2
2
 
3
+ ## 1.10.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`143f58c914711`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/143f58c914711) -
8
+ Migated kudos list analytics to teams-app-internal-analytics
9
+
3
10
  ## 1.9.0
4
11
 
5
12
  ### Minor Changes
@@ -2135,3 +2135,27 @@ events:
2135
2135
  error:
2136
2136
  type: string
2137
2137
  description: the error message
2138
+ - ProfileKudos viewed:
2139
+ type: ui
2140
+ description: fired when the profile kudos is viewed
2141
+ attributes:
2142
+ isEmpty:
2143
+ type: boolean
2144
+ description: whether the profile kudos is empty
2145
+ - ProfileKudosTab clicked:
2146
+ type: ui
2147
+ description: fired when the profile kudos tab is clicked
2148
+ attributes:
2149
+ tabName:
2150
+ type: ['given', 'received']
2151
+ description: the name of the tab
2152
+ - ProfileKudos clicked:
2153
+ type: ui
2154
+ description: fired when a kudos item is clicked
2155
+ attributes:
2156
+ kudosId:
2157
+ type: string
2158
+ description: the id of the kudos
2159
+ tabName:
2160
+ type: ['given', 'received']
2161
+ description: the name of the tab
@@ -3,5 +3,11 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.EVENT_CHANNEL = void 0;
7
- var EVENT_CHANNEL = exports.EVENT_CHANNEL = 'peopleTeams';
6
+ exports.EVENT_CHANNEL = exports.AnalyticsEventSource = void 0;
7
+ var EVENT_CHANNEL = exports.EVENT_CHANNEL = 'peopleTeams';
8
+ var AnalyticsEventSource = exports.AnalyticsEventSource = /*#__PURE__*/function (AnalyticsEventSource) {
9
+ AnalyticsEventSource["USER_PROFILE_SCREEN"] = "userProfileScreen";
10
+ AnalyticsEventSource["TEAM_PROFILE_ABOUT"] = "teamProfileAbout";
11
+ AnalyticsEventSource["TEAM_PROFILE_SCREEN"] = "teamProfileScreen";
12
+ return AnalyticsEventSource;
13
+ }({});
package/dist/cjs/index.js CHANGED
@@ -4,6 +4,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
4
4
  Object.defineProperty(exports, "__esModule", {
5
5
  value: true
6
6
  });
7
+ Object.defineProperty(exports, "AnalyticsEventSource", {
8
+ enumerable: true,
9
+ get: function get() {
10
+ return _constants.AnalyticsEventSource;
11
+ }
12
+ });
7
13
  Object.defineProperty(exports, "TeamsAppAnalyticsContext", {
8
14
  enumerable: true,
9
15
  get: function get() {
@@ -24,4 +30,5 @@ Object.defineProperty(exports, "useAnalyticsEvents", {
24
30
  });
25
31
  var _analyticsContext = require("./ui/analytics-context");
26
32
  var _useAnalyticsEvents = require("./common/utils/generated/use-analytics-events");
27
- var _createEventPayload = _interopRequireDefault(require("./common/utils/generated/create-event-payload"));
33
+ var _createEventPayload = _interopRequireDefault(require("./common/utils/generated/create-event-payload"));
34
+ var _constants = require("./common/utils/constants");
@@ -16,7 +16,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
16
16
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
17
17
  var defaultAnalyticsContextData = exports.defaultAnalyticsContextData = {
18
18
  packageName: "@atlaskit/teams-app-internal-analytics",
19
- packageVersion: "1.8.0"
19
+ packageVersion: "1.9.0"
20
20
  };
21
21
  function TeamsAppAnalyticsContext(_ref) {
22
22
  var data = _ref.data,
@@ -1 +1,7 @@
1
- export const EVENT_CHANNEL = 'peopleTeams';
1
+ export const EVENT_CHANNEL = 'peopleTeams';
2
+ export let AnalyticsEventSource = /*#__PURE__*/function (AnalyticsEventSource) {
3
+ AnalyticsEventSource["USER_PROFILE_SCREEN"] = "userProfileScreen";
4
+ AnalyticsEventSource["TEAM_PROFILE_ABOUT"] = "teamProfileAbout";
5
+ AnalyticsEventSource["TEAM_PROFILE_SCREEN"] = "teamProfileScreen";
6
+ return AnalyticsEventSource;
7
+ }({});
@@ -1,3 +1,4 @@
1
1
  export { TeamsAppAnalyticsContext } from './ui/analytics-context';
2
2
  export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';
3
- export { default as createEventPayload } from './common/utils/generated/create-event-payload';
3
+ export { default as createEventPayload } from './common/utils/generated/create-event-payload';
4
+ export { AnalyticsEventSource } from './common/utils/constants';
@@ -2,7 +2,7 @@ import React, { useMemo } from 'react';
2
2
  import { PeopleTeamsAnalyticsContext } from '@atlaskit/analytics-namespaced-context';
3
3
  export const defaultAnalyticsContextData = {
4
4
  packageName: "@atlaskit/teams-app-internal-analytics",
5
- packageVersion: "1.8.0"
5
+ packageVersion: "1.9.0"
6
6
  };
7
7
  export function TeamsAppAnalyticsContext({
8
8
  data,
@@ -1 +1,7 @@
1
- export var EVENT_CHANNEL = 'peopleTeams';
1
+ export var EVENT_CHANNEL = 'peopleTeams';
2
+ export var AnalyticsEventSource = /*#__PURE__*/function (AnalyticsEventSource) {
3
+ AnalyticsEventSource["USER_PROFILE_SCREEN"] = "userProfileScreen";
4
+ AnalyticsEventSource["TEAM_PROFILE_ABOUT"] = "teamProfileAbout";
5
+ AnalyticsEventSource["TEAM_PROFILE_SCREEN"] = "teamProfileScreen";
6
+ return AnalyticsEventSource;
7
+ }({});
package/dist/esm/index.js CHANGED
@@ -1,3 +1,4 @@
1
1
  export { TeamsAppAnalyticsContext } from './ui/analytics-context';
2
2
  export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';
3
- export { default as createEventPayload } from './common/utils/generated/create-event-payload';
3
+ export { default as createEventPayload } from './common/utils/generated/create-event-payload';
4
+ export { AnalyticsEventSource } from './common/utils/constants';
@@ -6,7 +6,7 @@ import React, { useMemo } from 'react';
6
6
  import { PeopleTeamsAnalyticsContext } from '@atlaskit/analytics-namespaced-context';
7
7
  export var defaultAnalyticsContextData = {
8
8
  packageName: "@atlaskit/teams-app-internal-analytics",
9
- packageVersion: "1.8.0"
9
+ packageVersion: "1.9.0"
10
10
  };
11
11
  export function TeamsAppAnalyticsContext(_ref) {
12
12
  var data = _ref.data,
@@ -1 +1,6 @@
1
1
  export declare const EVENT_CHANNEL = "peopleTeams";
2
+ export declare enum AnalyticsEventSource {
3
+ USER_PROFILE_SCREEN = "userProfileScreen",
4
+ TEAM_PROFILE_ABOUT = "teamProfileAbout",
5
+ TEAM_PROFILE_SCREEN = "teamProfileScreen"
6
+ }
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Generates Typescript types for analytics events from analytics.spec.yaml
5
5
  *
6
- * @codegen <<SignedSource::5bf63f0d58116f1c1218fe6ce17463c5>>
6
+ * @codegen <<SignedSource::7cc12d551a61a0b3d81d50dd1cd56318>>
7
7
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
8
8
  */
9
9
  export type PackageMetaDataType = {
@@ -1027,6 +1027,16 @@ export type ErrorBoundaryTriggeredAttributesType = {
1027
1027
  boundary: string;
1028
1028
  error: string;
1029
1029
  };
1030
+ export type ProfileKudosViewedAttributesType = {
1031
+ isEmpty: boolean;
1032
+ };
1033
+ export type ProfileKudosTabClickedAttributesType = {
1034
+ tabName: 'given' | 'received';
1035
+ };
1036
+ export type ProfileKudosClickedAttributesType = {
1037
+ kudosId: string;
1038
+ tabName: 'given' | 'received';
1039
+ };
1030
1040
  export type AnalyticsEventAttributes = {
1031
1041
  /**
1032
1042
  * fired when the teams-app-internal-analytics example button is clicked */
@@ -1705,5 +1715,14 @@ export type AnalyticsEventAttributes = {
1705
1715
  /**
1706
1716
  * fired when an error boundary is triggered */
1707
1717
  'operational.errorBoundary.triggered': ErrorBoundaryTriggeredAttributesType;
1718
+ /**
1719
+ * fired when the profile kudos is viewed */
1720
+ 'ui.ProfileKudos.viewed': ProfileKudosViewedAttributesType;
1721
+ /**
1722
+ * fired when the profile kudos tab is clicked */
1723
+ 'ui.ProfileKudosTab.clicked': ProfileKudosTabClickedAttributesType;
1724
+ /**
1725
+ * fired when a kudos item is clicked */
1726
+ 'ui.ProfileKudos.clicked': ProfileKudosClickedAttributesType;
1708
1727
  };
1709
1728
  export type EventKey = keyof AnalyticsEventAttributes;
@@ -1,5 +1,6 @@
1
1
  export { TeamsAppAnalyticsContext } from './ui/analytics-context';
2
2
  export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';
3
+ export { default as createEventPayload } from './common/utils/generated/create-event-payload';
3
4
  export type { AnalyticsEventAttributes } from './common/utils/generated/analytics.types';
4
5
  export type { FireEventType } from './common/utils/types';
5
- export { default as createEventPayload } from './common/utils/generated/create-event-payload';
6
+ export { AnalyticsEventSource } from './common/utils/constants';
@@ -1,8 +1,9 @@
1
1
  import React, { type ReactNode } from 'react';
2
+ import type { AnalyticsEventSource } from '../../common/utils/constants';
2
3
  import type { PackageMetaDataType } from '../../common/utils/generated/analytics.types';
3
4
  export declare const defaultAnalyticsContextData: PackageMetaDataType;
4
5
  type TeamsAppAnalyticsContextData = {
5
- source?: string;
6
+ source?: AnalyticsEventSource;
6
7
  attributes?: Record<string, any>;
7
8
  };
8
9
  export declare function TeamsAppAnalyticsContext({ data, children, }: {
@@ -1 +1,6 @@
1
1
  export declare const EVENT_CHANNEL = "peopleTeams";
2
+ export declare enum AnalyticsEventSource {
3
+ USER_PROFILE_SCREEN = "userProfileScreen",
4
+ TEAM_PROFILE_ABOUT = "teamProfileAbout",
5
+ TEAM_PROFILE_SCREEN = "teamProfileScreen"
6
+ }
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Generates Typescript types for analytics events from analytics.spec.yaml
5
5
  *
6
- * @codegen <<SignedSource::5bf63f0d58116f1c1218fe6ce17463c5>>
6
+ * @codegen <<SignedSource::7cc12d551a61a0b3d81d50dd1cd56318>>
7
7
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
8
8
  */
9
9
  export type PackageMetaDataType = {
@@ -1027,6 +1027,16 @@ export type ErrorBoundaryTriggeredAttributesType = {
1027
1027
  boundary: string;
1028
1028
  error: string;
1029
1029
  };
1030
+ export type ProfileKudosViewedAttributesType = {
1031
+ isEmpty: boolean;
1032
+ };
1033
+ export type ProfileKudosTabClickedAttributesType = {
1034
+ tabName: 'given' | 'received';
1035
+ };
1036
+ export type ProfileKudosClickedAttributesType = {
1037
+ kudosId: string;
1038
+ tabName: 'given' | 'received';
1039
+ };
1030
1040
  export type AnalyticsEventAttributes = {
1031
1041
  /**
1032
1042
  * fired when the teams-app-internal-analytics example button is clicked */
@@ -1705,5 +1715,14 @@ export type AnalyticsEventAttributes = {
1705
1715
  /**
1706
1716
  * fired when an error boundary is triggered */
1707
1717
  'operational.errorBoundary.triggered': ErrorBoundaryTriggeredAttributesType;
1718
+ /**
1719
+ * fired when the profile kudos is viewed */
1720
+ 'ui.ProfileKudos.viewed': ProfileKudosViewedAttributesType;
1721
+ /**
1722
+ * fired when the profile kudos tab is clicked */
1723
+ 'ui.ProfileKudosTab.clicked': ProfileKudosTabClickedAttributesType;
1724
+ /**
1725
+ * fired when a kudos item is clicked */
1726
+ 'ui.ProfileKudos.clicked': ProfileKudosClickedAttributesType;
1708
1727
  };
1709
1728
  export type EventKey = keyof AnalyticsEventAttributes;
@@ -1,5 +1,6 @@
1
1
  export { TeamsAppAnalyticsContext } from './ui/analytics-context';
2
2
  export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';
3
+ export { default as createEventPayload } from './common/utils/generated/create-event-payload';
3
4
  export type { AnalyticsEventAttributes } from './common/utils/generated/analytics.types';
4
5
  export type { FireEventType } from './common/utils/types';
5
- export { default as createEventPayload } from './common/utils/generated/create-event-payload';
6
+ export { AnalyticsEventSource } from './common/utils/constants';
@@ -1,8 +1,9 @@
1
1
  import React, { type ReactNode } from 'react';
2
+ import type { AnalyticsEventSource } from '../../common/utils/constants';
2
3
  import type { PackageMetaDataType } from '../../common/utils/generated/analytics.types';
3
4
  export declare const defaultAnalyticsContextData: PackageMetaDataType;
4
5
  type TeamsAppAnalyticsContextData = {
5
- source?: string;
6
+ source?: AnalyticsEventSource;
6
7
  attributes?: Record<string, any>;
7
8
  };
8
9
  export declare function TeamsAppAnalyticsContext({ data, children, }: {
package/package.json CHANGED
@@ -88,7 +88,7 @@
88
88
  }
89
89
  },
90
90
  "name": "@atlaskit/teams-app-internal-analytics",
91
- "version": "1.9.0",
91
+ "version": "1.10.0",
92
92
  "description": "A package used by the teams app and platform packages to handle people and teams analytics",
93
93
  "author": "Atlassian Pty Ltd",
94
94
  "license": "Apache-2.0",