@atlaskit/editor-plugin-extension 19.1.10 → 19.2.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/editor-plugin-extension
 
+## 19.2.0
+
+### Minor Changes
+
+- [`dfe761c33db5a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/dfe761c33db5a) -
+  Add `copyEnabled` and `deleteEnabled` plugin options, both defaulting to `true`, behind
+  `platform_editor_extension_hide_toolbar_actions`. Setting either to `false` hides the matching
+  button on the extension floating toolbar, along with the separators that would otherwise be left
+  orphaned. This mirrors the existing `breakoutEnabled` option and lets a product whose page
+  structure is fixed stop offering actions its document would refuse.
+
+  Inert until that gate is enabled, so the options are a no-op on rollout even for a host that sets
+  them. The gate is read only once a host has opted in — the option check short-circuits before it —
+  so it is not exposed on toolbars it cannot affect.
+
+  `copyEnabled` applies to every extension in the editor; the manifest node's `hideCopyButton`
+  remains the way to hide copy on a single extension type and is not behind this gate. Hosts that
+  set neither option are unaffected in either gate state.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 19.1.10
 
 ### Patch Changes

package/dist/cjs/extensionPlugin.js

@@ -199,6 +199,8 @@ var extensionPlugin = exports.extensionPlugin = function extensionPlugin(_ref) {
     pluginsOptions: {
       floatingToolbar: (0, _toolbar.getToolbarConfig)({
         breakoutEnabled: options.breakoutEnabled,
+        copyEnabled: options.copyEnabled,
+        deleteEnabled: options.deleteEnabled,
         extensionApi: _api,
         getUnsupportedContent: options.getUnsupportedContent
       }),

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

@@ -342,6 +342,10 @@ var createOnClickCopyButton = exports.createOnClickCopyButton = function createO
 var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref2) {
   var _ref2$breakoutEnabled = _ref2.breakoutEnabled,
     breakoutEnabled = _ref2$breakoutEnabled === void 0 ? true : _ref2$breakoutEnabled,
+    _ref2$copyEnabled = _ref2.copyEnabled,
+    copyEnabled = _ref2$copyEnabled === void 0 ? true : _ref2$copyEnabled,
+    _ref2$deleteEnabled = _ref2.deleteEnabled,
+    deleteEnabled = _ref2$deleteEnabled === void 0 ? true : _ref2$deleteEnabled,
     extensionApi = _ref2.extensionApi,
     getUnsupportedContent = _ref2.getUnsupportedContent;
   return function (state, intl) {
@@ -391,9 +395,19 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref
       };
     }
 
-    // Hide the copy button when the extension's manifest node opts out via
+    // Hide the copy button when the host disables it for every extension
+    // (`copyEnabled`), 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';
+    //
+    // The host check is deliberately evaluated before the gate, so the gate is
+    // only read — and so only exposed — for hosts that opted in. Reading it
+    // unconditionally would report an exposure on every extension toolbar in
+    // every product, drowning the rollout metric in traffic it cannot affect.
+    var shouldHideCopyButton = !copyEnabled && (0, _fg.fg)('platform_editor_extension_hide_toolbar_actions') || !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';
+    var shouldHideDeleteButton = !deleteEnabled && (0, _fg.fg)('platform_editor_extension_hide_toolbar_actions');
+    // With both trailing actions gone the toolbar ends after the breakout
+    // options, so the divider that used to introduce them would be an orphan.
+    var hasTrailingActions = !shouldHideCopyButton || !shouldHideDeleteButton;
     return {
       title: 'Extension floating controls',
       // Ignored via go/ees005
@@ -407,7 +421,7 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref
       },
       items: [].concat((0, _toConsumableArray2.default)(editButtonItems), (0, _toConsumableArray2.default)(breakoutItems), [{
         type: 'separator',
-        hidden: editButtonItems.length === 0 && breakoutItems.length === 0
+        hidden: editButtonItems.length === 0 && breakoutItems.length === 0 || !hasTrailingActions
       }, {
         type: 'extensions-placeholder',
         separator: 'end'
@@ -429,12 +443,14 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref
       }, shouldHideCopyButton && {
         hidden: shouldHideCopyButton
       }),
-      // Hide this separator when the copy button is hidden, otherwise it
-      // renders as an orphaned divider before the delete button.
+      // Hide this separator when either neighbour is hidden, otherwise it
+      // renders as an orphaned divider before or after the delete button.
       {
         type: 'separator',
-        hidden: shouldHideCopyButton
-      }, {
+        hidden: shouldHideCopyButton || shouldHideDeleteButton
+      }, _objectSpread(_objectSpread({}, shouldHideDeleteButton && {
+        hidden: true
+      }), {}, {
         id: 'editor.extension.delete',
         type: 'button',
         icon: _delete.default,
@@ -449,7 +465,7 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(_ref
         title: formatMessage(_messages.default.remove),
         tabIndex: null,
         confirmDialog: confirmDialog
-      }]),
+      })]),
       scrollable: true
     };
   };

package/dist/es2019/extensionPlugin.js

@@ -185,6 +185,8 @@ export const extensionPlugin = ({
     pluginsOptions: {
       floatingToolbar: getToolbarConfig({
         breakoutEnabled: options.breakoutEnabled,
+        copyEnabled: options.copyEnabled,
+        deleteEnabled: options.deleteEnabled,
         extensionApi: api,
         getUnsupportedContent: options.getUnsupportedContent
       }),

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

@@ -344,6 +344,8 @@ export const createOnClickCopyButton = ({
 };
 export const getToolbarConfig = ({
   breakoutEnabled = true,
+  copyEnabled = true,
+  deleteEnabled = true,
   extensionApi,
   getUnsupportedContent
 }) => (state, intl) => {
@@ -392,9 +394,19 @@ export const getToolbarConfig = ({
     };
   }
 
-  // Hide the copy button when the extension's manifest node opts out via
+  // Hide the copy button when the host disables it for every extension
+  // (`copyEnabled`), 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';
+  //
+  // The host check is deliberately evaluated before the gate, so the gate is
+  // only read — and so only exposed — for hosts that opted in. Reading it
+  // unconditionally would report an exposure on every extension toolbar in
+  // every product, drowning the rollout metric in traffic it cannot affect.
+  const shouldHideCopyButton = !copyEnabled && fg('platform_editor_extension_hide_toolbar_actions') || !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';
+  const shouldHideDeleteButton = !deleteEnabled && fg('platform_editor_extension_hide_toolbar_actions');
+  // With both trailing actions gone the toolbar ends after the breakout
+  // options, so the divider that used to introduce them would be an orphan.
+  const hasTrailingActions = !shouldHideCopyButton || !shouldHideDeleteButton;
   return {
     title: 'Extension floating controls',
     // Ignored via go/ees005
@@ -404,7 +416,7 @@ export const getToolbarConfig = ({
     onPositionCalculated: (editorView, nextPos) => calculateToolbarPosition(editorView, nextPos, state, extensionObj),
     items: [...editButtonItems, ...breakoutItems, {
       type: 'separator',
-      hidden: editButtonItems.length === 0 && breakoutItems.length === 0
+      hidden: editButtonItems.length === 0 && breakoutItems.length === 0 || !hasTrailingActions
     }, {
       type: 'extensions-placeholder',
       separator: 'end'
@@ -427,12 +439,15 @@ export const getToolbarConfig = ({
         hidden: shouldHideCopyButton
       })
     },
-    // Hide this separator when the copy button is hidden, otherwise it
-    // renders as an orphaned divider before the delete button.
+    // Hide this separator when either neighbour is hidden, otherwise it
+    // renders as an orphaned divider before or after the delete button.
     {
       type: 'separator',
-      hidden: shouldHideCopyButton
+      hidden: shouldHideCopyButton || shouldHideDeleteButton
     }, {
+      ...(shouldHideDeleteButton && {
+        hidden: true
+      }),
       id: 'editor.extension.delete',
       type: 'button',
       icon: DeleteIcon,

package/dist/esm/extensionPlugin.js

@@ -190,6 +190,8 @@ export var extensionPlugin = function extensionPlugin(_ref) {
     pluginsOptions: {
       floatingToolbar: getToolbarConfig({
         breakoutEnabled: options.breakoutEnabled,
+        copyEnabled: options.copyEnabled,
+        deleteEnabled: options.deleteEnabled,
         extensionApi: _api,
         getUnsupportedContent: options.getUnsupportedContent
       }),

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

@@ -336,6 +336,10 @@ export var createOnClickCopyButton = function createOnClickCopyButton(_ref) {
 export var getToolbarConfig = function getToolbarConfig(_ref2) {
   var _ref2$breakoutEnabled = _ref2.breakoutEnabled,
     breakoutEnabled = _ref2$breakoutEnabled === void 0 ? true : _ref2$breakoutEnabled,
+    _ref2$copyEnabled = _ref2.copyEnabled,
+    copyEnabled = _ref2$copyEnabled === void 0 ? true : _ref2$copyEnabled,
+    _ref2$deleteEnabled = _ref2.deleteEnabled,
+    deleteEnabled = _ref2$deleteEnabled === void 0 ? true : _ref2$deleteEnabled,
     extensionApi = _ref2.extensionApi,
     getUnsupportedContent = _ref2.getUnsupportedContent;
   return function (state, intl) {
@@ -385,9 +389,19 @@ export var getToolbarConfig = function getToolbarConfig(_ref2) {
       };
     }
 
-    // Hide the copy button when the extension's manifest node opts out via
+    // Hide the copy button when the host disables it for every extension
+    // (`copyEnabled`), 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';
+    //
+    // The host check is deliberately evaluated before the gate, so the gate is
+    // only read — and so only exposed — for hosts that opted in. Reading it
+    // unconditionally would report an exposure on every extension toolbar in
+    // every product, drowning the rollout metric in traffic it cannot affect.
+    var shouldHideCopyButton = !copyEnabled && fg('platform_editor_extension_hide_toolbar_actions') || !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';
+    var shouldHideDeleteButton = !deleteEnabled && fg('platform_editor_extension_hide_toolbar_actions');
+    // With both trailing actions gone the toolbar ends after the breakout
+    // options, so the divider that used to introduce them would be an orphan.
+    var hasTrailingActions = !shouldHideCopyButton || !shouldHideDeleteButton;
     return {
       title: 'Extension floating controls',
       // Ignored via go/ees005
@@ -401,7 +415,7 @@ export var getToolbarConfig = function getToolbarConfig(_ref2) {
       },
       items: [].concat(_toConsumableArray(editButtonItems), _toConsumableArray(breakoutItems), [{
         type: 'separator',
-        hidden: editButtonItems.length === 0 && breakoutItems.length === 0
+        hidden: editButtonItems.length === 0 && breakoutItems.length === 0 || !hasTrailingActions
       }, {
         type: 'extensions-placeholder',
         separator: 'end'
@@ -423,12 +437,14 @@ export var getToolbarConfig = function getToolbarConfig(_ref2) {
       }, shouldHideCopyButton && {
         hidden: shouldHideCopyButton
       }),
-      // Hide this separator when the copy button is hidden, otherwise it
-      // renders as an orphaned divider before the delete button.
+      // Hide this separator when either neighbour is hidden, otherwise it
+      // renders as an orphaned divider before or after the delete button.
       {
         type: 'separator',
-        hidden: shouldHideCopyButton
-      }, {
+        hidden: shouldHideCopyButton || shouldHideDeleteButton
+      }, _objectSpread(_objectSpread({}, shouldHideDeleteButton && {
+        hidden: true
+      }), {}, {
         id: 'editor.extension.delete',
         type: 'button',
         icon: DeleteIcon,
@@ -443,7 +459,7 @@ export var getToolbarConfig = function getToolbarConfig(_ref2) {
         title: formatMessage(commonMessages.remove),
         tabIndex: null,
         confirmDialog: confirmDialog
-      }]),
+      })]),
       scrollable: true
     };
   };

package/dist/types/extensionPluginType.d.ts

@@ -54,6 +54,24 @@ export interface ExtensionPluginOptions extends LongPressSelectionPluginOptions
     };
     appearance?: EditorAppearance;
     breakoutEnabled?: boolean;
+    /**
+     * Whether the extension floating toolbar offers a copy button. Defaults to
+     * `true`. Set `false` for content whose structure the product fixes, so the
+     * toolbar does not offer an action the document will refuse.
+     *
+     * Gated on `platform_editor_extension_hide_toolbar_actions`: until that gate
+     * is on, setting this has no effect.
+     *
+     * For hiding copy on a single extension type instead, use the manifest node's
+     * `hideCopyButton`, which is not gated on the above.
+     */
+    copyEnabled?: boolean;
+    /**
+     * Whether the extension floating toolbar offers a delete button. Defaults to
+     * `true`, and gated on `platform_editor_extension_hide_toolbar_actions` the
+     * same way `copyEnabled` is.
+     */
+    deleteEnabled?: boolean;
     extensionHandlers?: ExtensionHandlers;
     /**
      * Helps optimize layout shift while rendering by setting minimum heights before the extension content loads.

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

@@ -23,6 +23,8 @@ export declare const createOnClickCopyButton: ({ formatMessage, extensionApi, ex
 }) => Command | undefined;
 interface GetToolbarConfigProps {
     breakoutEnabled: boolean | undefined;
+    copyEnabled?: boolean | undefined;
+    deleteEnabled?: boolean | undefined;
     extensionApi?: PublicPluginAPI<[
         ContextPanelPlugin,
         AnalyticsPlugin,
@@ -33,5 +35,5 @@ interface GetToolbarConfigProps {
     ]> | undefined;
     getUnsupportedContent?: ExtensionPluginOptions['getUnsupportedContent'];
 }
-export declare const getToolbarConfig: ({ breakoutEnabled, extensionApi, getUnsupportedContent, }: GetToolbarConfigProps) => FloatingToolbarHandler;
+export declare const getToolbarConfig: ({ breakoutEnabled, copyEnabled, deleteEnabled, extensionApi, getUnsupportedContent, }: GetToolbarConfigProps) => FloatingToolbarHandler;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-extension",
-	"version": "19.1.10",
+	"version": "19.2.0",
 	"description": "editor-plugin-extension plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -97,6 +97,9 @@
 		},
 		"platform_editor_extension_hide_copy_button": {
 			"type": "boolean"
+		},
+		"platform_editor_extension_hide_toolbar_actions": {
+			"type": "boolean"
 		}
 	}
 }