@atlaskit/editor-plugin-selection-extension 3.7.2 → 4.1.0

package/dist/esm/ui/utils/migrate-selection-extention.js

@@ -0,0 +1,46 @@
+/**
+ *
+ * TODO: ED-29157 - remove once Confluence migrates to `extensionList`API
+ *
+ * NOTES:
+ * - This is temporary until we deprecate SelectionExtension and DynamicSelectionExtension.
+ * - Only supporing SelectionExtension as DynamicSelectionExtension is not being used and will be deprecated.
+ *
+ * Converts a SelectionExtension -> ExtensionMenuItemConfiguration. This allows existing extensions to appear in the new toolbar.
+ */
+export var migrateSelectionExtensionToMenuItem = function migrateSelectionExtensionToMenuItem(extension, api) {
+  if (!extension.icon) {
+    return undefined;
+  }
+
+  // Warning! These are inlined because the onClick handler must have up to date references to selection (which is awkwaradly set during extension.onClick invocation).
+  var getSelection = function getSelection() {
+    var _sharedState$activeEx;
+    var sharedState = api === null || api === void 0 ? void 0 : api.selectionExtension.sharedState.currentState();
+    return sharedState === null || sharedState === void 0 || (_sharedState$activeEx = sharedState.activeExtension) === null || _sharedState$activeEx === void 0 ? void 0 : _sharedState$activeEx.selection;
+  };
+  return {
+    label: extension.name,
+    icon: extension.icon,
+    isDisabled: extension.isDisabled && extension.isDisabled({
+      selection: getSelection(),
+      // pass undefined as no consumers use this
+      selectedNodeAdf: undefined,
+      selectionRanges: undefined
+    }),
+    /**
+     * SelectionExtension supports passing through selection, selectionAdf, and selectionRanges.
+     *
+     * To support backwards compatibility wrap the onClick with these parameters here and let MenuItem invoke onClick using its expected signature.
+     */
+    onClick: function onClick() {
+      var selectionAdf = api === null || api === void 0 ? void 0 : api.selectionExtension.actions.getSelectionAdf();
+      extension.onClick && extension.onClick({
+        selection: getSelection(),
+        selectedNodeAdf: selectionAdf === null || selectionAdf === void 0 ? void 0 : selectionAdf.selectedNodeAdf,
+        selectionRanges: selectionAdf === null || selectionAdf === void 0 ? void 0 : selectionAdf.selectionRanges
+      });
+    },
+    contentComponent: extension.component
+  };
+};

package/dist/types/index.d.ts

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

package/dist/types/pm-plugins/utils/index.d.ts

@@ -1,7 +1,7 @@
 import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { type EditorState } from '@atlaskit/editor-prosemirror/state';
+import { type EditorState, type Selection } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
 import type { SelectionExtensionSelectionInfo } from '../../types';
@@ -17,4 +17,5 @@ export declare const getFragmentInfoFromSelection: (state: EditorState) => {
     selectedNodeAdf: ADFEntity;
 };
 export declare function getSelectionAdfInfo(state: EditorState): SelectionInfo;
+export declare function getSelectionAdfInfoNew(selection: Selection): SelectionInfo;
 export {};

package/dist/types/selectionExtensionPluginType.d.ts

@@ -6,9 +6,10 @@ import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmo
 import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { SelectionToolbarPlugin } from '@atlaskit/editor-plugin-selection-toolbar';
+import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
 import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
 import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
-import type { DynamicSelectionExtension, SelectionAdfResult, InsertAdfAtEndOfDocResult, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo } from './types';
+import type { DynamicSelectionExtension, SelectionAdfResult, InsertAdfAtEndOfDocResult, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo, ExtensionMenuItemConfiguration } from './types';
 export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
     actions: {
         getDocumentFromSelection: () => {
@@ -21,7 +22,7 @@ export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
     commands: {
         clearActiveExtension: () => EditorCommand;
         setActiveExtension: ({ extension, selection, }: {
-            extension: SelectionExtension | DynamicSelectionExtension;
+            extension: SelectionExtension | DynamicSelectionExtension | ExtensionMenuItemConfiguration;
             selection: SelectionExtensionSelectionInfo;
         }) => EditorCommand;
     };
@@ -33,6 +34,7 @@ export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
         OptionalPlugin<UserIntentPlugin>,
         OptionalPlugin<SelectionPlugin>,
         OptionalPlugin<BlockMenuPlugin>,
+        OptionalPlugin<ToolbarPlugin>,
         SelectionToolbarPlugin
     ];
     pluginConfiguration: SelectionExtensionPluginOptions | undefined;

package/dist/types/ui/toolbar-components/MenuItem.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionMenuItemConfiguration } from '../../types';
+type MenuItemProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    extensionMenuItems: ExtensionMenuItemConfiguration[];
+};
+export declare const MenuItem: ({ extensionMenuItems, api }: MenuItemProps) => React.JSX.Element | null;
+export {};

