@atlaskit/editor-synced-block-provider 2.15.1 → 2.15.3

package/dist/es2019/store-manager/sourceSyncBlockStoreManager.js

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import uuid from 'uuid';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -42,7 +43,10 @@ export class SourceSyncBlockStoreManager {
         throw new Error('Local ID or resource ID is not set');
       }
       const syncBlockData = convertSyncBlockPMNodeToSyncBlockData(syncBlockNode);
-      this.syncBlockCache.set(resourceId, syncBlockData);
+      this.syncBlockCache.set(resourceId, {
+        ...syncBlockData,
+        isDirty: true
+      });
       return true;
     } catch (error) {
       var _this$fireAnalyticsEv;
@@ -68,7 +72,8 @@ export class SourceSyncBlockStoreManager {
       const bodiedSyncBlockData = [];
       Array.from(this.syncBlockCache.values()).forEach(syncBlockData => {
         // Don't flush nodes that are waiting to be deleted to avoid nodes being re-created
-        if (!syncBlockData.pendingDeletion) {
+        // Don't flush nodes that haven't been updated since we last flushed
+        if (!syncBlockData.pendingDeletion && syncBlockData.isDirty) {
           bodiedSyncBlockNodes.push({
             type: 'bodiedSyncBlock',
             attrs: {
@@ -83,10 +88,19 @@ export class SourceSyncBlockStoreManager {
         return Promise.resolve(true);
       }
       const writeResults = await this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
-      if (writeResults.every(result => result.resourceId !== undefined)) {
+      writeResults.forEach(result => {
+        // set isDirty to false on write success and unrecoverable errors like not found
+        if (result.resourceId && (result.error === SyncBlockError.NotFound || !result.error)) {
+          const cachedData = this.syncBlockCache.get(result.resourceId);
+          if (cachedData) {
+            cachedData.isDirty = false;
+          }
+        }
+      });
+      if (writeResults.every(result => result.resourceId && !result.error)) {
         return true;
       } else {
-        writeResults.filter(result => result.resourceId === undefined).forEach(result => {
+        writeResults.filter(result => !result.resourceId || result.error).forEach(result => {
           var _this$fireAnalyticsEv2;
           (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 ? void 0 : _this$fireAnalyticsEv2.call(this, updateErrorPayload(result.error || 'Failed to write data'));
         });

package/dist/es2019/utils/errorHandling.js

@@ -18,6 +18,7 @@ export const getErrorPayload = (actionSubjectId, error) => ({
 export const fetchErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error);
 export const getSourceInfoErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error);
 export const updateErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error);
+export const updateReferenceErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error);
 export const createErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error);
 export const deleteErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error);
 export const updateCacheErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error);

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

@@ -240,4 +240,45 @@ export var createSyncedBlock = /*#__PURE__*/function () {
   return function createSyncedBlock(_x5) {
     return _ref9.apply(this, arguments);
   };
+}();
+export var updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
+  var _ref1 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(_ref0) {
+    var documentAri, blocks, _ref0$noContent, noContent, response;
+    return _regeneratorRuntime.wrap(function _callee6$(_context6) {
+      while (1) switch (_context6.prev = _context6.next) {
+        case 0:
+          documentAri = _ref0.documentAri, blocks = _ref0.blocks, _ref0$noContent = _ref0.noContent, noContent = _ref0$noContent === void 0 ? true : _ref0$noContent;
+          _context6.next = 3;
+          return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/block/document/").concat(encodeURIComponent(documentAri), "/references?noContent=").concat(noContent), {
+            method: 'PUT',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify({
+              blocks: blocks
+            })
+          });
+        case 3:
+          response = _context6.sent;
+          if (response.ok) {
+            _context6.next = 6;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 6:
+          if (noContent) {
+            _context6.next = 10;
+            break;
+          }
+          _context6.next = 9;
+          return response.json();
+        case 9:
+          return _context6.abrupt("return", _context6.sent);
+        case 10:
+        case "end":
+          return _context6.stop();
+      }
+    }, _callee6);
+  }));
+  return function updateReferenceSyncedBlockOnDocument(_x6) {
+    return _ref1.apply(this, arguments);
+  };
 }();

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

@@ -6,7 +6,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 /* eslint-disable require-unicode-regexp  */
 import { useMemo } from 'react';
 import { generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
-import { BlockError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getSyncedBlockContent, updateSyncedBlock } from '../../clients/block-service/blockService';
+import { BlockError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock } from '../../clients/block-service/blockService';
 import { SyncBlockError } from '../../common/types';
 import { stringifyError } from '../../utils/errorHandling';
 var mapBlockError = function mapBlockError(error) {
@@ -317,21 +317,30 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               _context5.prev = 7;
               _context5.t0 = _context5["catch"](1);
               if (!(_context5.t0 instanceof BlockError)) {
-                _context5.next = 11;
+                _context5.next = 13;
+                break;
+              }
+              if (!(_context5.t0.status === 404)) {
+                _context5.next = 12;
                 break;
               }
+              return _context5.abrupt("return", {
+                resourceId: resourceId,
+                success: true
+              });
+            case 12:
               return _context5.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
                 error: mapBlockError(_context5.t0)
               });
-            case 11:
+            case 13:
               return _context5.abrupt("return", {
                 resourceId: resourceId,
                 success: false,
                 error: stringifyError(_context5.t0)
               });
-            case 12:
+            case 14:
             case "end":
               return _context5.stop();
           }
@@ -352,6 +361,56 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     value: function generateResourceId() {
       return crypto.randomUUID();
     }
+  }, {
+    key: "updateReferenceData",
+    value: function () {
+      var _updateReferenceData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(blocks, noContent) {
+        var _this = this;
+        return _regeneratorRuntime.wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
+            case 0:
+              _context6.prev = 0;
+              _context6.next = 3;
+              return updateReferenceSyncedBlockOnDocument({
+                documentAri: this.sourceAri,
+                blocks: blocks.map(function (block) {
+                  return {
+                    blockAri: generateBlockAriFromReference(_this.sourceAri, block.resourceId),
+                    blockInstanceId: block.localId
+                  };
+                }, noContent)
+              });
+            case 3:
+              return _context6.abrupt("return", {
+                success: true
+              });
+            case 6:
+              _context6.prev = 6;
+              _context6.t0 = _context6["catch"](0);
+              if (!(_context6.t0 instanceof BlockError)) {
+                _context6.next = 10;
+                break;
+              }
+              return _context6.abrupt("return", {
+                success: false,
+                error: mapBlockError(_context6.t0)
+              });
+            case 10:
+              return _context6.abrupt("return", {
+                success: false,
+                error: stringifyError(_context6.t0)
+              });
+            case 11:
+            case "end":
+              return _context6.stop();
+          }
+        }, _callee6, this, [[0, 6]]);
+      }));
+      function updateReferenceData(_x6, _x7) {
+        return _updateReferenceData.apply(this, arguments);
+      }
+      return updateReferenceData;
+    }()
   }]);
 }();
 /**

package/dist/esm/providers/confluence/confluenceContentAPI.js

@@ -403,6 +403,13 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
     value: function generateResourceIdForReference(sourceId) {
       return sourceId;
     }
+  }, {
+    key: "updateReferenceData",
+    value: function updateReferenceData(_blocks, _noContent) {
+      return Promise.resolve({
+        success: true
+      });
+    }
   }]);
 }();
 /**

package/dist/esm/providers/syncBlockProvider.js

@@ -289,6 +289,11 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
           throw new Error("".concat(sourceProduct, " source product not supported"));
       }
     }
+  }, {
+    key: "updateReferenceData",
+    value: function updateReferenceData(blocks, noContent) {
+      return this.writeProvider.updateReferenceData(blocks, noContent);
+    }
   }]);
 }(SyncBlockDataProvider);
 export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions, getSSRData) {

package/dist/esm/store-manager/referenceSyncBlockStoreManager.js

@@ -12,7 +12,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { SyncBlockError } from '../common/types';
-import { fetchErrorPayload, getSourceInfoErrorPayload } from '../utils/errorHandling';
+import { fetchErrorPayload, getSourceInfoErrorPayload, updateReferenceErrorPayload } from '../utils/errorHandling';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { createSyncBlockNode } from '../utils/utils';
 
@@ -24,6 +24,10 @@ import { createSyncBlockNode } from '../utils/utils';
 export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   function ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
     _classCallCheck(this, ReferenceSyncBlockStoreManager);
+    // Keeps track of addition and deletion of reference synced blocks on the document
+    // This starts as true to always flush the cache when document is saved for the first time
+    // to cater the case when a editor seesion is closed without document being updated right after reference block is deleted
+    _defineProperty(this, "isCacheDirty", true);
     _defineProperty(this, "isRefreshingSubscriptions", false);
     this.syncBlockCache = new Map();
     this.subscriptions = new Map();
@@ -321,6 +325,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       // add to subscriptions map
       var resourceSubscriptions = this.subscriptions.get(resourceId) || {};
       this.subscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, _defineProperty({}, localId, callback)));
+
+      // New subscription means new reference synced block is added to the document
+      this.isCacheDirty = true;
       var syncBlockNode = createSyncBlockNode(localId, resourceId);
 
       // call the callback immediately if we have cached data
@@ -340,6 +347,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       return function () {
         var resourceSubscriptions = _this3.subscriptions.get(resourceId);
         if (resourceSubscriptions) {
+          // Unsubscription means a reference synced block is removed from the document
+          _this3.isCacheDirty = true;
           delete resourceSubscriptions[localId];
           if (Object.keys(resourceSubscriptions).length === 0) {
             _this3.subscriptions.delete(resourceId);
@@ -509,6 +518,89 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         }
       }
     }
+
+    /**
+     * Update reference synced blocks on the document with the BE
+     * 
+     * @returns true if the reference synced blocks are updated successfully, false otherwise
+     */
+  }, {
+    key: "flush",
+    value: (function () {
+      var _flush = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+        var success, blocks, updateResult, _this$fireAnalyticsEv9, _this$fireAnalyticsEv0;
+        return _regeneratorRuntime.wrap(function _callee3$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              if (this.isCacheDirty) {
+                _context4.next = 2;
+                break;
+              }
+              return _context4.abrupt("return", true);
+            case 2:
+              success = true;
+              _context4.prev = 3;
+              if (this.dataProvider) {
+                _context4.next = 6;
+                break;
+              }
+              throw new Error('Data provider not set');
+            case 6:
+              blocks = []; // Collect all reference synced blocks on the current document
+              Array.from(this.subscriptions.entries()).forEach(function (_ref2) {
+                var _ref3 = _slicedToArray(_ref2, 2),
+                  resourceId = _ref3[0],
+                  callbacks = _ref3[1];
+                Object.keys(callbacks).forEach(function (localId) {
+                  blocks.push({
+                    resourceId: resourceId,
+                    localId: localId
+                  });
+                });
+              });
+              if (!(blocks.length === 0)) {
+                _context4.next = 10;
+                break;
+              }
+              return _context4.abrupt("return", true);
+            case 10:
+              _context4.next = 12;
+              return this.dataProvider.updateReferenceData(blocks);
+            case 12:
+              updateResult = _context4.sent;
+              if (!updateResult.success) {
+                success = false;
+                (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, updateReferenceErrorPayload(updateResult.error || 'Failed to update reference synced blocks on the document'));
+              }
+              _context4.next = 21;
+              break;
+            case 16:
+              _context4.prev = 16;
+              _context4.t0 = _context4["catch"](3);
+              success = false;
+              logException(_context4.t0, {
+                location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'
+              });
+              (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, updateReferenceErrorPayload(_context4.t0.message));
+            case 21:
+              _context4.prev = 21;
+              if (success) {
+                this.isCacheDirty = false;
+              }
+              return _context4.finish(21);
+            case 24:
+              return _context4.abrupt("return", success);
+            case 25:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee3, this, [[3, 16, 21, 24]]);
+      }));
+      function flush() {
+        return _flush.apply(this, arguments);
+      }
+      return flush;
+    }())
   }, {
     key: "destroy",
     value: function destroy() {

package/dist/esm/store-manager/sourceSyncBlockStoreManager.js

@@ -3,9 +3,12 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import uuid from 'uuid';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -51,7 +54,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           throw new Error('Local ID or resource ID is not set');
         }
         var syncBlockData = convertSyncBlockPMNodeToSyncBlockData(syncBlockNode);
-        this.syncBlockCache.set(resourceId, syncBlockData);
+        this.syncBlockCache.set(resourceId, _objectSpread(_objectSpread({}, syncBlockData), {}, {
+          isDirty: true
+        }));
         return true;
       } catch (error) {
         var _this$fireAnalyticsEv;
@@ -88,7 +93,8 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               bodiedSyncBlockData = [];
               Array.from(this.syncBlockCache.values()).forEach(function (syncBlockData) {
                 // Don't flush nodes that are waiting to be deleted to avoid nodes being re-created
-                if (!syncBlockData.pendingDeletion) {
+                // Don't flush nodes that haven't been updated since we last flushed
+                if (!syncBlockData.pendingDeletion && syncBlockData.isDirty) {
                   bodiedSyncBlockNodes.push({
                     type: 'bodiedSyncBlock',
                     attrs: {
@@ -109,37 +115,46 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
             case 10:
               writeResults = _context.sent;
+              writeResults.forEach(function (result) {
+                // set isDirty to false on write success and unrecoverable errors like not found
+                if (result.resourceId && (result.error === SyncBlockError.NotFound || !result.error)) {
+                  var cachedData = _this2.syncBlockCache.get(result.resourceId);
+                  if (cachedData) {
+                    cachedData.isDirty = false;
+                  }
+                }
+              });
               if (!writeResults.every(function (result) {
-                return result.resourceId !== undefined;
+                return result.resourceId && !result.error;
               })) {
-                _context.next = 15;
+                _context.next = 16;
                 break;
               }
               return _context.abrupt("return", true);
-            case 15:
+            case 16:
               writeResults.filter(function (result) {
-                return result.resourceId === undefined;
+                return !result.resourceId || result.error;
               }).forEach(function (result) {
                 var _this2$fireAnalyticsE;
                 (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, updateErrorPayload(result.error || 'Failed to write data'));
               });
               return _context.abrupt("return", false);
-            case 17:
-              _context.next = 24;
+            case 18:
+              _context.next = 25;
               break;
-            case 19:
-              _context.prev = 19;
+            case 20:
+              _context.prev = 20;
               _context.t0 = _context["catch"](0);
               logException(_context.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_context.t0.message));
               return _context.abrupt("return", false);
-            case 24:
+            case 25:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 19]]);
+        }, _callee, this, [[0, 20]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);

package/dist/esm/utils/errorHandling.js

@@ -26,6 +26,9 @@ export var getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error)
 export var updateErrorPayload = function updateErrorPayload(error) {
   return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error);
 };
+export var updateReferenceErrorPayload = function updateReferenceErrorPayload(error) {
+  return getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error);
+};
 export var createErrorPayload = function createErrorPayload(error) {
   return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error);
 };

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

