@atlaskit/smart-card 16.1.1 → 16.2.0

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

@@ -1,141 +1,117 @@
-import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
-import _createClass from "@babel/runtime/helpers/createClass";
-import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
-import _inherits from "@babel/runtime/helpers/inherits";
-import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
-import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(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; } }
-
-import React from 'react';
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import React, { lazy, useEffect, useState, Suspense } from 'react';
 import uuid from 'uuid';
 import { CardLinkView } from '@atlaskit/media-ui';
 import { uiRenderFailedEvent, fireSmartLinkEvent } from '../../utils/analytics';
 import { clearMarks, clearMeasures } from '../../utils/performance';
-export var CardWithURLRenderer = /*#__PURE__*/function (_React$PureComponent) {
-  _inherits(CardWithURLRenderer, _React$PureComponent);
-
-  var _super = _createSuper(CardWithURLRenderer);
-
-  function CardWithURLRenderer(props) {
-    var _this;
-
-    _classCallCheck(this, CardWithURLRenderer);
-
-    _this = _super.call(this, props);
-
-    _defineProperty(_assertThisInitialized(_this), "dispatchAnalytics", function (analyticsPayload) {
-      var _this$props = _this.props,
-          appearance = _this$props.appearance,
-          createAnalyticsEvent = _this$props.createAnalyticsEvent;
-
-      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;
-        }
-      }
-
-      fireSmartLinkEvent(analyticsPayload, createAnalyticsEvent);
-    });
-
-    _this.state = {
-      id: uuid()
-    };
-    return _this;
-  }
-
-  _createClass(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;
+import { ErrorBoundary } from 'react-error-boundary';
+import { failUfoExperience, startUfoExperience } from '../../state/analytics/ufoExperiences';
+var LazyCardWithUrlContent = /*#__PURE__*/lazy(function () {
+  return import(
+  /* webpackChunkName: "@atlaskit-internal_smartcard-urlcardcontent" */
+  './component-lazy/index');
+});
+export function CardWithURLRenderer(props) {
+  var _useState = useState(function () {
+    return uuid();
+  }),
+      _useState2 = _slicedToArray(_useState, 1),
+      id = _useState2[0]; // Equivalent to ComponentWillMount
+
+
+  useState(function () {
+    // We want to start timing of render event only once and right at the start
+    startUfoExperience('smart-link-rendered', id);
+  });
+  useEffect(function () {
+    // ComponentWillUnmount
+    return function () {
       clearMarks(id);
       clearMeasures(id);
+    };
+  }, [id]);
+
+  var logError = function logError(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
+      };
+      failUfoExperience('smart-link-rendered', id);
+      failUfoExperience('smart-link-authenticated', id);
+      dispatchAnalytics(uiRenderFailedEvent(appearance, error, errorInfo));
     }
-  }, {
-    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.
+  }; // Wrapper around analytics.
 
-      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(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;
+  var dispatchAnalytics = function dispatchAnalytics(analyticsPayload) {
+    var appearance = props.appearance,
+        createAnalyticsEvent = props.createAnalyticsEvent;
 
-      if (!url) {
-        throw new Error('@atlaskit/smart-card: url property is missing.');
+    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.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.createElement(CardLinkView, {
-        key: 'chunk-placeholder',
-        link: url
-      });
     }
-  }], [{
-    key: "moduleImporter",
-    value: function moduleImporter(target) {
-      import(
-      /* webpackChunkName: "@atlaskit-internal_smartcard-urlcardcontent" */
-      './component-lazy/index').then(function (module) {
-        CardWithURLRenderer.CardContent = module.LazyCardWithUrlContent;
-        target.forceUpdate();
-      });
-    }
-  }]);
 
-  return CardWithURLRenderer;
-}(React.PureComponent);
+    fireSmartLinkEvent(analyticsPayload, createAnalyticsEvent);
+  };
+
+  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;
+
+  if (!url) {
+    throw new Error('@atlaskit/smart-card: url property is missing.');
+  }
 
