@atlaskit/editor-plugin-selection 2.1.8 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-selection
 
+## 2.2.0
+
+### Minor Changes
+
+- [#147781](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/147781)
+  [`154676654d6ce`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/154676654d6ce) -
+  [ED-27777] Remove selection decorator until interaction for live pages
+
+## 2.1.9
+
+### Patch Changes
+
+- [#142352](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/142352)
+  [`05903fde6d94d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/05903fde6d94d) -
+  Internal change to use Compiled variant of `@atlaskit/primitives`.
+- Updated dependencies
+
 ## 2.1.8
 
 ### Patch Changes

package/dist/cjs/pm-plugins/gap-cursor/actions.js

@@ -23,8 +23,10 @@ var shouldSkipGapCursor = exports.shouldSkipGapCursor = function shouldSkipGapCu
       }
       return (0, _utils.isPositionNearTableRow)($pos, schema, 'before') || (0, _utils3.isTextBlockNearPos)(doc, schema, $pos, -1) || (0, _utils.isNodeBeforeMediaNode)($pos, state);
     case _direction.Direction.DOWN:
-      return (0, _selection.atTheEndOfDoc)(state) || (0, _utils3.isTextBlockNearPos)(doc, schema, $pos, 1) || (0, _utils.isPositionNearTableRow)($pos, schema, 'after') || ((_$pos$nodeBefore = $pos.nodeBefore) === null || _$pos$nodeBefore === void 0 ? void 0 : _$pos$nodeBefore.type.name) === 'text' && !$pos.nodeAfter // end of a paragraph
-      ;
+      return (
+        // end of a paragraph
+        (0, _selection.atTheEndOfDoc)(state) || (0, _utils3.isTextBlockNearPos)(doc, schema, $pos, 1) || (0, _utils.isPositionNearTableRow)($pos, schema, 'after') || ((_$pos$nodeBefore = $pos.nodeBefore) === null || _$pos$nodeBefore === void 0 ? void 0 : _$pos$nodeBefore.type.name) === 'text' && !$pos.nodeAfter
+      );
     default:
       return false;
   }

package/dist/cjs/pm-plugins/selection-main.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.getInitialState = exports.createPlugin = void 0;
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _view = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _types = require("../types");
 var _actions = require("./actions");
@@ -20,8 +22,8 @@ var getInitialState = exports.getInitialState = function getInitialState(state)
     selection: state.selection
   };
 };
-var createPlugin = exports.createPlugin = function createPlugin(dispatch, dispatchAnalyticsEvent) {
-  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+var createPlugin = exports.createPlugin = function createPlugin(api, dispatch, dispatchAnalyticsEvent) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   return new _safePlugin.SafePlugin({
     key: _types.selectionPluginKey,
     state: (0, _pluginFactory.createPluginState)(dispatch, getInitialState),
@@ -68,6 +70,17 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, dispat
     props: {
       createSelectionBetween: _createSelectionBetween.onCreateSelectionBetween,
       decorations: function decorations(state) {
+        var _api$interaction;
+        // TODO: ED-27865 - This has to be explicitly checked against false to ensure that
+        // we don't change behaviour when hasHadInteraction is undefined.
+        var hasHadInteraction = (api === null || api === void 0 || (_api$interaction = api.interaction) === null || _api$interaction === void 0 || (_api$interaction = _api$interaction.sharedState.currentState()) === null || _api$interaction === void 0 ? void 0 : _api$interaction.hasHadInteraction) !== false;
+
+        // Do not show selection decorations for live pages where the user has not
+        // interacted with the page. We do not show cursor until interaction and we do not
+        // want to show selections either.
+        if (options.__livePage && !hasHadInteraction && (0, _platformFeatureFlags.fg)('platform_editor_no_selection_decorations')) {
+          return _view.DecorationSet.empty;
+        }
         return (0, _pluginFactory.getPluginState)(state).decorationSet;
       },
       handleDOMEvents: {

package/dist/cjs/selectionPlugin.js

@@ -47,7 +47,8 @@ var setManualSelection = function setManualSelection(anchor, head) {
   };
 };
 var selectionPlugin = exports.selectionPlugin = function selectionPlugin(_ref4) {
-  var options = _ref4.config;
+  var api = _ref4.api,
+    options = _ref4.config;
   return {
     name: 'selection',
     commands: {
@@ -82,7 +83,7 @@ var selectionPlugin = exports.selectionPlugin = function selectionPlugin(_ref4)
         plugin: function plugin(_ref6) {
           var dispatch = _ref6.dispatch,
             dispatchAnalyticsEvent = _ref6.dispatchAnalyticsEvent;
-          return (0, _selectionMain.createPlugin)(dispatch, dispatchAnalyticsEvent, options);
+          return (0, _selectionMain.createPlugin)(api, dispatch, dispatchAnalyticsEvent, options);
         }
       }, {
         name: 'selectionKeymap',

package/dist/es2019/pm-plugins/gap-cursor/actions.js

@@ -19,8 +19,10 @@ export const shouldSkipGapCursor = (direction, state, $pos) => {
       }
       return isPositionNearTableRow($pos, schema, 'before') || isTextBlockNearPos(doc, schema, $pos, -1) || isNodeBeforeMediaNode($pos, state);
     case Direction.DOWN:
-      return atTheEndOfDoc(state) || isTextBlockNearPos(doc, schema, $pos, 1) || isPositionNearTableRow($pos, schema, 'after') || ((_$pos$nodeBefore = $pos.nodeBefore) === null || _$pos$nodeBefore === void 0 ? void 0 : _$pos$nodeBefore.type.name) === 'text' && !$pos.nodeAfter // end of a paragraph
-      ;
+      return (
+        // end of a paragraph
+        atTheEndOfDoc(state) || isTextBlockNearPos(doc, schema, $pos, 1) || isPositionNearTableRow($pos, schema, 'after') || ((_$pos$nodeBefore = $pos.nodeBefore) === null || _$pos$nodeBefore === void 0 ? void 0 : _$pos$nodeBefore.type.name) === 'text' && !$pos.nodeAfter
+      );
     default:
       return false;
   }

package/dist/es2019/pm-plugins/selection-main.js

@@ -1,5 +1,7 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { selectionPluginKey } from '../types';
 import { SelectionActionTypes } from './actions';
@@ -12,7 +14,7 @@ export const getInitialState = state => ({
   decorationSet: getDecorations(state.tr),
   selection: state.selection
 });
-export const createPlugin = (dispatch, dispatchAnalyticsEvent, options = {}) => {
+export const createPlugin = (api, dispatch, dispatchAnalyticsEvent, options = {}) => {
   return new SafePlugin({
     key: selectionPluginKey,
     state: createPluginState(dispatch, getInitialState),
@@ -61,6 +63,17 @@ export const createPlugin = (dispatch, dispatchAnalyticsEvent, options = {}) =>
     props: {
       createSelectionBetween: onCreateSelectionBetween,
       decorations(state) {
+        var _api$interaction, _api$interaction$shar;
+        // TODO: ED-27865 - This has to be explicitly checked against false to ensure that
+        // we don't change behaviour when hasHadInteraction is undefined.
+        const hasHadInteraction = (api === null || api === void 0 ? void 0 : (_api$interaction = api.interaction) === null || _api$interaction === void 0 ? void 0 : (_api$interaction$shar = _api$interaction.sharedState.currentState()) === null || _api$interaction$shar === void 0 ? void 0 : _api$interaction$shar.hasHadInteraction) !== false;
+
+        // Do not show selection decorations for live pages where the user has not
+        // interacted with the page. We do not show cursor until interaction and we do not
+        // want to show selections either.
+        if (options.__livePage && !hasHadInteraction && fg('platform_editor_no_selection_decorations')) {
+          return DecorationSet.empty;
+        }
         return getPluginState(state).decorationSet;
       },
       handleDOMEvents: {

package/dist/es2019/selectionPlugin.js

@@ -36,6 +36,7 @@ const setManualSelection = (anchor, head) => ({
   });
 };
 export const selectionPlugin = ({
+  api,
   config: options
 }) => ({
   name: 'selection',
@@ -70,7 +71,7 @@ export const selectionPlugin = ({
       plugin: ({
         dispatch,
         dispatchAnalyticsEvent
-      }) => createPlugin(dispatch, dispatchAnalyticsEvent, options)
+      }) => createPlugin(api, dispatch, dispatchAnalyticsEvent, options)
     }, {
       name: 'selectionKeymap',
       plugin: selectionKeymapPlugin

package/dist/esm/pm-plugins/gap-cursor/actions.js

@@ -17,8 +17,10 @@ export var shouldSkipGapCursor = function shouldSkipGapCursor(direction, state,
       }
       return isPositionNearTableRow($pos, schema, 'before') || isTextBlockNearPos(doc, schema, $pos, -1) || isNodeBeforeMediaNode($pos, state);
     case Direction.DOWN:
-      return atTheEndOfDoc(state) || isTextBlockNearPos(doc, schema, $pos, 1) || isPositionNearTableRow($pos, schema, 'after') || ((_$pos$nodeBefore = $pos.nodeBefore) === null || _$pos$nodeBefore === void 0 ? void 0 : _$pos$nodeBefore.type.name) === 'text' && !$pos.nodeAfter // end of a paragraph
-      ;
+      return (
+        // end of a paragraph
+        atTheEndOfDoc(state) || isTextBlockNearPos(doc, schema, $pos, 1) || isPositionNearTableRow($pos, schema, 'after') || ((_$pos$nodeBefore = $pos.nodeBefore) === null || _$pos$nodeBefore === void 0 ? void 0 : _$pos$nodeBefore.type.name) === 'text' && !$pos.nodeAfter
+      );
     default:
       return false;
   }

package/dist/esm/pm-plugins/selection-main.js

@@ -1,5 +1,7 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { selectionPluginKey } from '../types';
 import { SelectionActionTypes } from './actions';
@@ -14,8 +16,8 @@ export var getInitialState = function getInitialState(state) {
     selection: state.selection
   };
 };
-export var createPlugin = function createPlugin(dispatch, dispatchAnalyticsEvent) {
-  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+export var createPlugin = function createPlugin(api, dispatch, dispatchAnalyticsEvent) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   return new SafePlugin({
     key: selectionPluginKey,
     state: createPluginState(dispatch, getInitialState),
@@ -62,6 +64,17 @@ export var createPlugin = function createPlugin(dispatch, dispatchAnalyticsEvent
     props: {
       createSelectionBetween: onCreateSelectionBetween,
       decorations: function decorations(state) {
+        var _api$interaction;
+        // TODO: ED-27865 - This has to be explicitly checked against false to ensure that
+        // we don't change behaviour when hasHadInteraction is undefined.
+        var hasHadInteraction = (api === null || api === void 0 || (_api$interaction = api.interaction) === null || _api$interaction === void 0 || (_api$interaction = _api$interaction.sharedState.currentState()) === null || _api$interaction === void 0 ? void 0 : _api$interaction.hasHadInteraction) !== false;
+
+        // Do not show selection decorations for live pages where the user has not
+        // interacted with the page. We do not show cursor until interaction and we do not
+        // want to show selections either.
+        if (options.__livePage && !hasHadInteraction && fg('platform_editor_no_selection_decorations')) {
+          return DecorationSet.empty;
+        }
         return getPluginState(state).decorationSet;
       },
       handleDOMEvents: {

package/dist/esm/selectionPlugin.js

@@ -40,7 +40,8 @@ var setManualSelection = function setManualSelection(anchor, head) {
   };
 };
 export var selectionPlugin = function selectionPlugin(_ref4) {
-  var options = _ref4.config;
+  var api = _ref4.api,
+    options = _ref4.config;
   return {
     name: 'selection',
     commands: {
@@ -75,7 +76,7 @@ export var selectionPlugin = function selectionPlugin(_ref4) {
         plugin: function plugin(_ref6) {
           var dispatch = _ref6.dispatch,
             dispatchAnalyticsEvent = _ref6.dispatchAnalyticsEvent;
-          return createPlugin(dispatch, dispatchAnalyticsEvent, options);
+          return createPlugin(api, dispatch, dispatchAnalyticsEvent, options);
         }
       }, {
         name: 'selectionKeymap',

package/dist/types/pm-plugins/selection-main.d.ts

@@ -2,7 +2,9 @@ import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { SelectionPluginState } from '@atlaskit/editor-common/selection';
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { SelectionPlugin } from '../selectionPluginType';
 import type { SelectionPluginOptions } from '../types';
 export declare const getInitialState: (state: EditorState) => SelectionPluginState;
-export declare const createPlugin: (dispatch: Dispatch, dispatchAnalyticsEvent: DispatchAnalyticsEvent, options?: SelectionPluginOptions) => SafePlugin<SelectionPluginState>;
+export declare const createPlugin: (api: ExtractInjectionAPI<SelectionPlugin> | undefined, dispatch: Dispatch, dispatchAnalyticsEvent: DispatchAnalyticsEvent, options?: SelectionPluginOptions) => SafePlugin<SelectionPluginState>;

package/dist/types/selectionPluginType.d.ts

@@ -1,9 +1,11 @@
 import type { SelectionSharedState } from '@atlaskit/editor-common/selection';
-import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+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;

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

@@ -2,7 +2,9 @@ import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { SelectionPluginState } from '@atlaskit/editor-common/selection';
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { SelectionPlugin } from '../selectionPluginType';
 import type { SelectionPluginOptions } from '../types';
 export declare const getInitialState: (state: EditorState) => SelectionPluginState;
-export declare const createPlugin: (dispatch: Dispatch, dispatchAnalyticsEvent: DispatchAnalyticsEvent, options?: SelectionPluginOptions) => SafePlugin<SelectionPluginState>;
+export declare const createPlugin: (api: ExtractInjectionAPI<SelectionPlugin> | undefined, dispatch: Dispatch, dispatchAnalyticsEvent: DispatchAnalyticsEvent, options?: SelectionPluginOptions) => SafePlugin<SelectionPluginState>;

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

@@ -1,9 +1,13 @@
 import type { SelectionSharedState } from '@atlaskit/editor-common/selection';
-import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+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;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection",
-	"version": "2.1.8",
+	"version": "2.2.0",
 	"description": "Selection plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -20,13 +20,14 @@
 		"runReact18": true
 	},
 	"dependencies": {
-		"@atlaskit/editor-common": "^103.4.0",
+		"@atlaskit/editor-common": "^103.22.0",
+		"@atlaskit/editor-plugin-interaction": "^1.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.6.0",
-		"@atlaskit/tokens": "^4.7.0",
+		"@atlaskit/tmp-editor-statsig": "^4.15.0",
+		"@atlaskit/tokens": "^4.8.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -92,6 +93,9 @@
 		},
 		"platform_editor_nested_tables_gap_cursor": {
 			"type": "boolean"
+		},
+		"platform_editor_no_selection_decorations": {
+			"type": "boolean"
 		}
 	}
 }