@atlaskit/smart-card 32.5.0 → 32.6.0

package/dist/esm/state/actions/index.js

@@ -100,18 +100,32 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
     var services = getServices(details);
     // When authentication is triggered, let GAS know!
     if (status === 'unauthorized') {
-      analytics.ui.authEvent({
-        display: appearance,
-        definitionId: definitionId,
-        extensionKey: extensionKey
-      });
+      if (fg('platform_migrate-some-ui-events-smart-card')) {
+        fireEvent('ui.button.clicked.connectAccount', {
+          display: appearance,
+          definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+        });
+      } else {
+        analytics.ui.authEvent({
+          display: appearance,
+          definitionId: definitionId,
+          extensionKey: extensionKey
+        });
+      }
     }
     if (status === 'forbidden') {
-      analytics.ui.authAlternateAccountEvent({
-        display: appearance,
-        definitionId: definitionId,
-        extensionKey: extensionKey
-      });
+      if (fg('platform_migrate-some-ui-events-smart-card')) {
+        fireEvent('ui.smartLink.clicked.tryAnotherAccount', {
+          display: appearance,
+          definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+        });
+      } else {
+        analytics.ui.authAlternateAccountEvent({
+          display: appearance,
+          definitionId: definitionId,
+          extensionKey: extensionKey
+        });
+      }
     }
     if (services.length > 0) {
       fireEvent('screen.consentModal.viewed', {
@@ -121,52 +135,42 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
         fireEvent('track.applicationAccount.connected', {
           definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
         });
-        if (fg('platform_smart-card-migrate-operational-analytics')) {
-          startUfoExperience('smart-link-authenticated', id, {
-            extensionKey: extensionKey,
-            status: 'success'
-          });
-          fireEvent('operational.smartLink.connectSucceeded', {
-            definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
-          });
-        } else {
-          analytics.operational.connectSucceededEvent({
-            id: id,
-            definitionId: definitionId,
-            extensionKey: extensionKey
-          });
-        }
+        startUfoExperience('smart-link-authenticated', id, {
+          extensionKey: extensionKey,
+          status: 'success'
+        });
+        fireEvent('operational.smartLink.connectSucceeded', {
+          definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+        });
         reload();
       }, function (err) {
-        if (fg('platform_smart-card-migrate-operational-analytics')) {
-          var _err$type;
-          startUfoExperience('smart-link-authenticated', id, {
-            extensionKey: extensionKey,
-            status: err.type
-          });
-          fireEvent('operational.smartLink.connectFailed', {
-            definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null,
-            reason: (_err$type = err.type) !== null && _err$type !== void 0 ? _err$type : null
-          });
-        } else {
-          analytics.operational.connectFailedEvent({
-            id: id,
-            definitionId: definitionId,
-            extensionKey: extensionKey,
-            reason: err.type
-          });
-        }
+        var _err$type;
+        startUfoExperience('smart-link-authenticated', id, {
+          extensionKey: extensionKey,
+          status: err.type
+        });
+        fireEvent('operational.smartLink.connectFailed', {
+          definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null,
+          reason: (_err$type = err.type) !== null && _err$type !== void 0 ? _err$type : null
+        });
         if (err.type === 'auth_window_closed') {
-          analytics.ui.closedAuthEvent({
-            display: appearance,
-            definitionId: definitionId,
-            extensionKey: extensionKey
-          });
+          if (fg('platform_migrate-some-ui-events-smart-card')) {
+            fireEvent('ui.consentModal.closed', {
+              display: appearance,
+              definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+            });
+          } else {
+            analytics.ui.closedAuthEvent({
+              display: appearance,
+              definitionId: definitionId,
+              extensionKey: extensionKey
+            });
+          }
         }
         reload();
       });
     }
