@atlaskit/media-card 70.9.0 → 72.0.0

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

@@ -0,0 +1,225 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "getCardPreviewFromFilePreview", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getCardPreviewFromFilePreview;
+  }
+});
+Object.defineProperty(exports, "getCardPreviewFromBackend", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.getCardPreviewFromBackend;
+  }
+});
+Object.defineProperty(exports, "isSupportedLocalPreview", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isSupportedLocalPreview;
+  }
+});
+Object.defineProperty(exports, "extractFilePreviewStatus", {
+  enumerable: true,
+  get: function get() {
+    return _filePreviewStatus.extractFilePreviewStatus;
+  }
+});
+exports.shouldResolvePreview = exports.getCardPreview = exports.getFilePreviewFromFileState = exports.removeCardPreviewFromCache = exports.getCardPreviewFromCache = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+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");
+
+var _cache = _interopRequireDefault(require("./cache"));
+
+var _helpers = require("./helpers");
+
+var _errors = require("../../../errors");
+
+var _dimensionComparer = require("../../../utils/dimensionComparer");
+
+var _filePreviewStatus = require("./filePreviewStatus");
+
+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) { (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 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.removeCardPreviewFromCache = removeCardPreviewFromCache;
+
+var getFilePreviewFromFileState = function getFilePreviewFromFileState(fileState) {
+  return 'mimeType' in fileState && (0, _mediaCommon.isMimeTypeSupportedByBrowser)(fileState.mimeType) && (0, _mediaClient.isPreviewableFileState)(fileState) ? fileState.preview : undefined;
+};
+
+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;
+
+    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.
+ * This, in order to ensure there is always going to be a valid return value OR throw an error if the process fails.
+ * It is worth noting that local preview failures break the process if there is no remote preview available.
+ * In that case we throw an error immediately.
+ * Otherwise, if the local preview fails but there is a remote preview available, the failure does not break the process.
+ * 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 _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref) {
+    var mediaClient, id, _ref$dimensions, dimensions, filePreview, onLocalPreviewError, isRemotePreviewReady, imageUrlParams, mediaBlobUrlAttrs, cachedPreview, localPreview, remotePreview;
+
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            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 (!cachedPreview) {
+              _context.next = 4;
+              break;
+            }
+
+            return _context.abrupt("return", cachedPreview);
+
+          case 4:
+            _context.prev = 4;
+
+            if (!filePreview) {
+              _context.next = 10;
+              break;
+            }
+
+            _context.next = 8;
+            return (0, _helpers.getCardPreviewFromFilePreview)(filePreview);
+
+          case 8:
+            localPreview = _context.sent;
+            return _context.abrupt("return", extendAndCachePreview(id, dimensions, localPreview, mediaBlobUrlAttrs));
+
+          case 10:
+            _context.next = 17;
+            break;
+
+          case 12:
+            _context.prev = 12;
+            _context.t0 = _context["catch"](4);
+
+            /**
+             * We report the error if:
+             * - local preview is supported and fails
+             * - local preview is unsupported and remote preview is NOT READY
+             *   i.e. the function was called for "no reason".
+             * We DON'T report the error if:
+             * - local preview is unsupported and remote preview IS READY
+             *   i.e. local preview is available and not supported,
+             *   but we are after the remote preview instead.
+             */
+            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
+             * if there is no remote preview available
+             */
+
+
+            if (isRemotePreviewReady) {
+              _context.next = 17;
+              break;
+            }
+
+            throw _context.t0;
+
+          case 17:
+            if (isRemotePreviewReady) {
+              _context.next = 19;
+              break;
+            }
+
+            throw new _errors.MediaCardError('remote-preview-not-ready');
+
+          case 19:
+            _context.next = 21;
+            return (0, _helpers.getCardPreviewFromBackend)(mediaClient, id, imageUrlParams);
+
+          case 21:
+            remotePreview = _context.sent;
+            return _context.abrupt("return", extendAndCachePreview(id, dimensions, remotePreview, mediaBlobUrlAttrs));
+
+          case 23:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[4, 12]]);
+  }));
+
+  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;

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

@@ -3,26 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getCardStatus = exports.extractCardStatusParams = void 0;
-
-var _mediaClient = require("@atlaskit/media-client");
-
-var extractCardStatusParams = function extractCardStatusParams(fileState, featureFlags) {
-  return {
-    // TODO: align these checks with helpers from Media Client
-    // https://product-fabric.atlassian.net/browse/BMPT-1300
-    isPreviewableType: 'mediaType' in fileState && !!fileState.mediaType && (0, _mediaClient.isPreviewableType)(fileState.mediaType, featureFlags),
-    hasFilesize: 'size' in fileState && !!fileState.size,
-    isPreviewableFileState: (0, _mediaClient.isPreviewableFileState)(fileState)
-  };
+exports.getCardStatus = exports.isFinalCardStatus = void 0;
+
+var isFinalCardStatus = function isFinalCardStatus(status) {
+  return ['complete', 'error', 'failed-processing'].includes(status);
 };
 
-exports.extractCardStatusParams = extractCardStatusParams;
+exports.isFinalCardStatus = isFinalCardStatus;
 
 var getCardStatus = function getCardStatus(fileStatus, _ref) {
-  var isPreviewableType = _ref.isPreviewableType,
-      hasFilesize = _ref.hasFilesize,
-      isPreviewableFileState = _ref.isPreviewableFileState;
+  var hasFilesize = _ref.hasFilesize,
+      isPreviewable = _ref.isPreviewable,
+      hasPreview = _ref.hasPreview;
 
   switch (fileStatus) {
     case 'uploading':
@@ -32,24 +24,27 @@ var getCardStatus = function getCardStatus(fileStatus, _ref) {
 
     case 'processing':
       // Legacy empty files logic
-      // isPreviewableType will most likely be false for empty files,
+      // isPreviewable will most likely be false for empty files,
       // therefore we need to do this cut before that check.
       // TODO: https://product-fabric.atlassian.net/browse/BMPT-1247
       if (!hasFilesize) {
         return 'processing';
       } // If we show no preview for this file
-      // we won't show the "creating preview" message
-      // i.e. Card is "complete".
+      // we won't show the "creating preview" message, i.e. Card is "complete".
 
 
-      if (!isPreviewableType || isPreviewableFileState) {
+      if (!isPreviewable) {
         return 'complete';
       }
 
       return 'processing';
 
     case 'processed':
-      return 'complete';
+      if (!isPreviewable || !hasPreview) {
+        return 'complete';
+      }
+
+      return 'loading-preview';
 
     default:
       return 'loading';