@atlaskit/media-card 70.11.0 → 73.0.0

package/dist/cjs/root/card/getCardPreview/index.js

@@ -5,32 +5,41 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "getCardPreviewFromFilePreview", {
+Object.defineProperty(exports, "extractFilePreviewStatus", {
   enumerable: true,
   get: function get() {
-    return _helpers.getCardPreviewFromFilePreview;
+    return _filePreviewStatus.extractFilePreviewStatus;
   }
 });
+exports.getCardPreview = exports.fetchAndCacheRemotePreview = void 0;
 Object.defineProperty(exports, "getCardPreviewFromBackend", {
   enumerable: true,
   get: function get() {
     return _helpers.getCardPreviewFromBackend;
   }
 });
+exports.getCardPreviewFromCache = void 0;
+Object.defineProperty(exports, "getCardPreviewFromFilePreview", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getCardPreviewFromFilePreview;
+  }
+});
+exports.isSSRServerPreview = exports.isSSRPreview = exports.isSSRClientPreview = exports.isLocalPreview = exports.getSSRCardPreview = exports.getFilePreviewFromFileState = void 0;
 Object.defineProperty(exports, "isSupportedLocalPreview", {
   enumerable: true,
   get: function get() {
     return _helpers.isSupportedLocalPreview;
   }
 });
-exports.getCardPreview = exports.getFilePreviewFromFileState = exports.getCardPreviewFromCache = exports.shouldGetCardPreview = exports.extractFilePreviewStatus = void 0;
+exports.shouldResolvePreview = exports.removeCardPreviewFromCache = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _mediaClient = require("@atlaskit/media-client");
 
 var _mediaCommon = require("@atlaskit/media-common");
@@ -41,63 +50,23 @@ var _helpers = require("./helpers");
 
 var _errors = require("../../../errors");
 
-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; }
+var _dimensionComparer = require("../../../utils/dimensionComparer");
 
-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 _filePreviewStatus = require("./filePreviewStatus");
 
-// TODO: align these checks with helpers from Media Client
-// https://product-fabric.atlassian.net/browse/BMPT-1300
-var extractFilePreviewStatus = function extractFilePreviewStatus(fileState, 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 && (0, _mediaClient.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 = (0, _mediaClient.isPreviewableFileState)(fileState) && (0, _helpers.isSupportedLocalPreview)(mediaType) && !!mimeType && (0, _mediaCommon.isMimeTypeSupportedByBrowser)(mimeType);
-  var hasRemotePreview = (0, _mediaClient.isImageRepresentationReady)(fileState);
-  var hasPreview = hasLocalPreview || hasRemotePreview;
-  var isSupportedByBrowser = !!mimeType && (0, _mediaCommon.isMimeTypeSupportedByBrowser)(mimeType);
-  return {
-    hasFilesize: hasFilesize,
-    isPreviewable: isPreviewable,
-    hasPreview: hasPreview,
-    isSupportedByBrowser: isSupportedByBrowser
-  };
-};
+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; }
 
-exports.extractFilePreviewStatus = extractFilePreviewStatus;
-
-var shouldGetCardPreview = function shouldGetCardPreview(cardStatus, _ref3) {
-  var isPreviewable = _ref3.isPreviewable,
-      hasPreview = _ref3.hasPreview,
-      isSupportedByBrowser = _ref3.isSupportedByBrowser;
-  return cardStatus === 'loading-preview' || cardStatus === 'uploading' && hasPreview && isPreviewable ||
-  /**
-   * For Video, we can have local or remote preview while processing.
-   * Then, we only want to show the thumbnail if the file is supported by the browser,
-   * this way we prevent playing unsupported videos that are not procesed
-   */
-  cardStatus === 'processing' && hasPreview && isPreviewable && isSupportedByBrowser;
-};
+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; }
 
-exports.shouldGetCardPreview = shouldGetCardPreview;
 var getCardPreviewFromCache = _cache.default.get;
+exports.getCardPreviewFromCache = getCardPreviewFromCache;
+var removeCardPreviewFromCache = _cache.default.remove;
 /**
  * Will return the preview if available and supported by the browser
  * See extractFilePreviewStatus "hasLocalPreview" logic
  */
 
