@atlaskit/smart-card 15.5.0 → 16.2.0

package/CHANGELOG.md

@@ -1,5 +1,83 @@
 # @atlaskit/smart-card
 
+## 16.2.0
+
+### Minor Changes
+
+- [`0448db49f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0448db49f68) - Implement UFO instrumentation events pattern
+
+### Patch Changes
+
+- [`df4e03438f2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/df4e03438f2) - Add post render authentication experience using UFO
+- [`7d13155a61c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7d13155a61c) - Updated smart links to UFO with perf metrics
+- [`572581a2ae3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/572581a2ae3) - Polaris (Jira Product Discovery) anonymous views unfurling embed by default.
+- Updated dependencies
+
+## 16.1.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 16.1.0
+
+### Minor Changes
+
+- [`978e9280610`](https://bitbucket.org/atlassian/atlassian-frontend/commits/978e9280610) - add support for platform in BlockCard component
+
+### Patch Changes
+
+- [`b90c0237824`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b90c0237824) - Update package.jsons to remove unused dependencies.
+- Updated dependencies
+
+## 16.0.0
+
+### Major Changes
+
+- [`86aeb07cae3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/86aeb07cae3) - EDM-2264: allow embed resize events from all domains
+
+  **Note:**
+
+  The breaking change in this commit is a rename from `IframelyResizeMessageListener` to `EmbedResizeMessageListener`. The functionality of the component itself remains the same for all consumers.
+
+### Minor Changes
+
+- [`b6aabf0bfe4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b6aabf0bfe4) - Expose useSmartLinkEvents hook from smart-card
+- [`00de5482a5a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/00de5482a5a) - # expose smart-link selectors
+
+  Documentation with visual examples: https://hello.atlassian.net/wiki/spaces/~hzarcogarcia/pages/1250247546/How+to+use+smart+link+classnames
+
+  ```
+  import {
+    contentFooterClassName,
+    metadataListClassName,
+    blockCardResolvingViewClassName,
+    blockCardResolvedViewClassName,
+    blockCardForbiddenViewClassName,
+    blockCardIconImageClassName,
+    loadingPlaceholderClassName
+  } from '@atlaskit/smart-card';
+
+  // Example usage:
+
+  css`
+    .${contentFooterClassName} {
+      background-color: red;
+    }
+  `
+  ```
+
+- [`17776bda189`](https://bitbucket.org/atlassian/atlassian-frontend/commits/17776bda189) - - Improve Smart Links providers and batch requests mechanism
+  - Remove non-functional props that impact reloading
+- [`8e6a1034cfd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8e6a1034cfd) - EDM-1730: added in-product Cypress tests for Smart Links
+
+### Patch Changes
+
+- [`5c5f3cccdd0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5c5f3cccdd0) - Revert changes to fix a regression CEMS-2063
+- [`ab8f0df38a0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ab8f0df38a0) - Replacing bottleneck library with p-throttle
+- [`c0d4f38bf63`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c0d4f38bf63) - Fix regexp for Polaris (Jira Product Discovery) View links.
+- Updated dependencies
+
 ## 15.5.0
 
 ### Minor Changes

package/dist/cjs/client/index.js

@@ -19,6 +19,10 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+require("setimmediate");
+
 var _dataloader = _interopRequireDefault(require("dataloader"));
 
 var _asyncRetry = _interopRequireDefault(require("async-retry"));
@@ -29,7 +33,7 @@ var _errors = require("./errors");
 
 var _environments = require("./utils/environments");
 
-var _light = _interopRequireDefault(require("bottleneck/light"));
+var _pThrottle = _interopRequireDefault(require("p-throttle"));
 
 var _responses = require("./types/responses");
 
@@ -37,26 +41,18 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 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; }
 
