@atlaskit/media-client 25.0.2 → 25.0.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/media-client
 
+## 25.0.3
+
+### Patch Changes
+
+- [#43076](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43076) [`43317a91142`](https://bitbucket.org/atlassian/atlassian-frontend/commits/43317a91142) - Added new internal interface MediaApi
+
 ## 25.0.2
 
 ### Patch Changes

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

@@ -0,0 +1,631 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getMediaRegion = exports.getMediaEnvironment = exports.MediaStore = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _mediaCommon = require("@atlaskit/media-common");
+var _constants = require("../../constants");
+var _artifacts = require("../../models/artifacts");
+var _request3 = require("../../utils/request");
+var _helpers = require("../../utils/request/helpers");
+var _resolveAuth = require("./resolveAuth");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var MEDIA_API_REGION = 'media-api-region';
+var MEDIA_API_ENVIRONMENT = 'media-api-environment';
+var defaultImageOptions = {
+  'max-age': _constants.FILE_CACHE_MAX_AGE,
+  allowAnimated: true,
+  mode: 'crop'
+};
+var extendImageParams = function extendImageParams(params) {
+  var fetchMaxRes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  return _objectSpread(_objectSpread(_objectSpread({}, defaultImageOptions), params), fetchMaxRes ? {
+    width: _constants.MAX_RESOLUTION,
+    height: _constants.MAX_RESOLUTION
+  } : {});
+};
+var jsonHeaders = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+};
+var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
+  function MediaStore(config) {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, MediaStore);
+    (0, _defineProperty2.default)(this, "resolveAuth", function (authContext) {
+      return (0, _resolveAuth.resolveAuth)(_this.config.authProvider, authContext);
+    });
+    (0, _defineProperty2.default)(this, "resolveInitialAuth", function () {
+      return (0, _resolveAuth.resolveInitialAuth)(_this.config.initialAuth);
+    });
+    this.config = config;
+  }
+  (0, _createClass2.default)(MediaStore, [{
+    key: "removeCollectionFile",
+    value: function () {
+      var _removeCollectionFile = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(id, collectionName, occurrenceKey, traceContext) {
+        var metadata, body, options;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              metadata = {
+                method: 'PUT',
+                endpoint: '/collection/{collectionName}'
+              };
+              body = {
+                actions: [{
+                  action: 'remove',
+                  item: {
+                    type: 'file',
+                    id: id,
+                    occurrenceKey: occurrenceKey
+                  }
+                }]
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: collectionName
+                },
+                headers: {
+                  Accept: 'application/json',
+                  'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(body),
+                traceContext: traceContext
+              });
+              _context.next = 5;
+              return this.request("/collection/".concat(collectionName), options);
+            case 5:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function removeCollectionFile(_x, _x2, _x3, _x4) {
+        return _removeCollectionFile.apply(this, arguments);
+      }
+      return removeCollectionFile;
+    }()
+  }, {
+    key: "createUpload",
+    value: function createUpload() {
+      var createUpTo = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+      var collectionName = arguments.length > 1 ? arguments[1] : undefined;
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
+      var metadata = {
+        method: 'POST',
+        endpoint: '/upload'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        authContext: {
+          collectionName: collectionName
+        },
+        params: {
+          createUpTo: createUpTo
+        },
+        headers: {
+          Accept: 'application/json'
+        },
+        traceContext: traceContext
+      });
+      return this.request("/upload", options).then((0, _helpers.createMapResponseToJson)(metadata));
+    }
+  }, {
+    key: "uploadChunk",
+    value: function () {
+      var _uploadChunk = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(etag, blob, uploadId, partNumber, collectionName, traceContext) {
+        var metadata, options;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              metadata = {
+                method: 'PUT',
+                endpoint: '/chunk/{etag}'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                params: {
+                  uploadId: uploadId,
+                  partNumber: partNumber
+                },
+                authContext: {
+                  collectionName: collectionName
+                },
+                body: blob,
+                traceContext: traceContext
+              });
+              _context2.next = 4;
+              return this.request("/chunk/".concat(etag), options);
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this);
+      }));
+      function uploadChunk(_x5, _x6, _x7, _x8, _x9, _x10) {
+        return _uploadChunk.apply(this, arguments);
+      }
+      return uploadChunk;
+    }()
+  }, {
+    key: "probeChunks",
+    value: function probeChunks(chunks, uploadId, collectionName, traceContext) {
+      var metadata = {
+        method: 'POST',
+        endpoint: '/chunk/probe'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        params: {
+          uploadId: uploadId
+        },
+        authContext: {
+          collectionName: collectionName
+        },
+        headers: jsonHeaders,
+        body: JSON.stringify({
+          chunks: chunks
+        }),
+        traceContext: traceContext
+      });
+      return this.request("/chunk/probe", options).then((0, _helpers.createMapResponseToJson)(metadata));
+    }
+  }, {
+    key: "createFileFromUpload",
+    value: function createFileFromUpload(body) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
+      var metadata = {
+        method: 'POST',
+        endpoint: '/file/upload'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        authContext: {
+          collectionName: params.collection
+        },
+        params: params,
+        headers: jsonHeaders,
+        body: JSON.stringify(body),
+        traceContext: traceContext
+      });
+      return this.request('/file/upload', options).then((0, _helpers.createMapResponseToJson)(metadata));
+    }
+  }, {
+    key: "getRejectedResponseFromDescriptor",
+    value: function getRejectedResponseFromDescriptor(descriptor, limit) {
+      return {
+        fileId: descriptor.fileId,
+        error: {
+          code: 'ExceedMaxFileSizeLimit',
+          title: 'The expected file size exceeded the maximum size limit.',
+          href: 'https://dt-api-filestore--app.ap-southeast-2.dev.atl-paas.net/api.html#BadRequest',
+          limit: limit,
+          size: descriptor.size
+        }
+      };
+    }
+  }, {
+    key: "touchFiles",
+    value: function () {
+      var _touchFiles = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(body) {
+        var params,
+          traceContext,
+          metadata,
+          options,
+          _args3 = arguments;
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              params = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+              traceContext = _args3.length > 2 ? _args3[2] : undefined;
+              metadata = {
+                method: 'POST',
+                endpoint: '/upload/createWithFiles'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: params.collection
+                },
+                headers: jsonHeaders,
+                body: JSON.stringify(body),
+                traceContext: traceContext
+              });
+              return _context3.abrupt("return", this.request('/upload/createWithFiles', options).then((0, _helpers.createMapResponseToJson)(metadata)));
+            case 5:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this);
+      }));
+      function touchFiles(_x11) {
+        return _touchFiles.apply(this, arguments);
+      }
+      return touchFiles;
+    }()
+  }, {
+    key: "getFile",
+    value: function getFile(fileId) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
+      var metadata = {
+        method: 'GET',
+        endpoint: '/file/{fileId}'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        authContext: {
+          collectionName: params.collection
+        },
+        params: params,
+        traceContext: traceContext
+      });
+      return this.request("/file/".concat(fileId), options).then((0, _helpers.createMapResponseToJson)(metadata));
+    }
+  }, {
+    key: "getFileImageURL",
+    value: function () {
+      var _getFileImageURL = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id, params) {
+        var _ref, collectionName, auth;
+        return _regenerator.default.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              _ref = params || {}, collectionName = _ref.collection;
+              _context4.next = 3;
+              return this.resolveAuth({
+                collectionName: collectionName
+              });
+            case 3:
+              auth = _context4.sent;
+              return _context4.abrupt("return", this.createFileImageURL(id, auth, params));
+            case 5:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, this);
+      }));
+      function getFileImageURL(_x12, _x13) {
+        return _getFileImageURL.apply(this, arguments);
+      }
+      return getFileImageURL;
+    }() // TODO Create ticket in case Trace Id can be supported through query params
+  }, {
+    key: "getFileImageURLSync",
+    value: function getFileImageURLSync(id, params) {
+      var auth = this.resolveInitialAuth();
+      return this.createFileImageURL(id, auth, params);
+    }
+  }, {
+    key: "createFileImageURL",
+    value: function createFileImageURL(id, auth, params) {
+      var options = {
+        params: extendImageParams(params),
+        auth: auth
+      };
+      return (0, _helpers.createUrl)("".concat(auth.baseUrl, "/file/").concat(id, "/image"), options);
+    }
+  }, {
+    key: "getFileBinaryURL",
+    value: function () {
+      var _getFileBinaryURL = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id, collectionName) {
+        var auth, options;
+        return _regenerator.default.wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
+            case 0:
+              _context5.next = 2;
+              return this.resolveAuth({
+                collectionName: collectionName
+              });
+            case 2:
+              auth = _context5.sent;
+              options = {
+                params: {
+                  dl: true,
+                  collection: collectionName,
+                  'max-age': _constants.FILE_CACHE_MAX_AGE
+                },
+                auth: auth
+              };
+              return _context5.abrupt("return", (0, _helpers.createUrl)("".concat(auth.baseUrl, "/file/").concat(id, "/binary"), options));
+            case 5:
+            case "end":
+              return _context5.stop();
+          }
+        }, _callee5, this);
+      }));
+      function getFileBinaryURL(_x14, _x15) {
+        return _getFileBinaryURL.apply(this, arguments);
+      }
+      return getFileBinaryURL;
+    }()
+  }, {
+    key: "getArtifactURL",
+    value: function () {
+      var _getArtifactURL = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(artifacts, artifactName, collectionName) {
+        var artifactUrl, auth, options;
+        return _regenerator.default.wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
+            case 0:
+              artifactUrl = (0, _artifacts.getArtifactUrl)(artifacts, artifactName);
+              if (artifactUrl) {
+                _context6.next = 3;
+                break;
+              }
+              throw new Error("artifact ".concat(artifactName, " not found"));
+            case 3:
+              _context6.next = 5;
+              return this.resolveAuth({
+                collectionName: collectionName
+              });
+            case 5:
+              auth = _context6.sent;
+              options = {
+                params: {
+                  collection: collectionName,
+                  'max-age': _constants.FILE_CACHE_MAX_AGE
+                },
+                auth: auth
+              };
+              return _context6.abrupt("return", (0, _helpers.createUrl)("".concat(auth.baseUrl).concat(artifactUrl), options));
+            case 8:
+            case "end":
+              return _context6.stop();
+          }
+        }, _callee6, this);
+      }));
+      function getArtifactURL(_x16, _x17, _x18) {
+        return _getArtifactURL.apply(this, arguments);
+      }
+      return getArtifactURL;
+    }()
+  }, {
+    key: "getImage",
+    value: function () {
+      var _getImage = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(id, params, controller, fetchMaxRes, traceContext) {
+        var isWebpSupported, headers, metadata, options;
+        return _regenerator.default.wrap(function _callee7$(_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
+            case 0:
+              // TODO add checkWebpSupport() back https://product-fabric.atlassian.net/browse/MPT-584
+              isWebpSupported = false;
+              headers = {};
+              if (isWebpSupported) {
+                headers.accept = 'image/webp,image/*,*/*;q=0.8';
+              }
+              metadata = {
+                method: 'GET',
+                endpoint: '/file/{fileId}/image'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: params && params.collection
+                },
+                params: extendImageParams(params, fetchMaxRes),
+                headers: headers,
+                traceContext: traceContext
+              });
+              return _context7.abrupt("return", this.request("/file/".concat(id, "/image"), options, controller).then((0, _helpers.createMapResponseToBlob)(metadata)));
+            case 6:
+            case "end":
+              return _context7.stop();
+          }
+        }, _callee7, this);
+      }));
+      function getImage(_x19, _x20, _x21, _x22, _x23) {
+        return _getImage.apply(this, arguments);
+      }
+      return getImage;
+    }()
+  }, {
+    key: "getItems",
+    value: function () {
+      var _getItems = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(ids, collectionName, traceContext) {
+        var descriptors, metadata, options;
+        return _regenerator.default.wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
+            case 0:
+              descriptors = ids.map(function (id) {
+                return {
+                  type: 'file',
+                  id: id,
+                  collection: collectionName
+                };
+              });
+              metadata = {
+                method: 'POST',
+                endpoint: '/items'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: collectionName
+                },
+                headers: jsonHeaders,
+                body: JSON.stringify({
+                  descriptors: descriptors
+                }),
+                traceContext: traceContext
+              });
+              return _context8.abrupt("return", this.request('/items', options).then((0, _helpers.createMapResponseToJson)(metadata)));
+            case 4:
+            case "end":
+              return _context8.stop();
+          }
+        }, _callee8, this);
+      }));
+      function getItems(_x24, _x25, _x26) {
+        return _getItems.apply(this, arguments);
+      }
+      return getItems;
+    }()
+  }, {
+    key: "getImageMetadata",
+    value: function () {
+      var _getImageMetadata = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(id, params, traceContext) {
+        var metadata, options;
+        return _regenerator.default.wrap(function _callee9$(_context9) {
+          while (1) switch (_context9.prev = _context9.next) {
+            case 0:
+              metadata = {
+                method: 'GET',
+                endpoint: '/file/{fileId}/image/metadata'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: params && params.collection
+                },
+                params: params,
+                traceContext: traceContext
+              });
+              return _context9.abrupt("return", this.request("/file/".concat(id, "/image/metadata"), options).then((0, _helpers.createMapResponseToJson)(metadata)));
+            case 3:
+            case "end":
+              return _context9.stop();
+          }
+        }, _callee9, this);
+      }));
+      function getImageMetadata(_x27, _x28, _x29) {
+        return _getImageMetadata.apply(this, arguments);
+      }
+      return getImageMetadata;
+    }()
+  }, {
+    key: "appendChunksToUpload",
+    value: function () {
+      var _appendChunksToUpload = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(uploadId, body, collectionName, traceContext) {
+        var metadata, options;
+        return _regenerator.default.wrap(function _callee10$(_context10) {
+          while (1) switch (_context10.prev = _context10.next) {
+            case 0:
+              metadata = {
+                method: 'PUT',
+                endpoint: '/upload/{uploadId}/chunks'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: collectionName
+                },
+                headers: jsonHeaders,
+                body: JSON.stringify(body),
+                traceContext: traceContext
+              });
+              _context10.next = 4;
+              return this.request("/upload/".concat(uploadId, "/chunks"), options);
+            case 4:
+            case "end":
+              return _context10.stop();
+          }
+        }, _callee10, this);
+      }));
+      function appendChunksToUpload(_x30, _x31, _x32, _x33) {
+        return _appendChunksToUpload.apply(this, arguments);
+      }
+      return appendChunksToUpload;
+    }()
+  }, {
+    key: "copyFileWithToken",
+    value: function copyFileWithToken(body, params, traceContext) {
+      var metadata = {
+        method: 'POST',
+        endpoint: '/file/copy/withToken'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        authContext: {
+          collectionName: params.collection
+        },
+        // Contains collection name to write to
+        params: params,
+        // Contains collection name to write to
+        headers: jsonHeaders,
+        body: JSON.stringify(body),
+        // Contains collection name to read from
+        traceContext: traceContext
+      });
+      return this.request('/file/copy/withToken', options).then((0, _helpers.createMapResponseToJson)(metadata));
+    }
+  }, {
+    key: "request",
+    value: function () {
+      var _request2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(path) {
+        var options,
+          controller,
+          method,
+          endpoint,
+          authContext,
+          params,
+          headers,
+          body,
+          clientOptions,
+          traceContext,
+          auth,
+          extendedTraceContext,
+          response,
+          _args11 = arguments;
+        return _regenerator.default.wrap(function _callee11$(_context11) {
+          while (1) switch (_context11.prev = _context11.next) {
+            case 0:
+              options = _args11.length > 1 && _args11[1] !== undefined ? _args11[1] : {
+                method: 'GET',
+                endpoint: undefined,
+                authContext: {}
+              };
+              controller = _args11.length > 2 ? _args11[2] : undefined;
+              method = options.method, endpoint = options.endpoint, authContext = options.authContext, params = options.params, headers = options.headers, body = options.body, clientOptions = options.clientOptions, traceContext = options.traceContext;
+              _context11.next = 5;
+              return this.resolveAuth(authContext);
+            case 5:
+              auth = _context11.sent;
+              extendedTraceContext = traceContext ? _objectSpread(_objectSpread({}, traceContext), {}, {
+                spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || (0, _mediaCommon.getRandomHex)(8)
+              }) : undefined;
+              _context11.next = 9;
+              return (0, _request3.request)("".concat(auth.baseUrl).concat(path), {
+                method: method,
+                endpoint: endpoint,
+                auth: auth,
+                params: params,
+                headers: headers,
+                body: body,
+                clientOptions: clientOptions,
+                traceContext: extendedTraceContext
+              }, controller);
+            case 9:
+              response = _context11.sent;
+              setKeyValueInSessionStorage(MEDIA_API_REGION, response.headers.get('x-media-region'));
+              setKeyValueInSessionStorage(MEDIA_API_ENVIRONMENT, response.headers.get('x-media-env'));
+              return _context11.abrupt("return", response);
+            case 13:
+            case "end":
+              return _context11.stop();
+          }
+        }, _callee11, this);
+      }));
+      function request(_x34) {
+        return _request2.apply(this, arguments);
+      }
+      return request;
+    }()
+  }]);
+  return MediaStore;
+}();
+var getValueFromSessionStorage = function getValueFromSessionStorage(key) {
+  return window && window.sessionStorage && window.sessionStorage.getItem(key) || undefined;
+};
+var setKeyValueInSessionStorage = function setKeyValueInSessionStorage(key, value) {
+  if (!value || !(window && window.sessionStorage)) {
+    return;
+  }
+  var currentValue = window.sessionStorage.getItem(key);
+  if (currentValue !== value) {
+    window.sessionStorage.setItem(key, value);
+  }
+};
+var getMediaEnvironment = exports.getMediaEnvironment = function getMediaEnvironment() {
+  return getValueFromSessionStorage(MEDIA_API_ENVIRONMENT);
+};
+var getMediaRegion = exports.getMediaRegion = function getMediaRegion() {
+  return getValueFromSessionStorage(MEDIA_API_REGION);
+};