-_defineProperty(CardWithURLRenderer, "CardContent", null);
+  return /*#__PURE__*/React.createElement(ErrorBoundary, {
+    FallbackComponent: ErrorFallback,
+    onError: logError
+  }, /*#__PURE__*/React.createElement(Suspense, {
+    fallback: /*#__PURE__*/React.createElement(CardLinkView, {
+      key: 'chunk-placeholder',
+      link: url
+    })
+  }, /*#__PURE__*/React.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.createElement("span", null);
+};

package/dist/types/state/analytics/index.d.ts

@@ -1,32 +1,3 @@
-import { AnalyticsHandler } from '../../utils/types';
-import { CardInnerAppearance } from '../../view/Card/types';
-import { ErrorInfo } from 'react';
-import { CardType } from '../store/types';
-import { APIError } from '../../client/errors';
-export declare const useSmartLinkAnalytics: (dispatchAnalytics: AnalyticsHandler) => {
-    ui: {
-        authEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-        authAlternateAccountEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-        cardClickedEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-        actionClickedEvent: (providerKey: string, actionType: string, display?: "inline" | "block" | "embed" | "preview" | undefined) => void;
-        closedAuthEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-        renderSuccessEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-        renderFailedEvent: (display: CardInnerAppearance, error: Error, errorInfo: ErrorInfo) => void;
-    };
-    operational: {
-        resolvedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;
-        unresolvedEvent: (id: string, status: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;
-        invokeSucceededEvent: (id: string, providerKey: string, actionType: string, display: CardInnerAppearance) => void;
-        invokeFailedEvent: (id: string, providerKey: string, actionType: string, display: CardInnerAppearance, reason: string) => void;
-        connectSucceededEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-        connectFailedEvent: (definitionId?: string | undefined, extensionKey?: string | undefined, reason?: string | undefined) => void;
-        instrument: (id: string, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: APIError | undefined) => void;
-    };
-    track: {
-        appAccountConnected: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-    };
-    screen: {
-        authPopupEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-    };
-};
-export declare type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
+export { startUfoExperience, succeedUfoExperience, failUfoExperience, addMetadataToExperience, } from './ufoExperiences';
+export { useSmartLinkAnalytics } from './useSmartLinkAnalytics';
+export type { AnalyticsFacade } from './useSmartLinkAnalytics';

package/dist/types/state/analytics/ufoExperiences.d.ts

@@ -0,0 +1,7 @@
+import { CustomData } from '@atlaskit/ufo';
+declare type UfoExperienceName = 'smart-link-rendered' | 'smart-link-authenticated';
+export declare const startUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData | undefined) => void;
+export declare const succeedUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData | undefined) => void;
+export declare const failUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData | undefined) => void;
+export declare const addMetadataToExperience: (experienceName: UfoExperienceName, id: string, properties: CustomData) => void;
+export {};

package/dist/types/state/analytics/useSmartLinkAnalytics.d.ts

