@atlaskit/rovo-agent-analytics 0.4.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/rovo-agent-analytics
 
+## 0.6.0
+
+### Minor Changes
+
+- [`83339258ea2e8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/83339258ea2e8) -
+  Update rovo agent analytics context
+
+## 0.5.0
+
+### Minor Changes
+
+- [`93bff15d188d5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/93bff15d188d5) -
+  Update agent analytics create actions
+
 ## 0.4.0
 
 ### Minor Changes

package/actions/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/rovo-agent-analytics/actions",
+  "main": "../dist/cjs/actions/index.js",
+  "module": "../dist/esm/actions/index.js",
+  "module:es2019": "../dist/es2019/actions/index.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/actions/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/actions/index.d.ts"
+      ]
+    }
+  }
+}

package/create/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/rovo-agent-analytics/create",
+  "main": "../dist/cjs/create/index.js",
+  "module": "../dist/esm/create/index.js",
+  "module:es2019": "../dist/es2019/create/index.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/create/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/create/index.d.ts"
+      ]
+    }
+  }
+}

package/dist/cjs/actions/index.js

@@ -0,0 +1,70 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRovoAgentActionAnalytics = exports.AgentActions = exports.ANALYTICS_CHANNEL = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = require("react");
+var _analyticsListeners = require("@atlaskit/analytics-listeners");
+var _analyticsNext = require("@atlaskit/analytics-next");
+var _utils = require("../common/utils");
+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; }
+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; }
+var AgentActions = exports.AgentActions = /*#__PURE__*/function (AgentActions) {
+  /* View agent clicked */
+  AgentActions["VIEW"] = "view";
+  /* Edit agent clicked */
+  AgentActions["EDIT"] = "edit";
+  /* Create agent clicked */
+  AgentActions["CREATE"] = "create";
+  /* Agent updated */
+  AgentActions["UPDATED"] = "updated";
+  /* Copy link clicked */
+  AgentActions["COPY_LINK"] = "copyLink";
+  /* Delete agent clicked */
+  AgentActions["DELETE"] = "delete";
+  /* Duplicate agent clicked */
+  AgentActions["DUPLICATE"] = "duplicate";
+  /* Star agent clicked */
+  AgentActions["STAR"] = "star";
+  /* Chat with agent clicked */
+  AgentActions["CHAT"] = "chat";
+  return AgentActions;
+}({});
+var ANALYTICS_CHANNEL = exports.ANALYTICS_CHANNEL = _analyticsListeners.FabricChannel.aiMate;
+var useRovoAgentActionAnalytics = exports.useRovoAgentActionAnalytics = function useRovoAgentActionAnalytics(commonAttributes) {
+  var analyticsContext = (0, _react.useContext)(_analyticsNext.AnalyticsReactContext);
+  var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  var eventConfig = (0, _utils.getDefaultTrackEventConfig)();
+  var fireAnalyticsEvent = (0, _react.useCallback)(function (event) {
+    var attributes = _objectSpread(_objectSpread(_objectSpread({}, (0, _utils.getAttributesFromContexts)(analyticsContext.getAtlaskitAnalyticsContext())), commonAttributes), event.attributes);
+    createAnalyticsEvent(_objectSpread(_objectSpread(_objectSpread({}, eventConfig), event), {}, {
+      attributes: attributes
+    })).fire(ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, commonAttributes, analyticsContext]);
+  var trackAgentAction = (0, _react.useCallback)(function (action, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: action,
+      attributes: attributes
+    });
+  }, [fireAnalyticsEvent]);
+  var trackAgentActionError = (0, _react.useCallback)(function (action, error, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgentError',
+      action: action,
+      attributes: _objectSpread(_objectSpread({}, attributes), {}, {
+        error: {
+          message: error.message
+        }
+      })
+    });
+  }, [fireAnalyticsEvent]);
+  return {
+    trackAgentAction: trackAgentAction,
+    trackAgentActionError: trackAgentActionError
+  };
+};

package/dist/cjs/common/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CSID_QUERY_PARAM = exports.ANALYTICS_CHANNEL = void 0;
+var _analyticsListeners = require("@atlaskit/analytics-listeners");
+var ANALYTICS_CHANNEL = exports.ANALYTICS_CHANNEL = _analyticsListeners.FabricChannel.aiMate;
+var CSID_QUERY_PARAM = exports.CSID_QUERY_PARAM = 'csid';

package/dist/cjs/common/csid/index.js

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRovoAgentCSID = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+var _constants = require("../constants");
+var CACHED_CSID = null;
+var generateCSID = function generateCSID() {
+  return crypto.randomUUID();
+};
+var retrieveCSID = function retrieveCSID() {
+  if (CACHED_CSID) {
+    return CACHED_CSID;
+  }
+  var queryParams = new URLSearchParams(window.location.search);
+  var querySessionId = queryParams.get(_constants.CSID_QUERY_PARAM);
+  return querySessionId !== null && querySessionId !== void 0 ? querySessionId : generateCSID();
+};
+
+/**
+ * Hook to get Rovo Agent Create Session ID (CSID) from the query parameters or generate a new one if not found.
+ * @returns Rovo Agent CSID as a string.
+ */
+var useRovoAgentCSID = exports.useRovoAgentCSID = function useRovoAgentCSID() {
+  var _useState = (0, _react.useState)(retrieveCSID()),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    CSID = _useState2[0],
+    setCSID = _useState2[1];
+  var actions = (0, _react.useMemo)(function () {
+    return {
+      refresh: function refresh() {
+        var newCSID = generateCSID();
+        setCSID(newCSID);
+      },
+      clear: function clear() {
+        // remove CSID query parameter
+        var url = new URL(window.location.href);
+        url.searchParams.delete(_constants.CSID_QUERY_PARAM);
+        window.history.replaceState({}, '', url.toString());
+
+        // reset state
+        setCSID(null);
+      }
+    };
+  }, []);
+  (0, _react.useEffect)(function () {
+    // sync cache on state change
+    CACHED_CSID = CSID;
+  }, [CSID]);
+  return [CSID, actions];
+};

package/dist/cjs/common/types.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/common/utils/index.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getDefaultTrackEventConfig = exports.getAttributesFromContexts = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+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; }
+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; }
+var getDefaultTrackEventConfig = exports.getDefaultTrackEventConfig = function getDefaultTrackEventConfig() {
+  return {
+    eventType: 'track',
+    tags: ['atlaskit']
+  };
+};
+var getAttributesFromContexts = exports.getAttributesFromContexts = function getAttributesFromContexts(context) {
+  if (!context || !Array.isArray(context)) {
+    return {};
+  }
+  return context.reduce(function (acc, x) {
+    return _objectSpread(_objectSpread({}, acc), x);
+  }, {});
+};

package/dist/cjs/create/index.js

@@ -0,0 +1,71 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRovoAgentCreateAnalytics = exports.AgentCreateActions = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+var _analyticsNext = require("@atlaskit/analytics-next");
+var _constants = require("../common/constants");
+var _csid = require("../common/csid");
+var _utils = require("../common/utils");
+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; }
+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; }
+var AgentCreateActions = exports.AgentCreateActions = /*#__PURE__*/function (AgentCreateActions) {
+  AgentCreateActions["START"] = "createFlowStart";
+  AgentCreateActions["SKIP_NL"] = "createFlowSkipNL";
+  AgentCreateActions["REVIEW_NL"] = "createFlowReviewNL";
+  AgentCreateActions["ACTIVATE"] = "createFlowActivate";
+  AgentCreateActions["ERROR"] = "createFlowError";
+  return AgentCreateActions;
+}({});
+var useRovoAgentCreateAnalytics = exports.useRovoAgentCreateAnalytics = function useRovoAgentCreateAnalytics(commonAttributes) {
+  var _useRovoAgentCSID = (0, _csid.useRovoAgentCSID)(),
+    _useRovoAgentCSID2 = (0, _slicedToArray2.default)(_useRovoAgentCSID, 2),
+    csid = _useRovoAgentCSID2[0],
+    refreshCSID = _useRovoAgentCSID2[1].refresh;
+  var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  var eventConfig = (0, _utils.getDefaultTrackEventConfig)();
+  var fireAnalyticsEvent = (0, _react.useCallback)(function (event) {
+    createAnalyticsEvent(_objectSpread(_objectSpread(_objectSpread({}, eventConfig), event), {}, {
+      attributes: _objectSpread(_objectSpread({
+        csid: csid
+      }, commonAttributes), event.attributes)
+    })).fire(_constants.ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, csid, commonAttributes]);
+  var trackCreateSession = (0, _react.useCallback)(function (action, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: action,
+      attributes: attributes
+    });
+  }, [fireAnalyticsEvent]);
+  var trackCreateSessionStart = (0, _react.useCallback)(function (attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: AgentCreateActions.START,
+      attributes: attributes
+    });
+    refreshCSID();
+  }, [fireAnalyticsEvent, refreshCSID]);
+  var trackCreateSessionError = (0, _react.useCallback)(function (error, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: AgentCreateActions.ERROR,
+      attributes: _objectSpread({
+        error: {
+          message: error.message
+        }
+      }, attributes)
+    });
+  }, [fireAnalyticsEvent]);
+  return [csid, {
+    trackCreateSession: trackCreateSession,
+    trackCreateSessionStart: trackCreateSessionStart,
+    trackCreateSessionError: trackCreateSessionError
+  }];
+};

