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

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @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

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

@@ -130,6 +130,7 @@ 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}");
 };
@@ -187,6 +188,9 @@ var buildBatchRetrieveBlocksQuery = function buildBatchRetrieveBlocksQuery(block
   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;
@@ -665,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

@@ -79,6 +79,7 @@ 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 {
@@ -213,6 +214,24 @@ const buildBatchRetrieveBlocksQuery = blockAris => {
 	}
 }`;
 };
+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`);
@@ -475,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

@@ -123,6 +123,7 @@ 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}");
 };
@@ -180,6 +181,9 @@ var buildBatchRetrieveBlocksQuery = function buildBatchRetrieveBlocksQuery(block
   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;
@@ -658,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/package.json

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