@vertracloud/api-types 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -40
- package/common/v1.d.ts +23 -7
- package/common/v1.js.map +1 -1
- package/package.json +5 -5
- package/payloads/v1/activity.d.ts +22 -10
- package/payloads/v1/activity.js +9 -0
- package/payloads/v1/activity.js.map +1 -1
- package/payloads/v1/activity.mjs +8 -0
- package/payloads/v1/api-error.d.ts +302 -0
- package/payloads/v1/api-error.js +216 -0
- package/payloads/v1/api-error.js.map +1 -0
- package/payloads/v1/api-error.mjs +188 -0
- package/payloads/v1/api-key.d.ts +88 -0
- package/payloads/v1/api-key.js +267 -0
- package/payloads/v1/api-key.js.map +1 -0
- package/payloads/v1/api-key.mjs +235 -0
- package/payloads/v1/application.d.ts +234 -47
- package/payloads/v1/application.js +34 -3
- package/payloads/v1/application.js.map +1 -1
- package/payloads/v1/application.mjs +28 -2
- package/payloads/v1/database-data.d.ts +329 -0
- package/payloads/v1/database-data.js +63 -0
- package/payloads/v1/database-data.js.map +1 -0
- package/payloads/v1/database-data.mjs +35 -0
- package/payloads/v1/database.d.ts +29 -31
- package/payloads/v1/database.js.map +1 -1
- package/payloads/v1/github.d.ts +20 -0
- package/{rest/v1/credits.js → payloads/v1/github.js} +4 -4
- package/payloads/v1/github.js.map +1 -0
- package/payloads/v1/github.mjs +1 -0
- package/payloads/v1/index.d.ts +12 -9
- package/payloads/v1/index.js +630 -10
- package/payloads/v1/index.js.map +1 -1
- package/payloads/v1/index.mjs +590 -9
- package/payloads/v1/notification.d.ts +2 -3
- package/payloads/v1/notification.js.map +1 -1
- package/payloads/v1/oauth.d.ts +27 -0
- package/payloads/v1/oauth.js +34 -0
- package/payloads/v1/oauth.js.map +1 -0
- package/payloads/v1/oauth.mjs +8 -0
- package/payloads/v1/orders.d.ts +52 -27
- package/payloads/v1/orders.js +30 -0
- package/payloads/v1/orders.js.map +1 -1
- package/payloads/v1/orders.mjs +21 -0
- package/payloads/v1/redeem.d.ts +1 -1
- package/payloads/v1/redeem.js.map +1 -1
- package/payloads/v1/snapshot.d.ts +37 -7
- package/payloads/v1/snapshot.js +8 -2
- package/payloads/v1/snapshot.js.map +1 -1
- package/payloads/v1/snapshot.mjs +6 -1
- package/payloads/v1/status.d.ts +2 -2
- package/payloads/v1/status.js.map +1 -1
- package/payloads/v1/user.d.ts +54 -20
- package/payloads/v1/user.js +16 -0
- package/payloads/v1/user.js.map +1 -1
- package/payloads/v1/user.mjs +9 -0
- package/payloads/v1/workspace.d.ts +296 -25
- package/payloads/v1/workspace.js +128 -8
- package/payloads/v1/workspace.js.map +1 -1
- package/payloads/v1/workspace.mjs +115 -7
- package/rest/v1/activity.d.ts +20 -9
- package/rest/v1/activity.js.map +1 -1
- package/rest/v1/api-key.d.ts +26 -0
- package/{payloads/v1/credits.js → rest/v1/api-key.js} +4 -4
- package/rest/v1/api-key.js.map +1 -0
- package/rest/v1/api-key.mjs +1 -0
- package/rest/v1/application.d.ts +302 -30
- package/rest/v1/application.js.map +1 -1
- package/rest/v1/database-data.d.ts +234 -0
- package/rest/v1/database-data.js +19 -0
- package/rest/v1/database-data.js.map +1 -0
- package/rest/v1/database-data.mjs +1 -0
- package/rest/v1/database.d.ts +55 -14
- package/rest/v1/database.js.map +1 -1
- package/rest/v1/github.d.ts +22 -0
- package/rest/v1/{wing.js → github.js} +4 -4
- package/rest/v1/github.js.map +1 -0
- package/rest/v1/github.mjs +1 -0
- package/rest/v1/index.d.ts +16 -11
- package/rest/v1/index.js.map +1 -1
- package/rest/v1/notification.d.ts +2 -3
- package/rest/v1/notification.js.map +1 -1
- package/rest/v1/oauth.d.ts +60 -0
- package/{payloads/v1/wing.js → rest/v1/oauth.js} +4 -4
- package/rest/v1/oauth.js.map +1 -0
- package/rest/v1/oauth.mjs +1 -0
- package/rest/v1/orders.d.ts +28 -7
- package/rest/v1/orders.js.map +1 -1
- package/rest/v1/redeem.d.ts +2 -1
- package/rest/v1/redeem.js.map +1 -1
- package/rest/v1/snapshot.d.ts +45 -10
- package/rest/v1/snapshot.js.map +1 -1
- package/rest/v1/status.d.ts +1 -0
- package/rest/v1/user.d.ts +56 -7
- package/rest/v1/user.js.map +1 -1
- package/rest/v1/workspace.d.ts +186 -18
- package/rest/v1/workspace.js.map +1 -1
- package/v1.d.ts +24 -19
- package/v1.js +630 -10
- package/v1.js.map +1 -1
- package/v1.mjs +590 -9
- package/payloads/v1/credits.d.ts +0 -56
- package/payloads/v1/credits.js.map +0 -1
- package/payloads/v1/credits.mjs +0 -1
- package/payloads/v1/wing.d.ts +0 -133
- package/payloads/v1/wing.js.map +0 -1
- package/payloads/v1/wing.mjs +0 -1
- package/rest/v1/credits.d.ts +0 -17
- package/rest/v1/credits.js.map +0 -1
- package/rest/v1/credits.mjs +0 -1
- package/rest/v1/wing.d.ts +0 -38
- package/rest/v1/wing.js.map +0 -1
- package/rest/v1/wing.mjs +0 -1
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// payloads/v1/api-key.ts
|
|
21
|
+
var api_key_exports = {};
|
|
22
|
+
__export(api_key_exports, {
|
|
23
|
+
APIApiKeyPreset: () => APIApiKeyPreset,
|
|
24
|
+
APIApiKeyScope: () => APIApiKeyScope,
|
|
25
|
+
API_KEY_MAX_ALLOWED_IPS: () => API_KEY_MAX_ALLOWED_IPS,
|
|
26
|
+
API_KEY_MAX_PER_USER: () => API_KEY_MAX_PER_USER,
|
|
27
|
+
API_KEY_NAME_MAX_LENGTH: () => API_KEY_NAME_MAX_LENGTH,
|
|
28
|
+
API_KEY_SCOPES: () => API_KEY_SCOPES,
|
|
29
|
+
API_KEY_SCOPE_LIST: () => API_KEY_SCOPE_LIST,
|
|
30
|
+
apiKeyPresetScopes: () => apiKeyPresetScopes
|
|
31
|
+
});
|
|
32
|
+
module.exports = __toCommonJS(api_key_exports);
|
|
33
|
+
var APIApiKeyScope = {
|
|
34
|
+
APPS_READ: "apps:read",
|
|
35
|
+
APPS_WRITE: "apps:write",
|
|
36
|
+
APPS_DELETE: "apps:delete",
|
|
37
|
+
APPS_ENVS: "apps:envs",
|
|
38
|
+
APPS_FILES: "apps:files",
|
|
39
|
+
DATABASES_READ: "databases:read",
|
|
40
|
+
DATABASES_WRITE: "databases:write",
|
|
41
|
+
DATABASES_DELETE: "databases:delete",
|
|
42
|
+
DATABASES_CREDENTIALS: "databases:credentials",
|
|
43
|
+
SNAPSHOTS_READ: "snapshots:read",
|
|
44
|
+
SNAPSHOTS_WRITE: "snapshots:write",
|
|
45
|
+
ACCOUNT_READ: "account:read",
|
|
46
|
+
ACCOUNT_WRITE: "account:write",
|
|
47
|
+
WORKSPACES_READ: "workspaces:read",
|
|
48
|
+
WORKSPACES_WRITE: "workspaces:write",
|
|
49
|
+
WORKSPACES_DELETE: "workspaces:delete",
|
|
50
|
+
WORKSPACES_INVITES: "workspaces:invites",
|
|
51
|
+
BILLING_READ: "billing:read",
|
|
52
|
+
BILLING_WRITE: "billing:write",
|
|
53
|
+
REDEEM_WRITE: "redeem:write"
|
|
54
|
+
};
|
|
55
|
+
var APIApiKeyPreset = { Read: "read", Write: "write", Full: "full" };
|
|
56
|
+
var API_KEY_SCOPES = {
|
|
57
|
+
"apps:read": {
|
|
58
|
+
group: "apps",
|
|
59
|
+
routes: [
|
|
60
|
+
{ method: "GET", path: "/v1/apps/runtimes" },
|
|
61
|
+
{ method: "GET", path: "/v1/apps/status" },
|
|
62
|
+
{ method: "GET", path: "/v1/apps/:id" },
|
|
63
|
+
{ method: "GET", path: "/v1/apps/:id/status" },
|
|
64
|
+
{ method: "GET", path: "/v1/apps/:id/realtime" },
|
|
65
|
+
{ method: "GET", path: "/v1/apps/:id/metrics" },
|
|
66
|
+
{ method: "GET", path: "/v1/apps/:id/logs" },
|
|
67
|
+
{ method: "GET", path: "/v1/apps/:id/download" },
|
|
68
|
+
{ method: "GET", path: "/v1/apps/:id/deploys" },
|
|
69
|
+
{ method: "GET", path: "/v1/apps/:id/deploys/webhook" },
|
|
70
|
+
{ method: "GET", path: "/v1/apps/:id/network/custom" },
|
|
71
|
+
{ method: "GET", path: "/v1/apps/:id/network/dns" }
|
|
72
|
+
]
|
|
73
|
+
},
|
|
74
|
+
"apps:write": {
|
|
75
|
+
group: "apps",
|
|
76
|
+
routes: [
|
|
77
|
+
{ method: "POST", path: "/v1/apps" },
|
|
78
|
+
{ method: "POST", path: "/v1/apps/:id/start" },
|
|
79
|
+
{ method: "POST", path: "/v1/apps/:id/stop" },
|
|
80
|
+
{ method: "POST", path: "/v1/apps/:id/restart" },
|
|
81
|
+
{ method: "PATCH", path: "/v1/apps/:id/config" },
|
|
82
|
+
{ method: "POST", path: "/v1/apps/:id/deploys/webhook" },
|
|
83
|
+
{ method: "DELETE", path: "/v1/apps/:id/deploys/webhook" },
|
|
84
|
+
{ method: "POST", path: "/v1/apps/:id/network/custom" },
|
|
85
|
+
{ method: "DELETE", path: "/v1/apps/:id/network/custom" },
|
|
86
|
+
{ method: "POST", path: "/v1/apps/:id/network/purge-cache" },
|
|
87
|
+
{ method: "PATCH", path: "/v1/apps/:id/network/subdomain" },
|
|
88
|
+
{ method: "POST", path: "/v1/apps/:id/network/publish" },
|
|
89
|
+
{ method: "DELETE", path: "/v1/apps/:id/network/publish" }
|
|
90
|
+
]
|
|
91
|
+
},
|
|
92
|
+
"apps:delete": { group: "apps", routes: [{ method: "DELETE", path: "/v1/apps/:id" }] },
|
|
93
|
+
"apps:envs": {
|
|
94
|
+
group: "apps",
|
|
95
|
+
routes: [
|
|
96
|
+
{ method: "GET", path: "/v1/apps/:id/envs" },
|
|
97
|
+
{ method: "POST", path: "/v1/apps/:id/envs" },
|
|
98
|
+
{ method: "DELETE", path: "/v1/apps/:id/envs/:envId" }
|
|
99
|
+
]
|
|
100
|
+
},
|
|
101
|
+
"apps:files": {
|
|
102
|
+
group: "apps",
|
|
103
|
+
routes: [
|
|
104
|
+
{ method: "GET", path: "/v1/apps/:id/files" },
|
|
105
|
+
{ method: "GET", path: "/v1/apps/:id/files/tree" },
|
|
106
|
+
{ method: "GET", path: "/v1/apps/:id/files/content" },
|
|
107
|
+
{ method: "PUT", path: "/v1/apps/:id/files" },
|
|
108
|
+
{ method: "PATCH", path: "/v1/apps/:id/files" },
|
|
109
|
+
{ method: "DELETE", path: "/v1/apps/:id/files" },
|
|
110
|
+
{ method: "POST", path: "/v1/apps/:id/files/upload" }
|
|
111
|
+
]
|
|
112
|
+
},
|
|
113
|
+
"databases:read": {
|
|
114
|
+
group: "databases",
|
|
115
|
+
routes: [
|
|
116
|
+
{ method: "GET", path: "/v1/databases/status" },
|
|
117
|
+
{ method: "GET", path: "/v1/databases/:id" },
|
|
118
|
+
{ method: "GET", path: "/v1/databases/:id/status" },
|
|
119
|
+
{ method: "GET", path: "/v1/databases/:id/metrics" }
|
|
120
|
+
]
|
|
121
|
+
},
|
|
122
|
+
"databases:write": {
|
|
123
|
+
group: "databases",
|
|
124
|
+
routes: [
|
|
125
|
+
{ method: "POST", path: "/v1/databases" },
|
|
126
|
+
{ method: "PUT", path: "/v1/databases/:id" },
|
|
127
|
+
{ method: "POST", path: "/v1/databases/:id/start" },
|
|
128
|
+
{ method: "POST", path: "/v1/databases/:id/stop" },
|
|
129
|
+
{ method: "POST", path: "/v1/databases/:id/reset" }
|
|
130
|
+
]
|
|
131
|
+
},
|
|
132
|
+
"databases:delete": { group: "databases", routes: [{ method: "DELETE", path: "/v1/databases/:id" }] },
|
|
133
|
+
"databases:credentials": {
|
|
134
|
+
group: "databases",
|
|
135
|
+
routes: [
|
|
136
|
+
{ method: "GET", path: "/v1/databases/:id/credentials/certificate" },
|
|
137
|
+
{ method: "POST", path: "/v1/databases/:id/credentials/certificate/reset" },
|
|
138
|
+
{ method: "POST", path: "/v1/databases/:id/credentials/reset" }
|
|
139
|
+
]
|
|
140
|
+
},
|
|
141
|
+
"snapshots:read": {
|
|
142
|
+
group: "snapshots",
|
|
143
|
+
routes: [
|
|
144
|
+
{ method: "GET", path: "/v1/users/snapshots" },
|
|
145
|
+
{ method: "GET", path: "/v1/users/:id/snapshots" },
|
|
146
|
+
{ method: "GET", path: "/v1/users/:id/snapshots/:snapshot_id/download" }
|
|
147
|
+
]
|
|
148
|
+
},
|
|
149
|
+
"snapshots:write": {
|
|
150
|
+
group: "snapshots",
|
|
151
|
+
routes: [
|
|
152
|
+
{ method: "POST", path: "/v1/users/:id/snapshots" },
|
|
153
|
+
{ method: "POST", path: "/v1/users/:id/snapshots/:snapshot_id/restore" }
|
|
154
|
+
]
|
|
155
|
+
},
|
|
156
|
+
"account:read": {
|
|
157
|
+
group: "account",
|
|
158
|
+
routes: [
|
|
159
|
+
{ method: "GET", path: "/v1/users/me" },
|
|
160
|
+
{ method: "GET", path: "/v1/users/me/sessions" }
|
|
161
|
+
]
|
|
162
|
+
},
|
|
163
|
+
"account:write": {
|
|
164
|
+
group: "account",
|
|
165
|
+
routes: [
|
|
166
|
+
{ method: "PATCH", path: "/v1/users/me" },
|
|
167
|
+
{ method: "POST", path: "/v1/users/me/folders" },
|
|
168
|
+
{ method: "PATCH", path: "/v1/users/me/folders/:folder_id" },
|
|
169
|
+
{ method: "DELETE", path: "/v1/users/me/folders/:folder_id" },
|
|
170
|
+
{ method: "PUT", path: "/v1/users/me/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
171
|
+
{ method: "DELETE", path: "/v1/users/me/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
172
|
+
{ method: "PUT", path: "/v1/users/me/favorites/:resource_type/:resource_id" },
|
|
173
|
+
{ method: "DELETE", path: "/v1/users/me/favorites/:resource_type/:resource_id" }
|
|
174
|
+
]
|
|
175
|
+
},
|
|
176
|
+
"workspaces:read": {
|
|
177
|
+
group: "workspaces",
|
|
178
|
+
routes: [
|
|
179
|
+
{ method: "GET", path: "/v1/workspaces" },
|
|
180
|
+
{ method: "GET", path: "/v1/workspaces/:id" },
|
|
181
|
+
{ method: "GET", path: "/v1/workspaces/:id/members" },
|
|
182
|
+
{ method: "GET", path: "/v1/workspaces/:id/roles" },
|
|
183
|
+
{ method: "GET", path: "/v1/workspaces/:id/action-requests" }
|
|
184
|
+
]
|
|
185
|
+
},
|
|
186
|
+
"workspaces:write": {
|
|
187
|
+
group: "workspaces",
|
|
188
|
+
routes: [
|
|
189
|
+
{ method: "POST", path: "/v1/workspaces" },
|
|
190
|
+
{ method: "PUT", path: "/v1/workspaces/:id" },
|
|
191
|
+
{ method: "PUT", path: "/v1/workspaces/:id/members/:user_id" },
|
|
192
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/members/:user_id" },
|
|
193
|
+
{ method: "POST", path: "/v1/workspaces/:id/roles" },
|
|
194
|
+
{ method: "PUT", path: "/v1/workspaces/:id/roles/:role_id" },
|
|
195
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/roles/:role_id" },
|
|
196
|
+
{ method: "POST", path: "/v1/workspaces/:id/apps/:app_id" },
|
|
197
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/apps/:app_id" },
|
|
198
|
+
{ method: "POST", path: "/v1/workspaces/:id/databases/:db_id" },
|
|
199
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/databases/:db_id" },
|
|
200
|
+
{ method: "POST", path: "/v1/workspaces/:id/folders" },
|
|
201
|
+
{ method: "PATCH", path: "/v1/workspaces/:id/folders/:folder_id" },
|
|
202
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/folders/:folder_id" },
|
|
203
|
+
{ method: "PUT", path: "/v1/workspaces/:id/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
204
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
205
|
+
{ method: "PUT", path: "/v1/workspaces/:id/favorites/:resource_type/:resource_id" },
|
|
206
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/favorites/:resource_type/:resource_id" },
|
|
207
|
+
{ method: "POST", path: "/v1/workspaces/:id/action-requests" }
|
|
208
|
+
]
|
|
209
|
+
},
|
|
210
|
+
/**
|
|
211
|
+
* Intentionally left out (dashboard session only): creating invites (a leaked key could grant
|
|
212
|
+
* access that outlives its revocation), transferring ownership, approving/rejecting action
|
|
213
|
+
* requests (approval is a human decision) and exporting activities.
|
|
214
|
+
*/
|
|
215
|
+
/** Delete a workspace (soft delete). Only in the `full` preset, like `apps:delete`. */
|
|
216
|
+
"workspaces:delete": {
|
|
217
|
+
group: "workspaces",
|
|
218
|
+
routes: [{ method: "DELETE", path: "/v1/workspaces/:id" }]
|
|
219
|
+
},
|
|
220
|
+
/** List and revoke workspace invites; view, accept and decline your own invite by token. Only in the `full` preset. */
|
|
221
|
+
"workspaces:invites": {
|
|
222
|
+
group: "workspaces",
|
|
223
|
+
routes: [
|
|
224
|
+
{ method: "GET", path: "/v1/workspaces/:id/invites" },
|
|
225
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/invites/:invite_id" },
|
|
226
|
+
{ method: "GET", path: "/v1/workspaces/invites/:token" },
|
|
227
|
+
{ method: "POST", path: "/v1/workspaces/invites/:token/accept" },
|
|
228
|
+
{ method: "POST", path: "/v1/workspaces/invites/:token/decline" }
|
|
229
|
+
]
|
|
230
|
+
},
|
|
231
|
+
"billing:read": {
|
|
232
|
+
group: "billing",
|
|
233
|
+
routes: [
|
|
234
|
+
{ method: "GET", path: "/v1/orders" },
|
|
235
|
+
{ method: "GET", path: "/v1/orders/:orderId/status" }
|
|
236
|
+
]
|
|
237
|
+
},
|
|
238
|
+
/** Creates a plan order and generates the PIX charge; the payment itself is made by a person in their banking app. */
|
|
239
|
+
"billing:write": {
|
|
240
|
+
group: "billing",
|
|
241
|
+
routes: [
|
|
242
|
+
{ method: "POST", path: "/v1/orders" },
|
|
243
|
+
{ method: "POST", path: "/v1/orders/:orderId/initiate/pix" }
|
|
244
|
+
]
|
|
245
|
+
},
|
|
246
|
+
"redeem:write": { group: "billing", routes: [{ method: "POST", path: "/v1/redeem/:code" }] }
|
|
247
|
+
};
|
|
248
|
+
var API_KEY_SCOPE_LIST = Object.keys(API_KEY_SCOPES);
|
|
249
|
+
function apiKeyPresetScopes(preset) {
|
|
250
|
+
if (preset === "full") return API_KEY_SCOPE_LIST;
|
|
251
|
+
return API_KEY_SCOPE_LIST.filter((s) => s.endsWith(":read") || preset === "write" && s.endsWith(":write"));
|
|
252
|
+
}
|
|
253
|
+
var API_KEY_MAX_PER_USER = 10;
|
|
254
|
+
var API_KEY_MAX_ALLOWED_IPS = 20;
|
|
255
|
+
var API_KEY_NAME_MAX_LENGTH = 40;
|
|
256
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
257
|
+
0 && (module.exports = {
|
|
258
|
+
APIApiKeyPreset,
|
|
259
|
+
APIApiKeyScope,
|
|
260
|
+
API_KEY_MAX_ALLOWED_IPS,
|
|
261
|
+
API_KEY_MAX_PER_USER,
|
|
262
|
+
API_KEY_NAME_MAX_LENGTH,
|
|
263
|
+
API_KEY_SCOPES,
|
|
264
|
+
API_KEY_SCOPE_LIST,
|
|
265
|
+
apiKeyPresetScopes
|
|
266
|
+
});
|
|
267
|
+
//# sourceMappingURL=api-key.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["api-key.ts"],"sourcesContent":["import type { ISODateString } from \"../../common/v1\";\n\n/**\n * API key scope, in the form `<resource>:<action>`. Presets: `read` = every `*:read`;\n * `write` = `read` + every `*:write`; `full` = all of them, including the ones without a\n * `read`/`write` suffix (delete, envs, files, credentials).\n * @see https://docs.vertracloud.app/api-reference/introduction#scopes\n */\nexport type APIApiKeyScope =\n\t| \"apps:read\"\n\t| \"apps:write\"\n\t| \"apps:delete\"\n\t| \"apps:envs\"\n\t| \"apps:files\"\n\t| \"databases:read\"\n\t| \"databases:write\"\n\t| \"databases:delete\"\n\t| \"databases:credentials\"\n\t| \"snapshots:read\"\n\t| \"snapshots:write\"\n\t| \"account:read\"\n\t| \"account:write\"\n\t| \"workspaces:read\"\n\t| \"workspaces:write\"\n\t| \"workspaces:delete\"\n\t| \"workspaces:invites\"\n\t| \"billing:read\"\n\t| \"billing:write\"\n\t| \"redeem:write\";\n\nexport const APIApiKeyScope = {\n\tAPPS_READ: \"apps:read\",\n\tAPPS_WRITE: \"apps:write\",\n\tAPPS_DELETE: \"apps:delete\",\n\tAPPS_ENVS: \"apps:envs\",\n\tAPPS_FILES: \"apps:files\",\n\tDATABASES_READ: \"databases:read\",\n\tDATABASES_WRITE: \"databases:write\",\n\tDATABASES_DELETE: \"databases:delete\",\n\tDATABASES_CREDENTIALS: \"databases:credentials\",\n\tSNAPSHOTS_READ: \"snapshots:read\",\n\tSNAPSHOTS_WRITE: \"snapshots:write\",\n\tACCOUNT_READ: \"account:read\",\n\tACCOUNT_WRITE: \"account:write\",\n\tWORKSPACES_READ: \"workspaces:read\",\n\tWORKSPACES_WRITE: \"workspaces:write\",\n\tWORKSPACES_DELETE: \"workspaces:delete\",\n\tWORKSPACES_INVITES: \"workspaces:invites\",\n\tBILLING_READ: \"billing:read\",\n\tBILLING_WRITE: \"billing:write\",\n\tREDEEM_WRITE: \"redeem:write\",\n} as const satisfies Record<string, APIApiKeyScope>;\n\nexport type APIApiKeyPreset = \"read\" | \"write\" | \"full\";\nexport const APIApiKeyPreset = { Read: \"read\", Write: \"write\", Full: \"full\" } as const;\n\nexport type APIApiKeyRouteMethod = \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\";\n\nexport interface APIApiKeyRoute {\n\tmethod: APIApiKeyRouteMethod;\n\t/** Full route pattern with `:param` placeholders (`/v1/apps/:id/files`). Matched exactly, no regex. */\n\tpath: string;\n}\n\nexport interface APIApiKeyScopeEntry {\n\t/** Display group the scope belongs to. */\n\tgroup: \"apps\" | \"databases\" | \"snapshots\" | \"account\" | \"workspaces\" | \"billing\";\n\troutes: APIApiKeyRoute[];\n}\n\n/**\n * Closed catalog of the routes an API key can reach, per scope. A key without the route's scope\n * gets 403 `API_KEY_SCOPE_DENIED`; a route that is not listed here always returns 403 to an API key.\n *\n * Intentionally left out (dashboard session only): key management, creating workspace invites\n * (an invite would outlive the key's revocation), revoking sessions, plan downgrade, and the\n * database **Data** tab (`/v1/databases/:id/data/*`).\n */\nexport const API_KEY_SCOPES: Record<APIApiKeyScope, APIApiKeyScopeEntry> = {\n\t\"apps:read\": {\n\t\tgroup: \"apps\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/apps/runtimes\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/status\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/status\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/realtime\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/metrics\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/logs\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/download\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/deploys\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/deploys/webhook\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/network/custom\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/network/dns\" },\n\t\t],\n\t},\n\t\"apps:write\": {\n\t\tgroup: \"apps\",\n\t\troutes: [\n\t\t\t{ method: \"POST\", path: \"/v1/apps\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/start\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/stop\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/restart\" },\n\t\t\t{ method: \"PATCH\", path: \"/v1/apps/:id/config\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/deploys/webhook\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/apps/:id/deploys/webhook\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/network/custom\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/apps/:id/network/custom\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/network/purge-cache\" },\n\t\t\t{ method: \"PATCH\", path: \"/v1/apps/:id/network/subdomain\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/network/publish\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/apps/:id/network/publish\" },\n\t\t],\n\t},\n\t\"apps:delete\": { group: \"apps\", routes: [{ method: \"DELETE\", path: \"/v1/apps/:id\" }] },\n\t\"apps:envs\": {\n\t\tgroup: \"apps\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/envs\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/envs\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/apps/:id/envs/:envId\" },\n\t\t],\n\t},\n\t\"apps:files\": {\n\t\tgroup: \"apps\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/files\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/files/tree\" },\n\t\t\t{ method: \"GET\", path: \"/v1/apps/:id/files/content\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/apps/:id/files\" },\n\t\t\t{ method: \"PATCH\", path: \"/v1/apps/:id/files\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/apps/:id/files\" },\n\t\t\t{ method: \"POST\", path: \"/v1/apps/:id/files/upload\" },\n\t\t],\n\t},\n\t\"databases:read\": {\n\t\tgroup: \"databases\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/databases/status\" },\n\t\t\t{ method: \"GET\", path: \"/v1/databases/:id\" },\n\t\t\t{ method: \"GET\", path: \"/v1/databases/:id/status\" },\n\t\t\t{ method: \"GET\", path: \"/v1/databases/:id/metrics\" },\n\t\t],\n\t},\n\t\"databases:write\": {\n\t\tgroup: \"databases\",\n\t\troutes: [\n\t\t\t{ method: \"POST\", path: \"/v1/databases\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/databases/:id\" },\n\t\t\t{ method: \"POST\", path: \"/v1/databases/:id/start\" },\n\t\t\t{ method: \"POST\", path: \"/v1/databases/:id/stop\" },\n\t\t\t{ method: \"POST\", path: \"/v1/databases/:id/reset\" },\n\t\t],\n\t},\n\t\"databases:delete\": { group: \"databases\", routes: [{ method: \"DELETE\", path: \"/v1/databases/:id\" }] },\n\t\"databases:credentials\": {\n\t\tgroup: \"databases\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/databases/:id/credentials/certificate\" },\n\t\t\t{ method: \"POST\", path: \"/v1/databases/:id/credentials/certificate/reset\" },\n\t\t\t{ method: \"POST\", path: \"/v1/databases/:id/credentials/reset\" },\n\t\t],\n\t},\n\t\"snapshots:read\": {\n\t\tgroup: \"snapshots\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/users/snapshots\" },\n\t\t\t{ method: \"GET\", path: \"/v1/users/:id/snapshots\" },\n\t\t\t{ method: \"GET\", path: \"/v1/users/:id/snapshots/:snapshot_id/download\" },\n\t\t],\n\t},\n\t\"snapshots:write\": {\n\t\tgroup: \"snapshots\",\n\t\troutes: [\n\t\t\t{ method: \"POST\", path: \"/v1/users/:id/snapshots\" },\n\t\t\t{ method: \"POST\", path: \"/v1/users/:id/snapshots/:snapshot_id/restore\" },\n\t\t],\n\t},\n\t\"account:read\": {\n\t\tgroup: \"account\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/users/me\" },\n\t\t\t{ method: \"GET\", path: \"/v1/users/me/sessions\" },\n\t\t],\n\t},\n\t\"account:write\": {\n\t\tgroup: \"account\",\n\t\troutes: [\n\t\t\t{ method: \"PATCH\", path: \"/v1/users/me\" },\n\t\t\t{ method: \"POST\", path: \"/v1/users/me/folders\" },\n\t\t\t{ method: \"PATCH\", path: \"/v1/users/me/folders/:folder_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/users/me/folders/:folder_id\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/users/me/folders/:folder_id/resources/:resource_type/:resource_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/users/me/folders/:folder_id/resources/:resource_type/:resource_id\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/users/me/favorites/:resource_type/:resource_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/users/me/favorites/:resource_type/:resource_id\" },\n\t\t],\n\t},\n\t\"workspaces:read\": {\n\t\tgroup: \"workspaces\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces\" },\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces/:id\" },\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces/:id/members\" },\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces/:id/roles\" },\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces/:id/action-requests\" },\n\t\t],\n\t},\n\t\"workspaces:write\": {\n\t\tgroup: \"workspaces\",\n\t\troutes: [\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/workspaces/:id\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/workspaces/:id/members/:user_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/members/:user_id\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/:id/roles\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/workspaces/:id/roles/:role_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/roles/:role_id\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/:id/apps/:app_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/apps/:app_id\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/:id/databases/:db_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/databases/:db_id\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/:id/folders\" },\n\t\t\t{ method: \"PATCH\", path: \"/v1/workspaces/:id/folders/:folder_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/folders/:folder_id\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/workspaces/:id/folders/:folder_id/resources/:resource_type/:resource_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/folders/:folder_id/resources/:resource_type/:resource_id\" },\n\t\t\t{ method: \"PUT\", path: \"/v1/workspaces/:id/favorites/:resource_type/:resource_id\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/favorites/:resource_type/:resource_id\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/:id/action-requests\" },\n\t\t],\n\t},\n\t/**\n\t * Intentionally left out (dashboard session only): creating invites (a leaked key could grant\n\t * access that outlives its revocation), transferring ownership, approving/rejecting action\n\t * requests (approval is a human decision) and exporting activities.\n\t */\n\t/** Delete a workspace (soft delete). Only in the `full` preset, like `apps:delete`. */\n\t\"workspaces:delete\": {\n\t\tgroup: \"workspaces\",\n\t\troutes: [{ method: \"DELETE\", path: \"/v1/workspaces/:id\" }],\n\t},\n\t/** List and revoke workspace invites; view, accept and decline your own invite by token. Only in the `full` preset. */\n\t\"workspaces:invites\": {\n\t\tgroup: \"workspaces\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces/:id/invites\" },\n\t\t\t{ method: \"DELETE\", path: \"/v1/workspaces/:id/invites/:invite_id\" },\n\t\t\t{ method: \"GET\", path: \"/v1/workspaces/invites/:token\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/invites/:token/accept\" },\n\t\t\t{ method: \"POST\", path: \"/v1/workspaces/invites/:token/decline\" },\n\t\t],\n\t},\n\t\"billing:read\": {\n\t\tgroup: \"billing\",\n\t\troutes: [\n\t\t\t{ method: \"GET\", path: \"/v1/orders\" },\n\t\t\t{ method: \"GET\", path: \"/v1/orders/:orderId/status\" },\n\t\t],\n\t},\n\t/** Creates a plan order and generates the PIX charge; the payment itself is made by a person in their banking app. */\n\t\"billing:write\": {\n\t\tgroup: \"billing\",\n\t\troutes: [\n\t\t\t{ method: \"POST\", path: \"/v1/orders\" },\n\t\t\t{ method: \"POST\", path: \"/v1/orders/:orderId/initiate/pix\" },\n\t\t],\n\t},\n\t\"redeem:write\": { group: \"billing\", routes: [{ method: \"POST\", path: \"/v1/redeem/:code\" }] },\n};\n\nexport const API_KEY_SCOPE_LIST = Object.keys(API_KEY_SCOPES) as APIApiKeyScope[];\n\n/** Scopes selected by a preset. `full` is the whole catalog. */\nexport function apiKeyPresetScopes(preset: APIApiKeyPreset): APIApiKeyScope[] {\n\tif (preset === \"full\") return API_KEY_SCOPE_LIST;\n\treturn API_KEY_SCOPE_LIST.filter((s) => s.endsWith(\":read\") || (preset === \"write\" && s.endsWith(\":write\")));\n}\n\n/** Maximum keys per account, entries in `allowed_ips`, and key name length. */\nexport const API_KEY_MAX_PER_USER = 10;\nexport const API_KEY_MAX_ALLOWED_IPS = 20;\nexport const API_KEY_NAME_MAX_LENGTH = 40;\n\n/**\n * An API key as listed. The secret is returned only ONCE, in `APIApiKeyCreated`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/users/api-keys/list\n */\nexport interface APIApiKey {\n\tid: string;\n\tname: string;\n\t/** Public start of the key (`vc_live_a1b2c3d4`; older keys: 8 hex characters). */\n\tprefix: string;\n\t/** Last 4 characters; `null` for keys generated before the `vc_live_` format. */\n\tlast4: string | null;\n\tscopes: APIApiKeyScope[];\n\t/** Allowed IPs/CIDRs. Empty list = any IP. */\n\tallowed_ips: string[];\n\tcreated_at: ISODateString;\n\tlast_used_at: ISODateString | null;\n}\n\nexport interface APIApiKeyCreated extends APIApiKey {\n\t/** The full secret. Shown once; it cannot be recovered. */\n\tapi_key: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA8BO,IAAM,iBAAiB;AAAA,EAC7B,WAAW;AAAA,EACX,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,WAAW;AAAA,EACX,YAAY;AAAA,EACZ,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,kBAAkB;AAAA,EAClB,uBAAuB;AAAA,EACvB,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,cAAc;AAAA,EACd,eAAe;AAAA,EACf,iBAAiB;AAAA,EACjB,kBAAkB;AAAA,EAClB,mBAAmB;AAAA,EACnB,oBAAoB;AAAA,EACpB,cAAc;AAAA,EACd,eAAe;AAAA,EACf,cAAc;AACf;AAGO,IAAM,kBAAkB,EAAE,MAAM,QAAQ,OAAO,SAAS,MAAM,OAAO;AAwBrE,IAAM,iBAA8D;AAAA,EAC1E,aAAa;AAAA,IACZ,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,oBAAoB;AAAA,MAC3C,EAAE,QAAQ,OAAO,MAAM,kBAAkB;AAAA,MACzC,EAAE,QAAQ,OAAO,MAAM,eAAe;AAAA,MACtC,EAAE,QAAQ,OAAO,MAAM,sBAAsB;AAAA,MAC7C,EAAE,QAAQ,OAAO,MAAM,wBAAwB;AAAA,MAC/C,EAAE,QAAQ,OAAO,MAAM,uBAAuB;AAAA,MAC9C,EAAE,QAAQ,OAAO,MAAM,oBAAoB;AAAA,MAC3C,EAAE,QAAQ,OAAO,MAAM,wBAAwB;AAAA,MAC/C,EAAE,QAAQ,OAAO,MAAM,uBAAuB;AAAA,MAC9C,EAAE,QAAQ,OAAO,MAAM,+BAA+B;AAAA,MACtD,EAAE,QAAQ,OAAO,MAAM,8BAA8B;AAAA,MACrD,EAAE,QAAQ,OAAO,MAAM,2BAA2B;AAAA,IACnD;AAAA,EACD;AAAA,EACA,cAAc;AAAA,IACb,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,QAAQ,MAAM,WAAW;AAAA,MACnC,EAAE,QAAQ,QAAQ,MAAM,qBAAqB;AAAA,MAC7C,EAAE,QAAQ,QAAQ,MAAM,oBAAoB;AAAA,MAC5C,EAAE,QAAQ,QAAQ,MAAM,uBAAuB;AAAA,MAC/C,EAAE,QAAQ,SAAS,MAAM,sBAAsB;AAAA,MAC/C,EAAE,QAAQ,QAAQ,MAAM,+BAA+B;AAAA,MACvD,EAAE,QAAQ,UAAU,MAAM,+BAA+B;AAAA,MACzD,EAAE,QAAQ,QAAQ,MAAM,8BAA8B;AAAA,MACtD,EAAE,QAAQ,UAAU,MAAM,8BAA8B;AAAA,MACxD,EAAE,QAAQ,QAAQ,MAAM,mCAAmC;AAAA,MAC3D,EAAE,QAAQ,SAAS,MAAM,iCAAiC;AAAA,MAC1D,EAAE,QAAQ,QAAQ,MAAM,+BAA+B;AAAA,MACvD,EAAE,QAAQ,UAAU,MAAM,+BAA+B;AAAA,IAC1D;AAAA,EACD;AAAA,EACA,eAAe,EAAE,OAAO,QAAQ,QAAQ,CAAC,EAAE,QAAQ,UAAU,MAAM,eAAe,CAAC,EAAE;AAAA,EACrF,aAAa;AAAA,IACZ,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,oBAAoB;AAAA,MAC3C,EAAE,QAAQ,QAAQ,MAAM,oBAAoB;AAAA,MAC5C,EAAE,QAAQ,UAAU,MAAM,2BAA2B;AAAA,IACtD;AAAA,EACD;AAAA,EACA,cAAc;AAAA,IACb,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,qBAAqB;AAAA,MAC5C,EAAE,QAAQ,OAAO,MAAM,0BAA0B;AAAA,MACjD,EAAE,QAAQ,OAAO,MAAM,6BAA6B;AAAA,MACpD,EAAE,QAAQ,OAAO,MAAM,qBAAqB;AAAA,MAC5C,EAAE,QAAQ,SAAS,MAAM,qBAAqB;AAAA,MAC9C,EAAE,QAAQ,UAAU,MAAM,qBAAqB;AAAA,MAC/C,EAAE,QAAQ,QAAQ,MAAM,4BAA4B;AAAA,IACrD;AAAA,EACD;AAAA,EACA,kBAAkB;AAAA,IACjB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,uBAAuB;AAAA,MAC9C,EAAE,QAAQ,OAAO,MAAM,oBAAoB;AAAA,MAC3C,EAAE,QAAQ,OAAO,MAAM,2BAA2B;AAAA,MAClD,EAAE,QAAQ,OAAO,MAAM,4BAA4B;AAAA,IACpD;AAAA,EACD;AAAA,EACA,mBAAmB;AAAA,IAClB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,QAAQ,MAAM,gBAAgB;AAAA,MACxC,EAAE,QAAQ,OAAO,MAAM,oBAAoB;AAAA,MAC3C,EAAE,QAAQ,QAAQ,MAAM,0BAA0B;AAAA,MAClD,EAAE,QAAQ,QAAQ,MAAM,yBAAyB;AAAA,MACjD,EAAE,QAAQ,QAAQ,MAAM,0BAA0B;AAAA,IACnD;AAAA,EACD;AAAA,EACA,oBAAoB,EAAE,OAAO,aAAa,QAAQ,CAAC,EAAE,QAAQ,UAAU,MAAM,oBAAoB,CAAC,EAAE;AAAA,EACpG,yBAAyB;AAAA,IACxB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,4CAA4C;AAAA,MACnE,EAAE,QAAQ,QAAQ,MAAM,kDAAkD;AAAA,MAC1E,EAAE,QAAQ,QAAQ,MAAM,sCAAsC;AAAA,IAC/D;AAAA,EACD;AAAA,EACA,kBAAkB;AAAA,IACjB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,sBAAsB;AAAA,MAC7C,EAAE,QAAQ,OAAO,MAAM,0BAA0B;AAAA,MACjD,EAAE,QAAQ,OAAO,MAAM,gDAAgD;AAAA,IACxE;AAAA,EACD;AAAA,EACA,mBAAmB;AAAA,IAClB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,QAAQ,MAAM,0BAA0B;AAAA,MAClD,EAAE,QAAQ,QAAQ,MAAM,+CAA+C;AAAA,IACxE;AAAA,EACD;AAAA,EACA,gBAAgB;AAAA,IACf,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,eAAe;AAAA,MACtC,EAAE,QAAQ,OAAO,MAAM,wBAAwB;AAAA,IAChD;AAAA,EACD;AAAA,EACA,iBAAiB;AAAA,IAChB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,SAAS,MAAM,eAAe;AAAA,MACxC,EAAE,QAAQ,QAAQ,MAAM,uBAAuB;AAAA,MAC/C,EAAE,QAAQ,SAAS,MAAM,kCAAkC;AAAA,MAC3D,EAAE,QAAQ,UAAU,MAAM,kCAAkC;AAAA,MAC5D,EAAE,QAAQ,OAAO,MAAM,wEAAwE;AAAA,MAC/F,EAAE,QAAQ,UAAU,MAAM,wEAAwE;AAAA,MAClG,EAAE,QAAQ,OAAO,MAAM,qDAAqD;AAAA,MAC5E,EAAE,QAAQ,UAAU,MAAM,qDAAqD;AAAA,IAChF;AAAA,EACD;AAAA,EACA,mBAAmB;AAAA,IAClB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,iBAAiB;AAAA,MACxC,EAAE,QAAQ,OAAO,MAAM,qBAAqB;AAAA,MAC5C,EAAE,QAAQ,OAAO,MAAM,6BAA6B;AAAA,MACpD,EAAE,QAAQ,OAAO,MAAM,2BAA2B;AAAA,MAClD,EAAE,QAAQ,OAAO,MAAM,qCAAqC;AAAA,IAC7D;AAAA,EACD;AAAA,EACA,oBAAoB;AAAA,IACnB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,QAAQ,MAAM,iBAAiB;AAAA,MACzC,EAAE,QAAQ,OAAO,MAAM,qBAAqB;AAAA,MAC5C,EAAE,QAAQ,OAAO,MAAM,sCAAsC;AAAA,MAC7D,EAAE,QAAQ,UAAU,MAAM,sCAAsC;AAAA,MAChE,EAAE,QAAQ,QAAQ,MAAM,2BAA2B;AAAA,MACnD,EAAE,QAAQ,OAAO,MAAM,oCAAoC;AAAA,MAC3D,EAAE,QAAQ,UAAU,MAAM,oCAAoC;AAAA,MAC9D,EAAE,QAAQ,QAAQ,MAAM,kCAAkC;AAAA,MAC1D,EAAE,QAAQ,UAAU,MAAM,kCAAkC;AAAA,MAC5D,EAAE,QAAQ,QAAQ,MAAM,sCAAsC;AAAA,MAC9D,EAAE,QAAQ,UAAU,MAAM,sCAAsC;AAAA,MAChE,EAAE,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,MACrD,EAAE,QAAQ,SAAS,MAAM,wCAAwC;AAAA,MACjE,EAAE,QAAQ,UAAU,MAAM,wCAAwC;AAAA,MAClE,EAAE,QAAQ,OAAO,MAAM,8EAA8E;AAAA,MACrG,EAAE,QAAQ,UAAU,MAAM,8EAA8E;AAAA,MACxG,EAAE,QAAQ,OAAO,MAAM,2DAA2D;AAAA,MAClF,EAAE,QAAQ,UAAU,MAAM,2DAA2D;AAAA,MACrF,EAAE,QAAQ,QAAQ,MAAM,qCAAqC;AAAA,IAC9D;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,qBAAqB;AAAA,IACpB,OAAO;AAAA,IACP,QAAQ,CAAC,EAAE,QAAQ,UAAU,MAAM,qBAAqB,CAAC;AAAA,EAC1D;AAAA;AAAA,EAEA,sBAAsB;AAAA,IACrB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,6BAA6B;AAAA,MACpD,EAAE,QAAQ,UAAU,MAAM,wCAAwC;AAAA,MAClE,EAAE,QAAQ,OAAO,MAAM,gCAAgC;AAAA,MACvD,EAAE,QAAQ,QAAQ,MAAM,uCAAuC;AAAA,MAC/D,EAAE,QAAQ,QAAQ,MAAM,wCAAwC;AAAA,IACjE;AAAA,EACD;AAAA,EACA,gBAAgB;AAAA,IACf,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,OAAO,MAAM,aAAa;AAAA,MACpC,EAAE,QAAQ,OAAO,MAAM,6BAA6B;AAAA,IACrD;AAAA,EACD;AAAA;AAAA,EAEA,iBAAiB;AAAA,IAChB,OAAO;AAAA,IACP,QAAQ;AAAA,MACP,EAAE,QAAQ,QAAQ,MAAM,aAAa;AAAA,MACrC,EAAE,QAAQ,QAAQ,MAAM,mCAAmC;AAAA,IAC5D;AAAA,EACD;AAAA,EACA,gBAAgB,EAAE,OAAO,WAAW,QAAQ,CAAC,EAAE,QAAQ,QAAQ,MAAM,mBAAmB,CAAC,EAAE;AAC5F;AAEO,IAAM,qBAAqB,OAAO,KAAK,cAAc;AAGrD,SAAS,mBAAmB,QAA2C;AAC7E,MAAI,WAAW,OAAQ,QAAO;AAC9B,SAAO,mBAAmB,OAAO,CAAC,MAAM,EAAE,SAAS,OAAO,KAAM,WAAW,WAAW,EAAE,SAAS,QAAQ,CAAE;AAC5G;AAGO,IAAM,uBAAuB;AAC7B,IAAM,0BAA0B;AAChC,IAAM,0BAA0B;","names":[]}
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
// payloads/v1/api-key.ts
|
|
2
|
+
var APIApiKeyScope = {
|
|
3
|
+
APPS_READ: "apps:read",
|
|
4
|
+
APPS_WRITE: "apps:write",
|
|
5
|
+
APPS_DELETE: "apps:delete",
|
|
6
|
+
APPS_ENVS: "apps:envs",
|
|
7
|
+
APPS_FILES: "apps:files",
|
|
8
|
+
DATABASES_READ: "databases:read",
|
|
9
|
+
DATABASES_WRITE: "databases:write",
|
|
10
|
+
DATABASES_DELETE: "databases:delete",
|
|
11
|
+
DATABASES_CREDENTIALS: "databases:credentials",
|
|
12
|
+
SNAPSHOTS_READ: "snapshots:read",
|
|
13
|
+
SNAPSHOTS_WRITE: "snapshots:write",
|
|
14
|
+
ACCOUNT_READ: "account:read",
|
|
15
|
+
ACCOUNT_WRITE: "account:write",
|
|
16
|
+
WORKSPACES_READ: "workspaces:read",
|
|
17
|
+
WORKSPACES_WRITE: "workspaces:write",
|
|
18
|
+
WORKSPACES_DELETE: "workspaces:delete",
|
|
19
|
+
WORKSPACES_INVITES: "workspaces:invites",
|
|
20
|
+
BILLING_READ: "billing:read",
|
|
21
|
+
BILLING_WRITE: "billing:write",
|
|
22
|
+
REDEEM_WRITE: "redeem:write"
|
|
23
|
+
};
|
|
24
|
+
var APIApiKeyPreset = { Read: "read", Write: "write", Full: "full" };
|
|
25
|
+
var API_KEY_SCOPES = {
|
|
26
|
+
"apps:read": {
|
|
27
|
+
group: "apps",
|
|
28
|
+
routes: [
|
|
29
|
+
{ method: "GET", path: "/v1/apps/runtimes" },
|
|
30
|
+
{ method: "GET", path: "/v1/apps/status" },
|
|
31
|
+
{ method: "GET", path: "/v1/apps/:id" },
|
|
32
|
+
{ method: "GET", path: "/v1/apps/:id/status" },
|
|
33
|
+
{ method: "GET", path: "/v1/apps/:id/realtime" },
|
|
34
|
+
{ method: "GET", path: "/v1/apps/:id/metrics" },
|
|
35
|
+
{ method: "GET", path: "/v1/apps/:id/logs" },
|
|
36
|
+
{ method: "GET", path: "/v1/apps/:id/download" },
|
|
37
|
+
{ method: "GET", path: "/v1/apps/:id/deploys" },
|
|
38
|
+
{ method: "GET", path: "/v1/apps/:id/deploys/webhook" },
|
|
39
|
+
{ method: "GET", path: "/v1/apps/:id/network/custom" },
|
|
40
|
+
{ method: "GET", path: "/v1/apps/:id/network/dns" }
|
|
41
|
+
]
|
|
42
|
+
},
|
|
43
|
+
"apps:write": {
|
|
44
|
+
group: "apps",
|
|
45
|
+
routes: [
|
|
46
|
+
{ method: "POST", path: "/v1/apps" },
|
|
47
|
+
{ method: "POST", path: "/v1/apps/:id/start" },
|
|
48
|
+
{ method: "POST", path: "/v1/apps/:id/stop" },
|
|
49
|
+
{ method: "POST", path: "/v1/apps/:id/restart" },
|
|
50
|
+
{ method: "PATCH", path: "/v1/apps/:id/config" },
|
|
51
|
+
{ method: "POST", path: "/v1/apps/:id/deploys/webhook" },
|
|
52
|
+
{ method: "DELETE", path: "/v1/apps/:id/deploys/webhook" },
|
|
53
|
+
{ method: "POST", path: "/v1/apps/:id/network/custom" },
|
|
54
|
+
{ method: "DELETE", path: "/v1/apps/:id/network/custom" },
|
|
55
|
+
{ method: "POST", path: "/v1/apps/:id/network/purge-cache" },
|
|
56
|
+
{ method: "PATCH", path: "/v1/apps/:id/network/subdomain" },
|
|
57
|
+
{ method: "POST", path: "/v1/apps/:id/network/publish" },
|
|
58
|
+
{ method: "DELETE", path: "/v1/apps/:id/network/publish" }
|
|
59
|
+
]
|
|
60
|
+
},
|
|
61
|
+
"apps:delete": { group: "apps", routes: [{ method: "DELETE", path: "/v1/apps/:id" }] },
|
|
62
|
+
"apps:envs": {
|
|
63
|
+
group: "apps",
|
|
64
|
+
routes: [
|
|
65
|
+
{ method: "GET", path: "/v1/apps/:id/envs" },
|
|
66
|
+
{ method: "POST", path: "/v1/apps/:id/envs" },
|
|
67
|
+
{ method: "DELETE", path: "/v1/apps/:id/envs/:envId" }
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
"apps:files": {
|
|
71
|
+
group: "apps",
|
|
72
|
+
routes: [
|
|
73
|
+
{ method: "GET", path: "/v1/apps/:id/files" },
|
|
74
|
+
{ method: "GET", path: "/v1/apps/:id/files/tree" },
|
|
75
|
+
{ method: "GET", path: "/v1/apps/:id/files/content" },
|
|
76
|
+
{ method: "PUT", path: "/v1/apps/:id/files" },
|
|
77
|
+
{ method: "PATCH", path: "/v1/apps/:id/files" },
|
|
78
|
+
{ method: "DELETE", path: "/v1/apps/:id/files" },
|
|
79
|
+
{ method: "POST", path: "/v1/apps/:id/files/upload" }
|
|
80
|
+
]
|
|
81
|
+
},
|
|
82
|
+
"databases:read": {
|
|
83
|
+
group: "databases",
|
|
84
|
+
routes: [
|
|
85
|
+
{ method: "GET", path: "/v1/databases/status" },
|
|
86
|
+
{ method: "GET", path: "/v1/databases/:id" },
|
|
87
|
+
{ method: "GET", path: "/v1/databases/:id/status" },
|
|
88
|
+
{ method: "GET", path: "/v1/databases/:id/metrics" }
|
|
89
|
+
]
|
|
90
|
+
},
|
|
91
|
+
"databases:write": {
|
|
92
|
+
group: "databases",
|
|
93
|
+
routes: [
|
|
94
|
+
{ method: "POST", path: "/v1/databases" },
|
|
95
|
+
{ method: "PUT", path: "/v1/databases/:id" },
|
|
96
|
+
{ method: "POST", path: "/v1/databases/:id/start" },
|
|
97
|
+
{ method: "POST", path: "/v1/databases/:id/stop" },
|
|
98
|
+
{ method: "POST", path: "/v1/databases/:id/reset" }
|
|
99
|
+
]
|
|
100
|
+
},
|
|
101
|
+
"databases:delete": { group: "databases", routes: [{ method: "DELETE", path: "/v1/databases/:id" }] },
|
|
102
|
+
"databases:credentials": {
|
|
103
|
+
group: "databases",
|
|
104
|
+
routes: [
|
|
105
|
+
{ method: "GET", path: "/v1/databases/:id/credentials/certificate" },
|
|
106
|
+
{ method: "POST", path: "/v1/databases/:id/credentials/certificate/reset" },
|
|
107
|
+
{ method: "POST", path: "/v1/databases/:id/credentials/reset" }
|
|
108
|
+
]
|
|
109
|
+
},
|
|
110
|
+
"snapshots:read": {
|
|
111
|
+
group: "snapshots",
|
|
112
|
+
routes: [
|
|
113
|
+
{ method: "GET", path: "/v1/users/snapshots" },
|
|
114
|
+
{ method: "GET", path: "/v1/users/:id/snapshots" },
|
|
115
|
+
{ method: "GET", path: "/v1/users/:id/snapshots/:snapshot_id/download" }
|
|
116
|
+
]
|
|
117
|
+
},
|
|
118
|
+
"snapshots:write": {
|
|
119
|
+
group: "snapshots",
|
|
120
|
+
routes: [
|
|
121
|
+
{ method: "POST", path: "/v1/users/:id/snapshots" },
|
|
122
|
+
{ method: "POST", path: "/v1/users/:id/snapshots/:snapshot_id/restore" }
|
|
123
|
+
]
|
|
124
|
+
},
|
|
125
|
+
"account:read": {
|
|
126
|
+
group: "account",
|
|
127
|
+
routes: [
|
|
128
|
+
{ method: "GET", path: "/v1/users/me" },
|
|
129
|
+
{ method: "GET", path: "/v1/users/me/sessions" }
|
|
130
|
+
]
|
|
131
|
+
},
|
|
132
|
+
"account:write": {
|
|
133
|
+
group: "account",
|
|
134
|
+
routes: [
|
|
135
|
+
{ method: "PATCH", path: "/v1/users/me" },
|
|
136
|
+
{ method: "POST", path: "/v1/users/me/folders" },
|
|
137
|
+
{ method: "PATCH", path: "/v1/users/me/folders/:folder_id" },
|
|
138
|
+
{ method: "DELETE", path: "/v1/users/me/folders/:folder_id" },
|
|
139
|
+
{ method: "PUT", path: "/v1/users/me/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
140
|
+
{ method: "DELETE", path: "/v1/users/me/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
141
|
+
{ method: "PUT", path: "/v1/users/me/favorites/:resource_type/:resource_id" },
|
|
142
|
+
{ method: "DELETE", path: "/v1/users/me/favorites/:resource_type/:resource_id" }
|
|
143
|
+
]
|
|
144
|
+
},
|
|
145
|
+
"workspaces:read": {
|
|
146
|
+
group: "workspaces",
|
|
147
|
+
routes: [
|
|
148
|
+
{ method: "GET", path: "/v1/workspaces" },
|
|
149
|
+
{ method: "GET", path: "/v1/workspaces/:id" },
|
|
150
|
+
{ method: "GET", path: "/v1/workspaces/:id/members" },
|
|
151
|
+
{ method: "GET", path: "/v1/workspaces/:id/roles" },
|
|
152
|
+
{ method: "GET", path: "/v1/workspaces/:id/action-requests" }
|
|
153
|
+
]
|
|
154
|
+
},
|
|
155
|
+
"workspaces:write": {
|
|
156
|
+
group: "workspaces",
|
|
157
|
+
routes: [
|
|
158
|
+
{ method: "POST", path: "/v1/workspaces" },
|
|
159
|
+
{ method: "PUT", path: "/v1/workspaces/:id" },
|
|
160
|
+
{ method: "PUT", path: "/v1/workspaces/:id/members/:user_id" },
|
|
161
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/members/:user_id" },
|
|
162
|
+
{ method: "POST", path: "/v1/workspaces/:id/roles" },
|
|
163
|
+
{ method: "PUT", path: "/v1/workspaces/:id/roles/:role_id" },
|
|
164
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/roles/:role_id" },
|
|
165
|
+
{ method: "POST", path: "/v1/workspaces/:id/apps/:app_id" },
|
|
166
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/apps/:app_id" },
|
|
167
|
+
{ method: "POST", path: "/v1/workspaces/:id/databases/:db_id" },
|
|
168
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/databases/:db_id" },
|
|
169
|
+
{ method: "POST", path: "/v1/workspaces/:id/folders" },
|
|
170
|
+
{ method: "PATCH", path: "/v1/workspaces/:id/folders/:folder_id" },
|
|
171
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/folders/:folder_id" },
|
|
172
|
+
{ method: "PUT", path: "/v1/workspaces/:id/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
173
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/folders/:folder_id/resources/:resource_type/:resource_id" },
|
|
174
|
+
{ method: "PUT", path: "/v1/workspaces/:id/favorites/:resource_type/:resource_id" },
|
|
175
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/favorites/:resource_type/:resource_id" },
|
|
176
|
+
{ method: "POST", path: "/v1/workspaces/:id/action-requests" }
|
|
177
|
+
]
|
|
178
|
+
},
|
|
179
|
+
/**
|
|
180
|
+
* Intentionally left out (dashboard session only): creating invites (a leaked key could grant
|
|
181
|
+
* access that outlives its revocation), transferring ownership, approving/rejecting action
|
|
182
|
+
* requests (approval is a human decision) and exporting activities.
|
|
183
|
+
*/
|
|
184
|
+
/** Delete a workspace (soft delete). Only in the `full` preset, like `apps:delete`. */
|
|
185
|
+
"workspaces:delete": {
|
|
186
|
+
group: "workspaces",
|
|
187
|
+
routes: [{ method: "DELETE", path: "/v1/workspaces/:id" }]
|
|
188
|
+
},
|
|
189
|
+
/** List and revoke workspace invites; view, accept and decline your own invite by token. Only in the `full` preset. */
|
|
190
|
+
"workspaces:invites": {
|
|
191
|
+
group: "workspaces",
|
|
192
|
+
routes: [
|
|
193
|
+
{ method: "GET", path: "/v1/workspaces/:id/invites" },
|
|
194
|
+
{ method: "DELETE", path: "/v1/workspaces/:id/invites/:invite_id" },
|
|
195
|
+
{ method: "GET", path: "/v1/workspaces/invites/:token" },
|
|
196
|
+
{ method: "POST", path: "/v1/workspaces/invites/:token/accept" },
|
|
197
|
+
{ method: "POST", path: "/v1/workspaces/invites/:token/decline" }
|
|
198
|
+
]
|
|
199
|
+
},
|
|
200
|
+
"billing:read": {
|
|
201
|
+
group: "billing",
|
|
202
|
+
routes: [
|
|
203
|
+
{ method: "GET", path: "/v1/orders" },
|
|
204
|
+
{ method: "GET", path: "/v1/orders/:orderId/status" }
|
|
205
|
+
]
|
|
206
|
+
},
|
|
207
|
+
/** Creates a plan order and generates the PIX charge; the payment itself is made by a person in their banking app. */
|
|
208
|
+
"billing:write": {
|
|
209
|
+
group: "billing",
|
|
210
|
+
routes: [
|
|
211
|
+
{ method: "POST", path: "/v1/orders" },
|
|
212
|
+
{ method: "POST", path: "/v1/orders/:orderId/initiate/pix" }
|
|
213
|
+
]
|
|
214
|
+
},
|
|
215
|
+
"redeem:write": { group: "billing", routes: [{ method: "POST", path: "/v1/redeem/:code" }] }
|
|
216
|
+
};
|
|
217
|
+
var API_KEY_SCOPE_LIST = Object.keys(API_KEY_SCOPES);
|
|
218
|
+
function apiKeyPresetScopes(preset) {
|
|
219
|
+
if (preset === "full") return API_KEY_SCOPE_LIST;
|
|
220
|
+
return API_KEY_SCOPE_LIST.filter((s) => s.endsWith(":read") || preset === "write" && s.endsWith(":write"));
|
|
221
|
+
}
|
|
222
|
+
var API_KEY_MAX_PER_USER = 10;
|
|
223
|
+
var API_KEY_MAX_ALLOWED_IPS = 20;
|
|
224
|
+
var API_KEY_NAME_MAX_LENGTH = 40;
|
|
225
|
+
export {
|
|
226
|
+
APIApiKeyPreset,
|
|
227
|
+
APIApiKeyScope,
|
|
228
|
+
API_KEY_MAX_ALLOWED_IPS,
|
|
229
|
+
API_KEY_MAX_PER_USER,
|
|
230
|
+
API_KEY_NAME_MAX_LENGTH,
|
|
231
|
+
API_KEY_SCOPES,
|
|
232
|
+
API_KEY_SCOPE_LIST,
|
|
233
|
+
apiKeyPresetScopes
|
|
234
|
+
};
|
|
235
|
+
//# sourceMappingURL=api-key.mjs.map
|