-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathtypes.ts
More file actions
202 lines (162 loc) Β· 3.53 KB
/
types.ts
File metadata and controls
202 lines (162 loc) Β· 3.53 KB
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
// βββ API Response Types βββ
export interface ApiSuccessResponse<T = unknown> {
ok: true;
data: T;
}
export interface ApiErrorResponse {
ok: false;
error: {
code: ErrorCode;
message: string;
};
}
export type ApiResponse<T = unknown> = ApiSuccessResponse<T> | ApiErrorResponse;
export type ErrorCode =
| "BAD_REQUEST"
| "UNAUTHORIZED"
| "FORBIDDEN"
| "NOT_FOUND"
| "CONFLICT"
| "INTERNAL_ERROR";
// βββ Key Types βββ
export type KeyType = "user" | "system";
export type Permission = "read" | "readwrite";
export interface KeyScope {
project: string;
environment: string;
}
// βββ Bootstrap βββ
export interface BootstrapRequest {
user_email?: string;
}
export interface BootstrapStatusResponse {
initialized: boolean;
}
export interface BootstrapResponse {
key: string;
prefix: string;
type: "user";
label: string;
user_email: string | null;
}
// βββ Keys βββ
export interface CreateKeyRequest {
type: KeyType;
label: string;
scopes?: KeyScope[];
permission?: Permission;
user_email?: string;
}
export interface CreateKeyResponse {
key: string;
prefix: string;
type: KeyType;
label: string;
scopes: KeyScope[] | null;
permission: string;
user_email: string | null;
}
export interface KeyInfo {
id: string;
prefix: string;
type: KeyType;
label: string;
scopes: KeyScope[] | null;
permission: string;
user_email: string | null;
created_at: string;
last_used_at: string | null;
revoked: boolean;
}
export interface ListKeysResponse {
keys: KeyInfo[];
}
export interface RevokeKeyResponse {
revoked: string;
}
export interface UpdateKeyRequest {
scopes: KeyScope[];
permission: Permission;
}
export interface UpdateKeyResponse {
prefix: string;
type: KeyType;
label: string;
scopes: KeyScope[];
permission: string;
}
// βββ Projects βββ
export interface CreateProjectRequest {
name: string;
/** When true, do not create default Dev/Prod environments. Default: false. */
environmentless?: boolean;
}
export interface ProjectInfo {
id: string;
name: string;
environment_count: number;
created_at: string;
}
export interface CreateProjectResponse {
id: string;
name: string;
created_at: string;
}
export interface ListProjectsResponse {
projects: ProjectInfo[];
}
export interface DeleteProjectResponse {
deleted: string;
environments_removed: number;
secrets_removed: number;
}
// βββ Environments βββ
export interface CreateEnvironmentRequest {
name: string;
}
export interface EnvironmentInfo {
id: string;
name: string;
secret_count: number;
created_at: string;
}
export interface CreateEnvironmentResponse {
id: string;
name: string;
project: string;
created_at: string;
}
export interface ListEnvironmentsResponse {
environments: EnvironmentInfo[];
}
// βββ Secrets βββ
export interface GetSecretsResponse {
secrets: Record<string, string>;
}
export interface SetSecretsRequest {
secrets: Record<string, string>;
}
export interface SetSecretsResponse {
count: number;
project: string;
environment: string;
}
export interface PatchSecretsRequest {
set?: Record<string, string>;
delete?: string[];
}
export interface PatchSecretsResponse {
set: number;
deleted: number;
total: number;
}
// βββ Health βββ
export interface HealthResponse {
ok: true;
version: string;
}
// βββ Auth Verify βββ
export interface AuthVerifyResponse {
key_type: "user" | "system";
key_prefix: string;
}