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

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.10}/.gitignore

@@ -18,3 +18,4 @@ __pycache__/
 .Python
 /.run/
 /build
+.env

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdfdancer-client-python
-Version: 0.3.8
+Version: 0.3.10
 Summary: Python client for PDFDancer API
 Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
 License: 
@@ -672,6 +672,7 @@ Contributions are welcome via pull request. Please:
 - [PyPI](https://pypi.org/project/pdfdancer-client-python/)
 - [Changelog](https://www.pdfdancer.com/changelog/?utm_source=github&utm_medium=readme&utm_campaign=pdfdancer-python)
 - [Status](https://status.pdfdancer.com?utm_source=github&utm_medium=readme&utm_campaign=pdfdancer-python)
+- [Issue tracker](https://github.com/MenschMachine/pdfdancer)
 
 ## Related SDKs
 

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.10}/README.md

@@ -433,6 +433,7 @@ Contributions are welcome via pull request. Please:
 - [PyPI](https://pypi.org/project/pdfdancer-client-python/)
 - [Changelog](https://www.pdfdancer.com/changelog/?utm_source=github&utm_medium=readme&utm_campaign=pdfdancer-python)
 - [Status](https://status.pdfdancer.com?utm_source=github&utm_medium=readme&utm_campaign=pdfdancer-python)
+- [Issue tracker](https://github.com/MenschMachine/pdfdancer)
 
 ## Related SDKs
 

{pdfdancer_client_python-0.3.8 → pdfdancer_client_python-0.3.10}/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.10}/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.10}/pyproject.toml

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

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

@@ -1652,6 +1652,7 @@ class ImageTransformType(Enum):
     CROP = "CROP"
     OPACITY = "OPACITY"
     FLIP = "FLIP"
+    FILL_REGION = "FILL_REGION"
 
 
 class ImageFlipDirection(Enum):
@@ -1685,18 +1686,22 @@ class TemplateReplacement:
 
     Parameters:
     - placeholder: The exact text to find and replace in the PDF.
-    - text: The text to replace the placeholder with.
+    - text: The text to replace the placeholder with. None for image replacements.
     - font: Optional font for the replacement text.
     - color: Optional color for the replacement text.
+    - image: Optional Image to replace the placeholder with. When set, text should be None.
     """
 
     placeholder: str
-    text: str
+    text: Optional[str] = None
     font: Optional[Font] = None
     color: Optional[Color] = None
+    image: Optional[Image] = None
 
     def to_dict(self) -> dict:
         """Convert to dictionary for JSON serialization."""
+        import base64
+
         result: Dict[str, Any] = {
             "placeholder": self.placeholder,
             "text": self.text,
@@ -1710,6 +1715,20 @@ class TemplateReplacement:
                 "blue": self.color.b,
                 "alpha": self.color.a,
             }
+        if self.image:
+            image_dict: Dict[str, Any] = {}
+            if self.image.data:
+                image_dict["data"] = base64.b64encode(self.image.data).decode("utf-8")
+            if self.image.format:
+                image_dict["format"] = self.image.format
+            if self.image.width is not None or self.image.height is not None:
+                size: Dict[str, float] = {}
+                if self.image.width is not None:
+                    size["width"] = self.image.width
+                if self.image.height is not None:
+                    size["height"] = self.image.height
+                image_dict["size"] = size
+            result["image"] = image_dict
         return result
 
 
@@ -1781,6 +1800,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 +1860,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.10}/src/pdfdancer/pdfdancer_v1.py

@@ -131,6 +131,34 @@ def _dict_to_replacements(
     for placeholder, value in replacements.items():
         if isinstance(value, str):
             result.append(TemplateReplacement(placeholder=placeholder, text=value))
+        elif "image" in value:
+            image_source = value["image"]
+            if isinstance(image_source, Path):
+                image_data = image_source.read_bytes()
+                image_format = image_source.suffix.lstrip(".").upper()
+                if image_format == "JPG":
+                    image_format = "JPEG"
+            elif isinstance(image_source, bytes):
+                image_data = image_source
+                image_format = None
+            else:
+                raise ValueError(
+                    f"Unsupported image source type: {type(image_source)}. "
+                    "Use a Path or bytes."
+                )
+            img = Image(
+                data=image_data,
+                format=value.get("format", image_format),
+                width=value.get("width"),
+                height=value.get("height"),
+            )
+            result.append(
+                TemplateReplacement(
+                    placeholder=placeholder,
+                    text=None,
+                    image=img,
+                )
+            )
         else:
             result.append(
                 TemplateReplacement(
@@ -644,6 +672,8 @@ class PageClient:
             replacements: Dict mapping placeholder strings to replacement values.
                 - Simple: {"{{NAME}}": "John Doe"}
                 - With options: {"{{NAME}}": {"text": "John", "font": Font(...), "color": Color(...)}}
+                - With image: {"{{LOGO}}": {"image": Path("logo.png")}}
+                - With image and size: {"{{LOGO}}": {"image": Path("logo.png"), "width": 50, "height": 50}}
             reflow_preset: Optional ReflowPreset to control text reflow behavior.
                 - BEST_EFFORT: Attempt to reflow, proceed even if imperfect
                 - FIT_OR_FAIL: Reflow must succeed or operation fails
@@ -2281,6 +2311,8 @@ class PDFDancer:
             replacements: Dict mapping placeholder strings to replacement values.
                 - Simple: {"{{NAME}}": "John Doe"}
                 - With options: {"{{NAME}}": {"text": "John", "font": Font(...), "color": Color(...)}}
+                - With image: {"{{LOGO}}": {"image": Path("logo.png")}}
+                - With image and size: {"{{LOGO}}": {"image": Path("logo.png"), "width": 50, "height": 50}}
             reflow_preset: Optional ReflowPreset to control text reflow behavior.
                 - BEST_EFFORT: Attempt to reflow, proceed even if imperfect
                 - FIT_OR_FAIL: Reflow must succeed or operation fails