rfw_catalog_schema 2.0.0 copy "rfw_catalog_schema: ^2.0.0" to clipboard
rfw_catalog_schema: ^2.0.0 copied to clipboard

Public schema, annotations, wire identity, and JSON codecs for a Remote Flutter Widgets (RFW) widget catalog. Pure-Dart — used to produce, transmit, or decode catalogs.

Changelog #

2.0.0 #

  • Name the PreferredSizeWidget slot type and the synthetic strategies that carry such a slot's height and that surface a Size argument as a height.
  • Make the unnamed generative constructor the source of truth for custom widget inputs, requiredness, positionalness, and order; descriptions may come from Dartdoc and RestageProperty becomes an optional metadata overlay.
  • Emit canonical catalog schema v5 while continuing to decode schema v4 at the catalog boundary.
  • Remove the closed event-name enum and event rename/declaration fields. An event's identity is now the exact callback constructor property name.
  • Add pure-Dart target configuration annotations with aggregate and composable shorthand constructors for A2UI, RFW, and Widgetbook.
  • Add EmitTarget and target-selective @Ignore authoring. Bare @ignore and @Ignore() retain their all-target behavior.
  • Add class-level enabled configuration and a composable Config.enabled shorthand for RFW, A2UI, and Widgetbook custom-widget targets.
  • Remove the deprecated target fields from RestageWidget and RestageProperty.
  • Remove public RestageWidget.childrenSlot. Custom child-bearing properties are derived from every exact Widget and List<Widget> constructor input; the ChildrenSlot enum and WidgetEntry.childrenSlot wire field remain for curated built-ins and backwards-compatible decoding.
  • Add typed RestageConstraints to property annotations and catalog entries, with deterministic schema-v4 encoding and structural preservation of unknown constraint keywords.
  • Add RestageDataField for nested data documentation.

1.1.0 #

  • Add the optional usage parameter to @RestageWidget: producer-facing guidance for when and how to use a widget. It emits into the generated A2UI catalog's system-prompt fragments, falling back to the widget description.
  • Add the opaque list-of-structured wire shape (ListShape.opaqueStructured and ListShape.isOpaqueStructuredList) for a property typed as a list of structured values, where the item shape carries the structured reference.

1.0.3 #

  • Documentation: README refresh.

1.0.2 #

  • Add the optional writeBackValue parameter to @RestageProperty, pairing a callback property with the field whose value it writes back.

1.0.1 #

  • Add a usage example and shorten the package description.

1.0.0 #

  • Initial release. Catalog data types, wire identity (WireId, WireIdRef, WireIdKind), annotations, hand-written JSON codecs, and the supporting metadata, default-value, lifecycle, and compatibility-rule types.
1
likes
160
points
332
downloads

Documentation

API reference

Publisher

verified publisherrestage.dev

Weekly Downloads

Public schema, annotations, wire identity, and JSON codecs for a Remote Flutter Widgets (RFW) widget catalog. Pure-Dart — used to produce, transmit, or decode catalogs.

Homepage
Repository (GitHub)
View/report issues
Contributing

Topics

#server-driven-ui #remote-ui #flutter

License

BSD-3-Clause (license)

Dependencies

meta

More

Packages that depend on rfw_catalog_schema