greentic-types 0.4.13

Shared primitives for Greentic: TenantCtx, InvocationEnvelope, NodeError, ids.
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

//! Canonical pack manifest (.gtpack) representation.

use alloc::string::String;
use alloc::vec::Vec;

use semver::Version;

use crate::{ComponentId, FlowId, PackId, SemverReq};

#[cfg(feature = "schemars")]
use schemars::JsonSchema;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Hint describing the primary purpose of a pack.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub enum PackKind {
    /// Normal digital worker packs.
    Application,
    /// Packs whose flows primarily operate on deployment plans.
    Deployment,
    /// Packs that mix both application and deployment flows.
    Mixed,
}

/// Pack manifest describing bundled flows and referenced components.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct PackManifest {
    /// Logical pack identifier.
    pub id: PackId,
    /// Pack semantic version.
    #[cfg_attr(
        feature = "schemars",
        schemars(with = "String", description = "SemVer version")
    )]
    pub version: Version,
    /// Optional human-friendly name.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub name: Option<String>,
    /// Flow references bundled within the pack.
    #[cfg_attr(feature = "serde", serde(default))]
    pub flows: Vec<PackFlowRef>,
    /// Component references required by the pack.
    #[cfg_attr(feature = "serde", serde(default))]
    pub components: Vec<PackComponentRef>,
    /// Optional pack-level profile defaults.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub profiles: Option<Value>,
    /// Optional component source metadata (registries, mirrors, etc.).
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub component_sources: Option<Value>,
    /// Optional connector metadata describing ingress wiring.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub connectors: Option<Value>,
    /// Optional hint about the primary intent of this pack.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub kind: Option<PackKind>,
}

/// Flow reference within a pack manifest.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct PackFlowRef {
    /// Flow identifier as referenced by connectors/runners.
    pub id: FlowId,
    /// Relative file path (inside the pack) to the .ygtc document.
    pub file: String,
}

/// Component reference within a pack manifest.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct PackComponentRef {
    /// Component identifier.
    pub id: ComponentId,
    /// Supported version requirement.
    pub version_req: SemverReq,
    /// Optional source hint (registry, OCI ref, etc.).
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub source: Option<String>,
}