@atlaskit/media-card 71.0.0 → 72.0.0

package/dist/esm/errors.js

@@ -70,6 +70,41 @@ export var RemotePreviewError = /*#__PURE__*/function (_MediaCardError2) {
 
   return RemotePreviewError;
 }(MediaCardError);
+export var getImageLoadPrimaryReason = function getImageLoadPrimaryReason(source) {
+  switch (source) {
+    case 'cache-remote':
+      return 'cache-remote-uri';
+
+    case 'cache-local':
+      return 'cache-local-uri';
+
+    case 'external':
+      return 'external-uri';
+
+    case 'local':
+      return 'local-uri';
+
+    case 'remote':
+      return 'remote-uri';
+    // This fail reason will come from a bug, most likely.
+
+    default:
+      return "unknown-uri";
+  }
+};
+export var ImageLoadError = /*#__PURE__*/function (_MediaCardError3) {
+  _inherits(ImageLoadError, _MediaCardError3);
+
+  var _super4 = _createSuper(ImageLoadError);
+
+  function ImageLoadError(source) {
+    _classCallCheck(this, ImageLoadError);
+
+    return _super4.call(this, getImageLoadPrimaryReason(source));
+  }
+
+  return ImageLoadError;
+}(MediaCardError);
 export function isMediaCardError(err) {
   return err instanceof MediaCardError;
 }
@@ -81,9 +116,15 @@ export var isRemotePreviewError = function isRemotePreviewError(err) {
 };
 export var isUnsupportedLocalPreviewError = function isUnsupportedLocalPreviewError(err) {
   return isMediaCardError(err) && err.primaryReason === 'local-preview-unsupported';
-}; // In a try/catch statement, the error caught is the type of any.
+};
+export function isImageLoadError(err) {
+  return err instanceof ImageLoadError;
+} // In a try/catch statement, the error caught is the type of any.
 // We can use this helper to ensure that the error handled is the type of MediaCardError if unsure
 
 export var ensureMediaCardError = function ensureMediaCardError(primaryReason, error) {
   return isMediaCardError(error) ? error : new MediaCardError(primaryReason, error);
+};
+export var isUploadError = function isUploadError(error) {
+  return error.primaryReason === 'upload';
 };

package/dist/esm/files/cardImageView/index.js

@@ -20,20 +20,17 @@ import { CardLoading } from '../../utils/lightCards/cardLoading';
 import { shouldDisplayImageThumbnail } from '../../utils/shouldDisplayImageThumbnail';
 import { ProgressBar } from '../../utils/progressBar';
 import CardActions from '../../utils/cardActions';
-import { withAnalyticsEvents } from '@atlaskit/analytics-next';
-import { fireMediaCardEvent, RenderEventAction, getRenderSucceededEventPayload, getRenderFailedFileUriPayload, getRenderFailedExternalUriPayload } from '../../utils/analytics';
-import { withFileAttributes } from '../../utils/fileAttributesContext';
 export var fileCardImageViewSelector = 'media-file-card-view';
 export var fileCardImageViewSelectedSelector = 'media-file-card-view-selected';
-export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
-  _inherits(FileCardImageViewBase, _Component);
+export var FileCardImageView = /*#__PURE__*/function (_Component) {
+  _inherits(FileCardImageView, _Component);
 
-  var _super = _createSuper(FileCardImageViewBase);
+  var _super = _createSuper(FileCardImageView);
 
-  function FileCardImageViewBase() {
+  function FileCardImageView() {
     var _this;
 
-    _classCallCheck(this, FileCardImageViewBase);
+    _classCallCheck(this, FileCardImageView);
 
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
@@ -159,60 +156,18 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
       })));
     });
 
