@atlaskit/editor-plugin-selection 3.0.7 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-selection
 
+## 3.1.0
+
+### Minor Changes
+
+- [`7b86b50272e47`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b86b50272e47) -
+  Introduce new APIs for selection: getSelectionLocalIds and getSelectionFragment
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.0.7
 
 ### Patch Changes

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

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getSelectionLocalIds = exports.getSelectionFragment = void 0;
+var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var getSelectionFragment = exports.getSelectionFragment = function getSelectionFragment(api) {
+  return function () {
+    var _api$selection$shared, _api$core$sharedState;
+    var selection = api === null || api === void 0 || (_api$selection$shared = api.selection.sharedState) === null || _api$selection$shared === void 0 || (_api$selection$shared = _api$selection$shared.currentState()) === null || _api$selection$shared === void 0 ? void 0 : _api$selection$shared.selection;
+    var schema = api === null || api === void 0 || (_api$core$sharedState = api.core.sharedState.currentState()) === null || _api$core$sharedState === void 0 ? void 0 : _api$core$sharedState.schema;
+    if (!selection || !schema || selection.empty) {
+      return null;
+    }
+    var content = selection === null || selection === void 0 ? void 0 : selection.content().content;
+    var fragment = [];
+    content.forEach(function (node) {
+      fragment.push((0, _editorJsonTransformer.nodeToJSON)(node));
+    });
+    return fragment;
+  };
+};
+var getSelectionLocalIds = exports.getSelectionLocalIds = function getSelectionLocalIds(api) {
+  return function () {
+    var _api$selection$shared2, _selection;
+    var selection = api === null || api === void 0 || (_api$selection$shared2 = api.selection.sharedState) === null || _api$selection$shared2 === void 0 || (_api$selection$shared2 = _api$selection$shared2.currentState()) === null || _api$selection$shared2 === void 0 ? void 0 : _api$selection$shared2.selection;
+    if ((_selection = selection) !== null && _selection !== void 0 && _selection.empty) {
+      // If we have an empty selection the current state might not be correct
+      // We have a hack here to retrieve the current selection - but not dispatch a transaction
+      api === null || api === void 0 || api.core.actions.execute(function (_ref) {
+        var tr = _ref.tr;
+        selection = tr.selection;
+        return null;
+      });
+    }
+    if (!selection) {
+      return null;
+    }
+    if (selection instanceof _state.NodeSelection) {
+      return [selection.node.attrs.localId];
+    } else if (selection.empty) {
+      return [selection.$from.parent.attrs.localId];
+    }
+    var content = selection.content().content;
+    var ids = [];
+    content.forEach(function (node) {
+      var _node$attrs;
+      var localId = (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.localId;
+      if (localId) {
+        ids.push(localId);
+      }
+    });
+    return ids;
+  };
+};

package/dist/cjs/selectionPlugin.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.selectionPlugin = exports.default = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _editorActions = require("./editor-actions");
 var _autoExpandSelectionRangeOnInlineNodeMain = require("./pm-plugins/auto-expand-selection-range-on-inline-node-main");
 var _commands = require("./pm-plugins/commands");
 var _gapCursorKeymap = _interopRequireDefault(require("./pm-plugins/gap-cursor-keymap"));
@@ -65,7 +66,9 @@ var selectionPlugin = exports.selectionPlugin = function selectionPlugin(_ref4)
             tr: state.tr
           }) || state.tr;
         };
