@sailresearch/sdk 0.2.14

package/dist/image.d.ts

@@ -0,0 +1,90 @@
+import type { Client } from "./client.js";
+import type { ImageArchitecture, ImageSpec } from "./types/image.js";
+/** Target CPU architecture for a base image. */
+/** Options for {@link Image.addLocalFile}. */
+export interface AddLocalFileOptions {
+    /** Unix mode bits (low 9); omitted uses the builder default (0644). */
+    mode?: number;
+}
+/** Options for {@link Image.addLocalDir}. */
+export interface AddLocalDirOptions {
+    /** Gitignore-style patterns to skip (e.g. `"*.pyc"`, `"__pycache__/"`). */
+    ignore?: string[];
+    /** A gitignore-style file whose patterns to skip (e.g. `.gitignore`). */
+    ignoreFile?: string;
+}
+/**
+ * A custom image definition. Immutable and fluent: each method returns a new
+ * `Image`. Local files/dirs are recorded here and hashed + uploaded by the
+ * core when the image is resolved to a spec (at {@link Sailbox.create}, or via
+ * {@link toSpec}), so chaining stays synchronous.
+ *
+ * @example
+ * ```ts
+ * const image = Image.debian("arm64")
+ *   .aptInstall("git")
+ *   .pipInstall("numpy")
+ *   .addLocalDir("./app", "/app", { ignore: ["*.pyc", "__pycache__/"] })
+ *   .runCommand("pip install -e /app");
+ * const box = await Sailbox.create({ app, name: "w", image });
+ * ```
+ */
+export declare class Image {
+    private readonly base;
+    private readonly architecture;
+    private readonly envVars;
+    private readonly steps;
+    private constructor();
+    /** A Debian base image (defaults to arm64). */
+    static debian(architecture?: ImageArchitecture): Image;
+    /** The devbox base image (defaults to arm64): a prebuilt Debian base with a
+     * baked development layer. Prebuilt-only, so it does not support build
+     * steps or env; start from {@link Image.debian} to customize. */
+    static devbox(architecture?: ImageArchitecture): Image;
+    /** Install system packages with apt. */
+    aptInstall(...packages: string[]): Image;
+    /** Install Python packages with pip. */
+    pipInstall(...packages: string[]): Image;
+    /** Run a shell command during the build. */
+    runCommand(command: string): Image;
+    /** Bake environment variables into the image (keys are trimmed). */
+    env(env: Record<string, string>): Image;
+    /** Bake one local file into the image at `path` (absolute POSIX path;
+     * a trailing `/` appends the source basename). Hashed + uploaded at resolve. */
+    addLocalFile(localPath: string, remotePath: string, options?: AddLocalFileOptions): Image;
+    /** Bake a local directory tree into the image at `path`. Each regular
+     * file is hashed + uploaded at resolve; symlinks are skipped and file modes
+     * preserved. `ignore` takes gitignore-style patterns. */
+    addLocalDir(localPath: string, remotePath: string, options?: AddLocalDirOptions): Image;
+    /**
+     * Resolve to an {@link ImageSpec}, hashing and uploading any local
+     * files/dirs via `client` (defaults to the env client). The walk, gitignore
+     * matching, hashing, and uploads all run in the core. {@link Sailbox.create}
+     * calls this for you; use it directly only if you need the raw spec.
+     */
+    toSpec(client?: Client): Promise<ImageSpec>;
+    /**
+     * Upload any local files and build the image, waiting until it is ready.
+     * Returns the resolved {@link ImageSpec}. {@link Sailbox.create} calls this
+     * for a custom image before creating the sailbox (the backend serves the
+     * content-addressed built image); a bare base image skips the build.
+     */
+    build(options?: {
+        client?: Client;
+        timeoutSeconds?: number;
+    }): Promise<ImageSpec>;
+    private definition;
+    private withStep;
+    /** The devbox base is prebuilt-only; the backend rejects it with any build
+     * steps or env, so fail at the builder call instead. */
+    private rejectDevboxCustomization;
+}
+export declare function isBuiltinBaseSpec(spec: ImageSpec, client?: Client): boolean;
+/** Whether resolving this `image` option runs an image build (an {@link Image}
+ * may still skip it in the core when it is a bare builtin base). */
+export declare function willBuild(image: ImageSpec | Image, client?: Client): boolean;
+/** Resolve the `image` option of {@link Sailbox.create}: build an {@link Image}
+ * (the core skips the build for a bare builtin base), pass a builtin
+ * {@link ImageSpec} through, and build a custom spec to ready. */
+export declare function resolveImageForCreate(client: Client, image: ImageSpec | Image, timeoutSeconds: number): Promise<ImageSpec>;
+//# sourceMappingURL=image.d.ts.map

package/dist/image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../src/image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAI1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAErE,gDAAgD;AAChD,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IAClC,uEAAuE;IACvE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6CAA6C;AAC7C,MAAM,WAAW,kBAAkB;IACjC,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,KAAK;IAEd,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAJxB,OAAO;IAOP,+CAA+C;IAC/C,MAAM,CAAC,MAAM,CAAC,YAAY,GAAE,iBAA2B,GAAG,KAAK;IAI/D;;qEAEiE;IACjE,MAAM,CAAC,MAAM,CAAC,YAAY,GAAE,iBAA2B,GAAG,KAAK;IAI/D,wCAAwC;IACxC,UAAU,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,KAAK;IAMxC,wCAAwC;IACxC,UAAU,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,KAAK;IAMxC,4CAA4C;IAC5C,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK;IAQlC,oEAAoE;IACpE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK;IAsBvC;oFACgF;IAChF,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,mBAAwB,GAChC,KAAK;IAgBR;;6DAEyD;IACzD,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,kBAAuB,GAC/B,KAAK;IAWR;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3C;;;;;OAKG;IACH,KAAK,CACH,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAO,GACzD,OAAO,CAAC,SAAS,CAAC;IAOrB,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,QAAQ;IAQhB;4DACwD;IACxD,OAAO,CAAC,yBAAyB;CAQlC;AA2BD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAE3E;AAED;oEACoE;AACpE,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAE5E;AAED;;kEAEkE;AAClE,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,SAAS,GAAG,KAAK,EACxB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,SAAS,CAAC,CAQpB"}

package/dist/image.js

@@ -0,0 +1,193 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Image = void 0;
+exports.isBuiltinBaseSpec = isBuiltinBaseSpec;
+exports.willBuild = willBuild;
+exports.resolveImageForCreate = resolveImageForCreate;
+const default_client_js_1 = require("./default-client.js");
+const errors_js_1 = require("./errors.js");
+/**
+ * A custom image definition. Immutable and fluent: each method returns a new
+ * `Image`. Local files/dirs are recorded here and hashed + uploaded by the
+ * core when the image is resolved to a spec (at {@link Sailbox.create}, or via
+ * {@link toSpec}), so chaining stays synchronous.
+ *
+ * @example
+ * ```ts
+ * const image = Image.debian("arm64")
+ *   .aptInstall("git")
+ *   .pipInstall("numpy")
+ *   .addLocalDir("./app", "/app", { ignore: ["*.pyc", "__pycache__/"] })
+ *   .runCommand("pip install -e /app");
+ * const box = await Sailbox.create({ app, name: "w", image });
+ * ```
+ */
+class Image {
+    base;
+    architecture;
+    envVars;
+    steps;
+    constructor(base, architecture, envVars, steps) {
+        this.base = base;
+        this.architecture = architecture;
+        this.envVars = envVars;
+        this.steps = steps;
+    }
+    /** A Debian base image (defaults to arm64). */
+    static debian(architecture = "arm64") {
+        return new Image("debian", checkedArchitecture(architecture), {}, []);
+    }
+    /** The devbox base image (defaults to arm64): a prebuilt Debian base with a
+     * baked development layer. Prebuilt-only, so it does not support build
+     * steps or env; start from {@link Image.debian} to customize. */
+    static devbox(architecture = "arm64") {
+        return new Image("devbox", checkedArchitecture(architecture), {}, []);
+    }
+    /** Install system packages with apt. */
+    aptInstall(...packages) {
+        return this.withStep({
+            aptInstall: cleanPackages(packages, "aptInstall"),
+        });
+    }
+    /** Install Python packages with pip. */
+    pipInstall(...packages) {
+        return this.withStep({
+            pipInstall: cleanPackages(packages, "pipInstall"),
+        });
+    }
+    /** Run a shell command during the build. */
+    runCommand(command) {
+        const cmd = command.trim();
+        if (!cmd) {
+            throw new errors_js_1.InvalidArgumentError("runCommand requires a non-empty command");
+        }
+        return this.withStep({ runCommand: cmd });
+    }
+    /** Bake environment variables into the image (keys are trimmed). */
+    env(env) {
+        this.rejectDevboxCustomization();
+        const entries = Object.entries(env);
+        if (entries.length === 0) {
+            throw new errors_js_1.InvalidArgumentError("env requires at least one key");
+        }
+        const cleaned = {};
+        for (const [key, value] of entries) {
+            const cleanKey = key.trim();
+            if (!cleanKey) {
+                throw new errors_js_1.InvalidArgumentError("env keys must be non-empty");
+            }
+            cleaned[cleanKey] = value;
+        }
+        return new Image(this.base, this.architecture, { ...this.envVars, ...cleaned }, this.steps);
+    }
+    /** Bake one local file into the image at `path` (absolute POSIX path;
+     * a trailing `/` appends the source basename). Hashed + uploaded at resolve. */
+    addLocalFile(localPath, remotePath, options = {}) {
+        // A fractional mode would truncate at the native u32 boundary and bake
+        // different permissions than the caller wrote.
+        if (options.mode !== undefined &&
+            (!Number.isInteger(options.mode) ||
+                options.mode < 0 ||
+                options.mode > 0o777)) {
+            throw new errors_js_1.InvalidArgumentError("mode must be between 0 and 0o777");
+        }
+        return this.withStep({
+            addLocalFile: { localPath, remotePath, mode: options.mode },
+        });
+    }
+    /** Bake a local directory tree into the image at `path`. Each regular
+     * file is hashed + uploaded at resolve; symlinks are skipped and file modes
+     * preserved. `ignore` takes gitignore-style patterns. */
+    addLocalDir(localPath, remotePath, options = {}) {
+        return this.withStep({
+            addLocalDir: {
+                localPath,
+                remotePath,
+                ignore: options.ignore,
+                ignoreFile: options.ignoreFile,
+            },
+        });
+    }
+    /**
+     * Resolve to an {@link ImageSpec}, hashing and uploading any local
+     * files/dirs via `client` (defaults to the env client). The walk, gitignore
+     * matching, hashing, and uploads all run in the core. {@link Sailbox.create}
+     * calls this for you; use it directly only if you need the raw spec.
+     */
+    toSpec(client) {
+        return (client ?? (0, default_client_js_1.defaultClient)()).resolveImage(this.definition());
+    }
+    /**
+     * Upload any local files and build the image, waiting until it is ready.
+     * Returns the resolved {@link ImageSpec}. {@link Sailbox.create} calls this
+     * for a custom image before creating the sailbox (the backend serves the
+     * content-addressed built image); a bare base image skips the build.
+     */
+    build(options = {}) {
+        return (options.client ?? (0, default_client_js_1.defaultClient)()).buildImageDefinition(this.definition(), options.timeoutSeconds ?? 1800);
+    }
+    definition() {
+        return {
+            base: this.base,
+            architecture: this.architecture,
+            env: Object.keys(this.envVars).length ? { ...this.envVars } : undefined,
+            steps: this.steps.length ? [...this.steps] : undefined,
+        };
+    }
+    withStep(step) {
+        this.rejectDevboxCustomization();
+        return new Image(this.base, this.architecture, this.envVars, [
+            ...this.steps,
+            step,
+        ]);
+    }
+    /** The devbox base is prebuilt-only; the backend rejects it with any build
+     * steps or env, so fail at the builder call instead. */
+    rejectDevboxCustomization() {
+        if (this.base === "devbox") {
+            throw new errors_js_1.InvalidArgumentError("the devbox base image does not support build steps or env; start " +
+                "from Image.debian() to customize");
+        }
+    }
+}
+exports.Image = Image;
+function cleanPackages(packages, method) {
+    const cleaned = packages.map((pkg) => pkg.trim());
+    if (cleaned.length === 0) {
+        throw new errors_js_1.InvalidArgumentError(`${method} requires at least one package`);
+    }
+    if (cleaned.some((pkg) => !pkg)) {
+        throw new errors_js_1.InvalidArgumentError(`${method} packages must be non-empty`);
+    }
+    return cleaned;
+}
+/** A bare base image the backend already ships prebuilt (no build needed).
+ * The predicate lives in the core, shared by every SDK. */
+/** Fail fast on an unknown architecture from untyped JS. */
+function checkedArchitecture(architecture) {
+    if (architecture !== "amd64" && architecture !== "arm64") {
+        throw new errors_js_1.InvalidArgumentError(`unknown architecture ${JSON.stringify(architecture)}; use "amd64" or "arm64"`);
+    }
+    return architecture;
+}
+function isBuiltinBaseSpec(spec, client) {
+    return (client ?? (0, default_client_js_1.defaultClient)()).isBuiltinBaseSpec(spec);
+}
+/** Whether resolving this `image` option runs an image build (an {@link Image}
+ * may still skip it in the core when it is a bare builtin base). */
+function willBuild(image, client) {
+    return image instanceof Image || !isBuiltinBaseSpec(image, client);
+}
+/** Resolve the `image` option of {@link Sailbox.create}: build an {@link Image}
+ * (the core skips the build for a bare builtin base), pass a builtin
+ * {@link ImageSpec} through, and build a custom spec to ready. */
+async function resolveImageForCreate(client, image, timeoutSeconds) {
+    if (image instanceof Image) {
+        return image.build({ client, timeoutSeconds });
+    }
+    if (!isBuiltinBaseSpec(image, client)) {
+        await client.buildSpecToReady(image, timeoutSeconds);
+    }
+    return image;
+}
+//# sourceMappingURL=image.js.map

