@atlaskit/rovo-agent-analytics 0.12.0 → 0.12.1

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.
Files changed (10) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/cjs/actions/index.js +10 -10
  3. package/dist/cjs/create/index.js +17 -8
  4. package/dist/es2019/actions/index.js +10 -10
  5. package/dist/es2019/create/index.js +17 -8
  6. package/dist/esm/actions/index.js +10 -10
  7. package/dist/esm/create/index.js +17 -8
  8. package/dist/types/create/index.d.ts +1 -1
  9. package/dist/types-ts4.5/create/index.d.ts +1 -1
  10. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @atlaskit/rovo-agent-analytics
2
2
 
3
+ ## 0.12.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [`f2c0a49bc75c7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2c0a49bc75c7) -
8
+ Add comments to data-portal registry
9
+
3
10
  ## 0.12.0
4
11
 
5
12
  ### Minor Changes
package/dist/cjs/actions/index.js CHANGED
@@ -13,25 +13,25 @@ var _utils = require("../common/utils");
13
13
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
14
14
  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; }
15
15
  var AgentActions = exports.AgentActions = /*#__PURE__*/function (AgentActions) {
16
- /* View agent clicked */
16
+ /* View agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97125 */
17
17
  AgentActions["VIEW"] = "view";
18
- /* Edit agent clicked */
18
+ /* Edit agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97126 */
19
19
  AgentActions["EDIT"] = "edit";
20
- /* Agent updated */
20
+ /* Agent updated - https://data-portal.internal.atlassian.com/analytics/registry/97122 */
21
21
  AgentActions["UPDATED"] = "updated";
22
- /* Copy link clicked */
22
+ /* Copy link clicked - https://data-portal.internal.atlassian.com/analytics/registry/97128 */
23
23
  AgentActions["COPY_LINK"] = "copyLink";
24
- /* Delete agent clicked */
24
+ /* Delete agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97129 */
25
25
  AgentActions["DELETE"] = "delete";
26
- /* Duplicate agent clicked */
26
+ /* Duplicate agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97130 */
27
27
  AgentActions["DUPLICATE"] = "duplicate";
28
- /* Star agent clicked */
28
+ /* Star agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97133 */
29
29
  AgentActions["STAR"] = "star";
30
- /* Chat with agent clicked */
30
+ /* Chat with agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97095 */
31
31
  AgentActions["CHAT"] = "chat";
32
- /* Verify agent clicked */
32
+ /* Verify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97134 */
33
33
  AgentActions["VERIFY"] = "verify";
34
- /* Unverify agent clicked */
34
+ /* Unverify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97135 */
35
35
  AgentActions["UNVERIFY"] = "unverify";
36
36
  return AgentActions;
37
37
  }({});
package/dist/cjs/create/index.js CHANGED
@@ -15,21 +15,21 @@ var _utils = require("../common/utils");
15
15
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
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 AgentCreateActions = exports.AgentCreateActions = /*#__PURE__*/function (AgentCreateActions) {
18
- /* Start create flow when user clicks on "Create agent" button */
18
+ /* Start create flow when user clicks on "Create agent" button - https://data-portal.internal.atlassian.com/analytics/registry/97089 */
19
19
  AgentCreateActions["START"] = "createFlowStart";
20
- /* Skip natural language */
20
+ /* Skip natural language - https://data-portal.internal.atlassian.com/analytics/registry/97127 */
21
21
  AgentCreateActions["SKIP_NL"] = "createFlowSkipNL";
22
- /* Review natural language */
22
+ /* Review natural language - https://data-portal.internal.atlassian.com/analytics/registry/97124 */
23
23
  AgentCreateActions["REVIEW_NL"] = "createFlowReviewNL";
24
- /* Activate agent */
24
+ /* Activate agent - https://data-portal.internal.atlassian.com/analytics/registry/97123 */
25
25
  AgentCreateActions["ACTIVATE"] = "createFlowActivate";
26
- /* Restart create flow */
26
+ /* Restart create flow - https://data-portal.internal.atlassian.com/analytics/registry/97131 */
27
27
  AgentCreateActions["RESTART"] = "createFlowRestart";
28
- /* Error occurred */
28
+ /* Error occurred - https://data-portal.internal.atlassian.com/analytics/registry/97132 */
29
29
  AgentCreateActions["ERROR"] = "createFlowError";
30
- /* Land in studio */
30
+ /* Land in studio - https://data-portal.internal.atlassian.com/analytics/registry/97136 */
31
31
  AgentCreateActions["LAND"] = "createLandInStudio";
32
- /* Discard agent */
32
+ /* Discard agent - https://data-portal.internal.atlassian.com/analytics/registry/97137 */
33
33
  AgentCreateActions["DISCARD"] = "createDiscard";
34
34
  return AgentCreateActions;
35
35
  }({});