-// @ts-ignore
-var Bottleneck = _light.default;
+// import setimmediate to temporary fix dataloader 2.0.0 bug
+// @see https://github.com/graphql/dataloader/issues/249
 var MAX_BATCH_SIZE = 50;
 var MIN_TIME_BETWEEN_BATCHES = 250;
 
 var CardClient = /*#__PURE__*/function () {
   function CardClient(envKey) {
-    (0, _classCallCheck2.default)(this, CardClient);
-    this.resolverUrl = (0, _environments.getResolverUrl)(envKey);
-    this.loadersByDomain = {};
-    this.retryConfig = {
-      retries: 2
-    };
-    this.resolvedCache = {};
-  }
+    var _this = this;
 
-  (0, _createClass2.default)(CardClient, [{
-    key: "batchResolve",
-    value: function () {
-      var _batchResolve = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(urls) {
+    (0, _classCallCheck2.default)(this, CardClient);
+    (0, _defineProperty2.default)(this, "batchResolve", /*#__PURE__*/function () {
+      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(urls) {
         var deDuplicatedUrls, resolvedUrls, map, i, url, data;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) {
@@ -67,7 +63,7 @@ var CardClient = /*#__PURE__*/function () {
                 resolvedUrls = [];
                 _context.prev = 2;
                 _context.next = 5;
-                return api.request('post', "".concat(this.resolverUrl, "/resolve/batch"), deDuplicatedUrls.map(function (resourceUrl) {
+                return api.request('post', "".concat(_this.resolverUrl, "/resolve/batch"), deDuplicatedUrls.map(function (resourceUrl) {
                   return {
                     resourceUrl: resourceUrl
                   };
@@ -112,31 +108,35 @@ var CardClient = /*#__PURE__*/function () {
                 return _context.stop();
             }
           }
-        }, _callee, this, [[2, 8]]);
+        }, _callee, null, [[2, 8]]);
       }));
 
-      function batchResolve(_x) {
-        return _batchResolve.apply(this, arguments);
-      }
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }());
+    this.resolverUrl = (0, _environments.getResolverUrl)(envKey);
+    this.loadersByDomain = {};
+    this.retryConfig = {
+      retries: 2
+    };
+    this.resolvedCache = {};
+  }
 
-      return batchResolve;
-    }()
-  }, {
+  (0, _createClass2.default)(CardClient, [{
     key: "createLoader",
     value: function createLoader() {
-      var _this = this;
-
-      var limiter = new Bottleneck({
-        minTime: MIN_TIME_BETWEEN_BATCHES
+      var batchResolveThrottler = (0, _pThrottle.default)({
+        limit: 1,
+        interval: MIN_TIME_BETWEEN_BATCHES
       });
+      var throttledBatchResolve = batchResolveThrottler(this.batchResolve);
       return new _dataloader.default( // We place all calls to `batchResolve` in a limiter so we don't send off several simultaneous batch requests.
       // This is for two reasons:
       //  1: we want to avoid getting rate limited upstream (eg: forge and other APIs)
       //  2: we want to avoid sending out heaps of requests from the client at once
       function (urls) {
-        return limiter.schedule(function () {
-          return _this.batchResolve(urls);
-        });
+        return throttledBatchResolve(urls);
       }, {
         maxBatchSize: MAX_BATCH_SIZE,
         // NOTE: we turn off DataLoader's cache because it doesn't work for our use-case. Consider the following:

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

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.getResolverUrl = exports.getBaseUrl = exports.BaseUrls = void 0;
 var devBaseUrl = 'https://api-private.dev.atlassian.com';
-var stgBaseUrl = 'https://api-private.stg.atlassian.com';
+var stgBaseUrl = 'https://commerce-components-preview.dev.atlassian.com/gateway/api';
 var prodBaseUrl = 'https://api-private.atlassian.com';
 var BaseUrls = {
   dev: devBaseUrl,

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

@@ -63,14 +63,14 @@ var extractBlockDetails = function extractBlockDetails(jsonLd) {
   });
 };
 
-var extractBlockActions = function extractBlockActions(props, jsonLd, opts) {
+var extractBlockActions = function extractBlockActions(props, jsonLd, opts, platform) {
   if (opts) {
     var handleInvoke = opts.handleInvoke,
         handleAnalytics = opts.handleAnalytics,
         definitionId = opts.definitionId,
         testId = opts.testId;
     var actions = (0, _extractActions.extractActions)(jsonLd, handleInvoke);
-    var previewAction = (0, _extractPreviewAction.extractPreviewAction)(definitionId, props, jsonLd, handleInvoke, handleAnalytics, testId); // The previewAction should always be the last action
+    var previewAction = (0, _extractPreviewAction.extractPreviewAction)(definitionId, props, jsonLd, handleInvoke, handleAnalytics, testId, platform); // The previewAction should always be the last action
 
     if (previewAction) {
       actions.push(previewAction);
@@ -108,7 +108,7 @@ var extractBlockUsers = function extractBlockUsers(jsonLd) {
 
 exports.extractBlockUsers = extractBlockUsers;
 
-var extractBlockProps = function extractBlockProps(jsonLd, meta, opts, renderers) {
+var extractBlockProps = function extractBlockProps(jsonLd, meta, opts, renderers, platform) {
   var props = {
     link: (0, _primitives.extractLink)(jsonLd),
     title: (0, _primitives.extractTitle)(jsonLd),
@@ -124,7 +124,7 @@ var extractBlockProps = function extractBlockProps(jsonLd, meta, opts, renderers
     isTrusted: (0, _extractIsTrusted.extractIsTrusted)(meta)
   };
   return _objectSpread(_objectSpread({}, props), {}, {
-    actions: extractBlockActions(props, jsonLd, opts)
+    actions: extractBlockActions(props, jsonLd, opts, platform)
   });
 };
 

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

@@ -23,10 +23,10 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
-var getMetadataFromJsonLd = function getMetadataFromJsonLd(jsonLd) {
+var getMetadataFromJsonLd = function getMetadataFromJsonLd(jsonLd, platform) {
   var download = (0, _detail.extractDownloadUrl)(jsonLd);
   var provider = (0, _context.extractProvider)(jsonLd);
-  var preview = (0, _preview.extractPreview)(jsonLd);
+  var preview = (0, _preview.extractPreview)(jsonLd, platform);
   return {
     download: download,
     providerName: provider && provider.text,
@@ -72,8 +72,9 @@ var extractPreviewAction = function extractPreviewAction() {
   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;
   // Extract metadata from view props & raw JSON-LD.
-  var metadataFromJsonLd = getMetadataFromJsonLd(jsonLd);
+  var metadataFromJsonLd = getMetadataFromJsonLd(jsonLd, platform);
   var metadataFromViewProps = getMetadataFromResolvedProps(viewProps);
 
   var metadata = _objectSpread(_objectSpread({}, metadataFromJsonLd), metadataFromViewProps); // Extract preview action only if we have an iframe src.

package/dist/cjs/in-product.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "InlineCardPageObject", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.InlineCardPageObject;
+  }
+});
+Object.defineProperty(exports, "BlockCardPageObject", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.BlockCardPageObject;
+  }
+});
+Object.defineProperty(exports, "EmbedCardPageObject", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.EmbedCardPageObject;
+  }
+});
+Object.defineProperty(exports, "inlineSmartLinkRendersTestCase", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.inlineSmartLinkRendersTestCase;
+  }
+});
+Object.defineProperty(exports, "blockSmartLinkRendersTestCase", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.blockSmartLinkRendersTestCase;
+  }
+});
+Object.defineProperty(exports, "embedSmartLinkRendersTestCase", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.embedSmartLinkRendersTestCase;
+  }
+});
+
+var _tests_external__ = require("./__tests_external__");

package/dist/cjs/index.js

@@ -53,10 +53,10 @@ Object.defineProperty(exports, "Context", {
     return _context.default;
   }
 });
-Object.defineProperty(exports, "IframelyResizeMessageListener", {
+Object.defineProperty(exports, "EmbedResizeMessageListener", {
   enumerable: true,
   get: function get() {
-    return _IframelyResizeMessageListener.IframelyResizeMessageListener;
+    return _EmbedResizeMessageListener.EmbedResizeMessageListener;
   }
 });
 Object.defineProperty(exports, "embedHeaderHeight", {
@@ -65,6 +65,60 @@ Object.defineProperty(exports, "embedHeaderHeight", {
     return _embeds.embedHeaderHeight;
   }
 });
+Object.defineProperty(exports, "SmartLinkEvents", {
+  enumerable: true,
+  get: function get() {
+    return _analytics.SmartLinkEvents;
+  }
+});
+Object.defineProperty(exports, "useSmartLinkEvents", {
+  enumerable: true,
+  get: function get() {
+    return _useSmartLinkEvents.useSmartLinkEvents;
+  }
+});
+Object.defineProperty(exports, "contentFooterClassName", {
+  enumerable: true,
+  get: function get() {
+    return _classNames.contentFooterClassName;
+  }
+});
+Object.defineProperty(exports, "metadataListClassName", {
+  enumerable: true,
+  get: function get() {
+    return _classNames.metadataListClassName;
+  }
+});
+Object.defineProperty(exports, "blockCardResolvingViewClassName", {
+  enumerable: true,
+  get: function get() {
+    return _classNames.blockCardResolvingViewClassName;
+  }
+});
+Object.defineProperty(exports, "blockCardResolvedViewClassName", {
+  enumerable: true,
+  get: function get() {
+    return _classNames.blockCardResolvedViewClassName;
+  }
+});
+Object.defineProperty(exports, "blockCardForbiddenViewClassName", {
+  enumerable: true,
+  get: function get() {
+    return _classNames.blockCardForbiddenViewClassName;
+  }
+});
+Object.defineProperty(exports, "blockCardIconImageClassName", {
+  enumerable: true,
+  get: function get() {
+    return _classNames.blockCardIconImageClassName;
+  }
+});
+Object.defineProperty(exports, "loadingPlaceholderClassName", {
+  enumerable: true,
+  get: function get() {
+    return _LazyFallback.loadingPlaceholderClassName;
+  }
+});
 
 var _state = require("./state");
 
@@ -78,6 +132,14 @@ var _Card = require("./view/Card");
 
 var _context = _interopRequireDefault(require("./state/context"));
 
-var _IframelyResizeMessageListener = require("./view/EmbedCard/IframelyResizeMessageListener");
+var _EmbedResizeMessageListener = require("./view/EmbedCard/EmbedResizeMessageListener");
+
+var _embeds = require("@atlaskit/media-ui/embeds");
+
+var _analytics = require("./utils/analytics/analytics");
+
+var _useSmartLinkEvents = require("./view/SmartLinkEvents/useSmartLinkEvents");
+
+var _classNames = require("@atlaskit/media-ui/classNames");
 
-var _embeds = require("@atlaskit/media-ui/embeds");
+var _LazyFallback = require("./view/CardWithUrl/component-lazy/LazyFallback");