appcore-app-spec 0.1.0

The specification for AppCore apps
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

use schemars::JsonSchema;
use serde_derive::Deserialize;

pub use crate::nextjs::*;

mod nextjs;

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct AppSpec {
    pub name: String,

    /// The fully qualified domain name of the app.
    pub domain: String,

    pub dev: DevConfig,

    pub app: AppDetails,

    pub secrets: AppSecretsConfig,

    #[serde(default)]
    pub auth: Option<AppAuthConfig>,

    #[serde(default)]
    pub db: Option<DatabaseConfig>,

    #[serde(default)]
    pub redis: Option<RedisConfig>,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum AppDetails {
    #[serde(rename = "nextjs-app")]
    NextJsApp(NextJsApp),
    #[serde(rename = "nodejs-api-server")]
    NodeJsApiServer(NodeJsApiServer),
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct NodeJsApiServer {}

/// Configuration for the development environment.
#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct DevConfig {
    pub port: u16,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(tag = "provider", rename_all = "snake_case", deny_unknown_fields)]
pub enum AppSecretsConfig {
    #[serde(rename = "vercel")]
    Vercel(VercelSecretsConfig),
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct VercelSecretsConfig {
    pub org: String,
    pub project: String,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(tag = "provider", rename_all = "snake_case", deny_unknown_fields)]
pub enum AppAuthConfig {
    #[serde(rename = "logto")]
    Logto(LogtoAuthConfig),
}

/// Configuration for the Logto authentication provider.
///
/// This configuration assumes `https://$domain/api/auth/callback` and
/// `http://localhost:$port/api/auth/callback` is the callback url for the
/// application.
#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct LogtoAuthConfig {
    pub app_name: String,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(tag = "provider", rename_all = "snake_case", deny_unknown_fields)]
pub enum DatabaseConfig {
    #[serde(rename = "neon")]
    Neon(NeonDatabaseConfig),
    #[serde(rename = "coolify")]
    Coolify(CoolifyDatabaseConfig),
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct NeonDatabaseConfig {
    pub project_name: String,
}

/// Configuration for the Coolify database provider.
///
/// This configuration assumes the environment for the database is `production`
/// and `development`.
#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct CoolifyDatabaseConfig {
    pub project_name: String,
    pub server_name: String,
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(tag = "provider", rename_all = "snake_case", deny_unknown_fields)]
pub enum RedisConfig {
    #[serde(rename = "coolify")]
    Coolify(CoolifyRedisConfig),
}

#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub struct CoolifyRedisConfig {
    pub project_name: String,
    pub server_name: String,
}