louietui 1.0.0

An agentic-first TUI framework with complete ontology for agent discoverability
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! # Ontology — Agent Discoverability System
//!
//! The ontology module provides structured metadata for every component in a
//! louie application. AI agents can introspect widget schemas, discover
//! available actions, query capabilities, and navigate the UI tree
//! programmatically.
//!
//! ## Design
//!
//! Every widget that implements [`Discoverable`] exposes:
//! - **Schema**: Type name, description, properties with types and constraints
//! - **Capabilities**: What the widget can do (scrollable, editable, focusable, etc.)
//! - **Actions**: Named operations with typed parameters that agents can invoke
//! - **Semantic Role**: The widget's purpose (input, navigation, display, container, etc.)
//!
//! The [`OntologyRegistry`] maintains a global catalog of all registered widget
//! types, enabling agents to list, search, and instantiate widgets by name or role.

mod action;
mod capability;
pub mod registry;
mod schema;

pub use action::{ActionParam, ActionParamType, AgentAction};
pub use capability::AgentCapability;
pub use registry::{OntologyRegistry, UiNode, UiTree};
pub use schema::{PropertyConstraint, PropertySchema, PropertyType, SemanticRole, WidgetSchema};

/// Trait for widgets that expose metadata to agents.
///
/// Any widget implementing this trait becomes discoverable: agents can introspect
/// its schema, invoke actions, and read its state as structured data.
pub trait Discoverable {
    /// Returns the static schema describing this widget type.
    fn schema() -> WidgetSchema
    where
        Self: Sized;

    /// Returns the capabilities of this specific widget instance.
    /// Returns the capabilities of this specific widget instance.
    fn capabilities(&self) -> Vec<AgentCapability>;

    /// Returns the actions available on this specific widget instance.
    fn actions(&self) -> Vec<AgentAction>;

    /// Returns the semantic role of this widget (e.g., TextInput, Display, Navigation).
    fn semantic_role(&self) -> SemanticRole;

    /// Returns the current state as a JSON value for agent inspection.
    fn agent_state(&self) -> serde_json::Value;

    /// Attempt to execute a named action with the given JSON parameters.
    /// Returns Ok with a result value, or Err with a description of the failure.
    fn execute_action(
        &mut self,
        action: &str,
        params: &serde_json::Value,
    ) -> Result<serde_json::Value, String>;

    /// An optional unique identifier for this widget instance in the UI tree.
    fn agent_id(&self) -> Option<&str> {
        None
    }

    /// An optional accessibility label for screen readers and agents.
    fn accessibility_label(&self) -> Option<String> {
        None
    }
}