@atlaskit/editor-synced-block-provider 3.30.6 → 3.31.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.31.0
+
+### Minor Changes
+
+- [`6590226f4f11a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6590226f4f11a) -
+  EDITOR-2914 implement bulk update for synced blocks
+
+### Patch Changes
+
+- [`f4633c591d70f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f4633c591d70f) -
+  Revert 610719f because the query stopped sending
+- Updated dependencies
+
 ## 3.30.6
 
 ### 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.getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockError = void 0;
+exports.updateSyncedBlocks = exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocksByBlockAri = 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"));
@@ -129,6 +129,7 @@ var UPDATE_DOCUMENT_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE_DOCU
 var BATCH_RETRIEVE_BLOCKS_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_BATCH_RETRIEVE_BLOCKS';
 var GET_BLOCK_REFERENCES_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_REFERENCES';
 var GET_BLOCK_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_BLOCK';
+var BATCH_UPDATE_BLOCKS_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_BATCH_UPDATE_BLOCKS';
 var buildGetDocumentReferenceBlocksQuery = function buildGetDocumentReferenceBlocksQuery(documentAri) {
   return "query ".concat(GET_DOCUMENT_REFERENCE_BLOCKS_OPERATION_NAME, " {\n\tblockService_getDocumentReferenceBlocks(documentAri: ").concat((0, _platformFeatureFlags.fg)('platform_synced_block_patch_4') ? JSON.stringify(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}");
 };
@@ -201,6 +202,19 @@ var buildBatchRetrieveBlocksQuery = function buildBatchRetrieveBlocksQuery(block
 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 buildBatchUpdateBlocksMutation = function buildBatchUpdateBlocksMutation(blocks) {
+  var blocksArray = blocks.map(function (block) {
+    var inputParts = ["blockAri: ".concat(JSON.stringify(block.blockAri)), "content: ".concat(JSON.stringify(block.content))];
+    if (block.stepVersion !== undefined) {
+      inputParts.push("stepVersion: ".concat(block.stepVersion));
+    }
+    if (block.status !== undefined) {
+      inputParts.push("status: ".concat(JSON.stringify(block.status)));
+    }
+    return "{ ".concat(inputParts.join(', '), " }");
+  }).join(', ');
+  return "mutation ".concat(BATCH_UPDATE_BLOCKS_OPERATION_NAME, " {\n\tblockService_batchUpdateBlocks(input: { blocks: [").concat(blocksArray, "] }) {\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 BlockError = exports.BlockError = /*#__PURE__*/function (_Error) {
   function BlockError(status) {
     var _this;
@@ -618,4 +632,87 @@ var getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocksByBlock
   return function getReferenceSyncedBlocksByBlockAri(_x8) {
     return _ref13.apply(this, arguments);
   };
+}();
+
+/**
+ * Batch updates multiple synced blocks.
+ *
+ * Calls the Block Service GraphQL API: `blockService_batchUpdateBlocks`
+ *
+ * @param blocks - Array of block updates to apply
+ * @returns A promise containing arrays of successfully updated blocks and any errors encountered
+ *
+ * @example
+ * ```typescript
+ * const result = await updateSyncedBlocks({
+ *   blocks: [
+ *     {
+ *       blockAri: 'ari:cloud:blocks:site-123:synced-block/uuid-456',
+ *       content: '{"type":"doc","version":1,"content":[]}',
+ *       status: 'active',
+ *       stepVersion: 42
+ *     }
+ *   ]
+ * });
+ * ```
+ */
+var updateSyncedBlocks = exports.updateSyncedBlocks = /*#__PURE__*/function () {
+  var _ref15 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(_ref14) {
+    var _result$data8;
+    var blocks, bodyData, url, response, result, graphqlResponse;
+    return _regenerator.default.wrap(function _callee9$(_context9) {
+      while (1) switch (_context9.prev = _context9.next) {
+        case 0:
+          blocks = _ref14.blocks;
+          bodyData = {
+            query: buildBatchUpdateBlocksMutation(blocks),
+            operationName: BATCH_UPDATE_BLOCKS_OPERATION_NAME
+          };
+          url = (0, _platformFeatureFlags.fg)('platform_synced_block_patch_3') ? "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchUpdateBlocks") : GRAPHQL_ENDPOINT;
+          _context9.next = 5;
+          return (0, _retry.fetchWithRetry)(url, {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify(bodyData)
+          });
+        case 5:
+          response = _context9.sent;
+          if (response.ok) {
+            _context9.next = 8;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 8:
+          _context9.next = 10;
+          return response.json();
+        case 10:
+          result = _context9.sent;
+          if (!(result.errors && result.errors.length > 0)) {
+            _context9.next = 13;
+            break;
+          }
+          throw new Error(result.errors.map(function (e) {
+            return e.message;
+          }).join(', '));
+        case 13:
+          if ((_result$data8 = result.data) !== null && _result$data8 !== void 0 && _result$data8.blockService_batchUpdateBlocks) {
+            _context9.next = 15;
+            break;
+          }
+          throw new Error('No data returned from GraphQL mutation');
+        case 15:
+          graphqlResponse = result.data.blockService_batchUpdateBlocks;
+          return _context9.abrupt("return", {
+            success: graphqlResponse.success,
+            error: graphqlResponse.error
+          });
+        case 17:
+        case "end":
+          return _context9.stop();
+      }
+    }, _callee9);
+  }));
+  return function updateSyncedBlocks(_x9) {
+    return _ref15.apply(this, arguments);
+  };
 }();

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

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.subscribeToBlockUpdates = void 0;
 var _graphqlWs = require("graphql-ws");
 var _coreUtils = require("@atlaskit/editor-common/core-utils");
-var _sharedSubscriptionUtils = require("./sharedSubscriptionUtils");
+var _utils = require("../../utils/utils");
 var GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 var blockServiceClient = null;
 var getBlockServiceClient = function getBlockServiceClient() {
@@ -25,6 +25,51 @@ var getBlockServiceClient = function getBlockServiceClient() {
   }
   return blockServiceClient;
 };
+var SUBSCRIPTION_QUERY = "\nsubscription EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED($resourceId: ID!) {\n\tblockService_onBlockUpdated(resourceId: $resourceId) {\n\t\tblockAri\n\t\tblockInstanceId\n\t\tcontent\n\t\tcontentUpdatedAt\n\t\tcreatedAt\n\t\tcreatedBy\n\t\tdeletionReason\n\t\tproduct\n\t\tsourceAri\n\t\tstatus\n\t}\n}\n";
+/**
+ * Extracts the resourceId from a block ARI.
+ * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
+ * @param blockAri - The block ARI string
+ * @returns The resourceId portion of the ARI
+ */
+var extractResourceIdFromBlockAri = function extractResourceIdFromBlockAri(blockAri) {
+  // eslint-disable-next-line require-unicode-regexp
+  var match = blockAri.match(/ari:cloud:blocks:[^:]+:synced-block\/(.+)$/);
+  return (match === null || match === void 0 ? void 0 : match[1]) || null;
+};
+
+/**
+ * Parses the subscription payload into a standardized format.
+ * @param payload - The raw subscription payload
+ * @returns Parsed block data or null if parsing fails
+ */
+var parseSubscriptionPayload = function parseSubscriptionPayload(payload) {
+  try {
+    var resourceId = extractResourceIdFromBlockAri(payload.blockAri);
+    if (!resourceId) {
+      return null;
+    }
+    var createdAt;
+    if (payload.createdAt !== undefined && payload.createdAt !== null) {
+      createdAt = new Date(payload.createdAt).toISOString();
+    }
+    return {
+      blockAri: payload.blockAri,
+      blockInstanceId: payload.blockInstanceId,
+      content: JSON.parse(payload.content),
+      contentUpdatedAt: (0, _utils.convertContentUpdatedAt)(payload.contentUpdatedAt),
+      createdAt: createdAt,
+      createdBy: payload.createdBy,
+      product: payload.product,
+      resourceId: resourceId,
+      sourceAri: payload.sourceAri,
+      status: payload.status
+    };
+  } catch (_unused) {
+    return null;
+  }
+};
+
 /**
  * Creates a GraphQL subscription to block updates using the shared graphql-ws client.
  *
@@ -40,7 +85,7 @@ var subscribeToBlockUpdates = exports.subscribeToBlockUpdates = function subscri
     return function () {};
   }
   var unsubscribe = client.subscribe({
-    query: _sharedSubscriptionUtils.BLOCK_SERVICE_SUBSCRIPTION_QUERY,
+    query: SUBSCRIPTION_QUERY,
     variables: {
       resourceId: blockAri
     },
@@ -49,7 +94,7 @@ var subscribeToBlockUpdates = exports.subscribeToBlockUpdates = function subscri
     next: function next(value) {
       var _value$data;
       if ((_value$data = value.data) !== null && _value$data !== void 0 && _value$data.blockService_onBlockUpdated) {
-        var parsed = (0, _sharedSubscriptionUtils.parseSubscriptionPayload)(value.data.blockService_onBlockUpdated);
+        var parsed = parseSubscriptionPayload(value.data.blockService_onBlockUpdated);
         if (parsed !== null) {
           onData(parsed);
         } else {

package/dist/cjs/index.js

@@ -3,12 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "BLOCK_SERVICE_SUBSCRIPTION_QUERY", {
-  enumerable: true,
-  get: function get() {
-    return _sharedSubscriptionUtils.BLOCK_SERVICE_SUBSCRIPTION_QUERY;
-  }
-});
 Object.defineProperty(exports, "BlockError", {
   enumerable: true,
   get: function get() {
@@ -63,12 +57,6 @@ Object.defineProperty(exports, "convertPMNodesToSyncBlockNodes", {
     return _utils.convertPMNodesToSyncBlockNodes;
   }
 });
-Object.defineProperty(exports, "convertRelayResponseToSyncBlockInstance", {
-  enumerable: true,
-  get: function get() {
-    return _relayResponseConverter.convertRelayResponseToSyncBlockInstance;
-  }
-});
 Object.defineProperty(exports, "convertSyncBlockJSONNodeToSyncBlockNode", {
   enumerable: true,
   get: function get() {
@@ -87,18 +75,6 @@ Object.defineProperty(exports, "convertToSyncBlockData", {
     return _blockServiceAPI.convertToSyncBlockData;
   }
 });
-Object.defineProperty(exports, "createRelayBlockSubscription", {
-  enumerable: true,
-  get: function get() {
-    return _relaySubscriptionUtils.createRelayBlockSubscription;
-  }
-});
-Object.defineProperty(exports, "createRelaySubscriptionFunction", {
-  enumerable: true,
-  get: function get() {
-    return _relaySubscriptionUtils.createRelaySubscriptionFunction;
-  }
-});
 Object.defineProperty(exports, "createResourceIdForReference", {
   enumerable: true,
   get: function get() {
@@ -207,12 +183,6 @@ Object.defineProperty(exports, "parseResourceId", {
     return _resourceId.parseResourceId;
   }
 });
-Object.defineProperty(exports, "parseSubscriptionPayload", {
-  enumerable: true,
-  get: function get() {
-    return _sharedSubscriptionUtils.parseSubscriptionPayload;
-  }
-});
 Object.defineProperty(exports, "rebaseTransaction", {
   enumerable: true,
   get: function get() {
@@ -231,6 +201,12 @@ Object.defineProperty(exports, "syncBlockInMemorySessionCache", {
     return _syncBlockInMemorySessionCache.syncBlockInMemorySessionCache;
   }
 });
+Object.defineProperty(exports, "updateSyncedBlocks", {
+  enumerable: true,
+  get: function get() {
+    return _blockService.updateSyncedBlocks;
+  }
+});
 Object.defineProperty(exports, "useFetchSyncBlockData", {
   enumerable: true,
   get: function get() {
@@ -273,6 +249,12 @@ Object.defineProperty(exports, "useMemoizedSyncedBlockProvider", {
     return _syncBlockProvider.useMemoizedSyncedBlockProvider;
   }
 });
+Object.defineProperty(exports, "writeDataBatch", {
+  enumerable: true,
+  get: function get() {
+    return _blockServiceAPI.writeDataBatch;
+  }
+});
 var _rebaseTransaction = require("./common/rebase-transaction");
 var _types = require("./common/types");
 var _useFetchSyncBlockData = require("./hooks/useFetchSyncBlockData");
@@ -289,9 +271,6 @@ var _syncBlockProvider = require("./providers/syncBlockProvider");
 var _referenceSyncBlockStoreManager = require("./store-manager/referenceSyncBlockStoreManager");
 var _syncBlockInMemorySessionCache = require("./store-manager/syncBlockInMemorySessionCache");
 var _syncBlockStoreManager = require("./store-manager/syncBlockStoreManager");
-var _sharedSubscriptionUtils = require("./clients/block-service/sharedSubscriptionUtils");
-var _relayResponseConverter = require("./utils/relayResponseConverter");
-var _relaySubscriptionUtils = require("./utils/relaySubscriptionUtils");
 var _resolveSyncBlockInstance = require("./utils/resolveSyncBlockInstance");
 var _resourceId = require("./utils/resourceId");
 var _utils = require("./utils/utils");