@atlaskit/editor-plugin-undo-redo 2.0.10 → 2.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # @atlaskit/editor-plugin-undo-redo
2
2
 
3
+ ## 2.0.12
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 2.0.11
10
+
11
+ ### Patch Changes
12
+
13
+ - [#149778](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/149778)
14
+ [`de5587be5f109`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/de5587be5f109) -
15
+ Added undo/redo via shortcut analytics
16
+ - Updated dependencies
17
+
3
18
  ## 2.0.10
4
19
 
5
20
  ### Patch Changes
@@ -42,14 +42,14 @@ var inputSourceToInputMethod = function inputSourceToInputMethod(inputSource) {
42
42
  var attachInputMetaWithAnalytics = exports.attachInputMetaWithAnalytics = function attachInputMetaWithAnalytics(editorAnalyticsAPI) {
43
43
  return function (inputSource, action) {
44
44
  return function (command) {
45
- return (0, _editorAnalytics.withAnalytics)(editorAnalyticsAPI, {
45
+ return attachInputMeta(inputSource)((0, _editorAnalytics.withAnalytics)(editorAnalyticsAPI, {
46
46
  eventType: _analytics.EVENT_TYPE.TRACK,
47
47
  action: action,
48
48
  actionSubject: _analytics.ACTION_SUBJECT.EDITOR,
49
49
  attributes: {
50
50
  inputMethod: inputSourceToInputMethod(inputSource)
51
51
  }
52
- })(attachInputMeta(inputSource)(command));
52
+ })(command));
53
53
  };
54
54
  };
55
55
  };
@@ -3,7 +3,7 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.undoFromToolbarWithAnalytics = exports.undoFromToolbar = exports.undoFromKeyboard = exports.redoFromToolbarWithAnalytics = exports.redoFromToolbar = exports.redoFromKeyboard = void 0;
6
+ exports.undoFromToolbarWithAnalytics = exports.undoFromToolbar = exports.undoFromKeyboardWithAnalytics = exports.undoFromKeyboard = exports.redoFromToolbarWithAnalytics = exports.redoFromToolbar = exports.redoFromKeyboardWithAnalytics = exports.redoFromKeyboard = void 0;
7
7
  var _analytics = require("@atlaskit/editor-common/analytics");
8
8
  var _history = require("@atlaskit/editor-prosemirror/history");
9
9
  var _attachInputMeta = require("./attach-input-meta");
@@ -12,6 +12,12 @@ var undoFromKeyboard = exports.undoFromKeyboard = (0, _attachInputMeta.attachInp
12
12
  var redoFromKeyboard = exports.redoFromKeyboard = (0, _attachInputMeta.attachInputMeta)(_enums.InputSource.KEYBOARD)(_history.redo);
13
13
  var undoFromToolbar = exports.undoFromToolbar = (0, _attachInputMeta.attachInputMeta)(_enums.InputSource.TOOLBAR)(_history.undo);
14
14
  var redoFromToolbar = exports.redoFromToolbar = (0, _attachInputMeta.attachInputMeta)(_enums.InputSource.TOOLBAR)(_history.redo);
15
+ var undoFromKeyboardWithAnalytics = exports.undoFromKeyboardWithAnalytics = function undoFromKeyboardWithAnalytics(editorAnalyticsAPI) {
16
+ return (0, _attachInputMeta.attachInputMetaWithAnalytics)(editorAnalyticsAPI)(_enums.InputSource.KEYBOARD, _analytics.ACTION.UNDO_PERFORMED)(_history.undo);
17
+ };
18
+ var redoFromKeyboardWithAnalytics = exports.redoFromKeyboardWithAnalytics = function redoFromKeyboardWithAnalytics(editorAnalyticsAPI) {
19
+ return (0, _attachInputMeta.attachInputMetaWithAnalytics)(editorAnalyticsAPI)(_enums.InputSource.KEYBOARD, _analytics.ACTION.REDO_PERFORMED)(_history.redo);
20
+ };
15
21
  var undoFromToolbarWithAnalytics = exports.undoFromToolbarWithAnalytics = function undoFromToolbarWithAnalytics(editorAnalyticsAPI) {
16
22
  return (0, _attachInputMeta.attachInputMetaWithAnalytics)(editorAnalyticsAPI)(_enums.InputSource.TOOLBAR, _analytics.ACTION.UNDO_PERFORMED)(_history.undo);
17
23
  };
@@ -9,20 +9,23 @@ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
9
9
  var _keymap = require("@atlaskit/editor-prosemirror/keymap");
10
10
  var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
11
11
  var _commands = require("./commands");
12
- function keymapPlugin() {
12
+ function keymapPlugin(api) {
13
+ var _api$analytics, _api$analytics3;
13
14
  var list = {};
14
-
15
+ (0, _keymaps.bindKeymapWithCommand)(
15
16
  // Ignored via go/ees005
16
17
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
17
- (0, _keymaps.bindKeymapWithCommand)((0, _keymaps.findKeyMapForBrowser)(_keymaps.redo), _commands.redoFromKeyboard, list);
18
+ (0, _keymaps.findKeyMapForBrowser)(_keymaps.redo), (0, _platformFeatureFlags.fg)('platform_editor_controls_patch_analytics') ? (0, _commands.redoFromKeyboardWithAnalytics)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions) : _commands.redoFromKeyboard, list);
18
19
  if ((0, _platformFeatureFlags.fg)('platform_editor_cmd_y_mac_redo_shortcut')) {
20
+ var _api$analytics2;
21
+ (0, _keymaps.bindKeymapWithCommand)(
19
22
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
20
- (0, _keymaps.bindKeymapWithCommand)((0, _keymaps.findKeyMapForBrowser)(_keymaps.redoAlt), _commands.redoFromKeyboard, list);
23
+ (0, _keymaps.findKeyMapForBrowser)(_keymaps.redoAlt), (0, _platformFeatureFlags.fg)('platform_editor_controls_patch_analytics') ? (0, _commands.redoFromKeyboardWithAnalytics)(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions) : _commands.redoFromKeyboard, list);
21
24
  }
22
-
25
+ (0, _keymaps.bindKeymapWithCommand)(
23
26
  // Ignored via go/ees005
24
27
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
25
- (0, _keymaps.bindKeymapWithCommand)(_keymaps.undo.common, _commands.undoFromKeyboard, list);
28
+ _keymaps.undo.common, (0, _platformFeatureFlags.fg)('platform_editor_controls_patch_analytics') ? (0, _commands.undoFromKeyboardWithAnalytics)(api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions) : _commands.undoFromKeyboard, list);
26
29
  return new _safePlugin.SafePlugin({
27
30
  props: {
28
31
  handleKeyDown: function handleKeyDown(view, event) {
@@ -65,7 +65,7 @@ var undoRedoPlugin = exports.undoRedoPlugin = function undoRedoPlugin(_ref) {
65
65
  var plugins = [{
66
66
  name: 'undoRedoKeyMap',
67
67
  plugin: function plugin() {
68
- return (0, _keymaps.keymapPlugin)();
68
+ return (0, _keymaps.keymapPlugin)(api);
69
69
  }
70
70
  }, {
71
71
  name: 'undoRedoPlugin',
@@ -29,11 +29,11 @@ const inputSourceToInputMethod = inputSource => {
29
29
  return INPUT_METHOD.EXTERNAL;
30
30
  }
31
31
  };
32
- export const attachInputMetaWithAnalytics = editorAnalyticsAPI => (inputSource, action) => command => withAnalytics(editorAnalyticsAPI, {
32
+ export const attachInputMetaWithAnalytics = editorAnalyticsAPI => (inputSource, action) => command => attachInputMeta(inputSource)(withAnalytics(editorAnalyticsAPI, {
33
33
  eventType: EVENT_TYPE.TRACK,
34
34
  action,
35
35
  actionSubject: ACTION_SUBJECT.EDITOR,
36
36
  attributes: {
37
37
  inputMethod: inputSourceToInputMethod(inputSource)
38
38
  }
39
- })(attachInputMeta(inputSource)(command));
39
+ })(command));
@@ -6,5 +6,7 @@ export const undoFromKeyboard = attachInputMeta(InputSource.KEYBOARD)(undo);
6
6
  export const redoFromKeyboard = attachInputMeta(InputSource.KEYBOARD)(redo);
7
7
  export const undoFromToolbar = attachInputMeta(InputSource.TOOLBAR)(undo);
8
8
  export const redoFromToolbar = attachInputMeta(InputSource.TOOLBAR)(redo);
9
+ export const undoFromKeyboardWithAnalytics = editorAnalyticsAPI => attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.KEYBOARD, ACTION.UNDO_PERFORMED)(undo);
10
+ export const redoFromKeyboardWithAnalytics = editorAnalyticsAPI => attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.KEYBOARD, ACTION.REDO_PERFORMED)(redo);
9
11
  export const undoFromToolbarWithAnalytics = editorAnalyticsAPI => attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.TOOLBAR, ACTION.UNDO_PERFORMED)(undo);
10
12
  export const redoFromToolbarWithAnalytics = editorAnalyticsAPI => attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.TOOLBAR, ACTION.REDO_PERFORMED)(redo);
@@ -2,21 +2,24 @@ import { bindKeymapWithCommand, findKeyMapForBrowser, isCapsLockOnAndModifyKeybo
2
2
  import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
3
3
  import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
4
4
  import { fg } from '@atlaskit/platform-feature-flags';
5
- import { redoFromKeyboard, undoFromKeyboard } from './commands';
6
- export function keymapPlugin() {
5
+ import { redoFromKeyboard, redoFromKeyboardWithAnalytics, undoFromKeyboard, undoFromKeyboardWithAnalytics } from './commands';
6
+ export function keymapPlugin(api) {
7
+ var _api$analytics, _api$analytics3;
7
8
  const list = {};
8
-
9
+ bindKeymapWithCommand(
9
10
  // Ignored via go/ees005
10
11
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
11
- bindKeymapWithCommand(findKeyMapForBrowser(redo), redoFromKeyboard, list);
12
+ findKeyMapForBrowser(redo), fg('platform_editor_controls_patch_analytics') ? redoFromKeyboardWithAnalytics(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions) : redoFromKeyboard, list);
12
13
  if (fg('platform_editor_cmd_y_mac_redo_shortcut')) {
14
+ var _api$analytics2;
15
+ bindKeymapWithCommand(
13
16
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
14
- bindKeymapWithCommand(findKeyMapForBrowser(redoAlt), redoFromKeyboard, list);
17
+ findKeyMapForBrowser(redoAlt), fg('platform_editor_controls_patch_analytics') ? redoFromKeyboardWithAnalytics(api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions) : redoFromKeyboard, list);
15
18
  }
16
-
19
+ bindKeymapWithCommand(
17
20
  // Ignored via go/ees005
18
21
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
19
- bindKeymapWithCommand(undo.common, undoFromKeyboard, list);
22
+ undo.common, fg('platform_editor_controls_patch_analytics') ? undoFromKeyboardWithAnalytics(api === null || api === void 0 ? void 0 : (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions) : undoFromKeyboard, list);
20
23
  return new SafePlugin({
21
24
  props: {
22
25
  handleKeyDown(view, event) {
@@ -58,7 +58,7 @@ export const undoRedoPlugin = ({
58
58
  pmPlugins() {
59
59
  const plugins = [{
60
60
  name: 'undoRedoKeyMap',
61
- plugin: () => keymapPlugin()
61
+ plugin: () => keymapPlugin(api)
62
62
  }, {
63
63
  name: 'undoRedoPlugin',
64
64
  plugin: options => createPlugin(options)
@@ -36,14 +36,14 @@ var inputSourceToInputMethod = function inputSourceToInputMethod(inputSource) {
36
36
  export var attachInputMetaWithAnalytics = function attachInputMetaWithAnalytics(editorAnalyticsAPI) {
37
37
  return function (inputSource, action) {
38
38
  return function (command) {
39
- return withAnalytics(editorAnalyticsAPI, {
39
+ return attachInputMeta(inputSource)(withAnalytics(editorAnalyticsAPI, {
40
40
  eventType: EVENT_TYPE.TRACK,
41
41
  action: action,
42
42
  actionSubject: ACTION_SUBJECT.EDITOR,
43
43
  attributes: {
44
44
  inputMethod: inputSourceToInputMethod(inputSource)
45
45
  }
46
- })(attachInputMeta(inputSource)(command));
46
+ })(command));
47
47
  };
48
48
  };
49
49
  };
@@ -6,6 +6,12 @@ export var undoFromKeyboard = attachInputMeta(InputSource.KEYBOARD)(undo);
6
6
  export var redoFromKeyboard = attachInputMeta(InputSource.KEYBOARD)(redo);
7
7
  export var undoFromToolbar = attachInputMeta(InputSource.TOOLBAR)(undo);
8
8
  export var redoFromToolbar = attachInputMeta(InputSource.TOOLBAR)(redo);
9
+ export var undoFromKeyboardWithAnalytics = function undoFromKeyboardWithAnalytics(editorAnalyticsAPI) {
10
+ return attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.KEYBOARD, ACTION.UNDO_PERFORMED)(undo);
11
+ };
12
+ export var redoFromKeyboardWithAnalytics = function redoFromKeyboardWithAnalytics(editorAnalyticsAPI) {
13
+ return attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.KEYBOARD, ACTION.REDO_PERFORMED)(redo);
14
+ };
9
15
  export var undoFromToolbarWithAnalytics = function undoFromToolbarWithAnalytics(editorAnalyticsAPI) {
10
16
  return attachInputMetaWithAnalytics(editorAnalyticsAPI)(InputSource.TOOLBAR, ACTION.UNDO_PERFORMED)(undo);
11
17
  };
@@ -2,21 +2,24 @@ import { bindKeymapWithCommand, findKeyMapForBrowser, isCapsLockOnAndModifyKeybo
2
2
  import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
3
3
  import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
4
4
  import { fg } from '@atlaskit/platform-feature-flags';
5
- import { redoFromKeyboard, undoFromKeyboard } from './commands';
6
- export function keymapPlugin() {
5
+ import { redoFromKeyboard, redoFromKeyboardWithAnalytics, undoFromKeyboard, undoFromKeyboardWithAnalytics } from './commands';
6
+ export function keymapPlugin(api) {
7
+ var _api$analytics, _api$analytics3;
7
8
  var list = {};
8
-
9
+ bindKeymapWithCommand(
9
10
  // Ignored via go/ees005
10
11
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
11
- bindKeymapWithCommand(findKeyMapForBrowser(redo), redoFromKeyboard, list);
12
+ findKeyMapForBrowser(redo), fg('platform_editor_controls_patch_analytics') ? redoFromKeyboardWithAnalytics(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions) : redoFromKeyboard, list);
12
13
  if (fg('platform_editor_cmd_y_mac_redo_shortcut')) {
14
+ var _api$analytics2;
15
+ bindKeymapWithCommand(
13
16
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
14
- bindKeymapWithCommand(findKeyMapForBrowser(redoAlt), redoFromKeyboard, list);
17
+ findKeyMapForBrowser(redoAlt), fg('platform_editor_controls_patch_analytics') ? redoFromKeyboardWithAnalytics(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions) : redoFromKeyboard, list);
15
18
  }
16
-
19
+ bindKeymapWithCommand(
17
20
  // Ignored via go/ees005
18
21
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
19
- bindKeymapWithCommand(undo.common, undoFromKeyboard, list);
22
+ undo.common, fg('platform_editor_controls_patch_analytics') ? undoFromKeyboardWithAnalytics(api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions) : undoFromKeyboard, list);
20
23
  return new SafePlugin({
21
24
  props: {
22
25
  handleKeyDown: function handleKeyDown(view, event) {
@@ -57,7 +57,7 @@ export var undoRedoPlugin = function undoRedoPlugin(_ref) {
57
57
  var plugins = [{
58
58
  name: 'undoRedoKeyMap',
59
59
  plugin: function plugin() {
60
- return keymapPlugin();
60
+ return keymapPlugin(api);
61
61
  }
62
62
  }, {
63
63
  name: 'undoRedoPlugin',
@@ -3,5 +3,7 @@ export declare const undoFromKeyboard: import("@atlaskit/editor-common/types").C
3
3
  export declare const redoFromKeyboard: import("@atlaskit/editor-common/types").Command;
4
4
  export declare const undoFromToolbar: import("@atlaskit/editor-common/types").Command;
5
5
  export declare const redoFromToolbar: import("@atlaskit/editor-common/types").Command;
6
+ export declare const undoFromKeyboardWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
7
+ export declare const redoFromKeyboardWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
6
8
  export declare const undoFromToolbarWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
7
9
  export declare const redoFromToolbarWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
@@ -1,2 +1,4 @@
1
1
  import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
- export declare function keymapPlugin(): SafePlugin;
2
+ import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
3
+ import { UndoRedoPlugin } from '../undoRedoPluginType';
4
+ export declare function keymapPlugin(api?: ExtractInjectionAPI<UndoRedoPlugin>): SafePlugin;
@@ -3,5 +3,7 @@ export declare const undoFromKeyboard: import("@atlaskit/editor-common/types").C
3
3
  export declare const redoFromKeyboard: import("@atlaskit/editor-common/types").Command;
4
4
  export declare const undoFromToolbar: import("@atlaskit/editor-common/types").Command;
5
5
  export declare const redoFromToolbar: import("@atlaskit/editor-common/types").Command;
6
+ export declare const undoFromKeyboardWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
7
+ export declare const redoFromKeyboardWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
6
8
  export declare const undoFromToolbarWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
7
9
  export declare const redoFromToolbarWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => import("@atlaskit/editor-common/types").Command;
@@ -1,2 +1,4 @@
1
1
  import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
- export declare function keymapPlugin(): SafePlugin;
2
+ import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
3
+ import { UndoRedoPlugin } from '../undoRedoPluginType';
4
+ export declare function keymapPlugin(api?: ExtractInjectionAPI<UndoRedoPlugin>): SafePlugin;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-undo-redo",
3
- "version": "2.0.10",
3
+ "version": "2.0.12",
4
4
  "description": "Undo redo plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -33,14 +33,14 @@
33
33
  ".": "./src/index.ts"
34
34
  },
35
35
  "dependencies": {
36
- "@atlaskit/editor-common": "^103.21.0",
36
+ "@atlaskit/editor-common": "^104.0.0",
37
37
  "@atlaskit/editor-plugin-history": "^2.0.0",
38
38
  "@atlaskit/editor-plugin-primary-toolbar": "^3.2.0",
39
- "@atlaskit/editor-plugin-type-ahead": "^2.5.0",
39
+ "@atlaskit/editor-plugin-type-ahead": "^2.6.0",
40
40
  "@atlaskit/editor-prosemirror": "7.0.0",
41
41
  "@atlaskit/icon": "^25.6.0",
42
42
  "@atlaskit/platform-feature-flags": "^1.1.0",
43
- "@atlaskit/tmp-editor-statsig": "^4.15.0",
43
+ "@atlaskit/tmp-editor-statsig": "^4.16.0",
44
44
  "@babel/runtime": "^7.0.0",
45
45
  "@emotion/react": "^11.7.1"
46
46
  },