@miosa/sdk 1.2.2 → 1.2.3
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 +42 -0
- package/dist/index.d.ts +166 -26
- package/dist/index.js +346 -66
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +5 -0
- package/src/index.ts +15 -0
- package/src/resources/deployments.test.ts +66 -0
- package/src/resources/deployments.ts +201 -0
- package/src/resources/docker-deploy.test.ts +102 -0
- package/src/resources/docker-deploy.ts +183 -0
- package/src/resources/phase1.test.ts +187 -0
- package/src/resources/quotas.ts +77 -0
- package/src/resources/sandbox-processes.ts +112 -0
- package/src/resources/sandbox-shares.ts +83 -0
- package/src/resources/tenant-events.ts +32 -0
- package/src/resources/tenant.ts +101 -19
- package/src/resources/webhooks.ts +39 -54
- package/src/resources/workspaces.ts +285 -0
|
@@ -66,11 +66,6 @@ export interface WebhookUpdateParams {
|
|
|
66
66
|
[key: string]: unknown;
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
-
export interface WebhookSignatureVerifyOptions {
|
|
70
|
-
/** Maximum age for the webhook timestamp in seconds. Defaults to 300. */
|
|
71
|
-
toleranceSeconds?: number;
|
|
72
|
-
}
|
|
73
|
-
|
|
74
69
|
// ── Helpers ───────────────────────────────────────────────────────────────────
|
|
75
70
|
|
|
76
71
|
function unwrap<T>(payload: unknown): T {
|
|
@@ -106,74 +101,64 @@ function idempotencyKey(key?: string): string {
|
|
|
106
101
|
return key ?? randomUUID();
|
|
107
102
|
}
|
|
108
103
|
|
|
109
|
-
function
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
const parts = header.split(",").map((part) => part.trim());
|
|
114
|
-
let timestamp: number | null = null;
|
|
115
|
-
const signatures: string[] = [];
|
|
116
|
-
|
|
117
|
-
for (const part of parts) {
|
|
118
|
-
const [key, value] = part.split("=", 2);
|
|
119
|
-
if (!key || !value) continue;
|
|
120
|
-
if (key === "t") {
|
|
121
|
-
const parsed = Number(value);
|
|
122
|
-
if (Number.isFinite(parsed)) timestamp = parsed;
|
|
123
|
-
} else if (key === "v1") {
|
|
124
|
-
signatures.push(value);
|
|
125
|
-
}
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
if (timestamp == null || signatures.length === 0) return null;
|
|
129
|
-
return { timestamp, signatures };
|
|
104
|
+
function bodyBuffer(body: Buffer | Uint8Array | string): Buffer {
|
|
105
|
+
if (Buffer.isBuffer(body)) return body;
|
|
106
|
+
if (typeof body === "string") return Buffer.from(body, "utf8");
|
|
107
|
+
return Buffer.from(body);
|
|
130
108
|
}
|
|
131
109
|
|
|
132
110
|
/**
|
|
133
|
-
* Verify
|
|
111
|
+
* Verify the `Miosa-Signature` webhook header.
|
|
134
112
|
*
|
|
135
|
-
* Header format: `t=<unix_seconds>,v1=<
|
|
113
|
+
* Header format: `t=<unix_seconds>,v1=<hex_hmac>`.
|
|
114
|
+
* Signed payload: `<timestamp>.<raw_body>`.
|
|
136
115
|
*/
|
|
137
116
|
export function verifySignature(
|
|
138
|
-
body:
|
|
117
|
+
body: Buffer | Uint8Array | string,
|
|
139
118
|
header: string,
|
|
140
119
|
secret: string,
|
|
141
|
-
|
|
120
|
+
toleranceSec = 300,
|
|
142
121
|
): boolean {
|
|
143
|
-
const
|
|
144
|
-
|
|
122
|
+
const parts = Object.fromEntries(
|
|
123
|
+
header
|
|
124
|
+
.split(",")
|
|
125
|
+
.map((chunk) => chunk.split("=", 2))
|
|
126
|
+
.filter(([key, value]) => key && value),
|
|
127
|
+
);
|
|
128
|
+
|
|
129
|
+
const timestamp = parts.t;
|
|
130
|
+
const received = parts.v1;
|
|
131
|
+
if (!timestamp || !received || !secret) return false;
|
|
132
|
+
|
|
133
|
+
const unixSeconds = Number(timestamp);
|
|
134
|
+
if (!Number.isFinite(unixSeconds)) return false;
|
|
145
135
|
|
|
146
|
-
const
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
throw new Error("Webhook signature timestamp is too old");
|
|
136
|
+
const ageSec = Math.abs(Date.now() / 1000 - unixSeconds);
|
|
137
|
+
if (ageSec > toleranceSec) {
|
|
138
|
+
throw new Error("webhook timestamp too old");
|
|
150
139
|
}
|
|
151
140
|
|
|
152
|
-
const
|
|
153
|
-
const
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
if (actualBuffer.length !== expectedBuffer.length) return false;
|
|
165
|
-
return timingSafeEqual(actualBuffer, expectedBuffer);
|
|
166
|
-
});
|
|
141
|
+
const rawBody = bodyBuffer(body);
|
|
142
|
+
const signed = Buffer.concat([Buffer.from(`${timestamp}.`), rawBody]);
|
|
143
|
+
const expected = createHmac("sha256", secret).update(signed).digest("hex");
|
|
144
|
+
|
|
145
|
+
try {
|
|
146
|
+
return timingSafeEqual(
|
|
147
|
+
Buffer.from(expected, "utf8"),
|
|
148
|
+
Buffer.from(received, "utf8"),
|
|
149
|
+
);
|
|
150
|
+
} catch {
|
|
151
|
+
return false;
|
|
152
|
+
}
|
|
167
153
|
}
|
|
168
154
|
|
|
169
155
|
// ── Main resource ─────────────────────────────────────────────────────────────
|
|
170
156
|
|
|
171
157
|
export class Webhooks {
|
|
172
|
-
static verifySignature = verifySignature;
|
|
173
|
-
static verify_signature = verifySignature;
|
|
174
|
-
|
|
175
158
|
constructor(private readonly http: HttpClient) {}
|
|
176
159
|
|
|
160
|
+
static verifySignature = verifySignature;
|
|
161
|
+
|
|
177
162
|
async list(params: WebhookListParams = {}): Promise<WebhookData[]> {
|
|
178
163
|
const query = stripUndefined({ ...params }) as Record<
|
|
179
164
|
string,
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Workspaces resource — top-level tenant workspaces grouping computers.
|
|
3
|
+
*
|
|
4
|
+
* A workspace is a logical bucket of computers (handy for teams / projects).
|
|
5
|
+
* Accessed via `miosa.workspaces` on the top-level client.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* const ws = await miosa.workspaces.create({ name: "prod" });
|
|
10
|
+
* const computers = await miosa.workspaces.listComputers(ws.id);
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import type { HttpClient } from "../http.js";
|
|
15
|
+
import type { ComputerData } from "../types.js";
|
|
16
|
+
import { Computer } from "./computer.js";
|
|
17
|
+
|
|
18
|
+
// ── Branded IDs ──────────────────────────────────────────────────────────────
|
|
19
|
+
|
|
20
|
+
export type WorkspaceId = string & { readonly __brand: "WorkspaceId" };
|
|
21
|
+
|
|
22
|
+
// ── Resource shapes ──────────────────────────────────────────────────────────
|
|
23
|
+
|
|
24
|
+
export interface WorkspaceData {
|
|
25
|
+
id: WorkspaceId;
|
|
26
|
+
tenant_id: string;
|
|
27
|
+
name: string;
|
|
28
|
+
slug?: string | null;
|
|
29
|
+
description?: string | null;
|
|
30
|
+
metadata?: Record<string, unknown> | null;
|
|
31
|
+
settings?: Record<string, unknown> | null;
|
|
32
|
+
created_at?: string;
|
|
33
|
+
updated_at?: string;
|
|
34
|
+
[key: string]: unknown;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// ── Request payloads ─────────────────────────────────────────────────────────
|
|
38
|
+
|
|
39
|
+
export interface WorkspaceCreateParams {
|
|
40
|
+
name: string;
|
|
41
|
+
slug?: string;
|
|
42
|
+
description?: string;
|
|
43
|
+
metadata?: Record<string, unknown>;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface WorkspaceUpdateParams {
|
|
47
|
+
name?: string;
|
|
48
|
+
description?: string;
|
|
49
|
+
metadata?: Record<string, unknown>;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export interface WorkspaceComputerTemplateCreateParams {
|
|
53
|
+
name: string;
|
|
54
|
+
templateType?: string;
|
|
55
|
+
template_type?: string;
|
|
56
|
+
description?: string;
|
|
57
|
+
[key: string]: unknown;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// ── Helpers ───────────────────────────────────────────────────────────────────
|
|
61
|
+
|
|
62
|
+
function unwrap<T>(payload: unknown): T {
|
|
63
|
+
if (payload && typeof payload === "object" && "data" in (payload as object)) {
|
|
64
|
+
return (payload as { data: T }).data;
|
|
65
|
+
}
|
|
66
|
+
return payload as T;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
function listItems<T>(
|
|
70
|
+
payload: unknown,
|
|
71
|
+
candidateKeys: string[] = ["data", "items"],
|
|
72
|
+
): T[] {
|
|
73
|
+
if (Array.isArray(payload)) return payload;
|
|
74
|
+
if (!payload || typeof payload !== "object") return [];
|
|
75
|
+
const p = payload as Record<string, unknown>;
|
|
76
|
+
if (Array.isArray(p.data)) return p.data as T[];
|
|
77
|
+
for (const key of candidateKeys) {
|
|
78
|
+
if (Array.isArray(p[key])) return p[key] as T[];
|
|
79
|
+
}
|
|
80
|
+
return [];
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
// ── Workspaces resource ───────────────────────────────────────────────────────
|
|
84
|
+
|
|
85
|
+
export class Workspaces {
|
|
86
|
+
private readonly http: HttpClient;
|
|
87
|
+
|
|
88
|
+
constructor(http: HttpClient) {
|
|
89
|
+
this.http = http;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Create a new workspace.
|
|
94
|
+
*/
|
|
95
|
+
async create(params: WorkspaceCreateParams): Promise<WorkspaceData> {
|
|
96
|
+
const payload = await this.http.post<unknown>("/workspaces", params);
|
|
97
|
+
return unwrap<WorkspaceData>(payload);
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* List all workspaces visible to the current credential.
|
|
102
|
+
*/
|
|
103
|
+
async list(): Promise<WorkspaceData[]> {
|
|
104
|
+
const payload = await this.http.get<unknown>("/workspaces");
|
|
105
|
+
if (
|
|
106
|
+
payload &&
|
|
107
|
+
typeof payload === "object" &&
|
|
108
|
+
"workspaces" in (payload as object)
|
|
109
|
+
) {
|
|
110
|
+
const p = payload as Record<string, unknown>;
|
|
111
|
+
return (p["workspaces"] as WorkspaceData[]) ?? [];
|
|
112
|
+
}
|
|
113
|
+
return listItems<WorkspaceData>(payload, ["data", "workspaces", "items"]);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Get a single workspace by ID.
|
|
118
|
+
*/
|
|
119
|
+
async get(id: WorkspaceId | string): Promise<WorkspaceData> {
|
|
120
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}`);
|
|
121
|
+
return unwrap<WorkspaceData>(payload);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Update a workspace's metadata.
|
|
126
|
+
*/
|
|
127
|
+
async update(
|
|
128
|
+
id: WorkspaceId | string,
|
|
129
|
+
params: WorkspaceUpdateParams,
|
|
130
|
+
): Promise<WorkspaceData> {
|
|
131
|
+
const payload = await this.http.patch<unknown>(`/workspaces/${id}`, params);
|
|
132
|
+
return unwrap<WorkspaceData>(payload);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Delete a workspace. Does not delete member computers.
|
|
137
|
+
*/
|
|
138
|
+
async delete(id: WorkspaceId | string): Promise<void> {
|
|
139
|
+
await this.http.delete<void>(`/workspaces/${id}`);
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Update workspace-level settings.
|
|
144
|
+
*/
|
|
145
|
+
async updateSettings(
|
|
146
|
+
id: WorkspaceId | string,
|
|
147
|
+
settings: Record<string, unknown>,
|
|
148
|
+
): Promise<WorkspaceData> {
|
|
149
|
+
const payload = await this.http.put<unknown>(
|
|
150
|
+
`/workspaces/${id}/settings`,
|
|
151
|
+
settings,
|
|
152
|
+
);
|
|
153
|
+
return unwrap<WorkspaceData>(payload);
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* List all computers that belong to the given workspace.
|
|
158
|
+
*/
|
|
159
|
+
async listComputers(id: WorkspaceId | string): Promise<Computer[]> {
|
|
160
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/computers`);
|
|
161
|
+
const items = listItems<ComputerData>(payload, [
|
|
162
|
+
"data",
|
|
163
|
+
"computers",
|
|
164
|
+
"items",
|
|
165
|
+
]);
|
|
166
|
+
return items.map((d) => new Computer(this.http, d));
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* List all sandboxes that belong to this workspace.
|
|
171
|
+
*/
|
|
172
|
+
async listSandboxes(
|
|
173
|
+
id: WorkspaceId | string,
|
|
174
|
+
): Promise<Record<string, unknown>[]> {
|
|
175
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/sandboxes`);
|
|
176
|
+
return listItems<Record<string, unknown>>(payload, [
|
|
177
|
+
"data",
|
|
178
|
+
"sandboxes",
|
|
179
|
+
"items",
|
|
180
|
+
]);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* List all deployments that belong to this workspace.
|
|
185
|
+
*/
|
|
186
|
+
async listDeployments(
|
|
187
|
+
id: WorkspaceId | string,
|
|
188
|
+
): Promise<Record<string, unknown>[]> {
|
|
189
|
+
const payload = await this.http.get<unknown>(
|
|
190
|
+
`/workspaces/${id}/deployments`,
|
|
191
|
+
);
|
|
192
|
+
return listItems<Record<string, unknown>>(payload, [
|
|
193
|
+
"data",
|
|
194
|
+
"deployments",
|
|
195
|
+
"items",
|
|
196
|
+
]);
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* List all managed databases that belong to this workspace.
|
|
201
|
+
*/
|
|
202
|
+
async listDatabases(
|
|
203
|
+
id: WorkspaceId | string,
|
|
204
|
+
): Promise<Record<string, unknown>[]> {
|
|
205
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/databases`);
|
|
206
|
+
return listItems<Record<string, unknown>>(payload, [
|
|
207
|
+
"data",
|
|
208
|
+
"databases",
|
|
209
|
+
"items",
|
|
210
|
+
]);
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* List all projects that belong to this workspace.
|
|
215
|
+
*/
|
|
216
|
+
async listProjects(
|
|
217
|
+
id: WorkspaceId | string,
|
|
218
|
+
): Promise<Record<string, unknown>[]> {
|
|
219
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/projects`);
|
|
220
|
+
return listItems<Record<string, unknown>>(payload, [
|
|
221
|
+
"data",
|
|
222
|
+
"projects",
|
|
223
|
+
"items",
|
|
224
|
+
]);
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* Return aggregate resource stats for this workspace.
|
|
229
|
+
*/
|
|
230
|
+
async stats(id: WorkspaceId | string): Promise<Record<string, unknown>> {
|
|
231
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/stats`);
|
|
232
|
+
return unwrap<Record<string, unknown>>(payload);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Return metered usage data for this workspace.
|
|
237
|
+
*/
|
|
238
|
+
async usage(id: WorkspaceId | string): Promise<Record<string, unknown>> {
|
|
239
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/usage`);
|
|
240
|
+
return unwrap<Record<string, unknown>>(payload);
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* Return activity feed for this workspace.
|
|
245
|
+
*/
|
|
246
|
+
async activity(id: WorkspaceId | string): Promise<Record<string, unknown>[]> {
|
|
247
|
+
const payload = await this.http.get<unknown>(`/workspaces/${id}/activity`);
|
|
248
|
+
return listItems<Record<string, unknown>>(payload, [
|
|
249
|
+
"data",
|
|
250
|
+
"activity",
|
|
251
|
+
"events",
|
|
252
|
+
"items",
|
|
253
|
+
]);
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* List computer templates available in this workspace.
|
|
258
|
+
*/
|
|
259
|
+
async listComputerTemplates(
|
|
260
|
+
id: WorkspaceId | string,
|
|
261
|
+
): Promise<Record<string, unknown>[]> {
|
|
262
|
+
const payload = await this.http.get<unknown>(
|
|
263
|
+
`/workspaces/${id}/computer-templates`,
|
|
264
|
+
);
|
|
265
|
+
return listItems<Record<string, unknown>>(payload, [
|
|
266
|
+
"data",
|
|
267
|
+
"templates",
|
|
268
|
+
"items",
|
|
269
|
+
]);
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Create a computer template scoped to this workspace.
|
|
274
|
+
*/
|
|
275
|
+
async createComputerTemplate(
|
|
276
|
+
id: WorkspaceId | string,
|
|
277
|
+
params: WorkspaceComputerTemplateCreateParams,
|
|
278
|
+
): Promise<Record<string, unknown>> {
|
|
279
|
+
const payload = await this.http.post<unknown>(
|
|
280
|
+
`/workspaces/${id}/computer-templates`,
|
|
281
|
+
params,
|
|
282
|
+
);
|
|
283
|
+
return unwrap<Record<string, unknown>>(payload);
|
|
284
|
+
}
|
|
285
|
+
}
|