OVAPortableText 0.2.0__tar.gz → 0.4.0__tar.gz

{ovaportabletext-0.2.0 → ovaportabletext-0.4.0}/CHANGELOG.md

@@ -4,6 +4,54 @@
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-05-14
+
+### Added
+
+* aligned the package with `report.v1.3`
+* added typed chart models for `bar`, `line`, and `matrix_bubble` datasets
+* added shared `ChartAxis`, `ChartCategory`, `MatrixBubbleCategory`, and `SizeMetric` models
+* added chart helper functions for bar, horizontal bar, line, and matrix bubble datasets
+* added validation coverage for v1.3 chart category references, series keys, and matrix bubble size values
+* added tests covering v1.3 schema defaults, `pie.slices[].colorHint`, bar variants, line points, and matrix bubble output
+
+### Changed
+
+* default `schemaVersion` is now `report.v1.3`
+* package metadata and public version now reflect `v0.4.0` / `report.v1.3`
+* `datasets.charts` now has first-class Python models for all v1.3 formal chart types while keeping the generic chart fallback
+
+### Fixed
+
+* preserved `pie.slices[].colorHint` while avoiding new visual-style fields for v1.3 chart types
+* normalized legacy `sizeMetric.valueUnit` input to `sizeMetric.unit` without emitting `valueUnit` in new matrix-bubble output
+* avoided any `chartType = "bubble"` helper for v1.3; classification bubble charts now use `chartType = "matrix_bubble"`
+
+## [0.3.0] - 2026-04-08
+
+### Added
+
+* aligned the package with `report.v1.2`
+* added `DoughnutChartDataset` and `doughnut_chart_dataset(...)`
+* added section-level models and helpers for `sectionRole`, `navigation`, `pagination`, and `presentation`
+* added support for `_type="chart"` inside `GridTableCell.blocks`
+* added validation coverage for doughnut constraints, grid-cell chart refs, and `presentation.titleBlockStyle`
+* added tests covering v1.2 doughnut datasets, section fields, and grid-cell charts
+
+### Changed
+
+* default `schemaVersion` is now `report.v1.2`
+* `ChartBlock.id`, `TableBlock.id`, `MathBlock.id`, and `CalloutBlock.id` are now optional to match the protocol's instance-layer rules
+* `Section`, `Document.new_section(...)`, and `section(...)` now accept v1.2 section fields
+* chart / table / math helper functions now accept optional instance ids
+* public exports and packaging metadata now reflect `v0.3.0` / `report.v1.2`
+
+### Fixed
+
+* fixed the protocol mismatch where grid-cell chart blocks were still rejected by the Python models and validator
+* fixed the resolver mismatch where optional chart / table / math / callout instance ids could break target indexing
+* fixed the validation gap where grid-cell `chartRef` values were not resolved
+
 ## [0.2.0] - 2026-04-01
 
 ### Added

{ovaportabletext-0.2.0 → ovaportabletext-0.4.0}/PKG-INFO

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

{ovaportabletext-0.2.0 → ovaportabletext-0.4.0}/docs/API_REFERENCE.md

@@ -1,7 +1,7 @@
 # API Reference / API 参考
 
-This page is a practical map of the public API in OVAPortableText `v0.2.0`, aligned to `report.v1.1`.
-本文档是 OVAPortableText `v0.2.0` 的实用 API 地图，对齐 `report.v1.1`。
+This page is a practical map of the public API in OVAPortableText `v0.4.0`, aligned to `report.v1.3`.
+本文档是 OVAPortableText `v0.4.0` 的实用 API 地图，对齐 `report.v1.3`。
 
 ---
 
@@ -17,7 +17,7 @@ This page is a practical map of the public API in OVAPortableText `v0.2.0`, alig
 
 Default schema version:
 
-- `Document.schemaVersion == "report.v1.1"`
+- `Document.schemaVersion == "report.v1.3"`
 
 Common arguments / 常用参数：
 
@@ -46,11 +46,12 @@ Body block objects / 正文块对象：
 - `MathBlock`
 - `CalloutBlock`
 
-Important v1.1 note / v1.1 重点：
+Important v1.3 note / v1.3 重点：
 
-- `ImageBlock(imageRef="...")` is valid
-- `ImageBlock.id` and `ImageBlock.anchor` are optional
-- `imageRef` is required
+- `ImageBlock(imageRef="...")` remains valid
+- `ChartBlock(chartRef="...")`, `TableBlock(tableRef="...")`, and `MathBlock(latex="...")` may now omit instance `id`
+- `Section` now supports `sectionRole`, `navigation`, `pagination`, and `presentation`
+- `GridTableCell.blocks[]` now supports `_type="chart"` in addition to `_type="block"` and `_type="image"`
 
 ---
 
@@ -208,10 +209,39 @@ Supported length units:
 - `table_layout(*column_specs)`
 - `pie_slice(...)`
 - `pie_chart_dataset(...)`
+- `doughnut_chart_dataset(...)`
 - `pie_chart_from_parallel_arrays(...)`
+- `chart_axis(...)`
+- `chart_category(...)`
+- `bar_data_point(...)`
+- `bar_series(...)`
+- `bar_chart_dataset(...)`
+- `horizontal_bar_chart_dataset(...)`
+- `line_point(...)`
+- `line_series(...)`
+- `line_chart_dataset(...)`
+- `matrix_bubble_category(...)`
+- `size_metric(...)`
+- `matrix_bubble_point(...)`
+- `matrix_bubble_series(...)`
+- `matrix_bubble_chart_dataset(...)`
 - `metric_value(...)`
 - `metric_dataset(...)`
 
+
+### v1.3 chart models / v1.3 图表模型
+
+`datasets.charts[]` now has typed helpers for the five formal chart types: `pie`, `doughnut`, `bar`, `line`, and `matrix_bubble`.
+`datasets.charts[]` 现在为五类正式图表提供 typed helper：`pie`、`doughnut`、`bar`、`line`、`matrix_bubble`。
+
+Key boundaries / 关键边界：
+
+- horizontal bar charts still use `chartType = "bar"` with `orientation = "horizontal"`
+- line charts use `points[].xValue / yValue / label`, not `categories[]`
+- classification bubble charts use `chartType = "matrix_bubble"`, never `bubble`
+- `matrix_bubble.sizeValue` uses `sizeMetric.unit`; new output does not emit `sizeMetric.valueUnit`
+- v1.2 `pie.slices[].colorHint` remains supported; new chart types intentionally avoid visual styling fields
+
 ### Registry-backed block instances / 正文引用实例
 
 - `image_block(image_ref=..., id=None, anchor=None)`

{ovaportabletext-0.2.0 → ovaportabletext-0.4.0}/docs/PROTOCOL_ALIGNMENT.md

@@ -1,7 +1,7 @@
 # Protocol Alignment / 协议对齐说明
 
-This page explains how OVAPortableText 0.1.3 aligns with the current Report Profile v1.0 protocol draft used in this repository.  
-本文档说明 OVAPortableText 0.1.3 与当前仓库内维护的 Report Profile v1.0 协议草案之间的对齐关系。
+This page explains how OVAPortableText 0.4.0 aligns with the current Report Profile v1.3 protocol maintained in this repository.  
+本文档说明 OVAPortableText 0.4.0 与当前仓库内维护的 Report Profile v1.3 正式协议之间的对齐关系。
 
 ---
 
@@ -20,8 +20,8 @@ The package aligns to this top-level shape:
 - `glossary`
 - `sections`
 
-`schemaVersion` defaults to `report.v1.1`.  
-`schemaVersion` 默认值为 `report.v1.1`。
+`schemaVersion` defaults to `report.v1.3`.  
+`schemaVersion` 默认值为 `report.v1.3`。
 
 ---
 

{ovaportabletext-0.2.0 → ovaportabletext-0.4.0}/docs/QUICKSTART.md

@@ -50,8 +50,8 @@ What happens here / 这里发生了什么：
 
 ## 3. Add registry-backed content / 添加引用型内容
 
-The protocol separates top-level registries from body instances. In `report.v1.1`, image instances may omit `id`, and text blocks can carry `layout`.  
-协议把“顶层 registry”与“正文实例”分开处理。在 `report.v1.1` 中，图片实例可以省略 `id`，文本块还可以携带 `layout`。
+The protocol separates top-level registries from body instances. In `report.v1.3`, image / chart / table / math instances may omit instance `id` where the protocol allows it, text blocks can carry `layout`, sections can carry `sectionRole / navigation / pagination / presentation`, and grid cells can now contain charts.  
+协议把“顶层 registry”与“正文实例”分开处理。在 `report.v1.3` 中，协议允许的图片 / 图表 / 表格 / 公式实例都可以省略实例 `id`，文本块可携带 `layout`，section 可携带 `sectionRole / navigation / pagination / presentation`，grid 单元格现在还可以放图表。
 
 ### Example / 示例