@@ -52,6 +52,11 @@ var useRovoAgentCreateAnalytics = exports.useRovoAgentCreateAnalytics = function
52
52
  }, commonAttributes), event.attributes)
53
53
  })).fire(_constants.ANALYTICS_CHANNEL);
54
54
  }, [createAnalyticsEvent, eventConfig, csid, commonAttributes]);
55
+
56
+ /**
57
+ * This will fire analytics event for intermediate steps in the create agent flow funnel
58
+ * To start the create agent flow, use trackCreateSessionStart
59
+ */
55
60
  var trackCreateSession = (0, _react.useCallback)(function (action, attributes) {
56
61
  fireAnalyticsEvent({
57
62
  actionSubject: 'rovoAgent',
@@ -59,6 +64,10 @@ var useRovoAgentCreateAnalytics = exports.useRovoAgentCreateAnalytics = function
59
64
  attributes: attributes
60
65
  });
61
66
  }, [fireAnalyticsEvent]);
67
+
68
+ /**
69
+ * This should be used ONLY in the beginning of the funnel of create agent flow, it will create a new CSID (CSID = create session ID)
70
+ */
62
71
  var trackCreateSessionStart = (0, _react.useCallback)(function (attributes) {
63
72
  fireAnalyticsEvent({
64
73
  actionSubject: 'rovoAgent',
package/dist/es2019/actions/index.js CHANGED
@@ -3,25 +3,25 @@ import { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-n
3
3
  import { ANALYTICS_CHANNEL } from '../common/constants';
4
4
  import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
5
5
  export let AgentActions = /*#__PURE__*/function (AgentActions) {
6
- /* View agent clicked */
6
+ /* View agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97125 */
7
7
  AgentActions["VIEW"] = "view";
8
- /* Edit agent clicked */
8
+ /* Edit agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97126 */
9
9
  AgentActions["EDIT"] = "edit";
10
- /* Agent updated */
10
+ /* Agent updated - https://data-portal.internal.atlassian.com/analytics/registry/97122 */
11
11
  AgentActions["UPDATED"] = "updated";
12
- /* Copy link clicked */
12
+ /* Copy link clicked - https://data-portal.internal.atlassian.com/analytics/registry/97128 */
13
13
  AgentActions["COPY_LINK"] = "copyLink";
14
- /* Delete agent clicked */
14
+ /* Delete agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97129 */
15
15
  AgentActions["DELETE"] = "delete";
16
- /* Duplicate agent clicked */
16
+ /* Duplicate agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97130 */
17
17
  AgentActions["DUPLICATE"] = "duplicate";
18
- /* Star agent clicked */
18
+ /* Star agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97133 */
19
19
  AgentActions["STAR"] = "star";
20
- /* Chat with agent clicked */
20
+ /* Chat with agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97095 */
21
21
  AgentActions["CHAT"] = "chat";
22
- /* Verify agent clicked */
22
+ /* Verify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97134 */
23
23
  AgentActions["VERIFY"] = "verify";
24
- /* Unverify agent clicked */
24
+ /* Unverify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97135 */
25
25
  AgentActions["UNVERIFY"] = "unverify";
26
26
  return AgentActions;
27
27
  }({});
package/dist/es2019/create/index.js CHANGED
@@ -4,21 +4,21 @@ import { ANALYTICS_CHANNEL } from '../common/constants';
4
4
  import { useRovoAgentCSID } from '../common/csid';
5
5
  import { getDefaultTrackEventConfig } from '../common/utils';
6
6
  export let AgentCreateActions = /*#__PURE__*/function (AgentCreateActions) {
7
- /* Start create flow when user clicks on "Create agent" button */
7
+ /* Start create flow when user clicks on "Create agent" button - https://data-portal.internal.atlassian.com/analytics/registry/97089 */
8
8
  AgentCreateActions["START"] = "createFlowStart";
9
- /* Skip natural language */
9
+ /* Skip natural language - https://data-portal.internal.atlassian.com/analytics/registry/97127 */
10
10
  AgentCreateActions["SKIP_NL"] = "createFlowSkipNL";
11
- /* Review natural language */
11
+ /* Review natural language - https://data-portal.internal.atlassian.com/analytics/registry/97124 */
12
12
  AgentCreateActions["REVIEW_NL"] = "createFlowReviewNL";
13
- /* Activate agent */
13
+ /* Activate agent - https://data-portal.internal.atlassian.com/analytics/registry/97123 */
14
14
  AgentCreateActions["ACTIVATE"] = "createFlowActivate";
15
- /* Restart create flow */
15
+ /* Restart create flow - https://data-portal.internal.atlassian.com/analytics/registry/97131 */
16
16
  AgentCreateActions["RESTART"] = "createFlowRestart";
17
- /* Error occurred */
17
+ /* Error occurred - https://data-portal.internal.atlassian.com/analytics/registry/97132 */
18
18
  AgentCreateActions["ERROR"] = "createFlowError";
19
- /* Land in studio */
19
+ /* Land in studio - https://data-portal.internal.atlassian.com/analytics/registry/97136 */
20
20
  AgentCreateActions["LAND"] = "createLandInStudio";
21
- /* Discard agent */
21
+ /* Discard agent - https://data-portal.internal.atlassian.com/analytics/registry/97137 */
22
22
  AgentCreateActions["DISCARD"] = "createDiscard";
23
23
  return AgentCreateActions;
24
24
  }({});
@@ -43,6 +43,11 @@ export const useRovoAgentCreateAnalytics = commonAttributes => {
43
43
  }
44
44
  }).fire(ANALYTICS_CHANNEL);
45
45
  }, [createAnalyticsEvent, eventConfig, csid, commonAttributes]);
46
+
47
+ /**
48
+ * This will fire analytics event for intermediate steps in the create agent flow funnel
49
+ * To start the create agent flow, use trackCreateSessionStart
50
+ */
46
51
  const trackCreateSession = useCallback((action, attributes) => {
47
52
  fireAnalyticsEvent({
48
53
  actionSubject: 'rovoAgent',
@@ -50,6 +55,10 @@ export const useRovoAgentCreateAnalytics = commonAttributes => {
50
55
  attributes
51
56
  });
52
57
  }, [fireAnalyticsEvent]);
58
+
59
+ /**
60
+ * This should be used ONLY in the beginning of the funnel of create agent flow, it will create a new CSID (CSID = create session ID)
61
+ */
53
62
  const trackCreateSessionStart = useCallback(attributes => {
54
63
  fireAnalyticsEvent({
55
64
  actionSubject: 'rovoAgent',
package/dist/esm/actions/index.js CHANGED
@@ -6,25 +6,25 @@ import { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-n
6
6
  import { ANALYTICS_CHANNEL } from '../common/constants';
7
7
  import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
8
8
  export var AgentActions = /*#__PURE__*/function (AgentActions) {
9
- /* View agent clicked */
9
+ /* View agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97125 */
10
10
  AgentActions["VIEW"] = "view";
11
- /* Edit agent clicked */
11
+ /* Edit agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97126 */
12
12
  AgentActions["EDIT"] = "edit";
13
- /* Agent updated */
13
+ /* Agent updated - https://data-portal.internal.atlassian.com/analytics/registry/97122 */
14
14
  AgentActions["UPDATED"] = "updated";
15
- /* Copy link clicked */
15
+ /* Copy link clicked - https://data-portal.internal.atlassian.com/analytics/registry/97128 */
16
16
  AgentActions["COPY_LINK"] = "copyLink";
17
- /* Delete agent clicked */
17
+ /* Delete agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97129 */
18
18
  AgentActions["DELETE"] = "delete";
19
- /* Duplicate agent clicked */
19
+ /* Duplicate agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97130 */
20
20
  AgentActions["DUPLICATE"] = "duplicate";
21
- /* Star agent clicked */
21
+ /* Star agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97133 */
22
22
  AgentActions["STAR"] = "star";
23
- /* Chat with agent clicked */
23
+ /* Chat with agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97095 */
24
24
  AgentActions["CHAT"] = "chat";
25
- /* Verify agent clicked */
25
+ /* Verify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97134 */
26
26
  AgentActions["VERIFY"] = "verify";
27
- /* Unverify agent clicked */
27
+ /* Unverify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97135 */
28
28
  AgentActions["UNVERIFY"] = "unverify";
29
29
  return AgentActions;
30
30
  }({});
package/dist/esm/create/index.js CHANGED
@@ -8,21 +8,21 @@ import { ANALYTICS_CHANNEL } from '../common/constants';
8
8
  import { useRovoAgentCSID } from '../common/csid';
9
9
  import { getDefaultTrackEventConfig } from '../common/utils';
10
10
  export var AgentCreateActions = /*#__PURE__*/function (AgentCreateActions) {
11
- /* Start create flow when user clicks on "Create agent" button */
11
+ /* Start create flow when user clicks on "Create agent" button - https://data-portal.internal.atlassian.com/analytics/registry/97089 */
12
12
  AgentCreateActions["START"] = "createFlowStart";
13
- /* Skip natural language */
13
+ /* Skip natural language - https://data-portal.internal.atlassian.com/analytics/registry/97127 */
14
14
  AgentCreateActions["SKIP_NL"] = "createFlowSkipNL";
15
- /* Review natural language */
15
+ /* Review natural language - https://data-portal.internal.atlassian.com/analytics/registry/97124 */
16
16
  AgentCreateActions["REVIEW_NL"] = "createFlowReviewNL";
17
- /* Activate agent */
17
+ /* Activate agent - https://data-portal.internal.atlassian.com/analytics/registry/97123 */
18
18
  AgentCreateActions["ACTIVATE"] = "createFlowActivate";
19
- /* Restart create flow */
19
+ /* Restart create flow - https://data-portal.internal.atlassian.com/analytics/registry/97131 */
20
20
  AgentCreateActions["RESTART"] = "createFlowRestart";
21
- /* Error occurred */
21
+ /* Error occurred - https://data-portal.internal.atlassian.com/analytics/registry/97132 */
22
22
  AgentCreateActions["ERROR"] = "createFlowError";
23
- /* Land in studio */
23
+ /* Land in studio - https://data-portal.internal.atlassian.com/analytics/registry/97136 */
24
24
  AgentCreateActions["LAND"] = "createLandInStudio";
25
- /* Discard agent */
25
+ /* Discard agent - https://data-portal.internal.atlassian.com/analytics/registry/97137 */
26
26
  AgentCreateActions["DISCARD"] = "createDiscard";
27
27
  return AgentCreateActions;
28
28
  }({});
@@ -45,6 +45,11 @@ export var useRovoAgentCreateAnalytics = function useRovoAgentCreateAnalytics(co
45
45
  }, commonAttributes), event.attributes)
46
46
  })).fire(ANALYTICS_CHANNEL);
47
47
  }, [createAnalyticsEvent, eventConfig, csid, commonAttributes]);
