@atlaskit/smart-card 21.2.0 → 22.1.0

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # @atlaskit/smart-card
 
+## 22.1.0
+
+### Minor Changes
+
+- [`c908307ef8e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c908307ef8e) - Embed Preview: Update embed preview modal analytics
+
+## 22.0.0
+
+### Major Changes
+
+- [`e2bd5c50884`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e2bd5c50884) - This PR changes how Smart Link Analytics events are defined.
+  Analytics events now use object args rather than inline arguments.
+
+  Previously:
+
+  ```
+      const analytics = useSmartLinkAnalytics(
+          url,
+          analyticsHandler,
+          undefined,
+          location,
+      );
+      analytics.ui.cardClickedEvent(
+          id,
+          'block',
+          'resolved',
+          'this-is-a-test-definition-id',
+          'this-is-a-test-extension-key',
+      );
+  ```
+
+  After change:
+
+  ```
+      const analytics = useSmartLinkAnalytics(
+          url,
+          analyticsHandler,
+          undefined,
+          location,
+      );
+      analytics.ui.cardClickedEvent({
+          id,
+          display: 'block',
+          status: 'resolved',
+          definitionId: 'this-is-a-test-definition-id',
+          extensionKey: 'this-is-a-test-extension-key',
+      });
+  ```
+
+## 21.3.0
+
+### Minor Changes
+
+- [`1c76ddcd2f3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1c76ddcd2f3) - [ux] Flex-UI: - Add props to generic block: - onRender - onTransitionEnd - blockRef
+  HoverCard: - use the above properties in Hover Card to apply transition to preview block and fallback to snippet
+
 ## 21.2.0
 
 ### Minor Changes

package/dist/cjs/extractors/block/index.js

