qa-spec 0.5.0

Core QA specification models and validation utilities.
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

use crate::expr::Expr;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

/// Identifier for QA flow steps.
pub type StepId = String;

/// Card/render modes for message steps.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum CardMode {
    Text,
    Json,
    Card,
}

/// Single message/prompt step inside a flow.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct MessageStep {
    pub mode: CardMode,
    pub template: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next: Option<StepId>,
}

/// Step that asks a question.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct QuestionStep {
    pub question_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next: Option<StepId>,
}

/// Conditional branch case.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct DecisionCase {
    #[serde(rename = "if")]
    pub if_expr: Expr,
    pub goto: StepId,
}

/// Decision / branching step.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct DecisionStep {
    pub cases: Vec<DecisionCase>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_goto: Option<StepId>,
}

/// Flow-wide policies (placeholder for future expansion).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct FlowPolicy {
    #[serde(default)]
    pub allow_back: bool,
    #[serde(default)]
    pub allow_submit_all: bool,
}

/// A single wire-up step in QA flows.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum StepSpec {
    Message(MessageStep),
    Question(QuestionStep),
    Decision(DecisionStep),
    Action { name: String },
    End,
}

/// QAFlow: directed graph of steps executed inside the wizard.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct QAFlowSpec {
    pub id: String,
    pub title: String,
    pub version: String,
    pub entry: StepId,
    pub steps: BTreeMap<StepId, StepSpec>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub policies: Option<FlowPolicy>,
}