@atlaskit/editor-core 202.3.0 → 202.3.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-core
 
+## 202.3.1
+
+### Patch Changes
+
+- [#167666](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/167666)
+  [`1e925c655550f`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1e925c655550f) -
+  Some editor states were occassionally missed by the editor API due to an edge case - this change
+  ensures all prosemirror states are observed fixing some minor bugs (ie. context panel not closing
+  when changing selection).
+
 ## 202.3.0
 
 ### Minor Changes

package/dist/cjs/create-editor/ReactEditorView.js

@@ -210,7 +210,8 @@ var ReactEditorView = exports.ReactEditorView = /*#__PURE__*/function (_React$Co
         featureFlags: _this.featureFlags,
         getIntl: function getIntl() {
           return _this.props.intl;
-        }
+        },
+        onEditorStateUpdated: (0, _platformFeatureFlags.fg)('platform_editor_catch_missing_injection_states') ? _this.pluginInjectionAPI.onEditorViewUpdated : undefined
       });
       _this.contentTransformer = contentTransformerProvider ? contentTransformerProvider(schema) : undefined;
       var doc;
@@ -286,10 +287,14 @@ var ReactEditorView = exports.ReactEditorView = /*#__PURE__*/function (_React$Co
           return;
         }
         _this.view.updateState(editorState);
-        _this.pluginInjectionAPI.onEditorViewUpdated({
-          newEditorState: editorState,
-          oldEditorState: oldEditorState
-        });
+        if (!(0, _platformFeatureFlags.fg)('platform_editor_catch_missing_injection_states')) {
+          _this.pluginInjectionAPI.onEditorViewUpdated({
+            newEditorState: editorState,
+            oldEditorState: oldEditorState
+          });
+        }
+
+        // ED-25839: Investigate if we also want to migrate this API to use `onEditorStateUpdated` in `createPMPlugins`
         _this.onEditorViewStateUpdated({
           originalTransaction: transaction,
           transactions: transactions,
@@ -591,7 +596,8 @@ var ReactEditorView = exports.ReactEditorView = /*#__PURE__*/function (_React$Co
         featureFlags: (0, _featureFlagsFromProps.createFeatureFlagsFromProps)(props.editorProps.featureFlags),
         getIntl: function getIntl() {
           return _this2.props.intl;
-        }
+        },
+        onEditorStateUpdated: (0, _platformFeatureFlags.fg)('platform_editor_catch_missing_injection_states') ? this.pluginInjectionAPI.onEditorViewUpdated : undefined
       });
       var newState = state.reconfigure({
         plugins: plugins

package/dist/cjs/create-editor/ReactEditorViewNext.js

@@ -153,7 +153,8 @@ function ReactEditorView(props) {
       featureFlags: featureFlags,
       getIntl: function getIntl() {
         return props.intl;
-      }
+      },
+      onEditorStateUpdated: (0, _platformFeatureFlags.fg)('platform_editor_catch_missing_injection_states') ? pluginInjectionAPI.current.onEditorViewUpdated : undefined
     });
     contentTransformer.current = contentTransformerProvider ? contentTransformerProvider(schema) : undefined;
     var api = pluginInjectionAPI.current.api();
@@ -320,7 +321,8 @@ function ReactEditorView(props) {
       featureFlags: featureFlags,
       getIntl: function getIntl() {
         return props.intl;
-      }
+      },
+      onEditorStateUpdated: (0, _platformFeatureFlags.fg)('platform_editor_catch_missing_injection_states') ? pluginInjectionAPI.current.onEditorViewUpdated : undefined
     });
     var newState = state.reconfigure({
       plugins: plugins
@@ -339,10 +341,14 @@ function ReactEditorView(props) {
       transactions = _ref2.transactions,
       oldEditorState = _ref2.oldEditorState,
       newEditorState = _ref2.newEditorState;
-    pluginInjectionAPI.current.onEditorViewUpdated({
-      newEditorState: newEditorState,
-      oldEditorState: oldEditorState
-    });
+    if (!(0, _platformFeatureFlags.fg)('platform_editor_catch_missing_injection_states')) {
+      pluginInjectionAPI.current.onEditorViewUpdated({
+        newEditorState: newEditorState,
+        oldEditorState: oldEditorState
+      });
+    }
+
+    // ED-25839: Investigate if we also want to migrate this API to use `onEditorStateUpdated` in `createPMPlugins`
     (_config$current = config.current) === null || _config$current === void 0 || _config$current.onEditorViewStateUpdatedCallbacks.forEach(function (entry) {
       entry.callback({
         originalTransaction: originalTransaction,

package/dist/cjs/create-editor/create-editor.js

@@ -11,6 +11,7 @@ exports.processPluginsList = processPluginsList;
 exports.sortByRank = sortByRank;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _errorReporter = require("@atlaskit/editor-common/error-reporter");
+var _editorStateNotificationPlugin = require("./editorStateNotificationPlugin");
 var _sortByOrder = require("./sort-by-order");
 function sortByRank(a, b) {
   return a.rank - b.rank;
@@ -94,7 +95,7 @@ function processPluginsList(plugins) {
 }
 function createPMPlugins(config) {
   var editorConfig = config.editorConfig;
-  return editorConfig.pmPlugins.sort((0, _sortByOrder.sortByOrder)('plugins')).map(function (_ref) {
+  var pmPlugins = editorConfig.pmPlugins.sort((0, _sortByOrder.sortByOrder)('plugins')).map(function (_ref) {
     var plugin = _ref.plugin;
     return plugin({
       schema: config.schema,
@@ -111,6 +112,10 @@ function createPMPlugins(config) {
   }).filter(function (plugin) {
     return typeof plugin !== 'undefined';
   });
+  if (config.onEditorStateUpdated !== undefined) {
+    return [(0, _editorStateNotificationPlugin.createEditorStateNotificationPlugin)(config.onEditorStateUpdated)].concat((0, _toConsumableArray2.default)(pmPlugins));
+  }
+  return pmPlugins;
 }
 function createErrorReporter(errorReporterHandler) {
   var errorReporter = new _errorReporter.ErrorReporter();

package/dist/cjs/create-editor/editorStateNotificationPlugin.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createEditorStateNotificationPlugin = void 0;
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var createEditorStateNotificationPlugin = exports.createEditorStateNotificationPlugin = function createEditorStateNotificationPlugin(onEditorStateUpdated) {
+  return new _safePlugin.SafePlugin({
+    view: function view() {
+      return {
+        update: function update(view, oldEditorState) {
+          onEditorStateUpdated({
+            oldEditorState: oldEditorState,
+            newEditorState: view.state
+          });
+        }
+      };
+    }
+  });
+};

package/dist/cjs/version-wrapper.js

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
-var version = exports.version = "202.3.0";
+var version = exports.version = "202.3.1";

package/dist/es2019/create-editor/ReactEditorView.js

@@ -201,7 +201,8 @@ export class ReactEditorView extends React.Component {
         nodeViewPortalProviderAPI: this.props.nodeViewPortalProviderAPI,
         dispatchAnalyticsEvent: this.dispatchAnalyticsEvent,
         featureFlags: this.featureFlags,
-        getIntl: () => this.props.intl
+        getIntl: () => this.props.intl,
+        onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? this.pluginInjectionAPI.onEditorViewUpdated : undefined
       });
       this.contentTransformer = contentTransformerProvider ? contentTransformerProvider(schema) : undefined;
       let doc;
@@ -279,10 +280,14 @@ export class ReactEditorView extends React.Component {
           return;
         }
         this.view.updateState(editorState);
-        this.pluginInjectionAPI.onEditorViewUpdated({
-          newEditorState: editorState,
-          oldEditorState
-        });
+        if (!fg('platform_editor_catch_missing_injection_states')) {
+          this.pluginInjectionAPI.onEditorViewUpdated({
+            newEditorState: editorState,
+            oldEditorState
+          });
+        }
+
+        // ED-25839: Investigate if we also want to migrate this API to use `onEditorStateUpdated` in `createPMPlugins`
         this.onEditorViewStateUpdated({
           originalTransaction: transaction,
           transactions,
@@ -545,7 +550,8 @@ export class ReactEditorView extends React.Component {
       nodeViewPortalProviderAPI: props.nodeViewPortalProviderAPI,
       dispatchAnalyticsEvent: this.dispatchAnalyticsEvent,
       featureFlags: createFeatureFlagsFromProps(props.editorProps.featureFlags),
-      getIntl: () => this.props.intl
+      getIntl: () => this.props.intl,
+      onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? this.pluginInjectionAPI.onEditorViewUpdated : undefined
     });
     const newState = state.reconfigure({
       plugins: plugins

package/dist/es2019/create-editor/ReactEditorViewNext.js

@@ -129,7 +129,8 @@ function ReactEditorView(props) {
       nodeViewPortalProviderAPI: props.nodeViewPortalProviderAPI,
       dispatchAnalyticsEvent: dispatchAnalyticsEvent,
       featureFlags,
-      getIntl: () => props.intl
+      getIntl: () => props.intl,
+      onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? pluginInjectionAPI.current.onEditorViewUpdated : undefined
     });
     contentTransformer.current = contentTransformerProvider ? contentTransformerProvider(schema) : undefined;
     const api = pluginInjectionAPI.current.api();
@@ -293,7 +294,8 @@ function ReactEditorView(props) {
       nodeViewPortalProviderAPI: props.nodeViewPortalProviderAPI,
       dispatchAnalyticsEvent: dispatchAnalyticsEvent,
       featureFlags,
-      getIntl: () => props.intl
+      getIntl: () => props.intl,
+      onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? pluginInjectionAPI.current.onEditorViewUpdated : undefined
     });
     const newState = state.reconfigure({
       plugins: plugins
@@ -314,10 +316,14 @@ function ReactEditorView(props) {
     newEditorState
   }) => {
     var _config$current;
-    pluginInjectionAPI.current.onEditorViewUpdated({
-      newEditorState,
-      oldEditorState
-    });
+    if (!fg('platform_editor_catch_missing_injection_states')) {
+      pluginInjectionAPI.current.onEditorViewUpdated({
+        newEditorState,
+        oldEditorState
+      });
+    }
+
+    // ED-25839: Investigate if we also want to migrate this API to use `onEditorStateUpdated` in `createPMPlugins`
     (_config$current = config.current) === null || _config$current === void 0 ? void 0 : _config$current.onEditorViewStateUpdatedCallbacks.forEach(entry => {
       entry.callback({
         originalTransaction,

package/dist/es2019/create-editor/create-editor.js

@@ -1,4 +1,5 @@
 import { ErrorReporter } from '@atlaskit/editor-common/error-reporter';
+import { createEditorStateNotificationPlugin } from './editorStateNotificationPlugin';
 import { sortByOrder } from './sort-by-order';
 export function sortByRank(a, b) {
   return a.rank - b.rank;
@@ -77,7 +78,7 @@ export function createPMPlugins(config) {
   const {
     editorConfig
   } = config;
-  return editorConfig.pmPlugins.sort(sortByOrder('plugins')).map(({
+  const pmPlugins = editorConfig.pmPlugins.sort(sortByOrder('plugins')).map(({
     plugin
   }) => plugin({
     schema: config.schema,
@@ -91,6 +92,10 @@ export function createPMPlugins(config) {
     featureFlags: config.featureFlags || {},
     getIntl: config.getIntl
   })).filter(plugin => typeof plugin !== 'undefined');
+  if (config.onEditorStateUpdated !== undefined) {
+    return [createEditorStateNotificationPlugin(config.onEditorStateUpdated), ...pmPlugins];
+  }
+  return pmPlugins;
 }
 export function createErrorReporter(errorReporterHandler) {
   const errorReporter = new ErrorReporter();

package/dist/es2019/create-editor/editorStateNotificationPlugin.js

@@ -0,0 +1,13 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export const createEditorStateNotificationPlugin = onEditorStateUpdated => new SafePlugin({
+  view: () => {
+    return {
+      update: (view, oldEditorState) => {
+        onEditorStateUpdated({
+          oldEditorState,
+          newEditorState: view.state
+        });
+      }
+    };
+  }
+});

package/dist/es2019/version-wrapper.js

@@ -1,2 +1,2 @@
 export const name = "@atlaskit/editor-core";
-export const version = "202.3.0";
+export const version = "202.3.1";

package/dist/esm/create-editor/ReactEditorView.js

@@ -203,7 +203,8 @@ export var ReactEditorView = /*#__PURE__*/function (_React$Component) {
         featureFlags: _this.featureFlags,
         getIntl: function getIntl() {
           return _this.props.intl;
-        }
+        },
+        onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? _this.pluginInjectionAPI.onEditorViewUpdated : undefined
       });
       _this.contentTransformer = contentTransformerProvider ? contentTransformerProvider(schema) : undefined;
       var doc;
@@ -279,10 +280,14 @@ export var ReactEditorView = /*#__PURE__*/function (_React$Component) {
           return;
         }
         _this.view.updateState(editorState);
-        _this.pluginInjectionAPI.onEditorViewUpdated({
-          newEditorState: editorState,
-          oldEditorState: oldEditorState
-        });
+        if (!fg('platform_editor_catch_missing_injection_states')) {
+          _this.pluginInjectionAPI.onEditorViewUpdated({
+            newEditorState: editorState,
+            oldEditorState: oldEditorState
+          });
+        }
+
+        // ED-25839: Investigate if we also want to migrate this API to use `onEditorStateUpdated` in `createPMPlugins`
         _this.onEditorViewStateUpdated({
           originalTransaction: transaction,
           transactions: transactions,
@@ -584,7 +589,8 @@ export var ReactEditorView = /*#__PURE__*/function (_React$Component) {
         featureFlags: createFeatureFlagsFromProps(props.editorProps.featureFlags),
         getIntl: function getIntl() {
           return _this2.props.intl;
-        }
+        },
+        onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? this.pluginInjectionAPI.onEditorViewUpdated : undefined
       });
       var newState = state.reconfigure({
         plugins: plugins

package/dist/esm/create-editor/ReactEditorViewNext.js

@@ -143,7 +143,8 @@ function ReactEditorView(props) {
       featureFlags: featureFlags,
       getIntl: function getIntl() {
         return props.intl;
-      }
+      },
+      onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? pluginInjectionAPI.current.onEditorViewUpdated : undefined
     });
     contentTransformer.current = contentTransformerProvider ? contentTransformerProvider(schema) : undefined;
     var api = pluginInjectionAPI.current.api();
@@ -310,7 +311,8 @@ function ReactEditorView(props) {
       featureFlags: featureFlags,
       getIntl: function getIntl() {
         return props.intl;
-      }
+      },
+      onEditorStateUpdated: fg('platform_editor_catch_missing_injection_states') ? pluginInjectionAPI.current.onEditorViewUpdated : undefined
     });
     var newState = state.reconfigure({
       plugins: plugins
@@ -329,10 +331,14 @@ function ReactEditorView(props) {
       transactions = _ref2.transactions,
       oldEditorState = _ref2.oldEditorState,
       newEditorState = _ref2.newEditorState;
-    pluginInjectionAPI.current.onEditorViewUpdated({
-      newEditorState: newEditorState,
-      oldEditorState: oldEditorState
-    });
+    if (!fg('platform_editor_catch_missing_injection_states')) {
+      pluginInjectionAPI.current.onEditorViewUpdated({
+        newEditorState: newEditorState,
+        oldEditorState: oldEditorState
+      });
+    }
+
+    // ED-25839: Investigate if we also want to migrate this API to use `onEditorStateUpdated` in `createPMPlugins`
     (_config$current = config.current) === null || _config$current === void 0 || _config$current.onEditorViewStateUpdatedCallbacks.forEach(function (entry) {
       entry.callback({
         originalTransaction: originalTransaction,

package/dist/esm/create-editor/create-editor.js

@@ -1,5 +1,6 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import { ErrorReporter } from '@atlaskit/editor-common/error-reporter';
+import { createEditorStateNotificationPlugin } from './editorStateNotificationPlugin';
 import { sortByOrder } from './sort-by-order';
 export function sortByRank(a, b) {
   return a.rank - b.rank;
@@ -83,7 +84,7 @@ export function processPluginsList(plugins) {
 }
 export function createPMPlugins(config) {
   var editorConfig = config.editorConfig;
-  return editorConfig.pmPlugins.sort(sortByOrder('plugins')).map(function (_ref) {
+  var pmPlugins = editorConfig.pmPlugins.sort(sortByOrder('plugins')).map(function (_ref) {
     var plugin = _ref.plugin;
     return plugin({
       schema: config.schema,
@@ -100,6 +101,10 @@ export function createPMPlugins(config) {
   }).filter(function (plugin) {
     return typeof plugin !== 'undefined';
   });
+  if (config.onEditorStateUpdated !== undefined) {
+    return [createEditorStateNotificationPlugin(config.onEditorStateUpdated)].concat(_toConsumableArray(pmPlugins));
+  }
+  return pmPlugins;
 }
 export function createErrorReporter(errorReporterHandler) {
   var errorReporter = new ErrorReporter();

package/dist/esm/create-editor/editorStateNotificationPlugin.js

@@ -0,0 +1,15 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export var createEditorStateNotificationPlugin = function createEditorStateNotificationPlugin(onEditorStateUpdated) {
+  return new SafePlugin({
+    view: function view() {
+      return {
+        update: function update(view, oldEditorState) {
+          onEditorStateUpdated({
+            oldEditorState: oldEditorState,
+            newEditorState: view.state
+          });
+        }
+      };
+    }
+  });
+};

package/dist/esm/version-wrapper.js

@@ -1,2 +1,2 @@
 export var name = "@atlaskit/editor-core";
-export var version = "202.3.0";
+export var version = "202.3.1";

package/dist/types/create-editor/create-editor.d.ts

@@ -1,6 +1,6 @@
 import { ErrorReporter } from '@atlaskit/editor-common/error-reporter';
 import type { ErrorReportingHandler } from '@atlaskit/editor-common/error-reporter';
-import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { type SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { MarkSpec } from '@atlaskit/editor-prosemirror/model';
 import type { EditorConfig, EditorPlugin, PMPluginCreateConfig } from '../types';
 export declare function sortByRank(a: {

package/dist/types/create-editor/editorStateNotificationPlugin.d.ts

@@ -0,0 +1,6 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const createEditorStateNotificationPlugin: (onEditorStateUpdated: (props: {
+    oldEditorState: EditorState;
+    newEditorState: EditorState;
+}) => void) => SafePlugin<any>;

package/dist/types/types/pm-plugin-list.d.ts

@@ -1,5 +1,10 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorConfig } from './editor-config';
 import type { PMPluginFactoryParams } from './pm-plugin';
 export type PMPluginCreateConfig = PMPluginFactoryParams & {
     editorConfig: EditorConfig;
+    onEditorStateUpdated: ((props: {
+        newEditorState: EditorState;
+        oldEditorState: EditorState;
+    }) => void) | undefined;
 };

package/dist/types-ts4.5/create-editor/create-editor.d.ts

@@ -1,6 +1,6 @@
 import { ErrorReporter } from '@atlaskit/editor-common/error-reporter';
 import type { ErrorReportingHandler } from '@atlaskit/editor-common/error-reporter';
-import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { type SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { MarkSpec } from '@atlaskit/editor-prosemirror/model';
 import type { EditorConfig, EditorPlugin, PMPluginCreateConfig } from '../types';
 export declare function sortByRank(a: {

package/dist/types-ts4.5/create-editor/editorStateNotificationPlugin.d.ts

@@ -0,0 +1,6 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const createEditorStateNotificationPlugin: (onEditorStateUpdated: (props: {
+    oldEditorState: EditorState;
+    newEditorState: EditorState;
+}) => void) => SafePlugin<any>;

package/dist/types-ts4.5/types/pm-plugin-list.d.ts

@@ -1,5 +1,10 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorConfig } from './editor-config';
 import type { PMPluginFactoryParams } from './pm-plugin';
 export type PMPluginCreateConfig = PMPluginFactoryParams & {
     editorConfig: EditorConfig;
+    onEditorStateUpdated: ((props: {
+        newEditorState: EditorState;
+        oldEditorState: EditorState;
+    }) => void) | undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "202.3.0",
+	"version": "202.3.1",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -97,7 +97,7 @@
 		"@atlaskit/primitives": "^13.2.0",
 		"@atlaskit/renderer": "^112.6.0",
 		"@atlaskit/smart-card": "^30.3.0",
-		"@atlaskit/synchrony-test-helpers": "^2.5.0",
+		"@atlaskit/synchrony-test-helpers": "^3.0.0",
 		"@atlaskit/toggle": "^13.4.0",
 		"@atlaskit/util-data-test": "^17.13.0",
 		"@atlaskit/visual-regression": "*",
@@ -290,6 +290,9 @@
 			"type": "boolean",
 			"referenceOnly": true
 		},
+		"platform_editor_catch_missing_injection_states": {
+			"type": "boolean"
+		},
 		"platform_editor_react_editor_view_react_18": {
 			"type": "boolean"
 		},