@atlaskit/editor-plugin-synced-block 10.2.4 → 10.2.6

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/editor-plugin-synced-block
 
+## 10.2.6
+
+### Patch Changes
+
+- Updated dependencies
+
+## 10.2.5
+
+### Patch Changes
+
+- [`12355710b809c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/12355710b809c) -
+  Add the `platform_editor_sync_block_activation` boolean experiment API to
+  `@atlaskit/tmp-editor-statsig` for Confluence sync block activation checks. Consumers can gate
+  sync block activation behavior with
+  `expValEquals('platform_editor_sync_block_activation', 'isEnabled', true)`, for example to keep
+  source synced block placeholders visible only while the activation experiment is enabled.
+
+  Decoration-based placeholders now remain visible for empty source synced blocks while activation
+  is enabled.
+
+  The bodied synced block source nodeview now keeps its existing SSR streaming label-container fix
+  and only applies the non-SSR separate label container behavior when
+  `platform_synced_block_patch_14` is enabled.
+
+- Updated dependencies
+
 ## 10.2.4
 
 ### Patch Changes

package/dist/cjs/editor-commands/index.js

@@ -278,8 +278,7 @@ var editSyncedBlockSource = exports.editSyncedBlockSource = function editSyncedB
     var syncBlockURL = syncBlockStore.referenceManager.getSyncBlockURL(resourceId);
     var syncBlockData = (_syncBlockStore$refer = syncBlockStore.referenceManager.getFromCache(resourceId)) === null || _syncBlockStore$refer === void 0 ? void 0 : _syncBlockStore$refer.data;
     var isOnSameDocument = (syncBlockData === null || syncBlockData === void 0 ? void 0 : syncBlockData.onSameDocument) === true;
-    var shouldReportSameDocument = (0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_2');
-    var sourceBlock = shouldReportSameDocument && isOnSameDocument && syncBlockData ? (0, _utils3.findBodiedSyncBlockByLocalId)(state, syncBlockData.blockInstanceId) : undefined;
+    var sourceBlock = isOnSameDocument && syncBlockData ? (0, _utils3.findBodiedSyncBlockByLocalId)(state, syncBlockData.blockInstanceId) : undefined;
     if (syncBlockURL) {
       var _api$analytics5;
       api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 || _api$analytics5.actions.fireAnalyticsEvent({
@@ -287,11 +286,10 @@ var editSyncedBlockSource = exports.editSyncedBlockSource = function editSyncedB
         action: _analytics.ACTION.SYNCED_BLOCK_EDIT_SOURCE,
         actionSubject: _analytics.ACTION_SUBJECT.SYNCED_BLOCK,
         actionSubjectId: _analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_SOURCE_URL,
-        attributes: _objectSpread({
-          resourceId: resourceId
-        }, shouldReportSameDocument ? {
+        attributes: {
+          resourceId: resourceId,
           sameDocument: isOnSameDocument
-        } : {})
+        }
       });
       if (sourceBlock) {
         var tr = state.tr.setSelection(_state.NodeSelection.create(state.doc, sourceBlock.pos)).scrollIntoView();

package/dist/cjs/nodeviews/bodiedSyncedBlock.js

@@ -18,6 +18,8 @@ var _reactNodeView = _interopRequireDefault(require("@atlaskit/editor-common/rea
 var _syncBlock = require("@atlaskit/editor-common/sync-block");
 var _editorPluginConnectivity = require("@atlaskit/editor-plugin-connectivity");
 var _model = require("@atlaskit/editor-prosemirror/model");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _BodiedSyncBlockWrapper = require("../ui/BodiedSyncBlockWrapper");
 var _SyncBlockLabel = require("../ui/SyncBlockLabel");
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
@@ -190,12 +192,17 @@ var BodiedSyncBlock = exports.BodiedSyncBlock = /*#__PURE__*/function () {
     this.dom = dom;
     // eslint-disable-next-line @atlaskit/editor/no-as-casting
     this.contentDOM = contentDOM;
-
-    // During SSR, the portal's renderToStaticMarkup + innerHTML clobbers
-    // contentDOM. Render the label into a separate container to prevent this.
-    // On client, render directly into this.dom as before.
     var labelContainer;
     if ((0, _coreUtils.isSSR)() && (0, _coreUtils.isSSRStreaming)()) {
+      // During SSR, the portal's renderToStaticMarkup + innerHTML clobbers
+      // contentDOM. Render the label into a separate container to prevent this.
+      // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- NodeView DOM must be created against active runtime document
+      labelContainer = document.createElement('div');
+      this.dom.appendChild(labelContainer);
+    } else if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_14') || (0, _expValEquals.expValEquals)('platform_editor_sync_block_activation', 'isEnabled', true)) {
+      // Render the label into a separate container for the activation experience so
+      // portal implementations that write directly into the target do not clobber
+      // the ProseMirror contentDOM.
       // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- NodeView DOM must be created against active runtime document
       labelContainer = document.createElement('div');
       this.dom.appendChild(labelContainer);

package/dist/es2019/editor-commands/index.js

@@ -274,8 +274,7 @@ export const editSyncedBlockSource = (syncBlockStore, api) => (state, dispatch,
   const syncBlockURL = syncBlockStore.referenceManager.getSyncBlockURL(resourceId);
   const syncBlockData = (_syncBlockStore$refer = syncBlockStore.referenceManager.getFromCache(resourceId)) === null || _syncBlockStore$refer === void 0 ? void 0 : _syncBlockStore$refer.data;
   const isOnSameDocument = (syncBlockData === null || syncBlockData === void 0 ? void 0 : syncBlockData.onSameDocument) === true;
-  const shouldReportSameDocument = fg('platform_editor_blocks_patch_2');
-  const sourceBlock = shouldReportSameDocument && isOnSameDocument && syncBlockData ? findBodiedSyncBlockByLocalId(state, syncBlockData.blockInstanceId) : undefined;
+  const sourceBlock = isOnSameDocument && syncBlockData ? findBodiedSyncBlockByLocalId(state, syncBlockData.blockInstanceId) : undefined;
   if (syncBlockURL) {
     var _api$analytics5;
     api === null || api === void 0 ? void 0 : (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions.fireAnalyticsEvent({
@@ -285,9 +284,7 @@ export const editSyncedBlockSource = (syncBlockStore, api) => (state, dispatch,
       actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_SOURCE_URL,
       attributes: {
         resourceId: resourceId,
-        ...(shouldReportSameDocument ? {
-          sameDocument: isOnSameDocument
-        } : {})
+        sameDocument: isOnSameDocument
       }
     });
     if (sourceBlock) {

package/dist/es2019/nodeviews/bodiedSyncedBlock.js

@@ -6,6 +6,8 @@ import ReactNodeView from '@atlaskit/editor-common/react-node-view';
 import { BodiedSyncBlockSharedCssClassName } from '@atlaskit/editor-common/sync-block';
 import { isOfflineMode } from '@atlaskit/editor-plugin-connectivity';
 import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { BodiedSyncBlockWrapper } from '../ui/BodiedSyncBlockWrapper';
 import { SyncBlockLabel } from '../ui/SyncBlockLabel';
 const toDOMOld = () => ['div', {
@@ -155,12 +157,17 @@ export class BodiedSyncBlock {
     this.dom = dom;
     // eslint-disable-next-line @atlaskit/editor/no-as-casting
     this.contentDOM = contentDOM;
-
-    // During SSR, the portal's renderToStaticMarkup + innerHTML clobbers
-    // contentDOM. Render the label into a separate container to prevent this.
-    // On client, render directly into this.dom as before.
     let labelContainer;
     if (isSSR() && isSSRStreaming()) {
+      // During SSR, the portal's renderToStaticMarkup + innerHTML clobbers
+      // contentDOM. Render the label into a separate container to prevent this.
+      // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- NodeView DOM must be created against active runtime document
+      labelContainer = document.createElement('div');
+      this.dom.appendChild(labelContainer);
+    } else if (fg('platform_synced_block_patch_14') || expValEquals('platform_editor_sync_block_activation', 'isEnabled', true)) {
+      // Render the label into a separate container for the activation experience so
+      // portal implementations that write directly into the target do not clobber
+      // the ProseMirror contentDOM.
       // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- NodeView DOM must be created against active runtime document
       labelContainer = document.createElement('div');
       this.dom.appendChild(labelContainer);

package/dist/esm/editor-commands/index.js

@@ -271,8 +271,7 @@ export var editSyncedBlockSource = function editSyncedBlockSource(syncBlockStore
     var syncBlockURL = syncBlockStore.referenceManager.getSyncBlockURL(resourceId);
     var syncBlockData = (_syncBlockStore$refer = syncBlockStore.referenceManager.getFromCache(resourceId)) === null || _syncBlockStore$refer === void 0 ? void 0 : _syncBlockStore$refer.data;
     var isOnSameDocument = (syncBlockData === null || syncBlockData === void 0 ? void 0 : syncBlockData.onSameDocument) === true;
-    var shouldReportSameDocument = fg('platform_editor_blocks_patch_2');
-    var sourceBlock = shouldReportSameDocument && isOnSameDocument && syncBlockData ? findBodiedSyncBlockByLocalId(state, syncBlockData.blockInstanceId) : undefined;
+    var sourceBlock = isOnSameDocument && syncBlockData ? findBodiedSyncBlockByLocalId(state, syncBlockData.blockInstanceId) : undefined;
     if (syncBlockURL) {
       var _api$analytics5;
       api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 || _api$analytics5.actions.fireAnalyticsEvent({
@@ -280,11 +279,10 @@ export var editSyncedBlockSource = function editSyncedBlockSource(syncBlockStore
         action: ACTION.SYNCED_BLOCK_EDIT_SOURCE,
         actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
         actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_SOURCE_URL,
-        attributes: _objectSpread({
-          resourceId: resourceId
-        }, shouldReportSameDocument ? {
+        attributes: {
+          resourceId: resourceId,
           sameDocument: isOnSameDocument
-        } : {})
+        }
       });
       if (sourceBlock) {
         var tr = state.tr.setSelection(NodeSelection.create(state.doc, sourceBlock.pos)).scrollIntoView();

package/dist/esm/nodeviews/bodiedSyncedBlock.js

@@ -13,6 +13,8 @@ import ReactNodeView from '@atlaskit/editor-common/react-node-view';
 import { BodiedSyncBlockSharedCssClassName } from '@atlaskit/editor-common/sync-block';
 import { isOfflineMode } from '@atlaskit/editor-plugin-connectivity';
 import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { BodiedSyncBlockWrapper } from '../ui/BodiedSyncBlockWrapper';
 import { SyncBlockLabel } from '../ui/SyncBlockLabel';
 var toDOMOld = function toDOMOld() {
@@ -183,12 +185,17 @@ export var BodiedSyncBlock = /*#__PURE__*/function () {
     this.dom = dom;
     // eslint-disable-next-line @atlaskit/editor/no-as-casting
     this.contentDOM = contentDOM;
-
-    // During SSR, the portal's renderToStaticMarkup + innerHTML clobbers
-    // contentDOM. Render the label into a separate container to prevent this.
-    // On client, render directly into this.dom as before.
     var labelContainer;
     if (isSSR() && isSSRStreaming()) {
+      // During SSR, the portal's renderToStaticMarkup + innerHTML clobbers
+      // contentDOM. Render the label into a separate container to prevent this.
+      // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- NodeView DOM must be created against active runtime document
+      labelContainer = document.createElement('div');
+      this.dom.appendChild(labelContainer);
+    } else if (fg('platform_synced_block_patch_14') || expValEquals('platform_editor_sync_block_activation', 'isEnabled', true)) {
+      // Render the label into a separate container for the activation experience so
+      // portal implementations that write directly into the target do not clobber
+      // the ProseMirror contentDOM.
       // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- NodeView DOM must be created against active runtime document
       labelContainer = document.createElement('div');
       this.dom.appendChild(labelContainer);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "10.2.4",
+	"version": "10.2.6",
 	"description": "SyncedBlock plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -21,7 +21,7 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/adf-schema": "^56.1.0",
-		"@atlaskit/button": "24.3.1",
+		"@atlaskit/button": "24.3.2",
 		"@atlaskit/dropdown-menu": "17.1.2",
 		"@atlaskit/editor-json-transformer": "^9.0.0",
 		"@atlaskit/editor-plugin-analytics": "^12.0.0",
@@ -46,8 +46,8 @@
 		"@atlaskit/platform-feature-flags": "^2.0.0",
 		"@atlaskit/primitives": "^20.6.0",
 		"@atlaskit/spinner": "20.1.0",
-		"@atlaskit/tmp-editor-statsig": "^124.1.0",
-		"@atlaskit/tokens": "15.6.1",
+		"@atlaskit/tmp-editor-statsig": "^124.2.0",
+		"@atlaskit/tokens": "15.7.0",
 		"@atlaskit/tooltip": "^23.1.0",
 		"@atlaskit/visually-hidden": "^4.1.0",
 		"@babel/runtime": "^7.0.0",
@@ -57,7 +57,7 @@
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.26.0",
+		"@atlaskit/editor-common": "^116.27.0",
 		"react": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -109,9 +109,6 @@
 		"confluence_fronend_labels_categorization_migration": {
 			"type": "boolean"
 		},
-		"platform_editor_blocks_patch_2": {
-			"type": "boolean"
-		},
 		"platform_editor_blocks_patch_4": {
 			"type": "boolean"
 		},