@atlaskit/media-client 26.0.0 → 26.1.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/media-client
 
+## 26.1.0
+
+### Minor Changes
+
+- [#60253](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/60253) [`2d535695b891`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2d535695b891) - Exposed MediaApi type
+- [#60253](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/60253) [`662b6d273ec0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/662b6d273ec0) - Breaking change: Updated interface for Test Helper "createMockedMediaApi". This is not a production-code breaking change
+
 ## 26.0.0
 
 ### Major Changes

package/dist/cjs/test-helpers/MockedMediaApi/MockedMediaApi.js

@@ -9,7 +9,7 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _helpers = require("./helpers");
 var getMediaApi = function getMediaApi(_ref) {
-  var getFileItem = _ref.getFileItem;
+  var getItem = _ref.getItem;
   return {
     // --------------------------------------------------------
     // UPLOAD ENDPOINTS - None is supported
@@ -120,7 +120,7 @@ var getMediaApi = function getMediaApi(_ref) {
         return _regenerator.default.wrap(function _callee6$(_context6) {
           while (1) switch (_context6.prev = _context6.next) {
             case 0:
-              fileItem = getFileItem(fileId);
+              fileItem = getItem(fileId);
               if (fileItem) {
                 _context6.next = 3;
                 break;
@@ -148,7 +148,7 @@ var getMediaApi = function getMediaApi(_ref) {
           while (1) switch (_context7.prev = _context7.next) {
             case 0:
               items = ids.map(function (id) {
-                return getFileItem(id);
+                return getItem(id);
               }).filter(function (fileState) {
                 return !!fileState;
               });
@@ -218,7 +218,7 @@ var getMediaApi = function getMediaApi(_ref) {
         return _regenerator.default.wrap(function _callee10$(_context10) {
           while (1) switch (_context10.prev = _context10.next) {
             case 0:
-              fileItem = getFileItem(id);
+              fileItem = getItem(id);
               if (fileItem) {
                 _context10.next = 3;
                 break;
@@ -278,7 +278,7 @@ var getMediaApi = function getMediaApi(_ref) {
         return _regenerator.default.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
-              fileItem = getFileItem(fileId);
+              fileItem = getItem(fileId);
               if (fileItem) {
                 _context12.next = 3;
                 break;
@@ -315,7 +315,7 @@ var getMediaApi = function getMediaApi(_ref) {
           while (1) switch (_context13.prev = _context13.next) {
             case 0:
               fileId = body.sourceFile.id;
-              fileItem = getFileItem(fileId);
+              fileItem = getItem(fileId);
               if (fileItem) {
                 _context13.next = 4;
                 break;
@@ -408,25 +408,25 @@ var getMediaApi = function getMediaApi(_ref) {
  */
 var createMockedMediaApi = exports.createMockedMediaApi = function createMockedMediaApi(initialFileItems) {
   var storedFileItems = new Map();
-  var getFileItem = function getFileItem(fileId) {
+  var getItem = function getItem(fileId) {
     return storedFileItems.get(fileId);
   };
-  var setFileItems = function setFileItems(fileItems) {
+  var setItems = function setItems(fileItems) {
     var normalised = (0, _helpers.normaliseInput)(fileItems);
     normalised.forEach(function (fileItem) {
       return storedFileItems.set(fileItem.id, fileItem);
     });
   };
   if (initialFileItems) {
-    setFileItems(initialFileItems);
+    setItems(initialFileItems);
   }
   var mediaApi = getMediaApi({
-    setFileItems: setFileItems,
-    getFileItem: getFileItem
+    setItems: setItems,
+    getItem: getItem
   });
   return {
-    setFileItems: setFileItems,
-    getFileItem: getFileItem,
+    setItems: setItems,
+    getItem: getItem,
     mediaApi: mediaApi
   };
 };

package/dist/cjs/test-helpers/MockedMediaApi/helpers.js

@@ -146,7 +146,7 @@ var createFileState = exports.createFileState = function createFileState(_ref3)
     representations: representations
   };
 };
-var createUploadingFileState = exports.createUploadingFileState = function createUploadingFileState(_ref4, progress) {
+var createUploadingFileState = exports.createUploadingFileState = function createUploadingFileState(_ref4, progress, binary) {
   var id = _ref4.id,
     _ref4$details = _ref4.details,
     name = _ref4$details.name,
@@ -164,7 +164,7 @@ var createUploadingFileState = exports.createUploadingFileState = function creat
     mimeType: mimeType,
     createdAt: createdAt,
     preview: {
-      value: new Blob(['some-content'], {
+      value: binary || new Blob(['some-content'], {
         type: mimeType
       })
     }

package/dist/es2019/test-helpers/MockedMediaApi/MockedMediaApi.js

@@ -1,6 +1,6 @@
 import { getMediaFile, normaliseInput } from './helpers';
 const getMediaApi = ({
-  getFileItem
+  getItem
 }) => ({
   // --------------------------------------------------------
   // UPLOAD ENDPOINTS - None is supported
@@ -37,7 +37,7 @@ const getMediaApi = ({
   // --------------------------------------------------------
 
   getFile: async fileId => {
-    const fileItem = getFileItem(fileId);
+    const fileItem = getItem(fileId);
     if (!fileItem) {
       throw new Error('404 - MockedMediaApi.getFile: file not found');
     }
@@ -46,7 +46,7 @@ const getMediaApi = ({
     };
   },
   getItems: async ids => {
-    const items = ids.map(id => getFileItem(id)).filter(fileState => !!fileState);
+    const items = ids.map(id => getItem(id)).filter(fileState => !!fileState);
     return {
       data: {
         items
@@ -70,7 +70,7 @@ const getMediaApi = ({
     throw new Error('500 - MockedMediaApi.getFileImageURLSync: method not implemented');
   },
   getFileBinaryURL: async id => {
-    const fileItem = getFileItem(id);
+    const fileItem = getItem(id);
     if (!fileItem) {
       throw new Error('404 - MockedMediaApi.getFileBinaryURL: file not found');
     }
@@ -92,7 +92,7 @@ const getMediaApi = ({
   // BINARY ENDPOINTS
   // --------------------------------------------------------
   getImage: async fileId => {
-    const fileItem = getFileItem(fileId);
+    const fileItem = getItem(fileId);
     if (!fileItem) {
       throw new Error('404 - MockedMediaApi.getImage: file not found');
     }
@@ -110,7 +110,7 @@ const getMediaApi = ({
   // TODO
   copyFileWithToken: async body => {
     const fileId = body.sourceFile.id;
-    const fileItem = getFileItem(fileId);
+    const fileItem = getItem(fileId);
     if (!fileItem) {
       throw new Error('404 - MockedMediaApi.copyFileWithToken: file not found');
     }
@@ -141,21 +141,21 @@ const getMediaApi = ({
  */
 export const createMockedMediaApi = initialFileItems => {
   const storedFileItems = new Map();
-  const getFileItem = fileId => storedFileItems.get(fileId);
-  const setFileItems = fileItems => {
+  const getItem = fileId => storedFileItems.get(fileId);
+  const setItems = fileItems => {
     const normalised = normaliseInput(fileItems);
     normalised.forEach(fileItem => storedFileItems.set(fileItem.id, fileItem));
   };
   if (initialFileItems) {
-    setFileItems(initialFileItems);
+    setItems(initialFileItems);
   }
   const mediaApi = getMediaApi({
-    setFileItems,
-    getFileItem
+    setItems,
+    getItem
   });
   return {
-    setFileItems,
-    getFileItem,
+    setItems,
+    getItem,
     mediaApi
   };
 };

package/dist/es2019/test-helpers/MockedMediaApi/helpers.js

@@ -138,7 +138,7 @@ export const createUploadingFileState = ({
     mimeType,
     createdAt
   }
-}, progress) => ({
+}, progress, binary) => ({
   status: 'uploading',
   progress,
   id,
@@ -148,7 +148,7 @@ export const createUploadingFileState = ({
   mimeType,
   createdAt,
   preview: {
-    value: new Blob(['some-content'], {
+    value: binary || new Blob(['some-content'], {
       type: mimeType
     })
   }

package/dist/esm/test-helpers/MockedMediaApi/MockedMediaApi.js

@@ -2,7 +2,7 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { getMediaFile, normaliseInput } from './helpers';
 var getMediaApi = function getMediaApi(_ref) {
-  var getFileItem = _ref.getFileItem;
+  var getItem = _ref.getItem;
   return {
     // --------------------------------------------------------
     // UPLOAD ENDPOINTS - None is supported
@@ -113,7 +113,7 @@ var getMediaApi = function getMediaApi(_ref) {
         return _regeneratorRuntime.wrap(function _callee6$(_context6) {
           while (1) switch (_context6.prev = _context6.next) {
             case 0:
-              fileItem = getFileItem(fileId);
+              fileItem = getItem(fileId);
               if (fileItem) {
                 _context6.next = 3;
                 break;
@@ -141,7 +141,7 @@ var getMediaApi = function getMediaApi(_ref) {
           while (1) switch (_context7.prev = _context7.next) {
             case 0:
               items = ids.map(function (id) {
-                return getFileItem(id);
+                return getItem(id);
               }).filter(function (fileState) {
                 return !!fileState;
               });
@@ -211,7 +211,7 @@ var getMediaApi = function getMediaApi(_ref) {
         return _regeneratorRuntime.wrap(function _callee10$(_context10) {
           while (1) switch (_context10.prev = _context10.next) {
             case 0:
-              fileItem = getFileItem(id);
+              fileItem = getItem(id);
               if (fileItem) {
                 _context10.next = 3;
                 break;
@@ -271,7 +271,7 @@ var getMediaApi = function getMediaApi(_ref) {
         return _regeneratorRuntime.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
-              fileItem = getFileItem(fileId);
+              fileItem = getItem(fileId);
               if (fileItem) {
                 _context12.next = 3;
                 break;
@@ -308,7 +308,7 @@ var getMediaApi = function getMediaApi(_ref) {
           while (1) switch (_context13.prev = _context13.next) {
             case 0:
               fileId = body.sourceFile.id;
-              fileItem = getFileItem(fileId);
+              fileItem = getItem(fileId);
               if (fileItem) {
                 _context13.next = 4;
                 break;
@@ -401,25 +401,25 @@ var getMediaApi = function getMediaApi(_ref) {
  */
 export var createMockedMediaApi = function createMockedMediaApi(initialFileItems) {
   var storedFileItems = new Map();
-  var getFileItem = function getFileItem(fileId) {
+  var getItem = function getItem(fileId) {
     return storedFileItems.get(fileId);
   };
-  var setFileItems = function setFileItems(fileItems) {
+  var setItems = function setItems(fileItems) {
     var normalised = normaliseInput(fileItems);
     normalised.forEach(function (fileItem) {
       return storedFileItems.set(fileItem.id, fileItem);
     });
   };
   if (initialFileItems) {
-    setFileItems(initialFileItems);
+    setItems(initialFileItems);
   }
   var mediaApi = getMediaApi({
-    setFileItems: setFileItems,
-    getFileItem: getFileItem
+    setItems: setItems,
+    getItem: getItem
   });
   return {
-    setFileItems: setFileItems,
-    getFileItem: getFileItem,
+    setItems: setItems,
+    getItem: getItem,
     mediaApi: mediaApi
   };
 };

package/dist/esm/test-helpers/MockedMediaApi/helpers.js

@@ -138,7 +138,7 @@ export var createFileState = function createFileState(_ref3) {
     representations: representations
   };
 };
-export var createUploadingFileState = function createUploadingFileState(_ref4, progress) {
+export var createUploadingFileState = function createUploadingFileState(_ref4, progress, binary) {
   var id = _ref4.id,
     _ref4$details = _ref4.details,
     name = _ref4$details.name,
@@ -156,7 +156,7 @@ export var createUploadingFileState = function createUploadingFileState(_ref4, p
     mimeType: mimeType,
     createdAt: createdAt,
     preview: {
-      value: new Blob(['some-content'], {
+      value: binary || new Blob(['some-content'], {
         type: mimeType
       })
     }

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export { MediaStore, MediaStoreError, isMediaStoreError, getMediaEnvironment, getMediaRegion, } from './client/media-store';
-export type { ResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, TouchedFiles, EmptyFile, MediaStoreErrorReason, MediaStoreErrorAttributes, } from './client/media-store';
+export type { ResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, TouchedFiles, EmptyFile, MediaStoreErrorReason, MediaStoreErrorAttributes, MediaApi, } from './client/media-store';
 export { UploadController } from './upload-controller';
 export type { AbortFunction } from './upload-controller';
 export type { MediaItemType, FileItem, FileProcessingStatus, MediaArtifact, Artifacts, FileDetails, } from './models/item';

package/dist/types/test-helpers/MockedMediaApi/MockedMediaApi.d.ts

@@ -1,14 +1,14 @@
 import { MediaApi, ResponseFileItem } from '../../client/media-store';
-export interface SetFileItems {
-    (fileItems: ResponseFileItem | ResponseFileItem[]): void;
+export interface SetItems {
+    (fileItems?: ResponseFileItem | ResponseFileItem[]): void;
 }
-export interface GetFileItem {
+export interface GetItem {
     (id: string): ResponseFileItem | undefined;
 }
 export interface CreateMockedMediaApiResult {
     mediaApi: MediaApi;
-    setFileItems: SetFileItems;
-    getFileItem: GetFileItem;
+    setItems: SetItems;
+    getItem: GetItem;
 }
 /**
  * Mocked Media API

package/dist/types/test-helpers/MockedMediaApi/helpers.d.ts

@@ -19,5 +19,5 @@ export declare const copy: (fileItem: ResponseFileItem) => ResponseFileItem;
  */
 export declare const getIdentifier: (fileItem: ResponseFileItem) => FileIdentifier;
 export declare const createFileState: ({ id, details: { name, size, mediaType, mimeType, createdAt, processingStatus, artifacts, representations, }, }: ResponseFileItem) => FileState;
-export declare const createUploadingFileState: ({ id, details: { name, size, mediaType, mimeType, createdAt }, }: ResponseFileItem, progress: number) => UploadingFileState;
+export declare const createUploadingFileState: ({ id, details: { name, size, mediaType, mimeType, createdAt }, }: ResponseFileItem, progress: number, binary?: Blob) => UploadingFileState;
 export declare const createErrorFileState: ({ id, }: ResponseFileItem) => ErrorFileState;

package/dist/types/test-helpers/MockedMediaApi/index.d.ts

@@ -1,3 +1,3 @@
-export type { CreateMockedMediaApiResult, SetFileItems, GetFileItem, } from './MockedMediaApi';
+export type { CreateMockedMediaApiResult, SetItems, GetItem, } from './MockedMediaApi';
 export { createMockedMediaApi } from './MockedMediaApi';
 export { copy, getIdentifier, createEmptyFileItem, createUploadingFileState, createErrorFileState, createFileState, createProcessingFileItem, } from './helpers';

package/dist/types/test-helpers/index.d.ts

@@ -5,5 +5,5 @@ export { animatedFileId, archiveFileId, atlassianLogoUrl, audioFileDetails, audi
 export declare const authProviderBaseURL = "https://media.dev.atl-paas.net";
 export { mediaPickerAuthProvider, defaultMediaPickerAuthProvider, } from './mediaPickerAuthProvider';
 export { fakeMediaClient } from './fakeMediaClient';
-export type { CreateMockedMediaApiResult, SetFileItems, GetFileItem, } from './MockedMediaApi';
+export type { CreateMockedMediaApiResult, SetItems, GetItem, } from './MockedMediaApi';
 export { createMockedMediaApi, copy, getIdentifier, createProcessingFileItem, createEmptyFileItem, createUploadingFileState, createFileState, createErrorFileState, } from './MockedMediaApi';

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

@@ -1,5 +1,5 @@
 export { MediaStore, MediaStoreError, isMediaStoreError, getMediaEnvironment, getMediaRegion, } from './client/media-store';
-export type { ResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, TouchedFiles, EmptyFile, MediaStoreErrorReason, MediaStoreErrorAttributes, } from './client/media-store';
+export type { ResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, TouchedFiles, EmptyFile, MediaStoreErrorReason, MediaStoreErrorAttributes, MediaApi, } from './client/media-store';
 export { UploadController } from './upload-controller';
 export type { AbortFunction } from './upload-controller';
 export type { MediaItemType, FileItem, FileProcessingStatus, MediaArtifact, Artifacts, FileDetails, } from './models/item';

package/dist/types-ts4.5/test-helpers/MockedMediaApi/MockedMediaApi.d.ts

@@ -1,14 +1,14 @@
 import { MediaApi, ResponseFileItem } from '../../client/media-store';
-export interface SetFileItems {
-    (fileItems: ResponseFileItem | ResponseFileItem[]): void;
+export interface SetItems {
+    (fileItems?: ResponseFileItem | ResponseFileItem[]): void;
 }
-export interface GetFileItem {
+export interface GetItem {
     (id: string): ResponseFileItem | undefined;
 }
 export interface CreateMockedMediaApiResult {
     mediaApi: MediaApi;
-    setFileItems: SetFileItems;
-    getFileItem: GetFileItem;
+    setItems: SetItems;
+    getItem: GetItem;
 }
 /**
  * Mocked Media API

package/dist/types-ts4.5/test-helpers/MockedMediaApi/helpers.d.ts

@@ -19,5 +19,5 @@ export declare const copy: (fileItem: ResponseFileItem) => ResponseFileItem;
  */
 export declare const getIdentifier: (fileItem: ResponseFileItem) => FileIdentifier;
 export declare const createFileState: ({ id, details: { name, size, mediaType, mimeType, createdAt, processingStatus, artifacts, representations, }, }: ResponseFileItem) => FileState;
-export declare const createUploadingFileState: ({ id, details: { name, size, mediaType, mimeType, createdAt }, }: ResponseFileItem, progress: number) => UploadingFileState;
+export declare const createUploadingFileState: ({ id, details: { name, size, mediaType, mimeType, createdAt }, }: ResponseFileItem, progress: number, binary?: Blob) => UploadingFileState;
 export declare const createErrorFileState: ({ id, }: ResponseFileItem) => ErrorFileState;

package/dist/types-ts4.5/test-helpers/MockedMediaApi/index.d.ts

@@ -1,3 +1,3 @@
-export type { CreateMockedMediaApiResult, SetFileItems, GetFileItem, } from './MockedMediaApi';
+export type { CreateMockedMediaApiResult, SetItems, GetItem, } from './MockedMediaApi';
 export { createMockedMediaApi } from './MockedMediaApi';
 export { copy, getIdentifier, createEmptyFileItem, createUploadingFileState, createErrorFileState, createFileState, createProcessingFileItem, } from './helpers';

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

@@ -5,5 +5,5 @@ export { animatedFileId, archiveFileId, atlassianLogoUrl, audioFileDetails, audi
 export declare const authProviderBaseURL = "https://media.dev.atl-paas.net";
 export { mediaPickerAuthProvider, defaultMediaPickerAuthProvider, } from './mediaPickerAuthProvider';
 export { fakeMediaClient } from './fakeMediaClient';
-export type { CreateMockedMediaApiResult, SetFileItems, GetFileItem, } from './MockedMediaApi';
+export type { CreateMockedMediaApiResult, SetItems, GetItem, } from './MockedMediaApi';
 export { createMockedMediaApi, copy, getIdentifier, createProcessingFileItem, createEmptyFileItem, createUploadingFileState, createFileState, createErrorFileState, } from './MockedMediaApi';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-client",
-  "version": "26.0.0",
+  "version": "26.1.0",
   "description": "Media API Web Client Library",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -58,7 +58,7 @@
     "@atlaskit/media-core": "^34.1.0",
     "@atlaskit/media-state": "^1.0.0",
     "@atlaskit/ssr": "*",
-    "@atlaskit/tokens": "^1.29.0",
+    "@atlaskit/tokens": "^1.30.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@emotion/react": "^11.7.1",
     "@types/deep-equal": "^1.0.1",