@atlaskit/rovo-agent-analytics 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/rovo-agent-analytics
 
+## 0.11.0
+
+### Minor Changes
+
+- [`d701db2f15d73`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d701db2f15d73) -
+  Rovo agents debug modal analytics
+
 ## 0.10.0
 
 ### Minor Changes

package/debug/package.json

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

package/dist/cjs/actions/index.js

@@ -4,11 +4,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useRovoAgentActionAnalytics = exports.AgentActions = exports.ANALYTICS_CHANNEL = void 0;
+exports.useRovoAgentActionAnalytics = exports.AgentActions = 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 _constants = require("../common/constants");
 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; }
@@ -35,7 +35,6 @@ var AgentActions = exports.AgentActions = /*#__PURE__*/function (AgentActions) {
   AgentActions["UNVERIFY"] = "unverify";
   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)(),
@@ -45,7 +44,7 @@ var useRovoAgentActionAnalytics = exports.useRovoAgentActionAnalytics = function
     var attributes = _objectSpread(_objectSpread(_objectSpread({}, (0, _utils.getAttributesFromContexts)(analyticsContext.getAtlaskitAnalyticsContext())), commonAttributes), event.attributes);
     createAnalyticsEvent(_objectSpread(_objectSpread(_objectSpread({}, eventConfig), event), {}, {
       attributes: attributes
-    })).fire(ANALYTICS_CHANNEL);
+    })).fire(_constants.ANALYTICS_CHANNEL);
   }, [createAnalyticsEvent, eventConfig, commonAttributes, analyticsContext]);
   var trackAgentAction = (0, _react.useCallback)(function (action, attributes) {
     fireAnalyticsEvent({

package/dist/cjs/debug/index.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRovoAgentDebugAnalytics = exports.AgentDebugActions = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = require("react");
+var _analyticsNext = require("@atlaskit/analytics-next");
+var _constants = require("../common/constants");
+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 AgentDebugActions = exports.AgentDebugActions = /*#__PURE__*/function (AgentDebugActions) {
+  /* View debug modal */
+  AgentDebugActions["VIEW"] = "debugView";
+  /* Copy all debug data */
+  AgentDebugActions["COPY_ALL"] = "debugCopyAll";
+  /* Copy debug data */
+  AgentDebugActions["COPY"] = "debugCopy";
+  /* Toggle skill info */
+  AgentDebugActions["TOGGLE_SKILL_INFO"] = "debugToggleSkillInfo";
+  /* Error occurred */
+  AgentDebugActions["ERROR"] = "debugError";
+  return AgentDebugActions;
+}({});
+var useRovoAgentDebugAnalytics = exports.useRovoAgentDebugAnalytics = function useRovoAgentDebugAnalytics(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(_constants.ANALYTICS_CHANNEL);
+  }, [createAnalyticsEvent, eventConfig, commonAttributes, analyticsContext]);
+  var trackAgentDebug = (0, _react.useCallback)(function (action, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: action,
+      attributes: attributes
+    });
+  }, [fireAnalyticsEvent]);
+  var trackAgentDebugError = (0, _react.useCallback)(function (action, error, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgentError',
+      action: action,
+      attributes: _objectSpread(_objectSpread({}, attributes), error && {
+        error: {
+          message: error.message
+        }
+      })
+    });
+  }, [fireAnalyticsEvent]);
+  return {
+    trackAgentDebug: trackAgentDebug,
+    trackAgentDebugError: trackAgentDebugError
+  };
+};

package/dist/es2019/actions/index.js

@@ -1,6 +1,6 @@
 import { useCallback, useContext } from 'react';
-import { FabricChannel } from '@atlaskit/analytics-listeners';
 import { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../common/constants';
 import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
 export let AgentActions = /*#__PURE__*/function (AgentActions) {
   /* View agent clicked */
@@ -25,7 +25,6 @@ export let AgentActions = /*#__PURE__*/function (AgentActions) {
   AgentActions["UNVERIFY"] = "unverify";
   return AgentActions;
 }({});
-export const ANALYTICS_CHANNEL = FabricChannel.aiMate;
 export const useRovoAgentActionAnalytics = commonAttributes => {
   const analyticsContext = useContext(AnalyticsReactContext);
   const {

package/dist/es2019/debug/index.js

@@ -0,0 +1,61 @@
+import { useCallback, useContext } from 'react';
+import { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../common/constants';
+import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
+export let AgentDebugActions = /*#__PURE__*/function (AgentDebugActions) {
+  /* View debug modal */
+  AgentDebugActions["VIEW"] = "debugView";
+  /* Copy all debug data */
+  AgentDebugActions["COPY_ALL"] = "debugCopyAll";
+  /* Copy debug data */
+  AgentDebugActions["COPY"] = "debugCopy";
+  /* Toggle skill info */
+  AgentDebugActions["TOGGLE_SKILL_INFO"] = "debugToggleSkillInfo";
+  /* Error occurred */
+  AgentDebugActions["ERROR"] = "debugError";
+  return AgentDebugActions;
+}({});
+export const useRovoAgentDebugAnalytics = 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 trackAgentDebug = useCallback((action, attributes) => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action,
+      attributes
+    });
+  }, [fireAnalyticsEvent]);
+  const trackAgentDebugError = useCallback((action, error, attributes) => {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgentError',
+      action,
+      attributes: {
+        ...attributes,
+        ...(error && {
+          error: {
+            message: error.message
+          }
+        })
+      }
+    });
+  }, [fireAnalyticsEvent]);
+  return {
+    trackAgentDebug,
+    trackAgentDebugError
+  };
+};

