@atlaskit/media-client 16.0.1 → 17.1.1

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @atlaskit/media-client
 
+## 17.1.1
+
+### Patch Changes
+
+- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
+- Updated dependencies
+
+## 17.1.0
+
+### Minor Changes
+
+- [`c07a8176ddf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c07a8176ddf) - New BlobType SlicedBlob that includes partnumber introduced and used for uploading chunks
+- [`a2e6bd37426`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a2e6bd37426) - add uploadId to prob function to support new media upload api
+
+### Patch Changes
+
+- [`e80f52696fe`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e80f52696fe) - Migrated styled-components to emotion
+- [`de9dc9e7cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/de9dc9e7cbd) - Renamed internal helpers and files
+- Updated dependencies
+
+## 17.0.0
+
+### Major Changes
+
+- [`a718050239e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a718050239e) - Media Client Uploader enforces a hard limit of 2Tb files.
+
+  To mitigate these changes:
+
+  - Set the feature flag mediaUploadApiV2 as false or Revert to a previous version for affected consumers and methods;
+    Media Client uploadFile method.
+    Media Client File Fetcher upload method.
+    Media Picker.
+
+- [`e4d0b89cd8b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e4d0b89cd8b) - Additional parameters and changes to the way parameters are passed to MediaStore.uploadChunk and MediaStore.probeChunks.
+- [`d07442a7ff7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d07442a7ff7) - Breaking change to media-client uploadFile method, chunkSize and processingBatchSize as parameters removed from uploadFile.
+
+### Patch Changes
+
+- [`61cf857a95a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/61cf857a95a) - A util function for dynamically calculating chunkSizes.
+- Updated dependencies
+
 ## 16.0.1
 
 ### Patch Changes

package/dist/cjs/client/collection-fetcher.js

@@ -7,10 +7,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.collectionCache = exports.CollectionFetcher = void 0;
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
@@ -25,7 +25,7 @@ var _fileStreamsCache = require("../file-streams-cache");
 
 var _fileState = require("../models/file-state");
 
-var _toMediaSubscribable = require("../utils/toMediaSubscribable");
+var _mediaSubscribable = require("../utils/mediaSubscribable");
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -116,7 +116,7 @@ var CollectionFetcher = /*#__PURE__*/function () {
       }).catch(function (error) {
         return subject.error(error);
       });
-      return (0, _toMediaSubscribable.toMediaSubscribable)(subject);
+      return (0, _mediaSubscribable.fromObservable)(subject);
     }
   }, {
     key: "removeFile",

package/dist/cjs/client/file-fetcher/index.js

@@ -69,7 +69,7 @@ var _overrideMediaTypeIfUnknown = require("../../utils/overrideMediaTypeIfUnknow
 
 var _convertBase64ToBlob = require("../../utils/convertBase64ToBlob");
 
-var _mediaSubscribableToPromise = require("../../utils/mediaSubscribableToPromise");
+var _mediaSubscribable = require("../../utils/mediaSubscribable");
 
 var _getDimensionsFromBlob = require("../../utils/getDimensionsFromBlob");
 
@@ -83,8 +83,6 @@ var _polling = require("../../utils/polling");
 
 var _detectEmptyFile = require("../../utils/detectEmptyFile");
 
-var _toMediaSubscribable = require("../../utils/toMediaSubscribable");
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -182,17 +180,17 @@ var FileFetcherImpl = /*#__PURE__*/function () {
           collectionName: collectionName,
           occurrenceKey: occurrenceKey
         }));
-        return (0, _toMediaSubscribable.toMediaSubscribable)(subject);
+        return (0, _mediaSubscribable.fromObservable)(subject);
       }
 
-      return (0, _toMediaSubscribable.toMediaSubscribable)((0, _fileStreamsCache.getFileStreamsCache)().getOrInsert(id, function () {
+      return (0, _mediaSubscribable.fromObservable)((0, _fileStreamsCache.getFileStreamsCache)().getOrInsert(id, function () {
         return _this2.createDownloadFileStream(id, collectionName);
       }));
     }
   }, {
     key: "getCurrentState",
     value: function getCurrentState(id, options) {
-      return (0, _mediaSubscribableToPromise.mediaSubscribableToPromise)(this.getFileState(id, options));
+      return (0, _mediaSubscribable.toPromise)(this.getFileState(id, options));
     }
   }, {
     key: "getArtifactURL",
@@ -480,7 +478,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
         });
       }
 
-      return (0, _toMediaSubscribable.toMediaSubscribable)(subject);
+      return (0, _mediaSubscribable.fromObservable)(subject);
     }
   }, {
     key: "downloadBinary",

package/dist/cjs/client/media-store/index.js

@@ -225,26 +225,38 @@ var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "uploadChunk",
     value: function () {
-      var _uploadChunk = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(etag, blob, collectionName) {
-        var metadata, options;
+      var _uploadChunk = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(etag, blob) {
+        var _ref,
+            collectionName,
+            uploadId,
+            partNumber,
+            metadata,
+            options,
+            _args3 = arguments;
+
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) {
             switch (_context3.prev = _context3.next) {
               case 0:
+                _ref = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : {}, collectionName = _ref.collectionName, uploadId = _ref.uploadId, partNumber = _ref.partNumber;
                 metadata = {
                   method: 'PUT',
                   endpoint: '/chunk/{etag}'
                 };
                 options = _objectSpread(_objectSpread({}, metadata), {}, {
+                  params: {
+                    uploadId: uploadId,
+                    partNumber: partNumber
+                  },
                   authContext: {
                     collectionName: collectionName
                   },
                   body: blob
                 });
-                _context3.next = 4;
+                _context3.next = 5;
                 return this.request("/chunk/".concat(etag), options);
 
-              case 4:
+              case 5:
               case "end":
                 return _context3.stop();
             }
@@ -252,7 +264,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee3, this);
       }));
 
-      function uploadChunk(_x6, _x7, _x8) {
+      function uploadChunk(_x6, _x7) {
         return _uploadChunk.apply(this, arguments);
       }
 
@@ -260,13 +272,20 @@ var MediaStore = /*#__PURE__*/function () {
     }()
   }, {
     key: "probeChunks",
-    value: function probeChunks(chunks, collectionName) {
+    value: function probeChunks(chunks) {
+      var _ref2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+          collectionName = _ref2.collectionName,
+          uploadId = _ref2.uploadId;
+
       var metadata = {
         method: 'POST',
         endpoint: '/chunk/probe'
       };
 
       var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        params: {
+          uploadId: uploadId
+        },
         authContext: {
           collectionName: collectionName
         },
@@ -339,13 +358,13 @@ var MediaStore = /*#__PURE__*/function () {
     key: "getFileImageURL",
     value: function () {
       var _getFileImageURL = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id, params) {
-        var _ref, collectionName, auth;
+        var _ref3, collectionName, auth;
 
         return _regenerator.default.wrap(function _callee4$(_context4) {
           while (1) {
             switch (_context4.prev = _context4.next) {
               case 0:
-                _ref = params || {}, collectionName = _ref.collection;
+                _ref3 = params || {}, collectionName = _ref3.collection;
                 _context4.next = 3;
                 return this.resolveAuth({
                   collectionName: collectionName
@@ -363,7 +382,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee4, this);
       }));
 
-      function getFileImageURL(_x9, _x10) {
+      function getFileImageURL(_x8, _x9) {
         return _getFileImageURL.apply(this, arguments);
       }
 
@@ -418,7 +437,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee5, this);
       }));
 
-      function getFileBinaryURL(_x11, _x12) {
+      function getFileBinaryURL(_x10, _x11) {
         return _getFileBinaryURL.apply(this, arguments);
       }
 
@@ -467,7 +486,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee6, this);
       }));
 
-      function getArtifactURL(_x13, _x14, _x15) {
+      function getArtifactURL(_x12, _x13, _x14) {
         return _getArtifactURL.apply(this, arguments);
       }
 
@@ -512,7 +531,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee7, this);
       }));
 
