@atlaskit/editor-synced-block-provider 2.11.3 → 2.12.0

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

@@ -1,3 +1,60 @@
+export const isBlockContentResponse = response => {
+  const content = response.content;
+  return typeof content === 'string';
+};
+
+/**
+ * Retrieves all synced blocks referenced in a document.
+ *
+ * Calls the Block Service API endpoint: `/v1/block/document/reference/{documentAri}`
+ *
+ * @param documentAri - The ARI of the document to fetch synced blocks for
+ * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
+ *
+ * @example
+ * ```typescript
+ * const { blocks, errors } = await getReferenceSyncedBlocks(
+ *   'ari:cloud:confluence:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:page/88888888'
+ * );
+ * ```
+ *
+ * Example response:
+ * ```json
+ * {
+ *   "blocks": [
+ *     {
+ *       "blockAri": "ari:cloud:blocks:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:synced-block/xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "version": 1,
+ *       "sourceDocumentAri": "ari:cloud:confluence:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:page/88888888",
+ *       "blockInstanceId": "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "content": "string",
+ *       "status": "active",
+ *       "createdAt": "2025-10-08T10:30:00.000Z",
+ *       "createdBy": "557058:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "updatedAt": "2025-10-08T10:30:00.000Z"
+ *     }
+ *   ],
+ *   "errors": [
+ *     {
+ *       "blockAri": "ari:cloud:blocks:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:synced-block/xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "code": "error",
+ *       "reason": "some error reason"
+ *     }
+ *   ]
+ * }
+ * ```
+ * Check https://block-service.dev.atl-paas.net/ for latest API documentation.
+ */
+export const getReferenceSyncedBlocks = async documentAri => {
+  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/document/reference/${encodeURIComponent(documentAri)}`, {
+    method: 'GET',
+    headers: COMMON_HEADERS
+  });
+  if (!response.ok) {
+    throw new BlockError(response.status);
+  }
+  return await response.json();
+};
 const COMMON_HEADERS = {
   'Content-Type': 'application/json',
   Accept: 'application/json'

package/dist/es2019/common/types.js

@@ -2,5 +2,6 @@ export let SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";
   SyncBlockError["Forbidden"] = "forbidden";
+  SyncBlockError["InvalidContent"] = "invalid_content"; // content is not a valid JSON
   return SyncBlockError;
 }({});

package/dist/es2019/index.js

@@ -23,4 +23,5 @@ export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 
 // utils
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
-export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes } from './utils/utils';
+export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes } from './utils/utils';
+export { fetchReferences } from './providers/block-service/blockServiceAPI';

package/dist/es2019/providers/block-service/blockServiceAPI.js

@@ -1,6 +1,6 @@
 import { useMemo } from 'react';
 import { blockResourceIdFromSourceAndLocalId, getLocalIdFromBlockResourceId } from '../../clients/block-service/ari';
-import { BlockError, createSyncedBlock, deleteSyncedBlock, getSyncedBlockContent, updateSyncedBlock } from '../../clients/block-service/blockService';
+import { BlockError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getSyncedBlockContent, updateSyncedBlock } from '../../clients/block-service/blockService';
 import { SyncBlockError } from '../../common/types';
 import { stringifyError } from '../../utils/errorHandling';
 const mapBlockError = error => {
@@ -13,6 +13,59 @@ const mapBlockError = error => {
   return SyncBlockError.Errored;
 };
 
+// convert BlockContentResponse to SyncBlockData
+// throws exception if JSON parsing fails
+// what's missing from BlockContentResponse to SyncBlockData:
+// - updatedAt
+// - sourceURL
+// - sourceTitle
+// - isSynced
+const convertToSyncBlockData = data => {
+  return {
+    blockInstanceId: data.blockInstanceId,
+    content: JSON.parse(data.content),
+    createdAt: new Date(data.createdAt).toISOString(),
+    createdBy: data.createdBy,
+    product: data.product,
+    resourceId: data.blockAri,
+    sourceAri: data.sourceAri
+  };
+};
+export const fetchReferences = async documentAri => {
+  let response;
+  try {
+    response = await getReferenceSyncedBlocks(documentAri);
+  } catch (error) {
+    if (error instanceof BlockError) {
+      return mapBlockError(error);
+    }
+    return SyncBlockError.Errored;
+  }
+  const {
+    blocks,
+    errors
+  } = response || {};
+  const blocksInstances = (blocks || []).map(blockContentResponse => {
+    try {
+      return {
+        data: convertToSyncBlockData(blockContentResponse),
+        resourceId: blockContentResponse.blockAri
+      };
+    } catch {
+      // JSON parsing error, return InvalidContent error
+      return {
+        error: SyncBlockError.InvalidContent,
+        resourceId: blockContentResponse.blockAri
+      };
+    }
+  });
+  const errorInstances = (errors || []).map(errorBlock => ({
+    error: SyncBlockError.Errored,
+    resourceId: errorBlock.blockAri
+  }));
+  return [...blocksInstances, ...errorInstances];
+};
+
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */

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

@@ -1,13 +1,93 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+export var isBlockContentResponse = function isBlockContentResponse(response) {
+  var content = response.content;
+  return typeof content === 'string';
+};
+
+/**
+ * Retrieves all synced blocks referenced in a document.
+ *
+ * Calls the Block Service API endpoint: `/v1/block/document/reference/{documentAri}`
+ *
+ * @param documentAri - The ARI of the document to fetch synced blocks for
+ * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
+ *
+ * @example
+ * ```typescript
+ * const { blocks, errors } = await getReferenceSyncedBlocks(
+ *   'ari:cloud:confluence:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:page/88888888'
+ * );
+ * ```
+ *
+ * Example response:
+ * ```json
+ * {
+ *   "blocks": [
+ *     {
+ *       "blockAri": "ari:cloud:blocks:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:synced-block/xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "version": 1,
+ *       "sourceDocumentAri": "ari:cloud:confluence:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:page/88888888",
+ *       "blockInstanceId": "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "content": "string",
+ *       "status": "active",
+ *       "createdAt": "2025-10-08T10:30:00.000Z",
+ *       "createdBy": "557058:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "updatedAt": "2025-10-08T10:30:00.000Z"
+ *     }
+ *   ],
+ *   "errors": [
+ *     {
+ *       "blockAri": "ari:cloud:blocks:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx:synced-block/xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ *       "code": "error",
+ *       "reason": "some error reason"
+ *     }
+ *   ]
+ * }
+ * ```
+ * Check https://block-service.dev.atl-paas.net/ for latest API documentation.
+ */
+export var getReferenceSyncedBlocks = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(documentAri) {
+    var response;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.next = 2;
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/document/reference/").concat(encodeURIComponent(documentAri)), {
+            method: 'GET',
+            headers: COMMON_HEADERS
+          });
+        case 2:
+          response = _context.sent;
+          if (response.ok) {
+            _context.next = 5;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 5:
+          _context.next = 7;
+          return response.json();
+        case 7:
+          return _context.abrupt("return", _context.sent);
+        case 8:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function getReferenceSyncedBlocks(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
 var COMMON_HEADERS = {
   'Content-Type': 'application/json',
   Accept: 'application/json'
@@ -25,76 +105,76 @@ export var BlockError = /*#__PURE__*/function (_Error) {
   return _createClass(BlockError);
 }( /*#__PURE__*/_wrapNativeSuper(Error));
 export var getSyncedBlockContent = /*#__PURE__*/function () {
-  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
+  var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref2) {
     var blockAri, response;
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
         case 0:
-          blockAri = _ref.blockAri;
-          _context.next = 3;
+          blockAri = _ref2.blockAri;
+          _context2.next = 3;
           return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'GET',
             headers: COMMON_HEADERS
           });
         case 3:
-          response = _context.sent;
+          response = _context2.sent;
           if (response.ok) {
-            _context.next = 6;
+            _context2.next = 6;
             break;
           }
           throw new BlockError(response.status);
         case 6:
-          _context.next = 8;
+          _context2.next = 8;
           return response.json();
         case 8:
-          return _context.abrupt("return", _context.sent);
+          return _context2.abrupt("return", _context2.sent);
         case 9:
         case "end":
-          return _context.stop();
+          return _context2.stop();
       }
-    }, _callee);
+    }, _callee2);
   }));
-  return function getSyncedBlockContent(_x) {
-    return _ref2.apply(this, arguments);
+  return function getSyncedBlockContent(_x2) {
+    return _ref3.apply(this, arguments);
   };
 }();
 export var deleteSyncedBlock = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref3) {
+  var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref4) {
     var blockAri, response;
-    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          blockAri = _ref3.blockAri;
-          _context2.next = 3;
+          blockAri = _ref4.blockAri;
+          _context3.next = 3;
           return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'DELETE',
             headers: COMMON_HEADERS
           });
         case 3:
-          response = _context2.sent;
+          response = _context3.sent;
           if (response.ok) {
-            _context2.next = 6;
+            _context3.next = 6;
             break;
           }
           throw new BlockError(response.status);
         case 6:
         case "end":
-          return _context2.stop();
+          return _context3.stop();
       }
-    }, _callee2);
+    }, _callee3);
   }));
-  return function deleteSyncedBlock(_x2) {
-    return _ref4.apply(this, arguments);
+  return function deleteSyncedBlock(_x3) {
+    return _ref5.apply(this, arguments);
   };
 }();
 export var updateSyncedBlock = /*#__PURE__*/function () {
-  var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref5) {
+  var _ref7 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref6) {
     var blockAri, content, response;
-    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
+    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
         case 0:
-          blockAri = _ref5.blockAri, content = _ref5.content;
-          _context3.next = 3;
+          blockAri = _ref6.blockAri, content = _ref6.content;
+          _context4.next = 3;
           return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'PUT',
             headers: COMMON_HEADERS,
@@ -103,30 +183,30 @@ export var updateSyncedBlock = /*#__PURE__*/function () {
             })
           });
         case 3:
-          response = _context3.sent;
+          response = _context4.sent;
           if (response.ok) {
-            _context3.next = 6;
+            _context4.next = 6;
             break;
           }
           throw new BlockError(response.status);
         case 6:
         case "end":
-          return _context3.stop();
+          return _context4.stop();
       }
-    }, _callee3);
+    }, _callee4);
   }));
-  return function updateSyncedBlock(_x3) {
-    return _ref6.apply(this, arguments);
+  return function updateSyncedBlock(_x4) {
+    return _ref7.apply(this, arguments);
   };
 }();
 export var createSyncedBlock = /*#__PURE__*/function () {
-  var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref7) {
+  var _ref9 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(_ref8) {
     var blockAri, blockInstanceId, sourceAri, product, content, response;
-    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
-      while (1) switch (_context4.prev = _context4.next) {
+    return _regeneratorRuntime.wrap(function _callee5$(_context5) {
+      while (1) switch (_context5.prev = _context5.next) {
         case 0:
-          blockAri = _ref7.blockAri, blockInstanceId = _ref7.blockInstanceId, sourceAri = _ref7.sourceAri, product = _ref7.product, content = _ref7.content;
-          _context4.next = 3;
+          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content;
+          _context5.next = 3;
           return fetch("".concat(BLOCK_SERVICE_API_URL, "/block"), {
             method: 'POST',
             headers: COMMON_HEADERS,
@@ -139,24 +219,24 @@ export var createSyncedBlock = /*#__PURE__*/function () {
             })
           });
         case 3:
-          response = _context4.sent;
+          response = _context5.sent;
           if (response.ok) {
-            _context4.next = 6;
+            _context5.next = 6;
             break;
           }
           throw new BlockError(response.status);
         case 6:
-          _context4.next = 8;
+          _context5.next = 8;
           return response.json();
         case 8:
-          return _context4.abrupt("return", _context4.sent);
+          return _context5.abrupt("return", _context5.sent);
         case 9:
         case "end":
-          return _context4.stop();
+          return _context5.stop();
       }
-    }, _callee4);
+    }, _callee5);
   }));
-  return function createSyncedBlock(_x4) {
-    return _ref8.apply(this, arguments);
+  return function createSyncedBlock(_x5) {
+    return _ref9.apply(this, arguments);
   };
 }();

package/dist/esm/common/types.js

@@ -2,5 +2,6 @@ export var SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";
   SyncBlockError["Forbidden"] = "forbidden";
+  SyncBlockError["InvalidContent"] = "invalid_content"; // content is not a valid JSON
   return SyncBlockError;
 }({});

package/dist/esm/index.js

@@ -23,4 +23,5 @@ export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 
 // utils
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
-export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes } from './utils/utils';
+export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes } from './utils/utils';
+export { fetchReferences } from './providers/block-service/blockServiceAPI';