@testing-library/user-event 13.4.1 → 14.0.0-alpha.10

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.
Files changed (122) hide show
  1. package/README.md +4 -0
  2. package/dist/clear.d.ts +2 -2
  3. package/dist/clear.js +14 -29
  4. package/dist/click.d.ts +4 -3
  5. package/dist/click.js +29 -143
  6. package/dist/document/index.d.ts +10 -0
  7. package/dist/document/index.js +100 -0
  8. package/dist/document/interceptor.d.ts +15 -0
  9. package/dist/document/interceptor.js +37 -0
  10. package/dist/document/selection.d.ts +27 -0
  11. package/dist/document/selection.js +90 -0
  12. package/dist/document/value.d.ts +18 -0
  13. package/dist/document/value.js +77 -0
  14. package/dist/hover.d.ts +3 -3
  15. package/dist/hover.js +15 -57
  16. package/dist/index.d.ts +4 -21
  17. package/dist/index.js +4 -29
  18. package/dist/keyboard/getNextKeyDef.d.ts +3 -0
  19. package/dist/keyboard/getNextKeyDef.js +59 -87
  20. package/dist/keyboard/index.d.ts +1 -0
  21. package/dist/keyboard/index.js +4 -0
  22. package/dist/keyboard/keyMap.js +4 -0
  23. package/dist/keyboard/keyboardImplementation.js +28 -8
  24. package/dist/keyboard/plugins/arrow.js +7 -12
  25. package/dist/keyboard/plugins/character.js +29 -57
  26. package/dist/keyboard/plugins/combination.d.ts +5 -0
  27. package/dist/keyboard/plugins/combination.js +17 -0
  28. package/dist/keyboard/plugins/control.js +5 -16
  29. package/dist/keyboard/plugins/functional.js +33 -15
  30. package/dist/keyboard/plugins/index.js +5 -5
  31. package/dist/keyboard/shared/index.d.ts +0 -2
  32. package/dist/keyboard/shared/index.js +0 -26
  33. package/dist/keyboard/types.d.ts +8 -0
  34. package/dist/paste.d.ts +3 -2
  35. package/dist/paste.js +8 -15
  36. package/dist/pointer/index.d.ts +18 -0
  37. package/dist/pointer/index.js +90 -0
  38. package/dist/pointer/keyMap.d.ts +2 -0
  39. package/dist/pointer/keyMap.js +29 -0
  40. package/dist/pointer/parseKeyDef.d.ts +6 -0
  41. package/dist/pointer/parseKeyDef.js +36 -0
  42. package/dist/pointer/pointerAction.d.ts +6 -0
  43. package/dist/pointer/pointerAction.js +52 -0
  44. package/dist/pointer/pointerMove.d.ts +5 -0
  45. package/dist/pointer/pointerMove.js +136 -0
  46. package/dist/pointer/pointerPress.d.ts +7 -0
  47. package/dist/pointer/pointerPress.js +330 -0
  48. package/dist/pointer/resolveSelectionTarget.d.ts +5 -0
  49. package/dist/pointer/resolveSelectionTarget.js +75 -0
  50. package/dist/pointer/types.d.ts +72 -0
  51. package/dist/pointer/types.js +1 -0
  52. package/dist/selectOptions.d.ts +4 -0
  53. package/dist/{select-options.js → selectOptions.js} +18 -20
  54. package/dist/setup.d.ts +92 -0
  55. package/dist/setup.js +203 -0
  56. package/dist/tab.d.ts +3 -4
  57. package/dist/tab.js +3 -136
  58. package/dist/type.d.ts +14 -0
  59. package/dist/type.js +74 -0
  60. package/dist/upload.d.ts +4 -3
  61. package/dist/upload.js +3 -9
  62. package/dist/utils/edit/calculateNewValue.d.ts +12 -5
  63. package/dist/utils/edit/calculateNewValue.js +19 -21
  64. package/dist/utils/edit/editInputElement.d.ts +16 -0
  65. package/dist/utils/edit/editInputElement.js +53 -0
  66. package/dist/utils/edit/getValue.d.ts +1 -1
  67. package/dist/utils/edit/getValue.js +3 -1
  68. package/dist/utils/edit/isContentEditable.d.ts +4 -0
  69. package/dist/utils/edit/isContentEditable.js +14 -0
  70. package/dist/utils/edit/isEditable.d.ts +1 -0
  71. package/dist/utils/edit/prepareInput.d.ts +7 -0
  72. package/dist/utils/edit/prepareInput.js +77 -0
  73. package/dist/{blur.d.ts → utils/focus/blur.d.ts} +0 -0
  74. package/dist/utils/focus/blur.js +19 -0
  75. package/dist/{focus.d.ts → utils/focus/focus.d.ts} +0 -0
  76. package/dist/utils/focus/focus.js +22 -0
  77. package/dist/utils/focus/getTabDestination.d.ts +1 -0
  78. package/dist/utils/focus/getTabDestination.js +71 -0
  79. package/dist/utils/focus/isFocusable.js +1 -3
  80. package/dist/utils/focus/selectAll.d.ts +5 -0
  81. package/dist/utils/focus/selectAll.js +51 -0
  82. package/dist/utils/focus/selection.d.ts +42 -0
  83. package/dist/utils/focus/selection.js +190 -0
  84. package/dist/utils/index.d.ts +13 -6
  85. package/dist/utils/index.js +145 -54
  86. package/dist/utils/keyDef/readNextDescriptor.d.ts +19 -0
  87. package/dist/utils/keyDef/readNextDescriptor.js +102 -0
  88. package/dist/utils/misc/findClosest.d.ts +1 -0
  89. package/dist/utils/misc/findClosest.js +20 -0
  90. package/dist/utils/misc/hasFormSubmit.d.ts +1 -0
  91. package/dist/utils/misc/hasFormSubmit.js +10 -0
  92. package/dist/utils/misc/isDescendantOrSelf.d.ts +1 -0
  93. package/dist/utils/misc/isDescendantOrSelf.js +20 -0
  94. package/dist/utils/pointer/firePointerEvents.d.ts +25 -0
  95. package/dist/utils/pointer/firePointerEvents.js +112 -0
  96. package/dist/utils/pointer/mouseButtons.d.ts +12 -0
  97. package/dist/utils/pointer/mouseButtons.js +45 -0
  98. package/package.json +4 -3
  99. package/dist/blur.js +0 -15
  100. package/dist/dom-helpers.d.ts +0 -3
  101. package/dist/focus.js +0 -15
  102. package/dist/keyboard/shared/carryValue.d.ts +0 -2
  103. package/dist/keyboard/shared/carryValue.js +0 -13
  104. package/dist/keyboard/shared/fireInputEvent.d.ts +0 -17
  105. package/dist/keyboard/shared/fireInputEvent.js +0 -110
  106. package/dist/select-options.d.ts +0 -4
  107. package/dist/type/index.d.ts +0 -7
  108. package/dist/type/index.js +0 -33
  109. package/dist/type/typeImplementation.d.ts +0 -10
  110. package/dist/type/typeImplementation.js +0 -64
  111. package/dist/utils/click/getMouseEventOptions.d.ts +0 -31
  112. package/dist/utils/click/getMouseEventOptions.js +0 -61
  113. package/dist/utils/edit/cursorPosition.d.ts +0 -2
  114. package/dist/utils/edit/cursorPosition.js +0 -35
  115. package/dist/utils/edit/hasUnreliableEmptyValue.d.ts +0 -10
  116. package/dist/utils/edit/hasUnreliableEmptyValue.js +0 -21
  117. package/dist/utils/edit/selectionRange.d.ts +0 -16
  118. package/dist/utils/edit/selectionRange.js +0 -104
  119. package/dist/utils/misc/isDocument.d.ts +0 -1
  120. package/dist/utils/misc/isDocument.js +0 -10
  121. package/dist/utils/misc/isLabelWithInternallyDisabledControl.d.ts +0 -1
  122. package/dist/utils/misc/isLabelWithInternallyDisabledControl.js +0 -22
