@atlaskit/editor-plugin-collab-edit 4.0.1 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 4.0.2
+
+### Patch Changes
+
+- [#183342](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/183342)
+  [`2929809030e36`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2929809030e36) -
+  Ensures telepointer selection will continue to show while using AI.
+
 ## 4.0.1
 
 ### Patch Changes

package/dist/cjs/pm-plugins/events/send-transaction.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.sendTransaction = void 0;
 var _steps = require("@atlaskit/adf-schema/steps");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _actions = require("../actions");
 var _pluginKey = require("../main/plugin-key");
@@ -47,14 +48,33 @@ var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
       sessionId = currentPluginState.sessionId;
     var selectionChanged = !oldEditorState.selection.eq(newEditorState.selection);
     var participantsChanged = prevActiveParticipants && !prevActiveParticipants.eq(activeParticipants);
-    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged && !hideTelecursorOnLoad)) {
-      var selection = (0, _actions.getSendableSelection)(newEditorState.selection);
-      var message = {
-        type: 'telepointer',
-        selection: selection,
-        sessionId: sessionId
-      };
-      provider.sendMessage(message);
+    if ((0, _platformFeatureFlags.fg)('platform_editor_ai_in_document_streaming')) {
+      // uiEvent is standard metdata (docs: https://prosemirror.net/docs/ref/#state.Transaction)
+      var isPaste = (docChangedTransaction === null || docChangedTransaction === void 0 ? void 0 : docChangedTransaction.getMeta('uiEvent')) === 'paste';
+      if (sessionId && viewMode === 'edit' && (
+      // Broadcast the position if the selection has changed, and the doc hasn't changed (it is mapped
+      // by the receiver).
+      // If we're pasting content though make an exception (as doc has changed)
+      // as on a ranged selection it results in not clearing the ranged selection after the paste
+      selectionChanged && (!docChangedTransaction || isPaste) || participantsChanged && !hideTelecursorOnLoad)) {
+        var selection = (0, _actions.getSendableSelection)(newEditorState.selection);
+        var message = {
+          type: 'telepointer',
+          selection: selection,
+          sessionId: sessionId
+        };
+        provider.sendMessage(message);
+      }
+    } else {
+      if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged && !hideTelecursorOnLoad)) {
+        var _selection = (0, _actions.getSendableSelection)(newEditorState.selection);
+        var _message = {
+          type: 'telepointer',
+          selection: _selection,
+          sessionId: sessionId
+        };
+        provider.sendMessage(_message);
+      }
     }
   };
 };

package/dist/cjs/pm-plugins/main/plugin-state.js

@@ -183,25 +183,26 @@ var PluginState = exports.PluginState = /*#__PURE__*/function () {
         } catch (err) {
           this.onError(err);
         }
-
-        // Remove any selection decoration within the change range,
-        // takes care of the issue when after pasting we end up with a dead selection
-        tr.steps.filter(_utils.isReplaceStep).forEach(function (s) {
-          // Ignored via go/ees005
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          var _ref2 = s,
-            from = _ref2.from,
-            to = _ref2.to;
-          // Ignored via go/ees005
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          _this.decorationSet.find(from, to).forEach(function (deco) {
-            // `type` is private, `from` and `to` are public in latest version
-            // `from` != `to` means it's a selection
-            if (deco.from !== deco.to) {
-              remove.push(deco);
-            }
+        if (!(0, _platformFeatureFlags.fg)('platform_editor_ai_in_document_streaming')) {
+          // Remove any selection decoration within the change range,
+          // takes care of the issue when after pasting we end up with a dead selection
+          tr.steps.filter(_utils.isReplaceStep).forEach(function (s) {
+            // Ignored via go/ees005
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            var _ref2 = s,
+              from = _ref2.from,
+              to = _ref2.to;
+            // Ignored via go/ees005
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            _this.decorationSet.find(from, to).forEach(function (deco) {
+              // `type` is private, `from` and `to` are public in latest version
+              // `from` != `to` means it's a selection
+              if (deco.from !== deco.to) {
+                remove.push(deco);
+              }
+            });
           });
-        });
+        }
       }
       var selection = tr.selection;
       // Ignored via go/ees005

package/dist/cjs/pm-plugins/utils.js

@@ -19,18 +19,12 @@ var _view = require("@atlaskit/editor-prosemirror/view");
 var _editorSharedStyles = require("@atlaskit/editor-shared-styles");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _findPointers = exports._findPointers = function _findPointers(id, decorations) {
-  return decorations.find()
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  .reduce(function (arr, deco) {
+  return decorations.find().reduce(function (arr, deco) {
     return deco.spec.pointer.sessionId === id ? arr.concat(deco) : arr;
   }, []);
 };
 var findPointers = exports.findPointers = function findPointers(id, decorations) {
-  return decorations.find().reduce(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function (arr, deco) {
+  return decorations.find().reduce(function (arr, deco) {
     return deco.spec.pointer.presenceId === id ? arr.concat(deco) : arr;
   }, []);
 };
@@ -52,10 +46,7 @@ var createTelepointers = exports.createTelepointers = function createTelepointer
   var color = avatarColor.index.toString();
   if (isSelection) {
     var className = "telepointer color-".concat(color, " telepointer-selection");
-    decorations.push(
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    _view.Decoration.inline(from, to, {
+    decorations.push(_view.Decoration.inline(from, to, {
       class: className,
       'data-initial': initial
     }, {
@@ -95,28 +86,19 @@ var createTelepointers = exports.createTelepointers = function createTelepointer
     initialEl.style.backgroundColor = avatarColor.backgroundColor;
     cursor.appendChild(initialEl);
   }
-  return decorations.concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  _view.Decoration.widget(to, spaceJoinerAfter, {
+  return decorations.concat(_view.Decoration.widget(to, spaceJoinerAfter, {
     pointer: {
       sessionId: sessionId,
       presenceId: presenceId
     },
     key: "telepointer-".concat(sessionId, "-zero")
-  })).concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  _view.Decoration.widget(to, cursor, {
+  })).concat(_view.Decoration.widget(to, cursor, {
     pointer: {
       sessionId: sessionId,
       presenceId: presenceId
     },
     key: "telepointer-".concat(sessionId)
-  })).concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  _view.Decoration.widget(to, spaceJoinerBefore, {
+  })).concat(_view.Decoration.widget(to, spaceJoinerBefore, {
     pointer: {
       sessionId: sessionId,
       presenceId: presenceId

package/dist/es2019/pm-plugins/events/send-transaction.js

@@ -1,4 +1,5 @@
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../main/plugin-key';
@@ -42,13 +43,32 @@ export const sendTransaction = ({
   } = currentPluginState;
   const selectionChanged = !oldEditorState.selection.eq(newEditorState.selection);
   const participantsChanged = prevActiveParticipants && !prevActiveParticipants.eq(activeParticipants);
-  if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged && !hideTelecursorOnLoad)) {
-    const selection = getSendableSelection(newEditorState.selection);
-    const message = {
-      type: 'telepointer',
-      selection,
-      sessionId
-    };
-    provider.sendMessage(message);
+  if (fg('platform_editor_ai_in_document_streaming')) {
+    // uiEvent is standard metdata (docs: https://prosemirror.net/docs/ref/#state.Transaction)
+    const isPaste = (docChangedTransaction === null || docChangedTransaction === void 0 ? void 0 : docChangedTransaction.getMeta('uiEvent')) === 'paste';
+    if (sessionId && viewMode === 'edit' && (
+    // Broadcast the position if the selection has changed, and the doc hasn't changed (it is mapped
+    // by the receiver).
+    // If we're pasting content though make an exception (as doc has changed)
+    // as on a ranged selection it results in not clearing the ranged selection after the paste
+    selectionChanged && (!docChangedTransaction || isPaste) || participantsChanged && !hideTelecursorOnLoad)) {
+      const selection = getSendableSelection(newEditorState.selection);
+      const message = {
+        type: 'telepointer',
+        selection,
+        sessionId
+      };
+      provider.sendMessage(message);
+    }
+  } else {
+    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged && !hideTelecursorOnLoad)) {
+      const selection = getSendableSelection(newEditorState.selection);
+      const message = {
+        type: 'telepointer',
+        selection,
+        sessionId
+      };
+      provider.sendMessage(message);
+    }
   }
 };

package/dist/es2019/pm-plugins/main/plugin-state.js

@@ -164,26 +164,27 @@ export class PluginState {
       } catch (err) {
         this.onError(err);
       }
-
-      // Remove any selection decoration within the change range,
-      // takes care of the issue when after pasting we end up with a dead selection
-      tr.steps.filter(isReplaceStep).forEach(s => {
-        // Ignored via go/ees005
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const {
-          from,
-          to
-        } = s;
-        // Ignored via go/ees005
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.decorationSet.find(from, to).forEach(deco => {
-          // `type` is private, `from` and `to` are public in latest version
-          // `from` != `to` means it's a selection
-          if (deco.from !== deco.to) {
-            remove.push(deco);
-          }
+      if (!fg('platform_editor_ai_in_document_streaming')) {
+        // Remove any selection decoration within the change range,
+        // takes care of the issue when after pasting we end up with a dead selection
+        tr.steps.filter(isReplaceStep).forEach(s => {
+          // Ignored via go/ees005
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          const {
+            from,
+            to
+          } = s;
+          // Ignored via go/ees005
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          this.decorationSet.find(from, to).forEach(deco => {
+            // `type` is private, `from` and `to` are public in latest version
+            // `from` != `to` means it's a selection
+            if (deco.from !== deco.to) {
+              remove.push(deco);
+            }
+          });
         });
-      });
+      }
     }
     const {
       selection

package/dist/es2019/pm-plugins/utils.js

@@ -8,14 +8,8 @@ import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { getParticipantColor } from '@atlaskit/editor-shared-styles';
 import { fg } from '@atlaskit/platform-feature-flags';
-export const _findPointers = (id, decorations) => decorations.find()
-// Ignored via go/ees005
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-.reduce((arr, deco) => deco.spec.pointer.sessionId === id ? arr.concat(deco) : arr, []);
-export const findPointers = (id, decorations) => decorations.find().reduce(
-// Ignored via go/ees005
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-(arr, deco) => deco.spec.pointer.presenceId === id ? arr.concat(deco) : arr, []);
+export const _findPointers = (id, decorations) => decorations.find().reduce((arr, deco) => deco.spec.pointer.sessionId === id ? arr.concat(deco) : arr, []);
+export const findPointers = (id, decorations) => decorations.find().reduce((arr, deco) => deco.spec.pointer.presenceId === id ? arr.concat(deco) : arr, []);
 function style(options) {
   const color = options && options.color || 'black';
   return `border-right: 2px solid ${color}; margin-right: -2px; z-index: 1`;
@@ -34,10 +28,7 @@ export const createTelepointers = (from, to, sessionId, isSelection, initial, pr
   const color = avatarColor.index.toString();
   if (isSelection) {
     const className = `telepointer color-${color} telepointer-selection`;
-    decorations.push(
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    Decoration.inline(from, to, {
+    decorations.push(Decoration.inline(from, to, {
       class: className,
       'data-initial': initial
     }, {
@@ -77,28 +68,19 @@ export const createTelepointers = (from, to, sessionId, isSelection, initial, pr
     initialEl.style.backgroundColor = avatarColor.backgroundColor;
     cursor.appendChild(initialEl);
   }
-  return decorations.concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Decoration.widget(to, spaceJoinerAfter, {
+  return decorations.concat(Decoration.widget(to, spaceJoinerAfter, {
     pointer: {
       sessionId,
       presenceId
     },
     key: `telepointer-${sessionId}-zero`
-  })).concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Decoration.widget(to, cursor, {
+  })).concat(Decoration.widget(to, cursor, {
     pointer: {
       sessionId,
       presenceId
     },
     key: `telepointer-${sessionId}`
-  })).concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Decoration.widget(to, spaceJoinerBefore, {
+  })).concat(Decoration.widget(to, spaceJoinerBefore, {
     pointer: {
       sessionId,
       presenceId

package/dist/esm/pm-plugins/events/send-transaction.js

@@ -1,4 +1,5 @@
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../main/plugin-key';
@@ -41,14 +42,33 @@ export var sendTransaction = function sendTransaction(_ref) {
       sessionId = currentPluginState.sessionId;
     var selectionChanged = !oldEditorState.selection.eq(newEditorState.selection);
     var participantsChanged = prevActiveParticipants && !prevActiveParticipants.eq(activeParticipants);
-    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged && !hideTelecursorOnLoad)) {
-      var selection = getSendableSelection(newEditorState.selection);
-      var message = {
-        type: 'telepointer',
-        selection: selection,
-        sessionId: sessionId
-      };
-      provider.sendMessage(message);
+    if (fg('platform_editor_ai_in_document_streaming')) {
+      // uiEvent is standard metdata (docs: https://prosemirror.net/docs/ref/#state.Transaction)
+      var isPaste = (docChangedTransaction === null || docChangedTransaction === void 0 ? void 0 : docChangedTransaction.getMeta('uiEvent')) === 'paste';
+      if (sessionId && viewMode === 'edit' && (
+      // Broadcast the position if the selection has changed, and the doc hasn't changed (it is mapped
+      // by the receiver).
+      // If we're pasting content though make an exception (as doc has changed)
+      // as on a ranged selection it results in not clearing the ranged selection after the paste
+      selectionChanged && (!docChangedTransaction || isPaste) || participantsChanged && !hideTelecursorOnLoad)) {
+        var selection = getSendableSelection(newEditorState.selection);
+        var message = {
+          type: 'telepointer',
+          selection: selection,
+          sessionId: sessionId
+        };
+        provider.sendMessage(message);
+      }
+    } else {
+      if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged && !hideTelecursorOnLoad)) {
+        var _selection = getSendableSelection(newEditorState.selection);
+        var _message = {
+          type: 'telepointer',
+          selection: _selection,
+          sessionId: sessionId
+        };
+        provider.sendMessage(_message);
+      }
     }
   };
 };

package/dist/esm/pm-plugins/main/plugin-state.js

@@ -177,25 +177,26 @@ export var PluginState = /*#__PURE__*/function () {
         } catch (err) {
           this.onError(err);
         }
-
-        // Remove any selection decoration within the change range,
-        // takes care of the issue when after pasting we end up with a dead selection
-        tr.steps.filter(isReplaceStep).forEach(function (s) {
-          // Ignored via go/ees005
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          var _ref2 = s,
-            from = _ref2.from,
-            to = _ref2.to;
-          // Ignored via go/ees005
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          _this.decorationSet.find(from, to).forEach(function (deco) {
-            // `type` is private, `from` and `to` are public in latest version
-            // `from` != `to` means it's a selection
-            if (deco.from !== deco.to) {
-              remove.push(deco);
-            }
+        if (!fg('platform_editor_ai_in_document_streaming')) {
+          // Remove any selection decoration within the change range,
+          // takes care of the issue when after pasting we end up with a dead selection
+          tr.steps.filter(isReplaceStep).forEach(function (s) {
+            // Ignored via go/ees005
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            var _ref2 = s,
+              from = _ref2.from,
+              to = _ref2.to;
+            // Ignored via go/ees005
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            _this.decorationSet.find(from, to).forEach(function (deco) {
+              // `type` is private, `from` and `to` are public in latest version
+              // `from` != `to` means it's a selection
+              if (deco.from !== deco.to) {
+                remove.push(deco);
+              }
+            });
           });
-        });
+        }
       }
       var selection = tr.selection;
       // Ignored via go/ees005

package/dist/esm/pm-plugins/utils.js

@@ -10,18 +10,12 @@ import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { getParticipantColor } from '@atlaskit/editor-shared-styles';
 import { fg } from '@atlaskit/platform-feature-flags';
 export var _findPointers = function _findPointers(id, decorations) {
-  return decorations.find()
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  .reduce(function (arr, deco) {
+  return decorations.find().reduce(function (arr, deco) {
     return deco.spec.pointer.sessionId === id ? arr.concat(deco) : arr;
   }, []);
 };
 export var findPointers = function findPointers(id, decorations) {
-  return decorations.find().reduce(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function (arr, deco) {
+  return decorations.find().reduce(function (arr, deco) {
     return deco.spec.pointer.presenceId === id ? arr.concat(deco) : arr;
   }, []);
 };
@@ -43,10 +37,7 @@ export var createTelepointers = function createTelepointers(from, to, sessionId,
   var color = avatarColor.index.toString();
   if (isSelection) {
     var className = "telepointer color-".concat(color, " telepointer-selection");
-    decorations.push(
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    Decoration.inline(from, to, {
+    decorations.push(Decoration.inline(from, to, {
       class: className,
       'data-initial': initial
     }, {
@@ -86,28 +77,19 @@ export var createTelepointers = function createTelepointers(from, to, sessionId,
     initialEl.style.backgroundColor = avatarColor.backgroundColor;
     cursor.appendChild(initialEl);
   }
-  return decorations.concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Decoration.widget(to, spaceJoinerAfter, {
+  return decorations.concat(Decoration.widget(to, spaceJoinerAfter, {
     pointer: {
       sessionId: sessionId,
       presenceId: presenceId
     },
     key: "telepointer-".concat(sessionId, "-zero")
-  })).concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Decoration.widget(to, cursor, {
+  })).concat(Decoration.widget(to, cursor, {
     pointer: {
       sessionId: sessionId,
       presenceId: presenceId
     },
     key: "telepointer-".concat(sessionId)
-  })).concat(
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Decoration.widget(to, spaceJoinerBefore, {
+  })).concat(Decoration.widget(to, spaceJoinerBefore, {
     pointer: {
       sessionId: sessionId,
       presenceId: presenceId

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "4.0.1",
+	"version": "4.0.2",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -42,7 +42,7 @@
 		"@atlaskit/frontend-utilities": "^3.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.17.0",
-		"@atlaskit/tmp-editor-statsig": "^9.0.0",
+		"@atlaskit/tmp-editor-statsig": "^9.2.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
@@ -107,6 +107,9 @@
 		"confluence_team_presence_scroll_to_pointer": {
 			"type": "boolean"
 		},
+		"platform_editor_ai_in_document_streaming": {
+			"type": "boolean"
+		},
 		"platform_enable_ncs_step_metrics": {
 			"type": "boolean"
 		}