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

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

@@ -1,10 +1,11 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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';
 var mapBlockError = function mapBlockError(error) {
@@ -17,6 +18,81 @@ var mapBlockError = function 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
+var convertToSyncBlockData = function 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 var fetchReferences = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(documentAri) {
+    var response, _ref2, blocks, errors, blocksInstances, errorInstances;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.prev = 0;
+          _context.next = 3;
+          return getReferenceSyncedBlocks(documentAri);
+        case 3:
+          response = _context.sent;
+          _context.next = 11;
+          break;
+        case 6:
+          _context.prev = 6;
+          _context.t0 = _context["catch"](0);
+          if (!(_context.t0 instanceof BlockError)) {
+            _context.next = 10;
+            break;
+          }
+          return _context.abrupt("return", mapBlockError(_context.t0));
+        case 10:
+          return _context.abrupt("return", SyncBlockError.Errored);
+        case 11:
+          _ref2 = response || {}, blocks = _ref2.blocks, errors = _ref2.errors;
+          blocksInstances = (blocks || []).map(function (blockContentResponse) {
+            try {
+              return {
+                data: convertToSyncBlockData(blockContentResponse),
+                resourceId: blockContentResponse.blockAri
+              };
+            } catch (_unused) {
+              // JSON parsing error, return InvalidContent error
+              return {
+                error: SyncBlockError.InvalidContent,
+                resourceId: blockContentResponse.blockAri
+              };
+            }
+          });
+          errorInstances = (errors || []).map(function (errorBlock) {
+            return {
+              error: SyncBlockError.Errored,
+              resourceId: errorBlock.blockAri
+            };
+          });
+          return _context.abrupt("return", [].concat(_toConsumableArray(blocksInstances), _toConsumableArray(errorInstances)));
+        case 15:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[0, 6]]);
+  }));
+  return function fetchReferences(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */
@@ -29,32 +105,32 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
     value: // resourceId is the ARI of the block. E.G ari:cloud:blocks:site-123:synced-block/uuid-456
     // in the content API provider, this was the concatenation of the source document's ARI and the local ID. E.G ari:cloud:confluence:site-123:page/pageId/uuid-456
     function () {
-      var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(resourceId) {
+      var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(resourceId) {
         var localId, blockContentResponse, value, syncedBlockData;
-        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:
               localId = getLocalIdFromBlockResourceId(resourceId);
-              _context.prev = 1;
-              _context.next = 4;
+              _context2.prev = 1;
+              _context2.next = 4;
               return getSyncedBlockContent({
                 blockAri: resourceId
               });
             case 4:
-              blockContentResponse = _context.sent;
+              blockContentResponse = _context2.sent;
               value = blockContentResponse.content;
               if (value) {
-                _context.next = 8;
+                _context2.next = 8;
                 break;
               }
-              return _context.abrupt("return", {
+              return _context2.abrupt("return", {
                 error: SyncBlockError.NotFound,
                 resourceId: resourceId
               });
             case 8:
               // Parse the synced block content from the response's content
               syncedBlockData = JSON.parse(value);
-              return _context.abrupt("return", {
+              return _context2.abrupt("return", {
                 data: {
                   content: syncedBlockData,
                   resourceId: resourceId,
@@ -65,28 +141,28 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
                 resourceId: resourceId
               });
             case 12:
-              _context.prev = 12;
-              _context.t0 = _context["catch"](1);
-              if (!(_context.t0 instanceof BlockError)) {
-                _context.next = 16;
+              _context2.prev = 12;
+              _context2.t0 = _context2["catch"](1);
+              if (!(_context2.t0 instanceof BlockError)) {
+                _context2.next = 16;
                 break;
               }
-              return _context.abrupt("return", {
-                error: mapBlockError(_context.t0),
+              return _context2.abrupt("return", {
+                error: mapBlockError(_context2.t0),
                 resourceId: resourceId
               });
             case 16:
-              return _context.abrupt("return", {
+              return _context2.abrupt("return", {
                 error: SyncBlockError.Errored,
                 resourceId: resourceId
               });
             case 17:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, null, [[1, 12]]);
+        }, _callee2, null, [[1, 12]]);
       }));
-      function fetchData(_x) {
+      function fetchData(_x2) {
         return _fetchData.apply(this, arguments);
       }
       return fetchData;
@@ -107,34 +183,34 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
   return _createClass(BlockServiceADFWriteProvider, [{
     key: "writeData",
     value: function () {
-      var _writeData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(data) {
+      var _writeData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(data) {
         var resourceId;
-        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:
               resourceId = data.resourceId;
-              _context2.prev = 1;
-              _context2.next = 4;
+              _context3.prev = 1;
+              _context3.next = 4;
               return updateSyncedBlock({
                 blockAri: resourceId,
                 content: JSON.stringify(data.content)
               });
             case 4:
-              return _context2.abrupt("return", {
+              return _context3.abrupt("return", {
                 resourceId: resourceId
               });
             case 7:
-              _context2.prev = 7;
-              _context2.t0 = _context2["catch"](1);
-              if (!(_context2.t0 instanceof BlockError)) {
-                _context2.next = 16;
+              _context3.prev = 7;
+              _context3.t0 = _context3["catch"](1);
+              if (!(_context3.t0 instanceof BlockError)) {
+                _context3.next = 16;
                 break;
               }
-              if (!(_context2.t0.status === 404)) {
-                _context2.next = 15;
+              if (!(_context3.t0.status === 404)) {
+                _context3.next = 15;
                 break;
               }
-              _context2.next = 13;
+              _context3.next = 13;
               return createSyncedBlock({
                 blockAri: resourceId,
                 blockInstanceId: data.blockInstanceId,
@@ -143,25 +219,25 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 content: JSON.stringify(data.content)
               });
             case 13:
-              _context2.next = 16;
+              _context3.next = 16;
               break;
             case 15:
-              return _context2.abrupt("return", {
-                error: mapBlockError(_context2.t0),
+              return _context3.abrupt("return", {
+                error: mapBlockError(_context3.t0),
                 resourceId: resourceId
               });
             case 16:
-              return _context2.abrupt("return", {
-                error: stringifyError(_context2.t0),
+              return _context3.abrupt("return", {
+                error: stringifyError(_context3.t0),
                 resourceId: resourceId
               });
             case 17:
             case "end":
-              return _context2.stop();
+              return _context3.stop();
           }
-        }, _callee2, this, [[1, 7]]);
+        }, _callee3, this, [[1, 7]]);
       }));
-      function writeData(_x2) {
+      function writeData(_x3) {
         return _writeData.apply(this, arguments);
       }
       return writeData;
@@ -169,46 +245,46 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
   }, {
     key: "deleteData",
     value: function () {
-      var _deleteData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(resourceId) {
-        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
+      var _deleteData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(resourceId) {
+        return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              _context3.prev = 0;
-              _context3.next = 3;
+              _context4.prev = 0;
+              _context4.next = 3;
               return deleteSyncedBlock({
                 blockAri: resourceId
               });
             case 3:
-              return _context3.abrupt("return", {
+              return _context4.abrupt("return", {
                 resourceId: resourceId,
                 success: true,
                 error: undefined
               });
             case 6:
-              _context3.prev = 6;
-              _context3.t0 = _context3["catch"](0);
-              if (!(_context3.t0 instanceof BlockError)) {
-                _context3.next = 10;
+              _context4.prev = 6;
+              _context4.t0 = _context4["catch"](0);
+              if (!(_context4.t0 instanceof BlockError)) {
+                _context4.next = 10;
                 break;
               }
-              return _context3.abrupt("return", {
+              return _context4.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
-                error: mapBlockError(_context3.t0)
+                error: mapBlockError(_context4.t0)
               });
             case 10:
-              return _context3.abrupt("return", {
+              return _context4.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
-                error: stringifyError(_context3.t0)
+                error: stringifyError(_context4.t0)
               });
             case 11:
             case "end":
-              return _context3.stop();
+              return _context4.stop();
           }
-        }, _callee3, null, [[0, 6]]);
+        }, _callee4, null, [[0, 6]]);
       }));
-      function deleteData(_x3) {
+      function deleteData(_x4) {
         return _deleteData.apply(this, arguments);
       }
       return deleteData;

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

@@ -10,6 +10,58 @@ export type BlockContentResponse = {
     status: 'active' | 'deleted';
     version: number;
 };
+export type BlockContentErrorResponse = {
+    blockAri: string;
+    code: string;
+    reason: string;
+};
+export declare const isBlockContentResponse: (response: BlockContentResponse | BlockContentErrorResponse) => response is BlockContentResponse;
+/**
+ * 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 declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<{
+    blocks?: Array<BlockContentResponse>;
+    errors?: Array<BlockContentErrorResponse>;
+}>;
 export type GetSyncedBlockContentRequest = {
     blockAri: string;
 };

package/dist/types/common/types.d.ts

@@ -15,7 +15,8 @@ export interface SyncBlockNode extends JSONNode {
 export declare enum SyncBlockError {
     Errored = "errored",
     NotFound = "not_found",
-    Forbidden = "forbidden"
+    Forbidden = "forbidden",
+    InvalidContent = "invalid_content"
 }
 export interface SyncBlockData {
     blockInstanceId: BlockInstanceId;

package/dist/types/index.d.ts

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

package/dist/types/providers/block-service/blockServiceAPI.d.ts

@@ -1,5 +1,6 @@
-import { type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import { SyncBlockError, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
 import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */

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

@@ -10,6 +10,58 @@ export type BlockContentResponse = {
     status: 'active' | 'deleted';
     version: number;
 };
+export type BlockContentErrorResponse = {
+    blockAri: string;
+    code: string;
+    reason: string;
+};
+export declare const isBlockContentResponse: (response: BlockContentResponse | BlockContentErrorResponse) => response is BlockContentResponse;
+/**
+ * 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 declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<{
+    blocks?: Array<BlockContentResponse>;
+    errors?: Array<BlockContentErrorResponse>;
+}>;
 export type GetSyncedBlockContentRequest = {
     blockAri: string;
 };

package/dist/types-ts4.5/common/types.d.ts

@@ -15,7 +15,8 @@ export interface SyncBlockNode extends JSONNode {
 export declare enum SyncBlockError {
     Errored = "errored",
     NotFound = "not_found",
-    Forbidden = "forbidden"
+    Forbidden = "forbidden",
+    InvalidContent = "invalid_content"
 }
 export interface SyncBlockData {
     blockInstanceId: BlockInstanceId;

package/dist/types-ts4.5/index.d.ts

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

package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts

@@ -1,5 +1,6 @@
-import { type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import { SyncBlockError, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
 import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */

package/package.json

@@ -34,7 +34,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.36.0",
+		"@atlaskit/editor-common": "^110.37.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.11.3",
+	"version": "2.12.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",