package/dist/types/ui/toolbar-components/ToolbarButton.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionToolbarItemConfiguration } from '../../types';
+type ToolbarButtonProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    config: ExtensionToolbarItemConfiguration;
+};
+export declare const ToolbarButton: ({ api, config }: ToolbarButtonProps) => React.JSX.Element | null;
+export {};

package/dist/types/ui/toolbar-components/ToolbarMenu.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionToolbarItemConfiguration } from '../../types';
+type ToolbarMenuProps = React.PropsWithChildren<{
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    config: ExtensionToolbarItemConfiguration;
+}>;
+export declare const ToolbarMenu: ({ api, config, children }: ToolbarMenuProps) => React.JSX.Element | null;
+export {};

package/dist/types/ui/toolbar-components/register-inline-toolbar.d.ts

@@ -0,0 +1,11 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionConfiguration } from '../../types';
+type RegisterExtensionProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    extension: ExtensionConfiguration;
+    index: number;
+};
+export declare const registerInlineToolbar: ({ api, extension, index }: RegisterExtensionProps) => RegisterComponent[];
+export {};

package/dist/types/ui/toolbar-components.d.ts

@@ -0,0 +1,11 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
+import type { SelectionExtensionPlugin } from '../selectionExtensionPluginType';
+import { type SelectionExtensionPluginOptions } from '../types';
+type GetToolbarComponentsProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    config: SelectionExtensionPluginOptions | undefined;
+};
+type GetToolbarComponents = (props: GetToolbarComponentsProps) => RegisterComponent[];
+export declare const getToolbarComponents: GetToolbarComponents;
+export {};

package/dist/types/ui/utils/migrate-selection-extention.d.ts

@@ -0,0 +1,14 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionMenuItemConfiguration, SelectionExtension } from '../../types';
+/**
+ *
+ * TODO: ED-29157 - remove once Confluence migrates to `extensionList`API
+ *
+ * NOTES:
+ * - This is temporary until we deprecate SelectionExtension and DynamicSelectionExtension.
+ * - Only supporing SelectionExtension as DynamicSelectionExtension is not being used and will be deprecated.
+ *
+ * Converts a SelectionExtension -> ExtensionMenuItemConfiguration. This allows existing extensions to appear in the new toolbar.
+ */
+export declare const migrateSelectionExtensionToMenuItem: (extension: SelectionExtension, api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined) => ExtensionMenuItemConfiguration | undefined;

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

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

package/dist/types-ts4.5/pm-plugins/utils/index.d.ts

@@ -1,7 +1,7 @@
 import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { type EditorState } from '@atlaskit/editor-prosemirror/state';
+import { type EditorState, type Selection } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
 import type { SelectionExtensionSelectionInfo } from '../../types';
@@ -17,4 +17,5 @@ export declare const getFragmentInfoFromSelection: (state: EditorState) => {
     selectedNodeAdf: ADFEntity;
 };
 export declare function getSelectionAdfInfo(state: EditorState): SelectionInfo;
+export declare function getSelectionAdfInfoNew(selection: Selection): SelectionInfo;
 export {};

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

@@ -6,9 +6,10 @@ import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmo
 import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { SelectionToolbarPlugin } from '@atlaskit/editor-plugin-selection-toolbar';
+import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
 import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
 import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
-import type { DynamicSelectionExtension, SelectionAdfResult, InsertAdfAtEndOfDocResult, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo } from './types';
+import type { DynamicSelectionExtension, SelectionAdfResult, InsertAdfAtEndOfDocResult, ReplaceWithAdfResult, SelectionExtension, SelectionExtensionPluginOptions, SelectionExtensionPluginState, SelectionExtensionSelectionInfo, ExtensionMenuItemConfiguration } from './types';
 export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
     actions: {
         getDocumentFromSelection: () => {
@@ -21,7 +22,7 @@ export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
     commands: {
         clearActiveExtension: () => EditorCommand;
         setActiveExtension: ({ extension, selection, }: {
-            extension: SelectionExtension | DynamicSelectionExtension;
+            extension: SelectionExtension | DynamicSelectionExtension | ExtensionMenuItemConfiguration;
             selection: SelectionExtensionSelectionInfo;
         }) => EditorCommand;
     };
@@ -33,6 +34,7 @@ export type SelectionExtensionPlugin = NextEditorPlugin<'selectionExtension', {
         OptionalPlugin<UserIntentPlugin>,
         OptionalPlugin<SelectionPlugin>,
         OptionalPlugin<BlockMenuPlugin>,
+        OptionalPlugin<ToolbarPlugin>,
         SelectionToolbarPlugin
     ];
     pluginConfiguration: SelectionExtensionPluginOptions | undefined;

package/dist/types-ts4.5/ui/toolbar-components/MenuItem.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionMenuItemConfiguration } from '../../types';
+type MenuItemProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    extensionMenuItems: ExtensionMenuItemConfiguration[];
+};
+export declare const MenuItem: ({ extensionMenuItems, api }: MenuItemProps) => React.JSX.Element | null;
+export {};

