cyberdesk 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

cyberdesk/actions.py

@@ -1,38 +1,118 @@
-from .types import (
+from typing import Union, List, Optional
+
+from openapi_client.api_reference_client.types import UNSET
+from openapi_client.api_reference_client.models import (
     PostV1DesktopIdComputerActionClickMouseAction,
+    PostV1DesktopIdComputerActionClickMouseActionType,
+    PostV1DesktopIdComputerActionClickMouseActionButton as ClickMouseButton,
+    PostV1DesktopIdComputerActionClickMouseActionClickType as ClickMouseActionType,
     PostV1DesktopIdComputerActionDragMouseAction,
+    PostV1DesktopIdComputerActionDragMouseActionType,
+    PostV1DesktopIdComputerActionDragMouseActionStart,
+    PostV1DesktopIdComputerActionDragMouseActionEnd,
     PostV1DesktopIdComputerActionGetCursorPositionAction,
+    PostV1DesktopIdComputerActionGetCursorPositionActionType,
     PostV1DesktopIdComputerActionMoveMouseAction,
+    PostV1DesktopIdComputerActionMoveMouseActionType,
     PostV1DesktopIdComputerActionPressKeysAction,
+    PostV1DesktopIdComputerActionPressKeysActionType,
+    PostV1DesktopIdComputerActionPressKeysActionKeyActionType as PressKeyActionType,
     PostV1DesktopIdComputerActionScreenshotAction,
+    PostV1DesktopIdComputerActionScreenshotActionType,
     PostV1DesktopIdComputerActionScrollAction,
+    PostV1DesktopIdComputerActionScrollActionType,
+    PostV1DesktopIdComputerActionScrollActionDirection as ScrollDirection,
     PostV1DesktopIdComputerActionTypeTextAction,
+    PostV1DesktopIdComputerActionTypeTextActionType,
     PostV1DesktopIdComputerActionWaitAction,
+    PostV1DesktopIdComputerActionWaitActionType,
 )
 
-def click_mouse(x: int, y: int, button: str = "left") -> PostV1DesktopIdComputerActionClickMouseAction:
-    return PostV1DesktopIdComputerActionClickMouseAction(type="click_mouse", x=x, y=y, button=button)
+# Re-export the original Enum types under their aliased names for user convenience if they need to import them
+# This makes `from cyberdesk.actions import ClickMouseButton` possible.
+
+def click_mouse(
+    x: Optional[int] = None,
+    y: Optional[int] = None,
+    button: Optional[ClickMouseButton] = None,
+    num_of_clicks: Optional[int] = None,
+    click_type: Optional[ClickMouseActionType] = None,
+) -> PostV1DesktopIdComputerActionClickMouseAction:
+    return PostV1DesktopIdComputerActionClickMouseAction(
+        type_=PostV1DesktopIdComputerActionClickMouseActionType.CLICK_MOUSE,
+        x=x if x is not None else UNSET,
+        y=y if y is not None else UNSET,
+        button=button if button is not None else UNSET,
+        num_of_clicks=num_of_clicks if num_of_clicks is not None else UNSET,
+        click_type=click_type if click_type is not None else UNSET
+    )
 
-def drag_mouse(start_x: int, start_y: int, end_x: int, end_y: int, button: str = "left") -> PostV1DesktopIdComputerActionDragMouseAction:
-    return PostV1DesktopIdComputerActionDragMouseAction(type="drag_mouse", start_x=start_x, start_y=start_y, end_x=end_x, end_y=end_y, button=button)
+def drag_mouse(
+    start_x: int,
+    start_y: int,
+    end_x: int,
+    end_y: int
+) -> PostV1DesktopIdComputerActionDragMouseAction:
+    start_model = PostV1DesktopIdComputerActionDragMouseActionStart(x=start_x, y=start_y)
+    end_model = PostV1DesktopIdComputerActionDragMouseActionEnd(x=end_x, y=end_y)
+    return PostV1DesktopIdComputerActionDragMouseAction(
+        type_=PostV1DesktopIdComputerActionDragMouseActionType.DRAG_MOUSE,
+        start=start_model,
+        end=end_model
+    )
 
 def get_cursor_position() -> PostV1DesktopIdComputerActionGetCursorPositionAction:
-    return PostV1DesktopIdComputerActionGetCursorPositionAction(type="get_cursor_position")
+    return PostV1DesktopIdComputerActionGetCursorPositionAction(
+        type_=PostV1DesktopIdComputerActionGetCursorPositionActionType.GET_CURSOR_POSITION
+    )
 
-def move_mouse(x: int, y: int) -> PostV1DesktopIdComputerActionMoveMouseAction:
-    return PostV1DesktopIdComputerActionMoveMouseAction(type="move_mouse", x=x, y=y)
+def move_mouse(
+    x: int,
+    y: int
+) -> PostV1DesktopIdComputerActionMoveMouseAction:
+    return PostV1DesktopIdComputerActionMoveMouseAction(
+        type_=PostV1DesktopIdComputerActionMoveMouseActionType.MOVE_MOUSE,
+        x=x,
+        y=y
+    )
 
-def press_keys(keys: list[str]) -> PostV1DesktopIdComputerActionPressKeysAction:
-    return PostV1DesktopIdComputerActionPressKeysAction(type="press_keys", keys=keys)
+def press_keys(
+    keys: Optional[Union[str, List[str]]] = None,
+    key_action_type: Optional[PressKeyActionType] = None
+) -> PostV1DesktopIdComputerActionPressKeysAction:
+    return PostV1DesktopIdComputerActionPressKeysAction(
+        type_=PostV1DesktopIdComputerActionPressKeysActionType.PRESS_KEYS,
+        keys=keys if keys is not None else UNSET,
+        key_action_type=key_action_type if key_action_type is not None else UNSET
+    )
 
 def screenshot() -> PostV1DesktopIdComputerActionScreenshotAction:
-    return PostV1DesktopIdComputerActionScreenshotAction(type="screenshot")
+    return PostV1DesktopIdComputerActionScreenshotAction(
+        type_=PostV1DesktopIdComputerActionScreenshotActionType.SCREENSHOT
+    )
 
-def scroll(dx: int, dy: int) -> PostV1DesktopIdComputerActionScrollAction:
-    return PostV1DesktopIdComputerActionScrollAction(type="scroll", dx=dx, dy=dy)
+def scroll(
+    direction: ScrollDirection,
+    amount: int
+) -> PostV1DesktopIdComputerActionScrollAction:
+    return PostV1DesktopIdComputerActionScrollAction(
+        type_=PostV1DesktopIdComputerActionScrollActionType.SCROLL,
+        direction=direction,
+        amount=amount
+    )
 
-def type_text(text: str) -> PostV1DesktopIdComputerActionTypeTextAction:
-    return PostV1DesktopIdComputerActionTypeTextAction(type="type", text=text)
+def type_text(
+    text: str
+) -> PostV1DesktopIdComputerActionTypeTextAction:
+    return PostV1DesktopIdComputerActionTypeTextAction(
+        type_=PostV1DesktopIdComputerActionTypeTextActionType.TYPE,
+        text=text
+    )
 
-def wait(ms: int) -> PostV1DesktopIdComputerActionWaitAction:
-    return PostV1DesktopIdComputerActionWaitAction(type="wait", ms=ms) 
+def wait(
+    ms: int
+) -> PostV1DesktopIdComputerActionWaitAction:
+    return PostV1DesktopIdComputerActionWaitAction(
+        type_=PostV1DesktopIdComputerActionWaitActionType.WAIT,
+        ms=ms
+    ) 

{cyberdesk-0.2.6.dist-info → cyberdesk-0.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberdesk
-Version: 0.2.6
+Version: 0.2.7
 Summary: The official Python SDK for Cyberdesk
 Author-email: Cyberdesk Team <dev@cyberdesk.io>
 License-Expression: MIT
@@ -71,9 +71,9 @@ print('Desktop info:', info)
 ### Perform a Computer Action (e.g., Mouse Click)
 
 ```python
-from cyberdesk.actions import click_mouse
+from cyberdesk.actions import click_mouse, ClickMouseButton
 
-action = click_mouse(x=100, y=150, button="left")
+action = click_mouse(x=100, y=150, button=ClickMouseButton.LEFT)
 action_result = client.execute_computer_action("your-desktop-id", action)
 
 if hasattr(action_result, 'error') and action_result.error:
@@ -106,9 +106,9 @@ To create computer actions (mouse, keyboard, etc.), use the factory functions in
 
 **Example:**
 ```python
-from cyberdesk.actions import click_mouse, type_text
+from cyberdesk.actions import click_mouse, type_text, ClickMouseButton
 
-action1 = click_mouse(x=100, y=200, button="left")
+action1 = click_mouse(x=100, y=200, button=ClickMouseButton.LEFT)
 action2 = type_text(text="Hello, world!")
 
 client.execute_computer_action("your-desktop-id", action1)
@@ -136,14 +136,14 @@ All methods are also available as async variants (prefixed with `async_`). Examp
 ```python
 import asyncio
 from cyberdesk import CyberdeskClient
-from cyberdesk.actions import click_mouse
+from cyberdesk.actions import click_mouse, ClickMouseButton
 
 async def main():
     client = CyberdeskClient(api_key="YOUR_API_KEY")
     result = await client.async_launch_desktop(timeout_ms=10000)
     print(result)
     # Example async computer action
-    action = click_mouse(x=100, y=200)
+    action = click_mouse(x=100, y=200, button=ClickMouseButton.LEFT)
     await client.async_execute_computer_action("your-desktop-id", action)
     # ... use other async_ methods as needed
 
@@ -157,9 +157,11 @@ asyncio.run(main())
 All request/response types are available from the generated models, and all computer actions are available as factory functions in `cyberdesk.actions` for ergonomic, type-safe usage.
 
 ```python
-from cyberdesk.actions import click_mouse, drag_mouse, type_text, wait, scroll, move_mouse, press_keys, screenshot, get_cursor_position
+from cyberdesk.actions import click_mouse, drag_mouse, type_text, wait, scroll, move_mouse, press_keys, screenshot, get_cursor_position, ClickMouseButton, ClickMouseActionType, PressKeyActionType, ScrollDirection
 ```
 
+# Note: All action enums (e.g., ClickMouseButton, ClickMouseActionType, PressKeyActionType, ScrollDirection, etc.) are available from cyberdesk.actions for type-safe usage.
+
 ---
 
 ## For Cyberdesk Team: Publishing to PyPI

{cyberdesk-0.2.6.dist-info → cyberdesk-0.2.7.dist-info}/RECORD

@@ -1,8 +1,8 @@
 cyberdesk/__init__.py,sha256=36X_HPAXaE9dfr3OmHbTrRgpm3b90W5TiOf0eAg-cmw,163
-cyberdesk/actions.py,sha256=O8AV9hsPMvhSn2qZHaSuGfjMaAJeLoHdnd10LT_4_Ws,2069
+cyberdesk/actions.py,sha256=5simzCOs5xDNMm9DmuXQzpxBJlt8-H5ipU3COL8UBpo,4773
 cyberdesk/client.py,sha256=kxtkdh7AjNuXU8u2rAGhHQTuUKRLyXvX_h7jtdgLzrk,3807
 cyberdesk/types.py,sha256=5jJSShzk3G8DqT0uRc8NFMlSru46tP9q3KJXcZhNRhc,1975
-cyberdesk-0.2.6.dist-info/licenses/LICENSE,sha256=06Op63FCwGhuUOz__M8IZW5sxd29WxyGC4X5-Uih7IQ,1071
+cyberdesk-0.2.7.dist-info/licenses/LICENSE,sha256=06Op63FCwGhuUOz__M8IZW5sxd29WxyGC4X5-Uih7IQ,1071
 openapi_client/api_reference_client/__init__.py,sha256=AKzi7ml3W37ADpacR564Q0j8Vsls9eFRsccqBgVWUNk,164
 openapi_client/api_reference_client/client.py,sha256=fXqcOZ8-Gse8ibdNn29cB93rozF_LAmSuofr5fMH0bw,12687
 openapi_client/api_reference_client/errors.py,sha256=DqMs2X8xF-YlxOWUYdkm_1wiQyDOKtWzYSiETtsXGjg,562
@@ -130,7 +130,7 @@ openapi_client/api_reference_client/models/post_v1_desktop_response_500.py,sha25
 openapi_client/api_reference_client/models/post_v1_desktop_response_500_status.py,sha256=xZ16zTTNQmzXJ_kGwZ0Dpzgfb3pYAfXgvSybiTohs1M,163
 openapi_client/api_reference_client/models/post_v1_desktop_response_502.py,sha256=AtVm799Itz2A2-cQOwHu-1japGSXVvMDUTETLDvTrAI,2036
 openapi_client/api_reference_client/models/post_v1_desktop_response_502_status.py,sha256=y45sxeHU0bzaR2hkDQLLUN-NGr3OtJ_ofqdywlL6kZA,163
-cyberdesk-0.2.6.dist-info/METADATA,sha256=Ut3KsH-nYSKOpY1CBaqzmpQ6TuFW_7NBFa0C8XxTiWg,6426
-cyberdesk-0.2.6.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-cyberdesk-0.2.6.dist-info/top_level.txt,sha256=qTYHZHVHh3VClNPQsiFFA8p8tmJgFGhq9G1COd-pX_A,25
-cyberdesk-0.2.6.dist-info/RECORD,,
+cyberdesk-0.2.7.dist-info/METADATA,sha256=b_G-VoXyh3vzMoezQsmk19OnQ7qbAtMDrsPnTOSwSh8,6793
+cyberdesk-0.2.7.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+cyberdesk-0.2.7.dist-info/top_level.txt,sha256=qTYHZHVHh3VClNPQsiFFA8p8tmJgFGhq9G1COd-pX_A,25
+cyberdesk-0.2.7.dist-info/RECORD,,