@miosa/sdk 1.1.0 → 1.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 +1 -1
- package/dist/index.d.ts +23 -234
- package/dist/index.js +15 -280
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +0 -5
- package/src/index.ts +0 -10
- package/src/resources/api-keys.ts +1 -5
- package/src/resources/computer.ts +9 -4
- package/src/resources/cron-jobs.ts +0 -7
- package/src/resources/custom_domains.ts +1 -8
- package/src/resources/deployments.ts +2 -13
- package/src/resources/flat-custom-domains.ts +0 -7
- package/src/resources/functions.ts +0 -7
- package/src/resources/sandboxes.test.ts +10 -7
- package/src/resources/storage.ts +0 -7
- package/src/resources/tenant.ts +3 -82
- package/src/resources/volumes.ts +0 -7
- package/src/resources/webhooks.ts +0 -55
- package/src/types.ts +5 -9
- package/src/resources/phase1.test.ts +0 -187
- package/src/resources/quotas.ts +0 -77
- package/src/resources/sandbox-processes.ts +0 -112
- package/src/resources/sandbox-shares.ts +0 -83
- package/src/resources/tenant-events.ts +0 -32
- package/src/resources/workspaces.ts +0 -285
package/README.md
CHANGED
|
@@ -38,7 +38,7 @@ console.log(result.stdout); // hello from miosa
|
|
|
38
38
|
|
|
39
39
|
// Expose a live preview URL
|
|
40
40
|
const url = await sbx.expose(3000);
|
|
41
|
-
console.log(url); // https://3000-<slug>.sandbox
|
|
41
|
+
console.log(url); // https://3000-<slug>.sandbox.<tenant-domain>
|
|
42
42
|
|
|
43
43
|
await sbx.destroy();
|
|
44
44
|
```
|
package/dist/index.d.ts
CHANGED
|
@@ -214,9 +214,6 @@ interface ApiKeyCreateParams {
|
|
|
214
214
|
expires_at?: string;
|
|
215
215
|
expiresAt?: string;
|
|
216
216
|
idempotencyKey?: string;
|
|
217
|
-
/** Scope this key to a single workspace. Omit for a tenant-wide key. */
|
|
218
|
-
workspaceId?: string;
|
|
219
|
-
workspace_id?: string;
|
|
220
217
|
[key: string]: unknown;
|
|
221
218
|
}
|
|
222
219
|
declare class ApiKeys {
|
|
@@ -642,7 +639,7 @@ interface CustomDomainData$1 {
|
|
|
642
639
|
* // 1. Register the domain
|
|
643
640
|
* const domain = await computer.domains.register("app.example.com");
|
|
644
641
|
* console.log(domain.instructions);
|
|
645
|
-
* // => "Add a CNAME record: app.example.com → <slug>.sandbox
|
|
642
|
+
* // => "Add a CNAME record: app.example.com → <slug>.sandbox.<tenant-domain>"
|
|
646
643
|
*
|
|
647
644
|
* // 2. Add the CNAME in your DNS registrar, then...
|
|
648
645
|
*
|
|
@@ -748,12 +745,6 @@ interface ComputerCreateParams {
|
|
|
748
745
|
size?: ComputerSize;
|
|
749
746
|
visibility?: ComputerVisibility;
|
|
750
747
|
metadata?: Record<string, string>;
|
|
751
|
-
externalWorkspaceId?: string;
|
|
752
|
-
external_workspace_id?: string;
|
|
753
|
-
externalUserId?: string;
|
|
754
|
-
external_user_id?: string;
|
|
755
|
-
externalProjectId?: string;
|
|
756
|
-
external_project_id?: string;
|
|
757
748
|
}
|
|
758
749
|
interface ComputerUpdateParams {
|
|
759
750
|
name?: string;
|
|
@@ -764,7 +755,8 @@ interface ComputerData {
|
|
|
764
755
|
id: ComputerId;
|
|
765
756
|
name: string;
|
|
766
757
|
/**
|
|
767
|
-
* URL-safe identifier used in preview URLs:
|
|
758
|
+
* URL-safe identifier used in preview URLs:
|
|
759
|
+
* `https://{port}-{slug}.sandbox.{preview_domain}`.
|
|
768
760
|
* Falls back to the computer id when no slug is assigned.
|
|
769
761
|
*/
|
|
770
762
|
slug: string;
|
|
@@ -776,8 +768,10 @@ interface ComputerData {
|
|
|
776
768
|
metadata: Record<string, string>;
|
|
777
769
|
/** Controls who can access the HTTP preview URL. Defaults to `"public"`. */
|
|
778
770
|
visibility: ComputerVisibility;
|
|
779
|
-
/** Public ingress root, e.g. `https://<slug>.sandbox
|
|
771
|
+
/** Public ingress root, e.g. `https://<slug>.sandbox.<preview_domain>`. */
|
|
780
772
|
sandbox_url?: string;
|
|
773
|
+
/** Tenant's white-label preview/base domain, e.g. `cliniciq.com`. */
|
|
774
|
+
preview_domain?: string;
|
|
781
775
|
/** KasmVNC URL for desktop templates. */
|
|
782
776
|
desktop_url?: string;
|
|
783
777
|
created_at: string;
|
|
@@ -2180,16 +2174,18 @@ declare class Computer {
|
|
|
2180
2174
|
* ```ts
|
|
2181
2175
|
* await computer.exec.bash("npm run dev &");
|
|
2182
2176
|
* const url = computer.previewUrl(3000);
|
|
2183
|
-
* // => https://3000-<slug>.sandbox
|
|
2177
|
+
* // => https://3000-<slug>.sandbox.<tenant-domain>
|
|
2184
2178
|
* ```
|
|
2185
2179
|
*
|
|
2186
2180
|
* Works for any TCP HTTP listener. Public (no auth required); anyone with
|
|
2187
2181
|
* the URL can see it. Served over the ingress proxy so it inherits the
|
|
2188
|
-
*
|
|
2182
|
+
* tenant's white-label preview domain — no per-sandbox certs to manage.
|
|
2189
2183
|
*/
|
|
2190
2184
|
previewUrl(port: number, path?: string): string;
|
|
2191
2185
|
/** Root preview URL — serves whatever is on the default app port. */
|
|
2192
2186
|
get publicUrl(): string;
|
|
2187
|
+
/** Tenant's preview/base domain, white-label aware. */
|
|
2188
|
+
get previewDomain(): string;
|
|
2193
2189
|
/** Start the computer. */
|
|
2194
2190
|
start(): Promise<Computer>;
|
|
2195
2191
|
/** Stop the computer. */
|
|
@@ -2408,12 +2404,6 @@ interface CronJobCreateParams {
|
|
|
2408
2404
|
name: string;
|
|
2409
2405
|
schedule: string;
|
|
2410
2406
|
idempotencyKey?: string;
|
|
2411
|
-
externalWorkspaceId?: string;
|
|
2412
|
-
external_workspace_id?: string;
|
|
2413
|
-
externalUserId?: string;
|
|
2414
|
-
external_user_id?: string;
|
|
2415
|
-
externalProjectId?: string;
|
|
2416
|
-
external_project_id?: string;
|
|
2417
2407
|
[key: string]: unknown;
|
|
2418
2408
|
}
|
|
2419
2409
|
interface CronJobUpdateParams {
|
|
@@ -2597,7 +2587,7 @@ interface DeploymentData {
|
|
|
2597
2587
|
* with `source_sandbox_id` on the version row. Will become nullable.
|
|
2598
2588
|
*/
|
|
2599
2589
|
repo_url?: string;
|
|
2600
|
-
repo_provider?: "github"
|
|
2590
|
+
repo_provider?: "github";
|
|
2601
2591
|
branch?: string;
|
|
2602
2592
|
build_command?: string | null;
|
|
2603
2593
|
run_command?: string | null;
|
|
@@ -2768,9 +2758,6 @@ interface DeploymentCreateParams extends ExternalAttribution {
|
|
|
2768
2758
|
autoDeploy?: boolean;
|
|
2769
2759
|
database?: DeploymentDatabaseRequest;
|
|
2770
2760
|
metadata?: Record<string, unknown>;
|
|
2771
|
-
/** Pin build and runtime VMs to a specific DC. One of: "us-west", "us-east", "us-mia". */
|
|
2772
|
-
target_region?: string;
|
|
2773
|
-
targetRegion?: string;
|
|
2774
2761
|
idempotencyKey?: string;
|
|
2775
2762
|
}
|
|
2776
2763
|
interface DeploymentUpdateParams {
|
|
@@ -2909,9 +2896,7 @@ declare class Deployments {
|
|
|
2909
2896
|
rollback(deploymentId: string, params?: RollbackParams): Promise<DeploymentData>;
|
|
2910
2897
|
listBuilds(deploymentId: string): Promise<DeploymentBuildData[]>;
|
|
2911
2898
|
getBuild(deploymentId: string, buildId: string): Promise<DeploymentBuildData>;
|
|
2912
|
-
listEnv(deploymentId: string,
|
|
2913
|
-
environment?: string;
|
|
2914
|
-
}): Promise<Record<string, unknown>[]>;
|
|
2899
|
+
listEnv(deploymentId: string): Promise<Record<string, unknown>[]>;
|
|
2915
2900
|
setEnv(deploymentId: string, vars: Record<string, string>, opts?: {
|
|
2916
2901
|
environment?: string;
|
|
2917
2902
|
}): Promise<Record<string, unknown>[]>;
|
|
@@ -3060,12 +3045,6 @@ interface CustomDomainCreateParams {
|
|
|
3060
3045
|
redirect_policy?: "none" | "www_to_apex" | "apex_to_www";
|
|
3061
3046
|
redirectPolicy?: "none" | "www_to_apex" | "apex_to_www";
|
|
3062
3047
|
idempotencyKey?: string;
|
|
3063
|
-
externalWorkspaceId?: string;
|
|
3064
|
-
external_workspace_id?: string;
|
|
3065
|
-
externalUserId?: string;
|
|
3066
|
-
external_user_id?: string;
|
|
3067
|
-
externalProjectId?: string;
|
|
3068
|
-
external_project_id?: string;
|
|
3069
3048
|
[key: string]: unknown;
|
|
3070
3049
|
}
|
|
3071
3050
|
declare class FlatCustomDomains {
|
|
@@ -3113,12 +3092,6 @@ interface FunctionCreateParams {
|
|
|
3113
3092
|
timeoutSec?: number;
|
|
3114
3093
|
env?: Record<string, string>;
|
|
3115
3094
|
idempotencyKey?: string;
|
|
3116
|
-
externalWorkspaceId?: string;
|
|
3117
|
-
external_workspace_id?: string;
|
|
3118
|
-
externalUserId?: string;
|
|
3119
|
-
external_user_id?: string;
|
|
3120
|
-
externalProjectId?: string;
|
|
3121
|
-
external_project_id?: string;
|
|
3122
3095
|
[key: string]: unknown;
|
|
3123
3096
|
}
|
|
3124
3097
|
interface FunctionUpdateParams {
|
|
@@ -3346,7 +3319,7 @@ type TunnelId = string & {
|
|
|
3346
3319
|
type ClusterId = string & {
|
|
3347
3320
|
readonly __brand: "ClusterId";
|
|
3348
3321
|
};
|
|
3349
|
-
type WorkspaceId
|
|
3322
|
+
type WorkspaceId = string & {
|
|
3350
3323
|
readonly __brand: "WorkspaceId";
|
|
3351
3324
|
};
|
|
3352
3325
|
type SecretId = string & {
|
|
@@ -3559,7 +3532,7 @@ interface AppInstallEvent {
|
|
|
3559
3532
|
}
|
|
3560
3533
|
type OcWorkspaceStatus = "creating" | "ready" | "running" | "stopped" | "error";
|
|
3561
3534
|
interface OcWorkspaceData {
|
|
3562
|
-
id: WorkspaceId
|
|
3535
|
+
id: WorkspaceId;
|
|
3563
3536
|
host_id: HostId;
|
|
3564
3537
|
name: string;
|
|
3565
3538
|
repo_url: string | null;
|
|
@@ -3584,7 +3557,7 @@ interface OcWorkspaceListResponse {
|
|
|
3584
3557
|
}
|
|
3585
3558
|
interface OcWorkspaceEvent {
|
|
3586
3559
|
type: string;
|
|
3587
|
-
workspace_id: WorkspaceId
|
|
3560
|
+
workspace_id: WorkspaceId;
|
|
3588
3561
|
data: unknown;
|
|
3589
3562
|
timestamp: string;
|
|
3590
3563
|
}
|
|
@@ -4060,28 +4033,28 @@ declare class OcWorkspaces {
|
|
|
4060
4033
|
/**
|
|
4061
4034
|
* Fetch a single workspace.
|
|
4062
4035
|
*/
|
|
4063
|
-
get(hostId: HostId | string, workspaceId: WorkspaceId
|
|
4036
|
+
get(hostId: HostId | string, workspaceId: WorkspaceId | string): Promise<OcWorkspaceData>;
|
|
4064
4037
|
/**
|
|
4065
4038
|
* Update workspace metadata (name, branch).
|
|
4066
4039
|
*/
|
|
4067
|
-
update(hostId: HostId | string, workspaceId: WorkspaceId
|
|
4040
|
+
update(hostId: HostId | string, workspaceId: WorkspaceId | string, params: OcWorkspaceUpdateParams): Promise<OcWorkspaceData>;
|
|
4068
4041
|
/**
|
|
4069
4042
|
* Delete a workspace.
|
|
4070
4043
|
*/
|
|
4071
|
-
delete(hostId: HostId | string, workspaceId: WorkspaceId
|
|
4044
|
+
delete(hostId: HostId | string, workspaceId: WorkspaceId | string): Promise<void>;
|
|
4072
4045
|
/**
|
|
4073
4046
|
* Pull the latest changes from the remote repository.
|
|
4074
4047
|
*/
|
|
4075
|
-
pull(hostId: HostId | string, workspaceId: WorkspaceId
|
|
4048
|
+
pull(hostId: HostId | string, workspaceId: WorkspaceId | string): Promise<OcWorkspaceData>;
|
|
4076
4049
|
/**
|
|
4077
4050
|
* Open a terminal session scoped to the workspace root directory.
|
|
4078
4051
|
* Returns a short-lived WebSocket ticket.
|
|
4079
4052
|
*/
|
|
4080
|
-
openTerminal(hostId: HostId | string, workspaceId: WorkspaceId
|
|
4053
|
+
openTerminal(hostId: HostId | string, workspaceId: WorkspaceId | string): Promise<WsTicket>;
|
|
4081
4054
|
/**
|
|
4082
4055
|
* Stream workspace setup / clone / install events.
|
|
4083
4056
|
*/
|
|
4084
|
-
events(hostId: HostId | string, workspaceId: WorkspaceId
|
|
4057
|
+
events(hostId: HostId | string, workspaceId: WorkspaceId | string): AsyncIterableIterator<OcWorkspaceEvent>;
|
|
4085
4058
|
}
|
|
4086
4059
|
|
|
4087
4060
|
/**
|
|
@@ -4982,12 +4955,6 @@ interface BucketCreateParams {
|
|
|
4982
4955
|
visibility?: "private" | "public";
|
|
4983
4956
|
quota_bytes?: number;
|
|
4984
4957
|
public?: boolean;
|
|
4985
|
-
externalWorkspaceId?: string;
|
|
4986
|
-
external_workspace_id?: string;
|
|
4987
|
-
externalUserId?: string;
|
|
4988
|
-
external_user_id?: string;
|
|
4989
|
-
externalProjectId?: string;
|
|
4990
|
-
external_project_id?: string;
|
|
4991
4958
|
[key: string]: unknown;
|
|
4992
4959
|
}
|
|
4993
4960
|
interface ObjectListParams {
|
|
@@ -5158,7 +5125,7 @@ declare class OrgInvites {
|
|
|
5158
5125
|
}
|
|
5159
5126
|
|
|
5160
5127
|
/**
|
|
5161
|
-
* Tenant — current tenant info
|
|
5128
|
+
* Tenant — current tenant info and plan/usage.
|
|
5162
5129
|
*/
|
|
5163
5130
|
|
|
5164
5131
|
interface TenantPlan {
|
|
@@ -5168,53 +5135,8 @@ interface TenantPlan {
|
|
|
5168
5135
|
usage?: Record<string, unknown>;
|
|
5169
5136
|
[key: string]: unknown;
|
|
5170
5137
|
}
|
|
5171
|
-
interface PreviewDomainData {
|
|
5172
|
-
domain: string;
|
|
5173
|
-
verified_at?: string | null;
|
|
5174
|
-
cname_target?: string;
|
|
5175
|
-
[key: string]: unknown;
|
|
5176
|
-
}
|
|
5177
|
-
interface PreviewDomainVerifyResult {
|
|
5178
|
-
verified: boolean;
|
|
5179
|
-
target?: string;
|
|
5180
|
-
records?: unknown[];
|
|
5181
|
-
[key: string]: unknown;
|
|
5182
|
-
}
|
|
5183
|
-
interface BrandingData {
|
|
5184
|
-
product_name?: string;
|
|
5185
|
-
logo_url?: string;
|
|
5186
|
-
support_url?: string;
|
|
5187
|
-
support_email?: string;
|
|
5188
|
-
primary_color?: string;
|
|
5189
|
-
background_color?: string;
|
|
5190
|
-
[key: string]: unknown;
|
|
5191
|
-
}
|
|
5192
|
-
declare class PreviewDomain {
|
|
5193
|
-
private readonly http;
|
|
5194
|
-
constructor(http: HttpClient);
|
|
5195
|
-
/** GET /api/v1/tenant/preview-domain → {domain, verified_at, cname_target} */
|
|
5196
|
-
get(): Promise<PreviewDomainData>;
|
|
5197
|
-
/** PUT /api/v1/tenant/preview-domain — set the preview domain. */
|
|
5198
|
-
set(domain: string): Promise<PreviewDomainData>;
|
|
5199
|
-
/** POST /api/v1/tenant/preview-domain/verify → {verified, target, records} */
|
|
5200
|
-
verify(): Promise<PreviewDomainVerifyResult>;
|
|
5201
|
-
/** DELETE /api/v1/tenant/preview-domain */
|
|
5202
|
-
delete(): Promise<void>;
|
|
5203
|
-
}
|
|
5204
|
-
declare class Branding {
|
|
5205
|
-
private readonly http;
|
|
5206
|
-
constructor(http: HttpClient);
|
|
5207
|
-
/** GET /api/v1/tenant/branding */
|
|
5208
|
-
get(): Promise<BrandingData>;
|
|
5209
|
-
/** PUT /api/v1/tenant/branding — keys: product_name, logo_url, support_url, support_email, primary_color, background_color */
|
|
5210
|
-
set(branding: BrandingData): Promise<BrandingData>;
|
|
5211
|
-
/** DELETE /api/v1/tenant/branding */
|
|
5212
|
-
delete(): Promise<void>;
|
|
5213
|
-
}
|
|
5214
5138
|
declare class Tenant {
|
|
5215
5139
|
private readonly http;
|
|
5216
|
-
readonly preview_domain: PreviewDomain;
|
|
5217
|
-
readonly branding: Branding;
|
|
5218
5140
|
constructor(http: HttpClient);
|
|
5219
5141
|
/** Get the current tenant's plan, limits, and live usage counters. */
|
|
5220
5142
|
current(): Promise<TenantPlan>;
|
|
@@ -5290,12 +5212,6 @@ interface VolumeCreateParams {
|
|
|
5290
5212
|
sizeGb?: number;
|
|
5291
5213
|
region?: string;
|
|
5292
5214
|
idempotencyKey?: string;
|
|
5293
|
-
externalWorkspaceId?: string;
|
|
5294
|
-
external_workspace_id?: string;
|
|
5295
|
-
externalUserId?: string;
|
|
5296
|
-
external_user_id?: string;
|
|
5297
|
-
externalProjectId?: string;
|
|
5298
|
-
external_project_id?: string;
|
|
5299
5215
|
[key: string]: unknown;
|
|
5300
5216
|
}
|
|
5301
5217
|
declare class Volumes {
|
|
@@ -5373,16 +5289,6 @@ declare class Webhooks {
|
|
|
5373
5289
|
idempotencyKey?: string;
|
|
5374
5290
|
}): Promise<Record<string, unknown>>;
|
|
5375
5291
|
deliveries(webhookId: string): Promise<WebhookDeliveryData[]>;
|
|
5376
|
-
/**
|
|
5377
|
-
* Verify an incoming ``X-Miosa-Signature`` header.
|
|
5378
|
-
*
|
|
5379
|
-
* Header format: ``t=<unix_ts>,v1=<hex_hmac>``
|
|
5380
|
-
* HMAC body: ``<t>.<raw_payload>``
|
|
5381
|
-
*
|
|
5382
|
-
* Throws if timestamp is older than 5 minutes.
|
|
5383
|
-
* Returns true if signature matches.
|
|
5384
|
-
*/
|
|
5385
|
-
static verifySignature(payload: string | Uint8Array, signatureHeader: string, secret: string): boolean;
|
|
5386
5292
|
}
|
|
5387
5293
|
|
|
5388
5294
|
/**
|
|
@@ -5599,121 +5505,6 @@ declare class WorkspaceInvites {
|
|
|
5599
5505
|
accept(token: string): Promise<AcceptWorkspaceInviteResponse>;
|
|
5600
5506
|
}
|
|
5601
5507
|
|
|
5602
|
-
/**
|
|
5603
|
-
* Workspaces resource — top-level tenant workspaces grouping computers.
|
|
5604
|
-
*
|
|
5605
|
-
* A workspace is a logical bucket of computers (handy for teams / projects).
|
|
5606
|
-
* Accessed via `miosa.workspaces` on the top-level client.
|
|
5607
|
-
*
|
|
5608
|
-
* @example
|
|
5609
|
-
* ```ts
|
|
5610
|
-
* const ws = await miosa.workspaces.create({ name: "prod" });
|
|
5611
|
-
* const computers = await miosa.workspaces.listComputers(ws.id);
|
|
5612
|
-
* ```
|
|
5613
|
-
*/
|
|
5614
|
-
|
|
5615
|
-
type WorkspaceId = string & {
|
|
5616
|
-
readonly __brand: "WorkspaceId";
|
|
5617
|
-
};
|
|
5618
|
-
interface WorkspaceData {
|
|
5619
|
-
id: WorkspaceId;
|
|
5620
|
-
tenant_id: string;
|
|
5621
|
-
name: string;
|
|
5622
|
-
slug?: string | null;
|
|
5623
|
-
description?: string | null;
|
|
5624
|
-
metadata?: Record<string, unknown> | null;
|
|
5625
|
-
settings?: Record<string, unknown> | null;
|
|
5626
|
-
created_at?: string;
|
|
5627
|
-
updated_at?: string;
|
|
5628
|
-
[key: string]: unknown;
|
|
5629
|
-
}
|
|
5630
|
-
interface WorkspaceCreateParams {
|
|
5631
|
-
name: string;
|
|
5632
|
-
slug?: string;
|
|
5633
|
-
description?: string;
|
|
5634
|
-
metadata?: Record<string, unknown>;
|
|
5635
|
-
}
|
|
5636
|
-
interface WorkspaceUpdateParams {
|
|
5637
|
-
name?: string;
|
|
5638
|
-
description?: string;
|
|
5639
|
-
metadata?: Record<string, unknown>;
|
|
5640
|
-
}
|
|
5641
|
-
interface WorkspaceComputerTemplateCreateParams {
|
|
5642
|
-
name: string;
|
|
5643
|
-
templateType?: string;
|
|
5644
|
-
template_type?: string;
|
|
5645
|
-
description?: string;
|
|
5646
|
-
[key: string]: unknown;
|
|
5647
|
-
}
|
|
5648
|
-
declare class Workspaces {
|
|
5649
|
-
private readonly http;
|
|
5650
|
-
constructor(http: HttpClient);
|
|
5651
|
-
/**
|
|
5652
|
-
* Create a new workspace.
|
|
5653
|
-
*/
|
|
5654
|
-
create(params: WorkspaceCreateParams): Promise<WorkspaceData>;
|
|
5655
|
-
/**
|
|
5656
|
-
* List all workspaces visible to the current credential.
|
|
5657
|
-
*/
|
|
5658
|
-
list(): Promise<WorkspaceData[]>;
|
|
5659
|
-
/**
|
|
5660
|
-
* Get a single workspace by ID.
|
|
5661
|
-
*/
|
|
5662
|
-
get(id: WorkspaceId | string): Promise<WorkspaceData>;
|
|
5663
|
-
/**
|
|
5664
|
-
* Update a workspace's metadata.
|
|
5665
|
-
*/
|
|
5666
|
-
update(id: WorkspaceId | string, params: WorkspaceUpdateParams): Promise<WorkspaceData>;
|
|
5667
|
-
/**
|
|
5668
|
-
* Delete a workspace. Does not delete member computers.
|
|
5669
|
-
*/
|
|
5670
|
-
delete(id: WorkspaceId | string): Promise<void>;
|
|
5671
|
-
/**
|
|
5672
|
-
* Update workspace-level settings.
|
|
5673
|
-
*/
|
|
5674
|
-
updateSettings(id: WorkspaceId | string, settings: Record<string, unknown>): Promise<WorkspaceData>;
|
|
5675
|
-
/**
|
|
5676
|
-
* List all computers that belong to the given workspace.
|
|
5677
|
-
*/
|
|
5678
|
-
listComputers(id: WorkspaceId | string): Promise<Computer[]>;
|
|
5679
|
-
/**
|
|
5680
|
-
* List all sandboxes that belong to this workspace.
|
|
5681
|
-
*/
|
|
5682
|
-
listSandboxes(id: WorkspaceId | string): Promise<Record<string, unknown>[]>;
|
|
5683
|
-
/**
|
|
5684
|
-
* List all deployments that belong to this workspace.
|
|
5685
|
-
*/
|
|
5686
|
-
listDeployments(id: WorkspaceId | string): Promise<Record<string, unknown>[]>;
|
|
5687
|
-
/**
|
|
5688
|
-
* List all managed databases that belong to this workspace.
|
|
5689
|
-
*/
|
|
5690
|
-
listDatabases(id: WorkspaceId | string): Promise<Record<string, unknown>[]>;
|
|
5691
|
-
/**
|
|
5692
|
-
* List all projects that belong to this workspace.
|
|
5693
|
-
*/
|
|
5694
|
-
listProjects(id: WorkspaceId | string): Promise<Record<string, unknown>[]>;
|
|
5695
|
-
/**
|
|
5696
|
-
* Return aggregate resource stats for this workspace.
|
|
5697
|
-
*/
|
|
5698
|
-
stats(id: WorkspaceId | string): Promise<Record<string, unknown>>;
|
|
5699
|
-
/**
|
|
5700
|
-
* Return metered usage data for this workspace.
|
|
5701
|
-
*/
|
|
5702
|
-
usage(id: WorkspaceId | string): Promise<Record<string, unknown>>;
|
|
5703
|
-
/**
|
|
5704
|
-
* Return activity feed for this workspace.
|
|
5705
|
-
*/
|
|
5706
|
-
activity(id: WorkspaceId | string): Promise<Record<string, unknown>[]>;
|
|
5707
|
-
/**
|
|
5708
|
-
* List computer templates available in this workspace.
|
|
5709
|
-
*/
|
|
5710
|
-
listComputerTemplates(id: WorkspaceId | string): Promise<Record<string, unknown>[]>;
|
|
5711
|
-
/**
|
|
5712
|
-
* Create a computer template scoped to this workspace.
|
|
5713
|
-
*/
|
|
5714
|
-
createComputerTemplate(id: WorkspaceId | string, params: WorkspaceComputerTemplateCreateParams): Promise<Record<string, unknown>>;
|
|
5715
|
-
}
|
|
5716
|
-
|
|
5717
5508
|
/**
|
|
5718
5509
|
* The top-level MIOSA client.
|
|
5719
5510
|
*
|
|
@@ -5728,8 +5519,6 @@ declare class Workspaces {
|
|
|
5728
5519
|
* ```
|
|
5729
5520
|
*/
|
|
5730
5521
|
declare class Miosa {
|
|
5731
|
-
/** Workspace CRUD — create, list, get, update, delete, and sub-resource queries. */
|
|
5732
|
-
readonly workspaces: Workspaces;
|
|
5733
5522
|
/** Per-workspace user roster — list, add, update role, remove. */
|
|
5734
5523
|
readonly workspaceMembers: WorkspaceMembers;
|
|
5735
5524
|
/**
|
|
@@ -5877,4 +5666,4 @@ declare class NetworkError extends MiosaError {
|
|
|
5877
5666
|
constructor(message: string, cause: Error);
|
|
5878
5667
|
}
|
|
5879
5668
|
|
|
5880
|
-
export { type AcceptOrgInviteResponse, type AcceptWorkspaceInviteResponse, type AddDomainParams, type AddWorkspaceMemberParams, Admin, type AgentDispatchParams, type AgentEvent$1 as AgentEvent, type AgentEventType, type AgentSessionCreateParams, type AgentSessionData, type AgentSessionListResponse$1 as AgentSessionListResponse, type AgentSessionStatus$1 as AgentSessionStatus, type AllowParams, Analytics, type AnalyticsFilters, type ApiKeyCreateParams, type ApiKeyCreateResult, type ApiKeyData, type ApiKeyId, type ApiKeyListParams, ApiKeys, type AppCatalogEntry, type AppInstallData, type AppInstallEvent, type AuditListParams, AuditLog, type AuditLogEvent, type AuditLogListParams, type AuditTailParams, AuthError, type BenchmarkCompareParams, type BenchmarkCreateParams, Benchmarks, type BindingCreateParams, type BindingListParams, type BrandingUpdateParams, type BucketCreateParams, type BucketData, type BucketId, type BuilderSessionListParams, BuilderSessions, type BulkUserActionParams, type ChannelCreateParams, type ChannelData, type ChannelListParams, type ChannelUpdateParams, Channels, type ChatCompletionCreateParams, type ChatCompletionCreateStreamParams, Checkpoints, type ClickParams, type ClusterCreateParams, type ClusterData, type ClusterEvent, type ClusterId, type ClusterListResponse, type ClusterStatus, CommandCenter, Community, type CompletionCreateParams, type CompletionCreateStreamParams, Completions, Computer, ComputerAudit, ComputerAutoStop, type ComputerCreateParams, type ComputerData, ComputerEnv, type ComputerId, ComputerInbox, type ComputerListParams, type ComputerListResponse, ComputerLogs, type ComputerLogsGetParams, ComputerNetwork, ComputerOsa, ComputerPorts, ComputerSecrets, type ComputerSize, type ComputerStatus, type ComputerTemplateType, ComputerTerminal, type ComputerUpdateParams, type ComputerVisibility, ComputerVolumes, Computers, type CopyParams, type CreateAdminApiKeyParams, type CreateOrgInviteParams, type CreateWorkspaceInviteParams, type CreateWorkspaceInviteResponse, type CreditBalance, type CreditTransaction, type CreditTransactionListResponse, type CreditUsage, Credits, type CronJobCreateParams, type CronJobData, type CronJobExecutionData, type CronJobExecutionId, type CronJobId, type CronJobListParams, type CronJobUpdateParams, CronJobs, type CursorInfo, type CustomDomainCreateParams, type CustomDomainData, type CustomDomainId, type CustomDomainListParams, Dashboard, type DashboardSummary, type DatabaseCreateParams, type DatabaseCredentials, type DatabaseData, type DatabaseId, type DatabaseListParams, type DatabaseLogsParams, type DatabaseLogsResult, Databases, type DeploymentBuildData, type DeploymentCreateParams, type DeploymentData, DeploymentDomains, type DeploymentId, type DeploymentListParams, type DeploymentReleaseData, type DeploymentReleaseId, DeploymentReleases, DeploymentRuntimeInstances, type DeploymentServiceData, type DeploymentServiceId, type DeploymentServiceType, type DeploymentSourceType, type DeploymentState, type DeploymentUpdateParams, type DeploymentVersionData, type DeploymentVersionId, type DeploymentVersionKind, type DeploymentVersionState, DeploymentVersions, Deployments, Desktop$1 as Desktop, type DesktopActionResult, type DirEntry, type DirListResult, type DiscordSendTestParams, type DoubleClickParams, type DragParams, type EgressAllowlistRule, EgressAudit, type EgressAuditEvent, type EgressBindingData, EgressNetwork, type EgressPolicyData, type EgressPolicyMode, type EgressRuleEffect, type EgressSecretData, type EgressSecretScope, type EgressSecretType, EgressSecrets, type EgressSuggestion, Email, EmailCampaigns, EmailInbox, EmailTemplates, type EmbeddingCreateParams, Embeddings, Exec, type ExecParams, type ExecPythonParams, type ExecResult, type ExternalAttribution, type ExternalKeyCreateParams, type ExternalKeyData, ExternalKeys, type FileDeleteParams, type FileDownloadParams, type FileEntry, type FileExportParams, type FileExportResult, type FileListParams, type FileListResult, type FileStat, Files, FlatCustomDomains, type FsEntry, type FsListResponse, type FsStat, type FunctionCreateParams, type FunctionData, type FunctionId, type FunctionInvokeParams, type FunctionListParams, type FunctionUpdateParams, Functions, type GithubRepo, type GithubSshKey, type HealthCheckCreateParams, type HealthCheckData, type HealthCheckId, type HealthCheckListParams, type HealthCheckUpdateParams, HealthChecks, type HostCreateParams, type HostData, type HostEvent, type HostId, type HostListResponse, type HostStatus, type HostUpdateParams, InsufficientCreditsError, type IntegrationCatalogEntry, type IntegrationData, Integrations, type JobData, type JobEvent, type JobEventType, type JobId, type JobListResponse, type JobRunParams, type JobStatus, type KeyParams, type LaunchParams, type LinearCreateIssueParams, type ListAdminApiKeysParams, type ListAdminComputersParams, type ListAdminTenantsParams, type ListAdminUsersParams, Mcp, type McpDispatchParams, Miosa, type MiosaClientConfig, MiosaError, type MkdirParams, type ModeParams, Models, type MouseButton, NetworkError, NetworkPolicy, type NetworkPolicyData, type NetworkPolicyEffect, type NetworkPolicyProtocol, type NetworkPolicyRule, type NetworkPolicySetParams, NotFoundError, type NotificationPrefsUpdateParams, OAuthFlow, type OauthConnectParams, type OauthProvider, type OauthStartResult, type OauthStatusResult, type ObjectListParams, type AgentEvent as OcAgentEvent, type OcAgentSessionData, type AgentSessionListResponse as OcAgentSessionListResponse, type OcWorkspaceCreateParams, type OcWorkspaceData, type OcWorkspaceEvent, type OcWorkspaceListResponse, type OcWorkspaceStatus, type OcWorkspaceUpdateParams, OpenComputers, type OrgInvite, type OrgInviteCreated, type OrgInviteCreatedResponse, type OrgInviteListResponse, type OrgInvitePreview, type OrgInviteRevokeResponse, OrgInvites, type OrgRole, type OverviewData, type PolicyCreateParams, type PolicyListParams, type PolicyUpdateParams, type PresignParams, type PresignResult, ProjectAuth, type ProjectAuthEnableParams, type ProjectAuthStatus, type ProjectAuthUpdateParams, type ProjectIntegrationCatalogEntry, type ProjectIntegrationCreateParams, type ProjectIntegrationData, type ProjectIntegrationListParams, type ProjectIntegrationUpdateParams, ProjectIntegrations, ProviderDefaults, type ProviderKeyUpsertParams, type PublishFromSandboxParams, type PublishParams, type PublishResult, RateLimitError, type RegionData, Regions, type RollbackParams, type RulesListParams, type RuntimeInstanceData, type RuntimeInstanceId, type RuntimeInstanceState, type RuntimeLogsResult, SANDBOX_TEMPLATE, Sandbox, SandboxArtifacts, SandboxAudit, type SandboxBuildSpec, type SandboxBuildSpecError, type SandboxBuildSpecValidation, SandboxCommands, type SandboxCreateParams, type SandboxData, SandboxEnv, SandboxEvents, type SandboxExecOptions, type SandboxExecResult, SandboxFiles, type SandboxId, type SandboxListParams, SandboxNetwork, SandboxPreview, SandboxPreviews, SandboxSecrets, type SandboxState, SandboxTags, type SandboxTemplate, type SandboxTemplateBuild, type SandboxTemplateBuildCreateParams, type SandboxTemplateBuildResourceData, type SandboxTemplateBuildResourceId, type SandboxTemplateCreateParams, type SandboxTemplateList, type SandboxTemplateListParams, type SandboxTemplateResourceData, type SandboxTemplateResourceId, SandboxTemplates, SandboxTerminal, Sandboxes, ScopedFs, type ScrollDirection, type ScrollParams, type SecretCreateParams, type SecretData, type SecretId, type SecretListParams, type SecretRotateParams, type SecretSetParams, type SecretUpdateParams, type SessionId, Settings, type SettingsUpdateParams, type SizeData, type SlackSendTestParams, type SnapshotCreateParams, type SnapshotData, type SnapshotListResponse, type SnapshotProgressEvent, type SnapshotRestoreResult, type SnapshotStatus, SnapshotsStandalone, Storage, type StorageObjectData, type SuggestionsParams, type TemplateBuildCreateParams, type TemplateCreateParams, type TemplateData, Tenant, type TenantId, type TenantPlan, type TenantSummary, type
|
|
5669
|
+
export { type AcceptOrgInviteResponse, type AcceptWorkspaceInviteResponse, type AddDomainParams, type AddWorkspaceMemberParams, Admin, type AgentDispatchParams, type AgentEvent$1 as AgentEvent, type AgentEventType, type AgentSessionCreateParams, type AgentSessionData, type AgentSessionListResponse$1 as AgentSessionListResponse, type AgentSessionStatus$1 as AgentSessionStatus, type AllowParams, Analytics, type AnalyticsFilters, type ApiKeyCreateParams, type ApiKeyCreateResult, type ApiKeyData, type ApiKeyId, type ApiKeyListParams, ApiKeys, type AppCatalogEntry, type AppInstallData, type AppInstallEvent, type AuditListParams, AuditLog, type AuditLogEvent, type AuditLogListParams, type AuditTailParams, AuthError, type BenchmarkCompareParams, type BenchmarkCreateParams, Benchmarks, type BindingCreateParams, type BindingListParams, type BrandingUpdateParams, type BucketCreateParams, type BucketData, type BucketId, type BuilderSessionListParams, BuilderSessions, type BulkUserActionParams, type ChannelCreateParams, type ChannelData, type ChannelListParams, type ChannelUpdateParams, Channels, type ChatCompletionCreateParams, type ChatCompletionCreateStreamParams, Checkpoints, type ClickParams, type ClusterCreateParams, type ClusterData, type ClusterEvent, type ClusterId, type ClusterListResponse, type ClusterStatus, CommandCenter, Community, type CompletionCreateParams, type CompletionCreateStreamParams, Completions, Computer, ComputerAudit, ComputerAutoStop, type ComputerCreateParams, type ComputerData, ComputerEnv, type ComputerId, ComputerInbox, type ComputerListParams, type ComputerListResponse, ComputerLogs, type ComputerLogsGetParams, ComputerNetwork, ComputerOsa, ComputerPorts, ComputerSecrets, type ComputerSize, type ComputerStatus, type ComputerTemplateType, ComputerTerminal, type ComputerUpdateParams, type ComputerVisibility, ComputerVolumes, Computers, type CopyParams, type CreateAdminApiKeyParams, type CreateOrgInviteParams, type CreateWorkspaceInviteParams, type CreateWorkspaceInviteResponse, type CreditBalance, type CreditTransaction, type CreditTransactionListResponse, type CreditUsage, Credits, type CronJobCreateParams, type CronJobData, type CronJobExecutionData, type CronJobExecutionId, type CronJobId, type CronJobListParams, type CronJobUpdateParams, CronJobs, type CursorInfo, type CustomDomainCreateParams, type CustomDomainData, type CustomDomainId, type CustomDomainListParams, Dashboard, type DashboardSummary, type DatabaseCreateParams, type DatabaseCredentials, type DatabaseData, type DatabaseId, type DatabaseListParams, type DatabaseLogsParams, type DatabaseLogsResult, Databases, type DeploymentBuildData, type DeploymentCreateParams, type DeploymentData, DeploymentDomains, type DeploymentId, type DeploymentListParams, type DeploymentReleaseData, type DeploymentReleaseId, DeploymentReleases, DeploymentRuntimeInstances, type DeploymentServiceData, type DeploymentServiceId, type DeploymentServiceType, type DeploymentSourceType, type DeploymentState, type DeploymentUpdateParams, type DeploymentVersionData, type DeploymentVersionId, type DeploymentVersionKind, type DeploymentVersionState, DeploymentVersions, Deployments, Desktop$1 as Desktop, type DesktopActionResult, type DirEntry, type DirListResult, type DiscordSendTestParams, type DoubleClickParams, type DragParams, type EgressAllowlistRule, EgressAudit, type EgressAuditEvent, type EgressBindingData, EgressNetwork, type EgressPolicyData, type EgressPolicyMode, type EgressRuleEffect, type EgressSecretData, type EgressSecretScope, type EgressSecretType, EgressSecrets, type EgressSuggestion, Email, EmailCampaigns, EmailInbox, EmailTemplates, type EmbeddingCreateParams, Embeddings, Exec, type ExecParams, type ExecPythonParams, type ExecResult, type ExternalAttribution, type ExternalKeyCreateParams, type ExternalKeyData, ExternalKeys, type FileDeleteParams, type FileDownloadParams, type FileEntry, type FileExportParams, type FileExportResult, type FileListParams, type FileListResult, type FileStat, Files, FlatCustomDomains, type FsEntry, type FsListResponse, type FsStat, type FunctionCreateParams, type FunctionData, type FunctionId, type FunctionInvokeParams, type FunctionListParams, type FunctionUpdateParams, Functions, type GithubRepo, type GithubSshKey, type HealthCheckCreateParams, type HealthCheckData, type HealthCheckId, type HealthCheckListParams, type HealthCheckUpdateParams, HealthChecks, type HostCreateParams, type HostData, type HostEvent, type HostId, type HostListResponse, type HostStatus, type HostUpdateParams, InsufficientCreditsError, type IntegrationCatalogEntry, type IntegrationData, Integrations, type JobData, type JobEvent, type JobEventType, type JobId, type JobListResponse, type JobRunParams, type JobStatus, type KeyParams, type LaunchParams, type LinearCreateIssueParams, type ListAdminApiKeysParams, type ListAdminComputersParams, type ListAdminTenantsParams, type ListAdminUsersParams, Mcp, type McpDispatchParams, Miosa, type MiosaClientConfig, MiosaError, type MkdirParams, type ModeParams, Models, type MouseButton, NetworkError, NetworkPolicy, type NetworkPolicyData, type NetworkPolicyEffect, type NetworkPolicyProtocol, type NetworkPolicyRule, type NetworkPolicySetParams, NotFoundError, type NotificationPrefsUpdateParams, OAuthFlow, type OauthConnectParams, type OauthProvider, type OauthStartResult, type OauthStatusResult, type ObjectListParams, type AgentEvent as OcAgentEvent, type OcAgentSessionData, type AgentSessionListResponse as OcAgentSessionListResponse, type OcWorkspaceCreateParams, type OcWorkspaceData, type OcWorkspaceEvent, type OcWorkspaceListResponse, type OcWorkspaceStatus, type OcWorkspaceUpdateParams, OpenComputers, type OrgInvite, type OrgInviteCreated, type OrgInviteCreatedResponse, type OrgInviteListResponse, type OrgInvitePreview, type OrgInviteRevokeResponse, OrgInvites, type OrgRole, type OverviewData, type PolicyCreateParams, type PolicyListParams, type PolicyUpdateParams, type PresignParams, type PresignResult, ProjectAuth, type ProjectAuthEnableParams, type ProjectAuthStatus, type ProjectAuthUpdateParams, type ProjectIntegrationCatalogEntry, type ProjectIntegrationCreateParams, type ProjectIntegrationData, type ProjectIntegrationListParams, type ProjectIntegrationUpdateParams, ProjectIntegrations, ProviderDefaults, type ProviderKeyUpsertParams, type PublishFromSandboxParams, type PublishParams, type PublishResult, RateLimitError, type RegionData, Regions, type RollbackParams, type RulesListParams, type RuntimeInstanceData, type RuntimeInstanceId, type RuntimeInstanceState, type RuntimeLogsResult, SANDBOX_TEMPLATE, Sandbox, SandboxArtifacts, SandboxAudit, type SandboxBuildSpec, type SandboxBuildSpecError, type SandboxBuildSpecValidation, SandboxCommands, type SandboxCreateParams, type SandboxData, SandboxEnv, SandboxEvents, type SandboxExecOptions, type SandboxExecResult, SandboxFiles, type SandboxId, type SandboxListParams, SandboxNetwork, SandboxPreview, SandboxPreviews, SandboxSecrets, type SandboxState, SandboxTags, type SandboxTemplate, type SandboxTemplateBuild, type SandboxTemplateBuildCreateParams, type SandboxTemplateBuildResourceData, type SandboxTemplateBuildResourceId, type SandboxTemplateCreateParams, type SandboxTemplateList, type SandboxTemplateListParams, type SandboxTemplateResourceData, type SandboxTemplateResourceId, SandboxTemplates, SandboxTerminal, Sandboxes, ScopedFs, type ScrollDirection, type ScrollParams, type SecretCreateParams, type SecretData, type SecretId, type SecretListParams, type SecretRotateParams, type SecretSetParams, type SecretUpdateParams, type SessionId, Settings, type SettingsUpdateParams, type SizeData, type SlackSendTestParams, type SnapshotCreateParams, type SnapshotData, type SnapshotListResponse, type SnapshotProgressEvent, type SnapshotRestoreResult, type SnapshotStatus, SnapshotsStandalone, Storage, type StorageObjectData, type SuggestionsParams, type TemplateBuildCreateParams, type TemplateCreateParams, type TemplateData, Tenant, type TenantId, type TenantPlan, type TenantSummary, type TerminalCreateParams, TimeoutError, type TimeseriesParams, type TunnelAuthMode, type TunnelCreateParams, type TunnelData, type TunnelId, type TunnelListResponse, type TunnelUpdateParams, type TypeParams, type UpdateWorkspaceMemberRoleParams, Usage, type UsageReportParams, type UsageSession, type UsageSessionsParams, type UsageSummary, ValidationError, type VersionListParams, type VolumeCreateParams, type VolumeData, type VolumeId, type VolumeListParams, Volumes, type WaitParams, type WebhookCreateParams, type WebhookData, type WebhookDeliveryData, type WebhookDeliveryId, type WebhookId, type WebhookListParams, type WebhookUpdateParams, Webhooks, type WindowFocusParams, type WindowInfo, type WorkspaceId, type WorkspaceInvite, type WorkspaceInviteCreatedResponse, type WorkspaceInviteListResponse, type WorkspaceInvitePreview, type WorkspaceInviteRevokeResponse, WorkspaceInvites, type WorkspaceMember, type WorkspaceMemberAddedResponse, type WorkspaceMemberDeleteResponse, type WorkspaceMemberListResponse, type WorkspaceMemberRecord, type WorkspaceMemberRecordResponse, WorkspaceMembers, type WorkspaceRole, type WsTicket };
|