refactor: abstract event object

packages/core/src/foundation/Keyboard.ts

@@ -27,6 +27,7 @@ import {
 } from '../common/addKeyboardEventListener';
 import { combine } from '../common/combine';
 import { ShortcutEventTarget } from './ShortcutEventTarget';
+import { ShortcutKeyboardEvent } from './ShortcutKeyboardEvent';
 
 export class Keyboard {
     private readonly commands: Record<
@@ -43,8 +44,8 @@ export class Keyboard {
     private readonly registry: MacroRegistry;
     private readonly partiallyMatchShortcutsStore: Store<Set<Shortcut>> =
         new Store();
-    private readonly keyboardEventStore: Store<KeyboardEvent> =
-        new Store<KeyboardEvent>();
+    private readonly keyboardEventStore: Store<ShortcutKeyboardEvent> =
+        new Store<ShortcutKeyboardEvent>();
     private readonly interceptors: Interceptor[] = [];
     private readonly _unregisterEvents = () => {
         // PASS
@@ -86,7 +87,7 @@ export class Keyboard {
         this.partiallyMatchShortcutsStore.dispatch(shortcuts);
     }
 
-    public fire(e: KeyboardEvent) {
+    public fire(e: ShortcutKeyboardEvent) {
         if (this.paused) {
             return;
         }
@@ -146,7 +147,7 @@ export class Keyboard {
             switch (e.type) {
                 case 'keydown':
                 case 'keyup':
-                    this.fire(e);
+                    this.fire(e as ShortcutKeyboardEvent);
                     break;
             }
         });
@@ -189,7 +190,7 @@ export class Keyboard {
     }
 
     private executeCommand(
-        e: KeyboardEvent,
+        e: ShortcutKeyboardEvent,
         commandName: string,
         commandOptions: ParsedCommandOptions
     ) {

packages/core/src/foundation/KeyboardEventMatcher.ts

@@ -1,5 +1,7 @@
+import { ShortcutKeyboardEvent } from './ShortcutKeyboardEvent';
+
 export interface KeyboardEventMatcher {
-    match(event: KeyboardEvent): boolean;
+    match(event: ShortcutKeyboardEvent): boolean;
 
     /**
      * @desc Help text for this matcher.
@@ -9,5 +11,5 @@ export interface KeyboardEventMatcher {
     str(): string;
 }
 export interface KeyboardEventMatcherFn {
-    (event: KeyboardEvent): boolean;
+    (event: ShortcutKeyboardEvent): boolean;
 }

packages/core/src/foundation/ShortcutEvent.ts

@@ -1,9 +1,10 @@
 import { Shortcut } from '../shortcut/Shortcut';
 import { ShortcutContext } from './ShortcutContext';
+import { ShortcutKeyboardEvent } from './ShortcutKeyboardEvent';
 
 export interface ShortcutEvent {
     readonly shortcut: Shortcut;
-    readonly native: KeyboardEvent;
+    readonly native: ShortcutKeyboardEvent;
     preventDefault(): void;
     stopImmediatePropagation(): void;
     stopPropagation(): void;
@@ -17,15 +18,16 @@ export interface ShortcutCommandEvent extends ShortcutEvent {
 export class ShortcutEventImpl implements ShortcutEvent {
     constructor(
         public readonly shortcut: Shortcut,
-        public readonly native: KeyboardEvent
+        public readonly native: ShortcutKeyboardEvent
     ) {}
     preventDefault(): void {
-        this.native.preventDefault();
+        this.native.preventDefault && this.native.preventDefault();
     }
     stopImmediatePropagation(): void {
-        this.native.stopImmediatePropagation();
+        this.native.stopImmediatePropagation &&
+            this.native.stopImmediatePropagation();
     }
     stopPropagation(): void {
-        this.native.stopPropagation();
+        this.native.stopPropagation && this.native.stopPropagation();
     }
 }

packages/core/src/foundation/ShortcutEventTarget.ts

@@ -1 +1,8 @@
-export type ShortcutEventTarget = HTMLElement | SVGElement | Document | Window;
+import { ShortcutKeyboardEvent } from './ShortcutKeyboardEvent';
+
+export type ShortcutEventTarget = {
+    addEventListener: (
+        type: 'keydown' | 'keyup' | 'keypress',
+        listener: (event: ShortcutKeyboardEvent) => void
+    ) => void;
+};

packages/core/src/foundation/ShortcutKeyboardEvent.ts

@@ -0,0 +1,12 @@
+export interface ShortcutKeyboardEvent {
+    type: 'keydown' | 'keyup' | 'keypress';
+    shiftKey: boolean;
+    ctrlKey: boolean;
+    metaKey: boolean;
+    altKey: boolean;
+    keyCode: number;
+    key: string;
+    preventDefault?: () => void;
+    stopPropagation?: () => void;
+    stopImmediatePropagation?: () => void;
+}

packages/core/src/matchers/KeyCodeMatcher.ts

@@ -1,8 +1,9 @@
 import { KeyboardEventMatcher } from '../foundation/KeyboardEventMatcher';
+import { ShortcutKeyboardEvent } from '../foundation/ShortcutKeyboardEvent';
 
 export class KeyCodeMatcher implements KeyboardEventMatcher {
     constructor(private readonly keyCode: number) {}
-    match(event: KeyboardEvent): boolean {
+    match(event: ShortcutKeyboardEvent): boolean {
         return event.keyCode === this.keyCode;
     }
 

packages/core/src/matchers/KeyMatcher.ts

@@ -1,11 +1,12 @@
 import { KeyboardEventMatcher } from '../foundation/KeyboardEventMatcher';
+import { ShortcutKeyboardEvent } from '../foundation/ShortcutKeyboardEvent';
 
 class KeyMatcher implements KeyboardEventMatcher {
     constructor(
         private readonly key: string,
         private readonly caseSensitive: boolean
     ) {}
-    match(event: KeyboardEvent): boolean {
+    match(event: ShortcutKeyboardEvent): boolean {
         if (this.caseSensitive) {
             return event.key === this.key;
         }

packages/core/src/matchers/and.ts

@@ -2,11 +2,12 @@ import {
     KeyboardEventMatcher,
     KeyboardEventMatcherFn
 } from '../foundation/KeyboardEventMatcher';
+import { ShortcutKeyboardEvent } from '../foundation/ShortcutKeyboardEvent';
 
 export function and(
     ...matchers: Array<KeyboardEventMatcher | KeyboardEventMatcherFn>
 ) {
-    return (keyboardEvent: KeyboardEvent) => {
+    return (keyboardEvent: ShortcutKeyboardEvent) => {
         return (
             matchers.length > 0 &&
             matchers.every(it => {

packages/core/src/matchers/or.ts

@@ -2,11 +2,12 @@ import {
     KeyboardEventMatcher,
     KeyboardEventMatcherFn
 } from '../foundation/KeyboardEventMatcher';
+import { ShortcutKeyboardEvent } from '../foundation/ShortcutKeyboardEvent';
 
 export function or(
     ...matchers: Array<KeyboardEventMatcher | KeyboardEventMatcherFn>
 ): KeyboardEventMatcherFn {
-    return (keyboardEvent: KeyboardEvent) => {
+    return (keyboardEvent: ShortcutKeyboardEvent) => {
         return matchers.some(it => {
             if (typeof it === 'function') {
                 return it(keyboardEvent);

packages/core/src/shortcut/Shortcut.ts

@@ -6,6 +6,7 @@ import { AltKeyMatcher } from '../matchers/AltKeyMatcher';
 import { ShiftKeyMatcher } from '../matchers/ShiftKeyMatcher';
 import { MetaKeyMatcher } from '../matchers/MetaKeyMatcher';
 import { MacroKeyboardEventMatcher } from '../macro/MacroKeyboardEventMatcher';
+import { ShortcutKeyboardEvent } from '../foundation/ShortcutKeyboardEvent';
 
 export class Shortcut implements KeyboardEventMatcher {
     static keyDeliminator: string = '+';
@@ -32,7 +33,7 @@ export class Shortcut implements KeyboardEventMatcher {
         this.parts = matchers.map(it => new ShortcutPart(it));
     }
 
-    match(event: KeyboardEvent): boolean {
+    match(event: ShortcutKeyboardEvent): boolean {
         if (this.isFullMatch()) {
             this.reset();
         }
@@ -107,7 +108,7 @@ class ShortcutPart {
         });
     }
 
-    match(event: KeyboardEvent): boolean {
+    match(event: ShortcutKeyboardEvent): boolean {
         if (this.ctrl !== event.ctrlKey) {
             return false;
         }