package/dist/cjs/index.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRovoAgentActionAnalytics = void 0;
+var useRovoAgentActionAnalytics = exports.useRovoAgentActionAnalytics = function useRovoAgentActionAnalytics() {};

package/dist/es2019/actions/index.js

@@ -0,0 +1,68 @@
+import { useCallback, useContext } from 'react';
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+import { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
+export let AgentActions = /*#__PURE__*/function (AgentActions) {
+  /* View agent clicked */
+  AgentActions["VIEW"] = "view";
+  /* Edit agent clicked */
+  AgentActions["EDIT"] = "edit";
+  /* Create agent clicked */
+  AgentActions["CREATE"] = "create";
+  /* Agent updated */
+  AgentActions["UPDATED"] = "updated";
+  /* Copy link clicked */
+  AgentActions["COPY_LINK"] = "copyLink";
+  /* Delete agent clicked */
+  AgentActions["DELETE"] = "delete";
+  /* Duplicate agent clicked */
+  AgentActions["DUPLICATE"] = "duplicate";
+  /* Star agent clicked */
+  AgentActions["STAR"] = "star";
+  /* Chat with agent clicked */
+  AgentActions["CHAT"] = "chat";
+  return AgentActions;
+}({});
+export const ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export const useRovoAgentActionAnalytics = commonAttributes => {
+  const analyticsContext = useContext(AnalyticsReactContext);
+  const {
+    createAnalyticsEvent
+  } = useAnalyticsEvents();
+  const eventConfig = getDefaultTrackEventConfig();
+  const fireAnalyticsEvent = useCallback(event => {
+    const attributes = {
+      ...getAttributesFromContexts(analyticsContext.getAtlaskitAnalyticsContext()),
+      ...commonAttributes,
+      ...event.attributes
+    };
+    createAnalyticsEvent({
+      ...eventConfig,
+      ...event,
+      attributes
+    }).fire(ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, commonAttributes, analyticsContext]);
+  const trackAgentAction = useCallback((action, attributes) => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action,
+      attributes
+    });
+  }, [fireAnalyticsEvent]);
+  const trackAgentActionError = useCallback((action, error, attributes) => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgentError',
+      action,
+      attributes: {
+        ...attributes,
+        error: {
+          message: error.message
+        }
+      }
+    });
+  }, [fireAnalyticsEvent]);
+  return {
+    trackAgentAction,
+    trackAgentActionError
+  };
+};

package/dist/es2019/common/constants.js

@@ -0,0 +1,3 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+export const ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export const CSID_QUERY_PARAM = 'csid';

package/dist/es2019/common/csid/index.js

@@ -0,0 +1,44 @@
+import { useEffect, useMemo, useState } from 'react';
+import { CSID_QUERY_PARAM } from '../constants';
+let CACHED_CSID = null;
+const generateCSID = () => {
+  return crypto.randomUUID();
+};
+const retrieveCSID = () => {
+  if (CACHED_CSID) {
+    return CACHED_CSID;
+  }
+  const queryParams = new URLSearchParams(window.location.search);
+  const querySessionId = queryParams.get(CSID_QUERY_PARAM);
+  return querySessionId !== null && querySessionId !== void 0 ? querySessionId : generateCSID();
+};
+
+/**
+ * Hook to get Rovo Agent Create Session ID (CSID) from the query parameters or generate a new one if not found.
+ * @returns Rovo Agent CSID as a string.
+ */
+export const useRovoAgentCSID = () => {
+  const [CSID, setCSID] = useState(retrieveCSID());
+  const actions = useMemo(() => {
+    return {
+      refresh: () => {
+        const newCSID = generateCSID();
+        setCSID(newCSID);
+      },
+      clear: () => {
+        // remove CSID query parameter
+        const url = new URL(window.location.href);
+        url.searchParams.delete(CSID_QUERY_PARAM);
+        window.history.replaceState({}, '', url.toString());
+
+        // reset state
+        setCSID(null);
+      }
+    };
+  }, []);
+  useEffect(() => {
+    // sync cache on state change
+    CACHED_CSID = CSID;
+  }, [CSID]);
+  return [CSID, actions];
+};

package/dist/es2019/common/utils/index.js

@@ -0,0 +1,15 @@
+export const getDefaultTrackEventConfig = () => ({
+  eventType: 'track',
+  tags: ['atlaskit']
+});
+export const getAttributesFromContexts = context => {
+  if (!context || !Array.isArray(context)) {
+    return {};
+  }
+  return context.reduce((acc, x) => {
+    return {
+      ...acc,
+      ...x
+    };
+  }, {});
+};

package/dist/es2019/create/index.js

@@ -0,0 +1,65 @@
+import { useCallback } from 'react';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../common/constants';
+import { useRovoAgentCSID } from '../common/csid';
+import { getDefaultTrackEventConfig } from '../common/utils';
+export let AgentCreateActions = /*#__PURE__*/function (AgentCreateActions) {
+  AgentCreateActions["START"] = "createFlowStart";
+  AgentCreateActions["SKIP_NL"] = "createFlowSkipNL";
+  AgentCreateActions["REVIEW_NL"] = "createFlowReviewNL";
+  AgentCreateActions["ACTIVATE"] = "createFlowActivate";
+  AgentCreateActions["ERROR"] = "createFlowError";
+  return AgentCreateActions;
+}({});
+export const useRovoAgentCreateAnalytics = commonAttributes => {
+  const [csid, {
+    refresh: refreshCSID
+  }] = useRovoAgentCSID();
+  const {
+    createAnalyticsEvent
+  } = useAnalyticsEvents();
+  const eventConfig = getDefaultTrackEventConfig();
+  const fireAnalyticsEvent = useCallback(event => {
+    createAnalyticsEvent({
+      ...eventConfig,
+      ...event,
+      attributes: {
+        csid,
+        ...commonAttributes,
+        ...event.attributes
+      }
+    }).fire(ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, csid, commonAttributes]);
+  const trackCreateSession = useCallback((action, attributes) => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action,
+      attributes
+    });
+  }, [fireAnalyticsEvent]);
+  const trackCreateSessionStart = useCallback(attributes => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: AgentCreateActions.START,
+      attributes
+    });
+    refreshCSID();
+  }, [fireAnalyticsEvent, refreshCSID]);
+  const trackCreateSessionError = useCallback((error, attributes) => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: AgentCreateActions.ERROR,
+      attributes: {
+        error: {
+          message: error.message
+        },
+        ...attributes
+      }
+    });
+  }, [fireAnalyticsEvent]);
+  return [csid, {
+    trackCreateSession,
+    trackCreateSessionStart,
+    trackCreateSessionError
+  }];
+};

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export const useRovoAgentActionAnalytics = () => {};

package/dist/esm/actions/index.js

@@ -0,0 +1,63 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
+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) { _defineProperty(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; }
+import { useCallback, useContext } from 'react';
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+import { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
+export var AgentActions = /*#__PURE__*/function (AgentActions) {
+  /* View agent clicked */
+  AgentActions["VIEW"] = "view";
+  /* Edit agent clicked */
+  AgentActions["EDIT"] = "edit";
+  /* Create agent clicked */
+  AgentActions["CREATE"] = "create";
+  /* Agent updated */
+  AgentActions["UPDATED"] = "updated";
+  /* Copy link clicked */
+  AgentActions["COPY_LINK"] = "copyLink";
+  /* Delete agent clicked */
+  AgentActions["DELETE"] = "delete";
+  /* Duplicate agent clicked */
+  AgentActions["DUPLICATE"] = "duplicate";
+  /* Star agent clicked */
+  AgentActions["STAR"] = "star";
+  /* Chat with agent clicked */
+  AgentActions["CHAT"] = "chat";
+  return AgentActions;
+}({});
+export var ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export var useRovoAgentActionAnalytics = function useRovoAgentActionAnalytics(commonAttributes) {
+  var analyticsContext = useContext(AnalyticsReactContext);
+  var _useAnalyticsEvents = useAnalyticsEvents(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  var eventConfig = getDefaultTrackEventConfig();
+  var fireAnalyticsEvent = useCallback(function (event) {
+    var attributes = _objectSpread(_objectSpread(_objectSpread({}, getAttributesFromContexts(analyticsContext.getAtlaskitAnalyticsContext())), commonAttributes), event.attributes);
+    createAnalyticsEvent(_objectSpread(_objectSpread(_objectSpread({}, eventConfig), event), {}, {
+      attributes: attributes
+    })).fire(ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, commonAttributes, analyticsContext]);
+  var trackAgentAction = useCallback(function (action, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: action,
+      attributes: attributes
+    });
+  }, [fireAnalyticsEvent]);
+  var trackAgentActionError = useCallback(function (action, error, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgentError',
+      action: action,
+      attributes: _objectSpread(_objectSpread({}, attributes), {}, {
+        error: {
+          message: error.message
+        }
+      })
+    });
+  }, [fireAnalyticsEvent]);
+  return {
+    trackAgentAction: trackAgentAction,
+    trackAgentActionError: trackAgentActionError
+  };
+};

package/dist/esm/common/constants.js

@@ -0,0 +1,3 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+export var ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export var CSID_QUERY_PARAM = 'csid';

package/dist/esm/common/csid/index.js

@@ -0,0 +1,48 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useEffect, useMemo, useState } from 'react';
+import { CSID_QUERY_PARAM } from '../constants';
+var CACHED_CSID = null;
+var generateCSID = function generateCSID() {
+  return crypto.randomUUID();
+};
+var retrieveCSID = function retrieveCSID() {
+  if (CACHED_CSID) {
+    return CACHED_CSID;
+  }
+  var queryParams = new URLSearchParams(window.location.search);
+  var querySessionId = queryParams.get(CSID_QUERY_PARAM);
+  return querySessionId !== null && querySessionId !== void 0 ? querySessionId : generateCSID();
+};
+
+/**
+ * Hook to get Rovo Agent Create Session ID (CSID) from the query parameters or generate a new one if not found.
+ * @returns Rovo Agent CSID as a string.
+ */
+export var useRovoAgentCSID = function useRovoAgentCSID() {
+  var _useState = useState(retrieveCSID()),
+    _useState2 = _slicedToArray(_useState, 2),
+    CSID = _useState2[0],
+    setCSID = _useState2[1];
+  var actions = useMemo(function () {
+    return {
+      refresh: function refresh() {
+        var newCSID = generateCSID();
+        setCSID(newCSID);
+      },
+      clear: function clear() {
+        // remove CSID query parameter
+        var url = new URL(window.location.href);
+        url.searchParams.delete(CSID_QUERY_PARAM);
+        window.history.replaceState({}, '', url.toString());
+
+        // reset state
+        setCSID(null);
+      }
+    };
+  }, []);
+  useEffect(function () {
+    // sync cache on state change
+    CACHED_CSID = CSID;
+  }, [CSID]);
+  return [CSID, actions];
+};

package/dist/esm/common/utils/index.js

