@sailresearch/sdk 0.2.14

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Sail Research, Inc.
+
+   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,126 @@
+# @sailresearch/sdk
+
+TypeScript SDK for [Sail](https://sailresearch.com) sandboxes (sailboxes). Create,
+run commands in, move files to and from, and manage sandboxes from a TS agent
+harness.
+
+It is a thin wrapper over the canonical Sail Rust core, shipped as a native addon
+(napi-rs). It runs on **Node 20+** and **Bun**. It is not a browser library.
+
+## Install
+
+```sh
+npm install @sailresearch/sdk
+# or: pnpm add @sailresearch/sdk / bun add @sailresearch/sdk
+```
+
+Prebuilt native binaries are published per platform (Linux x64/arm64 gnu and
+musl, macOS x64/arm64, Windows x64) and resolved automatically at install time.
+
+## Configure
+
+Set `SAIL_API_KEY` (and optionally `SAIL_MODE` = `prod` | `dev` | `staging` |
+`local`) in the environment. The SDK also reads `~/.sail`. The object-model
+statics use this environment configuration by default.
+
+## Quickstart
+
+```ts
+import { App, Sailbox } from "@sailresearch/sdk";
+
+// Look up (or create) the app your sandboxes belong to.
+const app = await App.find("example-app", { mintIfMissing: true });
+
+// Boot a sandbox.
+const sb = await Sailbox.create({ app, name: "worker-1" });
+
+// Run a command and stream its output. A string runs via `/bin/sh -lc`; pass a
+// string[] to exec directly without a shell.
+const proc = await sb.exec("echo hello && ls /");
+for await (const chunk of proc.stdout) process.stdout.write(chunk);
+const result = await proc.wait();
+console.log("exit code:", result.exitCode);
+
+// Move files.
+const writer = await sb.writeStream("/tmp/note.txt", { createParents: true });
+await writer.write(Buffer.from("hi from the harness\n"));
+await writer.finish();
+const contents = await (await sb.readStream("/tmp/note.txt")).bytes();
+
+// Expose a port and wait until it's routable.
+await sb.expose(8080, "http");
+const listener = await sb.waitForListener(8080);
+if (listener.endpoint?.kind === "http") {
+  console.log("reachable at:", listener.endpoint.url);
+}
+
+// Lifecycle.
+await sb.sleep(); // or pause() / resume() / checkpoint() / terminate()
+await sb.terminate();
+```
+
+## Conventions
+
+- **Fields are camelCase** (`memoryMib`, `result.exitCode`,
+  `listener.endpoint`, `info.sailboxId`). Object-model helpers accept ergonomic
+  handles like `app`; lower-level `Client` request objects use generated fields
+  like `appId`.
+- **Errors** all extend `SailError`, so `catch (e) { if (e instanceof SailError) }`
+  catches everything, and subclasses (`NotFoundError`, `SailboxExecutionError`,
+  ...) let you match specifics.
+- **Bytes** cross as `Buffer`; a `string` passed to `write`/`writeStdin` is UTF-8.
+
+## Explicit configuration
+
+Instead of the environment, construct a `Client` and pass it to the statics (or
+call its methods directly):
+
+```ts
+import { Client, Sailbox } from "@sailresearch/sdk";
+
+const client = Client.fromConfig({ apiKey: "sk_...", mode: "dev" });
+const sb = await Sailbox.create({ app: "app_...", name: "w", client });
+```
+
+## Custom images
+
+Build a custom image with the fluent `Image` builder and pass it to
+`Sailbox.create`; local files/dirs are hashed and uploaded when the box is
+created:
+
+```ts
+import { App, Image, Sailbox } from "@sailresearch/sdk";
+
+const app = await App.find("example-app", { mintIfMissing: true });
+
+const image = Image.debian("arm64")
+  .aptInstall("git")
+  .pipInstall("numpy")
+  .addLocalDir("./app", "/app", { ignore: ["node_modules/", ".git/"] })
+  .runCommand("pip install -e /app");
+
+const sb = await Sailbox.create({ app, name: "worker", image });
+```
+
+## API
+
+- `Sailbox` — `create` / `get` / `list` / `listPage` / `fromCheckpoint`;
+  instance `exec`, `read` / `write`, `writeStream` / `readStream`,
+  `expose` / `unexpose` / `listeners` / `listener` / `waitForListener` /
+  `ingressAuthHeaders`, `enableSsh`, `terminate` / `pause` / `sleep` / `resume` /
+  `checkpoint` / `upgrade`, and an interactive `shell`.
+- `App` — `find` / `list`.
+- `Volume` — `find` / `list`; instance `delete`.
+- `Image` — `debian` / `devbox`, `aptInstall` / `pipInstall` / `runCommand` / `env`,
+  `addLocalFile` / `addLocalDir`, `build`, `toSpec`. (`Sailbox.create` builds a
+  custom image for you.)
+- `Client` — the lower-level surface with the same operations.
+- `ExecProcess` / `ExecStream` / `FileStream` / `FileWriter` — streaming handles.
+- Errors — `SailError` and typed subclasses (`NotFoundError`,
+  `SailboxCreationError`, `SailboxExecutionError`, ...); errors the SDK raises
+  map to a `SailError` subclass, so `catch (e) { if (e instanceof SailError) }`
+  covers them.
+
+## License
+
+Apache-2.0.

package/dist/app.d.ts

@@ -0,0 +1,23 @@
+import type { ClientOptions } from "./types/config.js";
+/**
+ * An app: the billing/ownership scope a sailbox belongs to. Look one up (or mint
+ * it) with {@link App.find}, then pass it (or its {@link App.id}) to
+ * {@link Sailbox.create}.
+ */
+export declare class App {
+    /** Stable app id. */
+    readonly id: string;
+    /** App name. */
+    readonly name: string;
+    /** Creation time. */
+    readonly createdAt: Date;
+    private constructor();
+    private static from;
+    /** Find an app by name, optionally minting it if missing. */
+    static find(name: string, options?: ClientOptions & {
+        mintIfMissing?: boolean;
+    }): Promise<App>;
+    /** Every app the current org owns, newest first. */
+    static list(options?: ClientOptions): Promise<App[]>;
+}
+//# sourceMappingURL=app.d.ts.map

package/dist/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;GAIG;AACH,qBAAa,GAAG;IAEZ,qBAAqB;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM;IACnB,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,qBAAqB;IACrB,QAAQ,CAAC,SAAS,EAAE,IAAI;IAN1B,OAAO;IASP,OAAO,CAAC,MAAM,CAAC,IAAI;IAInB,6DAA6D;WAChD,IAAI,CACf,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,aAAa,GAAG;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAO,GACxD,OAAO,CAAC,GAAG,CAAC;IAKf,oDAAoD;WACvC,IAAI,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;CAI/D"}

package/dist/app.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.App = void 0;
+const default_client_js_1 = require("./default-client.js");
+/**
+ * An app: the billing/ownership scope a sailbox belongs to. Look one up (or mint
+ * it) with {@link App.find}, then pass it (or its {@link App.id}) to
+ * {@link Sailbox.create}.
+ */
+class App {
+    id;
+    name;
+    createdAt;
+    constructor(
+    /** Stable app id. */
+    id, 
+    /** App name. */
+    name, 
+    /** Creation time. */
+    createdAt) {
+        this.id = id;
+        this.name = name;
+        this.createdAt = createdAt;
+    }
+    static from(data) {
+        return new App(data.id, data.name, new Date(data.createdAt));
+    }
+    /** Find an app by name, optionally minting it if missing. */
+    static async find(name, options = {}) {
+        const client = options.client ?? (0, default_client_js_1.defaultClient)();
+        return App.from(await client.findApp(name, options.mintIfMissing ?? false));
+    }
+    /** Every app the current org owns, newest first. */
+    static async list(options = {}) {
+        const client = options.client ?? (0, default_client_js_1.defaultClient)();
+        return (await client.listApps()).map((data) => App.from(data));
+    }
+}
+exports.App = App;
+//# sourceMappingURL=app.js.map

package/dist/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";;;AAAA,2DAAoD;AAKpD;;;;GAIG;AACH,MAAa,GAAG;IAGH;IAEA;IAEA;IANX;IACE,qBAAqB;IACZ,EAAU;IACnB,gBAAgB;IACP,IAAY;IACrB,qBAAqB;IACZ,SAAe;QAJf,OAAE,GAAF,EAAE,CAAQ;QAEV,SAAI,GAAJ,IAAI,CAAQ;QAEZ,cAAS,GAAT,SAAS,CAAM;IACvB,CAAC;IAEI,MAAM,CAAC,IAAI,CAAC,IAAa;QAC/B,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,6DAA6D;IAC7D,MAAM,CAAC,KAAK,CAAC,IAAI,CACf,IAAY,EACZ,UAAuD,EAAE;QAEzD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAA,iCAAa,GAAE,CAAC;QACjD,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,oDAAoD;IACpD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,UAAyB,EAAE;QAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAA,iCAAa,GAAE,CAAC;QACjD,OAAO,CAAC,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;CACF;AA5BD,kBA4BC"}

