sprawling-wire 0.0.12

The process boundary of a sprawling city: the frames its clients speak, and the server that answers them.
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
// Copyright (c) 2026 2youg1 and the sprawling contributors

//! How far the person has got through the first-run guide, kept per
//! city (`crates/wire/spec/Guide.lean` ยง8-68): the record a page reads with `Query::Guide`
//! and writes whole with `Command::PutGuide`, beside `preference`, which
//! is the same kind of record for the person's own settings.
//!
//! What this records is where the person went, not what is configured:
//! whether a step is done is read from the configuration and the doctor
//! each time, and a step opened or skipped here is never drawn as done.

use serde::{Deserialize, Serialize};

/// The guide's progress in one city: where it reopens, whether the
/// person has left it, and each optional step seen or put off.
///
/// The provider step has no mark: it is the one step that must be done,
/// and only the city's saved endpoint and `main` model say whether it is.
/// Every field defaults, so a city nobody has guided reads as a guide at
/// its start.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct GuideProgress {
    /// The step the guide opens at next; absent until the person moved.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub at: Option<GuideStep>,
    #[serde(default)]
    pub state: GuideState,
    /// Step 2, the dependencies the doctor reads.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dependencies: Option<GuideMark>,
    /// Step 3, the texts and the names.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub texts: Option<GuideMark>,
    /// Step 4, importing a skill.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub skills: Option<GuideMark>,
    /// Step 5, connecting a tool server.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mcp: Option<GuideMark>,
}

/// The five steps, in the order the guide gives them.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum GuideStep {
    Provider,
    Dependencies,
    Texts,
    Skills,
    Mcp,
}

/// Whether opening the city still offers the guide.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum GuideState {
    /// The guide is offered when the city opens.
    #[default]
    Open,
    /// The person left it: the city opens on the conversation, and the
    /// guide opens from the settings.
    Left,
}

/// What the person did with one optional step. A step with no mark has
/// not been looked at.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum GuideMark {
    Seen,
    Skipped,
}