@atlaskit/media-client 34.2.0 → 35.1.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/media-client
 
+## 35.1.0
+
+### Minor Changes
+
+- [#185135](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/185135)
+  [`3d2527a53b492`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3d2527a53b492) -
+  Add media metadata fields to relevant types/mappings
+
+### Patch Changes
+
+- Updated dependencies
+
+## 35.0.0
+
+### Major Changes
+
+- [#179845](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/179845)
+  [`8a03175bb502a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8a03175bb502a) -
+  Updated Delete Artifact interface
+
 ## 34.2.0
 
 ### Minor Changes

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

@@ -219,19 +219,19 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
       };
     }());
     (0, _defineProperty2.default)(this, "deleteArtifact", /*#__PURE__*/function () {
-      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(id, params, collectionName, traceContext) {
+      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(id, artifactName, collectionName, traceContext) {
         var file, updatedArtifacts, updatedFileState;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               _context3.next = 2;
-              return _this.mediaApi.deleteArtifact(id, params, collectionName, traceContext);
+              return _this.mediaApi.deleteArtifact(id, artifactName, collectionName, traceContext);
             case 2:
               // Manually remove the artifact from file state instead of re-requesting the entire payload.
               file = _this.store.getState().files[id];
               if (file && file.status === 'processed' && file.artifacts) {
                 updatedArtifacts = _objectSpread({}, file.artifacts);
-                delete updatedArtifacts[params.artifactName];
+                delete updatedArtifacts[artifactName];
                 updatedFileState = _objectSpread(_objectSpread({}, file), {}, {
                   artifacts: updatedArtifacts
                 });

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

@@ -125,7 +125,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
       };
     }());
     (0, _defineProperty2.default)(this, "deleteArtifact", /*#__PURE__*/function () {
-      var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(id, params, collectionName, traceContext) {
+      var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(id, artifactName, collectionName, traceContext) {
         var metadata, authContext, options;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
@@ -144,10 +144,13 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
               };
               options = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: authContext,
-                traceContext: traceContext
+                traceContext: traceContext,
+                params: {
+                  collection: collectionName
+                }
               });
               _context3.next = 5;
-              return _this.request("/file/".concat(id, "/artifact/").concat(params.artifactName), options);
+              return _this.request("/file/".concat(id, "/artifact/").concat(artifactName), options);
             case 5:
             case "end":
               return _context3.stop();

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

@@ -55,7 +55,8 @@ var mapMediaFileToFileState = exports.mapMediaFileToFileState = function mapMedi
     createdAt = _mediaFile$data.createdAt,
     metadataTraceContext = _mediaFile$data.metadataTraceContext,
     hash = _mediaFile$data.hash,
-    abuseClassification = _mediaFile$data.abuseClassification;
+    abuseClassification = _mediaFile$data.abuseClassification,
+    mediaMetadata = _mediaFile$data.mediaMetadata;
   var baseState = {
     id: id,
     name: name,
@@ -67,7 +68,8 @@ var mapMediaFileToFileState = exports.mapMediaFileToFileState = function mapMedi
     createdAt: createdAt,
     hash: hash,
     metadataTraceContext: metadataTraceContext,
-    abuseClassification: abuseClassification
+    abuseClassification: abuseClassification,
+    mediaMetadata: mediaMetadata
   };
   switch (processingStatus) {
     case 'pending':

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

@@ -155,8 +155,8 @@ export class FileFetcherImpl {
       this.setFileState(id, mapMediaItemToFileState(id, itemDetails));
       return data;
     });
-    _defineProperty(this, "deleteArtifact", async (id, params, collectionName, traceContext) => {
-      await this.mediaApi.deleteArtifact(id, params, collectionName, traceContext);
+    _defineProperty(this, "deleteArtifact", async (id, artifactName, collectionName, traceContext) => {
+      await this.mediaApi.deleteArtifact(id, artifactName, collectionName, traceContext);
 
       // Manually remove the artifact from file state instead of re-requesting the entire payload.
       const file = this.store.getState().files[id];
@@ -164,7 +164,7 @@ export class FileFetcherImpl {
         const updatedArtifacts = {
           ...file.artifacts
         };
-        delete updatedArtifacts[params.artifactName];
+        delete updatedArtifacts[artifactName];
         const updatedFileState = {
           ...file,
           artifacts: updatedArtifacts

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

@@ -87,7 +87,7 @@ export class MediaStore {
       };
       return this.request(`/file/${id}/artifact/binary`, options).then(createMapResponseToJson(metadata));
     });
-    _defineProperty(this, "deleteArtifact", async (id, params, collectionName, traceContext) => {
+    _defineProperty(this, "deleteArtifact", async (id, artifactName, collectionName, traceContext) => {
       const metadata = {
         method: 'DELETE',
         endpoint: '/file/{fileId}/artifact/{artifactName}'
@@ -103,9 +103,12 @@ export class MediaStore {
       const options = {
         ...metadata,
         authContext,
-        traceContext
+        traceContext,
+        params: {
+          collection: collectionName
+        }
       };
-      await this.request(`/file/${id}/artifact/${params.artifactName}`, options);
+      await this.request(`/file/${id}/artifact/${artifactName}`, options);
     });
     _defineProperty(this, "resolveAuth", authContext => resolveAuth(this.config.authProvider, authContext, this.config.authProviderTimeout));
     _defineProperty(this, "resolveInitialAuth", () => resolveInitialAuth(this.config.initialAuth));

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

@@ -29,7 +29,8 @@ export const mapMediaFileToFileState = mediaFile => {
     createdAt,
     metadataTraceContext,
     hash,
-    abuseClassification
+    abuseClassification,
+    mediaMetadata
   } = mediaFile.data;
   const baseState = {
     id,
@@ -42,7 +43,8 @@ export const mapMediaFileToFileState = mediaFile => {
     createdAt,
     hash,
     metadataTraceContext,
-    abuseClassification
+    abuseClassification,
+    mediaMetadata
   };
   switch (processingStatus) {
     case 'pending':

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

@@ -201,19 +201,19 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
       };
     }());
     _defineProperty(this, "deleteArtifact", /*#__PURE__*/function () {
-      var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(id, params, collectionName, traceContext) {
+      var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(id, artifactName, collectionName, traceContext) {
         var file, updatedArtifacts, updatedFileState;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               _context3.next = 2;
-              return _this.mediaApi.deleteArtifact(id, params, collectionName, traceContext);
+              return _this.mediaApi.deleteArtifact(id, artifactName, collectionName, traceContext);
             case 2:
               // Manually remove the artifact from file state instead of re-requesting the entire payload.
               file = _this.store.getState().files[id];
               if (file && file.status === 'processed' && file.artifacts) {
                 updatedArtifacts = _objectSpread({}, file.artifacts);
-                delete updatedArtifacts[params.artifactName];
+                delete updatedArtifacts[artifactName];
                 updatedFileState = _objectSpread(_objectSpread({}, file), {}, {
                   artifacts: updatedArtifacts
                 });

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

@@ -119,7 +119,7 @@ export var MediaStore = /*#__PURE__*/function () {
       };
     }());
     _defineProperty(this, "deleteArtifact", /*#__PURE__*/function () {
-      var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(id, params, collectionName, traceContext) {
+      var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(id, artifactName, collectionName, traceContext) {
         var metadata, authContext, options;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
@@ -138,10 +138,13 @@ export var MediaStore = /*#__PURE__*/function () {
               };
               options = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: authContext,
-                traceContext: traceContext
+                traceContext: traceContext,
+                params: {
+                  collection: collectionName
+                }
               });
               _context3.next = 5;
-              return _this.request("/file/".concat(id, "/artifact/").concat(params.artifactName), options);
+              return _this.request("/file/".concat(id, "/artifact/").concat(artifactName), options);
             case 5:
             case "end":
               return _context3.stop();

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

@@ -48,7 +48,8 @@ export var mapMediaFileToFileState = function mapMediaFileToFileState(mediaFile)
     createdAt = _mediaFile$data.createdAt,
     metadataTraceContext = _mediaFile$data.metadataTraceContext,
     hash = _mediaFile$data.hash,
-    abuseClassification = _mediaFile$data.abuseClassification;
+    abuseClassification = _mediaFile$data.abuseClassification,
+    mediaMetadata = _mediaFile$data.mediaMetadata;
   var baseState = {
     id: id,
     name: name,
@@ -60,7 +61,8 @@ export var mapMediaFileToFileState = function mapMediaFileToFileState(mediaFile)
     createdAt: createdAt,
     hash: hash,
     metadataTraceContext: metadataTraceContext,
-    abuseClassification: abuseClassification
+    abuseClassification: abuseClassification,
+    mediaMetadata: mediaMetadata
   };
   switch (processingStatus) {
     case 'pending':

package/dist/types/client/file-fetcher/index.d.ts

@@ -9,7 +9,7 @@ import { type MediaSubscribable } from '../../utils/mediaSubscribable';
 import { type Dimensions } from '../../utils/getDimensionsFromBlob';
 import { type MediaTraceContext } from '@atlaskit/media-common';
 import { type FilePreview, type FileState, type MediaStore } from '@atlaskit/media-state';
-import { type UploadArtifactParams, type DeleteArtifactParams } from '../media-store/types';
+import { type UploadArtifactParams } from '../media-store/types';
 export type { FileFetcherErrorAttributes, FileFetcherErrorReason } from './error';
 export { isFileFetcherError, FileFetcherError } from './error';
 export interface CopySourceFile {
@@ -42,7 +42,7 @@ export interface FileFetcher {
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
     registerCopyIntent(id: string, collectionName?: string): Promise<void>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaItemDetails>;
-    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
+    deleteArtifact(id: string, artifactName: string, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     /** @exprimental This is exprimental for the purposes of COMMIT-18082 and is prone to breaking changes */
     getVideoDurations(files: Array<{
         id: string;

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

@@ -164,9 +164,6 @@ export type UploadArtifactCaptionsParams = {
     language: string;
 };
 export type UploadArtifactParams = UploadArtifactCaptionsParams;
-export type DeleteArtifactParams = {
-    artifactName: string;
-};
 export interface MediaApi {
     removeCollectionFile: (id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext) => Promise<void>;
     createUpload: (createUpTo: number, collectionName?: string, traceContext?: MediaTraceContext, chunkChunkHashAlgorithm?: ChunkHashAlgorithm) => Promise<MediaStoreResponse<MediaUpload[]>>;
@@ -182,7 +179,7 @@ export interface MediaApi {
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
     getArtifactBinary(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, options: GetArtifactBinaryOptions): Promise<Blob>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaItemDetails>>;
-    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
+    deleteArtifact(id: string, artifactName: string, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;
     getItems: (ids: string[], collectionName?: string, traceContext?: MediaTraceContext, includeHashForDuplicateFiles?: boolean) => Promise<MediaStoreResponse<ItemsPayload>>;
     getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{

package/dist/types/models/media.d.ts

@@ -7,6 +7,9 @@ export type AbuseClassification = {
     classification: 'ABHORRENT' | 'MALICIOUS' | 'ILLICIT' | 'COPYRIGHT';
     confidence: 'HIGH' | 'MEDIUM' | 'LOW' | 'SYNTHETIC';
 };
+export type FileMediaMetadata = {
+    duration?: number;
+};
 export type MediaFile = {
     readonly id: string;
     readonly mediaType: MediaType;
@@ -20,6 +23,7 @@ export type MediaFile = {
     readonly hash?: string;
     readonly metadataTraceContext?: MediaTraceContext;
     readonly abuseClassification?: AbuseClassification;
+    readonly mediaMetadata?: FileMediaMetadata;
 };
 export type MediaItemDetails = {
     readonly mediaType: MediaType;
@@ -33,6 +37,7 @@ export type MediaItemDetails = {
     readonly hash?: string;
     readonly metadataTraceContext?: MediaTraceContext;
     readonly abuseClassification?: AbuseClassification;
+    readonly mediaMetadata?: FileMediaMetadata;
 };
 export type NotFoundMediaItemDetails = {
     readonly id: string;

package/dist/types-ts4.5/client/file-fetcher/index.d.ts

@@ -9,7 +9,7 @@ import { type MediaSubscribable } from '../../utils/mediaSubscribable';
 import { type Dimensions } from '../../utils/getDimensionsFromBlob';
 import { type MediaTraceContext } from '@atlaskit/media-common';
 import { type FilePreview, type FileState, type MediaStore } from '@atlaskit/media-state';
-import { type UploadArtifactParams, type DeleteArtifactParams } from '../media-store/types';
+import { type UploadArtifactParams } from '../media-store/types';
 export type { FileFetcherErrorAttributes, FileFetcherErrorReason } from './error';
 export { isFileFetcherError, FileFetcherError } from './error';
 export interface CopySourceFile {
@@ -42,7 +42,7 @@ export interface FileFetcher {
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
     registerCopyIntent(id: string, collectionName?: string): Promise<void>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaItemDetails>;
-    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
+    deleteArtifact(id: string, artifactName: string, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     /** @exprimental This is exprimental for the purposes of COMMIT-18082 and is prone to breaking changes */
     getVideoDurations(files: Array<{
         id: string;

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

@@ -164,9 +164,6 @@ export type UploadArtifactCaptionsParams = {
     language: string;
 };
 export type UploadArtifactParams = UploadArtifactCaptionsParams;
-export type DeleteArtifactParams = {
-    artifactName: string;
-};
 export interface MediaApi {
     removeCollectionFile: (id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext) => Promise<void>;
     createUpload: (createUpTo: number, collectionName?: string, traceContext?: MediaTraceContext, chunkChunkHashAlgorithm?: ChunkHashAlgorithm) => Promise<MediaStoreResponse<MediaUpload[]>>;
@@ -182,7 +179,7 @@ export interface MediaApi {
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
     getArtifactBinary(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, options: GetArtifactBinaryOptions): Promise<Blob>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaItemDetails>>;
-    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
+    deleteArtifact(id: string, artifactName: string, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;
     getItems: (ids: string[], collectionName?: string, traceContext?: MediaTraceContext, includeHashForDuplicateFiles?: boolean) => Promise<MediaStoreResponse<ItemsPayload>>;
     getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{

package/dist/types-ts4.5/models/media.d.ts

@@ -7,6 +7,9 @@ export type AbuseClassification = {
     classification: 'ABHORRENT' | 'MALICIOUS' | 'ILLICIT' | 'COPYRIGHT';
     confidence: 'HIGH' | 'MEDIUM' | 'LOW' | 'SYNTHETIC';
 };
+export type FileMediaMetadata = {
+    duration?: number;
+};
 export type MediaFile = {
     readonly id: string;
     readonly mediaType: MediaType;
@@ -20,6 +23,7 @@ export type MediaFile = {
     readonly hash?: string;
     readonly metadataTraceContext?: MediaTraceContext;
     readonly abuseClassification?: AbuseClassification;
+    readonly mediaMetadata?: FileMediaMetadata;
 };
 export type MediaItemDetails = {
     readonly mediaType: MediaType;
@@ -33,6 +37,7 @@ export type MediaItemDetails = {
     readonly hash?: string;
     readonly metadataTraceContext?: MediaTraceContext;
     readonly abuseClassification?: AbuseClassification;
+    readonly mediaMetadata?: FileMediaMetadata;
 };
 export type NotFoundMediaItemDetails = {
     readonly id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "34.2.0",
+	"version": "35.1.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -51,13 +51,13 @@
 	},
 	"peerDependencies": {
 		"@atlaskit/media-core": "^37.0.0",
-		"@atlaskit/media-state": "^1.6.0"
+		"@atlaskit/media-state": "^1.8.0"
 	},
 	"devDependencies": {
 		"@atlaskit/media-core": "^37.0.0",
-		"@atlaskit/media-state": "^1.6.0",
+		"@atlaskit/media-state": "^1.8.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/tokens": "^5.4.0",
+		"@atlaskit/tokens": "^5.5.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",
 		"@emotion/react": "^11.7.1",
 		"@types/deep-equal": "^1.0.1",