@testing-library/user-event 13.5.0 → 14.0.0-alpha.4

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 (100) hide show
  1. package/README.md +3 -0
  2. package/dist/clear.d.ts +2 -2
  3. package/dist/clear.js +1 -3
  4. package/dist/click.d.ts +3 -3
  5. package/dist/click.js +13 -144
  6. package/dist/document/index.d.ts +9 -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 +17 -0
  11. package/dist/document/selection.js +64 -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.js +3 -92
  19. package/dist/keyboard/index.d.ts +1 -0
  20. package/dist/keyboard/index.js +4 -0
  21. package/dist/keyboard/keyMap.js +4 -0
  22. package/dist/keyboard/plugins/character.js +8 -18
  23. package/dist/keyboard/plugins/control.js +3 -6
  24. package/dist/keyboard/plugins/functional.js +20 -6
  25. package/dist/keyboard/plugins/index.js +2 -4
  26. package/dist/keyboard/shared/index.d.ts +0 -2
  27. package/dist/keyboard/shared/index.js +0 -26
  28. package/dist/keyboard/types.d.ts +3 -0
  29. package/dist/paste.d.ts +3 -2
  30. package/dist/pointer/index.d.ts +18 -0
  31. package/dist/pointer/index.js +90 -0
  32. package/dist/pointer/keyMap.d.ts +2 -0
  33. package/dist/pointer/keyMap.js +29 -0
  34. package/dist/pointer/parseKeyDef.d.ts +6 -0
  35. package/dist/pointer/parseKeyDef.js +36 -0
  36. package/dist/pointer/pointerAction.d.ts +6 -0
  37. package/dist/pointer/pointerAction.js +52 -0
  38. package/dist/pointer/pointerMove.d.ts +5 -0
  39. package/dist/pointer/pointerMove.js +125 -0
  40. package/dist/pointer/pointerPress.d.ts +7 -0
  41. package/dist/pointer/pointerPress.js +328 -0
  42. package/dist/pointer/resolveSelectionTarget.d.ts +5 -0
  43. package/dist/pointer/resolveSelectionTarget.js +74 -0
  44. package/dist/pointer/types.d.ts +72 -0
  45. package/dist/pointer/types.js +1 -0
  46. package/dist/selectOptions.d.ts +4 -0
  47. package/dist/{select-options.js → selectOptions.js} +18 -20
  48. package/dist/setup.d.ts +89 -0
  49. package/dist/setup.js +206 -0
  50. package/dist/tab.d.ts +3 -3
  51. package/dist/tab.js +18 -97
  52. package/dist/type.d.ts +14 -0
  53. package/dist/type.js +74 -0
  54. package/dist/upload.d.ts +4 -3
  55. package/dist/upload.js +3 -9
  56. package/dist/{keyboard/shared → utils/edit}/fireInputEvent.d.ts +0 -9
  57. package/dist/utils/edit/fireInputEvent.js +59 -0
  58. package/dist/utils/edit/getValue.d.ts +1 -1
  59. package/dist/utils/edit/getValue.js +3 -1
  60. package/dist/utils/edit/selectionRange.d.ts +0 -11
  61. package/dist/utils/edit/selectionRange.js +9 -49
  62. package/dist/{blur.d.ts → utils/focus/blur.d.ts} +0 -0
  63. package/dist/utils/focus/blur.js +19 -0
  64. package/dist/{focus.d.ts → utils/focus/focus.d.ts} +0 -0
  65. package/dist/utils/focus/focus.js +19 -0
  66. package/dist/utils/focus/getTabDestination.d.ts +1 -0
  67. package/dist/utils/focus/getTabDestination.js +72 -0
  68. package/dist/utils/focus/isFocusable.js +1 -3
  69. package/dist/utils/index.d.ts +10 -3
  70. package/dist/utils/index.js +120 -29
  71. package/dist/utils/keyDef/readNextDescriptor.d.ts +19 -0
  72. package/dist/utils/keyDef/readNextDescriptor.js +102 -0
  73. package/dist/utils/misc/findClosest.d.ts +1 -0
  74. package/dist/utils/misc/findClosest.js +20 -0
  75. package/dist/utils/misc/isDescendantOrSelf.d.ts +1 -0
  76. package/dist/utils/misc/isDescendantOrSelf.js +20 -0
  77. package/dist/utils/pointer/fakeEvent.d.ts +20 -0
  78. package/dist/utils/pointer/fakeEvent.js +91 -0
  79. package/dist/utils/pointer/firePointerEvents.d.ts +14 -0
  80. package/dist/utils/pointer/firePointerEvents.js +55 -0
  81. package/dist/utils/pointer/mouseButtons.d.ts +12 -0
  82. package/dist/utils/pointer/mouseButtons.js +45 -0
  83. package/package.json +4 -3
  84. package/dist/blur.js +0 -15
  85. package/dist/dom-helpers.d.ts +0 -3
  86. package/dist/focus.js +0 -15
  87. package/dist/keyboard/shared/carryValue.d.ts +0 -2
  88. package/dist/keyboard/shared/carryValue.js +0 -13
  89. package/dist/keyboard/shared/fireInputEvent.js +0 -110
  90. package/dist/select-options.d.ts +0 -4
  91. package/dist/type/index.d.ts +0 -7
  92. package/dist/type/index.js +0 -33
  93. package/dist/type/typeImplementation.d.ts +0 -10
  94. package/dist/type/typeImplementation.js +0 -64
  95. package/dist/utils/click/getMouseEventOptions.d.ts +0 -31
  96. package/dist/utils/click/getMouseEventOptions.js +0 -61
  97. package/dist/utils/edit/hasUnreliableEmptyValue.d.ts +0 -10
  98. package/dist/utils/edit/hasUnreliableEmptyValue.js +0 -21
  99. package/dist/utils/misc/isLabelWithInternallyDisabledControl.d.ts +0 -1
  100. package/dist/utils/misc/isLabelWithInternallyDisabledControl.js +0 -22
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;
@@ -4,12 +4,8 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.getNextKeyDef = getNextKeyDef;
7
- var bracketDict;
8
7
 
9
- (function (bracketDict) {
10
- bracketDict["{"] = "}";
11
- bracketDict["["] = "]";
12
- })(bracketDict || (bracketDict = {}));
8
+ var _utils = require("../utils");
13
9
 
14
10
  var legacyModifiers;
15
11
 
@@ -48,9 +44,9 @@ function getNextKeyDef(text, options) {
48
44
  descriptor,
49
45
  consumedLength,
50
46
  releasePrevious,
51
- releaseSelf,
47
+ releaseSelf = !(type === '{' && getEnumValue(legacyModifiers, descriptor.toLowerCase())),
52
48
  repeat
53
- } = readNextDescriptor(text);
49
+ } = (0, _utils.readNextDescriptor)(text);
54
50
  const keyDef = (_options$keyboardMap$ = options.keyboardMap.find(def => {
55
51
  if (type === '[') {
56
52
  var _def$code;
@@ -78,97 +74,12 @@ function getNextKeyDef(text, options) {
78
74
  };
79
75
  }
80
76
 
81
- function readNextDescriptor(text) {
82
- let pos = 0;
83
- const startBracket = text[pos] in bracketDict ? text[pos] : '';
84
- pos += startBracket.length; // `foo{{bar` is an escaped char at position 3,
85
- // but `foo{{{>5}bar` should be treated as `{` pressed down for 5 keydowns.
86
-
87
- const startBracketRepeated = startBracket ? text.match(new RegExp(`^\\${startBracket}+`))[0].length : 0;
88
- const isEscapedChar = startBracketRepeated === 2 || startBracket === '{' && startBracketRepeated > 3;
89
- const type = isEscapedChar ? '' : startBracket;
90
- return {
91
- type,
92
- ...(type === '' ? readPrintableChar(text, pos) : readTag(text, pos, type))
93
- };
94
- }
95
-
96
- function readPrintableChar(text, pos) {
97
- const descriptor = text[pos];
98
- assertDescriptor(descriptor, text, pos);
99
- pos += descriptor.length;
100
- return {
101
- consumedLength: pos,
102
- descriptor,
103
- releasePrevious: false,
104
- releaseSelf: true,
105
- repeat: 1
106
- };
107
- }
108
-
109
- function readTag(text, pos, startBracket) {
110
- var _text$slice$match, _text$slice$match$, _text$slice$match2;
111
-
112
- const releasePreviousModifier = text[pos] === '/' ? '/' : '';
113
- pos += releasePreviousModifier.length;
114
- const descriptor = (_text$slice$match = text.slice(pos).match(/^\w+/)) == null ? void 0 : _text$slice$match[0];
115
- assertDescriptor(descriptor, text, pos);
116
- pos += descriptor.length;
117
- const repeatModifier = (_text$slice$match$ = (_text$slice$match2 = text.slice(pos).match(/^>\d+/)) == null ? void 0 : _text$slice$match2[0]) != null ? _text$slice$match$ : '';
118
- pos += repeatModifier.length;
119
- const releaseSelfModifier = text[pos] === '/' || !repeatModifier && text[pos] === '>' ? text[pos] : '';
120
- pos += releaseSelfModifier.length;
121
- const expectedEndBracket = bracketDict[startBracket];
122
- const endBracket = text[pos] === expectedEndBracket ? expectedEndBracket : '';
123
-
124
- if (!endBracket) {
125
- throw new Error(getErrorMessage([!repeatModifier && 'repeat modifier', !releaseSelfModifier && 'release modifier', `"${expectedEndBracket}"`].filter(Boolean).join(' or '), text[pos], text));
126
- }
127
-
128
- pos += endBracket.length;
129
- return {
130
- consumedLength: pos,
131
- descriptor,
132
- releasePrevious: !!releasePreviousModifier,
133
- repeat: repeatModifier ? Math.max(Number(repeatModifier.substr(1)), 1) : 1,
134
- releaseSelf: hasReleaseSelf(startBracket, descriptor, releaseSelfModifier, repeatModifier)
135
- };
136
- }
137
-
138
- function assertDescriptor(descriptor, text, pos) {
139
- if (!descriptor) {
140
- throw new Error(getErrorMessage('key descriptor', text[pos], text));
141
- }
142
- }
143
-
144
77
  function getEnumValue(f, key) {
145
78
  return f[key];
146
79
  }
147
80
 
148
- function hasReleaseSelf(startBracket, descriptor, releaseSelfModifier, repeatModifier) {
149
- if (releaseSelfModifier) {
150
- return releaseSelfModifier === '/';
151
- }
152
-
153
- if (repeatModifier) {
154
- return false;
155
- }
156
-
157
- if (startBracket === '{' && getEnumValue(legacyModifiers, descriptor.toLowerCase())) {
158
- return false;
159
- }
160
-
161
- return true;
162
- }
163
-
164
81
  function mapLegacyKey(descriptor) {
165
82
  var _getEnumValue;
166
83
 
167
84
  return (_getEnumValue = getEnumValue(legacyKeyMap, descriptor)) != null ? _getEnumValue : descriptor;
168
- }
169
-
170
- function getErrorMessage(expected, found, text) {
171
- return `Expected ${expected} but found "${found != null ? found : ''}" in "${text}"
172
- See https://github.com/testing-library/user-event/blob/main/README.md#keyboardtext-options
173
- for more information about how userEvent parses your input.`;
174
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',
@@ -42,7 +42,7 @@ const keypressBehavior = [{
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.fireInputEvent)(element, {
46
46
  newValue,
47
47
  newSelectionStart,
48
48
  eventOverrides: {
@@ -83,7 +83,7 @@ const keypressBehavior = [{
83
83
  // TODO: verify if it is even needed by this handler
84
84
 
85
85
  if (prevValue !== newValue) {
86
- (0, _shared.fireInputEvent)(element, {
86
+ (0, _utils.fireInputEvent)(element, {
87
87
  newValue,
88
88
  newSelectionStart,
89
89
  eventOverrides: {
@@ -112,20 +112,17 @@ const keypressBehavior = [{
112
112
  readOnly: false
113
113
  });
114
114
  },
115
- handle: (keyDef, element, options, state) => {
116
- var _ref, _state$carryValue3, _newValue$match, _newValue$match2;
115
+ handle: (keyDef, element) => {
116
+ var _newValue$match, _newValue$match2;
117
117
 
118
118
  if (!/[\d.\-e]/.test(keyDef.key)) {
119
119
  return;
120
120
  }
121
121
 
122
- const oldValue = (_ref = (_state$carryValue3 = state.carryValue) != null ? _state$carryValue3 : (0, _utils.getValue)(element)) != null ? _ref :
123
- /* istanbul ignore next */
124
- '';
125
122
  const {
126
123
  newValue,
127
124
  newSelectionStart
128
- } = (0, _utils.calculateNewValue)(keyDef.key, element, oldValue); // the browser allows some invalid input but not others
125
+ } = (0, _utils.calculateNewValue)(keyDef.key, element); // the browser allows some invalid input but not others
129
126
  // it allows up to two '-' at any place before any 'e' or one directly following 'e'
130
127
  // it allows one '.' at any place before e
131
128
 
@@ -135,7 +132,7 @@ const keypressBehavior = [{
135
132
  return;
136
133
  }
137
134
 
138
- (0, _shared.fireInputEvent)(element, {
135
+ (0, _utils.fireInputEvent)(element, {
139
136
  newValue,
140
137
  newSelectionStart,
141
138
  eventOverrides: {
@@ -143,13 +140,6 @@ const keypressBehavior = [{
143
140
  inputType: 'insertText'
144
141
  }
145
142
  });
146
- const appliedValue = (0, _utils.getValue)(element);
147
-
148
- if (appliedValue === newValue) {
149
- state.carryValue = undefined;
150
- } else {
151
- state.carryValue = newValue;
152
- }
153
143
  }
154
144
  }, {
155
145
  matches: (keyDef, element) => {
@@ -164,7 +154,7 @@ const keypressBehavior = [{
164
154
  newValue,
165
155
  newSelectionStart
166
156
  } = (0, _utils.calculateNewValue)(keyDef.key, element);
167
- (0, _shared.fireInputEvent)(element, {
157
+ (0, _utils.fireInputEvent)(element, {
168
158
  newValue,
169
159
  newSelectionStart,
170
160
  eventOverrides: {
@@ -183,7 +173,7 @@ const keypressBehavior = [{
183
173
  newSelectionStart
184
174
  } = (0, _utils.calculateNewValue)('\n', element);
185
175
  const inputType = (0, _utils.isContentEditable)(element) && !state.modifiers.shift ? 'insertParagraph' : 'insertLineBreak';
186
- (0, _shared.fireInputEvent)(element, {
176
+ (0, _utils.fireInputEvent)(element, {
187
177
  newValue,
188
178
  newSelectionStart,
189
179
  eventOverrides: {
@@ -7,8 +7,6 @@ exports.keydownBehavior = void 0;
7
7
 
8
8
  var _utils = require("../../utils");
9
9
 
10
- var _shared = require("../shared");
11
-
12
10
  /**
13
11
  * This file should contain behavior for arrow keys as described here:
14
12
  * https://w3c.github.io/uievents-code/#key-controlpad-section
@@ -45,19 +43,18 @@ const keydownBehavior = [{
45
43
  }
46
44
  }, {
47
45
  matches: (keyDef, element) => keyDef.key === 'Delete' && (0, _utils.isEditable)(element) && !(0, _utils.isCursorAtEnd)(element),
48
- handle: (keDef, element, options, state) => {
46
+ handle: (keDef, element) => {
49
47
  const {
50
48
  newValue,
51
49
  newSelectionStart
52
- } = (0, _utils.calculateNewValue)('', element, state.carryValue, undefined, 'forward');
53
- (0, _shared.fireInputEvent)(element, {
50
+ } = (0, _utils.calculateNewValue)('', element, undefined, undefined, 'forward');
51
+ (0, _utils.fireInputEvent)(element, {
54
52
  newValue,
55
53
  newSelectionStart,
56
54
  eventOverrides: {
57
55
  inputType: 'deleteContentForward'
58
56
  }
59
57
  });
60
- (0, _shared.carryValue)(element, state, newValue);
61
58
  }
62
59
  }];
63
60
  exports.keydownBehavior = keydownBehavior;
@@ -7,12 +7,12 @@ exports.preKeyupBehavior = exports.preKeydownBehavior = exports.postKeyupBehavio
7
7
 
8
8
  var _dom = require("@testing-library/dom");
9
9
 
10
+ var _document = require("../../document");
11
+
10
12
  var _utils = require("../../utils");
11
13
 
12
14
  var _getEventProps = require("../getEventProps");
13
15
 
14
- var _shared = require("../shared");
15
-
16
16
  /**
17
17
  * This file should contain behavior for functional keys as described here:
18
18
  * https://w3c.github.io/uievents-code/#key-alphanumeric-functional
@@ -54,19 +54,33 @@ const keydownBehavior = [{
54
54
  }
55
55
  }, {
56
56
  matches: (keyDef, element) => keyDef.key === 'Backspace' && (0, _utils.isEditable)(element) && !(0, _utils.isCursorAtStart)(element),
57
- handle: (keyDef, element, options, state) => {
57
+ handle: (keyDef, element) => {
58
58
  const {
59
59
  newValue,
60
60
  newSelectionStart
61
- } = (0, _utils.calculateNewValue)('', element, state.carryValue, undefined, 'backward');
62
- (0, _shared.fireInputEvent)(element, {
61
+ } = (0, _utils.calculateNewValue)('', element, undefined, undefined, 'backward');
62
+ (0, _utils.fireInputEvent)(element, {
63
63
  newValue,
64
64
  newSelectionStart,
65
65
  eventOverrides: {
66
66
  inputType: 'deleteContentBackward'
67
67
  }
68
68
  });
69
- (0, _shared.carryValue)(element, state, newValue);
69
+ }
70
+ }, {
71
+ matches: keyDef => keyDef.key === 'Tab',
72
+ handle: (keyDef, element, options, state) => {
73
+ const dest = (0, _utils.getTabDestination)(element, state.modifiers.shift, element.ownerDocument);
74
+
75
+ if (dest === element.ownerDocument.body) {
76
+ (0, _utils.blur)(element);
77
+ } else {
78
+ (0, _utils.focus)(dest);
79
+
80
+ if ((0, _utils.isElementType)(dest, ['input', 'textarea'])) {
81
+ (0, _document.setUISelection)(dest, 0, dest.value.length);
82
+ }
83
+ }
70
84
  }
71
85
  }];
72
86
  exports.keydownBehavior = keydownBehavior;
@@ -21,10 +21,8 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
21
21
 
22
22
  const replaceBehavior = [{
23
23
  matches: (keyDef, element) => keyDef.key === 'selectall' && (0, _utils.isElementType)(element, ['input', 'textarea']),
24
- handle: (keyDef, element, options, state) => {
25
- var _state$carryValue;
26
-
27
- (0, _utils.setSelectionRange)(element, 0, ((_state$carryValue = state.carryValue) != null ? _state$carryValue : element.value).length);
24
+ handle: (keyDef, element) => {
25
+ (0, _utils.setSelectionRange)(element, 0, (0, _utils.getValue)(element).length);
28
26
  }
29
27
  }];
30
28
  exports.replaceBehavior = replaceBehavior;
@@ -1,3 +1 @@
1
- export * from './carryValue';
2
1
  export * from './fireChangeForInputTimeIfValid';
3
- export * from './fireInputEvent';
@@ -4,19 +4,6 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
 
7
- var _carryValue = require("./carryValue");
8
-
9
- Object.keys(_carryValue).forEach(function (key) {
10
- if (key === "default" || key === "__esModule") return;
11
- if (key in exports && exports[key] === _carryValue[key]) return;
12
- Object.defineProperty(exports, key, {
13
- enumerable: true,
14
- get: function () {
15
- return _carryValue[key];
16
- }
17
- });
18
- });
19
-
20
7
  var _fireChangeForInputTimeIfValid = require("./fireChangeForInputTimeIfValid");
21
8
 
22
9
  Object.keys(_fireChangeForInputTimeIfValid).forEach(function (key) {
@@ -28,17 +15,4 @@ Object.keys(_fireChangeForInputTimeIfValid).forEach(function (key) {
28
15
  return _fireChangeForInputTimeIfValid[key];
29
16
  }
30
17
  });
31
- });
32
-
33
- var _fireInputEvent = require("./fireInputEvent");
34
-
35
- Object.keys(_fireInputEvent).forEach(function (key) {
36
- if (key === "default" || key === "__esModule") return;
37
- if (key in exports && exports[key] === _fireInputEvent[key]) return;
38
- Object.defineProperty(exports, key, {
39
- enumerable: true,
40
- get: function () {
41
- return _fireInputEvent[key];
42
- }
43
- });
44
18
  });
@@ -29,6 +29,9 @@ export declare type keyboardState = {
29
29
  For HTMLInputElements type='number':
30
30
  If the last input char is '.', '-' or 'e',
31
31
  the IDL value attribute does not reflect the input value.
32
+
33
+ @deprecated The document state workaround in `src/document/value.ts` keeps track
34
+ of UI value diverging from value property.
32
35
  */
33
36
  carryValue?: string;
34
37
  /**
package/dist/paste.d.ts CHANGED
@@ -1,6 +1,7 @@
1
+ import type { UserEvent } from './setup';
1
2
  interface pasteOptions {
2
3
  initialSelectionStart?: number;
3
4
  initialSelectionEnd?: number;
4
5
  }
5
- declare function paste(element: HTMLElement, text: string, init?: ClipboardEventInit, { initialSelectionStart, initialSelectionEnd }?: pasteOptions): void;
6
- export { paste };
6
+ export declare function paste(this: UserEvent, element: HTMLElement, text: string, init?: ClipboardEventInit, { initialSelectionStart, initialSelectionEnd }?: pasteOptions): void;
7
+ export {};
@@ -0,0 +1,18 @@
1
+ import { PointerAction, PointerActionTarget } from './pointerAction';
2
+ import type { inputDeviceState, pointerOptions, pointerState } from './types';
3
+ export declare function pointer(input: PointerInput, options?: Partial<pointerOptions & {
4
+ delay: 0;
5
+ } & inputDeviceState>): pointerState;
6
+ export declare function pointer(input: PointerInput, options: Partial<pointerOptions & {
7
+ delay: number;
8
+ } & inputDeviceState>): Promise<pointerState>;
9
+ declare type PointerActionInput = string | ({
10
+ keys: string;
11
+ } & PointerActionTarget) | PointerAction;
12
+ declare type PointerInput = PointerActionInput | Array<PointerActionInput>;
13
+ export declare function pointerImplementationWrapper(input: PointerInput, config: Partial<pointerOptions & inputDeviceState>): {
14
+ promise: Promise<unknown[]>;
15
+ pointerState: pointerState;
16
+ };
17
+ export declare function createPointerState(): pointerState;
18
+ export {};
@@ -0,0 +1,90 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.createPointerState = createPointerState;
7
+ exports.pointer = pointer;
8
+ exports.pointerImplementationWrapper = pointerImplementationWrapper;
9
+
10
+ var _dom = require("@testing-library/dom");
11
+
12
+ var _keyboard = require("../keyboard");
13
+
14
+ var _parseKeyDef = require("./parseKeyDef");
15
+
16
+ var _keyMap = require("./keyMap");
17
+
18
+ var _pointerAction = require("./pointerAction");
19
+
20
+ function pointer(input, options = {}) {
21
+ var _options$delay;
22
+
23
+ const {
24
+ promise,
25
+ pointerState
26
+ } = pointerImplementationWrapper(input, options);
27
+
28
+ if (((_options$delay = options.delay) != null ? _options$delay : 0) > 0) {
29
+ return (0, _dom.getConfig)().asyncWrapper(() => promise.then(() => pointerState));
30
+ } else {
31
+ // prevent users from dealing with UnhandledPromiseRejectionWarning in sync call
32
+ promise.catch(console.error);
33
+ return pointerState;
34
+ }
35
+ }
36
+
37
+ function pointerImplementationWrapper(input, config) {
38
+ const {
39
+ pointerState = createPointerState(),
40
+ keyboardState = (0, _keyboard.createKeyboardState)(),
41
+ delay = 0,
42
+ pointerMap = _keyMap.defaultKeyMap
43
+ } = config;
44
+ const options = {
45
+ delay,
46
+ pointerMap
47
+ };
48
+ const actions = [];
49
+ (Array.isArray(input) ? input : [input]).forEach(actionInput => {
50
+ if (typeof actionInput === 'string') {
51
+ actions.push(...(0, _parseKeyDef.parseKeyDef)(actionInput, options));
52
+ } else if ('keys' in actionInput) {
53
+ actions.push(...(0, _parseKeyDef.parseKeyDef)(actionInput.keys, options).map(i => ({ ...actionInput,
54
+ ...i
55
+ })));
56
+ } else {
57
+ actions.push(actionInput);
58
+ }
59
+ });
60
+ return {
61
+ promise: (0, _pointerAction.pointerAction)(actions, options, {
62
+ pointerState,
63
+ keyboardState
64
+ }),
65
+ pointerState
66
+ };
67
+ }
68
+
69
+ function createPointerState() {
70
+ return {
71
+ pointerId: 1,
72
+ position: {
73
+ mouse: {
74
+ pointerType: 'mouse',
75
+ pointerId: 1,
76
+ coords: {
77
+ clientX: 0,
78
+ clientY: 0,
79
+ offsetX: 0,
80
+ offsetY: 0,
81
+ pageX: 0,
82
+ pageY: 0,
83
+ x: 0,
84
+ y: 0
85
+ }
86
+ }
87
+ },
88
+ pressed: []
89
+ };
90
+ }
@@ -0,0 +1,2 @@
1
+ import { pointerKey } from './types';
2
+ export declare const defaultKeyMap: pointerKey[];
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.defaultKeyMap = void 0;
7
+ const defaultKeyMap = [{
8
+ name: 'MouseLeft',
9
+ pointerType: 'mouse',
10
+ button: 'primary'
11
+ }, {
12
+ name: 'MouseRight',
13
+ pointerType: 'mouse',
14
+ button: 'secondary'
15
+ }, {
16
+ name: 'MouseMiddle',
17
+ pointerType: 'mouse',
18
+ button: 'auxiliary'
19
+ }, {
20
+ name: 'TouchA',
21
+ pointerType: 'touch'
22
+ }, {
23
+ name: 'TouchB',
24
+ pointerType: 'touch'
25
+ }, {
26
+ name: 'TouchC',
27
+ pointerType: 'touch'
28
+ }];
29
+ exports.defaultKeyMap = defaultKeyMap;
@@ -0,0 +1,6 @@
1
+ import { pointerKey, pointerOptions } from './types';
2
+ export declare function parseKeyDef(keys: string, { pointerMap }: pointerOptions): {
3
+ keyDef: pointerKey;
4
+ releasePrevious: boolean;
5
+ releaseSelf: boolean;
6
+ }[];
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.parseKeyDef = parseKeyDef;
7
+
8
+ var _utils = require("../utils");
9
+
10
+ function parseKeyDef(keys, {
11
+ pointerMap
12
+ }) {
13
+ const defs = [];
14
+
15
+ do {
16
+ const {
17
+ descriptor,
18
+ consumedLength,
19
+ releasePrevious,
20
+ releaseSelf = true
21
+ } = (0, _utils.readNextDescriptor)(keys);
22
+ const keyDef = pointerMap.find(p => p.name === descriptor);
23
+
24
+ if (keyDef) {
25
+ defs.push({
26
+ keyDef,
27
+ releasePrevious,
28
+ releaseSelf
29
+ });
30
+ }
31
+
32
+ keys = keys.slice(consumedLength);
33
+ } while (keys);
34
+
35
+ return defs;
36
+ }
@@ -0,0 +1,6 @@
1
+ import { PointerMoveAction } from './pointerMove';
2
+ import { PointerPressAction } from './pointerPress';
3
+ import { inputDeviceState, pointerOptions, PointerTarget, SelectionTarget } from './types';
4
+ export declare type PointerActionTarget = Partial<PointerTarget> & Partial<SelectionTarget>;
5
+ export declare type PointerAction = PointerActionTarget & (Omit<PointerPressAction, 'target' | 'coords'> | Omit<PointerMoveAction, 'target' | 'coords'>);
6
+ export declare function pointerAction(actions: PointerAction[], options: pointerOptions, state: inputDeviceState): Promise<unknown[]>;