merge

Author: christianalfoni

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.11.1](https://github.com/codesandbox/codesandbox-sdk/compare/v0.11.0...v0.11.1) (2025-03-13)
+
+
+### Bug Fixes
+
+* support `keepActiveWhileConnected` for browser sessions ([#81](https://github.com/codesandbox/codesandbox-sdk/issues/81)) ([ca1f825](https://github.com/codesandbox/codesandbox-sdk/commit/ca1f82582d2f12b84cdf379902c596e6d5bfed52))
+
+## [0.11.0](https://github.com/codesandbox/codesandbox-sdk/compare/v0.10.0...v0.11.0) (2025-03-11)
+
+
+### Features
+
+* add support for configuring auto-wake behaviour ([#79](https://github.com/codesandbox/codesandbox-sdk/issues/79)) ([8c2ef89](https://github.com/codesandbox/codesandbox-sdk/commit/8c2ef897b03ce2d3f4865f6e68e2c2f07824852c))
+
 ## [0.10.0](https://github.com/codesandbox/codesandbox-sdk/compare/v0.9.0...v0.10.0) (2025-02-28)
 
 

openapi.json

@@ -243,7 +243,7 @@
                     "type": "boolean"
                   },
                   "websocket": {
-                    "default": false,
+                    "default": true,
                     "description": "Whether the VM should automatically wake up on WebSocket connections",
                     "type": "boolean"
                   }
@@ -520,7 +520,7 @@
                 "type": "boolean"
               },
               "websocket": {
-                "default": false,
+                "default": true,
                 "description": "Whether the VM should automatically wake up on WebSocket connections",
                 "type": "boolean"
               }
@@ -1957,6 +1957,6 @@
     }
   },
   "security": [],
-  "servers": [{ "url": "https://api.codesandbox.io", "variables": {} }],
+  "servers": [{ "url": "https://api.codesandbox.stream", "variables": {} }],
   "tags": []
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@codesandbox/sdk",
-  "version": "0.10.0",
+  "version": "0.11.1",
   "description": "The CodeSandbox SDK",
   "author": "CodeSandbox",
   "license": "MIT",

package.json

@@ -212,6 +212,7 @@ function startOptionsFromOpts(opts: StartSandboxOpts | undefined) {
     ipcountry: opts.ipcountry,
     tier: opts.vmTier?.name,
     hibernation_timeout_seconds: opts.hibernationTimeoutSeconds,
+    automatic_wakeup_config: opts.automaticWakeupConfig,
   };
 }
 
@@ -240,6 +241,25 @@ export interface StartSandboxOpts {
    * Defaults to 300 seconds for free users, 1800 seconds for pro users. Maximum is 86400 seconds (1 day).
    */
   hibernationTimeoutSeconds?: number;
+
+  /**
+   * Configuration for when the VM should automatically wake up from hibernation.
+   */
+  automaticWakeupConfig?: {
+    /**
+     * Whether the VM should automatically wake up on HTTP requests to preview URLs (excludes WebSocket requests)
+     *
+     * @default true
+     */
+    http: boolean;
+
+    /**
+     * Whether the VM should automatically wake up on WebSocket connections to preview URLs
+     *
+     * @default false
+     */
+    websocket: boolean;
+  };
 }
 
 export type HandledResponse<D, E> = {

src/sandbox-client.ts

@@ -183,6 +183,30 @@ export class SandboxSession extends Disposable {
     this.pitcherClient.disconnect();
     this.dispose();
   }
+
+  private keepAliveInterval: NodeJS.Timeout | null = null;
+  /**
+   * If enabled, we will keep the sandbox from hibernating as long as the SDK is connected to it.
+   */
+  public keepActiveWhileConnected(enabled: boolean) {
+    if (enabled && !this.keepAliveInterval) {
+      this.keepAliveInterval = setInterval(() => {
+        this.pitcherClient.clients.system.update();
+      }, 1000 * 30);
+
+      this.onWillDispose(() => {
+        if (this.keepAliveInterval) {
+          clearInterval(this.keepAliveInterval);
+          this.keepAliveInterval = null;
+        }
+      });
+    } else {
+      if (this.keepAliveInterval) {
+        clearInterval(this.keepAliveInterval);
+        this.keepAliveInterval = null;
+      }
+    }
+  }
 }
 
 export class Sandbox extends SandboxSession {
@@ -281,28 +305,4 @@ export class Sandbox extends SandboxSession {
   public async updateHibernationTimeout(timeoutSeconds: number): Promise<void> {
     await this.sandboxClient.updateHibernationTimeout(this.id, timeoutSeconds);
   }
-
-  private keepAliveInterval: NodeJS.Timeout | null = null;
-  /**
-   * If enabled, we will keep the sandbox from hibernating as long as the SDK is connected to it.
-   */
-  public keepActiveWhileConnected(enabled: boolean) {
-    if (enabled && !this.keepAliveInterval) {
-      this.keepAliveInterval = setInterval(() => {
-        this.pitcherClient.clients.system.update();
-      }, 1000 * 30);
-
-      this.onWillDispose(() => {
-        if (this.keepAliveInterval) {
-          clearInterval(this.keepAliveInterval);
-          this.keepAliveInterval = null;
-        }
-      });
-    } else {
-      if (this.keepAliveInterval) {
-        clearInterval(this.keepAliveInterval);
-        this.keepAliveInterval = null;
-      }
-    }
-  }
 }

src/sandbox.ts

@@ -108,7 +108,7 @@ export class Shells extends Disposable {
    * ## Example
    *
    * ```ts
-   * const shell = await sandbox.shell.runCommand("echo 'Hello, world!'");
+   * const shell = sandbox.shell.run("echo 'Hello, world!'");
    *
    * shell.onOutput((data) => {
    *   console.log(data);