@atlaskit/editor-synced-block-provider 13.1.7 → 13.2.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-synced-block-provider
 
+## 13.2.0
+
+### Minor Changes
+
+- [`5dd6cdd8c1d11`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5dd6cdd8c1d11) -
+  Allow a surface to opt out of real-time synced block subscriptions.
+
+  `SyncBlockStoreManager` and `useMemoizedSyncBlockStoreManager` accept a new
+  `SyncBlockStoreManagerOptions` argument, and `useMemoizedSyncedBlockNodeComponent` accepts a
+  matching `enableRealTimeSubscriptions` prop. Both default to `true`, so existing behaviour is
+  unchanged.
+
+  When set to `false`, real-time updates are turned off at construction, so no
+  `blockService_onBlockUpdated` subscription is ever opened for that store's reference blocks. This
+  is deliberately independent of `viewMode`: a live doc in read mode is the editor in view mode and
+  must stay live. Consumed by the Confluence classic renderer behind the
+  `platform_editor_sync_block_renderer_no_realtime` experiment, so a page being read no longer
+  changes under the reader.
+
 ## 13.1.7
 
 ### Patch Changes

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

@@ -27,12 +27,16 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 // SourceSyncBlockStoreManager is responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Can be used in both editor and renderer contexts.
 var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider, viewMode, isLivePage) {
+  function SyncBlockStoreManager(dataProvider, viewMode, isLivePage, options) {
+    var _options$enableRealTi;
     (0, _classCallCheck2.default)(this, SyncBlockStoreManager);
     this.sourceSyncBlockStoreManager = new _sourceSyncBlockStoreManager.SourceSyncBlockStoreManager(dataProvider, viewMode, isLivePage);
     this.referenceSyncBlockStoreManager = new _referenceSyncBlockStoreManager.ReferenceSyncBlockStoreManager(dataProvider, viewMode, this.sourceSyncBlockStoreManager);
     this.dataProvider = dataProvider;
-    this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled(true);
+    // Set in the constructor rather than from an effect on the consumer side:
+    // reference nodes subscribe as they mount, so any later toggle would open
+    // (and immediately tear down) subscriptions the surface never wanted.
+    this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled((_options$enableRealTi = options === null || options === void 0 ? void 0 : options.enableRealTimeSubscriptions) !== null && _options$enableRealTi !== void 0 ? _options$enableRealTi : true);
   }
   return (0, _createClass2.default)(SyncBlockStoreManager, [{
     key: "isSyncBlock",
@@ -292,13 +296,18 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
     }()
   }]);
 }();
