pdfdancer-client-python 0.3.8__tar.gz → 0.3.9__tar.gz

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/PKG-INFO

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

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/docs/api-schemas/v0.yml

@@ -458,7 +458,7 @@ paths:
           description: removeTenantUser 200 response
   /config:
     get:
-      operationId: findFont
+      operationId: getConfig
       parameters:
       - name: v
         in: query
@@ -482,7 +482,7 @@ paths:
           type: string
       responses:
         "200":
-          description: findFont 200 response
+          description: getConfig 200 response
           content:
             application/json:
               schema:
@@ -2257,6 +2257,51 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/CommandResult"
+  /pii/detect:
+    post:
+      operationId: detectPii
+      parameters:
+      - name: v
+        in: query
+        description: API version
+        schema:
+          type: string
+      - name: api-version
+        in: query
+        description: API version
+        schema:
+          type: string
+      - name: X-API-VERSION
+        in: header
+        description: API version
+        schema:
+          type: string
+      - name: Accept-Version
+        in: header
+        description: API version
+        schema:
+          type: string
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                pdf:
+                  type: string
+                  format: binary
+            encoding:
+              pdf:
+                contentType: application/octet-stream
+                explode: false
+        required: true
+      responses:
+        "200":
+          description: detectPii 200 response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DocumentPiiResponse"
   /ping:
     get:
       operationId: index
@@ -3823,6 +3868,36 @@ components:
           type: string
         systemFontName:
           type: string
+    DocumentPiiResponse:
+      required:
+      - errors
+      - pageCount
+      - paragraphsAnalyzed
+      - paragraphsWithPii
+      - results
+      - totalEntities
+      type: object
+      properties:
+        pageCount:
+          type: integer
+          format: int32
+        paragraphsAnalyzed:
+          type: integer
+          format: int32
+        paragraphsWithPii:
+          type: integer
+          format: int32
+        totalEntities:
+          type: integer
+          format: int32
+        results:
+          type: array
+          items:
+            $ref: "#/components/schemas/ParagraphPiiResult"
+        errors:
+          type: array
+          items:
+            type: string
     DocumentSnapshot:
       required:
       - fonts
@@ -4041,6 +4116,26 @@ components:
           nullable: true
           allOf:
           - $ref: "#/components/schemas/ImageTransformRequest.FlipDirection"
+        fillRegionX:
+          type: integer
+          format: int32
+          nullable: true
+        fillRegionY:
+          type: integer
+          format: int32
+          nullable: true
+        fillRegionWidth:
+          type: integer
+          format: int32
+          nullable: true
+        fillRegionHeight:
+          type: integer
+          format: int32
+          nullable: true
+        fillColor:
+          type: integer
+          format: int32
+          nullable: true
     ImageTransformRequest.FlipDirection:
       type: string
       enum:
@@ -4056,6 +4151,7 @@ components:
       - CROP
       - OPACITY
       - FLIP
+      - FILL_REGION
     JvmStatsService.BufferPoolStats:
       required:
       - count
@@ -4320,6 +4416,23 @@ components:
             $ref: "#/components/schemas/Point"
           objectType:
             $ref: "#/components/schemas/ObjectType"
+    MatchedWord:
+      required:
+      - boundingBox
+      - id
+      - text
+      - wordIndex
+      type: object
+      properties:
+        id:
+          type: string
+        wordIndex:
+          type: integer
+          format: int32
+        text:
+          type: string
+        boundingBox:
+          $ref: "#/components/schemas/BoundingRect"
     MetricsBuffer.BufferStats:
       required:
       - configEnabled
@@ -4585,6 +4698,28 @@ components:
             $ref: "#/components/schemas/Font"
           text:
             type: string
