@atlaskit/editor-plugin-extension 20.0.5 → 20.0.6

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-plugin-extension
 
+## 20.0.6
+
+### Patch Changes
+
+- [`78155dcee29bf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/78155dcee29bf) -
+  Add generic extension API insertion and node-type replacement support. Use these APIs to preserve
+  the position of newly inserted inline-bodied Forge macros and to restore inline placement when an
+  inline Connect macro is harmonized to Forge while platform_forge_inline_bodied_macro is enabled.
+- Updated dependencies
+
 ## 20.0.5
 
 ### Patch Changes

package/dist/cjs/pm-plugins/extension-api.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getEditInLegacyMacroBrowser = exports.createExtensionAPI = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _validator = require("@atlaskit/adf-utils/validator");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _utils = require("@atlaskit/editor-common/utils");
@@ -167,15 +167,38 @@ var createExtensionAPI = exports.createExtensionAPI = function createExtensionAP
       }
       dispatch(tr);
     },
+    insertAtSelection: function insertAtSelection(adf) {
+      if (!(0, _fg.fg)('platform_forge_inline_bodied_macro')) {
+        return;
+      }
+      try {
+        validate(adf);
+      } catch (_unused) {
+        throw new Error("insertAtSelection(): Invalid ADF given.");
+      }
+      var _options$editorView = options.editorView,
+        dispatch = _options$editorView.dispatch,
+        state = _options$editorView.state;
+      var newNode = state.schema.nodeFromJSON(adf);
+      var tr = state.tr.replaceSelectionWith(newNode).scrollIntoView();
+      try {
+        tr.doc.check();
+      } catch (err) {
+        throw new Error("insertAtSelection(): The given ADFEntity cannot replace the current selection.\n".concat(err));
+      }
+      var apiCallPayload = extensionAPICallPayload('insertAtSelection');
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(apiCallPayload)(tr);
+      dispatch(tr);
+    },
     scrollTo: function scrollTo(localId) {
       var nodePos = ensureNodePosByLocalId(localId, {
         opName: 'scrollTo'
       });
       // Analytics - tracking the api call
       var apiCallPayload = extensionAPICallPayload('scrollTo');
-      var _options$editorView = options.editorView,
-        dispatch = _options$editorView.dispatch,
-        state = _options$editorView.state;
+      var _options$editorView2 = options.editorView,
+        dispatch = _options$editorView2.dispatch,
+        state = _options$editorView2.state;
       var tr = state.tr;
       editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(apiCallPayload)(tr);
       tr = (0, _utils2.setTextSelection)(nodePos.pos)(tr);
@@ -202,12 +225,14 @@ var createExtensionAPI = exports.createExtensionAPI = function createExtensionAP
         }),
         node = _ensureNodePosByLocal.node,
         pos = _ensureNodePosByLocal.pos;
-      var _options$editorView2 = options.editorView,
-        dispatch = _options$editorView2.dispatch,
-        state = _options$editorView2.state;
+      var _options$editorView3 = options.editorView,
+        dispatch = _options$editorView3.dispatch,
+        state = _options$editorView3.state;
       var tr = state.tr,
         schema = state.schema;
-      var changedValues = mutationCallback({
+      var changedValues = mutationCallback(_objectSpread(_objectSpread({}, (0, _fg.fg)('platform_forge_inline_bodied_macro') ? {
+        type: node.type.name
+      } : {}), {}, {
         content: (0, _utils.nodeToJSON)(node).content,
         attrs: node.attrs,
         marks: node.marks.map(function (pmMark) {
@@ -216,7 +241,7 @@ var createExtensionAPI = exports.createExtensionAPI = function createExtensionAP
             attrs: pmMark.attrs
           };
         })
-      });
+      }));
       var ensureValidMark = function ensureValidMark(mark) {
         if ((0, _typeof2.default)(mark) !== 'object' || Array.isArray(mark)) {
           throw new Error("update(): Invalid mark given.");
@@ -242,6 +267,13 @@ var createExtensionAPI = exports.createExtensionAPI = function createExtensionAP
         return mark.create(attrs);
       }) : node.marks;
       var newContent = changedValues.hasOwnProperty('content') ? _model.Fragment.fromJSON(schema, changedValues.content) : node.content;
+      var newType = node.type;
+      if (changedValues.hasOwnProperty('type') && changedValues.type !== node.type.name && (0, _fg.fg)('platform_forge_inline_bodied_macro')) {
+        newType = changedValues.type ? schema.nodes[changedValues.type] : undefined;
+      }
+      if (!newType) {
+        throw new Error("update(): Invalid ADF node type '".concat(changedValues.type, "'."));
+      }
       var newAttrs = changedValues.hasOwnProperty('attrs') ? changedValues.attrs : node.attrs;
       if (node.type.name === 'multiBodiedExtension') {
         var _changedValues$attrs, _node$attrs$parameter, _changedValues$attrs2;
@@ -255,13 +287,21 @@ var createExtensionAPI = exports.createExtensionAPI = function createExtensionAP
 
       // Validate if the new attributes, content and marks result in a valid node and adf.
       try {
-        var newNode = node.type.createChecked(newAttrs, newContent, newMarks);
+        var newNode = newType.createChecked(newAttrs, newContent, newMarks);
         var newNodeAdf = new _JSONTransformer.JSONTransformer().encodeNode(newNode);
         validate(newNodeAdf);
-        tr.replaceWith(pos, pos + node.nodeSize, newNode);
+        if (newType === node.type) {
+          tr.replaceWith(pos, pos + node.nodeSize, newNode);
+        } else {
+          tr.replaceRangeWith(pos, pos + node.nodeSize, newNode);
+          if (node.isBlock && newNode.isInline) {
+            (0, _utils.autoJoinTr)(tr, ['paragraph']);
+          }
+          tr.doc.check();
+        }
 
         // Keep selection if content does not change
-        if (newContent === node.content) {
+        if (newType === node.type && newContent === node.content) {
           tr.setSelection(_state.Selection.fromJSON(tr.doc, state.selection.toJSON()));
         }
       } catch (err) {

package/dist/es2019/pm-plugins/extension-api.js

@@ -1,6 +1,6 @@
 import { validator } from '@atlaskit/adf-utils/validator';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { nodeToJSON } from '@atlaskit/editor-common/utils';
+import { autoJoinTr, nodeToJSON } from '@atlaskit/editor-common/utils';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer/JSONTransformer-2';
 import { Fragment, Mark } from '@atlaskit/editor-prosemirror/model';
 import { NodeSelection, Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
@@ -169,6 +169,30 @@ export const createExtensionAPI = options => {
       }
       dispatch(tr);
     },
+    insertAtSelection: adf => {
+      if (!fg('platform_forge_inline_bodied_macro')) {
+        return;
+      }
+      try {
+        validate(adf);
+      } catch {
+        throw new Error(`insertAtSelection(): Invalid ADF given.`);
+      }
+      const {
+        dispatch,
+        state
+      } = options.editorView;
+      const newNode = state.schema.nodeFromJSON(adf);
+      const tr = state.tr.replaceSelectionWith(newNode).scrollIntoView();
+      try {
+        tr.doc.check();
+      } catch (err) {
+        throw new Error(`insertAtSelection(): The given ADFEntity cannot replace the current selection.\n${err}`);
+      }
+      const apiCallPayload = extensionAPICallPayload('insertAtSelection');
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(apiCallPayload)(tr);
+      dispatch(tr);
+    },
     scrollTo: localId => {
       const nodePos = ensureNodePosByLocalId(localId, {
         opName: 'scrollTo'
@@ -221,6 +245,9 @@ export const createExtensionAPI = options => {
         schema
       } = state;
       const changedValues = mutationCallback({
+        ...(fg('platform_forge_inline_bodied_macro') ? {
+          type: node.type.name
+        } : {}),
         content: nodeToJSON(node).content,
         attrs: node.attrs,
         marks: node.marks.map(pmMark => ({
@@ -253,6 +280,13 @@ export const createExtensionAPI = options => {
         attrs
       }) => mark.create(attrs)) : node.marks;
       const newContent = changedValues.hasOwnProperty('content') ? Fragment.fromJSON(schema, changedValues.content) : node.content;
+      let newType = node.type;
+      if (changedValues.hasOwnProperty('type') && changedValues.type !== node.type.name && fg('platform_forge_inline_bodied_macro')) {
+        newType = changedValues.type ? schema.nodes[changedValues.type] : undefined;
+      }
+      if (!newType) {
+        throw new Error(`update(): Invalid ADF node type '${changedValues.type}'.`);
+      }
       let newAttrs = changedValues.hasOwnProperty('attrs') ? changedValues.attrs : node.attrs;
       if (node.type.name === 'multiBodiedExtension') {
         var _changedValues$attrs, _node$attrs$parameter, _changedValues$attrs2, _changedValues$attrs3;
@@ -273,13 +307,21 @@ export const createExtensionAPI = options => {
 
       // Validate if the new attributes, content and marks result in a valid node and adf.
       try {
-        const newNode = node.type.createChecked(newAttrs, newContent, newMarks);
+        const newNode = newType.createChecked(newAttrs, newContent, newMarks);
         const newNodeAdf = new JSONTransformer().encodeNode(newNode);
         validate(newNodeAdf);
-        tr.replaceWith(pos, pos + node.nodeSize, newNode);
+        if (newType === node.type) {
+          tr.replaceWith(pos, pos + node.nodeSize, newNode);
+        } else {
+          tr.replaceRangeWith(pos, pos + node.nodeSize, newNode);
+          if (node.isBlock && newNode.isInline) {
+            autoJoinTr(tr, ['paragraph']);
+          }
+          tr.doc.check();
+        }
 
         // Keep selection if content does not change
-        if (newContent === node.content) {
+        if (newType === node.type && newContent === node.content) {
           tr.setSelection(Selection.fromJSON(tr.doc, state.selection.toJSON()));
         }
       } catch (err) {

package/dist/esm/pm-plugins/extension-api.js

@@ -1,10 +1,10 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _typeof from "@babel/runtime/helpers/typeof";
+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; }
 import { validator } from '@atlaskit/adf-utils/validator';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { nodeToJSON } from '@atlaskit/editor-common/utils';
+import { autoJoinTr, nodeToJSON } from '@atlaskit/editor-common/utils';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer/JSONTransformer-2';
 import { Fragment, Mark } from '@atlaskit/editor-prosemirror/model';
 import { NodeSelection, Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
@@ -160,15 +160,38 @@ export var createExtensionAPI = function createExtensionAPI(options) {
       }
       dispatch(tr);
     },
+    insertAtSelection: function insertAtSelection(adf) {
+      if (!fg('platform_forge_inline_bodied_macro')) {
+        return;
+      }
+      try {
+        validate(adf);
+      } catch (_unused) {
+        throw new Error("insertAtSelection(): Invalid ADF given.");
+      }
+      var _options$editorView = options.editorView,
+        dispatch = _options$editorView.dispatch,
+        state = _options$editorView.state;
+      var newNode = state.schema.nodeFromJSON(adf);
+      var tr = state.tr.replaceSelectionWith(newNode).scrollIntoView();
+      try {
+        tr.doc.check();
+      } catch (err) {
+        throw new Error("insertAtSelection(): The given ADFEntity cannot replace the current selection.\n".concat(err));
+      }
+      var apiCallPayload = extensionAPICallPayload('insertAtSelection');
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(apiCallPayload)(tr);
+      dispatch(tr);
+    },
     scrollTo: function scrollTo(localId) {
       var nodePos = ensureNodePosByLocalId(localId, {
         opName: 'scrollTo'
       });
       // Analytics - tracking the api call
       var apiCallPayload = extensionAPICallPayload('scrollTo');
-      var _options$editorView = options.editorView,
-        dispatch = _options$editorView.dispatch,
-        state = _options$editorView.state;
+      var _options$editorView2 = options.editorView,
+        dispatch = _options$editorView2.dispatch,
+        state = _options$editorView2.state;
       var tr = state.tr;
       editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(apiCallPayload)(tr);
       tr = setTextSelection(nodePos.pos)(tr);
@@ -195,12 +218,14 @@ export var createExtensionAPI = function createExtensionAPI(options) {
         }),
         node = _ensureNodePosByLocal.node,
         pos = _ensureNodePosByLocal.pos;
-      var _options$editorView2 = options.editorView,
-        dispatch = _options$editorView2.dispatch,
-        state = _options$editorView2.state;
+      var _options$editorView3 = options.editorView,
+        dispatch = _options$editorView3.dispatch,
+        state = _options$editorView3.state;
       var tr = state.tr,
         schema = state.schema;
-      var changedValues = mutationCallback({
+      var changedValues = mutationCallback(_objectSpread(_objectSpread({}, fg('platform_forge_inline_bodied_macro') ? {
+        type: node.type.name
+      } : {}), {}, {
         content: nodeToJSON(node).content,
         attrs: node.attrs,
         marks: node.marks.map(function (pmMark) {
@@ -209,7 +234,7 @@ export var createExtensionAPI = function createExtensionAPI(options) {
             attrs: pmMark.attrs
           };
         })
-      });
+      }));
       var ensureValidMark = function ensureValidMark(mark) {
         if (_typeof(mark) !== 'object' || Array.isArray(mark)) {
           throw new Error("update(): Invalid mark given.");
@@ -235,6 +260,13 @@ export var createExtensionAPI = function createExtensionAPI(options) {
         return mark.create(attrs);
       }) : node.marks;
       var newContent = changedValues.hasOwnProperty('content') ? Fragment.fromJSON(schema, changedValues.content) : node.content;
+      var newType = node.type;
+      if (changedValues.hasOwnProperty('type') && changedValues.type !== node.type.name && fg('platform_forge_inline_bodied_macro')) {
+        newType = changedValues.type ? schema.nodes[changedValues.type] : undefined;
+      }
+      if (!newType) {
+        throw new Error("update(): Invalid ADF node type '".concat(changedValues.type, "'."));
+      }
       var newAttrs = changedValues.hasOwnProperty('attrs') ? changedValues.attrs : node.attrs;
       if (node.type.name === 'multiBodiedExtension') {
         var _changedValues$attrs, _node$attrs$parameter, _changedValues$attrs2;
@@ -248,13 +280,21 @@ export var createExtensionAPI = function createExtensionAPI(options) {
 
       // Validate if the new attributes, content and marks result in a valid node and adf.
       try {
-        var newNode = node.type.createChecked(newAttrs, newContent, newMarks);
+        var newNode = newType.createChecked(newAttrs, newContent, newMarks);
         var newNodeAdf = new JSONTransformer().encodeNode(newNode);
         validate(newNodeAdf);
-        tr.replaceWith(pos, pos + node.nodeSize, newNode);
+        if (newType === node.type) {
+          tr.replaceWith(pos, pos + node.nodeSize, newNode);
+        } else {
+          tr.replaceRangeWith(pos, pos + node.nodeSize, newNode);
+          if (node.isBlock && newNode.isInline) {
+            autoJoinTr(tr, ['paragraph']);
+          }
+          tr.doc.check();
+        }
 
         // Keep selection if content does not change
-        if (newContent === node.content) {
+        if (newType === node.type && newContent === node.content) {
           tr.setSelection(Selection.fromJSON(tr.doc, state.selection.toJSON()));
         }
       } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-extension",
-	"version": "20.0.5",
+	"version": "20.0.6",
 	"description": "editor-plugin-extension plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -79,7 +79,7 @@
 		"uuid": "^11.1.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^121.2.0",
+		"@atlaskit/editor-common": "^121.3.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -94,6 +94,9 @@
 		"platform_editor_adf_validator_stage0": {
 			"type": "boolean"
 		},
+		"platform_forge_inline_bodied_macro": {
+			"type": "boolean"
+		},
 		"platform_editor_ai_object_sidebar_injection": {
 			"type": "boolean"
 		},