hyperbrowser 0.85.0__tar.gz → 0.87.0__tar.gz

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperbrowser
-Version: 0.85.0
+Version: 0.87.0
 Summary: Python SDK for hyperbrowser
 License: MIT
 License-File: LICENSE

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/hyperbrowser/client/managers/async_manager/sandbox.py

@@ -7,9 +7,14 @@ from ....models.sandbox import (
     SandboxExecParams,
     SandboxExposeParams,
     SandboxExposeResult,
+    SandboxImageListResponse,
+    SandboxListParams,
+    SandboxListResponse,
     SandboxMemorySnapshotParams,
     SandboxMemorySnapshotResult,
     SandboxRuntimeSession,
+    SandboxSnapshotListParams,
+    SandboxSnapshotListResponse,
     StartSandboxFromSnapshotParams,
 )
 from ....models.session import BasicResponse
@@ -288,6 +293,34 @@ class SandboxManager:
         await sandbox.connect()
         return sandbox
 
+    async def list(
+        self, params: SandboxListParams = SandboxListParams()
+    ) -> SandboxListResponse:
+        if not isinstance(params, SandboxListParams):
+            raise TypeError("params must be a SandboxListParams instance")
+        payload = await self._request(
+            "GET",
+            "/sandboxes",
+            params=params.model_dump(exclude_none=True, by_alias=True),
+        )
+        return SandboxListResponse(**payload)
+
+    async def list_images(self) -> SandboxImageListResponse:
+        payload = await self._request("GET", "/images")
+        return SandboxImageListResponse(**payload)
+
+    async def list_snapshots(
+        self, params: SandboxSnapshotListParams = SandboxSnapshotListParams()
+    ) -> SandboxSnapshotListResponse:
+        if not isinstance(params, SandboxSnapshotListParams):
+            raise TypeError("params must be a SandboxSnapshotListParams instance")
+        payload = await self._request(
+            "GET",
+            "/snapshots",
+            params=params.model_dump(exclude_none=True, by_alias=True),
+        )
+        return SandboxSnapshotListResponse(**payload)
+
     async def stop(self, sandbox_id: str) -> BasicResponse:
         payload = await self._request("PUT", f"/sandbox/{sandbox_id}/stop")
         return BasicResponse(**payload)

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/hyperbrowser/client/managers/async_manager/sandboxes/sandbox_files.py

@@ -18,6 +18,7 @@ from .....models.sandbox import (
     SandboxFileCopyParams,
     SandboxFileDeleteParams,
     SandboxFileInfo,
+    SandboxFileMoveParams,
     SandboxFileReadResult,
     SandboxFileSystemEvent,
     SandboxFileWriteEntry,
@@ -461,14 +462,24 @@ class SandboxFilesApi:
     ) -> bool:
         return await self.make_dir(path, parents=parents, mode=mode)
 
-    async def rename(self, old_path: str, new_path: str) -> SandboxFileInfo:
+    async def rename(
+        self,
+        old_path: str,
+        new_path: str,
+        *,
+        overwrite: Optional[bool] = None,
+    ) -> SandboxFileInfo:
+        payload = SandboxFileMoveParams(
+            source=old_path,
+            destination=new_path,
+            overwrite=overwrite,
+        ).model_dump(exclude_none=True)
+        payload["from"] = payload.pop("source")
+        payload["to"] = payload.pop("destination")
         payload = await self._transport.request_json(
             "/sandbox/files/move",
             method="POST",
-            json_body={
-                "from": old_path,
-                "to": new_path,
-            },
+            json_body=payload,
             headers={"content-type": "application/json"},
         )
         return _normalize_file_info(payload["entry"])
@@ -480,7 +491,7 @@ class SandboxFilesApi:
         destination: str,
         overwrite: Optional[bool] = None,
     ) -> SandboxFileInfo:
-        return await self.rename(source, destination)
+        return await self.rename(source, destination, overwrite=overwrite)
 
     async def remove(self, path: str, *, recursive: Optional[bool] = None) -> None:
         await self._transport.request_json(

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/hyperbrowser/client/managers/sync_manager/sandbox.py

@@ -7,9 +7,14 @@ from ....models.sandbox import (
     SandboxExecParams,
     SandboxExposeParams,
     SandboxExposeResult,
+    SandboxImageListResponse,
+    SandboxListParams,
+    SandboxListResponse,
     SandboxMemorySnapshotParams,
     SandboxMemorySnapshotResult,
     SandboxRuntimeSession,
+    SandboxSnapshotListParams,
+    SandboxSnapshotListResponse,
     StartSandboxFromSnapshotParams,
 )
 from ....models.session import BasicResponse
@@ -288,6 +293,34 @@ class SandboxManager:
         sandbox.connect()
         return sandbox
 
+    def list(
+        self, params: SandboxListParams = SandboxListParams()
+    ) -> SandboxListResponse:
+        if not isinstance(params, SandboxListParams):
+            raise TypeError("params must be a SandboxListParams instance")
+        payload = self._request(
+            "GET",
+            "/sandboxes",
+            params=params.model_dump(exclude_none=True, by_alias=True),
+        )
+        return SandboxListResponse(**payload)
+
+    def list_images(self) -> SandboxImageListResponse:
+        payload = self._request("GET", "/images")
+        return SandboxImageListResponse(**payload)
+
+    def list_snapshots(
+        self, params: SandboxSnapshotListParams = SandboxSnapshotListParams()
+    ) -> SandboxSnapshotListResponse:
+        if not isinstance(params, SandboxSnapshotListParams):
+            raise TypeError("params must be a SandboxSnapshotListParams instance")
+        payload = self._request(
+            "GET",
+            "/snapshots",
+            params=params.model_dump(exclude_none=True, by_alias=True),
+        )
+        return SandboxSnapshotListResponse(**payload)
+
     def stop(self, sandbox_id: str) -> BasicResponse:
         payload = self._request("PUT", f"/sandbox/{sandbox_id}/stop")
         return BasicResponse(**payload)

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/hyperbrowser/client/managers/sync_manager/sandboxes/sandbox_files.py

@@ -17,6 +17,7 @@ from .....models.sandbox import (
     SandboxFileCopyParams,
     SandboxFileDeleteParams,
     SandboxFileInfo,
+    SandboxFileMoveParams,
     SandboxFileReadResult,
     SandboxFileSystemEvent,
     SandboxFileWriteEntry,
@@ -442,14 +443,24 @@ class SandboxFilesApi:
     ) -> bool:
         return self.make_dir(path, parents=parents, mode=mode)
 
-    def rename(self, old_path: str, new_path: str) -> SandboxFileInfo:
+    def rename(
+        self,
+        old_path: str,
+        new_path: str,
+        *,
+        overwrite: Optional[bool] = None,
+    ) -> SandboxFileInfo:
+        payload = SandboxFileMoveParams(
+            source=old_path,
+            destination=new_path,
+            overwrite=overwrite,
+        ).model_dump(exclude_none=True)
+        payload["from"] = payload.pop("source")
+        payload["to"] = payload.pop("destination")
         payload = self._transport.request_json(
             "/sandbox/files/move",
             method="POST",
-            json_body={
-                "from": old_path,
-                "to": new_path,
-            },
+            json_body=payload,
             headers={"content-type": "application/json"},
         )
         return _normalize_file_info(payload["entry"])
@@ -461,7 +472,7 @@ class SandboxFilesApi:
         destination: str,
         overwrite: Optional[bool] = None,
     ) -> SandboxFileInfo:
-        return self.rename(source, destination)
+        return self.rename(source, destination, overwrite=overwrite)
 
     def remove(self, path: str, *, recursive: Optional[bool] = None) -> None:
         self._transport.request_json(

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/hyperbrowser/models/__init__.py

@@ -246,6 +246,12 @@ from .sandbox import (
     StartSandboxFromSnapshotParams,
     SandboxListParams,
     SandboxListResponse,
+    SandboxImageListResponse,
+    SandboxImageSummary,
+    SandboxSnapshotStatus,
+    SandboxSnapshotListResponse,
+    SandboxSnapshotSummary,
+    SandboxSnapshotListParams,
     SandboxMemorySnapshotParams,
     SandboxMemorySnapshotResult,
     SandboxExposeParams,
@@ -490,6 +496,12 @@ __all__ = [
     "StartSandboxFromSnapshotParams",
     "SandboxListParams",
     "SandboxListResponse",
+    "SandboxImageListResponse",
+    "SandboxImageSummary",
+    "SandboxSnapshotStatus",
+    "SandboxSnapshotListResponse",
+    "SandboxSnapshotSummary",
+    "SandboxSnapshotListParams",
     "SandboxMemorySnapshotParams",
     "SandboxMemorySnapshotResult",
     "SandboxExposeParams",

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/hyperbrowser/models/sandbox.py

@@ -23,6 +23,7 @@ SandboxProcessStatus = Literal[
     "killed",
     "timed_out",
 ]
+SandboxSnapshotStatus = Literal["creating", "created", "failed"]
 SandboxFileType = Literal["file", "dir"]
 SandboxFileEncoding = Literal["utf8", "base64"]
 SandboxFileReadFormat = Literal["text", "bytes", "blob", "stream"]
@@ -164,10 +165,9 @@ class StartSandboxFromSnapshotParams(CreateSandboxParams):
 
 
 class SandboxListParams(SandboxBaseModel):
-    status: Optional[SandboxStatus] = None
-    page: Optional[int] = None
-    limit: Optional[int] = None
-    search: Optional[str] = None
+    status: Optional[SandboxStatus] = Field(default=None, exclude=None)
+    page: int = Field(default=1, ge=1)
+    limit: int = Field(default=10, ge=1)
 
 
 class SandboxListResponse(SandboxBaseModel):
@@ -177,6 +177,51 @@ class SandboxListResponse(SandboxBaseModel):
     per_page: int = Field(alias="perPage")
 
 
+class SandboxImageSummary(SandboxBaseModel):
+    id: str
+    image_name: str = Field(alias="imageName")
+    namespace: str
+    uploaded: bool
+    created_at: datetime = Field(alias="createdAt")
+    updated_at: datetime = Field(alias="updatedAt")
+
+
+class SandboxImageListResponse(SandboxBaseModel):
+    images: List[SandboxImageSummary]
+    # TODO: add pagination metadata when /api/images supports it.
+    # total_count: Optional[int] = Field(default=None, alias="totalCount")
+    # page: Optional[int] = None
+    # per_page: Optional[int] = Field(default=None, alias="perPage")
+
+
+class SandboxSnapshotSummary(SandboxBaseModel):
+    id: str
+    snapshot_name: str = Field(alias="snapshotName")
+    namespace: str
+    image_namespace: str = Field(alias="imageNamespace")
+    image_name: str = Field(alias="imageName")
+    image_id: str = Field(alias="imageId")
+    status: SandboxSnapshotStatus
+    compatibility_tag: Optional[str] = Field(default=None, alias="compatibilityTag")
+    metadata: Dict[str, object]
+    uploaded: bool
+    created_at: datetime = Field(alias="createdAt")
+    updated_at: datetime = Field(alias="updatedAt")
+
+
+class SandboxSnapshotListParams(SandboxBaseModel):
+    status: Optional[SandboxSnapshotStatus] = Field(default=None, exclude=None)
+    limit: Optional[int] = Field(default=None, ge=1)
+
+
+class SandboxSnapshotListResponse(SandboxBaseModel):
+    snapshots: List[SandboxSnapshotSummary]
+    # TODO: add pagination metadata when /api/snapshots supports it.
+    # total_count: Optional[int] = Field(default=None, alias="totalCount")
+    # page: Optional[int] = None
+    # per_page: Optional[int] = Field(default=None, alias="perPage")
+
+
 class SandboxMemorySnapshotParams(SandboxBaseModel):
     snapshot_name: Optional[str] = Field(
         default=None, serialization_alias="snapshotName"

{hyperbrowser-0.85.0 → hyperbrowser-0.87.0}/pyproject.toml

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