package/dist/hover.d.ts CHANGED
@@ -1,4 +1,4 @@
1
+ import type { UserEvent } from './setup';
1
2
  import { PointerOptions } from './utils';
2
- declare function hover(element: Element, init?: MouseEventInit, { skipPointerEventsCheck }?: PointerOptions): void;
3
- declare function unhover(element: Element, init?: MouseEventInit, { skipPointerEventsCheck }?: PointerOptions): void;
4
- export { hover, unhover };
3
+ export declare function hover(this: UserEvent, element: Element, init?: MouseEventInit, { skipPointerEventsCheck }?: PointerOptions): void;
4
+ export declare function unhover(this: UserEvent, element: Element, init?: MouseEventInit, { skipPointerEventsCheck }?: PointerOptions): void;
package/dist/hover.js CHANGED
@@ -6,22 +6,10 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.hover = hover;
7
7
  exports.unhover = unhover;
8
8
 
9
- var _dom = require("@testing-library/dom");
9
+ var _pointer = require("./pointer");
10
10
 
11
11
  var _utils = require("./utils");
12
12
 
13
- // includes `element`
14
- function getParentElements(element) {
15
- const parentElements = [element];
16
- let currentElement = element;
17
-
18
- while ((currentElement = currentElement.parentElement) != null) {
19
- parentElements.push(currentElement);
20
- }
21
-
22
- return parentElements;
23
- }
24
-
25
13
  function hover(element, init, {
26
14
  skipPointerEventsCheck = false
27
15
  } = {}) {
@@ -29,28 +17,13 @@ function hover(element, init, {
29
17
  throw new Error('unable to hover element as it has or inherits pointer-events set to "none".');
30
18
  }
31
19
 
32
- if ((0, _utils.isLabelWithInternallyDisabledControl)(element)) return;
33
- const parentElements = getParentElements(element).reverse();
34
-
35
- _dom.fireEvent.pointerOver(element, init);
36
-
37
- for (const el of parentElements) {
38
- _dom.fireEvent.pointerEnter(el, init);
39
- }
40
-
41
- if (!(0, _utils.isDisabled)(element)) {
42
- _dom.fireEvent.mouseOver(element, (0, _utils.getMouseEventOptions)('mouseover', init));
43
-
44
- for (const el of parentElements) {
45
- _dom.fireEvent.mouseEnter(el, (0, _utils.getMouseEventOptions)('mouseenter', init));
46
- }
47
- }
48
-
49
- _dom.fireEvent.pointerMove(element, init);
50
-
51
- if (!(0, _utils.isDisabled)(element)) {
52
- _dom.fireEvent.mouseMove(element, (0, _utils.getMouseEventOptions)('mousemove', init));
53
- }
20
+ const pointerState = (0, _pointer.createPointerState)();
21
+ pointerState.position.mouse.target = element.ownerDocument.body;
22
+ this.pointer({
23
+ target: element
24
+ }, {
25
+ pointerState
26
+ });
54
27
  }
55
28
 
56
29
  function unhover(element, init, {
@@ -60,26 +33,11 @@ function unhover(element, init, {
60
33
  throw new Error('unable to unhover element as it has or inherits pointer-events set to "none".');
61
34
  }
62
35
 
63
- if ((0, _utils.isLabelWithInternallyDisabledControl)(element)) return;
64
- const parentElements = getParentElements(element);
65
-
66
- _dom.fireEvent.pointerMove(element, init);
67
-
68
- if (!(0, _utils.isDisabled)(element)) {
69
- _dom.fireEvent.mouseMove(element, (0, _utils.getMouseEventOptions)('mousemove', init));
70
- }
71
-
72
- _dom.fireEvent.pointerOut(element, init);
73
-
74
- for (const el of parentElements) {
75
- _dom.fireEvent.pointerLeave(el, init);
76
- }
77
-
78
- if (!(0, _utils.isDisabled)(element)) {
79
- _dom.fireEvent.mouseOut(element, (0, _utils.getMouseEventOptions)('mouseout', init));
80
-
81
- for (const el of parentElements) {
82
- _dom.fireEvent.mouseLeave(el, (0, _utils.getMouseEventOptions)('mouseleave', init));
83
- }
84
- }
36
+ const pointerState = (0, _pointer.createPointerState)();
37
+ pointerState.position.mouse.target = element;
38
+ this.pointer({
39
+ target: element.ownerDocument.body
40
+ }, {
41
+ pointerState
42
+ });
85
43
  }
package/dist/index.d.ts CHANGED
@@ -1,24 +1,7 @@
1
- import { click, dblClick } from './click';
2
- import { type } from './type';
3
- import { clear } from './clear';
4
- import { tab } from './tab';
5
- import { hover, unhover } from './hover';
6
- import { upload } from './upload';
7
- import { paste } from './paste';
8
- import { keyboard, specialCharMap } from './keyboard';
9
- declare const userEvent: {
10
- click: typeof click;
11
- dblClick: typeof dblClick;
12
- type: typeof type;
13
- clear: typeof clear;
14
- tab: typeof tab;
15
- hover: typeof hover;
16
- unhover: typeof unhover;
17
- upload: typeof upload;
18
- selectOptions: (args_0: Element, args_1: string | string[] | HTMLElement | HTMLElement[], args_2?: MouseEventInit | undefined, args_3?: import("./utils").PointerOptions | undefined) => void;
19
- deselectOptions: (args_0: Element, args_1: string | string[] | HTMLElement | HTMLElement[], args_2?: MouseEventInit | undefined, args_3?: import("./utils").PointerOptions | undefined) => void;
20
- paste: typeof paste;
21
- keyboard: typeof keyboard;
1
+ import { specialCharMap } from './keyboard';
2
+ import { UserEventApis, setup } from './setup';
3
+ declare const userEvent: UserEventApis & {
4
+ setup: typeof setup;
22
5
  };
23
6
  export default userEvent;
24
7
  export { specialCharMap as specialChars };
package/dist/index.js CHANGED
@@ -11,37 +11,12 @@ Object.defineProperty(exports, "specialChars", {
11
11
  }
12
12
  });
13
13
 
14
- var _click = require("./click");
15
-
16
- var _type = require("./type");
17
-
18
- var _clear = require("./clear");
19
-
20
- var _tab = require("./tab");
21
-
22
- var _hover = require("./hover");
23
-
24
- var _upload = require("./upload");
25
-
26
- var _selectOptions = require("./select-options");
27
-
28
- var _paste = require("./paste");
29
-
30
14
  var _keyboard = require("./keyboard");
31
15
 
32
- const userEvent = {
33
- click: _click.click,
34
- dblClick: _click.dblClick,
35
- type: _type.type,
36
- clear: _clear.clear,
37
- tab: _tab.tab,
38
- hover: _hover.hover,
39
- unhover: _hover.unhover,
40
- upload: _upload.upload,
41
- selectOptions: _selectOptions.selectOptions,
42
- deselectOptions: _selectOptions.deselectOptions,
43
- paste: _paste.paste,
44
- keyboard: _keyboard.keyboard
16
+ var _setup = require("./setup");
17
+
18
+ const userEvent = { ...Object.fromEntries(Object.entries(_setup.userEventApis).map(([k, f]) => [k, (...a) => f.apply(userEvent, a)])),
19
+ setup: _setup.setup
45
20
  };
46
21
  var _default = userEvent;
47
22
  exports.default = _default;
@@ -6,6 +6,8 @@ import { keyboardKey, keyboardOptions } from './types';
6
6
  * Everything else will be interpreted as a typed character - e.g. `a`.
7
7
  * Brackets `{` and `[` can be escaped by doubling - e.g. `foo[[bar` translates to `foo[bar`.
8
8
  * Keeping the key pressed can be written as `{key>}`.
9
+ * When keeping the key pressed you can choose how long (how many keydown and keypress) the key is pressed `{key>3}`.
10
+ * You can then release the key per `{key>3/}` or keep it pressed and continue with the next key.
9
11
  * Modifiers like `{shift}` imply being kept pressed. This can be turned of per `{shift/}`.
10
12
  */
11
13
  export declare function getNextKeyDef(text: string, options: keyboardOptions): {
@@ -13,4 +15,5 @@ export declare function getNextKeyDef(text: string, options: keyboardOptions): {
13
15
  consumedLength: number;
14
16
  releasePrevious: boolean;
15
17
  releaseSelf: boolean;
18
+ repeat: number;
16
19
  };
@@ -5,6 +5,18 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.getNextKeyDef = getNextKeyDef;
7
7
 
8
+ var _utils = require("../utils");
9
+
10
+ var legacyModifiers;
11
+
12
+ (function (legacyModifiers) {
13
+ legacyModifiers["alt"] = "alt";
14
+ legacyModifiers["ctrl"] = "ctrl";
15
+ legacyModifiers["meta"] = "meta";
16
+ legacyModifiers["shift"] = "shift";
17
+ })(legacyModifiers || (legacyModifiers = {}));
18
+
19
+ var legacyKeyMap;
8
20
  /**
9
21
  * Get the next key from keyMap
10
22
  *
@@ -12,102 +24,62 @@ exports.getNextKeyDef = getNextKeyDef;
12
24
  * Everything else will be interpreted as a typed character - e.g. `a`.
13
25
  * Brackets `{` and `[` can be escaped by doubling - e.g. `foo[[bar` translates to `foo[bar`.
14
26
  * Keeping the key pressed can be written as `{key>}`.
27
+ * When keeping the key pressed you can choose how long (how many keydown and keypress) the key is pressed `{key>3}`.
28
+ * You can then release the key per `{key>3/}` or keep it pressed and continue with the next key.
15
29
  * Modifiers like `{shift}` imply being kept pressed. This can be turned of per `{shift/}`.
16
30
  */
17
- function getNextKeyDef(text, options) {
18
- var _text$slice$match;
19
-
20
- const startBracket = ['{', '['].includes(text[0]) ? text[0] : '';
21
- const startModifier = startBracket && text[1] === '/' ? '/' : '';
22
- const descriptorStart = startBracket.length + startModifier.length;
23
- const descriptor = startBracket ? text[descriptorStart] === startBracket ? startBracket : (_text$slice$match = text.slice(descriptorStart).match(/^\w+/)) == null ? void 0 : _text$slice$match[0] : text[descriptorStart];
24
-
25
- if (!descriptor) {
26
- throw new Error(getErrorMessage('key descriptor', text[descriptorStart], text));
27
- }
28
31
 
29
- const descriptorEnd = descriptorStart + descriptor.length;
30
- const endModifier = startBracket && descriptor !== startBracket && ['/', '>'].includes(text[descriptorEnd]) ? text[descriptorEnd] : '';
31
- const endBracket = !startBracket || descriptor === startBracket ? '' : startBracket === '{' ? '}' : ']';
32
+ (function (legacyKeyMap) {
33
+ legacyKeyMap["ctrl"] = "Control";
34
+ legacyKeyMap["del"] = "Delete";
35
+ legacyKeyMap["esc"] = "Escape";
36
+ legacyKeyMap["space"] = " ";
37
+ })(legacyKeyMap || (legacyKeyMap = {}));
32
38
 
33
- if (endBracket && text[descriptorEnd + endModifier.length] !== endBracket) {
34
- throw new Error(getErrorMessage('closing bracket', text[descriptorEnd + endModifier.length], text));
35
- }
36
-
37
- const modifiers = {
38
- consumedLength: [startBracket, startModifier, descriptor, endModifier, endBracket].map(c => c.length).reduce((a, b) => a + b),
39
- releasePrevious: startModifier === '/',
40
- releaseSelf: hasReleaseSelf(startBracket, descriptor, endModifier)
39
+ function getNextKeyDef(text, options) {
40
+ var _options$keyboardMap$;
41
+
42
+ const {
43
+ type,
44
+ descriptor,
45
+ consumedLength,
46
+ releasePrevious,
47
+ releaseSelf = !(type === '{' && getEnumValue(legacyModifiers, descriptor.toLowerCase())),
48
+ repeat
49
+ } = (0, _utils.readNextDescriptor)(text);
50
+ const keyDef = (_options$keyboardMap$ = options.keyboardMap.find(def => {
51
+ if (type === '[') {
52
+ var _def$code;
53
+
54
+ return ((_def$code = def.code) == null ? void 0 : _def$code.toLowerCase()) === descriptor.toLowerCase();
55
+ } else if (type === '{') {
56
+ var _def$key;
57
+
58
+ const key = mapLegacyKey(descriptor);
59
+ return ((_def$key = def.key) == null ? void 0 : _def$key.toLowerCase()) === key.toLowerCase();
60
+ }
61
+
62
+ return def.key === descriptor;
63
+ })) != null ? _options$keyboardMap$ : {
64
+ key: 'Unknown',
65
+ code: 'Unknown',
66
+ [type === '[' ? 'code' : 'key']: descriptor
67
+ };
68
+ return {
69
+ keyDef,
70
+ consumedLength,
71
+ releasePrevious,
72
+ releaseSelf,
73
+ repeat
41
74
  };
42
-
43
- if (isPrintableCharacter(startBracket, descriptor)) {
44
- var _options$keyboardMap$;
45
-
46
- return { ...modifiers,
47
- keyDef: (_options$keyboardMap$ = options.keyboardMap.find(k => k.key === descriptor)) != null ? _options$keyboardMap$ : {
48
- key: descriptor,
49
- code: 'Unknown'
50
- }
51
- };
52
- } else if (startBracket === '{') {
53
- var _options$keyboardMap$2;
54
-
55
- const key = mapLegacyKey(descriptor);
56
- return { ...modifiers,
57
- keyDef: (_options$keyboardMap$2 = options.keyboardMap.find(k => {
58
- var _k$key;
59
-
60
- return ((_k$key = k.key) == null ? void 0 : _k$key.toLowerCase()) === key.toLowerCase();
61
- })) != null ? _options$keyboardMap$2 : {
62
- key: descriptor,
63
- code: 'Unknown'
64
- }
65
- };
66
- } else {
67
- var _options$keyboardMap$3;
68
-
69
- return { ...modifiers,
70
- keyDef: (_options$keyboardMap$3 = options.keyboardMap.find(k => {
71
- var _k$code;
72
-
73
- return ((_k$code = k.code) == null ? void 0 : _k$code.toLowerCase()) === descriptor.toLowerCase();
74
- })) != null ? _options$keyboardMap$3 : {
75
- key: 'Unknown',
76
- code: descriptor
77
- }
78
- };
79
- }
80
75
  }
81
76
 
82
- function hasReleaseSelf(startBracket, descriptor, endModifier) {
83
- if (endModifier === '/' || !startBracket) {
84
- return true;
85
- }
86
-
87
- if (startBracket === '{' && ['alt', 'ctrl', 'meta', 'shift'].includes(descriptor.toLowerCase())) {
88
- return false;
89
- }
90
-
91
- return endModifier !== '>';
77
+ function getEnumValue(f, key) {
78
+ return f[key];
92
79
  }
93
80
 
94
81
  function mapLegacyKey(descriptor) {
95
- var _ctrl$del$esc$space$d;
96
-
97
- return (_ctrl$del$esc$space$d = {
98
- ctrl: 'Control',
99
- del: 'Delete',
100
- esc: 'Escape',
101
- space: ' '
102
- }[descriptor]) != null ? _ctrl$del$esc$space$d : descriptor;
103
- }
104
-
105
- function isPrintableCharacter(startBracket, descriptor) {
106
- return !startBracket || startBracket === descriptor || startBracket === '{' && descriptor.length === 1;
107
- }
82
+ var _getEnumValue;
108
83
 
109
- function getErrorMessage(expected, found, text) {
110
- return `Expected ${expected} but found "${found != null ? found : ''}" in "${text}"
111
- See https://github.com/testing-library/user-event/blob/main/README.md#keyboardtext-options
112
- for more information about how userEvent parses your input.`;
84
+ return (_getEnumValue = getEnumValue(legacyKeyMap, descriptor)) != null ? _getEnumValue : descriptor;
113
85
  }
@@ -16,3 +16,4 @@ export declare function keyboardImplementationWrapper(text: string, config?: Par
16
16
  state: keyboardState;
17
17
  releaseAllKeys: () => void;
18
18
  };
19
+ export declare function createKeyboardState(): keyboardState;
@@ -3,6 +3,7 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
+ exports.createKeyboardState = createKeyboardState;
6
7
  exports.keyboard = keyboard;
7
8
  exports.keyboardImplementationWrapper = keyboardImplementationWrapper;
8
9
  Object.defineProperty(exports, "specialCharMap", {
@@ -14,6 +15,8 @@ Object.defineProperty(exports, "specialCharMap", {
14
15
 
15
16
  var _dom = require("@testing-library/dom");
16
17
 
18
+ var _document = require("../document");
19
+
17
20
  var _keyboardImplementation = require("./keyboardImplementation");
18
21
 
19
22
  var _keyMap = require("./keyMap");
@@ -51,6 +54,7 @@ function keyboardImplementationWrapper(text, config = {}) {
51
54
  autoModify,
52
55
  keyboardMap
53
56
  };
57
+ (0, _document.prepareDocument)(document);
54
58
  return {
55
59
  promise: (0, _keyboardImplementation.keyboardImplementation)(text, options, state),
56
60
  state,
@@ -79,6 +79,10 @@ const defaultKeyMap = [// alphanumeric keys
79
79
  key: 'OS',
80
80
  location: _types.DOM_KEY_LOCATION.RIGHT,
81
81
  keyCode: 91
82
+ }, {
83
+ code: 'Tab',
84
+ key: 'Tab',
85
+ keyCode: 9
82
86
  }, {
83
87
  code: 'CapsLock',
84
88
  key: 'CapsLock',
@@ -21,6 +21,8 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
21
21
  function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
22
22
 
23
23
  async function keyboardImplementation(text, options, state) {
24
+ var _state$repeatKey;
25
+
24
26
  const {
25
27
  document
26
28
  } = options;
@@ -31,14 +33,16 @@ async function keyboardImplementation(text, options, state) {
31
33
  keyDef,
32
34
  consumedLength,
33
35
  releasePrevious,
34
- releaseSelf
35
- } = (0, _getNextKeyDef.getNextKeyDef)(text, options);
36
+ releaseSelf,
37
+ repeat
38
+ } = (_state$repeatKey = state.repeatKey) != null ? _state$repeatKey : (0, _getNextKeyDef.getNextKeyDef)(text, options);
36
39
  const replace = applyPlugins(plugins.replaceBehavior, keyDef, getCurrentElement(), options, state);
37
40
 
38
41
  if (!replace) {
39
- const pressed = state.pressed.find(p => p.keyDef === keyDef);
42
+ const pressed = state.pressed.find(p => p.keyDef === keyDef); // Release the key automatically if it was pressed before.
43
+ // Do not release the key on iterations on `state.repeatKey`.
40
44
 
41
- if (pressed) {
45
+ if (pressed && !state.repeatKey) {
42
46
  keyup(keyDef, getCurrentElement, options, state, pressed.unpreventedDefault);
43
47
  }
44
48
 
@@ -47,15 +51,29 @@ async function keyboardImplementation(text, options, state) {
47
51
 
48
52
  if (unpreventedDefault && hasKeyPress(keyDef, state)) {
49
53
  keypress(keyDef, getCurrentElement, options, state);
50
- }
54
+ } // Release the key only on the last iteration on `state.repeatKey`.
55
+
51
56
 
52
- if (releaseSelf) {
57
+ if (releaseSelf && repeat <= 1) {
53
58
  keyup(keyDef, getCurrentElement, options, state, unpreventedDefault);
54
59
  }
55
60
  }
56
61
  }
57
62
 
58
- if (text.length > consumedLength) {
63
+ if (repeat > 1) {
64
+ state.repeatKey = {
65
+ // don't consume again on the next iteration
66
+ consumedLength: 0,
67
+ keyDef,
68
+ releasePrevious,
69
+ releaseSelf,
70
+ repeat: repeat - 1
71
+ };
72
+ } else {
73
+ delete state.repeatKey;
74
+ }
75
+
76
+ if (text.length > consumedLength || repeat > 1) {
59
77
  if (options.delay > 0) {
60
78
  await (0, _utils.wait)(options.delay);
61
79
  }
@@ -111,7 +129,9 @@ function keydown(keyDef, getCurrentElement, options, state) {
111
129
  function keypress(keyDef, getCurrentElement, options, state) {
112
130
  const element = getCurrentElement();
113
131
 
114
- const unpreventedDefault = _dom.fireEvent.keyPress(element, (0, _getEventProps.getKeyEventProps)(keyDef, state));
132
+ const unpreventedDefault = _dom.fireEvent.keyPress(element, { ...(0, _getEventProps.getKeyEventProps)(keyDef, state),
133
+ charCode: keyDef.key === 'Enter' ? 13 : String(keyDef.key).charCodeAt(0)
134
+ });
115
135
 
116
136
  if (unpreventedDefault) {
117
137
  applyPlugins(plugins.keypressBehavior, keyDef, getCurrentElement(), options, state);
@@ -7,6 +7,8 @@ exports.keydownBehavior = void 0;
7
7
 
8
8
  var _utils = require("../../utils");
9
9
 
10
+ var _document = require("../../document");
11
+
10
12
  /**
11
13
  * This file should contain behavior for arrow keys as described here:
12
14
  * https://w3c.github.io/uievents-code/#key-arrowpad-section
@@ -15,19 +17,12 @@ const keydownBehavior = [{
15
17
  // TODO: implement for contentEditable
16
18
  matches: (keyDef, element) => (keyDef.key === 'ArrowLeft' || keyDef.key === 'ArrowRight') && (0, _utils.isElementType)(element, ['input', 'textarea']),
17
19
  handle: (keyDef, element) => {
18
- var _ref;
20
+ const selection = (0, _document.getUISelection)(element); // TODO: implement shift/ctrl
19
21
 
20
- const {
21
- selectionStart,
22
- selectionEnd
23
- } = (0, _utils.getSelectionRange)(element);
24
- const direction = keyDef.key === 'ArrowLeft' ? -1 : 1;
25
- const newPos = (_ref = selectionStart === selectionEnd ? (selectionStart != null ? selectionStart :
26
- /* istanbul ignore next */
27
- 0) + direction : direction < 0 ? selectionStart : selectionEnd) != null ? _ref :
28
- /* istanbul ignore next */
29
- 0;
30
- (0, _utils.setSelectionRange)(element, newPos, newPos);
22
+ (0, _utils.setSelection)({
23
+ focusNode: element,
24
+ focusOffset: selection.startOffset === selection.endOffset ? selection.focusOffset + (keyDef.key === 'ArrowLeft' ? -1 : 1) : keyDef.key === 'ArrowLeft' ? selection.startOffset : selection.endOffset
25
+ });
31
26
  }
32
27
  }];
33
28
  exports.keydownBehavior = keydownBehavior;
@@ -36,15 +36,18 @@ const keypressBehavior = [{
36
36
 
37
37
  const {
38
38
  newValue,
39
- newSelectionStart
40
- } = (0, _utils.calculateNewValue)(newEntry, element);
39
+ newOffset
40
+ } = (0, _utils.calculateNewValue)(newEntry, element, (0, _utils.getInputRange)(element));
41
41
  const prevValue = (0, _utils.getValue)(element); // this check was provided by fireInputEventIfNeeded
42
42
  // TODO: verify if it is even needed by this handler
43
43
 
44
44
  if (prevValue !== newValue) {
45
- (0, _shared.fireInputEvent)(element, {
45
+ (0, _utils.editInputElement)(element, {
46
46
  newValue,
47
- newSelectionStart,
47
+ newSelection: {
48
+ node: element,
49
+ offset: newOffset
50
+ },
48
51
  eventOverrides: {
49
52
  data: keyDef.key,
50
53
  inputType: 'insertText'
@@ -77,15 +80,18 @@ const keypressBehavior = [{
77
80
 
78
81
  const {
79
82
  newValue,
80
- newSelectionStart
81
- } = (0, _utils.calculateNewValue)(newEntry, element);
83
+ newOffset
84
+ } = (0, _utils.calculateNewValue)(newEntry, element, (0, _utils.getInputRange)(element));
82
85
  const prevValue = (0, _utils.getValue)(element); // this check was provided by fireInputEventIfNeeded
83
86
  // TODO: verify if it is even needed by this handler
84
87
 
85
88
  if (prevValue !== newValue) {
86
- (0, _shared.fireInputEvent)(element, {
89
+ (0, _utils.editInputElement)(element, {
87
90
  newValue,
88
- newSelectionStart,
91
+ newSelection: {
92
+ node: element,
93
+ offset: newOffset
94
+ },
89
95
  eventOverrides: {
90
96
  data: keyDef.key,
91
97
  inputType: 'insertText'
@@ -112,20 +118,18 @@ const keypressBehavior = [{
112
118
  readOnly: false
113
119
  });
114
120
  },
115
- handle: (keyDef, element, options, state) => {
116
- var _ref, _state$carryValue3, _newValue$match, _newValue$match2;
121
+ handle: (keyDef, element) => {
122
+ var _newValue$match, _newValue$match2;
117
123
 
118
124
  if (!/[\d.\-e]/.test(keyDef.key)) {
119
125
  return;
120
126
  }
121
127
 
122
- const oldValue = (_ref = (_state$carryValue3 = state.carryValue) != null ? _state$carryValue3 : (0, _utils.getValue)(element)) != null ? _ref :
123
- /* istanbul ignore next */
124
- '';
125
128
  const {
126
- newValue,
127
- newSelectionStart
128
- } = (0, _utils.calculateNewValue)(keyDef.key, element, oldValue); // the browser allows some invalid input but not others
129
+ getNewValue,
130
+ commit
131
+ } = (0, _utils.prepareInput)(keyDef.key, element);
132
+ const newValue = getNewValue(); // the browser allows some invalid input but not others
129
133
  // it allows up to two '-' at any place before any 'e' or one directly following 'e'
130
134
  // it allows one '.' at any place before e
131
135
 
@@ -135,61 +139,29 @@ const keypressBehavior = [{
135
139
  return;
136
140
  }
137
141
 
138
- (0, _shared.fireInputEvent)(element, {
139
- newValue,
140
- newSelectionStart,
141
- eventOverrides: {
142
- data: keyDef.key,
143
- inputType: 'insertText'
144
- }
145
- });
146
- const appliedValue = (0, _utils.getValue)(element);
147
-
148
- if (appliedValue === newValue) {
149
- state.carryValue = undefined;
150
- } else {
151
- state.carryValue = newValue;
152
- }
142
+ commit();
153
143
  }
154
144
  }, {
155
145
  matches: (keyDef, element) => {
156
146
  var _keyDef$key4;
157
147
 
158
- return ((_keyDef$key4 = keyDef.key) == null ? void 0 : _keyDef$key4.length) === 1 && ((0, _utils.isElementType)(element, ['input', 'textarea'], {
148
+ return ((_keyDef$key4 = keyDef.key) == null ? void 0 : _keyDef$key4.length) === 1 && ((0, _utils.isEditableInput)(element) || (0, _utils.isElementType)(element, 'textarea', {
159
149
  readOnly: false
160
- }) && !(0, _utils.isClickableInput)(element) || (0, _utils.isContentEditable)(element)) && (0, _utils.getSpaceUntilMaxLength)(element) !== 0;
150
+ }) || (0, _utils.isContentEditable)(element)) && (0, _utils.getSpaceUntilMaxLength)(element) !== 0;
161
151
  },
162
152
  handle: (keyDef, element) => {
163
- const {
164
- newValue,
165
- newSelectionStart
166
- } = (0, _utils.calculateNewValue)(keyDef.key, element);
167
- (0, _shared.fireInputEvent)(element, {
168
- newValue,
169
- newSelectionStart,
170
- eventOverrides: {
171
- data: keyDef.key,
172
- inputType: 'insertText'
173
- }
174
- });
153
+ var _prepareInput;
154
+
155
+ (_prepareInput = (0, _utils.prepareInput)(keyDef.key, element)) == null ? void 0 : _prepareInput.commit();
175
156
  }
176
157
  }, {
177
158
  matches: (keyDef, element) => keyDef.key === 'Enter' && ((0, _utils.isElementType)(element, 'textarea', {
178
159
  readOnly: false
179
160
  }) || (0, _utils.isContentEditable)(element)) && (0, _utils.getSpaceUntilMaxLength)(element) !== 0,
180
161
  handle: (keyDef, element, options, state) => {
181
- const {
182
- newValue,
183
- newSelectionStart
184
- } = (0, _utils.calculateNewValue)('\n', element);
185
- const inputType = (0, _utils.isContentEditable)(element) && !state.modifiers.shift ? 'insertParagraph' : 'insertLineBreak';
186
- (0, _shared.fireInputEvent)(element, {
187
- newValue,
188
- newSelectionStart,
189
- eventOverrides: {
190
- inputType
191
- }
192
- });
162
+ var _prepareInput2;
163
+
164
+ (_prepareInput2 = (0, _utils.prepareInput)('\n', element, (0, _utils.isContentEditable)(element) && !state.modifiers.shift ? 'insertParagraph' : 'insertLineBreak')) == null ? void 0 : _prepareInput2.commit();
193
165
  }
194
166
  }];
195
167
  exports.keypressBehavior = keypressBehavior;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Default behavior for key combinations
3
+ */
4
+ import { behaviorPlugin } from '../types';
5
+ export declare const keydownBehavior: behaviorPlugin[];