@atlaskit/editor-plugin-selection 3.1.0 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-plugin-selection
 
+## 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
+
+- [`12618b43355c6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/12618b43355c6) -
+  Improve selection APIs by getting their fragment without the parent structure.
+
 ## 3.1.0
 
 ### Minor Changes

package/dist/cjs/editor-actions/index.js

@@ -1,11 +1,59 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getSelectionLocalIds = exports.getSelectionFragment = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
+var _model = require("@atlaskit/editor-prosemirror/model");
 var _state = require("@atlaskit/editor-prosemirror/state");
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+/**
+ * Get the slice of the document corresponding to the selection.
+ * This is similar to the prosemirror `selection.content()` - but
+ * does not include the parents (unless the result is inline)
+ *
+ * @param selection The selection to get the slice for.
+ * @returns The slice of the document corresponding to the selection.
+ */
+var getSlice = function getSlice(selection) {
+  var from = selection.from,
+    to = selection.to;
+  if (from === to) {
+    return _model.Fragment.empty;
+  }
+  var frag = _model.Fragment.empty;
+  var sortedRanges = (0, _toConsumableArray2.default)(selection.ranges.slice()).sort(function (a, b) {
+    return a.$from.pos - b.$from.pos;
+  });
+  var _iterator = _createForOfIteratorHelper(sortedRanges),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var range = _step.value;
+      var $from = range.$from,
+        $to = range.$to;
+      var _to = $to.pos;
+      var depth =
+      // If we're in a text selection, and share the parent node across the anchor->head
+      // make the depth the parent node
+      selection instanceof _state.TextSelection && $from.parent.eq($to.parent) ? Math.max(0, $from.sharedDepth(_to) - 1) : $from.sharedDepth(_to);
+      var start = $from.start(depth);
+      var node = $from.node(depth);
+      var content = node.content.cut($from.pos - start, $to.pos - start);
+      frag = frag.append(content);
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return frag;
+};
 var getSelectionFragment = exports.getSelectionFragment = function getSelectionFragment(api) {
   return function () {
     var _api$selection$shared, _api$core$sharedState;
@@ -14,7 +62,8 @@ var getSelectionFragment = exports.getSelectionFragment = function getSelectionF
     if (!selection || !schema || selection.empty) {
       return null;
     }
-    var content = selection === null || selection === void 0 ? void 0 : selection.content().content;
+    var slice = getSlice(selection);
+    var content = slice.content;
     var fragment = [];
     content.forEach(function (node) {
       fragment.push((0, _editorJsonTransformer.nodeToJSON)(node));
@@ -43,7 +92,7 @@ var getSelectionLocalIds = exports.getSelectionLocalIds = function getSelectionL
     } else if (selection.empty) {
       return [selection.$from.parent.attrs.localId];
     }
-    var content = selection.content().content;
+    var content = getSlice(selection).content;
     var ids = [];
     content.forEach(function (node) {
       var _node$attrs;

package/dist/es2019/editor-actions/index.js

@@ -1,5 +1,41 @@
 import { nodeToJSON } from '@atlaskit/editor-json-transformer';
-import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Get the slice of the document corresponding to the selection.
+ * This is similar to the prosemirror `selection.content()` - but
+ * does not include the parents (unless the result is inline)
+ *
+ * @param selection The selection to get the slice for.
+ * @returns The slice of the document corresponding to the selection.
+ */
+const getSlice = selection => {
+  const {
+    from,
+    to
+  } = selection;
+  if (from === to) {
+    return Fragment.empty;
+  }
+  let frag = Fragment.empty;
+  const sortedRanges = [...selection.ranges.slice()].sort((a, b) => a.$from.pos - b.$from.pos);
+  for (const range of sortedRanges) {
+    const {
+      $from,
+      $to
+    } = range;
+    const to = $to.pos;
+    const depth =
+    // If we're in a text selection, and share the parent node across the anchor->head
+    // make the depth the parent node
+    selection instanceof TextSelection && $from.parent.eq($to.parent) ? Math.max(0, $from.sharedDepth(to) - 1) : $from.sharedDepth(to);
+    const start = $from.start(depth);
+    const node = $from.node(depth);
+    const content = node.content.cut($from.pos - start, $to.pos - start);
+    frag = frag.append(content);
+  }
+  return frag;
+};
 export const getSelectionFragment = api => () => {
   var _api$selection$shared, _api$selection$shared2, _api$core$sharedState;
   const selection = api === null || api === void 0 ? void 0 : (_api$selection$shared = api.selection.sharedState) === null || _api$selection$shared === void 0 ? void 0 : (_api$selection$shared2 = _api$selection$shared.currentState()) === null || _api$selection$shared2 === void 0 ? void 0 : _api$selection$shared2.selection;
@@ -7,7 +43,8 @@ export const getSelectionFragment = api => () => {
   if (!selection || !schema || selection.empty) {
     return null;
   }
-  const content = selection === null || selection === void 0 ? void 0 : selection.content().content;
+  const slice = getSlice(selection);
+  const content = slice.content;
   const fragment = [];
   content.forEach(node => {
     fragment.push(nodeToJSON(node));
@@ -35,7 +72,7 @@ export const getSelectionLocalIds = api => () => {
   } else if (selection.empty) {
     return [selection.$from.parent.attrs.localId];
   }
-  const content = selection.content().content;
+  const content = getSlice(selection).content;
   const ids = [];
   content.forEach(node => {
     var _node$attrs;

package/dist/esm/editor-actions/index.js

@@ -1,5 +1,52 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 import { nodeToJSON } from '@atlaskit/editor-json-transformer';
-import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Get the slice of the document corresponding to the selection.
+ * This is similar to the prosemirror `selection.content()` - but
+ * does not include the parents (unless the result is inline)
+ *
+ * @param selection The selection to get the slice for.
+ * @returns The slice of the document corresponding to the selection.
+ */
+var getSlice = function getSlice(selection) {
+  var from = selection.from,
+    to = selection.to;
+  if (from === to) {
+    return Fragment.empty;
+  }
+  var frag = Fragment.empty;
+  var sortedRanges = _toConsumableArray(selection.ranges.slice()).sort(function (a, b) {
+    return a.$from.pos - b.$from.pos;
+  });
+  var _iterator = _createForOfIteratorHelper(sortedRanges),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var range = _step.value;
+      var $from = range.$from,
+        $to = range.$to;
+      var _to = $to.pos;
+      var depth =
+      // If we're in a text selection, and share the parent node across the anchor->head
+      // make the depth the parent node
+      selection instanceof TextSelection && $from.parent.eq($to.parent) ? Math.max(0, $from.sharedDepth(_to) - 1) : $from.sharedDepth(_to);
+      var start = $from.start(depth);
+      var node = $from.node(depth);
+      var content = node.content.cut($from.pos - start, $to.pos - start);
+      frag = frag.append(content);
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return frag;
+};
 export var getSelectionFragment = function getSelectionFragment(api) {
   return function () {
     var _api$selection$shared, _api$core$sharedState;
@@ -8,7 +55,8 @@ export var getSelectionFragment = function getSelectionFragment(api) {
     if (!selection || !schema || selection.empty) {
       return null;
     }
-    var content = selection === null || selection === void 0 ? void 0 : selection.content().content;
+    var slice = getSlice(selection);
+    var content = slice.content;
     var fragment = [];
     content.forEach(function (node) {
       fragment.push(nodeToJSON(node));
@@ -37,7 +85,7 @@ export var getSelectionLocalIds = function getSelectionLocalIds(api) {
     } else if (selection.empty) {
       return [selection.$from.parent.attrs.localId];
     }
-    var content = selection.content().content;
+    var content = getSlice(selection).content;
     var ids = [];
     content.forEach(function (node) {
       var _node$attrs;

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

@@ -14,18 +14,28 @@ export type SetSelectionRelativeToNode = (props: {
     selectionRelativeToNode?: RelativeSelectionPos;
     selection?: Selection | null;
 }) => (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;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

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

@@ -14,18 +14,28 @@ export type SetSelectionRelativeToNode = (props: {
     selectionRelativeToNode?: RelativeSelectionPos;
     selection?: Selection | null;
 }) => (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;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection",
-	"version": "3.1.0",
+	"version": "3.2.0",
 	"description": "Selection plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -19,18 +19,18 @@
 		"singleton": true
 	},
 	"dependencies": {
-		"@atlaskit/editor-json-transformer": "^8.26.0",
+		"@atlaskit/editor-json-transformer": "^8.27.0",
 		"@atlaskit/editor-plugin-interaction": "^5.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@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.26.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {