pdfdancer-client-python 0.3.6__tar.gz → 0.3.7__tar.gz

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/PKG-INFO

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

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/pyproject.toml

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

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/src/pdfdancer/__init__.py

@@ -44,7 +44,6 @@ from .models import (
     ShapeType,
     Size,
     StandardFonts,
-    TemplateReplacement,
     TextObjectRef,
     TextStatus,
 )
@@ -93,7 +92,6 @@ __all__ = [
     "RedactTarget",
     "RedactResponse",
     "ReflowPreset",
-    "TemplateReplacement",
     "PdfDancerException",
     "FontNotFoundException",
     "ValidationException",

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/src/pdfdancer/models.py

@@ -1686,25 +1686,31 @@ class TemplateReplacement:
     Parameters:
     - placeholder: The exact text to find and replace in the PDF.
     - text: The text to replace the placeholder with.
-
-    Example:
-    ```python
-    replacement = TemplateReplacement(
-        placeholder="{{NAME}}",
-        text="John Doe"
-    )
-    ```
+    - font: Optional font for the replacement text.
+    - color: Optional color for the replacement text.
     """
 
     placeholder: str
     text: str
+    font: Optional[Font] = None
+    color: Optional[Color] = None
 
     def to_dict(self) -> dict:
         """Convert to dictionary for JSON serialization."""
-        return {
+        result: Dict[str, Any] = {
             "placeholder": self.placeholder,
             "text": self.text,
         }
+        if self.font:
+            result["font"] = {"name": self.font.name, "size": self.font.size}
+        if self.color:
+            result["color"] = {
+                "red": self.color.r,
+                "green": self.color.g,
+                "blue": self.color.b,
+                "alpha": self.color.a,
+            }
+        return result
 
 
 @dataclass

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/src/pdfdancer/pdfdancer_v1.py

@@ -16,7 +16,7 @@ import time
 from datetime import datetime, timezone
 from importlib.metadata import version as get_package_version
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, BinaryIO, List, Mapping, Optional, Union
+from typing import TYPE_CHECKING, Any, BinaryIO, Dict, List, Mapping, Optional, Union
 
 import httpx
 from dotenv import load_dotenv
@@ -123,6 +123,26 @@ DEFAULT_RETRY_BACKOFF_FACTOR = float(
 )
 
 
+def _dict_to_replacements(
+    replacements: Dict[str, Union[str, dict]]
+) -> List[TemplateReplacement]:
+    """Convert dict-based replacements to TemplateReplacement list."""
+    result = []
+    for placeholder, value in replacements.items():
+        if isinstance(value, str):
+            result.append(TemplateReplacement(placeholder=placeholder, text=value))
+        else:
+            result.append(
+                TemplateReplacement(
+                    placeholder=placeholder,
+                    text=value["text"],
+                    font=value.get("font"),
+                    color=value.get("color"),
+                )
+            )
+    return result
+
+
 def _generate_timestamp() -> str:
     """
     Generate a timestamp string in the format expected by the API.
@@ -611,7 +631,7 @@ class PageClient:
 
     def apply_replacements(
         self,
-        replacements: List[TemplateReplacement],
+        replacements: Dict[str, Union[str, dict]],
         reflow_preset: Optional[ReflowPreset] = None,
     ) -> bool:
         """
@@ -621,8 +641,9 @@ class PageClient:
         content. All placeholders must be found or the operation fails atomically.
 
         Args:
-            replacements: List of TemplateReplacement objects specifying
-                placeholder/replacement pairs
+            replacements: Dict mapping placeholder strings to replacement values.
+                - Simple: {"{{NAME}}": "John Doe"}
+                - With options: {"{{NAME}}": {"text": "John", "font": Font(...), "color": Color(...)}}
             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
@@ -633,14 +654,15 @@ class PageClient:
 
         Example:
             ```python
-            page.apply_replacements([
-                TemplateReplacement("{{NAME}}", "John Doe"),
-            ])
+            page.apply_replacements({
+                "{{NAME}}": "John Doe",
+            })
             ```
         """
+        replacement_list = _dict_to_replacements(replacements)
         # noinspection PyProtectedMember
         return self.root._apply_replacements(
-            replacements=replacements,
+            replacements=replacement_list,
             page_number=self.page_number,
             reflow_preset=reflow_preset,
         )
@@ -2246,7 +2268,7 @@ class PDFDancer:
 
     def apply_replacements(
         self,
-        replacements: List[TemplateReplacement],
+        replacements: Dict[str, Union[str, dict]],
         reflow_preset: Optional[ReflowPreset] = None,
     ) -> bool:
         """
@@ -2256,8 +2278,9 @@ class PDFDancer:
         content. All placeholders must be found or the operation fails atomically.
 
         Args:
-            replacements: List of TemplateReplacement objects specifying
-                placeholder/replacement pairs
+            replacements: Dict mapping placeholder strings to replacement values.
+                - Simple: {"{{NAME}}": "John Doe"}
+                - With options: {"{{NAME}}": {"text": "John", "font": Font(...), "color": Color(...)}}
             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
@@ -2268,14 +2291,15 @@ class PDFDancer:
 
         Example:
             ```python
-            pdf.apply_replacements([
-                TemplateReplacement("{{NAME}}", "John Doe"),
-                TemplateReplacement("{{DATE}}", "2025-01-15"),
-            ])
+            pdf.apply_replacements({
+                "{{NAME}}": "John Doe",
+                "{{DATE}}": "2025-01-15",
+            })
             ```
         """
+        replacement_list = _dict_to_replacements(replacements)
         return self._apply_replacements(
-            replacements=replacements,
+            replacements=replacement_list,
             page_number=None,
             reflow_preset=reflow_preset,
         )

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/src/pdfdancer_client_python.egg-info/PKG-INFO

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

{pdfdancer_client_python-0.3.6 → pdfdancer_client_python-0.3.7}/tests/e2e/test_template_replace.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from pdfdancer import ReflowPreset, TemplateReplacement, ValidationException
+from pdfdancer import Color, Font, ReflowPreset, ValidationException
 from pdfdancer.pdfdancer_v1 import PDFDancer
 from tests.e2e import _require_env_and_fixture
 from tests.e2e.pdf_assertions import PDFAssertions
@@ -21,9 +21,7 @@ def test_replace_single_template():
         )
 
         # Replace the existing "Showcase" text