-    _defineProperty(_assertThisInitialized(_this), "onImageLoad", function () {
-      var _this$props6 = _this.props,
-          createAnalyticsEvent = _this$props6.createAnalyticsEvent,
-          fileAttributes = _this$props6.fileAttributes,
-          timeElapsedTillCommenced = _this$props6.timeElapsedTillCommenced;
-
-      if (fileAttributes && _this.shouldFireEvent(RenderEventAction.SUCCEEDED)) {
-        var timeElapsedTillSucceeded = performance.now();
-        var durationSinceCommenced = timeElapsedTillCommenced && timeElapsedTillSucceeded - timeElapsedTillCommenced;
-        var performanceAttributes = {
-          overall: {
-            durationSincePageStart: timeElapsedTillSucceeded,
-            durationSinceCommenced: durationSinceCommenced
-          }
-        };
-        fireMediaCardEvent(getRenderSucceededEventPayload(fileAttributes, performanceAttributes), createAnalyticsEvent);
-      }
-    });
-
-    _defineProperty(_assertThisInitialized(_this), "onImageError", function () {
-      var fileAttributes = _this.props.fileAttributes;
-
-      if (fileAttributes && _this.shouldFireEvent(RenderEventAction.FAILED)) {
-        var _this$props7 = _this.props,
-            createAnalyticsEvent = _this$props7.createAnalyticsEvent,
-            mediaItemType = _this$props7.mediaItemType,
-            timeElapsedTillCommenced = _this$props7.timeElapsedTillCommenced;
-        var timeElapsedTillFailed = performance.now();
-        var durationSinceCommenced = timeElapsedTillCommenced && timeElapsedTillFailed - timeElapsedTillCommenced;
-        var performanceAttributes = {
-          overall: {
-            durationSincePageStart: timeElapsedTillFailed,
-            durationSinceCommenced: durationSinceCommenced
-          }
-        };
-
-        if (mediaItemType === 'file') {
-          fireMediaCardEvent(getRenderFailedFileUriPayload(fileAttributes, performanceAttributes), createAnalyticsEvent);
-        } else if (mediaItemType === 'external-image') {
-          fireMediaCardEvent(getRenderFailedExternalUriPayload(fileAttributes, performanceAttributes), createAnalyticsEvent);
-        }
-      }
-    });
-
     _defineProperty(_assertThisInitialized(_this), "renderMediaImage", function () {
-      var _this$props8 = _this.props,
-          status = _this$props8.status,
-          mediaItemType = _this$props8.mediaItemType,
-          dataURI = _this$props8.dataURI,
-          mediaType = _this$props8.mediaType,
-          mimeType = _this$props8.mimeType,
-          previewOrientation = _this$props8.previewOrientation,
-          onDisplayImage = _this$props8.onDisplayImage,
-          alt = _this$props8.alt;
+      var _this$props6 = _this.props,
+          status = _this$props6.status,
+          mediaItemType = _this$props6.mediaItemType,
+          dataURI = _this$props6.dataURI,
+          mediaType = _this$props6.mediaType,
+          mimeType = _this$props6.mimeType,
+          previewOrientation = _this$props6.previewOrientation,
+          onDisplayImage = _this$props6.onDisplayImage,
+          alt = _this$props6.alt,
+          onImageLoad = _this$props6.onImageLoad,
+          onImageError = _this$props6.onImageError;
 
       if (!shouldDisplayImageThumbnail(status, mediaItemType, dataURI, mediaType, mimeType)) {
         return null;
@@ -229,21 +184,17 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
         crop: _this.isCropped,
         stretch: _this.isStretched,
         previewOrientation: previewOrientation,
-        onImageLoad: _this.onImageLoad,
-        onImageError: _this.onImageError
+        onImageLoad: onImageLoad,
+        onImageError: onImageError
       });
     });
 
