cufflink-types 0.11.0

Shared type definitions for the Cufflink CRUD microservice platform
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

use crate::{ColumnType, TableDefinition};
use serde_json::{json, Map, Value};

/// The component names of `table`'s row schema and its create-body schema.
pub(super) fn schema_names(table: &TableDefinition) -> (String, String) {
    let schema_name = to_pascal_case(&table.name);
    let create_schema_name = format!("{}Create", schema_name);
    (schema_name, create_schema_name)
}

/// How a nullable column's schema says so.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) enum Nullable {
    /// OpenAPI 3.0's `nullable: true`, which the absolute-path spec keeps.
    Flag,
    /// JSON Schema's `type: [T, "null"]`, OpenAPI 3.1's form.
    TypeUnion,
}

impl Nullable {
    fn apply(self, mut prop: Value) -> Value {
        if let Some(obj) = prop.as_object_mut() {
            match self {
                Nullable::Flag => {
                    obj.insert("nullable".into(), json!(true));
                }
                Nullable::TypeUnion => {
                    if let Some(kind) = obj.remove("type") {
                        obj.insert("type".into(), json!([kind, "null"]));
                    }
                }
            }
        }
        prop
    }
}

/// `table`'s row and create-body component schemas.
pub(super) fn table_schemas(table: &TableDefinition, nullable: Nullable) -> [(String, Value); 2] {
    let (schema_name, create_schema_name) = schema_names(table);
    [
        (schema_name, table_to_schema(table, nullable)),
        (create_schema_name, table_to_create_schema(table, nullable)),
    ]
}

/// The `Pagination` component every list response references.
pub(super) fn pagination() -> Value {
    json!({
        "type": "object",
        "properties": {
            "current_page": { "type": "integer" },
            "per_page": { "type": "integer" },
            "total_records": { "type": "integer" },
            "total_pages": { "type": "integer" }
        }
    })
}

pub(super) fn column_to_openapi_type(col_type: &ColumnType) -> Value {
    match col_type {
        ColumnType::Uuid => json!({"type": "string", "format": "uuid"}),
        ColumnType::Text => json!({"type": "string"}),
        ColumnType::Integer => json!({"type": "integer", "format": "int32"}),
        ColumnType::BigInteger => json!({"type": "integer", "format": "int64"}),
        ColumnType::Float => json!({"type": "number", "format": "float"}),
        ColumnType::Double => json!({"type": "number", "format": "double"}),
        ColumnType::Boolean => json!({"type": "boolean"}),
        ColumnType::Timestamp => json!({"type": "string", "format": "date-time"}),
        ColumnType::Date => json!({"type": "string", "format": "date"}),
        ColumnType::Jsonb => json!({"type": "object"}),
    }
}

fn table_to_schema(table: &TableDefinition, nullable: Nullable) -> Value {
    let mut properties = Map::new();
    let mut required = Vec::new();

    for col in &table.columns {
        let prop = column_to_openapi_type(&col.column_type);
        let prop = if col.nullable {
            nullable.apply(prop)
        } else {
            prop
        };
        properties.insert(col.name.clone(), prop);
        if !col.nullable {
            required.push(json!(col.name));
        }
    }

    json!({
        "type": "object",
        "properties": Value::Object(properties),
        "required": required
    })
}

fn table_to_create_schema(table: &TableDefinition, nullable: Nullable) -> Value {
    let mut properties = Map::new();
    let mut required = Vec::new();

    for col in &table.columns {
        if col.auto_generate {
            continue;
        }
        let prop = column_to_openapi_type(&col.column_type);
        let prop = if col.nullable {
            nullable.apply(prop)
        } else {
            prop
        };
        properties.insert(col.name.clone(), prop);
        if !col.nullable && col.default_value.is_none() {
            required.push(json!(col.name));
        }
    }

    json!({
        "type": "object",
        "properties": Value::Object(properties),
        "required": required
    })
}

fn to_pascal_case(s: &str) -> String {
    s.split('_')
        .map(|word| {
            let mut chars = word.chars();
            match chars.next() {
                Some(c) => c.to_uppercase().to_string() + &chars.as_str().to_lowercase(),
                None => String::new(),
            }
        })
        .collect()
}