@atlaskit/editor-plugin-selection-extension 3.4.0 → 3.4.2

package/dist/esm/ui/selectionToolbar.js

@@ -1,7 +1,33 @@
-export var selectionToolbar = function selectionToolbar(options) {
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import React from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { getToolbarItemExtensions } from './extensions';
+import { LegacyExtensionToolbarItem } from './LegacyToolbarComponent';
+export var selectionToolbar = function selectionToolbar(_ref) {
+  var overflowOptions = _ref.overflowOptions,
+    _ref$extensionList = _ref.extensionList,
+    extensionList = _ref$extensionList === void 0 ? [] : _ref$extensionList;
+  var inlineToolbarItemExtensions = fg('platform_editor_selection_extension_api_v2') ? getToolbarItemExtensions(extensionList, 'inlineToolbar') : [];
   return {
-    isToolbarAbove: true,
-    items: [{
+    items: [].concat(_toConsumableArray(inlineToolbarItemExtensions.length ? [{
+      type: 'separator',
+      fullHeight: true,
+      supportsViewMode: true
+    }].concat(_toConsumableArray(inlineToolbarItemExtensions.map(function (_ref2) {
+      var getToolbarItem = _ref2.getToolbarItem,
+        getMenuItems = _ref2.getMenuItems;
+      return {
+        type: 'custom',
+        render: function render() {
+          return /*#__PURE__*/React.createElement(LegacyExtensionToolbarItem, {
+            toolbarItem: getToolbarItem(),
+            getMenuItems: getMenuItems
+          });
+        },
+        fallback: [],
+        supportsViewMode: true
+      };
+    }))) : []), [{
       type: 'separator',
       fullHeight: true,
       supportsViewMode: true
@@ -9,8 +35,8 @@ export var selectionToolbar = function selectionToolbar(options) {
       type: 'overflow-dropdown',
       dropdownWidth: 240,
       supportsViewMode: true,
-      options: options
-    }],
+      options: overflowOptions
+    }]),
     rank: -6
   };
 };

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
 export { selectionExtensionPlugin } from './selectionExtensionPlugin';
 export type { SelectionExtensionPlugin } from './selectionExtensionPluginType';
-export type { SelectionExtensionComponentProps, SelectionExtensionPluginOptions, SelectionExtension, LinkInsertionOption, SelectionExtensionPluginState, SelectionExtensionSelectionInfo, DynamicSelectionExtension, ReplaceWithAdfResult, InsertAdfAtEndOfDocResult, } from './types';
+export type { BlockMenuExtensionConfiguration, DynamicSelectionExtension, ExtensionConfiguration, ExtensionMenuItemConfiguration, ExtensionToolbarItemConfiguration, InsertAdfAtEndOfDocResult, LinkInsertionOption, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionComponentProps, SelectionExtensionConfig, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo, ToolbarExtensionConfiguration, } from './types';

package/dist/types/selectionExtensionPluginType.d.ts

@@ -2,13 +2,17 @@ import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
+import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { SelectionToolbarPlugin } from '@atlaskit/editor-plugin-selection-toolbar';
+import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
 import type { DynamicSelectionExtension, InsertAdfAtEndOfDocResult, LinkInsertionOption, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo } from './types';
 export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
     pluginConfiguration: SelectionExtensionPluginOptions | undefined;
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>,
         OptionalPlugin<EditorViewModePlugin>,
+        OptionalPlugin<PrimaryToolbarPlugin>,
+        OptionalPlugin<UserPreferencesPlugin>,
         SelectionToolbarPlugin
     ];
     sharedState: SelectionExtensionPluginState | null;

package/dist/types/types/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
-import { type MenuItem } from '@atlaskit/editor-common/ui-menu';
+import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
 import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 export type MenuItemsType = Array<{
@@ -61,6 +61,7 @@ type SelectionExtensionModes = ViewMode;
 export type SelectionExtensionPluginOptions = {
     pageModes?: SelectionExtensionModes | SelectionExtensionModes[];
     extensions?: SelectionExtensions;
+    extensionList?: ExtensionConfiguration[];
 };
 /**
  * @private
@@ -74,6 +75,10 @@ export type SelectionExtensionCoords = {
     top: number;
     bottom: number;
 };
+export type BoundingBoxOffset = {
+    top: number;
+    bottom: number;
+};
 export type InsertPosition = {
     pointer: string;
     from?: number;
@@ -117,4 +122,39 @@ export type ReplaceWithAdfResult = {
 export type InsertAdfAtEndOfDocResult = {
     status: 'success' | 'failed';
 };
+export type ExtensionSource = 'first-party' | 'external';
+export type ExtensionConfiguration = {
+    key: string;
+    source: ExtensionSource;
+    inlineToolbar?: ToolbarExtensionConfiguration;
+    primaryToolbar?: ToolbarExtensionConfiguration;
+    blockMenu?: BlockMenuExtensionConfiguration;
+};
+export type GetToolbarItemFn = () => ExtensionToolbarItemConfiguration;
+export type GetMenuItemsFn = () => ExtensionMenuItemConfiguration[];
+export type ToolbarExtensionConfiguration = {
+    getToolbarItem?: GetToolbarItemFn;
+    getMenuItems?: GetMenuItemsFn;
+};
+export type BlockMenuExtensionConfiguration = {
+    getMenuItems?: GetMenuItemsFn;
+};
+export type ExtensionToolbarItemConfiguration = {
+    icon: React.ComponentType<React.PropsWithChildren<{
+        label: string;
+    }>>;
+    tooltip: string;
+    isDisabled?: boolean;
+    onClick?: () => void;
+    label?: string;
+};
+export type ExtensionMenuItemConfiguration = {
+    label: string;
+    icon: React.ComponentType<React.PropsWithChildren<{
+        label: string;
+    }>>;
+    onClick?: () => void;
+    isDisabled?: boolean;
+    contentComponent?: React.ComponentType<SelectionExtensionComponentProps>;
+};
 export {};

package/dist/types/ui/LegacyToolbarComponent.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import type { ExtensionToolbarItemConfiguration, GetMenuItemsFn, GetToolbarItemFn } from '../types';
+export type ToolbarItemExtension = {
+    getToolbarItem: GetToolbarItemFn;
+    getMenuItems?: GetMenuItemsFn;
+};
+type LegacyPrimaryToolbarComponentProps = {
+    primaryToolbarItemExtensions: ToolbarItemExtension[];
+};
+export declare const LegacyPrimaryToolbarComponent: ({ primaryToolbarItemExtensions, }: LegacyPrimaryToolbarComponentProps) => React.JSX.Element;
+type LegacyExtensionToolbarItemProps = {
+    toolbarItem: ExtensionToolbarItemConfiguration;
+    getMenuItems?: GetMenuItemsFn;
+};
+export declare const LegacyExtensionToolbarItem: ({ toolbarItem, getMenuItems, }: LegacyExtensionToolbarItemProps) => React.JSX.Element;
+export {};

package/dist/types/ui/extensions.d.ts

@@ -0,0 +1,27 @@
+import type { ExtensionConfiguration, ExtensionSource, GetMenuItemsFn, GetToolbarItemFn, SelectionExtensionConfig } from '../types';
+export type ToolbarItemExtension = {
+    getToolbarItem: GetToolbarItemFn;
+    getMenuItems?: GetMenuItemsFn;
+};
+/**
+ * From the full list of extensions, extract only those that have a toolbar item configuration
+ * for the specified type (either 'primaryToolbar' or 'inlineToolbar').
+ *
+ * @param extensionList - List of all extensions
+ * @param toolbarType - Type of toolbar ('primaryToolbar' or 'inlineToolbar')
+ * @returns Array of ToolbarItemExtension objects
+ * @example
+ */
+export declare const getToolbarItemExtensions: (extensionList: ExtensionConfiguration[], toolbarType: 'primaryToolbar' | 'inlineToolbar') => ToolbarItemExtension[];
+/**
+ * From the full list of extensions, extract only those that have a menu item configuration
+ * for the specified source (either 'first-party' or 'external').
+ *
+ * Map each to the legacy format for SelectionExtensionConfig.
+ *
+ * @param extensionList - List of all extensions
+ * @param targetSource - Source of the extensions ('first-party' or 'external')
+ * @returns Array of SelectionExtensionConfig objects
+ * @example
+ */
+export declare const getMenuItemExtensions: (extensionList: ExtensionConfiguration[], targetSource: ExtensionSource) => SelectionExtensionConfig[];

package/dist/types/ui/getBoundingBoxFromSelection.d.ts

@@ -1,11 +1,12 @@
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { SelectionExtensionCoords } from '../types';
+import type { SelectionExtensionCoords, BoundingBoxOffset } from '../types';
 /**
  * Calculates the bounding box coordinates of a text selection within an editor view.
  *
  * @param view - The editor view instance.
  * @param from - The starting position of the selection.
  * @param to - The ending position of the selection.
+ * @param offset - Optional offset to adjust the top and bottom coordinates of the bounding box.`
  * @returns An object containing the top, left, bottom, and right coordinates of the bounding box.
  */
-export declare const getBoundingBoxFromSelection: (view: EditorView, from: number, to: number) => SelectionExtensionCoords;
+export declare const getBoundingBoxFromSelection: (view: EditorView, from: number, to: number, offset?: BoundingBoxOffset) => SelectionExtensionCoords;

package/dist/types/ui/selectionToolbar.d.ts

@@ -1,18 +1,8 @@
-import { type Command, type FloatingToolbarOverflowDropdownOptions } from '@atlaskit/editor-common/types';
-export declare const selectionToolbar: (options: FloatingToolbarOverflowDropdownOptions<Command>) => {
-    isToolbarAbove: boolean;
-    items: ({
-        type: "separator";
-        fullHeight: boolean;
-        supportsViewMode: boolean;
-        dropdownWidth?: undefined;
-        options?: undefined;
-    } | {
-        type: "overflow-dropdown";
-        dropdownWidth: number;
-        supportsViewMode: boolean;
-        options: FloatingToolbarOverflowDropdownOptions<Command>;
-        fullHeight?: undefined;
-    })[];
-    rank: number;
+import type { Command, FloatingToolbarOverflowDropdownOptions, SelectionToolbarGroup } from '@atlaskit/editor-common/types';
+import type { ExtensionConfiguration } from '../types';
+type SelectionToolbarOptions = {
+    overflowOptions: FloatingToolbarOverflowDropdownOptions<Command>;
+    extensionList?: ExtensionConfiguration[];
 };
+export declare const selectionToolbar: ({ overflowOptions, extensionList, }: SelectionToolbarOptions) => SelectionToolbarGroup;
+export {};

package/dist/types-ts4.5/index.d.ts

@@ -1,3 +1,3 @@
 export { selectionExtensionPlugin } from './selectionExtensionPlugin';
 export type { SelectionExtensionPlugin } from './selectionExtensionPluginType';
-export type { SelectionExtensionComponentProps, SelectionExtensionPluginOptions, SelectionExtension, LinkInsertionOption, SelectionExtensionPluginState, SelectionExtensionSelectionInfo, DynamicSelectionExtension, ReplaceWithAdfResult, InsertAdfAtEndOfDocResult, } from './types';
+export type { BlockMenuExtensionConfiguration, DynamicSelectionExtension, ExtensionConfiguration, ExtensionMenuItemConfiguration, ExtensionToolbarItemConfiguration, InsertAdfAtEndOfDocResult, LinkInsertionOption, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionComponentProps, SelectionExtensionConfig, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo, ToolbarExtensionConfiguration, } from './types';

package/dist/types-ts4.5/selectionExtensionPluginType.d.ts

@@ -2,13 +2,17 @@ import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
+import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { SelectionToolbarPlugin } from '@atlaskit/editor-plugin-selection-toolbar';
+import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
 import type { DynamicSelectionExtension, InsertAdfAtEndOfDocResult, LinkInsertionOption, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo } from './types';
 export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
     pluginConfiguration: SelectionExtensionPluginOptions | undefined;
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>,
         OptionalPlugin<EditorViewModePlugin>,
+        OptionalPlugin<PrimaryToolbarPlugin>,
+        OptionalPlugin<UserPreferencesPlugin>,
         SelectionToolbarPlugin
     ];
     sharedState: SelectionExtensionPluginState | null;

package/dist/types-ts4.5/types/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
-import { type MenuItem } from '@atlaskit/editor-common/ui-menu';
+import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
 import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 export type MenuItemsType = Array<{
@@ -61,6 +61,7 @@ type SelectionExtensionModes = ViewMode;
 export type SelectionExtensionPluginOptions = {
     pageModes?: SelectionExtensionModes | SelectionExtensionModes[];
     extensions?: SelectionExtensions;
+    extensionList?: ExtensionConfiguration[];
 };
 /**
  * @private
@@ -74,6 +75,10 @@ export type SelectionExtensionCoords = {
     top: number;
     bottom: number;
 };
+export type BoundingBoxOffset = {
+    top: number;
+    bottom: number;
+};
 export type InsertPosition = {
     pointer: string;
     from?: number;
@@ -117,4 +122,39 @@ export type ReplaceWithAdfResult = {
 export type InsertAdfAtEndOfDocResult = {
     status: 'success' | 'failed';
 };
+export type ExtensionSource = 'first-party' | 'external';
+export type ExtensionConfiguration = {
+    key: string;
+    source: ExtensionSource;
+    inlineToolbar?: ToolbarExtensionConfiguration;
+    primaryToolbar?: ToolbarExtensionConfiguration;
+    blockMenu?: BlockMenuExtensionConfiguration;
+};
+export type GetToolbarItemFn = () => ExtensionToolbarItemConfiguration;
+export type GetMenuItemsFn = () => ExtensionMenuItemConfiguration[];
+export type ToolbarExtensionConfiguration = {
+    getToolbarItem?: GetToolbarItemFn;
+    getMenuItems?: GetMenuItemsFn;
+};
+export type BlockMenuExtensionConfiguration = {
+    getMenuItems?: GetMenuItemsFn;
+};
+export type ExtensionToolbarItemConfiguration = {
+    icon: React.ComponentType<React.PropsWithChildren<{
+        label: string;
+    }>>;
+    tooltip: string;
+    isDisabled?: boolean;
+    onClick?: () => void;
+    label?: string;
+};
+export type ExtensionMenuItemConfiguration = {
+    label: string;
+    icon: React.ComponentType<React.PropsWithChildren<{
+        label: string;
+    }>>;
+    onClick?: () => void;
+    isDisabled?: boolean;
+    contentComponent?: React.ComponentType<SelectionExtensionComponentProps>;
+};
 export {};

package/dist/types-ts4.5/ui/LegacyToolbarComponent.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import type { ExtensionToolbarItemConfiguration, GetMenuItemsFn, GetToolbarItemFn } from '../types';
+export type ToolbarItemExtension = {
+    getToolbarItem: GetToolbarItemFn;
+    getMenuItems?: GetMenuItemsFn;
+};
+type LegacyPrimaryToolbarComponentProps = {
+    primaryToolbarItemExtensions: ToolbarItemExtension[];
+};
+export declare const LegacyPrimaryToolbarComponent: ({ primaryToolbarItemExtensions, }: LegacyPrimaryToolbarComponentProps) => React.JSX.Element;
+type LegacyExtensionToolbarItemProps = {
+    toolbarItem: ExtensionToolbarItemConfiguration;
+    getMenuItems?: GetMenuItemsFn;
+};
+export declare const LegacyExtensionToolbarItem: ({ toolbarItem, getMenuItems, }: LegacyExtensionToolbarItemProps) => React.JSX.Element;
+export {};

package/dist/types-ts4.5/ui/extensions.d.ts

@@ -0,0 +1,27 @@
+import type { ExtensionConfiguration, ExtensionSource, GetMenuItemsFn, GetToolbarItemFn, SelectionExtensionConfig } from '../types';
+export type ToolbarItemExtension = {
+    getToolbarItem: GetToolbarItemFn;
+    getMenuItems?: GetMenuItemsFn;
+};
+/**
+ * From the full list of extensions, extract only those that have a toolbar item configuration
+ * for the specified type (either 'primaryToolbar' or 'inlineToolbar').
+ *
+ * @param extensionList - List of all extensions
+ * @param toolbarType - Type of toolbar ('primaryToolbar' or 'inlineToolbar')
+ * @returns Array of ToolbarItemExtension objects
+ * @example
+ */
+export declare const getToolbarItemExtensions: (extensionList: ExtensionConfiguration[], toolbarType: 'primaryToolbar' | 'inlineToolbar') => ToolbarItemExtension[];
+/**
+ * From the full list of extensions, extract only those that have a menu item configuration
+ * for the specified source (either 'first-party' or 'external').
+ *
+ * Map each to the legacy format for SelectionExtensionConfig.
+ *
+ * @param extensionList - List of all extensions
+ * @param targetSource - Source of the extensions ('first-party' or 'external')
+ * @returns Array of SelectionExtensionConfig objects
+ * @example
+ */
+export declare const getMenuItemExtensions: (extensionList: ExtensionConfiguration[], targetSource: ExtensionSource) => SelectionExtensionConfig[];

package/dist/types-ts4.5/ui/getBoundingBoxFromSelection.d.ts

@@ -1,11 +1,12 @@
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { SelectionExtensionCoords } from '../types';
+import type { SelectionExtensionCoords, BoundingBoxOffset } from '../types';
 /**
  * Calculates the bounding box coordinates of a text selection within an editor view.
  *
  * @param view - The editor view instance.
  * @param from - The starting position of the selection.
  * @param to - The ending position of the selection.
+ * @param offset - Optional offset to adjust the top and bottom coordinates of the bounding box.`
  * @returns An object containing the top, left, bottom, and right coordinates of the bounding box.
  */
-export declare const getBoundingBoxFromSelection: (view: EditorView, from: number, to: number) => SelectionExtensionCoords;
+export declare const getBoundingBoxFromSelection: (view: EditorView, from: number, to: number, offset?: BoundingBoxOffset) => SelectionExtensionCoords;

package/dist/types-ts4.5/ui/selectionToolbar.d.ts

@@ -1,18 +1,8 @@
-import { type Command, type FloatingToolbarOverflowDropdownOptions } from '@atlaskit/editor-common/types';
-export declare const selectionToolbar: (options: FloatingToolbarOverflowDropdownOptions<Command>) => {
-    isToolbarAbove: boolean;
-    items: ({
-        type: "separator";
-        fullHeight: boolean;
-        supportsViewMode: boolean;
-        dropdownWidth?: undefined;
-        options?: undefined;
-    } | {
-        type: "overflow-dropdown";
-        dropdownWidth: number;
-        supportsViewMode: boolean;
-        options: FloatingToolbarOverflowDropdownOptions<Command>;
-        fullHeight?: undefined;
-    })[];
-    rank: number;
+import type { Command, FloatingToolbarOverflowDropdownOptions, SelectionToolbarGroup } from '@atlaskit/editor-common/types';
+import type { ExtensionConfiguration } from '../types';
+type SelectionToolbarOptions = {
+    overflowOptions: FloatingToolbarOverflowDropdownOptions<Command>;
+    extensionList?: ExtensionConfiguration[];
 };
+export declare const selectionToolbar: ({ overflowOptions, extensionList, }: SelectionToolbarOptions) => SelectionToolbarGroup;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection-extension",
-	"version": "3.4.0",
+	"version": "3.4.2",
 	"description": "editor-plugin-selection-extension plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,23 +36,26 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-utils": "^19.20.0",
-		"@atlaskit/editor-json-transformer": "^8.24.0",
+		"@atlaskit/editor-json-transformer": "^8.25.0",
 		"@atlaskit/editor-plugin-analytics": "^3.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^5.0.0",
+		"@atlaskit/editor-plugin-primary-toolbar": "^4.1.0",
 		"@atlaskit/editor-plugin-selection-toolbar": "^4.2.0",
+		"@atlaskit/editor-plugin-user-preferences": "^1.2.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/editor-shared-styles": "^3.5.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/icon": "^27.8.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^14.11.0",
-		"@atlaskit/tmp-editor-statsig": "^9.17.0",
+		"@atlaskit/tmp-editor-statsig": "^9.20.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21",
 		"react-intl-next": "npm:react-intl@^5.18.1",
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.12.0",
+		"@atlaskit/editor-common": "^107.16.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -109,6 +112,9 @@
 		},
 		"platform_editor_selection_extension_api_v2": {
 			"type": "boolean"
+		},
+		"platform_editor_use_preferences_plugin": {
+			"type": "boolean"
 		}
 	}
 }