formfeed 0.3.2__tar.gz → 0.3.4__tar.gz

{formfeed-0.3.2 → formfeed-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: formfeed
-Version: 0.3.2
+Version: 0.3.4
 Summary: Formfeed API client: template-based PDF and image generation (sync and async, httpx).
 Project-URL: Homepage, https://formfeed.dev
 Project-URL: Documentation, https://docs.formfeed.dev/api/sdks/python

{formfeed-0.3.2 → formfeed-0.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "formfeed"
-version = "0.3.2"
+version = "0.3.4"
 description = "Formfeed API client: template-based PDF and image generation (sync and async, httpx)."
 readme = "README.md"
 # PEP 639: the SPDX expression replaces the licence classifier, the two must not be combined

{formfeed-0.3.2 → formfeed-0.3.4}/src/formfeed/__init__.py

@@ -62,4 +62,4 @@ __all__ = [
     "verify_webhook_signature",
 ]
 
-__version__ = "0.3.2"
+__version__ = "0.3.4"

{formfeed-0.3.2 → formfeed-0.3.4}/src/formfeed/client.py

@@ -499,6 +499,11 @@ def _guard(allow_breaking: bool) -> dict[str, Any] | None:
     return {"allow_breaking": True} if allow_breaking else None
 
 
+def _schema_path(id_or_slug: str, version: str | int | None) -> str:
+    params = httpx.QueryParams(_query(version=None if version is None else str(version)))
+    return f"/templates/{id_or_slug}/schema{'?' + str(params) if params else ''}"
+
+
 class _Channels:
     """Release channels: a render with ``version="staging"`` uses the version the channel points at.
     Moves reach renders within a minute; a breaking data schema change raises ``schema_breaking_change``
@@ -587,8 +592,9 @@ class _Templates:
         """Publishes a version; a data schema that breaks callers of the published one raises ``schema_breaking_change`` unless ``allow_breaking``."""
         return TemplateVersion.model_validate(self._c.request("POST", f"/templates/{id_or_slug}/versions/{number}/publish", _guard(allow_breaking)))
 
-    def schema(self, id_or_slug: str) -> dict[str, Any]:
-        return self._c.request("GET", f"/templates/{id_or_slug}/schema")
+    def schema(self, id_or_slug: str, *, version: str | int | None = None) -> dict[str, Any]:
+        """The JSON Schema of the template's data, stored or inferred from the sample data: of the published (else the latest) version, or of ``version`` (``published``, ``latest``, a number or a channel name)."""
+        return self._c.request("GET", _schema_path(id_or_slug, version))
 
     def validate(self, id_or_slug: str, data: dict[str, Any] | None = None, *, version: str | int = "published") -> TemplateValidation:
         """Checks a version with data without rendering. Free. Without ``data``, the version's sample data is checked."""
@@ -971,8 +977,8 @@ class _AsyncTemplates:
     async def publish(self, id_or_slug: str, number: int, *, allow_breaking: bool = False) -> TemplateVersion:
         return TemplateVersion.model_validate(await self._c.request("POST", f"/templates/{id_or_slug}/versions/{number}/publish", _guard(allow_breaking)))
 
-    async def schema(self, id_or_slug: str) -> dict[str, Any]:
-        return await self._c.request("GET", f"/templates/{id_or_slug}/schema")
+    async def schema(self, id_or_slug: str, *, version: str | int | None = None) -> dict[str, Any]:
+        return await self._c.request("GET", _schema_path(id_or_slug, version))
 
     async def validate(self, id_or_slug: str, data: dict[str, Any] | None = None, *, version: str | int = "published") -> TemplateValidation:
         body: dict[str, Any] = {"version": version}

{formfeed-0.3.2 → formfeed-0.3.4}/src/formfeed/models.py

@@ -341,6 +341,10 @@ class Diagnostic(_Model):
     location: dict[str, int] | None = None
     path: str | None = None
     """Data errors only: where in the data, e.g. ``data.invoice.lines[0].qty``."""
+    part: str | None = None
+    """Word and PowerPoint templates only: the file part the tag is in, e.g. ``word/document.xml``."""
+    paragraph: int | None = None
+    """Word and PowerPoint templates only: the 1-based paragraph in ``part``."""
 
 
 class TemplateValidation(_Model):

{formfeed-0.3.2 → formfeed-0.3.4}/tests/test_client.py

@@ -313,6 +313,19 @@ def test_templates_validate_sends_version_and_data():
     assert checked.ok is False and checked.diagnostics[0].path == "data.n" and checked.template.version == 3
     assert str(rec.calls[0].url).endswith("/templates/invoice/validate")
     assert json.loads(rec.calls[0].content) == {"version": "latest", "data": {"a": 1}}
+    # a channel name names its main version, on the check and on the schema
+    client.templates.validate("invoice", version="staging")
+    assert json.loads(rec.calls[1].content) == {"version": "staging"}
+
+
+def test_templates_schema_of_a_version_or_channel():
+    client, rec = sync_client(lambda req, n: _json({"type": "object"}))
+    assert client.templates.schema("invoice") == {"type": "object"}
+    assert str(rec.calls[0].url).endswith("/templates/invoice/schema")
+    client.templates.schema("invoice", version="staging")
+    assert str(rec.calls[1].url).endswith("/templates/invoice/schema?version=staging")
+    client.templates.schema("invoice", version=8)
+    assert str(rec.calls[2].url).endswith("/templates/invoice/schema?version=8")
 
 
 def test_library_files_as_image_watermarks_and_merge_sources():