@atlaskit/collab-provider 7.5.1 → 7.6.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/collab-provider
 
+## 7.6.1
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+- Updated dependencies
+
+## 7.6.0
+
+### Minor Changes
+
+- [`5bd58e91664`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5bd58e91664) - [ESS-2513] Add tracking for number of participants in analytics
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.5.1
 
 ### Patch Changes

package/channel/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/channel.js",
   "module:es2019": "../dist/es2019/channel.js",
   "sideEffects": false,
-  "types": "../dist/types/channel.d.ts"
+  "types": "../dist/types/channel.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/channel.d.ts"
+      ]
+    }
+  }
 }

package/config/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/config.js",
   "module:es2019": "../dist/es2019/config.js",
   "sideEffects": false,
-  "types": "../dist/types/config.d.ts"
+  "types": "../dist/types/config.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/config.d.ts"
+      ]
+    }
+  }
 }

package/disconnected-reason-mapper/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/disconnected-reason-mapper.js",
   "module:es2019": "../dist/es2019/disconnected-reason-mapper.js",
   "sideEffects": false,
-  "types": "../dist/types/disconnected-reason-mapper.d.ts"
+  "types": "../dist/types/disconnected-reason-mapper.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/disconnected-reason-mapper.d.ts"
+      ]
+    }
+  }
 }

package/dist/cjs/analytics/index.js

@@ -43,7 +43,8 @@ var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(analytics
     actionSubject: _const.EVENT_SUBJECT,
     source: 'unknown',
     attributes: _objectSpread({
-      packageName: _const.ATTRIBUTES_PACKAGE
+      packageName: _const.ATTRIBUTES_PACKAGE,
+      collabService: _const.COLLAB_SERVICE.NCS
     }, analyticsEvent.attributes)
   };
   fireAnalyticsEvent(analyticsClient, payload);

package/dist/cjs/channel.js

@@ -79,7 +79,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         eventAction: _const.EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: _const.EVENT_STATUS.SUCCESS,
-          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+          documentAri: _this.config.documentAri
         }
       }, _this.analyticsClient);
 
@@ -100,7 +101,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             attributes: {
               eventStatus: _const.EVENT_STATUS.SUCCESS,
               // TODO: detect when document init fails and fire corresponding event for it
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+              documentAri: _this.config.documentAri
             }
           }, _this.analyticsClient);
           var doc = data.doc,
@@ -257,7 +259,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
           attributes: {
             eventStatus: _const.EVENT_STATUS.FAILURE,
             error: error,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            documentAri: _this2.config.documentAri
           }
         }, _this2.analyticsClient); // If error received with `data`, it means the connection is rejected
         // by the server on purpose for example no permission, so no need to

package/dist/cjs/helpers/const.js

@@ -3,11 +3,19 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.ATTRIBUTES_PACKAGE = exports.ACK_MAX_TRY = void 0;
+exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.COLLAB_SERVICE = exports.ATTRIBUTES_PACKAGE = exports.ACK_MAX_TRY = void 0;
 var ATTRIBUTES_PACKAGE = 'collabProvider';
 exports.ATTRIBUTES_PACKAGE = ATTRIBUTES_PACKAGE;
 var EVENT_SUBJECT = 'collab';
 exports.EVENT_SUBJECT = EVENT_SUBJECT;
+var COLLAB_SERVICE;
+exports.COLLAB_SERVICE = COLLAB_SERVICE;
+
+(function (COLLAB_SERVICE) {
+  COLLAB_SERVICE["NCS"] = "ncs";
+  COLLAB_SERVICE["SYNCHRONY"] = "synchrony";
+})(COLLAB_SERVICE || (exports.COLLAB_SERVICE = COLLAB_SERVICE = {}));
+
 var EVENT_ACTION;
 exports.EVENT_ACTION = EVENT_ACTION;
 
@@ -17,6 +25,7 @@ exports.EVENT_ACTION = EVENT_ACTION;
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+  EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
 })(EVENT_ACTION || (exports.EVENT_ACTION = EVENT_ACTION = {}));
 
 var EVENT_STATUS;

package/dist/cjs/provider/index.js

@@ -263,7 +263,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                 eventAction: _const.EVENT_ACTION.CATCHUP,
                 attributes: {
                   eventStatus: _const.EVENT_STATUS.SUCCESS,
-                  latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                  latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                  documentAri: _this.config.documentAri
                 }
               }, _this.analyticsClient);
               _context.next = 17;
@@ -278,7 +279,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                 attributes: {
                   eventStatus: _const.EVENT_STATUS.FAILURE,
                   error: _context.t0,
-                  latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
+                  latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration,
+                  documentAri: _this.config.documentAri
                 }
               }, _this.analyticsClient);
               logger("Catch-Up Failed:", _context.t0.message);
@@ -308,7 +310,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
             eventAction: _const.EVENT_ACTION.ADD_STEPS,
             attributes: {
               eventStatus: _const.EVENT_STATUS.FAILURE,
-              error: error
+              error: error,
+              documentAri: _this.config.documentAri
             }
           }, _this.analyticsClient);
           _this.stepRejectCounter++;
@@ -515,6 +518,16 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       });
 
       if (joined.length || left.length) {
+        var _this$participants$si;
+
+        (0, _analytics.triggerCollabAnalyticsEvent)({
+          eventAction: _const.EVENT_ACTION.UPDATE_PARTICIPANTS,
+          attributes: {
+            participants: (_this$participants$si = _this.participants.size) !== null && _this$participants$si !== void 0 ? _this$participants$si : 1,
+            documentAri: _this.config.documentAri
+          }
+        }, _this.analyticsClient);
+
         _this.emit('presence', _objectSpread(_objectSpread({}, joined.length ? {
           joined: joined
         } : {}), left.length ? {
@@ -663,7 +676,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                   eventAction: _const.EVENT_ACTION.CONVERT_PM_TO_ADF,
                   attributes: {
                     eventStatus: _const.EVENT_STATUS.SUCCESS,
-                    latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                    latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                    documentAri: _this.config.documentAri
                   }
                 }, _this.analyticsClient);
               } catch (error) {
@@ -673,7 +687,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                   attributes: {
                     eventStatus: _const.EVENT_STATUS.FAILURE,
                     latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
-                    error: error
+                    error: error,
+                    documentAri: _this.config.documentAri
                   }
                 }, _this.analyticsClient);
                 logger("Error when converting PM document to ADF: ", error);
@@ -843,7 +858,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         (0, _analytics.triggerCollabAnalyticsEvent)({
           eventAction: _const.EVENT_ACTION.ADD_STEPS,
           attributes: {
-            eventStatus: _const.EVENT_STATUS.SUCCESS
+            eventStatus: _const.EVENT_STATUS.SUCCESS,
+            documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
         this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.5.1",
+	"version": "7.6.1",
 	"sideEffects": false
 }

package/dist/es2019/analytics/index.js

@@ -1,4 +1,4 @@
-import { ATTRIBUTES_PACKAGE, EVENT_SUBJECT } from '../helpers/const';
+import { ATTRIBUTES_PACKAGE, EVENT_SUBJECT, COLLAB_SERVICE } from '../helpers/const';
 export const fireAnalyticsEvent = (analyticsClient, payload) => {
   if (!analyticsClient || !payload) {
     return;
@@ -25,6 +25,7 @@ export const triggerCollabAnalyticsEvent = (analyticsEvent, analyticsClient) =>
     source: 'unknown',
     attributes: {
       packageName: ATTRIBUTES_PACKAGE,
+      collabService: COLLAB_SERVICE.NCS,
       ...analyticsEvent.attributes
     }
   };

package/dist/es2019/channel.js

@@ -32,7 +32,8 @@ export class Channel extends Emitter {
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: EVENT_STATUS.SUCCESS,
-          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+          documentAri: this.config.documentAri
         }
       }, this.analyticsClient);
       this.emit('connected', {
@@ -53,7 +54,8 @@ export class Channel extends Emitter {
             attributes: {
               eventStatus: EVENT_STATUS.SUCCESS,
               // TODO: detect when document init fails and fire corresponding event for it
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+              documentAri: this.config.documentAri
             }
           }, this.analyticsClient);
           const {
@@ -193,7 +195,8 @@ export class Channel extends Emitter {
         attributes: {
           eventStatus: EVENT_STATUS.FAILURE,
           error: error,
-          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+          documentAri: this.config.documentAri
         }
       }, this.analyticsClient); // If error received with `data`, it means the connection is rejected
       // by the server on purpose for example no permission, so no need to

package/dist/es2019/helpers/const.js

@@ -1,5 +1,12 @@
 export const ATTRIBUTES_PACKAGE = 'collabProvider';
 export const EVENT_SUBJECT = 'collab';
+export let COLLAB_SERVICE;
+
+(function (COLLAB_SERVICE) {
+  COLLAB_SERVICE["NCS"] = "ncs";
+  COLLAB_SERVICE["SYNCHRONY"] = "synchrony";
+})(COLLAB_SERVICE || (COLLAB_SERVICE = {}));
+
 export let EVENT_ACTION;
 
 (function (EVENT_ACTION) {
@@ -8,6 +15,7 @@ export let EVENT_ACTION;
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+  EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
 })(EVENT_ACTION || (EVENT_ACTION = {}));
 
 export let EVENT_STATUS;

package/dist/es2019/provider/index.js

@@ -189,7 +189,8 @@ export class Provider extends Emitter {
           eventAction: EVENT_ACTION.CATCHUP,
           attributes: {
             eventStatus: EVENT_STATUS.SUCCESS,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
       } catch (error) {
@@ -199,7 +200,8 @@ export class Provider extends Emitter {
           attributes: {
             eventStatus: EVENT_STATUS.FAILURE,
             error: error,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
         logger(`Catch-Up Failed:`, error.message);
@@ -218,7 +220,8 @@ export class Provider extends Emitter {
             eventAction: EVENT_ACTION.ADD_STEPS,
             attributes: {
               eventStatus: EVENT_STATUS.FAILURE,
-              error
+              error,
+              documentAri: this.config.documentAri
             }
           }, this.analyticsClient);
           this.stepRejectCounter++;
@@ -396,6 +399,15 @@ export class Provider extends Emitter {
       left.forEach(p => this.participants.delete(p.sessionId));
 
       if (joined.length || left.length) {
+        var _this$participants$si;
+
+        triggerCollabAnalyticsEvent({
+          eventAction: EVENT_ACTION.UPDATE_PARTICIPANTS,
+          attributes: {
+            participants: (_this$participants$si = this.participants.size) !== null && _this$participants$si !== void 0 ? _this$participants$si : 1,
+            documentAri: this.config.documentAri
+          }
+        }, this.analyticsClient);
         this.emit('presence', { ...(joined.length ? {
             joined
           } : {}),
@@ -505,7 +517,8 @@ export class Provider extends Emitter {
           eventAction: EVENT_ACTION.CONVERT_PM_TO_ADF,
           attributes: {
             eventStatus: EVENT_STATUS.SUCCESS,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
       } catch (error) {
@@ -515,7 +528,8 @@ export class Provider extends Emitter {
           attributes: {
             eventStatus: EVENT_STATUS.FAILURE,
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-            error: error
+            error: error,
+            documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
         logger(`Error when converting PM document to ADF: `, error);
@@ -666,7 +680,8 @@ export class Provider extends Emitter {
       triggerCollabAnalyticsEvent({
         eventAction: EVENT_ACTION.ADD_STEPS,
         attributes: {
-          eventStatus: EVENT_STATUS.SUCCESS
+          eventStatus: EVENT_STATUS.SUCCESS,
+          documentAri: this.config.documentAri
         }
       }, this.analyticsClient);
       this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.5.1",
+	"version": "7.6.1",
 	"sideEffects": false
 }

package/dist/esm/analytics/index.js

@@ -4,7 +4,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-import { ATTRIBUTES_PACKAGE, EVENT_SUBJECT } from '../helpers/const';
+import { ATTRIBUTES_PACKAGE, EVENT_SUBJECT, COLLAB_SERVICE } from '../helpers/const';
 export var fireAnalyticsEvent = function fireAnalyticsEvent(analyticsClient, payload) {
   if (!analyticsClient || !payload) {
     return;
@@ -30,7 +30,8 @@ export var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(an
     actionSubject: EVENT_SUBJECT,
     source: 'unknown',
     attributes: _objectSpread({
-      packageName: ATTRIBUTES_PACKAGE
+      packageName: ATTRIBUTES_PACKAGE,
+      collabService: COLLAB_SERVICE.NCS
     }, analyticsEvent.attributes)
   };
   fireAnalyticsEvent(analyticsClient, payload);

package/dist/esm/channel.js

@@ -63,7 +63,8 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: EVENT_STATUS.SUCCESS,
-          latency: measure === null || measure === void 0 ? void 0 : measure.duration
+          latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+          documentAri: _this.config.documentAri
         }
       }, _this.analyticsClient);
 
@@ -85,7 +86,8 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
             attributes: {
               eventStatus: EVENT_STATUS.SUCCESS,
               // TODO: detect when document init fails and fire corresponding event for it
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+              documentAri: _this.config.documentAri
             }
           }, _this.analyticsClient);
           var doc = data.doc,
@@ -243,7 +245,8 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           attributes: {
             eventStatus: EVENT_STATUS.FAILURE,
             error: error,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+            documentAri: _this2.config.documentAri
           }
         }, _this2.analyticsClient); // If error received with `data`, it means the connection is rejected
         // by the server on purpose for example no permission, so no need to

package/dist/esm/helpers/const.js

@@ -1,5 +1,12 @@
 export var ATTRIBUTES_PACKAGE = 'collabProvider';
 export var EVENT_SUBJECT = 'collab';
+export var COLLAB_SERVICE;
+
+(function (COLLAB_SERVICE) {
+  COLLAB_SERVICE["NCS"] = "ncs";
+  COLLAB_SERVICE["SYNCHRONY"] = "synchrony";
+})(COLLAB_SERVICE || (COLLAB_SERVICE = {}));
+
 export var EVENT_ACTION;
 
 (function (EVENT_ACTION) {
@@ -8,6 +15,7 @@ export var EVENT_ACTION;
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+  EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
 })(EVENT_ACTION || (EVENT_ACTION = {}));
 
 export var EVENT_STATUS;

package/dist/esm/provider/index.js

@@ -239,7 +239,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                 eventAction: EVENT_ACTION.CATCHUP,
                 attributes: {
                   eventStatus: EVENT_STATUS.SUCCESS,
-                  latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                  latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                  documentAri: _this.config.documentAri
                 }
               }, _this.analyticsClient);
               _context.next = 17;
@@ -254,7 +255,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                 attributes: {
                   eventStatus: EVENT_STATUS.FAILURE,
                   error: _context.t0,
-                  latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
+                  latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration,
+                  documentAri: _this.config.documentAri
                 }
               }, _this.analyticsClient);
               logger("Catch-Up Failed:", _context.t0.message);
@@ -285,7 +287,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
             eventAction: EVENT_ACTION.ADD_STEPS,
             attributes: {
               eventStatus: EVENT_STATUS.FAILURE,
-              error: error
+              error: error,
+              documentAri: _this.config.documentAri
             }
           }, _this.analyticsClient);
           _this.stepRejectCounter++;
@@ -502,6 +505,16 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       });
 
       if (joined.length || left.length) {
+        var _this$participants$si;
+
+        triggerCollabAnalyticsEvent({
+          eventAction: EVENT_ACTION.UPDATE_PARTICIPANTS,
+          attributes: {
+            participants: (_this$participants$si = _this.participants.size) !== null && _this$participants$si !== void 0 ? _this$participants$si : 1,
+            documentAri: _this.config.documentAri
+          }
+        }, _this.analyticsClient);
+
         _this.emit('presence', _objectSpread(_objectSpread({}, joined.length ? {
           joined: joined
         } : {}), left.length ? {
@@ -653,7 +666,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                   eventAction: EVENT_ACTION.CONVERT_PM_TO_ADF,
                   attributes: {
                     eventStatus: EVENT_STATUS.SUCCESS,
-                    latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                    latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                    documentAri: _this.config.documentAri
                   }
                 }, _this.analyticsClient);
               } catch (error) {
@@ -663,7 +677,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
                   attributes: {
                     eventStatus: EVENT_STATUS.FAILURE,
                     latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
-                    error: error
+                    error: error,
+                    documentAri: _this.config.documentAri
                   }
                 }, _this.analyticsClient);
                 logger("Error when converting PM document to ADF: ", error);
@@ -834,7 +849,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         triggerCollabAnalyticsEvent({
           eventAction: EVENT_ACTION.ADD_STEPS,
           attributes: {
-            eventStatus: EVENT_STATUS.SUCCESS
+            eventStatus: EVENT_STATUS.SUCCESS,
+            documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
         this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.5.1",
+	"version": "7.6.1",
 	"sideEffects": false
 }

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

@@ -1,12 +1,17 @@
 import { ErrorPayload } from '../types';
 export declare const ATTRIBUTES_PACKAGE = "collabProvider";
 export declare const EVENT_SUBJECT = "collab";
+export declare enum COLLAB_SERVICE {
+    NCS = "ncs",
+    SYNCHRONY = "synchrony"
+}
 export declare enum EVENT_ACTION {
     CONNECTION = "connection",
     CATCHUP = "catchup",
     DOCUMENT_INIT = "documentInit",
     ADD_STEPS = "addSteps",
-    CONVERT_PM_TO_ADF = "convertPMToADF"
+    CONVERT_PM_TO_ADF = "convertPMToADF",
+    UPDATE_PARTICIPANTS = "updateParticipants"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -15,10 +20,12 @@ export declare enum EVENT_STATUS {
 export declare type AnalyticsEvent = {
     eventAction: EVENT_ACTION;
     attributes: {
-        eventStatus: EVENT_STATUS;
+        documentAri?: string;
+        eventStatus?: EVENT_STATUS;
         meetsSLO?: boolean;
         latency?: number;
         error?: ErrorPayload;
+        participants?: number;
     };
 };
 export declare const ACK_MAX_TRY = 10;

package/dist/types-ts4.0/analytics/index.d.ts

@@ -0,0 +1,5 @@
+import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import { GasPurePayload } from '@atlaskit/analytics-gas-types';
+import { AnalyticsEvent } from '../helpers/const';
+export declare const fireAnalyticsEvent: (analyticsClient?: AnalyticsWebClient | undefined, payload?: GasPurePayload | undefined) => void;
+export declare const triggerCollabAnalyticsEvent: (analyticsEvent: AnalyticsEvent, analyticsClient?: AnalyticsWebClient | undefined) => void;

package/dist/types-ts4.0/analytics/performance.d.ts

@@ -0,0 +1,12 @@
+export declare enum MEASURE_NAME {
+    CALLING_CATCHUP_API = "callingCatchupApi",
+    SOCKET_CONNECT = "socketConnect",
+    DOCUMENT_INIT = "documentInit",
+    CONVERT_PM_TO_ADF = "convertPMToADF"
+}
+export declare function startMeasure(measureName: MEASURE_NAME): void;
+export declare function stopMeasure(measureName: MEASURE_NAME, onMeasureComplete?: (duration: number, startTime: number) => void): {
+    duration: number;
+    startTime: number;
+} | undefined;
+export declare function clearMeasure(measureName: string): void;

package/dist/types-ts4.0/channel.d.ts

@@ -0,0 +1,27 @@
+import { Emitter } from './emitter';
+import type { Config, Socket, ChannelEvent, CatchupResponse, Metadata } from './types';
+export declare class Channel extends Emitter<ChannelEvent> {
+    private connected;
+    private config;
+    private socket;
+    private initialized;
+    private analyticsClient?;
+    constructor(config: Config);
+    getInitialized: () => boolean;
+    getConnected: () => boolean;
+    getSocket: () => Socket | null;
+    /**
+     * Connect to collab service using websockets
+     */
+    connect(): void;
+    private onConnect;
+    private onReceiveData;
+    fetchCatchup(fromVersion: number): Promise<CatchupResponse>;
+    /**
+     * Send message to service. Timestamp will be added server side.
+     */
+    broadcast<K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>): void;
+    sendMetadata(metadata: Metadata): void;
+    sendPresenceJoined(): void;
+    disconnect(): void;
+}

package/dist/types-ts4.0/config.d.ts

@@ -0,0 +1,5 @@
+export declare const SOCKET_IO_OPTIONS: {
+    RECONNECTION_DELAY_MAX: number;
+    RECONNECTION_DELAY: number;
+    RANDOMIZATION_FACTOR: number;
+};

package/dist/types-ts4.0/disconnected-reason-mapper.d.ts

@@ -0,0 +1,15 @@
+export declare const socketIOReasons: {
+    IO_CLIENT_DISCONNECT: string;
+    IO_SERVER_DISCONNECT: string;
+    TRANSPORT_CLOSED: string;
+    TRANSPORT_ERROR: string;
+    PING_TIMEOUT: string;
+};
+export declare enum DisconnectReason {
+    CLIENT_DISCONNECT = "CLIENT_DISCONNECT",
+    SERVER_DISCONNECT = "SERVER_DISCONNECT",
+    SOCKET_CLOSED = "SOCKET_CLOSED",
+    SOCKET_ERROR = "SOCKET_ERROR",
+    SOCKET_TIMEOUT = "SOCKET_TIMEOUT",
+    UNKNOWN_DISCONNECT = "UNKNOWN_DISCONNECT"
+}

package/dist/types-ts4.0/emitter.d.ts

@@ -0,0 +1,19 @@
+export declare class Emitter<T = any> {
+    private eventEmitter;
+    /**
+     * Emit events to subscribers
+     */
+    protected emit<K extends keyof T>(evt: K, data: T[K]): this;
+    /**
+     * Subscribe to events emitted by this provider
+     */
+    on<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
+    /**
+     * Unsubscribe from events emitted by this provider
+     */
+    off<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
+    /**
+     * Unsubscribe from all events emitted by this provider.
+     */
+    unsubscribeAll<K extends keyof T>(evt?: K): this;
+}

package/dist/types-ts4.0/error-code-mapper.d.ts

@@ -0,0 +1,32 @@
+import type { CollabErrorPayload, ErrorPayload } from './types';
+export declare const ErrorCodeMapper: {
+    noPermissionError: {
+        code: string;
+        message: string;
+    };
+    documentNotFound: {
+        code: string;
+        message: string;
+    };
+    hasToLogin: {
+        code: string;
+        message: string;
+    };
+    catchupFail: {
+        code: string;
+        message: string;
+    };
+    serviceUnvailable: {
+        code: string;
+        message: string;
+    };
+    failToSave: {
+        code: string;
+        message: string;
+    };
+    internalError: {
+        code: string;
+        message: string;
+    };
+};
+export declare const errorCodeMapper: (error: ErrorPayload) => CollabErrorPayload | undefined;

package/dist/types-ts4.0/helpers/const.d.ts

@@ -0,0 +1,31 @@
+import { ErrorPayload } from '../types';
+export declare const ATTRIBUTES_PACKAGE = "collabProvider";
+export declare const EVENT_SUBJECT = "collab";
+export declare enum COLLAB_SERVICE {
+    NCS = "ncs",
+    SYNCHRONY = "synchrony"
+}
+export declare enum EVENT_ACTION {
+    CONNECTION = "connection",
+    CATCHUP = "catchup",
+    DOCUMENT_INIT = "documentInit",
+    ADD_STEPS = "addSteps",
+    CONVERT_PM_TO_ADF = "convertPMToADF",
+    UPDATE_PARTICIPANTS = "updateParticipants"
+}
+export declare enum EVENT_STATUS {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+export declare type AnalyticsEvent = {
+    eventAction: EVENT_ACTION;
+    attributes: {
+        documentAri?: string;
+        eventStatus?: EVENT_STATUS;
+        meetsSLO?: boolean;
+        latency?: number;
+        error?: ErrorPayload;
+        participants?: number;
+    };
+};
+export declare const ACK_MAX_TRY = 10;

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

@@ -0,0 +1,11 @@
+import type { ProductInformation } from '../types';
+export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
+export declare const getParticipant: (userId: string) => {
+    userId: string;
+    name: string;
+    avatar: string;
+    email: string;
+};
+export declare function sleep(ms: number): Promise<unknown>;
+export declare const getProduct: (productInfo?: ProductInformation | undefined) => string;
+export declare const getSubProduct: (productInfo?: ProductInformation | undefined) => string;

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,2 @@
+export { Provider } from './provider';
+export type { CollabConnectedPayload, CollabDisconnectedPayload, CollabErrorPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, Socket, } from './types';

package/dist/types-ts4.0/provider/catchup.d.ts

@@ -0,0 +1,9 @@
+import type { CatchupOptions } from '../types';
+import { Mapping, Step } from 'prosemirror-transform';
+/**
+ * Rebase the steps based on the mapping pipeline.
+ * Some steps could be lost, if they are no longer
+ * invalid after rebased.
+ */
+export declare function rebaseSteps(steps: Step[], mapping: Mapping): Step[];
+export declare const catchup: (opt: CatchupOptions) => Promise<void>;

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

@@ -0,0 +1,124 @@
+import { EditorState, Transaction } from 'prosemirror-state';
+import { Emitter } from '../emitter';
+import { CollabEditProvider, ResolvedEditorState } from '@atlaskit/editor-common/collab';
+import type { Config, Metadata, CollabEvents } from '../types';
+import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
+export declare const CATCHUP_THROTTLE: number;
+export declare const MAX_STEP_REJECTED_ERROR = 15;
+declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
+export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
+    private participants;
+    private channel;
+    private config;
+    private getState;
+    private metadata;
+    private stepRejectCounter;
+    private analyticsClient?;
+    private isChannelInitialized;
+    private onSyncUpError?;
+    private sessionId?;
+    private clientId?;
+    private userId?;
+    private participantUpdateTimeout?;
+    private presenceUpdateTimeout?;
+    private disconnectedAt?;
+    constructor(config: Config);
+    private initializeChannel;
+    /**
+     * Called by collab plugin in editor when it's ready to
+     * initialize a collab session.
+     */
+    initialize(getState: () => EditorState): this;
+    setup({ getState, onSyncUpError, }: {
+        getState: () => EditorState;
+        onSyncUpError?: SyncUpErrorFunction;
+    }): this;
+    /**
+     * We can use this function to throttle/delay
+     * Any send steps operation
+     *
+     * The getState function will return the current EditorState
+     * from the EditorView.
+     */
+    private sendStepsFromCurrentState;
+    /**
+     * Send steps from transaction to other participants
+     */
+    send(_tr: Transaction | null, _oldState: EditorState | null, newState: EditorState): void;
+    /**
+     * Called when we receive steps from the service
+     */
+    private onStepsAdded;
+    private throttledCatchup;
+    private fitlerQueue;
+    private updateDocumentWithMetadata;
+    private applyLocalsteps;
+    private getCurrentPmVersion;
+    private getUnconfirmedSteps;
+    /**
+     * Called when:
+     *   * session established(offline -> online)
+     *   * try to accept steps but version is behind.
+     */
+    private catchup;
+    private onErrorHandled;
+    private pauseQueue?;
+    private queue;
+    private queueSteps;
+    private processQueue;
+    private processSteps;
+    /**
+     * Send messages, such as telepointers, to other participants.
+     */
+    sendMessage(data: any): void;
+    private sendPresence;
+    /**
+     * Called when a participant joins the session.
+     *
+     * We keep track of participants internally in this class, and emit the `presence` event to update
+     * the active avatars in the editor.
+     * This method will be triggered from backend to notify all participants to exchange presence
+     *
+     */
+    private onPresenceJoined;
+    private onPresence;
+    /**
+     * Called when a metadata is changed.
+     *
+     */
+    private onMetadataChanged;
+    /**
+     * Called when a participant leaves the session.
+     *
+     * We emit the `presence` event to update the active avatars in the editor.
+     */
+    private onParticipantLeft;
+    /**
+     * Called when we receive an update event from another participant.
+     */
+    private onParticipantUpdated;
+    /**
+     * Called when we receive a telepointer update from another
+     * participant.
+     */
+    private onParticipantTelepointer;
+    private updateParticipant;
+    /**
+     * Keep list of participants up to date. Filter out inactive users etc.
+     */
+    private updateParticipants;
+    private emitTelepointersFromSteps;
+    private disconnectedReasonMapper;
+    private onDisconnected;
+    destroy(): this;
+    disconnect(): this;
+    setTitle(title: string, broadcast?: boolean): void;
+    setEditorWidth(editorWidth: string, broadcast?: boolean): void;
+    setMetadata(metadata: Metadata): void;
+    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+    /**
+     * Unsubscribe from all events emitted by this provider.
+     */
+    unsubscribeAll(): this;
+}
+export {};

package/dist/types-ts4.0/socket-io-provider.d.ts

@@ -0,0 +1,4 @@
+import { Provider } from './provider';
+import { Socket, Config, ProductInformation } from './types';
+export declare function createSocketIOSocket(url: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation): Socket;
+export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

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

@@ -0,0 +1,170 @@
+import type { Transaction } from 'prosemirror-state';
+import type { Step } from 'prosemirror-transform';
+import type { CollabParticipant, CollabEventTelepointerData as EditorCollabTelepointerData, CollabEventConnectionData as EditorCollabConnetedData, CollabEventInitData as EditorCollabInitData, CollabEventRemoteData as EditorCollabData, CollabEventPresenceData as EditorCollabPresenceData } from '@atlaskit/editor-common/collab';
+import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import type { Manager } from 'socket.io-client';
+import type { DisconnectReason } from './disconnected-reason-mapper';
+export interface Storage {
+    get(key: string): Promise<string>;
+    set(key: string, value: string): Promise<void>;
+    delete(key: string): Promise<void>;
+}
+export interface Config {
+    url: string;
+    documentAri: string;
+    lifecycle?: Lifecycle;
+    storage?: Storage;
+    need404?: boolean;
+    createSocket: (path: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation) => Socket;
+    analyticsClient?: AnalyticsWebClient;
+    getUser?(userId: string): Promise<Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
+        userId: string;
+    }>;
+    permissionTokenRefresh?: () => Promise<string>;
+    productInfo?: ProductInformation;
+}
+interface SimpleEventEmitter {
+    on(event: string, fn: Function): SimpleEventEmitter;
+}
+export interface Socket extends SimpleEventEmitter {
+    id: string;
+    connect(): Socket;
+    emit(event: string, ...args: any[]): Socket;
+    close(): Socket;
+    io?: Manager;
+}
+export declare type LifecycleEvents = 'save' | 'restore';
+export declare type EventHandler = () => void;
+export interface Lifecycle {
+    on(event: LifecycleEvents, handler: EventHandler): void;
+}
+export declare type CollabConnectedPayload = EditorCollabConnetedData;
+export interface CollabDisconnectedPayload {
+    reason: DisconnectReason;
+    sid: string;
+}
+export interface CollabErrorPayload {
+    status: number;
+    code: string;
+    message: string;
+    reason?: string;
+}
+export interface CollabInitPayload extends EditorCollabInitData {
+    doc: any;
+    version: number;
+    userId?: string;
+    metadata?: Metadata;
+}
+export interface CollabDataPayload extends EditorCollabData {
+    version: number;
+    json: StepJson[];
+    userIds: string[];
+}
+export declare type CollabTelepointerPayload = EditorCollabTelepointerData;
+export declare type CollabPresencePayload = EditorCollabPresenceData;
+export declare type CollabMetadataPayload = Metadata;
+export declare type CollabLocalStepsPayload = {
+    steps: Step[];
+};
+export interface CollabEvents {
+    'metadata:changed': CollabMetadataPayload;
+    init: CollabInitPayload;
+    connected: CollabConnectedPayload;
+    disconnected: CollabDisconnectedPayload;
+    data: CollabDataPayload;
+    telepointer: CollabTelepointerPayload;
+    presence: CollabPresencePayload;
+    'local-steps': CollabLocalStepsPayload;
+    error: CollabErrorPayload;
+    entity: any;
+}
+export interface Metadata {
+    [key: string]: string | number | boolean;
+}
+export declare type InitPayload = {
+    doc: any;
+    version: number;
+    userId?: string;
+    metadata?: Metadata;
+};
+export declare type PresencePayload = {
+    sessionId: string;
+    userId: string;
+    clientId: string;
+    timestamp: number;
+};
+export declare type TelepointerPayload = PresencePayload & {
+    selection: {
+        type: 'textSelection' | 'nodeSelection';
+        anchor: number;
+        head: number;
+    };
+};
+export declare type StepJson = {
+    from?: number;
+    to?: number;
+    stepType?: string;
+    clientId: string;
+    userId: string;
+};
+export declare type StepsPayload = {
+    version: number;
+    steps: StepJson[];
+};
+export declare type ErrorPayload = {
+    message: string;
+    data?: {
+        status: number;
+        code?: string;
+        meta?: string | {
+            description: string;
+            reason?: string;
+        };
+    };
+};
+export declare type ChannelEvent = {
+    connected: {
+        sid: string;
+        initialized: boolean;
+    };
+    init: InitPayload;
+    reconnected: null;
+    'presence:joined': PresencePayload;
+    presence: PresencePayload;
+    'participant:left': PresencePayload;
+    'participant:telepointer': TelepointerPayload;
+    'participant:updated': PresencePayload;
+    'steps:commit': StepsPayload & {
+        userId: string;
+    };
+    'steps:added': StepsPayload;
+    'metadata:changed': Metadata;
+    error: ErrorPayload;
+    disconnect: {
+        reason: string;
+    };
+};
+export interface CatchupResponse {
+    doc?: string;
+    version?: number;
+    stepMaps?: any[];
+    metadata?: Metadata;
+}
+export interface CatchupOptions {
+    getCurrentPmVersion: () => number;
+    fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>;
+    fitlerQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
+    getUnconfirmedSteps: () => {
+        version: number;
+        steps: Step<any>[];
+        clientID: string | number;
+        origins: Transaction<any>[];
+    } | null | undefined;
+    updateDocumentWithMetadata: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
+    applyLocalsteps: (steps: Step[]) => void;
+}
+export declare type ProductInformation = {
+    product: string;
+    subProduct?: string;
+};
+export {};

package/emitter/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/emitter.js",
   "module:es2019": "../dist/es2019/emitter.js",
   "sideEffects": false,
-  "types": "../dist/types/emitter.d.ts"
+  "types": "../dist/types/emitter.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/emitter.d.ts"
+      ]
+    }
+  }
 }