+    ParagraphPiiResult:
+      required:
+      - matches
+      - pageIndex
+      - paragraphId
+      - position
+      - text
+      type: object
+      properties:
+        pageIndex:
+          type: integer
+          format: int32
+        paragraphId:
+          type: string
+        text:
+          type: string
+        position:
+          $ref: "#/components/schemas/Position"
+        matches:
+          type: array
+          items:
+            $ref: "#/components/schemas/PiiMatch"
     Path:
       type: object
       allOf:
@@ -4629,6 +4764,33 @@ components:
       oneOf:
       - $ref: "#/components/schemas/Line"
       - $ref: "#/components/schemas/Bezier"
+    PiiMatch:
+      required:
+      - end
+      - score
+      - start
+      - text
+      - type
+      - words
+      type: object
+      properties:
+        type:
+          type: string
+        text:
+          type: string
+        start:
+          type: integer
+          format: int32
+        end:
+          type: integer
+          format: int32
+        score:
+          type: number
+          format: double
+        words:
+          type: array
+          items:
+            $ref: "#/components/schemas/MatchedWord"
     Point:
       required:
       - x

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/docs/api-schemas/v1.yml

@@ -458,7 +458,7 @@ paths:
           description: removeTenantUser 200 response
   /config:
     get:
-      operationId: findFont
+      operationId: getConfig
       parameters:
       - name: v
         in: query
@@ -482,7 +482,7 @@ paths:
           type: string
       responses:
         "200":
-          description: findFont 200 response
+          description: getConfig 200 response
           content:
             application/json:
               schema:
@@ -2257,6 +2257,51 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/CommandResult"
+  /pii/detect:
+    post:
+      operationId: detectPii
+      parameters:
+      - name: v
+        in: query
+        description: API version
+        schema:
+          type: string
+      - name: api-version
+        in: query
+        description: API version
+        schema:
+          type: string
+      - name: X-API-VERSION
+        in: header
+        description: API version
+        schema:
+          type: string
+      - name: Accept-Version
+        in: header
+        description: API version
+        schema:
+          type: string
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                pdf:
+                  type: string
+                  format: binary
+            encoding:
+              pdf:
+                contentType: application/octet-stream
+                explode: false
+        required: true
+      responses:
+        "200":
+          description: detectPii 200 response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DocumentPiiResponse"
   /ping:
     get:
       operationId: index
@@ -2723,16 +2768,10 @@ paths:
                 $ref: "#/components/schemas/SubscriptionController.SubscriptionStatus"
   /template/replace:
     post:
-      summary: Performs batch template placeholder replacements in a PDF document.
-      description: "Performs batch template placeholder replacements in a PDF document.\
-        \ This operation finds exact text matches for placeholders and replaces them\
-        \ with specified content, optionally with formatting overrides. All placeholders\
-        \ must be found or the operation fails atomically."
       operationId: replaceTemplates
       parameters:
       - name: X-Session-Id
         in: header
-        description: unique identifier for the user session containing the PDF
         required: true
         schema:
           type: string
@@ -2757,7 +2796,6 @@ paths:
         schema:
           type: string
       requestBody:
-        description: replacement specifications including placeholders and new text
         content:
           application/json:
             schema:
@@ -2765,7 +2803,7 @@ paths:
         required: true
       responses:
         "200":
-          description: HTTP response indicating success or failure with error details
+          description: replaceTemplates 200 response
           content:
             application/json:
               schema:
@@ -3841,6 +3879,36 @@ components:
           type: string
         systemFontName:
           type: string
+    DocumentPiiResponse:
+      required:
+      - errors
+      - pageCount
+      - paragraphsAnalyzed
+      - paragraphsWithPii
+      - results
+      - totalEntities
+      type: object
+      properties:
+        pageCount:
+          type: integer
+          format: int32
+        paragraphsAnalyzed:
+          type: integer
+          format: int32
+        paragraphsWithPii:
+          type: integer
+          format: int32
+        totalEntities:
+          type: integer
+          format: int32
+        results:
+          type: array
+          items:
+            $ref: "#/components/schemas/ParagraphPiiResult"
+        errors:
+          type: array
+          items:
+            type: string
     DocumentSnapshot:
       required:
       - fonts
@@ -4077,6 +4145,26 @@ components:
           nullable: true
           allOf:
           - $ref: "#/components/schemas/ImageTransformRequest.FlipDirection"
+        fillRegionX:
+          type: integer
+          format: int32
+          nullable: true
+        fillRegionY:
+          type: integer
+          format: int32
+          nullable: true
+        fillRegionWidth:
+          type: integer
+          format: int32
+          nullable: true
+        fillRegionHeight:
+          type: integer
+          format: int32
+          nullable: true
+        fillColor:
+          type: integer
+          format: int32
+          nullable: true
     ImageTransformRequest.FlipDirection:
       type: string
       enum:
@@ -4092,6 +4180,7 @@ components:
       - CROP
       - OPACITY
       - FLIP
+      - FILL_REGION
     JvmStatsService.BufferPoolStats:
       required:
       - count
@@ -4356,6 +4445,23 @@ components:
             $ref: "#/components/schemas/Point"
           objectType:
             $ref: "#/components/schemas/ObjectType"
+    MatchedWord:
+      required:
+      - boundingBox
+      - id
+      - text
+      - wordIndex
+      type: object
+      properties:
+        id:
+          type: string
+        wordIndex:
+          type: integer
+          format: int32
+        text:
+          type: string
+        boundingBox:
+          $ref: "#/components/schemas/BoundingRect"
     MetricsBuffer.BufferStats:
       required:
       - configEnabled
@@ -4638,6 +4744,28 @@ components:
             $ref: "#/components/schemas/Font"
           text:
             type: string
+    ParagraphPiiResult:
+      required:
+      - matches
+      - pageIndex
+      - paragraphId
+      - position
+      - text
+      type: object
+      properties:
+        pageIndex:
+          type: integer
+          format: int32
+        paragraphId:
+          type: string
+        text:
+          type: string
+        position:
+          $ref: "#/components/schemas/Position"
+        matches:
+          type: array
+          items:
+            $ref: "#/components/schemas/PiiMatch"
     Path:
       type: object
       allOf:
@@ -4682,6 +4810,33 @@ components:
       oneOf:
       - $ref: "#/components/schemas/Line"
       - $ref: "#/components/schemas/Bezier"
+    PiiMatch:
+      required:
+      - end
+      - score
+      - start
+      - text
+      - type
+      - words
+      type: object
+      properties:
+        type:
+          type: string
+        text:
+          type: string
+        start:
+          type: integer
+          format: int32
+        end:
+          type: integer
+          format: int32
+        score:
+          type: number
+          format: double
+        words:
+          type: array
+          items:
+            $ref: "#/components/schemas/MatchedWord"
     Point:
       required:
       - x

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pdfdancer-client-python"
-version = "0.3.8"
+version = "0.3.9"
 description = "Python client for PDFDancer API"
 readme = "README.md"
 authors = [

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/src/pdfdancer/models.py

@@ -1652,6 +1652,7 @@ class ImageTransformType(Enum):
     CROP = "CROP"
     OPACITY = "OPACITY"
     FLIP = "FLIP"
+    FILL_REGION = "FILL_REGION"
 
 
 class ImageFlipDirection(Enum):
@@ -1781,6 +1782,11 @@ class ImageTransformRequest:
     crop_bottom: Optional[int] = None
     opacity: Optional[float] = None
     flip_direction: Optional[ImageFlipDirection] = None
+    fill_region_x: Optional[int] = None
+    fill_region_y: Optional[int] = None
+    fill_region_width: Optional[int] = None
+    fill_region_height: Optional[int] = None
+    fill_color: Optional[int] = None
 
     def to_dict(self) -> dict:
         """Convert to dictionary for JSON serialization."""
@@ -1836,4 +1842,19 @@ class ImageTransformRequest:
         if self.flip_direction is not None:
             result["flipDirection"] = self.flip_direction.value
 
+        if self.fill_region_x is not None:
+            result["fillRegionX"] = self.fill_region_x
+
+        if self.fill_region_y is not None:
+            result["fillRegionY"] = self.fill_region_y
+
+        if self.fill_region_width is not None:
+            result["fillRegionWidth"] = self.fill_region_width
+
+        if self.fill_region_height is not None:
+            result["fillRegionHeight"] = self.fill_region_height
+
+        if self.fill_color is not None:
+            result["fillColor"] = self.fill_color
+
         return result

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/src/pdfdancer/types.py

@@ -8,7 +8,7 @@ from . import FormFieldRef, ObjectRef, ObjectType, Point, Position, TextObjectRe
 from .exceptions import ValidationException
 
 if TYPE_CHECKING:
-    from .models import CommandResult, Image, ImageFlipDirection
+    from .models import Color, CommandResult, Image, ImageFlipDirection
     from .pdfdancer_v1 import PDFDancer
 
 
@@ -244,6 +244,44 @@ class ImageObject(PDFObjectBase):
         )
         return self._client._transform_image(request)
 
