vika-cli 1.4.0

Generate TypeScript types, Zod schemas, and Fetch-based API clients from OpenAPI/Swagger specifications
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
use crate::config::model::Config;
use crate::error::{ConfigError, Result};
use std::path::{Path, PathBuf};

pub fn validate_config(config: &Config) -> Result<()> {
    // Validate that at least one spec is defined
    if config.specs.is_empty() {
        return Err(ConfigError::NoSpecDefined.into());
    }

    // Validate specs configuration
    // Check for duplicate names
    let mut seen_names = std::collections::HashSet::new();
    for spec in &config.specs {
        if seen_names.contains(&spec.name) {
            return Err(ConfigError::DuplicateSpecName {
                name: spec.name.clone(),
            }
            .into());
        }
        seen_names.insert(&spec.name);

        // Validate spec name
        if spec.name.is_empty() {
            return Err(ConfigError::InvalidSpecName {
                name: spec.name.clone(),
            }
            .into());
        }

        // Validate spec name format (alphanumeric, hyphens, underscores only)
        if !spec
            .name
            .chars()
            .all(|c| c.is_alphanumeric() || c == '-' || c == '_')
        {
            return Err(ConfigError::InvalidSpecName {
                name: spec.name.clone(),
            }
            .into());
        }

        // Validate spec path is not empty
        if spec.path.is_empty() {
            return Err(ConfigError::Invalid {
                message: format!("Spec '{}' has an empty path", spec.name),
            }
            .into());
        }

        // Validate per-spec schemas output path
        let schemas_output = PathBuf::from(&spec.schemas.output);
        if schemas_output.is_absolute() {
            validate_safe_path(&schemas_output)?;
        }

        // Validate per-spec apis output path
        let apis_output = PathBuf::from(&spec.apis.output);
        if apis_output.is_absolute() {
            validate_safe_path(&apis_output)?;
        }

        // Validate per-spec API style
        if spec.apis.style != "fetch" {
            return Err(ConfigError::Invalid {
                message: format!(
                    "Unsupported API style for spec '{}': {}. Only 'fetch' is supported.",
                    spec.name, spec.apis.style
                ),
            }
            .into());
        }
    }

    // Validate root_dir
    let root_dir = PathBuf::from(&config.root_dir);
    if root_dir.is_absolute() && !root_dir.exists() {
        return Err(ConfigError::Invalid {
            message: format!("Root directory does not exist: {}", config.root_dir),
        }
        .into());
    }

    Ok(())
}

