@tanstack/hotkeys 0.9.0 → 0.10.0

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 (148) hide show
  1. package/dist/_event-target.js +1 -2
  2. package/dist/_keyboard-event.js +1 -2
  3. package/dist/_match.js +1 -2
  4. package/dist/_named-keys.d.ts +3 -5
  5. package/dist/_named-keys.js +1 -2
  6. package/dist/_recorder-chord.js +1 -2
  7. package/dist/_recording-guard.js +1 -2
  8. package/dist/_registration.js +1 -2
  9. package/dist/conflicts.d.ts +4 -7
  10. package/dist/conflicts.js +1 -2
  11. package/dist/constants.d.ts +14 -17
  12. package/dist/constants.js +8 -9
  13. package/dist/display-labels.d.ts +7 -10
  14. package/dist/display-labels.js +1 -2
  15. package/dist/format.d.ts +9 -12
  16. package/dist/format.js +9 -7
  17. package/dist/hint.d.ts +3 -6
  18. package/dist/hint.js +1 -2
  19. package/dist/hotkey-manager.d.ts +8 -10
  20. package/dist/hotkey-manager.js +21 -3
  21. package/dist/hotkey-recorder.d.ts +4 -7
  22. package/dist/hotkey-recorder.js +9 -6
  23. package/dist/hotkey-sequence-recorder.d.ts +5 -8
  24. package/dist/hotkey-sequence-recorder.js +6 -7
  25. package/dist/hotkey.types.d.ts +15 -18
  26. package/dist/key-state-tracker.d.ts +4 -7
  27. package/dist/key-state-tracker.js +6 -3
  28. package/dist/key.types.d.ts +17 -20
  29. package/dist/match.d.ts +8 -11
  30. package/dist/match.js +1 -2
  31. package/dist/parse.d.ts +11 -14
  32. package/dist/parse.js +5 -4
  33. package/dist/platform.d.ts +3 -6
  34. package/dist/platform.js +1 -2
  35. package/dist/recorder-options.d.ts +6 -9
  36. package/dist/sequence-manager.d.ts +11 -14
  37. package/dist/sequence-manager.js +12 -7
  38. package/dist/validate.d.ts +5 -8
  39. package/dist/validate.js +1 -2
  40. package/package.json +8 -13
  41. package/dist/_event-target.cjs +0 -73
  42. package/dist/_event-target.cjs.map +0 -1
  43. package/dist/_event-target.js.map +0 -1
  44. package/dist/_keyboard-event.cjs +0 -83
  45. package/dist/_keyboard-event.cjs.map +0 -1
  46. package/dist/_keyboard-event.js.map +0 -1
  47. package/dist/_match.cjs +0 -49
  48. package/dist/_match.cjs.map +0 -1
  49. package/dist/_match.js.map +0 -1
  50. package/dist/_named-keys.cjs +0 -68
  51. package/dist/_named-keys.cjs.map +0 -1
  52. package/dist/_named-keys.d.cts +0 -8
  53. package/dist/_named-keys.js.map +0 -1
  54. package/dist/_recorder-chord.cjs +0 -44
  55. package/dist/_recorder-chord.cjs.map +0 -1
  56. package/dist/_recorder-chord.js.map +0 -1
  57. package/dist/_recording-guard.cjs +0 -59
  58. package/dist/_recording-guard.cjs.map +0 -1
  59. package/dist/_recording-guard.js.map +0 -1
  60. package/dist/_registration.cjs +0 -54
  61. package/dist/_registration.cjs.map +0 -1
  62. package/dist/_registration.js.map +0 -1
  63. package/dist/conflicts.cjs +0 -55
  64. package/dist/conflicts.cjs.map +0 -1
  65. package/dist/conflicts.d.cts +0 -39
  66. package/dist/conflicts.js.map +0 -1
  67. package/dist/constants.cjs +0 -410
  68. package/dist/constants.cjs.map +0 -1
  69. package/dist/constants.d.cts +0 -165
  70. package/dist/constants.js.map +0 -1
  71. package/dist/display-labels.cjs +0 -119
  72. package/dist/display-labels.cjs.map +0 -1
  73. package/dist/display-labels.d.cts +0 -93
  74. package/dist/display-labels.js.map +0 -1
  75. package/dist/format.cjs +0 -85
  76. package/dist/format.cjs.map +0 -1
  77. package/dist/format.d.cts +0 -99
  78. package/dist/format.js.map +0 -1
  79. package/dist/hint.cjs +0 -24
  80. package/dist/hint.cjs.map +0 -1
  81. package/dist/hint.d.cts +0 -23
  82. package/dist/hint.js.map +0 -1
  83. package/dist/hotkey-manager.cjs +0 -414
  84. package/dist/hotkey-manager.cjs.map +0 -1
  85. package/dist/hotkey-manager.d.cts +0 -234
  86. package/dist/hotkey-manager.js.map +0 -1
  87. package/dist/hotkey-recorder.cjs +0 -235
  88. package/dist/hotkey-recorder.cjs.map +0 -1
  89. package/dist/hotkey-recorder.d.cts +0 -119
  90. package/dist/hotkey-recorder.js.map +0 -1
  91. package/dist/hotkey-sequence-recorder.cjs +0 -255
  92. package/dist/hotkey-sequence-recorder.cjs.map +0 -1
  93. package/dist/hotkey-sequence-recorder.d.cts +0 -86
  94. package/dist/hotkey-sequence-recorder.js.map +0 -1
  95. package/dist/hotkey.types.d.cts +0 -236
  96. package/dist/index.cjs +0 -71
  97. package/dist/index.d.cts +0 -18
  98. package/dist/key-state-tracker.cjs +0 -197
  99. package/dist/key-state-tracker.cjs.map +0 -1
  100. package/dist/key-state-tracker.d.cts +0 -107
  101. package/dist/key-state-tracker.js.map +0 -1
  102. package/dist/key.types.d.cts +0 -82
  103. package/dist/match.cjs +0 -144
  104. package/dist/match.cjs.map +0 -1
  105. package/dist/match.d.cts +0 -101
  106. package/dist/match.js.map +0 -1
  107. package/dist/parse.cjs +0 -245
  108. package/dist/parse.cjs.map +0 -1
  109. package/dist/parse.d.cts +0 -134
  110. package/dist/parse.js.map +0 -1
  111. package/dist/platform.cjs +0 -55
  112. package/dist/platform.cjs.map +0 -1
  113. package/dist/platform.d.cts +0 -44
  114. package/dist/platform.js.map +0 -1
  115. package/dist/recorder-options.d.cts +0 -34
  116. package/dist/sequence-manager.cjs +0 -441
  117. package/dist/sequence-manager.cjs.map +0 -1
  118. package/dist/sequence-manager.d.cts +0 -172
  119. package/dist/sequence-manager.js.map +0 -1
  120. package/dist/validate.cjs +0 -112
  121. package/dist/validate.cjs.map +0 -1
  122. package/dist/validate.d.cts +0 -67
  123. package/dist/validate.js.map +0 -1
  124. package/src/_event-target.ts +0 -157
  125. package/src/_keyboard-event.ts +0 -101
  126. package/src/_match.ts +0 -96
  127. package/src/_named-keys.ts +0 -62
  128. package/src/_recorder-chord.ts +0 -76
  129. package/src/_recording-guard.ts +0 -63
  130. package/src/_registration.ts +0 -79
  131. package/src/conflicts.ts +0 -125
  132. package/src/constants.ts +0 -455
  133. package/src/display-labels.ts +0 -123
  134. package/src/format.ts +0 -201
  135. package/src/hint.ts +0 -42
  136. package/src/hotkey-manager.ts +0 -814
  137. package/src/hotkey-recorder.ts +0 -348
  138. package/src/hotkey-sequence-recorder.ts +0 -410
  139. package/src/hotkey.types.ts +0 -269
  140. package/src/index.ts +0 -17
  141. package/src/key-state-tracker.ts +0 -261
  142. package/src/key.types.ts +0 -268
  143. package/src/match.ts +0 -210
  144. package/src/parse.ts +0 -369
  145. package/src/platform.ts +0 -66
  146. package/src/recorder-options.ts +0 -34
  147. package/src/sequence-manager.ts +0 -769
  148. package/src/validate.ts +0 -179
@@ -1,441 +0,0 @@
1
- const require_constants = require('./constants.cjs');
2
- const require_platform = require('./platform.cjs');
3
- const require__keyboard_event = require('./_keyboard-event.cjs');
4
- const require_parse = require('./parse.cjs');
5
- const require_format = require('./format.cjs');
6
- const require__match = require('./_match.cjs');
7
- const require_match = require('./match.cjs');
8
- const require__recording_guard = require('./_recording-guard.cjs');
9
- const require__registration = require('./_registration.cjs');
10
- const require__event_target = require('./_event-target.cjs');
11
- let _tanstack_store = require("@tanstack/store");
12
-
13
- //#region src/sequence-manager.ts
14
- /**
15
- * Default timeout between keys in a sequence (in milliseconds).
16
- * Exported for consumers that display sequence state (e.g. devtools).
17
- */
18
- const DEFAULT_SEQUENCE_TIMEOUT = 1e3;
19
- let sequenceIdCounter = 0;
20
- /**
21
- * Generates a unique ID for sequence registrations.
22
- */
23
- function generateSequenceId() {
24
- return `sequence_${++sequenceIdCounter}`;
25
- }
26
- /**
27
- * Manages keyboard sequence matching for Vim-style shortcuts.
28
- *
29
- * This class allows registering multi-key sequences like 'g g' or 'd d'
30
- * that trigger callbacks when the full sequence is pressed within
31
- * a configurable timeout.
32
- *
33
- * Modifier-only `keydown` / `keyup` events (Shift, Control, Alt, or Meta
34
- * alone) are not processed: they neither match a step nor reset progress.
35
- * That supports chained modifier chords (e.g. `Shift+R` then `Shift+T`) when
36
- * the user presses a modifier alone between steps.
37
- *
38
- * @example
39
- * ```ts
40
- * const matcher = SequenceManager.getInstance()
41
- *
42
- * // Register 'g g' to go to top
43
- * const unregister = matcher.register(['G', 'G'], (event, context) => {
44
- * scrollToTop()
45
- * }, { timeout: 500 })
46
- *
47
- * // Later, to unregister:
48
- * unregister()
49
- * ```
50
- */
51
- /**
52
- * Builds a devtools view from an internal registration.
53
- */
54
- function toRegistrationView(reg) {
55
- const len = reg.parsedSequence.length;
56
- const inProgress = reg.currentIndex > 0 && reg.currentIndex < len;
57
- return {
58
- id: reg.id,
59
- sequence: reg.sequence,
60
- options: reg.options,
61
- target: reg.target,
62
- triggerCount: reg.triggerCount,
63
- hasFired: reg.hasFired,
64
- matchedStepCount: inProgress ? reg.currentIndex : 0,
65
- partialMatchLastKeyTime: inProgress ? reg.lastKeyTime : 0
66
- };
67
- }
68
- var SequenceManager = class SequenceManager {
69
- static #instance = null;
70
- #registrations = /* @__PURE__ */ new Map();
71
- #targetListeners = /* @__PURE__ */ new Map();
72
- #targetRegistrations = /* @__PURE__ */ new Map();
73
- #platform;
74
- constructor() {
75
- this.registrations = new _tanstack_store.Store(/* @__PURE__ */ new Map());
76
- this.#platform = require_platform.detectPlatform();
77
- }
78
- /**
79
- * Gets the singleton instance of SequenceManager.
80
- */
81
- static getInstance() {
82
- if (!SequenceManager.#instance) SequenceManager.#instance = new SequenceManager();
83
- return SequenceManager.#instance;
84
- }
85
- /**
86
- * Resets the singleton instance. Useful for testing.
87
- */
88
- static resetInstance() {
89
- if (SequenceManager.#instance) {
90
- SequenceManager.#instance.destroy();
91
- SequenceManager.#instance = null;
92
- }
93
- }
94
- #syncRegistrationView(registration) {
95
- this.registrations.setState((prev) => new Map(prev).set(registration.id, toRegistrationView(registration)));
96
- }
97
- /**
98
- * Registers a hotkey sequence handler.
99
- *
100
- * @param sequence - Array of hotkey strings that form the sequence
101
- * @param callback - Function to call when the sequence is completed
102
- * @param options - Options for the sequence behavior
103
- * @returns A handle to update or unregister the sequence
104
- */
105
- register(sequence, callback, options = {}) {
106
- if (sequence.length === 0) throw new Error("Sequence must contain at least one hotkey");
107
- const id = generateSequenceId();
108
- const platform = options.platform ?? this.#platform;
109
- const parsedSequence = sequence.map((hotkey) => require_parse.parseHotkey(hotkey, platform));
110
- const target = options.target ?? (typeof document !== "undefined" ? document : {});
111
- const conflictBehavior = options.conflictBehavior ?? "warn";
112
- const conflictingRegistration = this.#findConflictingSequence(parsedSequence, target);
113
- if (conflictingRegistration) require__registration.handleConflict(conflictingRegistration.id, require_format.formatHotkeySequence(sequence), conflictBehavior, (regId) => this.#unregister(regId));
114
- const firstStep = parsedSequence[0];
115
- const resolvedIgnoreInputs = options.ignoreInputs ?? require__registration.getDefaultIgnoreInputs(firstStep);
116
- const registration = {
117
- id,
118
- sequence,
119
- parsedSequence,
120
- callback,
121
- options: {
122
- ...require__registration.defaultHotkeyOptions,
123
- timeout: DEFAULT_SEQUENCE_TIMEOUT,
124
- ...options,
125
- platform,
126
- ignoreInputs: resolvedIgnoreInputs
127
- },
128
- target,
129
- currentIndex: 0,
130
- lastKeyTime: 0,
131
- triggerCount: 0,
132
- hasFired: false
133
- };
134
- this.#registrations.set(id, registration);
135
- this.registrations.setState((prev) => new Map(prev).set(id, toRegistrationView(registration)));
136
- if (!this.#targetRegistrations.has(target)) this.#targetRegistrations.set(target, /* @__PURE__ */ new Set());
137
- this.#targetRegistrations.get(target).add(id);
138
- this.#ensureListenersForTarget(target);
139
- const manager = this;
140
- return {
141
- get id() {
142
- return id;
143
- },
144
- get isActive() {
145
- return manager.#registrations.has(id);
146
- },
147
- get callback() {
148
- return manager.#registrations.get(id)?.callback ?? callback;
149
- },
150
- set callback(newCallback) {
151
- const reg = manager.#registrations.get(id);
152
- if (reg) reg.callback = newCallback;
153
- },
154
- setOptions: (newOptions) => {
155
- const reg = manager.#registrations.get(id);
156
- if (reg && !require__registration.optionsEqual(reg.options, {
157
- ...reg.options,
158
- ...newOptions
159
- })) {
160
- reg.options = {
161
- ...reg.options,
162
- ...newOptions
163
- };
164
- manager.registrations.setState((prev) => new Map(prev).set(id, toRegistrationView(reg)));
165
- }
166
- },
167
- unregister: () => {
168
- manager.#unregister(id);
169
- }
170
- };
171
- }
172
- /**
173
- * Unregisters a sequence by its registration ID.
174
- */
175
- #unregister(id) {
176
- const registration = this.#registrations.get(id);
177
- if (!registration) return;
178
- const target = registration.target;
179
- this.#registrations.delete(id);
180
- this.registrations.setState((prev) => {
181
- const next = new Map(prev);
182
- next.delete(id);
183
- return next;
184
- });
185
- const targetRegs = this.#targetRegistrations.get(target);
186
- if (targetRegs) {
187
- targetRegs.delete(id);
188
- if (targetRegs.size === 0) this.#removeListenersForTarget(target);
189
- }
190
- }
191
- /**
192
- * Ensures event listeners are attached for a specific target.
193
- */
194
- #ensureListenersForTarget(target) {
195
- if (typeof document === "undefined") return;
196
- if (this.#targetListeners.has(target)) return;
197
- const keydownHandler = this.#createTargetKeyDownHandler(target);
198
- const keyupHandler = this.#createTargetKeyUpHandler(target);
199
- target.addEventListener("keydown", keydownHandler);
200
- target.addEventListener("keyup", keyupHandler);
201
- this.#targetListeners.set(target, {
202
- keydown: keydownHandler,
203
- keyup: keyupHandler
204
- });
205
- }
206
- /**
207
- * Removes event listeners for a specific target.
208
- */
209
- #removeListenersForTarget(target) {
210
- if (typeof document === "undefined") return;
211
- const listeners = this.#targetListeners.get(target);
212
- if (!listeners) return;
213
- target.removeEventListener("keydown", listeners.keydown);
214
- target.removeEventListener("keyup", listeners.keyup);
215
- this.#targetListeners.delete(target);
216
- this.#targetRegistrations.delete(target);
217
- }
218
- /**
219
- * Creates a keydown handler for a specific target.
220
- */
221
- #createTargetKeyDownHandler(target) {
222
- return (event) => {
223
- this.#processTargetEvent(event, target, "keydown");
224
- };
225
- }
226
- /**
227
- * Creates a keyup handler for a specific target.
228
- */
229
- #createTargetKeyUpHandler(target) {
230
- return (event) => {
231
- this.#processTargetEvent(event, target, "keyup");
232
- };
233
- }
234
- /**
235
- * Processes keyboard events for a specific target and event type.
236
- */
237
- #processTargetEvent(event, target, eventType) {
238
- if (require__recording_guard.isRecordingEvent(event)) {
239
- for (const id of this.#targetRegistrations.get(target) ?? []) {
240
- const registration = this.#registrations.get(id);
241
- if (registration && registration.currentIndex > 0) {
242
- registration.currentIndex = 0;
243
- this.#syncRegistrationView(registration);
244
- }
245
- }
246
- return;
247
- }
248
- if (event.type === "keydown" && event.repeat || require__keyboard_event.normalizeKeyboardEvent(event).isComposing) return;
249
- if (require_parse.isModifierKey(require_constants.normalizeKeyName(event.key))) return;
250
- const targetRegs = this.#targetRegistrations.get(target);
251
- if (!targetRegs) return;
252
- const now = Date.now();
253
- const candidates = /* @__PURE__ */ new Map();
254
- let bestScore = 0;
255
- registrationIds: for (const id of targetRegs) {
256
- const registration = this.#registrations.get(id);
257
- if (!registration) continue;
258
- if (!require__event_target.isEventForTarget(event, target)) continue;
259
- if (!registration.options.enabled) continue;
260
- if (registration.options.ignoreInputs !== false) {
261
- if (require__event_target.shouldIgnoreInputEvent(event, target, registration.target)) continue registrationIds;
262
- }
263
- if (registration.options.eventType !== eventType) continue;
264
- const timeout = registration.options.timeout ?? 1e3;
265
- if (registration.currentIndex > 0 && now - registration.lastKeyTime > timeout) {
266
- registration.currentIndex = 0;
267
- this.#syncRegistrationView(registration);
268
- }
269
- const expectedHotkey = registration.parsedSequence[registration.currentIndex];
270
- if (!expectedHotkey) continue;
271
- let match = require__match.matchKeyboardEvent(event, expectedHotkey, registration.options.platform);
272
- let nextIndex = registration.currentIndex + 1;
273
- if (!match.matched && registration.currentIndex > 0) {
274
- match = require__match.matchKeyboardEvent(event, registration.parsedSequence[0], registration.options.platform);
275
- nextIndex = 1;
276
- }
277
- candidates.set(id, {
278
- score: match.score,
279
- nextIndex
280
- });
281
- bestScore = Math.max(bestScore, match.score);
282
- }
283
- for (const [id, candidate] of candidates) {
284
- const registration = this.#registrations.get(id);
285
- if (!registration || !registration.options.enabled) continue;
286
- if (candidate.score > 0 && candidate.score === bestScore) {
287
- registration.lastKeyTime = now;
288
- registration.currentIndex = candidate.nextIndex;
289
- if (registration.currentIndex >= registration.parsedSequence.length) {
290
- if (registration.options.preventDefault) event.preventDefault();
291
- if (registration.options.stopPropagation) event.stopPropagation();
292
- const context = {
293
- hotkey: registration.sequence.join(" "),
294
- parsedHotkey: registration.parsedSequence[registration.parsedSequence.length - 1]
295
- };
296
- registration.triggerCount++;
297
- registration.hasFired = true;
298
- registration.currentIndex = 0;
299
- this.#syncRegistrationView(registration);
300
- registration.callback(event, context);
301
- } else this.#syncRegistrationView(registration);
302
- } else if (registration.currentIndex > 0) {
303
- registration.currentIndex = 0;
304
- this.#syncRegistrationView(registration);
305
- }
306
- }
307
- }
308
- /**
309
- * Compares resolved step identities without changing the supplied sequence strings.
310
- */
311
- #findConflictingSequence(parsedSequence, target) {
312
- for (const registration of this.#registrations.values()) if (registration.target === target && registration.parsedSequence.length === parsedSequence.length && parsedSequence.every((step, index) => require_match.areHotkeysEqual(step, registration.parsedSequence[index]))) return registration;
313
- return null;
314
- }
315
- /**
316
- * Resets all sequence progress.
317
- */
318
- resetAll() {
319
- for (const registration of this.#registrations.values()) {
320
- registration.currentIndex = 0;
321
- registration.lastKeyTime = 0;
322
- this.#syncRegistrationView(registration);
323
- }
324
- }
325
- /**
326
- * Triggers a sequence's callback programmatically from devtools.
327
- * Creates a synthetic KeyboardEvent from the last key in the sequence.
328
- *
329
- * @param id - The registration ID to trigger
330
- * @returns True if the registration was found and triggered
331
- */
332
- triggerSequence(id) {
333
- const registration = this.#registrations.get(id);
334
- if (!registration) return false;
335
- const lastParsed = registration.parsedSequence[registration.parsedSequence.length - 1];
336
- if (!lastParsed) return false;
337
- const syntheticEvent = new KeyboardEvent(registration.options.eventType ?? "keydown", {
338
- ...lastParsed.code !== void 0 ? { code: lastParsed.code } : { key: lastParsed.key },
339
- ctrlKey: lastParsed.ctrl,
340
- shiftKey: lastParsed.shift,
341
- altKey: lastParsed.alt,
342
- metaKey: lastParsed.meta,
343
- bubbles: true,
344
- cancelable: true
345
- });
346
- registration.triggerCount++;
347
- registration.hasFired = true;
348
- this.#syncRegistrationView(registration);
349
- const context = {
350
- hotkey: registration.sequence.join(" "),
351
- parsedHotkey: lastParsed
352
- };
353
- registration.callback(syntheticEvent, context);
354
- return true;
355
- }
356
- /**
357
- * Gets the number of registered sequences.
358
- */
359
- getRegistrationCount() {
360
- return this.#registrations.size;
361
- }
362
- /**
363
- * Destroys the manager and removes all listeners.
364
- */
365
- destroy() {
366
- for (const target of this.#targetListeners.keys()) this.#removeListenersForTarget(target);
367
- this.#registrations.clear();
368
- this.registrations.setState(() => /* @__PURE__ */ new Map());
369
- }
370
- };
371
- /**
372
- * Gets the singleton SequenceManager instance.
373
- * Convenience function for accessing the manager.
374
- */
375
- function getSequenceManager() {
376
- return SequenceManager.getInstance();
377
- }
378
- /**
379
- * Creates a simple sequence matcher for one-off use.
380
- *
381
- * This is a low-level helper that does not support ignoreInputs, target,
382
- * or other HotkeyOptions. Callers must handle input filtering themselves
383
- * if attaching to document.
384
- *
385
- * @param sequence - The sequence of hotkeys to match
386
- * @param options - Options including timeout
387
- * @returns An object with match() and reset() methods
388
- *
389
- * @example
390
- * ```ts
391
- * const matcher = createSequenceMatcher(['G', 'G'], { timeout: 500 })
392
- *
393
- * document.addEventListener('keydown', (event) => {
394
- * if (matcher.match(event)) {
395
- * console.log('Sequence matched!')
396
- * }
397
- * })
398
- * ```
399
- */
400
- function createSequenceMatcher(sequence, options = {}) {
401
- const platform = options.platform ?? require_platform.detectPlatform();
402
- const timeout = options.timeout ?? 1e3;
403
- const parsedSequence = sequence.map((hotkey) => require_parse.parseHotkey(hotkey, platform));
404
- let currentIndex = 0;
405
- let lastKeyTime = 0;
406
- return {
407
- match(event) {
408
- if (event.type === "keydown" && event.repeat || require__keyboard_event.normalizeKeyboardEvent(event, platform).isComposing || require_parse.isModifierKey(require_constants.normalizeKeyName(event.key))) return false;
409
- const now = Date.now();
410
- if (currentIndex > 0 && now - lastKeyTime > timeout) currentIndex = 0;
411
- const expected = parsedSequence[currentIndex];
412
- if (!expected) return false;
413
- if (require_match.matchesKeyboardEvent(event, expected, platform)) {
414
- lastKeyTime = now;
415
- currentIndex++;
416
- if (currentIndex >= parsedSequence.length) {
417
- currentIndex = 0;
418
- return true;
419
- }
420
- } else if (currentIndex > 0) if (require_match.matchesKeyboardEvent(event, parsedSequence[0], platform)) {
421
- currentIndex = 1;
422
- lastKeyTime = now;
423
- } else currentIndex = 0;
424
- return false;
425
- },
426
- reset() {
427
- currentIndex = 0;
428
- lastKeyTime = 0;
429
- },
430
- getProgress() {
431
- return currentIndex;
432
- }
433
- };
434
- }
435
-
436
- //#endregion
437
- exports.DEFAULT_SEQUENCE_TIMEOUT = DEFAULT_SEQUENCE_TIMEOUT;
438
- exports.SequenceManager = SequenceManager;
439
- exports.createSequenceMatcher = createSequenceMatcher;
440
- exports.getSequenceManager = getSequenceManager;
441
- //# sourceMappingURL=sequence-manager.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"sequence-manager.cjs","names":["#instance","Store","#platform","detectPlatform","parseHotkey","#findConflictingSequence","formatHotkeySequence","#unregister","getDefaultIgnoreInputs","defaultHotkeyOptions","#registrations","#targetRegistrations","#ensureListenersForTarget","optionsEqual","#removeListenersForTarget","#targetListeners","#createTargetKeyDownHandler","#createTargetKeyUpHandler","#processTargetEvent","isRecordingEvent","#syncRegistrationView","normalizeKeyboardEvent","isModifierKey","normalizeKeyName","isEventForTarget","shouldIgnoreInputEvent","matchKeyboardEvent","areHotkeysEqual","matchesKeyboardEvent"],"sources":["../src/sequence-manager.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { isRecordingEvent } from './_recording-guard'\nimport { formatHotkeySequence } from './format'\nimport { detectPlatform } from './platform'\nimport { normalizeKeyName } from './constants'\nimport { isModifierKey, parseHotkey } from './parse'\nimport { areHotkeysEqual, matchesKeyboardEvent } from './match'\nimport { matchKeyboardEvent } from './_match'\nimport { normalizeKeyboardEvent } from './_keyboard-event'\nimport {\n defaultHotkeyOptions,\n getDefaultIgnoreInputs,\n handleConflict,\n optionsEqual,\n} from './_registration'\nimport { isEventForTarget, shouldIgnoreInputEvent } from './_event-target'\nimport type { HotkeyOptions } from './hotkey-manager'\nimport type {\n Hotkey,\n HotkeyCallback,\n HotkeyCallbackContext,\n ParsedHotkey,\n} from './hotkey.types'\n\nexport type Target = HTMLElement | Document | Window\n\n/**\n * Options for hotkey sequence matching.\n * Extends HotkeyOptions but excludes requireReset (not applicable to sequences).\n */\nexport interface SequenceOptions extends Omit<HotkeyOptions, 'requireReset'> {\n /** Timeout between keys in milliseconds. Default: 1000 */\n timeout?: number\n}\n\n/**\n * A sequence of hotkeys for Vim-style shortcuts.\n *\n * Each element is one step (a `Hotkey` string). Steps may include modifiers;\n * the same modifier can appear on consecutive steps (e.g. `Shift+R` then\n * `Shift+T`). Modifier-only key events do not advance or reset matching—see\n * `SequenceManager`. Automatic keydown repeats and IME composition are also ignored.\n *\n * @example\n * ```ts\n * const gotoTop: HotkeySequence = ['G', 'G'] // gg\n * const deleteLine: HotkeySequence = ['D', 'D'] // dd\n * const deleteWord: HotkeySequence = ['D', 'I', 'W'] // diw\n * const chainedShift: HotkeySequence = ['Shift+R', 'Shift+T']\n * ```\n */\nexport type HotkeySequence = Array<Hotkey>\n\n/**\n * Default timeout between keys in a sequence (in milliseconds).\n * Exported for consumers that display sequence state (e.g. devtools).\n */\nexport const DEFAULT_SEQUENCE_TIMEOUT = 1000\n\nlet sequenceIdCounter = 0\n\n/**\n * Generates a unique ID for sequence registrations.\n */\nfunction generateSequenceId(): string {\n return `sequence_${++sequenceIdCounter}`\n}\n\n/**\n * View of a sequence registration for devtools display.\n * Progress fields reflect an in-progress match (between first key and completion or timeout).\n */\nexport interface SequenceRegistrationView {\n id: string\n sequence: HotkeySequence\n options: SequenceOptions\n target: Target\n triggerCount: number\n /** Whether this sequence has been triggered at least once. */\n hasFired: boolean\n /** Steps matched in the current attempt (0 when idle or just completed). */\n matchedStepCount: number\n /** `Date.now()` when the last step in the current attempt matched; 0 if none. */\n partialMatchLastKeyTime: number\n}\n\n/**\n * Internal representation of a sequence registration.\n */\nexport interface SequenceRegistration {\n id: string\n sequence: HotkeySequence\n parsedSequence: Array<ParsedHotkey>\n callback: HotkeyCallback\n options: SequenceOptions\n target: Target\n currentIndex: number\n lastKeyTime: number\n triggerCount: number\n hasFired: boolean\n}\n\n/**\n * A handle returned from SequenceManager.register() that allows updating\n * the callback and options without re-registering the sequence.\n *\n * @example\n * ```ts\n * const handle = manager.register(['G', 'G'], callback, options)\n *\n * handle.callback = newCallback\n * handle.setOptions({ timeout: 500 })\n * handle.unregister()\n * ```\n */\nexport interface SequenceRegistrationHandle {\n readonly id: string\n readonly isActive: boolean\n callback: HotkeyCallback\n setOptions: (options: Partial<SequenceOptions>) => void\n unregister: () => void\n}\n\n/**\n * Manages keyboard sequence matching for Vim-style shortcuts.\n *\n * This class allows registering multi-key sequences like 'g g' or 'd d'\n * that trigger callbacks when the full sequence is pressed within\n * a configurable timeout.\n *\n * Modifier-only `keydown` / `keyup` events (Shift, Control, Alt, or Meta\n * alone) are not processed: they neither match a step nor reset progress.\n * That supports chained modifier chords (e.g. `Shift+R` then `Shift+T`) when\n * the user presses a modifier alone between steps.\n *\n * @example\n * ```ts\n * const matcher = SequenceManager.getInstance()\n *\n * // Register 'g g' to go to top\n * const unregister = matcher.register(['G', 'G'], (event, context) => {\n * scrollToTop()\n * }, { timeout: 500 })\n *\n * // Later, to unregister:\n * unregister()\n * ```\n */\n/**\n * Builds a devtools view from an internal registration.\n */\nfunction toRegistrationView(\n reg: SequenceRegistration,\n): SequenceRegistrationView {\n const len = reg.parsedSequence.length\n const inProgress = reg.currentIndex > 0 && reg.currentIndex < len\n return {\n id: reg.id,\n sequence: reg.sequence,\n options: reg.options,\n target: reg.target,\n triggerCount: reg.triggerCount,\n hasFired: reg.hasFired,\n matchedStepCount: inProgress ? reg.currentIndex : 0,\n partialMatchLastKeyTime: inProgress ? reg.lastKeyTime : 0,\n }\n}\n\nexport class SequenceManager {\n static #instance: SequenceManager | null = null\n\n /**\n * The TanStack Store containing sequence registration views for devtools.\n * Subscribe to this to observe registration changes.\n */\n readonly registrations: Store<Map<string, SequenceRegistrationView>> =\n new Store(new Map())\n\n #registrations: Map<string, SequenceRegistration> = new Map()\n #targetListeners: Map<\n Target,\n {\n keydown: (event: KeyboardEvent) => void\n keyup: (event: KeyboardEvent) => void\n }\n > = new Map()\n #targetRegistrations: Map<Target, Set<string>> = new Map()\n #platform: 'mac' | 'windows' | 'linux'\n\n private constructor() {\n this.#platform = detectPlatform()\n }\n\n /**\n * Gets the singleton instance of SequenceManager.\n */\n static getInstance(): SequenceManager {\n if (!SequenceManager.#instance) {\n SequenceManager.#instance = new SequenceManager()\n }\n return SequenceManager.#instance\n }\n\n /**\n * Resets the singleton instance. Useful for testing.\n */\n static resetInstance(): void {\n if (SequenceManager.#instance) {\n SequenceManager.#instance.destroy()\n SequenceManager.#instance = null\n }\n }\n\n #syncRegistrationView(registration: SequenceRegistration): void {\n this.registrations.setState((prev) =>\n new Map(prev).set(registration.id, toRegistrationView(registration)),\n )\n }\n\n /**\n * Registers a hotkey sequence handler.\n *\n * @param sequence - Array of hotkey strings that form the sequence\n * @param callback - Function to call when the sequence is completed\n * @param options - Options for the sequence behavior\n * @returns A handle to update or unregister the sequence\n */\n register(\n sequence: HotkeySequence,\n callback: HotkeyCallback,\n options: SequenceOptions = {},\n ): SequenceRegistrationHandle {\n if (sequence.length === 0) {\n throw new Error('Sequence must contain at least one hotkey')\n }\n\n const id = generateSequenceId()\n const platform = options.platform ?? this.#platform\n const parsedSequence = sequence.map((hotkey) =>\n parseHotkey(hotkey, platform),\n )\n\n // Resolve target: default to document if not provided or null\n const target: Target =\n options.target ??\n (typeof document !== 'undefined' ? document : ({} as Document))\n\n // Resolve conflict behavior\n const conflictBehavior = options.conflictBehavior ?? 'warn'\n\n // Check for existing registrations with the same sequence and target\n const conflictingRegistration = this.#findConflictingSequence(\n parsedSequence,\n target,\n )\n\n if (conflictingRegistration) {\n handleConflict(\n conflictingRegistration.id,\n formatHotkeySequence(sequence),\n conflictBehavior,\n (regId) => this.#unregister(regId),\n )\n }\n\n const firstStep = parsedSequence[0]!\n const resolvedIgnoreInputs =\n options.ignoreInputs ?? getDefaultIgnoreInputs(firstStep)\n\n const baseOptions = {\n ...defaultHotkeyOptions,\n timeout: DEFAULT_SEQUENCE_TIMEOUT,\n ...options,\n platform,\n ignoreInputs: resolvedIgnoreInputs,\n }\n\n const registration: SequenceRegistration = {\n id,\n sequence,\n parsedSequence,\n callback,\n options: baseOptions,\n target,\n currentIndex: 0,\n lastKeyTime: 0,\n triggerCount: 0,\n hasFired: false,\n }\n\n this.#registrations.set(id, registration)\n this.registrations.setState((prev) =>\n new Map(prev).set(id, toRegistrationView(registration)),\n )\n\n // Track registration for this target\n if (!this.#targetRegistrations.has(target)) {\n this.#targetRegistrations.set(target, new Set())\n }\n this.#targetRegistrations.get(target)!.add(id)\n\n // Ensure listeners are attached for this target\n this.#ensureListenersForTarget(target)\n\n const manager = this\n const handle: SequenceRegistrationHandle = {\n get id() {\n return id\n },\n get isActive() {\n return manager.#registrations.has(id)\n },\n get callback() {\n const reg = manager.#registrations.get(id)\n return reg?.callback ?? callback\n },\n set callback(newCallback: HotkeyCallback) {\n const reg = manager.#registrations.get(id)\n if (reg) {\n reg.callback = newCallback\n }\n },\n setOptions: (newOptions: Partial<SequenceOptions>) => {\n const reg = manager.#registrations.get(id)\n if (\n reg &&\n !optionsEqual(reg.options, { ...reg.options, ...newOptions })\n ) {\n reg.options = { ...reg.options, ...newOptions }\n manager.registrations.setState((prev) =>\n new Map(prev).set(id, toRegistrationView(reg)),\n )\n }\n },\n unregister: () => {\n manager.#unregister(id)\n },\n }\n\n return handle\n }\n\n /**\n * Unregisters a sequence by its registration ID.\n */\n #unregister(id: string): void {\n const registration = this.#registrations.get(id)\n if (!registration) {\n return\n }\n\n const target = registration.target\n\n this.#registrations.delete(id)\n this.registrations.setState((prev) => {\n const next = new Map(prev)\n next.delete(id)\n return next\n })\n\n // Remove from target registrations tracking\n const targetRegs = this.#targetRegistrations.get(target)\n if (targetRegs) {\n targetRegs.delete(id)\n if (targetRegs.size === 0) {\n this.#removeListenersForTarget(target)\n }\n }\n }\n\n /**\n * Ensures event listeners are attached for a specific target.\n */\n #ensureListenersForTarget(target: Target): void {\n if (typeof document === 'undefined') {\n return // SSR safety\n }\n\n if (this.#targetListeners.has(target)) {\n return\n }\n\n const keydownHandler = this.#createTargetKeyDownHandler(target)\n const keyupHandler = this.#createTargetKeyUpHandler(target)\n\n target.addEventListener('keydown', keydownHandler as EventListener)\n target.addEventListener('keyup', keyupHandler as EventListener)\n\n this.#targetListeners.set(target, {\n keydown: keydownHandler,\n keyup: keyupHandler,\n })\n }\n\n /**\n * Removes event listeners for a specific target.\n */\n #removeListenersForTarget(target: Target): void {\n if (typeof document === 'undefined') {\n return\n }\n\n const listeners = this.#targetListeners.get(target)\n if (!listeners) {\n return\n }\n\n target.removeEventListener('keydown', listeners.keydown as EventListener)\n target.removeEventListener('keyup', listeners.keyup as EventListener)\n\n this.#targetListeners.delete(target)\n this.#targetRegistrations.delete(target)\n }\n\n /**\n * Creates a keydown handler for a specific target.\n */\n #createTargetKeyDownHandler(target: Target): (event: KeyboardEvent) => void {\n return (event: KeyboardEvent) => {\n this.#processTargetEvent(event, target, 'keydown')\n }\n }\n\n /**\n * Creates a keyup handler for a specific target.\n */\n #createTargetKeyUpHandler(target: Target): (event: KeyboardEvent) => void {\n return (event: KeyboardEvent) => {\n this.#processTargetEvent(event, target, 'keyup')\n }\n }\n\n /**\n * Processes keyboard events for a specific target and event type.\n */\n #processTargetEvent(\n event: KeyboardEvent,\n target: Target,\n eventType: 'keydown' | 'keyup',\n ): void {\n if (isRecordingEvent(event)) {\n for (const id of this.#targetRegistrations.get(target) ?? []) {\n const registration = this.#registrations.get(id)\n if (registration && registration.currentIndex > 0) {\n registration.currentIndex = 0\n this.#syncRegistrationView(registration)\n }\n }\n return\n }\n if (\n (event.type === 'keydown' && event.repeat) ||\n normalizeKeyboardEvent(event).isComposing\n ) {\n return\n }\n // Skip modifier-only events so pressing e.g. Shift before Shift+C does not reset the sequence.\n if (isModifierKey(normalizeKeyName(event.key))) {\n return\n }\n\n const targetRegs = this.#targetRegistrations.get(target)\n if (!targetRegs) {\n return\n }\n\n const now = Date.now()\n // Score eligible next steps (or restarts) before advancing any sequence.\n const candidates = new Map<string, { score: number; nextIndex: number }>()\n let bestScore = 0\n\n registrationIds: for (const id of targetRegs) {\n const registration = this.#registrations.get(id)\n if (!registration) {\n continue\n }\n\n if (!isEventForTarget(event, target)) {\n continue\n }\n\n if (!registration.options.enabled) {\n continue\n }\n\n // Check if we should ignore input elements (defaults to true)\n if (registration.options.ignoreInputs !== false) {\n if (shouldIgnoreInputEvent(event, target, registration.target)) {\n continue registrationIds\n }\n }\n\n // Only process registrations that listen for this event type\n if (registration.options.eventType !== eventType) {\n continue\n }\n\n const timeout = registration.options.timeout ?? DEFAULT_SEQUENCE_TIMEOUT\n\n // Check if sequence has timed out\n if (\n registration.currentIndex > 0 &&\n now - registration.lastKeyTime > timeout\n ) {\n registration.currentIndex = 0\n this.#syncRegistrationView(registration)\n }\n\n const expectedHotkey =\n registration.parsedSequence[registration.currentIndex]\n if (!expectedHotkey) {\n continue\n }\n\n let match = matchKeyboardEvent(\n event,\n expectedHotkey,\n registration.options.platform,\n )\n let nextIndex = registration.currentIndex + 1\n if (!match.matched && registration.currentIndex > 0) {\n match = matchKeyboardEvent(\n event,\n registration.parsedSequence[0]!,\n registration.options.platform,\n )\n nextIndex = 1\n }\n candidates.set(id, { score: match.score, nextIndex })\n bestScore = Math.max(bestScore, match.score)\n }\n\n for (const [id, candidate] of candidates) {\n const registration = this.#registrations.get(id)\n if (!registration || !registration.options.enabled) continue\n if (candidate.score > 0 && candidate.score === bestScore) {\n registration.lastKeyTime = now\n registration.currentIndex = candidate.nextIndex\n\n if (registration.currentIndex >= registration.parsedSequence.length) {\n if (registration.options.preventDefault) {\n event.preventDefault()\n }\n if (registration.options.stopPropagation) {\n event.stopPropagation()\n }\n\n const context: HotkeyCallbackContext = {\n hotkey: registration.sequence.join(' ') as Hotkey,\n parsedHotkey:\n registration.parsedSequence[\n registration.parsedSequence.length - 1\n ]!,\n }\n\n registration.triggerCount++\n registration.hasFired = true\n registration.currentIndex = 0\n\n this.#syncRegistrationView(registration)\n\n registration.callback(event, context)\n } else {\n this.#syncRegistrationView(registration)\n }\n } else if (registration.currentIndex > 0) {\n // A mismatched or weaker candidate cannot carry stale progress forward.\n registration.currentIndex = 0\n this.#syncRegistrationView(registration)\n }\n }\n }\n\n /**\n * Compares resolved step identities without changing the supplied sequence strings.\n */\n #findConflictingSequence(\n parsedSequence: Array<ParsedHotkey>,\n target: Target,\n ): SequenceRegistration | null {\n for (const registration of this.#registrations.values()) {\n if (\n registration.target === target &&\n registration.parsedSequence.length === parsedSequence.length &&\n parsedSequence.every((step, index) =>\n areHotkeysEqual(step, registration.parsedSequence[index]!),\n )\n ) {\n return registration\n }\n }\n return null\n }\n\n /**\n * Resets all sequence progress.\n */\n resetAll(): void {\n for (const registration of this.#registrations.values()) {\n registration.currentIndex = 0\n registration.lastKeyTime = 0\n this.#syncRegistrationView(registration)\n }\n }\n\n /**\n * Triggers a sequence's callback programmatically from devtools.\n * Creates a synthetic KeyboardEvent from the last key in the sequence.\n *\n * @param id - The registration ID to trigger\n * @returns True if the registration was found and triggered\n */\n triggerSequence(id: string): boolean {\n const registration = this.#registrations.get(id)\n if (!registration) {\n return false\n }\n\n const lastParsed =\n registration.parsedSequence[registration.parsedSequence.length - 1]\n if (!lastParsed) {\n return false\n }\n\n const syntheticEvent = new KeyboardEvent(\n registration.options.eventType ?? 'keydown',\n {\n ...(lastParsed.code !== undefined\n ? { code: lastParsed.code }\n : { key: lastParsed.key }),\n ctrlKey: lastParsed.ctrl,\n shiftKey: lastParsed.shift,\n altKey: lastParsed.alt,\n metaKey: lastParsed.meta,\n bubbles: true,\n cancelable: true,\n },\n )\n\n registration.triggerCount++\n registration.hasFired = true\n\n this.#syncRegistrationView(registration)\n\n const context: HotkeyCallbackContext = {\n hotkey: registration.sequence.join(' ') as Hotkey,\n parsedHotkey: lastParsed,\n }\n\n registration.callback(syntheticEvent, context)\n\n return true\n }\n\n /**\n * Gets the number of registered sequences.\n */\n getRegistrationCount(): number {\n return this.#registrations.size\n }\n\n /**\n * Destroys the manager and removes all listeners.\n */\n destroy(): void {\n for (const target of this.#targetListeners.keys()) {\n this.#removeListenersForTarget(target)\n }\n this.#registrations.clear()\n this.registrations.setState(() => new Map())\n }\n}\n\n/**\n * Gets the singleton SequenceManager instance.\n * Convenience function for accessing the manager.\n */\nexport function getSequenceManager(): SequenceManager {\n return SequenceManager.getInstance()\n}\n\n/**\n * Creates a simple sequence matcher for one-off use.\n *\n * This is a low-level helper that does not support ignoreInputs, target,\n * or other HotkeyOptions. Callers must handle input filtering themselves\n * if attaching to document.\n *\n * @param sequence - The sequence of hotkeys to match\n * @param options - Options including timeout\n * @returns An object with match() and reset() methods\n *\n * @example\n * ```ts\n * const matcher = createSequenceMatcher(['G', 'G'], { timeout: 500 })\n *\n * document.addEventListener('keydown', (event) => {\n * if (matcher.match(event)) {\n * console.log('Sequence matched!')\n * }\n * })\n * ```\n */\nexport function createSequenceMatcher(\n sequence: HotkeySequence,\n options: { timeout?: number; platform?: 'mac' | 'windows' | 'linux' } = {},\n): {\n match: (event: KeyboardEvent) => boolean\n reset: () => void\n getProgress: () => number\n} {\n const platform = options.platform ?? detectPlatform()\n const timeout = options.timeout ?? DEFAULT_SEQUENCE_TIMEOUT\n const parsedSequence = sequence.map((hotkey) => parseHotkey(hotkey, platform))\n\n let currentIndex = 0\n let lastKeyTime = 0\n\n return {\n match(event: KeyboardEvent): boolean {\n // These events are not sequence steps and must not refresh the timeout.\n if (\n (event.type === 'keydown' && event.repeat) ||\n normalizeKeyboardEvent(event, platform).isComposing ||\n isModifierKey(normalizeKeyName(event.key))\n ) {\n return false\n }\n const now = Date.now()\n\n if (currentIndex > 0 && now - lastKeyTime > timeout) {\n currentIndex = 0\n }\n\n const expected = parsedSequence[currentIndex]\n if (!expected) {\n return false\n }\n\n if (matchesKeyboardEvent(event, expected, platform)) {\n lastKeyTime = now\n currentIndex++\n\n if (currentIndex >= parsedSequence.length) {\n currentIndex = 0\n return true\n }\n } else if (currentIndex > 0) {\n if (matchesKeyboardEvent(event, parsedSequence[0]!, platform)) {\n currentIndex = 1\n lastKeyTime = now\n } else {\n currentIndex = 0\n }\n }\n\n return false\n },\n\n reset(): void {\n currentIndex = 0\n lastKeyTime = 0\n },\n\n getProgress(): number {\n return currentIndex\n },\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAyDA,MAAa,2BAA2B;AAExC,IAAI,oBAAoB;;;;AAKxB,SAAS,qBAA6B;AACpC,QAAO,YAAY,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsFvB,SAAS,mBACP,KAC0B;CAC1B,MAAM,MAAM,IAAI,eAAe;CAC/B,MAAM,aAAa,IAAI,eAAe,KAAK,IAAI,eAAe;AAC9D,QAAO;EACL,IAAI,IAAI;EACR,UAAU,IAAI;EACd,SAAS,IAAI;EACb,QAAQ,IAAI;EACZ,cAAc,IAAI;EAClB,UAAU,IAAI;EACd,kBAAkB,aAAa,IAAI,eAAe;EAClD,yBAAyB,aAAa,IAAI,cAAc;EACzD;;AAGH,IAAa,kBAAb,MAAa,gBAAgB;CAC3B,QAAOA,WAAoC;CAS3C,iCAAoD,IAAI,KAAK;CAC7D,mCAMI,IAAI,KAAK;CACb,uCAAiD,IAAI,KAAK;CAC1D;CAEA,AAAQ,cAAc;uBAbpB,IAAIC,sCAAM,IAAI,KAAK,CAAC;AAcpB,QAAKC,WAAYC,iCAAgB;;;;;CAMnC,OAAO,cAA+B;AACpC,MAAI,CAAC,iBAAgBH,SACnB,kBAAgBA,WAAY,IAAI,iBAAiB;AAEnD,SAAO,iBAAgBA;;;;;CAMzB,OAAO,gBAAsB;AAC3B,MAAI,iBAAgBA,UAAW;AAC7B,oBAAgBA,SAAU,SAAS;AACnC,oBAAgBA,WAAY;;;CAIhC,sBAAsB,cAA0C;AAC9D,OAAK,cAAc,UAAU,SAC3B,IAAI,IAAI,KAAK,CAAC,IAAI,aAAa,IAAI,mBAAmB,aAAa,CAAC,CACrE;;;;;;;;;;CAWH,SACE,UACA,UACA,UAA2B,EAAE,EACD;AAC5B,MAAI,SAAS,WAAW,EACtB,OAAM,IAAI,MAAM,4CAA4C;EAG9D,MAAM,KAAK,oBAAoB;EAC/B,MAAM,WAAW,QAAQ,YAAY,MAAKE;EAC1C,MAAM,iBAAiB,SAAS,KAAK,WACnCE,0BAAY,QAAQ,SAAS,CAC9B;EAGD,MAAM,SACJ,QAAQ,WACP,OAAO,aAAa,cAAc,WAAY,EAAE;EAGnD,MAAM,mBAAmB,QAAQ,oBAAoB;EAGrD,MAAM,0BAA0B,MAAKC,wBACnC,gBACA,OACD;AAED,MAAI,wBACF,sCACE,wBAAwB,IACxBC,oCAAqB,SAAS,EAC9B,mBACC,UAAU,MAAKC,WAAY,MAAM,CACnC;EAGH,MAAM,YAAY,eAAe;EACjC,MAAM,uBACJ,QAAQ,gBAAgBC,6CAAuB,UAAU;EAU3D,MAAM,eAAqC;GACzC;GACA;GACA;GACA;GACA,SAbkB;IAClB,GAAGC;IACH,SAAS;IACT,GAAG;IACH;IACA,cAAc;IACf;GAQC;GACA,cAAc;GACd,aAAa;GACb,cAAc;GACd,UAAU;GACX;AAED,QAAKC,cAAe,IAAI,IAAI,aAAa;AACzC,OAAK,cAAc,UAAU,SAC3B,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,mBAAmB,aAAa,CAAC,CACxD;AAGD,MAAI,CAAC,MAAKC,oBAAqB,IAAI,OAAO,CACxC,OAAKA,oBAAqB,IAAI,wBAAQ,IAAI,KAAK,CAAC;AAElD,QAAKA,oBAAqB,IAAI,OAAO,CAAE,IAAI,GAAG;AAG9C,QAAKC,yBAA0B,OAAO;EAEtC,MAAM,UAAU;AAmChB,SAlC2C;GACzC,IAAI,KAAK;AACP,WAAO;;GAET,IAAI,WAAW;AACb,WAAO,SAAQF,cAAe,IAAI,GAAG;;GAEvC,IAAI,WAAW;AAEb,WADY,SAAQA,cAAe,IAAI,GAAG,EAC9B,YAAY;;GAE1B,IAAI,SAAS,aAA6B;IACxC,MAAM,MAAM,SAAQA,cAAe,IAAI,GAAG;AAC1C,QAAI,IACF,KAAI,WAAW;;GAGnB,aAAa,eAAyC;IACpD,MAAM,MAAM,SAAQA,cAAe,IAAI,GAAG;AAC1C,QACE,OACA,CAACG,mCAAa,IAAI,SAAS;KAAE,GAAG,IAAI;KAAS,GAAG;KAAY,CAAC,EAC7D;AACA,SAAI,UAAU;MAAE,GAAG,IAAI;MAAS,GAAG;MAAY;AAC/C,aAAQ,cAAc,UAAU,SAC9B,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,mBAAmB,IAAI,CAAC,CAC/C;;;GAGL,kBAAkB;AAChB,aAAQN,WAAY,GAAG;;GAE1B;;;;;CAQH,YAAY,IAAkB;EAC5B,MAAM,eAAe,MAAKG,cAAe,IAAI,GAAG;AAChD,MAAI,CAAC,aACH;EAGF,MAAM,SAAS,aAAa;AAE5B,QAAKA,cAAe,OAAO,GAAG;AAC9B,OAAK,cAAc,UAAU,SAAS;GACpC,MAAM,OAAO,IAAI,IAAI,KAAK;AAC1B,QAAK,OAAO,GAAG;AACf,UAAO;IACP;EAGF,MAAM,aAAa,MAAKC,oBAAqB,IAAI,OAAO;AACxD,MAAI,YAAY;AACd,cAAW,OAAO,GAAG;AACrB,OAAI,WAAW,SAAS,EACtB,OAAKG,yBAA0B,OAAO;;;;;;CAQ5C,0BAA0B,QAAsB;AAC9C,MAAI,OAAO,aAAa,YACtB;AAGF,MAAI,MAAKC,gBAAiB,IAAI,OAAO,CACnC;EAGF,MAAM,iBAAiB,MAAKC,2BAA4B,OAAO;EAC/D,MAAM,eAAe,MAAKC,yBAA0B,OAAO;AAE3D,SAAO,iBAAiB,WAAW,eAAgC;AACnE,SAAO,iBAAiB,SAAS,aAA8B;AAE/D,QAAKF,gBAAiB,IAAI,QAAQ;GAChC,SAAS;GACT,OAAO;GACR,CAAC;;;;;CAMJ,0BAA0B,QAAsB;AAC9C,MAAI,OAAO,aAAa,YACtB;EAGF,MAAM,YAAY,MAAKA,gBAAiB,IAAI,OAAO;AACnD,MAAI,CAAC,UACH;AAGF,SAAO,oBAAoB,WAAW,UAAU,QAAyB;AACzE,SAAO,oBAAoB,SAAS,UAAU,MAAuB;AAErE,QAAKA,gBAAiB,OAAO,OAAO;AACpC,QAAKJ,oBAAqB,OAAO,OAAO;;;;;CAM1C,4BAA4B,QAAgD;AAC1E,UAAQ,UAAyB;AAC/B,SAAKO,mBAAoB,OAAO,QAAQ,UAAU;;;;;;CAOtD,0BAA0B,QAAgD;AACxE,UAAQ,UAAyB;AAC/B,SAAKA,mBAAoB,OAAO,QAAQ,QAAQ;;;;;;CAOpD,oBACE,OACA,QACA,WACM;AACN,MAAIC,0CAAiB,MAAM,EAAE;AAC3B,QAAK,MAAM,MAAM,MAAKR,oBAAqB,IAAI,OAAO,IAAI,EAAE,EAAE;IAC5D,MAAM,eAAe,MAAKD,cAAe,IAAI,GAAG;AAChD,QAAI,gBAAgB,aAAa,eAAe,GAAG;AACjD,kBAAa,eAAe;AAC5B,WAAKU,qBAAsB,aAAa;;;AAG5C;;AAEF,MACG,MAAM,SAAS,aAAa,MAAM,UACnCC,+CAAuB,MAAM,CAAC,YAE9B;AAGF,MAAIC,4BAAcC,mCAAiB,MAAM,IAAI,CAAC,CAC5C;EAGF,MAAM,aAAa,MAAKZ,oBAAqB,IAAI,OAAO;AACxD,MAAI,CAAC,WACH;EAGF,MAAM,MAAM,KAAK,KAAK;EAEtB,MAAM,6BAAa,IAAI,KAAmD;EAC1E,IAAI,YAAY;AAEhB,kBAAiB,MAAK,MAAM,MAAM,YAAY;GAC5C,MAAM,eAAe,MAAKD,cAAe,IAAI,GAAG;AAChD,OAAI,CAAC,aACH;AAGF,OAAI,CAACc,uCAAiB,OAAO,OAAO,CAClC;AAGF,OAAI,CAAC,aAAa,QAAQ,QACxB;AAIF,OAAI,aAAa,QAAQ,iBAAiB,OACxC;QAAIC,6CAAuB,OAAO,QAAQ,aAAa,OAAO,CAC5D,UAAS;;AAKb,OAAI,aAAa,QAAQ,cAAc,UACrC;GAGF,MAAM,UAAU,aAAa,QAAQ;AAGrC,OACE,aAAa,eAAe,KAC5B,MAAM,aAAa,cAAc,SACjC;AACA,iBAAa,eAAe;AAC5B,UAAKL,qBAAsB,aAAa;;GAG1C,MAAM,iBACJ,aAAa,eAAe,aAAa;AAC3C,OAAI,CAAC,eACH;GAGF,IAAI,QAAQM,kCACV,OACA,gBACA,aAAa,QAAQ,SACtB;GACD,IAAI,YAAY,aAAa,eAAe;AAC5C,OAAI,CAAC,MAAM,WAAW,aAAa,eAAe,GAAG;AACnD,YAAQA,kCACN,OACA,aAAa,eAAe,IAC5B,aAAa,QAAQ,SACtB;AACD,gBAAY;;AAEd,cAAW,IAAI,IAAI;IAAE,OAAO,MAAM;IAAO;IAAW,CAAC;AACrD,eAAY,KAAK,IAAI,WAAW,MAAM,MAAM;;AAG9C,OAAK,MAAM,CAAC,IAAI,cAAc,YAAY;GACxC,MAAM,eAAe,MAAKhB,cAAe,IAAI,GAAG;AAChD,OAAI,CAAC,gBAAgB,CAAC,aAAa,QAAQ,QAAS;AACpD,OAAI,UAAU,QAAQ,KAAK,UAAU,UAAU,WAAW;AACxD,iBAAa,cAAc;AAC3B,iBAAa,eAAe,UAAU;AAEtC,QAAI,aAAa,gBAAgB,aAAa,eAAe,QAAQ;AACnE,SAAI,aAAa,QAAQ,eACvB,OAAM,gBAAgB;AAExB,SAAI,aAAa,QAAQ,gBACvB,OAAM,iBAAiB;KAGzB,MAAM,UAAiC;MACrC,QAAQ,aAAa,SAAS,KAAK,IAAI;MACvC,cACE,aAAa,eACX,aAAa,eAAe,SAAS;MAE1C;AAED,kBAAa;AACb,kBAAa,WAAW;AACxB,kBAAa,eAAe;AAE5B,WAAKU,qBAAsB,aAAa;AAExC,kBAAa,SAAS,OAAO,QAAQ;UAErC,OAAKA,qBAAsB,aAAa;cAEjC,aAAa,eAAe,GAAG;AAExC,iBAAa,eAAe;AAC5B,UAAKA,qBAAsB,aAAa;;;;;;;CAQ9C,yBACE,gBACA,QAC6B;AAC7B,OAAK,MAAM,gBAAgB,MAAKV,cAAe,QAAQ,CACrD,KACE,aAAa,WAAW,UACxB,aAAa,eAAe,WAAW,eAAe,UACtD,eAAe,OAAO,MAAM,UAC1BiB,8BAAgB,MAAM,aAAa,eAAe,OAAQ,CAC3D,CAED,QAAO;AAGX,SAAO;;;;;CAMT,WAAiB;AACf,OAAK,MAAM,gBAAgB,MAAKjB,cAAe,QAAQ,EAAE;AACvD,gBAAa,eAAe;AAC5B,gBAAa,cAAc;AAC3B,SAAKU,qBAAsB,aAAa;;;;;;;;;;CAW5C,gBAAgB,IAAqB;EACnC,MAAM,eAAe,MAAKV,cAAe,IAAI,GAAG;AAChD,MAAI,CAAC,aACH,QAAO;EAGT,MAAM,aACJ,aAAa,eAAe,aAAa,eAAe,SAAS;AACnE,MAAI,CAAC,WACH,QAAO;EAGT,MAAM,iBAAiB,IAAI,cACzB,aAAa,QAAQ,aAAa,WAClC;GACE,GAAI,WAAW,SAAS,SACpB,EAAE,MAAM,WAAW,MAAM,GACzB,EAAE,KAAK,WAAW,KAAK;GAC3B,SAAS,WAAW;GACpB,UAAU,WAAW;GACrB,QAAQ,WAAW;GACnB,SAAS,WAAW;GACpB,SAAS;GACT,YAAY;GACb,CACF;AAED,eAAa;AACb,eAAa,WAAW;AAExB,QAAKU,qBAAsB,aAAa;EAExC,MAAM,UAAiC;GACrC,QAAQ,aAAa,SAAS,KAAK,IAAI;GACvC,cAAc;GACf;AAED,eAAa,SAAS,gBAAgB,QAAQ;AAE9C,SAAO;;;;;CAMT,uBAA+B;AAC7B,SAAO,MAAKV,cAAe;;;;;CAM7B,UAAgB;AACd,OAAK,MAAM,UAAU,MAAKK,gBAAiB,MAAM,CAC/C,OAAKD,yBAA0B,OAAO;AAExC,QAAKJ,cAAe,OAAO;AAC3B,OAAK,cAAc,+BAAe,IAAI,KAAK,CAAC;;;;;;;AAQhD,SAAgB,qBAAsC;AACpD,QAAO,gBAAgB,aAAa;;;;;;;;;;;;;;;;;;;;;;;;AAyBtC,SAAgB,sBACd,UACA,UAAwE,EAAE,EAK1E;CACA,MAAM,WAAW,QAAQ,YAAYP,iCAAgB;CACrD,MAAM,UAAU,QAAQ;CACxB,MAAM,iBAAiB,SAAS,KAAK,WAAWC,0BAAY,QAAQ,SAAS,CAAC;CAE9E,IAAI,eAAe;CACnB,IAAI,cAAc;AAElB,QAAO;EACL,MAAM,OAA+B;AAEnC,OACG,MAAM,SAAS,aAAa,MAAM,UACnCiB,+CAAuB,OAAO,SAAS,CAAC,eACxCC,4BAAcC,mCAAiB,MAAM,IAAI,CAAC,CAE1C,QAAO;GAET,MAAM,MAAM,KAAK,KAAK;AAEtB,OAAI,eAAe,KAAK,MAAM,cAAc,QAC1C,gBAAe;GAGjB,MAAM,WAAW,eAAe;AAChC,OAAI,CAAC,SACH,QAAO;AAGT,OAAIK,mCAAqB,OAAO,UAAU,SAAS,EAAE;AACnD,kBAAc;AACd;AAEA,QAAI,gBAAgB,eAAe,QAAQ;AACzC,oBAAe;AACf,YAAO;;cAEA,eAAe,EACxB,KAAIA,mCAAqB,OAAO,eAAe,IAAK,SAAS,EAAE;AAC7D,mBAAe;AACf,kBAAc;SAEd,gBAAe;AAInB,UAAO;;EAGT,QAAc;AACZ,kBAAe;AACf,iBAAc;;EAGhB,cAAsB;AACpB,UAAO;;EAEV"}
@@ -1,172 +0,0 @@
1
- import { Hotkey, HotkeyCallback, ParsedHotkey } from "./hotkey.types.cjs";
2
- import { HotkeyOptions } from "./hotkey-manager.cjs";
3
- import { Store } from "@tanstack/store";
4
-
5
- //#region src/sequence-manager.d.ts
6
- type Target = HTMLElement | Document | Window;
7
- /**
8
- * Options for hotkey sequence matching.
9
- * Extends HotkeyOptions but excludes requireReset (not applicable to sequences).
10
- */
11
- interface SequenceOptions extends Omit<HotkeyOptions, 'requireReset'> {
12
- /** Timeout between keys in milliseconds. Default: 1000 */
13
- timeout?: number;
14
- }
15
- /**
16
- * A sequence of hotkeys for Vim-style shortcuts.
17
- *
18
- * Each element is one step (a `Hotkey` string). Steps may include modifiers;
19
- * the same modifier can appear on consecutive steps (e.g. `Shift+R` then
20
- * `Shift+T`). Modifier-only key events do not advance or reset matching—see
21
- * `SequenceManager`. Automatic keydown repeats and IME composition are also ignored.
22
- *
23
- * @example
24
- * ```ts
25
- * const gotoTop: HotkeySequence = ['G', 'G'] // gg
26
- * const deleteLine: HotkeySequence = ['D', 'D'] // dd
27
- * const deleteWord: HotkeySequence = ['D', 'I', 'W'] // diw
28
- * const chainedShift: HotkeySequence = ['Shift+R', 'Shift+T']
29
- * ```
30
- */
31
- type HotkeySequence = Array<Hotkey>;
32
- /**
33
- * Default timeout between keys in a sequence (in milliseconds).
34
- * Exported for consumers that display sequence state (e.g. devtools).
35
- */
36
- declare const DEFAULT_SEQUENCE_TIMEOUT = 1000;
37
- /**
38
- * View of a sequence registration for devtools display.
39
- * Progress fields reflect an in-progress match (between first key and completion or timeout).
40
- */
41
- interface SequenceRegistrationView {
42
- id: string;
43
- sequence: HotkeySequence;
44
- options: SequenceOptions;
45
- target: Target;
46
- triggerCount: number;
47
- /** Whether this sequence has been triggered at least once. */
48
- hasFired: boolean;
49
- /** Steps matched in the current attempt (0 when idle or just completed). */
50
- matchedStepCount: number;
51
- /** `Date.now()` when the last step in the current attempt matched; 0 if none. */
52
- partialMatchLastKeyTime: number;
53
- }
54
- /**
55
- * Internal representation of a sequence registration.
56
- */
57
- interface SequenceRegistration {
58
- id: string;
59
- sequence: HotkeySequence;
60
- parsedSequence: Array<ParsedHotkey>;
61
- callback: HotkeyCallback;
62
- options: SequenceOptions;
63
- target: Target;
64
- currentIndex: number;
65
- lastKeyTime: number;
66
- triggerCount: number;
67
- hasFired: boolean;
68
- }
69
- /**
70
- * A handle returned from SequenceManager.register() that allows updating
71
- * the callback and options without re-registering the sequence.
72
- *
73
- * @example
74
- * ```ts
75
- * const handle = manager.register(['G', 'G'], callback, options)
76
- *
77
- * handle.callback = newCallback
78
- * handle.setOptions({ timeout: 500 })
79
- * handle.unregister()
80
- * ```
81
- */
82
- interface SequenceRegistrationHandle {
83
- readonly id: string;
84
- readonly isActive: boolean;
85
- callback: HotkeyCallback;
86
- setOptions: (options: Partial<SequenceOptions>) => void;
87
- unregister: () => void;
88
- }
89
- declare class SequenceManager {
90
- #private;
91
- /**
92
- * The TanStack Store containing sequence registration views for devtools.
93
- * Subscribe to this to observe registration changes.
94
- */
95
- readonly registrations: Store<Map<string, SequenceRegistrationView>>;
96
- private constructor();
97
- /**
98
- * Gets the singleton instance of SequenceManager.
99
- */
100
- static getInstance(): SequenceManager;
101
- /**
102
- * Resets the singleton instance. Useful for testing.
103
- */
104
- static resetInstance(): void;
105
- /**
106
- * Registers a hotkey sequence handler.
107
- *
108
- * @param sequence - Array of hotkey strings that form the sequence
109
- * @param callback - Function to call when the sequence is completed
110
- * @param options - Options for the sequence behavior
111
- * @returns A handle to update or unregister the sequence
112
- */
113
- register(sequence: HotkeySequence, callback: HotkeyCallback, options?: SequenceOptions): SequenceRegistrationHandle;
114
- /**
115
- * Resets all sequence progress.
116
- */
117
- resetAll(): void;
118
- /**
119
- * Triggers a sequence's callback programmatically from devtools.
120
- * Creates a synthetic KeyboardEvent from the last key in the sequence.
121
- *
122
- * @param id - The registration ID to trigger
123
- * @returns True if the registration was found and triggered
124
- */
125
- triggerSequence(id: string): boolean;
126
- /**
127
- * Gets the number of registered sequences.
128
- */
129
- getRegistrationCount(): number;
130
- /**
131
- * Destroys the manager and removes all listeners.
132
- */
133
- destroy(): void;
134
- }
135
- /**
136
- * Gets the singleton SequenceManager instance.
137
- * Convenience function for accessing the manager.
138
- */
139
- declare function getSequenceManager(): SequenceManager;
140
- /**
141
- * Creates a simple sequence matcher for one-off use.
142
- *
143
- * This is a low-level helper that does not support ignoreInputs, target,
144
- * or other HotkeyOptions. Callers must handle input filtering themselves
145
- * if attaching to document.
146
- *
147
- * @param sequence - The sequence of hotkeys to match
148
- * @param options - Options including timeout
149
- * @returns An object with match() and reset() methods
150
- *
151
- * @example
152
- * ```ts
153
- * const matcher = createSequenceMatcher(['G', 'G'], { timeout: 500 })
154
- *
155
- * document.addEventListener('keydown', (event) => {
156
- * if (matcher.match(event)) {
157
- * console.log('Sequence matched!')
158
- * }
159
- * })
160
- * ```
161
- */
162
- declare function createSequenceMatcher(sequence: HotkeySequence, options?: {
163
- timeout?: number;
164
- platform?: 'mac' | 'windows' | 'linux';
165
- }): {
166
- match: (event: KeyboardEvent) => boolean;
167
- reset: () => void;
168
- getProgress: () => number;
169
- };
170
- //#endregion
171
- export { DEFAULT_SEQUENCE_TIMEOUT, HotkeySequence, SequenceManager, SequenceOptions, SequenceRegistration, SequenceRegistrationHandle, SequenceRegistrationView, Target, createSequenceMatcher, getSequenceManager };
172
- //# sourceMappingURL=sequence-manager.d.cts.map