@atlaskit/smart-card 21.3.0 → 22.0.0

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @atlaskit/smart-card
 
+## 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

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

@@ -87,10 +87,18 @@ var extractPreviewAction = function extractPreviewAction() {
       featureFlags: featureFlags,
       testId: testId,
       onOpen: function onOpen() {
-        handleAnalytics((0, _analytics.uiRenderSuccessEvent)('preview', 'resolved', key));
+        handleAnalytics((0, _analytics.uiRenderSuccessEvent)({
+          display: 'preview',
+          status: 'resolved',
+          extensionKey: key
+        }));
       },
       onOpenFailed: function onOpenFailed(error, errorInfo) {
-        handleAnalytics((0, _analytics.uiRenderFailedEvent)('preview', error, errorInfo));
+        handleAnalytics((0, _analytics.uiRenderFailedEvent)({
+          display: 'preview',
+          error: error,
+          errorInfo: errorInfo
+        }));
       },
       onDownloadActionClick: function onDownloadActionClick() {
         handleInvoke(getInvokeOpts(key, 'DownloadAction'));

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
+});