-  }, [getSmartLinkState, analytics.ui, analytics.operational, id, reload, fireEvent]);
+  }, [getSmartLinkState, analytics.ui, id, reload, fireEvent]);
   var invoke = useCallback( /*#__PURE__*/function () {
     var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(opts, appearance) {
       var key, action, source;

package/dist/esm/state/analytics/useSmartLinkAnalytics.js

@@ -5,7 +5,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { useMemo } from 'react';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
 import { getUrl } from '@atlaskit/linking-common';
-import { chunkloadFailedEvent as _chunkloadFailedEvent, connectFailedEvent as _connectFailedEvent, connectSucceededEvent as _connectSucceededEvent, context, instrumentEvent, invokeFailedEvent as _invokeFailedEvent, invokeSucceededEvent as _invokeSucceededEvent, uiActionClickedEvent, uiAuthAlternateAccountEvent, uiAuthEvent, uiCardClickedEvent, uiClosedAuthEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiHoverCardViewedEvent, uiLearnMoreLinkClickedEvent, uiRenderFailedEvent, uiRenderSuccessEvent, uiSmartLinkStatusListItemButtonClicked, uiSmartLinkStatusLozengeButtonClicked, uiSmartLinkStatusOpenPreviewButtonClicked } from '../../utils/analytics';
+import { context, invokeFailedEvent as _invokeFailedEvent, invokeSucceededEvent as _invokeSucceededEvent, uiActionClickedEvent, uiAuthAlternateAccountEvent, uiAuthEvent, uiCardClickedEvent, uiClosedAuthEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiHoverCardViewedEvent, uiLearnMoreLinkClickedEvent, uiRenderFailedEvent, uiRenderSuccessEvent, uiSmartLinkStatusListItemButtonClicked, uiSmartLinkStatusLozengeButtonClicked, uiSmartLinkStatusOpenPreviewButtonClicked } from '../../utils/analytics';
 import { uiServerActionClicked } from '../../utils/analytics/analytics';
 import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getStatusDetails, getSubproduct } from '../helpers';
 import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './ufoExperiences';
@@ -72,6 +72,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       authEvent: function authEvent(_ref) {
         var display = _ref.display,
@@ -98,6 +99,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       authAlternateAccountEvent: function authAlternateAccountEvent(_ref2) {
         var display = _ref2.display,
@@ -142,6 +144,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param location Where the Smart Link is currently rendered.
        * @param destinationProduct The product the Smart Link is linked to.
        * @returns
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       cardClickedEvent: function cardClickedEvent(_ref3) {
         var id = _ref3.id,
@@ -206,6 +209,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param previewInvokeMethod How the preview was triggered.
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       hoverCardOpenLinkClickedEvent: function hoverCardOpenLinkClickedEvent(_ref5) {
         var previewDisplay = _ref5.previewDisplay,
@@ -232,6 +236,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       closedAuthEvent: function closedAuthEvent(_ref6) {
         var display = _ref6.display,
@@ -350,6 +355,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param previewInvokeMethod How the preview was triggered.
        * @returns
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       hoverCardViewedEvent: function hoverCardViewedEvent(_ref9) {
         var previewDisplay = _ref9.previewDisplay,
@@ -383,6 +389,7 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * @param extensionKey The extensionKey of the Smart Link resolver invoked.
        * @param previewInvokeMethod How the preview was triggered.
        * @returns
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       hoverCardDismissedEvent: function hoverCardDismissedEvent(_ref10) {
         var id = _ref10.id,
@@ -414,28 +421,35 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
        * Fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param location The location where a link is displayed (jiraWebLinks, confluencePages etc)
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       learnMoreClickedEvent: function learnMoreClickedEvent() {
         return dispatchAnalytics(applyCommonAttributes(uiLearnMoreLinkClickedEvent(), commonAttributes));
       },
       /**
        * Fires an event that represent a click was performed on a Status Lozenge
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       smartLinkLozengeActionClickedEvent: function smartLinkLozengeActionClickedEvent() {
         return dispatchAnalytics(applyCommonAttributes(uiSmartLinkStatusLozengeButtonClicked(), commonAttributes));
       },
       /**
        * Fires an event that represent a click was performed on a Status Lozenge's dropdown item
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       smartLinkLozengeActionListItemClickedEvent: function smartLinkLozengeActionListItemClickedEvent() {
         return dispatchAnalytics(applyCommonAttributes(uiSmartLinkStatusListItemButtonClicked(), commonAttributes));
       },
       /**
        * Fires an event that represent a click was performed on a Status Lozenge open preview button
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
        */
       smartLinkLozengeActionErrorOpenPreviewClickedEvent: function smartLinkLozengeActionErrorOpenPreviewClickedEvent() {
         return dispatchAnalytics(applyCommonAttributes(uiSmartLinkStatusOpenPreviewButtonClicked(), commonAttributes));
       },
+      /**
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+       */
       smartLinkServerActionClickedEvent: function smartLinkServerActionClickedEvent(props) {
         return dispatchAnalytics(applyCommonAttributes(uiServerActionClicked(props), commonAttributes));
       }
@@ -505,134 +519,6 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defau
           destinationSubproduct: destinationSubproduct,
           location: location
         }), commonAttributes));
-      },
-      /**
-       * This fires an event that represents an account successfully being connected via a Smart Link.
-       * @param id The unique ID for this Smart Link.
-       * @param definitionId The definitionId of the Smart Link resolver invoked.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-       */
-      connectSucceededEvent: function connectSucceededEvent(_ref13) {
-        var id = _ref13.id,
-          extensionKey = _ref13.extensionKey,
-          definitionId = _ref13.definitionId,
-          resourceType = _ref13.resourceType,
-          destinationProduct = _ref13.destinationProduct,
-          destinationSubproduct = _ref13.destinationSubproduct,
-          location = _ref13.location;
-        var experienceId = id ? id : defaultId;
-        startUfoExperience('smart-link-authenticated', experienceId, {
-          extensionKey: extensionKey,
-          status: 'success'
-        });
-        dispatchAnalytics(applyCommonAttributes(_connectSucceededEvent(_objectSpread(_objectSpread({}, commonAttributes), {}, {
-          id: experienceId,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        })), commonAttributes));
-      },
-      /**
-       * This fires an event that represents an account unsuccessfully being connected.
-       * @param id The unique ID for this Smart Link.
-       * @param definitionId The definitionId of the Smart Link resolver invoked.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param reason The reason why the Smart Link connect account failed.
-       * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-       */
-      connectFailedEvent: function connectFailedEvent(_ref14) {
-        var id = _ref14.id,
-          reason = _ref14.reason,
-          extensionKey = _ref14.extensionKey,
-          definitionId = _ref14.definitionId,
-          resourceType = _ref14.resourceType,
-          destinationProduct = _ref14.destinationProduct,
-          destinationSubproduct = _ref14.destinationSubproduct,
-          location = _ref14.location;
-        var experienceId = id ? id : defaultId;
-        startUfoExperience('smart-link-authenticated', experienceId, {
-          extensionKey: extensionKey,
-          status: reason
-        });
-        dispatchAnalytics(applyCommonAttributes(_connectFailedEvent(_objectSpread(_objectSpread({}, commonAttributes), {}, {
-          id: experienceId,
-          reason: reason,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        })), commonAttributes));
-      },
-      /**
-       * This fires an event which represents a Smart Link request succeeding or failing based on the status.
-       * @param id The unique ID for this Smart Link.
-       * @param status The status of the Smart Link.
-       * @param definitionId The definitionId of the Smart Link resolver invoked.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
-       * @param error An error representing why the Smart Link request failed.
-       * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-       */
-      instrument: function instrument(_ref15) {
-        var id = _ref15.id,
-          status = _ref15.status,
-          extensionKey = _ref15.extensionKey,
-          definitionId = _ref15.definitionId,
-          resourceType = _ref15.resourceType,
-          destinationProduct = _ref15.destinationProduct,
-          destinationSubproduct = _ref15.destinationSubproduct,
-          location = _ref15.location,
-          error = _ref15.error;
-        var event = instrumentEvent(_objectSpread(_objectSpread({}, commonAttributes), {}, {
-          id: id,
-          status: status,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location,
-          error: error
-        }));
-        if (event) {
-          dispatchAnalytics(applyCommonAttributes(event, commonAttributes));
-        }
-      },
-      /**
-       * This fires an event that represents when a Smart Link renders unsuccessfully.
-       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       * @param id The unique ID for this Smart Link.
-       * @param error: An error representing why the Smart Link render failed.
-       * @param errorInfo: Additional details about the error including the stack trace.
-       * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-       */
-      chunkloadFailedEvent: function chunkloadFailedEvent(_ref16) {
-        var display = _ref16.display,
-          error = _ref16.error,
-          errorInfo = _ref16.errorInfo,
-          extensionKey = _ref16.extensionKey,
-          definitionId = _ref16.definitionId,
-          resourceType = _ref16.resourceType,
-          destinationProduct = _ref16.destinationProduct,
-          destinationSubproduct = _ref16.destinationSubproduct,
-          location = _ref16.location;
-        dispatchAnalytics(applyCommonAttributes(_chunkloadFailedEvent({
-          display: display,
-          error: error,
-          errorInfo: errorInfo,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        }), commonAttributes));
       }
     };
   }, [defaultId, commonAttributes, dispatchAnalytics]);