@testing-library/user-event 13.4.2 → 14.0.0-alpha.11

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 (125) 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 +3 -22
  17. package/dist/index.js +3 -36
  18. package/dist/keyboard/getEventProps.d.ts +0 -2
  19. package/dist/keyboard/getEventProps.js +1 -7
  20. package/dist/keyboard/getNextKeyDef.d.ts +3 -0
  21. package/dist/keyboard/getNextKeyDef.js +59 -87
  22. package/dist/keyboard/index.d.ts +1 -1
  23. package/dist/keyboard/index.js +4 -8
  24. package/dist/keyboard/keyMap.js +26 -46
  25. package/dist/keyboard/keyboardImplementation.js +35 -19
  26. package/dist/keyboard/plugins/arrow.js +7 -12
  27. package/dist/keyboard/plugins/character.js +29 -57
  28. package/dist/keyboard/plugins/combination.d.ts +5 -0
  29. package/dist/keyboard/plugins/combination.js +17 -0
  30. package/dist/keyboard/plugins/control.js +5 -16
  31. package/dist/keyboard/plugins/functional.js +23 -14
  32. package/dist/keyboard/plugins/index.d.ts +0 -1
  33. package/dist/keyboard/plugins/index.js +4 -13
  34. package/dist/keyboard/shared/index.d.ts +0 -2
  35. package/dist/keyboard/shared/index.js +0 -26
  36. package/dist/keyboard/types.d.ts +8 -2
  37. package/dist/paste.d.ts +3 -2
  38. package/dist/paste.js +8 -15
  39. package/dist/pointer/index.d.ts +18 -0
  40. package/dist/pointer/index.js +90 -0
  41. package/dist/pointer/keyMap.d.ts +2 -0
  42. package/dist/pointer/keyMap.js +29 -0
  43. package/dist/pointer/parseKeyDef.d.ts +6 -0
  44. package/dist/pointer/parseKeyDef.js +36 -0
  45. package/dist/pointer/pointerAction.d.ts +6 -0
  46. package/dist/pointer/pointerAction.js +52 -0
  47. package/dist/pointer/pointerMove.d.ts +5 -0
  48. package/dist/pointer/pointerMove.js +136 -0
  49. package/dist/pointer/pointerPress.d.ts +7 -0
  50. package/dist/pointer/pointerPress.js +330 -0
  51. package/dist/pointer/resolveSelectionTarget.d.ts +5 -0
  52. package/dist/pointer/resolveSelectionTarget.js +75 -0
  53. package/dist/pointer/types.d.ts +72 -0
  54. package/dist/pointer/types.js +1 -0
  55. package/dist/selectOptions.d.ts +4 -0
  56. package/dist/{select-options.js → selectOptions.js} +18 -20
  57. package/dist/setup.d.ts +92 -0
  58. package/dist/setup.js +203 -0
  59. package/dist/tab.d.ts +3 -4
  60. package/dist/tab.js +3 -136
  61. package/dist/type.d.ts +14 -0
  62. package/dist/type.js +74 -0
  63. package/dist/upload.d.ts +4 -3
  64. package/dist/upload.js +3 -9
  65. package/dist/utils/edit/calculateNewValue.d.ts +12 -5
  66. package/dist/utils/edit/calculateNewValue.js +19 -21
  67. package/dist/utils/edit/editInputElement.d.ts +16 -0
  68. package/dist/utils/edit/editInputElement.js +53 -0
  69. package/dist/utils/edit/getValue.d.ts +1 -1
  70. package/dist/utils/edit/getValue.js +3 -1
  71. package/dist/utils/edit/isContentEditable.d.ts +4 -0
  72. package/dist/utils/edit/isContentEditable.js +14 -0
  73. package/dist/utils/edit/isEditable.d.ts +1 -0
  74. package/dist/utils/edit/prepareInput.d.ts +7 -0
  75. package/dist/utils/edit/prepareInput.js +77 -0
  76. package/dist/{blur.d.ts → utils/focus/blur.d.ts} +0 -0
  77. package/dist/utils/focus/blur.js +19 -0
  78. package/dist/{focus.d.ts → utils/focus/focus.d.ts} +0 -0
  79. package/dist/utils/focus/focus.js +22 -0
  80. package/dist/utils/focus/getTabDestination.d.ts +1 -0
  81. package/dist/utils/focus/getTabDestination.js +71 -0
  82. package/dist/utils/focus/isFocusable.js +1 -3
  83. package/dist/utils/focus/selectAll.d.ts +5 -0
  84. package/dist/utils/focus/selectAll.js +51 -0
  85. package/dist/utils/focus/selection.d.ts +42 -0
  86. package/dist/utils/focus/selection.js +190 -0
  87. package/dist/utils/index.d.ts +12 -6
  88. package/dist/utils/index.js +132 -54
  89. package/dist/utils/keyDef/readNextDescriptor.d.ts +19 -0
  90. package/dist/utils/keyDef/readNextDescriptor.js +102 -0
  91. package/dist/utils/misc/findClosest.d.ts +1 -0
  92. package/dist/utils/misc/findClosest.js +20 -0
  93. package/dist/utils/misc/isDescendantOrSelf.d.ts +1 -0
  94. package/dist/utils/misc/isDescendantOrSelf.js +20 -0
  95. package/dist/utils/pointer/firePointerEvents.d.ts +25 -0
  96. package/dist/utils/pointer/firePointerEvents.js +112 -0
  97. package/dist/utils/pointer/mouseButtons.d.ts +12 -0
  98. package/dist/utils/pointer/mouseButtons.js +45 -0
  99. package/package.json +4 -3
  100. package/dist/blur.js +0 -15
  101. package/dist/dom-helpers.d.ts +0 -3
  102. package/dist/focus.js +0 -15
  103. package/dist/keyboard/shared/carryValue.d.ts +0 -2
  104. package/dist/keyboard/shared/carryValue.js +0 -13
  105. package/dist/keyboard/shared/fireInputEvent.d.ts +0 -17
  106. package/dist/keyboard/shared/fireInputEvent.js +0 -110
  107. package/dist/keyboard/specialCharMap.d.ts +0 -22
  108. package/dist/keyboard/specialCharMap.js +0 -30
  109. package/dist/select-options.d.ts +0 -4
  110. package/dist/type/index.d.ts +0 -7
  111. package/dist/type/index.js +0 -33
  112. package/dist/type/typeImplementation.d.ts +0 -10
  113. package/dist/type/typeImplementation.js +0 -64
  114. package/dist/utils/click/getMouseEventOptions.d.ts +0 -31
  115. package/dist/utils/click/getMouseEventOptions.js +0 -61
  116. package/dist/utils/edit/cursorPosition.d.ts +0 -2
  117. package/dist/utils/edit/cursorPosition.js +0 -35
  118. package/dist/utils/edit/hasUnreliableEmptyValue.d.ts +0 -10
  119. package/dist/utils/edit/hasUnreliableEmptyValue.js +0 -21
  120. package/dist/utils/edit/selectionRange.d.ts +0 -16
  121. package/dist/utils/edit/selectionRange.js +0 -104
  122. package/dist/utils/misc/isDocument.d.ts +0 -1
  123. package/dist/utils/misc/isDocument.js +0 -10
  124. package/dist/utils/misc/isLabelWithInternallyDisabledControl.d.ts +0 -1
  125. 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,25 +1,6 @@
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 { UserEventApis, setup } from './setup';
2
+ declare const userEvent: UserEventApis & {
3
+ setup: typeof setup;
22
4
  };
23
5
  export default userEvent;
24
- export { specialCharMap as specialChars };
25
6
  export type { keyboardKey } from './keyboard';
package/dist/index.js CHANGED
@@ -4,44 +4,11 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.default = void 0;
7
- Object.defineProperty(exports, "specialChars", {
8
- enumerable: true,
9
- get: function () {
10
- return _keyboard.specialCharMap;
11
- }
12
- });
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
7
 
30
- var _keyboard = require("./keyboard");
8
+ var _setup = require("./setup");
31
9
 
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
10
+ const userEvent = { ...Object.fromEntries(Object.entries(_setup.userEventApis).map(([k, f]) => [k, (...a) => f.apply(userEvent, a)])),
11
+ setup: _setup.setup
45
12
  };
46
13
  var _default = userEvent;
47
14
  exports.default = _default;
@@ -6,8 +6,6 @@ export declare function getKeyEventProps(keyDef: keyboardKey, state: keyboardSta
6
6
  ctrlKey: boolean;
7
7
  metaKey: boolean;
8
8
  shiftKey: boolean;
9
- /** @deprecated use code instead */
10
- keyCode: number | undefined;
11
9
  };
12
10
  export declare function getMouseEventProps(state: keyboardState): {
13
11
  altKey: boolean;
@@ -7,19 +7,13 @@ exports.getKeyEventProps = getKeyEventProps;
7
7
  exports.getMouseEventProps = getMouseEventProps;
8
8
 
9
9
  function getKeyEventProps(keyDef, state) {
10
- var _keyDef$keyCode, _keyDef$key;
11
-
12
10
  return {
13
11
  key: keyDef.key,
14
12
  code: keyDef.code,
15
13
  altKey: state.modifiers.alt,
16
14
  ctrlKey: state.modifiers.ctrl,
17
15
  metaKey: state.modifiers.meta,
18
- shiftKey: state.modifiers.shift,
19
-
20
- /** @deprecated use code instead */
21
- keyCode: (_keyDef$keyCode = keyDef.keyCode) != null ? _keyDef$keyCode : // istanbul ignore next
22
- ((_keyDef$key = keyDef.key) == null ? void 0 : _keyDef$key.length) === 1 ? keyDef.key.charCodeAt(0) : undefined
16
+ shiftKey: state.modifiers.shift
23
17
  };
24
18
  }
25
19
 
@@ -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
  }
@@ -1,5 +1,4 @@
1
1
  import { keyboardState, keyboardOptions, keyboardKey } from './types';
2
- export { specialCharMap } from './specialCharMap';
3
2
  export type { keyboardOptions, keyboardKey };
4
3
  export declare function keyboard(text: string, options?: Partial<keyboardOptions & {
5
4
  keyboardState: keyboardState;
@@ -16,3 +15,4 @@ export declare function keyboardImplementationWrapper(text: string, config?: Par
16
15
  state: keyboardState;
17
16
  releaseAllKeys: () => void;
18
17
  };
18
+ export declare function createKeyboardState(): keyboardState;
@@ -3,23 +3,18 @@
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
- Object.defineProperty(exports, "specialCharMap", {
9
- enumerable: true,
10
- get: function () {
11
- return _specialCharMap.specialCharMap;
12
- }
13
- });
14
9
 
15
10
  var _dom = require("@testing-library/dom");
16
11
 
12
+ var _document = require("../document");
13
+
17
14
  var _keyboardImplementation = require("./keyboardImplementation");
18
15
 
19
16
  var _keyMap = require("./keyMap");
20
17
 
21
- var _specialCharMap = require("./specialCharMap");
22
-
23
18
  function keyboard(text, options) {
24
19
  var _options$delay;
25
20
 
@@ -51,6 +46,7 @@ function keyboardImplementationWrapper(text, config = {}) {
51
46
  autoModify,
52
47
  keyboardMap
53
48
  };
49
+ (0, _document.prepareDocument)(document);
54
50
  return {
55
51
  promise: (0, _keyboardImplementation.keyboardImplementation)(text, options, state),
56
52
  state,
@@ -32,108 +32,88 @@ const defaultKeyMap = [// alphanumeric keys
32
32
  }, {
33
33
  code: 'AltLeft',
34
34
  key: 'Alt',
35
- location: _types.DOM_KEY_LOCATION.LEFT,
36
- keyCode: 18
35
+ location: _types.DOM_KEY_LOCATION.LEFT
37
36
  }, {
38
37
  code: 'AltRight',
39
38
  key: 'Alt',
40
- location: _types.DOM_KEY_LOCATION.RIGHT,
41
- keyCode: 18
39
+ location: _types.DOM_KEY_LOCATION.RIGHT
42
40
  }, {
43
41
  code: 'ShiftLeft',
44
42
  key: 'Shift',
45
- location: _types.DOM_KEY_LOCATION.LEFT,
46
- keyCode: 16
43
+ location: _types.DOM_KEY_LOCATION.LEFT
47
44
  }, {
48
45
  code: 'ShiftRight',
49
46
  key: 'Shift',
50
- location: _types.DOM_KEY_LOCATION.RIGHT,
51
- keyCode: 16
47
+ location: _types.DOM_KEY_LOCATION.RIGHT
52
48
  }, {
53
49
  code: 'ControlLeft',
54
50
  key: 'Control',
55
- location: _types.DOM_KEY_LOCATION.LEFT,
56
- keyCode: 17
51
+ location: _types.DOM_KEY_LOCATION.LEFT
57
52
  }, {
58
53
  code: 'ControlRight',
59
54
  key: 'Control',
60
- location: _types.DOM_KEY_LOCATION.RIGHT,
61
- keyCode: 17
55
+ location: _types.DOM_KEY_LOCATION.RIGHT
62
56
  }, {
63
57
  code: 'MetaLeft',
64
58
  key: 'Meta',
65
- location: _types.DOM_KEY_LOCATION.LEFT,
66
- keyCode: 93
59
+ location: _types.DOM_KEY_LOCATION.LEFT
67
60
  }, {
68
61
  code: 'MetaRight',
69
62
  key: 'Meta',
70
- location: _types.DOM_KEY_LOCATION.RIGHT,
71
- keyCode: 93
63
+ location: _types.DOM_KEY_LOCATION.RIGHT
72
64
  }, {
73
65
  code: 'OSLeft',
74
66
  key: 'OS',
75
- location: _types.DOM_KEY_LOCATION.LEFT,
76
- keyCode: 91
67
+ location: _types.DOM_KEY_LOCATION.LEFT
77
68
  }, {
78
69
  code: 'OSRight',
79
70
  key: 'OS',
80
- location: _types.DOM_KEY_LOCATION.RIGHT,
81
- keyCode: 91
71
+ location: _types.DOM_KEY_LOCATION.RIGHT
72
+ }, {
73
+ code: 'Tab',
74
+ key: 'Tab'
82
75
  }, {
83
76
  code: 'CapsLock',
84
- key: 'CapsLock',
85
- keyCode: 20
77
+ key: 'CapsLock'
86
78
  }, {
87
79
  code: 'Backspace',
88
- key: 'Backspace',
89
- keyCode: 8
80
+ key: 'Backspace'
90
81
  }, {
91
82
  code: 'Enter',
92
- key: 'Enter',
93
- keyCode: 13
83
+ key: 'Enter'
94
84
  }, // function
95
85
  {
96
86
  code: 'Escape',
97
- key: 'Escape',
98
- keyCode: 27
87
+ key: 'Escape'
99
88
  }, // arrows
100
89
  {
101
90
  code: 'ArrowUp',
102
- key: 'ArrowUp',
103
- keyCode: 38
91
+ key: 'ArrowUp'
104
92
  }, {
105
93
  code: 'ArrowDown',
106
- key: 'ArrowDown',
107
- keyCode: 40
94
+ key: 'ArrowDown'
108
95
  }, {
109
96
  code: 'ArrowLeft',
110
- key: 'ArrowLeft',
111
- keyCode: 37
97
+ key: 'ArrowLeft'
112
98
  }, {
113
99
  code: 'ArrowRight',
114
- key: 'ArrowRight',
115
- keyCode: 39
100
+ key: 'ArrowRight'
116
101
  }, // control pad
117
102
  {
118
103
  code: 'Home',
119
- key: 'Home',
120
- keyCode: 36
104
+ key: 'Home'
121
105
  }, {
122
106
  code: 'End',
123
- key: 'End',
124
- keyCode: 35
107
+ key: 'End'
125
108
  }, {
126
109
  code: 'Delete',
127
- key: 'Delete',
128
- keyCode: 46
110
+ key: 'Delete'
129
111
  }, {
130
112
  code: 'PageUp',
131
- key: 'PageUp',
132
- keyCode: 33
113
+ key: 'PageUp'
133
114
  }, {
134
115
  code: 'PageDown',
135
- key: 'PageDown',
136
- keyCode: 34
116
+ key: 'PageDown'
137
117
  } // TODO: add mappings
138
118
  ];
139
119
  exports.defaultKeyMap = defaultKeyMap;
@@ -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,31 +33,43 @@ async function keyboardImplementation(text, options, state) {
31
33
  keyDef,
32
34
  consumedLength,
33
35
  releasePrevious,
34
- releaseSelf
35
- } = (0, _getNextKeyDef.getNextKeyDef)(text, options);
36
- const replace = applyPlugins(plugins.replaceBehavior, keyDef, getCurrentElement(), options, state);
37
-
38
- if (!replace) {
39
- const pressed = state.pressed.find(p => p.keyDef === keyDef);
36
+ releaseSelf,
37
+ repeat
38
+ } = (_state$repeatKey = state.repeatKey) != null ? _state$repeatKey : (0, _getNextKeyDef.getNextKeyDef)(text, options);
39
+ const pressed = state.pressed.find(p => p.keyDef === keyDef); // Release the key automatically if it was pressed before.
40
+ // Do not release the key on iterations on `state.repeatKey`.
41
+
42
+ if (pressed && !state.repeatKey) {
43
+ keyup(keyDef, getCurrentElement, options, state, pressed.unpreventedDefault);
44
+ }
40
45
 
41
- if (pressed) {
42
- keyup(keyDef, getCurrentElement, options, state, pressed.unpreventedDefault);
43
- }
46
+ if (!releasePrevious) {
47
+ const unpreventedDefault = keydown(keyDef, getCurrentElement, options, state);
44
48
 
45
- if (!releasePrevious) {
46
- const unpreventedDefault = keydown(keyDef, getCurrentElement, options, state);
49
+ if (unpreventedDefault && hasKeyPress(keyDef, state)) {
50
+ keypress(keyDef, getCurrentElement, options, state);
51
+ } // Release the key only on the last iteration on `state.repeatKey`.
47
52
 
48
- if (unpreventedDefault && hasKeyPress(keyDef, state)) {
49
- keypress(keyDef, getCurrentElement, options, state);
50
- }
51
53
 
52
- if (releaseSelf) {
53
- keyup(keyDef, getCurrentElement, options, state, unpreventedDefault);
54
- }
54
+ if (releaseSelf && repeat <= 1) {
55
+ keyup(keyDef, getCurrentElement, options, state, unpreventedDefault);
55
56
  }
56
57
  }
57
58
 
58
- if (text.length > consumedLength) {
59
+ if (repeat > 1) {
60
+ state.repeatKey = {
61
+ // don't consume again on the next iteration
62
+ consumedLength: 0,
63
+ keyDef,
64
+ releasePrevious,
65
+ releaseSelf,
66
+ repeat: repeat - 1
67
+ };
68
+ } else {
69
+ delete state.repeatKey;
70
+ }
71
+
72
+ if (text.length > consumedLength || repeat > 1) {
59
73
  if (options.delay > 0) {
60
74
  await (0, _utils.wait)(options.delay);
61
75
  }
@@ -111,7 +125,9 @@ function keydown(keyDef, getCurrentElement, options, state) {
111
125
  function keypress(keyDef, getCurrentElement, options, state) {
112
126
  const element = getCurrentElement();
113
127
 
114
- const unpreventedDefault = _dom.fireEvent.keyPress(element, (0, _getEventProps.getKeyEventProps)(keyDef, state));
128
+ const unpreventedDefault = _dom.fireEvent.keyPress(element, { ...(0, _getEventProps.getKeyEventProps)(keyDef, state),
129
+ charCode: keyDef.key === 'Enter' ? 13 : String(keyDef.key).charCodeAt(0)
130
+ });
115
131
 
116
132
  if (unpreventedDefault) {
117
133
  applyPlugins(plugins.keypressBehavior, keyDef, getCurrentElement(), options, state);