@atlaskit/editor-plugin-collab-edit 1.6.1 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 1.8.0
+
+### Minor Changes
+
+- [#115247](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/115247)
+  [`251d23ff9e6c8`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/251d23ff9e6c8) -
+  upgrade adf-schema version to 38.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
+## 1.7.0
+
+### Minor Changes
+
+- [#114811](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/114811)
+  [`ad0d2f10ef71b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ad0d2f10ef71b) -
+  CONFONBO-3268: Changes for the experiment Teammate Presence: expose 2 new collab events to add
+  statuses (viewing/editing) to Confluence
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.6.1
 
 ### Patch Changes

package/dist/cjs/actions.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.handleTelePointer = exports.handlePresence = exports.handleInit = exports.handleConnection = exports.getSendableSelection = exports.applyRemoteSteps = exports.applyRemoteData = void 0;
+exports.handleTelePointer = exports.handlePresence = exports.handleInit = exports.handleConnection = exports.handleActivityJoin = exports.handleActivityAck = exports.getSendableSelection = exports.applyRemoteSteps = exports.applyRemoteData = void 0;
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
@@ -30,6 +30,31 @@ var handlePresence = exports.handlePresence = function handlePresence(presenceDa
   var tr = view.state.tr;
   view.dispatch(tr.setMeta('presence', presenceData));
 };
+var ACTIVITY_EDITING = 'EDITING';
+
+/**
+ * A Handler for event "activity:ack" forwarded from NCS.
+ * This event "activity:ack" is emitted by the existing collaborators in response to a new collaborator
+ * joining. It is used to inform the new collaborator about the current actions or states of the existing
+ * collaborators, such as viewing or editing.
+ */
+var handleActivityAck = exports.handleActivityAck = function handleActivityAck() {};
+
+/**
+ * A Handler for event "activity:join" forwarded from NCS.
+ * Existing participant respond to the new joiner with their status.
+ * This event "activity:join" is emitted when a new collaborator joins the session. The event carries
+ * information about the action the new collaborator is currently doing in the session, such as viewing
+ * or editing.
+ */
+var handleActivityJoin = exports.handleActivityJoin = function handleActivityJoin(provider) {
+  if (provider) {
+    provider.sendMessage({
+      type: 'activity:ack',
+      activity: ACTIVITY_EDITING
+    });
+  }
+};
 var applyRemoteData = exports.applyRemoteData = function applyRemoteData(remoteData, view, options) {
   var json = remoteData.json,
     _remoteData$userIds = remoteData.userIds,

package/dist/cjs/events/handlers.js

@@ -51,6 +51,12 @@ var subscribe = exports.subscribe = effect(function (view, provider, options, fe
     presenceHandler: function presenceHandler(data) {
       return (0, _actions.handlePresence)(data, view);
     },
+    activityAckHandler: function activityAckHandler() {
+      return (0, _actions.handleActivityAck)();
+    },
+    activityJoinHandler: function activityJoinHandler() {
+      return (0, _actions.handleActivityJoin)(provider);
+    },
     telepointerHandler: function telepointerHandler(data) {
       return (0, _actions.handleTelePointer)(data, view);
     },
@@ -76,10 +82,10 @@ var subscribe = exports.subscribe = effect(function (view, provider, options, fe
       }
     }
   };
-  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
+  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('activity:ack', handlers.activityAckHandler).on('activity:join', handlers.activityJoinHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
   return function () {
     unsubscribeSynchronyEntity();
-    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
+    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('activity:ack', handlers.activityAckHandler).off('activity:join', handlers.activityJoinHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
   };
 }, function (previousDeps, currentDeps) {
   return currentDeps && currentDeps.every(function (dep, i) {

package/dist/es2019/actions.js

@@ -36,6 +36,31 @@ export const handlePresence = (presenceData, view) => {
   } = view;
   view.dispatch(tr.setMeta('presence', presenceData));
 };
+const ACTIVITY_EDITING = 'EDITING';
+
+/**
+ * A Handler for event "activity:ack" forwarded from NCS.
+ * This event "activity:ack" is emitted by the existing collaborators in response to a new collaborator
+ * joining. It is used to inform the new collaborator about the current actions or states of the existing
+ * collaborators, such as viewing or editing.
+ */
+export const handleActivityAck = () => {};
+
+/**
+ * A Handler for event "activity:join" forwarded from NCS.
+ * Existing participant respond to the new joiner with their status.
+ * This event "activity:join" is emitted when a new collaborator joins the session. The event carries
+ * information about the action the new collaborator is currently doing in the session, such as viewing
+ * or editing.
+ */
+export const handleActivityJoin = provider => {
+  if (provider) {
+    provider.sendMessage({
+      type: 'activity:ack',
+      activity: ACTIVITY_EDITING
+    });
+  }
+};
 export const applyRemoteData = (remoteData, view, options) => {
   const {
     json,

package/dist/es2019/events/handlers.js

@@ -1,4 +1,4 @@
-import { applyRemoteData, handleConnection, handleInit, handlePresence, handleTelePointer } from '../actions';
+import { applyRemoteData, handleActivityAck, handleActivityJoin, handleConnection, handleInit, handlePresence, handleTelePointer } from '../actions';
 import { addSynchronyEntityAnalytics, addSynchronyErrorAnalytics } from '../analytics';
 const effect = (fn, eq) => {
   let previousDeps;
@@ -36,6 +36,8 @@ export const subscribe = effect((view, provider, options, featureFlags, _provide
     connectedHandler: data => handleConnection(data, view),
     dataHandler: data => applyRemoteData(data, view, options),
     presenceHandler: data => handlePresence(data, view),
+    activityAckHandler: () => handleActivityAck(),
+    activityJoinHandler: () => handleActivityJoin(provider),
     telepointerHandler: data => handleTelePointer(data, view),
     localStepsHandler: data => {
       const {
@@ -64,9 +66,9 @@ export const subscribe = effect((view, provider, options, featureFlags, _provide
       }
     }
   };
-  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
+  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('activity:ack', handlers.activityAckHandler).on('activity:join', handlers.activityJoinHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
   return () => {
     unsubscribeSynchronyEntity();
-    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
+    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('activity:ack', handlers.activityAckHandler).off('activity:join', handlers.activityJoinHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
   };
 }, (previousDeps, currentDeps) => currentDeps && currentDeps.every((dep, i) => dep === previousDeps[i]));

package/dist/esm/actions.js

@@ -24,6 +24,31 @@ export var handlePresence = function handlePresence(presenceData, view) {
   var tr = view.state.tr;
   view.dispatch(tr.setMeta('presence', presenceData));
 };
+var ACTIVITY_EDITING = 'EDITING';
+
+/**
+ * A Handler for event "activity:ack" forwarded from NCS.
+ * This event "activity:ack" is emitted by the existing collaborators in response to a new collaborator
+ * joining. It is used to inform the new collaborator about the current actions or states of the existing
+ * collaborators, such as viewing or editing.
+ */
+export var handleActivityAck = function handleActivityAck() {};
+
+/**
+ * A Handler for event "activity:join" forwarded from NCS.
+ * Existing participant respond to the new joiner with their status.
+ * This event "activity:join" is emitted when a new collaborator joins the session. The event carries
+ * information about the action the new collaborator is currently doing in the session, such as viewing
+ * or editing.
+ */
+export var handleActivityJoin = function handleActivityJoin(provider) {
+  if (provider) {
+    provider.sendMessage({
+      type: 'activity:ack',
+      activity: ACTIVITY_EDITING
+    });
+  }
+};
 export var applyRemoteData = function applyRemoteData(remoteData, view, options) {
   var json = remoteData.json,
     _remoteData$userIds = remoteData.userIds,

package/dist/esm/events/handlers.js

@@ -1,4 +1,4 @@
-import { applyRemoteData, handleConnection, handleInit, handlePresence, handleTelePointer } from '../actions';
+import { applyRemoteData, handleActivityAck, handleActivityJoin, handleConnection, handleInit, handlePresence, handleTelePointer } from '../actions';
 import { addSynchronyEntityAnalytics, addSynchronyErrorAnalytics } from '../analytics';
 var effect = function effect(fn, eq) {
   var previousDeps;
@@ -45,6 +45,12 @@ export var subscribe = effect(function (view, provider, options, featureFlags, _
     presenceHandler: function presenceHandler(data) {
       return handlePresence(data, view);
     },
+    activityAckHandler: function activityAckHandler() {
+      return handleActivityAck();
+    },
+    activityJoinHandler: function activityJoinHandler() {
+      return handleActivityJoin(provider);
+    },
     telepointerHandler: function telepointerHandler(data) {
       return handleTelePointer(data, view);
     },
@@ -70,10 +76,10 @@ export var subscribe = effect(function (view, provider, options, featureFlags, _
       }
     }
   };
-  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
+  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('activity:ack', handlers.activityAckHandler).on('activity:join', handlers.activityJoinHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
   return function () {
     unsubscribeSynchronyEntity();
-    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
+    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('activity:ack', handlers.activityAckHandler).off('activity:join', handlers.activityJoinHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
   };
 }, function (previousDeps, currentDeps) {
   return currentDeps && currentDeps.every(function (dep, i) {

package/dist/types/actions.d.ts

@@ -1,10 +1,25 @@
-import type { CollabEventConnectionData, CollabEventInitData, CollabEventPresenceData, CollabEventRemoteData, CollabSendableSelection, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
+import type { CollabEditProvider, CollabEventConnectionData, CollabEventInitData, CollabEventPresenceData, CollabEventRemoteData, CollabSendableSelection, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
 import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { PrivateCollabEditOptions } from './types';
 export declare const handleInit: (initData: CollabEventInitData, view: EditorView, options?: PrivateCollabEditOptions) => void;
 export declare const handleConnection: (connectionData: CollabEventConnectionData, view: EditorView) => void;
 export declare const handlePresence: (presenceData: CollabEventPresenceData, view: EditorView) => void;
+/**
+ * A Handler for event "activity:ack" forwarded from NCS.
+ * This event "activity:ack" is emitted by the existing collaborators in response to a new collaborator
+ * joining. It is used to inform the new collaborator about the current actions or states of the existing
+ * collaborators, such as viewing or editing.
+ */
+export declare const handleActivityAck: () => void;
+/**
+ * A Handler for event "activity:join" forwarded from NCS.
+ * Existing participant respond to the new joiner with their status.
+ * This event "activity:join" is emitted when a new collaborator joins the session. The event carries
+ * information about the action the new collaborator is currently doing in the session, such as viewing
+ * or editing.
+ */
+export declare const handleActivityJoin: (provider: CollabEditProvider | null) => void;
 export declare const applyRemoteData: (remoteData: CollabEventRemoteData, view: EditorView, options: PrivateCollabEditOptions) => void;
 export declare const applyRemoteSteps: (json: any[], view: EditorView, userIds?: (number | string)[], options?: PrivateCollabEditOptions) => void;
 export declare const handleTelePointer: (telepointerData: CollabTelepointerPayload, view: EditorView) => void;

package/dist/types/events/handlers.d.ts

@@ -13,6 +13,8 @@ export interface CollabHandlers {
     connectedHandler: (data: CollabEventConnectionData) => void;
     dataHandler: (data: CollabEventRemoteData) => void;
     presenceHandler: (data: CollabEventPresenceData) => void;
+    activityAckHandler: () => void;
+    activityJoinHandler: () => void;
     telepointerHandler: (data: CollabTelepointerPayload) => void;
     localStepsHandler: (data: CollabEventLocalStepData) => void;
     errorHandler: (error: any) => void;

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

@@ -1,10 +1,25 @@
-import type { CollabEventConnectionData, CollabEventInitData, CollabEventPresenceData, CollabEventRemoteData, CollabSendableSelection, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
+import type { CollabEditProvider, CollabEventConnectionData, CollabEventInitData, CollabEventPresenceData, CollabEventRemoteData, CollabSendableSelection, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
 import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { PrivateCollabEditOptions } from './types';
 export declare const handleInit: (initData: CollabEventInitData, view: EditorView, options?: PrivateCollabEditOptions) => void;
 export declare const handleConnection: (connectionData: CollabEventConnectionData, view: EditorView) => void;
 export declare const handlePresence: (presenceData: CollabEventPresenceData, view: EditorView) => void;
+/**
+ * A Handler for event "activity:ack" forwarded from NCS.
+ * This event "activity:ack" is emitted by the existing collaborators in response to a new collaborator
+ * joining. It is used to inform the new collaborator about the current actions or states of the existing
+ * collaborators, such as viewing or editing.
+ */
+export declare const handleActivityAck: () => void;
+/**
+ * A Handler for event "activity:join" forwarded from NCS.
+ * Existing participant respond to the new joiner with their status.
+ * This event "activity:join" is emitted when a new collaborator joins the session. The event carries
+ * information about the action the new collaborator is currently doing in the session, such as viewing
+ * or editing.
+ */
+export declare const handleActivityJoin: (provider: CollabEditProvider | null) => void;
 export declare const applyRemoteData: (remoteData: CollabEventRemoteData, view: EditorView, options: PrivateCollabEditOptions) => void;
 export declare const applyRemoteSteps: (json: any[], view: EditorView, userIds?: (number | string)[], options?: PrivateCollabEditOptions) => void;
 export declare const handleTelePointer: (telepointerData: CollabTelepointerPayload, view: EditorView) => void;

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

@@ -13,6 +13,8 @@ export interface CollabHandlers {
     connectedHandler: (data: CollabEventConnectionData) => void;
     dataHandler: (data: CollabEventRemoteData) => void;
     presenceHandler: (data: CollabEventPresenceData) => void;
+    activityAckHandler: () => void;
+    activityJoinHandler: () => void;
     telepointerHandler: (data: CollabTelepointerPayload) => void;
     localStepsHandler: (data: CollabEventLocalStepData) => void;
     errorHandler: (error: any) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "1.6.1",
+	"version": "1.8.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,16 +32,16 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^37.0.0",
-		"@atlaskit/custom-steps": "^0.3.0",
-		"@atlaskit/editor-common": "^83.0.0",
-		"@atlaskit/editor-plugin-analytics": "1.3.1",
+		"@atlaskit/adf-schema": "^38.0.0",
+		"@atlaskit/custom-steps": "^0.4.0",
+		"@atlaskit/editor-common": "^83.3.0",
+		"@atlaskit/editor-plugin-analytics": "1.4.0",
 		"@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.5.0",
+		"@atlaskit/prosemirror-collab": "^0.6.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
@@ -51,11 +51,11 @@
 	"devDependencies": {
 		"@af/integration-testing": "*",
 		"@af/visual-regression": "*",
-		"@atlaskit/editor-plugin-mentions": "^1.7.0",
-		"@atlaskit/editor-plugin-text-formatting": "^1.8.0",
-		"@atlaskit/editor-plugin-type-ahead": "^1.3.0",
-		"@atlaskit/editor-plugin-unsupported-content": "^1.3.0",
-		"@atlaskit/editor-test-helpers": "^18.24.0",
+		"@atlaskit/editor-plugin-mentions": "^1.8.0",
+		"@atlaskit/editor-plugin-text-formatting": "^1.9.0",
+		"@atlaskit/editor-plugin-type-ahead": "^1.4.0",
+		"@atlaskit/editor-plugin-unsupported-content": "^1.4.0",
+		"@atlaskit/editor-test-helpers": "^18.25.0",
 		"@atlaskit/ssr": "*",
 		"@atlaskit/synchrony-test-helpers": "^2.4.0",
 		"@atlaskit/util-data-test": "^17.9.0",