@atlaskit/collab-provider 10.3.4 → 10.4.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/collab-provider
 
+## 10.4.1
+
+### Patch Changes
+
+- [#104569](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/104569)
+  [`b79a89c03faf9`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b79a89c03faf9) -
+  log obfuscated steps for transactions in view only
+
+## 10.4.0
+
+### Minor Changes
+
+- [#102499](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/102499)
+  [`c1bfe8b68a35e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c1bfe8b68a35e) -
+  log obfuscated steps in collab provider when catchup out of sync
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.3.4
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -17,6 +17,9 @@
         "../src/**/test.*"
     ],
     "references": [
+        {
+            "path": "../../adf-utils/afm-cc/tsconfig.json"
+        },
         {
             "path": "../../../analytics/analytics-gas-types/afm-cc/tsconfig.json"
         },
@@ -38,6 +41,9 @@
         {
             "path": "../../prosemirror-collab/afm-cc/tsconfig.json"
         },
+        {
+            "path": "../../../react-ufo/atlaskit/afm-cc/tsconfig.json"
+        },
         {
             "path": "../../../data/ufo-external/afm-cc/tsconfig.json"
         },

package/afm-jira/tsconfig.json

@@ -17,6 +17,9 @@
 		"../src/**/test.*"
 	],
 	"references": [
+		{
+			"path": "../../adf-utils/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../../analytics/analytics-gas-types/afm-jira/tsconfig.json"
 		},
@@ -38,6 +41,9 @@
 		{
 			"path": "../../prosemirror-collab/afm-jira/tsconfig.json"
 		},
+		{
+			"path": "../../../react-ufo/atlaskit/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../../data/ufo-external/afm-jira/tsconfig.json"
 		},

package/dist/cjs/analytics/analytics-helper.js

@@ -71,8 +71,6 @@ var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analy
   }
 };
 var AnalyticsHelper = exports.default = /*#__PURE__*/function () {
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   function AnalyticsHelper(documentAri, subProduct, analyticsClient, getAnalyticsClient) {
     (0, _classCallCheck2.default)(this, AnalyticsHelper);
     this.documentAri = documentAri;

package/dist/cjs/api/api.js

@@ -15,6 +15,9 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
 var _utils = require("../helpers/utils");
+var _experienceTraceIdContext = require("@atlaskit/react-ufo/experience-trace-id-context");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _featureFlagsAccessed = require("@atlaskit/react-ufo/feature-flags-accessed");
 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 _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)); }
@@ -46,7 +49,7 @@ var Api = exports.Api = /*#__PURE__*/function () {
     (0, _classCallCheck2.default)(this, Api);
     (0, _defineProperty2.default)(this, "submitComment", /*#__PURE__*/function () {
       var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(steps, version) {
-        var reqBody, url, fetchOptions;
+        var reqBody, url, tracingHeaderEnabled, tracingHeaders, fetchOptions;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -57,25 +60,33 @@ var Api = exports.Api = /*#__PURE__*/function () {
               });
               url = "".concat(_this2.config.url, "/document/").concat(encodeURIComponent(_this2.config.documentAri), "/comment");
               logger("Request url: ", url);
+
+              //Get tracing headers from UFO
+              tracingHeaderEnabled = (0, _platformFeatureFlags.fg)('platform_collab_provider_tracingheaders');
+              (0, _featureFlagsAccessed.addFeatureFlagAccessed)('platform_collab_provider_tracingheaders', tracingHeaderEnabled);
+              tracingHeaders = {};
+              if (tracingHeaderEnabled) {
+                tracingHeaders = (0, _experienceTraceIdContext.getActiveTraceHttpRequestHeaders)(url);
+              }
               _context.t0 = _objectSpread;
               _context.t1 = _objectSpread;
               _context.t2 = {};
               if (!_this2.config.permissionTokenRefresh) {
-                _context.next = 13;
+                _context.next = 17;
                 break;
               }
-              _context.next = 9;
+              _context.next = 13;
               return _this2.channel.getChannelToken();
-            case 9:
+            case 13:
               _context.t4 = _context.sent;
               _context.t3 = {
                 'x-token': _context.t4
               };
-              _context.next = 14;
+              _context.next = 18;
               break;
-            case 13:
+            case 17:
               _context.t3 = {};
-            case 14:
+            case 18:
               _context.t5 = _context.t3;
               _context.t6 = (0, _context.t1)(_context.t2, _context.t5);
               _context.t7 = {};
@@ -84,19 +95,20 @@ var Api = exports.Api = /*#__PURE__*/function () {
                 'x-subproduct': (0, _utils.getSubProduct)(_this2.config.productInfo),
                 'Content-Type': 'application/json'
               };
-              _context.t9 = (0, _context.t0)(_context.t6, _context.t7, _context.t8);
-              _context.t10 = reqBody;
+              _context.t9 = tracingHeaders;
+              _context.t10 = (0, _context.t0)(_context.t6, _context.t7, _context.t8, _context.t9);
+              _context.t11 = reqBody;
               fetchOptions = {
                 credentials: 'include',
-                headers: _context.t9,
+                headers: _context.t10,
                 method: 'POST',
-                body: _context.t10
+                body: _context.t11
               };
-              _context.next = 23;
+              _context.next = 28;
               return fetch(url, fetchOptions);
-            case 23:
+            case 28:
               return _context.abrupt("return", _context.sent);
-            case 24:
+            case 29:
             case "end":
               return _context.stop();
           }

package/dist/cjs/channel.js

@@ -235,8 +235,6 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
         _this.emit('steps:added', data);
       }
     });
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     (0, _defineProperty2.default)(_this, "fetchCatchupv2", /*#__PURE__*/function () {
       var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(fromVersion, clientId, catchUpOutofSync, reason) {
         var _yield$utils$requestS, steps, metadata, errorNotFound, errorCatchupv2;

package/dist/cjs/document/catchupv2.js

@@ -7,11 +7,13 @@ Object.defineProperty(exports, "__esModule", {
 exports.isOutOfSync = exports.catchupv2 = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _const = require("../helpers/const");
 var _utils = require("../helpers/utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var logger = (0, _utils.createLogger)('Catchupv2', 'red');
 var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(opt) {
-    var steps, metadata, fromVersion, _yield$opt$fetchCatch, _opt$analyticsHelper, _opt$onCatchupComplet, version, stepsPayload, _opt$analyticsHelper2;
+    var steps, metadata, fromVersion, _yield$opt$fetchCatch, _opt$analyticsHelper, _opt$onCatchupComplet, version, stepsPayload, clientOutOfSync, _opt$analyticsHelper2;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -53,23 +55,38 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
           };
           opt.onStepsAdded(stepsPayload);
           opt.updateMetadata(metadata);
-          return _context.abrupt("return", Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId)));
-        case 26:
-          _context.prev = 26;
+          clientOutOfSync = Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId));
+          if (clientOutOfSync) {
+            logObfuscatedSteps(steps, opt);
+          }
+          return _context.abrupt("return", clientOutOfSync);
+        case 28:
+          _context.prev = 28;
           _context.t1 = _context["catch"](14);
           (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 || _opt$analyticsHelper2.sendErrorEvent(_context.t1, 'Failed to apply catchupv2 result in the editor');
           logger("Apply catchupv2 steps failed:", _context.t1.message);
           throw _context.t1;
-        case 31:
+        case 33:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 9], [14, 26]]);
+    }, _callee, null, [[1, 9], [14, 28]]);
   }));
   return function catchupv2(_x) {
     return _ref.apply(this, arguments);
   };
 }();
+var logObfuscatedSteps = function logObfuscatedSteps(steps, opt) {
+  if ((0, _platformFeatureFlags.fg)('platform_editor_log_obfuscated_steps')) {
+    var _opt$getState, _opt$analyticsHelper3;
+    var state = (_opt$getState = opt.getState) === null || _opt$getState === void 0 ? void 0 : _opt$getState.call(opt);
+    (_opt$analyticsHelper3 = opt.analyticsHelper) === null || _opt$analyticsHelper3 === void 0 || _opt$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.OUT_OF_SYNC, _const.EVENT_STATUS.FAILURE, {
+      obfuscatedSteps: (0, _utils.getObfuscatedSteps)(steps),
+      obfuscatedDoc: state ? (0, _utils.getDocAdfWithObfuscation)(state.doc) : null,
+      catchupReason: opt.reason
+    });
+  }
+};
 
 /**
  * Checks if we're out of sync with the backend because catchup failed to apply, and thus the doc should be reset.
@@ -79,10 +96,7 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
  * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
  * @returns True if we're out of sync, false if not.
  */
-var isOutOfSync = exports.isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId
-// Ignored via go/ees005
-// eslint-disable-next-line @typescript-eslint/max-params
-) {
+var isOutOfSync = exports.isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
   return (
     // If version number hasn't increased, and steps are not from our client, we're out of sync
     Boolean(fromVersion >= currentVersion && steps.some(function (step) {

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

@@ -47,8 +47,6 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    * @param getConnected - if the channel is currently connected
    */
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   function DocumentService(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile,
   // Ignored via go/ees005
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -64,6 +62,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
     (0, _defineProperty2.default)(this, "aggressiveCatchup", false);
     (0, _defineProperty2.default)(this, "catchUpOutofSync", false);
+    (0, _defineProperty2.default)(this, "hasRecovered", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
@@ -122,7 +121,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                       remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
                     }));
                   }
-                }
+                },
+                getState: _this.getState
               });
             case 11:
               _this.catchUpOutofSync = _context.sent;
@@ -314,21 +314,24 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               doc = _ref6.doc, version = _ref6.version, metadata = _ref6.metadata, targetClientId = _ref6.targetClientId;
+              if (!targetClientId) {
+                _this.hasRecovered = true;
+              }
               if (!(targetClientId && _this.clientId !== targetClientId)) {
-                _context3.next = 3;
+                _context3.next = 4;
                 break;
               }
               return _context3.abrupt("return");
-            case 3:
+            case 4:
               // We preserve these as they will be lost apon this.updateDocument. This is because we are using document recovery.
               // We can then reconcile the document with the preserved state.
               unconfirmedSteps = _this.getUnconfirmedSteps();
-              _context3.next = 6;
+              _context3.next = 7;
               return _this.getCurrentState();
-            case 6:
+            case 7:
               currentState = _context3.sent;
               useReconcile = Boolean((unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) && currentState && !targetClientId);
-              _context3.prev = 8;
+              _context3.prev = 9;
               // Reset the editor,
               //  - Replace the document, keep in sync with the server
               //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
@@ -343,10 +346,10 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               });
               _this.metadataService.updateMetadata(metadata);
               if (!(0, _platformFeatureFlags.fg)('restore_localstep_fallback_reconcile')) {
-                _context3.next = 25;
+                _context3.next = 26;
                 break;
               }
-              _context3.prev = 12;
+              _context3.prev = 13;
               (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.INFO, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
@@ -357,35 +360,35 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-              _context3.next = 23;
+              _context3.next = 24;
               break;
-            case 17:
-              _context3.prev = 17;
-              _context3.t0 = _context3["catch"](12);
+            case 18:
+              _context3.prev = 18;
+              _context3.t0 = _context3["catch"](13);
               (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendErrorEvent(_context3.t0, "Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile");
               useReconcile = true;
-              _context3.next = 23;
+              _context3.next = 24;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 23:
-              _context3.next = 31;
+            case 24:
+              _context3.next = 32;
               break;
-            case 25:
+            case 26:
               if (!(useReconcile && currentState)) {
-                _context3.next = 30;
+                _context3.next = 31;
                 break;
               }
-              _context3.next = 28;
+              _context3.next = 29;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 28:
-              _context3.next = 31;
+            case 29:
+              _context3.next = 32;
               break;
-            case 30:
+            case 31:
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 // we don't want to use reconcile for restore triggered by catchup client out of sync (when targetClientId is provided)
                 // as this results in all changes made while the client was out of sync being lost
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-            case 31:
+            case 32:
               (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
@@ -394,11 +397,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 targetClientId: targetClientId,
                 triggeredByCatchup: targetClientId ? true : false
               });
-              _context3.next = 39;
+              _context3.next = 40;
               break;
-            case 34:
-              _context3.prev = 34;
-              _context3.t1 = _context3["catch"](8);
+            case 35:
+              _context3.prev = 35;
+              _context3.t1 = _context3["catch"](9);
               (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 || _this$analyticsHelper16.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.FAILURE, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 useReconcile: useReconcile,
@@ -415,11 +418,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                   code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
                 }
               });
-            case 39:
+            case 40:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, null, [[8, 34], [12, 17]]);
+        }, _callee3, null, [[9, 35], [13, 18]]);
       }));
       return function (_x3) {
         return _ref7.apply(this, arguments);
@@ -830,8 +833,6 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     function send(_tr, _oldState, newState, sendAnalyticsEvent) {
       var unconfirmedStepsData = (0, _prosemirrorCollab.sendableSteps)(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
@@ -889,7 +890,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         onErrorHandled: this.onErrorHandled,
         analyticsHelper: this.analyticsHelper,
         emit: this.providerEmitCallback,
-        __livePage: this.options.__livePage
+        __livePage: this.options.__livePage,
+        hasRecovered: this.hasRecovered
       });
     }
   }]);

package/dist/cjs/helpers/const.js

@@ -25,8 +25,9 @@ var EVENT_ACTION = exports.EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["RECONNECTION"] = "providerReconnection";
   EVENT_ACTION["PROVIDER_SETUP"] = "providerSetup";
   EVENT_ACTION["HAS_UNCONFIRMED_STEPS"] = "hasUnconfirmedSteps";
+  EVENT_ACTION["OUT_OF_SYNC"] = "outOfSync";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/56141
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/74993
 var EVENT_STATUS = exports.EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/cjs/helpers/utils.js

@@ -1,10 +1,21 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isAIProviderID = exports.getSubProduct = exports.getStepUGCFreeDetails = exports.getProduct = exports.createLogger = void 0;
+exports.isAIProviderID = exports.getSubProduct = exports.getStepsAdfWithObfuscation = exports.getStepUGCFreeDetails = exports.getStepTypes = exports.getStepPositions = exports.getProduct = exports.getObfuscatedSteps = exports.getDocAdfWithObfuscation = exports.createLogger = void 0;
+exports.logObfuscatedSteps = logObfuscatedSteps;
 exports.sleep = sleep;
+exports.toObfuscatedSteps = toObfuscatedSteps;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _scrub = require("@atlaskit/adf-utils/scrub");
+var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
+var _customErrors = require("../errors/custom-errors");
+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 createLogger = exports.createLogger = function createLogger(prefix) {
   var color = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'blue';
   return (
@@ -64,4 +75,207 @@ var getStepUGCFreeDetails = exports.getStepUGCFreeDetails = function getStepUGCF
     contentTypes: contentTypes,
     stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
   };
-};
+};
+var stepWithNextDocument = function stepWithNextDocument(stepJson) {
+  return stepJson.stepType === 'override-document' && 'nextDocument' in stepJson;
+};
+var stepWithMark = function stepWithMark(stepJson) {
+  return stepJson.stepType === 'addMark' || stepJson.stepType === 'addNodeMark';
+};
+var stepWithAttrs = function stepWithAttrs(stepJson) {
+  return stepJson.stepType === 'setAttrs' && 'attrs' in stepJson;
+};
+var stepWithBatchAttrs = function stepWithBatchAttrs(stepJson) {
+  return stepJson.stepType === 'batchAttrs' && 'data' in stepJson;
+};
+var stepWithFromTo = function stepWithFromTo(stepJson) {
+  return 'from' in stepJson && typeof stepJson.from === 'number' && 'to' in stepJson && typeof stepJson.to === 'number';
+};
+var stepWithGapFromTo = function stepWithGapFromTo(stepJson) {
+  return 'gapFrom' in stepJson && typeof stepJson.gapFrom === 'number' && 'gapTo' in stepJson && typeof stepJson.gapTo === 'number';
+};
+var stepWithInsert = function stepWithInsert(stepJson) {
+  return 'insert' in stepJson && typeof stepJson.insert === 'number';
+};
+var stepWithPos = function stepWithPos(stepJson) {
+  return 'pos' in stepJson && typeof stepJson.pos === 'number';
+};
+var stepWithSlice = function stepWithSlice(stepJson) {
+  var _stepJson$slice3;
+  return 'slice' in stepJson && Array.isArray((_stepJson$slice3 = stepJson.slice) === null || _stepJson$slice3 === void 0 ? void 0 : _stepJson$slice3.content);
+};
+
+// Get as step info which is known not to contain user generated content.
+var getStepTypes = exports.getStepTypes = function getStepTypes(stepJson) {
+  var contentTypes = null;
+  if (stepWithSlice(stepJson)) {
+    contentTypes = stepJson.slice.content.map(function (c) {
+      return (c === null || c === void 0 ? void 0 : c.type) || 'unknown';
+    }).join(', ');
+  }
+  return {
+    type: stepJson.stepType || 'unknown',
+    contentTypes: contentTypes
+  };
+};
+var getStepsAdfWithObfuscation = exports.getStepsAdfWithObfuscation = function getStepsAdfWithObfuscation(stepJson) {
+  var stepContentAsAdf = stepToAdf(stepJson);
+  if (!stepContentAsAdf) {
+    return null;
+  }
+  var scrubbedSteps = stepContentAsAdf.map(function (adf) {
+    return (0, _scrub.scrubAdf)(adf);
+  }).filter(function (adf) {
+    return !!adf;
+  });
+  return scrubbedSteps;
+};
+var getDocAdfWithObfuscation = exports.getDocAdfWithObfuscation = function getDocAdfWithObfuscation(doc) {
+  var docJson = doc.toJSON();
+  var scrubbedDoc = (0, _scrub.scrubAdf)(docJson);
+  if (!scrubbedDoc) {
+    return null;
+  }
+  return scrubbedDoc;
+};
+var getStepPositions = exports.getStepPositions = function getStepPositions(stepJson) {
+  return _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, stepWithFromTo(stepJson) && {
+    from: stepJson.from,
+    to: stepJson.to
+  }), stepWithGapFromTo(stepJson) && {
+    gapFrom: stepJson.gapFrom,
+    gapTo: stepJson.gapTo
+  }), stepWithInsert(stepJson) && {
+    insert: stepJson.insert
+  }), stepWithPos(stepJson) && {
+    pos: stepJson.pos
+  });
+};
+
+/**
+ * Returns the metadata for Step
+ * @description metadata is applied by transform overrides [here](https://bitbucket.org/atlassian/adf-schema/src/e13bbece84ede8f245067dc53dd7ce694f427eda/packages/editor-prosemirror/src/transform-override.ts#lines-12)
+ */
+var getStepMetadata = function getStepMetadata(stepJson) {
+  return stepJson.metadata;
+};
+var getObfuscatedSteps = exports.getObfuscatedSteps = function getObfuscatedSteps(steps) {
+  var endIndex = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined;
+  return steps.slice(0, endIndex).map(function (step) {
+    return {
+      stepType: getStepTypes(step),
+      stepContent: getStepsAdfWithObfuscation(step),
+      stepPositions: getStepPositions(step),
+      stepMetadata: getStepMetadata(step)
+    };
+  });
+};
+var stepToAdf = function stepToAdf(step) {
+  if (stepWithSlice(step)) {
+    return [{
+      type: 'doc',
+      content: step.slice.content.filter(function (el) {
+        return el !== null;
+      })
+    }];
+  } else if (stepWithNextDocument(step)) {
+    return [{
+      type: 'doc',
+      content: step.nextDocument.content
+    }];
+  } else if (stepWithMark(step) && step.mark) {
+    return [{
+      type: 'doc',
+      marks: [{
+        type: step.mark.type || 'unknown',
+        attrs: step.mark.attrs
+      }]
+    }];
+  } else if (stepWithAttrs(step)) {
+    return [{
+      type: 'doc',
+      attrs: step.attrs
+    }];
+  } else if (stepWithBatchAttrs(step)) {
+    return step.data.map(function (stepData) {
+      return {
+        type: 'doc',
+        attrs: stepData.attrs
+      };
+    });
+  }
+  return [];
+};
+function logObfuscatedSteps(_x, _x2) {
+  return _logObfuscatedSteps.apply(this, arguments);
+}
+function _logObfuscatedSteps() {
+  _logObfuscatedSteps = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(oldState, newState) {
+    var _states$new, _states$old, stepsFromOldState, stepsFromNewState, states;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.prev = 0;
+          stepsFromOldState = '', stepsFromNewState = '';
+          states = {
+            old: oldState ? (0, _prosemirrorCollab.sendableSteps)(oldState) : null,
+            new: (0, _prosemirrorCollab.sendableSteps)(newState)
+          };
+          if (!((_states$new = states.new) !== null && _states$new !== void 0 && _states$new.steps)) {
+            _context.next = 7;
+            break;
+          }
+          _context.next = 6;
+          return toObfuscatedSteps(states.new.steps);
+        case 6:
+          stepsFromNewState = _context.sent;
+        case 7:
+          if (!((_states$old = states.old) !== null && _states$old !== void 0 && _states$old.steps)) {
+            _context.next = 11;
+            break;
+          }
+          _context.next = 10;
+          return toObfuscatedSteps(states.old.steps);
+        case 10:
+          stepsFromOldState = _context.sent;
+        case 11:
+          return _context.abrupt("return", {
+            stepsFromOldState: stepsFromOldState,
+            stepsFromNewState: stepsFromNewState
+          });
+        case 14:
+          _context.prev = 14;
+          _context.t0 = _context["catch"](0);
+          return _context.abrupt("return", new _customErrors.CustomError('Failed to obfuscate steps', _context.t0));
+        case 17:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[0, 14]]);
+  }));
+  return _logObfuscatedSteps.apply(this, arguments);
+}
+function toObfuscatedSteps(_x3) {
+  return _toObfuscatedSteps.apply(this, arguments);
+}
+function _toObfuscatedSteps() {
+  _toObfuscatedSteps = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(steps) {
+    var _steps;
+    return _regenerator.default.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _context2.next = 2;
+          return Promise.resolve(steps.slice().map(function (s) {
+            return s.toJSON();
+          }));
+        case 2:
+          _steps = _context2.sent;
+          return _context2.abrupt("return", JSON.stringify(getObfuscatedSteps(_steps)));
+        case 4:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return _toObfuscatedSteps.apply(this, arguments);
+}