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

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

@@ -7,9 +7,11 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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; }
 import { useMemo } from 'react';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getProductFromSourceAri } from '../clients/block-service/ari';
 import { SyncBlockError } from '../common/types';
 import { fetchReferencesErrorPayload } from '../utils/errorHandling';
+import { getFetchReferencesExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
 import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 
@@ -32,7 +34,7 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
     value: function () {
       var _fetchReferencesSourceInfo = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(resourceId, blockInstanceId, isSourceSyncBlock) {
         var _this = this;
-        var _response$references, response, sourceInfoPromises, sourceInfos, sourceSyncBlockData, _this$fireAnalyticsEv;
+        var _this$fetchReferences, _response$references, _this$fetchReferences5, response, _this$fetchReferences2, _this$fetchReferences3, _this$fetchReferences4, sourceInfoPromises, sourceInfos, sourceSyncBlockData, _this$fireAnalyticsEv;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -43,51 +45,69 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
               }
               throw new Error('Data provider not set');
             case 3:
-              _context2.next = 5;
+              (_this$fetchReferences = this.fetchReferencesExperience) === null || _this$fetchReferences === void 0 || _this$fetchReferences.start();
+              _context2.next = 6;
               return this.dataProvider.fetchReferences(resourceId, isSourceSyncBlock);
-            case 5:
+            case 6:
               response = _context2.sent;
               if (!response.error) {
-                _context2.next = 8;
+                _context2.next = 10;
                 break;
               }
+              (_this$fetchReferences2 = this.fetchReferencesExperience) === null || _this$fetchReferences2 === void 0 || _this$fetchReferences2.failure({
+                reason: response.error
+              });
               return _context2.abrupt("return", {
                 error: response.error
               });
-            case 8:
+            case 10:
               if (!(!response.references || ((_response$references = response.references) === null || _response$references === void 0 ? void 0 : _response$references.length) === 0)) {
-                _context2.next = 10;
+                _context2.next = 13;
                 break;
               }
+              // No reference found
+              if (isSourceSyncBlock) {
+                (_this$fetchReferences3 = this.fetchReferencesExperience) === null || _this$fetchReferences3 === void 0 || _this$fetchReferences3.success();
+              } else {
+                (_this$fetchReferences4 = this.fetchReferencesExperience) === null || _this$fetchReferences4 === void 0 || _this$fetchReferences4.failure({
+                  reason: 'No references found for reference synced block'
+                });
+              }
               return _context2.abrupt("return", isSourceSyncBlock ? {
                 references: []
               } : {
                 error: SyncBlockError.Errored
               });
-            case 10:
+            case 13:
+              (_this$fetchReferences5 = this.fetchReferencesExperience) === null || _this$fetchReferences5 === void 0 || _this$fetchReferences5.success();
               sourceInfoPromises = response.references.map( /*#__PURE__*/function () {
                 var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(reference) {
-                  var _this$dataProvider;
-                  var sourceInfo;
+                  var _this$fetchSourceInfo, _this$dataProvider, _this$fetchSourceInfo3;
+                  var sourceInfo, _this$fetchSourceInfo2;
                   return _regeneratorRuntime.wrap(function _callee$(_context) {
                     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');
-                      case 2:
+                        (_this$fetchSourceInfo = _this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo === void 0 || _this$fetchSourceInfo.start();
+                        _context.next = 3;
+                        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 3:
                         sourceInfo = _context.sent;
                         if (sourceInfo) {
-                          _context.next = 5;
+                          _context.next = 7;
                           break;
                         }
+                        (_this$fetchSourceInfo2 = _this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo2 === void 0 || _this$fetchSourceInfo2.failure({
+                          reason: "no source info returned for ari: ".concat(reference.documentAri)
+                        });
                         return _context.abrupt("return", undefined);
-                      case 5:
+                      case 7:
+                        (_this$fetchSourceInfo3 = _this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo3 === void 0 || _this$fetchSourceInfo3.success();
                         return _context.abrupt("return", _objectSpread(_objectSpread({}, sourceInfo), {}, {
                           onSameDocument: reference.onSameDocument,
                           hasAccess: reference.hasAccess,
                           productType: sourceInfo.productType
                         }));
-                      case 6:
+                      case 9:
                       case "end":
                         return _context.stop();
                     }
@@ -97,13 +117,13 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
                   return _ref.apply(this, arguments);
                 };
               }());
-              _context2.next = 13;
+              _context2.next = 17;
               return Promise.all(sourceInfoPromises);
-            case 13:
+            case 17:
               sourceInfos = _context2.sent;
-              _context2.next = 16;
+              _context2.next = 20;
               return isSourceSyncBlock ? this.sourceSyncBlockStoreManager.getSyncBlockSourceInfo(blockInstanceId) : this.referenceSyncBlockStoreManager.fetchSyncBlockSourceInfo(resourceId);
-            case 16:
+            case 20:
               sourceSyncBlockData = _context2.sent;
               if (sourceSyncBlockData) {
                 sourceInfos.push(_objectSpread(_objectSpread({}, sourceSyncBlockData), {}, {
@@ -116,8 +136,8 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
               return _context2.abrupt("return", {
                 references: sourceInfos
               });
-            case 21:
-              _context2.prev = 21;
+            case 25:
+              _context2.prev = 25;
               _context2.t0 = _context2["catch"](0);
               logException(_context2.t0, {
                 location: 'editor-synced-block-provider/syncBlockStoreManager'
@@ -126,11 +146,11 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
               return _context2.abrupt("return", {
                 error: SyncBlockError.Errored
               });
-            case 26:
+            case 30:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[0, 21]]);
+        }, _callee2, this, [[0, 25]]);
       }));
       function fetchReferencesSourceInfo(_x, _x2, _x3) {
         return _fetchReferencesSourceInfo.apply(this, arguments);
@@ -143,6 +163,10 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
       this.referenceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
       this.sourceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+      if (fg('platform_synced_block_dogfooding')) {
+        this.fetchReferencesExperience = getFetchReferencesExperience(fireAnalyticsEvent);
+        this.fetchSourceInfoExperience = getFetchSourceInfoExperience(fireAnalyticsEvent);
+      }
     }
   }, {
     key: "referenceManager",
@@ -157,8 +181,15 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "destroy",
     value: function destroy() {
+      var _this$fetchReferences6, _this$fetchSourceInfo4;
       this.referenceSyncBlockStoreManager.destroy();
       this.sourceSyncBlockStoreManager.destroy();
+      (_this$fetchReferences6 = this.fetchReferencesExperience) === null || _this$fetchReferences6 === void 0 || _this$fetchReferences6.abort({
+        reason: 'editorDestroyed'
+      });
+      (_this$fetchSourceInfo4 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo4 === void 0 || _this$fetchSourceInfo4.abort({
+        reason: 'editorDestroyed'
+      });
     }
   }]);
 }();

package/dist/esm/utils/experienceTracking.js

@@ -110,4 +110,21 @@ export var getCreateSourceExperience = function getCreateSourceExperience(fireAn
       durationMs: TIMEOUT_DURATION
     })]
   });
+};
+
+/**
+ * This experience tracks when a source sync block is created and registered to the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export var getFetchReferencesExperience = function getFetchReferencesExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_FETCH_REFERENCES,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
 };

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;
@@ -82,6 +84,7 @@ export type CreateSyncedBlockRequest = {
     content: string;
     product: SyncBlockProduct;
     sourceAri: string;
+    status?: SyncBlockStatus;
     stepVersion?: number;
 };
 type ReferenceSyncedBlockIDs = {
@@ -117,7 +120,7 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
-export declare const getSyncedBlockContent: ({ blockAri }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
  *
@@ -127,9 +130,9 @@ 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 createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
 export declare const getReferenceSyncedBlocksByBlockAri: ({ blockAri, }: GetReferenceSyncedBlocksByBlockAriRequest) => Promise<GetReferenceSyncedBlocksByBlockAriResponse>;
 export {};

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

@@ -56,6 +56,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;
     getVersion?: () => number | undefined;
+    isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;
     product: SyncBlockProduct;
@@ -67,12 +68,13 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     private cloudId;
     private parentId?;
     private getVersion?;
+    private isParentUnpublished?;
     product: SyncBlockProduct;
     parentAri: string | undefined;
-    constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
+    constructor({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: 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>;
@@ -80,11 +82,12 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
 interface BlockServiceAPIProvidersProps {
     cloudId: string;
     getVersion?: () => number | undefined;
+    isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;
     product: SyncBlockProduct;
 }
-export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
+export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: BlockServiceAPIProvidersProps) => {
     fetchProvider: BlockServiceADFFetchProvider;
     writeProvider: BlockServiceADFWriteProvider;
 };

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/referenceSyncBlockStoreManager.d.ts

@@ -20,6 +20,8 @@ export declare class ReferenceSyncBlockStoreManager {
     private graphqlSubscriptions;
     private useRealTimeSubscriptions;
     private subscriptionChangeListeners;
+    private newlyAddedSyncBlocks;
+    private onUnpublishedSyncBlockDetected?;
     fetchExperience: Experience | undefined;
     private fetchSourceInfoExperience;
     private saveExperience;
@@ -57,6 +59,13 @@ export declare class ReferenceSyncBlockStoreManager {
      */
     handleSubscriptionUpdate(syncBlockInstance: SyncBlockInstance): void;
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
+    setOnUnpublishedSyncBlockDetected(callback?: (resourceId: ResourceId) => void): void;
+    /**
+     * Mark a sync block as newly added to the document.
+     * This should be called when a sync block node is added via a transaction.
+     * @param resourceId - The resource ID of the newly added sync block
+     */
+    markAsNewlyAdded(resourceId: ResourceId): void;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;

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;
@@ -18,6 +18,7 @@ export declare class SourceSyncBlockStoreManager {
     private createExperience;
     private saveExperience;
     private deleteExperience;
+    private fetchSourceInfoExperience;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     isSourceBlock(node: PMNode): boolean;
@@ -70,8 +71,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/store-manager/syncBlockStoreManager.d.ts

@@ -8,6 +8,8 @@ export declare class SyncBlockStoreManager {
     private sourceSyncBlockStoreManager;
     private dataProvider?;
     private fireAnalyticsEvent?;
+    private fetchReferencesExperience;
+    private fetchSourceInfoExperience;
     constructor(dataProvider?: SyncBlockDataProvider);
     fetchReferencesSourceInfo(resourceId: ResourceId, blockInstanceId: BlockInstanceId, isSourceSyncBlock: boolean): Promise<ReferencesSourceInfo>;
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;

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

@@ -49,3 +49,11 @@ export declare const getDeleteSourceExperience: (fireAnalyticsEvent?: (payload:
  * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
  */
 export declare const getCreateSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a source sync block is created and registered to the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getFetchReferencesExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;

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;
@@ -82,6 +84,7 @@ export type CreateSyncedBlockRequest = {
     content: string;
     product: SyncBlockProduct;
     sourceAri: string;
+    status?: SyncBlockStatus;
     stepVersion?: number;
 };
 type ReferenceSyncedBlockIDs = {
@@ -117,7 +120,7 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
-export declare const getSyncedBlockContent: ({ blockAri }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
  *
@@ -127,9 +130,9 @@ 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 createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
 export declare const getReferenceSyncedBlocksByBlockAri: ({ blockAri, }: GetReferenceSyncedBlocksByBlockAriRequest) => Promise<GetReferenceSyncedBlocksByBlockAriResponse>;
 export {};

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

@@ -56,6 +56,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;
     getVersion?: () => number | undefined;
+    isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;
     product: SyncBlockProduct;
@@ -67,12 +68,13 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     private cloudId;
     private parentId?;
     private getVersion?;
+    private isParentUnpublished?;
     product: SyncBlockProduct;
     parentAri: string | undefined;
-    constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
+    constructor({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: 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>;
@@ -80,11 +82,12 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
 interface BlockServiceAPIProvidersProps {
     cloudId: string;
     getVersion?: () => number | undefined;
+    isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;
     product: SyncBlockProduct;
 }
-export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
+export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: BlockServiceAPIProvidersProps) => {
     fetchProvider: BlockServiceADFFetchProvider;
     writeProvider: BlockServiceADFWriteProvider;
 };

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
      *