-      }
+      },
+      getSelectionFragment: (0, _editorActions.getSelectionFragment)(api),
+      getSelectionLocalIds: (0, _editorActions.getSelectionLocalIds)(api)
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {

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

@@ -0,0 +1,48 @@
+import { nodeToJSON } from '@atlaskit/editor-json-transformer';
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+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;
+  const schema = api === null || api === void 0 ? void 0 : (_api$core$sharedState = api.core.sharedState.currentState()) === null || _api$core$sharedState === void 0 ? void 0 : _api$core$sharedState.schema;
+  if (!selection || !schema || selection.empty) {
+    return null;
+  }
+  const content = selection === null || selection === void 0 ? void 0 : selection.content().content;
+  const fragment = [];
+  content.forEach(node => {
+    fragment.push(nodeToJSON(node));
+  });
+  return fragment;
+};
+export const getSelectionLocalIds = api => () => {
+  var _api$selection$shared3, _api$selection$shared4, _selection;
+  let selection = api === null || api === void 0 ? void 0 : (_api$selection$shared3 = api.selection.sharedState) === null || _api$selection$shared3 === void 0 ? void 0 : (_api$selection$shared4 = _api$selection$shared3.currentState()) === null || _api$selection$shared4 === void 0 ? void 0 : _api$selection$shared4.selection;
+  if ((_selection = selection) !== null && _selection !== void 0 && _selection.empty) {
+    // If we have an empty selection the current state might not be correct
+    // We have a hack here to retrieve the current selection - but not dispatch a transaction
+    api === null || api === void 0 ? void 0 : api.core.actions.execute(({
+      tr
+    }) => {
+      selection = tr.selection;
+      return null;
+    });
+  }
+  if (!selection) {
+    return null;
+  }
+  if (selection instanceof NodeSelection) {
+    return [selection.node.attrs.localId];
+  } else if (selection.empty) {
+    return [selection.$from.parent.attrs.localId];
+  }
+  const content = selection.content().content;
+  const ids = [];
+  content.forEach(node => {
+    var _node$attrs;
+    const localId = (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.localId;
+    if (localId) {
+      ids.push(localId);
+    }
+  });
+  return ids;
+};

package/dist/es2019/selectionPlugin.js

@@ -1,3 +1,4 @@
+import { getSelectionFragment, getSelectionLocalIds } from './editor-actions';
 import { createAutoExpandSelectionRangeOnInlineNodePlugin } from './pm-plugins/auto-expand-selection-range-on-inline-node-main';
 import { selectNearNode } from './pm-plugins/commands';
 import gapCursorKeymapPlugin from './pm-plugins/gap-cursor-keymap';
@@ -53,7 +54,9 @@ export const selectionPlugin = ({
       return selectNearNode(selectionRelativeToNode, selection)({
         tr: state.tr
       }) || state.tr;
-    }
+    },
+    getSelectionFragment: getSelectionFragment(api),
+    getSelectionLocalIds: getSelectionLocalIds(api)
   },
   getSharedState(editorState) {
     if (!editorState) {

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

@@ -0,0 +1,51 @@
+import { nodeToJSON } from '@atlaskit/editor-json-transformer';
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+export var getSelectionFragment = function getSelectionFragment(api) {
+  return function () {
+    var _api$selection$shared, _api$core$sharedState;
+    var selection = api === null || api === void 0 || (_api$selection$shared = api.selection.sharedState) === null || _api$selection$shared === void 0 || (_api$selection$shared = _api$selection$shared.currentState()) === null || _api$selection$shared === void 0 ? void 0 : _api$selection$shared.selection;
+    var schema = api === null || api === void 0 || (_api$core$sharedState = api.core.sharedState.currentState()) === null || _api$core$sharedState === void 0 ? void 0 : _api$core$sharedState.schema;
+    if (!selection || !schema || selection.empty) {
+      return null;
+    }
+    var content = selection === null || selection === void 0 ? void 0 : selection.content().content;
+    var fragment = [];
+    content.forEach(function (node) {
+      fragment.push(nodeToJSON(node));
+    });
+    return fragment;
+  };
+};
+export var getSelectionLocalIds = function getSelectionLocalIds(api) {
+  return function () {
+    var _api$selection$shared2, _selection;
+    var selection = api === null || api === void 0 || (_api$selection$shared2 = api.selection.sharedState) === null || _api$selection$shared2 === void 0 || (_api$selection$shared2 = _api$selection$shared2.currentState()) === null || _api$selection$shared2 === void 0 ? void 0 : _api$selection$shared2.selection;
+    if ((_selection = selection) !== null && _selection !== void 0 && _selection.empty) {
+      // If we have an empty selection the current state might not be correct
+      // We have a hack here to retrieve the current selection - but not dispatch a transaction
+      api === null || api === void 0 || api.core.actions.execute(function (_ref) {
+        var tr = _ref.tr;
+        selection = tr.selection;
+        return null;
+      });
+    }
+    if (!selection) {
+      return null;
+    }
+    if (selection instanceof NodeSelection) {
+      return [selection.node.attrs.localId];
+    } else if (selection.empty) {
+      return [selection.$from.parent.attrs.localId];
+    }
+    var content = selection.content().content;
+    var ids = [];
+    content.forEach(function (node) {
+      var _node$attrs;
+      var localId = (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.localId;
+      if (localId) {
+        ids.push(localId);
+      }
+    });
+    return ids;
+  };
+};

package/dist/esm/selectionPlugin.js

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { getSelectionFragment, getSelectionLocalIds } from './editor-actions';
 import { createAutoExpandSelectionRangeOnInlineNodePlugin } from './pm-plugins/auto-expand-selection-range-on-inline-node-main';
 import { selectNearNode as _selectNearNode } from './pm-plugins/commands';
 import gapCursorKeymapPlugin from './pm-plugins/gap-cursor-keymap';
@@ -58,7 +59,9 @@ export var selectionPlugin = function selectionPlugin(_ref4) {
             tr: state.tr
           }) || state.tr;
         };
-      }
+      },
+      getSelectionFragment: getSelectionFragment(api),
+      getSelectionLocalIds: getSelectionLocalIds(api)
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {

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

@@ -0,0 +1,5 @@
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type JSONNode } from '@atlaskit/editor-json-transformer';
+import type { SelectionPlugin } from '../selectionPluginType';
+export declare const getSelectionFragment: (api: ExtractInjectionAPI<SelectionPlugin> | undefined) => () => JSONNode[] | null;
+export declare const getSelectionLocalIds: (api: ExtractInjectionAPI<SelectionPlugin> | undefined) => () => any[] | null;

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

