@atlaskit/editor-plugin-collab-edit 0.1.10 → 0.1.12

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 0.1.12
+
+### Patch Changes
+
+- [#69825](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/69825) [`e2363da4f6a1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e2363da4f6a1) - [No Issue] Replace View Mode API for annotations
+- [#69825](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/69825) [`e2363da4f6a1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e2363da4f6a1) - [No Issue] Replace View Mode API for annotations
+- [#69825](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/69825) [`e2363da4f6a1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e2363da4f6a1) - [No Issue] Replace View Mode API for annotations
+
+## 0.1.11
+
+### Patch Changes
+
+- [#72026](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/72026) [`0a0cc061a8a7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0a0cc061a8a7) - [No Issue] Improve Confluence Integration tests precision with data-has-collab-initialised
+
 ## 0.1.10
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -8,6 +8,7 @@ exports.collabEditPlugin = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _analytics = require("./analytics");
 var _sendTransaction = require("./events/send-transaction");
@@ -56,10 +57,25 @@ var providerBuilder = function providerBuilder(collabEditProviderPromise) {
     };
   }();
 };
-var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref2) {
+var createAddInlineCommentMark = function createAddInlineCommentMark(providerPromise) {
+  return function (_ref2) {
+    var from = _ref2.from,
+      to = _ref2.to,
+      mark = _ref2.mark;
+    providerPromise.then(function (provider) {
+      var _provider$api;
+      var commentMark = new _transform.AddMarkStep(Math.min(from, to), Math.max(from, to), mark);
+
+      // @ts-expect-error 2339: Property 'api' does not exist on type 'CollabEditProvider<CollabEvents>'.
+      (_provider$api = provider.api) === null || _provider$api === void 0 || _provider$api.addComment([commentMark]);
+    });
+    return false;
+  };
+};
+var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref3) {
   var _api$featureFlags;
-  var options = _ref2.config,
-    api = _ref2.api;
+  var options = _ref3.config,
+    api = _ref3.api;
   var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
   var providerResolver = function providerResolver() {};
   var collabEditProviderPromise = new Promise(function (_providerResolver) {
@@ -91,14 +107,15 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
       };
     },
     actions: {
-      getAvatarColor: _utils.getAvatarColor
+      getAvatarColor: _utils.getAvatarColor,
+      addInlineCommentMark: createAddInlineCommentMark(collabEditProviderPromise)
     },
     pmPlugins: function pmPlugins() {
-      var _ref3 = options || {},
-        _ref3$useNativePlugin = _ref3.useNativePlugin,
-        useNativePlugin = _ref3$useNativePlugin === void 0 ? false : _ref3$useNativePlugin,
-        _ref3$userId = _ref3.userId,
-        userId = _ref3$userId === void 0 ? null : _ref3$userId;
+      var _ref4 = options || {},
+        _ref4$useNativePlugin = _ref4.useNativePlugin,
+        useNativePlugin = _ref4$useNativePlugin === void 0 ? false : _ref4$useNativePlugin,
+        _ref4$userId = _ref4.userId,
+        userId = _ref4$userId === void 0 ? null : _ref4$userId;
       return [].concat((0, _toConsumableArray2.default)(useNativePlugin ? [{
         name: 'pmCollab',
         plugin: function plugin() {
@@ -115,9 +132,9 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
         }
       }] : []), [{
         name: 'collab',
-        plugin: function plugin(_ref4) {
-          var dispatch = _ref4.dispatch,
-            providerFactory = _ref4.providerFactory;
+        plugin: function plugin(_ref5) {
+          var dispatch = _ref5.dispatch,
+            providerFactory = _ref5.providerFactory;
           return (0, _main.createPlugin)(dispatch, providerFactory, providerResolver, executeProviderCode, options, featureFlags, api);
         }
       }, {

package/dist/cjs/pm-plugins/track-ncs-initialization.js

@@ -1,9 +1,11 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.trackNCSInitializationPluginKey = exports.createPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _collab = require("@atlaskit/editor-common/collab");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
@@ -44,6 +46,12 @@ var createPlugin = exports.createPlugin = function createPlugin() {
         }
         return prevPluginState;
       }
+    },
+    props: {
+      attributes: function attributes(editorState) {
+        var trackPluginState = trackNCSInitializationPluginKey.getState(editorState);
+        return (0, _defineProperty2.default)({}, 'data-has-collab-initialised', "".concat(Boolean(trackPluginState === null || trackPluginState === void 0 ? void 0 : trackPluginState.collabInitialisedAt)));
+      }
     }
   });
 };

package/dist/es2019/plugin.js

@@ -1,3 +1,4 @@
+import { AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { collab } from '@atlaskit/prosemirror-collab';
 import { addSynchronyErrorAnalytics } from './analytics';
 import { sendTransaction } from './events/send-transaction';
@@ -21,6 +22,20 @@ const providerBuilder = collabEditProviderPromise => async (codeToExecute, onErr
     }
   }
 };
+const createAddInlineCommentMark = providerPromise => ({
+  from,
+  to,
+  mark
+}) => {
+  providerPromise.then(provider => {
+    var _provider$api;
+    const commentMark = new AddMarkStep(Math.min(from, to), Math.max(from, to), mark);
+
+    // @ts-expect-error 2339: Property 'api' does not exist on type 'CollabEditProvider<CollabEvents>'.
+    (_provider$api = provider.api) === null || _provider$api === void 0 ? void 0 : _provider$api.addComment([commentMark]);
+  });
+  return false;
+};
 export const collabEditPlugin = ({
   config: options,
   api
@@ -57,7 +72,8 @@ export const collabEditPlugin = ({
       };
     },
     actions: {
-      getAvatarColor
+      getAvatarColor,
+      addInlineCommentMark: createAddInlineCommentMark(collabEditProviderPromise)
     },
     pmPlugins() {
       const {

package/dist/es2019/pm-plugins/track-ncs-initialization.js

@@ -38,6 +38,14 @@ export const createPlugin = () => {
         }
         return prevPluginState;
       }
+    },
+    props: {
+      attributes(editorState) {
+        const trackPluginState = trackNCSInitializationPluginKey.getState(editorState);
+        return {
+          ['data-has-collab-initialised']: `${Boolean(trackPluginState === null || trackPluginState === void 0 ? void 0 : trackPluginState.collabInitialisedAt)}`
+        };
+      }
     }
   });
 };

