@atlaskit/editor-synced-block-provider 3.14.1 → 3.14.2

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

@@ -506,11 +506,12 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               // Don't fetch for not_found error since the source is already deleted
               nodesToFetch = [];
               syncBlockNodes.forEach(function (node) {
+                var _existingSyncBlock$er;
                 if (_this5.syncBlockFetchDataRequests.get(node.attrs.resourceId)) {
                   return;
                 }
                 var existingSyncBlock = _this5.getFromCache(node.attrs.resourceId);
-                if ((existingSyncBlock === null || existingSyncBlock === void 0 ? void 0 : existingSyncBlock.error) === SyncBlockError.NotFound) {
+                if ((existingSyncBlock === null || existingSyncBlock === void 0 || (_existingSyncBlock$er = existingSyncBlock.error) === null || _existingSyncBlock$er === void 0 ? void 0 : _existingSyncBlock$er.type) === SyncBlockError.NotFound) {
                   return;
                 }
                 nodesToFetch.push(node);
@@ -545,8 +546,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
               hasExpectedError = false;
               data.forEach(function (syncBlockInstance) {
                 if (!syncBlockInstance.resourceId) {
-                  var _this5$fireAnalyticsE;
-                  (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, fetchErrorPayload(syncBlockInstance.error || 'Returned sync block instance does not have resource id'));
+                  var _this5$fireAnalyticsE, _syncBlockInstance$er;
+                  (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, fetchErrorPayload(((_syncBlockInstance$er = syncBlockInstance.error) === null || _syncBlockInstance$er === void 0 ? void 0 : _syncBlockInstance$er.type) || 'Returned sync block instance does not have resource id'));
                   return;
                 }
                 var existingSyncBlock = _this5.getFromCache(syncBlockInstance.resourceId);
@@ -554,8 +555,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 _this5.updateCache(resolvedSyncBlockInstance);
                 if (syncBlockInstance.error) {
                   var _this5$fireAnalyticsE2;
-                  (_this5$fireAnalyticsE2 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE2 === void 0 || _this5$fireAnalyticsE2.call(_this5, fetchErrorPayload(syncBlockInstance.error, syncBlockInstance.resourceId));
-                  if (syncBlockInstance.error === SyncBlockError.NotFound || syncBlockInstance.error === SyncBlockError.Forbidden) {
+                  (_this5$fireAnalyticsE2 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE2 === void 0 || _this5$fireAnalyticsE2.call(_this5, fetchErrorPayload(syncBlockInstance.error.type, syncBlockInstance.resourceId));
+                  if (syncBlockInstance.error.type === SyncBlockError.NotFound || syncBlockInstance.error.type === SyncBlockError.Forbidden) {
                     hasExpectedError = true;
                   } else if (syncBlockInstance.error) {
                     hasUnexpectedError = true;

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

@@ -8,7 +8,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
-import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload } from '../utils/errorHandling';
+import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience } from '../utils/experienceTracking';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -128,10 +128,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               if (fg('platform_synced_block_dogfooding')) {
                 (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 || _this$saveExperience.start({});
               }
-              ;
-              _context.next = 12;
+              _context.next = 11;
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
-            case 12:
+            case 11:
               writeResults = _context.sent;
               writeResults.forEach(function (result) {
                 // set isDirty to true for cases where it failed to save the sync block to the BE
@@ -145,7 +144,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               if (!writeResults.every(function (result) {
                 return result.resourceId && !result.error;
               })) {
-                _context.next = 20;
+                _context.next = 18;
                 break;
               }
               if (fg('platform_synced_block_dogfooding')) {
@@ -157,9 +156,8 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                   }
                 });
               }
-              ;
               return _context.abrupt("return", true);
-            case 20:
+            case 18:
               if (fg('platform_synced_block_dogfooding')) {
                 (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure();
               }
@@ -170,22 +168,22 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                 (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, updateErrorPayload(result.error || 'Failed to write data', result.resourceId));
               });
               return _context.abrupt("return", false);
-            case 23:
-              _context.next = 30;
+            case 21:
+              _context.next = 28;
               break;
-            case 25:
-              _context.prev = 25;
+            case 23:
+              _context.prev = 23;
               _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 30:
+            case 28:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 25]]);
+        }, _callee, this, [[0, 23]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);
@@ -338,7 +336,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "delete",
     value: function () {
-      var _delete2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(syncBlockIds, onDelete, onDeleteCompleted) {
+      var _delete2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(syncBlockIds, onDelete, onDeleteCompleted, reason) {
         var _this5 = this;
         var _this$deleteExperienc, results, callback, isDeleteSuccessful, _this$deleteExperienc2, _this$deleteExperienc3;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
@@ -360,7 +358,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               _context2.next = 7;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
-              }));
+              }), reason);
             case 7:
               results = _context2.sent;
               isDeleteSuccessful = results.every(function (result) {
@@ -425,7 +423,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           }
         }, _callee2, this, [[0, 15]]);
       }));
-      function _delete(_x, _x2, _x3) {
+      function _delete(_x, _x2, _x3, _x4) {
         return _delete2.apply(this, arguments);
       }
       return _delete;
@@ -439,7 +437,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     key: "retryDeletion",
     value: function () {
       var _retryDeletion = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
-        var _this$deletionRetryIn, syncBlockIds, onDelete, onDeleteCompleted;
+        var _this$deletionRetryIn, syncBlockIds, onDelete, onDeleteCompleted, deletionReason;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
@@ -449,13 +447,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               }
               return _context3.abrupt("return", Promise.resolve());
             case 2:
-              _this$deletionRetryIn = this.deletionRetryInfo, syncBlockIds = _this$deletionRetryIn.syncBlockIds, onDelete = _this$deletionRetryIn.onDelete, onDeleteCompleted = _this$deletionRetryIn.onDeleteCompleted;
+              _this$deletionRetryIn = this.deletionRetryInfo, syncBlockIds = _this$deletionRetryIn.syncBlockIds, onDelete = _this$deletionRetryIn.onDelete, onDeleteCompleted = _this$deletionRetryIn.onDeleteCompleted, deletionReason = _this$deletionRetryIn.deletionReason;
               if (!this.confirmationCallback) {
                 _context3.next = 6;
                 break;
               }
               _context3.next = 6;
-              return this.delete(syncBlockIds, onDelete, onDeleteCompleted);
+              return this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason);
             case 6:
             case "end":
               return _context3.stop();
@@ -485,7 +483,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "deleteSyncBlocksWithConfirmation",
     value: (function () {
-      var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(syncBlockIds, onDelete, onDeleteCompleted, destroyCallback) {
+      var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(syncBlockIds, deletionReason, onDelete, onDeleteCompleted, destroyCallback) {
         var confirmed, isDeleteSuccessful;
         return _regeneratorRuntime.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
@@ -495,7 +493,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                 break;
               }
               _context4.next = 3;
-              return this.confirmationCallback(syncBlockIds.length);
+              return this.confirmationCallback(syncBlockIds, deletionReason);
             case 3:
               confirmed = _context4.sent;
               if (!confirmed) {
@@ -503,7 +501,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                 break;
               }
               _context4.next = 7;
-              return this.delete(syncBlockIds, onDelete, onDeleteCompleted);
+              return this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason);
             case 7:
               isDeleteSuccessful = _context4.sent;
               if (!isDeleteSuccessful) {
@@ -512,7 +510,8 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                   syncBlockIds: syncBlockIds,
                   onDelete: onDelete,
                   onDeleteCompleted: onDeleteCompleted,
-                  destroyCallback: destroyCallback
+                  destroyCallback: destroyCallback,
+                  deletionReason: deletionReason
                 };
               } else {
                 destroyCallback();
@@ -527,7 +526,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           }
         }, _callee4, this);
       }));
-      function deleteSyncBlocksWithConfirmation(_x4, _x5, _x6, _x7) {
+      function deleteSyncBlocksWithConfirmation(_x5, _x6, _x7, _x8, _x9) {
         return _deleteSyncBlocksWithConfirmation.apply(this, arguments);
       }
       return deleteSyncBlocksWithConfirmation;
@@ -549,6 +548,25 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         return Promise.resolve(undefined);
       }
     }
+  }, {
+    key: "fetchReferences",
+    value: function fetchReferences(resourceId) {
+      try {
+        if (!this.dataProvider) {
+          throw new Error('Data provider not set');
+        }
+        return this.dataProvider.fetchReferences(resourceId, true);
+      } catch (error) {
+        var _this$fireAnalyticsEv7;
+        logException(error, {
+          location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
+        });
+        (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, fetchReferencesErrorPayload(error.message));
+        return Promise.resolve({
+          error: SyncBlockError.Errored
+        });
+      }
+    }
   }, {
     key: "destroy",
     value: function destroy() {

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

@@ -73,7 +73,7 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
                     while (1) switch (_context.prev = _context.next) {
                       case 0:
                         _context.next = 2;
-                        return (_this$dataProvider = _this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.fetchSyncBlockSourceInfo(blockInstanceId, reference.documentAri, getProductFromSourceAri(reference.documentAri), _this.fireAnalyticsEvent, reference.hasAccess, 'view');
+                        return (_this$dataProvider = _this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.fetchSyncBlockSourceInfo(reference.blockInstanceId || '', reference.documentAri, getProductFromSourceAri(reference.documentAri), _this.fireAnalyticsEvent, reference.hasAccess, 'view');
                       case 2:
                         sourceInfo = _context.sent;
                         if (sourceInfo) {

package/dist/esm/utils/resolveSyncBlockInstance.js

@@ -19,8 +19,9 @@ export var resolveSyncBlockInstance = function resolveSyncBlockInstance(oldResul
   if (!oldResult.data) {
     return newResult;
   } else if (!newResult.data) {
+    var _newResult$error, _newResult$error2;
     // return the old result if there was an error, e.g. network error, but not if not found or forbidden
-    if (newResult.error === SyncBlockError.NotFound || newResult.error === SyncBlockError.Forbidden) {
+    if (((_newResult$error = newResult.error) === null || _newResult$error === void 0 ? void 0 : _newResult$error.type) === SyncBlockError.NotFound || ((_newResult$error2 = newResult.error) === null || _newResult$error2 === void 0 ? void 0 : _newResult$error2.type) === SyncBlockError.Forbidden) {
       return newResult;
     } else {
       return oldResult;

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

@@ -1,4 +1,4 @@
-import type { ReferenceSyncBlockResponse, SyncBlockProduct, SyncBlockStatus } from '../../common/types';
+import type { ReferenceSyncBlockResponse, SyncBlockProduct, SyncBlockStatus, DeletionReason } from '../../common/types';
 export type BlockContentResponse = {
     blockAri: string;
     blockInstanceId: string;
@@ -6,6 +6,7 @@ export type BlockContentResponse = {
     contentUpdatedAt: number;
     createdAt: number;
     createdBy: string;
+    deletionReason: DeletionReason;
     product: SyncBlockProduct;
     sourceAri: string;
     status: SyncBlockStatus;
@@ -70,6 +71,7 @@ export type GetSyncedBlockContentRequest = {
 };
 export type DeleteSyncedBlockRequest = {
     blockAri: string;
+    deleteReason: string | undefined;
 };
 export type UpdateSyncedBlockRequest = {
     blockAri: string;
@@ -127,7 +129,7 @@ export declare const getSyncedBlockContent: ({ blockAri }: GetSyncedBlockContent
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
  */
 export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, documentAri, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
-export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
+export declare const deleteSyncedBlock: ({ blockAri, deleteReason, }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;

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

@@ -32,6 +32,7 @@ export interface SyncBlockData {
     contentUpdatedAt?: string;
     createdAt?: string;
     createdBy?: string;
+    deletionReason?: DeletionReason;
     isSynced?: boolean;
     /**
      * Whether the block is on the same page as the source block
@@ -47,6 +48,7 @@ export interface SyncBlockData {
     sourceTitle?: string;
     sourceURL?: string;
     status?: SyncBlockStatus;
+    updatedAt?: string;
 }
 export interface ReferenceSyncBlockResponse {
     blockAri: string;
@@ -68,3 +70,5 @@ export type ReferencesSourceInfo = {
     error?: SyncBlockError;
     references?: Array<SyncBlockSourceInfo | undefined>;
 };
+export type DeletionReason = 'source-block-deleted' | 'source-block-unsynced';
+export type DeletionReasonResponse = DeletionReason | 'source-document-deleted';

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 export { rebaseTransaction } from './common/rebase-transaction';
 export { SyncBlockError } from './common/types';
-export type { ResourceId, SyncBlockData, SyncBlockNode, SyncBlockProduct, SyncBlockStatus, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, ReferencesSourceInfo } from './common/types';
+export type { ResourceId, SyncBlockData, SyncBlockNode, SyncBlockProduct, SyncBlockStatus, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, ReferencesSourceInfo, DeletionReason, } from './common/types';
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';

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

@@ -72,7 +72,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
-    deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    deleteData(resourceId: string, deleteReason: string | undefined): Promise<DeleteSyncBlockResult>;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     generateResourceId(): ResourceId;
     updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;

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

@@ -1,6 +1,6 @@
 import type { RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import { type BlockInstanceId, type ReferenceSyncBlockData, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
+import { type BlockInstanceId, type DeletionReason, type ReferenceSyncBlockData, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
 import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type BlockSubscriptionErrorCallback, type BlockUpdateCallback, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type Unsubscribe, type UpdateReferenceSyncBlockResult, type WriteSyncBlockResult } from './types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
@@ -58,7 +58,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      *
      * @returns Array of {resourceId?: string, error?: string}.
      */
-    deleteNodesData(resourceIds: ResourceId[]): Promise<Array<DeleteSyncBlockResult>>;
+    deleteNodesData(resourceIds: ResourceId[], deletionReason: DeletionReason | undefined): Promise<Array<DeleteSyncBlockResult>>;
     /**
      * Fetch the source info from the source id
      *

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, SyncBlockAttrs, ReferenceSyncBlockData } from '../common/types';
+import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, DeletionReason } 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.
@@ -12,7 +12,10 @@ import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBloc
  */
 export type SyncBlockInstance = {
     data?: SyncBlockData;
-    error?: SyncBlockError;
+    error?: {
+        reason?: string;
+        type: SyncBlockError;
+    };
     /**
      *  The resourceId in the attrs of the block
      */
@@ -73,10 +76,11 @@ export interface ADFWriteProvider {
     /**
      * Delete source block.
      * @param resourceId the resourceId of the block to be deleted
+     * @param deleteReason the reason for the deletion, e.g. 'source-block-unsynced', 'source-block-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>;
+    deleteData: (resourceId: ResourceId, deleteReason: string | undefined) => Promise<DeleteSyncBlockResult>;
     generateResourceIdForReference: (sourceId: ResourceId) => ResourceId;
     parentAri?: string;
     product: SyncBlockProduct;
@@ -105,7 +109,7 @@ export type SyncedBlockRendererProviderOptions = {
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract createNodeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
-    abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
+    abstract deleteNodesData(resourceIds: string[], deleteReason: DeletionReason | undefined): Promise<Array<DeleteSyncBlockResult>>;
     abstract fetchSyncBlockSourceInfo(localId: BlockInstanceId, sourceAri?: string, sourceProduct?: SyncBlockProduct, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void, hasAccess?: boolean, urlType?: 'view' | 'edit'): Promise<SyncBlockSourceInfo | undefined>;
     abstract setProviderOptions(providerOptions: SyncedBlockRendererProviderOptions): void;
     abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;

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

@@ -1,8 +1,8 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { type ResourceId, type SyncBlockAttrs, type BlockInstanceId } from '../common/types';
+import { type ResourceId, type SyncBlockAttrs, type BlockInstanceId, type DeletionReason, type ReferenceSyncBlockData } from '../common/types';
 import type { SyncBlockDataProvider, SyncBlockSourceInfo } from '../providers/types';
-export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
+export type ConfirmationCallback = (syncBlockIds: SyncBlockAttrs[], deleteReason: DeletionReason | undefined) => Promise<boolean>;
 type OnDelete = () => void;
 type OnDeleteCompleted = (success: boolean) => void;
 type DestroyCallback = () => void;
@@ -70,8 +70,9 @@ export declare class SourceSyncBlockStoreManager {
      * @param onDeleteCompleted - The callback for after the deletion is saved to BE (whether successful or not)
      * @param destroyCallback - The callback to clear any reference stored for deletion (regardless if deletion is completed or abort)
      */
-    deleteSyncBlocksWithConfirmation(syncBlockIds: SyncBlockAttrs[], onDelete: OnDelete, onDeleteCompleted: OnDeleteCompleted, destroyCallback: DestroyCallback): Promise<void>;
+    deleteSyncBlocksWithConfirmation(syncBlockIds: SyncBlockAttrs[], deletionReason: DeletionReason | undefined, onDelete: OnDelete, onDeleteCompleted: OnDeleteCompleted, destroyCallback: DestroyCallback): Promise<void>;
     getSyncBlockSourceInfo(localId: BlockInstanceId): Promise<SyncBlockSourceInfo | undefined>;
+    fetchReferences(resourceId: string): Promise<ReferenceSyncBlockData>;
     destroy(): void;
 }
 export {};

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

@@ -1,4 +1,4 @@
-import type { ReferenceSyncBlockResponse, SyncBlockProduct, SyncBlockStatus } from '../../common/types';
+import type { ReferenceSyncBlockResponse, SyncBlockProduct, SyncBlockStatus, DeletionReason } from '../../common/types';
 export type BlockContentResponse = {
     blockAri: string;
     blockInstanceId: string;
@@ -6,6 +6,7 @@ export type BlockContentResponse = {
     contentUpdatedAt: number;
     createdAt: number;
     createdBy: string;
+    deletionReason: DeletionReason;
     product: SyncBlockProduct;
     sourceAri: string;
     status: SyncBlockStatus;
@@ -70,6 +71,7 @@ export type GetSyncedBlockContentRequest = {
 };
 export type DeleteSyncedBlockRequest = {
     blockAri: string;
+    deleteReason: string | undefined;
 };
 export type UpdateSyncedBlockRequest = {
     blockAri: string;
@@ -127,7 +129,7 @@ export declare const getSyncedBlockContent: ({ blockAri }: GetSyncedBlockContent
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
  */
 export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, documentAri, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
-export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
+export declare const deleteSyncedBlock: ({ blockAri, deleteReason, }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;

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

@@ -32,6 +32,7 @@ export interface SyncBlockData {
     contentUpdatedAt?: string;
     createdAt?: string;
     createdBy?: string;
+    deletionReason?: DeletionReason;
     isSynced?: boolean;
     /**
      * Whether the block is on the same page as the source block
@@ -47,6 +48,7 @@ export interface SyncBlockData {
     sourceTitle?: string;
     sourceURL?: string;
     status?: SyncBlockStatus;
+    updatedAt?: string;
 }
 export interface ReferenceSyncBlockResponse {
     blockAri: string;
@@ -68,3 +70,5 @@ export type ReferencesSourceInfo = {
     error?: SyncBlockError;
     references?: Array<SyncBlockSourceInfo | undefined>;
 };
+export type DeletionReason = 'source-block-deleted' | 'source-block-unsynced';
+export type DeletionReasonResponse = DeletionReason | 'source-document-deleted';

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

@@ -1,6 +1,6 @@
 export { rebaseTransaction } from './common/rebase-transaction';
 export { SyncBlockError } from './common/types';
-export type { ResourceId, SyncBlockData, SyncBlockNode, SyncBlockProduct, SyncBlockStatus, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, ReferencesSourceInfo } from './common/types';
+export type { ResourceId, SyncBlockData, SyncBlockNode, SyncBlockProduct, SyncBlockStatus, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, ReferencesSourceInfo, DeletionReason, } from './common/types';
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';

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

@@ -72,7 +72,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
-    deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    deleteData(resourceId: string, deleteReason: string | undefined): Promise<DeleteSyncBlockResult>;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     generateResourceId(): ResourceId;
     updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;

package/dist/types-ts4.5/providers/syncBlockProvider.d.ts

@@ -1,6 +1,6 @@
 import type { RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import { type BlockInstanceId, type ReferenceSyncBlockData, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
+import { type BlockInstanceId, type DeletionReason, type ReferenceSyncBlockData, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
 import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type BlockSubscriptionErrorCallback, type BlockUpdateCallback, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type Unsubscribe, type UpdateReferenceSyncBlockResult, type WriteSyncBlockResult } from './types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
@@ -58,7 +58,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      *
      * @returns Array of {resourceId?: string, error?: string}.
      */
-    deleteNodesData(resourceIds: ResourceId[]): Promise<Array<DeleteSyncBlockResult>>;
+    deleteNodesData(resourceIds: ResourceId[], deletionReason: DeletionReason | undefined): Promise<Array<DeleteSyncBlockResult>>;
     /**
      * Fetch the source info from the source id
      *

package/dist/types-ts4.5/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, SyncBlockAttrs, ReferenceSyncBlockData } from '../common/types';
+import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, DeletionReason } 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.
@@ -12,7 +12,10 @@ import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBloc
  */
 export type SyncBlockInstance = {
     data?: SyncBlockData;
-    error?: SyncBlockError;
+    error?: {
+        reason?: string;
+        type: SyncBlockError;
+    };
     /**
      *  The resourceId in the attrs of the block
      */
@@ -73,10 +76,11 @@ export interface ADFWriteProvider {
     /**
      * Delete source block.
      * @param resourceId the resourceId of the block to be deleted
+     * @param deleteReason the reason for the deletion, e.g. 'source-block-unsynced', 'source-block-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>;
+    deleteData: (resourceId: ResourceId, deleteReason: string | undefined) => Promise<DeleteSyncBlockResult>;
     generateResourceIdForReference: (sourceId: ResourceId) => ResourceId;
     parentAri?: string;
     product: SyncBlockProduct;
@@ -105,7 +109,7 @@ export type SyncedBlockRendererProviderOptions = {
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract createNodeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
-    abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
+    abstract deleteNodesData(resourceIds: string[], deleteReason: DeletionReason | undefined): Promise<Array<DeleteSyncBlockResult>>;
     abstract fetchSyncBlockSourceInfo(localId: BlockInstanceId, sourceAri?: string, sourceProduct?: SyncBlockProduct, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void, hasAccess?: boolean, urlType?: 'view' | 'edit'): Promise<SyncBlockSourceInfo | undefined>;
     abstract setProviderOptions(providerOptions: SyncedBlockRendererProviderOptions): void;
     abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;

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

@@ -1,8 +1,8 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { type ResourceId, type SyncBlockAttrs, type BlockInstanceId } from '../common/types';
+import { type ResourceId, type SyncBlockAttrs, type BlockInstanceId, type DeletionReason, type ReferenceSyncBlockData } from '../common/types';
 import type { SyncBlockDataProvider, SyncBlockSourceInfo } from '../providers/types';
-export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
+export type ConfirmationCallback = (syncBlockIds: SyncBlockAttrs[], deleteReason: DeletionReason | undefined) => Promise<boolean>;
 type OnDelete = () => void;
 type OnDeleteCompleted = (success: boolean) => void;
 type DestroyCallback = () => void;
@@ -70,8 +70,9 @@ export declare class SourceSyncBlockStoreManager {
      * @param onDeleteCompleted - The callback for after the deletion is saved to BE (whether successful or not)
      * @param destroyCallback - The callback to clear any reference stored for deletion (regardless if deletion is completed or abort)
      */
-    deleteSyncBlocksWithConfirmation(syncBlockIds: SyncBlockAttrs[], onDelete: OnDelete, onDeleteCompleted: OnDeleteCompleted, destroyCallback: DestroyCallback): Promise<void>;
+    deleteSyncBlocksWithConfirmation(syncBlockIds: SyncBlockAttrs[], deletionReason: DeletionReason | undefined, onDelete: OnDelete, onDeleteCompleted: OnDeleteCompleted, destroyCallback: DestroyCallback): Promise<void>;
     getSyncBlockSourceInfo(localId: BlockInstanceId): Promise<SyncBlockSourceInfo | undefined>;
+    fetchReferences(resourceId: string): Promise<ReferenceSyncBlockData>;
     destroy(): void;
 }
 export {};

package/package.json

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