@atlaskit/editor-synced-block-provider 3.23.0 → 3.25.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.25.0
+
+### Minor Changes
+
+- [`1ded312f31a41`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1ded312f31a41) -
+  Fetch references by blockAri uses GraphQL endpoint
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.24.0
+
+### Minor Changes
+
+- [`79754ae4abb79`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/79754ae4abb79) -
+  Use GraphQL query for batch retrieve blocks
+
 ## 3.23.0
 
 ### Minor Changes

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

@@ -129,6 +129,8 @@ var UPDATE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_BLOCK';
 var DELETE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_DELETE_BLOCK';
 var CREATE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_CREATE_BLOCK';
 var UPDATE_DOCUMENT_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_DOCUMENT_REFERENCES';
+var BATCH_RETRIEVE_BLOCKS_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_BATCH_RETRIEVE_BLOCKS';
+var GET_BLOCK_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_REFERENCES';
 var buildGetDocumentReferenceBlocksQuery = function buildGetDocumentReferenceBlocksQuery(documentAri) {
   return "query ".concat(GET_DOCUMENT_REFERENCE_BLOCKS_OPERATION_NAME, " {\n\tblockService_getDocumentReferenceBlocks(documentAri: \"").concat(documentAri, "\") {\n\t\tblocks {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcontent\n\t\t\tcontentUpdatedAt\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tproduct\n\t\t\tsourceAri\n\t\t\tstatus\n\t\t\tversion\n\t\t}\n\t\terrors {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
 };
@@ -179,6 +181,16 @@ var buildUpdateDocumentReferencesMutation = function buildUpdateDocumentReferenc
   var inputArgs = "documentAri: ".concat(JSON.stringify(documentAri), ", blocks: [").concat(blocksArray, "], noContent: ").concat(noContent);
   return "mutation ".concat(UPDATE_DOCUMENT_REFERENCES_OPERATION_NAME, " {\n\tblockService_updateDocumentReferences(input: { ").concat(inputArgs, " }) {\n\t\tblocks {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcontent\n\t\t\tcontentUpdatedAt\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tproduct\n\t\t\tsourceAri\n\t\t\tstatus\n\t\t\tversion\n\t\t}\n\t\terrors {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
 };
+var buildBatchRetrieveBlocksQuery = function buildBatchRetrieveBlocksQuery(blockAris) {
+  var blockArisArray = blockAris.map(function (ari) {
+    return JSON.stringify(ari);
+  }).join(', ');
+  var inputArgs = "blockAris: [".concat(blockArisArray, "]");
+  return "query ".concat(BATCH_RETRIEVE_BLOCKS_OPERATION_NAME, " {\n\tblockService_batchRetrieveBlocks(input: { ").concat(inputArgs, " }) {\n\t\tsuccess {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcontent\n\t\t\tcontentUpdatedAt\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tdeletionReason\n\t\t\tproduct\n\t\t\tsourceAri\n\t\t\tstatus\n\t\t\tversion\n\t\t}\n\t\terror {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
+};
+var buildGetBlockReferencesQuery = function buildGetBlockReferencesQuery(blockAri) {
+  return "query ".concat(GET_BLOCK_REFERENCES_OPERATION_NAME, " {\n\tblockService_getReferences(blockAri: ").concat(JSON.stringify(blockAri), ") {\n\t\treferences {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tdocumentAri\n\t\t}\n\t\terrors {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
+};
 var BlockError = exports.BlockError = /*#__PURE__*/function (_Error) {
   function BlockError(status) {
     var _this;
@@ -233,18 +245,68 @@ var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/functio
  * Batch retrieves multiple synced blocks by their ARIs.
  *
  * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
  *
  * @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 blockIdentifiers, documentAri, response;
+    var blockIdentifiers, documentAri, _result$data, blockAris, bodyData, _response, result, graphqlResponse, response;
     return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
           blockIdentifiers = _ref4.blockIdentifiers, documentAri = _ref4.documentAri;
-          _context3.next = 3;
+          if (!(0, _platformFeatureFlags.fg)('platform_synced_block_patch_1')) {
+            _context3.next = 18;
+            break;
+          }
+          blockAris = blockIdentifiers.map(function (blockIdentifier) {
+            return blockIdentifier.blockAri;
+          });
+          bodyData = {
+            query: buildBatchRetrieveBlocksQuery(blockAris),
+            operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
+          };
+          _context3.next = 6;
+          return (0, _retry.fetchWithRetry)(GRAPHQL_ENDPOINT, {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify(bodyData)
+          });
+        case 6:
+          _response = _context3.sent;
+          if (_response.ok) {
+            _context3.next = 9;
+            break;
+          }
+          throw new BlockError(_response.status);
+        case 9:
+          _context3.next = 11;
+          return _response.json();
+        case 11:
+          result = _context3.sent;
+          if (!(result.errors && result.errors.length > 0)) {
+            _context3.next = 14;
+            break;
+          }
+          throw new Error(result.errors.map(function (e) {
+            return e.message;
+          }).join(', '));
+        case 14:
+          if ((_result$data = result.data) !== null && _result$data !== void 0 && _result$data.blockService_batchRetrieveBlocks) {
+            _context3.next = 16;
+            break;
+          }
+          throw new Error('No data returned from GraphQL query');
+        case 16:
+          graphqlResponse = result.data.blockService_batchRetrieveBlocks;
+          return _context3.abrupt("return", {
+            success: graphqlResponse.success,
+            error: graphqlResponse.error
+          });
+        case 18:
+          _context3.next = 20;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/batch-retrieve"), {
             method: 'POST',
             headers: COMMON_HEADERS,
@@ -256,19 +318,19 @@ var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*
               })
             })
           });
