Merge pull request #36 from e2b-dev/hf-fixes-upd

Added human-friendly key mappings and updated readme

Author: mishushakov

.changeset/metal-spiders-trade.md

@@ -0,0 +1,6 @@
+---
+"@e2b/desktop-python": minor
+"@e2b/desktop": minor
+---
+
+press key lowercase and readme changes

README.md

@@ -174,7 +174,7 @@ desktop.left_click()
 desktop.right_click()
 desktop.middle_click()
 desktop.scroll(10) # Scroll by the amount. Positive for up, negative for down.
-desktop.mouse_move(100, 200) # Move to x, y coordinates
+desktop.move_mouse(100, 200) # Move to x, y coordinates
 desktop.drag((100, 100), (200, 200)) # Drag using the mouse
 desktop.mouse_press("left") # Press the mouse button
 desktop.mouse_release("left") # Release the mouse button

packages/js-sdk/src/sandbox.ts

@@ -19,6 +19,63 @@ const MOUSE_BUTTONS = {
   middle: 2
 }
 
+const KEYS = {
+  "enter": "Return",
+  "space": "space",
+  "backspace": "BackSpace",
+  "tab": "Tab",
+  "escape": "Escape",
+  "shift": "Shift_L",
+  "shift_left": "Shift_L",
+  "shift_right": "Shift_R",
+  "control": "Control_L",
+  "control_left": "Control_L",
+  "control_right": "Control_R",
+  "alt": "Alt_L",
+  "alt_left": "Alt_L",
+  "alt_right": "Alt_R",
+  "super": "Super_L",
+  "super_left": "Super_L",
+  "super_right": "Super_R",
+  "caps_lock": "Caps_Lock",
+  "num_lock": "Num_Lock",
+  "scroll_lock": "Scroll_Lock",
+  "insert": "Insert",
+  "delete": "Delete",
+  "home": "Home",
+  "end": "End",
+  "page_up": "Page_Up",
+  "page_down": "Page_Down",
+  "up": "Up",
+  "down": "Down",
+  "left": "Left",
+  "right": "Right",
+  "f1": "F1",
+  "f2": "F2",
+  "f3": "F3",
+  "f4": "F4",
+  "f5": "F5",
+  "f6": "F6",
+  "f7": "F7",
+  "f8": "F8",
+  "f9": "F9",
+  "f10": "F10",
+  "f11": "F11",
+  "f12": "F12",
+  "print_screen": "Print",
+  "pause": "Pause",
+  "menu": "Menu",
+  "meta": "Meta_L"
+}
+
+function mapKey(key: string): string {
+  const lowerKey = key.toLowerCase()
+  if (lowerKey in KEYS) {
+    return KEYS[lowerKey as keyof typeof KEYS]
+  }
+  return key
+}
+
 /**
  * Configuration options for the Sandbox environment.
  * @interface SandboxOpts
@@ -396,8 +453,14 @@ export class Sandbox extends SandboxBase {
    * @param key - The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys.
    */
   async press(key: string | string[]): Promise<void> {
+    if (Array.isArray(key)) {
+      key = key.map(mapKey).join('+')
+    } else {
+      key = mapKey(key)
+    }
+
     await this.commands.run(
-      `xdotool key ${Array.isArray(key) ? key.join('+') : key}`, { envs: { DISPLAY: this.display } }
+      `xdotool key ${key}`, { envs: { DISPLAY: this.display } }
     );
   }
 

packages/python-sdk/README.md

@@ -101,7 +101,7 @@ desktop.left_click()
 desktop.right_click()
 desktop.middle_click()
 desktop.scroll(10) # Scroll by the amount. Positive for up, negative for down.
-desktop.mouse_move(100, 200) # Move to x, y coordinates
+desktop.move_mouse(100, 200) # Move to x, y coordinates
 desktop.drag((100, 100), (200, 200)) # Drag using the mouse
 desktop.mouse_press("left") # Press the mouse button
 desktop.mouse_release("left") # Release the mouse button

packages/python-sdk/e2b_desktop/main.py

@@ -12,6 +12,61 @@
     "middle": 2
 }
 
+KEYS = {
+  "enter": "Return",
+  "space": "space",
+  "backspace": "BackSpace",
+  "tab": "Tab",
+  "escape": "Escape",
+  "shift": "Shift_L",
+  "shift_left": "Shift_L",
+  "shift_right": "Shift_R",
+  "control": "Control_L",
+  "control_left": "Control_L",
+  "control_right": "Control_R",
+  "alt": "Alt_L",
+  "alt_left": "Alt_L",
+  "alt_right": "Alt_R",
+  "super": "Super_L",
+  "super_left": "Super_L",
+  "super_right": "Super_R",
+  "caps_lock": "Caps_Lock",
+  "num_lock": "Num_Lock",
+  "scroll_lock": "Scroll_Lock",
+  "insert": "Insert",
+  "delete": "Delete",
+  "home": "Home",
+  "end": "End",
+  "page_up": "Page_Up",
+  "page_down": "Page_Down",
+  "up": "Up",
+  "down": "Down",
+  "left": "Left",
+  "right": "Right",
+  "f1": "F1",
+  "f2": "F2",
+  "f3": "F3",
+  "f4": "F4",
+  "f5": "F5",
+  "f6": "F6",
+  "f7": "F7",
+  "f8": "F8",
+  "f9": "F9",
+  "f10": "F10",
+  "f11": "F11",
+  "f12": "F12",
+  "print_screen": "Print",
+  "pause": "Pause",
+  "menu": "Menu",
+  "meta": "Meta_L"
+}
+
+def map_key(key: str) -> str:
+    lower_key = key.lower()
+    if lower_key in KEYS:
+        return KEYS[lower_key]
+    return key
+
 class _VNCServer:
     def __init__(self, desktop: "Sandbox") -> None:
         self.__vnc_handle: CommandHandle | None = None
@@ -371,7 +426,9 @@ def press(self, key: str | list[str]):
         :param key: The key to press (e.g. "enter", "space", "backspace", etc.).
         """
         if isinstance(key, list):
-            key = "+".join(key)
+            key = "+".join(map_key(k) for k in key)
+        else:
+            key = map_key(key)
 
         self.commands.run(f"xdotool key {key}", envs={"DISPLAY": self._display})