@atlaskit/media-card 78.0.7 → 78.0.9

package/dist/es2019/card/getCardPreview/helpers.js

@@ -1,74 +0,0 @@
-import { takeSnapshot } from '../../utils/videoSnapshot';
-import { getMediaTypeFromMimeType } from '@atlaskit/media-common';
-import { getOrientation } from '@atlaskit/media-ui';
-import { LocalPreviewError, RemotePreviewError } from '../../errors';
-/**
- * This method tells the support for the media
- * types covered in getCardPreviewFromFilePreview
- */
-export const isSupportedLocalPreview = mediaType => mediaType === 'image' || mediaType === 'video';
-const getImageLocalPreview = async value => {
-  try {
-    const orientation = await getOrientation(value);
-    const dataURI = URL.createObjectURL(value);
-    return {
-      dataURI,
-      orientation,
-      source: 'local'
-    };
-  } catch (e) {
-    throw new LocalPreviewError('local-preview-image', e instanceof Error ? e : undefined);
-  }
-};
-const getVideoLocalPreview = async value => {
-  try {
-    const dataURI = await takeSnapshot(value);
-    return {
-      dataURI,
-      orientation: 1,
-      source: 'local'
-    };
-  } catch (e) {
-    throw new LocalPreviewError('local-preview-video', e instanceof Error ? e : undefined);
-  }
-};
-export const getCardPreviewFromFilePreview = async filePreview => {
-  let value;
-  try {
-    const resolvedFilePreview = await filePreview;
-    value = resolvedFilePreview.value;
-  } catch (e) {
-    throw new LocalPreviewError('local-preview-rejected', e instanceof Error ? e : undefined);
-  }
-  if (typeof value === 'string') {
-    return {
-      dataURI: value,
-      orientation: 1,
-      source: 'local'
-    };
-  } else if (value instanceof Blob) {
-    const {
-      type
-    } = value;
-    const mediaType = getMediaTypeFromMimeType(type);
-    switch (mediaType) {
-      case 'image':
-        return getImageLocalPreview(value);
-      case 'video':
-        return getVideoLocalPreview(value);
-    }
-  }
-  throw new LocalPreviewError('local-preview-unsupported');
-};
-export const getCardPreviewFromBackend = async (mediaClient, id, params, traceContext) => {
-  try {
-    const blob = await mediaClient.getImage(id, params, undefined, undefined, traceContext);
-    return {
-      dataURI: URL.createObjectURL(blob),
-      orientation: 1,
-      source: 'remote'
-    };
-  } catch (e) {
-    throw new RemotePreviewError('remote-preview-fetch', e instanceof Error ? e : undefined);
-  }
-};

package/dist/es2019/card/getCardPreview/index.js

