@atlaskit/editor-plugin-selection 3.1.1 → 3.2.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-selection
 
+## 3.2.1
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
+## 3.2.0
+
+### Minor Changes
+
+- [`22c631389088c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/22c631389088c) -
+  Add option to provide custom selection to get\* selection actions
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.1.1
 
 ### Patch Changes

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

@@ -6,12 +6,12 @@ export declare enum SelectionActionTypes {
     SET_RELATIVE_SELECTION = "SET_RELATIVE_SELECTION"
 }
 export interface SetDecorations {
-    type: SelectionActionTypes.SET_DECORATIONS;
     decorationSet: DecorationSet;
     selection: Selection;
+    type: SelectionActionTypes.SET_DECORATIONS;
 }
 export interface SetRelativeSelection {
-    type: SelectionActionTypes.SET_RELATIVE_SELECTION;
     selectionRelativeToNode?: RelativeSelectionPos;
+    type: SelectionActionTypes.SET_RELATIVE_SELECTION;
 }
 export type SelectionAction = SetDecorations | SetRelativeSelection;

package/dist/types/pm-plugins/gap-cursor/actions.d.ts

@@ -10,14 +10,14 @@ export declare const setSelectionTopLevelBlocks: (tr: Transaction, event: React.
     left: number;
     top: number;
 }) => {
-    pos: number;
     inside: number;
+    pos: number;
 } | null | void, editorFocused: boolean) => void;
 export declare const setCursorForTopLevelBlocks: (event: React.MouseEvent<any>, editorRef: HTMLElement, posAtCoords: (coords: {
     left: number;
     top: number;
 }) => {
-    pos: number;
     inside: number;
+    pos: number;
 } | null | void, editorFocused: boolean) => Command;
 export declare const hasGapCursorPlugin: (state: EditorState) => boolean;

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

@@ -20,8 +20,8 @@ export declare const getNodesToDecorateFromSelection: (selection: Selection, doc
     pos: number;
 }[];
 export declare function shouldRecalcDecorations({ oldEditorState, newEditorState, }: {
-    oldEditorState: EditorState;
     newEditorState: EditorState;
+    oldEditorState: EditorState;
 }): boolean;
 export declare const isSelectableContainerNode: (node?: PmNode | null) => boolean;
 export declare const isSelectableChildNode: (node?: PmNode | null) => boolean;

package/dist/types/selectionPluginType.d.ts

@@ -3,13 +3,13 @@ import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/
 import type { InteractionPlugin } from '@atlaskit/editor-plugin-interaction';
 import type { EditorSelectionAPI, SelectionPluginOptions } from './types';
 export type SelectionPlugin = NextEditorPlugin<'selection', {
-    pluginConfiguration: SelectionPluginOptions | undefined;
     actions: EditorSelectionAPI;
-    dependencies: [OptionalPlugin<InteractionPlugin>];
     commands: {
-        displayGapCursor: (toggle: boolean) => EditorCommand;
         clearManualSelection: () => EditorCommand;
+        displayGapCursor: (toggle: boolean) => EditorCommand;
         setManualSelection: (anchor: number, head: number) => EditorCommand;
     };
+    dependencies: [OptionalPlugin<InteractionPlugin>];
+    pluginConfiguration: SelectionPluginOptions | undefined;
     sharedState: SelectionSharedState;
 }>;

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

@@ -11,21 +11,31 @@ export declare enum SelectionDirection {
     After = 1
 }
 export type SetSelectionRelativeToNode = (props: {
-    selectionRelativeToNode?: RelativeSelectionPos;
     selection?: Selection | null;
+    selectionRelativeToNode?: RelativeSelectionPos;
 }) => (state: EditorState) => Transaction;
+type SelectionUtilityOptions = {
+    /**
+     * Use a specific selection rather than the current which is the default
+     */
+    selection?: Selection;
+};
 export type EditorSelectionAPI = {
-    selectNearNode: SetSelectionRelativeToNode;
     /**
      * Gets the current selection fragment.
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection fragment as an array of JSON nodes.
      */
-    getSelectionFragment: () => JSONNode[] | null;
+    getSelectionFragment: (props?: SelectionUtilityOptions) => JSONNode[] | null;
     /**
      * Gets the current selection local IDs. This includes all local IDs
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection local IDs as an array of strings.
      */
-    getSelectionLocalIds: () => string[] | null;
+    getSelectionLocalIds: (props?: SelectionUtilityOptions) => string[] | null;
+    selectNearNode: SetSelectionRelativeToNode;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

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

@@ -6,12 +6,12 @@ export declare enum SelectionActionTypes {
     SET_RELATIVE_SELECTION = "SET_RELATIVE_SELECTION"
 }
 export interface SetDecorations {
-    type: SelectionActionTypes.SET_DECORATIONS;
     decorationSet: DecorationSet;
     selection: Selection;
+    type: SelectionActionTypes.SET_DECORATIONS;
 }
 export interface SetRelativeSelection {
-    type: SelectionActionTypes.SET_RELATIVE_SELECTION;
     selectionRelativeToNode?: RelativeSelectionPos;
+    type: SelectionActionTypes.SET_RELATIVE_SELECTION;
 }
 export type SelectionAction = SetDecorations | SetRelativeSelection;

package/dist/types-ts4.5/pm-plugins/gap-cursor/actions.d.ts

@@ -10,14 +10,14 @@ export declare const setSelectionTopLevelBlocks: (tr: Transaction, event: React.
     left: number;
     top: number;
 }) => {
-    pos: number;
     inside: number;
+    pos: number;
 } | null | void, editorFocused: boolean) => void;
 export declare const setCursorForTopLevelBlocks: (event: React.MouseEvent<any>, editorRef: HTMLElement, posAtCoords: (coords: {
     left: number;
     top: number;
 }) => {
-    pos: number;
     inside: number;
+    pos: number;
 } | null | void, editorFocused: boolean) => Command;
 export declare const hasGapCursorPlugin: (state: EditorState) => boolean;

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

@@ -20,8 +20,8 @@ export declare const getNodesToDecorateFromSelection: (selection: Selection, doc
     pos: number;
 }[];
 export declare function shouldRecalcDecorations({ oldEditorState, newEditorState, }: {
-    oldEditorState: EditorState;
     newEditorState: EditorState;
+    oldEditorState: EditorState;
 }): boolean;
 export declare const isSelectableContainerNode: (node?: PmNode | null) => boolean;
 export declare const isSelectableChildNode: (node?: PmNode | null) => boolean;

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

@@ -3,15 +3,15 @@ import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/
 import type { InteractionPlugin } from '@atlaskit/editor-plugin-interaction';
 import type { EditorSelectionAPI, SelectionPluginOptions } from './types';
 export type SelectionPlugin = NextEditorPlugin<'selection', {
-    pluginConfiguration: SelectionPluginOptions | undefined;
     actions: EditorSelectionAPI;
-    dependencies: [
-        OptionalPlugin<InteractionPlugin>
-    ];
     commands: {
-        displayGapCursor: (toggle: boolean) => EditorCommand;
         clearManualSelection: () => EditorCommand;
+        displayGapCursor: (toggle: boolean) => EditorCommand;
         setManualSelection: (anchor: number, head: number) => EditorCommand;
     };
+    dependencies: [
+        OptionalPlugin<InteractionPlugin>
+    ];
+    pluginConfiguration: SelectionPluginOptions | undefined;
     sharedState: SelectionSharedState;
 }>;

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

@@ -11,21 +11,31 @@ export declare enum SelectionDirection {
     After = 1
 }
 export type SetSelectionRelativeToNode = (props: {
-    selectionRelativeToNode?: RelativeSelectionPos;
     selection?: Selection | null;
+    selectionRelativeToNode?: RelativeSelectionPos;
 }) => (state: EditorState) => Transaction;
+type SelectionUtilityOptions = {
+    /**
+     * Use a specific selection rather than the current which is the default
+     */
+    selection?: Selection;
+};
 export type EditorSelectionAPI = {
-    selectNearNode: SetSelectionRelativeToNode;
     /**
      * Gets the current selection fragment.
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection fragment as an array of JSON nodes.
      */
-    getSelectionFragment: () => JSONNode[] | null;
+    getSelectionFragment: (props?: SelectionUtilityOptions) => JSONNode[] | null;
     /**
      * Gets the current selection local IDs. This includes all local IDs
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection local IDs as an array of strings.
      */
-    getSelectionLocalIds: () => string[] | null;
+    getSelectionLocalIds: (props?: SelectionUtilityOptions) => string[] | null;
+    selectNearNode: SetSelectionRelativeToNode;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection",
-	"version": "3.1.1",
+	"version": "3.2.1",
 	"description": "Selection plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -25,12 +25,12 @@
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.27.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {