@atlaskit/collab-provider 9.45.0 → 9.46.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.46.0
+
+### Minor Changes
+
+- [#163507](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/163507)
+  [`2fe2661c3c1e0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2fe2661c3c1e0) -
+  EDF-1842 Push agent information to collab session
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.45.0
 
 ### Minor Changes

package/afm-cc/tsconfig.json

@@ -29,6 +29,9 @@
         {
             "path": "../../editor-json-transformer/afm-cc/tsconfig.json"
         },
+        {
+            "path": "../../../measurement/feature-gate-js-client/afm-cc/tsconfig.json"
+        },
         {
             "path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
         },

package/afm-jira/tsconfig.json

@@ -29,6 +29,9 @@
 		{
 			"path": "../../editor-json-transformer/afm-jira/tsconfig.json"
 		},
+		{
+			"path": "../../../measurement/feature-gate-js-client/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../../platform/feature-flags/afm-jira/tsconfig.json"
 		},

package/dist/cjs/helpers/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getSubProduct = exports.getStepUGCFreeDetails = exports.getProduct = exports.createLogger = void 0;
+exports.isAIProviderID = exports.getSubProduct = exports.getStepUGCFreeDetails = exports.getProduct = exports.createLogger = void 0;
 exports.sleep = sleep;
 var createLogger = exports.createLogger = function createLogger(prefix) {
   var color = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'blue';
@@ -20,6 +20,9 @@ function sleep(ms) {
     setTimeout(resolve, ms);
   });
 }
+var isAIProviderID = exports.isAIProviderID = function isAIProviderID(id) {
+  return typeof id === 'string' && id.startsWith('agent:');
+};
 var getProduct = exports.getProduct = function getProduct(productInfo) {
   var _productInfo$product;
   return (_productInfo$product = productInfo === null || productInfo === void 0 ? void 0 : productInfo.product) !== null && _productInfo$product !== void 0 ? _productInfo$product : 'unknown';

package/dist/cjs/participants/participants-service.js

@@ -13,6 +13,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _disconnectedReasonMapper = require("../disconnected-reason-mapper");
 var _const = require("../helpers/const");
 var _telepointersHelper = require("./telepointers-helper");
+var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
 var _participantsHelper = require("./participants-helper");
 var _participantsState = require("./participants-state");
 var _utils = require("../helpers/utils");
@@ -41,6 +42,28 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
     var getPresenceData = arguments.length > 6 ? arguments[6] : undefined;
     var setUserId = arguments.length > 7 ? arguments[7] : undefined;
     (0, _classCallCheck2.default)(this, ParticipantsService);
+    (0, _defineProperty2.default)(this, "sendAIProviderChanged", function (payload) {
+      var isFacepileExperimentEnabled = _featureGateJsClient.default.getExperimentValue('platform_editor_ai_facepile', 'isEnabled', false);
+      if (isFacepileExperimentEnabled && payload.providerId) {
+        for (var propKey in payload.permit) {
+          if (payload.permit.hasOwnProperty(propKey)) {
+            payload.permit[propKey] = false;
+          }
+        }
+        var presencePayload = {
+          sessionId: "".concat(payload.providerId, "::").concat(payload.sessionId),
+          userId: payload.providerId,
+          clientId: "".concat(payload.providerId, "::").concat(payload.clientId),
+          permit: payload.permit,
+          timestamp: Date.now()
+        };
+        if (payload.action === 'add') {
+          _this.channelBroadcast('participant:updated', presencePayload);
+        } else if (payload.action === 'remove') {
+          _this.channelBroadcast('participant:left', presencePayload);
+        }
+      }
+    });
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
@@ -106,8 +129,31 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
      * Called when a participant leaves the session.
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    (0, _defineProperty2.default)(this, "onParticipantLeft", function (_ref2) {
-      var sessionId = _ref2.sessionId;
+    (0, _defineProperty2.default)(this, "onParticipantLeft", function (payload) {
+      var sessionId = payload.sessionId;
+      var isFacepileExperimentEnabled = _featureGateJsClient.default.getExperimentValue('platform_editor_ai_facepile', 'isEnabled', false);
+      if (isFacepileExperimentEnabled) {
+        var _payload$data;
+        // When an agent leaves a session, the backend service returns the original user's
+        // session ID accompanied by a payload containing the agent's session ID.
+        // If the user session leaves, we also want to remove all agent sessions associated.
+        if (payload !== null && payload !== void 0 && (_payload$data = payload.data) !== null && _payload$data !== void 0 && _payload$data.sessionId && (0, _utils.isAIProviderID)(payload.data.sessionId)) {
+          sessionId = payload.data.sessionId;
+        } else {
+          var associatedAgents = _this.getAIProviderParticipants().filter(function (ap) {
+            return ap.sessionId.endsWith(sessionId);
+          });
+          associatedAgents.forEach(function (agent) {
+            _this.onParticipantLeft({
+              sessionId: sessionId,
+              timestamp: payload.timestamp,
+              data: agent,
+              userId: undefined,
+              clientId: ''
+            });
+          });
+        }
+      }
       _this.participantsState.removeBySessionId(sessionId);
       _this.emitPresence({
         left: [{
@@ -318,6 +364,9 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
     (0, _defineProperty2.default)(this, "getParticipants", function () {
       return _this.participantsState.getParticipants();
     });
+    (0, _defineProperty2.default)(this, "getAIProviderParticipants", function () {
+      return _this.participantsState.getAIProviderParticipants();
+    });
     this.analyticsHelper = analyticsHelper;
     this.participantsState = participantsState;
     this.emit = emit;

package/dist/cjs/participants/participants-state.js

@@ -9,6 +9,7 @@ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _utils = require("../helpers/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 ParticipantsState = exports.ParticipantsState = /*#__PURE__*/(0, _createClass2.default)(function ParticipantsState() {
@@ -26,7 +27,19 @@ var ParticipantsState = exports.ParticipantsState = /*#__PURE__*/(0, _createClas
   (0, _defineProperty2.default)(this, "getParticipants", function () {
     return (
       // Spread to get deep copy
-      (0, _toConsumableArray2.default)(_this.participants.values()).map(function (p) {
+      (0, _toConsumableArray2.default)(_this.participants.values()).filter(function (p) {
+        return !(0, _utils.isAIProviderID)(p.userId);
+      }).map(function (p) {
+        return _objectSpread({}, p);
+      })
+    );
+  });
+  (0, _defineProperty2.default)(this, "getAIProviderParticipants", function () {
+    return (
+      // Spread to get deep copy
+      (0, _toConsumableArray2.default)(_this.participants.values()).filter(function (p) {
+        return (0, _utils.isAIProviderID)(p.userId);
+      }).map(function (p) {
         return _objectSpread({}, p);
       })
     );

package/dist/cjs/provider/index.js

@@ -278,6 +278,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getParticipants", function () {
       return _this.participantsService.getParticipants();
     });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getAIProviderParticipants", function () {
+      return _this.participantsService.getAIProviderParticipants();
+    });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getSessionId", function () {
       return _this.sessionId;
     });
@@ -460,8 +463,11 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     }
 
     /**
-     * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
+     * Send messages, such as telepointers,  and AI provider changes to NCS and other participants.
+     * Only used for telepointer data (text and node selections) in the editor and JWM.
+     * JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
+     *
      * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
@@ -485,6 +491,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           this.channel.broadcast((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' ? 'participant:activity-join' : 'participant:activity-ack', _objectSpread(_objectSpread({}, basePayload), {}, {
             activity: data.activity
           }), activityCallback());
+        } else if ((data === null || data === void 0 ? void 0 : data.type) === 'ai-provider:change') {
+          this.participantsService.sendAIProviderChanged(_objectSpread(_objectSpread({}, basePayload), data));
         }
       } catch (error) {
         var _this$analyticsHelper12;

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "9.45.0";
+var version = exports.version = "9.46.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/helpers/utils.js

@@ -9,6 +9,7 @@ export function sleep(ms) {
     setTimeout(resolve, ms);
   });
 }
+export const isAIProviderID = id => typeof id === 'string' && id.startsWith('agent:');
 export const getProduct = productInfo => {
   var _productInfo$product;
   return (_productInfo$product = productInfo === null || productInfo === void 0 ? void 0 : productInfo.product) !== null && _productInfo$product !== void 0 ? _productInfo$product : 'unknown';

package/dist/es2019/participants/participants-service.js

@@ -2,9 +2,10 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { disconnectedReasonMapper } from '../disconnected-reason-mapper';
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { telepointerFromStep } from './telepointers-helper';
+import FeatureGates from '@atlaskit/feature-gate-js-client';
 import { createParticipantFromPayload as enrichParticipant, PARTICIPANT_UPDATE_INTERVAL } from './participants-helper';
 import { ParticipantsState } from './participants-state';
-import { createLogger } from '../helpers/utils';
+import { createLogger, isAIProviderID } from '../helpers/utils';
 const logger = createLogger('PresenceService', 'pink');
 const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
 
@@ -19,6 +20,28 @@ const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
  */
 export class ParticipantsService {
   constructor(analyticsHelper, participantsState = new ParticipantsState(), emit, getUser, channelBroadcast, sendPresenceJoined, getPresenceData, setUserId) {
+    _defineProperty(this, "sendAIProviderChanged", payload => {
+      const isFacepileExperimentEnabled = FeatureGates.getExperimentValue('platform_editor_ai_facepile', 'isEnabled', false);
+      if (isFacepileExperimentEnabled && payload.providerId) {
+        for (const propKey in payload.permit) {
+          if (payload.permit.hasOwnProperty(propKey)) {
+            payload.permit[propKey] = false;
+          }
+        }
+        const presencePayload = {
+          sessionId: `${payload.providerId}::${payload.sessionId}`,
+          userId: payload.providerId,
+          clientId: `${payload.providerId}::${payload.clientId}`,
+          permit: payload.permit,
+          timestamp: Date.now()
+        };
+        if (payload.action === 'add') {
+          this.channelBroadcast('participant:updated', presencePayload);
+        } else if (payload.action === 'remove') {
+          this.channelBroadcast('participant:left', presencePayload);
+        }
+      }
+    });
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
@@ -63,9 +86,29 @@ export class ParticipantsService {
      * Called when a participant leaves the session.
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    _defineProperty(this, "onParticipantLeft", ({
-      sessionId
-    }) => {
+    _defineProperty(this, "onParticipantLeft", payload => {
+      let sessionId = payload.sessionId;
+      const isFacepileExperimentEnabled = FeatureGates.getExperimentValue('platform_editor_ai_facepile', 'isEnabled', false);
+      if (isFacepileExperimentEnabled) {
+        var _payload$data;
+        // When an agent leaves a session, the backend service returns the original user's
+        // session ID accompanied by a payload containing the agent's session ID.
+        // If the user session leaves, we also want to remove all agent sessions associated.
+        if (payload !== null && payload !== void 0 && (_payload$data = payload.data) !== null && _payload$data !== void 0 && _payload$data.sessionId && isAIProviderID(payload.data.sessionId)) {
+          sessionId = payload.data.sessionId;
+        } else {
+          const associatedAgents = this.getAIProviderParticipants().filter(ap => ap.sessionId.endsWith(sessionId));
+          associatedAgents.forEach(agent => {
+            this.onParticipantLeft({
+              sessionId,
+              timestamp: payload.timestamp,
+              data: agent,
+              userId: undefined,
+              clientId: ''
+            });
+          });
+        }
+      }
       this.participantsState.removeBySessionId(sessionId);
       this.emitPresence({
         left: [{
@@ -267,6 +310,9 @@ export class ParticipantsService {
     _defineProperty(this, "getParticipants", () => {
       return this.participantsState.getParticipants();
     });
+    _defineProperty(this, "getAIProviderParticipants", () => {
+      return this.participantsState.getAIProviderParticipants();
+    });
     this.analyticsHelper = analyticsHelper;
     this.participantsState = participantsState;
     this.emit = emit;

package/dist/es2019/participants/participants-state.js

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { isAIProviderID } from '../helpers/utils';
 export class ParticipantsState {
   constructor(baseParticipants = new Map()) {
     _defineProperty(this, "getBySessionId", sessionId => {
@@ -13,7 +14,12 @@ export class ParticipantsState {
     });
     _defineProperty(this, "getParticipants", () =>
     // Spread to get deep copy
-    [...this.participants.values()].map(p => ({
+    [...this.participants.values()].filter(p => !isAIProviderID(p.userId)).map(p => ({
+      ...p
+    })));
+    _defineProperty(this, "getAIProviderParticipants", () =>
+    // Spread to get deep copy
+    [...this.participants.values()].filter(p => isAIProviderID(p.userId)).map(p => ({
       ...p
     })));
     _defineProperty(this, "removeBySessionId", sessionId => this.participants.delete(sessionId));

package/dist/es2019/provider/index.js

@@ -231,6 +231,9 @@ export class Provider extends Emitter {
     _defineProperty(this, "getParticipants", () => {
       return this.participantsService.getParticipants();
     });
+    _defineProperty(this, "getAIProviderParticipants", () => {
+      return this.participantsService.getAIProviderParticipants();
+    });
     _defineProperty(this, "getSessionId", () => {
       return this.sessionId;
     });
@@ -397,8 +400,11 @@ export class Provider extends Emitter {
   }
 
   /**
-   * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
+   * Send messages, such as telepointers,  and AI provider changes to NCS and other participants.
+   * Only used for telepointer data (text and node selections) in the editor and JWM.
+   * JWM does some weird serialisation stuff on the node selections.
    * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
+   *
    * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
    * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
    * @param {CollabSendableSelection} data.selection Object representing the selected element
@@ -422,6 +428,11 @@ export class Provider extends Emitter {
           ...basePayload,
           activity: data.activity
         }, activityCallback());
+      } else if ((data === null || data === void 0 ? void 0 : data.type) === 'ai-provider:change') {
+        this.participantsService.sendAIProviderChanged({
+          ...basePayload,
+          ...data
+        });
       }
     } catch (error) {
       var _this$analyticsHelper12;

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.45.0";
+export const version = "9.46.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/helpers/utils.js

@@ -13,6 +13,9 @@ export function sleep(ms) {
     setTimeout(resolve, ms);
   });
 }
+export var isAIProviderID = function isAIProviderID(id) {
+  return typeof id === 'string' && id.startsWith('agent:');
+};
 export var getProduct = function getProduct(productInfo) {
   var _productInfo$product;
   return (_productInfo$product = productInfo === null || productInfo === void 0 ? void 0 : productInfo.product) !== null && _productInfo$product !== void 0 ? _productInfo$product : 'unknown';

package/dist/esm/participants/participants-service.js

@@ -8,9 +8,10 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { disconnectedReasonMapper } from '../disconnected-reason-mapper';
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { telepointerFromStep } from './telepointers-helper';
+import FeatureGates from '@atlaskit/feature-gate-js-client';
 import { createParticipantFromPayload as enrichParticipant, PARTICIPANT_UPDATE_INTERVAL } from './participants-helper';
 import { ParticipantsState } from './participants-state';
-import { createLogger } from '../helpers/utils';
+import { createLogger, isAIProviderID } from '../helpers/utils';
 var logger = createLogger('PresenceService', 'pink');
 var SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
 
@@ -34,6 +35,28 @@ export var ParticipantsService = /*#__PURE__*/function () {
     var getPresenceData = arguments.length > 6 ? arguments[6] : undefined;
     var setUserId = arguments.length > 7 ? arguments[7] : undefined;
     _classCallCheck(this, ParticipantsService);
+    _defineProperty(this, "sendAIProviderChanged", function (payload) {
+      var isFacepileExperimentEnabled = FeatureGates.getExperimentValue('platform_editor_ai_facepile', 'isEnabled', false);
+      if (isFacepileExperimentEnabled && payload.providerId) {
+        for (var propKey in payload.permit) {
+          if (payload.permit.hasOwnProperty(propKey)) {
+            payload.permit[propKey] = false;
+          }
+        }
+        var presencePayload = {
+          sessionId: "".concat(payload.providerId, "::").concat(payload.sessionId),
+          userId: payload.providerId,
+          clientId: "".concat(payload.providerId, "::").concat(payload.clientId),
+          permit: payload.permit,
+          timestamp: Date.now()
+        };
+        if (payload.action === 'add') {
+          _this.channelBroadcast('participant:updated', presencePayload);
+        } else if (payload.action === 'remove') {
+          _this.channelBroadcast('participant:left', presencePayload);
+        }
+      }
+    });
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
@@ -99,8 +122,31 @@ export var ParticipantsService = /*#__PURE__*/function () {
      * Called when a participant leaves the session.
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    _defineProperty(this, "onParticipantLeft", function (_ref2) {
-      var sessionId = _ref2.sessionId;
+    _defineProperty(this, "onParticipantLeft", function (payload) {
+      var sessionId = payload.sessionId;
+      var isFacepileExperimentEnabled = FeatureGates.getExperimentValue('platform_editor_ai_facepile', 'isEnabled', false);
+      if (isFacepileExperimentEnabled) {
+        var _payload$data;
+        // When an agent leaves a session, the backend service returns the original user's
+        // session ID accompanied by a payload containing the agent's session ID.
+        // If the user session leaves, we also want to remove all agent sessions associated.
+        if (payload !== null && payload !== void 0 && (_payload$data = payload.data) !== null && _payload$data !== void 0 && _payload$data.sessionId && isAIProviderID(payload.data.sessionId)) {
+          sessionId = payload.data.sessionId;
+        } else {
+          var associatedAgents = _this.getAIProviderParticipants().filter(function (ap) {
+            return ap.sessionId.endsWith(sessionId);
+          });
+          associatedAgents.forEach(function (agent) {
+            _this.onParticipantLeft({
+              sessionId: sessionId,
+              timestamp: payload.timestamp,
+              data: agent,
+              userId: undefined,
+              clientId: ''
+            });
+          });
+        }
+      }
       _this.participantsState.removeBySessionId(sessionId);
       _this.emitPresence({
         left: [{
@@ -311,6 +357,9 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "getParticipants", function () {
       return _this.participantsState.getParticipants();
     });
+    _defineProperty(this, "getAIProviderParticipants", function () {
+      return _this.participantsState.getAIProviderParticipants();
+    });
     this.analyticsHelper = analyticsHelper;
     this.participantsState = participantsState;
     this.emit = emit;

package/dist/esm/participants/participants-state.js

@@ -4,6 +4,7 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _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 { isAIProviderID } from '../helpers/utils';
 export var ParticipantsState = /*#__PURE__*/_createClass(function ParticipantsState() {
   var _this = this;
   var baseParticipants = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Map();
@@ -19,7 +20,19 @@ export var ParticipantsState = /*#__PURE__*/_createClass(function ParticipantsSt
   _defineProperty(this, "getParticipants", function () {
     return (
       // Spread to get deep copy
-      _toConsumableArray(_this.participants.values()).map(function (p) {
+      _toConsumableArray(_this.participants.values()).filter(function (p) {
+        return !isAIProviderID(p.userId);
+      }).map(function (p) {
+        return _objectSpread({}, p);
+      })
+    );
+  });
+  _defineProperty(this, "getAIProviderParticipants", function () {
+    return (
+      // Spread to get deep copy
+      _toConsumableArray(_this.participants.values()).filter(function (p) {
+        return isAIProviderID(p.userId);
+      }).map(function (p) {
         return _objectSpread({}, p);
       })
     );

package/dist/esm/provider/index.js

@@ -271,6 +271,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _defineProperty(_assertThisInitialized(_this), "getParticipants", function () {
       return _this.participantsService.getParticipants();
     });
+    _defineProperty(_assertThisInitialized(_this), "getAIProviderParticipants", function () {
+      return _this.participantsService.getAIProviderParticipants();
+    });
     _defineProperty(_assertThisInitialized(_this), "getSessionId", function () {
       return _this.sessionId;
     });
@@ -453,8 +456,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     }
 
     /**
-     * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
+     * Send messages, such as telepointers,  and AI provider changes to NCS and other participants.
+     * Only used for telepointer data (text and node selections) in the editor and JWM.
+     * JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
+     *
      * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
@@ -478,6 +484,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           this.channel.broadcast((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' ? 'participant:activity-join' : 'participant:activity-ack', _objectSpread(_objectSpread({}, basePayload), {}, {
             activity: data.activity
           }), activityCallback());
+        } else if ((data === null || data === void 0 ? void 0 : data.type) === 'ai-provider:change') {
+          this.participantsService.sendAIProviderChanged(_objectSpread(_objectSpread({}, basePayload), data));
         }
       } catch (error) {
         var _this$analyticsHelper12;

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.45.0";
+export var version = "9.46.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/helpers/utils.d.ts

@@ -2,6 +2,7 @@ import type { ProductInformation } from '../types';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
+export declare const isAIProviderID: (id: string) => boolean;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;
 export type UGCFreeStepDetails = {

package/dist/types/participants/participants-helper.d.ts

@@ -5,6 +5,7 @@ export type ParticipantsMap = Map<string, ProviderParticipant>;
 export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId' | 'email' | 'isGuest'>>) | undefined;
 export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {
     timestamp: number;
+    data?: Record<string, any> | undefined;
 } & {
     userId: string;
 }, getUser: GetUserType) => Promise<ProviderParticipant>;

package/dist/types/participants/participants-service.d.ts

@@ -1,6 +1,6 @@
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { CollabEventDisconnectedData, ChannelEvent, PresenceData, PresencePayload, TelepointerPayload, ActivityPayload } from '../types';
-import type { CollabActivityData, CollabEventPresenceData, CollabTelepointerPayload, ProviderParticipant, StepJson } from '@atlaskit/editor-common/collab';
+import type { CollabActivityData, CollabEventPresenceData, CollabTelepointerPayload, ProviderParticipant, StepJson, UserPermitType } from '@atlaskit/editor-common/collab';
 import type { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -24,6 +24,14 @@ export declare class ParticipantsService {
     private participantUpdateTimeout;
     private presenceUpdateTimeout;
     constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState, emit: (evt: 'presence' | 'telepointer' | 'disconnected' | 'activity:join' | 'activity:ack', data: CollabEventPresenceData | CollabTelepointerPayload | CollabEventDisconnectedData | CollabActivityData) => void, getUser: GetUserType, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void, getPresenceData: () => PresenceData, setUserId: (id: string) => void);
+    sendAIProviderChanged: (payload: {
+        userId: string;
+        sessionId: string;
+        clientId: string | number;
+        providerId?: string;
+        action: 'add' | 'remove';
+        permit?: UserPermitType;
+    }) => void;
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
@@ -34,7 +42,7 @@ export declare class ParticipantsService {
      * Called when a participant leaves the session.
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    onParticipantLeft: ({ sessionId }: PresencePayload) => void;
+    onParticipantLeft: (payload: PresencePayload) => void;
     disconnect: (reason: string, sessionId: string | undefined) => void;
     /**
      * Updates when users were last active
@@ -105,4 +113,5 @@ export declare class ParticipantsService {
      *
      */
     getParticipants: () => ProviderParticipant[];
+    getAIProviderParticipants: () => ProviderParticipant[];
 }

package/dist/types/participants/participants-state.d.ts

@@ -6,6 +6,7 @@ export declare class ParticipantsState {
     getBySessionId: (sessionId: string) => ProviderParticipant | undefined;
     setBySessionId: (sessionId: string, participant: ProviderParticipant) => void;
     getParticipants: () => ProviderParticipant[];
+    getAIProviderParticipants: () => ProviderParticipant[];
     removeBySessionId: (sessionId: string) => boolean;
     clear: () => void;
     doesntHave: (sessionId: string) => boolean;

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

@@ -2,7 +2,7 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { Emitter } from '../emitter';
 import type { Config } from '../types';
-import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabActivityJoinPayload, CollabActivityAckPayload } from '@atlaskit/editor-common/collab';
+import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabActivityJoinPayload, CollabActivityAckPayload, CollabActivityAIProviderChangedPayload } from '@atlaskit/editor-common/collab';
 import { Api } from '../api/api';
 import { NullApi } from '../api/null-api';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
@@ -82,14 +82,17 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private onErrorHandled;
     private isViewOnly;
     /**
-     * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
+     * Send messages, such as telepointers,  and AI provider changes to NCS and other participants.
+     * Only used for telepointer data (text and node selections) in the editor and JWM.
+     * JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
+     *
      * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session
      */
-    sendMessage(data: CollabTelepointerPayload | CollabActivityJoinPayload | CollabActivityAckPayload): void;
+    sendMessage(data: CollabTelepointerPayload | CollabActivityJoinPayload | CollabActivityAckPayload | CollabActivityAIProviderChangedPayload): void;
     private onDisconnected;
     /**
      * "Destroy" the provider, disconnect it's connection to the back-end service and unsubscribe all event listeners on the provider.
@@ -163,6 +166,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      *
      */
     getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getAIProviderParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
     getSessionId: () => string | undefined;
 }
 export {};

package/dist/types/types.d.ts

@@ -128,6 +128,7 @@ export type PresenceData = {
 };
 export type PresencePayload = PresenceData & {
     timestamp: number;
+    data?: Record<string, any>;
 };
 export type ActivityPayload = {
     userId: string | undefined;

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

@@ -2,6 +2,7 @@ import type { ProductInformation } from '../types';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
+export declare const isAIProviderID: (id: string) => boolean;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;
 export type UGCFreeStepDetails = {

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

@@ -5,6 +5,7 @@ export type ParticipantsMap = Map<string, ProviderParticipant>;
 export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId' | 'email' | 'isGuest'>>) | undefined;
 export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {
     timestamp: number;
+    data?: Record<string, any> | undefined;
 } & {
     userId: string;
 }, getUser: GetUserType) => Promise<ProviderParticipant>;

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

@@ -1,6 +1,6 @@
 import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { CollabEventDisconnectedData, ChannelEvent, PresenceData, PresencePayload, TelepointerPayload, ActivityPayload } from '../types';
-import type { CollabActivityData, CollabEventPresenceData, CollabTelepointerPayload, ProviderParticipant, StepJson } from '@atlaskit/editor-common/collab';
+import type { CollabActivityData, CollabEventPresenceData, CollabTelepointerPayload, ProviderParticipant, StepJson, UserPermitType } from '@atlaskit/editor-common/collab';
 import type { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -24,6 +24,14 @@ export declare class ParticipantsService {
     private participantUpdateTimeout;
     private presenceUpdateTimeout;
     constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState, emit: (evt: 'presence' | 'telepointer' | 'disconnected' | 'activity:join' | 'activity:ack', data: CollabEventPresenceData | CollabTelepointerPayload | CollabEventDisconnectedData | CollabActivityData) => void, getUser: GetUserType, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void, getPresenceData: () => PresenceData, setUserId: (id: string) => void);
+    sendAIProviderChanged: (payload: {
+        userId: string;
+        sessionId: string;
+        clientId: string | number;
+        providerId?: string;
+        action: 'add' | 'remove';
+        permit?: UserPermitType;
+    }) => void;
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
@@ -34,7 +42,7 @@ export declare class ParticipantsService {
      * Called when a participant leaves the session.
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    onParticipantLeft: ({ sessionId }: PresencePayload) => void;
+    onParticipantLeft: (payload: PresencePayload) => void;
     disconnect: (reason: string, sessionId: string | undefined) => void;
     /**
      * Updates when users were last active
@@ -105,4 +113,5 @@ export declare class ParticipantsService {
      *
      */
     getParticipants: () => ProviderParticipant[];
+    getAIProviderParticipants: () => ProviderParticipant[];
 }

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

@@ -6,6 +6,7 @@ export declare class ParticipantsState {
     getBySessionId: (sessionId: string) => ProviderParticipant | undefined;
     setBySessionId: (sessionId: string, participant: ProviderParticipant) => void;
     getParticipants: () => ProviderParticipant[];
+    getAIProviderParticipants: () => ProviderParticipant[];
     removeBySessionId: (sessionId: string) => boolean;
     clear: () => void;
     doesntHave: (sessionId: string) => boolean;

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

@@ -2,7 +2,7 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { Emitter } from '../emitter';
 import type { Config } from '../types';
-import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabActivityJoinPayload, CollabActivityAckPayload } from '@atlaskit/editor-common/collab';
+import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabActivityJoinPayload, CollabActivityAckPayload, CollabActivityAIProviderChangedPayload } from '@atlaskit/editor-common/collab';
 import { Api } from '../api/api';
 import { NullApi } from '../api/null-api';
 export declare const MAX_STEP_REJECTED_ERROR = 15;
@@ -82,14 +82,17 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private onErrorHandled;
     private isViewOnly;
     /**
-     * Send messages, such as telepointers, to NCS and other participants. Only used for telepointer data (text and node selections) in the editor and JWM. JWM does some weird serialisation stuff on the node selections.
+     * Send messages, such as telepointers,  and AI provider changes to NCS and other participants.
+     * Only used for telepointer data (text and node selections) in the editor and JWM.
+     * JWM does some weird serialisation stuff on the node selections.
      * Silently fails if an error occurs, since Presence isn't a critical functionality and self-restores over time.
+     *
      * @param {CollabTelepointerPayload} data Data you want to send to NCS / the other participants
      * @param {string} data.type Can only be 'telepointer' for now, we don't support anything else yet
      * @param {CollabSendableSelection} data.selection Object representing the selected element
      * @param {string} data.sessionId Identifier identifying the session
      */
-    sendMessage(data: CollabTelepointerPayload | CollabActivityJoinPayload | CollabActivityAckPayload): void;
+    sendMessage(data: CollabTelepointerPayload | CollabActivityJoinPayload | CollabActivityAckPayload | CollabActivityAIProviderChangedPayload): void;
     private onDisconnected;
     /**
      * "Destroy" the provider, disconnect it's connection to the back-end service and unsubscribe all event listeners on the provider.
@@ -163,6 +166,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      *
      */
     getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getAIProviderParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
     getSessionId: () => string | undefined;
 }
 export {};

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

@@ -128,6 +128,7 @@ export type PresenceData = {
 };
 export type PresencePayload = PresenceData & {
     timestamp: number;
+    data?: Record<string, any>;
 };
 export type ActivityPayload = {
     userId: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.45.0",
+	"version": "9.46.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -34,9 +34,10 @@
 	"dependencies": {
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^8.11.0",
-		"@atlaskit/editor-common": "^94.20.0",
+		"@atlaskit/editor-common": "^94.24.0",
 		"@atlaskit/editor-json-transformer": "^8.21.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
+		"@atlaskit/feature-gate-js-client": "^4.22.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
 		"@atlaskit/prosemirror-collab": "^0.10.0",
 		"@atlaskit/ufo": "^0.3.0",