@@ -0,0 +1,30 @@
+import { AnalyticsHandler } from '../../utils/types';
+import { CardInnerAppearance } from '../../view/Card/types';
+import { CardType } from '../store/types';
+import { APIError } from '../../client/errors';
+export declare const useSmartLinkAnalytics: (dispatchAnalytics: AnalyticsHandler) => {
+    ui: {
+        authEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        authAlternateAccountEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        cardClickedEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        actionClickedEvent: (providerKey: string, actionType: string, display?: "inline" | "block" | "embed" | "preview" | undefined) => void;
+        closedAuthEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        renderSuccessEvent: (display: CardInnerAppearance, id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+    };
+    operational: {
+        resolvedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;
+        unresolvedEvent: (id: string, status: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;
+        invokeSucceededEvent: (id: string, providerKey: string, actionType: string, display: CardInnerAppearance) => void;
+        invokeFailedEvent: (id: string, providerKey: string, actionType: string, display: CardInnerAppearance, reason: string) => void;
+        connectSucceededEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        connectFailedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, status?: string | undefined) => void;
+        instrument: (id: string, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: APIError | undefined) => void;
+    };
+    track: {
+        appAccountConnected: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+    };
+    screen: {
+        authPopupEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+    };
+};
+export declare type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;

package/dist/types/state/hooks/useSmartLink.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { AnalyticsHandler } from '../../utils/types';
 export declare function useSmartLink(id: string, url: string, dispatchAnalytics: AnalyticsHandler): {
     state: import("../types").CardState;
@@ -16,16 +15,15 @@ export declare function useSmartLink(id: string, url: string, dispatchAnalytics:
             cardClickedEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
             actionClickedEvent: (providerKey: string, actionType: string, display?: "inline" | "block" | "embed" | "preview" | undefined) => void;
             closedAuthEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            renderSuccessEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            renderFailedEvent: (display: import("../../view/Card/types").CardInnerAppearance, error: Error, errorInfo: import("react").ErrorInfo) => void;
+            renderSuccessEvent: (display: import("../../view/Card/types").CardInnerAppearance, id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
         };
         operational: {
             resolvedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;
             unresolvedEvent: (id: string, status: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;
             invokeSucceededEvent: (id: string, providerKey: string, actionType: string, display: import("../../view/Card/types").CardInnerAppearance) => void;
             invokeFailedEvent: (id: string, providerKey: string, actionType: string, display: import("../../view/Card/types").CardInnerAppearance, reason: string) => void;
-            connectSucceededEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            connectFailedEvent: (definitionId?: string | undefined, extensionKey?: string | undefined, reason?: string | undefined) => void;
+            connectSucceededEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+            connectFailedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, status?: string | undefined) => void;
             instrument: (id: string, status: import("../store").CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: import("../..").APIError | undefined) => void;
         };
         track: {
@@ -36,4 +34,5 @@ export declare function useSmartLink(id: string, url: string, dispatchAnalytics:
         };
     };
     renderers: import("../context/types").CardProviderRenderers | undefined;
+    error: null;
 };

package/dist/types/view/CardWithUrl/component-lazy/index.d.ts

@@ -1,2 +1,2 @@
 import { CardWithUrlContentProps } from '../types';
-export declare function LazyCardWithUrlContent(props: CardWithUrlContentProps): JSX.Element;
+export default function LazyCardWithUrlContent(props: CardWithUrlContentProps): JSX.Element;

package/dist/types/view/CardWithUrl/loader.d.ts

@@ -1,16 +1,2 @@
-import React, { ErrorInfo } from 'react';
 import { CardProps } from '../Card/types';
-import { LazyCardWithUrlContent as CardWithUrlContentType } from './component-lazy';
-import { AnalyticsPayload } from '../../utils/types';
-export declare class CardWithURLRenderer extends React.PureComponent<CardProps, {
-    id: string;
-}> {
-    constructor(props: CardProps);
-    static CardContent: typeof CardWithUrlContentType | null;
-    static moduleImporter(target: CardWithURLRenderer): void;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
-    dispatchAnalytics: (analyticsPayload: AnalyticsPayload) => void;
-    render(): JSX.Element;
-}
+export declare function CardWithURLRenderer(props: CardProps): JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "16.1.1",
+  "version": "16.2.0",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -21,7 +21,7 @@
     ".": "./src/index.ts"
   },
   "atlassian": {
-    "team": "Editor Media",
+    "team": "Linking Platform",
     "releaseModel": "scheduled",
     "website": {
       "name": "Smart Card"
@@ -35,14 +35,16 @@
     "@atlaskit/icon-object": "^6.2.0",
     "@atlaskit/in-product-testing": "^0.1.0",
     "@atlaskit/logo": "^13.5.0",
-    "@atlaskit/media-ui": "^17.0.0",
+    "@atlaskit/media-ui": "^17.1.0",
     "@atlaskit/outbound-auth-flow-client": "^3.1.0",
     "@atlaskit/theme": "^12.0.0",
+    "@atlaskit/ufo": "^0.0.6",
     "@babel/runtime": "^7.0.0",
     "async-retry": "^1.2.3",
     "dataloader": "^2.0.0",
     "json-ld-types": "2.3.0",
     "p-throttle": "^4.1.1",
+    "react-error-boundary": "^3.1.3",
     "react-lazily-render": "^1.2.0",
     "react-loadable": "^5.1.0",
     "redux": "^3.7.2",
@@ -83,6 +85,7 @@
     "abortcontroller-polyfill": "^1.1.9",
     "brace": "^0.11.1",
     "enzyme": "^3.10.0",
+    "jest-extended": "^0.11.2",
     "lorem-ipsum": "^1.0.6",
     "mockdate": "^3.0.2",
     "react": "^16.8.0",