@atlaskit/editor-plugin-track-changes 6.0.1 → 6.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-track-changes
 
+## 6.0.2
+
+### Patch Changes
+
+- [`819348f0857f5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/819348f0857f5) -
+  [ux] [EDITOR-3769] added shortcut to track changes button
+- Updated dependencies
+
 ## 6.0.1
 
 ### Patch Changes

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

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.keymapPlugin = keymapPlugin;
+var _browser = require("@atlaskit/editor-common/browser");
+var _keymaps = require("@atlaskit/editor-common/keymaps");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _keymap = require("@atlaskit/editor-prosemirror/keymap");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+function keymapPlugin(api) {
+  var list = {};
+  var browser = (0, _browser.getBrowserInfo)();
+
+  // Exclude Firefox browser from keyboard shortcut
+  if (!browser.gecko && (0, _platformFeatureFlags.fg)('platform_editor_ai_aifc_patch_ga_blockers')) {
+    (0, _keymaps.bindKeymapWithCommand)(
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    _keymaps.toggleViewChanges.common, function () {
+      var _api$trackChanges, _api$trackChanges2;
+      var isShowDiffAvailable = 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 ? void 0 : _api$trackChanges.isShowDiffAvailable;
+      if (!isShowDiffAvailable) {
+        return false;
+      }
+      var result = api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 || (_api$trackChanges2 = api.trackChanges) === null || _api$trackChanges2 === void 0 ? void 0 : _api$trackChanges2.commands.toggleChanges);
+      return result !== null && result !== void 0 ? result : false;
+    }, list);
+  }
+  return new _safePlugin.SafePlugin({
+    props: {
+      handleKeyDown: function handleKeyDown(view, event) {
+        var keyboardEvent = (0, _keymaps.isCapsLockOnAndModifyKeyboardEvent)(event);
+        return (0, _keymap.keydownHandler)(list)(view, keyboardEvent);
+      }
+    }
+  });
+}

package/dist/cjs/trackChangesPlugin.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.trackChangesPlugin = void 0;
 var _react = _interopRequireDefault(require("react"));
+var _keymaps = require("./pm-plugins/keymaps");
 var _main = require("./pm-plugins/main");
 var _types = require("./pm-plugins/types");
 var _toolbarComponents = require("./ui/toolbar-components");
@@ -35,6 +36,11 @@ var trackChangesPlugin = exports.trackChangesPlugin = function trackChangesPlugi
     name: 'trackChanges',
     pmPlugins: function pmPlugins() {
       return [{
+        name: 'trackChangesKeyMap',
+        plugin: function plugin() {
+          return (0, _keymaps.keymapPlugin)(api);
+        }
+      }, {
         name: 'trackChangesPlugin',
         plugin: function plugin() {
           return (0, _main.createTrackChangesPlugin)(api);

package/dist/cjs/ui/TrackChangesToolbarButton.js

@@ -8,9 +8,12 @@ exports.TrackChangesToolbarButton = void 0;
 var _react = _interopRequireDefault(require("react"));
 var _reactIntlNext = require("react-intl-next");
 var _new = require("@atlaskit/button/new");
+var _browser = require("@atlaskit/editor-common/browser");
 var _hooks = require("@atlaskit/editor-common/hooks");
+var _keymaps = require("@atlaskit/editor-common/keymaps");
 var _messages = require("@atlaskit/editor-common/messages");
 var _editorToolbar = require("@atlaskit/editor-toolbar");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref) {
   var api = _ref.api,
     Wrapper = _ref.wrapper;
@@ -35,9 +38,16 @@ var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function Tra
       api === null || api === void 0 || api.core.actions.focus();
     }
   }, [api, isDisplayingChanges]);
+  var browser = (0, _browser.getBrowserInfo)();
+  // Exclude Firefox browser from showing keyboard shortcut in tooltip
+  var showShortcut = !browser.gecko && (0, _platformFeatureFlags.fg)('platform_editor_ai_aifc_patch_ga_blockers');
+  var tooltipContent = showShortcut ? /*#__PURE__*/_react.default.createElement(_keymaps.ToolTipContent, {
+    description: formatMessage(_messages.trackChangesMessages.toolbarIconLabel),
+    keymap: _keymaps.toggleViewChanges
+  }) : formatMessage(_messages.trackChangesMessages.toolbarIconLabel);
   if (!isToolbarAIFCEnabled) {
     return /*#__PURE__*/_react.default.createElement(_editorToolbar.ToolbarTooltip, {
-      content: formatMessage(_messages.trackChangesMessages.toolbarIconLabel)
+      content: tooltipContent
     }, /*#__PURE__*/_react.default.createElement(_new.IconButton, {
       icon: _editorToolbar.HistoryIcon,
       label: formatMessage(_messages.trackChangesMessages.toolbarIconLabel),
@@ -48,7 +58,7 @@ var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function Tra
     }));
   }
   var button = /*#__PURE__*/_react.default.createElement(_editorToolbar.ToolbarTooltip, {
-    content: formatMessage(_messages.trackChangesMessages.toolbarIconLabel)
+    content: tooltipContent
   }, /*#__PURE__*/_react.default.createElement(_editorToolbar.ToolbarButton, {
     iconBefore: /*#__PURE__*/_react.default.createElement(_editorToolbar.HistoryIcon, {
       label: formatMessage(_messages.trackChangesMessages.toolbarIconLabel),

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

@@ -0,0 +1,32 @@
+import { getBrowserInfo } from '@atlaskit/editor-common/browser';
+import { bindKeymapWithCommand, isCapsLockOnAndModifyKeyboardEvent, toggleViewChanges } from '@atlaskit/editor-common/keymaps';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
+import { fg } from '@atlaskit/platform-feature-flags';
+export function keymapPlugin(api) {
+  const list = {};
+  const browser = getBrowserInfo();
+
+  // Exclude Firefox browser from keyboard shortcut
+  if (!browser.gecko && fg('platform_editor_ai_aifc_patch_ga_blockers')) {
+    bindKeymapWithCommand(
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    toggleViewChanges.common, () => {
+      var _api$trackChanges, _api$trackChanges$sha, _api$trackChanges2;
+      const isShowDiffAvailable = api === null || api === void 0 ? void 0 : (_api$trackChanges = api.trackChanges) === null || _api$trackChanges === void 0 ? void 0 : (_api$trackChanges$sha = _api$trackChanges.sharedState.currentState()) === null || _api$trackChanges$sha === void 0 ? void 0 : _api$trackChanges$sha.isShowDiffAvailable;
+      if (!isShowDiffAvailable) {
+        return false;
+      }
+      const result = api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : (_api$trackChanges2 = api.trackChanges) === null || _api$trackChanges2 === void 0 ? void 0 : _api$trackChanges2.commands.toggleChanges);
+      return result !== null && result !== void 0 ? result : false;
+    }, list);
+  }
+  return new SafePlugin({
+    props: {
+      handleKeyDown(view, event) {
+        const keyboardEvent = isCapsLockOnAndModifyKeyboardEvent(event);
+        return keydownHandler(list)(view, keyboardEvent);
+      }
+    }
+  });
+}

package/dist/es2019/trackChangesPlugin.js

@@ -1,4 +1,5 @@
 import React from 'react';
+import { keymapPlugin } from './pm-plugins/keymaps';
 import { createTrackChangesPlugin, trackChangesPluginKey } from './pm-plugins/main';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './pm-plugins/types';
 import { getToolbarComponents } from './ui/toolbar-components';
@@ -29,6 +30,9 @@ export const trackChangesPlugin = ({
     name: 'trackChanges',
     pmPlugins() {
       return [{
+        name: 'trackChangesKeyMap',
+        plugin: () => keymapPlugin(api)
+      }, {
         name: 'trackChangesPlugin',
         plugin: () => createTrackChangesPlugin(api)
       }];

package/dist/es2019/ui/TrackChangesToolbarButton.js

@@ -1,9 +1,12 @@
 import React from 'react';
 import { useIntl } from 'react-intl-next';
 import { IconButton } from '@atlaskit/button/new';
+import { getBrowserInfo } from '@atlaskit/editor-common/browser';
 import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
+import { toggleViewChanges, ToolTipContent } from '@atlaskit/editor-common/keymaps';
 import { trackChangesMessages } from '@atlaskit/editor-common/messages';
 import { ToolbarButton, ToolbarTooltip, HistoryIcon } from '@atlaskit/editor-toolbar';
+import { fg } from '@atlaskit/platform-feature-flags';
 export const TrackChangesToolbarButton = ({
   api,
   wrapper: Wrapper
@@ -31,9 +34,16 @@ export const TrackChangesToolbarButton = ({
       api === null || api === void 0 ? void 0 : api.core.actions.focus();
     }
   }, [api, isDisplayingChanges]);
+  const browser = getBrowserInfo();
+  // Exclude Firefox browser from showing keyboard shortcut in tooltip
+  const showShortcut = !browser.gecko && fg('platform_editor_ai_aifc_patch_ga_blockers');
+  const tooltipContent = showShortcut ? /*#__PURE__*/React.createElement(ToolTipContent, {
+    description: formatMessage(trackChangesMessages.toolbarIconLabel),
+    keymap: toggleViewChanges
+  }) : formatMessage(trackChangesMessages.toolbarIconLabel);
   if (!isToolbarAIFCEnabled) {
     return /*#__PURE__*/React.createElement(ToolbarTooltip, {
-      content: formatMessage(trackChangesMessages.toolbarIconLabel)
+      content: tooltipContent
     }, /*#__PURE__*/React.createElement(IconButton, {
       icon: HistoryIcon,
       label: formatMessage(trackChangesMessages.toolbarIconLabel),
@@ -44,7 +54,7 @@ export const TrackChangesToolbarButton = ({
     }));
   }
   const button = /*#__PURE__*/React.createElement(ToolbarTooltip, {
-    content: formatMessage(trackChangesMessages.toolbarIconLabel)
+    content: tooltipContent
   }, /*#__PURE__*/React.createElement(ToolbarButton, {
     iconBefore: /*#__PURE__*/React.createElement(HistoryIcon, {
       label: formatMessage(trackChangesMessages.toolbarIconLabel),

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

@@ -0,0 +1,32 @@
+import { getBrowserInfo } from '@atlaskit/editor-common/browser';
+import { bindKeymapWithCommand, isCapsLockOnAndModifyKeyboardEvent, toggleViewChanges } from '@atlaskit/editor-common/keymaps';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
+import { fg } from '@atlaskit/platform-feature-flags';
+export function keymapPlugin(api) {
+  var list = {};
+  var browser = getBrowserInfo();
+
+  // Exclude Firefox browser from keyboard shortcut
+  if (!browser.gecko && fg('platform_editor_ai_aifc_patch_ga_blockers')) {
+    bindKeymapWithCommand(
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    toggleViewChanges.common, function () {
+      var _api$trackChanges, _api$trackChanges2;
+      var isShowDiffAvailable = 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 ? void 0 : _api$trackChanges.isShowDiffAvailable;
+      if (!isShowDiffAvailable) {
+        return false;
+      }
+      var result = api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 || (_api$trackChanges2 = api.trackChanges) === null || _api$trackChanges2 === void 0 ? void 0 : _api$trackChanges2.commands.toggleChanges);
+      return result !== null && result !== void 0 ? result : false;
+    }, list);
+  }
+  return new SafePlugin({
+    props: {
+      handleKeyDown: function handleKeyDown(view, event) {
+        var keyboardEvent = isCapsLockOnAndModifyKeyboardEvent(event);
+        return keydownHandler(list)(view, keyboardEvent);
+      }
+    }
+  });
+}

package/dist/esm/trackChangesPlugin.js

@@ -1,4 +1,5 @@
 import React from 'react';
+import { keymapPlugin } from './pm-plugins/keymaps';
 import { createTrackChangesPlugin, trackChangesPluginKey } from './pm-plugins/main';
 import { TOGGLE_TRACK_CHANGES_ACTION as ACTION } from './pm-plugins/types';
 import { getToolbarComponents } from './ui/toolbar-components';
@@ -28,6 +29,11 @@ export var trackChangesPlugin = function trackChangesPlugin(_ref) {
     name: 'trackChanges',
     pmPlugins: function pmPlugins() {
       return [{
+        name: 'trackChangesKeyMap',
+        plugin: function plugin() {
+          return keymapPlugin(api);
+        }
+      }, {
         name: 'trackChangesPlugin',
         plugin: function plugin() {
           return createTrackChangesPlugin(api);

package/dist/esm/ui/TrackChangesToolbarButton.js

@@ -1,9 +1,12 @@
 import React from 'react';
 import { useIntl } from 'react-intl-next';
 import { IconButton } from '@atlaskit/button/new';
+import { getBrowserInfo } from '@atlaskit/editor-common/browser';
 import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
+import { toggleViewChanges, ToolTipContent } from '@atlaskit/editor-common/keymaps';
 import { trackChangesMessages } from '@atlaskit/editor-common/messages';
 import { ToolbarButton, ToolbarTooltip, HistoryIcon } from '@atlaskit/editor-toolbar';
+import { fg } from '@atlaskit/platform-feature-flags';
 export var TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref) {
   var api = _ref.api,
     Wrapper = _ref.wrapper;
@@ -28,9 +31,16 @@ export var TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref)
       api === null || api === void 0 || api.core.actions.focus();
     }
   }, [api, isDisplayingChanges]);
+  var browser = getBrowserInfo();
+  // Exclude Firefox browser from showing keyboard shortcut in tooltip
+  var showShortcut = !browser.gecko && fg('platform_editor_ai_aifc_patch_ga_blockers');
+  var tooltipContent = showShortcut ? /*#__PURE__*/React.createElement(ToolTipContent, {
+    description: formatMessage(trackChangesMessages.toolbarIconLabel),
+    keymap: toggleViewChanges
+  }) : formatMessage(trackChangesMessages.toolbarIconLabel);
   if (!isToolbarAIFCEnabled) {
     return /*#__PURE__*/React.createElement(ToolbarTooltip, {
-      content: formatMessage(trackChangesMessages.toolbarIconLabel)
+      content: tooltipContent
     }, /*#__PURE__*/React.createElement(IconButton, {
       icon: HistoryIcon,
       label: formatMessage(trackChangesMessages.toolbarIconLabel),
@@ -41,7 +51,7 @@ export var TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref)
     }));
   }
   var button = /*#__PURE__*/React.createElement(ToolbarTooltip, {
-    content: formatMessage(trackChangesMessages.toolbarIconLabel)
+    content: tooltipContent
   }, /*#__PURE__*/React.createElement(ToolbarButton, {
     iconBefore: /*#__PURE__*/React.createElement(HistoryIcon, {
       label: formatMessage(trackChangesMessages.toolbarIconLabel),

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

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { TrackChangesPlugin } from '../trackChangesPluginType';
+export declare function keymapPlugin(api?: ExtractInjectionAPI<TrackChangesPlugin>): SafePlugin;

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

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { TrackChangesPlugin } from '../trackChangesPluginType';
+export declare function keymapPlugin(api?: ExtractInjectionAPI<TrackChangesPlugin>): SafePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-track-changes",
-	"version": "6.0.1",
+	"version": "6.0.2",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -45,11 +45,15 @@
 		"react": "^18.2.0"
 	},
 	"featureGates": [
-		"platform_editor_toolbar_aifc_undo_redo_confluence"
+		"platform_editor_toolbar_aifc_undo_redo_confluence",
+		"platform_editor_ai_aifc_patch_ga_blockers"
 	],
 	"platform-feature-flags": {
 		"platform_editor_toolbar_aifc_undo_redo_confluence": {
 			"type": "boolean"
+		},
+		"platform_editor_ai_aifc_patch_ga_blockers": {
+			"type": "boolean"
 		}
 	},
 	"techstack": {