@atlaskit/editor-plugin-track-changes 2.2.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/editor-plugin-track-changes
 
+## 2.4.0
+
+### Minor Changes
+
+- [#193925](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/193925)
+  [`696d65f882441`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/696d65f882441) -
+  Implement `resetBaseline` command for track changes plugin which can be called to reset the diff
+  history.
+
+## 2.3.0
+
+### Minor Changes
+
+- [#193889](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/193889)
+  [`6d4374ce318fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6d4374ce318fd) -
+  [EDITOR-1073] Add i18n for Track Changes button & toggle button on toolbar with plugin option
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.2.0
 
 ### Minor Changes

package/README.md

@@ -1 +1,89 @@
 # Editor plugin track changes
+
+Track changes plugin for @atlaskit/editor-core
+
+## Usage
+
+`import { trackChangesPlugin } from '@atlaskit/editor-plugin-track-changes';`
+
+### Dependencies
+
+**Required:**
+- `ShowDiffPlugin` - Required for displaying track changes diff view
+
+**Optional:**
+- `PrimaryToolbarPlugin` - Required if using `showOnToolbar: true`
+
+### Configuration
+
+The plugin accepts an optional configuration object:
+
+```typescript
+trackChangesPlugin({
+  showOnToolbar: true // Shows track changes button in the toolbar (default: false)
+})
+```
+
+### Example
+
+```typescript
+import React from 'react';
+
+import Button from '@atlaskit/button/new';
+import { cssMap } from '@atlaskit/css';
+import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
+import { ComposableEditor } from '@atlaskit/editor-core/composable-editor';
+import { usePreset } from '@atlaskit/editor-core/use-preset';
+import { basePlugin } from '@atlaskit/editor-plugins/base';
+import { Box } from '@atlaskit/primitives/compiled';
+import { token } from '@atlaskit/tokens';
+
+import { showDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
+import { trackChangesPlugin } from '@atlaskit/editor-plugin-track-changes';
+
+const styles = cssMap({
+	aboveEditor: {
+		paddingTop: token('space.100'),
+		paddingBottom: token('space.100'),
+	},
+	everythingContainer: {
+		paddingTop: token('space.200'),
+		paddingBottom: token('space.200'),
+		paddingLeft: token('space.200'),
+		paddingRight: token('space.200'),
+	},
+});
+
+function Editor() {
+	const { preset, editorApi } = usePreset(
+		(builder) =>
+			builder.add(basePlugin).add(showDiffPlugin).add(trackChangesPlugin),
+		[],
+	);
+
+	const isSelected = useSharedPluginStateSelector(editorApi, 'trackChanges.isDisplayingChanges');
+
+	return (
+		<Box xcss={styles.everythingContainer}>
+			<Box xcss={styles.aboveEditor}>
+				<Button
+					appearance="primary"
+					onClick={() => {
+						editorApi?.core.actions.execute(
+							editorApi?.trackChanges.commands.toggleChanges,
+						);
+					}}
+					isSelected={isSelected}
+				>
+					Show Diff
+				</Button>
+			</Box>
+			<ComposableEditor preset={preset} />
+		</Box>
+	);
+}
+
+export default Editor;
+```
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-track-changes).

package/afm-cc/tsconfig.json

@@ -14,12 +14,20 @@
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
 		"../src/**/test.*",
-		"../src/**/examples.*"
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{
 			"path": "../../../design-system/button/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../editor-plugin-history/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-primary-toolbar/afm-cc/tsconfig.json"
 		},

package/afm-jira/tsconfig.json

@@ -14,7 +14,12 @@
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
 		"../src/**/test.*",
-		"../src/**/examples.*"
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/afm-post-office/tsconfig.json

@@ -14,7 +14,12 @@
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
 		"../src/**/test.*",
-		"../src/**/examples.*"
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/afm-rovo-extension/tsconfig.json

@@ -14,7 +14,12 @@
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
 		"../src/**/test.*",
-		"../src/**/examples.*"
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/afm-townsquare/tsconfig.json

@@ -14,7 +14,12 @@
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
 		"../src/**/test.*",
-		"../src/**/examples.*"
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/build/tsconfig.json

@@ -1,17 +1,22 @@
 {
-	"extends": "../tsconfig",
-	"compilerOptions": {
-		"target": "es5",
-		"paths": {}
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	]
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "target": "es5",
+    "paths": {}
+  },
+  "include": [
+    "../src/**/*.ts",
+    "../src/**/*.tsx"
+  ],
+  "exclude": [
+    "../src/**/__tests__/*",
+    "../src/**/*.test.*",
+    "../src/**/test.*",
+    "../src/**/examples.*",
+    "../src/**/examples/*",
+    "../src/**/examples/**/*",
+    "../src/**/*.stories.*",
+    "../src/**/stories/*",
+    "../src/**/stories/**/*"
+  ]
 }

package/dist/cjs/pm-plugins/filterSteps.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.filterSteps = filterSteps;
+var _maxSteps = require("./maxSteps");
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+/**
+ * Returns the filtered steps to ensure we don't track an entire document worth of changes
+ */
+function filterSteps(steps, allocations) {
+  if (allocations.size <= _maxSteps.MAX_STEPS_FROM_BASELINE) {
+    return {
+      steps: steps,
+      allocations: allocations
+    };
+  }
+
+  // Create a new allocation, retaining only the most recent values
+  var elements = Array.from(allocations);
+  var newAllocation = new Set(elements.slice(-_maxSteps.MAX_STEPS_FROM_BASELINE));
+  var finalSteps = [];
+  var cutoffFound = false;
+  var _iterator = _createForOfIteratorHelper(steps),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      if (newAllocation.has(step.allocation)) {
+        cutoffFound = true;
+      }
+      // Accept everything after this point otherwise we could have mis-ordered steps
+      if (cutoffFound) {
+        finalSteps.push(step);
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return {
+    steps: finalSteps,
+    allocations: newAllocation
+  };
+}

package/dist/cjs/pm-plugins/invertableStep.js

@@ -0,0 +1,15 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InvertableStep = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var InvertableStep = exports.InvertableStep = /*#__PURE__*/(0, _createClass2.default)(function InvertableStep(step, inverted, allocation) {
+  (0, _classCallCheck2.default)(this, InvertableStep);
+  this.step = step;
+  this.inverted = inverted;
+  this.allocation = allocation;
+});

package/dist/cjs/pm-plugins/main.js

@@ -4,14 +4,14 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.trackChangesPluginKey = exports.createTrackChangesPlugin = exports.InvertableStep = void 0;
+exports.trackChangesPluginKey = exports.getBaselineFromSteps = exports.createTrackChangesPlugin = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
+var _filterSteps2 = require("./filterSteps");
+var _invertableStep = require("./invertableStep");
 var _types = require("./types");
 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; }
@@ -19,18 +19,14 @@ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 var trackChangesPluginKey = exports.trackChangesPluginKey = new _state.PluginKey('trackChangesPlugin');
-var InvertableStep = exports.InvertableStep = /*#__PURE__*/(0, _createClass2.default)(function InvertableStep(step, inverted) {
-  (0, _classCallCheck2.default)(this, InvertableStep);
-  this.step = step;
-  this.inverted = inverted;
-});
-var getBaselineFromSteps = function getBaselineFromSteps(doc, steps) {
+// Exported for test purposes
+var getBaselineFromSteps = exports.getBaselineFromSteps = function getBaselineFromSteps(doc, steps) {
   var _iterator = _createForOfIteratorHelper(steps.slice().reverse()),
     _step;
   try {
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var _step2 = _step.value;
-      var result = _step2.inverted.apply(doc);
+      var step = _step.value;
+      var result = step.inverted.apply(doc);
       if (result.failed === null && result.doc) {
         doc = result.doc;
       }
@@ -52,11 +48,19 @@ var createTrackChangesPlugin = exports.createTrackChangesPlugin = function creat
         return {
           steps: [],
           shouldChangesBeDisplayed: false,
-          isShowDiffAvailable: false
+          isShowDiffAvailable: false,
+          allocations: new Set()
         };
       },
       apply: function apply(tr, state) {
+        var _api$history, _state$steps$at$alloc, _state$steps$at;
         var metadata = tr.getMeta(trackChangesPluginKey);
+        if (metadata && metadata.action === _types.TOGGLE_TRACK_CHANGES_ACTION.RESET_BASELINE) {
+          return _objectSpread(_objectSpread({}, state), {}, {
+            steps: [],
+            isShowDiffAvailable: false
+          });
+        }
         if (metadata && metadata.action === _types.TOGGLE_TRACK_CHANGES_ACTION.TOGGLE_TRACK_CHANGES) {
           resetBaseline = true;
           return _objectSpread(_objectSpread({}, state), {}, {
@@ -70,14 +74,24 @@ var createTrackChangesPlugin = exports.createTrackChangesPlugin = function creat
           // If no document changes, return the old changeSet
           return state;
         }
+
+        // If we don't have the history plugin don't limit the change tracking
+        var historyState = api === null || api === void 0 || (_api$history = api.history) === null || _api$history === void 0 ? void 0 : _api$history.sharedState.currentState();
+        var currentAllocation = historyState ?
+        // Combine both done + undone so we have the total "distance".
+        historyState.done.eventCount + historyState.undone.eventCount : ((_state$steps$at$alloc = (_state$steps$at = state.steps.at(-1)) === null || _state$steps$at === void 0 ? void 0 : _state$steps$at.allocation) !== null && _state$steps$at$alloc !== void 0 ? _state$steps$at$alloc : 0) + 1;
         var newSteps = tr.steps.map(function (step, idx) {
-          return new InvertableStep(step, step.invert(tr.docs[idx]));
+          return new _invertableStep.InvertableStep(step, step.invert(tr.docs[idx]), currentAllocation);
         });
-        var steps = resetBaseline ? newSteps : [].concat((0, _toConsumableArray2.default)(state.steps), (0, _toConsumableArray2.default)(newSteps));
+        var concatSteps = resetBaseline ? newSteps : [].concat((0, _toConsumableArray2.default)(state.steps), (0, _toConsumableArray2.default)(newSteps));
         resetBaseline = false;
+        var _filterSteps = (0, _filterSteps2.filterSteps)(concatSteps, state.allocations.add(currentAllocation)),
+          allocations = _filterSteps.allocations,
+          steps = _filterSteps.steps;
 
         // Create a new ChangeSet based on document changes
         return _objectSpread(_objectSpread({}, state), {}, {
+          allocations: allocations,
           steps: steps,
           shouldChangesBeDisplayed: false,
           isShowDiffAvailable: true

package/dist/cjs/pm-plugins/maxSteps.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.MAX_STEPS_FROM_BASELINE = void 0;
+// To be determined a suitable threshold
+// Exported for testing
+var MAX_STEPS_FROM_BASELINE = exports.MAX_STEPS_FROM_BASELINE = 10;

package/dist/cjs/pm-plugins/types.js

@@ -6,5 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.TOGGLE_TRACK_CHANGES_ACTION = void 0;
 var TOGGLE_TRACK_CHANGES_ACTION = exports.TOGGLE_TRACK_CHANGES_ACTION = /*#__PURE__*/function (TOGGLE_TRACK_CHANGES_ACTION) {
   TOGGLE_TRACK_CHANGES_ACTION["TOGGLE_TRACK_CHANGES"] = "TOGGLE_TRACK_CHANGES";
+  TOGGLE_TRACK_CHANGES_ACTION["RESET_BASELINE"] = "RESET_BASELINE";
   return TOGGLE_TRACK_CHANGES_ACTION;
 }({});

package/dist/cjs/trackChangesPlugin.js

@@ -10,17 +10,20 @@ var _main = require("./pm-plugins/main");
 var _types = require("./pm-plugins/types");
 var _TrackChangesToolbarButton = require("./ui/TrackChangesToolbarButton");
 var trackChangesPlugin = exports.trackChangesPlugin = function trackChangesPlugin(_ref) {
-  var _api$primaryToolbar;
-  var api = _ref.api;
+  var api = _ref.api,
+    options = _ref.config;
   var primaryToolbarComponent = function primaryToolbarComponent() {
     return /*#__PURE__*/_react.default.createElement(_TrackChangesToolbarButton.TrackChangesToolbarButton, {
       api: api
     });
   };
-  api === null || api === void 0 || (_api$primaryToolbar = api.primaryToolbar) === null || _api$primaryToolbar === void 0 || (_api$primaryToolbar = _api$primaryToolbar.actions) === null || _api$primaryToolbar === void 0 || _api$primaryToolbar.registerComponent({
-    name: 'trackChanges',
-    component: primaryToolbarComponent
-  });
+  if ((options === null || options === void 0 ? void 0 : options.showOnToolbar) === true) {
+    var _api$primaryToolbar;
+    api === null || api === void 0 || (_api$primaryToolbar = api.primaryToolbar) === null || _api$primaryToolbar === void 0 || (_api$primaryToolbar = _api$primaryToolbar.actions) === null || _api$primaryToolbar === void 0 || _api$primaryToolbar.registerComponent({
+      name: 'trackChanges',
+      component: primaryToolbarComponent
+    });
+  }
   return {
     name: 'trackChanges',
     pmPlugins: function pmPlugins() {
@@ -37,6 +40,16 @@ var trackChangesPlugin = exports.trackChangesPlugin = function trackChangesPlugi
         return tr.setMeta(_main.trackChangesPluginKey, {
           action: _types.TOGGLE_TRACK_CHANGES_ACTION.TOGGLE_TRACK_CHANGES
         });
+      },
+      resetBaseline: function resetBaseline(_ref3) {
+        var _api$trackChanges;
+        var tr = _ref3.tr;
+        if (!(api !== null && api !== void 0 && (_api$trackChanges = api.trackChanges) !== null && _api$trackChanges !== void 0 && (_api$trackChanges = _api$trackChanges.sharedState.currentState()) !== null && _api$trackChanges !== void 0 && _api$trackChanges.isShowDiffAvailable)) {
+          return null;
+        }
+        return tr.setMeta(_main.trackChangesPluginKey, {
+          action: _types.TOGGLE_TRACK_CHANGES_ACTION.RESET_BASELINE
+        });
       }
     },
     getSharedState: function getSharedState(editorState) {

package/dist/cjs/ui/TrackChangesToolbarButton.js

@@ -6,8 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.TrackChangesToolbarButton = void 0;
 var _react = _interopRequireDefault(require("react"));
+var _reactIntlNext = require("react-intl-next");
 var _new = require("@atlaskit/button/new");
 var _hooks = require("@atlaskit/editor-common/hooks");
+var _messages = require("@atlaskit/editor-common/messages");
 var _history = _interopRequireDefault(require("@atlaskit/icon-lab/core/history"));
 var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref) {
   var _api$trackChanges;
@@ -21,12 +23,14 @@ var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function Tra
     }),
     isDisplayingChanges = _useSharedPluginState.isDisplayingChanges,
     isShowDiffAvailable = _useSharedPluginState.isShowDiffAvailable;
+  var _useIntl = (0, _reactIntlNext.useIntl)(),
+    formatMessage = _useIntl.formatMessage;
   var handleClick = _react.default.useCallback(function () {
     api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 ? void 0 : api.trackChanges.commands.toggleChanges);
   }, [api === null || api === void 0 || (_api$trackChanges = api.trackChanges) === null || _api$trackChanges === void 0 ? void 0 : _api$trackChanges.commands, api === null || api === void 0 ? void 0 : api.core.actions]);
   return /*#__PURE__*/_react.default.createElement(_new.IconButton, {
     icon: _history.default,
-    label: "Track Changes",
+    label: formatMessage(_messages.trackChangesMessages.toolbarIconLabel),
     appearance: "subtle",
     isDisabled: !isShowDiffAvailable,
     isSelected: isDisplayingChanges,

package/dist/es2019/pm-plugins/filterSteps.js

@@ -0,0 +1,32 @@
+import { MAX_STEPS_FROM_BASELINE } from './maxSteps';
+
+/**
+ * Returns the filtered steps to ensure we don't track an entire document worth of changes
+ */
+export function filterSteps(steps, allocations) {
+  if (allocations.size <= MAX_STEPS_FROM_BASELINE) {
+    return {
+      steps,
+      allocations
+    };
+  }
+
+  // Create a new allocation, retaining only the most recent values
+  const elements = Array.from(allocations);
+  const newAllocation = new Set(elements.slice(-MAX_STEPS_FROM_BASELINE));
+  const finalSteps = [];
+  let cutoffFound = false;
+  for (const step of steps) {
+    if (newAllocation.has(step.allocation)) {
+      cutoffFound = true;
+    }
+    // Accept everything after this point otherwise we could have mis-ordered steps
+    if (cutoffFound) {
+      finalSteps.push(step);
+    }
+  }
+  return {
+    steps: finalSteps,
+    allocations: newAllocation
+  };
+}

package/dist/es2019/pm-plugins/invertableStep.js

@@ -0,0 +1,7 @@
+export class InvertableStep {
+  constructor(step, inverted, allocation) {
+    this.step = step;
+    this.inverted = inverted;
+    this.allocation = allocation;
+  }
+}

package/dist/es2019/pm-plugins/main.js

@@ -1,15 +1,12 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { filterSteps } from './filterSteps';
+import { InvertableStep } from './invertableStep';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './types';
 export const trackChangesPluginKey = new PluginKey('trackChangesPlugin');
-export class InvertableStep {
-  constructor(step, inverted) {
-    this.step = step;
-    this.inverted = inverted;
-  }
-}
-const getBaselineFromSteps = (doc, steps) => {
+// Exported for test purposes
+export const getBaselineFromSteps = (doc, steps) => {
   for (const step of steps.slice().reverse()) {
     const result = step.inverted.apply(doc);
     if (result.failed === null && result.doc) {
@@ -28,11 +25,20 @@ export const createTrackChangesPlugin = api => {
         return {
           steps: [],
           shouldChangesBeDisplayed: false,
-          isShowDiffAvailable: false
+          isShowDiffAvailable: false,
+          allocations: new Set()
         };
       },
       apply(tr, state) {
+        var _api$history, _state$steps$at$alloc, _state$steps$at;
         const metadata = tr.getMeta(trackChangesPluginKey);
+        if (metadata && metadata.action === ACTION.RESET_BASELINE) {
+          return {
+            ...state,
+            steps: [],
+            isShowDiffAvailable: false
+          };
+        }
         if (metadata && metadata.action === ACTION.TOGGLE_TRACK_CHANGES) {
           resetBaseline = true;
           return {
@@ -45,13 +51,24 @@ export const createTrackChangesPlugin = api => {
           // If no document changes, return the old changeSet
           return state;
         }
-        const newSteps = tr.steps.map((step, idx) => new InvertableStep(step, step.invert(tr.docs[idx])));
-        const steps = resetBaseline ? newSteps : [...state.steps, ...newSteps];
+
+        // If we don't have the history plugin don't limit the change tracking
+        const historyState = api === null || api === void 0 ? void 0 : (_api$history = api.history) === null || _api$history === void 0 ? void 0 : _api$history.sharedState.currentState();
+        const currentAllocation = historyState ?
+        // Combine both done + undone so we have the total "distance".
+        historyState.done.eventCount + historyState.undone.eventCount : ((_state$steps$at$alloc = (_state$steps$at = state.steps.at(-1)) === null || _state$steps$at === void 0 ? void 0 : _state$steps$at.allocation) !== null && _state$steps$at$alloc !== void 0 ? _state$steps$at$alloc : 0) + 1;
+        const newSteps = tr.steps.map((step, idx) => new InvertableStep(step, step.invert(tr.docs[idx]), currentAllocation));
+        const concatSteps = resetBaseline ? newSteps : [...state.steps, ...newSteps];
         resetBaseline = false;
+        const {
+          allocations,
+          steps
+        } = filterSteps(concatSteps, state.allocations.add(currentAllocation));
 
         // Create a new ChangeSet based on document changes
         return {
           ...state,
+          allocations,
           steps,
           shouldChangesBeDisplayed: false,
           isShowDiffAvailable: true

package/dist/es2019/pm-plugins/maxSteps.js

@@ -0,0 +1,3 @@
+// To be determined a suitable threshold
+// Exported for testing
+export const MAX_STEPS_FROM_BASELINE = 10;

package/dist/es2019/pm-plugins/types.js

@@ -1,4 +1,5 @@
 export let TOGGLE_TRACK_CHANGES_ACTION = /*#__PURE__*/function (TOGGLE_TRACK_CHANGES_ACTION) {
   TOGGLE_TRACK_CHANGES_ACTION["TOGGLE_TRACK_CHANGES"] = "TOGGLE_TRACK_CHANGES";
+  TOGGLE_TRACK_CHANGES_ACTION["RESET_BASELINE"] = "RESET_BASELINE";
   return TOGGLE_TRACK_CHANGES_ACTION;
 }({});

package/dist/es2019/trackChangesPlugin.js

@@ -3,18 +3,21 @@ import { createTrackChangesPlugin, trackChangesPluginKey } from './pm-plugins/ma
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './pm-plugins/types';
 import { TrackChangesToolbarButton } from './ui/TrackChangesToolbarButton';
 export const trackChangesPlugin = ({
-  api
+  api,
+  config: options
 }) => {
-  var _api$primaryToolbar, _api$primaryToolbar$a;
   const primaryToolbarComponent = () => {
     return /*#__PURE__*/React.createElement(TrackChangesToolbarButton, {
       api: api
     });
   };
-  api === null || api === void 0 ? void 0 : (_api$primaryToolbar = api.primaryToolbar) === null || _api$primaryToolbar === void 0 ? void 0 : (_api$primaryToolbar$a = _api$primaryToolbar.actions) === null || _api$primaryToolbar$a === void 0 ? void 0 : _api$primaryToolbar$a.registerComponent({
-    name: 'trackChanges',
-    component: primaryToolbarComponent
-  });
+  if ((options === null || options === void 0 ? void 0 : options.showOnToolbar) === true) {
+    var _api$primaryToolbar, _api$primaryToolbar$a;
+    api === null || api === void 0 ? void 0 : (_api$primaryToolbar = api.primaryToolbar) === null || _api$primaryToolbar === void 0 ? void 0 : (_api$primaryToolbar$a = _api$primaryToolbar.actions) === null || _api$primaryToolbar$a === void 0 ? void 0 : _api$primaryToolbar$a.registerComponent({
+      name: 'trackChanges',
+      component: primaryToolbarComponent
+    });
+  }
   return {
     name: 'trackChanges',
     pmPlugins() {
@@ -30,6 +33,17 @@ export const trackChangesPlugin = ({
         return tr.setMeta(trackChangesPluginKey, {
           action: ACTION.TOGGLE_TRACK_CHANGES
         });
+      },
+      resetBaseline: ({
+        tr
+      }) => {
+        var _api$trackChanges, _api$trackChanges$sha;
+        if (!(api !== null && api !== void 0 && (_api$trackChanges = api.trackChanges) !== null && _api$trackChanges !== void 0 && (_api$trackChanges$sha = _api$trackChanges.sharedState.currentState()) !== null && _api$trackChanges$sha !== void 0 && _api$trackChanges$sha.isShowDiffAvailable)) {
+          return null;
+        }
+        return tr.setMeta(trackChangesPluginKey, {
+          action: ACTION.RESET_BASELINE
+        });
       }
     },
     getSharedState: editorState => {

package/dist/es2019/ui/TrackChangesToolbarButton.js

@@ -1,6 +1,8 @@
 import React from 'react';
+import { useIntl } from 'react-intl-next';
 import { IconButton } from '@atlaskit/button/new';
 import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
+import { trackChangesMessages } from '@atlaskit/editor-common/messages';
 import HistoryIcon from '@atlaskit/icon-lab/core/history';
 export const TrackChangesToolbarButton = ({
   api
@@ -16,12 +18,15 @@ export const TrackChangesToolbarButton = ({
       isShowDiffAvailable: (_states$trackChangesS2 = states.trackChangesState) === null || _states$trackChangesS2 === void 0 ? void 0 : _states$trackChangesS2.isShowDiffAvailable
     };
   });
+  const {
+    formatMessage
+  } = useIntl();
   const handleClick = React.useCallback(() => {
     api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : api.trackChanges.commands.toggleChanges);
   }, [api === null || api === void 0 ? void 0 : (_api$trackChanges = api.trackChanges) === null || _api$trackChanges === void 0 ? void 0 : _api$trackChanges.commands, api === null || api === void 0 ? void 0 : api.core.actions]);
   return /*#__PURE__*/React.createElement(IconButton, {
     icon: HistoryIcon,
-    label: "Track Changes",
+    label: formatMessage(trackChangesMessages.toolbarIconLabel),
     appearance: "subtle",
     isDisabled: !isShowDiffAvailable,
     isSelected: isDisplayingChanges,

package/dist/esm/pm-plugins/filterSteps.js

@@ -0,0 +1,44 @@
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { MAX_STEPS_FROM_BASELINE } from './maxSteps';
+
+/**
+ * Returns the filtered steps to ensure we don't track an entire document worth of changes
+ */
+export function filterSteps(steps, allocations) {
+  if (allocations.size <= MAX_STEPS_FROM_BASELINE) {
+    return {
+      steps: steps,
+      allocations: allocations
+    };
+  }
+
+  // Create a new allocation, retaining only the most recent values
+  var elements = Array.from(allocations);
+  var newAllocation = new Set(elements.slice(-MAX_STEPS_FROM_BASELINE));
+  var finalSteps = [];
+  var cutoffFound = false;
+  var _iterator = _createForOfIteratorHelper(steps),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      if (newAllocation.has(step.allocation)) {
+        cutoffFound = true;
+      }
+      // Accept everything after this point otherwise we could have mis-ordered steps
+      if (cutoffFound) {
+        finalSteps.push(step);
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return {
+    steps: finalSteps,
+    allocations: newAllocation
+  };
+}

package/dist/esm/pm-plugins/invertableStep.js

@@ -0,0 +1,8 @@
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+export var InvertableStep = /*#__PURE__*/_createClass(function InvertableStep(step, inverted, allocation) {
+  _classCallCheck(this, InvertableStep);
+  this.step = step;
+  this.inverted = inverted;
+  this.allocation = allocation;
+});

package/dist/esm/pm-plugins/main.js

@@ -1,7 +1,5 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _createClass from "@babel/runtime/helpers/createClass";
-import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 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; }
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
@@ -10,20 +8,18 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { filterSteps } from './filterSteps';
+import { InvertableStep } from './invertableStep';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './types';
 export var trackChangesPluginKey = new PluginKey('trackChangesPlugin');
-export var InvertableStep = /*#__PURE__*/_createClass(function InvertableStep(step, inverted) {
-  _classCallCheck(this, InvertableStep);
-  this.step = step;
-  this.inverted = inverted;
-});
-var getBaselineFromSteps = function getBaselineFromSteps(doc, steps) {
+// Exported for test purposes
+export var getBaselineFromSteps = function getBaselineFromSteps(doc, steps) {
   var _iterator = _createForOfIteratorHelper(steps.slice().reverse()),
     _step;
   try {
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var _step2 = _step.value;
-      var result = _step2.inverted.apply(doc);
+      var step = _step.value;
+      var result = step.inverted.apply(doc);
       if (result.failed === null && result.doc) {
         doc = result.doc;
       }
@@ -45,11 +41,19 @@ export var createTrackChangesPlugin = function createTrackChangesPlugin(api) {
         return {
           steps: [],
           shouldChangesBeDisplayed: false,
-          isShowDiffAvailable: false
+          isShowDiffAvailable: false,
+          allocations: new Set()
         };
       },
       apply: function apply(tr, state) {
+        var _api$history, _state$steps$at$alloc, _state$steps$at;
         var metadata = tr.getMeta(trackChangesPluginKey);
+        if (metadata && metadata.action === ACTION.RESET_BASELINE) {
+          return _objectSpread(_objectSpread({}, state), {}, {
+            steps: [],
+            isShowDiffAvailable: false
+          });
+        }
         if (metadata && metadata.action === ACTION.TOGGLE_TRACK_CHANGES) {
           resetBaseline = true;
           return _objectSpread(_objectSpread({}, state), {}, {
@@ -63,14 +67,24 @@ export var createTrackChangesPlugin = function createTrackChangesPlugin(api) {
           // If no document changes, return the old changeSet
           return state;
         }
+
+        // If we don't have the history plugin don't limit the change tracking
+        var historyState = api === null || api === void 0 || (_api$history = api.history) === null || _api$history === void 0 ? void 0 : _api$history.sharedState.currentState();
+        var currentAllocation = historyState ?
+        // Combine both done + undone so we have the total "distance".
+        historyState.done.eventCount + historyState.undone.eventCount : ((_state$steps$at$alloc = (_state$steps$at = state.steps.at(-1)) === null || _state$steps$at === void 0 ? void 0 : _state$steps$at.allocation) !== null && _state$steps$at$alloc !== void 0 ? _state$steps$at$alloc : 0) + 1;
         var newSteps = tr.steps.map(function (step, idx) {
-          return new InvertableStep(step, step.invert(tr.docs[idx]));
+          return new InvertableStep(step, step.invert(tr.docs[idx]), currentAllocation);
         });
-        var steps = resetBaseline ? newSteps : [].concat(_toConsumableArray(state.steps), _toConsumableArray(newSteps));
+        var concatSteps = resetBaseline ? newSteps : [].concat(_toConsumableArray(state.steps), _toConsumableArray(newSteps));
         resetBaseline = false;
+        var _filterSteps = filterSteps(concatSteps, state.allocations.add(currentAllocation)),
+          allocations = _filterSteps.allocations,
+          steps = _filterSteps.steps;
 
         // Create a new ChangeSet based on document changes
         return _objectSpread(_objectSpread({}, state), {}, {
+          allocations: allocations,
           steps: steps,
           shouldChangesBeDisplayed: false,
           isShowDiffAvailable: true

package/dist/esm/pm-plugins/maxSteps.js

@@ -0,0 +1,3 @@
+// To be determined a suitable threshold
+// Exported for testing
+export var MAX_STEPS_FROM_BASELINE = 10;

package/dist/esm/pm-plugins/types.js

@@ -1,4 +1,5 @@
 export var TOGGLE_TRACK_CHANGES_ACTION = /*#__PURE__*/function (TOGGLE_TRACK_CHANGES_ACTION) {
   TOGGLE_TRACK_CHANGES_ACTION["TOGGLE_TRACK_CHANGES"] = "TOGGLE_TRACK_CHANGES";
+  TOGGLE_TRACK_CHANGES_ACTION["RESET_BASELINE"] = "RESET_BASELINE";
   return TOGGLE_TRACK_CHANGES_ACTION;
 }({});

package/dist/esm/trackChangesPlugin.js

@@ -3,17 +3,20 @@ import { createTrackChangesPlugin, trackChangesPluginKey } from './pm-plugins/ma
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './pm-plugins/types';
 import { TrackChangesToolbarButton } from './ui/TrackChangesToolbarButton';
 export var trackChangesPlugin = function trackChangesPlugin(_ref) {
-  var _api$primaryToolbar;
-  var api = _ref.api;
+  var api = _ref.api,
+    options = _ref.config;
   var primaryToolbarComponent = function primaryToolbarComponent() {
     return /*#__PURE__*/React.createElement(TrackChangesToolbarButton, {
       api: api
     });
   };
-  api === null || api === void 0 || (_api$primaryToolbar = api.primaryToolbar) === null || _api$primaryToolbar === void 0 || (_api$primaryToolbar = _api$primaryToolbar.actions) === null || _api$primaryToolbar === void 0 || _api$primaryToolbar.registerComponent({
-    name: 'trackChanges',
-    component: primaryToolbarComponent
-  });
+  if ((options === null || options === void 0 ? void 0 : options.showOnToolbar) === true) {
+    var _api$primaryToolbar;
+    api === null || api === void 0 || (_api$primaryToolbar = api.primaryToolbar) === null || _api$primaryToolbar === void 0 || (_api$primaryToolbar = _api$primaryToolbar.actions) === null || _api$primaryToolbar === void 0 || _api$primaryToolbar.registerComponent({
+      name: 'trackChanges',
+      component: primaryToolbarComponent
+    });
+  }
   return {
     name: 'trackChanges',
     pmPlugins: function pmPlugins() {
@@ -30,6 +33,16 @@ export var trackChangesPlugin = function trackChangesPlugin(_ref) {
         return tr.setMeta(trackChangesPluginKey, {
           action: ACTION.TOGGLE_TRACK_CHANGES
         });
+      },
+      resetBaseline: function resetBaseline(_ref3) {
+        var _api$trackChanges;
+        var tr = _ref3.tr;
+        if (!(api !== null && api !== void 0 && (_api$trackChanges = api.trackChanges) !== null && _api$trackChanges !== void 0 && (_api$trackChanges = _api$trackChanges.sharedState.currentState()) !== null && _api$trackChanges !== void 0 && _api$trackChanges.isShowDiffAvailable)) {
+          return null;
+        }
+        return tr.setMeta(trackChangesPluginKey, {
+          action: ACTION.RESET_BASELINE
+        });
       }
     },
     getSharedState: function getSharedState(editorState) {

package/dist/esm/ui/TrackChangesToolbarButton.js

@@ -1,6 +1,8 @@
 import React from 'react';
+import { useIntl } from 'react-intl-next';
 import { IconButton } from '@atlaskit/button/new';
 import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
+import { trackChangesMessages } from '@atlaskit/editor-common/messages';
 import HistoryIcon from '@atlaskit/icon-lab/core/history';
 export var TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref) {
   var _api$trackChanges;
@@ -14,12 +16,14 @@ export var TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref)
     }),
     isDisplayingChanges = _useSharedPluginState.isDisplayingChanges,
     isShowDiffAvailable = _useSharedPluginState.isShowDiffAvailable;
+  var _useIntl = useIntl(),
+    formatMessage = _useIntl.formatMessage;
   var handleClick = React.useCallback(function () {
     api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 ? void 0 : api.trackChanges.commands.toggleChanges);
   }, [api === null || api === void 0 || (_api$trackChanges = api.trackChanges) === null || _api$trackChanges === void 0 ? void 0 : _api$trackChanges.commands, api === null || api === void 0 ? void 0 : api.core.actions]);
   return /*#__PURE__*/React.createElement(IconButton, {
     icon: HistoryIcon,
-    label: "Track Changes",
+    label: formatMessage(trackChangesMessages.toolbarIconLabel),
     appearance: "subtle",
     isDisabled: !isShowDiffAvailable,
     isSelected: isDisplayingChanges,

package/dist/types/pm-plugins/filterSteps.d.ts

@@ -0,0 +1,8 @@
+import type { InvertableStep } from './invertableStep';
+/**
+ * Returns the filtered steps to ensure we don't track an entire document worth of changes
+ */
+export declare function filterSteps(steps: InvertableStep[], allocations: Set<number>): {
+    steps: InvertableStep[];
+    allocations: Set<number>;
+};

package/dist/types/pm-plugins/invertableStep.d.ts

@@ -0,0 +1,7 @@
+import { type Step } from '@atlaskit/editor-prosemirror/transform';
+export declare class InvertableStep {
+    readonly step: Step;
+    readonly inverted: Step;
+    readonly allocation: number;
+    constructor(step: Step, inverted: Step, allocation: number);
+}

package/dist/types/pm-plugins/main.d.ts

@@ -1,18 +1,16 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { type Step } from '@atlaskit/editor-prosemirror/transform';
 import type { TrackChangesPlugin } from '../trackChangesPluginType';
+import { InvertableStep } from './invertableStep';
 export declare const trackChangesPluginKey: PluginKey<TrackChangesPluginState>;
 type TrackChangesPluginState = {
     shouldChangesBeDisplayed: boolean;
     isShowDiffAvailable: boolean;
     steps: InvertableStep[];
+    allocations: Set<number>;
 };
-export declare class InvertableStep {
-    readonly step: Step;
-    readonly inverted: Step;
-    constructor(step: Step, inverted: Step);
-}
+export declare const getBaselineFromSteps: (doc: PMNode, steps: InvertableStep[]) => PMNode;
 export declare const createTrackChangesPlugin: (api: ExtractInjectionAPI<TrackChangesPlugin> | undefined) => SafePlugin<TrackChangesPluginState>;
 export {};

package/dist/types/pm-plugins/maxSteps.d.ts

@@ -0,0 +1 @@
+export declare const MAX_STEPS_FROM_BASELINE = 10;

package/dist/types/pm-plugins/types.d.ts

@@ -1,3 +1,4 @@
 export declare enum TOGGLE_TRACK_CHANGES_ACTION {
-    TOGGLE_TRACK_CHANGES = "TOGGLE_TRACK_CHANGES"
+    TOGGLE_TRACK_CHANGES = "TOGGLE_TRACK_CHANGES",
+    RESET_BASELINE = "RESET_BASELINE"
 }

package/dist/types/trackChangesPluginType.d.ts

@@ -1,4 +1,5 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { HistoryPlugin } from '@atlaskit/editor-plugin-history';
 import { type PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
@@ -7,8 +8,32 @@ export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
          * Toggles the displaying of changes in the editor.
          */
         toggleChanges: EditorCommand;
+        /**
+         * Resets the baseline used for tracking changes in the editor.
+         */
+        resetBaseline: EditorCommand;
+    };
+    dependencies: [
+        /**
+         * Primary toolbar plugin for registering the track changes button.
+         */
+        OptionalPlugin<PrimaryToolbarPlugin>,
+        /**
+         * For ensuring the tracked changes align with the history
+         */
+        OptionalPlugin<HistoryPlugin>,
+        /**
+         * Show diff plugin for showing the changes in a diff view.
+         */
+        ShowDiffPlugin
+    ];
+    pluginConfiguration?: {
+        /**
+         * Whether the track changes button should be shown on the toolbar.
+         * Defaults to false.
+         */
+        showOnToolbar?: boolean;
     };
-    dependencies: [OptionalPlugin<PrimaryToolbarPlugin>, ShowDiffPlugin];
     sharedState: {
         /**
          * Whether the track changes feature is currently displaying changes.

package/dist/types-ts4.5/pm-plugins/filterSteps.d.ts

@@ -0,0 +1,8 @@
+import type { InvertableStep } from './invertableStep';
+/**
+ * Returns the filtered steps to ensure we don't track an entire document worth of changes
+ */
+export declare function filterSteps(steps: InvertableStep[], allocations: Set<number>): {
+    steps: InvertableStep[];
+    allocations: Set<number>;
+};

package/dist/types-ts4.5/pm-plugins/invertableStep.d.ts

@@ -0,0 +1,7 @@
+import { type Step } from '@atlaskit/editor-prosemirror/transform';
+export declare class InvertableStep {
+    readonly step: Step;
+    readonly inverted: Step;
+    readonly allocation: number;
+    constructor(step: Step, inverted: Step, allocation: number);
+}

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -1,18 +1,16 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { type Step } from '@atlaskit/editor-prosemirror/transform';
 import type { TrackChangesPlugin } from '../trackChangesPluginType';
+import { InvertableStep } from './invertableStep';
 export declare const trackChangesPluginKey: PluginKey<TrackChangesPluginState>;
 type TrackChangesPluginState = {
     shouldChangesBeDisplayed: boolean;
     isShowDiffAvailable: boolean;
     steps: InvertableStep[];
+    allocations: Set<number>;
 };
-export declare class InvertableStep {
-    readonly step: Step;
-    readonly inverted: Step;
-    constructor(step: Step, inverted: Step);
-}
+export declare const getBaselineFromSteps: (doc: PMNode, steps: InvertableStep[]) => PMNode;
 export declare const createTrackChangesPlugin: (api: ExtractInjectionAPI<TrackChangesPlugin> | undefined) => SafePlugin<TrackChangesPluginState>;
 export {};

package/dist/types-ts4.5/pm-plugins/maxSteps.d.ts

@@ -0,0 +1 @@
+export declare const MAX_STEPS_FROM_BASELINE = 10;

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

@@ -1,3 +1,4 @@
 export declare enum TOGGLE_TRACK_CHANGES_ACTION {
-    TOGGLE_TRACK_CHANGES = "TOGGLE_TRACK_CHANGES"
+    TOGGLE_TRACK_CHANGES = "TOGGLE_TRACK_CHANGES",
+    RESET_BASELINE = "RESET_BASELINE"
 }

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

@@ -1,4 +1,5 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { HistoryPlugin } from '@atlaskit/editor-plugin-history';
 import { type PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
@@ -7,11 +8,32 @@ export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
          * Toggles the displaying of changes in the editor.
          */
         toggleChanges: EditorCommand;
+        /**
+         * Resets the baseline used for tracking changes in the editor.
+         */
+        resetBaseline: EditorCommand;
     };
     dependencies: [
+        /**
+         * Primary toolbar plugin for registering the track changes button.
+         */
         OptionalPlugin<PrimaryToolbarPlugin>,
+        /**
+         * For ensuring the tracked changes align with the history
+         */
+        OptionalPlugin<HistoryPlugin>,
+        /**
+         * Show diff plugin for showing the changes in a diff view.
+         */
         ShowDiffPlugin
     ];
+    pluginConfiguration?: {
+        /**
+         * Whether the track changes button should be shown on the toolbar.
+         * Defaults to false.
+         */
+        showOnToolbar?: boolean;
+    };
     sharedState: {
         /**
          * Whether the track changes feature is currently displaying changes.

package/docs/0-intro.tsx

@@ -30,11 +30,47 @@ The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\
 below:
 
 ${code`
-type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
-	commands: {
-		toggleChanges: EditorCommand
-	}
-}>;
+type TrackChangesPlugin = NextEditorPlugin<
+  'trackChanges',
+  {
+    commands: {
+      /**
+       * Toggles the displaying of changes in the editor.
+       */
+      toggleChanges: EditorCommand;
+    };
+    dependencies: [
+      /**
+       * Primary toolbar plugin for registering the track changes button.
+       */
+      OptionalPlugin<PrimaryToolbarPlugin>,
+      /**
+       * Show diff plugin for showing the changes in a diff view.
+       */
+      ShowDiffPlugin,
+    ];
+    pluginConfiguration?: {
+      /**
+       * Whether the track changes button should be shown on the toolbar.
+       * Defaults to false.
+       */
+      showOnToolbar?: boolean;
+    };
+    sharedState: {
+      /**
+       * Whether the track changes feature is currently displaying changes.
+       * Defaults to false.
+       */
+      isDisplayingChanges: boolean;
+      /**
+       * If there are changes in the document that determine if track changes button
+       * should be enabled.
+       * This will only be false initially before any changes in the session.
+       */
+      isShowDiffAvailable: boolean;
+    };
+  }
+>;
 `}
 
   ### Example Usage
@@ -51,7 +87,8 @@ import { basePlugin } from '@atlaskit/editor-plugins/base';
 import { Box } from '@atlaskit/primitives/compiled';
 import { token } from '@atlaskit/tokens';
 
-import { trackChangesPlugin } from '../src/trackChangesPlugin';
+import { showDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
+import { trackChangesPlugin } from '@atlaskit/editor-plugin-track-changes';
 
 const styles = cssMap({
 	aboveEditor: {
@@ -69,7 +106,7 @@ const styles = cssMap({
 function Editor() {
 	const { preset, editorApi } = usePreset(
 		(builder) =>
-			builder.add(basePlugin).add(trackChangesPlugin),
+			builder.add(basePlugin).add(showDiffPlugin).add(trackChangesPlugin),
 		[],
 	);
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-track-changes",
-	"version": "2.2.0",
+	"version": "2.4.0",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,14 +32,16 @@
 	},
 	"dependencies": {
 		"@atlaskit/button": "^23.3.0",
+		"@atlaskit/editor-plugin-history": "3.1.0",
 		"@atlaskit/editor-plugin-primary-toolbar": "^4.1.0",
 		"@atlaskit/editor-plugin-show-diff": "0.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/icon-lab": "^5.2.0",
-		"@babel/runtime": "^7.0.0"
+		"@babel/runtime": "^7.0.0",
+		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.13.0",
+		"@atlaskit/editor-common": "^107.14.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {

package/tsconfig.json

@@ -1,12 +1,18 @@
 {
-	"extends": "../../../tsconfig.json",
-	"include": [
-		"examples/**/*.ts",
-		"examples/**/*.tsx",
-		"example-helpers/**/*.ts",
-		"example-helpers/**/*.tsx",
-		"src/**/*.ts",
-		"src/**/*.tsx"
-	],
-	"compilerOptions": {}
+  "extends": "../../../tsconfig.json",
+  "include": [
+    "examples/**/*.ts",
+    "examples/**/*.tsx",
+    "example-helpers/**/*.ts",
+    "example-helpers/**/*.tsx",
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "**/stories.ts",
+    "**/stories.tsx",
+    "**/stories/*.ts",
+    "**/stories/*.tsx",
+    "**/stories/**/*.ts",
+    "**/stories/**/*.tsx"
+  ],
+  "compilerOptions": {}
 }