@@ -1,170 +0,0 @@
-import { isPreviewableFileState, addFileAttrsToUrl } from '@atlaskit/media-client';
-import { isMimeTypeSupportedByBrowser } from '@atlaskit/media-common';
-import cardPreviewCache from './cache';
-import { getCardPreviewFromFilePreview, getCardPreviewFromBackend } from './helpers';
-import { MediaCardError, SsrPreviewError, isUnsupportedLocalPreviewError } from '../../errors';
-import { isBigger } from '../../utils/dimensionComparer';
-import { extractFilePreviewStatus, isPreviewableStatus } from './filePreviewStatus';
-export { getCardPreviewFromFilePreview, getCardPreviewFromBackend, isSupportedLocalPreview } from './helpers';
-export { extractFilePreviewStatus } from './filePreviewStatus';
-export const getCardPreviewFromCache = cardPreviewCache.get;
-export const removeCardPreviewFromCache = cardPreviewCache.remove;
-
-/**
- * Will return the preview if available and supported by the browser
- * See extractFilePreviewStatus "hasLocalPreview" logic
- */
-export const getFilePreviewFromFileState = fileState => 'mimeType' in fileState && isMimeTypeSupportedByBrowser(fileState.mimeType) && isPreviewableFileState(fileState) ? fileState.preview : undefined;
-const extendAndCachePreview = (id, mode, preview, mediaBlobUrlAttrs) => {
-  let 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.
-  const dataURI = mediaBlobUrlAttrs ? addFileAttrsToUrl(preview.dataURI, mediaBlobUrlAttrs) : preview.dataURI;
-  // We store new cardPreview into cache
-  cardPreviewCache.set(id, mode, {
-    ...preview,
-    source,
-    dataURI
-  });
-  return {
-    ...preview,
-    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
- */
-export const getCardPreview = async ({
-  mediaClient,
-  id,
-  dimensions = {},
-  filePreview,
-  onLocalPreviewError,
-  isRemotePreviewReady,
-  imageUrlParams,
-  mediaBlobUrlAttrs,
-  traceContext
-}) => {
-  const mode = imageUrlParams.mode;
-  const cachedPreview = cardPreviewCache.get(id, mode);
-  const dimensionsAreBigger = isBigger(cachedPreview === null || cachedPreview === void 0 ? void 0 : cachedPreview.dimensions, dimensions);
-  if (cachedPreview && !dimensionsAreBigger) {
-    return cachedPreview;
-  }
-  try {
-    if (filePreview) {
-      const localPreview = await getCardPreviewFromFilePreview(filePreview);
-      return extendAndCachePreview(id, mode, {
-        ...localPreview,
-        dimensions
-      }, mediaBlobUrlAttrs);
-    }
-  } catch (e) {
-    /**
-     * 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 (!isUnsupportedLocalPreviewError(e) || isUnsupportedLocalPreviewError(e) && !isRemotePreviewReady) {
-      onLocalPreviewError && onLocalPreviewError(e);
-    }
-    /**
-     * No matter the reason why the local preview failed, we break the process
-     * if there is no remote preview available
-     */
-    if (!isRemotePreviewReady) {
-      throw e;
-    }
-  }
-  if (!isRemotePreviewReady) {
-    /**
-     * We throw this in case this function has been called
-     * without checking isRemotePreviewReady first.
-     * If remote preview is not ready, the call to getCardPreviewFromBackend
-     * will generate a console error due to a 404 code
-     */
-    throw new MediaCardError('remote-preview-not-ready');
-  }
-  const remotePreview = await fetchAndCacheRemotePreview(mediaClient, id, dimensions, imageUrlParams, mediaBlobUrlAttrs, traceContext);
-  return remotePreview;
-};
-export const shouldResolvePreview = ({
-  status,
-  fileState,
-  prevDimensions,
-  dimensions,
-  hasCardPreview,
-  isBannedLocalPreview,
-  wasResolvedUpfrontPreview
-}) => {
-  const statusIsPreviewable = isPreviewableStatus(status, extractFilePreviewStatus(fileState, isBannedLocalPreview));
-  const dimensionsAreBigger = isBigger(prevDimensions, dimensions);
-  // We should not fetch the preview if the upfront one hasn't been resolved yet (it could be resolving now), even if there are new dimensions.
-  return wasResolvedUpfrontPreview && statusIsPreviewable && (!hasCardPreview || dimensionsAreBigger);
-};
-export const getSSRCardPreview = (ssr, mediaClient, id, params, mediaBlobUrlAttrs) => {
-  let dataURI;
-  try {
-    const rawDataURI = mediaClient.getImageUrlSync(id, params);
-    // We want to embed some meta context into dataURI for Copy/Paste to work.
-    dataURI = mediaBlobUrlAttrs ? addFileAttrsToUrl(rawDataURI, mediaBlobUrlAttrs) : rawDataURI;
-    const source = ssr === 'client' ? 'ssr-client' : 'ssr-server';
-    return {
-      dataURI,
-      source,
-      orientation: 1
-    };
-  } catch (e) {
-    const reason = ssr === 'server' ? 'ssr-server-uri' : 'ssr-client-uri';
-    throw new SsrPreviewError(reason, e instanceof Error ? e : undefined);
-  }
-};
-export const isLocalPreview = preview => {
-  const localSources = ['local', 'cache-local'];
-  return localSources.includes(preview.source);
-};
-export const isSSRPreview = preview => isSSRClientPreview(preview) || isSSRServerPreview(preview) || isSSRDataPreview(preview);
-export const isSSRServerPreview = preview => {
-  const ssrClientSources = ['ssr-server', 'cache-ssr-server'];
-  return ssrClientSources.includes(preview.source);
-};
-export const isSSRClientPreview = preview => {
-  const ssrClientSources = ['ssr-client', 'cache-ssr-client'];
-  return ssrClientSources.includes(preview.source);
-};
-export const isSSRDataPreview = preview => preview.source === 'ssr-data';
-export const fetchAndCacheRemotePreview = async (mediaClient, id, dimensions, params, mediaBlobUrlAttrs, traceContext) => {
-  const remotePreview = await getCardPreviewFromBackend(mediaClient, id, params, traceContext);
-  return extendAndCachePreview(id, params.mode, {
-    ...remotePreview,
-    dimensions
-  }, mediaBlobUrlAttrs);
-};

package/dist/esm/card/cardState.js

@@ -1,32 +0,0 @@
-import { isErrorFileState } from '@atlaskit/media-client';
-import { MediaCardError } from '../errors';
-import { getCardStatus, isFinalCardStatus } from './getCardStatus';
-import { extractFilePreviewStatus } from './getCardPreview';
-
-/**
- * From docs: "Both state and props received by the updater function are guaranteed to be up-to-date.
- * The output of the updater is shallowly merged with state."
- */
-export var createStateUpdater = function createStateUpdater(newState, fireErrorEvent) {
-  return function (prevState) {
-    // Only override if previous status is non-final or new status is 'complete'
-    if (!!newState.status && isFinalCardStatus(prevState.status) && newState.status !== 'complete') {
-      // Log the error if the new state is not going to store it.
-      // i.e. this is a non critical error
-      !!newState.error && fireErrorEvent(newState.error);
-      return prevState;
-    }
-    return newState;
-  };
-};
-export var getCardStateFromFileState = function getCardStateFromFileState(fileState, isBannedLocalPreview) {
-  var status = getCardStatus(fileState.status, extractFilePreviewStatus(fileState, isBannedLocalPreview));
-  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/card/getCardPreview/cache.js

@@ -1,35 +0,0 @@
-import _createClass from "@babel/runtime/helpers/createClass";
-import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { createObjectURLCache } from '../../utils/objectURLCache';
-
-// Dimensions are used to create a key.
-// Cache is invalidated when different dimensions are provided.
-
-export var getCacheKey = function getCacheKey(id, mode) {
-  var resizeMode = mode || 'crop';
-  return [id, resizeMode].join('-');
-};
-export var CardPreviewCacheImpl = /*#__PURE__*/_createClass(function CardPreviewCacheImpl(previewCache) {
-  var _this = this;
-  _classCallCheck(this, CardPreviewCacheImpl);
-  _defineProperty(this, "get", function (id, mode) {
-    var cacheKey = getCacheKey(id, mode);
-    return _this.previewCache.get(cacheKey);
-  });
-  _defineProperty(this, "set", function (id, mode, cardPreview) {
-    var cacheKey = getCacheKey(id, mode);
-    _this.previewCache.set(cacheKey, cardPreview);
-  });
-  _defineProperty(this, "remove", function (id, mode) {
-    var cacheKey = getCacheKey(id, mode);
-    _this.previewCache.remove(cacheKey);
-  });
-  _defineProperty(this, "clear", function () {
-    _this.previewCache.clear();
-  });
-  this.previewCache = previewCache;
-});
-
-// eslint-disable-next-line import/no-anonymous-default-export
-export default new CardPreviewCacheImpl(createObjectURLCache());

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

@@ -1,40 +0,0 @@
-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) {
-  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);
-
-  // 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
-  };
-};
-
-// CXP-2723 TODO: Review this in relation to removing status from the hook
-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' ||
-  // 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' && isSupportedByBrowser);
-};

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

@@ -1,158 +0,0 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { takeSnapshot } from '../../utils/videoSnapshot';
-import { getMediaTypeFromMimeType } from '@atlaskit/media-common';
-import { getOrientation } from '@atlaskit/media-ui';
-import { LocalPreviewError, RemotePreviewError } from '../../errors';
-/**
- * This method tells the support for the media
- * types covered in getCardPreviewFromFilePreview
- */
-export var isSupportedLocalPreview = function isSupportedLocalPreview(mediaType) {
-  return mediaType === 'image' || mediaType === 'video';
-};
-var getImageLocalPreview = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(value) {
-    var orientation, dataURI;
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
-        case 0:
-          _context.prev = 0;
-          _context.next = 3;
-          return getOrientation(value);
-        case 3:
-          orientation = _context.sent;
-          dataURI = URL.createObjectURL(value);
-          return _context.abrupt("return", {
-            dataURI: dataURI,
-            orientation: orientation,
-            source: 'local'
-          });
-        case 8:
-          _context.prev = 8;
-          _context.t0 = _context["catch"](0);
-          throw new LocalPreviewError('local-preview-image', _context.t0 instanceof Error ? _context.t0 : undefined);
-        case 11:
-        case "end":
-          return _context.stop();
-      }
-    }, _callee, null, [[0, 8]]);
-  }));
-  return function getImageLocalPreview(_x) {
-    return _ref.apply(this, arguments);
-  };
-}();
-var getVideoLocalPreview = /*#__PURE__*/function () {
-  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(value) {
-    var dataURI;
-    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
-        case 0:
-          _context2.prev = 0;
-          _context2.next = 3;
-          return takeSnapshot(value);
-        case 3:
-          dataURI = _context2.sent;
-          return _context2.abrupt("return", {
-            dataURI: dataURI,
-            orientation: 1,
-            source: 'local'
-          });
-        case 7:
-          _context2.prev = 7;
-          _context2.t0 = _context2["catch"](0);
-          throw new LocalPreviewError('local-preview-video', _context2.t0 instanceof Error ? _context2.t0 : undefined);
-        case 10:
-        case "end":
-          return _context2.stop();
-      }
-    }, _callee2, null, [[0, 7]]);
-  }));
-  return function getVideoLocalPreview(_x2) {
-    return _ref2.apply(this, arguments);
-  };
-}();
-export var getCardPreviewFromFilePreview = /*#__PURE__*/function () {
-  var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(filePreview) {
-    var value, resolvedFilePreview, _value, type, mediaType;
-    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
-        case 0:
-          _context3.prev = 0;
-          _context3.next = 3;
-          return filePreview;
-        case 3:
-          resolvedFilePreview = _context3.sent;
-          value = resolvedFilePreview.value;
-          _context3.next = 10;
-          break;
-        case 7:
-          _context3.prev = 7;
-          _context3.t0 = _context3["catch"](0);
-          throw new LocalPreviewError('local-preview-rejected', _context3.t0 instanceof Error ? _context3.t0 : undefined);
-        case 10:
-          if (!(typeof value === 'string')) {
-            _context3.next = 14;
-            break;
-          }
-          return _context3.abrupt("return", {
-            dataURI: value,
-            orientation: 1,
-            source: 'local'
-          });
-        case 14:
-          if (!(value instanceof Blob)) {
-            _context3.next = 22;
-            break;
-          }
-          _value = value, type = _value.type;
-          mediaType = getMediaTypeFromMimeType(type);
-          _context3.t1 = mediaType;
-          _context3.next = _context3.t1 === 'image' ? 20 : _context3.t1 === 'video' ? 21 : 22;
-          break;
-        case 20:
-          return _context3.abrupt("return", getImageLocalPreview(value));
-        case 21:
-          return _context3.abrupt("return", getVideoLocalPreview(value));
-        case 22:
-          throw new LocalPreviewError('local-preview-unsupported');
-        case 23:
-        case "end":
-          return _context3.stop();
-      }
-    }, _callee3, null, [[0, 7]]);
-  }));
-  return function getCardPreviewFromFilePreview(_x3) {
-    return _ref3.apply(this, arguments);
-  };
-}();
-export var getCardPreviewFromBackend = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(mediaClient, id, params, traceContext) {
-    var blob;
-    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
-      while (1) switch (_context4.prev = _context4.next) {
-        case 0:
-          _context4.prev = 0;
-          _context4.next = 3;
-          return mediaClient.getImage(id, params, undefined, undefined, traceContext);
-        case 3:
-          blob = _context4.sent;
-          return _context4.abrupt("return", {
-            dataURI: URL.createObjectURL(blob),
-            orientation: 1,
-            source: 'remote'
-          });
-        case 7:
-          _context4.prev = 7;
-          _context4.t0 = _context4["catch"](0);
-          throw new RemotePreviewError('remote-preview-fetch', _context4.t0 instanceof Error ? _context4.t0 : undefined);
-        case 10:
-        case "end":
-          return _context4.stop();
-      }
-    }, _callee4, null, [[0, 7]]);
-  }));
-  return function getCardPreviewFromBackend(_x4, _x5, _x6, _x7) {
-    return _ref4.apply(this, arguments);
-  };
-}();