@@ -55,14 +55,13 @@ var extractBlockDetails = function extractBlockDetails(jsonLd) {
 
 var extractBlockActions = function extractBlockActions(props, jsonLd, opts, platform) {
   if (opts) {
-    var featureFlags = opts.featureFlags,
-        handleInvoke = opts.handleInvoke,
-        handleAnalytics = opts.handleAnalytics,
-        extensionKey = opts.extensionKey,
-        source = opts.source,
-        testId = opts.testId;
+    var handleInvoke = opts.handleInvoke;
     var actions = (0, _extractActions.extractActions)(jsonLd, handleInvoke);
-    var previewAction = (0, _extractPreviewAction.extractPreviewAction)(extensionKey, props, jsonLd, handleInvoke, handleAnalytics, testId, platform, source, featureFlags); // The previewAction should always be the last action
+    var previewAction = (0, _extractPreviewAction.extractPreviewAction)(_objectSpread(_objectSpread({}, opts), {}, {
+      viewProps: props,
+      jsonLd: jsonLd,
+      platform: platform
+    })); // The previewAction should always be the last action
 
     if (previewAction) {
       actions.push(previewAction);

package/dist/cjs/extractors/common/actions/extractPreviewAction.js

@@ -9,8 +9,6 @@ exports.extractPreviewAction = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
-var _analytics = require("../../../utils/analytics");
-
 var _detail = require("../detail");
 
 var _extractors = require("@atlaskit/linking-common/extractors");
@@ -63,16 +61,19 @@ var getInvokeOpts = function getInvokeOpts(key, action, source) {
   };
 };
 
-var extractPreviewAction = function extractPreviewAction() {
-  var extensionKey = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'empty-object-provider';
-  var viewProps = arguments.length > 1 ? arguments[1] : undefined;
-  var jsonLd = arguments.length > 2 ? arguments[2] : undefined;
-  var handleInvoke = arguments.length > 3 ? arguments[3] : undefined;
-  var handleAnalytics = arguments.length > 4 ? arguments[4] : undefined;
-  var testId = arguments.length > 5 ? arguments[5] : undefined;
-  var platform = arguments.length > 6 ? arguments[6] : undefined;
-  var source = arguments.length > 7 ? arguments[7] : undefined;
-  var featureFlags = arguments.length > 8 ? arguments[8] : undefined;
+var extractPreviewAction = function extractPreviewAction(_ref) {
+  var _ref$extensionKey = _ref.extensionKey,
+      extensionKey = _ref$extensionKey === void 0 ? 'empty-object-provider' : _ref$extensionKey,
+      viewProps = _ref.viewProps,
+      jsonLd = _ref.jsonLd,
+      handleInvoke = _ref.handleInvoke,
+      testId = _ref.testId,
+      platform = _ref.platform,
+      origin = _ref.origin,
+      _ref$source = _ref.source,
+      source = _ref$source === void 0 ? 'block' : _ref$source,
+      featureFlags = _ref.featureFlags,
+      analytics = _ref.analytics;
   // Extract metadata from view props & raw JSON-LD.
   var metadataFromJsonLd = getMetadataFromJsonLd(jsonLd, platform);
   var metadataFromViewProps = getMetadataFromResolvedProps(viewProps);
@@ -84,14 +85,10 @@ var extractPreviewAction = function extractPreviewAction() {
     // Build action using instrumentation hooks.
     var key = extensionKey;
     var previewAction = (0, _BlockCard.PreviewAction)(_objectSpread(_objectSpread({}, metadata), {}, {
+      analytics: analytics,
+      origin: origin,
       featureFlags: featureFlags,
       testId: testId,
-      onOpen: function onOpen() {
-        handleAnalytics((0, _analytics.uiRenderSuccessEvent)('preview', 'resolved', key));
-      },
-      onOpenFailed: function onOpenFailed(error, errorInfo) {
-        handleAnalytics((0, _analytics.uiRenderFailedEvent)('preview', error, errorInfo));
-      },
       onDownloadActionClick: function onDownloadActionClick() {
         handleInvoke(getInvokeOpts(key, 'DownloadAction'));
       },
@@ -101,7 +98,7 @@ var extractPreviewAction = function extractPreviewAction() {
     })); // Setup props to go through proper Redux 'invocation' flow
     // for analytics, further state management if required in future.
 
-    var previewActionProps = getInvokeOpts(key, 'PreviewAction', source !== null && source !== void 0 ? source : 'block'); // - Promise invoked by the action invocation handler; open preview.
+    var previewActionProps = getInvokeOpts(key, 'PreviewAction', source); // - Promise invoked by the action invocation handler; open preview.
 
     previewActionProps.action.promise = previewAction.promise; // - Promise invoked on click of `Preview` on block card; trigger above promise.
 

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

@@ -210,24 +210,51 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
     var services = (0, _helpers.getServices)(details); // When authentication is triggered, let GAS know!
 
     if (status === 'unauthorized') {
-      analytics.ui.authEvent(appearance, definitionId, extensionKey);
+      analytics.ui.authEvent({
+        display: appearance,
+        definitionId: definitionId,
+        extensionKey: extensionKey
+      });
     }
 
     if (status === 'forbidden') {
-      analytics.ui.authAlternateAccountEvent(appearance, definitionId, extensionKey);
+      analytics.ui.authAlternateAccountEvent({
+        display: appearance,
+        definitionId: definitionId,
+        extensionKey: extensionKey
+      });
     }
 
     if (services.length > 0) {
-      analytics.screen.authPopupEvent(definitionId, extensionKey);
+      analytics.screen.authPopupEvent({
+        definitionId: definitionId,
+        extensionKey: extensionKey
+      });
       (0, _outboundAuthFlowClient.auth)(services[0].url).then(function () {
-        analytics.track.appAccountConnected(definitionId, extensionKey);
-        analytics.operational.connectSucceededEvent(id, definitionId, extensionKey);
+        analytics.track.appAccountConnected({
+          definitionId: definitionId,
+          extensionKey: extensionKey
+        });
+        analytics.operational.connectSucceededEvent({
+          id: id,
+          definitionId: definitionId,
+          extensionKey: extensionKey
+        });
         reload();
       }, function (err) {
-        analytics.operational.connectFailedEvent(id, definitionId, extensionKey, err.type);
+        analytics.operational.connectFailedEvent({
+          id: id,
+          definitionId: definitionId,
+          extensionKey: extensionKey,
+          reason: err.type
+        });
 
         if (err.type === 'auth_window_closed') {
-          analytics.ui.closedAuthEvent(appearance, definitionId, extensionKey);
+          analytics.ui.closedAuthEvent({
+            display: appearance,
+            definitionId: definitionId,
+            extensionKey: extensionKey
+          });
         }
 
         reload();
@@ -248,7 +275,13 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
               measure.mark(markName, 'pending');
               _context2.prev = 4;
               // Begin analytics instrumentation.
-              analytics.ui.actionClickedEvent(id, key, action.type, source, opts.type); // Invoke action - either client-side or server-side.
+              analytics.ui.actionClickedEvent({
+                id: id,
+                extensionKey: key,
+                actionType: action.type,
+                display: source,
+                invokeType: opts.type
+              }); // Invoke action - either client-side or server-side.
 
               if (!(opts.type === 'client')) {
                 _context2.next = 12;
@@ -272,14 +305,25 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
 
             case 15:
               measure.mark(markName, 'resolved');
-              analytics.operational.invokeSucceededEvent(id, key, action.type, source);
+              analytics.operational.invokeSucceededEvent({
+                id: id,
+                extensionKey: key,
+                actionType: action.type,
+                display: source
+              });
               return _context2.abrupt("return", response);
 
             case 20:
               _context2.prev = 20;
               _context2.t0 = _context2["catch"](4);
               measure.mark(markName, 'errored');
-              analytics.operational.invokeFailedEvent(id, key, action.type, source, _context2.t0.message);
+              analytics.operational.invokeFailedEvent({
+                id: id,
+                extensionKey: key,
+                actionType: action.type,
+                display: source,
+                reason: _context2.t0.message
+              });
               throw _context2.t0;
 
             case 25:

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

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});