OVAPortableText 0.1.3__tar.gz → 0.1.4__tar.gz

ovaportabletext-0.1.4/CHANGELOG.md

@@ -0,0 +1,80 @@
+# Changelog
+
+**All notable changes to this project will be documented in this file.**  ** **本项目的重要变更会记录在此文件中。
+
+## [Unreleased]
+
+## [0.1.4] - 2026-03-25
+
+### Added
+
+* **bilingual end-user and developer documentation, including a restructured **`README.md`
+* **protocol-aligned table authoring helpers for both **`record` and `grid` table modes
+* **generic chart registry support so non-**`pie` chart entries can remain in `datasets.charts[]` without pretending to follow the `pie` schema
+* **richer example coverage for image sources, grid tables, references, marks, and end-to-end report generation**
+* **resolver support for the generic **`asset` target alias in cross-references
+
+### Changed
+
+* **synchronized the package with the latest **`report.v1.0` protocol wording and data contracts
+* **standardized document schema version handling to **`report.v1.0`
+* **aligned **`meta` handling with the latest protocol field set, including stronger enum / format validation where the protocol now defines it
+* **aligned bibliography generation with the latest protocol by treating **`displayText` as the primary display field
+* **aligned image registries (**`images`, `logos`, `backgrounds`, `icons`) around the current `imageSource` model and helper flow
+* **aligned inline reference models around **`targetId`
+* **expanded validator coverage for **`grid` tables, protocol-native image sources, and newer registry / reference rules
+* **refreshed examples and tests to use the current protocol instead of older transitional shapes**
+
+### Fixed
+
+* **corrected remaining mismatches between protocol examples and package-generated JSON structures**
+* **corrected resolver / validator gaps around newer reference and asset resolution behaviors**
+* **corrected helper / example inconsistencies that could force manual post-processing for some protocol features**
+
+## [0.1.3]
+
+### Added
+
+* **formal image-source helpers: **`image_asset_url(...)`, `image_asset_embedded(...)`, and `image_asset_from_file(...)`
+* **typed image source models: **`ImageSourceUrl`, `ImageSourceEmbedded`, and discriminated `ImageSource`
+
+### Changed
+
+* `assets.images` now follows the pure `imageSource` protocol and no longer depends on legacy `src`
+* **image-related examples, tests, and docs now use the new protocol-native image helpers**
+
+## [0.1.2]
+
+### Added
+
+* **optional **`strict_ids=True` fail-early duplicate-ID checks for common authoring paths
+* **continuous-content helpers on **`Section`:
+  * `append_to_last_content()`
+  * `append_blocks_to_last_content()`
+  * `append_text_block_to_last_content()`
+  * `append_paragraph_to_last_content()`
+* **release-facing docs now explain the implemented v1.0 protocol subset more explicitly**
+
+### Changed
+
+* **packaging and release metadata were aligned for a cleaner publication flow**
+* `Section.numbering` now accepts only protocol-approved values: `auto`, `none`, and `manual`
+* **publishing checklist now includes changelog layout and sdist verification guidance**
+
+## [0.1.1]
+
+### Added
+
+* **improved authoring ergonomics for local save/load and batch section writing**
+* **more release-prep docs and smoke-test coverage**
+
+## [0.1.0]
+
+### Added
+
+* **document / section tree builder**
+* **text blocks, spans, marks, markDefs, and list semantics**
+* **inline refs: **`xref`, `citation_ref`, `footnote_ref`, `glossary_term`, `hard_break`
+* **block objects: **`image`, `chart`, `table`, `math_block`, `callout`
+* **registries: assets, datasets, bibliography, footnotes, glossary**
+* **numbering helpers, resolver, validator, and round-trip helpers**

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OVAPortableText
-Version: 0.1.3
+Version: 0.1.4
 Summary: Python builder for generating OVAPortableText / Report Profile v1 JSON documents
 Author: FENG QU
 License-Expression: MIT

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/extended_registries_demo.py

@@ -1,19 +1,19 @@
 from ova_portable_text import (
     attachment_asset,
-    background_asset,
+    background_asset_url,
     create_document,
-    icon_asset,
-    logo_asset,
+    icon_asset_url,
+    logo_asset_url,
     metric_dataset,
     metric_value,
 )
 
 report = create_document(title="Extended Registries Demo", language="en", reportType="valuation")
 
-report.add_logo_asset(logo_asset(id="logo-main", url="https://example.com/assets/logo.svg", alt="Main brand logo", variant="light"))
-report.add_background_asset(background_asset(id="bg-cover", url="https://example.com/assets/cover.png", usage="cover"))
-report.add_icon_asset(icon_asset(id="icon-growth", url="https://example.com/assets/growth.svg", alt="Growth icon", family="outline"))
-report.add_attachment_asset(attachment_asset(id="att-appendix-a", url="https://example.com/appendix-a.pdf", file_name="appendix-a.pdf", description="Supporting appendix PDF"))
+report.add_logo_asset(logo_asset_url(id="logo-main", url="https://example.com/assets/logo.svg", alt="Main brand logo", variant="light"))
+report.add_background_asset(background_asset_url(id="bg-cover", url="https://example.com/assets/cover.png", usage="cover"))
+report.add_icon_asset(icon_asset_url(id="icon-growth", url="https://example.com/assets/growth.svg", alt="Growth icon", family="outline"))
+report.add_attachment_asset(attachment_asset(id="att-appendix-a", src="https://example.com/appendix-a.pdf", file_name="appendix-a.pdf", description="Supporting appendix PDF"))
 report.add_metric_dataset(metric_dataset(id="metric-overview", values=[metric_value(key="revenue", label="Revenue", value=128.4, unit="USDm"), metric_value(key="employees", label="Employees", value=96), metric_value(key="profitable", label="Profitable", value=True)], label="Company snapshot"))
 
 print(report.to_json())

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/full_report_workflow_demo.py

@@ -23,7 +23,7 @@ report = create_document(
     title="Full Workflow Demo",
     language="en",
     subtitle="Step 8 end-to-end example",
-    documentType="valuationReport",
+    documentType="report",
 )
 
 report.add_image_asset(
@@ -60,11 +60,11 @@ report.add_chart_dataset(
 report.add_bibliography_entry(
     bibliography_entry(
         id="bib-pt",
-        display_text="Portable Text Authors. Portable Text Specification. 2026.",
+        display_text="Portable Text Authors (2026). Portable Text Specification.",
         title="Portable Text Specification",
         authors=["Portable Text Authors"],
         year=2026,
-        type="other",
+        type="specification",
     )
 )
 

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/image_sources_demo.py

@@ -43,7 +43,11 @@ def main() -> None:
     report.add_logo_asset(
         logo_asset(
             id="logo-main",
-            data_base64=TINY_PNG_BASE64,
+            image_source={
+                "kind": "embedded",
+                "encoding": "base64",
+                "data": TINY_PNG_BASE64,
+            },
             alt="Main logo",
             mimeType="image/png",
             width=32,
@@ -54,7 +58,10 @@ def main() -> None:
     report.add_background_asset(
         background_asset(
             id="bg-cover",
-            url="https://example.com/assets/cover-bg.png",
+            image_source={
+                "kind": "url",
+                "url": "https://example.com/assets/cover-bg.png",
+            },
             mimeType="image/png",
             width=1600,
             height=900,
@@ -64,7 +71,11 @@ def main() -> None:
     report.add_icon_asset(
         icon_asset(
             id="icon-growth",
-            data_base64=TINY_PNG_BASE64,
+            image_source={
+                "kind": "embedded",
+                "encoding": "base64",
+                "data": TINY_PNG_BASE64,
+            },
             alt="Growth icon",
             mimeType="image/png",
             width=16,

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/inline_objects_report.py

@@ -13,7 +13,7 @@ from ova_portable_text import (
 report = create_document(
     title="Inline Object Demo",
     language="en",
-    documentType="valuationReport",
+    documentType="report",
 )
 
 intro = section(id="sec-intro", level=1, title="Introduction")

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/patent_valuation_style_report.py

@@ -27,7 +27,7 @@ def main() -> None:
         title="Patent Valuation Report",
         subtitle="Illustrative protocol example",
         language="en",
-        documentType="valuationReport",
+        documentType="report",
         author="OVA Demo",
         confidentiality="internal",
     )
@@ -81,7 +81,7 @@ def main() -> None:
     report.add_bibliography_entry(
         bibliography_entry(
             id="bib-market-2025",
-            display_text="Research Team. Global Patent Market Review. 2025.",
+            display_text="Research Team (2025). Global Patent Market Review.",
             title="Global Patent Market Review",
             authors=["Research Team"],
             year=2025,

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/references_and_marks_demo.py

@@ -3,18 +3,14 @@
 from __future__ import annotations
 
 from ova_portable_text import (
+    annotation_def,
     bibliography_entry,
-    citation_ref_def,
     create_document,
     footnote_entry,
-    footnote_ref_def,
     glossary_entry,
-    glossary_term_def,
-    inline_math_def,
     link_def,
     paragraph,
     span,
-    xref_def,
 )
 
 
@@ -70,11 +66,11 @@ def main() -> None:
         ".",
         mark_defs=[
             link_def(key="m-link", href="https://example.com"),
-            xref_def(key="m-xref", target_id="sec-method", target_type="section"),
-            citation_ref_def(key="m-cite", target_id="cite-fu-2026"),
-            footnote_ref_def(key="m-footnote", target_id="fn-1"),
-            glossary_term_def(key="m-term", target_id="term-dcf"),
-            inline_math_def(key="m-math", latex="E = mc^2"),
+            annotation_def(key="m-xref", type="xref", data={"targetId": "sec-method", "targetType": "section"}),
+            annotation_def(key="m-cite", type="citation_ref", data={"targetId": "cite-fu-2026"}),
+            annotation_def(key="m-footnote", type="footnote_ref", data={"targetId": "fn-1"}),
+            annotation_def(key="m-term", type="glossary_term", data={"targetId": "term-dcf"}),
+            annotation_def(key="m-math", type="inline_math", data={"latex": "E = mc^2"}),
         ],
     )
 

{ovaportabletext-0.1.3 → ovaportabletext-0.1.4}/examples/registry_blocks_report.py

@@ -16,7 +16,7 @@ from ova_portable_text import (
 report = create_document(
     title="OVAPortableText Step 3 Demo",
     language="en",
-    documentType="valuationReport",
+    documentType="report",
 )
 
 # Add registry entries / 追加顶层 registry 条目