@atlaskit/smart-card 16.0.0 → 16.2.1

package/dist/cjs/view/CardWithUrl/loader.js

@@ -2,28 +2,16 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _typeof = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.CardWithURLRenderer = void 0;
-
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
-
-var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
-
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+exports.CardWithURLRenderer = CardWithURLRenderer;
 
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
-var _react = _interopRequireDefault(require("react"));
+var _react = _interopRequireWildcard(require("react"));
 
 var _uuid = _interopRequireDefault(require("uuid"));
 
@@ -33,132 +21,116 @@ var _analytics = require("../../utils/analytics");
 
 var _performance = require("../../utils/performance");
 
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+var _reactErrorBoundary = require("react-error-boundary");
 
-var CardWithURLRenderer = /*#__PURE__*/function (_React$PureComponent) {
-  (0, _inherits2.default)(CardWithURLRenderer, _React$PureComponent);
+var _ufoExperiences = require("../../state/analytics/ufoExperiences");
 
-  var _super = _createSuper(CardWithURLRenderer);
-
-  function CardWithURLRenderer(props) {
-    var _this;
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-    (0, _classCallCheck2.default)(this, CardWithURLRenderer);
-    _this = _super.call(this, props);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "dispatchAnalytics", function (analyticsPayload) {
-      var _this$props = _this.props,
-          appearance = _this$props.appearance,
-          createAnalyticsEvent = _this$props.createAnalyticsEvent;
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || (0, _typeof2.default)(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-      if (analyticsPayload && analyticsPayload.attributes) {
-        // Update if we haven't already set the display - possible
-        // in the case of `preview` which is rendered differently.
-        if (!analyticsPayload.attributes.display) {
-          analyticsPayload.attributes.display = appearance;
-        }
-      }
-
-      (0, _analytics.fireSmartLinkEvent)(analyticsPayload, createAnalyticsEvent);
-    });
-    _this.state = {
-      id: (0, _uuid.default)()
-    };
-    return _this;
-  }
+var LazyCardWithUrlContent = /*#__PURE__*/(0, _react.lazy)(function () {
+  return Promise.resolve().then(function () {
+    return _interopRequireWildcard(require('./component-lazy/index'));
+  });
+});
 
-  (0, _createClass2.default)(CardWithURLRenderer, [{
-    key: "componentDidMount",
-    value: function componentDidMount() {
-      if (CardWithURLRenderer.CardContent === null) {
-        (this.props.importer || CardWithURLRenderer.moduleImporter)(this);
-      }
-    }
-  }, {
-    key: "componentWillUnmount",
-    value: function componentWillUnmount() {
-      var id = this.state.id;
+function CardWithURLRenderer(props) {
+  var _useState = (0, _react.useState)(function () {
+    return (0, _uuid.default)();
+  }),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 1),
+      id = _useState2[0]; // Equivalent to ComponentWillMount
+
+
+  (0, _react.useState)(function () {
+    // We want to start timing of render event only once and right at the start
+    (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', id);
+  });
+  (0, _react.useEffect)(function () {
+    // ComponentWillUnmount
+    return function () {
       (0, _performance.clearMarks)(id);
       (0, _performance.clearMeasures)(id);
-    }
-  }, {
-    key: "componentDidCatch",
-    value: function componentDidCatch(error, errorInfo) {
-      var appearance = this.props.appearance; // NB: APIErrors are thrown in response to Object Resolver Service.
-      // In these cases, control is handed back to the Editor. We do not
-      // fire an event for these, as they do not cover failed UI render events.
-
-      if (error.name === 'APIError') {
-        throw error;
-      } // NB: the rest of the errors caught here are unexpected, and correlate
-      // to the reliability of the smart-card front-end components. We instrument
-      // these in order to measure our front-end reliability.
-      else {
-          this.dispatchAnalytics((0, _analytics.uiRenderFailedEvent)(appearance, error, errorInfo));
-        }
-    } // Wrapper around analytics.
-
-  }, {
-    key: "render",
-    value: function render() {
-      var _this$props2 = this.props,
-          url = _this$props2.url,
-          appearance = _this$props2.appearance,
-          isSelected = _this$props2.isSelected,
-          isFrameVisible = _this$props2.isFrameVisible,
-          onClick = _this$props2.onClick,
-          container = _this$props2.container,
-          onResolve = _this$props2.onResolve,
-          testId = _this$props2.testId,
-          showActions = _this$props2.showActions,
-          inheritDimensions = _this$props2.inheritDimensions,
-          platform = _this$props2.platform,
-          embedIframeRef = _this$props2.embedIframeRef,
-          inlinePreloaderStyle = _this$props2.inlinePreloaderStyle;
-
-      if (!url) {
-        throw new Error('@atlaskit/smart-card: url property is missing.');
+    };
+  }, [id]);
+  var url = props.url,
+      appearance = props.appearance,
+      isSelected = props.isSelected,
+      isFrameVisible = props.isFrameVisible,
+      onClick = props.onClick,
+      container = props.container,
+      onResolve = props.onResolve,
+      testId = props.testId,
+      showActions = props.showActions,
+      inheritDimensions = props.inheritDimensions,
+      platform = props.platform,
+      embedIframeRef = props.embedIframeRef,
+      inlinePreloaderStyle = props.inlinePreloaderStyle,
+      createAnalyticsEvent = props.createAnalyticsEvent; // Wrapper around analytics.
+
+  var dispatchAnalytics = (0, _react.useCallback)(function (analyticsPayload) {
+    if (analyticsPayload && analyticsPayload.attributes) {
+      // Update if we haven't already set the display - possible
+      // in the case of `preview` which is rendered differently.
+      if (!analyticsPayload.attributes.display) {
+        analyticsPayload.attributes.display = appearance;
       }
-
-      return CardWithURLRenderer.CardContent !== null ? /*#__PURE__*/_react.default.createElement(CardWithURLRenderer.CardContent, {
-        id: this.state.id,
-        url: url,
-        appearance: appearance,
-        onClick: onClick,
-        isSelected: isSelected,
-        isFrameVisible: isFrameVisible,
-        dispatchAnalytics: this.dispatchAnalytics,
-        container: container,
-        onResolve: onResolve,
-        testId: testId,
-        showActions: showActions,
-        inheritDimensions: inheritDimensions,
-        platform: platform,
-        embedIframeRef: embedIframeRef,
-        inlinePreloaderStyle: inlinePreloaderStyle
-      }) : /*#__PURE__*/_react.default.createElement(_mediaUi.CardLinkView, {
-        key: 'chunk-placeholder',
-        link: url
-      });
     }
-  }], [{
-    key: "moduleImporter",
-    value: function moduleImporter(target) {
-      Promise.resolve().then(function () {
-        return _interopRequireWildcard(require('./component-lazy/index'));
-      }).then(function (module) {
-        CardWithURLRenderer.CardContent = module.LazyCardWithUrlContent;
-        target.forceUpdate();
-      });
+
+    (0, _analytics.fireSmartLinkEvent)(analyticsPayload, createAnalyticsEvent);
+  }, [appearance, createAnalyticsEvent]);
+  var logError = (0, _react.useCallback)(function (error, info) {
+    var componentStack = info.componentStack; // NB: APIErrors are thrown in response to Object Resolver Service.
+    // In these cases, control is handed back to the Editor. We do not
+    // fire an event for these, as they do not cover failed UI render events.
+
+    if (error.name === 'APIError') {
+      throw error;
+    } // NB: the rest of the errors caught here are unexpected, and correlate
+    // to the reliability of the smart-card front-end components. We instrument
+    // these in order to measure our front-end reliability.
+    else {
+      var errorInfo = {
+        componentStack: componentStack
+      };
+      (0, _ufoExperiences.failUfoExperience)('smart-link-rendered', id);
+      (0, _ufoExperiences.failUfoExperience)('smart-link-authenticated', id);
+      dispatchAnalytics((0, _analytics.uiRenderFailedEvent)(appearance, error, errorInfo));
     }
-  }]);
-  return CardWithURLRenderer;
-}(_react.default.PureComponent);
+  }, [appearance, dispatchAnalytics, id]);
 
-exports.CardWithURLRenderer = CardWithURLRenderer;
-(0, _defineProperty2.default)(CardWithURLRenderer, "CardContent", null);
+  if (!url) {
+    throw new Error('@atlaskit/smart-card: url property is missing.');
+  }
+
+  return /*#__PURE__*/_react.default.createElement(_reactErrorBoundary.ErrorBoundary, {
+    FallbackComponent: ErrorFallback,
+    onError: logError
+  }, /*#__PURE__*/_react.default.createElement(_react.Suspense, {
+    fallback: /*#__PURE__*/_react.default.createElement(_mediaUi.CardLinkView, {
+      key: 'chunk-placeholder',
+      link: url
+    })
+  }, /*#__PURE__*/_react.default.createElement(LazyCardWithUrlContent, {
+    id: id,
+    url: url,
+    appearance: appearance,
+    onClick: onClick,
+    isSelected: isSelected,
+    isFrameVisible: isFrameVisible,
+    dispatchAnalytics: dispatchAnalytics,
+    container: container,
+    onResolve: onResolve,
+    testId: testId,
+    showActions: showActions,
+    inheritDimensions: inheritDimensions,
+    platform: platform,
+    embedIframeRef: embedIframeRef,
+    inlinePreloaderStyle: inlinePreloaderStyle
+  })));
+}
+
+var ErrorFallback = function ErrorFallback() {
+  return /*#__PURE__*/_react.default.createElement("span", null);
+};

package/dist/es2019/client/utils/environments.js

@@ -1,5 +1,5 @@
 const devBaseUrl = 'https://api-private.dev.atlassian.com';
-const stgBaseUrl = 'https://api-private.stg.atlassian.com';
+const stgBaseUrl = 'https://commerce-components-preview.dev.atlassian.com/gateway/api';
 const prodBaseUrl = 'https://api-private.atlassian.com';
 export const BaseUrls = {
   dev: devBaseUrl,

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

@@ -30,7 +30,7 @@ const extractBlockIcon = jsonLd => {
 
 const extractBlockDetails = jsonLd => [extractCommentCount(jsonLd), extractProgrammingLanguage(jsonLd), extractSubscriberCount(jsonLd)].filter(detail => !!detail);
 
-export const extractBlockActions = (props, jsonLd, opts) => {
+export const extractBlockActions = (props, jsonLd, opts, platform) => {
   if (opts) {
     const {
       handleInvoke,
@@ -39,7 +39,7 @@ export const extractBlockActions = (props, jsonLd, opts) => {
       testId
     } = opts;
     const actions = extractActions(jsonLd, handleInvoke);
-    const previewAction = extractPreviewAction(definitionId, props, jsonLd, handleInvoke, handleAnalytics, testId); // The previewAction should always be the last action
+    const previewAction = extractPreviewAction(definitionId, props, jsonLd, handleInvoke, handleAnalytics, testId, platform); // The previewAction should always be the last action
 
     if (previewAction) {
       actions.push(previewAction);
@@ -71,7 +71,7 @@ export const extractBlockUsers = jsonLd => {
     return updatedByMembers || createdByMembers;
   }
 };
-export const extractBlockProps = (jsonLd, meta, opts, renderers) => {
+export const extractBlockProps = (jsonLd, meta, opts, renderers, platform) => {
   const props = {
     link: extractLink(jsonLd),
     title: extractTitle(jsonLd),
@@ -87,6 +87,6 @@ export const extractBlockProps = (jsonLd, meta, opts, renderers) => {
     isTrusted: extractIsTrusted(meta)
   };
   return { ...props,
-    actions: extractBlockActions(props, jsonLd, opts)
+    actions: extractBlockActions(props, jsonLd, opts, platform)
   };
 };

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

@@ -4,10 +4,10 @@ import { extractDownloadUrl } from '../detail';
 import { extractProvider } from '../context';
 import { extractPreview } from '../preview';
 
-const getMetadataFromJsonLd = jsonLd => {
+const getMetadataFromJsonLd = (jsonLd, platform) => {
   const download = extractDownloadUrl(jsonLd);
   const provider = extractProvider(jsonLd);
-  const preview = extractPreview(jsonLd);
+  const preview = extractPreview(jsonLd, platform);
   return {
     download,
     providerName: provider && provider.text,
@@ -40,9 +40,9 @@ const getInvokeOpts = (key, action, source) => ({
   }
 });
 
-export const extractPreviewAction = (definitionId = 'empty-object-provider', viewProps, jsonLd, handleInvoke, handleAnalytics, testId) => {
+export const extractPreviewAction = (definitionId = 'empty-object-provider', viewProps, jsonLd, handleInvoke, handleAnalytics, testId, platform) => {
   // Extract metadata from view props & raw JSON-LD.
-  const metadataFromJsonLd = getMetadataFromJsonLd(jsonLd);
+  const metadataFromJsonLd = getMetadataFromJsonLd(jsonLd, platform);
   const metadataFromViewProps = getMetadataFromResolvedProps(viewProps);
   const metadata = { ...metadataFromJsonLd,
     ...metadataFromViewProps

package/dist/es2019/providers/editor/transformer.js

@@ -1,6 +1,6 @@
 const isJiraRoadMap = url => url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/roadmap\/?/);
 
-const isPolarisView = url => url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$/);
+const isPolarisView = url => url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$|^https:\/\/.*?\/secure\/JiraProductDiscoveryAnonymous\.jspa\?hash=\w+|^https:\/\/.*?\/jira\/polaris\/share\/\w+/);
 
 const isSlackMessage = url => url.match(/^https:\/\/.+?\.slack\.com\/archives\/[CG][A-Z0-9]+\/p[0-9]+(\?.*)?$/);
 

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

@@ -7,6 +7,7 @@ import { useSmartLinkContext } from '../context';
 import * as measure from '../../utils/performance';
 import { APIError } from '../../client/errors';
 import { getUnauthorizedJsonLd } from '../../utils/jsonld';
+import { addMetadataToExperience } from '../analytics';
 export const useSmartCardActions = (id, url, analytics) => {
   const {
     store,
@@ -91,8 +92,12 @@ export const useSmartCardActions = (id, url, analytics) => {
     // has come back asynchronously, dispatch the resolved action for the card.
     if (isReloading || !hasData) {
       return connections.client.fetchData(resourceUrl).then(response => handleResolvedLinkResponse(resourceUrl, response)).catch(error => handleResolvedLinkError(resourceUrl, error));
+    } else {
+      addMetadataToExperience('smart-link-rendered', id, {
+        cached: true
+      });
     }
-  }, [url, hasData, connections.client, handleResolvedLinkResponse, handleResolvedLinkError]);
+  }, [url, hasData, connections.client, handleResolvedLinkResponse, handleResolvedLinkError, id]);
   const register = useCallback(() => {
     if (!details) {
       dispatch(cardAction(ACTION_PENDING, {
@@ -128,10 +133,10 @@ export const useSmartCardActions = (id, url, analytics) => {
       analytics.screen.authPopupEvent(definitionId, extensionKey);
       auth(services[0].url).then(() => {
         analytics.track.appAccountConnected(definitionId, extensionKey);
-        analytics.operational.connectSucceededEvent(definitionId, extensionKey);
+        analytics.operational.connectSucceededEvent(id, definitionId, extensionKey);
         reload();
       }, err => {
-        analytics.operational.connectFailedEvent(definitionId, extensionKey, err.type);
+        analytics.operational.connectFailedEvent(id, definitionId, extensionKey, err.type);
 
         if (err.type === 'auth_window_closed') {
           analytics.ui.closedAuthEvent(appearance, definitionId, extensionKey);
@@ -140,7 +145,7 @@ export const useSmartCardActions = (id, url, analytics) => {
         reload();
       });
     }
-  }, [analytics.ui, analytics.screen, analytics.track, analytics.operational, reload, details, status]);
+  }, [analytics.ui, analytics.screen, analytics.track, analytics.operational, id, reload, details, status]);
   const invoke = useCallback(async (opts, appearance) => {
     const {
       key,

package/dist/es2019/state/analytics/index.js

@@ -1,40 +1,2 @@
-import { uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, uiRenderSuccessEvent, uiRenderFailedEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountConnected, screenAuthPopupEvent, instrumentEvent } from '../../utils/analytics';
-import { useMemo } from 'react';
-export const useSmartLinkAnalytics = dispatchAnalytics => {
-  const ui = useMemo(() => ({
-    authEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiAuthEvent(display, definitionId, extensionKey)),
-    authAlternateAccountEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiAuthAlternateAccountEvent(display, definitionId, extensionKey)),
-    cardClickedEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiCardClickedEvent(display, definitionId, extensionKey)),
-    actionClickedEvent: (providerKey, actionType, display) => dispatchAnalytics(uiActionClickedEvent(providerKey, actionType, display)),
-    closedAuthEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiClosedAuthEvent(display, definitionId, extensionKey)),
-    renderSuccessEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiRenderSuccessEvent(display, definitionId, extensionKey)),
-    renderFailedEvent: (display, error, errorInfo) => dispatchAnalytics(uiRenderFailedEvent(display, error, errorInfo))
-  }), [dispatchAnalytics]);
-  const operational = useMemo(() => ({
-    resolvedEvent: (id, definitionId, extensionKey, resourceType) => dispatchAnalytics(resolvedEvent(id, definitionId, extensionKey, resourceType)),
-    unresolvedEvent: (id, status, definitionId, extensionKey, resourceType) => dispatchAnalytics(unresolvedEvent(id, status, definitionId, extensionKey, resourceType)),
-    invokeSucceededEvent: (id, providerKey, actionType, display) => dispatchAnalytics(invokeSucceededEvent(id, providerKey, actionType, display)),
-    invokeFailedEvent: (id, providerKey, actionType, display, reason) => dispatchAnalytics(invokeFailedEvent(id, providerKey, actionType, display, reason)),
-    connectSucceededEvent: (definitionId, extensionKey) => dispatchAnalytics(connectSucceededEvent(definitionId, extensionKey)),
-    connectFailedEvent: (definitionId, extensionKey, reason) => dispatchAnalytics(connectFailedEvent(definitionId, extensionKey, reason)),
-    instrument: (id, status, definitionId, extensionKey, resourceType, error) => {
-      const event = instrumentEvent(id, status, definitionId, extensionKey, resourceType, error);
-
-      if (event) {
-        dispatchAnalytics(event);
-      }
-    }
-  }), [dispatchAnalytics]);
-  const track = useMemo(() => ({
-    appAccountConnected: (definitionId, extensionKey) => dispatchAnalytics(trackAppAccountConnected(definitionId, extensionKey))
-  }), [dispatchAnalytics]);
-  const screen = useMemo(() => ({
-    authPopupEvent: (definitionId, extensionKey) => dispatchAnalytics(screenAuthPopupEvent(definitionId, extensionKey))
-  }), [dispatchAnalytics]);
-  return useMemo(() => ({
-    ui,
-    operational,
-    track,
-    screen
-  }), [ui, operational, track, screen]);
-};
+export { startUfoExperience, succeedUfoExperience, failUfoExperience, addMetadataToExperience } from './ufoExperiences';
+export { useSmartLinkAnalytics } from './useSmartLinkAnalytics';

package/dist/es2019/state/analytics/ufoExperiences.js

@@ -0,0 +1,40 @@
+import { ConcurrentExperience, ExperiencePerformanceTypes, ExperienceTypes } from '@atlaskit/ufo';
+const ufoExperiences = {
+  'smart-link-rendered': new ConcurrentExperience('smart-link-rendered', {
+    type: ExperienceTypes.Load,
+    performanceType: ExperiencePerformanceTypes.PageSegmentLoad,
+    platform: {
+      component: 'smart-links'
+    }
+  }),
+  'smart-link-authenticated': new ConcurrentExperience('smart-link-authenticated', {
+    type: ExperienceTypes.Load,
+    performanceType: ExperiencePerformanceTypes.PageSegmentLoad,
+    platform: {
+      component: 'smart-links'
+    }
+  })
+};
+export const startUfoExperience = (experienceName, id, properties) => {
+  const experience = ufoExperiences[experienceName].getInstance(id);
+  experience.start();
+
+  if (properties) {
+    experience.addMetadata(properties);
+  }
+};
+export const succeedUfoExperience = (experienceName, id, properties) => {
+  const experience = ufoExperiences[experienceName].getInstance(id);
+  experience.success({
+    metadata: properties
+  });
+};
+export const failUfoExperience = (experienceName, id, properties) => {
+  const experience = ufoExperiences[experienceName].getInstance(id);
+  experience.failure({
+    metadata: properties
+  });
+};
+export const addMetadataToExperience = (experienceName, id, properties) => {
+  ufoExperiences[experienceName].getInstance(id).addMetadata(properties);
+};

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

@@ -0,0 +1,62 @@
+import { uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, uiRenderSuccessEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountConnected, screenAuthPopupEvent, instrumentEvent } from '../../utils/analytics';
+import { useMemo } from 'react';
+import { startUfoExperience, succeedUfoExperience } from './ufoExperiences';
+export const useSmartLinkAnalytics = dispatchAnalytics => {
+  const ui = useMemo(() => ({
+    authEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiAuthEvent(display, definitionId, extensionKey)),
+    authAlternateAccountEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiAuthAlternateAccountEvent(display, definitionId, extensionKey)),
+    cardClickedEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiCardClickedEvent(display, definitionId, extensionKey)),
+    actionClickedEvent: (providerKey, actionType, display) => dispatchAnalytics(uiActionClickedEvent(providerKey, actionType, display)),
+    closedAuthEvent: (display, definitionId, extensionKey) => dispatchAnalytics(uiClosedAuthEvent(display, definitionId, extensionKey)),
+    renderSuccessEvent: (display, id, definitionId, extensionKey) => {
+      succeedUfoExperience('smart-link-rendered', id, {
+        extensionKey,
+        display
+      }); // UFO will disregard this if authentication experience has not yet been started
+
+      succeedUfoExperience('smart-link-authenticated', id, {
+        display
+      });
+      dispatchAnalytics(uiRenderSuccessEvent(display, definitionId, extensionKey));
+    }
+  }), [dispatchAnalytics]);
+  const operational = useMemo(() => ({
+    resolvedEvent: (id, definitionId, extensionKey, resourceType) => dispatchAnalytics(resolvedEvent(id, definitionId, extensionKey, resourceType)),
+    unresolvedEvent: (id, status, definitionId, extensionKey, resourceType) => dispatchAnalytics(unresolvedEvent(id, status, definitionId, extensionKey, resourceType)),
+    invokeSucceededEvent: (id, providerKey, actionType, display) => dispatchAnalytics(invokeSucceededEvent(id, providerKey, actionType, display)),
+    invokeFailedEvent: (id, providerKey, actionType, display, reason) => dispatchAnalytics(invokeFailedEvent(id, providerKey, actionType, display, reason)),
+    connectSucceededEvent: (id, definitionId, extensionKey) => {
+      startUfoExperience('smart-link-authenticated', id, {
+        extensionKey,
+        status: 'success'
+      });
+      dispatchAnalytics(connectSucceededEvent(definitionId, extensionKey));
+    },
+    connectFailedEvent: (id, definitionId, extensionKey, status) => {
+      startUfoExperience('smart-link-authenticated', id, {
+        extensionKey,
+        status
+      });
+      dispatchAnalytics(connectFailedEvent(definitionId, extensionKey, status));
+    },
+    instrument: (id, status, definitionId, extensionKey, resourceType, error) => {
+      const event = instrumentEvent(id, status, definitionId, extensionKey, resourceType, error);
+
+      if (event) {
+        dispatchAnalytics(event);
+      }
+    }
+  }), [dispatchAnalytics]);
+  const track = useMemo(() => ({
+    appAccountConnected: (definitionId, extensionKey) => dispatchAnalytics(trackAppAccountConnected(definitionId, extensionKey))
+  }), [dispatchAnalytics]);
+  const screen = useMemo(() => ({
+    authPopupEvent: (definitionId, extensionKey) => dispatchAnalytics(screenAuthPopupEvent(definitionId, extensionKey))
+  }), [dispatchAnalytics]);
+  return useMemo(() => ({
+    ui,
+    operational,
+    track,
+    screen
+  }), [ui, operational, track, screen]);
+};

package/dist/es2019/state/hooks/useSmartLink.js

@@ -11,12 +11,10 @@ export function useSmartLink(id, url, dispatchAnalytics) {
   const config = useSmartLinkConfig();
   const renderers = useSmartLinkRenderers(); // NB: used to propagate errors from hooks to error boundaries.
 
-  const [, setState] = useState(); // Register the current card.
+  const [error, setError] = useState(null); // Register the current card.
 
   const register = () => {
-    actions.register().catch(err => setState(() => {
-      throw err;
-    }));
+    actions.register().catch(err => setError(err));
   }; // AFP-2511 TODO: Fix automatic suppressions below
   // eslint-disable-next-line react-hooks/exhaustive-deps
 
@@ -28,6 +26,7 @@ export function useSmartLink(id, url, dispatchAnalytics) {
     actions,
     config,
     analytics,
-    renderers
+    renderers,
+    error
   };
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "16.0.0",
+	"version": "16.2.1",
 	"sideEffects": false
 }

package/dist/es2019/view/BlockCard/index.js

@@ -21,7 +21,8 @@ export const BlockCard = ({
   isSelected,
   onResolve,
   testId,
-  showActions
+  showActions,
+  platform
 }) => {
   var _details$meta, _forbiddenViewProps$c;
 
@@ -42,7 +43,7 @@ export const BlockCard = ({
       });
 
     case 'resolved':
-      const resolvedViewProps = extractBlockProps(data, meta, extractorOpts, renderers);
+      const resolvedViewProps = extractBlockProps(data, meta, extractorOpts, renderers, platform);
 
       if (onResolve) {
         onResolve({

package/dist/es2019/view/CardWithUrl/component-lazy/index.js

@@ -2,7 +2,7 @@ import React from 'react';
 import { isIntersectionObserverSupported } from '@atlaskit/media-ui';
 import { LazyLazilyRenderCard } from './LazyLazilyRenderCard';
 import { LazyIntersectionObserverCard } from './LazyIntersectionObserverCard';
-export function LazyCardWithUrlContent(props) {
+export default function LazyCardWithUrlContent(props) {
   if (isIntersectionObserverSupported()) {
     return /*#__PURE__*/React.createElement(LazyIntersectionObserverCard, props);
   } else {

package/dist/es2019/view/CardWithUrl/component.js

@@ -28,7 +28,8 @@ export function CardWithUrlContent({
     actions,
     config,
     analytics,
-    renderers
+    renderers,
+    error
   } = useSmartLink(id, url, dispatchAnalytics);
   const definitionId = getDefinitionId(state.details);
   const extensionKey = getExtensionKey(state.details);
@@ -67,9 +68,13 @@ export function CardWithUrlContent({
 
   useEffect(() => {
     if (isFinalState(state.status)) {
-      analytics.ui.renderSuccessEvent(appearance, definitionId, extensionKey);
+      analytics.ui.renderSuccessEvent(appearance, id, definitionId, extensionKey);
     }
-  }, [appearance, state.details, state.status, url, definitionId, extensionKey, analytics.ui]);
+  }, [appearance, state.details, state.status, url, definitionId, extensionKey, analytics.ui, id]); // We have to keep this last to prevent hook order from being violated
+
+  if (error) {
+    throw error;
+  }
 
   switch (appearance) {
     case 'inline':
@@ -99,7 +104,8 @@ export function CardWithUrlContent({
         isSelected: isSelected,
         onResolve: onResolve,
         testId: testId,
-        showActions: showActions
+        showActions: showActions,
+        platform: platform
       });
 
     case 'embed':