package/dist/client.d.ts

@@ -0,0 +1,119 @@
+import { type AppInfo, type VolumeInfo } from "./native.js";
+import { ExecProcess } from "./exec-process.js";
+import { FileStream, FileWriter } from "./file-stream.js";
+import type { EnableSshOptions, SshEndpoint } from "./ssh.js";
+import type { ShellOptions } from "./types/exec.js";
+import type { ClientConfig } from "./types/config.js";
+import type { CheckpointOptions } from "./sailbox.js";
+import type { ImageDefinition } from "./native.js";
+import type { ImageBuild, ImageSpec } from "./types/image.js";
+import type { ExecOptions, WriteOptions } from "./types/exec.js";
+import { type IngressProtocol, type Listener } from "./types/listener.js";
+import { type CreateSailboxRequest, type FromCheckpointRequest, type ListSailboxesQuery, type SailboxCheckpoint, type SailboxHandle, type SailboxInfo, type SailboxInfoPage, type UpgradeResult } from "./types/sailbox.js";
+/**
+ * A configured Sail client: the low-level surface over the native core (one
+ * config snapshot; env vars are read at construction). Every control-plane
+ * operation is here. The object-model API ({@link Sailbox}, {@link App},
+ * {@link Volume}) is built on top of it.
+ *
+ * Construct with {@link Client.fromEnv} or {@link Client.fromConfig}.
+ */
+export declare class Client {
+    private readonly native;
+    private constructor();
+    /** Build a client from the environment (`SAIL_API_KEY`, `SAIL_MODE`, ...). */
+    static fromEnv(): Client;
+    /** Build a client from an explicit {@link ClientConfig}. */
+    static fromConfig(config: ClientConfig): Client;
+    /** Create a sailbox. `timeoutSeconds` bounds each create attempt (default
+     * 600s); pass `0` for no client-side timeout. Timed-out attempts are retried,
+     * reattaching to the same box, so when the overall budget is exhausted the
+     * box may still be coming up server-side: find or terminate it by `name`.
+     * `image` defaults to a plain Debian base. */
+    createSailbox(req: CreateSailboxRequest, timeoutSeconds?: number): Promise<SailboxHandle>;
+    /** Fetch one sailbox by id. */
+    getSailbox(sailboxId: string): Promise<SailboxInfo>;
+    /** List one page of sailboxes in the current org. */
+    listSailboxes(params?: ListSailboxesQuery): Promise<SailboxInfoPage>;
+    /** Terminate a sailbox (idempotent). */
+    terminateSailbox(sailboxId: string): Promise<void>;
+    /** Pause a sailbox in memory. */
+    pauseSailbox(sailboxId: string): Promise<void>;
+    /** Sleep a sailbox to disk (wakes on traffic). */
+    sleepSailbox(sailboxId: string): Promise<void>;
+    /** Resume a paused or sleeping sailbox. */
+    resumeSailbox(sailboxId: string): Promise<SailboxHandle>;
+    /** Take a checkpoint of a sailbox. `name` sets the handle's display name;
+     * `ttlSeconds`, when given, overrides the server's default retention
+     * window. */
+    checkpointSailbox(sailboxId: string, options?: CheckpointOptions): Promise<SailboxCheckpoint>;
+    /** Create a new sailbox from a checkpoint. */
+    createFromCheckpoint(params: FromCheckpointRequest): Promise<SailboxHandle>;
+    /** Upgrade a sailbox's in-guest agent (now if running, else at next wake). */
+    upgradeSailbox(sailboxId: string): Promise<UpgradeResult>;
+    /** Expose a guest port at runtime (route status starts "unspecified"; the
+     * response confirms configuration, not reachability). */
+    exposeListener(sailboxId: string, guestPort: number, protocol?: IngressProtocol, allowlist?: string[]): Promise<Listener>;
+    /** Remove a runtime ingress port. */
+    unexposeListener(sailboxId: string, guestPort: number): Promise<void>;
+    /** List a sailbox's listeners without waking it. */
+    listListeners(sailboxId: string): Promise<Listener[]>;
+    /** Fetch one listener by guest port without waking the box. */
+    getListener(sailboxId: string, guestPort: number): Promise<Listener>;
+    /** Block until the listener on `guestPort` is reachable end to end — route
+     * ACTIVE and its endpoint accepting (HTTP GET / raw-TCP connect) — and
+     * return it, throwing {@link TimeoutError} after `timeoutSeconds`. */
+    waitForListener(sailboxId: string, guestPort: number, timeoutSeconds: number, pollIntervalSeconds: number): Promise<Listener>;
+    /** Ingress-identity headers for this sailbox, as a name→value map. */
+    ingressAuthHeaders(sailboxId: string): Promise<Record<string, string>>;
+    /** Look up (optionally minting) an NFS volume by name. */
+    getVolume(name: string, mintIfMissing?: boolean): Promise<VolumeInfo>;
+    /** List NFS volumes in the current org. */
+    listVolumes(maxObjects?: number): Promise<VolumeInfo[]>;
+    /** Delete a volume by id. Resolves `null` when `allowMissing` and it's gone. */
+    deleteVolume(volumeId: string, allowMissing?: boolean): Promise<VolumeInfo | null>;
+    /** Find an app by name, optionally minting it. */
+    findApp(name: string, mintIfMissing?: boolean): Promise<AppInfo>;
+    /** Every app the current org owns, newest first. */
+    listApps(): Promise<AppInfo[]>;
+    /** Run a command in a sailbox and return a handle to the live process. A
+     * `string` command is run via `/bin/sh -lc`; a `string[]` is exec'd directly.
+     * `cwd`/`background` apply to string commands (see {@link ExecOptions}). */
+    exec(sailboxId: string, command: string | string[], options?: ExecOptions): Promise<ExecProcess>;
+    /** Open an interactive pty session on a sailbox, bridged to the local
+     * terminal: raw keystrokes reach the remote process, output renders
+     * locally, and resizes propagate. Resolves with the remote process's exit
+     * code. Requires an interactive terminal (stdin and stdout TTYs). */
+    shell(sailboxId: string, command?: string, options?: ShellOptions): Promise<number>;
+    /** Open a streaming read of a guest file. */
+    readStream(sailboxId: string, path: string): Promise<FileStream>;
+    /** Open a streaming upload to a guest file. */
+    writeStream(sailboxId: string, path: string, options?: WriteOptions): Promise<FileWriter>;
+    /** Whether a spec is a bare builtin base the backend ships prebuilt (no
+     * build needed). */
+    isBuiltinBaseSpec(spec: ImageSpec): boolean;
+    /** Resolve an image definition into a content-addressed {@link ImageSpec}:
+     * the core walks local directories (gitignore-style `ignore`), hashes every
+     * file, and uploads content the server does not already have. */
+    resolveImage(def: ImageDefinition): Promise<ImageSpec>;
+    /** Resolve an image definition and build it to ready, returning the
+     * content-addressed {@link ImageSpec} to create sailboxes from. A bare
+     * builtin base skips the build; `timeoutSeconds` bounds the whole pipeline
+     * (hashing, uploads, and the build). */
+    buildImageDefinition(def: ImageDefinition, timeoutSeconds: number): Promise<ImageSpec>;
+    /** Build an already-resolved spec to ready (submit + poll), bounded by
+     * `timeoutSeconds`. */
+    buildSpecToReady(spec: ImageSpec, timeoutSeconds: number): Promise<ImageBuild>;
+    /** Enable SSH on a sailbox: trust the org SSH CA, start `sshd`, and expose
+     * guest port 22 as TCP once the CA-only daemon owns it. A non-empty
+     * `allowlist` restricts port 22 to those source CIDRs, replacing any
+     * existing restriction. With `wait` (the default), polls until the endpoint
+     * is reachable and returns it, throwing {@link TimeoutError} if it is not
+     * within `timeoutSeconds`; with `wait: false`, skips the probe and resolves
+     * `null`. */
+    enableSsh(sailboxId: string, options?: EnableSshOptions): Promise<SshEndpoint | null>;
+    /** Fetch (creating on first use) the org SSH certificate authority public key.
+     * Used to preflight SSH before a box is provisioned. */
+    orgSshCaPublicKey(): Promise<string>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAQxE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,QAAQ,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,aAAa,EACnB,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;GAOG;AACH,qBAAa,MAAM;IACG,OAAO,CAAC,QAAQ,CAAC,MAAM;IAA3C,OAAO;IAEP,8EAA8E;IAC9E,MAAM,CAAC,OAAO,IAAI,MAAM;IAIxB,4DAA4D;IAC5D,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;IAM/C;;;;kDAI8C;IACxC,aAAa,CACjB,GAAG,EAAE,oBAAoB,EACzB,cAAc,SAAM,GACnB,OAAO,CAAC,aAAa,CAAC;IAOzB,+BAA+B;IAC/B,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInD,qDAAqD;IAC/C,aAAa,CACjB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,eAAe,CAAC;IAe3B,wCAAwC;IACxC,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,iCAAiC;IACjC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C,kDAAkD;IAClD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C,2CAA2C;IAC3C,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIxD;;iBAEa;IACP,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAgB7B,8CAA8C;IACxC,oBAAoB,CACxB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,aAAa,CAAC;IAezB,8EAA8E;IAC9E,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAMzD;6DACyD;IACnD,cAAc,CAClB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,eAAwB,EAClC,SAAS,GAAE,MAAM,EAAO,GACvB,OAAO,CAAC,QAAQ,CAAC;IAgBpB,qCAAqC;IAC/B,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3E,oDAAoD;IACpD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAMrD,+DAA+D;IACzD,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO1E;;0EAEsE;IAChE,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,EACtB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,QAAQ,CAAC;IA2BpB,sEAAsE;IACtE,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAMtE,0DAA0D;IAC1D,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAInE,2CAA2C;IACrC,WAAW,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAU7D,gFAAgF;IAChF,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,YAAY,UAAQ,GACnB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAM7B,kDAAkD;IAClD,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9D,oDAAoD;IACpD,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAM9B;;gFAE4E;IACtE,IAAI,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAC1B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,WAAW,CAAC;IAiCvB;;;yEAGqE;IAC/D,KAAK,CACT,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,MAAM,CAAC;IAqBlB,6CAA6C;IAC7C,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMhE,+CAA+C;IACzC,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,UAAU,CAAC;IAsBtB;wBACoB;IACpB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAI3C;;qEAEiE;IACjE,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;IAStD;;;4CAGwC;IAClC,oBAAoB,CACxB,GAAG,EAAE,eAAe,EACpB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,SAAS,CAAC;IAWrB;2BACuB;IACjB,gBAAgB,CACpB,IAAI,EAAE,SAAS,EACf,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,CAAC;IAQtB;;;;;;iBAMa;IACP,SAAS,CACb,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAqB9B;4DACwD;IACxD,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;CAGrC"}