@atlaskit/link-datasource 2.12.0 → 2.12.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/link-datasource
 
+## 2.12.1
+
+### Patch Changes
+
+- [#137443](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/137443)
+  [`1be2afe0863d9`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1be2afe0863d9) -
+  Fire analytic event `ui.error.shown.inlineEdit` when error flag is shown
+
 ## 2.12.0
 
 ### Minor Changes

package/dist/cjs/hooks/useDatasourceTableFlag.js

@@ -12,11 +12,20 @@ var _reactIntlNext = require("react-intl-next");
 var _uuid = _interopRequireDefault(require("uuid"));
 var _flag = require("@atlaskit/flag");
 var _crossCircle = _interopRequireDefault(require("@atlaskit/icon/glyph/cross-circle"));
+var _analytics = require("../analytics");
 var _messages = require("../ui/issue-like-table/messages");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 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 getErrorReason = function getErrorReason(status) {
+  switch (status) {
+    case 403:
+      return 'access_denied';
+    default:
+      return 'request_failed';
+  }
+};
 var getGenericErrorMessage = function getGenericErrorMessage(status) {
   switch (status) {
     case 403:
@@ -34,6 +43,8 @@ var getGenericErrorMessage = function getGenericErrorMessage(status) {
 var useDatasourceTableFlag = exports.useDatasourceTableFlag = function useDatasourceTableFlag(options) {
   var _useFlags = (0, _flag.useFlags)(),
     showFlag = _useFlags.showFlag;
+  var _useDatasourceAnalyti = (0, _analytics.useDatasourceAnalyticsEvents)(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var showErrorFlag = (0, _react.useCallback)(function (args) {
     showFlag(_objectSpread(_objectSpread({
       // We need IconTile in order to scale the new icon to 24px
@@ -45,7 +56,10 @@ var useDatasourceTableFlag = exports.useDatasourceTableFlag = function useDataso
       id: (0, _uuid.default)(),
       isAutoDismiss: true
     }, getGenericErrorMessage(args === null || args === void 0 ? void 0 : args.status)), args));
-  }, [showFlag]);
+    fireEvent('ui.error.shown.inlineEdit', {
+      reason: getErrorReason(args === null || args === void 0 ? void 0 : args.status)
+    });
+  }, [fireEvent, showFlag]);
   return {
     showErrorFlag: showErrorFlag
   };

package/dist/es2019/hooks/useDatasourceTableFlag.js

@@ -3,7 +3,16 @@ import { FormattedMessage } from 'react-intl-next';
 import uuid from 'uuid';
 import { useFlags } from '@atlaskit/flag';
 import CrossCircleIcon from '@atlaskit/icon/glyph/cross-circle';
+import { useDatasourceAnalyticsEvents } from '../analytics';
 import { issueLikeTableMessages } from '../ui/issue-like-table/messages';
+const getErrorReason = status => {
+  switch (status) {
+    case 403:
+      return 'access_denied';
+    default:
+      return 'request_failed';
+  }
+};
 const getGenericErrorMessage = status => {
   switch (status) {
     case 403:
@@ -22,6 +31,9 @@ export const useDatasourceTableFlag = options => {
   const {
     showFlag
   } = useFlags();
+  const {
+    fireEvent
+  } = useDatasourceAnalyticsEvents();
   const showErrorFlag = useCallback(args => {
     showFlag({
       // We need IconTile in order to scale the new icon to 24px
@@ -35,7 +47,10 @@ export const useDatasourceTableFlag = options => {
       ...getGenericErrorMessage(args === null || args === void 0 ? void 0 : args.status),
       ...args
     });
-  }, [showFlag]);
+    fireEvent('ui.error.shown.inlineEdit', {
+      reason: getErrorReason(args === null || args === void 0 ? void 0 : args.status)
+    });
+  }, [fireEvent, showFlag]);
   return {
     showErrorFlag
   };

package/dist/esm/hooks/useDatasourceTableFlag.js

@@ -6,7 +6,16 @@ import { FormattedMessage } from 'react-intl-next';
 import uuid from 'uuid';
 import { useFlags } from '@atlaskit/flag';
 import CrossCircleIcon from '@atlaskit/icon/glyph/cross-circle';
+import { useDatasourceAnalyticsEvents } from '../analytics';
 import { issueLikeTableMessages } from '../ui/issue-like-table/messages';
+var getErrorReason = function getErrorReason(status) {
+  switch (status) {
+    case 403:
+      return 'access_denied';
+    default:
+      return 'request_failed';
+  }
+};
 var getGenericErrorMessage = function getGenericErrorMessage(status) {
   switch (status) {
     case 403:
@@ -24,6 +33,8 @@ var getGenericErrorMessage = function getGenericErrorMessage(status) {
 export var useDatasourceTableFlag = function useDatasourceTableFlag(options) {
   var _useFlags = useFlags(),
     showFlag = _useFlags.showFlag;
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var showErrorFlag = useCallback(function (args) {
     showFlag(_objectSpread(_objectSpread({
       // We need IconTile in order to scale the new icon to 24px
@@ -35,7 +46,10 @@ export var useDatasourceTableFlag = function useDatasourceTableFlag(options) {
       id: uuid(),
       isAutoDismiss: true
     }, getGenericErrorMessage(args === null || args === void 0 ? void 0 : args.status)), args));
-  }, [showFlag]);
+    fireEvent('ui.error.shown.inlineEdit', {
+      reason: getErrorReason(args === null || args === void 0 ? void 0 : args.status)
+    });
+  }, [fireEvent, showFlag]);
   return {
     showErrorFlag: showErrorFlag
   };

package/dist/types/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::bd4a9ac1dd6f3a586ddf6c80d30b68fd>>
+ * @codegen <<SignedSource::87bb81d0c3b90473d208f9c02285004e>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type ComponentMetaDataType = {
@@ -157,6 +157,9 @@ export type InlineEditClickedDatasourceAttributesType = {
     integrationKey: string;
     fieldKey: string;
 };
+export type ErrorShownInlineEditAttributesType = {
+    reason: 'access_denied' | 'request_failed';
+};
 export type AnalyticsEventAttributes = {
     /**
      * Fires when user sees modal dialog. */
@@ -278,5 +281,8 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when inline edit is clicked to show edit mode */
     'ui.inlineEdit.clicked.datasource': InlineEditClickedDatasourceAttributesType;
+    /**
+     * Fired when the inline edit failed and the error flag is shown. */
+    'ui.error.shown.inlineEdit': ErrorShownInlineEditAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

package/dist/types-ts4.5/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::bd4a9ac1dd6f3a586ddf6c80d30b68fd>>
+ * @codegen <<SignedSource::87bb81d0c3b90473d208f9c02285004e>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type ComponentMetaDataType = {
@@ -157,6 +157,9 @@ export type InlineEditClickedDatasourceAttributesType = {
     integrationKey: string;
     fieldKey: string;
 };
+export type ErrorShownInlineEditAttributesType = {
+    reason: 'access_denied' | 'request_failed';
+};
 export type AnalyticsEventAttributes = {
     /**
      * Fires when user sees modal dialog. */
@@ -278,5 +281,8 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when inline edit is clicked to show edit mode */
     'ui.inlineEdit.clicked.datasource': InlineEditClickedDatasourceAttributesType;
+    /**
+     * Fired when the inline edit failed and the error flag is shown. */
+    'ui.error.shown.inlineEdit': ErrorShownInlineEditAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/link-datasource",
-	"version": "2.12.0",
+	"version": "2.12.1",
 	"description": "UI Components to support linking platform dataset feature",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",