@@ -0,0 +1,17 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
+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) { _defineProperty(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; }
+export var getDefaultTrackEventConfig = function getDefaultTrackEventConfig() {
+  return {
+    eventType: 'track',
+    tags: ['atlaskit']
+  };
+};
+export var getAttributesFromContexts = function getAttributesFromContexts(context) {
+  if (!context || !Array.isArray(context)) {
+    return {};
+  }
+  return context.reduce(function (acc, x) {
+    return _objectSpread(_objectSpread({}, acc), x);
+  }, {});
+};

package/dist/esm/create/index.js

@@ -0,0 +1,64 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+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; }
+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) { _defineProperty(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; }
+import { useCallback } from 'react';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../common/constants';
+import { useRovoAgentCSID } from '../common/csid';
+import { getDefaultTrackEventConfig } from '../common/utils';
+export var AgentCreateActions = /*#__PURE__*/function (AgentCreateActions) {
+  AgentCreateActions["START"] = "createFlowStart";
+  AgentCreateActions["SKIP_NL"] = "createFlowSkipNL";
+  AgentCreateActions["REVIEW_NL"] = "createFlowReviewNL";
+  AgentCreateActions["ACTIVATE"] = "createFlowActivate";
+  AgentCreateActions["ERROR"] = "createFlowError";
+  return AgentCreateActions;
+}({});
+export var useRovoAgentCreateAnalytics = function useRovoAgentCreateAnalytics(commonAttributes) {
+  var _useRovoAgentCSID = useRovoAgentCSID(),
+    _useRovoAgentCSID2 = _slicedToArray(_useRovoAgentCSID, 2),
+    csid = _useRovoAgentCSID2[0],
+    refreshCSID = _useRovoAgentCSID2[1].refresh;
+  var _useAnalyticsEvents = useAnalyticsEvents(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  var eventConfig = getDefaultTrackEventConfig();
+  var fireAnalyticsEvent = useCallback(function (event) {
+    createAnalyticsEvent(_objectSpread(_objectSpread(_objectSpread({}, eventConfig), event), {}, {
+      attributes: _objectSpread(_objectSpread({
+        csid: csid
+      }, commonAttributes), event.attributes)
+    })).fire(ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, csid, commonAttributes]);
+  var trackCreateSession = useCallback(function (action, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: action,
+      attributes: attributes
+    });
+  }, [fireAnalyticsEvent]);
+  var trackCreateSessionStart = useCallback(function (attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: AgentCreateActions.START,
+      attributes: attributes
+    });
+    refreshCSID();
+  }, [fireAnalyticsEvent, refreshCSID]);
+  var trackCreateSessionError = useCallback(function (error, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: AgentCreateActions.ERROR,
+      attributes: _objectSpread({
+        error: {
+          message: error.message
+        }
+      }, attributes)
+    });
+  }, [fireAnalyticsEvent]);
+  return [csid, {
+    trackCreateSession: trackCreateSession,
+    trackCreateSessionStart: trackCreateSessionStart,
+    trackCreateSessionError: trackCreateSessionError
+  }];
+};

package/dist/esm/index.js

@@ -0,0 +1 @@
+export var useRovoAgentActionAnalytics = function useRovoAgentActionAnalytics() {};

package/dist/types/actions/index.d.ts

@@ -0,0 +1,23 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+import type { RemainingRequired } from '../common/types';
+export declare enum AgentActions {
+    VIEW = "view",
+    EDIT = "edit",
+    CREATE = "create",
+    UPDATED = "updated",
+    COPY_LINK = "copyLink",
+    DELETE = "delete",
+    DUPLICATE = "duplicate",
+    STAR = "star",
+    CHAT = "chat"
+}
+type CommonAnalyticsAttributes = {
+    touchPoint: string;
+    agentId: string;
+};
+export declare const ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export declare const useRovoAgentActionAnalytics: <T extends Partial<CommonAnalyticsAttributes>>(commonAttributes: T) => {
+    trackAgentAction: (action: AgentActions, attributes: RemainingRequired<CommonAnalyticsAttributes, T> & Record<string, any>) => void;
+    trackAgentActionError: (action: AgentActions, error: Error, attributes?: RemainingRequired<CommonAnalyticsAttributes, T> & Record<string, any>) => void;
+};
+export {};

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

@@ -0,0 +1,3 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+export declare const ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export declare const CSID_QUERY_PARAM = "csid";

package/dist/types/common/csid/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Hook to get Rovo Agent Create Session ID (CSID) from the query parameters or generate a new one if not found.
+ * @returns Rovo Agent CSID as a string.
+ */
+export declare const useRovoAgentCSID: () => readonly [string | null, {
+    refresh: () => void;
+    clear: () => void;
+}];

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

@@ -0,0 +1 @@
+export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;

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

@@ -0,0 +1,5 @@
+export declare const getDefaultTrackEventConfig: () => {
+    eventType: string;
+    tags: string[];
+};
+export declare const getAttributesFromContexts: (context: unknown) => Record<string, any>;

package/dist/types/create/index.d.ts

