@atlaskit/media-client 28.1.0 → 28.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/media-client
 
+## 28.2.0
+
+### Minor Changes
+
+- [`6099ac032dd30`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/6099ac032dd30) -
+  Added viewerOptions to override file preview renderer in media components
+
 ## 28.1.0
 
 ### Minor Changes

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

@@ -308,7 +308,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getFileBinary",
     value: function () {
-      var _getFileBinary = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id, collectionName) {
+      var _getFileBinary = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id, collectionName, abortController) {
         var maxAge,
           headers,
           binaryEndpoint,
@@ -318,7 +318,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee5$(_context5) {
           while (1) switch (_context5.prev = _context5.next) {
             case 0:
-              maxAge = _args5.length > 2 && _args5[2] !== undefined ? _args5[2] : _constants.FILE_CACHE_MAX_AGE;
+              maxAge = _args5.length > 3 && _args5[3] !== undefined ? _args5[3] : _constants.FILE_CACHE_MAX_AGE;
               headers = {};
               binaryEndpoint = cdnFeatureFlag('binary');
               metadata = {
@@ -335,14 +335,14 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
                   'max-age': "".concat(maxAge)
                 }
               });
-              return _context5.abrupt("return", this.request("/file/".concat(id, "/").concat(binaryEndpoint), options, undefined, true).then((0, _helpers.createMapResponseToBlob)(metadata)));
+              return _context5.abrupt("return", this.request("/file/".concat(id, "/").concat(binaryEndpoint), options, abortController, true).then((0, _helpers.createMapResponseToBlob)(metadata)));
             case 6:
             case "end":
               return _context5.stop();
           }
         }, _callee5, this);
       }));
-      function getFileBinary(_x14, _x15) {
+      function getFileBinary(_x14, _x15, _x16) {
         return _getFileBinary.apply(this, arguments);
       }
       return getFileBinary;
@@ -382,7 +382,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee6, this);
       }));
-      function getFileBinaryURL(_x16, _x17) {
+      function getFileBinaryURL(_x17, _x18) {
         return _getFileBinaryURL.apply(this, arguments);
       }
       return getFileBinaryURL;
@@ -422,7 +422,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee7, this);
       }));
-      function getArtifactURL(_x18, _x19, _x20) {
+      function getArtifactURL(_x19, _x20, _x21) {
         return _getArtifactURL.apply(this, arguments);
       }
       return getArtifactURL;
@@ -462,7 +462,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee8, this);
       }));
-      function getImage(_x21, _x22, _x23, _x24, _x25) {
+      function getImage(_x22, _x23, _x24, _x25, _x26) {
         return _getImage.apply(this, arguments);
       }
       return getImage;
@@ -503,7 +503,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee9, this);
       }));
-      function getItems(_x26, _x27, _x28) {
+      function getItems(_x27, _x28, _x29) {
         return _getItems.apply(this, arguments);
       }
       return getItems;
@@ -534,7 +534,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee10, this);
       }));
-      function getImageMetadata(_x29, _x30, _x31) {
+      function getImageMetadata(_x30, _x31, _x32) {
         return _getImageMetadata.apply(this, arguments);
       }
       return getImageMetadata;
@@ -567,7 +567,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee11, this);
       }));
-      function appendChunksToUpload(_x32, _x33, _x34, _x35) {
+      function appendChunksToUpload(_x33, _x34, _x35, _x36) {
         return _appendChunksToUpload.apply(this, arguments);
       }
       return appendChunksToUpload;
@@ -662,7 +662,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee12, this);
       }));
-      function request(_x36) {
+      function request(_x37) {
         return _request2.apply(this, arguments);
       }
       return request;

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

@@ -200,7 +200,7 @@ export class MediaStore {
     const imageEndpoint = cdnFeatureFlag('image');
     return mapToMediaCdnUrl(createUrl(`${auth.baseUrl}/file/${id}/${imageEndpoint}`, options), auth.token);
   }
-  async getFileBinary(id, collectionName, maxAge = FILE_CACHE_MAX_AGE) {
+  async getFileBinary(id, collectionName, abortController, maxAge = FILE_CACHE_MAX_AGE) {
     const headers = {};
     const binaryEndpoint = cdnFeatureFlag('binary');
     const metadata = {
@@ -218,7 +218,7 @@ export class MediaStore {
         'max-age': `${maxAge}`
       }
     };
-    return this.request(`/file/${id}/${binaryEndpoint}`, options, undefined, true).then(createMapResponseToBlob(metadata));
+    return this.request(`/file/${id}/${binaryEndpoint}`, options, abortController, true).then(createMapResponseToBlob(metadata));
   }
   async getFileBinaryURL(id, collectionName, maxAge = FILE_CACHE_MAX_AGE) {
     const auth = await this.resolveAuth({

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

@@ -302,7 +302,7 @@ export var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getFileBinary",
     value: function () {
-      var _getFileBinary = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(id, collectionName) {
+      var _getFileBinary = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(id, collectionName, abortController) {
         var maxAge,
           headers,
           binaryEndpoint,
@@ -312,7 +312,7 @@ export var MediaStore = /*#__PURE__*/function () {
         return _regeneratorRuntime.wrap(function _callee5$(_context5) {
           while (1) switch (_context5.prev = _context5.next) {
             case 0:
-              maxAge = _args5.length > 2 && _args5[2] !== undefined ? _args5[2] : FILE_CACHE_MAX_AGE;
+              maxAge = _args5.length > 3 && _args5[3] !== undefined ? _args5[3] : FILE_CACHE_MAX_AGE;
               headers = {};
               binaryEndpoint = cdnFeatureFlag('binary');
               metadata = {
@@ -329,14 +329,14 @@ export var MediaStore = /*#__PURE__*/function () {
                   'max-age': "".concat(maxAge)
                 }
               });
-              return _context5.abrupt("return", this.request("/file/".concat(id, "/").concat(binaryEndpoint), options, undefined, true).then(createMapResponseToBlob(metadata)));
+              return _context5.abrupt("return", this.request("/file/".concat(id, "/").concat(binaryEndpoint), options, abortController, true).then(createMapResponseToBlob(metadata)));
             case 6:
             case "end":
               return _context5.stop();
           }
         }, _callee5, this);
       }));
-      function getFileBinary(_x14, _x15) {
+      function getFileBinary(_x14, _x15, _x16) {
         return _getFileBinary.apply(this, arguments);
       }
       return getFileBinary;
@@ -376,7 +376,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee6, this);
       }));
-      function getFileBinaryURL(_x16, _x17) {
+      function getFileBinaryURL(_x17, _x18) {
         return _getFileBinaryURL.apply(this, arguments);
       }
       return getFileBinaryURL;
@@ -416,7 +416,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee7, this);
       }));
