@atlaskit/editor-core 203.13.1 → 203.14.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-core
 
+## 203.14.0
+
+### Minor Changes
+
+- [#106350](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/106350)
+  [`ab9819f908779`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ab9819f908779) -
+  Migrated onEditorViewStateUpdatedCallbacks calls to createEditorStateNotificationPlugin
+
 ## 203.13.1
 
 ### Patch Changes

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

@@ -346,7 +346,6 @@ function ReactEditorView(props) {
     }));
   }, [blur, dispatchAnalyticsEvent, eventDispatcher, dispatch, errorReporter, featureFlags]);
   var onEditorViewUpdated = (0, _react.useCallback)(function (_ref2) {
-    var _config$current;
     var originalTransaction = _ref2.originalTransaction,
       transactions = _ref2.transactions,
       oldEditorState = _ref2.oldEditorState,
@@ -357,16 +356,17 @@ function ReactEditorView(props) {
         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,
-        transactions: transactions,
-        oldEditorState: oldEditorState,
-        newEditorState: newEditorState
+    if (!(0, _platformFeatureFlags.fg)('platform_editor_migrate_state_updates')) {
+      var _config$current;
+      (_config$current = config.current) === null || _config$current === void 0 || _config$current.onEditorViewStateUpdatedCallbacks.forEach(function (entry) {
+        entry.callback({
+          originalTransaction: originalTransaction,
+          transactions: transactions,
+          oldEditorState: oldEditorState,
+          newEditorState: newEditorState
+        });
       });
-    });
+    }
   }, []);
   var _dispatchTransaction = (0, _useDispatchTransaction.useDispatchTransaction)({
     onChange: props.editorProps.onChange,

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

@@ -115,7 +115,7 @@ function createPMPlugins(config) {
     return typeof plugin !== 'undefined';
   });
   if (config.onEditorStateUpdated !== undefined) {
-    return [(0, _editorStateNotificationPlugin.createEditorStateNotificationPlugin)(config.onEditorStateUpdated)].concat((0, _toConsumableArray2.default)(pmPlugins));
+    return [(0, _editorStateNotificationPlugin.createEditorStateNotificationPlugin)(config.onEditorStateUpdated, config.editorConfig.onEditorViewStateUpdatedCallbacks)].concat((0, _toConsumableArray2.default)(pmPlugins));
   }
   return pmPlugins;
 }

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