package/error-code-mapper/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/error-code-mapper.js",
   "module:es2019": "../dist/es2019/error-code-mapper.js",
   "sideEffects": false,
-  "types": "../dist/types/error-code-mapper.d.ts"
+  "types": "../dist/types/error-code-mapper.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/error-code-mapper.d.ts"
+      ]
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.5.1",
+  "version": "7.6.1",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "atlassian": {
@@ -21,10 +28,10 @@
     "releaseModel": "scheduled"
   },
   "dependencies": {
-    "@atlaskit/analytics-gas-types": "5.0.8",
+    "@atlaskit/analytics-gas-types": "5.0.9",
     "@atlaskit/analytics-listeners": "^8.3.0",
-    "@atlaskit/editor-common": "^69.1.0",
-    "@atlaskit/editor-json-transformer": "^8.7.0",
+    "@atlaskit/editor-common": "^69.3.0",
+    "@atlaskit/editor-json-transformer": "^8.8.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
     "eventemitter2": "^4.1.0",
@@ -44,14 +51,14 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^23.3.0",
-    "@atlaskit/editor-test-helpers": "^17.1.0",
+    "@atlaskit/adf-schema": "^24.0.0",
+    "@atlaskit/editor-test-helpers": "^17.2.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-collab": "^1.1.1",
     "@types/prosemirror-model": "^1.11.0",
     "@types/prosemirror-state": "^1.2.0",
     "prosemirror-model": "1.14.3",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }

package/socket-io-provider/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/socket-io-provider.js",
   "module:es2019": "../dist/es2019/socket-io-provider.js",
   "sideEffects": false,
-  "types": "../dist/types/socket-io-provider.d.ts"
+  "types": "../dist/types/socket-io-provider.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/socket-io-provider.d.ts"
+      ]
+    }
+  }
 }

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
   "sideEffects": false,
-  "types": "../dist/types/types.d.ts"
+  "types": "../dist/types/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/types.d.ts"
+      ]
+    }
+  }
 }