platform/platform-schema.json at main · SolidWorx/platform · GitHub

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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "SolidWorx Platform Configuration",
    "description": "Configuration schema for platform.yaml",
    "type": "object",
    "properties": {
        "platform": {
            "type": "object",
            "description": "Core platform configuration",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The name of the platform.",
                    "default": "SolidWorx Platform"
                },
                "version": {
                    "type": "string",
                    "description": "The version of the platform.",
                    "default": "1.0.0"
                },
                "security": {
                    "type": "object",
                    "properties": {
                        "two_factor": {
                            "type": "object",
                            "properties": {
                                "enabled": {
                                    "type": "boolean",
                                    "description": "Enable two-factor authentication.",
                                    "default": false
                                },
                                "base_template": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "description": "The base layout template for 2FA pages."
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "doctrine": {
                    "type": "object",
                    "properties": {
                        "types": {
                            "type": "object",
                            "properties": {
                                "enable_utc_date": {
                                    "type": "boolean",
                                    "description": "Enable UTC date type.",
                                    "default": true
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "models": {
                    "type": "object",
                    "properties": {
                        "user": {
                            "type": "string",
                            "description": "The User model class.",
                            "default": "SolidWorx\\Platform\\PlatformBundle\\Model\\User"
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "saas": {
            "type": "object",
            "description": "SaaS / subscription configuration",
            "properties": {
                "doctrine": {
                    "type": "object",
                    "required": [
                        "subscriptions"
                    ],
                    "properties": {
                        "subscriptions": {
                            "type": "object",
                            "required": [
                                "entity"
                            ],
                            "properties": {
                                "entity": {
                                    "type": "string",
                                    "description": "Fully-qualified class name of the subscription entity."
                                }
                            }
                        },
                        "db_schema": {
                            "type": "object",
                            "properties": {
                                "table_names": {
                                    "type": "object",
                                    "properties": {
                                        "plan": {
                                            "type": "string",
                                            "default": "saas_plan"
                                        },
                                        "subscription": {
                                            "type": "string",
                                            "default": "saas_subscription"
                                        },
                                        "subscription_log": {
                                            "type": "string",
                                            "default": "saas_subscription_log"
                                        },
                                        "plan_feature": {
                                            "type": "string",
                                            "default": "saas_plan_feature"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "payment": {
                    "type": "object",
                    "required": [
                        "return_route"
                    ],
                    "properties": {
                        "return_route": {
                            "type": "string",
                            "description": "Route name to redirect to after payment."
                        }
                    }
                },
                "integration": {
                    "type": "object",
                    "properties": {
                        "lemon_squeezy": {
                            "type": "object",
                            "properties": {
                                "enabled": {
                                    "type": "boolean",
                                    "default": false
                                },
                                "api_key": {
                                    "type": "string"
                                },
                                "webhook_secret": {
                                    "type": "string"
                                },
                                "store_id": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                "features": {
                    "type": "object",
                    "description": "Named feature definitions.",
                    "additionalProperties": {
                        "type": "object",
                        "required": [
                            "type",
                            "default"
                        ],
                        "properties": {
                            "type": {
                                "type": "string",
                                "enum": [
                                    "boolean",
                                    "integer",
                                    "string",
                                    "array"
                                ]
                            },
                            "default": {
                                "description": "Default value for the feature."
                            },
                            "description": {
                                "type": "string"
                            }
                        }
                    }
                }
            }
        },
        "ui": {
            "type": "object",
            "description": "UI / presentation configuration",
            "properties": {
                "icon_pack": {
                    "type": "string",
                    "description": "The icon pack to use.",
                    "default": "tabler"
                },
                "templates": {
                    "type": "object",
                    "properties": {
                        "base": {
                            "type": "string",
                            "description": "The base layout template.",
                            "default": "@Ui/Layout/base.html.twig"
                        },
                        "login": {
                            "type": "string",
                            "description": "The login page template.",
                            "default": "@Ui/Security/login.html.twig"
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}