@atlaskit/smart-card 32.5.1 → 32.6.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/smart-card
 
+## 32.6.0
+
+### Minor Changes
+
+- [#174435](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/174435)
+  [`fc8332240eec9`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/fc8332240eec9) -
+  Migration of some UI analytics
+- [#174257](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/174257)
+  [`d2af0045121e9`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d2af0045121e9) -
+  Clean up smart-card-remove-block-card-from-embed and update embed card resolving view testId
+
+### Patch Changes
+
+- [#175610](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/175610)
+  [`cd659ec54a158`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cd659ec54a158) -
+  Remove FF platform_smart-card-migrate-operational-analytics
+- Updated dependencies
+
 ## 32.5.1
 
 ### Patch Changes

package/analytics.spec.yaml

@@ -444,3 +444,166 @@ events:
           required: true
           description: Additional details about the error including the stack trace.
           type: object
+  - smartLink clicked:
+      type: ui
+      description: fires an event that represents when a user clicks on a Smart Link.
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext, *ResolvedContext]
+        id:
+          required: true
+          type: string
+          description: The unique ID for this Smart Link.
+        display:
+          required: true
+          type: ['inline', 'block', 'embed', 'embedPreview', 'flexible', 'hoverCardPreview']
+          description: Whether the card was an Inline, Block, Embed or Flexible UI
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+        isModifierKeyPressed:
+          required: false
+          type: boolean
+          description: Whether a modifier key was pressed when clicking the Smart Link.
+  - smartLink clicked (titleGoToLink):
+      type: ui
+      description: fires an event that represents when a user clicks on a Smart Link.
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext, *ResolvedContext]
+        id:
+          required: true
+          type: string
+          description: The unique ID for this Smart Link.
+        display:
+          required: true
+          type: ['inline', 'block', 'embed', 'embedPreview', 'flexible', 'hoverCardPreview']
+          description: Whether the card was an Inline, Block, Embed or Flexible UI
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+        isModifierKeyPressed:
+          required: false
+          type: boolean
+          description: Whether a modifier key was pressed when clicking the Smart Link.
+  - hoverCard viewed:
+      type: ui
+      description: fires an event that represents a hover preview being opened.
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext, *ResolvedContext]
+        previewDisplay:
+          type: ['card', 'embed']
+          required: true
+          description: What format the preview is in.
+        previewInvokeMethod:
+          type: ['keyboard', 'mouse_hover', 'mouse_click']
+          required: false
+          description: How the preview was triggered.
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+  - hoverCard dismissed:
+      type: ui
+      description: fires an event that represents a hover preview being dismissed.
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext, *ResolvedContext]
+        previewDisplay:
+          type: ['card', 'embed']
+          required: true
+          description: What format the preview is in.
+        hoverTime:
+          type: number
+          required: true
+          description:
+            The duration that the user hovered over a Smart Link before the preview was dismissed.
+        previewInvokeMethod:
+          type: ['keyboard', 'mouse_hover', 'mouse_click']
+          required: false
+          description: How the preview was triggered.
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+  - button clicked (connectAccount):
+      type: ui
+      description:
+        fires an event that represents when a user clicks on the authentication call to action with
+        no current authenticated account. (i.e. Connect to Preview).
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+        display:
+          required: true
+          type: ['inline', 'block', 'embed', 'embedPreview', 'flexible', 'hoverCardPreview']
+          description: Whether the card was an Inline, Block, Embed or Flexible UI.
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+  - smartLink clicked (tryAnotherAccount):
+      type: ui
+      description:
+        fires an event that represents when a user clicks on the authentication call to action with
+        a forbidden authenticated account. (i.e. Try another account).
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+        display:
+          required: true
+          type: ['inline', 'block', 'embed', 'embedPreview', 'flexible', 'hoverCardPreview']
+          description: Whether the card was an Inline, Block, Embed or Flexible UI.
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+  - consentModal closed:
+      type: ui
+      description:
+        fires an event that represents when a user closed the authentication window without
+        authenticating after opening it.
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+        display:
+          required: true
+          type: ['inline', 'block', 'embed', 'embedPreview', 'flexible', 'hoverCardPreview']
+          description: Whether the card was an Inline, Block, Embed or Flexible UI.
+        definitionId:
+          required: false
+          type: string
+          description: The definitionId of the Smart Link resolver invoked.
+  - button clicked (learnMore):
+      type: ui
+      description:
+        fires an event that signifies that a "Learn More" link was clicked on an unauthenticated
+        card
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+  - button clicked (smartLinkStatusLozenge):
+      type: ui
+      description: fires an event that represent a click was performed on a Status Lozenge
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+  - button clicked (smartLinkStatusListItem):
+      type: ui
+      description:
+        fires an event that represent a click was performed on a Status Lozenge's dropdown item
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+  - button clicked (smartLinkStatusOpenPreview):
+      type: ui
+      description:
+        fires an event that represent a click was performed on a Status Lozenge open preview button
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+  - button clicked (smartLinkFollowButton):
+      type: ui
+      description: fires an event that represents a click was performed on the follow button.
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+  - button clicked (StatusUpdateAction):
+      type: ui
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]
+  - button clicked (GetStatusTransitionsAction):
+      type: ui
+      attributes:
+        <<: [*PackageMetaDataContext, *CommonContext]

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