fn validate_safe_path(path: &Path) -> Result<()> {
    // Prevent writing to system directories
    let path_str = path.to_string_lossy();

    if path_str.contains("/etc/")
        || path_str.contains("/usr/")
        || path_str.contains("/bin/")
        || path_str.contains("/sbin/")
        || path_str.contains("/var/")
        || path_str.contains("/opt/")
        || path_str == "/"
        || path_str == "/root"
    {
        return Err(ConfigError::InvalidOutputDirectory {
            path: path_str.to_string(),
        }
        .into());
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::model::Config;

    #[test]
    fn test_validate_config_valid() {
        let mut config = Config::default();
        config.specs = vec![crate::config::model::SpecEntry {
            name: "test".to_string(),
            path: "test.yaml".to_string(),
            schemas: crate::config::model::SchemasConfig::default(),
            apis: crate::config::model::ApisConfig::default(),
            hooks: None,
            modules: crate::config::model::ModulesConfig::default(),
        }];
        assert!(validate_config(&config).is_ok());
    }

    #[test]
    fn test_validate_config_invalid_style() {
        let apis = crate::config::model::ApisConfig {
            style: "invalid".to_string(),
            ..Default::default()
        };
        let config = Config {
            specs: vec![crate::config::model::SpecEntry {
                name: "test".to_string(),
                path: "test.yaml".to_string(),
                schemas: crate::config::model::SchemasConfig::default(),
                apis,
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            }],
            ..Default::default()
        };

        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("Unsupported API style"));
    }

    #[test]
    fn test_validate_safe_path_etc() {
        let path = PathBuf::from("/etc/test");
        let result = validate_safe_path(&path);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_safe_path_usr() {
        let path = PathBuf::from("/usr/test");
        let result = validate_safe_path(&path);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_safe_path_bin() {
        let path = PathBuf::from("/bin/test");
        let result = validate_safe_path(&path);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_safe_path_root() {
        let path = PathBuf::from("/");
        let result = validate_safe_path(&path);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_safe_path_valid() {
        let path = PathBuf::from("/home/user/project");
        let result = validate_safe_path(&path);
        assert!(result.is_ok());
    }

    #[test]
    fn test_validate_config_absolute_paths() {
        let schemas = crate::config::model::SchemasConfig {
            output: "/home/user/schemas".to_string(),
            ..Default::default()
        };
        let apis = crate::config::model::ApisConfig {
            output: "/home/user/apis".to_string(),
            ..Default::default()
        };
        let config = Config {
            specs: vec![crate::config::model::SpecEntry {
                name: "test".to_string(),
                path: "test.yaml".to_string(),
                schemas,
                apis,
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            }],
            ..Default::default()
        };

        let result = validate_config(&config);
        assert!(result.is_ok());
    }

    #[test]
    fn test_validate_config_unsafe_schemas_path() {
        let schemas = crate::config::model::SchemasConfig {
            output: "/etc/schemas".to_string(),
            ..Default::default()
        };
        let config = Config {
            specs: vec![crate::config::model::SpecEntry {
                name: "test".to_string(),
                path: "test.yaml".to_string(),
                schemas,
                apis: crate::config::model::ApisConfig::default(),
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            }],
            ..Default::default()
        };

        let result = validate_config(&config);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_config_unsafe_apis_path() {
        let apis = crate::config::model::ApisConfig {
            output: "/usr/apis".to_string(),
            ..Default::default()
        };
        let config = Config {
            specs: vec![crate::config::model::SpecEntry {
                name: "test".to_string(),
                path: "test.yaml".to_string(),
                schemas: crate::config::model::SchemasConfig::default(),
                apis,
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            }],
            ..Default::default()
        };

        let result = validate_config(&config);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_config_no_spec_defined() {
        let config = Config::default();
        // Default config has no specs, so this should fail
        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("No specs are defined"));
    }

    #[test]
    fn test_validate_config_empty_specs_array() {
        let config = Config {
            specs: vec![],
            ..Default::default()
        };

        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("No specs are defined"));
    }

    #[test]
    fn test_validate_config_duplicate_spec_names() {
        let mut config = Config::default();
        config.specs = vec![
            crate::config::model::SpecEntry {
                name: "auth".to_string(),
                path: "specs/auth.yaml".to_string(),
                schemas: crate::config::model::SchemasConfig::default(),
                apis: crate::config::model::ApisConfig::default(),
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            },
            crate::config::model::SpecEntry {
                name: "auth".to_string(),
                path: "specs/auth2.yaml".to_string(),
                schemas: crate::config::model::SchemasConfig::default(),
                apis: crate::config::model::ApisConfig::default(),
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            },
        ];

        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("Duplicate spec name"));
    }

    #[test]
    fn test_validate_config_invalid_spec_name() {
        let mut config = Config::default();
        config.specs = vec![crate::config::model::SpecEntry {
            name: "invalid name".to_string(), // contains space
            path: "specs/auth.yaml".to_string(),
            schemas: crate::config::model::SchemasConfig::default(),
            apis: crate::config::model::ApisConfig::default(),
            hooks: None,
            modules: crate::config::model::ModulesConfig::default(),
        }];

        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("Invalid spec name"));
    }

    #[test]
    fn test_validate_config_empty_spec_name() {
        let mut config = Config::default();
        config.specs = vec![crate::config::model::SpecEntry {
            name: "".to_string(),
            path: "specs/auth.yaml".to_string(),
            schemas: crate::config::model::SchemasConfig::default(),
            apis: crate::config::model::ApisConfig::default(),
            hooks: None,
            modules: crate::config::model::ModulesConfig::default(),
        }];

        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("Invalid spec name"));
    }

    #[test]
    fn test_validate_config_empty_spec_path() {
        let mut config = Config::default();
        config.specs = vec![crate::config::model::SpecEntry {
            name: "auth".to_string(),
            path: "".to_string(),
            schemas: crate::config::model::SchemasConfig::default(),
            apis: crate::config::model::ApisConfig::default(),
            hooks: None,
            modules: crate::config::model::ModulesConfig::default(),
        }];

        let result = validate_config(&config);
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.to_string().contains("empty path"));
    }

    #[test]
    fn test_validate_config_valid_multi_spec() {
        let mut config = Config::default();
        config.specs = vec![
            crate::config::model::SpecEntry {
                name: "auth".to_string(),
                path: "specs/auth.yaml".to_string(),
                schemas: crate::config::model::SchemasConfig::default(),
                apis: crate::config::model::ApisConfig::default(),
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            },
            crate::config::model::SpecEntry {
                name: "orders".to_string(),
                path: "specs/orders.json".to_string(),
                schemas: crate::config::model::SchemasConfig::default(),
                apis: crate::config::model::ApisConfig::default(),
                hooks: None,
                modules: crate::config::model::ModulesConfig::default(),
            },
        ];

        let result = validate_config(&config);
        assert!(result.is_ok());
    }

    #[test]
    fn test_validate_config_valid_single_spec() {
        let mut config = Config::default();
        config.specs = vec![crate::config::model::SpecEntry {
            name: "default".to_string(),
            path: "openapi.json".to_string(),
            schemas: crate::config::model::SchemasConfig::default(),
            apis: crate::config::model::ApisConfig::default(),
            hooks: None,
            modules: crate::config::model::ModulesConfig::default(),
        }];

        let result = validate_config(&config);
        assert!(result.is_ok());
    }
}