computesdk 1.18.2 → 1.20.0

package/dist/index.js

@@ -37,10 +37,12 @@ __export(index_exports, {
   TerminalInstance: () => TerminalInstance,
   autoConfigureCompute: () => autoConfigureCompute,
   buildProviderHeaders: () => buildProviderHeaders,
+  buildSetupPayload: () => buildSetupPayload,
   compute: () => compute,
   decodeBinaryMessage: () => decodeBinaryMessage,
   detectProvider: () => detectProvider,
   encodeBinaryMessage: () => encodeBinaryMessage,
+  encodeSetupPayload: () => encodeSetupPayload,
   getMissingEnvVars: () => getMissingEnvVars,
   getProviderConfigFromEnv: () => getProviderConfigFromEnv,
   getProviderHeaders: () => getProviderHeaders,
@@ -1386,6 +1388,7 @@ var Server = class {
     this.listHandler = handlers.list;
     this.retrieveHandler = handlers.retrieve;
     this.stopHandler = handlers.stop;
+    this.deleteHandler = handlers.delete;
     this.restartHandler = handlers.restart;
     this.updateStatusHandler = handlers.updateStatus;
     this.logsHandler = handlers.logs;
@@ -1451,12 +1454,19 @@ var Server = class {
     return response.data.server;
   }
   /**
-   * Stop a server by slug
+   * Stop a server by slug (non-destructive)
    * @param slug - The server slug
    */
   async stop(slug) {
     await this.stopHandler(slug);
   }
+  /**
+   * Delete a server config by slug (stops + removes persistence)
+   * @param slug - The server slug
+   */
+  async delete(slug) {
+    await this.deleteHandler(slug);
+  }
   /**
    * Restart a server by slug
    * @param slug - The server slug
@@ -1926,8 +1936,8 @@ var Child = class {
    * Create a new child sandbox
    * @returns Child sandbox info including URL and subdomain
    */
-  async create() {
-    return this.createHandler();
+  async create(options) {
+    return this.createHandler(options);
   }
   /**
    * List all child sandboxes
@@ -2249,6 +2259,9 @@ var Sandbox = class {
       stop: async (slug) => {
         await this.stopServer(slug);
       },
+      delete: async (slug) => {
+        await this.deleteServer(slug);
+      },
       restart: async (slug) => this.restartServer(slug),
       updateStatus: async (slug, status) => {
         await this.updateServerStatus(slug, status);
@@ -2301,7 +2314,7 @@ var Sandbox = class {
       info: async () => this.getAuthInfo()
     });
     this.child = new Child({
-      create: async () => this.createSandbox(),
+      create: async (options) => this.createSandbox(options),
       list: async () => this.listSandboxes(),
       retrieve: async (subdomain) => this.getSandbox(subdomain),
       destroy: async (subdomain, deleteFiles) => this.deleteSandbox(subdomain, deleteFiles)
@@ -3164,6 +3177,12 @@ API request failed (${response.status}): ${error}`
    * @param options.path - Working directory (optional)
    * @param options.env_file - Path to .env file relative to path (optional)
    * @param options.environment - Inline environment variables (merged with env_file if both provided)
+   * @param options.port - Requested port (preallocated before start)
+   * @param options.strict_port - If true, fail instead of auto-incrementing when port is taken
+   * @param options.autostart - Auto-start on daemon boot (default: true)
+   * @param options.overlay - Inline overlay to create before starting
+   * @param options.overlays - Additional overlays to create before starting
+   * @param options.depends_on - Overlay IDs this server depends on
    * @param options.restart_policy - When to automatically restart: 'never' (default), 'on-failure', 'always'
    * @param options.max_restarts - Maximum restart attempts, 0 = unlimited (default: 0)
    * @param options.restart_delay_ms - Delay between restart attempts in milliseconds (default: 1000)
@@ -3190,6 +3209,18 @@ API request failed (${response.status}): ${error}`
    *   restart_delay_ms: 2000,
    *   stop_timeout_ms: 5000,
    * });
+   *
+   * // With inline overlay dependencies
+   * await sandbox.startServer({
+   *   slug: 'web',
+   *   start: 'npm run dev',
+   *   path: '/app',
+   *   overlay: {
+   *     source: '/templates/nextjs',
+   *     target: 'app',
+   *     strategy: 'smart',
+   *   },
+   * });
    * ```
    */
   async startServer(options) {
@@ -3206,17 +3237,26 @@ API request failed (${response.status}): ${error}`
     return this.request(`/servers/${encodeURIComponent(slug)}`);
   }
   /**
-   * Stop a managed server
+   * Stop a managed server (non-destructive)
    * @param slug - Server slug
    */
   async stopServer(slug) {
     return this.request(
-      `/servers/${encodeURIComponent(slug)}`,
+      `/servers/${encodeURIComponent(slug)}/stop`,
       {
-        method: "DELETE"
+        method: "POST"
       }
     );
   }
+  /**
+   * Delete a managed server configuration
+   * @param slug - Server slug
+   */
+  async deleteServer(slug) {
+    await this.request(`/servers/${encodeURIComponent(slug)}`, {
+      method: "DELETE"
+    });
+  }
   /**
    * Restart a managed server
    * @param slug - Server slug
@@ -3259,15 +3299,29 @@ API request failed (${response.status}): ${error}`
     );
   }
   // ============================================================================
+  // Ready Management
+  // ============================================================================
+  /**
+   * Get readiness status for autostarted servers and overlays
+   */
+  async ready() {
+    const response = await this.request("/ready");
+    return {
+      ready: response.ready,
+      servers: response.servers ?? [],
+      overlays: response.overlays ?? []
+    };
+  }
+  // ============================================================================
   // Sandbox Management
   // ============================================================================
   /**
    * Create a new sandbox environment
    */
-  async createSandbox() {
+  async createSandbox(options) {
     return this.request("/sandboxes", {
       method: "POST",
-      body: JSON.stringify({})
+      body: JSON.stringify(options || {})
     });
   }
   /**
@@ -3501,6 +3555,42 @@ API request failed (${response.status}): ${error}`
   }
 };
 
+// src/setup.ts
+var encodeBase64 = (value) => {
+  if (typeof Buffer !== "undefined") {
+    return Buffer.from(value, "utf8").toString("base64");
+  }
+  if (typeof btoa !== "undefined" && typeof TextEncoder !== "undefined") {
+    const bytes = new TextEncoder().encode(value);
+    let binary = "";
+    for (const byte of bytes) {
+      binary += String.fromCharCode(byte);
+    }
+    return btoa(binary);
+  }
+  throw new Error("Base64 encoding is not supported in this environment.");
+};
+var buildSetupPayload = (options) => {
+  const overlays = options.overlays?.map((overlay) => {
+    const { source, target, ignore, strategy } = overlay;
+    return {
+      source,
+      target,
+      ignore,
+      strategy
+    };
+  });
+  const servers = options.servers;
+  return {
+    overlays: overlays?.length ? overlays : void 0,
+    servers: servers?.length ? servers : void 0
+  };
+};
+var encodeSetupPayload = (options) => {
+  const payload = buildSetupPayload(options);
+  return encodeBase64(JSON.stringify(payload));
+};
+
 // src/provider-config.ts
 var PROVIDER_AUTH = {
   e2b: [["E2B_API_KEY"]],
@@ -4095,6 +4185,27 @@ var ComputeManager = class {
     this.sandbox = {
       /**
        * Create a new sandbox
+       *
+       * @example
+       * ```typescript
+       * const sandbox = await compute.sandbox.create({
+       *   directory: '/custom/path',
+       *   overlays: [
+       *     {
+       *       source: '/templates/nextjs',
+       *       target: 'app',
+       *       strategy: 'smart',
+       *     },
+       *   ],
+       *   servers: [
+       *     {
+       *       slug: 'web',
+       *       start: 'npm run dev',
+       *       path: '/app',
+       *     },
+       *   ],
+       * });
+       * ```
        */
       create: async (options) => {
         const config = this.getGatewayConfig();
@@ -4105,7 +4216,7 @@ var ComputeManager = class {
         if (!result.success || !result.data) {
           throw new Error(`Gateway returned invalid response`);
         }
-        const { sandboxId, url, token, provider, metadata, name, namespace } = result.data;
+        const { sandboxId, url, token, provider, metadata, name, namespace, overlays, servers } = result.data;
         const sandbox = new Sandbox({
           sandboxUrl: url,
           sandboxId,
@@ -4114,7 +4225,9 @@ var ComputeManager = class {
           metadata: {
             ...metadata,
             ...name && { name },
-            ...namespace && { namespace }
+            ...namespace && { namespace },
+            ...overlays && { overlays },
+            ...servers && { servers }
           },
           WebSocket: config.WebSocket || globalThis.WebSocket,
           destroyHandler: async () => {
@@ -4353,10 +4466,12 @@ var compute = new Proxy(
   TerminalInstance,
   autoConfigureCompute,
   buildProviderHeaders,
+  buildSetupPayload,
   compute,
   decodeBinaryMessage,
   detectProvider,
   encodeBinaryMessage,
+  encodeSetupPayload,
   getMissingEnvVars,
   getProviderConfigFromEnv,
   getProviderHeaders,