@@ -1,6 +1,7 @@
 import { RelativeSelectionPos } from '@atlaskit/editor-common/selection';
 export type { SelectionPluginState } from '@atlaskit/editor-common/selection';
 import type { LongPressSelectionPluginOptions } from '@atlaskit/editor-common/types';
+import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare const selectionPluginKey: PluginKey<any>;
@@ -15,6 +16,16 @@ export type SetSelectionRelativeToNode = (props: {
 }) => (state: EditorState) => Transaction;
 export type EditorSelectionAPI = {
     selectNearNode: SetSelectionRelativeToNode;
+    /**
+     * Gets the current selection fragment.
+     * @returns The current selection fragment as an array of JSON nodes.
+     */
+    getSelectionFragment: () => JSONNode[] | null;
+    /**
+     * Gets the current selection local IDs. This includes all local IDs
+     * @returns The current selection local IDs as an array of strings.
+     */
+    getSelectionLocalIds: () => string[] | null;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

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

@@ -0,0 +1,5 @@
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type JSONNode } from '@atlaskit/editor-json-transformer';
+import type { SelectionPlugin } from '../selectionPluginType';
+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/types/index.d.ts

@@ -1,6 +1,7 @@
 import { RelativeSelectionPos } from '@atlaskit/editor-common/selection';
 export type { SelectionPluginState } from '@atlaskit/editor-common/selection';
 import type { LongPressSelectionPluginOptions } from '@atlaskit/editor-common/types';
+import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare const selectionPluginKey: PluginKey<any>;
@@ -15,6 +16,16 @@ export type SetSelectionRelativeToNode = (props: {
 }) => (state: EditorState) => Transaction;
 export type EditorSelectionAPI = {
     selectNearNode: SetSelectionRelativeToNode;
+    /**
+     * Gets the current selection fragment.
+     * @returns The current selection fragment as an array of JSON nodes.
+     */
+    getSelectionFragment: () => JSONNode[] | null;
+    /**
+     * Gets the current selection local IDs. This includes all local IDs
+     * @returns The current selection local IDs as an array of strings.
+     */
+    getSelectionLocalIds: () => string[] | null;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection",
-	"version": "3.0.7",
+	"version": "3.1.0",
 	"description": "Selection plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -19,17 +19,18 @@
 		"singleton": true
 	},
 	"dependencies": {
+		"@atlaskit/editor-json-transformer": "^8.26.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.0.0",
+		"@atlaskit/tmp-editor-statsig": "^11.3.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.25.0",
+		"@atlaskit/editor-common": "^107.26.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {