@atlaskit/collab-provider 10.20.4 → 10.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/cjs/channel.js +1 -1
  3. package/dist/cjs/document/document-service.js +12 -8
  4. package/dist/cjs/helpers/const.js +1 -0
  5. package/dist/cjs/participants/participants-service.js +222 -159
  6. package/dist/cjs/provider/index.js +1 -1
  7. package/dist/cjs/socket-io-provider.js +9 -5
  8. package/dist/cjs/version-wrapper.js +1 -1
  9. package/dist/es2019/channel.js +1 -1
  10. package/dist/es2019/document/document-service.js +12 -8
  11. package/dist/es2019/helpers/const.js +1 -0
  12. package/dist/es2019/participants/participants-service.js +62 -40
  13. package/dist/es2019/provider/index.js +1 -1
  14. package/dist/es2019/socket-io-provider.js +12 -5
  15. package/dist/es2019/version-wrapper.js +1 -1
  16. package/dist/esm/channel.js +1 -1
  17. package/dist/esm/document/document-service.js +12 -8
  18. package/dist/esm/helpers/const.js +1 -0
  19. package/dist/esm/participants/participants-service.js +222 -159
  20. package/dist/esm/provider/index.js +1 -1
  21. package/dist/esm/socket-io-provider.js +9 -5
  22. package/dist/esm/version-wrapper.js +1 -1
  23. package/dist/types/helpers/const.d.ts +9 -2
  24. package/dist/types/participants/participants-helper.d.ts +1 -1
  25. package/dist/types/participants/participants-service.d.ts +7 -3
  26. package/dist/types/socket-io-provider.d.ts +1 -1
  27. package/dist/types/types.d.ts +5 -1
  28. package/dist/types-ts4.5/helpers/const.d.ts +9 -2
  29. package/dist/types-ts4.5/participants/participants-helper.d.ts +1 -1
  30. package/dist/types-ts4.5/participants/participants-service.d.ts +7 -3
  31. package/dist/types-ts4.5/socket-io-provider.d.ts +1 -1
  32. package/dist/types-ts4.5/types.d.ts +5 -1
  33. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @atlaskit/collab-provider
2
2
 
3
+ ## 10.21.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#179240](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/179240)
8
+ [`a5d25b58c755a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a5d25b58c755a) -
9
+ Support for custom authentication headers
10
+
11
+ ## 10.20.5
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies
16
+
3
17
  ## 10.20.4
4
18
 
5
19
  ### Patch Changes
@@ -636,7 +636,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
636
636
  };
637
637
  }();
638
638
  }
639
- this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper);
639
+ this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo, this.config.isPresenceOnly, this.analyticsHelper, this.config.customExtraHeaders);
640
640
 
641
641
  // Due to https://github.com/socketio/socket.io-client/issues/1473,
642
642
  // reconnect no longer fired on the socket.
@@ -900,6 +900,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
900
900
  logger("Processing data. Version \"".concat(version, "\"."));
901
901
  if (steps !== null && steps !== void 0 && steps.length) {
902
902
  try {
903
+ var _this$analyticsHelper33;
903
904
  var clientIds = steps.map(function (_ref1) {
904
905
  var clientId = _ref1.clientId;
905
906
  return clientId;
@@ -921,12 +922,13 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
921
922
  return _this2.sendStepsFromCurrentState();
922
923
  }, 100);
923
924
  }
925
+ (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendActionEvent(_const.EVENT_ACTION.PROCESS_STEPS, _const.EVENT_STATUS.SUCCESS);
924
926
  } catch (error) {
925
- var _this$analyticsHelper33;
927
+ var _this$analyticsHelper34;
926
928
  // ESS-6421: log if error processing steps when there are steps from the same userId but not the same clientId
927
929
  var userIdMatch = this.isStepsFromNewClientIdForSameUserId(steps);
928
930
  logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
929
- (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(error, userIdMatch ? "Error while processing steps with new clientId" : "Error while processing steps");
931
+ (_this$analyticsHelper34 = this.analyticsHelper) === null || _this$analyticsHelper34 === void 0 || _this$analyticsHelper34.sendErrorEvent(error, userIdMatch ? "Error while processing steps with new clientId" : "Error while processing steps");
930
932
  this.throttledCatchupv2(_const.CatchupEventReason.PROCESS_STEPS);
931
933
  }
932
934
  }
@@ -978,8 +980,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
978
980
  var _this$getState9;
979
981
  var state = (_this$getState9 = this.getState) === null || _this$getState9 === void 0 ? void 0 : _this$getState9.call(this);
980
982
  if (!state) {
981
- var _this$analyticsHelper34;
982
- (_this$analyticsHelper34 = this.analyticsHelper) === null || _this$analyticsHelper34 === void 0 || _this$analyticsHelper34.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
983
+ var _this$analyticsHelper35;
984
+ (_this$analyticsHelper35 = this.analyticsHelper) === null || _this$analyticsHelper35 === void 0 || _this$analyticsHelper35.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
983
985
  return;
984
986
  }
985
987
  this.send(null, null, state, sendAnalyticsEvent, reason);
@@ -1018,8 +1020,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
1018
1020
  // to ensure that analytics events with the number of unconfirmed steps is only
1019
1021
  // sent once on connection (as opposed to on every step)
1020
1022
  if (sendAnalyticsEvent) {
1021
- var _this$analyticsHelper35;
1022
- (_this$analyticsHelper35 = this.analyticsHelper) === null || _this$analyticsHelper35 === void 0 || _this$analyticsHelper35.sendActionEvent(_const.EVENT_ACTION.HAS_UNCONFIRMED_STEPS, _const.EVENT_STATUS.INFO, {
1023
+ var _this$analyticsHelper36;
1024
+ (_this$analyticsHelper36 = this.analyticsHelper) === null || _this$analyticsHelper36 === void 0 || _this$analyticsHelper36.sendActionEvent(_const.EVENT_ACTION.HAS_UNCONFIRMED_STEPS, _const.EVENT_STATUS.INFO, {
1023
1025
  numUnconfirmedSteps: (unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) || 0
1024
1026
  });
1025
1027
  }
@@ -1028,12 +1030,12 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
1028
1030
  }
1029
1031
  var rebased = tr === null || tr === void 0 ? void 0 : tr.getMeta('rebasedData');
1030
1032
  if (rebased) {
1031
- var _this$analyticsHelper36;
1033
+ var _this$analyticsHelper37;
1032
1034
  var obfuscatedUnconfirmedSteps = this.obfuscateStepsAndState(rebased.unconfirmedSteps).obfuscatedSteps;
1033
1035
  var obfuscatedRemoteSteps = this.obfuscateStepsAndState(rebased.remoteSteps);
1034
1036
  var obfuscatedRebasedSteps = this.obfuscateStepsAndState(unconfirmedSteps).obfuscatedSteps;
1035
1037
  // send analtyics on unconfirmed steps
1036
- (_this$analyticsHelper36 = this.analyticsHelper) === null || _this$analyticsHelper36 === void 0 || _this$analyticsHelper36.sendActionEvent(_const.EVENT_ACTION.STEPS_REBASED, _const.EVENT_STATUS.INFO, {
1038
+ (_this$analyticsHelper37 = this.analyticsHelper) === null || _this$analyticsHelper37 === void 0 || _this$analyticsHelper37.sendActionEvent(_const.EVENT_ACTION.STEPS_REBASED, _const.EVENT_STATUS.INFO, {
1037
1039
  obfuscatedUnconfirmedSteps: obfuscatedUnconfirmedSteps,
1038
1040
  obfuscatedRemoteSteps: obfuscatedRemoteSteps,
1039
1041
  obfuscatedRebasedSteps: obfuscatedRebasedSteps,
@@ -1053,6 +1055,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
1053
1055
  return origin.setMeta('mergeIsLocked', true);
1054
1056
  }
1055
1057
  });
1058
+ }
1059
+ if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true)) {
1056
1060
  var offlineSteps = unconfirmedStepsData === null || unconfirmedStepsData === void 0 ? void 0 : unconfirmedStepsData.origins.some(function (tr) {
1057
1061
  var _tr$getMeta;
1058
1062
  return tr instanceof _state.Transaction ? (_tr$getMeta = tr.getMeta('isOffline')) !== null && _tr$getMeta !== void 0 ? _tr$getMeta : false : false;
@@ -50,6 +50,7 @@ var EVENT_ACTION = exports.EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
50
50
  EVENT_ACTION["STEPS_REBASED"] = "stepsRebased";
51
51
  // https://data-portal.internal.atlassian.com/analytics/registry/76616
52
52
  EVENT_ACTION["POLLING_FALLBACK"] = "pollingFallback";
53
+ EVENT_ACTION["PROCESS_STEPS"] = "processSteps"; // https://data-portal.internal.atlassian.com/analytics/registry/85229
53
54
  return EVENT_ACTION;
54
55
  }({});
55
56
  var EVENT_STATUS = exports.EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {