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

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/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-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;
@@ -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-ts4.5/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-ts4.5/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/package.json

@@ -35,7 +35,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.8.0",
+		"@atlaskit/editor-common": "^111.9.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -78,7 +78,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.14.1",
+	"version": "3.14.3",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",