@promigence/sdk 0.1.0-beta.16 → 0.1.0-beta.17

package/dist/proxy.js

@@ -1,7 +1,8 @@
 import { request as httpRequest } from "node:http";
 import { request as httpsRequest } from "node:https";
 import { connect as tlsConnect } from "node:tls";
-import { Readable } from "node:stream";
+import { Readable, pipeline } from "node:stream";
+import { constants as zlibConstants, createBrotliDecompress, createGunzip } from "node:zlib";
 import { guardCertChain, makeCertChainGuard } from "./ca-guard.js";
 function withCertGuard(existing) {
     return existing === undefined ? guardCertChain : makeCertChainGuard(existing);
@@ -130,7 +131,32 @@ async function bodyOf(init) {
         return Buffer.from(b);
     return Buffer.from(await new Response(b).arrayBuffer());
 }
-function toResponse(res) {
+const ACCEPT_ENCODING = "br, gzip";
+function decoded(res) {
+    const enc = res.headers["content-encoding"];
+    if (typeof enc !== "string")
+        return res;
+    const steps = [];
+    for (const c of enc.toLowerCase().split(",").map((s) => s.trim()).reverse()) {
+        if (c === "" || c === "identity")
+            continue;
+        if (c === "gzip" || c === "x-gzip") {
+            steps.push(createGunzip({ flush: zlibConstants.Z_SYNC_FLUSH, finishFlush: zlibConstants.Z_SYNC_FLUSH }));
+        }
+        else if (c === "br") {
+            steps.push(createBrotliDecompress({
+                flush: zlibConstants.BROTLI_OPERATION_FLUSH, finishFlush: zlibConstants.BROTLI_OPERATION_FLUSH,
+            }));
+        }
+        else {
+            return res;
+        }
+    }
+    if (steps.length === 0)
+        return res;
+    return pipeline([res, ...steps], () => { });
+}
+function toResponse(res, head) {
     const headers = new Headers();
     for (const [k, v] of Object.entries(res.headers)) {
         if (v === undefined)
@@ -143,7 +169,8 @@ function toResponse(res) {
     }
     const status = res.statusCode ?? 502;
     const noBody = status === 204 || status === 304;
-    return new Response(noBody ? null : Readable.toWeb(res), {
+    const body = head ? res : decoded(res);
+    return new Response(noBody ? null : Readable.toWeb(body), {
         status, statusText: res.statusMessage ?? "", headers,
     });
 }
@@ -156,6 +183,8 @@ export function proxyFetch(proxy) {
         const url = new URL(typeof input === "string" ? input : input instanceof URL ? input.href : input.url);
         const method = (init?.method ?? "GET").toUpperCase();
         const headers = headersOf(init);
+        if (headers["accept-encoding"] === undefined)
+            headers["accept-encoding"] = ACCEPT_ENCODING;
         const body = await bodyOf(init);
         if (body)
             headers["content-length"] = String(body.length);
@@ -178,7 +207,7 @@ export function proxyFetch(proxy) {
             const done = (res) => {
                 settled = true;
                 signal?.removeEventListener("abort", onAbort);
-                resolve(toResponse(res));
+                resolve(toResponse(res, method === "HEAD"));
             };
             if (url.protocol === "http:") {
                 const req = proxyRequest({

package/dist/sandbox.d.ts

@@ -11,7 +11,7 @@
  */
 import { inspect, type InspectOptions } from "node:util";
 import { type CommandResult, type CommandRunOpts, type ForkOpts, type OptimizeFor, type SandboxOpts, type Tier } from "./core.js";
-import { PromigenceClient, type BackgroundExecRecord, type DirEntry, type DirListOpts, type ExtractResult, type FileInfo, type FileMatch, type Page, type PortRecord, type AutoPauseMode, type SandboxRecord, type SearchOpts, type SecretBinding, type SnapshotBuild, type VerifySpec } from "./client.js";
+import { PromigenceClient, type BackgroundExecRecord, type DirEntry, type DirListOpts, type ExtractResult, type FileInfo, type FileMatch, type Page, type PortExposeOpts, type PortRecord, type AutoPauseMode, type SandboxRecord, type SearchOpts, type SecretBinding, type SnapshotBuild, type VerifySpec } from "./client.js";
 import { CommandHandle } from "./handles.js";
 import type { PtyExit, PtySession, PtySize } from "./pty.js";
 /** `setTimeout`'s fix when the longer timeout does not fit under the run's spend cap. */
@@ -289,6 +289,7 @@ export declare class Sandbox {
         /**
          * Run `cmd` and resolve with its result. A non-zero exit throws `CommandExitError`; a command
          * killed at its own `timeoutMs` throws `CommandTimeoutError` (a `CommandExitError` too).
+         * With `throwOnExit: false` both resolve instead, and the result's `timedOut` tells them apart.
          */
         run(cmd: string, opts?: ForegroundRunOpts): Promise<CommandResult>;
         /** Background commands in this sandbox (running and ended, until killed with forget). */
@@ -325,7 +326,11 @@ export declare class Sandbox {
      * `promigence sandbox ssh <sid> -- -N -L <port>:localhost:<port>`.
      */
     readonly ports: {
-        expose(port: number): Promise<PortRecord>;
+        /**
+         * Publish `port`: `{ length: "long" }` for a longer, harder-to-guess URL (apps with sensitive
+         * data); omitted, the length this sandbox's project or organization chose (short by default).
+         */
+        expose(port: number, opts?: PortExposeOpts): Promise<PortRecord>;
         list(): Promise<PortRecord[]>;
         /** A token revokes that URL; a port number every URL for it. Returns the revoked tokens. */
         revoke(tokenOrPort: string | number): Promise<string[]>;
@@ -490,8 +495,9 @@ export declare class Sandbox {
      * the window may be. Bring it back with `resume()`, which is the warm path.
      *
      * `mode: "activity"` is for an agent that runs inside the sandbox on its own: it also waits
-     * until nothing inside has used CPU, moved a byte or held a connection open for the window
-     * (`AutoPauseMode`). Omitted, the mode is left as it is (`"requests"` unless set).
+     * until, for the whole window, the sandbox has used under 5% of one core, sent and received no
+     * network byte and held no connection out open; disk writes do not count (`AutoPauseMode`).
+     * Omitted, the mode is left as it is (`"requests"` unless set).
      */
     setAutoPause(seconds: number, mode?: AutoPauseMode): Promise<void>;
     /** The idle rule in force: seconds before it pauses itself, `0` when it never does. */
@@ -513,7 +519,8 @@ export declare class Sandbox {
      * full `url` with its scheme.
      *
      * Async, because the address is a capability minted on demand rather than
-     * a hostname derived from the id. An existing URL for the port is reused, not re-minted.
+     * a hostname derived from the id. An existing URL for the port is reused, not re-minted; a new
+     * one has the length this sandbox's project or organization chose (short by default).
      *
      * If your account's preview URLs aren't on, this throws `PreviewsUnavailableError`; write to
      * support@promigence.ai to have them turned on, and meanwhile reach the port with

package/dist/sandbox.js

@@ -361,7 +361,7 @@ export class Sandbox {
             },
         };
         this.ports = {
-            expose: (port) => this.#client.sandboxes.ports.expose(this.sandboxId, port),
+            expose: (port, opts) => this.#client.sandboxes.ports.expose(this.sandboxId, port, opts),
             list: () => this.#client.sandboxes.ports.list(this.sandboxId),
             revoke: async (tokenOrPort) => (await this.#client.sandboxes.ports.revoke(this.sandboxId, tokenOrPort)).revoked,
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promigence/sdk",
-  "version": "0.1.0-beta.16",
+  "version": "0.1.0-beta.17",
   "description": "The fastest sandboxes for AI agents and code. The Promigence TypeScript SDK: snapshot an environment once, fork it as often as you need, run commands in every copy. A simple Sandbox class and the full PromigenceClient, with zero runtime dependencies.",
   "license": "Apache-2.0",
   "homepage": "https://www.promigence.ai",