@@ -107,18 +107,32 @@ var useSmartCardActions = exports.useSmartCardActions = function useSmartCardAct
     var services = (0, _helpers.getServices)(details);
     // When authentication is triggered, let GAS know!
     if (status === 'unauthorized') {
-      analytics.ui.authEvent({
-        display: appearance,
-        definitionId: definitionId,
-        extensionKey: extensionKey
-      });
+      if ((0, _platformFeatureFlags.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 ((0, _platformFeatureFlags.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', {
@@ -128,52 +142,42 @@ var useSmartCardActions = exports.useSmartCardActions = function useSmartCardAct
         fireEvent('track.applicationAccount.connected', {
           definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
         });
-        if ((0, _platformFeatureFlags.fg)('platform_smart-card-migrate-operational-analytics')) {
-          (0, _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
-          });
-        }
+        (0, _analytics.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 ((0, _platformFeatureFlags.fg)('platform_smart-card-migrate-operational-analytics')) {
-          var _err$type;
-          (0, _analytics.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;
+        (0, _analytics.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 ((0, _platformFeatureFlags.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 = (0, _react.useCallback)( /*#__PURE__*/function () {
     var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(opts, appearance) {
       var key, action, source;

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

@@ -79,6 +79,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -105,6 +106,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -149,6 +151,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -213,6 +216,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -239,6 +243,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -357,6 +362,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -390,6 +396,7 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * @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,
@@ -421,28 +428,35 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
        * 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((0, _analytics.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((0, _analytics.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((0, _analytics.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((0, _analytics.uiSmartLinkStatusOpenPreviewButtonClicked)(), commonAttributes));
       },
+      /**
+       * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+       */
       smartLinkServerActionClickedEvent: function smartLinkServerActionClickedEvent(props) {
         return dispatchAnalytics(applyCommonAttributes((0, _analytics2.uiServerActionClicked)(props), commonAttributes));
       }
@@ -512,134 +526,6 @@ var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLin
           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;
-        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', experienceId, {
-          extensionKey: extensionKey,
-          status: 'success'
-        });
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.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;
-        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', experienceId, {
-          extensionKey: extensionKey,
-          status: reason
-        });
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.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 = (0, _analytics.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((0, _analytics.chunkloadFailedEvent)({
-          display: display,
-          error: error,
-          errorInfo: errorInfo,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        }), commonAttributes));
       }
     };
   }, [defaultId, commonAttributes, dispatchAnalytics]);