@@ -0,0 +1,16 @@
+type CommonAnalyticsAttributes = {
+    touchPoint?: string;
+} & Record<string, any>;
+export declare enum AgentCreateActions {
+    START = "createFlowStart",
+    SKIP_NL = "createFlowSkipNL",
+    REVIEW_NL = "createFlowReviewNL",
+    ACTIVATE = "createFlowActivate",
+    ERROR = "createFlowError"
+}
+export declare const useRovoAgentCreateAnalytics: (commonAttributes: CommonAnalyticsAttributes) => readonly [string | null, {
+    readonly trackCreateSession: (action: AgentCreateActions, attributes?: CommonAnalyticsAttributes) => void;
+    readonly trackCreateSessionStart: (attributes?: CommonAnalyticsAttributes) => void;
+    readonly trackCreateSessionError: (error: Error, attributes?: CommonAnalyticsAttributes) => void;
+}];
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export declare const useRovoAgentActionAnalytics: () => void;

package/dist/types-ts4.5/actions/index.d.ts

@@ -0,0 +1,23 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+import type { RemainingRequired } from '../common/types';
+export declare enum AgentActions {
+    VIEW = "view",
+    EDIT = "edit",
+    CREATE = "create",
+    UPDATED = "updated",
+    COPY_LINK = "copyLink",
+    DELETE = "delete",
+    DUPLICATE = "duplicate",
+    STAR = "star",
+    CHAT = "chat"
+}
+type CommonAnalyticsAttributes = {
+    touchPoint: string;
+    agentId: string;
+};
+export declare const ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export declare const useRovoAgentActionAnalytics: <T extends Partial<CommonAnalyticsAttributes>>(commonAttributes: T) => {
+    trackAgentAction: (action: AgentActions, attributes: RemainingRequired<CommonAnalyticsAttributes, T> & Record<string, any>) => void;
+    trackAgentActionError: (action: AgentActions, error: Error, attributes?: RemainingRequired<CommonAnalyticsAttributes, T> & Record<string, any>) => void;
+};
+export {};

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

@@ -0,0 +1,3 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+export declare const ANALYTICS_CHANNEL = FabricChannel.aiMate;
+export declare const CSID_QUERY_PARAM = "csid";

package/dist/types-ts4.5/common/csid/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Hook to get Rovo Agent Create Session ID (CSID) from the query parameters or generate a new one if not found.
+ * @returns Rovo Agent CSID as a string.
+ */
+export declare const useRovoAgentCSID: () => readonly [
+    string | null,
+    {
+        refresh: () => void;
+        clear: () => void;
+    }
+];

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

@@ -0,0 +1 @@
+export type RemainingRequired<T, P extends Partial<T>> = Required<Omit<T, keyof P>>;

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

@@ -0,0 +1,5 @@
+export declare const getDefaultTrackEventConfig: () => {
+    eventType: string;
+    tags: string[];
+};
+export declare const getAttributesFromContexts: (context: unknown) => Record<string, any>;

package/dist/types-ts4.5/create/index.d.ts

@@ -0,0 +1,19 @@
+type CommonAnalyticsAttributes = {
+    touchPoint?: string;
+} & Record<string, any>;
+export declare enum AgentCreateActions {
+    START = "createFlowStart",
+    SKIP_NL = "createFlowSkipNL",
+    REVIEW_NL = "createFlowReviewNL",
+    ACTIVATE = "createFlowActivate",
+    ERROR = "createFlowError"
+}
+export declare const useRovoAgentCreateAnalytics: (commonAttributes: CommonAnalyticsAttributes) => readonly [
+    string | null,
+    {
+        readonly trackCreateSession: (action: AgentCreateActions, attributes?: CommonAnalyticsAttributes) => void;
+        readonly trackCreateSessionStart: (attributes?: CommonAnalyticsAttributes) => void;
+        readonly trackCreateSessionError: (error: Error, attributes?: CommonAnalyticsAttributes) => void;
+    }
+];
+export {};

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1 @@
+export declare const useRovoAgentActionAnalytics: () => void;

package/package.json

@@ -6,7 +6,7 @@
 			"category": "Layout and structure"
 		}
 	},
-	"repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-monorepo",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
@@ -83,7 +83,7 @@
 		]
 	},
 	"name": "@atlaskit/rovo-agent-analytics",
-	"version": "0.4.0",
+	"version": "0.6.0",
 	"description": "Rovo Agents analytics",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",