feat(core): keyboard shortcuts

ulixee · Mar 1, 2022 · 19fa006 · 19fa006
1 parent af23474
commit 19fa006
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 3 deletions.
diff --git a/client/interfaces/IInteractions.ts b/client/interfaces/IInteractions.ts
@@ -1,4 +1,5 @@
 import { IKeyboardKeyCode } from '@ulixee/hero-interfaces/IKeyboardLayoutUS';
+import { IKeyboardShortcut } from '@ulixee/hero-interfaces/IKeyboardShortcuts';
 import {
   IElementInteractVerification,
   IMousePositionXY,
@@ -36,6 +37,7 @@ export enum Command {
 
   keyPress = 'keyPress',
   keyDown = 'keyDown',
+  keyShortcut = 'keyShortcut',
   keyUp = 'keyUp',
   type = 'type',
 
@@ -68,6 +70,7 @@ export interface ICommandDetailed {
   [Command.keyPress]?: IKeyboardKeyCode;
   [Command.keyUp]?: IKeyboardKeyCode;
   [Command.keyDown]?: IKeyboardKeyCode;
+  [Command.keyShortcut]?: IKeyboardShortcut;
 
   [Command.waitForMillis]?: number;
 }

diff --git a/client/lib/DomExtender.ts b/client/lib/DomExtender.ts
@@ -22,6 +22,7 @@ import Interactor from './Interactor';
 import XPathResult from 'awaited-dom/impl/official-klasses/XPathResult';
 import { createSuperNode } from 'awaited-dom/impl/create';
 import { getAwaitedPathAsMethodArg } from './SetupAwaitedHandler';
+import { KeyboardShortcuts } from '@ulixee/hero-interfaces/IKeyboardShortcuts';
 
 const awaitedPathState = StateMachine<
   any,
@@ -118,8 +119,7 @@ const NodeExtensionFns: INodeExtensionFns = {
     const coreFrame = await awaitedOptions.coreFrame;
     await Interactor.run(coreFrame, [
       { click: this },
-      { keyDown: KeyboardKey.Meta, keyPress: KeyboardKey.a },
-      { keyUp: KeyboardKey.Meta },
+      { keyShortcut: KeyboardShortcuts.selectAll },
       { keyPress: KeyboardKey.Backspace },
     ]);
   },

diff --git a/client/lib/Interactor.ts b/client/lib/Interactor.ts
@@ -22,6 +22,7 @@ import IInteractions, {
 } from '../interfaces/IInteractions';
 import CoreFrameEnvironment from './CoreFrameEnvironment';
 import { isAwaitedNode } from './SetupAwaitedHandler';
+import { IKeyboardShortcut } from '@ulixee/hero-interfaces/IKeyboardShortcuts';
 
 const { getState } = StateMachine<ISuperElement | ISuperNode, { awaitedPath: AwaitedPath }>();
 
@@ -200,6 +201,13 @@ function convertInteractionToInteractionGroup(interaction: IInteraction): IInter
         const command = CoreCommand.type;
         return iGroup.push({ command, keyboardCommands: [{ down: value as IKeyboardKeyCode }] });
       }
+      case Command.keyShortcut: {
+        const command = CoreCommand.type;
+        return iGroup.push({
+          command,
+          keyboardCommands: [{ shortcut: value as IKeyboardShortcut }],
+        });
+      }
       case Command.keyUp: {
         const command = CoreCommand.type;
         return iGroup.push({ command, keyboardCommands: [{ up: value as IKeyboardKeyCode }] });

diff --git a/core/lib/Interactor.ts b/core/lib/Interactor.ts
@@ -332,6 +332,8 @@ export default class Interactor implements IInteractionsHelper {
           } else if ('down' in keyboardCommand) {
             const key = getKeyboardKey(keyboardCommand.down);
             await this.keyboard.down(key);
+          } else if ('shortcut' in keyboardCommand) {
+            await this.keyboard.command(keyboardCommand.shortcut);
           } else if ('string' in keyboardCommand) {
             const text = keyboardCommand.string;
             for (const char of text) {

diff --git a/fullstack/test/domExtenders.test.ts b/fullstack/test/domExtenders.test.ts
@@ -53,6 +53,15 @@ describe('basic DomExtender tests', () => {
     await expect(hero.querySelector('#field').$click()).resolves.toBe(undefined);
     await expect(hero.querySelector('#field').$hasFocus).resolves.toBe(true);
   });
+
+  it('can clear a field', async () => {
+    koaServer.get('/domextender-clear', ctx => {
+      ctx.body = `<body><input id="field" type="text" value="1234Test"/></body>`;
+    });
+    const hero = await openBrowser(`/domextender-clear`);
+    await expect(hero.querySelector('#field').$clearValue()).resolves.toBe(undefined);
+    await expect(hero.querySelector('#field').value).resolves.toBe('');
+  });
 });
 
 async function openBrowser(path: string) {

diff --git a/interfaces/IInteractions.ts b/interfaces/IInteractions.ts
@@ -3,6 +3,7 @@ import { IJsPath } from 'awaited-dom/base/AwaitedPath';
 import { IKeyboardKeyCode } from './IKeyboardLayoutUS';
 import IMouseResult from './IMouseResult';
 import IPoint from './IPoint';
+import { IKeyboardShortcut } from './IKeyboardShortcuts';
 
 export type IElementInteractVerification = 'elementAtPath' | 'exactElement' | 'none';
 
@@ -71,13 +72,16 @@ export type IMousePosition = IMousePositionXY | IJsPath;
 // Keyboard-specific Types
 
 export type IKeyboardCommand = IKeyPress | IKeyboardObject;
-export type IKeyboardObject = IKeyboardString | IKeyboardUp | IKeyboardDown;
+export type IKeyboardObject = IKeyboardString | IKeyboardUp | IKeyboardDown | IKeyShortcutPress;
 export interface IKeyboardString {
   string: string;
 }
 export interface IKeyPress {
   keyCode: IKeyboardKeyCode;
 }
+export interface IKeyShortcutPress {
+  shortcut: IKeyboardShortcut;
+}
 export interface IKeyboardUp {
   up: IKeyboardKeyCode;
 }

diff --git a/interfaces/IKeyboardShortcuts.ts b/interfaces/IKeyboardShortcuts.ts
@@ -0,0 +1,13 @@
+export enum KeyboardShortcuts {
+  'selectAll' = 'selectAll',
+
+  'delete' = 'delete',
+  'deleteBackward' = 'deleteBackward',
+  'deleteForward' = 'deleteForward',
+  'deleteToEndOfParagraph' = 'deleteToEndOfParagraph',
+  'deleteWordForward' = 'deleteWordForward',
+  'deleteWordBackward' = 'deleteWordBackward',
+  'deleteToBeginningOfLine' = 'deleteToBeginningOfLine',
+}
+
+export type IKeyboardShortcut = keyof typeof KeyboardShortcuts;
diff --git a/interfaces/IPuppetInput.ts b/interfaces/IPuppetInput.ts
@@ -6,6 +6,7 @@ export interface IPuppetKeyboard {
   up(key: IKeyboardKey): Promise<void>;
   down(key: IKeyboardKey): Promise<void>;
   press(key: IKeyboardKey, keyupDelay?: number): Promise<void>;
+  command(command: string): Promise<void>;
   insertText(text: string): Promise<void>;
   sendCharacter(char: string): Promise<void>;
 }

diff --git a/puppet-chrome/lib/Keyboard.ts b/puppet-chrome/lib/Keyboard.ts
@@ -57,6 +57,13 @@ export class Keyboard implements IPuppetKeyboard {
     });
   }
 
+  async command(command: string): Promise<void> {
+    await this.devtoolsSession.send('Input.dispatchKeyEvent', {
+      type: 'rawKeyDown',
+      commands: [command],
+    });
+  }
+
   async up(key: IKeyboardKey): Promise<void> {
     const description = this.keyDescriptionForString(key);