+    def fill_region(
+        self, x: int, y: int, width: int, height: int, color: "Color"
+    ) -> "CommandResult":
+        """Fill a rectangular region within this image with a solid color.
+
+        Args:
+            x: X coordinate of the region (pixels from left edge of image)
+            y: Y coordinate of the region (pixels from top edge of image)
+            width: Width of the region in pixels
+            height: Height of the region in pixels
+            color: Fill color as a Color object (alpha channel is ignored)
+
+        Returns:
+            CommandResult indicating success or failure
+        """
+        from .models import Color, ImageTransformRequest, ImageTransformType
+
+        if not isinstance(color, Color):
+            raise ValidationException("color must be a Color object")
+        if width <= 0:
+            raise ValidationException(f"width must be positive, got {width}")
+        if height <= 0:
+            raise ValidationException(f"height must be positive, got {height}")
+
+        # Convert Color to integer: 0xRRGGBB format (RGB only, no alpha)
+        fill_color_int = (color.r << 16) | (color.g << 8) | color.b
+
+        request = ImageTransformRequest(
+            object_ref=self.object_ref(),
+            transform_type=ImageTransformType.FILL_REGION,
+            fill_region_x=x,
+            fill_region_y=y,
+            fill_region_width=width,
+            fill_region_height=height,
+            fill_color=fill_color_int,
+        )
+        return self._client._transform_image(request)
+
     def __eq__(self, other):
         if not isinstance(other, ImageObject):
             return False

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/src/pdfdancer_client_python.egg-info/PKG-INFO

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

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.9}/tests/e2e/test_image_transform.py

@@ -2,7 +2,7 @@ from pathlib import Path
 
 import pytest
 
-from pdfdancer import Image, ImageFlipDirection, ObjectType, ValidationException
+from pdfdancer import Color, Image, ImageFlipDirection, ObjectType, ValidationException
 from pdfdancer.pdfdancer_v1 import PDFDancer
 from tests.e2e import _require_env_and_fixture
 from tests.e2e.pdf_assertions import PDFAssertions
@@ -562,3 +562,123 @@ class TestImageTransformChaining:
             assertions.assert_image_size(
                 image_id, original_width, original_height, epsilon=2.0
             )
