@atlaskit/editor-synced-block-provider 6.6.5 → 6.6.7

package/dist/esm/utils/utils.js

@@ -1,9 +1,56 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 require-unicode-regexp  */
 
+import { fg } from '@atlaskit/platform-feature-flags';
+var _stripAnnotationMarksFromJSONContent = function stripAnnotationMarksFromJSONContent(content) {
+  var strippedContent;
+  content.forEach(function (contentNode, index) {
+    var _contentNode$marks;
+    if (!contentNode) {
+      var _strippedContent;
+      (_strippedContent = strippedContent) === null || _strippedContent === void 0 || _strippedContent.push(contentNode);
+      return;
+    }
+    var hasAnnotationMark = (_contentNode$marks = contentNode.marks) === null || _contentNode$marks === void 0 ? void 0 : _contentNode$marks.some(function (mark) {
+      return mark.type === 'annotation';
+    });
+    var childContent = contentNode.content ? _stripAnnotationMarksFromJSONContent(contentNode.content) : undefined;
+    var hasContentChanged = childContent !== undefined && childContent !== contentNode.content;
+    if (!hasAnnotationMark && !hasContentChanged) {
+      var _strippedContent2;
+      (_strippedContent2 = strippedContent) === null || _strippedContent2 === void 0 || _strippedContent2.push(contentNode);
+      return;
+    }
+    if (!strippedContent) {
+      strippedContent = content.slice(0, index);
+    }
+    var strippedNode = _objectSpread({}, contentNode);
+    if (hasAnnotationMark) {
+      var _contentNode$marks2;
+      var marks = (_contentNode$marks2 = contentNode.marks) === null || _contentNode$marks2 === void 0 ? void 0 : _contentNode$marks2.filter(function (mark) {
+        return mark.type !== 'annotation';
+      });
+      if (marks && marks.length > 0) {
+        strippedNode.marks = marks;
+      } else {
+        delete strippedNode.marks;
+      }
+    }
+    if (hasContentChanged && childContent) {
+      strippedNode.content = childContent;
+    }
+    strippedContent.push(strippedNode);
+  });
+  return strippedContent !== null && strippedContent !== void 0 ? strippedContent : content;
+};
+export { _stripAnnotationMarksFromJSONContent as stripAnnotationMarksFromJSONContent };
 export var convertSyncBlockPMNodeToSyncBlockData = function convertSyncBlockPMNodeToSyncBlockData(node) {
+  var content = node.content.toJSON();
   return {
     blockInstanceId: node.attrs.localId,
-    content: node.content.toJSON(),
+    content: fg('platform_synced_block_patch_12') ? _stripAnnotationMarksFromJSONContent(content) : content,
     resourceId: node.attrs.resourceId
   };
 };

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

@@ -31,6 +31,7 @@ export type ParsedBlockSubscriptionData = {
 };
 type SubscriptionCallback = (data: ParsedBlockSubscriptionData) => void;
 type ErrorCallback = (error: Error) => void;
+type CompleteCallback = () => void;
 type Unsubscribe = () => void;
 /**
  * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
@@ -47,5 +48,5 @@ export declare const extractGraphQLWSErrorMessage: (error: unknown) => string;
  * @param onError - Optional callback function invoked on subscription errors
  * @returns Unsubscribe function to close the subscription
  */
-export declare const subscribeToBlockUpdates: (blockAri: string, onData: SubscriptionCallback, onError?: ErrorCallback) => Unsubscribe;
+export declare const subscribeToBlockUpdates: (blockAri: string, onData: SubscriptionCallback, onError?: ErrorCallback, onComplete?: CompleteCallback) => Unsubscribe;
 export {};

package/dist/types/entry-points/providers-types.d.ts

@@ -1 +1 @@
-export type { ADFFetchProvider, ADFWriteProvider, BatchFetchConfig, BlockNodeIdentifiers, BlockSubscriptionErrorCallback, BlockUpdateCallback, SyncBlockDataProviderInterface, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, Unsubscribe, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, SyncBlockSourceInfo, SyncBlockJiraIssueType, } from '../providers/types';
+export type { ADFFetchProvider, ADFWriteProvider, BatchFetchConfig, BlockNodeIdentifiers, BlockSubscriptionCompleteCallback, BlockSubscriptionErrorCallback, BlockUpdateCallback, SyncBlockDataProviderInterface, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, Unsubscribe, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, SyncBlockSourceInfo, SyncBlockJiraIssueType, } from '../providers/types';

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

@@ -73,7 +73,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
      * @param onError - Optional callback function invoked on subscription errors
      * @returns Unsubscribe function to stop receiving updates
      */
-    subscribeToBlockUpdates(resourceId: ResourceId, onUpdate: (data: SyncBlockInstance) => void, onError?: (error: Error) => void): () => void;
+    subscribeToBlockUpdates(resourceId: ResourceId, onUpdate: (data: SyncBlockInstance) => void, onError?: (error: Error) => void, onComplete?: () => void): () => void;
 }
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;

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

@@ -98,7 +98,7 @@ export declare class SyncedBlockProvider extends SyncBlockDataProviderInterface
      * @param onError - Optional callback function invoked on subscription errors
      * @returns Unsubscribe function to stop receiving updates, or undefined if not supported
      */
-    subscribeToBlockUpdates(resourceId: string, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback): Unsubscribe | undefined;
+    subscribeToBlockUpdates(resourceId: string, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback, onComplete?: () => void): Unsubscribe | undefined;
 }
 type UseMemoizedSyncedBlockProviderProps = {
     fetchProvider: ADFFetchProvider;

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

@@ -92,6 +92,7 @@ export type BatchFetchConfig = {
 };
 export type BlockUpdateCallback = (data: SyncBlockInstance) => void;
 export type BlockSubscriptionErrorCallback = (error: Error) => void;
+export type BlockSubscriptionCompleteCallback = () => void;
 export type Unsubscribe = () => void;
 export interface ADFFetchProvider {
     batchFetchData: (blockNodeIdentifiers: BlockNodeIdentifiers[], config?: BatchFetchConfig) => Promise<SyncBlockInstance[]>;
@@ -100,7 +101,7 @@ export interface ADFFetchProvider {
     /**
      * Subscribes to real-time updates for a specific block.
      */
-    subscribeToBlockUpdates?: (resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback) => Unsubscribe;
+    subscribeToBlockUpdates?: (resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback, onComplete?: BlockSubscriptionCompleteCallback) => Unsubscribe;
 }
 export interface ADFWriteProvider {
     createData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
@@ -174,9 +175,10 @@ export declare abstract class SyncBlockDataProviderInterface extends NodeDataPro
      * @param resourceId - The resource ID of the block to subscribe to
      * @param onUpdate - Callback function invoked when the block is updated
      * @param onError - Optional callback function invoked on subscription errors
+     * @param onComplete - Optional callback function invoked when the subscription completes
      * @returns Unsubscribe function to stop receiving updates, or undefined if not supported
      */
-    subscribeToBlockUpdates?(resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback): Unsubscribe | undefined;
+    subscribeToBlockUpdates?(resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback, onComplete?: BlockSubscriptionCompleteCallback): Unsubscribe | undefined;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -65,6 +65,7 @@ export declare class ReferenceSyncBlockStoreManager {
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;
+    private stripAnnotationMarksFromReferenceData;
     private updateSessionCache;
     private getFromSessionCache;
     fetchSyncBlockSourceInfoBySourceAri(sourceAri: string, hasAccess?: boolean): Promise<SyncBlockSourceInfo | undefined>;

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

@@ -26,6 +26,11 @@ export declare class SyncBlockSubscriptionManager {
     private subscriptionChangeListeners;
     private useRealTimeSubscriptions;
     private pendingCacheDeletions;
+    private static readonly INITIAL_RETRY_DELAY_MS;
+    private static readonly RETRY_BACKOFF_MULTIPLIER;
+    private static readonly MAX_RETRY_ATTEMPTS;
+    private retryAttempts;
+    private pendingRetries;
     constructor(deps: SyncBlockSubscriptionManagerDeps);
     /**
      * Returns the subscriptions map. Used by external consumers (e.g. batch fetcher, flush)
@@ -48,6 +53,24 @@ export declare class SyncBlockSubscriptionManager {
      */
     notifySubscriptionCallbacks(resourceId: ResourceId, syncBlock: SyncBlockInstance): void;
     setupSubscription(resourceId: ResourceId): void;
+    /**
+     * Handles subscription termination (complete or error) by cleaning up the
+     * stale entry and scheduling a reconnection with exponential backoff.
+     */
+    private handleSubscriptionTerminated;
+    /**
+     * Schedules a reconnection attempt with exponential backoff.
+     * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
+     * e.g. 1s, 2s, 4s, 8s, 16s
+     */
+    private scheduleReconnection;
+    /**
+     * Resets the retry counter for a resource. Called when a successful
+     * update is received, indicating the subscription is healthy.
+     */
+    private resetRetryCount;
+    private cancelPendingRetry;
+    private cancelAllPendingRetries;
     cleanupSubscription(resourceId: ResourceId): void;
     setupSubscriptionsForAllBlocks(): void;
     cleanupAll(): void;

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

@@ -1,6 +1,7 @@
-import type { JSONNode } from '@atlaskit/editor-json-transformer';
+import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockData, BlockInstanceId, ResourceId, SyncBlockNode, SyncBlockProduct } from '../common/types';
+export declare const stripAnnotationMarksFromJSONContent: <T extends JSONNode | undefined>(content: T[]) => T[];
 export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode) => SyncBlockData;
 export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
 export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) => SyncBlockNode | undefined;

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

@@ -31,6 +31,7 @@ export type ParsedBlockSubscriptionData = {
 };
 type SubscriptionCallback = (data: ParsedBlockSubscriptionData) => void;
 type ErrorCallback = (error: Error) => void;
+type CompleteCallback = () => void;
 type Unsubscribe = () => void;
 /**
  * Extracts a meaningful error message from the error: GraphQL WebSocket Error: {"isTrusted":true}
@@ -47,5 +48,5 @@ export declare const extractGraphQLWSErrorMessage: (error: unknown) => string;
  * @param onError - Optional callback function invoked on subscription errors
  * @returns Unsubscribe function to close the subscription
  */
-export declare const subscribeToBlockUpdates: (blockAri: string, onData: SubscriptionCallback, onError?: ErrorCallback) => Unsubscribe;
+export declare const subscribeToBlockUpdates: (blockAri: string, onData: SubscriptionCallback, onError?: ErrorCallback, onComplete?: CompleteCallback) => Unsubscribe;
 export {};

package/dist/types-ts4.5/entry-points/providers-types.d.ts

@@ -1 +1 @@
-export type { ADFFetchProvider, ADFWriteProvider, BatchFetchConfig, BlockNodeIdentifiers, BlockSubscriptionErrorCallback, BlockUpdateCallback, SyncBlockDataProviderInterface, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, Unsubscribe, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, SyncBlockSourceInfo, SyncBlockJiraIssueType, } from '../providers/types';
+export type { ADFFetchProvider, ADFWriteProvider, BatchFetchConfig, BlockNodeIdentifiers, BlockSubscriptionCompleteCallback, BlockSubscriptionErrorCallback, BlockUpdateCallback, SyncBlockDataProviderInterface, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, Unsubscribe, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, SyncBlockSourceInfo, SyncBlockJiraIssueType, } from '../providers/types';

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

@@ -73,7 +73,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
      * @param onError - Optional callback function invoked on subscription errors
      * @returns Unsubscribe function to stop receiving updates
      */
-    subscribeToBlockUpdates(resourceId: ResourceId, onUpdate: (data: SyncBlockInstance) => void, onError?: (error: Error) => void): () => void;
+    subscribeToBlockUpdates(resourceId: ResourceId, onUpdate: (data: SyncBlockInstance) => void, onError?: (error: Error) => void, onComplete?: () => void): () => void;
 }
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;

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

@@ -98,7 +98,7 @@ export declare class SyncedBlockProvider extends SyncBlockDataProviderInterface
      * @param onError - Optional callback function invoked on subscription errors
      * @returns Unsubscribe function to stop receiving updates, or undefined if not supported
      */
-    subscribeToBlockUpdates(resourceId: string, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback): Unsubscribe | undefined;
+    subscribeToBlockUpdates(resourceId: string, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback, onComplete?: () => void): Unsubscribe | undefined;
 }
 type UseMemoizedSyncedBlockProviderProps = {
     fetchProvider: ADFFetchProvider;

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

@@ -92,6 +92,7 @@ export type BatchFetchConfig = {
 };
 export type BlockUpdateCallback = (data: SyncBlockInstance) => void;
 export type BlockSubscriptionErrorCallback = (error: Error) => void;
+export type BlockSubscriptionCompleteCallback = () => void;
 export type Unsubscribe = () => void;
 export interface ADFFetchProvider {
     batchFetchData: (blockNodeIdentifiers: BlockNodeIdentifiers[], config?: BatchFetchConfig) => Promise<SyncBlockInstance[]>;
@@ -100,7 +101,7 @@ export interface ADFFetchProvider {
     /**
      * Subscribes to real-time updates for a specific block.
      */
-    subscribeToBlockUpdates?: (resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback) => Unsubscribe;
+    subscribeToBlockUpdates?: (resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback, onComplete?: BlockSubscriptionCompleteCallback) => Unsubscribe;
 }
 export interface ADFWriteProvider {
     createData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
@@ -174,9 +175,10 @@ export declare abstract class SyncBlockDataProviderInterface extends NodeDataPro
      * @param resourceId - The resource ID of the block to subscribe to
      * @param onUpdate - Callback function invoked when the block is updated
      * @param onError - Optional callback function invoked on subscription errors
+     * @param onComplete - Optional callback function invoked when the subscription completes
      * @returns Unsubscribe function to stop receiving updates, or undefined if not supported
      */
-    subscribeToBlockUpdates?(resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback): Unsubscribe | undefined;
+    subscribeToBlockUpdates?(resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback, onComplete?: BlockSubscriptionCompleteCallback): Unsubscribe | undefined;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -65,6 +65,7 @@ export declare class ReferenceSyncBlockStoreManager {
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;
+    private stripAnnotationMarksFromReferenceData;
     private updateSessionCache;
     private getFromSessionCache;
     fetchSyncBlockSourceInfoBySourceAri(sourceAri: string, hasAccess?: boolean): Promise<SyncBlockSourceInfo | undefined>;

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

@@ -26,6 +26,11 @@ export declare class SyncBlockSubscriptionManager {
     private subscriptionChangeListeners;
     private useRealTimeSubscriptions;
     private pendingCacheDeletions;
+    private static readonly INITIAL_RETRY_DELAY_MS;
+    private static readonly RETRY_BACKOFF_MULTIPLIER;
+    private static readonly MAX_RETRY_ATTEMPTS;
+    private retryAttempts;
+    private pendingRetries;
     constructor(deps: SyncBlockSubscriptionManagerDeps);
     /**
      * Returns the subscriptions map. Used by external consumers (e.g. batch fetcher, flush)
@@ -48,6 +53,24 @@ export declare class SyncBlockSubscriptionManager {
      */
     notifySubscriptionCallbacks(resourceId: ResourceId, syncBlock: SyncBlockInstance): void;
     setupSubscription(resourceId: ResourceId): void;
+    /**
+     * Handles subscription termination (complete or error) by cleaning up the
+     * stale entry and scheduling a reconnection with exponential backoff.
+     */
+    private handleSubscriptionTerminated;
+    /**
+     * Schedules a reconnection attempt with exponential backoff.
+     * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
+     * e.g. 1s, 2s, 4s, 8s, 16s
+     */
+    private scheduleReconnection;
+    /**
+     * Resets the retry counter for a resource. Called when a successful
+     * update is received, indicating the subscription is healthy.
+     */
+    private resetRetryCount;
+    private cancelPendingRetry;
+    private cancelAllPendingRetries;
     cleanupSubscription(resourceId: ResourceId): void;
     setupSubscriptionsForAllBlocks(): void;
     cleanupAll(): void;

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

@@ -1,6 +1,7 @@
-import type { JSONNode } from '@atlaskit/editor-json-transformer';
+import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockData, BlockInstanceId, ResourceId, SyncBlockNode, SyncBlockProduct } from '../common/types';
+export declare const stripAnnotationMarksFromJSONContent: <T extends JSONNode | undefined>(content: T[]) => T[];
 export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode) => SyncBlockData;
 export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
 export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) => SyncBlockNode | undefined;

package/package.json

@@ -29,7 +29,7 @@
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/node-data-provider": "^11.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^82.0.0",
+		"@atlaskit/tmp-editor-statsig": "^82.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"graphql-ws": "^5.14.2",
@@ -38,7 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.36.0",
+		"@atlaskit/editor-common": "^114.39.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -81,7 +81,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "6.6.5",
+	"version": "6.6.7",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",