@atlaskit/media-client 14.3.1 → 15.0.0

package/CHANGELOG.md

@@ -1,5 +1,111 @@
 # @atlaskit/media-client
 
+## 15.0.0
+
+### Major Changes
+
+- [`fdc41ee7a0b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fdc41ee7a0b) - Stop exposing observableToPromise from media client API.
+  mediaSubscribableToPromise is used internally.
+- [`118f3af101f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/118f3af101f) - Media Client APIs has been updated to use MediaSubscribable which provides subscription functionality (similar to RxJs observables).
+  It exposes subscribe method that is called with MediaObserver as an argument and returns MediaSubscription.
+  MediaSubscription exposes unsubscribe method.
+
+  getFileState:
+  The returned type of this function has changed from RxJs ReplaySubject to MediaSubscribable.
+
+  ```
+  import { MediaClient, MediaObserver, MediaSubscribable, MediaSubscription } from '@atlaskit/media-client';
+
+  const mediaClient = new MediaClient({ authProvider });
+
+  const fileStateSubscribable: MediaSubscribable<FileState> = mediaClient.file.getFileState(id);
+
+  const mediaObserver: MediaObserver<FileState> = {
+    next: (fileState) => {
+      nextCallback(fileState)
+    },
+    error: (error) => {
+      errorCallback(error)
+    },
+  };
+
+  const subscription: MediaSubscription = fileStateSubscribable.subscribe(mediaObserver);
+
+  subscription.unsubscribe();
+  ```
+
+  upload:
+  The returned type of this function has changed from RxJs ReplaySubject to MediaSubscribable.
+
+  ```
+  import { MediaClient, MediaObserver, MediaSubscribable, MediaSubscription } from '@atlaskit/media-client';
+
+  const mediaClient = new MediaClient({ authProvider });
+
+  const uploadFileSubscribable: MediaSubscribable<FileState> = mediaClient.file.upload(uploadableFile);
+
+  const mediaObserver: MediaObserver<FileState> = {
+    next: (fileState) => {
+      nextCallback(fileState)
+    },
+    error: (error) => {
+      errorCallback(error)
+    },
+  };
+
+  const subscription: MediaSubscription = uploadFileSubscribable.subscribe(mediaObserver);
+
+  subscription.unsubscribe();
+  ```
+
+  getItems:
+  The returned type of this function has changed from RxJs ReplaySubject to MediaSubscribable.
+
+  ```
+  import { MediaClient, MediaObserver, MediaSubscribable, MediaSubscription } from '@atlaskit/media-client';
+
+  const mediaClient = new MediaClient({ authProvider });
+
+  const collectionItemsSubscribable: MediaSubscribable<MediaCollectionItem[]> = mediaClient.collection.getItems(collectionName);
+
+  const mediaObserver: MediaObserver<MediaCollectionItem[]> = {
+    next: (items) => {
+      nextCallback(items)
+    },
+    error: (error) => {
+      errorCallback(error)
+    },
+  };
+
+  const subscription: MediaSubscription = collectionItemsSubscribable.subscribe(mediaObserver);
+
+  subscription.unsubscribe();
+  ```
+
+### Minor Changes
+
+- [`f862d5ae7aa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f862d5ae7aa) - remove RxJs peer dependency
+
+### Patch Changes
+
+- Updated dependencies
+
+## 14.4.0
+
+### Minor Changes
+
+- [`7d2943a6038`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7d2943a6038) - Created MediaSubscribable wrapper around RxJs Observable
+
+### Patch Changes
+
+- Updated dependencies
+
+## 14.3.2
+
+### Patch Changes
+
+- [`59a14d364b1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/59a14d364b1) - Bump query-string@^6.14.1
+
 ## 14.3.1
 
 ### Patch Changes

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

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.CollectionFetcher = exports.collectionCache = void 0;
+exports.collectionCache = exports.CollectionFetcher = void 0;
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
@@ -25,9 +25,11 @@ var _fileStreamsCache = require("../file-streams-cache");
 
 var _fileState = require("../models/file-state");
 
