@atlaskit/editor-common 110.44.0 → 110.44.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-common
 
+## 110.44.1
+
+### Patch Changes
+
+- [`8da61d284b811`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8da61d284b811) -
+  EDITOR-3911 Expand selection to block range
+- Updated dependencies
+
 ## 110.44.0
 
 ### Minor Changes

package/dist/cjs/selection/index.js

@@ -76,6 +76,12 @@ Object.defineProperty(exports, "expandSelectionBounds", {
     return _utils2.expandSelectionBounds;
   }
 });
+Object.defineProperty(exports, "expandSelectionToBlockRange", {
+  enumerable: true,
+  get: function get() {
+    return _utils2.expandSelectionToBlockRange;
+  }
+});
 Object.defineProperty(exports, "expandToBlockRange", {
   enumerable: true,
   get: function get() {

package/dist/cjs/selection/utils.js

@@ -9,7 +9,7 @@ exports.atTheEndOfBlock = atTheEndOfBlock;
 exports.atTheEndOfDoc = atTheEndOfDoc;
 exports.deleteSelectedRange = void 0;
 exports.endPositionOfParent = endPositionOfParent;
-exports.isSelectionAtStartOfNode = exports.isSelectionAtEndOfNode = exports.expandToBlockRange = exports.expandSelectionBounds = void 0;
+exports.isSelectionAtStartOfNode = exports.isSelectionAtEndOfNode = exports.expandToBlockRange = exports.expandSelectionToBlockRange = exports.expandSelectionBounds = void 0;
 exports.startPositionOfParent = startPositionOfParent;
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _utils = require("@atlaskit/editor-tables/utils");
@@ -153,17 +153,29 @@ var deleteSelectedRange = exports.deleteSelectedRange = function deleteSelectedR
   tr.deleteRange(from, to);
   return tr;
 };
+var getDefaultPredicate = function getDefaultPredicate(_ref) {
+  var nodes = _ref.nodes;
+  var requiresFurtherExpansion = new Set([nodes.bulletList, nodes.orderedList, nodes.taskList, nodes.listItem, nodes.taskItem, nodes.tableHeader, nodes.tableRow, nodes.tableCell, nodes.table, nodes.mediaGroup, nodes.mediaSingle]);
+  return function (node) {
+    return !requiresFurtherExpansion.has(node.type);
+  };
+};
 
 /**
  * This expands the given $from and $to resolved positions to the block boundaries
  * spanning all nodes in the range up to the nearest common ancestor.
  *
+ * By default, it will further expand the range when encountering specific node types
+ * that require full block selection (like lists and tables). A custom predicate
+ * can be provided to modify this behavior.
+ *
  * @param $from The resolved start position
  * @param $to The resolved end position
  * @param predicate A predicate to determine if parent node is acceptable (see prosemirror-model/blockRange)
  * @returns An object containing the expanded $from and $to resolved positions
  */
-var expandToBlockRange = exports.expandToBlockRange = function expandToBlockRange($from, $to, predicate) {
+var expandToBlockRange = exports.expandToBlockRange = function expandToBlockRange($from, $to) {
+  var predicate = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : getDefaultPredicate($from.doc.type.schema);
   var range = $from.blockRange($to, predicate);
   if (!range) {
     return {
@@ -173,6 +185,25 @@ var expandToBlockRange = exports.expandToBlockRange = function expandToBlockRang
   }
   return {
     $from: $from.doc.resolve(range.start),
-    $to: $to.doc.resolve(range.end)
+    $to: $to.doc.resolve(range.end),
+    range: range
   };
+};
+
+/**
+ * Expands a given selection to a block range, considering specific node types that require expansion.
+ *
+ * E.g. if the selection starts/ends at list items or table cells, the selection will be expanded
+ * to encompass the entire list or table.
+ *
+ * Used mostly for block menu / drag handle related selections, where we want to ensure the selection
+ * being acted upon covers the entire block range selected by the user.
+ *
+ * @param selection The selection to expand
+ * @returns The expanded selection
+ */
+var expandSelectionToBlockRange = exports.expandSelectionToBlockRange = function expandSelectionToBlockRange(_ref2) {
+  var $from = _ref2.$from,
+    $to = _ref2.$to;
+  return expandToBlockRange($from, $to);
 };

package/dist/es2019/selection/index.js

@@ -12,7 +12,7 @@ export { isIgnored } from './gap-cursor/utils/is-ignored';
 export { isValidTargetNode } from './gap-cursor/utils/is-valid-target-node';
 export { setGapCursorSelection } from './gap-cursor/utils/setGapCursorSelection';
 export { hideCaretModifier, gapCursorStyles } from './gap-cursor/styles';
-export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent, expandToBlockRange } from './utils';
+export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, expandSelectionToBlockRange, expandToBlockRange, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent } from './utils';
 export function getNodeSelectionAnalyticsPayload(selection) {
   if (selection instanceof NodeSelection) {
     return {

package/dist/es2019/selection/utils.js

@@ -152,17 +152,29 @@ export const deleteSelectedRange = (tr, selectionToUse) => {
   tr.deleteRange(from, to);
   return tr;
 };
+const getDefaultPredicate = ({
+  nodes
+}) => {
+  const requiresFurtherExpansion = new Set([nodes.bulletList, nodes.orderedList, nodes.taskList, nodes.listItem, nodes.taskItem, nodes.tableHeader, nodes.tableRow, nodes.tableCell, nodes.table, nodes.mediaGroup, nodes.mediaSingle]);
+  return node => {
+    return !requiresFurtherExpansion.has(node.type);
+  };
+};
 
 /**
  * This expands the given $from and $to resolved positions to the block boundaries
  * spanning all nodes in the range up to the nearest common ancestor.
  *
+ * By default, it will further expand the range when encountering specific node types
+ * that require full block selection (like lists and tables). A custom predicate
+ * can be provided to modify this behavior.
+ *
  * @param $from The resolved start position
  * @param $to The resolved end position
  * @param predicate A predicate to determine if parent node is acceptable (see prosemirror-model/blockRange)
  * @returns An object containing the expanded $from and $to resolved positions
  */
-export const expandToBlockRange = ($from, $to, predicate) => {
+export const expandToBlockRange = ($from, $to, predicate = getDefaultPredicate($from.doc.type.schema)) => {
   const range = $from.blockRange($to, predicate);
   if (!range) {
     return {
@@ -172,6 +184,26 @@ export const expandToBlockRange = ($from, $to, predicate) => {
   }
   return {
     $from: $from.doc.resolve(range.start),
-    $to: $to.doc.resolve(range.end)
+    $to: $to.doc.resolve(range.end),
+    range
   };
+};
+
+/**
+ * Expands a given selection to a block range, considering specific node types that require expansion.
+ *
+ * E.g. if the selection starts/ends at list items or table cells, the selection will be expanded
+ * to encompass the entire list or table.
+ *
+ * Used mostly for block menu / drag handle related selections, where we want to ensure the selection
+ * being acted upon covers the entire block range selected by the user.
+ *
+ * @param selection The selection to expand
+ * @returns The expanded selection
+ */
+export const expandSelectionToBlockRange = ({
+  $from,
+  $to
+}) => {
+  return expandToBlockRange($from, $to);
 };

package/dist/esm/selection/index.js

@@ -12,7 +12,7 @@ export { isIgnored } from './gap-cursor/utils/is-ignored';
 export { isValidTargetNode } from './gap-cursor/utils/is-valid-target-node';
 export { setGapCursorSelection } from './gap-cursor/utils/setGapCursorSelection';
 export { hideCaretModifier, gapCursorStyles } from './gap-cursor/styles';
-export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent, expandToBlockRange } from './utils';
+export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, expandSelectionToBlockRange, expandToBlockRange, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent } from './utils';
 export function getNodeSelectionAnalyticsPayload(selection) {
   if (selection instanceof NodeSelection) {
     return {

package/dist/esm/selection/utils.js

@@ -140,17 +140,29 @@ export var deleteSelectedRange = function deleteSelectedRange(tr, selectionToUse
   tr.deleteRange(from, to);
   return tr;
 };
+var getDefaultPredicate = function getDefaultPredicate(_ref) {
+  var nodes = _ref.nodes;
+  var requiresFurtherExpansion = new Set([nodes.bulletList, nodes.orderedList, nodes.taskList, nodes.listItem, nodes.taskItem, nodes.tableHeader, nodes.tableRow, nodes.tableCell, nodes.table, nodes.mediaGroup, nodes.mediaSingle]);
+  return function (node) {
+    return !requiresFurtherExpansion.has(node.type);
+  };
+};
 
 /**
  * This expands the given $from and $to resolved positions to the block boundaries
  * spanning all nodes in the range up to the nearest common ancestor.
  *
+ * By default, it will further expand the range when encountering specific node types
+ * that require full block selection (like lists and tables). A custom predicate
+ * can be provided to modify this behavior.
+ *
  * @param $from The resolved start position
  * @param $to The resolved end position
  * @param predicate A predicate to determine if parent node is acceptable (see prosemirror-model/blockRange)
  * @returns An object containing the expanded $from and $to resolved positions
  */
-export var expandToBlockRange = function expandToBlockRange($from, $to, predicate) {
+export var expandToBlockRange = function expandToBlockRange($from, $to) {
+  var predicate = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : getDefaultPredicate($from.doc.type.schema);
   var range = $from.blockRange($to, predicate);
   if (!range) {
     return {
@@ -160,6 +172,25 @@ export var expandToBlockRange = function expandToBlockRange($from, $to, predicat
   }
   return {
     $from: $from.doc.resolve(range.start),
-    $to: $to.doc.resolve(range.end)
+    $to: $to.doc.resolve(range.end),
+    range: range
   };
+};
+
+/**
+ * Expands a given selection to a block range, considering specific node types that require expansion.
+ *
+ * E.g. if the selection starts/ends at list items or table cells, the selection will be expanded
+ * to encompass the entire list or table.
+ *
+ * Used mostly for block menu / drag handle related selections, where we want to ensure the selection
+ * being acted upon covers the entire block range selected by the user.
+ *
+ * @param selection The selection to expand
+ * @returns The expanded selection
+ */
+export var expandSelectionToBlockRange = function expandSelectionToBlockRange(_ref2) {
+  var $from = _ref2.$from,
+    $to = _ref2.$to;
+  return expandToBlockRange($from, $to);
 };

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

@@ -11,7 +11,7 @@ export { isIgnored } from './gap-cursor/utils/is-ignored';
 export { isValidTargetNode } from './gap-cursor/utils/is-valid-target-node';
 export { setGapCursorSelection } from './gap-cursor/utils/setGapCursorSelection';
 export { hideCaretModifier, gapCursorStyles } from './gap-cursor/styles';
-export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent, expandToBlockRange, } from './utils';
+export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, expandSelectionToBlockRange, expandToBlockRange, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent, } from './utils';
 export declare function getNodeSelectionAnalyticsPayload(selection: Selection): AnalyticsEventPayload | undefined;
 export declare function getAllSelectionAnalyticsPayload(selection: Selection): AnalyticsEventPayload | undefined;
 export declare function getCellSelectionAnalyticsPayload(state: EditorState): AnalyticsEventPayload | undefined;

package/dist/types/selection/utils.d.ts

@@ -30,6 +30,10 @@ export declare const deleteSelectedRange: (tr: Transaction, selectionToUse?: Sel
  * This expands the given $from and $to resolved positions to the block boundaries
  * spanning all nodes in the range up to the nearest common ancestor.
  *
+ * By default, it will further expand the range when encountering specific node types
+ * that require full block selection (like lists and tables). A custom predicate
+ * can be provided to modify this behavior.
+ *
  * @param $from The resolved start position
  * @param $to The resolved end position
  * @param predicate A predicate to determine if parent node is acceptable (see prosemirror-model/blockRange)
@@ -38,4 +42,30 @@ export declare const deleteSelectedRange: (tr: Transaction, selectionToUse?: Sel
 export declare const expandToBlockRange: ($from: ResolvedPos, $to: ResolvedPos, predicate?: (node: PMNode) => boolean) => {
     $from: ResolvedPos;
     $to: ResolvedPos;
+    range?: undefined;
+} | {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    range: import("prosemirror-model").NodeRange;
+};
+/**
+ * Expands a given selection to a block range, considering specific node types that require expansion.
+ *
+ * E.g. if the selection starts/ends at list items or table cells, the selection will be expanded
+ * to encompass the entire list or table.
+ *
+ * Used mostly for block menu / drag handle related selections, where we want to ensure the selection
+ * being acted upon covers the entire block range selected by the user.
+ *
+ * @param selection The selection to expand
+ * @returns The expanded selection
+ */
+export declare const expandSelectionToBlockRange: ({ $from, $to }: Selection) => {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    range?: undefined;
+} | {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    range: import("prosemirror-model").NodeRange;
 };

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

@@ -11,7 +11,7 @@ export { isIgnored } from './gap-cursor/utils/is-ignored';
 export { isValidTargetNode } from './gap-cursor/utils/is-valid-target-node';
 export { setGapCursorSelection } from './gap-cursor/utils/setGapCursorSelection';
 export { hideCaretModifier, gapCursorStyles } from './gap-cursor/styles';
-export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent, expandToBlockRange, } from './utils';
+export { atTheBeginningOfBlock, atTheBeginningOfDoc, atTheEndOfBlock, atTheEndOfDoc, deleteSelectedRange, endPositionOfParent, expandSelectionBounds, expandSelectionToBlockRange, expandToBlockRange, isSelectionAtEndOfNode, isSelectionAtStartOfNode, startPositionOfParent, } from './utils';
 export declare function getNodeSelectionAnalyticsPayload(selection: Selection): AnalyticsEventPayload | undefined;
 export declare function getAllSelectionAnalyticsPayload(selection: Selection): AnalyticsEventPayload | undefined;
 export declare function getCellSelectionAnalyticsPayload(state: EditorState): AnalyticsEventPayload | undefined;

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

@@ -30,6 +30,10 @@ export declare const deleteSelectedRange: (tr: Transaction, selectionToUse?: Sel
  * This expands the given $from and $to resolved positions to the block boundaries
  * spanning all nodes in the range up to the nearest common ancestor.
  *
+ * By default, it will further expand the range when encountering specific node types
+ * that require full block selection (like lists and tables). A custom predicate
+ * can be provided to modify this behavior.
+ *
  * @param $from The resolved start position
  * @param $to The resolved end position
  * @param predicate A predicate to determine if parent node is acceptable (see prosemirror-model/blockRange)
@@ -38,4 +42,30 @@ export declare const deleteSelectedRange: (tr: Transaction, selectionToUse?: Sel
 export declare const expandToBlockRange: ($from: ResolvedPos, $to: ResolvedPos, predicate?: (node: PMNode) => boolean) => {
     $from: ResolvedPos;
     $to: ResolvedPos;
+    range?: undefined;
+} | {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    range: import("prosemirror-model").NodeRange;
+};
+/**
+ * Expands a given selection to a block range, considering specific node types that require expansion.
+ *
+ * E.g. if the selection starts/ends at list items or table cells, the selection will be expanded
+ * to encompass the entire list or table.
+ *
+ * Used mostly for block menu / drag handle related selections, where we want to ensure the selection
+ * being acted upon covers the entire block range selected by the user.
+ *
+ * @param selection The selection to expand
+ * @returns The expanded selection
+ */
+export declare const expandSelectionToBlockRange: ({ $from, $to }: Selection) => {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    range?: undefined;
+} | {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    range: import("prosemirror-model").NodeRange;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "110.44.0",
+	"version": "110.44.1",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -74,7 +74,7 @@
 		"@atlaskit/prosemirror-history": "^0.2.0",
 		"@atlaskit/react-ufo": "^4.16.0",
 		"@atlaskit/section-message": "^8.10.0",
-		"@atlaskit/smart-card": "^43.15.0",
+		"@atlaskit/smart-card": "^43.16.0",
 		"@atlaskit/smart-user-picker": "^8.5.0",
 		"@atlaskit/spinner": "^19.0.0",
 		"@atlaskit/status": "^3.0.0",