@atlaskit/media-client 30.0.0 → 31.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/media-client
 
+## 31.0.0
+
+### Major Changes
+
+- [#104917](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/104917)
+  [`f5b9e90ce5043`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/f5b9e90ce5043) -
+  changed useFileHashes to take an array of identifiers which it will then pre-emptively fetch
+  metadata when it detects duplicates with missing hashes
+
+### Minor Changes
+
+- [#104917](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/104917)
+  [`4c1c65faff476`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4c1c65faff476) -
+  Adding forceRefresh to fileState request to enable removing cache and forcing the refetching of
+  meta-data
+
 ## 30.0.0
 
 ### Major Changes

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

@@ -86,7 +86,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
       });
     });
     // TODO: ----- ADD TICKET TO PASS TRACE ID to this.dataloader.load
-    (0, _defineProperty2.default)(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey, includeHashForDuplicateFiles) {
+    (0, _defineProperty2.default)(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey, includeHashForDuplicateFiles, forceRefresh) {
       var subject = (0, _createMediaSubject.createMediaSubject)();
       var poll = new _polling.PollingFunction();
 
@@ -99,16 +99,23 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.next = 2;
+              if (forceRefresh) {
+                _this.dataloader.clear({
+                  id: id,
+                  collectionName: collectionName,
+                  includeHashForDuplicateFiles: includeHashForDuplicateFiles
+                });
+              }
+              _context.next = 3;
               return _this.dataloader.load({
                 id: id,
                 collectionName: collectionName,
                 includeHashForDuplicateFiles: includeHashForDuplicateFiles
               });
-            case 2:
+            case 3:
               response = _context.sent;
               if (!(0, _media.isNotFoundMediaItemDetails)(response)) {
-                _context.next = 5;
+                _context.next = 6;
                 break;
               }
               throw new _error.FileFetcherError('emptyItems', {
@@ -117,9 +124,9 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                 occurrenceKey: occurrenceKey,
                 traceContext: response.metadataTraceContext
               });
-            case 5:
+            case 6:
               if (!(0, _detectEmptyFile.isEmptyFile)(response)) {
-                _context.next = 7;
+                _context.next = 8;
                 break;
               }
               throw new _error.FileFetcherError('zeroVersionFile', {
@@ -128,20 +135,20 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                 occurrenceKey: occurrenceKey,
                 traceContext: response.metadataTraceContext
               });
-            case 7:
+            case 8:
               fileState = (0, _fileState2.mapMediaItemToFileState)(id, response);
               subject.next(fileState);
               _context.t0 = fileState.status;
-              _context.next = _context.t0 === 'processing' ? 12 : _context.t0 === 'processed' ? 14 : 16;
+              _context.next = _context.t0 === 'processing' ? 13 : _context.t0 === 'processed' ? 15 : 17;
               break;
-            case 12:
+            case 13:
               // the only case for continuing polling, otherwise this function is run once only
               poll.next();
-              return _context.abrupt("break", 16);
-            case 14:
+              return _context.abrupt("break", 17);
+            case 15:
               subject.complete();
-              return _context.abrupt("break", 16);
-            case 16:
+              return _context.abrupt("break", 17);
+            case 17:
             case "end":
               return _context.stop();
           }
@@ -194,7 +201,8 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
       var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var collectionName = options.collectionName,
         occurrenceKey = options.occurrenceKey,
-        includeHashForDuplicateFiles = options.includeHashForDuplicateFiles;
+        includeHashForDuplicateFiles = options.includeHashForDuplicateFiles,
+        forceRefresh = options.forceRefresh;
       if (!(0, _uuidValidate.default)(id)) {
         var subject = (0, _createMediaSubject.createMediaSubject)();
         var err = new _error.FileFetcherError('invalidFileId', {
@@ -207,8 +215,11 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
         this.setFileState(id, errorFileState);
         return (0, _mediaSubscribable.fromObservable)(subject);
       }
+      if (forceRefresh) {
+        (0, _fileStreamsCache.getFileStreamsCache)().remove(id);
+      }
       return (0, _mediaSubscribable.fromObservable)((0, _fileStreamsCache.getFileStreamsCache)().getOrInsert(id, function () {
-        var subject = _this2.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles);
+        var subject = _this2.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles, forceRefresh);
         subject.subscribe({
           next: function next(fileState) {
             _this2.setFileState(id, fileState);

package/dist/cjs/index.js

@@ -249,6 +249,12 @@ Object.defineProperty(exports, "isMediaStoreError", {
     return _mediaStore.isMediaStoreError;
   }
 });
+Object.defineProperty(exports, "isNonErrorFinalFileState", {
+  enumerable: true,
+  get: function get() {
+    return _fileState.isNonErrorFinalFileState;
+  }
+});
 Object.defineProperty(exports, "isPollingError", {
   enumerable: true,
   get: function get() {

package/dist/cjs/models/file-state.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.mapMediaItemToFileState = exports.mapMediaFileToFileState = exports.isUploadingFileState = exports.isProcessingFileState = exports.isProcessedFileState = exports.isPreviewableFileState = exports.isImageRepresentationReady = exports.isFinalFileState = exports.isErrorFileState = void 0;
+exports.mapMediaItemToFileState = exports.mapMediaFileToFileState = exports.isUploadingFileState = exports.isProcessingFileState = exports.isProcessedFileState = exports.isPreviewableFileState = exports.isNonErrorFinalFileState = exports.isImageRepresentationReady = exports.isFinalFileState = exports.isErrorFileState = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 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; }
@@ -26,6 +26,9 @@ var isPreviewableFileState = exports.isPreviewableFileState = function isPreview
 var isFinalFileState = exports.isFinalFileState = function isFinalFileState(fileState) {
   return ['processed', 'failed-processing', 'error'].includes(fileState.status);
 };
+var isNonErrorFinalFileState = exports.isNonErrorFinalFileState = function isNonErrorFinalFileState(fileState) {
+  return ['processed', 'failed-processing'].includes(fileState.status);
+};
 var isImageRepresentationReady = exports.isImageRepresentationReady = function isImageRepresentationReady(fileState) {
   switch (fileState.status) {
     case 'processing':

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

@@ -55,13 +55,20 @@ export class FileFetcherImpl {
       });
     });
     // TODO: ----- ADD TICKET TO PASS TRACE ID to this.dataloader.load
-    _defineProperty(this, "createDownloadFileStream", (id, collectionName, occurrenceKey, includeHashForDuplicateFiles) => {
+    _defineProperty(this, "createDownloadFileStream", (id, collectionName, occurrenceKey, includeHashForDuplicateFiles, forceRefresh) => {
       const subject = createMediaSubject();
       const poll = new PollingFunction();
 
       // ensure subject errors if polling exceeds max iterations or uncaught exception in executor
       poll.onError = error => subject.error(error);
       poll.execute(async () => {
+        if (forceRefresh) {
+          this.dataloader.clear({
+            id,
+            collectionName,
+            includeHashForDuplicateFiles
+          });
+        }
         const response = await this.dataloader.load({
           id,
           collectionName,
@@ -142,7 +149,8 @@ export class FileFetcherImpl {
     const {
       collectionName,
       occurrenceKey,
-      includeHashForDuplicateFiles
+      includeHashForDuplicateFiles,
+      forceRefresh
     } = options;
     if (!isValidId(id)) {
       const subject = createMediaSubject();
@@ -156,8 +164,11 @@ export class FileFetcherImpl {
       this.setFileState(id, errorFileState);
       return fromObservable(subject);
     }
+    if (forceRefresh) {
+      getFileStreamsCache().remove(id);
+    }
     return fromObservable(getFileStreamsCache().getOrInsert(id, () => {
-      const subject = this.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles);
+      const subject = this.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles, forceRefresh);
       subject.subscribe({
         next: fileState => {
           this.setFileState(id, fileState);

package/dist/es2019/index.js

@@ -3,7 +3,7 @@ export { UploadController } from './upload-controller';
 export { isPreviewableType } from './models/media';
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
 export { uploadFile } from './uploader';
 export { request, RequestError, isRequestError, isRateLimitedError, createRequestErrorReason } from './utils/request';
 export { isAbortedRequestError, createUrl } from './utils/request/helpers';

package/dist/es2019/models/file-state.js

@@ -4,6 +4,7 @@ export const isProcessedFileState = fileState => fileState.status === 'processed
 export const isErrorFileState = fileState => fileState.status === 'error';
 export const isPreviewableFileState = fileState => !isErrorFileState(fileState) && !!fileState.preview;
 export const isFinalFileState = fileState => ['processed', 'failed-processing', 'error'].includes(fileState.status);
+export const isNonErrorFinalFileState = fileState => ['processed', 'failed-processing'].includes(fileState.status);
 export const isImageRepresentationReady = fileState => {
   switch (fileState.status) {
     case 'processing':

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

@@ -68,7 +68,7 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
       });
     });
     // TODO: ----- ADD TICKET TO PASS TRACE ID to this.dataloader.load
-    _defineProperty(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey, includeHashForDuplicateFiles) {
+    _defineProperty(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey, includeHashForDuplicateFiles, forceRefresh) {
       var subject = createMediaSubject();
       var poll = new PollingFunction();
 
@@ -81,16 +81,23 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.next = 2;
+              if (forceRefresh) {
+                _this.dataloader.clear({
+                  id: id,
+                  collectionName: collectionName,
+                  includeHashForDuplicateFiles: includeHashForDuplicateFiles
+                });
+              }
+              _context.next = 3;
               return _this.dataloader.load({
                 id: id,
                 collectionName: collectionName,
                 includeHashForDuplicateFiles: includeHashForDuplicateFiles
               });
-            case 2:
+            case 3:
               response = _context.sent;
               if (!isNotFoundMediaItemDetails(response)) {
-                _context.next = 5;
+                _context.next = 6;
                 break;
               }
               throw new FileFetcherError('emptyItems', {
@@ -99,9 +106,9 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
                 occurrenceKey: occurrenceKey,
                 traceContext: response.metadataTraceContext
               });
-            case 5:
+            case 6:
               if (!isEmptyFile(response)) {
-                _context.next = 7;
+                _context.next = 8;
                 break;
               }
               throw new FileFetcherError('zeroVersionFile', {
@@ -110,20 +117,20 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
                 occurrenceKey: occurrenceKey,
                 traceContext: response.metadataTraceContext
               });
-            case 7:
+            case 8:
               fileState = mapMediaItemToFileState(id, response);
               subject.next(fileState);
               _context.t0 = fileState.status;
-              _context.next = _context.t0 === 'processing' ? 12 : _context.t0 === 'processed' ? 14 : 16;
+              _context.next = _context.t0 === 'processing' ? 13 : _context.t0 === 'processed' ? 15 : 17;
               break;
-            case 12:
+            case 13:
               // the only case for continuing polling, otherwise this function is run once only
               poll.next();
-              return _context.abrupt("break", 16);
-            case 14:
+              return _context.abrupt("break", 17);
+            case 15:
               subject.complete();
-              return _context.abrupt("break", 16);
-            case 16:
+              return _context.abrupt("break", 17);
+            case 17:
             case "end":
               return _context.stop();
           }
@@ -176,7 +183,8 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
       var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var collectionName = options.collectionName,
         occurrenceKey = options.occurrenceKey,
-        includeHashForDuplicateFiles = options.includeHashForDuplicateFiles;
+        includeHashForDuplicateFiles = options.includeHashForDuplicateFiles,
+        forceRefresh = options.forceRefresh;
       if (!isValidId(id)) {
         var subject = createMediaSubject();
         var err = new FileFetcherError('invalidFileId', {
@@ -189,8 +197,11 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
         this.setFileState(id, errorFileState);
         return fromObservable(subject);
       }
+      if (forceRefresh) {
+        getFileStreamsCache().remove(id);
+      }
       return fromObservable(getFileStreamsCache().getOrInsert(id, function () {
-        var subject = _this2.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles);
+        var subject = _this2.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles, forceRefresh);
         subject.subscribe({
           next: function next(fileState) {
             _this2.setFileState(id, fileState);

package/dist/esm/index.js

@@ -3,7 +3,7 @@ export { UploadController } from './upload-controller';
 export { isPreviewableType } from './models/media';
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
 export { uploadFile } from './uploader';
 export { request, RequestError, isRequestError, isRateLimitedError, createRequestErrorReason } from './utils/request';
 export { isAbortedRequestError, createUrl } from './utils/request/helpers';

package/dist/esm/models/file-state.js

@@ -19,6 +19,9 @@ export var isPreviewableFileState = function isPreviewableFileState(fileState) {
 export var isFinalFileState = function isFinalFileState(fileState) {
   return ['processed', 'failed-processing', 'error'].includes(fileState.status);
 };
+export var isNonErrorFinalFileState = function isNonErrorFinalFileState(fileState) {
+  return ['processed', 'failed-processing'].includes(fileState.status);
+};
 export var isImageRepresentationReady = function isImageRepresentationReady(fileState) {
   switch (fileState.status) {
     case 'processing':

package/dist/types/index.d.ts

@@ -8,7 +8,7 @@ export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentati
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
 export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';
 export type { FileState, FilePreview, ErrorFileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ProcessingFailedState, MediaFileArtifact, MediaFileArtifacts, } from '@atlaskit/media-state';
 export type { MobileUpload, MobileUploadStartEvent, MobileUploadProgressEvent, MobileUploadEndEvent, MobileUploadErrorEvent, } from './models/mobile-upload';

package/dist/types/models/file-state.d.ts

@@ -10,6 +10,7 @@ export interface GetFileOptions {
     collectionName?: string;
     occurrenceKey?: string;
     includeHashForDuplicateFiles?: boolean;
+    forceRefresh?: boolean;
 }
 export interface PreviewableFileState {
     preview: FilePreview | Promise<FilePreview>;
@@ -21,6 +22,7 @@ export declare const isProcessedFileState: (fileState: FileState) => fileState i
 export declare const isErrorFileState: (fileState: FileState) => fileState is ErrorFileState;
 export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
 export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ErrorFileState | ProcessingFailedState;
+export declare const isNonErrorFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState;
 export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
 export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;
 export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;

package/dist/types-ts4.5/index.d.ts

@@ -8,7 +8,7 @@ export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentati
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
 export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';
 export type { FileState, FilePreview, ErrorFileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ProcessingFailedState, MediaFileArtifact, MediaFileArtifacts, } from '@atlaskit/media-state';
 export type { MobileUpload, MobileUploadStartEvent, MobileUploadProgressEvent, MobileUploadEndEvent, MobileUploadErrorEvent, } from './models/mobile-upload';

package/dist/types-ts4.5/models/file-state.d.ts

@@ -10,6 +10,7 @@ export interface GetFileOptions {
     collectionName?: string;
     occurrenceKey?: string;
     includeHashForDuplicateFiles?: boolean;
+    forceRefresh?: boolean;
 }
 export interface PreviewableFileState {
     preview: FilePreview | Promise<FilePreview>;
@@ -21,6 +22,7 @@ export declare const isProcessedFileState: (fileState: FileState) => fileState i
 export declare const isErrorFileState: (fileState: FileState) => fileState is ErrorFileState;
 export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
 export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ErrorFileState | ProcessingFailedState;
+export declare const isNonErrorFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState;
 export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
 export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;
 export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "30.0.0",
+	"version": "31.0.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -57,7 +57,7 @@
 		"@atlaskit/media-core": "^34.4.0",
 		"@atlaskit/media-state": "^1.5.0",
 		"@atlaskit/ssr": "*",
-		"@atlaskit/tokens": "^3.1.0",
+		"@atlaskit/tokens": "^3.2.0",
 		"@atlassian/feature-flags-test-utils": "0.2.3",
 		"@emotion/react": "^11.7.1",
 		"@types/deep-equal": "^1.0.1",