@atlaskit/collab-provider 10.3.3 → 10.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/collab-provider
 
+## 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
+
+- Updated dependencies
+
 ## 10.3.3
 
 ### 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"
         },

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.

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

@@ -122,7 +122,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;

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,15 @@
 "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.sleep = sleep;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _scrub = require("@atlaskit/adf-utils/scrub");
+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 +69,134 @@ 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 [];
 };

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

package/dist/es2019/document/catchupv2.js

@@ -1,4 +1,6 @@
-import { createLogger } from '../helpers/utils';
+import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { createLogger, getObfuscatedSteps, getDocAdfWithObfuscation } from '../helpers/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 const logger = createLogger('Catchupv2', 'red');
 export const catchupv2 = async opt => {
   // Ignored via go/ees005
@@ -34,7 +36,11 @@ export const catchupv2 = async opt => {
     };
     opt.onStepsAdded(stepsPayload);
     opt.updateMetadata(metadata);
-    return Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId));
+    const clientOutOfSync = Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId));
+    if (clientOutOfSync) {
+      logObfuscatedSteps(steps, opt);
+    }
+    return clientOutOfSync;
   } catch (error) {
     var _opt$analyticsHelper2;
     (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 ? void 0 : _opt$analyticsHelper2.sendErrorEvent(error, 'Failed to apply catchupv2 result in the editor');
@@ -42,6 +48,17 @@ export const catchupv2 = async opt => {
     throw error;
   }
 };
+const logObfuscatedSteps = (steps, opt) => {
+  if (fg('platform_editor_log_obfuscated_steps')) {
+    var _opt$getState, _opt$analyticsHelper3;
+    const 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 ? void 0 : _opt$analyticsHelper3.sendActionEvent(EVENT_ACTION.OUT_OF_SYNC, EVENT_STATUS.FAILURE, {
+      obfuscatedSteps: getObfuscatedSteps(steps),
+      obfuscatedDoc: state ? 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.

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

@@ -116,7 +116,8 @@ export class DocumentService {
                 remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
               });
             }
-          }
+          },
+          getState: this.getState
         });
         const latency = new Date().getTime() - start;
         (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {

package/dist/es2019/helpers/const.js

@@ -19,8 +19,9 @@ export let 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
 export let EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/es2019/helpers/utils.js

@@ -1,3 +1,4 @@
+import { scrubAdf } from '@atlaskit/adf-utils/scrub';
 export const createLogger = (prefix, color = 'blue') =>
 // Ignored via go/ees005
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -50,4 +51,132 @@ export const getStepUGCFreeDetails = step => {
     contentTypes,
     stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
   };
+};
+const stepWithNextDocument = stepJson => {
+  return stepJson.stepType === 'override-document' && 'nextDocument' in stepJson;
+};
+const stepWithMark = stepJson => {
+  return stepJson.stepType === 'addMark' || stepJson.stepType === 'addNodeMark';
+};
+const stepWithAttrs = stepJson => {
+  return stepJson.stepType === 'setAttrs' && 'attrs' in stepJson;
+};
+const stepWithBatchAttrs = stepJson => {
+  return stepJson.stepType === 'batchAttrs' && 'data' in stepJson;
+};
+const stepWithFromTo = stepJson => {
+  return 'from' in stepJson && typeof stepJson.from === 'number' && 'to' in stepJson && typeof stepJson.to === 'number';
+};
+const stepWithGapFromTo = stepJson => {
+  return 'gapFrom' in stepJson && typeof stepJson.gapFrom === 'number' && 'gapTo' in stepJson && typeof stepJson.gapTo === 'number';
+};
+const stepWithInsert = stepJson => {
+  return 'insert' in stepJson && typeof stepJson.insert === 'number';
+};
+const stepWithPos = stepJson => {
+  return 'pos' in stepJson && typeof stepJson.pos === 'number';
+};
+const 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.
+export const getStepTypes = stepJson => {
+  let contentTypes = null;
+  if (stepWithSlice(stepJson)) {
+    contentTypes = stepJson.slice.content.map(c => {
+      return (c === null || c === void 0 ? void 0 : c.type) || 'unknown';
+    }).join(', ');
+  }
+  return {
+    type: stepJson.stepType || 'unknown',
+    contentTypes
+  };
+};
+export const getStepsAdfWithObfuscation = stepJson => {
+  const stepContentAsAdf = stepToAdf(stepJson);
+  if (!stepContentAsAdf) {
+    return null;
+  }
+  const scrubbedSteps = stepContentAsAdf.map(adf => scrubAdf(adf)).filter(adf => !!adf);
+  return scrubbedSteps;
+};
+export const getDocAdfWithObfuscation = doc => {
+  const docJson = doc.toJSON();
+  const scrubbedDoc = scrubAdf(docJson);
+  if (!scrubbedDoc) {
+    return null;
+  }
+  return scrubbedDoc;
+};
+export const getStepPositions = stepJson => {
+  return {
+    ...(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)
+ */
+const getStepMetadata = stepJson => {
+  return stepJson.metadata;
+};
+export const getObfuscatedSteps = (steps, endIndex = undefined) => {
+  return steps.slice(0, endIndex).map(step => {
+    return {
+      stepType: getStepTypes(step),
+      stepContent: getStepsAdfWithObfuscation(step),
+      stepPositions: getStepPositions(step),
+      stepMetadata: getStepMetadata(step)
+    };
+  });
+};
+const stepToAdf = step => {
+  if (stepWithSlice(step)) {
+    return [{
+      type: 'doc',
+      content: step.slice.content.filter(el => 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(stepData => {
+      return {
+        type: 'doc',
+        attrs: stepData.attrs
+      };
+    });
+  }
+  return [];
 };

package/dist/es2019/version-wrapper.js

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

package/dist/esm/document/catchupv2.js

@@ -1,10 +1,12 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { createLogger } from '../helpers/utils';
+import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { createLogger, getObfuscatedSteps, getDocAdfWithObfuscation } from '../helpers/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 var logger = createLogger('Catchupv2', 'red');
 export var catchupv2 = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.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 _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -46,23 +48,38 @@ export var 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 (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(EVENT_ACTION.OUT_OF_SYNC, EVENT_STATUS.FAILURE, {
+      obfuscatedSteps: getObfuscatedSteps(steps),
+      obfuscatedDoc: state ? 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.

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

@@ -115,7 +115,8 @@ export var 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;

package/dist/esm/helpers/const.js

@@ -19,8 +19,9 @@ export var 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
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/esm/helpers/utils.js

@@ -1,3 +1,7 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { scrubAdf } from '@atlaskit/adf-utils/scrub';
 export var createLogger = function createLogger(prefix) {
   var color = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'blue';
   return (
@@ -57,4 +61,134 @@ export var getStepUGCFreeDetails = function getStepUGCFreeDetails(step) {
     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.
+export var 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
+  };
+};
+export var getStepsAdfWithObfuscation = function getStepsAdfWithObfuscation(stepJson) {
+  var stepContentAsAdf = stepToAdf(stepJson);
+  if (!stepContentAsAdf) {
+    return null;
+  }
+  var scrubbedSteps = stepContentAsAdf.map(function (adf) {
+    return scrubAdf(adf);
+  }).filter(function (adf) {
+    return !!adf;
+  });
+  return scrubbedSteps;
+};
+export var getDocAdfWithObfuscation = function getDocAdfWithObfuscation(doc) {
+  var docJson = doc.toJSON();
+  var scrubbedDoc = scrubAdf(docJson);
+  if (!scrubbedDoc) {
+    return null;
+  }
+  return scrubbedDoc;
+};
+export var 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;
+};
+export var 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 [];
 };

package/dist/esm/version-wrapper.js

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

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

@@ -19,7 +19,8 @@ export declare enum EVENT_ACTION {
     PROVIDER_INITIALIZED = "providerInitialized",// https://data-portal.internal.atlassian.com/analytics/registry/54714
     RECONNECTION = "providerReconnection",// https://data-portal.internal.atlassian.com/analytics/registry/73992
     PROVIDER_SETUP = "providerSetup",// https://data-portal.internal.atlassian.com/analytics/registry/54715
-    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps"
+    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/56141
+    OUT_OF_SYNC = "outOfSync"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -261,7 +262,20 @@ type ReconnectionAnalyticsEvent = {
         disconnectionPeriodSeconds: number;
     } & BaseActionAnalyticsEventAttributes;
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent;
+type OutOfSyncAnalyticsEvent = {
+    eventAction: EVENT_ACTION.OUT_OF_SYNC;
+    attributes: {
+        eventStatus: EVENT_STATUS.FAILURE;
+        obfuscatedSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedDoc: {
+            [key: string]: number;
+        };
+        catchupReason: CatchupEventReason | undefined;
+    } & BaseActionAnalyticsEventAttributes;
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 /** Enumerable for attaching a reason to catchup (v2) call(s) */

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

@@ -1,5 +1,8 @@
+import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { ProductInformation } from '../types';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { StepJson } from '@atlaskit/editor-common/collab';
+import type { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const isAIProviderID: (id: string) => boolean;
@@ -11,3 +14,41 @@ export type UGCFreeStepDetails = {
     stepSizeInBytes?: number;
 };
 export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;
+export declare const getStepTypes: (stepJson: StepJson) => {
+    type: string;
+    contentTypes: string | null;
+};
+export declare const getStepsAdfWithObfuscation: (stepJson: StepJson) => ADFEntity[] | null;
+export declare const getDocAdfWithObfuscation: (doc: ProseMirrorNode) => ADFEntity | null;
+export declare const getStepPositions: (stepJson: StepJson) => {
+    pos?: number | undefined;
+    insert?: number | undefined;
+    gapFrom?: number | undefined;
+    gapTo?: number | undefined;
+    from?: number | undefined;
+    to?: number | undefined;
+};
+export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number | undefined) => {
+    stepType: {
+        type: string;
+        contentTypes: string | null;
+    };
+    stepContent: ADFEntity[] | null;
+    stepPositions: {
+        pos?: number | undefined;
+        insert?: number | undefined;
+        gapFrom?: number | undefined;
+        gapTo?: number | undefined;
+        from?: number | undefined;
+        to?: number | undefined;
+    };
+    stepMetadata: {
+        source?: string | undefined;
+        stepId?: string | undefined;
+        prevStepId?: string | undefined;
+        rebased?: boolean | undefined;
+        traceId?: string | undefined;
+        reqId?: string | undefined;
+        schemaVersion?: string | undefined;
+    } | undefined;
+}[];

package/dist/types/types.d.ts

@@ -1,4 +1,3 @@
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager, Socket as SocketIOSocket } from 'socket.io-client';
 import type { InternalError } from './errors/internal-errors';
@@ -7,6 +6,7 @@ import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity, PresenceActivity } from '@atlaskit/editor-common/collab';
 import { type CatchupEventReason } from './helpers/const';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export interface CollabEventDisconnectedData {
     sid: string;
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
@@ -199,7 +199,7 @@ export type ChannelEvent = {
     status: NamespaceStatus;
 };
 export interface Catchupv2Response {
-    steps?: Step[];
+    steps?: StepJson[];
     metadata?: Metadata;
 }
 export interface ReconcileResponse {
@@ -218,6 +218,7 @@ export interface Catchupv2Options {
     catchUpOutofSync: boolean;
     reason?: CatchupEventReason;
     onCatchupComplete?: (steps: StepJson[]) => void;
+    getState: (() => EditorState) | undefined;
 }
 export type ReconnectionMetadata = {
     unconfirmedStepsLength: number | undefined;

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

@@ -19,7 +19,8 @@ export declare enum EVENT_ACTION {
     PROVIDER_INITIALIZED = "providerInitialized",// https://data-portal.internal.atlassian.com/analytics/registry/54714
     RECONNECTION = "providerReconnection",// https://data-portal.internal.atlassian.com/analytics/registry/73992
     PROVIDER_SETUP = "providerSetup",// https://data-portal.internal.atlassian.com/analytics/registry/54715
-    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps"
+    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/56141
+    OUT_OF_SYNC = "outOfSync"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -261,7 +262,20 @@ type ReconnectionAnalyticsEvent = {
         disconnectionPeriodSeconds: number;
     } & BaseActionAnalyticsEventAttributes;
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent;
+type OutOfSyncAnalyticsEvent = {
+    eventAction: EVENT_ACTION.OUT_OF_SYNC;
+    attributes: {
+        eventStatus: EVENT_STATUS.FAILURE;
+        obfuscatedSteps: {
+            [key: string]: number;
+        }[];
+        obfuscatedDoc: {
+            [key: string]: number;
+        };
+        catchupReason: CatchupEventReason | undefined;
+    } & BaseActionAnalyticsEventAttributes;
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 /** Enumerable for attaching a reason to catchup (v2) call(s) */

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

@@ -1,5 +1,8 @@
+import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { ProductInformation } from '../types';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { StepJson } from '@atlaskit/editor-common/collab';
+import type { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const isAIProviderID: (id: string) => boolean;
@@ -11,3 +14,41 @@ export type UGCFreeStepDetails = {
     stepSizeInBytes?: number;
 };
 export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;
+export declare const getStepTypes: (stepJson: StepJson) => {
+    type: string;
+    contentTypes: string | null;
+};
+export declare const getStepsAdfWithObfuscation: (stepJson: StepJson) => ADFEntity[] | null;
+export declare const getDocAdfWithObfuscation: (doc: ProseMirrorNode) => ADFEntity | null;
+export declare const getStepPositions: (stepJson: StepJson) => {
+    pos?: number | undefined;
+    insert?: number | undefined;
+    gapFrom?: number | undefined;
+    gapTo?: number | undefined;
+    from?: number | undefined;
+    to?: number | undefined;
+};
+export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number | undefined) => {
+    stepType: {
+        type: string;
+        contentTypes: string | null;
+    };
+    stepContent: ADFEntity[] | null;
+    stepPositions: {
+        pos?: number | undefined;
+        insert?: number | undefined;
+        gapFrom?: number | undefined;
+        gapTo?: number | undefined;
+        from?: number | undefined;
+        to?: number | undefined;
+    };
+    stepMetadata: {
+        source?: string | undefined;
+        stepId?: string | undefined;
+        prevStepId?: string | undefined;
+        rebased?: boolean | undefined;
+        traceId?: string | undefined;
+        reqId?: string | undefined;
+        schemaVersion?: string | undefined;
+    } | undefined;
+}[];

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

@@ -1,4 +1,3 @@
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager, Socket as SocketIOSocket } from 'socket.io-client';
 import type { InternalError } from './errors/internal-errors';
@@ -7,6 +6,7 @@ import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity, PresenceActivity } from '@atlaskit/editor-common/collab';
 import { type CatchupEventReason } from './helpers/const';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export interface CollabEventDisconnectedData {
     sid: string;
     reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
@@ -199,7 +199,7 @@ export type ChannelEvent = {
     status: NamespaceStatus;
 };
 export interface Catchupv2Response {
-    steps?: Step[];
+    steps?: StepJson[];
     metadata?: Metadata;
 }
 export interface ReconcileResponse {
@@ -218,6 +218,7 @@ export interface Catchupv2Options {
     catchUpOutofSync: boolean;
     reason?: CatchupEventReason;
     onCatchupComplete?: (steps: StepJson[]) => void;
+    getState: (() => EditorState) | undefined;
 }
 export type ReconnectionMetadata = {
     unconfirmedStepsLength: number | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "10.3.3",
+	"version": "10.4.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -32,9 +32,10 @@
 		"./version-wrapper": "./src/version-wrapper.ts"
 	},
 	"dependencies": {
+		"@atlaskit/adf-utils": "^19.17.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^8.13.0",
-		"@atlaskit/editor-common": "^98.0.0",
+		"@atlaskit/editor-common": "^99.2.0",
 		"@atlaskit/editor-json-transformer": "^8.21.0",
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/feature-gate-js-client": "^4.22.0",
@@ -71,6 +72,9 @@
 		"platform.editor.live-pages-expand-divergence": {
 			"type": "boolean"
 		},
+		"platform_editor_log_obfuscated_steps": {
+			"type": "boolean"
+		},
 		"platform_editor_merge_unconfirmed_steps": {
 			"type": "boolean"
 		},