@atlaskit/editor-plugin-extension 17.0.4 → 17.1.0

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @atlaskit/editor-plugin-extension
 
+## 17.1.0
+
+### Minor Changes
+
+- [`882186c3b96b6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/882186c3b96b6) -
+  Add an optional `hideCopyButton` capability to extension manifest nodes (`ExtensionModuleNode`).
+  When set, the extension's selection floating toolbar hides the copy button. Used by the redaction
+  extension so redacted content is delete-only (no copy, no configure).
+
+  The new toolbar behaviour is gated behind `platform_editor_extension_hide_copy_button`. When the
+  gate is off, the toolbar renders exactly as before. When the copy button is hidden, the trailing
+  toolbar separator is also hidden so delete-only toolbars do not render an orphaned divider.
+
+  ```ts
+  const manifest: ExtensionManifest = {
+  	// ...
+  	modules: {
+  		nodes: {
+  			default: {
+  				type: 'inlineExtension',
+  				render: () => import('./MyExtension'),
+  				// Hide the copy button on this node's selection toolbar
+  				hideCopyButton: true,
+  			},
+  		},
+  	},
+  };
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
+## 17.0.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 17.0.4
 
 ### Patch Changes

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

@@ -174,6 +174,10 @@ var handleUpdate = exports.handleUpdate = function handleUpdate(_ref3) {
       showContextPanel: false,
       element: newElement,
       showEditButton: _showEditButton,
+      // Default to showing synchronously; the manifest-driven value (if any)
+      // is resolved asynchronously via updateEditButton for provider-based
+      // extensions.
+      showCopyButton: true,
       updateExtension: updateExtension
     })(state, dispatch);
   }
@@ -194,6 +198,7 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, provid
   var intl = arguments.length > 11 ? arguments[11] : undefined;
   var state = (0, _pluginFactory.createPluginState)(dispatch, {
     showEditButton: false,
+    showCopyButton: true,
     showContextPanel: false
   });
   var extensionNodeViewOptions = {

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

@@ -21,6 +21,7 @@ var _contentWidthWide = _interopRequireDefault(require("@atlaskit/icon/core/cont
 var _delete = _interopRequireDefault(require("@atlaskit/icon/core/delete"));
 var _edit = _interopRequireDefault(require("@atlaskit/icon/core/edit"));
 var _expandHorizontal = _interopRequireDefault(require("@atlaskit/icon/core/expand-horizontal"));
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _actions = require("../editor-actions/actions");
@@ -390,8 +391,9 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref
       };
     }
 
-    // disable copy button for legacy content macro
-    var shouldHideCopyButton = (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionType) === 'com.atlassian.confluence.migration' && (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionKey) === 'legacy-content';
+    // Hide the copy button when the extension's manifest node opts out via
+    // `hideCopyButton` (e.g. redactions), or for the legacy content macro.
+    var shouldHideCopyButton = !extensionState.showCopyButton && (0, _fg.fg)('platform_editor_extension_hide_copy_button') || (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionType) === 'com.atlassian.confluence.migration' && (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionKey) === 'legacy-content';
     return {
       title: 'Extension floating controls',
       // Ignored via go/ees005
@@ -426,8 +428,12 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref
         }]
       }, shouldHideCopyButton && {
         hidden: shouldHideCopyButton
-      }), {
-        type: 'separator'
+      }),
+      // Hide this separator when the copy button is hidden, otherwise it
+      // renders as an orphaned divider before the delete button.
+      {
+        type: 'separator',
+        hidden: shouldHideCopyButton
       }, {
         id: 'editor.extension.delete',
         type: 'button',

package/dist/cjs/pm-plugins/update-edit-button.js

@@ -10,7 +10,7 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _extensions = require("@atlaskit/editor-common/extensions");
 var _commands = require("../editor-commands/commands");
 var _utils = require("./utils");
-var maybeGetUpdateMethodFromExtensionProvider = /*#__PURE__*/function () {
+var maybeGetExtensionModuleNode = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(view, extensionProvider) {
     var nodeWithPos, _nodeWithPos$node$att, extensionType, extensionKey, extensionModuleNode, newNodeWithPos;
     return _regenerator.default.wrap(function (_context) {
@@ -33,30 +33,32 @@ var maybeGetUpdateMethodFromExtensionProvider = /*#__PURE__*/function () {
             _context.next = 3;
             break;
           }
-          return _context.abrupt("return", extensionModuleNode.update);
+          return _context.abrupt("return", extensionModuleNode);
         case 3:
         case "end":
           return _context.stop();
       }
     }, _callee);
   }));
