@atlaskit/editor-plugin-extension 16.0.3 → 16.1.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @atlaskit/editor-plugin-extension
 
+## 16.1.0
+
+### Minor Changes
+
+- [`337e6777c26aa`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/337e6777c26aa) -
+  Add Block Menu transform extension APIs. Extension manifests can declare ADF-only transform
+  capabilities without importing Editor internals:
+
+  ```ts
+  const extensionNode = {
+  	blockTransform: {
+  		key: 'convert-tabs-to-panel',
+  		isSupported: ({ targetTypeName }) => targetTypeName === 'panel',
+  		transform: ({ source }) => ({ output: [{ type: 'panel', content: source.content }] }),
+  	},
+  };
+  ```
+
+  The Extension Plugin registers each keyed transform with Block Menu after manifests load. Block
+  Menu checks support, validates returned ADF, and owns replacement, selection, history, focus, and
+  analytics.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 16.0.4
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 16.0.3
 
 ### Patch Changes

package/dist/cjs/pm-plugins/block-transforms.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildExtensionBlockTransforms = void 0;
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+var buildExtensionBlockTransforms = exports.buildExtensionBlockTransforms = function buildExtensionBlockTransforms(manifests) {
+  var transforms = [];
+  var _iterator = _createForOfIteratorHelper(manifests),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var manifest = _step.value;
+      for (var _i = 0, _Object$values = Object.values((_manifest$modules$nod = manifest.modules.nodes) !== null && _manifest$modules$nod !== void 0 ? _manifest$modules$nod : {}); _i < _Object$values.length; _i++) {
+        var _manifest$modules$nod;
+        var nodeModule = _Object$values[_i];
+        if (nodeModule.blockTransform) {
+          transforms.push(nodeModule.blockTransform);
+        }
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return transforms;
+};

package/dist/cjs/pm-plugins/main.js

@@ -13,8 +13,10 @@ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _selection2 = require("@atlaskit/editor-common/selection");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _commands = require("../editor-commands/commands");
 var _lazyExtension = require("../nodeviews/lazyExtension");
+var _blockTransforms = require("./block-transforms");
 var _pluginFactory = require("./plugin-factory");
 var _pluginKey = require("./plugin-key");
 var _updateEditButton = require("./update-edit-button");
@@ -64,15 +66,15 @@ var getUpdateExtensionPromise = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
-var createExtensionProviderHandler = exports.createExtensionProviderHandler = function createExtensionProviderHandler(view) {
+var createExtensionProviderHandler = exports.createExtensionProviderHandler = function createExtensionProviderHandler(view, api) {
   return /*#__PURE__*/function () {
     var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(name, provider) {
-      var extensionProvider, _t;
+      var extensionProvider, _api$blockMenu, manifests, _t, _t2;
       return _regenerator.default.wrap(function (_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
             if (!(name === 'extensionProvider' && provider)) {
-              _context2.next = 5;
+              _context2.next = 9;
               break;
             }
             _context2.prev = 1;
@@ -86,19 +88,35 @@ var createExtensionProviderHandler = exports.createExtensionProviderHandler = fu
             _context2.next = 3;
             return (0, _updateEditButton.updateEditButton)(view, extensionProvider);
           case 3:
+            if (!(0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_block_menu_transform_extensions')) {
+              _context2.next = 7;
+              break;
+            }
+            _context2.prev = 4;
             _context2.next = 5;
+            return extensionProvider.getExtensions();
+          case 5:
+            manifests = _context2.sent;
+            api === null || api === void 0 || (_api$blockMenu = api.blockMenu) === null || _api$blockMenu === void 0 || _api$blockMenu.actions.registerBlockMenuTransforms((0, _blockTransforms.buildExtensionBlockTransforms)(manifests));
+            _context2.next = 7;
             break;
-          case 4:
-            _context2.prev = 4;
-            _t = _context2["catch"](1);
+          case 6:
+            _context2.prev = 6;
+            _t = _context2["catch"](4);
+          case 7:
+            _context2.next = 9;
+            break;
+          case 8:
+            _context2.prev = 8;
+            _t2 = _context2["catch"](1);
             (0, _commands.updateState)({
               extensionProvider: undefined
             })(view.state, view.dispatch);
-          case 5:
+          case 9:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[1, 4]]);
+      }, _callee2, null, [[1, 8], [4, 6]]);
     }));
     return function (_x4, _x5) {
       return _ref2.apply(this, arguments);
@@ -190,7 +208,7 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, provid
     state: state,
     view: function view(editorView) {
       var domAtPos = editorView.domAtPos.bind(editorView);
-      var extensionProviderHandler = createExtensionProviderHandler(editorView);
+      var extensionProviderHandler = createExtensionProviderHandler(editorView, pluginInjectionApi);
       providerFactory.subscribe('extensionProvider', extensionProviderHandler);
       return {
         update: function update(view, prevState) {

package/dist/es2019/pm-plugins/block-transforms.js

@@ -0,0 +1,12 @@
+export const buildExtensionBlockTransforms = manifests => {
+  const transforms = [];
+  for (const manifest of manifests) {
+    for (const nodeModule of Object.values((_manifest$modules$nod = manifest.modules.nodes) !== null && _manifest$modules$nod !== void 0 ? _manifest$modules$nod : {})) {
+      var _manifest$modules$nod;
+      if (nodeModule.blockTransform) {
+        transforms.push(nodeModule.blockTransform);
+      }
+    }
+  }
+  return transforms;
+};

package/dist/es2019/pm-plugins/main.js

@@ -3,8 +3,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { GapCursorSelection, createSelectionClickHandler, isSelectionAtEndOfNode, isSelectionAtStartOfNode } from '@atlaskit/editor-common/selection';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { findParentNodeOfTypeClosestToPos, findSelectedNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { clearEditingContext, updateState } from '../editor-commands/commands';
 import { lazyExtensionNodeView } from '../nodeviews/lazyExtension';
+import { buildExtensionBlockTransforms } from './block-transforms';
 import { createPluginState, getPluginState } from './plugin-factory';
 import { pluginKey } from './plugin-key';
 import { updateEditButton } from './update-edit-button';
@@ -30,7 +32,7 @@ const getUpdateExtensionPromise = async (view, extensionHandler, extensionProvid
   }
   throw new Error('No update method available');
 };
-export const createExtensionProviderHandler = view => async (name, provider) => {
+export const createExtensionProviderHandler = (view, api) => async (name, provider) => {
   if (name === 'extensionProvider' && provider) {
     try {
       const extensionProvider = await provider;
@@ -38,6 +40,15 @@ export const createExtensionProviderHandler = view => async (name, provider) =>
         extensionProvider
       })(view.state, view.dispatch);
       await updateEditButton(view, extensionProvider);
+      if (isExperimentEnabled('platform_editor_block_menu_transform_extensions')) {
+        try {
+          var _api$blockMenu;
+          const manifests = await extensionProvider.getExtensions();
+          api === null || api === void 0 ? void 0 : (_api$blockMenu = api.blockMenu) === null || _api$blockMenu === void 0 ? void 0 : _api$blockMenu.actions.registerBlockMenuTransforms(buildExtensionBlockTransforms(manifests));
+        } catch {
+          // Transform registration remains unavailable when manifests cannot be loaded.
+        }
+      }
     } catch {
       updateState({
         extensionProvider: undefined
@@ -133,7 +144,7 @@ export const createPlugin = (dispatch, providerFactory, extensionHandlers, exten
     state,
     view: editorView => {
       const domAtPos = editorView.domAtPos.bind(editorView);
-      const extensionProviderHandler = createExtensionProviderHandler(editorView);
+      const extensionProviderHandler = createExtensionProviderHandler(editorView, pluginInjectionApi);
       providerFactory.subscribe('extensionProvider', extensionProviderHandler);
       return {
         update: (view, prevState) => {

package/dist/esm/pm-plugins/block-transforms.js

@@ -0,0 +1,25 @@
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+export var buildExtensionBlockTransforms = function buildExtensionBlockTransforms(manifests) {
+  var transforms = [];
+  var _iterator = _createForOfIteratorHelper(manifests),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var manifest = _step.value;
+      for (var _i = 0, _Object$values = Object.values((_manifest$modules$nod = manifest.modules.nodes) !== null && _manifest$modules$nod !== void 0 ? _manifest$modules$nod : {}); _i < _Object$values.length; _i++) {
+        var _manifest$modules$nod;
+        var nodeModule = _Object$values[_i];
+        if (nodeModule.blockTransform) {
+          transforms.push(nodeModule.blockTransform);
+        }
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return transforms;
+};

package/dist/esm/pm-plugins/main.js

@@ -6,8 +6,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { GapCursorSelection, createSelectionClickHandler, isSelectionAtEndOfNode, isSelectionAtStartOfNode } from '@atlaskit/editor-common/selection';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { findParentNodeOfTypeClosestToPos, findSelectedNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { clearEditingContext, updateState } from '../editor-commands/commands';
 import { lazyExtensionNodeView } from '../nodeviews/lazyExtension';
+import { buildExtensionBlockTransforms } from './block-transforms';
 import { createPluginState, getPluginState } from './plugin-factory';
 import { pluginKey } from './plugin-key';
 import { updateEditButton } from './update-edit-button';
@@ -57,15 +59,15 @@ var getUpdateExtensionPromise = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
-export var createExtensionProviderHandler = function createExtensionProviderHandler(view) {
+export var createExtensionProviderHandler = function createExtensionProviderHandler(view, api) {
   return /*#__PURE__*/function () {
     var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(name, provider) {
-      var extensionProvider, _t;
+      var extensionProvider, _api$blockMenu, manifests, _t, _t2;
       return _regeneratorRuntime.wrap(function (_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
             if (!(name === 'extensionProvider' && provider)) {
-              _context2.next = 5;
+              _context2.next = 9;
               break;
             }
             _context2.prev = 1;
@@ -79,19 +81,35 @@ export var createExtensionProviderHandler = function createExtensionProviderHand
             _context2.next = 3;
             return updateEditButton(view, extensionProvider);
           case 3:
+            if (!isExperimentEnabled('platform_editor_block_menu_transform_extensions')) {
+              _context2.next = 7;
+              break;
+            }
+            _context2.prev = 4;
             _context2.next = 5;
+            return extensionProvider.getExtensions();
+          case 5:
+            manifests = _context2.sent;
+            api === null || api === void 0 || (_api$blockMenu = api.blockMenu) === null || _api$blockMenu === void 0 || _api$blockMenu.actions.registerBlockMenuTransforms(buildExtensionBlockTransforms(manifests));
+            _context2.next = 7;
             break;
-          case 4:
-            _context2.prev = 4;
-            _t = _context2["catch"](1);
+          case 6:
+            _context2.prev = 6;
+            _t = _context2["catch"](4);
+          case 7:
+            _context2.next = 9;
+            break;
+          case 8:
+            _context2.prev = 8;
+            _t2 = _context2["catch"](1);
             updateState({
               extensionProvider: undefined
             })(view.state, view.dispatch);
-          case 5:
+          case 9:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[1, 4]]);
+      }, _callee2, null, [[1, 8], [4, 6]]);
     }));
     return function (_x4, _x5) {
       return _ref2.apply(this, arguments);
@@ -183,7 +201,7 @@ export var createPlugin = function createPlugin(dispatch, providerFactory, exten
     state: state,
     view: function view(editorView) {
       var domAtPos = editorView.domAtPos.bind(editorView);
-      var extensionProviderHandler = createExtensionProviderHandler(editorView);
+      var extensionProviderHandler = createExtensionProviderHandler(editorView, pluginInjectionApi);
       providerFactory.subscribe('extensionProvider', extensionProviderHandler);
       return {
         update: function update(view, prevState) {

package/dist/types/extensionPluginType.d.ts

@@ -6,6 +6,7 @@ import type { MacroProvider } from '@atlaskit/editor-common/provider-factory';
 import type { EditorAppearance, LongPressSelectionPluginOptions, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { BlockMenuPlugin } from '@atlaskit/editor-plugin-block-menu/blockMenuPluginType';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
 import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier';
 import type { ApplyChangeHandler, ContextPanelPlugin } from '@atlaskit/editor-plugin-context-panel';
@@ -85,7 +86,8 @@ export type ExtensionPluginDependencies = [
     OptionalPlugin<ConnectivityPlugin>,
     OptionalPlugin<ToolbarPlugin>,
     OptionalPlugin<MentionsPlugin>,
-    OptionalPlugin<CopyButtonPlugin>
+    OptionalPlugin<CopyButtonPlugin>,
+    OptionalPlugin<BlockMenuPlugin>
 ];
 export type RegisterExtensionLoadingHandler = (options: {
     extensionType: string;

package/dist/types/pm-plugins/block-transforms.d.ts

@@ -0,0 +1,3 @@
+import type { BlockTransformExtension } from '@atlaskit/editor-common/block-menu/block-transform-extension';
+import type { ExtensionManifest } from '@atlaskit/editor-common/extensions/extension-manifest';
+export declare const buildExtensionBlockTransforms: (manifests: ExtensionManifest[]) => BlockTransformExtension[];

package/dist/types/pm-plugins/main.d.ts

@@ -10,7 +10,7 @@ import type { ApplyChangeHandler } from '@atlaskit/editor-plugin-context-panel';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { ExtensionPlugin, ExtensionPluginOptions, ExtensionState } from '../extensionPluginType';
-export declare const createExtensionProviderHandler: (view: EditorView) => (name: string, provider?: Promise<ExtensionProvider>) => Promise<void>;
+export declare const createExtensionProviderHandler: (view: EditorView, api?: ExtractInjectionAPI<ExtensionPlugin>) => (name: string, provider?: Promise<ExtensionProvider>) => Promise<void>;
 export declare const handleUpdate: ({ view, prevState, domAtPos, extensionHandlers, applyChange, }: {
     applyChange: ApplyChangeHandler | undefined;
     domAtPos: EditorView['domAtPos'];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-extension",
-	"version": "16.0.3",
+	"version": "16.1.0",
 	"description": "editor-plugin-extension 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.5.0",
+		"@atlaskit/adf-schema": "^56.6.0",
 		"@atlaskit/adf-utils": "^20.5.0",
 		"@atlaskit/analytics-next": "^12.3.0",
 		"@atlaskit/avatar": "^26.4.0",
@@ -31,14 +31,15 @@
 		"@atlaskit/datetime-picker": "^18.2.0",
 		"@atlaskit/editor-json-transformer": "^9.2.0",
 		"@atlaskit/editor-plugin-analytics": "^13.0.0",
+		"@atlaskit/editor-plugin-block-menu": "^12.1.0",
 		"@atlaskit/editor-plugin-connectivity": "^13.0.0",
 		"@atlaskit/editor-plugin-context-identifier": "^13.0.0",
 		"@atlaskit/editor-plugin-context-panel": "^15.0.0",
 		"@atlaskit/editor-plugin-copy-button": "^13.0.0",
 		"@atlaskit/editor-plugin-decorations": "^13.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^12.0.0",
-		"@atlaskit/editor-plugin-mentions": "^15.0.0",
-		"@atlaskit/editor-plugin-toolbar": "^10.0.0",
+		"@atlaskit/editor-plugin-mentions": "^15.1.0",
+		"@atlaskit/editor-plugin-toolbar": "^10.1.0",
 		"@atlaskit/editor-plugin-width": "^14.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/editor-shared-styles": "^4.0.0",
@@ -49,6 +50,7 @@
 		"@atlaskit/icon": "^37.3.0",
 		"@atlaskit/link": "^5.0.0",
 		"@atlaskit/mention": "^27.12.0",
+		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/primitives": "^22.2.0",
 		"@atlaskit/radio": "^9.1.0",
@@ -59,7 +61,7 @@
 		"@atlaskit/tabs": "^20.1.0",
 		"@atlaskit/textarea": "^9.1.0",
 		"@atlaskit/textfield": "^10.0.0",
-		"@atlaskit/tmp-editor-statsig": "^140.0.0",
+		"@atlaskit/tmp-editor-statsig": "^141.1.0",
 		"@atlaskit/toggle": "^17.1.0",
 		"@atlaskit/tokens": "^16.3.0",
 		"@atlaskit/tooltip": "^24.0.0",
@@ -73,7 +75,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^117.2.0",
+		"@atlaskit/editor-common": "^117.3.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},