Skip to content

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

  • Raise MSRV to Rust 1.99.

0.3.0 - 2026-09-23

Fixed

  • Schema validation rejected every valid ObjectType, Property, GroupOfProperties and DataTemplate inside a Library. Those four children are declared by reference to the global element (<xs:element ref=...>), and the table pipeline gave each an empty local definition instead of the global type. The pipeline now resolves element references, and the regenerated tables differ only in those four Library edges.

Added

  • scripts/generate-schema-catalog.py, the first stage of the schema-table pipeline (XSD to structural catalog), so both stages are reproducible from the repository. It still reads only a local, ignored copy of the XSD.
  • Lossless XML codec for every owned ISO 23387 type: to_element and from_element on ObjectType, Property, GroupOfProperties, DataTemplate, QuantityKind, Dimension, Unit, ReferenceDocument, Subject, and Concept::to_element_named. Children are written in schema order, taken from the generated tables. Decoding fails closed with a structured CodecError (CodecErrorKind names the failure, the path names the element) instead of dropping content it cannot represent.
  • Public Element/Attribute builders and Document::standalone, so other crates can construct ISO 23387 trees.
  • NonNegativeInteger and Base64Binary lexical types.
  • Scale::as_str and Base::as_str, the inverses of their From<&str>.
  • concept_mut/subject_mut on every owned type.

Changed

  • Owned types hold everything the schema declares. Concept gained every ConceptType child (definitions, descriptions, examples, four reference kinds, languages, countries, visual representations, versions, statuses, deprecation explanations, and about). Concept::definition now returns Option<&MultiLanguageText>, the first definition.
  • Subject::is_subtype_of_refs, Property::dimension_refs and DataTemplate::object_type_refs replace single-valued fields the schema declares as repeating. The singular getters and setters remain as deprecated aliases that read the first entry and replace all entries.
  • ValueErrorKind is #[non_exhaustive].

Deprecated

  • Concept::references/add_reference (use reference_document_refs), Subject::is_subtype_of_ref/set_is_subtype_of_ref, Property::dimension_ref/set_dimension_ref, DataTemplate::object_type_ref/set_object_type_ref.

0.2.1 - 2026-09-22

Fixed

  • Scoped getrandom to non-wasm targets so the library builds for wasm32-unknown-unknown. It is used only by the CLI, for the OS-random temporary-file token in atomic_replace, but as a plain dependency it was forced on every library consumer and broke browser builds outright. Native builds and the CLI are unchanged. The gate asserts the dependency stays target-scoped.

Changed

  • Relicensed repository-authored work from AGPL-3.0-or-later back to MIT. No version was ever published under the AGPL โ€” the relicense landed after 0.2.0 and was reverted before any release carried it, so every published version of openbim-dt is MIT. This also keeps the crate usable by its MIT dependents, notably openbim-loin. LICENSING.md records the version boundaries.

Added

  • Added XML Schema validation of the ISO 23387 element grammar via Document::validate_schema, reporting structured SchemaViolation values with stable codes for unknown roots, undeclared elements and attributes, sequence order, minOccurs/maxOccurs, mandatory choice branches, enumeration and pattern facets, datatype lexical spaces, and character data in element-only content.
  • Added byte-identical round trips via Document::to_xml_string_exact, which reproduces the parsed bytes exactly โ€” including attribute quoting, character reference spelling, intra-tag whitespace, CDATA versus escaped text, and empty-element syntax โ€” and fails closed rather than normalizing when source provenance is unavailable.
  • Added Document::source and Document::without_source to inspect and drop the retained parse input.
  • Added validate-schema and rewrite-exact CLI commands.
  • Added scripts/generate-schema-tables.py, which regenerates the committed schema tables from a derived structural catalog without vendoring the ISO schema.

Changed

  • Relicensed repository-authored work from MIT to AGPL-3.0-or-later; historical releases remain under their published MIT terms, and third-party material retains its own terms.
  • Document, Element, and node lists now compare by semantic content; retained source spans are provenance and no longer affect equality.
  • Documented the two writers explicitly: to_xml_string is semantic and may normalize equivalent syntax, to_xml_string_exact is byte-identical.

0.2.0 - 2026-08-25

Added

  • Added validated GUID, XML Schema date-time/language/decimal/any-URI, multilingual text, reference, rational, data-type/value-list, unit-scale/base, and reusable ConceptType contracts.
  • Added a reusable arbitrary-precision XML Schema positiveInteger contract.
  • Modelled the four Annex E DataTypeType boundary variants and its repeating, implementation-defined regular-expression DataFormat values.
  • Added owned contracts for the ISO 23387 complex types imported by ISO 7817-3: subject, object type, property, group, quantity kind, reference document, dimension, unit, and data template.
  • Added a bounded, namespace-aware XML 1.0 parser and semantic writer retaining namespaces, ordering, comments, processing instructions, CDATA, and unknown elements and attributes.
  • Added typed views and owned wrappers for all five concrete global roots and the local Library child families represented by the Annex E XSD inventory.
  • Added structured built-in diagnostics with stable severity, category, and path fields while keeping parsing separate from validation.
  • Added inspect, validate, and rewrite CLI commands.
  • Added original synthetic XML fixtures with committed provenance and mutation probes for strict XML parsing, root classification, unknown-content retention, and safe CLI output replacement.

Changed

  • Replaced the unused openbim-core scaffold dependency with direct maintained roxmltree well-formedness checking and quick-xml event integration.
  • Updated documentation from namespace-scaffold status to the exact implemented 0.2 capability boundary without claiming XSD or clause-level conformance.

Security

  • Reject malformed XML 1.0, duplicate expanded attributes, illegal namespace bindings, DTD declarations, undeclared entities and prefixes, invalid characters, and malformed qualified names; enforce configurable byte, depth, node, and per-element attribute limits.
  • Write CLI rewrites through an OS-random, exclusively created same-directory temporary file so pre-created symlinks cannot redirect the write.

Fixed

  • Corrected global-root classification to the five concrete Annex E declarations while retaining typed local Library child views.
  • Made multilingual-text and reference diagnostics context-sensitive to the actual Annex E Symbol and *Ref declarations.
  • Made the owned Concept core require validated creation-date, name, and definition state and applied XML Schema whitespace collapsing to typed scalar values.
  • Reworked inherited namespace handling to use delta scopes and shared URI storage, preventing depth-amplified copies of ancestor namespace declarations.
  • Corrected DateTime extended-year and end-of-day fractional-second edges and aligned AnyUri with XML Schema 1.0's broad escaped lexical space.
  • Preserved tab, newline, and carriage-return character references in attribute values, plus carriage-return references in text, across repeated parse/write/ parse cycles.
  • Corrected ValueListType to require a validated language and one-or-more DataValue children whose optional order is bounded to XML Schema int, and restored missing-language diagnostics.
  • Connected the complete pre-standalone DT lineage across packages/openbim/openbim-dt, packages/openbim-dt, and packages/dt without rewriting the published v0.1.0 or v0.1.1 release commits.
  • Made the GitHub Pages upload include hidden files so the deployed artifact matches the tree validated by the documentation gate, including .nojekyll.

0.1.1 - 2026-08-25

Changed

  • Established openbimrs/dt as the canonical standalone repository while preserving the data-template subtree history.
  • Corrected repository, homepage, documentation, and package metadata.
  • Added standalone CI, packaging gates, architecture documentation, roadmap, contributor guidance, and a verified GitHub Pages documentation pipeline.
  • Clarified that the released API is a namespace scaffold, not a complete ISO 23387 model, parser, writer, or validator.

Security

  • Added fail-closed package and documentation checks preventing ISO/DIN/CEN references, schemas, PDFs, and annex examples from entering release artifacts.

0.1.0 - 2026-08-24

Added

  • Reserved openbim-dt with ISO 23387 edition 2 and draft-placeholder namespace constants.