apcore 0.20.0

Schema-driven module standard for AI-perceivable interfaces
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! GetUser module — readonly + idempotent behavioral annotations.

use apcore::context::{Context, Identity};
use apcore::errors::ModuleError;
use apcore::module::{Module, ModuleAnnotations};
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use serde_json::{json, Value};
use std::collections::HashMap;

// ---------------------------------------------------------------------------
// Typed schemas
// ---------------------------------------------------------------------------

#[derive(Debug, Serialize, Deserialize)]
struct GetUserInput {
    user_id: String,
}

#[derive(Debug, Serialize, Deserialize)]
struct GetUserOutput {
    id: String,
    name: String,
    email: String,
}

// ---------------------------------------------------------------------------
// Module implementation
// ---------------------------------------------------------------------------

struct GetUserModule;

impl GetUserModule {
    fn users() -> HashMap<&'static str, GetUserOutput> {
        let mut m = HashMap::new();
        m.insert(
            "user-1",
            GetUserOutput {
                id: "user-1".into(),
                name: "Alice".into(),
                email: "alice@example.com".into(),
            },
        );
        m.insert(
            "user-2",
            GetUserOutput {
                id: "user-2".into(),
                name: "Bob".into(),
                email: "bob@example.com".into(),
            },
        );
        m
    }
}

#[async_trait]
impl Module for GetUserModule {
    fn input_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "user_id": { "type": "string", "description": "The user's unique identifier" }
            },
            "required": ["user_id"]
        })
    }

    fn output_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "id":    { "type": "string" },
                "name":  { "type": "string" },
                "email": { "type": "string" }
            },
            "required": ["id", "name", "email"]
        })
    }

    fn description(&self) -> &'static str {
        "Look up a user by ID (readonly, idempotent)"
    }

    async fn execute(&self, input: Value, _ctx: &Context<Value>) -> Result<Value, ModuleError> {
        let req: GetUserInput = serde_json::from_value(input).map_err(|e| {
            ModuleError::new(
                apcore::errors::ErrorCode::GeneralInvalidInput,
                e.to_string(),
            )
        })?;

        let users = Self::users();
        let output = match users.get(req.user_id.as_str()) {
            Some(u) => GetUserOutput {
                id: u.id.clone(),
                name: u.name.clone(),
                email: u.email.clone(),
            },
            None => GetUserOutput {
                id: req.user_id.clone(),
                name: "Unknown".into(),
                email: "unknown@example.com".into(),
            },
        };

        Ok(serde_json::to_value(output).unwrap())
    }
}

// ---------------------------------------------------------------------------
// Helper — build annotations for this module
// ---------------------------------------------------------------------------

fn get_user_annotations() -> ModuleAnnotations {
    ModuleAnnotations {
        readonly: true,
        idempotent: true,
        cacheable: true,
        cache_ttl: 60,
        ..Default::default()
    }
}

// ---------------------------------------------------------------------------
// Main
// ---------------------------------------------------------------------------

#[tokio::main]
async fn main() {
    let identity = Identity::new(
        "service-account".to_string(),
        "service".to_string(),
        vec!["reader".to_string()],
        HashMap::new(),
    );
    let ctx: Context<Value> = Context::new(identity);
    let module = GetUserModule;

    for user_id in ["user-1", "user-2", "user-999"] {
        let out = module
            .execute(json!({"user_id": user_id}), &ctx)
            .await
            .unwrap();
        println!("{user_id}: {out}");
    }

    // Show annotations
    let annotations = get_user_annotations();
    println!(
        "\nAnnotations: {}",
        serde_json::to_string_pretty(&annotations).unwrap()
    );
}