@atlaskit/editor-plugin-collab-edit 3.2.5 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 3.3.0
+
+### Minor Changes
+
+- [#136936](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/136936)
+  [`505147cb14bae`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/505147cb14bae) -
+  [ux] [ED-27431] Do not transmit telecursor position on initial load of non-empty live pages when
+  hideTelecursorOnLoad is set.
+
 ## 3.2.5
 
 ### Patch Changes

package/dist/cjs/collabEditPlugin.js

@@ -10,6 +10,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _utils = require("@atlaskit/editor-common/utils");
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
@@ -25,7 +26,7 @@ var _trackLastOrganicChange = require("./pm-plugins/track-last-organic-change");
 var _trackNcsInitialization = require("./pm-plugins/track-ncs-initialization");
 var _trackReconnectionConflict = require("./pm-plugins/track-reconnection-conflict");
 var _trackSteps = require("./pm-plugins/track-steps");
-var _utils = require("./pm-plugins/utils");
+var _utils2 = require("./pm-plugins/utils");
 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) { (0, _defineProperty2.default)(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; }
 var providerBuilder = function providerBuilder(collabEditProviderPromise) {
@@ -149,7 +150,7 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
       };
     },
     actions: {
-      getAvatarColor: _utils.getAvatarColor,
+      getAvatarColor: _utils2.getAvatarColor,
       addInlineCommentMark: createAddInlineCommentMark(collabEditProviderPromise),
       addInlineCommentNodeMark: createAddInlineCommentNodeMark(collabEditProviderPromise),
       isRemoteReplaceDocumentTransaction: function isRemoteReplaceDocumentTransaction(tr) {
@@ -260,15 +261,17 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
       return plugins;
     },
     onEditorViewStateUpdated: function onEditorViewStateUpdated(props) {
-      var _api$analytics2, _api$editorViewMode, _options$useNativePlu;
+      var _api$analytics2, _api$editorViewMode, _options$useNativePlu, _options$hideTelecurs;
       var addErrorAnalytics = (0, _analytics2.addSynchronyErrorAnalytics)(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions);
+      var isEmptyDoc = (0, _utils.isEmptyDocument)(props.newEditorState.doc);
       var viewMode = api === null || api === void 0 || (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 || (_api$editorViewMode = _api$editorViewMode.sharedState.currentState()) === null || _api$editorViewMode === void 0 ? void 0 : _api$editorViewMode.mode;
       executeProviderCode((0, _sendTransaction.sendTransaction)({
         originalTransaction: props.originalTransaction,
         transactions: props.transactions,
         oldEditorState: props.oldEditorState,
         newEditorState: props.newEditorState,
-        useNativePlugin: (_options$useNativePlu = options === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        useNativePlugin: (_options$useNativePlu = options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        hideTelecursorOnLoad: !isEmptyDoc && ((_options$hideTelecurs = options.hideTelecursorOnLoad) !== null && _options$hideTelecurs !== void 0 ? _options$hideTelecurs : false),
         viewMode: viewMode
       }), addErrorAnalytics);
       (0, _trackSteps.track)(_objectSpread(_objectSpread({}, props), {}, {

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.sendTransaction = void 0;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _actions = require("../actions");
 var _pluginKey = require("../main/plugin-key");
 var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
@@ -12,7 +13,8 @@ var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
     oldEditorState = _ref.oldEditorState,
     newEditorState = _ref.newEditorState,
     useNativePlugin = _ref.useNativePlugin,
-    viewMode = _ref.viewMode;
+    viewMode = _ref.viewMode,
+    hideTelecursorOnLoad = _ref.hideTelecursorOnLoad;
   return function (provider) {
     var docChangedTransaction = transactions.find(function (tr) {
       return tr.docChanged;
@@ -35,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 || participantsChanged)) {
+    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || ((0, _platformFeatureFlags.fg)('platform_editor_no_telecursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
       var selection = (0, _actions.getSendableSelection)(newEditorState.selection);
       var message = {
         type: 'telepointer',

package/dist/es2019/collabEditPlugin.js

@@ -1,4 +1,5 @@
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { AddMarkStep, AddNodeMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -206,15 +207,17 @@ export const collabEditPlugin = ({
       return plugins;
     },
     onEditorViewStateUpdated(props) {
-      var _api$analytics2, _api$editorViewMode, _api$editorViewMode$s, _options$useNativePlu;
+      var _api$analytics2, _api$editorViewMode, _api$editorViewMode$s, _options$useNativePlu, _options$hideTelecurs;
       const addErrorAnalytics = addSynchronyErrorAnalytics(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions);
+      const isEmptyDoc = isEmptyDocument(props.newEditorState.doc);
       const viewMode = api === null || api === void 0 ? void 0 : (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 ? void 0 : (_api$editorViewMode$s = _api$editorViewMode.sharedState.currentState()) === null || _api$editorViewMode$s === void 0 ? void 0 : _api$editorViewMode$s.mode;
       executeProviderCode(sendTransaction({
         originalTransaction: props.originalTransaction,
         transactions: props.transactions,
         oldEditorState: props.oldEditorState,
         newEditorState: props.newEditorState,
-        useNativePlugin: (_options$useNativePlu = options === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        useNativePlugin: (_options$useNativePlu = options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        hideTelecursorOnLoad: !isEmptyDoc && ((_options$hideTelecurs = options.hideTelecursorOnLoad) !== null && _options$hideTelecurs !== void 0 ? _options$hideTelecurs : false),
         viewMode
       }), addErrorAnalytics);
       track({

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

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../main/plugin-key';
 export const sendTransaction = ({
@@ -6,7 +7,8 @@ export const sendTransaction = ({
   oldEditorState,
   newEditorState,
   useNativePlugin,
-  viewMode
+  viewMode,
+  hideTelecursorOnLoad
 }) => provider => {
   const docChangedTransaction = transactions.find(tr => tr.docChanged);
   const currentPluginState = pluginKey.getState(newEditorState);
@@ -30,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 || participantsChanged)) {
+  if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || (fg('platform_editor_no_telecursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
     const selection = getSendableSelection(newEditorState.selection);
     const message = {
       type: 'telepointer',

package/dist/esm/collabEditPlugin.js

@@ -5,6 +5,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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 _regeneratorRuntime from "@babel/runtime/regenerator";
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { AddMarkStep, AddNodeMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -253,15 +254,17 @@ export var collabEditPlugin = function collabEditPlugin(_ref4) {
       return plugins;
     },
     onEditorViewStateUpdated: function onEditorViewStateUpdated(props) {
-      var _api$analytics2, _api$editorViewMode, _options$useNativePlu;
+      var _api$analytics2, _api$editorViewMode, _options$useNativePlu, _options$hideTelecurs;
       var addErrorAnalytics = addSynchronyErrorAnalytics(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions);
+      var isEmptyDoc = isEmptyDocument(props.newEditorState.doc);
       var viewMode = api === null || api === void 0 || (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 || (_api$editorViewMode = _api$editorViewMode.sharedState.currentState()) === null || _api$editorViewMode === void 0 ? void 0 : _api$editorViewMode.mode;
       executeProviderCode(sendTransaction({
         originalTransaction: props.originalTransaction,
         transactions: props.transactions,
         oldEditorState: props.oldEditorState,
         newEditorState: props.newEditorState,
-        useNativePlugin: (_options$useNativePlu = options === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        useNativePlugin: (_options$useNativePlu = options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        hideTelecursorOnLoad: !isEmptyDoc && ((_options$hideTelecurs = options.hideTelecursorOnLoad) !== null && _options$hideTelecurs !== void 0 ? _options$hideTelecurs : false),
         viewMode: viewMode
       }), addErrorAnalytics);
       track(_objectSpread(_objectSpread({}, props), {}, {

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

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../main/plugin-key';
 export var sendTransaction = function sendTransaction(_ref) {
@@ -6,7 +7,8 @@ export var sendTransaction = function sendTransaction(_ref) {
     oldEditorState = _ref.oldEditorState,
     newEditorState = _ref.newEditorState,
     useNativePlugin = _ref.useNativePlugin,
-    viewMode = _ref.viewMode;
+    viewMode = _ref.viewMode,
+    hideTelecursorOnLoad = _ref.hideTelecursorOnLoad;
   return function (provider) {
     var docChangedTransaction = transactions.find(function (tr) {
       return tr.docChanged;
@@ -29,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 || participantsChanged)) {
+    if (sessionId && viewMode === 'edit' && (selectionChanged && !docChangedTransaction || (fg('platform_editor_no_telecursor_on_live_doc_init') ? participantsChanged && !hideTelecursorOnLoad : participantsChanged))) {
       var selection = getSendableSelection(newEditorState.selection);
       var message = {
         type: 'telepointer',

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

@@ -1,4 +1,5 @@
 import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 type Props = {
     originalTransaction: Readonly<Transaction>;
@@ -6,7 +7,8 @@ type Props = {
     oldEditorState: EditorState;
     newEditorState: EditorState;
     useNativePlugin: boolean;
-    viewMode?: 'view' | 'edit';
+    hideTelecursorOnLoad: boolean;
+    viewMode?: ViewMode;
 };
-export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, }: Props) => (provider: CollabEditProvider) => void;
+export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, hideTelecursorOnLoad, }: Props) => (provider: CollabEditProvider) => void;
 export {};

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

@@ -4,6 +4,7 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export type PrivateCollabEditOptions = CollabEditOptions & {
     sanitizePrivateContent?: boolean;
     onSyncUpError?: SyncUpErrorFunction;
+    hideTelecursorOnLoad?: boolean;
 };
 export type ProviderCallback = <ReturnType>(codeToExecute: (provider: CollabEditProvider) => ReturnType | undefined, onError?: (err: Error) => void) => Promise<ReturnType | undefined> | undefined;
 export type ProviderBuilder = (collabEditProviderPromise: Promise<CollabEditProvider>) => ProviderCallback;

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

@@ -1,4 +1,5 @@
 import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 type Props = {
     originalTransaction: Readonly<Transaction>;
@@ -6,7 +7,8 @@ type Props = {
     oldEditorState: EditorState;
     newEditorState: EditorState;
     useNativePlugin: boolean;
-    viewMode?: 'view' | 'edit';
+    hideTelecursorOnLoad: boolean;
+    viewMode?: ViewMode;
 };
-export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, }: Props) => (provider: CollabEditProvider) => void;
+export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, hideTelecursorOnLoad, }: Props) => (provider: CollabEditProvider) => void;
 export {};

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

@@ -4,6 +4,7 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export type PrivateCollabEditOptions = CollabEditOptions & {
     sanitizePrivateContent?: boolean;
     onSyncUpError?: SyncUpErrorFunction;
+    hideTelecursorOnLoad?: boolean;
 };
 export type ProviderCallback = <ReturnType>(codeToExecute: (provider: CollabEditProvider) => ReturnType | undefined, onError?: (err: Error) => void) => Promise<ReturnType | undefined> | undefined;
 export type ProviderBuilder = (collabEditProviderPromise: Promise<CollabEditProvider>) => ProviderCallback;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "3.2.5",
+	"version": "3.3.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -114,6 +114,9 @@
 		},
 		"platform_editor_selection_without_left_shift": {
 			"type": "boolean"
+		},
+		"platform_editor_no_telecursor_on_live_doc_init": {
+			"type": "boolean"
 		}
 	}
 }