pdfdancer-client-python 0.3.12__py3-none-any.whl → 0.3.13__py3-none-any.whl

pdfdancer/__init__.py

@@ -28,6 +28,7 @@ from .models import (
     ImageTransformRequest,
     ImageTransformType,
     Line,
+    ModifyPathRequest,
     ObjectRef,
     ObjectType,
     Orientation,
@@ -36,6 +37,7 @@ from .models import (
     Paragraph,
     Path,
     PathGroupInfo,
+    PathObjectRef,
     PathSegment,
     Point,
     Position,
@@ -55,7 +57,7 @@ from .paragraph_builder import ParagraphBuilder
 from .path_builder import BezierBuilder, LineBuilder, PathBuilder
 from .text_line_builder import TextLineBuilder
 
-__version__ = "0.3.12"
+__version__ = "0.3.13"
 __all__ = [
     "PDFDancer",
     "ParagraphBuilder",
@@ -65,6 +67,8 @@ __all__ = [
     "LineBuilder",
     "BezierBuilder",
     "ObjectRef",
+    "PathObjectRef",
+    "ModifyPathRequest",
     "Position",
     "ObjectType",
     "Font",

pdfdancer/models.py

@@ -1895,3 +1895,85 @@ class ImageTransformRequest:
             result["fillColor"] = self.fill_color
 
         return result
+
+
+@dataclass
+class ModifyPathRequest:
+    """Request to modify path stroke and fill colors.
+
+    Parameters:
+    - object_ref: Reference to the path to modify.
+    - stroke_color: New stroke color (optional - null means don't change).
+    - fill_color: New fill color (optional - null means don't change).
+
+    Example:
+    ```python
+    req = ModifyPathRequest(object_ref=path_ref, stroke_color=Color(255, 0, 0), fill_color=None)
+    payload = req.to_dict()
+    ```
+    """
+
+    object_ref: ObjectRef
+    stroke_color: Optional[Color] = None
+    fill_color: Optional[Color] = None
+
+    def to_dict(self) -> dict:
+        """Convert to dictionary for JSON serialization."""
+        result: Dict[str, Any] = {
+            "ref": self.object_ref.to_dict(),
+        }
+
+        if self.stroke_color is not None:
+            result["strokeColor"] = {
+                "red": self.stroke_color.r,
+                "green": self.stroke_color.g,
+                "blue": self.stroke_color.b,
+                "alpha": self.stroke_color.a,
+            }
+
+        if self.fill_color is not None:
+            result["fillColor"] = {
+                "red": self.fill_color.r,
+                "green": self.fill_color.g,
+                "blue": self.fill_color.b,
+                "alpha": self.fill_color.a,
+            }
+
+        return result
+
+
+class PathObjectRef(ObjectRef):
+    """
+    Reference to a path object with stroke and fill color information.
+
+    Parameters (typically provided by the server):
+    - internal_id: Identifier of the path object.
+    - position: Position of the path.
+    - object_type: Should be ObjectType.PATH.
+    - stroke_color: Stroke/outline color of the path (optional).
+    - fill_color: Fill color of the path (optional).
+
+    Usage:
+    - Returned by find/snapshot APIs when querying paths.
+    - Pass to ModifyPathRequest to update path colors.
+    """
+
+    def __init__(
+        self,
+        internal_id: str,
+        position: Position,
+        object_type: ObjectType,
+        stroke_color: Optional[Color] = None,
+        fill_color: Optional[Color] = None,
+    ):
+        super().__init__(internal_id, position, object_type)
+        self.stroke_color = stroke_color
+        self.fill_color = fill_color
+
+    def get_stroke_color(self) -> Optional[Color]:
+        """Get the stroke/outline color of the path."""
+        return self.stroke_color
+
+    def get_fill_color(self) -> Optional[Color]:
+        """Get the fill color of the path."""
+        return self.fill_color

pdfdancer/pdfdancer_v1.py

@@ -47,6 +47,7 @@ from .models import (
     FontType,
     FormFieldRef,
     Image,
+    ModifyPathRequest,
     ModifyRequest,
     ModifyTextRequest,
     MoveRequest,
@@ -58,6 +59,7 @@ from .models import (
     PageSize,
     PageSnapshot,
     Paragraph,
+    PathObjectRef,
     Position,
     PositionMode,
     RedactRequest,
@@ -2755,6 +2757,38 @@ class PDFDancer:
         self._invalidate_snapshots()
         return result
 
+    def _modify_path(
+        self,
+        object_ref: ObjectRef,
+        stroke_color: Optional[Color],
+        fill_color: Optional[Color],
+    ) -> CommandResult:
+        """
+        Modifies the stroke and fill colors of a path object.
+
+        Args:
+            object_ref: Reference to the path to modify.
+            stroke_color: New stroke color (None means don't change).
+            fill_color: New fill color (None means don't change).
+
+        Returns:
+            CommandResult indicating success or failure.
+        """
+        if object_ref is None:
+            raise ValidationException("Object reference cannot be null")
+
+        request_data = ModifyPathRequest(
+            object_ref=object_ref,
+            stroke_color=stroke_color,
+            fill_color=fill_color,
+        ).to_dict()
+        response = self._make_request("PUT", "/pdf/modify/path", data=request_data)
+        result = CommandResult.from_dict(response.json())
+
+        # Invalidate snapshot caches after mutation
+        self._invalidate_snapshots()
+        return result
+
     # Font Operations
 
     def find_fonts(self, font_name: str, font_size: int) -> List[Font]:
@@ -3159,6 +3193,43 @@ class PDFDancer:
             value=obj_data["value"] if "value" in obj_data else None,
         )
 
+    def _parse_path_object_ref(self, obj_data: dict) -> PathObjectRef:
+        """Parse JSON object data into PathObjectRef instance with color information."""
+        position_data = obj_data.get("position", {})
+        position = self._parse_position(position_data) if position_data else None
+
+        object_type = ObjectType(obj_data["type"])
+
+        # Parse stroke color if present
+        stroke_color = None
+        stroke_color_data = obj_data.get("strokeColor")
+        if isinstance(stroke_color_data, dict):
+            red = stroke_color_data.get("red")
+            green = stroke_color_data.get("green")
+            blue = stroke_color_data.get("blue")
+            alpha = stroke_color_data.get("alpha", 255)
+            if all(isinstance(v, int) for v in [red, green, blue]):
+                stroke_color = Color(red, green, blue, alpha)
+
+        # Parse fill color if present
+        fill_color = None
+        fill_color_data = obj_data.get("fillColor")
+        if isinstance(fill_color_data, dict):
+            red = fill_color_data.get("red")
+            green = fill_color_data.get("green")
+            blue = fill_color_data.get("blue")
+            alpha = fill_color_data.get("alpha", 255)
+            if all(isinstance(v, int) for v in [red, green, blue]):
+                fill_color = Color(red, green, blue, alpha)
+
+        return PathObjectRef(
+            internal_id=obj_data["internalId"] if "internalId" in obj_data else None,
+            position=position,
+            object_type=object_type,
+            stroke_color=stroke_color,
+            fill_color=fill_color,
+        )
+
     @staticmethod
     def _parse_position(pos_data: dict) -> Position:
         """Parse JSON position data into Position instance."""
@@ -3473,6 +3544,9 @@ class PDFDancer:
                 ):
                     # Parse as FormFieldRef to capture name and value
                     elements.append(self._parse_form_field_ref(elem_data))
+                elif elem_type == ObjectType.PATH:
+                    # Parse as PathObjectRef to capture stroke/fill colors
+                    elements.append(self._parse_path_object_ref(elem_data))
                 else:
                     # Parse as basic ObjectRef
                     elements.append(self._parse_object_ref(elem_data))
@@ -3526,9 +3600,7 @@ class PDFDancer:
             self._client.close()
 
     def _to_path_objects(self, refs: List[ObjectRef]) -> List[PathObject]:
-        return [
-            PathObject(self, ref.internal_id, ref.type, ref.position) for ref in refs
-        ]
+        return [PathObject(self, ref) for ref in refs]
 
     def _to_paragraph_objects(self, refs: List[TextObjectRef]) -> List[ParagraphObject]:
         return [ParagraphObject(self, ref) for ref in refs]

pdfdancer/types.py

@@ -4,7 +4,7 @@ import sys
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Optional
 
-from . import FormFieldRef, ObjectRef, ObjectType, Point, Position, TextObjectRef
+from . import FormFieldRef, ObjectRef, ObjectType, PathObjectRef, Point, Position, TextObjectRef
 from .exceptions import ValidationException
 
 if TYPE_CHECKING:
@@ -86,11 +86,44 @@ class PDFObjectBase:
 class PathObject(PDFObjectBase):
     """Represents a vector path object inside a PDF page."""
 
+    def __init__(self, client: "PDFDancer", object_ref):
+        """
+        Initialize a PathObject.
+
+        Args:
+            client: PDFDancer client instance
+            object_ref: ObjectRef or PathObjectRef with path data
+        """
+        super().__init__(
+            client, object_ref.internal_id, object_ref.type, object_ref.position
+        )
+        self._object_ref = object_ref
+
     @property
     def bounding_box(self) -> Optional[BoundingRect]:
         """Optional bounding rectangle (if available)."""
         return self.position.bounding_rect
 
+    def edit(self) -> PathEditSession:
+        """Start a fluent editing session to modify path colors."""
+        return PathEditSession(self._client, self.object_ref())
+
+    def object_ref(self):
+        """Return an ObjectRef for this path."""
+        return self._object_ref
+
+    def get_stroke_color(self) -> Optional["Color"]:
+        """Get the stroke/outline color of the path, or None if not set."""
+        if isinstance(self._object_ref, PathObjectRef):
+            return self._object_ref.get_stroke_color()
+        return None
+
+    def get_fill_color(self) -> Optional["Color"]:
+        """Get the fill color of the path, or None if not set."""
+        if isinstance(self._object_ref, PathObjectRef):
+            return self._object_ref.get_fill_color()
+        return None
+
     def __eq__(self, other):
         if not isinstance(other, PathObject):
             return False
@@ -748,3 +781,61 @@ class FormFieldObject(PDFObjectBase):
             and self.name == other.name
             and self.value == other.value
         )
+
+
+class PathEditSession:
+    """
+    Fluent editing helper for modifying path stroke and fill colors.
+    """
+
+    def __init__(self, client: "PDFDancer", object_ref):
+        self._client = client
+        self._object_ref = object_ref
+        self._stroke_color = None
+        self._fill_color = None
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if exc_type:
+            return False
+        self.apply()
+        return False
+
+    def stroke_color(self, color) -> "PathEditSession":
+        """
+        Set the stroke/outline color.
+
+        Args:
+            color: The stroke color (Color object)
+
+        Returns:
+            Self for method chaining
+        """
+        self._stroke_color = color
+        return self
+
+    def fill_color(self, color) -> "PathEditSession":
+        """
+        Set the fill color.
+
+        Args:
+            color: The fill color (Color object)
+
+        Returns:
+            Self for method chaining
+        """
+        self._fill_color = color
+        return self
+
+    def apply(self):
+        """
+        Apply the color modifications to the path.
+
+        Returns:
+            CommandResult indicating success or failure
+        """
+        return self._client._modify_path(
+            self._object_ref, self._stroke_color, self._fill_color
+        )

{pdfdancer_client_python-0.3.12.dist-info → pdfdancer_client_python-0.3.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdfdancer-client-python
-Version: 0.3.12
+Version: 0.3.13
 Summary: Python client for PDFDancer API
 Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
 License: 

{pdfdancer_client_python-0.3.12.dist-info → pdfdancer_client_python-0.3.13.dist-info}/RECORD

@@ -1,17 +1,17 @@
-pdfdancer/__init__.py,sha256=DiYQ2gDQ4kYu8eUXc7Z-0vgdoeBi0Cek5jusrq0LYVE,2884
+pdfdancer/__init__.py,sha256=3gVfEG-Fgz2Zes2zS6QfWhE2_TbtSFvDeyc_EGD1azE,2972
 pdfdancer/exceptions.py,sha256=U6kD3NvcdNt05_OU11Tml5dXGtlodEtYC9zcV4fHXkc,2270
 pdfdancer/fingerprint.py,sha256=eL3PHPgv-knMya7s95RXg3qzzpkAA1aevxqb6tuOb34,3061
 pdfdancer/image_builder.py,sha256=aBxMFAMFzzbGTjlVH0hi94mA81cH8tp37Pk84HRPV00,1892
-pdfdancer/models.py,sha256=nrR8ssEIz7BttWCMv7F0oriTego5Jh-h-34GvJmoni8,60462
+pdfdancer/models.py,sha256=D8v42xWAqXQ7-q3gjpb5z5Gd3dxvjc0NE779Gd2-fBE,62964
 pdfdancer/page_builder.py,sha256=ARWLRtlrLGbES-0nbiigTOsRVmodRX0DNK8YIAkA9Ig,3850
 pdfdancer/paragraph_builder.py,sha256=OmhzYazMnq0n0rhrjWcKbo0LQfEC7BZoiLB29ycF630,20504
 pdfdancer/path_builder.py,sha256=safKb_IeHRWlQbyBTIXfcoBfXxUZhuzYvBIob5Tbp-8,23938
-pdfdancer/pdfdancer_v1.py,sha256=JaiB47v_zgUwb7OtnmnVDt4jroxB5Bh6sGQpAU8ZIBg,138359
+pdfdancer/pdfdancer_v1.py,sha256=u7LmwbVJ9szcS31aFYtSXo595nVZUP9RgTq1iskgzKI,141221
 pdfdancer/text_line_builder.py,sha256=8jYknV4hw0fyzwX0OI_oLvnh5aMmCV3jXaVkmYLu6MQ,10273
-pdfdancer/types.py,sha256=w0dJ6JcHgm62BFDzZTx7v10GymjNaZw8x8lKfg-U2zA,24949
-pdfdancer_client_python-0.3.12.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-pdfdancer_client_python-0.3.12.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
-pdfdancer_client_python-0.3.12.dist-info/METADATA,sha256=8uO4RQWyE64otUm9cY_Vj9gZsBH5-JpajgDcvijv_JM,28756
-pdfdancer_client_python-0.3.12.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-pdfdancer_client_python-0.3.12.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
-pdfdancer_client_python-0.3.12.dist-info/RECORD,,
+pdfdancer/types.py,sha256=GNThFde9dRloHB482nu3txhYc9wysI244cM1D7L8fa4,27501
+pdfdancer_client_python-0.3.13.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pdfdancer_client_python-0.3.13.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
+pdfdancer_client_python-0.3.13.dist-info/METADATA,sha256=xMyuh8uwwfxel2KotjXORNIpB-fxPmFaXMZjsWRXd6k,28756
+pdfdancer_client_python-0.3.13.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pdfdancer_client_python-0.3.13.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
+pdfdancer_client_python-0.3.13.dist-info/RECORD,,