@atlaskit/editor-plugin-track-changes 2.1.1 → 2.3.0

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

@@ -1,29 +1,37 @@
-import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { createInlineChangedDecoration, createDeletedContentDecoration } from './decorations';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './types';
 export const trackChangesPluginKey = new PluginKey('trackChangesPlugin');
-export const createTrackChangesPlugin = () => {
+export class InvertableStep {
+  constructor(step, inverted) {
+    this.step = step;
+    this.inverted = inverted;
+  }
+}
+const getBaselineFromSteps = (doc, steps) => {
+  for (const step of steps.slice().reverse()) {
+    const result = step.inverted.apply(doc);
+    if (result.failed === null && result.doc) {
+      doc = result.doc;
+    }
+  }
+  return doc;
+};
+export const createTrackChangesPlugin = api => {
   // Mark the state to be reset on next time the document has a meaningful change
   let resetBaseline = false;
   return new SafePlugin({
     key: trackChangesPluginKey,
     state: {
-      init(_, {
-        doc
-      }) {
+      init() {
         return {
-          changes: ChangeSet.create(doc),
+          steps: [],
           shouldChangesBeDisplayed: false,
-          isShowDiffAvailable: false,
-          baselineDoc: doc,
-          numOfChanges: 0
+          isShowDiffAvailable: false
         };
       },
-      apply(tr, state, oldState, newState) {
+      apply(tr, state) {
         const metadata = tr.getMeta(trackChangesPluginKey);
         if (metadata && metadata.action === ACTION.TOGGLE_TRACK_CHANGES) {
           resetBaseline = true;
@@ -37,54 +45,39 @@ export const createTrackChangesPlugin = () => {
           // If no document changes, return the old changeSet
           return state;
         }
-        const changes = resetBaseline ? ChangeSet.create(tr.docs[0]).addSteps(tr.doc,
-        // The new document
-        tr.mapping.maps,
-        // The set of changes
-        tr.docs[0].content // The old document
-        ) : state.changes.addSteps(tr.doc,
-        // The new document
-        tr.mapping.maps,
-        // The set of changes
-        tr.docs[0].content // The old document
-        );
-        const baselineDoc = resetBaseline ? tr.docs[0] : state.baselineDoc;
+        const newSteps = tr.steps.map((step, idx) => new InvertableStep(step, step.invert(tr.docs[idx])));
+        const steps = resetBaseline ? newSteps : [...state.steps, ...newSteps];
         resetBaseline = false;
 
         // Create a new ChangeSet based on document changes
         return {
           ...state,
-          baselineDoc,
+          steps,
           shouldChangesBeDisplayed: false,
-          changes,
           isShowDiffAvailable: true
         };
       }
     },
-    props: {
-      decorations: state => {
-        const pluginState = trackChangesPluginKey.getState(state);
-        if (!(pluginState !== null && pluginState !== void 0 && pluginState.shouldChangesBeDisplayed) || !pluginState.changes) {
-          return undefined;
-        }
-        const decoration = DecorationSet.empty;
-        const decorations = [];
-        const changes = simplifyChanges(pluginState.changes.changes, state.doc);
-        const tr = state.tr;
-        changes.forEach(change => {
-          if (change.inserted.length > 0) {
-            decorations.push(createInlineChangedDecoration(change));
-          }
-          if (change.deleted.length > 0) {
-            decorations.push(createDeletedContentDecoration({
-              change,
-              doc: pluginState === null || pluginState === void 0 ? void 0 : pluginState.baselineDoc,
-              tr
+    view() {
+      return {
+        update(view, prevState) {
+          var _trackChangesPluginKe;
+          const prevShouldChangesBeDisplayed = (_trackChangesPluginKe = trackChangesPluginKey.getState(prevState)) === null || _trackChangesPluginKe === void 0 ? void 0 : _trackChangesPluginKe.shouldChangesBeDisplayed;
+          const currentPluginState = trackChangesPluginKey.getState(view.state);
+          const currentShouldChangesBeDisplayed = currentPluginState === null || currentPluginState === void 0 ? void 0 : currentPluginState.shouldChangesBeDisplayed;
+          if (prevShouldChangesBeDisplayed === false && currentShouldChangesBeDisplayed === true) {
+            var _currentPluginState$s, _api$core, _api$showDiff, _api$showDiff$command;
+            const steps = (_currentPluginState$s = currentPluginState === null || currentPluginState === void 0 ? void 0 : currentPluginState.steps) !== null && _currentPluginState$s !== void 0 ? _currentPluginState$s : [];
+            api === null || api === void 0 ? void 0 : (_api$core = api.core) === null || _api$core === void 0 ? void 0 : _api$core.actions.execute(api === null || api === void 0 ? void 0 : (_api$showDiff = api.showDiff) === null || _api$showDiff === void 0 ? void 0 : (_api$showDiff$command = _api$showDiff.commands) === null || _api$showDiff$command === void 0 ? void 0 : _api$showDiff$command.showDiff({
+              originalDoc: getBaselineFromSteps(view.state.doc, steps),
+              steps: steps.map(s => s.step)
             }));
+          } else if (currentShouldChangesBeDisplayed === false && prevShouldChangesBeDisplayed === true) {
+            var _api$core2, _api$showDiff2, _api$showDiff2$comman;
+            api === null || api === void 0 ? void 0 : (_api$core2 = api.core) === null || _api$core2 === void 0 ? void 0 : _api$core2.actions.execute(api === null || api === void 0 ? void 0 : (_api$showDiff2 = api.showDiff) === null || _api$showDiff2 === void 0 ? void 0 : (_api$showDiff2$comman = _api$showDiff2.commands) === null || _api$showDiff2$comman === void 0 ? void 0 : _api$showDiff2$comman.hideDiff);
           }
-        });
-        return decoration.add(tr.doc, decorations);
-      }
+        }
+      };
     }
   });
 };

package/dist/es2019/trackChangesPlugin.js

@@ -1,33 +1,52 @@
+import React from 'react';
 import { createTrackChangesPlugin, trackChangesPluginKey } from './pm-plugins/main';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './pm-plugins/types';
-export const trackChangesPlugin = () => ({
-  name: 'trackChanges',
-  pmPlugins() {
-    return [{
-      name: 'trackChangesPlugin',
-      plugin: createTrackChangesPlugin
-    }];
-  },
-  commands: {
-    toggleChanges: ({
-      tr
-    }) => {
-      return tr.setMeta(trackChangesPluginKey, {
-        action: ACTION.TOGGLE_TRACK_CHANGES
-      });
-    }
-  },
-  getSharedState: editorState => {
-    var _trackChangesPluginKe, _trackChangesPluginKe2;
-    if (!editorState) {
+import { TrackChangesToolbarButton } from './ui/TrackChangesToolbarButton';
+export const trackChangesPlugin = ({
+  api,
+  config: options
+}) => {
+  const primaryToolbarComponent = () => {
+    return /*#__PURE__*/React.createElement(TrackChangesToolbarButton, {
+      api: api
+    });
+  };
+  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() {
+      return [{
+        name: 'trackChangesPlugin',
+        plugin: () => createTrackChangesPlugin(api)
+      }];
+    },
+    commands: {
+      toggleChanges: ({
+        tr
+      }) => {
+        return tr.setMeta(trackChangesPluginKey, {
+          action: ACTION.TOGGLE_TRACK_CHANGES
+        });
+      }
+    },
+    getSharedState: editorState => {
+      var _trackChangesPluginKe, _trackChangesPluginKe2;
+      if (!editorState) {
+        return {
+          isDisplayingChanges: false,
+          isShowDiffAvailable: false
+        };
+      }
       return {
-        isDisplayingChanges: false,
-        isShowDiffAvailable: false
+        isDisplayingChanges: Boolean((_trackChangesPluginKe = trackChangesPluginKey.getState(editorState)) === null || _trackChangesPluginKe === void 0 ? void 0 : _trackChangesPluginKe.shouldChangesBeDisplayed),
+        isShowDiffAvailable: Boolean((_trackChangesPluginKe2 = trackChangesPluginKey.getState(editorState)) === null || _trackChangesPluginKe2 === void 0 ? void 0 : _trackChangesPluginKe2.isShowDiffAvailable)
       };
     }
-    return {
-      isDisplayingChanges: Boolean((_trackChangesPluginKe = trackChangesPluginKey.getState(editorState)) === null || _trackChangesPluginKe === void 0 ? void 0 : _trackChangesPluginKe.shouldChangesBeDisplayed),
-      isShowDiffAvailable: Boolean((_trackChangesPluginKe2 = trackChangesPluginKey.getState(editorState)) === null || _trackChangesPluginKe2 === void 0 ? void 0 : _trackChangesPluginKe2.isShowDiffAvailable)
-    };
-  }
-});
+  };
+};

package/dist/es2019/ui/TrackChangesToolbarButton.js

@@ -0,0 +1,35 @@
+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
+}) => {
+  var _api$trackChanges;
+  const {
+    isDisplayingChanges,
+    isShowDiffAvailable
+  } = useSharedPluginStateWithSelector(api, ['trackChanges'], states => {
+    var _states$trackChangesS, _states$trackChangesS2;
+    return {
+      isDisplayingChanges: (_states$trackChangesS = states.trackChangesState) === null || _states$trackChangesS === void 0 ? void 0 : _states$trackChangesS.isDisplayingChanges,
+      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: formatMessage(trackChangesMessages.toolbarIconLabel),
+    appearance: "subtle",
+    isDisabled: !isShowDiffAvailable,
+    isSelected: isDisplayingChanges,
+    onClick: handleClick
+  });
+};

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

@@ -1,31 +1,54 @@
+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; }
-import { ChangeSet, simplifyChanges } from 'prosemirror-changeset';
+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 { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { createInlineChangedDecoration, createDeletedContentDecoration } from './decorations';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './types';
 export var trackChangesPluginKey = new PluginKey('trackChangesPlugin');
-export var createTrackChangesPlugin = function createTrackChangesPlugin() {
+export var InvertableStep = /*#__PURE__*/_createClass(function InvertableStep(step, inverted) {
+  _classCallCheck(this, InvertableStep);
+  this.step = step;
+  this.inverted = inverted;
+});
+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);
+      if (result.failed === null && result.doc) {
+        doc = result.doc;
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return doc;
+};
+export var createTrackChangesPlugin = function createTrackChangesPlugin(api) {
   // Mark the state to be reset on next time the document has a meaningful change
   var resetBaseline = false;
   return new SafePlugin({
     key: trackChangesPluginKey,
     state: {
-      init: function init(_, _ref) {
-        var doc = _ref.doc;
+      init: function init() {
         return {
-          changes: ChangeSet.create(doc),
+          steps: [],
           shouldChangesBeDisplayed: false,
-          isShowDiffAvailable: false,
-          baselineDoc: doc,
-          numOfChanges: 0
+          isShowDiffAvailable: false
         };
       },
-      apply: function apply(tr, state, oldState, newState) {
+      apply: function apply(tr, state) {
         var metadata = tr.getMeta(trackChangesPluginKey);
         if (metadata && metadata.action === ACTION.TOGGLE_TRACK_CHANGES) {
           resetBaseline = true;
@@ -40,53 +63,42 @@ export var createTrackChangesPlugin = function createTrackChangesPlugin() {
           // If no document changes, return the old changeSet
           return state;
         }
-        var changes = resetBaseline ? ChangeSet.create(tr.docs[0]).addSteps(tr.doc,
-        // The new document
-        tr.mapping.maps,
-        // The set of changes
-        tr.docs[0].content // The old document
-        ) : state.changes.addSteps(tr.doc,
-        // The new document
-        tr.mapping.maps,
-        // The set of changes
-        tr.docs[0].content // The old document
-        );
-        var baselineDoc = resetBaseline ? tr.docs[0] : state.baselineDoc;
+        var newSteps = tr.steps.map(function (step, idx) {
+          return new InvertableStep(step, step.invert(tr.docs[idx]));
+        });
+        var steps = resetBaseline ? newSteps : [].concat(_toConsumableArray(state.steps), _toConsumableArray(newSteps));
         resetBaseline = false;
 
         // Create a new ChangeSet based on document changes
         return _objectSpread(_objectSpread({}, state), {}, {
-          baselineDoc: baselineDoc,
+          steps: steps,
           shouldChangesBeDisplayed: false,
-          changes: changes,
           isShowDiffAvailable: true
         });
       }
     },
-    props: {
-      decorations: function decorations(state) {
-        var pluginState = trackChangesPluginKey.getState(state);
-        if (!(pluginState !== null && pluginState !== void 0 && pluginState.shouldChangesBeDisplayed) || !pluginState.changes) {
-          return undefined;
-        }
-        var decoration = DecorationSet.empty;
-        var decorations = [];
-        var changes = simplifyChanges(pluginState.changes.changes, state.doc);
-        var tr = state.tr;
-        changes.forEach(function (change) {
-          if (change.inserted.length > 0) {
-            decorations.push(createInlineChangedDecoration(change));
-          }
-          if (change.deleted.length > 0) {
-            decorations.push(createDeletedContentDecoration({
-              change: change,
-              doc: pluginState === null || pluginState === void 0 ? void 0 : pluginState.baselineDoc,
-              tr: tr
+    view: function view() {
+      return {
+        update: function update(view, prevState) {
+          var _trackChangesPluginKe;
+          var prevShouldChangesBeDisplayed = (_trackChangesPluginKe = trackChangesPluginKey.getState(prevState)) === null || _trackChangesPluginKe === void 0 ? void 0 : _trackChangesPluginKe.shouldChangesBeDisplayed;
+          var currentPluginState = trackChangesPluginKey.getState(view.state);
+          var currentShouldChangesBeDisplayed = currentPluginState === null || currentPluginState === void 0 ? void 0 : currentPluginState.shouldChangesBeDisplayed;
+          if (prevShouldChangesBeDisplayed === false && currentShouldChangesBeDisplayed === true) {
+            var _currentPluginState$s, _api$core, _api$showDiff;
+            var steps = (_currentPluginState$s = currentPluginState === null || currentPluginState === void 0 ? void 0 : currentPluginState.steps) !== null && _currentPluginState$s !== void 0 ? _currentPluginState$s : [];
+            api === null || api === void 0 || (_api$core = api.core) === null || _api$core === void 0 || _api$core.actions.execute(api === null || api === void 0 || (_api$showDiff = api.showDiff) === null || _api$showDiff === void 0 || (_api$showDiff = _api$showDiff.commands) === null || _api$showDiff === void 0 ? void 0 : _api$showDiff.showDiff({
+              originalDoc: getBaselineFromSteps(view.state.doc, steps),
+              steps: steps.map(function (s) {
+                return s.step;
+              })
             }));
+          } else if (currentShouldChangesBeDisplayed === false && prevShouldChangesBeDisplayed === true) {
+            var _api$core2, _api$showDiff2;
+            api === null || api === void 0 || (_api$core2 = api.core) === null || _api$core2 === void 0 || _api$core2.actions.execute(api === null || api === void 0 || (_api$showDiff2 = api.showDiff) === null || _api$showDiff2 === void 0 || (_api$showDiff2 = _api$showDiff2.commands) === null || _api$showDiff2 === void 0 ? void 0 : _api$showDiff2.hideDiff);
           }
-        });
-        return decoration.add(tr.doc, decorations);
-      }
+        }
+      };
     }
   });
 };

package/dist/esm/trackChangesPlugin.js

@@ -1,17 +1,35 @@
+import React from 'react';
 import { createTrackChangesPlugin, trackChangesPluginKey } from './pm-plugins/main';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './pm-plugins/types';
-export var trackChangesPlugin = function trackChangesPlugin() {
+import { TrackChangesToolbarButton } from './ui/TrackChangesToolbarButton';
+export var trackChangesPlugin = function trackChangesPlugin(_ref) {
+  var api = _ref.api,
+    options = _ref.config;
+  var primaryToolbarComponent = function primaryToolbarComponent() {
+    return /*#__PURE__*/React.createElement(TrackChangesToolbarButton, {
+      api: api
+    });
+  };
+  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() {
       return [{
         name: 'trackChangesPlugin',
-        plugin: createTrackChangesPlugin
+        plugin: function plugin() {
+          return createTrackChangesPlugin(api);
+        }
       }];
     },
     commands: {
-      toggleChanges: function toggleChanges(_ref) {
-        var tr = _ref.tr;
+      toggleChanges: function toggleChanges(_ref2) {
+        var tr = _ref2.tr;
         return tr.setMeta(trackChangesPluginKey, {
           action: ACTION.TOGGLE_TRACK_CHANGES
         });

package/dist/esm/ui/TrackChangesToolbarButton.js

@@ -0,0 +1,32 @@
+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;
+  var api = _ref.api;
+  var _useSharedPluginState = useSharedPluginStateWithSelector(api, ['trackChanges'], function (states) {
+      var _states$trackChangesS, _states$trackChangesS2;
+      return {
+        isDisplayingChanges: (_states$trackChangesS = states.trackChangesState) === null || _states$trackChangesS === void 0 ? void 0 : _states$trackChangesS.isDisplayingChanges,
+        isShowDiffAvailable: (_states$trackChangesS2 = states.trackChangesState) === null || _states$trackChangesS2 === void 0 ? void 0 : _states$trackChangesS2.isShowDiffAvailable
+      };
+    }),
+    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: formatMessage(trackChangesMessages.toolbarIconLabel),
+    appearance: "subtle",
+    isDisabled: !isShowDiffAvailable,
+    isSelected: isDisplayingChanges,
+    onClick: handleClick
+  });
+};

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

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

package/dist/types/trackChangesPluginType.d.ts

@@ -1,4 +1,6 @@
-import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import { type PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
+import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
     commands: {
         /**
@@ -6,6 +8,23 @@ export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
          */
         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.

package/dist/types/ui/TrackChangesToolbarButton.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type TrackChangesPlugin } from '../trackChangesPluginType';
+type TrackChangesToolbarButtonProps = {
+    api: ExtractInjectionAPI<TrackChangesPlugin> | undefined;
+};
+export declare const TrackChangesToolbarButton: ({ api }: TrackChangesToolbarButtonProps) => React.JSX.Element;
+export {};

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

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

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

@@ -1,4 +1,6 @@
-import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import { type PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
+import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
     commands: {
         /**
@@ -6,6 +8,23 @@ export type TrackChangesPlugin = NextEditorPlugin<'trackChanges', {
          */
         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.

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type TrackChangesPlugin } from '../trackChangesPluginType';
+type TrackChangesToolbarButtonProps = {
+    api: ExtractInjectionAPI<TrackChangesPlugin> | undefined;
+};
+export declare const TrackChangesToolbarButton: ({ api }: TrackChangesToolbarButtonProps) => React.JSX.Element;
+export {};