-        case 3:
+        case 20:
           response = _context3.sent;
           if (response.ok) {
-            _context3.next = 6;
+            _context3.next = 23;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context3.next = 8;
+        case 23:
+          _context3.next = 25;
           return response.json();
-        case 8:
+        case 25:
           return _context3.abrupt("return", _context3.sent);
-        case 9:
+        case 26:
         case "end":
           return _context3.stop();
       }
@@ -280,7 +342,7 @@ var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*
 }();
 var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
   var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(_ref6) {
-    var blockAri, deleteReason, _result$data, bodyData, _response, result, url, response;
+    var blockAri, deleteReason, _result$data2, bodyData, _response2, result, url, response;
     return _regenerator.default.wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
@@ -300,15 +362,15 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
             body: JSON.stringify(bodyData)
           });
         case 5:
-          _response = _context4.sent;
-          if (_response.ok) {
+          _response2 = _context4.sent;
+          if (_response2.ok) {
             _context4.next = 8;
             break;
           }
-          throw new BlockError(_response.status);
+          throw new BlockError(_response2.status);
         case 8:
           _context4.next = 10;
-          return _response.json();
+          return _response2.json();
         case 10:
           result = _context4.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -319,7 +381,7 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
             return e.message;
           }).join(', '));
         case 13:
-          if ((_result$data = result.data) !== null && _result$data !== void 0 && _result$data.blockService_deleteBlock.deleted) {
+          if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_deleteBlock.deleted) {
             _context4.next = 15;
             break;
           }
@@ -352,7 +414,7 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
 }();
 var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
   var _ref9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(_ref8) {
-    var blockAri, content, stepVersion, bodyData, _response2, result, requestBody, response;
+    var blockAri, content, stepVersion, bodyData, _response3, result, requestBody, response;
     return _regenerator.default.wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
@@ -372,15 +434,15 @@ var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
             body: JSON.stringify(bodyData)
           });
         case 5:
-          _response2 = _context5.sent;
-          if (_response2.ok) {
+          _response3 = _context5.sent;
+          if (_response3.ok) {
             _context5.next = 8;
             break;
           }
-          throw new BlockError(_response2.status);
+          throw new BlockError(_response3.status);
         case 8:
           _context5.next = 10;
-          return _response2.json();
+          return _response3.json();
         case 10:
           result = _context5.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -424,7 +486,7 @@ var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
 }();
 var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
   var _ref1 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(_ref0) {
-    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, _result$data2, bodyData, _response3, result, requestBody, response;
+    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, _result$data3, bodyData, _response4, result, requestBody, response;
     return _regenerator.default.wrap(function _callee6$(_context6) {
       while (1) switch (_context6.prev = _context6.next) {
         case 0:
@@ -444,15 +506,15 @@ var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
             body: JSON.stringify(bodyData)
           });
         case 5:
-          _response3 = _context6.sent;
-          if (_response3.ok) {
+          _response4 = _context6.sent;
+          if (_response4.ok) {
             _context6.next = 8;
             break;
           }
-          throw new BlockError(_response3.status);
+          throw new BlockError(_response4.status);
         case 8:
           _context6.next = 10;
-          return _response3.json();
+          return _response4.json();
         case 10:
           result = _context6.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -463,7 +525,7 @@ var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
             return e.message;
           }).join(', '));
         case 13:
