@pablofdezr/microvm 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,133 @@
+# microvm
+
+TypeScript client for the microvm daemon: run untrusted code in Firecracker
+microVMs. ESM, Node ≥ 18, zero runtime dependencies (it uses the built-in
+`fetch`). Types are generated from the same OpenAPI spec as the server.
+
+```
+npm install @pablofdezr/microvm
+```
+
+## Quick start
+
+```ts
+import { Client } from "@pablofdezr/microvm";
+
+const client = new Client("http://127.0.0.1:8080", { token });
+
+const sb = await client.sandboxes.create({ image: "python" });
+try {
+  const exe = await client.run(sb.id, "python3", ["-c", "print('hi')"]);
+  console.log(exe.stdout);
+} finally {
+  await client.sandboxes.delete(sb.id);
+}
+```
+
+## Sandboxes vs tasks
+
+- **Sandbox** — you hold a VM and run commands in it. `create` throws a capacity
+  error when the node is full (`err.isCapacity`), so backpressure is yours.
+- **Task** — you hand work to the fleet; it never fails for capacity and waits
+  for a slot on any node, sized to the CPU and memory you request.
+
+```ts
+const task = await client.tasks.create({
+  image: "python",
+  cmd: "python3",
+  args: ["-c", "print(2 + 2)"],
+  vcpus: 2,
+  mem_mib: 1024,
+  priority: 7, // 0-10, higher first
+});
+const done = await client.tasks.wait(task.id);
+console.log(done.stdout);
+```
+
+Optional fields are plain optional properties — no pointer wrappers.
+
+A task has no live sandbox to upload to first, so its files travel inside
+`create`, keyed by path and written before `cmd` runs. Pass the content as text
+or bytes — it is base64-encoded for you, exactly as `files.write` does:
+
+```ts
+await client.tasks.create({
+  image: "python",
+  cmd: "python3",
+  args: ["/app/main.py"],
+  files: { "/app/main.py": 'print("hi")' },
+});
+```
+
+## Streaming output
+
+```ts
+for await (const frame of client.executions.stream(sb.id, exe.id)) {
+  process.stdout.write(frame.data);
+}
+```
+
+## Pagination
+
+`all` is an async iterator that follows `has_more` to the end:
+
+```ts
+for await (const sb of client.sandboxes.all({})) {
+  console.log(sb.id, sb.state);
+}
+```
+
+`client.executions.all(sandboxId, {})` works the same way.
+
+## Retries
+
+Transient failures — a network error, or a 429/500/502/503/504 — are retried
+with exponential backoff, full jitter, and any `Retry-After` honoured. Only
+idempotent requests are retried: GET/PUT/DELETE always, and POST only when it
+carries an idempotency key.
+
+```ts
+const client = new Client(baseURL, { token, maxRetries: 4 }); // default 2, 0 disables
+
+await client.tasks.create(params, { idempotencyKey: crypto.randomUUID() });
+```
+
+## Errors
+
+Failures are `APIError` with the API's `type`, `code`, `message`, `param` and
+`requestId`. Branch on the guards:
+
+```ts
+try {
+  await client.sandboxes.retrieve(id);
+} catch (e) {
+  if (e instanceof APIError) {
+    if (e.isNotFound) { /* 404 */ }
+    if (e.isCapacity) { /* node full — consider a task */ }
+    if (e.isConflict) { /* e.g. executing in a stopped sandbox */ }
+    if (e.isForbidden) { /* key lacks permission (admin-only route) */ }
+  }
+}
+```
+
+## Observability
+
+`onResponse` is called once per HTTP attempt — retries included:
+
+```ts
+new Client(baseURL, {
+  token,
+  onResponse: (info) =>
+    console.log(`${info.method} ${info.path} attempt=${info.attempt} status=${info.status} ${info.durationMs}ms`),
+});
+```
+
+## Tenants (admin)
+
+Setting a tenant's storage policy needs an admin token; an ordinary key gets a
+403 (`err.isForbidden`).
+
+```ts
+await admin.tenants.setLimit(tenantId, 500 * 1024 * 1024, "evict"); // or "preserve"
+const t = await admin.tenants.retrieve(tenantId); // policy + live usage
+```

package/dist/client.d.ts

@@ -0,0 +1,335 @@
+/**
+ * The TypeScript client for the microvm API.
+ *
+ * The resource types in `types.gen.ts` are generated from `api/openapi.yaml`,
+ * the same file the server and the Go SDK are generated from. What is written
+ * here by hand is only what a generator does badly: the transport, typed
+ * errors, streaming, auto-pagination, and the few helpers that turn three calls
+ * into one.
+ *
+ * ```ts
+ * const client = new Client("http://127.0.0.1:8080", { token });
+ *
+ * const sb = await client.sandboxes.create({ image: "python" });
+ * try {
+ *   await client.files.write(sb.id, "main.py", 'print("hello")');
+ *   const exe = await client.run(sb.id, "python3", ["main.py"]);
+ *   console.log(exe.stdout);
+ * } finally {
+ *   await client.sandboxes.delete(sb.id);
+ * }
+ * ```
+ */
+import type { components } from "./types.gen.js";
+type Schemas = components["schemas"];
+export type Sandbox = Schemas["Sandbox"];
+export type SandboxList = Schemas["SandboxList"];
+export type SandboxState = Schemas["SandboxState"];
+export type SandboxCreateParams = Schemas["SandboxCreateParams"];
+export type Execution = Schemas["Execution"];
+export type ExecutionList = Schemas["ExecutionList"];
+export type ExecutionStatus = Schemas["ExecutionStatus"];
+export type ExecutionCreateParams = Schemas["ExecutionCreateParams"];
+export type ExecutionCancelParams = Schemas["ExecutionCancelParams"];
+export type File = Schemas["File"];
+export type Task = Schemas["Task"];
+export type TaskStatus = Schemas["TaskStatus"];
+export type TaskCreateParams = Omit<Schemas["TaskCreateParams"], "files"> & {
+    /**
+     * Files written into the sandbox before `cmd` runs, keyed by path. Pass the
+     * content as text or raw bytes; it is base64-encoded for you, exactly as
+     * `files.write` does — the wire form is base64, but that is not the caller's
+     * job to produce here any more than it is there.
+     */
+    files?: Record<string, string | Uint8Array>;
+};
+export type Queue = Schemas["Queue"];
+export type Image = Schemas["Image"];
+export type ImageList = Schemas["ImageList"];
+export type Tenant = Schemas["Tenant"];
+export type TenantList = Schemas["TenantList"];
+export type TenantUpdateParams = Schemas["TenantUpdateParams"];
+export type TenantFullPolicy = Schemas["TenantFullPolicy"];
+export type Health = Schemas["Health"];
+export type Frame = Schemas["Frame"];
+export type ErrorType = Schemas["ErrorType"];
+/** How long an ordinary request may take. Streams and waits opt out. */
+export declare const DEFAULT_TIMEOUT_MS = 30000;
+/** Where a daemon listens unless told otherwise. */
+export declare const DEFAULT_BASE_URL = "http://127.0.0.1:8080";
+/** This SDK's version, sent in the User-Agent. */
+export declare const SDK_VERSION = "0.1.0";
+/** How many times a transient failure is retried unless told otherwise. */
+export declare const DEFAULT_MAX_RETRIES = 2;
+/** What an onResponse observer is told about one HTTP attempt. */
+export interface RequestInfo {
+    method: string;
+    path: string;
+    /** 1 for the first try, 2 for the first retry, ... */
+    attempt: number;
+    /** 0 when the request never got a response. */
+    status: number;
+    error?: unknown;
+    durationMs: number;
+}
+export interface ClientOptions {
+    token?: string;
+    /** Overrides the global fetch, for tests or a custom agent. */
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+    /**
+     * How many times a transient failure -- a network error, or a
+     * 429/500/502/503/504 -- is retried before it is thrown, with exponential
+     * backoff and jitter and any Retry-After honoured. Only idempotent requests
+     * are retried: GET/PUT/DELETE always, POST only with an idempotency key.
+     * Defaults to DEFAULT_MAX_RETRIES; 0 disables.
+     */
+    maxRetries?: number;
+    /** Called once per HTTP attempt -- retries included -- for logging or metrics. */
+    onResponse?: (info: RequestInfo) => void;
+}
+/** Per-call options. */
+export interface RequestOptions {
+    signal?: AbortSignal;
+    /**
+     * Makes a create safe to retry.
+     *
+     * A request whose reply never arrived cannot be known to have failed, so a
+     * bare retry may run the work twice. With a key, the retry returns the
+     * original answer instead.
+     */
+    idempotencyKey?: string;
+}
+/**
+ * An error the API reported.
+ *
+ * `type` is what to branch on: it says what class of thing went wrong and so
+ * what to do about it. `code` says exactly which thing, for when that matters.
+ */
+export declare class APIError extends Error {
+    readonly status: number;
+    readonly type: ErrorType;
+    readonly code: string;
+    readonly param?: string | undefined;
+    readonly requestId?: string | undefined;
+    constructor(status: number, type: ErrorType, code: string, message: string, param?: string | undefined, requestId?: string | undefined);
+    /** The object does not exist. */
+    get isNotFound(): boolean;
+    /**
+     * The node has no room.
+     *
+     * The one error worth retrying unchanged — and the signal to consider a task
+     * instead, since tasks wait for a slot anywhere in the fleet rather than
+     * failing.
+     */
+    get isCapacity(): boolean;
+    /** The object is in a state that forbids the call. */
+    get isConflict(): boolean;
+    /**
+     * The key lacks permission — an ordinary token calling an admin-only endpoint,
+     * such as setting a tenant's policy. Distinct from a missing token: the
+     * request was authenticated, and refused.
+     */
+    get isForbidden(): boolean;
+}
+export declare class Client {
+    #private;
+    readonly sandboxes: SandboxResource;
+    readonly executions: ExecutionResource;
+    readonly files: FileResource;
+    readonly tasks: TaskResource;
+    readonly queue: QueueResource;
+    readonly images: ImageResource;
+    readonly tenants: TenantResource;
+    constructor(baseURL?: string, opts?: ClientOptions);
+    /** @internal */
+    request(method: string, path: string, init?: {
+        body?: unknown;
+        query?: Record<string, string | number | undefined>;
+        opts?: RequestOptions;
+        /** Streams manage their own lifetime, so no timeout is imposed. */
+        noTimeout?: boolean;
+    }): Promise<Response>;
+    /** @internal */
+    json<T>(method: string, path: string, init?: Parameters<Client["request"]>[2]): Promise<T>;
+    /** Whether the daemon is up. Needs no token. */
+    health(opts?: RequestOptions): Promise<Health>;
+    /**
+     * Start a command and wait for it to finish.
+     *
+     * Check `err(exe)` afterwards: a non-zero exit is the code's own verdict,
+     * whereas a timeout or a vanished sandbox is not.
+     */
+    run(sandboxID: string, cmd: string, args?: string[], opts?: RequestOptions): Promise<Execution>;
+}
+export type ListParams = {
+    limit?: number;
+    starting_after?: string;
+    ending_before?: string;
+};
+declare class SandboxResource {
+    private readonly c;
+    constructor(c: Client);
+    /**
+     * Boot a sandbox and wait for it to be ready.
+     *
+     * Throws a capacity error when the node is full — see `APIError.isCapacity`.
+     * That is by design: a sandbox is a reservation, so you are told at once
+     * rather than left waiting. Submit a task if you would rather wait.
+     */
+    create(params: SandboxCreateParams, opts?: RequestOptions): Promise<Sandbox>;
+    retrieve(id: string, opts?: RequestOptions): Promise<Sandbox>;
+    /**
+     * Kill the sandbox and get back its final cost.
+     *
+     * Those numbers are sampled just before the kill and cannot be had after: the
+     * accounting dies with the VM. This reply is the only record of what the
+     * sandbox consumed.
+     */
+    delete(id: string, opts?: RequestOptions): Promise<Sandbox>;
+    list(params?: ListParams & {
+        state?: SandboxState;
+    }, opts?: RequestOptions): Promise<SandboxList>;
+    /**
+     * Every sandbox, fetching pages as needed.
+     *
+     * Paging is mechanical and easy to get subtly wrong — forgetting `has_more`,
+     * or taking the cursor from the wrong end — and it is the same loop every
+     * time, so it lives here rather than in every caller.
+     */
+    all(params?: ListParams & {
+        state?: SandboxState;
+    }, opts?: RequestOptions): AsyncGenerator<Sandbox>;
+}
+declare class ExecutionResource {
+    private readonly c;
+    constructor(c: Client);
+    /**
+     * Start a command and return at once, without waiting for it.
+     *
+     * The command belongs to the sandbox, not to this call: dropping the
+     * connection does not kill it. Follow it with `stream`, or collect it later
+     * with `retrieve`.
+     */
+    create(sandboxID: string, params: ExecutionCreateParams, opts?: RequestOptions): Promise<Execution>;
+    /**
+     * An execution and everything it printed.
+     *
+     * Works after the sandbox is gone, which is the point: the output you most
+     * want is from the run that was killed.
+     */
+    retrieve(sandboxID: string, executionID: string, opts?: RequestOptions): Promise<Execution>;
+    list(sandboxID: string, params?: ListParams, opts?: RequestOptions): Promise<ExecutionList>;
+    /**
+     * Signal a running execution.
+     *
+     * The signal reaches the whole process group, so a program that spawned
+     * children does not leave them behind. Defaults to SIGKILL. Cancelling
+     * something that already finished is not an error.
+     */
+    cancel(sandboxID: string, executionID: string, params?: ExecutionCancelParams, opts?: RequestOptions): Promise<Execution>;
+    /**
+     * Follow an execution's output as it is produced.
+     *
+     * The stream replays from the beginning before it follows, so connecting late
+     * — or reconnecting after a dropped connection — loses nothing. Aborting the
+     * signal stops watching; the execution keeps running, because it belongs to
+     * its sandbox. To stop the execution itself, use `cancel`.
+     *
+     * ```ts
+     * for await (const frame of client.executions.stream(sbID, exeID)) {
+     *   if (frame.type === "stdout") process.stdout.write(frameText(frame));
+     * }
+     * ```
+     */
+    stream(sandboxID: string, executionID: string, opts?: RequestOptions): AsyncGenerator<Frame>;
+    /**
+     * Wait for an execution to finish.
+     *
+     * Polls rather than streams: streaming is for showing output as it appears,
+     * waiting is for knowing the result, and polling survives a dropped
+     * connection without any work from the caller.
+     */
+    wait(sandboxID: string, executionID: string, opts?: RequestOptions): Promise<Execution>;
+}
+declare class FileResource {
+    private readonly c;
+    constructor(c: Client);
+    /** Write a file into the sandbox, making parent directories. */
+    write(sandboxID: string, path: string, content: string | Uint8Array, opts?: RequestOptions): Promise<File>;
+    /** Download a file's bytes. */
+    retrieve(sandboxID: string, path: string, opts?: RequestOptions): Promise<Uint8Array>;
+    /** Download a file as text. */
+    readText(sandboxID: string, path: string, opts?: RequestOptions): Promise<string>;
+}
+declare class TaskResource {
+    private readonly c;
+    constructor(c: Client);
+    /**
+     * Queue work for the fleet.
+     *
+     * Unlike creating a sandbox this never fails for capacity: the task waits for
+     * a slot on any node. Use it for throughput, and a sandbox for several
+     * commands that share state.
+     */
+    create(params: TaskCreateParams, opts?: RequestOptions): Promise<Task>;
+    retrieve(taskID: string, opts?: RequestOptions): Promise<Task>;
+    /** Wait for a task to have a result. */
+    wait(taskID: string, opts?: RequestOptions): Promise<Task>;
+}
+declare class QueueResource {
+    private readonly c;
+    constructor(c: Client);
+    /**
+     * The queue's depth and this node's slots.
+     *
+     * The depth is the fleet's; the slots are this node's alone. No node knows
+     * the fleet's capacity, which is what lets one be added without telling
+     * anything else.
+     */
+    retrieve(opts?: RequestOptions): Promise<Queue>;
+}
+declare class ImageResource {
+    private readonly c;
+    constructor(c: Client);
+    list(opts?: RequestOptions): Promise<ImageList>;
+}
+/**
+ * The `/v1/tenants` resource, and it is administrative: a tenant's storage cap
+ * is set by an operator, never by the code that runs under it. Updating needs an
+ * admin token; an ordinary key is refused with a 403 (see `APIError.isForbidden`).
+ */
+declare class TenantResource {
+    private readonly c;
+    constructor(c: Client);
+    /** Set a tenant's byte cap and full policy, replacing any previous one. */
+    update(tenantID: string, params: TenantUpdateParams, opts?: RequestOptions): Promise<Tenant>;
+    /**
+     * `update` for the common case: a byte cap and a policy. Pass `"preserve"` to
+     * reject writes when full, or `"evict"` to delete the oldest objects to make
+     * room. A `maxBytes` of 0 means unlimited.
+     */
+    setLimit(tenantID: string, maxBytes: number, policy: TenantFullPolicy, opts?: RequestOptions): Promise<Tenant>;
+    /**
+     * A tenant's policy and its current usage, the usage read live from the bucket
+     * at call time (so it costs a listing — see `Tenant.usage_bytes`).
+     */
+    retrieve(tenantID: string, opts?: RequestOptions): Promise<Tenant>;
+    /** Every configured tenant. A tenant with no policy is absent: it is unlimited. */
+    list(opts?: RequestOptions): Promise<TenantList>;
+}
+/**
+ * Why an execution did not simply run to completion, or null.
+ *
+ * A non-zero exit returns null: the process ran, and that is its own verdict
+ * rather than a failure of ours. The endings that are *not* the code's doing —
+ * a timeout, a cancel, a VM taken away, a command that never started — return
+ * an error, because those are the ones that must not be mistaken for a program
+ * choosing to fail.
+ */
+export declare function err(exe: Execution): Error | null;
+/** A frame's bytes. */
+export declare function frameBytes(frame: Frame): Uint8Array;
+/** A frame's bytes as text. */
+export declare function frameText(frame: Frame): string;
+export {};