@atlaskit/editor-plugin-collab-edit 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 3.7.0
+
+### Minor Changes
+
+- [#157183](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/157183)
+  [`0e8b7956c0e3d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0e8b7956c0e3d) -
+  [ux] The telepointer pulse animation and a plugin action to access it have been added. This will
+  help users locate telepointers more easily on screen.
+
+### Patch Changes
+
+- [#157322](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/157322)
+  [`0e61040734cef`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0e61040734cef) -
+  [ED-27842] Consolidate extraneous no_cursor flags into one flag for full rollout
+- Updated dependencies
+
+## 3.6.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.6.0
 
 ### Minor Changes

package/dist/cjs/collabEditPlugin.js

@@ -287,6 +287,17 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
           });
         }
       }));
+    },
+    commands: {
+      nudgeTelepointer: function nudgeTelepointer(sessionId) {
+        return function (_ref7) {
+          var tr = _ref7.tr;
+          tr.setMeta('nudgeTelepointer', {
+            sessionId: sessionId
+          });
+          return tr;
+        };
+      }
     }
   };
 };

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

@@ -37,7 +37,7 @@ 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 || ((0, _platformFeatureFlags.fg)('platform_editor_no_telecursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
+    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || ((0, _platformFeatureFlags.fg)('platform_editor_no_cursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
       var selection = (0, _actions.getSendableSelection)(newEditorState.selection);
       var message = {
         type: 'telepointer',

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

@@ -88,6 +88,7 @@ var PluginState = exports.PluginState = /*#__PURE__*/function () {
         isReady = this.isReady;
       var presenceData = tr.getMeta('presence');
       var telepointerData = tr.getMeta('telepointer');
+      var nudgeTelepointerData = tr.getMeta('nudgeTelepointer');
       var sessionIdData = tr.getMeta('sessionId');
       var collabInitialised = tr.getMeta('collabInitialised');
       if (typeof collabInitialised !== 'boolean') {
@@ -229,6 +230,21 @@ var PluginState = exports.PluginState = /*#__PURE__*/function () {
           }
         }
       });
+      if (nudgeTelepointerData && (0, _platformFeatureFlags.fg)('confluence_team_presence_scroll_to_pointer')) {
+        var nudgeSessionId = nudgeTelepointerData === null || nudgeTelepointerData === void 0 ? void 0 : nudgeTelepointerData.sessionId;
+
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.decorationSet.find().forEach(function (deco) {
+          var _deco$spec, _deco$spec2;
+          if (deco.type.toDOM && participants.get(nudgeSessionId) && ((_deco$spec = deco.spec) === null || _deco$spec === void 0 || (_deco$spec = _deco$spec.pointer) === null || _deco$spec === void 0 ? void 0 : _deco$spec.sessionId) === nudgeSessionId && ((_deco$spec2 = deco.spec) === null || _deco$spec2 === void 0 ? void 0 : _deco$spec2.key) === "telepointer-".concat(nudgeSessionId)) {
+            // Restart animation by removing and re-adding the class
+            deco.type.toDOM.classList.remove(_collab.TELEPOINTER_PULSE_CLASS);
+            void deco.type.toDOM.offsetWidth; // Force reflow
+            deco.type.toDOM.classList.add(_collab.TELEPOINTER_PULSE_CLASS);
+          }
+        });
+      }
       if (remove.length) {
         this.decorationSet = this.decorationSet.remove(remove);
       }

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

@@ -10,6 +10,7 @@ exports.scrollToCollabCursor = exports.replaceDocument = exports.originalTransac
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _steps = require("@atlaskit/adf-schema/steps");
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _collab = require("@atlaskit/editor-common/collab");
 var _processRawValue = require("@atlaskit/editor-common/process-raw-value");
 var _whitespace = require("@atlaskit/editor-common/whitespace");
 var _state = require("@atlaskit/editor-prosemirror/state");
@@ -76,6 +77,7 @@ var createTelepointers = exports.createTelepointers = function createTelepointer
   }), ";");
   cursor.setAttribute('data-initial', initial);
   if ((0, _platformFeatureFlags.fg)('confluence_team_presence_scroll_to_pointer')) {
+    cursor.setAttribute(_collab.TELEPOINTER_DATA_SESSION_ID_ATTR, sessionId);
     var fullNameEl = document.createElement('span');
     fullNameEl.textContent = fullName;
     fullNameEl.className = 'telepointer-fullname';

package/dist/es2019/collabEditPlugin.js

@@ -234,6 +234,16 @@ export const collabEditPlugin = ({
           });
         }
       });
+    },
+    commands: {
+      nudgeTelepointer: sessionId => ({
+        tr
+      }) => {
+        tr.setMeta('nudgeTelepointer', {
+          sessionId
+        });
+        return tr;
+      }
     }
   };
 };

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

@@ -32,7 +32,7 @@ export const sendTransaction = ({
   } = currentPluginState;
   const selectionChanged = !oldEditorState.selection.eq(newEditorState.selection);
   const participantsChanged = prevActiveParticipants && !prevActiveParticipants.eq(activeParticipants);
-  if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || (fg('platform_editor_no_telecursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
+  if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || (fg('platform_editor_no_cursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
     const selection = getSendableSelection(newEditorState.selection);
     const message = {
       type: 'telepointer',

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

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { browser } from '@atlaskit/editor-common/browser';
-import { TELEPOINTER_DIM_CLASS } from '@atlaskit/editor-common/collab';
+import { TELEPOINTER_DIM_CLASS, TELEPOINTER_PULSE_CLASS } from '@atlaskit/editor-common/collab';
 import { Selection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -62,6 +62,7 @@ export class PluginState {
     } = this;
     const presenceData = tr.getMeta('presence');
     const telepointerData = tr.getMeta('telepointer');
+    const nudgeTelepointerData = tr.getMeta('nudgeTelepointer');
     const sessionIdData = tr.getMeta('sessionId');
     let collabInitialised = tr.getMeta('collabInitialised');
     if (typeof collabInitialised !== 'boolean') {
@@ -214,6 +215,21 @@ export class PluginState {
         }
       }
     });
+    if (nudgeTelepointerData && fg('confluence_team_presence_scroll_to_pointer')) {
+      const nudgeSessionId = nudgeTelepointerData === null || nudgeTelepointerData === void 0 ? void 0 : nudgeTelepointerData.sessionId;
+
+      // Ignored via go/ees005
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      this.decorationSet.find().forEach(deco => {
+        var _deco$spec, _deco$spec$pointer, _deco$spec2;
+        if (deco.type.toDOM && participants.get(nudgeSessionId) && ((_deco$spec = deco.spec) === null || _deco$spec === void 0 ? void 0 : (_deco$spec$pointer = _deco$spec.pointer) === null || _deco$spec$pointer === void 0 ? void 0 : _deco$spec$pointer.sessionId) === nudgeSessionId && ((_deco$spec2 = deco.spec) === null || _deco$spec2 === void 0 ? void 0 : _deco$spec2.key) === `telepointer-${nudgeSessionId}`) {
+          // Restart animation by removing and re-adding the class
+          deco.type.toDOM.classList.remove(TELEPOINTER_PULSE_CLASS);
+          void deco.type.toDOM.offsetWidth; // Force reflow
+          deco.type.toDOM.classList.add(TELEPOINTER_PULSE_CLASS);
+        }
+      });
+    }
     if (remove.length) {
       this.decorationSet = this.decorationSet.remove(remove);
     }

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

@@ -1,5 +1,6 @@
 import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { TELEPOINTER_DATA_SESSION_ID_ATTR } from '@atlaskit/editor-common/collab';
 import { processRawValueWithoutValidation } from '@atlaskit/editor-common/process-raw-value';
 import { ZERO_WIDTH_JOINER } from '@atlaskit/editor-common/whitespace';
 import { Transaction, Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
@@ -58,6 +59,7 @@ export const createTelepointers = (from, to, sessionId, isSelection, initial, pr
   })};`;
   cursor.setAttribute('data-initial', initial);
   if (fg('confluence_team_presence_scroll_to_pointer')) {
+    cursor.setAttribute(TELEPOINTER_DATA_SESSION_ID_ATTR, sessionId);
     const fullNameEl = document.createElement('span');
     fullNameEl.textContent = fullName;
     fullNameEl.className = 'telepointer-fullname';

package/dist/esm/collabEditPlugin.js

@@ -280,6 +280,17 @@ export var collabEditPlugin = function collabEditPlugin(_ref4) {
           });
         }
       }));
+    },
+    commands: {
+      nudgeTelepointer: function nudgeTelepointer(sessionId) {
+        return function (_ref7) {
+          var tr = _ref7.tr;
+          tr.setMeta('nudgeTelepointer', {
+            sessionId: sessionId
+          });
+          return tr;
+        };
+      }
     }
   };
 };

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

@@ -31,7 +31,7 @@ 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 || (fg('platform_editor_no_telecursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
+    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || (fg('platform_editor_no_cursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
       var selection = getSendableSelection(newEditorState.selection);
       var message = {
         type: 'telepointer',

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

@@ -2,7 +2,7 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { browser } from '@atlaskit/editor-common/browser';
-import { TELEPOINTER_DIM_CLASS } from '@atlaskit/editor-common/collab';
+import { TELEPOINTER_DIM_CLASS, TELEPOINTER_PULSE_CLASS } from '@atlaskit/editor-common/collab';
 import { Selection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -82,6 +82,7 @@ export var PluginState = /*#__PURE__*/function () {
         isReady = this.isReady;
       var presenceData = tr.getMeta('presence');
       var telepointerData = tr.getMeta('telepointer');
+      var nudgeTelepointerData = tr.getMeta('nudgeTelepointer');
       var sessionIdData = tr.getMeta('sessionId');
       var collabInitialised = tr.getMeta('collabInitialised');
       if (typeof collabInitialised !== 'boolean') {
@@ -223,6 +224,21 @@ export var PluginState = /*#__PURE__*/function () {
           }
         }
       });
+      if (nudgeTelepointerData && fg('confluence_team_presence_scroll_to_pointer')) {
+        var nudgeSessionId = nudgeTelepointerData === null || nudgeTelepointerData === void 0 ? void 0 : nudgeTelepointerData.sessionId;
+
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.decorationSet.find().forEach(function (deco) {
+          var _deco$spec, _deco$spec2;
+          if (deco.type.toDOM && participants.get(nudgeSessionId) && ((_deco$spec = deco.spec) === null || _deco$spec === void 0 || (_deco$spec = _deco$spec.pointer) === null || _deco$spec === void 0 ? void 0 : _deco$spec.sessionId) === nudgeSessionId && ((_deco$spec2 = deco.spec) === null || _deco$spec2 === void 0 ? void 0 : _deco$spec2.key) === "telepointer-".concat(nudgeSessionId)) {
+            // Restart animation by removing and re-adding the class
+            deco.type.toDOM.classList.remove(TELEPOINTER_PULSE_CLASS);
+            void deco.type.toDOM.offsetWidth; // Force reflow
+            deco.type.toDOM.classList.add(TELEPOINTER_PULSE_CLASS);
+          }
+        });
+      }
       if (remove.length) {
         this.decorationSet = this.decorationSet.remove(remove);
       }

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

@@ -1,6 +1,7 @@
 import _typeof from "@babel/runtime/helpers/typeof";
 import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { TELEPOINTER_DATA_SESSION_ID_ATTR } from '@atlaskit/editor-common/collab';
 import { processRawValueWithoutValidation } from '@atlaskit/editor-common/process-raw-value';
 import { ZERO_WIDTH_JOINER } from '@atlaskit/editor-common/whitespace';
 import { Transaction, Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
@@ -67,6 +68,7 @@ export var createTelepointers = function createTelepointers(from, to, sessionId,
   }), ";");
   cursor.setAttribute('data-initial', initial);
   if (fg('confluence_team_presence_scroll_to_pointer')) {
+    cursor.setAttribute(TELEPOINTER_DATA_SESSION_ID_ATTR, sessionId);
     var fullNameEl = document.createElement('span');
     fullNameEl.textContent = fullName;
     fullNameEl.className = 'telepointer-fullname';

package/dist/types/collabEditPluginType.d.ts

@@ -1,4 +1,4 @@
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
@@ -41,4 +41,7 @@ export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
         };
         validatePMJSONDocument: (doc: any) => boolean;
     };
+    commands: {
+        nudgeTelepointer: (sessionId: string) => EditorCommand;
+    };
 }>;

package/dist/types/pm-plugins/events/send-transaction.d.ts

@@ -1,5 +1,5 @@
 import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
-import { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
+import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 type Props = {
     originalTransaction: Readonly<Transaction>;

package/dist/types/pm-plugins/utils.d.ts

@@ -1,5 +1,5 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabEditOptions, CollabParticipant } from '@atlaskit/editor-common/collab';
+import { type CollabEditOptions, type CollabParticipant } from '@atlaskit/editor-common/collab';
 import { type EditorState, type ReadonlyTransaction, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';

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

@@ -1,4 +1,4 @@
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
@@ -41,4 +41,7 @@ export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
         };
         validatePMJSONDocument: (doc: any) => boolean;
     };
+    commands: {
+        nudgeTelepointer: (sessionId: string) => EditorCommand;
+    };
 }>;

package/dist/types-ts4.5/pm-plugins/events/send-transaction.d.ts

@@ -1,5 +1,5 @@
 import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
-import { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
+import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 type Props = {
     originalTransaction: Readonly<Transaction>;

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

@@ -1,5 +1,5 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabEditOptions, CollabParticipant } from '@atlaskit/editor-common/collab';
+import { type CollabEditOptions, type CollabParticipant } from '@atlaskit/editor-common/collab';
 import { type EditorState, type ReadonlyTransaction, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "3.6.0",
+	"version": "3.7.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,9 +33,9 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
 		"@atlaskit/custom-steps": "^0.11.0",
-		"@atlaskit/editor-common": "^104.1.0",
+		"@atlaskit/editor-common": "^105.8.0",
 		"@atlaskit/editor-json-transformer": "^8.24.0",
-		"@atlaskit/editor-plugin-analytics": "^2.2.0",
+		"@atlaskit/editor-plugin-analytics": "^2.3.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^3.1.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.4.0",
@@ -43,7 +43,7 @@
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.16.0",
-		"@atlaskit/tmp-editor-statsig": "^4.18.0",
+		"@atlaskit/tmp-editor-statsig": "^4.23.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
@@ -54,9 +54,9 @@
 	"devDependencies": {
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/editor-plugin-mentions": "^4.5.0",
+		"@atlaskit/editor-plugin-mentions": "^4.7.0",
 		"@atlaskit/editor-plugin-text-formatting": "^2.2.0",
-		"@atlaskit/editor-plugin-type-ahead": "^2.6.0",
+		"@atlaskit/editor-plugin-type-ahead": "^2.7.0",
 		"@atlaskit/editor-plugin-unsupported-content": "^2.1.0",
 		"@atlaskit/editor-test-helpers": "workspace:^",
 		"@atlaskit/ssr": "workspace:^",
@@ -110,7 +110,7 @@
 		"platform_editor_selection_without_left_shift": {
 			"type": "boolean"
 		},
-		"platform_editor_no_telecursor_on_live_doc_init": {
+		"platform_editor_no_cursor_on_live_doc_init": {
 			"type": "boolean"
 		},
 		"confluence_team_presence_scroll_to_pointer": {