@atlaskit/media-client 28.4.0 → 28.5.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/media-client
 
+## 28.5.0
+
+### Minor Changes
+
+- [#170974](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/170974)
+  [`215eb993c1ea3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/215eb993c1ea3) -
+  Added `registerCopyIntents` and `copyFile` endpoints to meida client to enable cross client copy
+  and paste
+
 ## 28.4.0
 
 ### Minor Changes

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

@@ -593,10 +593,71 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
       });
       return this.request('/file/copy/withToken', options).then((0, _helpers.createMapResponseToJson)(metadata));
     }
+  }, {
+    key: "copyFile",
+    value: function copyFile(id, params, traceContext) {
+      var metadata = {
+        method: 'POST',
+        endpoint: '/v2/file/copy'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        authContext: {
+          collectionName: params.collection
+        },
+        params: params,
+        headers: jsonHeaders,
+        body: JSON.stringify({
+          id: id
+        }),
+        traceContext: traceContext
+      });
+      return this.request('/v2/file/copy', options).then((0, _helpers.createMapResponseToJson)(metadata));
+    }
+  }, {
+    key: "registerCopyIntents",
+    value: function () {
+      var _registerCopyIntents = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(ids, collectionName, traceContext) {
+        var files, metadata, options;
+        return _regenerator.default.wrap(function _callee12$(_context12) {
+          while (1) switch (_context12.prev = _context12.next) {
+            case 0:
+              files = ids.map(function (id) {
+                return {
+                  id: id,
+                  collection: collectionName
+                };
+              });
+              metadata = {
+                method: 'POST',
+                endpoint: '/file/copy/intents'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: collectionName
+                },
+                headers: jsonHeaders,
+                body: JSON.stringify({
+                  files: files
+                }),
+                traceContext: traceContext
+              });
+              _context12.next = 5;
+              return this.request('/file/copy/intents', options);
+            case 5:
+            case "end":
+              return _context12.stop();
+          }
+        }, _callee12, this);
+      }));
+      function registerCopyIntents(_x38, _x39, _x40) {
+        return _registerCopyIntents.apply(this, arguments);
+      }
+      return registerCopyIntents;
+    }()
   }, {
     key: "request",
     value: function () {
-      var _request2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(path) {
+      var _request2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee13(path) {
         var options,
           controller,
           useMediaCdn,
@@ -615,22 +676,22 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           extendedParams,
           url,
           response,
-          _args12 = arguments;
-        return _regenerator.default.wrap(function _callee12$(_context12) {
-          while (1) switch (_context12.prev = _context12.next) {
+          _args13 = arguments;
+        return _regenerator.default.wrap(function _callee13$(_context13) {
+          while (1) switch (_context13.prev = _context13.next) {
             case 0:
-              options = _args12.length > 1 && _args12[1] !== undefined ? _args12[1] : {
+              options = _args13.length > 1 && _args13[1] !== undefined ? _args13[1] : {
                 method: 'GET',
                 endpoint: undefined,
                 authContext: {}
               };
-              controller = _args12.length > 2 ? _args12[2] : undefined;
-              useMediaCdn = _args12.length > 3 ? _args12[3] : undefined;
+              controller = _args13.length > 2 ? _args13[2] : undefined;
+              useMediaCdn = _args13.length > 3 ? _args13[3] : undefined;
               method = options.method, endpoint = options.endpoint, authContext = options.authContext, params = options.params, headers = options.headers, body = options.body, clientOptions = options.clientOptions, traceContext = options.traceContext, addMediaClientParam = options.addMediaClientParam;
-              _context12.next = 6;
+              _context13.next = 6;
               return this.resolveAuth(authContext);
             case 6:
-              auth = _context12.sent;
+              auth = _context13.sent;
               clientId = (0, _mediaCore.isClientBasedAuth)(auth) ? auth.clientId : undefined;
               extendedTraceContext = (0, _helpers.extendTraceContext)(traceContext);
               extendedParams = addMediaClientParam ? _objectSpread(_objectSpread({}, params), {}, {
@@ -640,7 +701,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
               if (useMediaCdn) {
                 url = (0, _mediaCdn.mapToMediaCdnUrl)(url, auth.token);
               }
-              _context12.next = 14;
+              _context13.next = 14;
               return (0, _request3.request)(url, {
                 method: method,
                 endpoint: endpoint,
@@ -652,17 +713,17 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
                 traceContext: extendedTraceContext
               }, controller);
             case 14:
-              response = _context12.sent;
+              response = _context13.sent;
               setKeyValueInSessionStorage(MEDIA_API_REGION, response.headers.get('x-media-region'));
               setKeyValueInSessionStorage(MEDIA_API_ENVIRONMENT, response.headers.get('x-media-env'));
-              return _context12.abrupt("return", response);
+              return _context13.abrupt("return", response);
             case 18:
             case "end":
-              return _context12.stop();
+              return _context13.stop();
           }
-        }, _callee12, this);
+        }, _callee13, this);
       }));
-      function request(_x38) {
+      function request(_x41) {
         return _request2.apply(this, arguments);
       }
       return request;
@@ -670,16 +731,16 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
   }, {
     key: "testUrl",
     value: function () {
-      var _testUrl = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee13(url) {
+      var _testUrl = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee14(url) {
         var options,
           traceContext,
-          _args13 = arguments;
-        return _regenerator.default.wrap(function _callee13$(_context13) {
-          while (1) switch (_context13.prev = _context13.next) {
+          _args14 = arguments;
+        return _regenerator.default.wrap(function _callee14$(_context14) {
+          while (1) switch (_context14.prev = _context14.next) {
             case 0:
-              options = _args13.length > 1 && _args13[1] !== undefined ? _args13[1] : {};
+              options = _args14.length > 1 && _args14[1] !== undefined ? _args14[1] : {};
               traceContext = options.traceContext;
-              _context13.next = 4;
+              _context14.next = 4;
               return (0, _request3.request)(url, {
                 method: 'HEAD',
                 traceContext: (0, _helpers.extendTraceContext)(traceContext),
@@ -691,11 +752,11 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
               });
             case 4:
             case "end":
-              return _context13.stop();
+              return _context14.stop();
           }
-        }, _callee13);
+        }, _callee14);
       }));
-      function testUrl(_x39) {
+      function testUrl(_x42) {
         return _testUrl.apply(this, arguments);
       }
       return testUrl;

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

@@ -350,6 +350,47 @@ export class MediaStore {
     };
     return this.request('/file/copy/withToken', options).then(createMapResponseToJson(metadata));
   }
+  copyFile(id, params, traceContext) {
+    const metadata = {
+      method: 'POST',
+      endpoint: '/v2/file/copy'
+    };
+    const options = {
+      ...metadata,
+      authContext: {
+        collectionName: params.collection
+      },
+      params,
+      headers: jsonHeaders,
+      body: JSON.stringify({
+        id
+      }),
+      traceContext
+    };
+    return this.request('/v2/file/copy', options).then(createMapResponseToJson(metadata));
+  }
+  async registerCopyIntents(ids, collectionName, traceContext) {
+    const files = ids.map(id => ({
+      id,
+      collection: collectionName
+    }));
+    const metadata = {
+      method: 'POST',
+      endpoint: '/file/copy/intents'
+    };
+    const options = {
+      ...metadata,
+      authContext: {
+        collectionName
+      },
+      headers: jsonHeaders,
+      body: JSON.stringify({
+        files
+      }),
+      traceContext
+    };
+    await this.request('/file/copy/intents', options);
+  }
   async request(path, options = {
     method: 'GET',
     endpoint: undefined,

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

@@ -587,10 +587,71 @@ export var MediaStore = /*#__PURE__*/function () {
       });
       return this.request('/file/copy/withToken', options).then(createMapResponseToJson(metadata));
     }
+  }, {
+    key: "copyFile",
+    value: function copyFile(id, params, traceContext) {
+      var metadata = {
+        method: 'POST',
+        endpoint: '/v2/file/copy'
+      };
+      var options = _objectSpread(_objectSpread({}, metadata), {}, {
+        authContext: {
+          collectionName: params.collection
+        },
+        params: params,
+        headers: jsonHeaders,
+        body: JSON.stringify({
+          id: id
+        }),
+        traceContext: traceContext
+      });
+      return this.request('/v2/file/copy', options).then(createMapResponseToJson(metadata));
+    }
+  }, {
+    key: "registerCopyIntents",
+    value: function () {
+      var _registerCopyIntents = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee12(ids, collectionName, traceContext) {
+        var files, metadata, options;
+        return _regeneratorRuntime.wrap(function _callee12$(_context12) {
+          while (1) switch (_context12.prev = _context12.next) {
+            case 0:
+              files = ids.map(function (id) {
+                return {
+                  id: id,
+                  collection: collectionName
+                };
+              });
+              metadata = {
+                method: 'POST',
+                endpoint: '/file/copy/intents'
+              };
+              options = _objectSpread(_objectSpread({}, metadata), {}, {
+                authContext: {
+                  collectionName: collectionName
+                },
+                headers: jsonHeaders,
+                body: JSON.stringify({
+                  files: files
+                }),
+                traceContext: traceContext
+              });
+              _context12.next = 5;
+              return this.request('/file/copy/intents', options);
+            case 5:
+            case "end":
+              return _context12.stop();
+          }
+        }, _callee12, this);
+      }));
+      function registerCopyIntents(_x38, _x39, _x40) {
+        return _registerCopyIntents.apply(this, arguments);
+      }
+      return registerCopyIntents;
+    }()
   }, {
     key: "request",
     value: function () {
-      var _request2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee12(path) {
+      var _request2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee13(path) {
         var options,
           controller,
           useMediaCdn,
@@ -609,22 +670,22 @@ export var MediaStore = /*#__PURE__*/function () {
           extendedParams,
           url,
           response,
-          _args12 = arguments;
-        return _regeneratorRuntime.wrap(function _callee12$(_context12) {
-          while (1) switch (_context12.prev = _context12.next) {
+          _args13 = arguments;
+        return _regeneratorRuntime.wrap(function _callee13$(_context13) {
+          while (1) switch (_context13.prev = _context13.next) {
             case 0:
-              options = _args12.length > 1 && _args12[1] !== undefined ? _args12[1] : {
+              options = _args13.length > 1 && _args13[1] !== undefined ? _args13[1] : {
                 method: 'GET',
                 endpoint: undefined,
                 authContext: {}
               };
-              controller = _args12.length > 2 ? _args12[2] : undefined;
-              useMediaCdn = _args12.length > 3 ? _args12[3] : undefined;
+              controller = _args13.length > 2 ? _args13[2] : undefined;
+              useMediaCdn = _args13.length > 3 ? _args13[3] : undefined;
               method = options.method, endpoint = options.endpoint, authContext = options.authContext, params = options.params, headers = options.headers, body = options.body, clientOptions = options.clientOptions, traceContext = options.traceContext, addMediaClientParam = options.addMediaClientParam;
-              _context12.next = 6;
+              _context13.next = 6;
               return this.resolveAuth(authContext);
             case 6:
-              auth = _context12.sent;
+              auth = _context13.sent;
               clientId = isClientBasedAuth(auth) ? auth.clientId : undefined;
               extendedTraceContext = extendTraceContext(traceContext);
               extendedParams = addMediaClientParam ? _objectSpread(_objectSpread({}, params), {}, {
@@ -634,7 +695,7 @@ export var MediaStore = /*#__PURE__*/function () {
               if (useMediaCdn) {
                 url = mapToMediaCdnUrl(url, auth.token);
               }
-              _context12.next = 14;
+              _context13.next = 14;
               return _request(url, {
                 method: method,
                 endpoint: endpoint,
@@ -646,17 +707,17 @@ export var MediaStore = /*#__PURE__*/function () {
                 traceContext: extendedTraceContext
               }, controller);
             case 14:
-              response = _context12.sent;
+              response = _context13.sent;
               setKeyValueInSessionStorage(MEDIA_API_REGION, response.headers.get('x-media-region'));
               setKeyValueInSessionStorage(MEDIA_API_ENVIRONMENT, response.headers.get('x-media-env'));
-              return _context12.abrupt("return", response);
+              return _context13.abrupt("return", response);
             case 18:
             case "end":
-              return _context12.stop();
+              return _context13.stop();
           }
-        }, _callee12, this);
+        }, _callee13, this);
       }));
-      function request(_x38) {
+      function request(_x41) {
         return _request2.apply(this, arguments);
       }
       return request;
@@ -664,16 +725,16 @@ export var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "testUrl",
     value: function () {
-      var _testUrl = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee13(url) {
+      var _testUrl = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee14(url) {
         var options,
           traceContext,
-          _args13 = arguments;
-        return _regeneratorRuntime.wrap(function _callee13$(_context13) {
-          while (1) switch (_context13.prev = _context13.next) {
+          _args14 = arguments;
+        return _regeneratorRuntime.wrap(function _callee14$(_context14) {
+          while (1) switch (_context14.prev = _context14.next) {
             case 0:
-              options = _args13.length > 1 && _args13[1] !== undefined ? _args13[1] : {};
+              options = _args14.length > 1 && _args14[1] !== undefined ? _args14[1] : {};
               traceContext = options.traceContext;
-              _context13.next = 4;
+              _context14.next = 4;
               return _request(url, {
                 method: 'HEAD',
                 traceContext: extendTraceContext(traceContext),
@@ -685,11 +746,11 @@ export var MediaStore = /*#__PURE__*/function () {
               });
             case 4:
             case "end":
-              return _context13.stop();
+              return _context14.stop();
           }
-        }, _callee13);
+        }, _callee14);
       }));
-      function testUrl(_x39) {
+      function testUrl(_x42) {
         return _testUrl.apply(this, arguments);
       }
       return testUrl;

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

@@ -1,7 +1,7 @@
 import { type AuthContext, type MediaApiConfig, type Auth } from '@atlaskit/media-core';
 import { type MediaTraceContext } from '@atlaskit/media-common';
 import { type MediaFileArtifacts } from '@atlaskit/media-state';
-import type { ItemsPayload, ImageMetadata, MediaStoreResponse, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, RejectedTouchFile, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, TouchedFiles, MediaApi } from './types';
+import type { ItemsPayload, ImageMetadata, MediaStoreResponse, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, RejectedTouchFile, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, TouchedFiles, MediaApi, CopyFileParams } from './types';
 import { type MediaFile, type MediaUpload } from '../../models/media';
 import { ChunkHashAlgorithm } from '@atlaskit/media-core';
 export declare class MediaStore implements MediaApi {
@@ -28,6 +28,8 @@ export declare class MediaStore implements MediaApi {
     }>;
     appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
+    copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
+    registerCopyIntents(ids: string[], collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     request(path: string, options?: MediaStoreRequestOptions, controller?: AbortController, useMediaCdn?: boolean): Promise<Response>;
     testUrl(url: string, options?: {
         traceContext?: MediaTraceContext;

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

@@ -113,6 +113,11 @@ export interface SourceFile {
 export type MediaStoreCopyFileWithTokenBody = {
     sourceFile: SourceFile;
 };
+export type CopyFileParams = {
+    sourceCollection?: string;
+    collection?: string;
+    replaceFileId?: string;
+};
 export type MediaStoreCopyFileWithTokenParams = {
     readonly collection?: string;
     readonly replaceFileId?: string;
@@ -166,6 +171,8 @@ export interface MediaApi {
     }>;
     appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
     copyFileWithToken: (body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    copyFile: (id: string, params: CopyFileParams) => Promise<MediaStoreResponse<MediaFile>>;
+    registerCopyIntents: (ids: string[], collectionName: string) => Promise<void>;
     request: (path: string, options: MediaStoreRequestOptions, controller?: AbortController) => Promise<Response>;
     testUrl: (url: string, options?: {
         traceContext?: MediaTraceContext;

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

@@ -1,7 +1,7 @@
 import { type AuthContext, type MediaApiConfig, type Auth } from '@atlaskit/media-core';
 import { type MediaTraceContext } from '@atlaskit/media-common';
 import { type MediaFileArtifacts } from '@atlaskit/media-state';
-import type { ItemsPayload, ImageMetadata, MediaStoreResponse, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, RejectedTouchFile, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, TouchedFiles, MediaApi } from './types';
+import type { ItemsPayload, ImageMetadata, MediaStoreResponse, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, RejectedTouchFile, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, TouchedFiles, MediaApi, CopyFileParams } from './types';
 import { type MediaFile, type MediaUpload } from '../../models/media';
 import { ChunkHashAlgorithm } from '@atlaskit/media-core';
 export declare class MediaStore implements MediaApi {
@@ -28,6 +28,8 @@ export declare class MediaStore implements MediaApi {
     }>;
     appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
+    copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
+    registerCopyIntents(ids: string[], collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     request(path: string, options?: MediaStoreRequestOptions, controller?: AbortController, useMediaCdn?: boolean): Promise<Response>;
     testUrl(url: string, options?: {
         traceContext?: MediaTraceContext;

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

@@ -113,6 +113,11 @@ export interface SourceFile {
 export type MediaStoreCopyFileWithTokenBody = {
     sourceFile: SourceFile;
 };
+export type CopyFileParams = {
+    sourceCollection?: string;
+    collection?: string;
+    replaceFileId?: string;
+};
 export type MediaStoreCopyFileWithTokenParams = {
     readonly collection?: string;
     readonly replaceFileId?: string;
@@ -166,6 +171,8 @@ export interface MediaApi {
     }>;
     appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
     copyFileWithToken: (body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    copyFile: (id: string, params: CopyFileParams) => Promise<MediaStoreResponse<MediaFile>>;
+    registerCopyIntents: (ids: string[], collectionName: string) => Promise<void>;
     request: (path: string, options: MediaStoreRequestOptions, controller?: AbortController) => Promise<Response>;
     testUrl: (url: string, options?: {
         traceContext?: MediaTraceContext;

package/package.json

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