-          if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_createBlock) {
+          if ((_result$data3 = result.data) !== null && _result$data3 !== void 0 && _result$data3.blockService_createBlock) {
             _context6.next = 15;
             break;
           }
@@ -514,7 +576,7 @@ var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
 }();
 var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
   var _ref11 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(_ref10) {
-    var documentAri, blocks, _ref10$noContent, noContent, bodyData, _response4, result, _result$data3, response;
+    var documentAri, blocks, _ref10$noContent, noContent, bodyData, _response5, result, _result$data4, response;
     return _regenerator.default.wrap(function _callee7$(_context7) {
       while (1) switch (_context7.prev = _context7.next) {
         case 0:
@@ -536,15 +598,15 @@ var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnD
             keepalive: true
           } : {}));
         case 5:
-          _response4 = _context7.sent;
-          if (_response4.ok) {
+          _response5 = _context7.sent;
+          if (_response5.ok) {
             _context7.next = 8;
             break;
           }
-          throw new BlockError(_response4.status);
+          throw new BlockError(_response5.status);
         case 8:
           _context7.next = 10;
-          return _response4.json();
+          return _response5.json();
         case 10:
           result = _context7.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -559,7 +621,7 @@ var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnD
             _context7.next = 17;
             break;
           }
-          if ((_result$data3 = result.data) !== null && _result$data3 !== void 0 && _result$data3.blockService_updateDocumentReferences) {
+          if ((_result$data4 = result.data) !== null && _result$data4 !== void 0 && _result$data4.blockService_updateDocumentReferences) {
             _context7.next = 16;
             break;
           }
@@ -607,29 +669,76 @@ var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnD
 }();
 var getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocksByBlockAri = /*#__PURE__*/function () {
   var _ref13 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(_ref12) {
-    var blockAri, response;
+    var blockAri, _result$data5, bodyData, _response6, result, graphqlResponse, response;
     return _regenerator.default.wrap(function _callee8$(_context8) {
       while (1) switch (_context8.prev = _context8.next) {
         case 0:
           blockAri = _ref12.blockAri;
-          _context8.next = 3;
+          if (!(0, _platformFeatureFlags.fg)('platform_synced_block_patch_1')) {
+            _context8.next = 17;
+            break;
+          }
+          bodyData = {
+            query: buildGetBlockReferencesQuery(blockAri),
+            operationName: GET_BLOCK_REFERENCES_OPERATION_NAME
+          };
+          _context8.next = 5;
+          return (0, _retry.fetchWithRetry)(GRAPHQL_ENDPOINT, {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify(bodyData)
+          });
+        case 5:
+          _response6 = _context8.sent;
+          if (_response6.ok) {
+            _context8.next = 8;
+            break;
+          }
+          throw new BlockError(_response6.status);
+        case 8:
+          _context8.next = 10;
+          return _response6.json();
+        case 10:
+          result = _context8.sent;
+          if (!(result.errors && result.errors.length > 0)) {
+            _context8.next = 13;
+            break;
+          }
+          throw new Error(result.errors.map(function (e) {
+            return e.message;
+          }).join(', '));
+        case 13:
+          if ((_result$data5 = result.data) !== null && _result$data5 !== void 0 && _result$data5.blockService_getReferences) {
+            _context8.next = 15;
+            break;
+          }
+          throw new Error('No data returned from GraphQL query');
+        case 15:
+          graphqlResponse = result.data.blockService_getReferences;
+          return _context8.abrupt("return", {
+            blockAri: blockAri,
+            references: graphqlResponse.references || [],
+            errors: graphqlResponse.errors || []
+          });
+        case 17:
+          _context8.next = 19;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/reference/batch-retrieve/").concat(encodeURIComponent(blockAri)), {
             method: 'GET',
             headers: COMMON_HEADERS
           });
-        case 3:
+        case 19:
           response = _context8.sent;
           if (response.ok) {
-            _context8.next = 6;
+            _context8.next = 22;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context8.next = 8;
+        case 22:
+          _context8.next = 24;
           return response.json();
-        case 8:
+        case 24:
           return _context8.abrupt("return", _context8.sent);
-        case 9:
+        case 25:
         case "end":
           return _context8.stop();
       }

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

@@ -78,6 +78,8 @@ const UPDATE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_BLOCK';
 const DELETE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_DELETE_BLOCK';
 const CREATE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_CREATE_BLOCK';
 const UPDATE_DOCUMENT_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_DOCUMENT_REFERENCES';
+const BATCH_RETRIEVE_BLOCKS_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_BATCH_RETRIEVE_BLOCKS';
+const GET_BLOCK_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_REFERENCES';
 const buildGetDocumentReferenceBlocksQuery = documentAri => `query ${GET_DOCUMENT_REFERENCE_BLOCKS_OPERATION_NAME} {
 	blockService_getDocumentReferenceBlocks(documentAri: "${documentAri}") {
 		blocks {
@@ -186,6 +188,50 @@ const buildUpdateDocumentReferencesMutation = (documentAri, blocks, noContent) =
 	}
 }`;
 };
+const buildBatchRetrieveBlocksQuery = blockAris => {
+  const blockArisArray = blockAris.map(ari => JSON.stringify(ari)).join(', ');
+  const inputArgs = `blockAris: [${blockArisArray}]`;
+  return `query ${BATCH_RETRIEVE_BLOCKS_OPERATION_NAME} {
+	blockService_batchRetrieveBlocks(input: { ${inputArgs} }) {
+		success {
+			blockAri
+			blockInstanceId
+			content
+			contentUpdatedAt
+			createdAt
+			createdBy
+			deletionReason
+			product
+			sourceAri
+			status
+			version
+		}
+		error {
+			blockAri
+			code
+			reason
+		}
+	}
+}`;
+};
+const buildGetBlockReferencesQuery = blockAri => {
+  return `query ${GET_BLOCK_REFERENCES_OPERATION_NAME} {
+	blockService_getReferences(blockAri: ${JSON.stringify(blockAri)}) {
+		references {
+			blockAri
+			blockInstanceId
+			createdAt
+			createdBy
+			documentAri
+		}
+		errors {
+			blockAri
+			code
+			reason
+		}
+	}
+}`;
+};
 export class BlockError extends Error {
   constructor(status) {
     super(`Block error`);
@@ -213,6 +259,7 @@ export const getSyncedBlockContent = async ({
  * Batch retrieves multiple synced blocks by their ARIs.
  *
  * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
  *
  * @param blockAris - Array of block ARIs to retrieve
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
@@ -221,6 +268,34 @@ export const batchRetrieveSyncedBlocks = async ({
   blockIdentifiers,
   documentAri
 }) => {
+  if (fg('platform_synced_block_patch_1')) {
+    var _result$data;
+    const blockAris = blockIdentifiers.map(blockIdentifier => blockIdentifier.blockAri);
+    const bodyData = {
+      query: buildBatchRetrieveBlocksQuery(blockAris),
+      operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
+    };
+    const response = await fetchWithRetry(GRAPHQL_ENDPOINT, {
+      method: 'POST',
+      headers: COMMON_HEADERS,
+      body: JSON.stringify(bodyData)
+    });
+    if (!response.ok) {
+      throw new BlockError(response.status);
+    }
+    const result = await response.json();
+    if (result.errors && result.errors.length > 0) {
+      throw new Error(result.errors.map(e => e.message).join(', '));
+    }
+    if (!((_result$data = result.data) !== null && _result$data !== void 0 && _result$data.blockService_batchRetrieveBlocks)) {
+      throw new Error('No data returned from GraphQL query');
+    }
+    const graphqlResponse = result.data.blockService_batchRetrieveBlocks;
+    return {
+      success: graphqlResponse.success,
+      error: graphqlResponse.error
+    };
+  }
   const response = await fetchWithRetry(`${BLOCK_SERVICE_API_URL}/block/batch-retrieve`, {
     method: 'POST',
     headers: COMMON_HEADERS,
@@ -240,7 +315,7 @@ export const deleteSyncedBlock = async ({
   deleteReason
 }) => {
   if (fg('platform_synced_block_patch_1')) {
-    var _result$data;
+    var _result$data2;
     const bodyData = {
       query: buildDeleteBlockMutation(blockAri, deleteReason),
       operationName: DELETE_BLOCK_OPERATION_NAME
@@ -257,7 +332,7 @@ export const deleteSyncedBlock = async ({
     if (result.errors && result.errors.length > 0) {
       throw new Error(result.errors.map(e => e.message).join(', '));
     }
-    if (!((_result$data = result.data) !== null && _result$data !== void 0 && _result$data.blockService_deleteBlock.deleted)) {
+    if (!((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_deleteBlock.deleted)) {
       throw new Error('Block deletion failed; deleted flag is false');
     }
     return;
@@ -320,7 +395,7 @@ export const createSyncedBlock = async ({
   status
 }) => {
   if (fg('platform_synced_block_patch_1')) {
-    var _result$data2;
+    var _result$data3;
     const bodyData = {
       query: buildCreateBlockMutation(blockAri, blockInstanceId, content, product, sourceAri, stepVersion, status !== undefined && fg('platform_synced_block_dogfooding') ? status : undefined),
       operationName: CREATE_BLOCK_OPERATION_NAME
@@ -337,7 +412,7 @@ export const createSyncedBlock = async ({
     if (result.errors && result.errors.length > 0) {
       throw new Error(result.errors.map(e => e.message).join(', '));
     }
-    if (!((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_createBlock)) {
+    if (!((_result$data3 = result.data) !== null && _result$data3 !== void 0 && _result$data3.blockService_createBlock)) {
       throw new Error('No data returned from GraphQL mutation');
     }
     return result.data.blockService_createBlock;
@@ -391,8 +466,8 @@ export const updateReferenceSyncedBlockOnDocument = async ({
       throw new Error(result.errors.map(e => e.message).join(', '));
     }
     if (!noContent) {
-      var _result$data3;
-      if (!((_result$data3 = result.data) !== null && _result$data3 !== void 0 && _result$data3.blockService_updateDocumentReferences)) {
+      var _result$data4;
+      if (!((_result$data4 = result.data) !== null && _result$data4 !== void 0 && _result$data4.blockService_updateDocumentReferences)) {
         throw new Error('No data returned from GraphQL mutation');
       }
       return result.data.blockService_updateDocumentReferences;
@@ -419,6 +494,34 @@ export const updateReferenceSyncedBlockOnDocument = async ({
 export const getReferenceSyncedBlocksByBlockAri = async ({
   blockAri
 }) => {
+  if (fg('platform_synced_block_patch_1')) {
+    var _result$data5;
+    const bodyData = {
+      query: buildGetBlockReferencesQuery(blockAri),
+      operationName: GET_BLOCK_REFERENCES_OPERATION_NAME
+    };
+    const response = await fetchWithRetry(GRAPHQL_ENDPOINT, {
+      method: 'POST',
+      headers: COMMON_HEADERS,
+      body: JSON.stringify(bodyData)
+    });
+    if (!response.ok) {
+      throw new BlockError(response.status);
+    }
+    const result = await response.json();
+    if (result.errors && result.errors.length > 0) {
+      throw new Error(result.errors.map(e => e.message).join(', '));
+    }
+    if (!((_result$data5 = result.data) !== null && _result$data5 !== void 0 && _result$data5.blockService_getReferences)) {
+      throw new Error('No data returned from GraphQL query');
+    }
+    const graphqlResponse = result.data.blockService_getReferences;
+    return {
+      blockAri,
+      references: graphqlResponse.references || [],
+      errors: graphqlResponse.errors || []
+    };
+  }
   const response = await fetchWithRetry(`${BLOCK_SERVICE_API_URL}/reference/batch-retrieve/${encodeURIComponent(blockAri)}`, {
     method: 'GET',
     headers: COMMON_HEADERS

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

@@ -122,6 +122,8 @@ var UPDATE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_BLOCK';
 var DELETE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_DELETE_BLOCK';
 var CREATE_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_CREATE_BLOCK';
 var UPDATE_DOCUMENT_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_DOCUMENT_REFERENCES';
+var BATCH_RETRIEVE_BLOCKS_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_BATCH_RETRIEVE_BLOCKS';
+var GET_BLOCK_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_REFERENCES';
 var buildGetDocumentReferenceBlocksQuery = function buildGetDocumentReferenceBlocksQuery(documentAri) {
   return "query ".concat(GET_DOCUMENT_REFERENCE_BLOCKS_OPERATION_NAME, " {\n\tblockService_getDocumentReferenceBlocks(documentAri: \"").concat(documentAri, "\") {\n\t\tblocks {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcontent\n\t\t\tcontentUpdatedAt\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tproduct\n\t\t\tsourceAri\n\t\t\tstatus\n\t\t\tversion\n\t\t}\n\t\terrors {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
 };
@@ -172,6 +174,16 @@ var buildUpdateDocumentReferencesMutation = function buildUpdateDocumentReferenc
   var inputArgs = "documentAri: ".concat(JSON.stringify(documentAri), ", blocks: [").concat(blocksArray, "], noContent: ").concat(noContent);
   return "mutation ".concat(UPDATE_DOCUMENT_REFERENCES_OPERATION_NAME, " {\n\tblockService_updateDocumentReferences(input: { ").concat(inputArgs, " }) {\n\t\tblocks {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcontent\n\t\t\tcontentUpdatedAt\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tproduct\n\t\t\tsourceAri\n\t\t\tstatus\n\t\t\tversion\n\t\t}\n\t\terrors {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
 };
+var buildBatchRetrieveBlocksQuery = function buildBatchRetrieveBlocksQuery(blockAris) {
+  var blockArisArray = blockAris.map(function (ari) {
+    return JSON.stringify(ari);
+  }).join(', ');
+  var inputArgs = "blockAris: [".concat(blockArisArray, "]");
+  return "query ".concat(BATCH_RETRIEVE_BLOCKS_OPERATION_NAME, " {\n\tblockService_batchRetrieveBlocks(input: { ").concat(inputArgs, " }) {\n\t\tsuccess {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcontent\n\t\t\tcontentUpdatedAt\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tdeletionReason\n\t\t\tproduct\n\t\t\tsourceAri\n\t\t\tstatus\n\t\t\tversion\n\t\t}\n\t\terror {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
+};
+var buildGetBlockReferencesQuery = function buildGetBlockReferencesQuery(blockAri) {
+  return "query ".concat(GET_BLOCK_REFERENCES_OPERATION_NAME, " {\n\tblockService_getReferences(blockAri: ").concat(JSON.stringify(blockAri), ") {\n\t\treferences {\n\t\t\tblockAri\n\t\t\tblockInstanceId\n\t\t\tcreatedAt\n\t\t\tcreatedBy\n\t\t\tdocumentAri\n\t\t}\n\t\terrors {\n\t\t\tblockAri\n\t\t\tcode\n\t\t\treason\n\t\t}\n\t}\n}");
+};
 export var BlockError = /*#__PURE__*/function (_Error) {
   function BlockError(status) {
     var _this;
@@ -226,18 +238,68 @@ export var getSyncedBlockContent = /*#__PURE__*/function () {
  * Batch retrieves multiple synced blocks by their ARIs.
  *
  * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
  *
  * @param blockAris - Array of block ARIs to retrieve
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
  */
 export var batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
   var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref4) {
-    var blockIdentifiers, documentAri, response;
+    var blockIdentifiers, documentAri, _result$data, blockAris, bodyData, _response, result, graphqlResponse, response;
     return _regeneratorRuntime.wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
           blockIdentifiers = _ref4.blockIdentifiers, documentAri = _ref4.documentAri;
-          _context3.next = 3;
+          if (!fg('platform_synced_block_patch_1')) {
+            _context3.next = 18;
+            break;
+          }
+          blockAris = blockIdentifiers.map(function (blockIdentifier) {
+            return blockIdentifier.blockAri;
+          });
+          bodyData = {
+            query: buildBatchRetrieveBlocksQuery(blockAris),
+            operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
+          };
+          _context3.next = 6;
+          return fetchWithRetry(GRAPHQL_ENDPOINT, {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify(bodyData)
+          });
+        case 6:
+          _response = _context3.sent;
+          if (_response.ok) {
+            _context3.next = 9;
+            break;
+          }
+          throw new BlockError(_response.status);
+        case 9:
+          _context3.next = 11;
+          return _response.json();
+        case 11:
+          result = _context3.sent;
+          if (!(result.errors && result.errors.length > 0)) {
+            _context3.next = 14;
+            break;
+          }
+          throw new Error(result.errors.map(function (e) {
+            return e.message;
+          }).join(', '));
+        case 14:
+          if ((_result$data = result.data) !== null && _result$data !== void 0 && _result$data.blockService_batchRetrieveBlocks) {
+            _context3.next = 16;
+            break;
+          }
+          throw new Error('No data returned from GraphQL query');
+        case 16:
+          graphqlResponse = result.data.blockService_batchRetrieveBlocks;
+          return _context3.abrupt("return", {
+            success: graphqlResponse.success,
+            error: graphqlResponse.error
+          });
+        case 18:
+          _context3.next = 20;
           return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/block/batch-retrieve"), {
             method: 'POST',
             headers: COMMON_HEADERS,
@@ -249,19 +311,19 @@ export var batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
               })
             })
           });
-        case 3:
+        case 20:
           response = _context3.sent;
           if (response.ok) {
-            _context3.next = 6;
+            _context3.next = 23;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context3.next = 8;
+        case 23:
+          _context3.next = 25;
           return response.json();
-        case 8:
+        case 25:
           return _context3.abrupt("return", _context3.sent);
-        case 9:
+        case 26:
         case "end":
           return _context3.stop();
       }
@@ -273,7 +335,7 @@ export var batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
 }();
 export var deleteSyncedBlock = /*#__PURE__*/function () {
   var _ref7 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref6) {
-    var blockAri, deleteReason, _result$data, bodyData, _response, result, url, response;
+    var blockAri, deleteReason, _result$data2, bodyData, _response2, result, url, response;
     return _regeneratorRuntime.wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
@@ -293,15 +355,15 @@ export var deleteSyncedBlock = /*#__PURE__*/function () {
             body: JSON.stringify(bodyData)
           });
         case 5:
-          _response = _context4.sent;
-          if (_response.ok) {
+          _response2 = _context4.sent;
+          if (_response2.ok) {
             _context4.next = 8;
             break;
           }
-          throw new BlockError(_response.status);
+          throw new BlockError(_response2.status);
         case 8:
           _context4.next = 10;
-          return _response.json();
+          return _response2.json();
         case 10:
           result = _context4.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -312,7 +374,7 @@ export var deleteSyncedBlock = /*#__PURE__*/function () {
             return e.message;
           }).join(', '));
         case 13:
-          if ((_result$data = result.data) !== null && _result$data !== void 0 && _result$data.blockService_deleteBlock.deleted) {
+          if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_deleteBlock.deleted) {
             _context4.next = 15;
             break;
           }
@@ -345,7 +407,7 @@ export var deleteSyncedBlock = /*#__PURE__*/function () {
 }();
 export var updateSyncedBlock = /*#__PURE__*/function () {
   var _ref9 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(_ref8) {
-    var blockAri, content, stepVersion, bodyData, _response2, result, requestBody, response;
+    var blockAri, content, stepVersion, bodyData, _response3, result, requestBody, response;
     return _regeneratorRuntime.wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
@@ -365,15 +427,15 @@ export var updateSyncedBlock = /*#__PURE__*/function () {
             body: JSON.stringify(bodyData)
           });
         case 5:
-          _response2 = _context5.sent;
-          if (_response2.ok) {
+          _response3 = _context5.sent;
+          if (_response3.ok) {
             _context5.next = 8;
             break;
           }
-          throw new BlockError(_response2.status);
+          throw new BlockError(_response3.status);
         case 8:
           _context5.next = 10;
-          return _response2.json();
+          return _response3.json();
         case 10:
           result = _context5.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -417,7 +479,7 @@ export var updateSyncedBlock = /*#__PURE__*/function () {
 }();
 export var createSyncedBlock = /*#__PURE__*/function () {
   var _ref1 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(_ref0) {
-    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, _result$data2, bodyData, _response3, result, requestBody, response;
+    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, _result$data3, bodyData, _response4, result, requestBody, response;
     return _regeneratorRuntime.wrap(function _callee6$(_context6) {
       while (1) switch (_context6.prev = _context6.next) {
         case 0:
@@ -437,15 +499,15 @@ export var createSyncedBlock = /*#__PURE__*/function () {
             body: JSON.stringify(bodyData)
           });
         case 5:
-          _response3 = _context6.sent;
-          if (_response3.ok) {
+          _response4 = _context6.sent;
+          if (_response4.ok) {
             _context6.next = 8;
             break;
           }
-          throw new BlockError(_response3.status);
+          throw new BlockError(_response4.status);
         case 8:
           _context6.next = 10;
-          return _response3.json();
+          return _response4.json();
         case 10:
           result = _context6.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -456,7 +518,7 @@ export var createSyncedBlock = /*#__PURE__*/function () {
             return e.message;
           }).join(', '));
         case 13:
-          if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_createBlock) {
+          if ((_result$data3 = result.data) !== null && _result$data3 !== void 0 && _result$data3.blockService_createBlock) {
             _context6.next = 15;
             break;
           }
@@ -507,7 +569,7 @@ export var createSyncedBlock = /*#__PURE__*/function () {
 }();
 export var updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
   var _ref11 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(_ref10) {
-    var documentAri, blocks, _ref10$noContent, noContent, bodyData, _response4, result, _result$data3, response;
+    var documentAri, blocks, _ref10$noContent, noContent, bodyData, _response5, result, _result$data4, response;
     return _regeneratorRuntime.wrap(function _callee7$(_context7) {
       while (1) switch (_context7.prev = _context7.next) {
         case 0:
@@ -529,15 +591,15 @@ export var updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
             keepalive: true
           } : {}));
         case 5:
-          _response4 = _context7.sent;
-          if (_response4.ok) {
+          _response5 = _context7.sent;
+          if (_response5.ok) {
             _context7.next = 8;
             break;
           }
-          throw new BlockError(_response4.status);
+          throw new BlockError(_response5.status);
         case 8:
           _context7.next = 10;
-          return _response4.json();
+          return _response5.json();
         case 10:
           result = _context7.sent;
           if (!(result.errors && result.errors.length > 0)) {
@@ -552,7 +614,7 @@ export var updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
             _context7.next = 17;
             break;
           }
-          if ((_result$data3 = result.data) !== null && _result$data3 !== void 0 && _result$data3.blockService_updateDocumentReferences) {
+          if ((_result$data4 = result.data) !== null && _result$data4 !== void 0 && _result$data4.blockService_updateDocumentReferences) {
             _context7.next = 16;
             break;
           }
@@ -600,29 +662,76 @@ export var updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
 }();
 export var getReferenceSyncedBlocksByBlockAri = /*#__PURE__*/function () {
   var _ref13 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8(_ref12) {
-    var blockAri, response;
+    var blockAri, _result$data5, bodyData, _response6, result, graphqlResponse, response;
     return _regeneratorRuntime.wrap(function _callee8$(_context8) {
       while (1) switch (_context8.prev = _context8.next) {
         case 0:
           blockAri = _ref12.blockAri;
-          _context8.next = 3;
+          if (!fg('platform_synced_block_patch_1')) {
+            _context8.next = 17;
+            break;
+          }
+          bodyData = {
+            query: buildGetBlockReferencesQuery(blockAri),
+            operationName: GET_BLOCK_REFERENCES_OPERATION_NAME
+          };
+          _context8.next = 5;
+          return fetchWithRetry(GRAPHQL_ENDPOINT, {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify(bodyData)
+          });
+        case 5:
+          _response6 = _context8.sent;
+          if (_response6.ok) {
+            _context8.next = 8;
+            break;
+          }
+          throw new BlockError(_response6.status);
+        case 8:
+          _context8.next = 10;
+          return _response6.json();
+        case 10:
+          result = _context8.sent;
+          if (!(result.errors && result.errors.length > 0)) {
+            _context8.next = 13;
+            break;
+          }
+          throw new Error(result.errors.map(function (e) {
+            return e.message;
+          }).join(', '));
+        case 13:
+          if ((_result$data5 = result.data) !== null && _result$data5 !== void 0 && _result$data5.blockService_getReferences) {
+            _context8.next = 15;
+            break;
+          }
+          throw new Error('No data returned from GraphQL query');
+        case 15:
+          graphqlResponse = result.data.blockService_getReferences;
+          return _context8.abrupt("return", {
+            blockAri: blockAri,
+            references: graphqlResponse.references || [],
+            errors: graphqlResponse.errors || []
+          });
+        case 17:
+          _context8.next = 19;
           return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/reference/batch-retrieve/").concat(encodeURIComponent(blockAri)), {
             method: 'GET',
             headers: COMMON_HEADERS
           });
-        case 3:
+        case 19:
           response = _context8.sent;
           if (response.ok) {
-            _context8.next = 6;
+            _context8.next = 22;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context8.next = 8;
+        case 22:
+          _context8.next = 24;
           return response.json();
-        case 8:
+        case 24:
           return _context8.abrupt("return", _context8.sent);
-        case 9:
+        case 25:
         case "end":
           return _context8.stop();
       }

package/dist/types/clients/block-service/blockService.d.ts

@@ -125,6 +125,7 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
  * Batch retrieves multiple synced blocks by their ARIs.
  *
  * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
  *
  * @param blockAris - Array of block ARIs to retrieve
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered

package/dist/types-ts4.5/clients/block-service/blockService.d.ts

@@ -125,6 +125,7 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
  * Batch retrieves multiple synced blocks by their ARIs.
  *
  * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
  *
  * @param blockAris - Array of block ARIs to retrieve
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered

package/package.json

@@ -79,7 +79,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.23.0",
+	"version": "3.25.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",