48
+
49
+ /**
50
+ * This will fire analytics event for intermediate steps in the create agent flow funnel
51
+ * To start the create agent flow, use trackCreateSessionStart
52
+ */
48
53
  var trackCreateSession = useCallback(function (action, attributes) {
49
54
  fireAnalyticsEvent({
50
55
  actionSubject: 'rovoAgent',
@@ -52,6 +57,10 @@ export var useRovoAgentCreateAnalytics = function useRovoAgentCreateAnalytics(co
52
57
  attributes: attributes
53
58
  });
54
59
  }, [fireAnalyticsEvent]);
60
+
61
+ /**
62
+ * This should be used ONLY in the beginning of the funnel of create agent flow, it will create a new CSID (CSID = create session ID)
63
+ */
55
64
  var trackCreateSessionStart = useCallback(function (attributes) {
56
65
  fireAnalyticsEvent({
57
66
  actionSubject: 'rovoAgent',
package/dist/types/create/index.d.ts CHANGED
@@ -12,7 +12,7 @@ export declare enum AgentCreateActions {
12
12
  DISCARD = "createDiscard"
13
13
  }
14
14
  export declare const useRovoAgentCreateAnalytics: (commonAttributes: CommonAnalyticsAttributes) => readonly [string | null, {
15
- readonly trackCreateSession: (action: AgentCreateActions, attributes?: CommonAnalyticsAttributes) => void;
15
+ readonly trackCreateSession: (action: Omit<AgentCreateActions, AgentCreateActions.START>, attributes?: CommonAnalyticsAttributes) => void;
16
16
  readonly trackCreateSessionStart: (attributes?: CommonAnalyticsAttributes) => void;
17
17
  readonly trackCreateSessionError: (error: Error, attributes?: CommonAnalyticsAttributes) => void;
18
18
  }];
package/dist/types-ts4.5/create/index.d.ts CHANGED
@@ -14,7 +14,7 @@ export declare enum AgentCreateActions {
14
14
  export declare const useRovoAgentCreateAnalytics: (commonAttributes: CommonAnalyticsAttributes) => readonly [
15
15
  string | null,
16
16
  {
17
- readonly trackCreateSession: (action: AgentCreateActions, attributes?: CommonAnalyticsAttributes) => void;
17
+ readonly trackCreateSession: (action: Omit<AgentCreateActions, AgentCreateActions.START>, attributes?: CommonAnalyticsAttributes) => void;
18
18
  readonly trackCreateSessionStart: (attributes?: CommonAnalyticsAttributes) => void;
19
19
  readonly trackCreateSessionError: (error: Error, attributes?: CommonAnalyticsAttributes) => void;
20
20
  }
package/package.json CHANGED
@@ -83,7 +83,7 @@
83
83
  ]
84
84
  },
85
85
  "name": "@atlaskit/rovo-agent-analytics",
86
- "version": "0.12.0",
86
+ "version": "0.12.1",
87
87
  "description": "Rovo Agents analytics",
88
88
  "author": "Atlassian Pty Ltd",
89
89
  "license": "Apache-2.0",