@@ -15,6 +15,10 @@ export type BlockContentErrorResponse = {
     code: string;
     reason: string;
 };
+type ReferenceSyncedBlockResponse = {
+    blocks?: Array<BlockContentResponse>;
+    errors?: Array<BlockContentErrorResponse>;
+};
 export declare const isBlockContentResponse: (response: BlockContentResponse | BlockContentErrorResponse) => response is BlockContentResponse;
 /**
  * Retrieves all synced blocks referenced in a document.
@@ -58,10 +62,7 @@ export declare const isBlockContentResponse: (response: BlockContentResponse | B
  * ```
  * 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 declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<ReferenceSyncedBlockResponse>;
 export type GetSyncedBlockContentRequest = {
     blockAri: string;
 };
@@ -79,6 +80,15 @@ export type CreateSyncedBlockRequest = {
     product: SyncBlockProduct;
     sourceAri: string;
 };
+type ReferenceSyncedBlockIDs = {
+    blockAri: string;
+    blockInstanceId: string;
+};
+type UpdateReferenceSyncedBlockOnDocumentRequest = {
+    blocks: ReferenceSyncedBlockIDs[];
+    documentAri: string;
+    noContent?: boolean;
+};
 export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
@@ -87,3 +97,5 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
+export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
+export {};

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

@@ -1,5 +1,5 @@
-import { SyncBlockError, type ResourceId, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { SyncBlockError, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, UpdateReferenceSyncBlockResult, WriteSyncBlockResult } from '../types';
 export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
@@ -22,6 +22,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     generateResourceId(): ResourceId;
+    updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string) => {
     fetchProvider: BlockServiceADFFetchProvider;

package/dist/types/providers/confluence/confluenceContentAPI.d.ts

@@ -1,5 +1,5 @@
-import { type ResourceId, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, UpdateReferenceSyncBlockResult, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -28,6 +28,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
     generateResourceId(sourceId: string, localId: string): string;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
+    updateReferenceData(_blocks: SyncBlockAttrs[], _noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 /**
  * Convenience function to create providers with default content property key

package/dist/types/providers/syncBlockProvider.d.ts

@@ -1,7 +1,7 @@
 import type { RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import { type BlockInstanceId, type ResourceId, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
+import { type BlockInstanceId, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type UpdateReferenceSyncBlockResult, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -94,5 +94,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @returns The parent info for the sync block
      */
     retrieveSyncBlockParentInfo(sourceAri: string, sourceProduct: SyncBlockProduct): SyncBlockParentInfo | undefined;