-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 _toMediaSubscribable = require("../utils/toMediaSubscribable");
 
-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; }
+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; }
 
 var collectionCache = {};
 exports.collectionCache = collectionCache;
@@ -114,7 +116,7 @@ var CollectionFetcher = /*#__PURE__*/function () {
       }).catch(function (error) {
         return subject.error(error);
       });
-      return subject;
+      return (0, _toMediaSubscribable.toMediaSubscribable)(subject);
     }
   }, {
     key: "removeFile",

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

@@ -5,8 +5,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isFileFetcherError = isFileFetcherError;
 exports.FileFetcherError = void 0;
+exports.isFileFetcherError = isFileFetcherError;
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 

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

@@ -5,19 +5,19 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "isFileFetcherError", {
+Object.defineProperty(exports, "FileFetcherError", {
   enumerable: true,
   get: function get() {
-    return _error.isFileFetcherError;
+    return _error.FileFetcherError;
   }
 });
-Object.defineProperty(exports, "FileFetcherError", {
+exports.FileFetcherImpl = void 0;
+Object.defineProperty(exports, "isFileFetcherError", {
   enumerable: true,
   get: function get() {
-    return _error.FileFetcherError;
+    return _error.isFileFetcherError;
   }
 });
-exports.FileFetcherImpl = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -69,11 +69,11 @@ var _overrideMediaTypeIfUnknown = require("../../utils/overrideMediaTypeIfUnknow
 
 var _convertBase64ToBlob = require("../../utils/convertBase64ToBlob");
 
-var _observableToPromise = require("../../utils/observableToPromise");
+var _mediaSubscribableToPromise = require("../../utils/mediaSubscribableToPromise");
 
 var _getDimensionsFromBlob = require("../../utils/getDimensionsFromBlob");
 
-var _createFileStateSubject = require("../../utils/createFileStateSubject");
+var _createMediaSubject = require("../../utils/createMediaSubject");
 
 var _mediaTypeUtils = require("@atlaskit/media-common/mediaTypeUtils");
 
@@ -83,9 +83,11 @@ var _polling = require("../../utils/polling");
 
 var _detectEmptyFile = require("../../utils/detectEmptyFile");
 
-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 _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 = 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; }
+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; }
 
 var FileFetcherImpl = /*#__PURE__*/function () {
   function FileFetcherImpl(mediaStore) {
@@ -93,7 +95,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
 
     (0, _classCallCheck2.default)(this, FileFetcherImpl);
     (0, _defineProperty2.default)(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey) {
-      var subject = (0, _createFileStateSubject.createFileStateSubject)();
+      var subject = (0, _createMediaSubject.createMediaSubject)();
       var poll = new _polling.PollingFunction(); // ensure subject errors if polling exceeds max iterations or uncaught exception in executor
 
       poll.onError = function (error) {
@@ -175,22 +177,22 @@ var FileFetcherImpl = /*#__PURE__*/function () {
           occurrenceKey = options.occurrenceKey;
 
       if (!(0, _uuidValidate.default)(id)) {
-        var subject = (0, _createFileStateSubject.createFileStateSubject)();
+        var subject = (0, _createMediaSubject.createMediaSubject)();
         subject.error(new _error.FileFetcherError('invalidFileId', id, {
           collectionName: collectionName,
           occurrenceKey: occurrenceKey
         }));
-        return subject;
+        return (0, _toMediaSubscribable.toMediaSubscribable)(subject);
       }
 
-      return (0, _fileStreamsCache.getFileStreamsCache)().getOrInsert(id, function () {
+      return (0, _toMediaSubscribable.toMediaSubscribable)((0, _fileStreamsCache.getFileStreamsCache)().getOrInsert(id, function () {
         return _this2.createDownloadFileStream(id, collectionName);
-      });
+      }));
     }
   }, {
     key: "getCurrentState",
     value: function getCurrentState(id, options) {
-      return (0, _observableToPromise.observableToPromise)(this.getFileState(id, options));
+      return (0, _mediaSubscribableToPromise.mediaSubscribableToPromise)(this.getFileState(id, options));
     }
   }, {
     key: "getArtifactURL",
@@ -246,7 +248,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
               case 0:
                 uploadableFileUpfrontIds = this.generateUploadableFileUpfrontIds(collection);
                 id = uploadableFileUpfrontIds.id, occurrenceKey = uploadableFileUpfrontIds.occurrenceKey;
-                subject = (0, _createFileStateSubject.createFileStateSubject)();
+                subject = (0, _createMediaSubject.createMediaSubject)();
                 deferredBlob = fetch(url).then(function (response) {
                   return response.blob();
                 }).catch(function () {
@@ -408,7 +410,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
       var preview; // TODO [MSW-796]: get file size for base64
 
       var mediaType = (0, _getMediaTypeFromUploadableFile.getMediaTypeFromUploadableFile)(file);
-      var subject = (0, _createFileStateSubject.createFileStateSubject)();
+      var subject = (0, _createMediaSubject.createMediaSubject)();
       var processingSubscription = new _Subscription.Subscription();
 
       if (content instanceof Blob) {
@@ -480,7 +482,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
         });
       }
 
-      return subject;
+      return (0, _toMediaSubscribable.toMediaSubscribable)(subject);
     }
   }, {
     key: "downloadBinary",
@@ -610,7 +612,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
                   data: copiedFileWithMimeType
                 });
                 fileCache = cache.get(copiedId);
-                subject = fileCache || (0, _createFileStateSubject.createFileStateSubject)(); // if we were passed a "preview", we propagate it into the copiedFileState
+                subject = fileCache || (0, _createMediaSubject.createMediaSubject)(); // if we were passed a "preview", we propagate it into the copiedFileState
 
                 previewOverride = !(0, _fileState.isErrorFileState)(copiedFileState) && !!preview ? {
                   preview: preview
@@ -678,7 +680,7 @@ var FileFetcherImpl = /*#__PURE__*/function () {
                     _fileCache.error(_context6.t3);
                   } else {
                     // Create a new subject with the error state for new subscriptions
-                    cache.set(id, (0, _createFileStateSubject.createFileStateSubject)(_context6.t3));
+                    cache.set(id, (0, _createMediaSubject.createMediaSubject)(_context6.t3));
                   }
                 }
 

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

@@ -5,8 +5,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isMediaStoreError = isMediaStoreError;
 exports.MediaStoreError = void 0;
+exports.isMediaStoreError = isMediaStoreError;
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 

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

@@ -5,6 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.MediaStore = void 0;
 Object.defineProperty(exports, "MediaStoreError", {
   enumerable: true,
   get: function get() {
@@ -17,7 +18,6 @@ Object.defineProperty(exports, "isMediaStoreError", {
     return _error.isMediaStoreError;
   }
 });
-exports.MediaStore = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -41,9 +41,9 @@ var _resolveAuth = require("./resolveAuth");
 
 var _error = require("./error");
 
-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 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 = 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; }
+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; }
 
 var defaultImageOptions = {
   'max-age': _constants.FILE_CACHE_MAX_AGE,

package/dist/cjs/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.MAX_RESOLUTION = exports.FILE_CACHE_MAX_AGE = exports.RECENTS_COLLECTION = void 0;
+exports.RECENTS_COLLECTION = exports.MAX_RESOLUTION = exports.FILE_CACHE_MAX_AGE = void 0;
 var RECENTS_COLLECTION = 'recents';
 exports.RECENTS_COLLECTION = RECENTS_COLLECTION;
 var FILE_CACHE_MAX_AGE = 60 * 60 * 24 * 30; // Retain for 30 days

package/dist/cjs/identifier.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isDifferentIdentifier = exports.isExternalImageIdentifier = exports.isFileIdentifier = void 0;
+exports.isFileIdentifier = exports.isExternalImageIdentifier = exports.isDifferentIdentifier = void 0;
 
 var _deepEqual = _interopRequireDefault(require("deep-equal"));