package/dist/esm/plugin.js

@@ -1,6 +1,7 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { collab } from '@atlaskit/prosemirror-collab';
 import { addSynchronyErrorAnalytics } from './analytics';
 import { sendTransaction } from './events/send-transaction';
@@ -49,10 +50,25 @@ var providerBuilder = function providerBuilder(collabEditProviderPromise) {
     };
   }();
 };
-export var collabEditPlugin = function collabEditPlugin(_ref2) {
+var createAddInlineCommentMark = function createAddInlineCommentMark(providerPromise) {
+  return function (_ref2) {
+    var from = _ref2.from,
+      to = _ref2.to,
+      mark = _ref2.mark;
+    providerPromise.then(function (provider) {
+      var _provider$api;
+      var commentMark = new AddMarkStep(Math.min(from, to), Math.max(from, to), mark);
+
+      // @ts-expect-error 2339: Property 'api' does not exist on type 'CollabEditProvider<CollabEvents>'.
+      (_provider$api = provider.api) === null || _provider$api === void 0 || _provider$api.addComment([commentMark]);
+    });
+    return false;
+  };
+};
+export var collabEditPlugin = function collabEditPlugin(_ref3) {
   var _api$featureFlags;
-  var options = _ref2.config,
-    api = _ref2.api;
+  var options = _ref3.config,
+    api = _ref3.api;
   var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
   var providerResolver = function providerResolver() {};
   var collabEditProviderPromise = new Promise(function (_providerResolver) {
@@ -84,14 +100,15 @@ export var collabEditPlugin = function collabEditPlugin(_ref2) {
       };
     },
     actions: {
-      getAvatarColor: getAvatarColor
+      getAvatarColor: getAvatarColor,
+      addInlineCommentMark: createAddInlineCommentMark(collabEditProviderPromise)
     },
     pmPlugins: function pmPlugins() {
-      var _ref3 = options || {},
-        _ref3$useNativePlugin = _ref3.useNativePlugin,
-        useNativePlugin = _ref3$useNativePlugin === void 0 ? false : _ref3$useNativePlugin,
-        _ref3$userId = _ref3.userId,
-        userId = _ref3$userId === void 0 ? null : _ref3$userId;
+      var _ref4 = options || {},
+        _ref4$useNativePlugin = _ref4.useNativePlugin,
+        useNativePlugin = _ref4$useNativePlugin === void 0 ? false : _ref4$useNativePlugin,
+        _ref4$userId = _ref4.userId,
+        userId = _ref4$userId === void 0 ? null : _ref4$userId;
       return [].concat(_toConsumableArray(useNativePlugin ? [{
         name: 'pmCollab',
         plugin: function plugin() {
@@ -108,9 +125,9 @@ export var collabEditPlugin = function collabEditPlugin(_ref2) {
         }
       }] : []), [{
         name: 'collab',
-        plugin: function plugin(_ref4) {
-          var dispatch = _ref4.dispatch,
-            providerFactory = _ref4.providerFactory;
+        plugin: function plugin(_ref5) {
+          var dispatch = _ref5.dispatch,
+            providerFactory = _ref5.providerFactory;
           return createPlugin(dispatch, providerFactory, providerResolver, executeProviderCode, options, featureFlags, api);
         }
       }, {

package/dist/esm/pm-plugins/track-ncs-initialization.js

@@ -1,3 +1,4 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { isDirtyTransaction } from '@atlaskit/editor-common/collab';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
@@ -38,6 +39,12 @@ export var createPlugin = function createPlugin() {
         }
         return prevPluginState;
       }
+    },
+    props: {
+      attributes: function attributes(editorState) {
+        var trackPluginState = trackNCSInitializationPluginKey.getState(editorState);
+        return _defineProperty({}, 'data-has-collab-initialised', "".concat(Boolean(trackPluginState === null || trackPluginState === void 0 ? void 0 : trackPluginState.collabInitialisedAt)));
+      }
     }
   });
 };

package/dist/types/types.d.ts

@@ -2,6 +2,7 @@ import type { CollabEditOptions, CollabEditProvider, CollabParticipant, Color, S
 import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { Mark } from '@atlaskit/editor-prosemirror/model';
 export type { InviteToEditComponentProps, InviteToEditButtonProps, CollabInviteToEditProps, CollabAnalyticsProps, } from '@atlaskit/editor-common/collab';
 export type PrivateCollabEditOptions = CollabEditOptions & {
     sanitizePrivateContent?: boolean;
@@ -35,5 +36,10 @@ export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
             index: number;
             color: Color;
         };
+        addInlineCommentMark: (props: {
+            from: number;
+            to: number;
+            mark: Mark;
+        }) => boolean;
     };
 }>;

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

@@ -2,6 +2,7 @@ import type { CollabEditOptions, CollabEditProvider, CollabParticipant, Color, S
 import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { Mark } from '@atlaskit/editor-prosemirror/model';
 export type { InviteToEditComponentProps, InviteToEditButtonProps, CollabInviteToEditProps, CollabAnalyticsProps, } from '@atlaskit/editor-common/collab';
 export type PrivateCollabEditOptions = CollabEditOptions & {
     sanitizePrivateContent?: boolean;
@@ -35,5 +36,10 @@ export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
             index: number;
             color: Color;
         };
+        addInlineCommentMark: (props: {
+            from: number;
+            to: number;
+            mark: Mark;
+        }) => boolean;
     };
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-collab-edit",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "Collab Edit plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -32,7 +32,7 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^77.3.0",
+    "@atlaskit/editor-common": "^77.4.0",
     "@atlaskit/editor-plugin-analytics": "0.4.7",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlaskit/editor-prosemirror": "3.0.0",