-        result = pdf.apply_replacements([
-            TemplateReplacement(placeholder="Showcase", text="Replaced"),
-        ])
+        result = pdf.apply_replacements({"Showcase": "Replaced"})
 
         assert result is True
 
@@ -42,10 +40,10 @@ def test_replace_multiple_templates():
 
     with PDFDancer.open(pdf_path, token=token, base_url=base_url, timeout=30.0) as pdf:
         # Replace multiple placeholders
-        result = pdf.apply_replacements([
-            TemplateReplacement(placeholder="PDFDancer", text="TestApp"),
-            TemplateReplacement(placeholder="Engine", text="System"),
-        ])
+        result = pdf.apply_replacements({
+            "PDFDancer": "TestApp",
+            "Engine": "System",
+        })
 
         assert result is True
 
@@ -71,9 +69,7 @@ def test_replace_template_on_specific_page():
         )
 
         # Replace only on page 1
-        result = pdf.page(1).apply_replacements([
-            TemplateReplacement(placeholder="Showcase", text="PageOneOnly"),
-        ])
+        result = pdf.page(1).apply_replacements({"Showcase": "PageOneOnly"})
 
         assert result is True
 
@@ -98,7 +94,7 @@ def test_replace_template_with_reflow_best_effort():
 
         # Replace with longer text using BEST_EFFORT reflow
         result = pdf.apply_replacements(
-            [TemplateReplacement(placeholder="Showcase", text="ThisIsAMuchLongerReplacementText")],
+            {"Showcase": "ThisIsAMuchLongerReplacementText"},
             reflow_preset=ReflowPreset.BEST_EFFORT,
         )
 
@@ -125,7 +121,7 @@ def test_replace_template_with_reflow_none():
 
         # Replace without reflow
         result = pdf.apply_replacements(
-            [TemplateReplacement(placeholder="Showcase", text="NoReflow")],
+            {"Showcase": "NoReflow"},
             reflow_preset=ReflowPreset.NONE,
         )
 
@@ -139,40 +135,86 @@ def test_replace_template_with_reflow_none():
         )
 
 
-def test_replace_template_empty_list_raises():
-    """Test that replacing with an empty list raises ValidationException."""
+def test_replace_template_empty_dict_raises():
+    """Test that replacing with an empty dict 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:
         with pytest.raises(ValidationException):
-            pdf.apply_replacements([])
+            pdf.apply_replacements({})
 
 
-def test_replace_template_page_level_empty_list_raises():
-    """Test that page-level replacement with empty list raises ValidationException."""
+def test_replace_template_page_level_empty_dict_raises():
+    """Test that page-level replacement with empty dict 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:
         with pytest.raises(ValidationException):
-            pdf.page(1).apply_replacements([])
+            pdf.page(1).apply_replacements({})
 
 
-def test_template_replacement_dataclass():
-    """Test TemplateReplacement dataclass structure and serialization."""
-    replacement = TemplateReplacement(
-        placeholder="{{NAME}}",
-        text="John Doe",
-    )
+def test_replace_template_with_font():
+    """Test template replacement with custom font."""
+    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:
+        result = pdf.apply_replacements({
+            "Showcase": {
+                "text": "FontTest",
+                "font": Font("Helvetica-Bold", 14),
+            }
+        })
+
+        assert result is True
+
+        (
+            PDFAssertions(pdf)
+            .assert_textline_does_not_exist("Showcase")
+            .assert_textline_exists("FontTest")
+        )
+
+
+def test_replace_template_with_color():
+    """Test template replacement with custom 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:
+        result = pdf.apply_replacements({
+            "Showcase": {
+                "text": "ColorTest",
+                "color": Color(255, 0, 0),
+            }
+        })
+
+        assert result is True
+
+        (
+            PDFAssertions(pdf)
+            .assert_textline_does_not_exist("Showcase")
+            .assert_textline_exists("ColorTest")
+        )
+
+
+def test_replace_template_with_font_and_color():
+    """Test template replacement with both font and 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:
+        result = pdf.apply_replacements({
+            "Showcase": {
+                "text": "StyledText",
+                "font": Font("Helvetica-Bold", 16),
+                "color": Color(0, 100, 0),
+            }
+        })
 
-    assert replacement.placeholder == "{{NAME}}"
-    assert replacement.text == "John Doe"
+        assert result is True
 
-    # Test to_dict
-    d = replacement.to_dict()
-    assert d == {
-        "placeholder": "{{NAME}}",
-        "text": "John Doe",
-    }
+        (
+            PDFAssertions(pdf)
+            .assert_textline_does_not_exist("Showcase")
+            .assert_textline_exists("StyledText")
+        )
 
 
 def test_reflow_preset_values():