idiolect-records 0.2.0

Rust record types mirroring the dev.idiolect.* Lexicon family.
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

// @generated by idiolect-codegen. do not edit.
// source: dev.idiolect.community

//! A group of DIDs that declare shared conventions. Self-constituted per P4: no central roll, no grading of legitimacy. Communities may be small and many.

#![allow(
    missing_docs,
    clippy::doc_markdown,
    clippy::struct_excessive_bools,
    clippy::derive_partial_eq_without_eq
)]
use serde::{Deserialize, Serialize};

/// A community is a self-constituted group declaring shared schemas, lenses, and conventions. Membership may be listed inline for small communities, or referenced for larger ones.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Community {
    /// Structured community conventions the decidable subset. Review cadence, verification requirements, deprecation policies. Style/tone norms live in `conventionsText`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub conventions: Option<Vec<CommunityConventions>>,
    /// Narrative conventions: style guides, tone, conventions not expressible as a structured predicate. Companion to `conventions`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub conventions_text: Option<String>,
    /// Lenses the community treats as canonical.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub core_lenses: Option<Vec<super::defs::LensRef>>,
    /// Schemas the community treats as canonical for its purposes.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub core_schemas: Option<Vec<super::defs::SchemaRef>>,
    pub created_at: String,
    /// Purpose, norms, and scope of the community. Narrative, not machine-interpreted.
    pub description: String,
    /// Other communities this community recognises as legitimate interlocutors. Endorsement is not transitive.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub endorsed_communities: Option<Vec<String>>,
    /// Inline list of member DIDs, for small communities. Use membershipRoll instead for communities above ~200 members.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub members: Option<Vec<String>>,
    /// AT-URI pointing to an externally maintained membership record for larger communities.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub membership_roll: Option<String>,
    /// Human-readable community name.
    pub name: String,
}

impl crate::Record for Community {
    const NSID: &'static str = "dev.idiolect.community";
}

/// How the community handles deprecation: minimum notice, replacement requirements.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ConventionDeprecationPolicy {
    /// Minimum days of advance notice before a deprecated lens is removed.
    pub notice_period_days: i64,
    /// Whether deprecations must point at a replacement lens before publication.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub replacement_required: Option<bool>,
}

/// Expected turnaround for community review of proposed lenses/verifications.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ConventionReviewCadence {
    /// Maximum business-days expected before a review is posted.
    pub max_days: i64,
    /// Optional narrowing (e.g. 'lens-review', 'verification-review', 'all').
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub scope: Option<String>,
}

/// A verification the community requires before endorsing a lens.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ConventionVerificationReq {
    pub kind: ConventionVerificationReqKind,
    /// Optional specific property required.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub property: Option<super::defs::LensProperty>,
}

/// ConventionVerificationReqKind.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum ConventionVerificationReqKind {
    RoundtripTest,
    PropertyTest,
    FormalProof,
    ConformanceTest,
    StaticCheck,
    ConvergencePreserving,
}

/// CommunityConventions tagged union.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "$type")]
pub enum CommunityConventions {
    #[serde(rename = "dev.idiolect.community#conventionReviewCadence")]
    ConventionReviewCadence(ConventionReviewCadence),
    #[serde(rename = "dev.idiolect.community#conventionVerificationReq")]
    ConventionVerificationReq(ConventionVerificationReq),
    #[serde(rename = "dev.idiolect.community#conventionDeprecationPolicy")]
    ConventionDeprecationPolicy(ConventionDeprecationPolicy),
}