-      function getImage(_x16, _x17, _x18, _x19) {
+      function getImage(_x15, _x16, _x17, _x18) {
         return _getImage.apply(this, arguments);
       }
 
@@ -557,7 +576,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee8, this);
       }));
 
-      function getItems(_x20, _x21) {
+      function getItems(_x19, _x20) {
         return _getItems.apply(this, arguments);
       }
 
@@ -592,7 +611,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee9, this);
       }));
 
-      function getImageMetadata(_x22, _x23) {
+      function getImageMetadata(_x21, _x22) {
         return _getImageMetadata.apply(this, arguments);
       }
 
@@ -629,7 +648,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee10, this);
       }));
 
-      function appendChunksToUpload(_x24, _x25, _x26) {
+      function appendChunksToUpload(_x23, _x24, _x25) {
         return _appendChunksToUpload.apply(this, arguments);
       }
 
@@ -714,7 +733,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee11, this);
       }));
 
-      function request(_x27) {
+      function request(_x26) {
         return _request2.apply(this, arguments);
       }
 

package/dist/cjs/constants.js

@@ -3,11 +3,20 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.RECENTS_COLLECTION = exports.MAX_RESOLUTION = exports.FILE_CACHE_MAX_AGE = void 0;
+exports.RECENTS_COLLECTION = exports.PROCESSING_BATCH_SIZE = exports.MAX_UPLOAD_FILE_SIZE = exports.MAX_RESOLUTION = exports.FILE_CACHE_MAX_AGE = exports.CHUNK_SIZE = void 0;
+
+var _media = require("./models/media");
+
 var RECENTS_COLLECTION = 'recents';
 exports.RECENTS_COLLECTION = RECENTS_COLLECTION;
 var FILE_CACHE_MAX_AGE = 60 * 60 * 24 * 30; // Retain for 30 days
 
 exports.FILE_CACHE_MAX_AGE = FILE_CACHE_MAX_AGE;
 var MAX_RESOLUTION = 4096;
-exports.MAX_RESOLUTION = MAX_RESOLUTION;
+exports.MAX_RESOLUTION = MAX_RESOLUTION;
+var CHUNK_SIZE = 4 * _media.DATA_UNIT.MB;
+exports.CHUNK_SIZE = CHUNK_SIZE;
+var PROCESSING_BATCH_SIZE = 1000;
+exports.PROCESSING_BATCH_SIZE = PROCESSING_BATCH_SIZE;
+var MAX_UPLOAD_FILE_SIZE = 2 * _media.DATA_UNIT.TB;
+exports.MAX_UPLOAD_FILE_SIZE = MAX_UPLOAD_FILE_SIZE;

package/dist/cjs/index.js

@@ -108,7 +108,7 @@ Object.defineProperty(exports, "createMediaSubject", {
 Object.defineProperty(exports, "createMediaSubscribable", {
   enumerable: true,
   get: function get() {
-    return _toMediaSubscribable.createMediaSubscribable;
+    return _mediaSubscribable.createMediaSubscribable;
   }
 });
 Object.defineProperty(exports, "createUrl", {
@@ -417,7 +417,7 @@ var _globalMediaEventEmitter = require("./globalMediaEventEmitter");
 
 var _url = require("./utils/url");
 
-var _toMediaSubscribable = require("./utils/toMediaSubscribable");
+var _mediaSubscribable = require("./utils/mediaSubscribable");
 
 var _constants = require("./constants");
 

package/dist/cjs/models/media.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isPreviewableType = exports.isMediaCollectionItemFullDetails = void 0;
+exports.isPreviewableType = exports.isMediaCollectionItemFullDetails = exports.DATA_UNIT = void 0;
 
 var _mediaCommon = require("@atlaskit/media-common");
 
@@ -24,4 +24,12 @@ var isMediaCollectionItemFullDetails = function isMediaCollectionItemFullDetails
   return !!mediaCollectionItem['mediaType'] && !!mediaCollectionItem['mimeType'] && !!mediaCollectionItem['processingStatus'];
 };
 
-exports.isMediaCollectionItemFullDetails = isMediaCollectionItemFullDetails;
+exports.isMediaCollectionItemFullDetails = isMediaCollectionItemFullDetails;
+var DATA_UNIT;
+exports.DATA_UNIT = DATA_UNIT;
+
+(function (DATA_UNIT) {
+  DATA_UNIT[DATA_UNIT["MB"] = 1048576] = "MB";
+  DATA_UNIT[DATA_UNIT["GB"] = 1073741824] = "GB";
+  DATA_UNIT[DATA_UNIT["TB"] = 1099511627776] = "TB";
+})(DATA_UNIT || (exports.DATA_UNIT = DATA_UNIT = {}));

package/dist/cjs/uploader/calculateChunkSize.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fileSizeError = exports.calculateChunkSize = void 0;
+
+var _media = require("../models/media");
+
+var _constants = require("../constants");
+
+var fileSizeError = 'fileSizeExceedsLimit';
+/**
+ * This is a helper to dynamically calculate the chunk size for a given file size.
+ *
+ * @param fileSize The size of a file to calculate the chunk size for.
+ * @returns A number of bytes per chunk or Throws an Error if the file size exceeds 2TB
+ *
+ * @see {@link https://product-fabric.atlassian.net/wiki/spaces/FIL/pages/3221881143/Rule+of+thumb+for+chunk+sizes#Given-the-following-conditions}
+ *
+ */
+
+exports.fileSizeError = fileSizeError;
+
+var calculateChunkSize = function calculateChunkSize(fileSize) {
+  if (fileSize > _constants.MAX_UPLOAD_FILE_SIZE) {
+    throw new Error(fileSizeError);
+  }
+
+  if (fileSize <= 5 * _media.DATA_UNIT.GB) {
+    return 5 * _media.DATA_UNIT.MB;
+  }
+
+  if (fileSize > 5 * _media.DATA_UNIT.GB && fileSize <= 50 * _media.DATA_UNIT.GB) {
+    return 50 * _media.DATA_UNIT.MB;
+  }
+
+  if (fileSize > 50 * _media.DATA_UNIT.GB && fileSize <= 0.95 * _media.DATA_UNIT.TB) {
+    return 100 * _media.DATA_UNIT.MB;
+  }
+
+  return 210 * _media.DATA_UNIT.MB;
+};
+
+exports.calculateChunkSize = calculateChunkSize;

package/dist/cjs/uploader/error.js

@@ -0,0 +1,67 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UploaderError = void 0;
+exports.isUploaderError = isUploaderError;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+
+var _errors = require("../models/errors");
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+var UploaderError = /*#__PURE__*/function (_BaseMediaClientError) {
+  (0, _inherits2.default)(UploaderError, _BaseMediaClientError);
+
+  var _super = _createSuper(UploaderError);
+
+  function UploaderError(reason, id, metadata) {
+    var _this;
+
+    (0, _classCallCheck2.default)(this, UploaderError);
+    _this = _super.call(this, reason);
+    _this.reason = reason;
+    _this.id = id;
+    _this.metadata = metadata;
+    return _this;
+  }
+
+  (0, _createClass2.default)(UploaderError, [{
+    key: "attributes",
+    get: function get() {
+      var reason = this.reason,
+          id = this.id,
+          _this$metadata = this.metadata;
+      _this$metadata = _this$metadata === void 0 ? {} : _this$metadata;
+      var collectionName = _this$metadata.collectionName,
+          occurrenceKey = _this$metadata.occurrenceKey;
+      return {
+        reason: reason,
+        id: id,
+        collectionName: collectionName,
+        occurrenceKey: occurrenceKey
+      };
+    }
+  }]);
+  return UploaderError;
+}(_errors.BaseMediaClientError);
+
+exports.UploaderError = UploaderError;
+
+function isUploaderError(err) {
+  return err instanceof UploaderError;
+}