@atlaskit/media-client 18.1.0 → 19.1.0

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

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "MediaStoreError", {
     return _error.MediaStoreError;
   }
 });
-exports.getMediaRegion = exports.getMediaEnvironment = exports.ZipkinHeaderKeys = void 0;
+exports.getMediaRegion = exports.getMediaEnvironment = void 0;
 Object.defineProperty(exports, "isMediaStoreError", {
   enumerable: true,
   get: function get() {
@@ -72,14 +72,6 @@ var jsonHeaders = {
   Accept: 'application/json',
   'Content-Type': 'application/json'
 };
-var ZipkinHeaderKeys = {
-  traceId: 'x-b3-traceid',
-  spanId: 'x-b3-spanid',
-  parentSpanId: 'x-b3-parentspanid',
-  sampled: 'x-b3-sampled',
-  flags: 'x-b3-flags'
-};
-exports.ZipkinHeaderKeys = ZipkinHeaderKeys;
 
 var MediaStore = /*#__PURE__*/function () {
   function MediaStore(config, featureFlags) {
@@ -99,7 +91,7 @@ var MediaStore = /*#__PURE__*/function () {
   (0, _createClass2.default)(MediaStore, [{
     key: "getCollectionItems",
     value: function () {
-      var _getCollectionItems = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(collectionName, params) {
+      var _getCollectionItems = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(collectionName, params, traceContext) {
         var metadata, options, response, _yield$createMapRespo, _yield$createMapRespo2, contents, nextInclusiveStartKey, contentsWithoutEmptyFiles;
 
         return _regenerator.default.wrap(function _callee$(_context) {
@@ -117,7 +109,8 @@ var MediaStore = /*#__PURE__*/function () {
                   params: _objectSpread(_objectSpread({}, defaultGetCollectionItems), params),
                   headers: {
                     Accept: 'application/json'
-                  }
+                  },
+                  traceContext: traceContext
                 });
                 _context.next = 4;
                 return this.request("/collection/".concat(collectionName, "/items"), options);
@@ -152,7 +145,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee, this);
       }));
 
-      function getCollectionItems(_x, _x2) {
+      function getCollectionItems(_x, _x2, _x3) {
         return _getCollectionItems.apply(this, arguments);
       }
 
@@ -161,7 +154,7 @@ var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "removeCollectionFile",
     value: function () {
-      var _removeCollectionFile = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id, collectionName, occurrenceKey) {
+      var _removeCollectionFile = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id, collectionName, occurrenceKey, traceContext) {
         var metadata, body, options;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) {
@@ -189,7 +182,8 @@ var MediaStore = /*#__PURE__*/function () {
                     Accept: 'application/json',
                     'Content-Type': 'application/json'
                   },
-                  body: JSON.stringify(body)
+                  body: JSON.stringify(body),
+                  traceContext: traceContext
                 });
                 _context2.next = 5;
                 return this.request("/collection/".concat(collectionName), options);
@@ -202,7 +196,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee2, this);
       }));
 
-      function removeCollectionFile(_x3, _x4, _x5) {
+      function removeCollectionFile(_x4, _x5, _x6, _x7) {
         return _removeCollectionFile.apply(this, arguments);
       }
 
@@ -213,6 +207,7 @@ var MediaStore = /*#__PURE__*/function () {
     value: function createUpload() {
       var createUpTo = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
       var collectionName = arguments.length > 1 ? arguments[1] : undefined;
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
       var metadata = {
         method: 'POST',
         endpoint: '/upload'
@@ -227,7 +222,8 @@ var MediaStore = /*#__PURE__*/function () {
         },
         headers: {
           Accept: 'application/json'
-        }
+        },
+        traceContext: traceContext
       });
 
       return this.request("/upload", options).then((0, _helpers.createMapResponseToJson)(metadata));
@@ -240,6 +236,7 @@ var MediaStore = /*#__PURE__*/function () {
             collectionName,
             uploadId,
             partNumber,
+            traceContext,
             metadata,
             options,
             _args3 = arguments;
@@ -249,6 +246,7 @@ var MediaStore = /*#__PURE__*/function () {
             switch (_context3.prev = _context3.next) {
               case 0:
                 _ref = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : {}, collectionName = _ref.collectionName, uploadId = _ref.uploadId, partNumber = _ref.partNumber;
+                traceContext = _args3.length > 3 ? _args3[3] : undefined;
                 metadata = {
                   method: 'PUT',
                   endpoint: '/chunk/{etag}'
@@ -261,12 +259,13 @@ var MediaStore = /*#__PURE__*/function () {
                   authContext: {
                     collectionName: collectionName
                   },
-                  body: blob
+                  body: blob,
+                  traceContext: traceContext
                 });
-                _context3.next = 5;
+                _context3.next = 6;
                 return this.request("/chunk/".concat(etag), options);
 
-              case 5:
+              case 6:
               case "end":
                 return _context3.stop();
             }
@@ -274,7 +273,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee3, this);
       }));
 
-      function uploadChunk(_x6, _x7) {
+      function uploadChunk(_x8, _x9) {
         return _uploadChunk.apply(this, arguments);
       }
 
@@ -287,6 +286,7 @@ var MediaStore = /*#__PURE__*/function () {
           collectionName = _ref2.collectionName,
           uploadId = _ref2.uploadId;
 
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
       var metadata = {
         method: 'POST',
         endpoint: '/chunk/probe'
@@ -302,7 +302,8 @@ var MediaStore = /*#__PURE__*/function () {
         headers: jsonHeaders,
         body: JSON.stringify({
           chunks: chunks
-        })
+        }),
+        traceContext: traceContext
       });
 
       return this.request("/chunk/probe", options).then((0, _helpers.createMapResponseToJson)(metadata));
@@ -311,6 +312,7 @@ var MediaStore = /*#__PURE__*/function () {
     key: "createFileFromUpload",
     value: function createFileFromUpload(body) {
       var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
       var metadata = {
         method: 'POST',
         endpoint: '/file/upload'
@@ -322,7 +324,8 @@ var MediaStore = /*#__PURE__*/function () {
         },
         params: params,
         headers: jsonHeaders,
-        body: JSON.stringify(body)
+        body: JSON.stringify(body),
+        traceContext: traceContext
       });
 
       return this.request('/file/upload', options).then((0, _helpers.createMapResponseToJson)(metadata));
@@ -331,6 +334,7 @@ var MediaStore = /*#__PURE__*/function () {
     key: "touchFiles",
     value: function touchFiles(body) {
       var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
       var metadata = {
         method: 'POST',
         endpoint: '/upload/createWithFiles'
@@ -341,7 +345,8 @@ var MediaStore = /*#__PURE__*/function () {
           collectionName: params.collection
         },
         headers: jsonHeaders,
-        body: JSON.stringify(body)
+        body: JSON.stringify(body),
+        traceContext: traceContext
       });
 
       return this.request('/upload/createWithFiles', options).then((0, _helpers.createMapResponseToJson)(metadata));
@@ -350,6 +355,7 @@ var MediaStore = /*#__PURE__*/function () {
     key: "getFile",
     value: function getFile(fileId) {
       var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var traceContext = arguments.length > 2 ? arguments[2] : undefined;
       var metadata = {
         method: 'GET',
         endpoint: '/file/{fileId}'
@@ -359,7 +365,8 @@ var MediaStore = /*#__PURE__*/function () {
         authContext: {
           collectionName: params.collection
         },
-        params: params
+        params: params,
+        traceContext: traceContext
       });
 
       return this.request("/file/".concat(fileId), options).then((0, _helpers.createMapResponseToJson)(metadata));
@@ -392,12 +399,13 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee4, this);
       }));
 
-      function getFileImageURL(_x8, _x9) {
+      function getFileImageURL(_x10, _x11) {
         return _getFileImageURL.apply(this, arguments);
       }
 
       return getFileImageURL;
-    }()
+    }() // TODO Create ticket in case Trace Id can be supported through query params
+
   }, {
     key: "getFileImageURLSync",
     value: function getFileImageURLSync(id, params) {
@@ -447,7 +455,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee5, this);
       }));
 