-exports.getCardPreviewFromCache = getCardPreviewFromCache;
+exports.removeCardPreviewFromCache = removeCardPreviewFromCache;
 
 var getFilePreviewFromFileState = function getFilePreviewFromFileState(fileState) {
   return 'mimeType' in fileState && (0, _mediaCommon.isMimeTypeSupportedByBrowser)(fileState.mimeType) && (0, _mediaClient.isPreviewableFileState)(fileState) ? fileState.preview : undefined;
@@ -105,6 +74,42 @@ var getFilePreviewFromFileState = function getFilePreviewFromFileState(fileState
 
 exports.getFilePreviewFromFileState = getFilePreviewFromFileState;
 
+var extendAndCachePreview = function extendAndCachePreview(id, dimensions, preview, mediaBlobUrlAttrs) {
+  var source;
+
+  switch (preview.source) {
+    case 'local':
+      source = 'cache-local';
+      break;
+
+    case 'remote':
+      source = 'cache-remote';
+      break;
+
+    case 'ssr-server':
+      source = 'cache-ssr-server';
+      break;
+
+    case 'ssr-client':
+      source = 'cache-ssr-client';
+      break;
+
+    default:
+      source = preview.source;
+  } // We want to embed some meta context into dataURI for Copy/Paste to work.
+
+
+  var dataURI = mediaBlobUrlAttrs ? (0, _mediaClient.addFileAttrsToUrl)(preview.dataURI, mediaBlobUrlAttrs) : preview.dataURI; // We store new cardPreview into cache
+
+  _cache.default.set(id, dimensions, _objectSpread(_objectSpread({}, preview), {}, {
+    source: source,
+    dataURI: dataURI
+  }));
+
+  return _objectSpread(_objectSpread({}, preview), {}, {
+    dataURI: dataURI
+  });
+};
 /**
  * This function will try to return a Card preview, either from cache, local preview or remote preview.
  * It should only be called if there is a chance to get either a remote or a local preview, or both.
@@ -115,49 +120,48 @@ exports.getFilePreviewFromFileState = getFilePreviewFromFileState;
  * In that case, we still want to report the local preview error to the caller, for feature realiability track.
  * hence the use of the optional callback onLocalPreviewError
  */
+
+
 var getCardPreview = /*#__PURE__*/function () {
-  var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref4) {
-    var mediaClient, id, collectionName, requestedDimensions, isRemotePreviewReady, addContextToDataURI, filePreview, _ref4$dimensions, dimensions, resizeMode, onLocalPreviewError, cardPreview;
+  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref) {
+    var mediaClient, id, _ref$dimensions, dimensions, filePreview, onLocalPreviewError, isRemotePreviewReady, imageUrlParams, mediaBlobUrlAttrs, cachedPreview, localPreview;
 
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            mediaClient = _ref4.mediaClient, id = _ref4.id, collectionName = _ref4.collectionName, requestedDimensions = _ref4.requestedDimensions, isRemotePreviewReady = _ref4.isRemotePreviewReady, addContextToDataURI = _ref4.addContextToDataURI, filePreview = _ref4.filePreview, _ref4$dimensions = _ref4.dimensions, dimensions = _ref4$dimensions === void 0 ? {} : _ref4$dimensions, resizeMode = _ref4.resizeMode, onLocalPreviewError = _ref4.onLocalPreviewError;
-            cardPreview = _cache.default.get(id, dimensions);
+            mediaClient = _ref.mediaClient, id = _ref.id, _ref$dimensions = _ref.dimensions, dimensions = _ref$dimensions === void 0 ? {} : _ref$dimensions, filePreview = _ref.filePreview, onLocalPreviewError = _ref.onLocalPreviewError, isRemotePreviewReady = _ref.isRemotePreviewReady, imageUrlParams = _ref.imageUrlParams, mediaBlobUrlAttrs = _ref.mediaBlobUrlAttrs;
+            cachedPreview = _cache.default.get(id, dimensions);
 
-            if (!cardPreview) {
+            if (!cachedPreview) {
               _context.next = 4;
               break;
             }
 
-            return _context.abrupt("return", _objectSpread(_objectSpread({}, cardPreview), {}, {
-              source: 'cache'
-            }));
+            return _context.abrupt("return", cachedPreview);
 
           case 4:
             _context.prev = 4;
-            _context.t0 = filePreview;
 
-            if (!_context.t0) {
+            if (!filePreview) {
               _context.next = 10;
               break;
             }
 
-            _context.next = 9;
+            _context.next = 8;
             return (0, _helpers.getCardPreviewFromFilePreview)(filePreview);
 
-          case 9:
-            _context.t0 = _context.sent;
+          case 8:
+            localPreview = _context.sent;
+            return _context.abrupt("return", extendAndCachePreview(id, dimensions, localPreview, mediaBlobUrlAttrs));
 
           case 10:
-            cardPreview = _context.t0;
-            _context.next = 18;
+            _context.next = 17;
             break;
 
-          case 13:
-            _context.prev = 13;
-            _context.t1 = _context["catch"](4);
+          case 12:
+            _context.prev = 12;
+            _context.t0 = _context["catch"](4);
 
             /**
              * We report the error if:
@@ -169,8 +173,8 @@ var getCardPreview = /*#__PURE__*/function () {
              *   i.e. local preview is available and not supported,
              *   but we are after the remote preview instead.
              */
-            if (!(0, _errors.isUnsupportedLocalPreviewError)(_context.t1) || (0, _errors.isUnsupportedLocalPreviewError)(_context.t1) && !isRemotePreviewReady) {
-              onLocalPreviewError && onLocalPreviewError(_context.t1);
+            if (!(0, _errors.isUnsupportedLocalPreviewError)(_context.t0) || (0, _errors.isUnsupportedLocalPreviewError)(_context.t0) && !isRemotePreviewReady) {
+              onLocalPreviewError && onLocalPreviewError(_context.t0);
             }
             /**
              * No matter the reason why the local preview failed, we break the process
@@ -179,56 +183,126 @@ var getCardPreview = /*#__PURE__*/function () {
 
 
             if (isRemotePreviewReady) {
-              _context.next = 18;
+              _context.next = 17;
               break;
             }
 
-            throw _context.t1;
-
-          case 18:
-            if (cardPreview) {
-              _context.next = 24;
-              break;
-            }
+            throw _context.t0;
 
+          case 17:
             if (isRemotePreviewReady) {
-              _context.next = 21;
+              _context.next = 19;
               break;
             }
 
             throw new _errors.MediaCardError('remote-preview-not-ready');
 
-          case 21:
-            _context.next = 23;
-            return (0, _helpers.getCardPreviewFromBackend)(mediaClient, id, requestedDimensions, collectionName, resizeMode);
+          case 19:
+            return _context.abrupt("return", fetchAndCacheRemotePreview(mediaClient, id, dimensions, imageUrlParams, mediaBlobUrlAttrs));
 
-          case 23:
-            cardPreview = _context.sent;
+          case 20:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[4, 12]]);
+  }));
 
-          case 24:
-            /**
-             * In case we've retrieved cardPreview using one of the two methods above,
-             * we want to embed some meta context into dataURI for Copy/Paste to work.
-             */
-            cardPreview = _objectSpread(_objectSpread({}, cardPreview), {}, {
-              dataURI: addContextToDataURI(cardPreview.dataURI)
-            }); // We store new cardPreview into cache
+  return function getCardPreview(_x) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+
+exports.getCardPreview = getCardPreview;
+
+var shouldResolvePreview = function shouldResolvePreview(_ref3) {
+  var status = _ref3.status,
+      fileState = _ref3.fileState,
+      dimensions = _ref3.dimensions,
+      prevDimensions = _ref3.prevDimensions,
+      hasCardPreview = _ref3.hasCardPreview,
+      isBannedLocalPreview = _ref3.isBannedLocalPreview,
+      featureFlags = _ref3.featureFlags;
+  var statusIsPreviewable = (0, _filePreviewStatus.isPreviewableStatus)(status, (0, _filePreviewStatus.extractFilePreviewStatus)(fileState, isBannedLocalPreview, featureFlags));
+  var dimensionsAreBigger = (0, _dimensionComparer.isBigger)(prevDimensions, dimensions);
+  return statusIsPreviewable && (!hasCardPreview || dimensionsAreBigger);
+};
+
+exports.shouldResolvePreview = shouldResolvePreview;
+
+var getSSRCardPreview = function getSSRCardPreview(ssr, mediaClient, id, params, mediaBlobUrlAttrs) {
+  var dataURI;
+
+  try {
+    var rawDataURI = mediaClient.getImageUrlSync(id, params); // We want to embed some meta context into dataURI for Copy/Paste to work.
+
+    dataURI = mediaBlobUrlAttrs ? (0, _mediaClient.addFileAttrsToUrl)(rawDataURI, mediaBlobUrlAttrs) : rawDataURI;
+    var source = ssr === 'client' ? 'ssr-client' : 'ssr-server';
+    return {
+      dataURI: dataURI,
+      source: source,
+      orientation: 1
+    };
+  } catch (e) {
+    var reason = ssr === 'server' ? 'ssr-server-uri' : 'ssr-client-uri';
+    throw new _errors.SsrPreviewError(reason, e);
+  }
+};
 
-            _cache.default.set(id, dimensions, cardPreview);
+exports.getSSRCardPreview = getSSRCardPreview;
 
-            return _context.abrupt("return", cardPreview);
+var isLocalPreview = function isLocalPreview(preview) {
+  var localSources = ['local', 'cache-local'];
+  return localSources.includes(preview.source);
+};
+
+exports.isLocalPreview = isLocalPreview;
+
+var isSSRPreview = function isSSRPreview(preview) {
+  return isSSRClientPreview(preview) || isSSRServerPreview(preview);
+};
+
+exports.isSSRPreview = isSSRPreview;
+
+var isSSRServerPreview = function isSSRServerPreview(preview) {
+  var ssrClientSources = ['ssr-server', 'cache-ssr-server'];
+  return ssrClientSources.includes(preview.source);
+};
+
+exports.isSSRServerPreview = isSSRServerPreview;
+
+var isSSRClientPreview = function isSSRClientPreview(preview) {
+  var ssrClientSources = ['ssr-client', 'cache-ssr-client'];
+  return ssrClientSources.includes(preview.source);
+};
+
+exports.isSSRClientPreview = isSSRClientPreview;
+
+var fetchAndCacheRemotePreview = /*#__PURE__*/function () {
+  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(mediaClient, id, dimensions, params, mediaBlobUrlAttrs) {
+    var remotePreview;
+    return _regenerator.default.wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.next = 2;
+            return (0, _helpers.getCardPreviewFromBackend)(mediaClient, id, params);
 
-          case 27:
+          case 2:
+            remotePreview = _context2.sent;
+            return _context2.abrupt("return", extendAndCachePreview(id, dimensions, remotePreview, mediaBlobUrlAttrs));
+
+          case 4:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
       }
-    }, _callee, null, [[4, 13]]);
+    }, _callee2);
   }));
 
-  return function getCardPreview(_x) {
-    return _ref5.apply(this, arguments);
+  return function fetchAndCacheRemotePreview(_x2, _x3, _x4, _x5, _x6) {
+    return _ref4.apply(this, arguments);
   };
 }();
 
-exports.getCardPreview = getCardPreview;
+exports.fetchAndCacheRemotePreview = fetchAndCacheRemotePreview;

package/dist/cjs/root/card/getCardStatus.js

@@ -3,7 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getCardStatus = void 0;
+exports.isFinalCardStatus = exports.getCardStatus = void 0;
+
+var isFinalCardStatus = function isFinalCardStatus(status) {
+  return ['complete', 'error', 'failed-processing'].includes(status);
+};
+
+exports.isFinalCardStatus = isFinalCardStatus;
 
 var getCardStatus = function getCardStatus(fileStatus, _ref) {
   var hasFilesize = _ref.hasFilesize,