-      function getArtifactURL(_x18, _x19, _x20) {
+      function getArtifactURL(_x19, _x20, _x21) {
         return _getArtifactURL.apply(this, arguments);
       }
       return getArtifactURL;
@@ -456,7 +456,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee8, this);
       }));
-      function getImage(_x21, _x22, _x23, _x24, _x25) {
+      function getImage(_x22, _x23, _x24, _x25, _x26) {
         return _getImage.apply(this, arguments);
       }
       return getImage;
@@ -497,7 +497,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee9, this);
       }));
-      function getItems(_x26, _x27, _x28) {
+      function getItems(_x27, _x28, _x29) {
         return _getItems.apply(this, arguments);
       }
       return getItems;
@@ -528,7 +528,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee10, this);
       }));
-      function getImageMetadata(_x29, _x30, _x31) {
+      function getImageMetadata(_x30, _x31, _x32) {
         return _getImageMetadata.apply(this, arguments);
       }
       return getImageMetadata;
@@ -561,7 +561,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee11, this);
       }));
-      function appendChunksToUpload(_x32, _x33, _x34, _x35) {
+      function appendChunksToUpload(_x33, _x34, _x35, _x36) {
         return _appendChunksToUpload.apply(this, arguments);
       }
       return appendChunksToUpload;
@@ -656,7 +656,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee12, this);
       }));
-      function request(_x36) {
+      function request(_x37) {
         return _request2.apply(this, arguments);
       }
       return request;

package/dist/types/client/media-store/MediaStore.d.ts

@@ -18,7 +18,7 @@ export declare class MediaStore implements MediaApi {
     getFileImageURL(id: string, params?: MediaStoreGetFileImageParams): Promise<string>;
     getFileImageURLSync(id: string, params?: MediaStoreGetFileImageParams): string;
     private createFileImageURL;
-    getFileBinary(id: string, collectionName?: string, maxAge?: number): Promise<Blob>;
+    getFileBinary(id: string, collectionName?: string, abortController?: AbortController, maxAge?: number): Promise<Blob>;
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
     getArtifactURL(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string): Promise<string>;
     getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;

package/dist/types/client/media-store/types.d.ts

@@ -156,7 +156,7 @@ export interface MediaApi {
     getFile: (fileId: string, params: MediaStoreGetFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
     getFileImageURL: (id: string, params?: MediaStoreGetFileImageParams) => Promise<string>;
     getFileImageURLSync: (id: string, params?: MediaStoreGetFileImageParams) => string;
-    getFileBinary: (id: string, collectionName?: string) => Promise<Blob>;
+    getFileBinary: (id: string, collectionName?: string, abortController?: AbortController) => Promise<Blob>;
     getFileBinaryURL: (id: string, collectionName?: string) => Promise<string>;
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
     getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;

package/dist/types-ts4.5/client/media-store/MediaStore.d.ts

@@ -18,7 +18,7 @@ export declare class MediaStore implements MediaApi {
     getFileImageURL(id: string, params?: MediaStoreGetFileImageParams): Promise<string>;
     getFileImageURLSync(id: string, params?: MediaStoreGetFileImageParams): string;
     private createFileImageURL;
-    getFileBinary(id: string, collectionName?: string, maxAge?: number): Promise<Blob>;
+    getFileBinary(id: string, collectionName?: string, abortController?: AbortController, maxAge?: number): Promise<Blob>;
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
     getArtifactURL(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string): Promise<string>;
     getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;

package/dist/types-ts4.5/client/media-store/types.d.ts

@@ -156,7 +156,7 @@ export interface MediaApi {
     getFile: (fileId: string, params: MediaStoreGetFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
     getFileImageURL: (id: string, params?: MediaStoreGetFileImageParams) => Promise<string>;
     getFileImageURLSync: (id: string, params?: MediaStoreGetFileImageParams) => string;
-    getFileBinary: (id: string, collectionName?: string) => Promise<Blob>;
+    getFileBinary: (id: string, collectionName?: string, abortController?: AbortController) => Promise<Blob>;
     getFileBinaryURL: (id: string, collectionName?: string) => Promise<string>;
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
     getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "28.1.0",
+	"version": "28.2.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"