package/dist/image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../src/image.ts"],"names":[],"mappings":";;;AA8NA,8CAEC;AAID,8BAEC;AAKD,sDAYC;AAtPD,2DAAoD;AACpD,2CAAmD;AAmBnD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,KAAK;IAEG;IACA;IACA;IACA;IAJnB,YACmB,IAAY,EACZ,YAAoB,EACpB,OAAyC,EACzC,KAAqC;QAHrC,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAQ;QACpB,YAAO,GAAP,OAAO,CAAkC;QACzC,UAAK,GAAL,KAAK,CAAgC;IACrD,CAAC;IAEJ,+CAA+C;IAC/C,MAAM,CAAC,MAAM,CAAC,eAAkC,OAAO;QACrD,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;qEAEiE;IACjE,MAAM,CAAC,MAAM,CAAC,eAAkC,OAAO;QACrD,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,wCAAwC;IACxC,UAAU,CAAC,GAAG,QAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC;YACnB,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,wCAAwC;IACxC,UAAU,CAAC,GAAG,QAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC;YACnB,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,4CAA4C;IAC5C,UAAU,CAAC,OAAe;QACxB,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,gCAAoB,CAAC,yCAAyC,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,oEAAoE;IACpE,GAAG,CAAC,GAA2B;QAC7B,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,gCAAoB,CAAC,+BAA+B,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACnC,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,gCAAoB,CAAC,4BAA4B,CAAC,CAAC;YAC/D,CAAC;YACD,OAAO,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,KAAK,CACd,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,YAAY,EACjB,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,OAAO,EAAE,EAC/B,IAAI,CAAC,KAAK,CACX,CAAC;IACJ,CAAC;IAED;oFACgF;IAChF,YAAY,CACV,SAAiB,EACjB,UAAkB,EAClB,UAA+B,EAAE;QAEjC,uEAAuE;QACvE,+CAA+C;QAC/C,IACE,OAAO,CAAC,IAAI,KAAK,SAAS;YAC1B,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC9B,OAAO,CAAC,IAAI,GAAG,CAAC;gBAChB,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,EACvB,CAAC;YACD,MAAM,IAAI,gCAAoB,CAAC,kCAAkC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;YACnB,YAAY,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;SAC5D,CAAC,CAAC;IACL,CAAC;IAED;;6DAEyD;IACzD,WAAW,CACT,SAAiB,EACjB,UAAkB,EAClB,UAA8B,EAAE;QAEhC,OAAO,IAAI,CAAC,QAAQ,CAAC;YACnB,WAAW,EAAE;gBACX,SAAS;gBACT,UAAU;gBACV,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,UAAU,EAAE,OAAO,CAAC,UAAU;aAC/B;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAe;QACpB,OAAO,CAAC,MAAM,IAAI,IAAA,iCAAa,GAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CACH,UAAwD,EAAE;QAE1D,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,IAAA,iCAAa,GAAE,CAAC,CAAC,oBAAoB,CAC7D,IAAI,CAAC,UAAU,EAAE,EACjB,OAAO,CAAC,cAAc,IAAI,IAAI,CAC/B,CAAC;IACJ,CAAC;IAEO,UAAU;QAChB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS;YACvE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;SACvD,CAAC;IACJ,CAAC;IAEO,QAAQ,CAAC,IAAyB;QACxC,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,EAAE;YAC3D,GAAG,IAAI,CAAC,KAAK;YACb,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;4DACwD;IAChD,yBAAyB;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,gCAAoB,CAC5B,mEAAmE;gBACjE,kCAAkC,CACrC,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AA9JD,sBA8JC;AAED,SAAS,aAAa,CAAC,QAAkB,EAAE,MAAc;IACvD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAClD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,gCAAoB,CAAC,GAAG,MAAM,gCAAgC,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,gCAAoB,CAAC,GAAG,MAAM,6BAA6B,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;2DAC2D;AAC3D,4DAA4D;AAC5D,SAAS,mBAAmB,CAC1B,YAA+B;IAE/B,IAAI,YAAY,KAAK,OAAO,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC;QACzD,MAAM,IAAI,gCAAoB,CAC5B,wBAAwB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,0BAA0B,CAC/E,CAAC;IACJ,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAgB,iBAAiB,CAAC,IAAe,EAAE,MAAe;IAChE,OAAO,CAAC,MAAM,IAAI,IAAA,iCAAa,GAAE,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED;oEACoE;AACpE,SAAgB,SAAS,CAAC,KAAwB,EAAE,MAAe;IACjE,OAAO,KAAK,YAAY,KAAK,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACrE,CAAC;AAED;;kEAEkE;AAC3D,KAAK,UAAU,qBAAqB,CACzC,MAAc,EACd,KAAwB,EACxB,cAAsB;IAEtB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @sailresearch/sdk — TypeScript SDK for Sail sandboxes (sailboxes), a thin wrapper over
+ * the canonical Rust core. Runs on Node 20+ and Bun.
+ *
+ * The object-model API ({@link Sailbox}, {@link App}, {@link Volume}) is the
+ * ergonomic entry point; {@link Client} is the lower-level surface underneath.
+ */
+export { Sailbox } from "./sailbox.js";
+export { App } from "./app.js";
+export { Volume } from "./volume.js";
+/** Guest-side: headers that authenticate this sailbox as an ingress
+ * allowlist source (only available inside a sailbox guest). */
+export { ingressAuthHeaders } from "./native.js";
+export { Image } from "./image.js";
+export { Client } from "./client.js";
+export { defaultClient, setDefaultClient } from "./default-client.js";
+export { ExecProcess } from "./exec-process.js";
+export { ExecStream } from "./exec-stream.js";
+export { FileStream, FileWriter } from "./file-stream.js";
+export { resolveConfig } from "./config.js";
+export { SailError, InvalidArgumentError, InternalError, NotFoundError, PermissionDeniedError, FileNotFoundError, BrokenPipeError, TimeoutError, TransportError, ApiError, SailboxCreationError, ImageBuildError, SailboxExecutionError, SailboxTerminatedError, SailboxExecRequestNotFoundError, SailboxWorkerLostError, } from "./errors.js";
+export type { AddLocalDirOptions, AddLocalFileOptions } from "./image.js";
+export type { CreateSailboxOptions, CheckpointOptions, FromCheckpointOptions, SailboxPage, WaitForListenerOptions, } from "./sailbox.js";
+export type { EnableSshOptions, SshEndpoint } from "./ssh.js";
+export type { AppInfo, ImageDefinition, ImageDefinitionStep, LocalDirInput, LocalFileInput, VolumeInfo, } from "./native.js";
+export type { ClientConfig, ClientOptions, IngressScheme, ResolvedConfig, SailMode, } from "./types/config.js";
+export type { CancelOptions, ExecOptions, ExecResult, ShellOptions, WriteOptions, } from "./types/exec.js";
+export type { AddLocalDir, AddLocalDirFile, AddLocalFile, BaseImage, ImageArchitecture, ImageBuild, ImageBuildStatus, ImageBuildStep, ImageSpec, PackageInstall, RunCommand, } from "./types/image.js";
+export type { HttpEndpoint, IngressProtocol, Listener, ListenerEndpoint, TcpEndpoint, ListenerRouteStatus, Protocol, } from "./types/listener.js";
+export type { SailboxSize, CreateSailboxRequest, FromCheckpointRequest, IngressPortInput, ListSailboxesQuery, SailboxCheckpoint, SailboxHandle, SailboxInfo, SailboxInfoPage, SailboxStatus, SailboxStatusFilter, UpgradeResult, VolumeMountInput, } from "./types/sailbox.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;+DAC+D;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,+BAA+B,EAC/B,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAErB,YAAY,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC1E,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,WAAW,EACX,sBAAsB,GACvB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC9D,YAAY,EACV,OAAO,EACP,eAAe,EACf,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,UAAU,GACX,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,YAAY,EACZ,aAAa,EACb,aAAa,EACb,cAAc,EACd,QAAQ,GACT,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,aAAa,EACb,WAAW,EACX,UAAU,EACV,YAAY,EACZ,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,WAAW,EACX,eAAe,EACf,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,EACT,cAAc,EACd,UAAU,GACX,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,WAAW,EACX,mBAAmB,EACnB,QAAQ,GACT,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,WAAW,EACX,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,gBAAgB,GACjB,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,55 @@
+"use strict";
+/**
+ * @sailresearch/sdk — TypeScript SDK for Sail sandboxes (sailboxes), a thin wrapper over
+ * the canonical Rust core. Runs on Node 20+ and Bun.
+ *
+ * The object-model API ({@link Sailbox}, {@link App}, {@link Volume}) is the
+ * ergonomic entry point; {@link Client} is the lower-level surface underneath.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SailboxWorkerLostError = exports.SailboxExecRequestNotFoundError = exports.SailboxTerminatedError = exports.SailboxExecutionError = exports.ImageBuildError = exports.SailboxCreationError = exports.ApiError = exports.TransportError = exports.TimeoutError = exports.BrokenPipeError = exports.FileNotFoundError = exports.PermissionDeniedError = exports.NotFoundError = exports.InternalError = exports.InvalidArgumentError = exports.SailError = exports.resolveConfig = exports.FileWriter = exports.FileStream = exports.ExecStream = exports.ExecProcess = exports.setDefaultClient = exports.defaultClient = exports.Client = exports.Image = exports.ingressAuthHeaders = exports.Volume = exports.App = exports.Sailbox = void 0;
+var sailbox_js_1 = require("./sailbox.js");
+Object.defineProperty(exports, "Sailbox", { enumerable: true, get: function () { return sailbox_js_1.Sailbox; } });
+var app_js_1 = require("./app.js");
+Object.defineProperty(exports, "App", { enumerable: true, get: function () { return app_js_1.App; } });
+var volume_js_1 = require("./volume.js");
+Object.defineProperty(exports, "Volume", { enumerable: true, get: function () { return volume_js_1.Volume; } });
+/** Guest-side: headers that authenticate this sailbox as an ingress
+ * allowlist source (only available inside a sailbox guest). */
+var native_js_1 = require("./native.js");
+Object.defineProperty(exports, "ingressAuthHeaders", { enumerable: true, get: function () { return native_js_1.ingressAuthHeaders; } });
+var image_js_1 = require("./image.js");
+Object.defineProperty(exports, "Image", { enumerable: true, get: function () { return image_js_1.Image; } });
+var client_js_1 = require("./client.js");
+Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_js_1.Client; } });
+var default_client_js_1 = require("./default-client.js");
+Object.defineProperty(exports, "defaultClient", { enumerable: true, get: function () { return default_client_js_1.defaultClient; } });
+Object.defineProperty(exports, "setDefaultClient", { enumerable: true, get: function () { return default_client_js_1.setDefaultClient; } });
+var exec_process_js_1 = require("./exec-process.js");
+Object.defineProperty(exports, "ExecProcess", { enumerable: true, get: function () { return exec_process_js_1.ExecProcess; } });
+var exec_stream_js_1 = require("./exec-stream.js");
+Object.defineProperty(exports, "ExecStream", { enumerable: true, get: function () { return exec_stream_js_1.ExecStream; } });
+var file_stream_js_1 = require("./file-stream.js");
+Object.defineProperty(exports, "FileStream", { enumerable: true, get: function () { return file_stream_js_1.FileStream; } });
+Object.defineProperty(exports, "FileWriter", { enumerable: true, get: function () { return file_stream_js_1.FileWriter; } });
+var config_js_1 = require("./config.js");
+Object.defineProperty(exports, "resolveConfig", { enumerable: true, get: function () { return config_js_1.resolveConfig; } });
+// Error taxonomy (the internal `rethrow` helper is deliberately not re-exported).
+var errors_js_1 = require("./errors.js");
+Object.defineProperty(exports, "SailError", { enumerable: true, get: function () { return errors_js_1.SailError; } });
+Object.defineProperty(exports, "InvalidArgumentError", { enumerable: true, get: function () { return errors_js_1.InvalidArgumentError; } });
+Object.defineProperty(exports, "InternalError", { enumerable: true, get: function () { return errors_js_1.InternalError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return errors_js_1.NotFoundError; } });
+Object.defineProperty(exports, "PermissionDeniedError", { enumerable: true, get: function () { return errors_js_1.PermissionDeniedError; } });
+Object.defineProperty(exports, "FileNotFoundError", { enumerable: true, get: function () { return errors_js_1.FileNotFoundError; } });
+Object.defineProperty(exports, "BrokenPipeError", { enumerable: true, get: function () { return errors_js_1.BrokenPipeError; } });
+Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function () { return errors_js_1.TimeoutError; } });
+Object.defineProperty(exports, "TransportError", { enumerable: true, get: function () { return errors_js_1.TransportError; } });
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return errors_js_1.ApiError; } });
+Object.defineProperty(exports, "SailboxCreationError", { enumerable: true, get: function () { return errors_js_1.SailboxCreationError; } });
+Object.defineProperty(exports, "ImageBuildError", { enumerable: true, get: function () { return errors_js_1.ImageBuildError; } });
+Object.defineProperty(exports, "SailboxExecutionError", { enumerable: true, get: function () { return errors_js_1.SailboxExecutionError; } });
+Object.defineProperty(exports, "SailboxTerminatedError", { enumerable: true, get: function () { return errors_js_1.SailboxTerminatedError; } });
+Object.defineProperty(exports, "SailboxExecRequestNotFoundError", { enumerable: true, get: function () { return errors_js_1.SailboxExecRequestNotFoundError; } });
+Object.defineProperty(exports, "SailboxWorkerLostError", { enumerable: true, get: function () { return errors_js_1.SailboxWorkerLostError; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,2CAAuC;AAA9B,qGAAA,OAAO,OAAA;AAChB,mCAA+B;AAAtB,6FAAA,GAAG,OAAA;AACZ,yCAAqC;AAA5B,mGAAA,MAAM,OAAA;AAEf;+DAC+D;AAC/D,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA;AAC3B,uCAAmC;AAA1B,iGAAA,KAAK,OAAA;AACd,yCAAqC;AAA5B,mGAAA,MAAM,OAAA;AACf,yDAAsE;AAA7D,kHAAA,aAAa,OAAA;AAAE,qHAAA,gBAAgB,OAAA;AACxC,qDAAgD;AAAvC,8GAAA,WAAW,OAAA;AACpB,mDAA8C;AAArC,4GAAA,UAAU,OAAA;AACnB,mDAA0D;AAAjD,4GAAA,UAAU,OAAA;AAAE,4GAAA,UAAU,OAAA;AAC/B,yCAA4C;AAAnC,0GAAA,aAAa,OAAA;AAEtB,kFAAkF;AAClF,yCAiBqB;AAhBnB,sGAAA,SAAS,OAAA;AACT,iHAAA,oBAAoB,OAAA;AACpB,0GAAA,aAAa,OAAA;AACb,0GAAA,aAAa,OAAA;AACb,kHAAA,qBAAqB,OAAA;AACrB,8GAAA,iBAAiB,OAAA;AACjB,4GAAA,eAAe,OAAA;AACf,yGAAA,YAAY,OAAA;AACZ,2GAAA,cAAc,OAAA;AACd,qGAAA,QAAQ,OAAA;AACR,iHAAA,oBAAoB,OAAA;AACpB,4GAAA,eAAe,OAAA;AACf,kHAAA,qBAAqB,OAAA;AACrB,mHAAA,sBAAsB,OAAA;AACtB,4HAAA,+BAA+B,OAAA;AAC/B,mHAAA,sBAAsB,OAAA"}

package/dist/native.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Re-exports the napi-rs generated native binding. The `native/` directory is
+ * produced by `pnpm build:native` (@napi-rs/cli) and is the only place the rest
+ * of the SDK touches the addon. The generated interfaces are the typed
+ * core⇄JS boundary; the modules under `types/` re-export them, narrowing
+ * server-controlled strings to open string-literal unions.
+ */
+export { CoreClient, ExecProcessHandle, AsyncStreamReaderHandle, FileReaderHandle, FileWriterHandle, resolvedConfig, validateAutosleepTimeout, validateSizeLimits, validateIngressPorts, validateVolumeMounts, ingressAuthHeaders, volumeFromMount, } from "../native/index.js";
+export type { AddLocalDir, AddLocalDirFile, AddLocalFile, AppInfo, ClientConfig, CreateSailboxRequest, ExecResult, ExecStartOptions, FromCheckpointRequest, ImageBuild, ImageDefinition, ImageDefinitionStep, ImageSpec, LocalDirInput, LocalFileInput, IngressPortInput, Listener, ListSailboxesQuery, VolumeInfo, PackageInstall, ResolvedConfig, RunCommand, SailboxCheckpoint, SailboxHandle, SailboxInfo, SailboxInfoPage, SshEndpoint, UpgradeResult, VolumeMountInput, } from "../native/index.js";
+//# sourceMappingURL=native.d.ts.map

package/dist/native.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"native.d.ts","sourceRoot":"","sources":["../src/native.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACV,WAAW,EACX,eAAe,EACf,YAAY,EACZ,OAAO,EACP,YAAY,EACZ,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,qBAAqB,EACrB,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,SAAS,EACT,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,cAAc,EACd,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,eAAe,EACf,WAAW,EACX,aAAa,EACb,gBAAgB,GACjB,MAAM,oBAAoB,CAAC"}

package/dist/native.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.volumeFromMount = exports.ingressAuthHeaders = exports.validateVolumeMounts = exports.validateIngressPorts = exports.validateSizeLimits = exports.validateAutosleepTimeout = exports.resolvedConfig = exports.FileWriterHandle = exports.FileReaderHandle = exports.AsyncStreamReaderHandle = exports.ExecProcessHandle = exports.CoreClient = void 0;
+/**
+ * Re-exports the napi-rs generated native binding. The `native/` directory is
+ * produced by `pnpm build:native` (@napi-rs/cli) and is the only place the rest
+ * of the SDK touches the addon. The generated interfaces are the typed
+ * core⇄JS boundary; the modules under `types/` re-export them, narrowing
+ * server-controlled strings to open string-literal unions.
+ */
+var index_js_1 = require("../native/index.js");
+Object.defineProperty(exports, "CoreClient", { enumerable: true, get: function () { return index_js_1.CoreClient; } });
+Object.defineProperty(exports, "ExecProcessHandle", { enumerable: true, get: function () { return index_js_1.ExecProcessHandle; } });
+Object.defineProperty(exports, "AsyncStreamReaderHandle", { enumerable: true, get: function () { return index_js_1.AsyncStreamReaderHandle; } });
+Object.defineProperty(exports, "FileReaderHandle", { enumerable: true, get: function () { return index_js_1.FileReaderHandle; } });
+Object.defineProperty(exports, "FileWriterHandle", { enumerable: true, get: function () { return index_js_1.FileWriterHandle; } });
+Object.defineProperty(exports, "resolvedConfig", { enumerable: true, get: function () { return index_js_1.resolvedConfig; } });
+Object.defineProperty(exports, "validateAutosleepTimeout", { enumerable: true, get: function () { return index_js_1.validateAutosleepTimeout; } });
+Object.defineProperty(exports, "validateSizeLimits", { enumerable: true, get: function () { return index_js_1.validateSizeLimits; } });
+Object.defineProperty(exports, "validateIngressPorts", { enumerable: true, get: function () { return index_js_1.validateIngressPorts; } });
+Object.defineProperty(exports, "validateVolumeMounts", { enumerable: true, get: function () { return index_js_1.validateVolumeMounts; } });
+Object.defineProperty(exports, "ingressAuthHeaders", { enumerable: true, get: function () { return index_js_1.ingressAuthHeaders; } });
+Object.defineProperty(exports, "volumeFromMount", { enumerable: true, get: function () { return index_js_1.volumeFromMount; } });
+//# sourceMappingURL=native.js.map

package/dist/native.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"native.js","sourceRoot":"","sources":["../src/native.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,+CAa4B;AAZ1B,sGAAA,UAAU,OAAA;AACV,6GAAA,iBAAiB,OAAA;AACjB,mHAAA,uBAAuB,OAAA;AACvB,4GAAA,gBAAgB,OAAA;AAChB,4GAAA,gBAAgB,OAAA;AAChB,0GAAA,cAAc,OAAA;AACd,oHAAA,wBAAwB,OAAA;AACxB,8GAAA,kBAAkB,OAAA;AAClB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA;AACpB,8GAAA,kBAAkB,OAAA;AAClB,2GAAA,eAAe,OAAA"}