env-manager/types.ts at master · BuildAppolis/env-manager · 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
// TypeScript types for the Environment Manager system

export interface EnvironmentVariable {
  name: string
  type: 'string' | 'url' | 'boolean' | 'number'
  sensitive: boolean
  description: string
  validation?: RegExp
  example?: string
  default?: string
  minLength?: number
  generate?: 'crypto' | 'uuid' | 'random'
}

export interface RequirementGroup {
  required: boolean
  variables: EnvironmentVariable[]
}

export interface ProjectValidation {
  requiredGroups: string[]
  customValidation?: ValidationRule[]
}

export interface ValidationRule {
  name: string
  description: string
  async: boolean
}

export interface DevServerConfig {
  blockUntilReady: boolean
  showProgress: boolean
  autoGenerate: boolean
  validateOnStart: boolean
}

export interface ProjectConfig {
  projectName: string
  projectVersion: string
  envManagerVersion: string
  requirements: Record<string, RequirementGroup>
  validation: ProjectValidation
  devServer: DevServerConfig
}

export interface VariableResult {
  name: string
  configured: boolean
  hasValue: boolean
  valid: boolean
  errors: string[]
}

export interface GroupResult {
  name: string
  required: boolean
  configured: boolean
  variables: VariableResult[]
  missing: string[]
  invalid: string[]
}

export interface ValidationResults {
  projectName: string
  isValid: boolean
  groups: Record<string, GroupResult>
  missing: string[]
  invalid: string[]
  canStart: boolean
}

export interface SetupStep {
  type: 'success' | 'error' | 'warning' | 'info'
  group?: string
  title?: string
  message?: string
  required?: boolean
  variables?: {
    name: string
    description: string
    example?: string
    type: string
    sensitive: boolean
  }[]
}

export interface SetupInstructions {
  title: string
  canStart: boolean
  steps: SetupStep[]
}

export interface ConfiguredVariable {
  name: string
  group: string
  generated: boolean
  value: string
}

export interface DatabaseVariable {
  name: string
  value: string
  category: string
  description: string
  required: boolean
  clientSide: boolean
  type: string
  sensitive: boolean
  deprecated: boolean
  addedAt?: string
  updatedAt?: string
  showValue?: boolean
}