@atlaskit/editor-plugin-collab-edit 1.5.0 → 1.5.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 1.5.1
+
+### Patch Changes
+
+- [#105724](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/105724)
+  [`d31b1d6bce097`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d31b1d6bce097) -
+  [ux] [ED-23466] Don't show view-mode telepointers to other live-mode users
+
 ## 1.5.0
 
 ### Minor Changes

package/dist/cjs/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("../pm-plugins/main/plugin-key");
 var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
@@ -11,7 +12,8 @@ var sendTransaction = exports.sendTransaction = function sendTransaction(_ref) {
     transactions = _ref.transactions,
     oldEditorState = _ref.oldEditorState,
     newEditorState = _ref.newEditorState,
-    useNativePlugin = _ref.useNativePlugin;
+    useNativePlugin = _ref.useNativePlugin,
+    viewMode = _ref.viewMode;
   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 && selectionChanged && !docChangedTransaction || sessionId && participantsChanged) {
+    if (sessionId && ((0, _platformFeatureFlags.getBooleanFF)('platform.editor.no-telecursors-for-viewmode-users_hok8o') ? viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged) : sessionId && selectionChanged && !docChangedTransaction || sessionId && participantsChanged)) {
       var selection = (0, _actions.getSendableSelection)(newEditorState.selection);
       var message = {
         type: 'telepointer',

package/dist/cjs/plugin.js

@@ -163,14 +163,16 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
       }]);
     },
     onEditorViewStateUpdated: function onEditorViewStateUpdated(props) {
-      var _api$analytics, _options$useNativePlu;
+      var _api$analytics, _api$editorViewMode, _options$useNativePlu;
       var addErrorAnalytics = (0, _analytics.addSynchronyErrorAnalytics)(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions);
+      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 === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        viewMode: viewMode
       }), addErrorAnalytics);
     }
   };

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

@@ -1,3 +1,4 @@
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../pm-plugins/main/plugin-key';
 export const sendTransaction = ({
@@ -5,7 +6,8 @@ export const sendTransaction = ({
   transactions,
   oldEditorState,
   newEditorState,
-  useNativePlugin
+  useNativePlugin,
+  viewMode
 }) => 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 && selectionChanged && !docChangedTransaction || sessionId && participantsChanged) {
+  if (sessionId && (getBooleanFF('platform.editor.no-telecursors-for-viewmode-users_hok8o') ? viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged) : sessionId && selectionChanged && !docChangedTransaction || sessionId && participantsChanged)) {
     const selection = getSendableSelection(newEditorState.selection);
     const message = {
       type: 'telepointer',

package/dist/es2019/plugin.js

@@ -121,14 +121,16 @@ export const collabEditPlugin = ({
       }];
     },
     onEditorViewStateUpdated(props) {
-      var _api$analytics, _options$useNativePlu;
+      var _api$analytics, _api$editorViewMode, _api$editorViewMode$s, _options$useNativePlu;
       const addErrorAnalytics = addSynchronyErrorAnalytics(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions);
+      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 === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        viewMode
       }), addErrorAnalytics);
     }
   };

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

@@ -1,3 +1,4 @@
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { getSendableSelection } from '../actions';
 import { pluginKey } from '../pm-plugins/main/plugin-key';
 export var sendTransaction = function sendTransaction(_ref) {
@@ -5,7 +6,8 @@ export var sendTransaction = function sendTransaction(_ref) {
     transactions = _ref.transactions,
     oldEditorState = _ref.oldEditorState,
     newEditorState = _ref.newEditorState,
-    useNativePlugin = _ref.useNativePlugin;
+    useNativePlugin = _ref.useNativePlugin,
+    viewMode = _ref.viewMode;
   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 && selectionChanged && !docChangedTransaction || sessionId && participantsChanged) {
+    if (sessionId && (getBooleanFF('platform.editor.no-telecursors-for-viewmode-users_hok8o') ? viewMode === 'edit' && (selectionChanged && !docChangedTransaction || participantsChanged) : sessionId && selectionChanged && !docChangedTransaction || sessionId && participantsChanged)) {
       var selection = getSendableSelection(newEditorState.selection);
       var message = {
         type: 'telepointer',

package/dist/esm/plugin.js

@@ -156,14 +156,16 @@ export var collabEditPlugin = function collabEditPlugin(_ref4) {
       }]);
     },
     onEditorViewStateUpdated: function onEditorViewStateUpdated(props) {
-      var _api$analytics, _options$useNativePlu;
+      var _api$analytics, _api$editorViewMode, _options$useNativePlu;
       var addErrorAnalytics = addSynchronyErrorAnalytics(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions);
+      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 === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false,
+        viewMode: viewMode
       }), addErrorAnalytics);
     }
   };

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

@@ -6,6 +6,7 @@ type Props = {
     oldEditorState: EditorState;
     newEditorState: EditorState;
     useNativePlugin: boolean;
+    viewMode?: 'view' | 'edit';
 };
-export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin }: Props) => (provider: CollabEditProvider) => void;
+export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, }: Props) => (provider: CollabEditProvider) => void;
 export {};

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
 import type { CollabEditOptions, CollabEditProvider, CollabParticipant, Color, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
 import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { Mark } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -28,7 +29,11 @@ export type CollabEditPluginSharedState = {
 };
 export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
     pluginConfiguration: PrivateCollabEditOptions;
-    dependencies: [OptionalPlugin<FeatureFlagsPlugin>, OptionalPlugin<AnalyticsPlugin>];
+    dependencies: [
+        OptionalPlugin<FeatureFlagsPlugin>,
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
+    ];
     sharedState: CollabEditPluginSharedState;
     actions: {
         getAvatarColor: (str: string) => {

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

@@ -6,6 +6,7 @@ type Props = {
     oldEditorState: EditorState;
     newEditorState: EditorState;
     useNativePlugin: boolean;
+    viewMode?: 'view' | 'edit';
 };
-export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin }: Props) => (provider: CollabEditProvider) => void;
+export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, viewMode, }: Props) => (provider: CollabEditProvider) => void;
 export {};

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

@@ -1,6 +1,7 @@
 import type { CollabEditOptions, CollabEditProvider, CollabParticipant, Color, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
 import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { Mark } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -30,7 +31,8 @@ export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
     pluginConfiguration: PrivateCollabEditOptions;
     dependencies: [
         OptionalPlugin<FeatureFlagsPlugin>,
-        OptionalPlugin<AnalyticsPlugin>
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
     ];
     sharedState: CollabEditPluginSharedState;
     actions: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "1.5.0",
+	"version": "1.5.1",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,7 +20,10 @@
 	"types": "dist/types/index.d.ts",
 	"typesVersions": {
 		">=4.5 <4.9": {
-			"*": ["dist/types-ts4.5/*", "dist/types-ts4.5/index.d.ts"]
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
 		}
 	},
 	"sideEffects": false,
@@ -31,11 +34,13 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^36.10.7",
 		"@atlaskit/custom-steps": "^0.2.0",
-		"@atlaskit/editor-common": "^82.6.0",
+		"@atlaskit/editor-common": "^82.10.0",
 		"@atlaskit/editor-plugin-analytics": "1.2.3",
+		"@atlaskit/editor-plugin-editor-viewmode": "^2.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.1.0",
 		"@atlaskit/editor-prosemirror": "4.0.1",
 		"@atlaskit/editor-shared-styles": "^2.12.0",
+		"@atlaskit/platform-feature-flags": "^0.2.5",
 		"@atlaskit/prosemirror-collab": "^0.4.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
@@ -63,18 +68,40 @@
 	},
 	"techstack": {
 		"@atlassian/frontend": {
-			"import-structure": ["atlassian-conventions"],
-			"circular-dependencies": ["file-and-folder-level"]
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
 		},
 		"@repo/internal": {
 			"dom-events": "use-bind-event-listener",
-			"analytics": ["analytics-next"],
-			"design-tokens": ["color"],
-			"theming": ["react-context"],
-			"ui-components": ["lite-mode"],
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
 			"deprecation": "no-deprecated-imports",
-			"styling": ["emotion", "emotion"],
-			"imports": ["import-no-extraneous-disable-for-examples-and-docs"]
+			"styling": [
+				"emotion",
+				"emotion"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	},
+	"platform-feature-flags": {
+		"platform.editor.no-telecursors-for-viewmode-users_hok8o": {
+			"type": "boolean"
 		}
 	}
 }