@@ -5,11 +5,39 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createEditorStateNotificationPlugin = void 0;
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
-var createEditorStateNotificationPlugin = exports.createEditorStateNotificationPlugin = function createEditorStateNotificationPlugin(onEditorStateUpdated) {
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var key = new _state.PluginKey('editorStateNotificationPlugin');
+var createEditorStateNotificationPlugin = exports.createEditorStateNotificationPlugin = function createEditorStateNotificationPlugin(onEditorStateUpdated, onEditorViewStateUpdatedCallbacks) {
   return new _safePlugin.SafePlugin({
+    key: key,
+    state: {
+      init: function init() {
+        return {
+          latestTransaction: undefined
+        };
+      },
+      apply: function apply(tr) {
+        return {
+          latestTransaction: tr
+        };
+      }
+    },
     view: function view() {
       return {
         update: function update(view, oldEditorState) {
+          var _key$getState;
+          var originalTransaction = (_key$getState = key.getState(view.state)) === null || _key$getState === void 0 ? void 0 : _key$getState.latestTransaction;
+          if (originalTransaction && (0, _platformFeatureFlags.fg)('platform_editor_migrate_state_updates')) {
+            onEditorViewStateUpdatedCallbacks.forEach(function (entry) {
+              entry.callback({
+                originalTransaction: originalTransaction,
+                transactions: [originalTransaction],
+                oldEditorState: oldEditorState,
+                newEditorState: view.state
+              });
+            });
+          }
           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 = "203.13.1";
+var version = exports.version = "203.14.0";

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

@@ -324,23 +324,23 @@ export function ReactEditorView(props) {
     oldEditorState,
     newEditorState
   }) => {
-    var _config$current;
     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,
-        transactions,
-        oldEditorState,
-        newEditorState
+    if (!fg('platform_editor_migrate_state_updates')) {
+      var _config$current;
+      (_config$current = config.current) === null || _config$current === void 0 ? void 0 : _config$current.onEditorViewStateUpdatedCallbacks.forEach(entry => {
+        entry.callback({
+          originalTransaction,
+          transactions,
+          oldEditorState,
+          newEditorState
+        });
       });
-    });
+    }
   }, []);
   const dispatchTransaction = useDispatchTransaction({
     onChange: props.editorProps.onChange,

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

@@ -95,7 +95,7 @@ export function createPMPlugins(config) {
     getIntl: config.getIntl
   })).filter(plugin => typeof plugin !== 'undefined');
   if (config.onEditorStateUpdated !== undefined) {
-    return [createEditorStateNotificationPlugin(config.onEditorStateUpdated), ...pmPlugins];
+    return [createEditorStateNotificationPlugin(config.onEditorStateUpdated, config.editorConfig.onEditorViewStateUpdatedCallbacks), ...pmPlugins];
   }
   return pmPlugins;
 }

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

@@ -1,8 +1,36 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-export const createEditorStateNotificationPlugin = onEditorStateUpdated => new SafePlugin({
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags';
+const key = new PluginKey('editorStateNotificationPlugin');
+export const createEditorStateNotificationPlugin = (onEditorStateUpdated, onEditorViewStateUpdatedCallbacks) => new SafePlugin({
+  key: key,
+  state: {
+    init() {
+      return {
+        latestTransaction: undefined
+      };
+    },
+    apply(tr) {
+      return {
+        latestTransaction: tr
+      };
+    }
+  },
   view: () => {
     return {
       update: (view, oldEditorState) => {
+        var _key$getState;
+        const originalTransaction = (_key$getState = key.getState(view.state)) === null || _key$getState === void 0 ? void 0 : _key$getState.latestTransaction;
+        if (originalTransaction && fg('platform_editor_migrate_state_updates')) {
+          onEditorViewStateUpdatedCallbacks.forEach(entry => {
+            entry.callback({
+              originalTransaction,
+              transactions: [originalTransaction],
+              oldEditorState,
+              newEditorState: view.state
+            });
+          });
+        }
         onEditorStateUpdated({
           oldEditorState,
           newEditorState: view.state

package/dist/es2019/version-wrapper.js

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

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

@@ -335,7 +335,6 @@ export function ReactEditorView(props) {
     }));
   }, [blur, dispatchAnalyticsEvent, eventDispatcher, dispatch, errorReporter, featureFlags]);
   var onEditorViewUpdated = useCallback(function (_ref2) {
-    var _config$current;
     var originalTransaction = _ref2.originalTransaction,
       transactions = _ref2.transactions,
       oldEditorState = _ref2.oldEditorState,
@@ -346,16 +345,17 @@ export function ReactEditorView(props) {
         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,
-        transactions: transactions,
-        oldEditorState: oldEditorState,
-        newEditorState: newEditorState
+    if (!fg('platform_editor_migrate_state_updates')) {
+      var _config$current;
+      (_config$current = config.current) === null || _config$current === void 0 || _config$current.onEditorViewStateUpdatedCallbacks.forEach(function (entry) {
+        entry.callback({
+          originalTransaction: originalTransaction,
+          transactions: transactions,
+          oldEditorState: oldEditorState,
+          newEditorState: newEditorState
+        });
       });
-    });
+    }
   }, []);
   var _dispatchTransaction = useDispatchTransaction({
     onChange: props.editorProps.onChange,

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

@@ -104,7 +104,7 @@ export function createPMPlugins(config) {
     return typeof plugin !== 'undefined';
   });
   if (config.onEditorStateUpdated !== undefined) {
-    return [createEditorStateNotificationPlugin(config.onEditorStateUpdated)].concat(_toConsumableArray(pmPlugins));
+    return [createEditorStateNotificationPlugin(config.onEditorStateUpdated, config.editorConfig.onEditorViewStateUpdatedCallbacks)].concat(_toConsumableArray(pmPlugins));
   }
   return pmPlugins;
 }

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

@@ -1,9 +1,37 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-export var createEditorStateNotificationPlugin = function createEditorStateNotificationPlugin(onEditorStateUpdated) {
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags';
+var key = new PluginKey('editorStateNotificationPlugin');
+export var createEditorStateNotificationPlugin = function createEditorStateNotificationPlugin(onEditorStateUpdated, onEditorViewStateUpdatedCallbacks) {
   return new SafePlugin({
+    key: key,
+    state: {
+      init: function init() {
+        return {
+          latestTransaction: undefined
+        };
+      },
+      apply: function apply(tr) {
+        return {
+          latestTransaction: tr
+        };
+      }
+    },
     view: function view() {
       return {
         update: function update(view, oldEditorState) {
+          var _key$getState;
+          var originalTransaction = (_key$getState = key.getState(view.state)) === null || _key$getState === void 0 ? void 0 : _key$getState.latestTransaction;
+          if (originalTransaction && fg('platform_editor_migrate_state_updates')) {
+            onEditorViewStateUpdatedCallbacks.forEach(function (entry) {
+              entry.callback({
+                originalTransaction: originalTransaction,
+                transactions: [originalTransaction],
+                oldEditorState: oldEditorState,
+                newEditorState: view.state
+              });
+            });
+          }
           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 = "203.13.1";
+export var version = "203.14.0";

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

@@ -1,6 +1,13 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { type ReadonlyTransaction, type EditorState } from '@atlaskit/editor-prosemirror/state';
+import { type EditorViewStateUpdatedCallbackProps } from '../types/editor-config';
+export type EditorStateNotificationPluginState = {
+    latestTransaction: ReadonlyTransaction | undefined;
+};
 export declare const createEditorStateNotificationPlugin: (onEditorStateUpdated: (props: {
     oldEditorState: EditorState;
     newEditorState: EditorState;
-}) => void) => SafePlugin<any>;
+}) => void, onEditorViewStateUpdatedCallbacks: {
+    pluginName: string;
+    callback: (props: EditorViewStateUpdatedCallbackProps) => void;
+}[]) => SafePlugin<EditorStateNotificationPluginState>;

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

@@ -1,6 +1,13 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { type ReadonlyTransaction, type EditorState } from '@atlaskit/editor-prosemirror/state';
+import { type EditorViewStateUpdatedCallbackProps } from '../types/editor-config';
+export type EditorStateNotificationPluginState = {
+    latestTransaction: ReadonlyTransaction | undefined;
+};
 export declare const createEditorStateNotificationPlugin: (onEditorStateUpdated: (props: {
     oldEditorState: EditorState;
     newEditorState: EditorState;
-}) => void) => SafePlugin<any>;
+}) => void, onEditorViewStateUpdatedCallbacks: {
+    pluginName: string;
+    callback: (props: EditorViewStateUpdatedCallbackProps) => void;
+}[]) => SafePlugin<EditorStateNotificationPluginState>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "203.13.1",
+	"version": "203.14.0",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -50,7 +50,7 @@
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/editor-shared-styles": "^3.2.0",
 		"@atlaskit/emoji": "^67.13.0",
-		"@atlaskit/icon": "^23.5.0",
+		"@atlaskit/icon": "^23.6.0",
 		"@atlaskit/media-card": "^78.19.0",
 		"@atlaskit/mention": "^23.11.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
@@ -265,6 +265,9 @@
 		"platform_editor_catch_missing_injection_states": {
 			"type": "boolean"
 		},
+		"platform_editor_migrate_state_updates": {
+			"type": "boolean"
+		},
 		"platform_editor_typography_ugc": {
 			"type": "boolean",
 			"referenceOnly": true