@atlaskit/collab-provider 10.2.1 → 10.3.0

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

@@ -51,7 +51,7 @@ var MetadataService = exports.MetadataService = /*#__PURE__*/function () {
     this.providerEmitCallback = providerEmitCallback;
     this.broadcastMetadata = broadcastMetadata;
   }
-  (0, _createClass2.default)(MetadataService, [{
+  return (0, _createClass2.default)(MetadataService, [{
     key: "setTitle",
     value: function setTitle(title, broadcast) {
       if (broadcast) {
@@ -72,5 +72,4 @@ var MetadataService = exports.MetadataService = /*#__PURE__*/function () {
       this.metadata.editorWidth = editorWidth;
     }
   }]);
-  return MetadataService;
 }();

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

@@ -13,7 +13,6 @@ 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");
@@ -44,8 +43,7 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
     var getAIProviderActiveIds = arguments.length > 8 ? arguments[8] : 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) {
+      if (payload.providerId) {
         for (var propKey in payload.permit) {
           if (payload.permit.hasOwnProperty(propKey)) {
             payload.permit[propKey] = false;
@@ -155,29 +153,27 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
      * We emit the `presence` event to update the active avatars in the editor.
      */
     (0, _defineProperty2.default)(this, "onParticipantLeft", function (payload) {
+      var _payload$data;
       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: ''
-            });
+
+      // 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({
@@ -405,7 +401,7 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
     this.setUserId = setUserId;
     this.getAIProviderActiveIds = getAIProviderActiveIds;
   }
-  (0, _createClass2.default)(ParticipantsService, [{
+  return (0, _createClass2.default)(ParticipantsService, [{
     key: "emitTelepointersFromSteps",
     value:
     /**
@@ -422,5 +418,4 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
       });
     }
   }]);
-  return ParticipantsService;
 }();

package/dist/cjs/provider/index.js

@@ -9,11 +9,10 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
-var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
-var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _uuid = require("uuid");
 var _emitter = require("../emitter");
@@ -36,27 +35,26 @@ var _performance = require("../analytics/performance");
 var _nullApi = require("../api/null-api");
 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; }
-function _createSuper(t) { var r = _isNativeReflectConstruct(); return function () { var e, o = (0, _getPrototypeOf2.default)(t); if (r) { var s = (0, _getPrototypeOf2.default)(this).constructor; e = Reflect.construct(o, arguments, s); } else e = o.apply(this, arguments); return (0, _possibleConstructorReturn2.default)(this, e); }; }
+function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _superPropGet(t, o, e, r) { var p = (0, _get2.default)((0, _getPrototypeOf2.default)(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 var logger = (0, _utils.createLogger)('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
 var MAX_STEP_REJECTED_ERROR = exports.MAX_STEP_REJECTED_ERROR = 15;
 var MAX_STEP_REJECTED_ERROR_AGGRESSIVE = exports.MAX_STEP_REJECTED_ERROR_AGGRESSIVE = 2;
 var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
-  (0, _inherits2.default)(Provider, _Emitter);
-  var _super = _createSuper(Provider);
   function Provider(config) {
     var _this$config$productI;
     var _this;
     (0, _classCallCheck2.default)(this, Provider);
-    _this = _super.call(this);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isChannelInitialized", false);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isProviderInitialized", false);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isBuffered", false);
+    _this = _callSuper(this, Provider);
+    (0, _defineProperty2.default)(_this, "isChannelInitialized", false);
+    (0, _defineProperty2.default)(_this, "isProviderInitialized", false);
+    (0, _defineProperty2.default)(_this, "isBuffered", false);
     // User permit is used to determine if the user is allowed to view, comment or edit the document
     // Therefore, the initial value is false for all three
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "permit", {
+    (0, _defineProperty2.default)(_this, "permit", {
       isPermittedToView: false,
       isPermittedToComment: false,
       isPermittedToEdit: false
@@ -64,16 +62,16 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     // isBufferingEnabled is a boolean value passed to the config during provider creation.
     // It determines if the provider should initialize immediately and will only be true if:
     // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isBufferingEnabled", false);
+    (0, _defineProperty2.default)(_this, "isBufferingEnabled", false);
     // Local IDs of active AI Providers
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "aiProviderActiveIds", []);
+    (0, _defineProperty2.default)(_this, "aiProviderActiveIds", []);
     /**
      * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
      * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
      * @param evt - Event name to emit to subscribers
      * @param data - Event data to emit to subscribers
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "emitCallback", function (evt, data) {
+    (0, _defineProperty2.default)(_this, "emitCallback", function (evt, data) {
       return _this.emit(evt, data);
     });
     /**
@@ -81,7 +79,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      * Catches and logs any errors thrown by document service's updateDocument and updateMetadata methods and destroys the provider in case of errors.
      * Passing the document, metadata, version (either from the initial draft or from collab service)
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "updateDocumentAndMetadata", function (_ref) {
+    (0, _defineProperty2.default)(_this, "updateDocumentAndMetadata", function (_ref) {
       var doc = _ref.doc,
         version = _ref.version,
         metadata = _ref.metadata;
@@ -100,7 +98,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         _this.destroy();
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initializeChannel", function () {
+    (0, _defineProperty2.default)(_this, "initializeChannel", function () {
       _this.emit('connecting', {
         initial: true
       });
@@ -161,12 +159,12 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         _this.emit('permission', permit);
       }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
-      }).on('participant:activity-join', _this.participantsService.onParticipantActivityJoin).on('participant:activity-ack', _this.participantsService.onParticipantActivityAck).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);
+      }).on('participant:activity-join', _this.participantsService.onParticipantActivityJoin).on('participant:activity-ack', _this.participantsService.onParticipantActivityAck).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "setUserId", function (id) {
+    (0, _defineProperty2.default)(_this, "setUserId", function (id) {
       _this.userId = id;
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getPresenceData", function () {
+    (0, _defineProperty2.default)(_this, "getPresenceData", function () {
       return {
         sessionId: _this.sessionId,
         userId: _this.userId,
@@ -179,7 +177,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     /**
      * @param {InternalError} error The error to handle
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onErrorHandled", function (error) {
+    (0, _defineProperty2.default)(_this, "onErrorHandled", function (error) {
       var _error$data, _error$data2;
       // User tried committing steps but they were rejected because:
       // HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
@@ -198,11 +196,11 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         }
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getAIProviderActiveIds", function () {
+    (0, _defineProperty2.default)(_this, "getAIProviderActiveIds", function () {
       return _this.aiProviderActiveIds;
     });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref4) {
+    (0, _defineProperty2.default)(_this, "onDisconnected", function (_ref4) {
       var reason = _ref4.reason;
       _this.disconnectedAt = Date.now();
       _this.participantsService.disconnect(reason, _this.sessionId);
@@ -210,7 +208,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     /**
      * Returns the documents metadata
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getMetadata", function () {
+    (0, _defineProperty2.default)(_this, "getMetadata", function () {
       return _this.metadataService.getMetaData();
     });
     /**
@@ -218,7 +216,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      * Used for draft sync, a process running every 5s for the first editor of a document to sync the document to the Confluence back-end.
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+    (0, _defineProperty2.default)(_this, "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
       var _this$analyticsHelper5;
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
@@ -244,7 +242,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
+    (0, _defineProperty2.default)(_this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
       var _this$analyticsHelper6;
       return _regenerator.default.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
@@ -265,7 +263,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         }
       }, _callee2, null, [[0, 6]]);
     })));
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getUnconfirmedSteps", function () {
+    (0, _defineProperty2.default)(_this, "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
     });
     /**
@@ -273,26 +271,26 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      *
      * @returns {number} Returns the current ProseMirror version from the Editor State
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getCurrentPmVersion", function () {
+    (0, _defineProperty2.default)(_this, "getCurrentPmVersion", function () {
       return _this.documentService.getCurrentPmVersion();
     });
     /**
      * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "clearTimers", function () {
+    (0, _defineProperty2.default)(_this, "clearTimers", function () {
       clearTimeout(_this.presenceUpdateTimeout);
       _this.participantsService.clearTimers();
     });
     /**
      *
      */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getParticipants", function () {
+    (0, _defineProperty2.default)(_this, "getParticipants", function () {
       return _this.participantsService.getParticipants();
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getAIProviderParticipants", function () {
+    (0, _defineProperty2.default)(_this, "getAIProviderParticipants", function () {
       return _this.participantsService.getAIProviderParticipants();
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getSessionId", function () {
+    (0, _defineProperty2.default)(_this, "getSessionId", function () {
       return _this.sessionId;
     });
     _this.config = config;
@@ -325,9 +323,11 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     }, 5000);
     return _this;
   }
-  (0, _createClass2.default)(Provider, [{
+  (0, _inherits2.default)(Provider, _Emitter);
+  return (0, _createClass2.default)(Provider, [{
     key: "initialize",
     value:
+    // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
     /**
      * Initialisation logic, called by Jira with a dummy getState function, deprecated in favour of the setup method which allows more configuration
      * @param {Function} getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
@@ -531,6 +531,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       return this.unsubscribeAll();
     }
 
+    // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
     /**
      * Disconnect the provider, disconnect it's connection to the back-end service and unsubscribe all event listeners on the provider.
      * Used by Confluence to disable the provider when a user doesn't have access to a resource.
@@ -543,6 +544,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       return this.unsubscribeAll();
     }
 
+    // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
     /**
      * Disconnect the provider's connection to the back-end service and unsubscribe from all events emitted by this provider. Kept to keep roughly aligned to Synchrony API, which you need to call for each event.
      * @deprecated use destroy instead, it does the same thing
@@ -552,7 +554,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     key: "unsubscribeAll",
     value: function unsubscribeAll() {
       try {
-        (0, _get2.default)((0, _getPrototypeOf2.default)(Provider.prototype), "unsubscribeAll", this).call(this);
+        _superPropGet(Provider, "unsubscribeAll", this, 3)([]);
         this.channel.disconnect();
         if (this.sendStepsTimer) {
           clearInterval(this.sendStepsTimer);
@@ -567,6 +569,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       return this;
     }
 
+    // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
     /**
      * Update the title of the document in the collab provider and optionally broadcast it to other participants and NCS
      * @deprecated use setMetadata instead, it does the same thing
@@ -589,6 +592,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
 
+    // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
     /**
      * Set editor width, not used any more
      * @deprecated use setMetadata instead, it does the same thing
@@ -637,7 +641,6 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       return this.namespaceService.getIsNamespaceLocked();
     }
   }]);
-  return Provider;
 }(_emitter.Emitter);
 /**
  * Callback for handling the broadcast response of participant activity.

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 = "10.2.1";
+var version = exports.version = "10.3.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };