@vuer-ai/dial-types
v0.0.1
Published
Shared schema contract for the Vuer dial system. Consumed by @vuer-ai/dial-cli (generator), @vuer-ai/vuer-uikit (renderer), and @vuer-ai/vuer (consumer). Types only, no runtime code.
Readme
@vuer-ai/dial-types
Shared schema contract for the Vuer dial system. Types only — no runtime code.
The dial system has three layers, and this package is the contract between them:
| Layer | Package | Role |
| --- | --- | --- |
| Generator | @vuer-ai/dial-cli | Parses annotated components, emits schemas in this format |
| Renderer | @vuer-ai/vuer-uikit | Renders dial UIs (DialPanel, DialProvider) from this format |
| Consumer | @vuer-ai/vuer (and others) | Declares controls (useDialControls, …) in this format |
Usage
import type { DialSchema, GroupSchema, ComponentSchema } from "@vuer-ai/dial-types";Since this package ships only type declarations, it is safe to list as a regular
dependency — it adds no runtime weight and cannot cause version conflicts at runtime.
Exported types
DialSchema— schema for a single dial controlGroupSchema— layout configuration for a group of controlsComponentSchema— full schema for a component (name + schemas + groups)NestedTypeDefinition— nested structure forinterface/tupledtypesDialDtype— all supporteddtypevaluesDialValue— value union for dial fieldsDialCustomRenderContext/DialCustomRenderFn— custom renderer contract fordtype="custom"
