qontinui-types 0.6.0

Canonical DTO types for Qontinui. Rust is the source of truth; TypeScript and Python are generated from JSON Schema emitted by schemars.
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

//! Config models — AI context and workflow category.
//!
//! Mirrors `src/qontinui_schemas/config/models/context.py` and the
//! `Category` class from `config_root.py`. Rust is the source of truth; TS
//! and Python bindings regenerate from the JSON Schemas emitted here.
//!
//! Wire convention: these types predate the snake_case migration and use
//! camelCase field aliases on the wire (`taskMentions`, `autoInclude`,
//! `createdAt`, …). Rust code uses snake_case; `#[serde(rename = ...)]`
//! renames each field on the wire to match the existing consumers.

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

// ============================================================================
// ContextAutoInclude
// ============================================================================

/// Rules for automatically including a context in AI tasks.
///
/// When an AI task is created, the runner evaluates these rules to decide
/// which contexts should be auto-included. Multiple rules are OR'd together
/// (any match triggers inclusion).
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
#[schemars(deny_unknown_fields)]
pub struct ContextAutoInclude {
    /// Keywords in the task prompt that trigger inclusion
    /// (case-insensitive).
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        rename = "taskMentions",
        alias = "task_mentions"
    )]
    pub task_mentions: Option<Vec<String>>,
    /// Action types in the loaded config that trigger inclusion
    /// (e.g., `CLICK`, `FIND`).
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        rename = "actionTypes",
        alias = "action_types"
    )]
    pub action_types: Option<Vec<String>>,
    /// Regex patterns in recent logs that trigger inclusion.
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        rename = "errorPatterns",
        alias = "error_patterns"
    )]
    pub error_patterns: Option<Vec<String>>,
    /// Glob patterns for files being worked on (e.g., `*.rs`, `src/api/**`).
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        rename = "filePatterns",
        alias = "file_patterns"
    )]
    pub file_patterns: Option<Vec<String>>,
}

// ============================================================================
// Context
// ============================================================================

/// AI context — a markdown document injected into AI task prompts to
/// provide background knowledge, coding standards, architectural guidance,
/// or debugging tips.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
#[schemars(deny_unknown_fields)]
pub struct Context {
    /// Unique identifier (UUID v4 or a prefixed string like
    /// `"ctx-schema-flow"`).
    #[serde(alias = "id")]
    pub id: String,
    /// Human-readable name for display.
    #[serde(alias = "name")]
    pub name: String,
    /// Markdown content injected into AI prompts.
    #[serde(alias = "content")]
    pub content: String,
    /// Category for organization (e.g., `"architecture"`, `"debugging"`,
    /// `"philosophy"`).
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "category")]
    pub category: Option<String>,
    /// Tags for flexible grouping and search.
    #[serde(default, alias = "tags")]
    pub tags: Vec<String>,
    /// Rules for automatic inclusion in AI tasks.
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        rename = "autoInclude",
        alias = "auto_include"
    )]
    pub auto_include: Option<ContextAutoInclude>,
    /// ISO 8601 creation timestamp.
    #[serde(rename = "createdAt", alias = "created_at")]
    pub created_at: String,
    /// ISO 8601 last-modification timestamp.
    #[serde(rename = "modifiedAt", alias = "modified_at")]
    pub modified_at: String,
}

// ============================================================================
// Category
// ============================================================================

/// Workflow category for organization and automation control.
///
/// Categories organize workflows and control which are available for
/// automation in the runner. Only workflows in categories with
/// `automationEnabled = true` appear in the runner's workflow list.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
#[schemars(deny_unknown_fields)]
pub struct Category {
    /// Category name (e.g., `"Main"`, `"Testing"`).
    #[serde(alias = "name")]
    pub name: String,
    /// Whether workflows in this category are available for automation.
    #[serde(
        default = "default_true",
        rename = "automationEnabled",
        alias = "automation_enabled"
    )]
    pub automation_enabled: bool,
}

fn default_true() -> bool {
    true
}