package/dist/esm/actions/index.js

@@ -2,8 +2,8 @@ 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 { ANALYTICS_CHANNEL } from '../common/constants';
 import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
 export var AgentActions = /*#__PURE__*/function (AgentActions) {
   /* View agent clicked */
@@ -28,7 +28,6 @@ export var AgentActions = /*#__PURE__*/function (AgentActions) {
   AgentActions["UNVERIFY"] = "unverify";
   return AgentActions;
 }({});
-export var ANALYTICS_CHANNEL = FabricChannel.aiMate;
 export var useRovoAgentActionAnalytics = function useRovoAgentActionAnalytics(commonAttributes) {
   var analyticsContext = useContext(AnalyticsReactContext);
   var _useAnalyticsEvents = useAnalyticsEvents(),

package/dist/esm/debug/index.js

@@ -0,0 +1,54 @@
+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 { AnalyticsReactContext, useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../common/constants';
+import { getAttributesFromContexts, getDefaultTrackEventConfig } from '../common/utils';
+export var AgentDebugActions = /*#__PURE__*/function (AgentDebugActions) {
+  /* View debug modal */
+  AgentDebugActions["VIEW"] = "debugView";
+  /* Copy all debug data */
+  AgentDebugActions["COPY_ALL"] = "debugCopyAll";
+  /* Copy debug data */
+  AgentDebugActions["COPY"] = "debugCopy";
+  /* Toggle skill info */
+  AgentDebugActions["TOGGLE_SKILL_INFO"] = "debugToggleSkillInfo";
+  /* Error occurred */
+  AgentDebugActions["ERROR"] = "debugError";
+  return AgentDebugActions;
+}({});
+export var useRovoAgentDebugAnalytics = function useRovoAgentDebugAnalytics(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 trackAgentDebug = useCallback(function (action, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgent',
+      action: action,
+      attributes: attributes
+    });
+  }, [fireAnalyticsEvent]);
+  var trackAgentDebugError = useCallback(function (action, error, attributes) {
+    fireAnalyticsEvent({
+      actionSubject: 'rovoAgentError',
+      action: action,
+      attributes: _objectSpread(_objectSpread({}, attributes), error && {
+        error: {
+          message: error.message
+        }
+      })
+    });
+  }, [fireAnalyticsEvent]);
+  return {
+    trackAgentDebug: trackAgentDebug,
+    trackAgentDebugError: trackAgentDebugError
+  };
+};

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

@@ -1,4 +1,3 @@
-import { FabricChannel } from '@atlaskit/analytics-listeners';
 import type { RemainingRequired } from '../common/types';
 export declare enum AgentActions {
     VIEW = "view",
@@ -16,7 +15,6 @@ 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;

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

@@ -0,0 +1,16 @@
+import type { RemainingRequired } from '../common/types';
+export declare enum AgentDebugActions {
+    VIEW = "debugView",
+    COPY_ALL = "debugCopyAll",
+    COPY = "debugCopy",
+    TOGGLE_SKILL_INFO = "debugToggleSkillInfo",
+    ERROR = "debugError"
+}
+type CommonAnalyticsAttributes = {
+    agentId: string;
+};
+export declare const useRovoAgentDebugAnalytics: <T extends Partial<CommonAnalyticsAttributes>>(commonAttributes?: T) => {
+    trackAgentDebug: (action: AgentDebugActions, attributes?: RemainingRequired<CommonAnalyticsAttributes, T extends undefined ? {} : T> & Record<string, any>) => void;
+    trackAgentDebugError: (action: AgentDebugActions, error?: Error, attributes?: RemainingRequired<CommonAnalyticsAttributes, T extends undefined ? {} : T> & Record<string, any>) => void;
+};
+export {};

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

@@ -1,4 +1,3 @@
-import { FabricChannel } from '@atlaskit/analytics-listeners';
 import type { RemainingRequired } from '../common/types';
 export declare enum AgentActions {
     VIEW = "view",
@@ -16,7 +15,6 @@ 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;

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

@@ -0,0 +1,16 @@
+import type { RemainingRequired } from '../common/types';
+export declare enum AgentDebugActions {
+    VIEW = "debugView",
+    COPY_ALL = "debugCopyAll",
+    COPY = "debugCopy",
+    TOGGLE_SKILL_INFO = "debugToggleSkillInfo",
+    ERROR = "debugError"
+}
+type CommonAnalyticsAttributes = {
+    agentId: string;
+};
+export declare const useRovoAgentDebugAnalytics: <T extends Partial<CommonAnalyticsAttributes>>(commonAttributes?: T) => {
+    trackAgentDebug: (action: AgentDebugActions, attributes?: RemainingRequired<CommonAnalyticsAttributes, T extends undefined ? {} : T> & Record<string, any>) => void;
+    trackAgentDebugError: (action: AgentDebugActions, error?: Error, attributes?: RemainingRequired<CommonAnalyticsAttributes, T extends undefined ? {} : T> & Record<string, any>) => void;
+};
+export {};

package/package.json

@@ -83,7 +83,7 @@
 		]
 	},
 	"name": "@atlaskit/rovo-agent-analytics",
-	"version": "0.10.0",
+	"version": "0.11.0",
 	"description": "Rovo Agents analytics",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",