+    updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions, getSSRData?: () => Record<string, SyncBlockInstance> | undefined) => SyncBlockProvider;

package/dist/types/providers/types.d.ts

@@ -4,7 +4,7 @@ import type { EmojiProvider } from '@atlaskit/emoji';
 import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
-import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId } from '../common/types';
+import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs } from '../common/types';
 /**
  * The instance of a sync block, containing its data and metadata.
  * Mainly used for representing the state of a sync block after fetching from a data provider.
@@ -39,15 +39,26 @@ export type SourceInfoFetchData = {
     pageARI: string;
     sourceLocalId?: string;
 };
+export type UpdateReferenceSyncBlockResult = {
+    error?: string;
+    success: boolean;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
 export interface ADFWriteProvider {
     createData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
+    /**
+     * Delete source block.
+     * @param resourceId the resourceId of the block to be deleted
+     * @returns Object representing the result of the deletion. {resourceId: string, success: boolean, error?: string}.
+     * User should not be blocked by not_found error when deleting, so successful result should be returned for 404 error
+     */
     deleteData: (resourceId: ResourceId) => Promise<DeleteSyncBlockResult>;
     generateResourceId: (sourceId: string, localId: string) => ResourceId;
     generateResourceIdForReference: (sourceId: ResourceId) => ResourceId;
     product: SyncBlockProduct;
+    updateReferenceData: (blocks: SyncBlockAttrs[], noContent?: boolean) => Promise<UpdateReferenceSyncBlockResult>;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export type MediaEmojiProviderOptions = {
@@ -84,6 +95,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
      */
     abstract generateResourceId(sourceId: ResourceId, localId: BlockInstanceId): ResourceId;
     abstract generateResourceIdForReference(sourceId: ResourceId): ResourceId;
+    abstract updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

package/dist/types/store-manager/referenceSyncBlockStoreManager.d.ts

@@ -6,6 +6,7 @@ import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, Ti
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
+    private isCacheDirty;
     private subscriptions;
     private titleSubscriptions;
     private providerFactories;
@@ -44,5 +45,11 @@ export declare class ReferenceSyncBlockStoreManager {
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     private retrieveDynamicProviders;
+    /**
+     * Update reference synced blocks on the document with the BE
+     *
+     * @returns true if the reference synced blocks are updated successfully, false otherwise
+     */
+    flush(): Promise<boolean>;
     destroy(): void;
 }

package/dist/types/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -1,6 +1,6 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { ResourceId, SyncBlockAttrs } from '../common/types';
+import { type ResourceId, type SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
 type OnDelete = () => void;

package/dist/types/utils/errorHandling.d.ts

@@ -6,6 +6,7 @@ export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjec
 export declare const fetchErrorPayload: (error: string) => RendererSyncBlockEventPayload;
 export declare const getSourceInfoErrorPayload: (error: string) => RendererSyncBlockEventPayload;
 export declare const updateErrorPayload: (error: string) => SyncBlockEventPayload;
+export declare const updateReferenceErrorPayload: (error: string) => RendererSyncBlockEventPayload;
 export declare const createErrorPayload: (error: string) => SyncBlockEventPayload;
 export declare const deleteErrorPayload: (error: string) => SyncBlockEventPayload;
 export declare const updateCacheErrorPayload: (error: string) => SyncBlockEventPayload;