supercode-interchange 0.4.76

Canonical, provider-neutral session interchange primitives for Supercode
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

//! The home and its profiles (§2.1): the root folder IS the `default`
//! profile; `profiles/<name>/` are the named ones.

use std::collections::BTreeMap;
use std::path::PathBuf;

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::{Access, ChannelConfig, Fire, Job, Obligation, Route, WebhookSubscription, WorkerSpec};
use crate::ontology::Binding;

/// The persona: `AGENTS.md` at the profile root, content hash first.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct PersonaRef {
    /// Always `AGENTS.md` in our folder (`SOUL.md` in a Hermes home).
    pub path: String,
    /// The text, when loaded.
    #[serde(default)]
    pub text: Option<String>,
    /// Hex sha256 of the text.
    pub sha256: String,
}

/// What a profile carries that the model does not interpret.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct ProfileResidue {
    /// `config.yaml` keys that are the source harness's, verbatim.
    #[serde(default)]
    pub config: BTreeMap<String, Value>,
    /// Unmodeled files, by path relative to the profile dir; copied verbatim.
    #[serde(default)]
    pub files: Vec<String>,
}

/// One profile: a folder with `AGENTS.md` at its root.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct Profile {
    /// `default` for the root, else the folder name.
    pub name: String,
    /// The folder.
    pub dir: PathBuf,
    /// O — which harness runs it.
    #[serde(default)]
    pub worker: Option<WorkerSpec>,
    /// O — `AGENTS.md`.
    #[serde(default)]
    pub persona: Option<PersonaRef>,
    /// H — `config.yaml` `platforms:` blocks.
    #[serde(default)]
    pub channels: BTreeMap<String, ChannelConfig>,
    /// H — `gateway.profile_routes`.
    #[serde(default)]
    pub routes: Vec<Route>,
    /// H — `cron/jobs.json`.
    #[serde(default)]
    pub jobs: BTreeMap<String, Job>,
    /// H — `webhook_subscriptions.json`.
    #[serde(default)]
    pub subscriptions: BTreeMap<String, WebhookSubscription>,
    /// H — allowlists and pairing.
    #[serde(default)]
    pub access: Access,
    /// O — the conversations, keyed by their slot (the surface key string for
    /// a live one, `<key>#<started_at>[#n]` for ended ones).
    #[serde(default)]
    pub bindings: BTreeMap<String, Binding>,
    /// H — `cron/executions.db`.
    #[serde(default)]
    pub fires: Vec<Fire>,
    /// H — `delivery_obligations`.
    #[serde(default)]
    pub obligations: Vec<Obligation>,
    /// What the model does not interpret.
    #[serde(default)]
    pub residue: ProfileResidue,
}

/// The whole home: the persisted half of `OrchestratorState` (§2.1); the
/// runtime half is never written and is not part of the wire.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
pub struct Orchestration {
    /// The home folder.
    pub root: PathBuf,
    /// `default` is the root folder; the rest are `profiles/<name>/`.
    pub profiles: BTreeMap<String, Profile>,
}