@atlaskit/editor-synced-block-provider 3.2.2 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.4.0
+
+### Minor Changes
+
+- [`f660139caa049`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f660139caa049) -
+  Use the batch retrieve endpoint instead of singular endpoint to get block
+
+## 3.3.0
+
+### Minor Changes
+
+- [`bf49041938d1a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bf49041938d1a) -
+  EDITOR-2257 editor synced blocks ssr part 1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.2.2
 
 ### Patch Changes

package/dist/cjs/clients/block-service/blockService.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.BlockError = void 0;
+exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockError = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -169,17 +169,29 @@ var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/functio
     return _ref3.apply(this, arguments);
   };
 }();
-var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
+
+/**
+ * Batch retrieves multiple synced blocks by their ARIs.
+ *
+ * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ *
+ * @param blockAris - Array of block ARIs to retrieve
+ * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
+ */
+var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(_ref4) {
-    var blockAri, response;
+    var blockAris, response;
     return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          blockAri = _ref4.blockAri;
+          blockAris = _ref4.blockAris;
           _context3.next = 3;
-          return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
-            method: 'DELETE',
-            headers: COMMON_HEADERS
+          return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/batch-retrieve"), {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify({
+              blockAris: blockAris
+            })
           });
         case 3:
           response = _context3.sent;
@@ -189,58 +201,92 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
           }
           throw new BlockError(response.status);
         case 6:
+          _context3.next = 8;
+          return response.json();
+        case 8:
+          return _context3.abrupt("return", _context3.sent);
+        case 9:
         case "end":
           return _context3.stop();
       }
     }, _callee3);
   }));
-  return function deleteSyncedBlock(_x3) {
+  return function batchRetrieveSyncedBlocks(_x3) {
     return _ref5.apply(this, arguments);
   };
 }();
-var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
+var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
   var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(_ref6) {
-    var blockAri, content, stepVersion, requestBody, response;
+    var blockAri, response;
     return _regenerator.default.wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
-          blockAri = _ref6.blockAri, content = _ref6.content, stepVersion = _ref6.stepVersion;
+          blockAri = _ref6.blockAri;
+          _context4.next = 3;
+          return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
+            method: 'DELETE',
+            headers: COMMON_HEADERS
+          });
+        case 3:
+          response = _context4.sent;
+          if (response.ok) {
+            _context4.next = 6;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 6:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  }));
+  return function deleteSyncedBlock(_x4) {
+    return _ref7.apply(this, arguments);
+  };
+}();
+var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
+  var _ref9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(_ref8) {
+    var blockAri, content, stepVersion, requestBody, response;
+    return _regenerator.default.wrap(function _callee5$(_context5) {
+      while (1) switch (_context5.prev = _context5.next) {
+        case 0:
+          blockAri = _ref8.blockAri, content = _ref8.content, stepVersion = _ref8.stepVersion;
           requestBody = {
             content: content
           };
           if (stepVersion !== undefined) {
             requestBody.stepVersion = stepVersion;
           }
-          _context4.next = 5;
+          _context5.next = 5;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'PUT',
             headers: COMMON_HEADERS,
             body: JSON.stringify(requestBody)
           });
         case 5:
-          response = _context4.sent;
+          response = _context5.sent;
           if (response.ok) {
-            _context4.next = 8;
+            _context5.next = 8;
             break;
           }
           throw new BlockError(response.status);
         case 8:
         case "end":
-          return _context4.stop();
+          return _context5.stop();
       }
-    }, _callee4);
+    }, _callee5);
   }));
-  return function updateSyncedBlock(_x4) {
-    return _ref7.apply(this, arguments);
+  return function updateSyncedBlock(_x5) {
+    return _ref9.apply(this, arguments);
   };
 }();
 var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
-  var _ref9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(_ref8) {
+  var _ref1 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(_ref0) {
     var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, requestBody, response;
-    return _regenerator.default.wrap(function _callee5$(_context5) {
-      while (1) switch (_context5.prev = _context5.next) {
+    return _regenerator.default.wrap(function _callee6$(_context6) {
+      while (1) switch (_context6.prev = _context6.next) {
         case 0:
-          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content, stepVersion = _ref8.stepVersion;
+          blockAri = _ref0.blockAri, blockInstanceId = _ref0.blockInstanceId, sourceAri = _ref0.sourceAri, product = _ref0.product, content = _ref0.content, stepVersion = _ref0.stepVersion;
           requestBody = {
             blockAri: blockAri,
             blockInstanceId: blockInstanceId,
@@ -251,42 +297,42 @@ var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
           if (stepVersion !== undefined) {
             requestBody.stepVersion = stepVersion;
           }
-          _context5.next = 5;
+          _context6.next = 5;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block"), {
             method: 'POST',
             headers: COMMON_HEADERS,
             body: JSON.stringify(requestBody)
           });
         case 5:
-          response = _context5.sent;
+          response = _context6.sent;
           if (response.ok) {
-            _context5.next = 8;
+            _context6.next = 8;
             break;
           }
           throw new BlockError(response.status);
         case 8:
-          _context5.next = 10;
+          _context6.next = 10;
           return response.json();
         case 10:
-          return _context5.abrupt("return", _context5.sent);
+          return _context6.abrupt("return", _context6.sent);
         case 11:
         case "end":
-          return _context5.stop();
+          return _context6.stop();
       }
-    }, _callee5);
+    }, _callee6);
   }));
-  return function createSyncedBlock(_x5) {
-    return _ref9.apply(this, arguments);
+  return function createSyncedBlock(_x6) {
+    return _ref1.apply(this, arguments);
   };
 }();
 var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
-  var _ref1 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(_ref0) {
-    var documentAri, blocks, _ref0$noContent, noContent, response;
-    return _regenerator.default.wrap(function _callee6$(_context6) {
-      while (1) switch (_context6.prev = _context6.next) {
+  var _ref11 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(_ref10) {
+    var documentAri, blocks, _ref10$noContent, noContent, response;
+    return _regenerator.default.wrap(function _callee7$(_context7) {
+      while (1) switch (_context7.prev = _context7.next) {
         case 0:
-          documentAri = _ref0.documentAri, blocks = _ref0.blocks, _ref0$noContent = _ref0.noContent, noContent = _ref0$noContent === void 0 ? true : _ref0$noContent;
-          _context6.next = 3;
+          documentAri = _ref10.documentAri, blocks = _ref10.blocks, _ref10$noContent = _ref10.noContent, noContent = _ref10$noContent === void 0 ? true : _ref10$noContent;
+          _context7.next = 3;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/document/").concat(encodeURIComponent(documentAri), "/references?noContent=").concat(noContent), {
             method: 'PUT',
             headers: COMMON_HEADERS,
@@ -295,28 +341,28 @@ var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnD
             })
           });
         case 3:
-          response = _context6.sent;
+          response = _context7.sent;
           if (response.ok) {
-            _context6.next = 6;
+            _context7.next = 6;
             break;
           }
           throw new BlockError(response.status);
         case 6:
           if (noContent) {
-            _context6.next = 10;
+            _context7.next = 10;
             break;
           }
-          _context6.next = 9;
+          _context7.next = 9;
           return response.json();
         case 9:
-          return _context6.abrupt("return", _context6.sent);
+          return _context7.abrupt("return", _context7.sent);
         case 10:
         case "end":
-          return _context6.stop();
+          return _context7.stop();
       }
-    }, _callee6);
+    }, _callee7);
   }));
-  return function updateReferenceSyncedBlockOnDocument(_x6) {
-    return _ref1.apply(this, arguments);
+  return function updateReferenceSyncedBlockOnDocument(_x7) {
+    return _ref11.apply(this, arguments);
   };
 }();