-    _defineProperty(_assertThisInitialized(_this), "shouldFireEvent", function (action) {
-      return !_this.lastAnalyticsAction || _this.lastAnalyticsAction !== action;
-    });
-
     _defineProperty(_assertThisInitialized(_this), "renderProgressBar", function () {
-      var _this$props9 = _this.props,
-          mediaName = _this$props9.mediaName,
-          progress = _this$props9.progress,
-          actions = _this$props9.actions,
-          status = _this$props9.status;
+      var _this$props7 = _this.props,
+          mediaName = _this$props7.mediaName,
+          progress = _this$props7.progress,
+          actions = _this$props7.actions,
+          status = _this$props7.status;
 
       if (status !== 'uploading') {
         return null;
@@ -262,10 +213,10 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
     });
 
     _defineProperty(_assertThisInitialized(_this), "renderSuccessCardContents", function () {
-      var _this$props10 = _this.props,
-          disableOverlay = _this$props10.disableOverlay,
-          selectable = _this$props10.selectable,
-          status = _this$props10.status;
+      var _this$props8 = _this.props,
+          disableOverlay = _this$props8.disableOverlay,
+          selectable = _this$props8.selectable,
+          status = _this$props8.status;
       var overlay = null;
 
       if (!disableOverlay) {
@@ -286,15 +237,15 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
     });
 
     _defineProperty(_assertThisInitialized(_this), "renderSuccessCardOverlay", function () {
-      var _this$props11 = _this.props,
-          status = _this$props11.status,
-          mediaName = _this$props11.mediaName,
-          mediaType = _this$props11.mediaType,
-          fileSize = _this$props11.fileSize,
-          dataURI = _this$props11.dataURI,
-          selectable = _this$props11.selectable,
-          selected = _this$props11.selected,
-          actions = _this$props11.actions;
+      var _this$props9 = _this.props,
+          status = _this$props9.status,
+          mediaName = _this$props9.mediaName,
+          mediaType = _this$props9.mediaType,
+          fileSize = _this$props9.fileSize,
+          dataURI = _this$props9.dataURI,
+          selectable = _this$props9.selectable,
+          selected = _this$props9.selected,
+          actions = _this$props9.actions;
       var isPersistent = mediaType === 'doc' || !dataURI;
       return /*#__PURE__*/React.createElement(CardOverlay, {
         cardStatus: status,
@@ -311,17 +262,17 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
     return _this;
   }
 
-  _createClass(FileCardImageViewBase, [{
+  _createClass(FileCardImageView, [{
     key: "render",
     value: function render() {
-      var _this$props12 = this.props,
-          disableOverlay = _this$props12.disableOverlay,
-          selectable = _this$props12.selectable,
-          selected = _this$props12.selected,
-          mediaType = _this$props12.mediaType,
-          progress = _this$props12.progress,
-          status = _this$props12.status,
-          mediaName = _this$props12.mediaName;
+      var _this$props10 = this.props,
+          disableOverlay = _this$props10.disableOverlay,
+          selectable = _this$props10.selectable,
+          selected = _this$props10.selected,
+          mediaType = _this$props10.mediaType,
+          progress = _this$props10.progress,
+          status = _this$props10.status,
+          mediaName = _this$props10.mediaName;
       return /*#__PURE__*/React.createElement(Wrapper, {
         "data-testid": "media-file-card-view",
         "data-test-media-name": mediaName,
@@ -338,9 +289,9 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
   }, {
     key: "isFileCardImageReadyForDisplay",
     get: function get() {
-      var _this$props13 = this.props,
-          dataURI = _this$props13.dataURI,
-          status = _this$props13.status;
+      var _this$props11 = this.props,
+          dataURI = _this$props11.dataURI,
+          status = _this$props11.status;
       return !!dataURI || !['loading', 'processing', 'loading-preview'].includes(status);
     }
   }, {
@@ -357,12 +308,10 @@ export var FileCardImageViewBase = /*#__PURE__*/function (_Component) {
     }
   }]);
 
-  return FileCardImageViewBase;
+  return FileCardImageView;
 }(Component);
 
-_defineProperty(FileCardImageViewBase, "defaultProps", {
+_defineProperty(FileCardImageView, "defaultProps", {
   resizeMode: 'crop',
   disableOverlay: false
-});
-
-export var FileCardImageView = withAnalyticsEvents()(withFileAttributes(FileCardImageViewBase));
+});

package/dist/esm/files/index.js

@@ -1 +1 @@
-export { FileCardImageView, FileCardImageViewBase } from './cardImageView';
+export { FileCardImageView } from './cardImageView';

package/dist/esm/root/card/cardAnalytics.js

@@ -1,25 +1,13 @@
 import { fireMediaCardEvent, getRenderSucceededEventPayload, getRenderErrorEventPayload, getRenderFailedFileStatusPayload, getCopiedFilePayload, getRenderCommencedEventPayload, getRenderPreviewableCardPayload } from '../../utils/analytics';
-export var relevantFeatureFlagNames = ['newCardExperience', 'poll_intervalMs', 'poll_maxAttempts', 'poll_backoffFactor', 'poll_maxIntervalMs', 'captions'];
-export var fireOperationalEvent = function fireOperationalEvent(createAnalyticsEvent, status, fileAttributes, performanceAttributes) {
-  var _ref = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {},
-      cardPreview = _ref.cardPreview,
-      error = _ref.error;
-
+export var relevantFeatureFlagNames = ['newCardExperience', 'captions'];
+export var fireOperationalEvent = function fireOperationalEvent(createAnalyticsEvent, status, fileAttributes, performanceAttributes, error) {
   var fireEvent = function fireEvent(payload) {
     return fireMediaCardEvent(payload, createAnalyticsEvent);
   };
 
   switch (status) {
     case 'complete':
-      /**
-       * A Card that is considered Complete and has no preview,
-       * reflects an expected behaviour, and thus a legitimate
-       * success case to be logged.
-       */
-      if (!(cardPreview !== null && cardPreview !== void 0 && cardPreview.dataURI)) {
-        fireEvent(getRenderSucceededEventPayload(fileAttributes, performanceAttributes));
-      }
-
+      fireEvent(getRenderSucceededEventPayload(fileAttributes, performanceAttributes));
       break;
 
     case 'failed-processing':

package/dist/esm/root/card/cardSSRView.js

@@ -7,6 +7,7 @@ import _extends from "@babel/runtime/helpers/extends";
  * imported file only contains and depends on only what is required for it to function.
  */
 import React from 'react';
+import { imageResizeModeToFileImageMode } from '@atlaskit/media-client';
 import { MediaImage } from '@atlaskit/media-ui';
 import SpinnerIcon from '@atlaskit/spinner';
 import { getRequestedDimensions } from '../../utils/getDataURIDimension';
@@ -32,7 +33,7 @@ export var CardSSRView = function CardSSRView(_ref) {
         width = _getRequestedDimensio.width,
         height = _getRequestedDimensio.height;
 
-    var mode = resizeMode === 'stretchy-fit' ? 'full-fit' : resizeMode;
+    var mode = imageResizeModeToFileImageMode(resizeMode);
     dataURI = mediaClient.getImageUrlSync(identifier.id, {
       collection: identifier.collectionName,
       mode: mode,
@@ -52,7 +53,7 @@ export var CardSSRView = function CardSSRView(_ref) {
     breakpoint: calculateBreakpoint(dimensions),
     shouldUsePointerCursor: Boolean(dataURI),
     displayBackground: shouldDisplayBackground,
-    disableOverlay: disableOverlay,
+    disableOverlay: !!disableOverlay,
     selected: false,
     "data-testid": "media-card-view"
   }, /*#__PURE__*/React.createElement(CardImageContainer, {

package/dist/esm/root/card/cardState.js

@@ -0,0 +1,32 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+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) { _defineProperty(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; }
+
+import { isErrorFileState } from '@atlaskit/media-client';
+import { MediaCardError } from '../../errors';
+import { getCardStatus, isFinalCardStatus } from './getCardStatus';
+import { extractFilePreviewStatus } from './getCardPreview';
+export var createStateUpdater = function createStateUpdater(newState) {
+  return function (prevState) {
+    // Only override if previous status is non-final
+    // or new status is 'complete'
+    if (isFinalCardStatus(prevState.status) && newState.status !== 'complete') {
+      return prevState;
+    }
+
+    return _objectSpread(_objectSpread({}, prevState), newState);
+  };
+};
+export var getCardStateFromFileState = function getCardStateFromFileState(fileState, isBannedLocalPreview, featureFlags) {
+  var status = getCardStatus(fileState.status, extractFilePreviewStatus(fileState, isBannedLocalPreview, featureFlags));
+  var error = status === 'error' && isErrorFileState(fileState) ? new MediaCardError('error-file-state', new Error(fileState.message)) : undefined;
+  var progress = status === 'uploading' && fileState.status === 'uploading' ? fileState.progress : 1;
+  return {
+    fileState: fileState,
+    status: status,
+    progress: progress,
+    error: error
+  };
+};

package/dist/esm/root/card/getCardPreview/cache.js

@@ -22,6 +22,12 @@ export var CardPreviewCacheImpl = function CardPreviewCacheImpl(previewCache) {
     _this.previewCache.set(cacheKey, cardPreview);
   });
 
+  _defineProperty(this, "remove", function (id, dimensions) {
+    var cacheKey = getCacheKey(id, dimensions);
+
+    _this.previewCache.remove(cacheKey);
+  });
+
   this.previewCache = previewCache;
 };
 export default new CardPreviewCacheImpl(createObjectURLCache());

package/dist/esm/root/card/getCardPreview/filePreviewStatus.js

@@ -0,0 +1,35 @@
+import { isMimeTypeSupportedByBrowser } from '@atlaskit/media-common';
+import { isPreviewableFileState, isPreviewableType, isImageRepresentationReady } from '@atlaskit/media-client';
+import { isSupportedLocalPreview } from './helpers'; // TODO: align these checks with helpers from Media Client
+// https://product-fabric.atlassian.net/browse/BMPT-1300
+
+export var extractFilePreviewStatus = function extractFilePreviewStatus(fileState, isBannedLocalPreview, featureFlags) {
+  var hasFilesize = 'size' in fileState && !!fileState.size;
+
+  var _ref = 'mediaType' in fileState && fileState || {},
+      mediaType = _ref.mediaType;
+
+  var _ref2 = 'mimeType' in fileState && fileState || {},
+      mimeType = _ref2.mimeType;
+
+  var isPreviewable = !!mediaType && isPreviewableType(mediaType, featureFlags); // Local preview is available only if it's supported by browser and supported by Media Card (isSupportedLocalPreview)
+  // For example, SVGs are mime type NOT supported by browser but media type supported by Media Card (image)
+  // Then, local Preview NOT available
+
+  var hasLocalPreview = !isBannedLocalPreview && isPreviewableFileState(fileState) && isSupportedLocalPreview(mediaType) && !!mimeType && isMimeTypeSupportedByBrowser(mimeType);
+  var hasRemotePreview = isImageRepresentationReady(fileState);
+  var hasPreview = hasLocalPreview || hasRemotePreview;
+  var isSupportedByBrowser = !!mimeType && isMimeTypeSupportedByBrowser(mimeType);
+  return {
+    hasFilesize: hasFilesize,
+    isPreviewable: isPreviewable,
+    hasPreview: hasPreview,
+    isSupportedByBrowser: isSupportedByBrowser
+  };
+};
+export var isPreviewableStatus = function isPreviewableStatus(cardStatus, _ref3) {
+  var isPreviewable = _ref3.isPreviewable,
+      hasPreview = _ref3.hasPreview,
+      isSupportedByBrowser = _ref3.isSupportedByBrowser;
+  return hasPreview && isPreviewable && (cardStatus === 'complete' || cardStatus === 'loading-preview' || cardStatus === 'uploading' || cardStatus === 'processing' && isSupportedByBrowser);
+};

package/dist/esm/root/card/getCardPreview/helpers.js

@@ -157,25 +157,17 @@ export var getCardPreviewFromFilePreview = /*#__PURE__*/function () {
   };
 }();
 export var getCardPreviewFromBackend = /*#__PURE__*/function () {
-  var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(mediaClient, id, _ref4, collectionName, resizeMode) {
-    var width, height, mode, blob;
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(mediaClient, id, params) {
+    var blob;
     return _regeneratorRuntime.wrap(function _callee4$(_context4) {
       while (1) {
         switch (_context4.prev = _context4.next) {
           case 0:
-            width = _ref4.width, height = _ref4.height;
-            _context4.prev = 1;
-            mode = resizeMode === 'stretchy-fit' ? 'full-fit' : resizeMode;
-            _context4.next = 5;
-            return mediaClient.getImage(id, {
-              collection: collectionName,
-              mode: mode,
-              width: width,
-              height: height,
-              allowAnimated: true
-            });
+            _context4.prev = 0;
+            _context4.next = 3;
+            return mediaClient.getImage(id, params);
 
-          case 5:
+          case 3:
             blob = _context4.sent;
             return _context4.abrupt("return", {
               dataURI: URL.createObjectURL(blob),
@@ -183,20 +175,20 @@ export var getCardPreviewFromBackend = /*#__PURE__*/function () {
               source: 'remote'
             });
 
-          case 9:
-            _context4.prev = 9;
-            _context4.t0 = _context4["catch"](1);
+          case 7:
+            _context4.prev = 7;
+            _context4.t0 = _context4["catch"](0);
             throw new RemotePreviewError('remote-preview-fetch', _context4.t0);
 
-          case 12:
+          case 10:
           case "end":
             return _context4.stop();
         }
       }
-    }, _callee4, null, [[1, 9]]);
+    }, _callee4, null, [[0, 7]]);
   }));
 
-  return function getCardPreviewFromBackend(_x4, _x5, _x6, _x7, _x8) {
-    return _ref5.apply(this, arguments);
+  return function getCardPreviewFromBackend(_x4, _x5, _x6) {
+    return _ref4.apply(this, arguments);
   };
 }();