-      function getFileBinaryURL(_x10, _x11) {
+      function getFileBinaryURL(_x12, _x13) {
         return _getFileBinaryURL.apply(this, arguments);
       }
 
@@ -496,7 +504,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee6, this);
       }));
 
-      function getArtifactURL(_x12, _x13, _x14) {
+      function getArtifactURL(_x14, _x15, _x16) {
         return _getArtifactURL.apply(this, arguments);
       }
 
@@ -505,9 +513,7 @@ var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getImage",
     value: function () {
-      var _getImage = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(id, params, controller, fetchMaxRes, traceId) {
-        var _ref4;
-
+      var _getImage = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(id, params, controller, fetchMaxRes, traceContext) {
         var isWebpSupported, headers, metadata, options;
         return _regenerator.default.wrap(function _callee7$(_context7) {
           while (1) {
@@ -515,7 +521,7 @@ var MediaStore = /*#__PURE__*/function () {
               case 0:
                 // TODO add checkWebpSupport() back https://product-fabric.atlassian.net/browse/MPT-584
                 isWebpSupported = false;
-                headers = !!traceId ? (_ref4 = {}, (0, _defineProperty2.default)(_ref4, ZipkinHeaderKeys.traceId, traceId), (0, _defineProperty2.default)(_ref4, ZipkinHeaderKeys.spanId, (0, _mediaCommon.getRandomHex)(16)), _ref4) : {};
+                headers = {};
 
                 if (isWebpSupported) {
                   headers.accept = 'image/webp,image/*,*/*;q=0.8';
@@ -530,7 +536,8 @@ var MediaStore = /*#__PURE__*/function () {
                     collectionName: params && params.collection
                   },
                   params: extendImageParams(params, fetchMaxRes),
-                  headers: headers
+                  headers: headers,
+                  traceContext: traceContext
                 });
                 return _context7.abrupt("return", this.request("/file/".concat(id, "/image"), options, controller).then((0, _helpers.createMapResponseToBlob)(metadata)));
 
@@ -542,7 +549,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee7, this);
       }));
 
-      function getImage(_x15, _x16, _x17, _x18, _x19) {
+      function getImage(_x17, _x18, _x19, _x20, _x21) {
         return _getImage.apply(this, arguments);
       }
 
@@ -551,7 +558,7 @@ var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getItems",
     value: function () {
-      var _getItems = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(ids, collectionName) {
+      var _getItems = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(ids, collectionName, traceContext) {
         var descriptors, metadata, options;
         return _regenerator.default.wrap(function _callee8$(_context8) {
           while (1) {
@@ -575,7 +582,8 @@ var MediaStore = /*#__PURE__*/function () {
                   headers: jsonHeaders,
                   body: JSON.stringify({
                     descriptors: descriptors
-                  })
+                  }),
+                  traceContext: traceContext
                 });
                 return _context8.abrupt("return", this.request('/items', options).then((0, _helpers.createMapResponseToJson)(metadata)));
 
@@ -587,7 +595,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee8, this);
       }));
 
-      function getItems(_x20, _x21) {
+      function getItems(_x22, _x23, _x24) {
         return _getItems.apply(this, arguments);
       }
 
@@ -596,7 +604,7 @@ var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getImageMetadata",
     value: function () {
-      var _getImageMetadata = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(id, params) {
+      var _getImageMetadata = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(id, params, traceContext) {
         var metadata, options;
         return _regenerator.default.wrap(function _callee9$(_context9) {
           while (1) {
@@ -610,7 +618,8 @@ var MediaStore = /*#__PURE__*/function () {
                   authContext: {
                     collectionName: params && params.collection
                   },
-                  params: params
+                  params: params,
+                  traceContext: traceContext
                 });
                 return _context9.abrupt("return", this.request("/file/".concat(id, "/image/metadata"), options).then((0, _helpers.createMapResponseToJson)(metadata)));
 
@@ -622,7 +631,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee9, this);
       }));
 
-      function getImageMetadata(_x22, _x23) {
+      function getImageMetadata(_x25, _x26, _x27) {
         return _getImageMetadata.apply(this, arguments);
       }
 
@@ -631,7 +640,7 @@ var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "appendChunksToUpload",
     value: function () {
-      var _appendChunksToUpload = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(uploadId, body, collectionName) {
+      var _appendChunksToUpload = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(uploadId, body, collectionName, traceContext) {
         var metadata, options;
         return _regenerator.default.wrap(function _callee10$(_context10) {
           while (1) {
@@ -646,7 +655,8 @@ var MediaStore = /*#__PURE__*/function () {
                     collectionName: collectionName
                   },
                   headers: jsonHeaders,
-                  body: JSON.stringify(body)
+                  body: JSON.stringify(body),
+                  traceContext: traceContext
                 });
                 _context10.next = 4;
                 return this.request("/upload/".concat(uploadId, "/chunks"), options);
@@ -659,7 +669,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee10, this);
       }));
 
-      function appendChunksToUpload(_x24, _x25, _x26) {
+      function appendChunksToUpload(_x28, _x29, _x30, _x31) {
         return _appendChunksToUpload.apply(this, arguments);
       }
 
@@ -667,7 +677,7 @@ var MediaStore = /*#__PURE__*/function () {
     }()
   }, {
     key: "copyFileWithToken",
-    value: function copyFileWithToken(body, params) {
+    value: function copyFileWithToken(body, params, traceContext) {
       var metadata = {
         method: 'POST',
         endpoint: '/file/copy/withToken'
@@ -681,8 +691,9 @@ var MediaStore = /*#__PURE__*/function () {
         params: params,
         // Contains collection name to write to
         headers: jsonHeaders,
-        body: JSON.stringify(body) // Contains collection name to read from
-
+        body: JSON.stringify(body),
+        // Contains collection name to read from
+        traceContext: traceContext
       });
 
       return this.request('/file/copy/withToken', options).then((0, _helpers.createMapResponseToJson)(metadata));
@@ -700,7 +711,9 @@ var MediaStore = /*#__PURE__*/function () {
             headers,
             body,
             clientOptions,
+            traceContext,
             auth,
+            extendedTraceContext,
             response,
             _args11 = arguments;
         return _regenerator.default.wrap(function _callee11$(_context11) {
@@ -713,13 +726,16 @@ var MediaStore = /*#__PURE__*/function () {
                   authContext: {}
                 };
                 controller = _args11.length > 2 ? _args11[2] : undefined;
-                method = options.method, endpoint = options.endpoint, authContext = options.authContext, params = options.params, headers = options.headers, body = options.body, clientOptions = options.clientOptions;
+                method = options.method, endpoint = options.endpoint, authContext = options.authContext, params = options.params, headers = options.headers, body = options.body, clientOptions = options.clientOptions, traceContext = options.traceContext;
                 _context11.next = 5;
                 return this.resolveAuth(authContext);
 
               case 5:
                 auth = _context11.sent;
-                _context11.next = 8;
+                extendedTraceContext = traceContext ? _objectSpread(_objectSpread({}, traceContext), {}, {
+                  spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || (0, _mediaCommon.getRandomHex)(8)
+                }) : undefined;
+                _context11.next = 9;
                 return (0, _request3.request)("".concat(auth.baseUrl).concat(path), {
                   method: method,
                   endpoint: endpoint,
@@ -727,16 +743,17 @@ var MediaStore = /*#__PURE__*/function () {
                   params: params,
                   headers: headers,
                   body: body,
-                  clientOptions: clientOptions
+                  clientOptions: clientOptions,
+                  traceContext: extendedTraceContext
                 }, controller);
 
-              case 8:
+              case 9:
                 response = _context11.sent;
                 setKeyValueInSessionStorage(MEDIA_API_REGION, response.headers.get('x-media-region'));
                 setKeyValueInSessionStorage(MEDIA_API_ENVIRONMENT, response.headers.get('x-media-env'));
                 return _context11.abrupt("return", response);
 
-              case 12:
+              case 13:
               case "end":
                 return _context11.stop();
             }
@@ -744,7 +761,7 @@ var MediaStore = /*#__PURE__*/function () {
         }, _callee11, this);
       }));
 
-      function request(_x27) {
+      function request(_x32) {
         return _request2.apply(this, arguments);
       }
 

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

@@ -73,7 +73,8 @@ var mapMediaFileToFileState = function mapMediaFileToFileState(mediaFile) {
       mediaType = _mediaFile$data.mediaType,
       mimeType = _mediaFile$data.mimeType,
       representations = _mediaFile$data.representations,
-      createdAt = _mediaFile$data.createdAt;
+      createdAt = _mediaFile$data.createdAt,
+      metadataTraceContext = _mediaFile$data.metadataTraceContext;
   var baseState = {
     id: id,
     name: name,
@@ -82,7 +83,8 @@ var mapMediaFileToFileState = function mapMediaFileToFileState(mediaFile) {
     mimeType: mimeType,
     artifacts: artifacts,
     representations: representations,
-    createdAt: createdAt
+    createdAt: createdAt,
+    metadataTraceContext: metadataTraceContext
   };
 
   switch (processingStatus) {