-  return function maybeGetUpdateMethodFromExtensionProvider(_x, _x2) {
+  return function maybeGetExtensionModuleNode(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();
 var updateEditButton = exports.updateEditButton = /*#__PURE__*/function () {
   var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(view, extensionProvider) {
-    var updateMethod, _t;
+    var extensionModuleNode, updateMethod, _t;
     return _regenerator.default.wrap(function (_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
           _context2.prev = 0;
           _context2.next = 1;
-          return maybeGetUpdateMethodFromExtensionProvider(view, extensionProvider);
+          return maybeGetExtensionModuleNode(view, extensionProvider);
         case 1:
-          updateMethod = _context2.sent;
+          extensionModuleNode = _context2.sent;
+          updateMethod = extensionModuleNode === null || extensionModuleNode === void 0 ? void 0 : extensionModuleNode.update;
           (0, _commands.updateState)({
             showEditButton: !!updateMethod,
+            showCopyButton: !(extensionModuleNode !== null && extensionModuleNode !== void 0 && extensionModuleNode.hideCopyButton),
             updateExtension: updateMethod && Promise.resolve(updateMethod) || undefined
           })(view.state, view.dispatch);
           return _context2.abrupt("return", updateMethod);

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

@@ -115,6 +115,10 @@ export const handleUpdate = ({
       showContextPanel: false,
       element: newElement,
       showEditButton,
+      // Default to showing synchronously; the manifest-driven value (if any)
+      // is resolved asynchronously via updateEditButton for provider-based
+      // extensions.
+      showCopyButton: true,
       updateExtension
     })(state, dispatch);
   }
@@ -130,6 +134,7 @@ export const createPlugin = (dispatch, providerFactory, extensionHandlers, exten
   var _featureFlags$macroIn;
   const state = createPluginState(dispatch, {
     showEditButton: false,
+    showCopyButton: true,
     showContextPanel: false
   });
   const extensionNodeViewOptions = {

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

@@ -12,6 +12,7 @@ import ContentWidthWideIcon from '@atlaskit/icon/core/content-width-wide';
 import DeleteIcon from '@atlaskit/icon/core/delete';
 import EditIcon from '@atlaskit/icon/core/edit';
 import ExpandHorizontalIcon from '@atlaskit/icon/core/expand-horizontal';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { editExtension } from '../editor-actions/actions';
@@ -391,8 +392,9 @@ export const getToolbarConfig = ({
     };
   }
 
-  // disable copy button for legacy content macro
-  const shouldHideCopyButton = (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionType) === 'com.atlassian.confluence.migration' && (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionKey) === 'legacy-content';
+  // Hide the copy button when the extension's manifest node opts out via
+  // `hideCopyButton` (e.g. redactions), or for the legacy content macro.
+  const shouldHideCopyButton = !extensionState.showCopyButton && fg('platform_editor_extension_hide_copy_button') || (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionType) === 'com.atlassian.confluence.migration' && (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionKey) === 'legacy-content';
   return {
     title: 'Extension floating controls',
     // Ignored via go/ees005
@@ -424,8 +426,12 @@ export const getToolbarConfig = ({
       ...(shouldHideCopyButton && {
         hidden: shouldHideCopyButton
       })
-    }, {
-      type: 'separator'
+    },
+    // Hide this separator when the copy button is hidden, otherwise it
+    // renders as an orphaned divider before the delete button.
+    {
+      type: 'separator',
+      hidden: shouldHideCopyButton
     }, {
       id: 'editor.extension.delete',
       type: 'button',

package/dist/es2019/pm-plugins/update-edit-button.js

@@ -1,7 +1,7 @@
 import { getExtensionModuleNode } from '@atlaskit/editor-common/extensions';
 import { updateState } from '../editor-commands/commands';
 import { getSelectedExtension } from './utils';
-const maybeGetUpdateMethodFromExtensionProvider = async (view, extensionProvider) => {
+const maybeGetExtensionModuleNode = async (view, extensionProvider) => {
   const nodeWithPos = getSelectedExtension(view.state, true);
   if (!nodeWithPos) {
     throw new Error('There is no selection');
@@ -13,14 +13,16 @@ const maybeGetUpdateMethodFromExtensionProvider = async (view, extensionProvider
   const extensionModuleNode = await getExtensionModuleNode(extensionProvider, extensionType, extensionKey);
   const newNodeWithPos = getSelectedExtension(view.state, true);
   if (newNodeWithPos && newNodeWithPos.node.attrs.extensionType === extensionType && newNodeWithPos.node.attrs.extensionKey === extensionKey && newNodeWithPos.pos === nodeWithPos.pos && extensionModuleNode) {
-    return extensionModuleNode.update;
+    return extensionModuleNode;
   }
 };
 export const updateEditButton = async (view, extensionProvider) => {
   try {
-    const updateMethod = await maybeGetUpdateMethodFromExtensionProvider(view, extensionProvider);
+    const extensionModuleNode = await maybeGetExtensionModuleNode(view, extensionProvider);
+    const updateMethod = extensionModuleNode === null || extensionModuleNode === void 0 ? void 0 : extensionModuleNode.update;
     updateState({
       showEditButton: !!updateMethod,
+      showCopyButton: !(extensionModuleNode !== null && extensionModuleNode !== void 0 && extensionModuleNode.hideCopyButton),
       updateExtension: updateMethod && Promise.resolve(updateMethod) || undefined
     })(view.state, view.dispatch);
     return updateMethod;

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

@@ -167,6 +167,10 @@ export var handleUpdate = function handleUpdate(_ref3) {
       showContextPanel: false,
       element: newElement,
       showEditButton: _showEditButton,
+      // Default to showing synchronously; the manifest-driven value (if any)
+      // is resolved asynchronously via updateEditButton for provider-based
+      // extensions.
+      showCopyButton: true,
       updateExtension: updateExtension
     })(state, dispatch);
   }
@@ -187,6 +191,7 @@ export var createPlugin = function createPlugin(dispatch, providerFactory, exten
   var intl = arguments.length > 11 ? arguments[11] : undefined;
   var state = createPluginState(dispatch, {
     showEditButton: false,
+    showCopyButton: true,
     showContextPanel: false
   });
   var extensionNodeViewOptions = {

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

@@ -16,6 +16,7 @@ import ContentWidthWideIcon from '@atlaskit/icon/core/content-width-wide';
 import DeleteIcon from '@atlaskit/icon/core/delete';
 import EditIcon from '@atlaskit/icon/core/edit';
 import ExpandHorizontalIcon from '@atlaskit/icon/core/expand-horizontal';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { editExtension } from '../editor-actions/actions';
@@ -384,8 +385,9 @@ export var getToolbarConfig = function getToolbarConfig(_ref2) {
       };
     }
 
-    // disable copy button for legacy content macro
-    var shouldHideCopyButton = (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionType) === 'com.atlassian.confluence.migration' && (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionKey) === 'legacy-content';
+    // Hide the copy button when the extension's manifest node opts out via
+    // `hideCopyButton` (e.g. redactions), or for the legacy content macro.
+    var shouldHideCopyButton = !extensionState.showCopyButton && fg('platform_editor_extension_hide_copy_button') || (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionType) === 'com.atlassian.confluence.migration' && (extensionObj === null || extensionObj === void 0 ? void 0 : extensionObj.node.attrs.extensionKey) === 'legacy-content';
     return {
       title: 'Extension floating controls',
       // Ignored via go/ees005
@@ -420,8 +422,12 @@ export var getToolbarConfig = function getToolbarConfig(_ref2) {
         }]
       }, shouldHideCopyButton && {
         hidden: shouldHideCopyButton
-      }), {
-        type: 'separator'
+      }),
+      // Hide this separator when the copy button is hidden, otherwise it
+      // renders as an orphaned divider before the delete button.
+      {
+        type: 'separator',
+        hidden: shouldHideCopyButton
       }, {
         id: 'editor.extension.delete',
         type: 'button',

package/dist/esm/pm-plugins/update-edit-button.js

@@ -3,7 +3,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { getExtensionModuleNode } from '@atlaskit/editor-common/extensions';
 import { updateState } from '../editor-commands/commands';
 import { getSelectedExtension } from './utils';
-var maybeGetUpdateMethodFromExtensionProvider = /*#__PURE__*/function () {
+var maybeGetExtensionModuleNode = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(view, extensionProvider) {
     var nodeWithPos, _nodeWithPos$node$att, extensionType, extensionKey, extensionModuleNode, newNodeWithPos;
     return _regeneratorRuntime.wrap(function (_context) {
@@ -26,30 +26,32 @@ var maybeGetUpdateMethodFromExtensionProvider = /*#__PURE__*/function () {
             _context.next = 3;
             break;
           }
-          return _context.abrupt("return", extensionModuleNode.update);
+          return _context.abrupt("return", extensionModuleNode);
         case 3:
         case "end":
           return _context.stop();
       }
     }, _callee);
   }));
-  return function maybeGetUpdateMethodFromExtensionProvider(_x, _x2) {
+  return function maybeGetExtensionModuleNode(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();
 export var updateEditButton = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(view, extensionProvider) {
-    var updateMethod, _t;
+    var extensionModuleNode, updateMethod, _t;
     return _regeneratorRuntime.wrap(function (_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
           _context2.prev = 0;
           _context2.next = 1;
-          return maybeGetUpdateMethodFromExtensionProvider(view, extensionProvider);
+          return maybeGetExtensionModuleNode(view, extensionProvider);
         case 1:
-          updateMethod = _context2.sent;
+          extensionModuleNode = _context2.sent;
+          updateMethod = extensionModuleNode === null || extensionModuleNode === void 0 ? void 0 : extensionModuleNode.update;
           updateState({
             showEditButton: !!updateMethod,
+            showCopyButton: !(extensionModuleNode !== null && extensionModuleNode !== void 0 && extensionModuleNode.hideCopyButton),
             updateExtension: updateMethod && Promise.resolve(updateMethod) || undefined
           })(view.state, view.dispatch);
           return _context2.abrupt("return", updateMethod);

package/dist/types/extensionPluginType.d.ts

@@ -32,6 +32,7 @@ export type ExtensionState<T extends Parameters = Parameters> = {
     processParametersBefore?: TransformBefore<T>;
     showContextPanel: boolean;
     showEditButton: boolean;
+    showCopyButton: boolean;
     updateExtension?: Promise<UpdateExtension<T> | void>;
 };
 export type ExtensionAction<T extends Parameters = Parameters> = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-extension",
-	"version": "17.0.4",
+	"version": "17.1.0",
 	"description": "editor-plugin-extension plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -61,7 +61,7 @@
 		"@atlaskit/tabs": "^21.0.0",
 		"@atlaskit/textarea": "^10.0.0",
 		"@atlaskit/textfield": "^10.0.0",
-		"@atlaskit/tmp-editor-statsig": "^145.0.0",
+		"@atlaskit/tmp-editor-statsig": "^146.0.0",
 		"@atlaskit/toggle": "^17.1.0",
 		"@atlaskit/tokens": "^16.6.0",
 		"@atlaskit/tooltip": "^24.0.0",
@@ -75,7 +75,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^118.4.0",
+		"@atlaskit/editor-common": "^118.7.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -121,6 +121,9 @@
 	"platform-feature-flags": {
 		"platform_editor_ai_object_sidebar_injection": {
 			"type": "boolean"
+		},
+		"platform_editor_extension_hide_copy_button": {
+			"type": "boolean"
 		}
 	},
 	"stricter": {