cronus_spec 0.7.0

The definitions for cronus API spec.
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
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
use std::{collections::{HashMap, VecDeque}, error::Error, fs, path::{Path, PathBuf}, sync::Arc};
use anyhow::{bail, Result};
use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct RawSchemaEnumItem {
    pub name: String,
    pub value: Option<i32>,
}


#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct GlobalOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub generator: Option<GeneratorOption>,

    /// Default: "usecase", other popular choices are: "service", etc..
    #[serde(skip_serializing_if = "Option::is_none")]
    pub usecase_suffix: Option<String>,

    /// Default: "request", other popular choices are: "input", "req", etc..
    #[serde(skip_serializing_if = "Option::is_none")]
    pub usecase_request_suffix: Option<String>,

    /// Default: "response", other popular choices are: "output", "res", etc..
    #[serde(skip_serializing_if = "Option::is_none")]
    pub usecase_response_suffix: Option<String>,

    /// If given type(s) is/are mentioned in the spec, do not generate
    pub skip_types: Option<Vec<String>>
}


#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct GeneratorOption {
    pub rust: Option<RustGeneratorOption>,
    pub golang: Option<GolangGeneratorOption>,
    pub golang_gin: Option<GolangGinGeneratorOption>,
    pub python: Option<PythonGeneratorOption>,
    pub python_fastapi: Option<PythonFastApiGeneratorOption>,
    pub python_redis: Option<PythonRedisGeneratorOption>,
    pub rust_axum: Option<RustAxumGeneratorOption>,
    pub openapi: Option<OpenapiGeneratorOption>,
    pub typescript: Option<TypescriptGeneratorOption>,
    pub typescript_nestjs: Option<TypescriptNestjsGeneratorOption>,
    pub java: Option<JavaGeneratorOption>,
    pub java_springweb: Option<JavaSpringWebGeneratorOption>
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct JavaGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output directory for .java files
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dir: Option<String>,

    /// Java Package Name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub package: Option<String>,

    /// Custom imports
    #[serde(skip_serializing_if = "Option::is_none")]
    pub imports: Option<Vec<String>>,

    /// Custom exception type for usecase methods
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exception_type: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_method_parameters: Option<Vec<String>>,

    /// Do not add throws clauses to usecase methods
    #[serde(skip_serializing_if = "Option::is_none")]
    pub no_exceptions: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude_types: Option<Vec<String>>,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct JavaSpringWebGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output directory for .java files
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dir: Option<String>,

    /// Java Package Name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub package: Option<String>,


    /// Java Domain Generated Package Import
    #[serde(skip_serializing_if = "Option::is_none")]
    pub domain_import: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_request_statements: Option<Vec<String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_method_parameters: Option<Vec<String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_imports: Option<Vec<String>>, 
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct GolangGinGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .go file
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file: Option<String>,

    /// Golang Package Name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub package: Option<String>,

    /// Golang Domain Generated Package Name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub domain_package: Option<String>,

    /// Golang Domain Generated Package Import
    #[serde(skip_serializing_if = "Option::is_none")]
    pub domain_import: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_request_fields: Option<Vec<String>>
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PythonRedisGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .py file
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file: Option<String>,

    #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
    pub async_flag: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub usecase_from: Option<String>,

}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct GolangGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .go file
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file: Option<String>,

    /// Golang Package Name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub package: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PythonFastApiGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .py file
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file: Option<String>,

    #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
    pub async_flag: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub get_ctx_from: Option<String>,

    /// where the python usecase types are defined (which module)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub usecase_from: Option<String>,
    
    pub extra_imports: Option<Vec<String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_method_args: Option<Vec<String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_request_fields: Option<Vec<String>>
}





#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct TypescriptNestjsGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .ts file
    pub file: Option<String>
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct TypescriptGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .ts file
    pub file: Option<String>,

}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PythonGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .py file
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file: Option<String>,

    #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
    pub async_flag: Option<bool>,


}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RustGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .rs file
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file: Option<String>,

    /// Do not place default derive for struct
    #[serde(skip_serializing_if = "Option::is_none")]
    pub no_default_derive: Option<bool>,

    /// Override the built-in default derive for struct
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_derive: Option<Vec<String>>,

    /// Custom extra uses
    #[serde(skip_serializing_if = "Option::is_none")]
    pub uses: Option<Vec<String>>,

    

    #[serde(skip_serializing_if = "Option::is_none")]
    pub no_error_type: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub error_type: Option<String>,

    #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
    pub async_flag: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub async_trait: Option<bool>,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RustAxumGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .rs file
    pub file: Option<String>
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub enum Case {
    #[serde(rename = "camel")]
    Camel,
    #[serde(rename = "snake")]
    Snake
}


#[derive(Debug, Serialize, Deserialize)]
pub struct OpenapiGeneratorOption {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    /// Output .rs file
    pub file: Option<String>,

    /// Case for the fields of request, response etc. in OpenAPI spec
    #[serde(skip_serializing_if = "Option::is_none")]
    pub field_case: Option<Case>
}


#[derive(Debug)]
pub struct DefLoc {
    pub file: PathBuf
}

impl DefLoc {
    pub fn new(file: PathBuf) -> Self {
        Self {
            file
        }
    }
}

impl Default for DefLoc {
    fn default() -> Self {
        Self {
            file: PathBuf::new()
        }
    }
}



#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct RawSchema {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub ty: Option<String>, // 'type' is a reserved keyword in Rust, hence the rename

    #[serde(skip_serializing_if = "Option::is_none")]
    pub items: Option<Box<RawSchema>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<HashMap<String, RawSchema>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub enum_items: Option<Vec<RawSchemaEnumItem>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub option: Option<RawSchemaPropertyOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extends: Option<HashMap<String, String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub flat_extends: Option<Vec<String>>,
}

impl RawSchema {
    pub fn new(def_loc: Arc<DefLoc>, ty: String) -> Self {
        Self {
            def_loc,
            ty: Some(ty),
            items: None,
            properties: None,
            required: None,
            namespace: None,
            enum_items: None,
            option: None,
            extends: None,
            flat_extends: None,
        }
    }

    pub fn new_array_ty(def_loc: Arc<DefLoc>, items_ty: String) -> Self {
        Self {
            def_loc: def_loc.clone(),
            ty: None,
            items: Some(Box::new(RawSchema::new(def_loc, items_ty))),
            properties: None,
            required: None,
            namespace: None,
            enum_items: None,
            option: None,
            extends: None,
            flat_extends: None,
        }
    }
}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rest: Option<RawSchemaPropertyRestOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub python: Option<RawSchemaPropertyPythonOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub rust: Option<RawSchemaPropertyRustOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub openapi: Option<RawSchemaPropertyOpenApiOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub python_fastapi: Option<RawSchemaPropertyPythonFastApiOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub golang_gin: Option<RawSchemaPropertyGolangGinOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub java_springweb: Option<RawSchemaPropertyJavaSpringWebOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>

}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyPythonOption {

}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyOpenApiOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude: Option<bool>
}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyGolangGinOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude: Option<bool>
}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyPythonFastApiOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude: Option<bool>
}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyJavaSpringWebOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude: Option<bool>
}



#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyRestOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub query: Option<bool>
}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(deny_unknown_fields)]
pub struct RawSchemaPropertyRustOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attrs: Option<Vec<String>>
}
#[derive(Debug, Serialize, Deserialize)]
pub struct RawUsecaseMethod {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub req: Option<RawSchema>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub res: Option<RawSchema>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub option: Option<RawUsecaseMethodOption>
}

  
#[derive(Debug, Serialize, Deserialize)]
pub  struct RawUsecase {
    #[serde(skip)]
    pub def_loc: Arc<DefLoc>,

    pub methods: HashMap<String, RawUsecaseMethod>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub option: Option<RawUsecaseOption>
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawUsecaseOption {

    #[serde(skip_serializing_if = "Option::is_none")]
    pub rest: Option<RawUsecaseRestOption>
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawUsecaseRestOption {
    /// Http endpoint prefix
    #[serde(skip_serializing_if = "Option::is_none")]
    pub path: Option<String>
}


#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawUsecaseMethodOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rest: Option<RawUsecaseMethodRestOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub redis: Option<RawUsecaseMethodRedisOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub python_fastapi: Option<RawUsecaseMethodPythonFastApiOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub golang_gin: Option<RawUsecaseMethodGolangGinOption>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

   
}



#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawUsecaseMethodRedisOption {

    #[serde(skip_serializing_if = "Option::is_none")]
    pub queue_name: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub ack_queue_name: Option<String>
}

#[derive(Debug, Serialize, Deserialize)]
pub struct RawUsecaseMethodGolangGinOption {

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_request_fields: Option<Vec<String>>
}

#[derive(Debug, Serialize, Deserialize)]
pub struct RawUsecaseMethodPythonFastApiOption {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_method_args: Option<Vec<String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra_request_fields: Option<Vec<String>>
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct RawUsecaseMethodRestOption {
    pub method: String,
    pub path: Option<String>,
    pub content_type: Option<String>, // e.g. Default is "application/json"
}

/// The schema for a spec
/// 
#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawSpec {


    #[serde(rename = "types", skip_serializing_if = "Option::is_none")]
    pub ty: Option<HashMap<String, RawSchema>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub usecases: Option<HashMap<String, RawUsecase>>,


    #[serde(skip_serializing_if = "Option::is_none")]
    pub option: Option<GlobalOption>,


    #[serde(skip_serializing_if = "Option::is_none")]
    pub imports: Option<Vec<String>>,

}


impl RawSpec {


    pub fn merge(&mut self, to_merge: RawSpec)-> Result<()> {
        if let Some(to_merge_ty) = to_merge.ty {
            let ty_map = self.ty.get_or_insert_with(HashMap::new);
            for (key, value) in to_merge_ty {
                if ty_map.contains_key(&key) {
                    bail!("Conflict for key '{}' in 'ty' hashmap", key);
                }
                ty_map.insert(key, value);
            }
        }

        // Merge 'usecase' HashMap
        if let Some(to_merge_usecase) = to_merge.usecases {
            let usecase_map = self.usecases.get_or_insert_with(HashMap::new);
            for (key, value) in to_merge_usecase {
                if usecase_map.contains_key(&key) {
                    bail!("Conflict for key '{}' in 'usecase' hashmap", key)
                }
                usecase_map.insert(key, value);
            }
        }

        // Global option has to be putted into the entry .api or .yaml file

        // Merge 'imports' Vec
        if let Some(to_merge_imports) = to_merge.imports {
            if let Some(imports) = &mut self.imports {
                for import in &to_merge_imports {
                    if imports.contains(import) {
                        continue;
                    }
                }
                imports.extend(to_merge_imports);
            } else {
                self.imports = Some(to_merge_imports);
            }
        }

        Ok(())
    }

    pub fn new() -> Self {
         Self { 
            ty: Default::default(), 
            usecases: Default::default(), 
            option: Default::default(), 
            imports: Default::default()
         }
    }
}