add list_windows computer action (#80)

Author: NikhilShahi

hyperbrowser/client/managers/async_manager/computer_action.py

@@ -18,6 +18,7 @@
     ComputerActionMouseButton,
     GetClipboardTextActionParams,
     PutSelectionTextActionParams,
+    ListWindowsActionParams,
 )
 
 
@@ -175,3 +176,11 @@ async def put_selection_text(
             text=text, return_screenshot=return_screenshot
         )
         return await self._execute_request(session, params)
+
+    async def list_windows(
+        self,
+        session: Union[SessionDetail, str],
+        return_screenshot: bool = False,
+    ) -> ComputerActionResponse:
+        params = ListWindowsActionParams(return_screenshot=return_screenshot)
+        return await self._execute_request(session, params)

hyperbrowser/client/managers/sync_manager/computer_action.py

@@ -18,6 +18,7 @@
     ComputerActionMouseButton,
     GetClipboardTextActionParams,
     PutSelectionTextActionParams,
+    ListWindowsActionParams,
 )
 
 
@@ -175,3 +176,11 @@ def put_selection_text(
             text=text, return_screenshot=return_screenshot
         )
         return self._execute_request(session, params)
+
+    def list_windows(
+        self,
+        session: Union[SessionDetail, str],
+        return_screenshot: bool = False,
+    ) -> ComputerActionResponse:
+        params = ListWindowsActionParams(return_screenshot=return_screenshot)
+        return self._execute_request(session, params)

hyperbrowser/models/__init__.py

@@ -233,7 +233,10 @@
     ComputerActionMouseButton,
     GetClipboardTextActionParams,
     PutSelectionTextActionParams,
+    ListWindowsActionParams,
+    ComputerActionWindow,
     ComputerActionResponseDataClipboardText,
+    ComputerActionResponseDataListWindows,
     ComputerActionResponseData,
 )
 from .session import (
@@ -628,7 +631,10 @@
     "ComputerActionMouseButton",
     "GetClipboardTextActionParams",
     "PutSelectionTextActionParams",
+    "ListWindowsActionParams",
+    "ComputerActionWindow",
     "ComputerActionResponseDataClipboardText",
+    "ComputerActionResponseDataListWindows",
     "ComputerActionResponseData",
     # web
     "StartBatchFetchJobParams",

hyperbrowser/models/computer_action.py

@@ -18,6 +18,7 @@ class ComputerAction(str, Enum):
     TYPE_TEXT = "type_text"
     GET_CLIPBOARD_TEXT = "get_clipboard_text"
     PUT_SELECTION_TEXT = "put_selection_text"
+    LIST_WINDOWS = "list_windows"
 
 
 ComputerActionMouseButton = Literal[
@@ -183,6 +184,17 @@ class PutSelectionTextActionParams(BaseModel):
     )
 
 
+class ListWindowsActionParams(BaseModel):
+    """Parameters for list windows action."""
+
+    model_config = ConfigDict(use_enum_values=True)
+
+    action: Literal[ComputerAction.LIST_WINDOWS] = ComputerAction.LIST_WINDOWS
+    return_screenshot: bool = Field(
+        serialization_alias="returnScreenshot", default=False
+    )
+
+
 ComputerActionParams = Union[
     ClickActionParams,
     DragActionParams,
@@ -196,6 +208,7 @@ class PutSelectionTextActionParams(BaseModel):
     MouseUpActionParams,
     GetClipboardTextActionParams,
     PutSelectionTextActionParams,
+    ListWindowsActionParams,
 ]
 
 
@@ -207,7 +220,27 @@ class ComputerActionResponseDataClipboardText(BaseModel):
     clipboard_text: Optional[str] = Field(default=None, alias="clipboardText")
 
 
-ComputerActionResponseData = Union[ComputerActionResponseDataClipboardText]
+class ComputerActionWindow(BaseModel):
+    model_config = ConfigDict(populate_by_alias=True)
+
+    id: str
+    name: str
+    active: bool
+
+
+class ComputerActionResponseDataListWindows(BaseModel):
+    """Data for list windows action."""
+
+    model_config = ConfigDict(populate_by_alias=True)
+
+    active_window_id: str = Field(default="", alias="activeWindowId")
+    windows: List[ComputerActionWindow] = Field(default_factory=list)
+
+
+ComputerActionResponseData = Union[
+    ComputerActionResponseDataListWindows,
+    ComputerActionResponseDataClipboardText,
+]
 
 
 class ComputerActionResponse(BaseModel):

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hyperbrowser"
-version = "0.90.7"
+version = "0.90.8"
 description = "Python SDK for hyperbrowser"
 authors = ["Nikhil Shahi <nshahi1998@gmail.com>"]
 license = "MIT"