apcore 0.19.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

//! SendEmail module — destructive action with sensitive fields and examples.

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 SendEmailInput {
    to: String,
    subject: String,
    body: String,
    /// Sensitive field — should be redacted in logs.
    api_key: String,
}

#[derive(Debug, Serialize, Deserialize)]
struct SendEmailOutput {
    status: String,
    message_id: String,
}

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

struct SendEmailModule;

#[async_trait]
impl Module for SendEmailModule {
    fn input_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "to":      { "type": "string", "description": "Recipient email address" },
                "subject": { "type": "string" },
                "body":    { "type": "string" },
                "api_key": { "type": "string", "x-sensitive": true }
            },
            "required": ["to", "subject", "body", "api_key"]
        })
    }

    fn output_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "status":     { "type": "string", "enum": ["sent", "failed"] },
                "message_id": { "type": "string" }
            },
            "required": ["status", "message_id"]
        })
    }

    fn description(&self) -> &'static str {
        "Send an email message via external API (destructive)"
    }

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

        // Simulate sending (real impl would call SMTP/API)
        println!(
            "[{}] Sending email to '{}' | subject: '{}'",
            ctx.trace_id, req.to, req.subject
        );

        let message_id = format!("msg-{:05}", req.to.len() * 1000 % 100_000);

        let output = SendEmailOutput {
            status: "sent".to_string(),
            message_id,
        };

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

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

fn send_email_annotations() -> ModuleAnnotations {
    ModuleAnnotations {
        destructive: true,
        requires_approval: true,
        open_world: true,
        ..Default::default()
    }
}

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

#[tokio::main]
async fn main() {
    let identity = Identity::new(
        "admin-1".to_string(),
        "user".to_string(),
        vec!["admin".to_string()],
        HashMap::new(),
    );
    let ctx: Context<Value> = Context::new(identity);
    let module = SendEmailModule;

    let out = module
        .execute(
            json!({
                "to":      "alice@example.com",
                "subject": "Hello from apcore",
                "body":    "This is a test email.",
                "api_key": "sk-secret"
            }),
            &ctx,
        )
        .await
        .unwrap();
    println!("Result: {out}");

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

    // Schema — note x-sensitive on api_key
    println!(
        "\nInput schema:\n{}",
        serde_json::to_string_pretty(&module.input_schema()).unwrap()
    );
}