package/dist/types-ts4.5/ui/toolbar-components/ToolbarButton.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionToolbarItemConfiguration } from '../../types';
+type ToolbarButtonProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    config: ExtensionToolbarItemConfiguration;
+};
+export declare const ToolbarButton: ({ api, config }: ToolbarButtonProps) => React.JSX.Element | null;
+export {};

package/dist/types-ts4.5/ui/toolbar-components/ToolbarMenu.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionToolbarItemConfiguration } from '../../types';
+type ToolbarMenuProps = React.PropsWithChildren<{
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    config: ExtensionToolbarItemConfiguration;
+}>;
+export declare const ToolbarMenu: ({ api, config, children }: ToolbarMenuProps) => React.JSX.Element | null;
+export {};

package/dist/types-ts4.5/ui/toolbar-components/register-inline-toolbar.d.ts

@@ -0,0 +1,11 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionConfiguration } from '../../types';
+type RegisterExtensionProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    extension: ExtensionConfiguration;
+    index: number;
+};
+export declare const registerInlineToolbar: ({ api, extension, index }: RegisterExtensionProps) => RegisterComponent[];
+export {};

package/dist/types-ts4.5/ui/toolbar-components.d.ts

@@ -0,0 +1,11 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
+import type { SelectionExtensionPlugin } from '../selectionExtensionPluginType';
+import { type SelectionExtensionPluginOptions } from '../types';
+type GetToolbarComponentsProps = {
+    api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined;
+    config: SelectionExtensionPluginOptions | undefined;
+};
+type GetToolbarComponents = (props: GetToolbarComponentsProps) => RegisterComponent[];
+export declare const getToolbarComponents: GetToolbarComponents;
+export {};

package/dist/types-ts4.5/ui/utils/migrate-selection-extention.d.ts

@@ -0,0 +1,14 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { SelectionExtensionPlugin } from '../../selectionExtensionPluginType';
+import type { ExtensionMenuItemConfiguration, SelectionExtension } from '../../types';
+/**
+ *
+ * TODO: ED-29157 - remove once Confluence migrates to `extensionList`API
+ *
+ * NOTES:
+ * - This is temporary until we deprecate SelectionExtension and DynamicSelectionExtension.
+ * - Only supporing SelectionExtension as DynamicSelectionExtension is not being used and will be deprecated.
+ *
+ * Converts a SelectionExtension -> ExtensionMenuItemConfiguration. This allows existing extensions to appear in the new toolbar.
+ */
+export declare const migrateSelectionExtensionToMenuItem: (extension: SelectionExtension, api: ExtractInjectionAPI<SelectionExtensionPlugin> | undefined) => ExtensionMenuItemConfiguration | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection-extension",
-	"version": "3.7.2",
+	"version": "4.1.0",
 	"description": "editor-plugin-selection-extension plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,27 +34,28 @@
 	"dependencies": {
 		"@atlaskit/adf-utils": "^19.21.0",
 		"@atlaskit/editor-json-transformer": "^8.27.0",
-		"@atlaskit/editor-plugin-analytics": "^3.0.0",
-		"@atlaskit/editor-plugin-block-menu": "^0.0.20",
-		"@atlaskit/editor-plugin-editor-viewmode": "^5.0.0",
-		"@atlaskit/editor-plugin-primary-toolbar": "^4.1.0",
-		"@atlaskit/editor-plugin-selection-toolbar": "^4.3.0",
-		"@atlaskit/editor-plugin-user-preferences": "^1.2.0",
+		"@atlaskit/editor-plugin-analytics": "^4.0.0",
+		"@atlaskit/editor-plugin-block-menu": "^1.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode": "^6.0.0",
+		"@atlaskit/editor-plugin-primary-toolbar": "^5.0.0",
+		"@atlaskit/editor-plugin-selection-toolbar": "^5.0.0",
+		"@atlaskit/editor-plugin-toolbar": "^1.1.0",
+		"@atlaskit/editor-plugin-user-preferences": "^2.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/editor-tables": "^2.9.0",
-		"@atlaskit/editor-toolbar": "^0.6.0",
+		"@atlaskit/editor-toolbar": "^0.7.0",
 		"@atlaskit/icon": "^28.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^14.12.0",
-		"@atlaskit/tmp-editor-statsig": "^11.12.0",
+		"@atlaskit/tmp-editor-statsig": "^12.2.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.35.0",
+		"@atlaskit/editor-common": "^108.1.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {