runx-contracts 0.6.19

Shared Rust contract types for runx JSON and host protocol boundaries.
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

//! Agent-context envelope (`runx.ai/spec/agent-context-envelope`): the bulky
//! per-act execution context referenced from a receipt act's `context_ref`
//! (instructions, inputs, current/historical artifact context, provenance, and
//! the resolved skill profiles).
//!
//! Identity is the legacy bare `runx.ai/spec` `$id` (no `x-runx-schema`).
use serde::{Deserialize, Serialize};

use crate::JsonObject;
use crate::output::OutputField;
use crate::schema::{NonEmptyString, RunxSchema};
use std::collections::BTreeMap;

/// The artifact context entry version. Committed as `const: "1"`.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
pub enum ContextEntryVersion {
    #[serde(rename = "1")]
    V1,
}

/// The producer of a context artifact.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ContextArtifactProducer {
    pub skill: NonEmptyString,
    pub runner: NonEmptyString,
}

/// Metadata for a context artifact. `step_id`, `parent_artifact_id`, and
/// `receipt_id` are required-but-nullable (present on the wire, possibly null).
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ContextArtifactMeta {
    pub artifact_id: NonEmptyString,
    pub run_id: NonEmptyString,
    pub step_id: Option<NonEmptyString>,
    pub producer: ContextArtifactProducer,
    pub created_at: NonEmptyString,
    pub hash: NonEmptyString,
    pub size_bytes: u64,
    pub parent_artifact_id: Option<NonEmptyString>,
    pub receipt_id: Option<NonEmptyString>,
    pub redacted: bool,
}

/// A single artifact context entry. `type` is required-but-nullable.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ContextEntry {
    #[serde(rename = "type")]
    pub entry_type: Option<NonEmptyString>,
    pub version: ContextEntryVersion,
    pub data: JsonObject,
    pub meta: ContextArtifactMeta,
}

/// One input/output provenance edge.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ProvenanceEntry {
    pub input: NonEmptyString,
    pub output: NonEmptyString,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from_step: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub artifact_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub receipt_id: Option<String>,
}

/// A resolved profile sourced from a workspace file (memory, conventions,
/// voice).
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ProfileFile {
    pub root_path: NonEmptyString,
    pub path: NonEmptyString,
    pub sha256: NonEmptyString,
    pub content: String,
}

/// The optional memory/conventions context block.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct AgentContextProfiles {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<ProfileFile>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub conventions: Option<ProfileFile>,
}

/// The resolved quality profile source. `source` is committed as
/// `const: "SKILL.md#quality-profile"`.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
pub enum QualityProfileSource {
    #[serde(rename = "SKILL.md#quality-profile")]
    SkillMd,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct QualityProfile {
    pub source: QualityProfileSource,
    pub sha256: NonEmptyString,
    pub content: String,
}

/// Where the skill executes from on disk.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ExecutionLocation {
    pub skill_directory: NonEmptyString,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tool_roots: Option<Vec<NonEmptyString>>,
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
#[runx_schema(spec_id = "https://runx.ai/spec/agent-context-envelope.schema.json")]
pub struct AgentContextEnvelope {
    pub run_id: NonEmptyString,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub step_id: Option<NonEmptyString>,
    pub skill: NonEmptyString,
    pub instructions: NonEmptyString,
    pub inputs: JsonObject,
    pub allowed_tools: Vec<NonEmptyString>,
    pub current_context: Vec<ContextEntry>,
    pub historical_context: Vec<ContextEntry>,
    pub provenance: Vec<ProvenanceEntry>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub context: Option<AgentContextProfiles>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub voice_profile: Option<ProfileFile>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quality_profile: Option<QualityProfile>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub execution_location: Option<ExecutionLocation>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub output: Option<BTreeMap<String, OutputField>>,
    pub trust_boundary: NonEmptyString,
}