+
+
+class TestImageFillRegion:
+    def test_fill_region_basic(self):
+        """Test filling a region within an image with a solid color."""
+        base_url, token, pdf_path = _require_env_and_fixture("Showcase.pdf")
+
+        with PDFDancer.open(
+            pdf_path, token=token, base_url=base_url, timeout=30.0
+        ) as pdf:
+            images = pdf.select_images()
+            assert len(images) > 0
+
+            image = images[0]
+            image_id = image.internal_id
+            page_num = image.position.page_number
+
+            # Fill a region with black color
+            result = image.fill_region(
+                x=10, y=10, width=50, height=30, color=Color(0, 0, 0)
+            )
+            assert result.success, f"Fill region failed: {result.message}"
+
+            # Verify image still exists
+            assertions = PDFAssertions(pdf)
+            image_after = assertions.get_image_by_id(image_id, page_num)
+            assert image_after is not None
+
+    def test_fill_region_with_red_color(self):
+        """Test filling a region with red color."""
+        base_url, token, pdf_path = _require_env_and_fixture("Showcase.pdf")
+
+        with PDFDancer.open(
+            pdf_path, token=token, base_url=base_url, timeout=30.0
+        ) as pdf:
+            images = pdf.select_images()
+            image = images[0]
+            image_id = image.internal_id
+            page_num = image.position.page_number
+
+            result = image.fill_region(
+                x=0, y=0, width=5, height=5, color=Color(255, 0, 0)
+            )
+            assert result.success, f"Fill region failed: {result.message}"
+
+            # Verify image still exists
+            assertions = PDFAssertions(pdf)
+            image_after = assertions.get_image_by_id(image_id, page_num)
+            assert image_after is not None
+
+    def test_fill_region_with_different_colors(self):
+        """Test fill_region with various colors."""
+        base_url, token, pdf_path = _require_env_and_fixture("Showcase.pdf")
+
+        with PDFDancer.open(
+            pdf_path, token=token, base_url=base_url, timeout=30.0
+        ) as pdf:
+            images = pdf.select_images()
+            image = images[0]
+            image_id = image.internal_id
+            page_num = image.position.page_number
+
+            # Test with white
+            result = image.fill_region(
+                x=0, y=0, width=10, height=10, color=Color(255, 255, 255)
+            )
+            assert result.success, f"Fill with white failed: {result.message}"
+
+            # Re-select image after transform
+            images = pdf.select_images()
+            image = next(i for i in images if i.internal_id == image_id)
+
+            # Test with blue
+            result = image.fill_region(
+                x=20, y=20, width=15, height=15, color=Color(0, 0, 255)
+            )
+            assert result.success, f"Fill with blue failed: {result.message}"
+
+            assertions = PDFAssertions(pdf)
+            image_after = assertions.get_image_by_id(image_id, page_num)
+            assert image_after is not None
+
+    def test_fill_region_invalid_width_raises_error(self):
+        """Test that width <= 0 raises ValidationException."""
+        base_url, token, pdf_path = _require_env_and_fixture("Showcase.pdf")
+
+        with PDFDancer.open(
+            pdf_path, token=token, base_url=base_url, timeout=30.0
+        ) as pdf:
+            images = pdf.select_images()
+            image = images[0]
+
+            with pytest.raises(ValidationException):
+                image.fill_region(x=0, y=0, width=0, height=10, color=Color(0, 0, 0))
+
+    def test_fill_region_invalid_height_raises_error(self):
+        """Test that height <= 0 raises ValidationException."""
+        base_url, token, pdf_path = _require_env_and_fixture("Showcase.pdf")
+
+        with PDFDancer.open(
+            pdf_path, token=token, base_url=base_url, timeout=30.0
+        ) as pdf:
+            images = pdf.select_images()
+            image = images[0]
+
+            with pytest.raises(ValidationException):
+                image.fill_region(x=0, y=0, width=10, height=-5, color=Color(0, 0, 0))
+
+    def test_fill_region_invalid_color_type_raises_error(self):
+        """Test that non-Color object raises ValidationException."""
+        base_url, token, pdf_path = _require_env_and_fixture("Showcase.pdf")
+
+        with PDFDancer.open(
+            pdf_path, token=token, base_url=base_url, timeout=30.0
+        ) as pdf:
+            images = pdf.select_images()
+            image = images[0]
+
+            with pytest.raises(ValidationException):
+                image.fill_region(x=0, y=0, width=10, height=10, color=0xFF0000)