@atlaskit/editor-plugin-selection 5.0.0 → 5.0.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-selection
 
+## 5.0.2
+
+### Patch Changes
+
+- [`86e3af7e468bb`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/86e3af7e468bb) -
+  Add experiment to add additional context to selection fragment data.
+- Updated dependencies
+
+## 5.0.1
+
+### Patch Changes
+
+- [`c69b58dc48801`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c69b58dc48801) -
+  Expose getSliceFromSelection
+
 ## 5.0.0
 
 ### Patch Changes

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

@@ -4,11 +4,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getSelectionLocalIds = exports.getSelectionFragment = void 0;
+exports.getSliceFromSelection = 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");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 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; }
@@ -20,7 +21,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
  * @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 getSliceFromSelection = exports.getSliceFromSelection = function getSliceFromSelection(selection) {
   var from = selection.from,
     to = selection.to;
   if (from === to) {
@@ -42,8 +43,9 @@ var getSlice = function getSlice(selection) {
       // 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 finalDepth = (0, _platformFeatureFlags.fg)('platform_editor_expand_selection_context') ? 0 : depth;
+      var start = $from.start(finalDepth);
+      var node = $from.node(finalDepth);
       var content = node.content.cut($from.pos - start, $to.pos - start);
       frag = frag.append(content);
     }
@@ -62,7 +64,7 @@ var getSelectionFragment = exports.getSelectionFragment = function getSelectionF
     if (!selection || !schema || selection.empty) {
       return null;
     }
-    var slice = getSlice(selection);
+    var slice = getSliceFromSelection(selection);
     var content = slice.content;
     var fragment = [];
     content.forEach(function (node) {
@@ -92,7 +94,7 @@ var getSelectionLocalIds = exports.getSelectionLocalIds = function getSelectionL
     } else if (selection.empty) {
       return [selection.$from.parent.attrs.localId];
     }
-    var content = getSlice(selection).content;
+    var content = getSliceFromSelection(selection).content;
     var ids = [];
     content.forEach(function (node) {
       var _node$attrs;

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

@@ -1,6 +1,7 @@
 import { nodeToJSON } from '@atlaskit/editor-json-transformer';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags';
 /**
  * Get the slice of the document corresponding to the selection.
  * This is similar to the prosemirror `selection.content()` - but
@@ -9,7 +10,7 @@ import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state
  * @param selection The selection to get the slice for.
  * @returns The slice of the document corresponding to the selection.
  */
-const getSlice = selection => {
+export const getSliceFromSelection = selection => {
   const {
     from,
     to
@@ -29,8 +30,9 @@ const getSlice = selection => {
     // 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 finalDepth = fg('platform_editor_expand_selection_context') ? 0 : depth;
+    const start = $from.start(finalDepth);
+    const node = $from.node(finalDepth);
     const content = node.content.cut($from.pos - start, $to.pos - start);
     frag = frag.append(content);
   }
@@ -43,7 +45,7 @@ export const getSelectionFragment = api => () => {
   if (!selection || !schema || selection.empty) {
     return null;
   }
-  const slice = getSlice(selection);
+  const slice = getSliceFromSelection(selection);
   const content = slice.content;
   const fragment = [];
   content.forEach(node => {
@@ -72,7 +74,7 @@ export const getSelectionLocalIds = api => () => {
   } else if (selection.empty) {
     return [selection.$from.parent.attrs.localId];
   }
-  const content = getSlice(selection).content;
+  const content = getSliceFromSelection(selection).content;
   const ids = [];
   content.forEach(node => {
     var _node$attrs;

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

@@ -5,6 +5,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 import { nodeToJSON } from '@atlaskit/editor-json-transformer';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags';
 /**
  * Get the slice of the document corresponding to the selection.
  * This is similar to the prosemirror `selection.content()` - but
@@ -13,7 +14,7 @@ import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state
  * @param selection The selection to get the slice for.
  * @returns The slice of the document corresponding to the selection.
  */
-var getSlice = function getSlice(selection) {
+export var getSliceFromSelection = function getSliceFromSelection(selection) {
   var from = selection.from,
     to = selection.to;
   if (from === to) {
@@ -35,8 +36,9 @@ var getSlice = function getSlice(selection) {
       // 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 finalDepth = fg('platform_editor_expand_selection_context') ? 0 : depth;
+      var start = $from.start(finalDepth);
+      var node = $from.node(finalDepth);
       var content = node.content.cut($from.pos - start, $to.pos - start);
       frag = frag.append(content);
     }
@@ -55,7 +57,7 @@ export var getSelectionFragment = function getSelectionFragment(api) {
     if (!selection || !schema || selection.empty) {
       return null;
     }
-    var slice = getSlice(selection);
+    var slice = getSliceFromSelection(selection);
     var content = slice.content;
     var fragment = [];
     content.forEach(function (node) {
@@ -85,7 +87,7 @@ export var getSelectionLocalIds = function getSelectionLocalIds(api) {
     } else if (selection.empty) {
       return [selection.$from.parent.attrs.localId];
     }
-    var content = getSlice(selection).content;
+    var content = getSliceFromSelection(selection).content;
     var ids = [];
     content.forEach(function (node) {
       var _node$attrs;

package/dist/types/editor-actions/index.d.ts

@@ -1,5 +1,16 @@
 import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type JSONNode } from '@atlaskit/editor-json-transformer';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { type Selection } from '@atlaskit/editor-prosemirror/state';
 import type { SelectionPlugin } from '../selectionPluginType';
+/**
+ * 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.
+ */
+export declare const getSliceFromSelection: (selection: Selection) => Fragment;
 export declare const getSelectionFragment: (api: ExtractInjectionAPI<SelectionPlugin> | undefined) => () => JSONNode[] | null;
 export declare const getSelectionLocalIds: (api: ExtractInjectionAPI<SelectionPlugin> | undefined) => () => any[] | null;

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

@@ -1,5 +1,16 @@
 import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type JSONNode } from '@atlaskit/editor-json-transformer';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { type Selection } from '@atlaskit/editor-prosemirror/state';
 import type { SelectionPlugin } from '../selectionPluginType';
+/**
+ * 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.
+ */
+export declare const getSliceFromSelection: (selection: Selection) => Fragment;
 export declare const getSelectionFragment: (api: ExtractInjectionAPI<SelectionPlugin> | undefined) => () => JSONNode[] | null;
 export declare const getSelectionLocalIds: (api: ExtractInjectionAPI<SelectionPlugin> | undefined) => () => any[] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection",
-	"version": "5.0.0",
+	"version": "5.0.2",
 	"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.27.0",
+		"@atlaskit/editor-json-transformer": "^8.29.0",
 		"@atlaskit/editor-plugin-interaction": "^7.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": "^12.9.0",
+		"@atlaskit/tmp-editor-statsig": "^12.27.0",
 		"@atlaskit/tokens": "^6.3.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^109.0.0",
+		"@atlaskit/editor-common": "^109.11.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {
@@ -81,6 +81,9 @@
 		"platform_editor_nested_tables_gap_cursor": {
 			"type": "boolean"
 		},
+		"platform_editor_expand_selection_context": {
+			"type": "boolean"
+		},
 		"platform_editor_fix_right_arrow_bug_list_in_layout": {
 			"type": "boolean"
 		},