-var createSyncBlockStoreManager = function createSyncBlockStoreManager(dataProvider) {
-  return new SyncBlockStoreManager(dataProvider);
+var createSyncBlockStoreManager = function createSyncBlockStoreManager(dataProvider, options) {
+  return new SyncBlockStoreManager(dataProvider, undefined, undefined, options);
 };
-var useMemoizedSyncBlockStoreManager = exports.useMemoizedSyncBlockStoreManager = function useMemoizedSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+var useMemoizedSyncBlockStoreManager = exports.useMemoizedSyncBlockStoreManager = function useMemoizedSyncBlockStoreManager(dataProvider, fireAnalyticsEvent, options) {
+  // Destructured so the memo depends on the value, not on the identity of an
+  // options object that callers commonly build inline.
+  var enableRealTimeSubscriptions = options === null || options === void 0 ? void 0 : options.enableRealTimeSubscriptions;
   var syncBlockStoreManager = (0, _react.useMemo)(function () {
-    return createSyncBlockStoreManager(dataProvider);
-  }, [dataProvider]);
+    return createSyncBlockStoreManager(dataProvider, {
+      enableRealTimeSubscriptions: enableRealTimeSubscriptions
+    });
+  }, [dataProvider, enableRealTimeSubscriptions]);
   var prevFireAnalyticsEventRef = (0, _react.useRef)(undefined);
   if (fireAnalyticsEvent !== prevFireAnalyticsEventRef.current) {
     prevFireAnalyticsEventRef.current = fireAnalyticsEvent;

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

@@ -15,11 +15,15 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 // Can be used in both editor and renderer contexts.
 
 export class SyncBlockStoreManager {
-  constructor(dataProvider, viewMode, isLivePage) {
+  constructor(dataProvider, viewMode, isLivePage, options) {
+    var _options$enableRealTi;
     this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider, viewMode, isLivePage);
     this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider, viewMode, this.sourceSyncBlockStoreManager);
     this.dataProvider = dataProvider;
-    this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled(true);
+    // Set in the constructor rather than from an effect on the consumer side:
+    // reference nodes subscribe as they mount, so any later toggle would open
+    // (and immediately tear down) subscriptions the surface never wanted.
+    this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled((_options$enableRealTi = options === null || options === void 0 ? void 0 : options.enableRealTimeSubscriptions) !== null && _options$enableRealTi !== void 0 ? _options$enableRealTi : true);
   }
   isSyncBlock(node) {
     return this.sourceSyncBlockStoreManager.isSourceBlock(node) || this.referenceSyncBlockStoreManager.isReferenceBlock(node);
@@ -193,13 +197,18 @@ export class SyncBlockStoreManager {
     };
   }
 }
-const createSyncBlockStoreManager = dataProvider => {
-  return new SyncBlockStoreManager(dataProvider);
+const createSyncBlockStoreManager = (dataProvider, options) => {
+  return new SyncBlockStoreManager(dataProvider, undefined, undefined, options);
 };
-export const useMemoizedSyncBlockStoreManager = (dataProvider, fireAnalyticsEvent) => {
+export const useMemoizedSyncBlockStoreManager = (dataProvider, fireAnalyticsEvent, options) => {
+  // Destructured so the memo depends on the value, not on the identity of an
+  // options object that callers commonly build inline.
+  const enableRealTimeSubscriptions = options === null || options === void 0 ? void 0 : options.enableRealTimeSubscriptions;
   const syncBlockStoreManager = useMemo(() => {
-    return createSyncBlockStoreManager(dataProvider);
-  }, [dataProvider]);
+    return createSyncBlockStoreManager(dataProvider, {
+      enableRealTimeSubscriptions
+    });
+  }, [dataProvider, enableRealTimeSubscriptions]);
   const prevFireAnalyticsEventRef = useRef(undefined);
   if (fireAnalyticsEvent !== prevFireAnalyticsEventRef.current) {
     prevFireAnalyticsEventRef.current = fireAnalyticsEvent;

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

@@ -22,12 +22,16 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 // Can be used in both editor and renderer contexts.
 
 export var SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider, viewMode, isLivePage) {
+  function SyncBlockStoreManager(dataProvider, viewMode, isLivePage, options) {
+    var _options$enableRealTi;
     _classCallCheck(this, SyncBlockStoreManager);
     this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider, viewMode, isLivePage);
     this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider, viewMode, this.sourceSyncBlockStoreManager);
     this.dataProvider = dataProvider;
-    this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled(true);
+    // Set in the constructor rather than from an effect on the consumer side:
+    // reference nodes subscribe as they mount, so any later toggle would open
+    // (and immediately tear down) subscriptions the surface never wanted.
+    this.referenceSyncBlockStoreManager.setRealTimeSubscriptionsEnabled((_options$enableRealTi = options === null || options === void 0 ? void 0 : options.enableRealTimeSubscriptions) !== null && _options$enableRealTi !== void 0 ? _options$enableRealTi : true);
   }
   return _createClass(SyncBlockStoreManager, [{
     key: "isSyncBlock",
@@ -287,13 +291,18 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
     }()
   }]);
 }();
-var createSyncBlockStoreManager = function createSyncBlockStoreManager(dataProvider) {
-  return new SyncBlockStoreManager(dataProvider);
+var createSyncBlockStoreManager = function createSyncBlockStoreManager(dataProvider, options) {
+  return new SyncBlockStoreManager(dataProvider, undefined, undefined, options);
 };
-export var useMemoizedSyncBlockStoreManager = function useMemoizedSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+export var useMemoizedSyncBlockStoreManager = function useMemoizedSyncBlockStoreManager(dataProvider, fireAnalyticsEvent, options) {
+  // Destructured so the memo depends on the value, not on the identity of an
+  // options object that callers commonly build inline.
+  var enableRealTimeSubscriptions = options === null || options === void 0 ? void 0 : options.enableRealTimeSubscriptions;
   var syncBlockStoreManager = useMemo(function () {
-    return createSyncBlockStoreManager(dataProvider);
-  }, [dataProvider]);
+    return createSyncBlockStoreManager(dataProvider, {
+      enableRealTimeSubscriptions: enableRealTimeSubscriptions
+    });
+  }, [dataProvider, enableRealTimeSubscriptions]);
   var prevFireAnalyticsEventRef = useRef(undefined);
   if (fireAnalyticsEvent !== prevFireAnalyticsEventRef.current) {
     prevFireAnalyticsEventRef.current = fireAnalyticsEvent;

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

@@ -1,2 +1,3 @@
 export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from '../store-manager/syncBlockStoreManager';
+export type { SyncBlockStoreManagerOptions } from '../store-manager/syncBlockStoreManager';
 export type { SourceSyncBlockStoreManager } from '../store-manager/sourceSyncBlockStoreManager';

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

@@ -5,6 +5,20 @@ import type { BlockInstanceId, ReferencesSourceInfo, ResourceId } from '../commo
 import type { SyncBlockDataProviderInterface } from '../providers/types';
 import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
+export type SyncBlockStoreManagerOptions = {
+    /**
+     * Whether reference blocks managed by this store should hold a real-time
+     * (`blockService_onBlockUpdated`) subscription and refresh in place when the
+     * source changes elsewhere. Defaults to `true`.
+     *
+     * Surfaces that show content "as of load" — most notably the Confluence
+     * classic page/blog renderer, where a document being read must not change
+     * under the reader — pass `false`. This is deliberately independent of
+     * `viewMode`: a live doc in read mode is the editor in view mode and must
+     * stay live, so `viewMode` cannot be used to identify those surfaces.
+     */
+    enableRealTimeSubscriptions?: boolean;
+};
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
@@ -12,7 +26,7 @@ export declare class SyncBlockStoreManager {
     private fireAnalyticsEvent?;
     private fetchReferencesExperience;
     private fetchSourceInfoExperience;
-    constructor(dataProvider?: SyncBlockDataProviderInterface, viewMode?: ViewMode, isLivePage?: boolean);
+    constructor(dataProvider?: SyncBlockDataProviderInterface, viewMode?: ViewMode, isLivePage?: boolean, options?: SyncBlockStoreManagerOptions);
     isSyncBlock(node: PMNode): boolean;
     fetchReferencesSourceInfo(resourceId: ResourceId, blockInstanceId: BlockInstanceId, isSourceSyncBlock: boolean): Promise<ReferencesSourceInfo>;
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
@@ -21,4 +35,4 @@ export declare class SyncBlockStoreManager {
     destroy(): void;
     private getUnregisteredReferences;
 }
-export declare const useMemoizedSyncBlockStoreManager: (dataProvider?: SyncBlockDataProviderInterface, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => SyncBlockStoreManager;
+export declare const useMemoizedSyncBlockStoreManager: (dataProvider?: SyncBlockDataProviderInterface, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void, options?: SyncBlockStoreManagerOptions) => SyncBlockStoreManager;

package/package.json

@@ -42,7 +42,7 @@
 		"react-dom": "^19.2.0"
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "13.1.7",
+	"version": "13.2.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",