Add .fromBunImage and .bunInstall to the SDK (#993)

<!-- CURSOR_SUMMARY -->
> [!NOTE]
> Adds `fromBunImage` and `bunInstall` to JS/Python SDKs, and extends
`npmInstall` with a `dev` flag, with tests across sync/async suites.
> 
> - **Template APIs**:
> - Add `fromBunImage` to start from `oven/bun:<variant>` in
`packages/js-sdk/src/template/index.ts` and
`packages/python-sdk/e2b/template/main.py`.
>   - Add `bunInstall(packages, { g, dev })` in both SDKs.
>   - Extend `npmInstall` to accept `{ dev: boolean }` in both SDKs.
> - **Types/Docs**:
> - Update `packages/js-sdk/src/template/types.ts` to declare
`fromBunImage`, `bunInstall`, and `npmInstall` `dev` option.
> - **Tests**:
> - Add tests for `fromBunImage` and `bunInstall` and update
`npmInstall` (global/dev) in JS (`packages/js-sdk/tests/...`) and Python
sync/async (`packages/python-sdk/tests/...`).
> - **Changeset**:
> - Minor releases for `@e2b/python-sdk` and `e2b`
(`.changeset/silly-lions-buy.md`).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
b6461d0. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: mishushakov

.changeset/silly-lions-buy.md

@@ -0,0 +1,6 @@
+---
+'@e2b/python-sdk': minor
+'e2b': minor
+---
+
+add from bun image and bun install

packages/js-sdk/src/template/index.ts

@@ -138,6 +138,10 @@ export class TemplateBase
     return this.fromImage(`node:${variant}`)
   }
 
+  fromBunImage(variant: string = 'latest'): TemplateBuilder {
+    return this.fromImage(`oven/bun:${variant}`)
+  }
+
   fromBaseImage(): TemplateBuilder {
     return this.fromImage(this.defaultBaseImage)
   }
@@ -448,7 +452,7 @@ export class TemplateBase
 
   npmInstall(
     packages?: string | string[],
-    options?: { g?: boolean }
+    options?: { g?: boolean; dev?: boolean }
   ): TemplateBuilder {
     const args = ['npm', 'install']
     const packageList = packages
@@ -459,6 +463,36 @@ export class TemplateBase
     if (options?.g) {
       args.push('-g')
     }
+    if (options?.dev) {
+      args.push('--save-dev')
+    }
+    if (packageList) {
+      args.push(...packageList)
+    }
+
+    return this.runInNewStackTraceContext(() =>
+      this.runCmd(args.join(' '), {
+        user: options?.g ? 'root' : undefined,
+      })
+    )
+  }
+
+  bunInstall(
+    packages?: string | string[],
+    options?: { g?: boolean; dev?: boolean }
+  ): TemplateBuilder {
+    const args = ['bun', 'install']
+    const packageList = packages
+      ? Array.isArray(packages)
+        ? packages
+        : [packages]
+      : undefined
+    if (options?.g) {
+      args.push('-g')
+    }
+    if (options?.dev) {
+      args.push('--dev')
+    }
     if (packageList) {
       args.push(...packageList)
     }

packages/js-sdk/src/template/types.ts

@@ -150,6 +150,17 @@ export interface TemplateFromImage {
    */
   fromNodeImage(variant?: string): TemplateBuilder
 
+  /**
+   * Start from a Bun-based Docker image.
+   * @param variant Bun variant (default: 'latest')
+   *
+   * @example
+   * ```ts
+   * Template().fromBunImage('1.3')
+   * ```
+   */
+  fromBunImage(variant?: string): TemplateBuilder
+
   /**
    * Start from E2B's default base image (e2bdev/base:latest).
    *
@@ -454,13 +465,32 @@ export interface TemplateBuilder {
    * ```ts
    * template.npmInstall('express')
    * template.npmInstall(['lodash', 'axios'])
-   * template.npmInstall('typescript', { g: true })
+   * template.npmInstall('tsx', { g: true })
+   * template.npmInstall('typescript', { dev: true })
    * template.npmInstall()  // Installs from package.json
    * ```
    */
   npmInstall(
     packages?: string | string[],
-    options?: { g?: boolean }
+    options?: { g?: boolean; dev?: boolean }
+  ): TemplateBuilder
+  /**
+   * Install Bun packages using bun.
+   * @param packages Package name(s) or undefined for package.json
+   * @param options Install options
+   *
+   * @example
+   * ```ts
+   * template.bunInstall('express')
+   * template.bunInstall(['lodash', 'axios'])
+   * template.bunInstall('tsx', { g: true })
+   * template.bunInstall('typescript', { dev: true })
+   * template.bunInstall()  // Installs from package.json
+   * ```
+   */
+  bunInstall(
+    packages?: string | string[],
+    options?: { g?: boolean; dev?: boolean }
   ): TemplateBuilder
 
   /**

packages/js-sdk/tests/template/methods/bunInstall.test.ts

@@ -0,0 +1,26 @@
+import { Template } from '../../../src'
+import { buildTemplateTest } from '../../setup'
+
+buildTemplateTest('bun install', async ({ buildTemplate }) => {
+  const template = Template()
+    .fromBunImage('1.3')
+    .bunInstall(['lodash', 'axios'])
+
+  await buildTemplate(template)
+})
+
+buildTemplateTest('bun install global', async ({ buildTemplate }) => {
+  const template = Template()
+    .fromBunImage('1.3')
+    .bunInstall(['tsx'], { g: true })
+
+  await buildTemplate(template)
+})
+
+buildTemplateTest('bun install dev', async ({ buildTemplate }) => {
+  const template = Template()
+    .fromBunImage('1.3')
+    .bunInstall(['typescript'], { dev: true })
+
+  await buildTemplate(template)
+})

packages/js-sdk/tests/template/methods/fromMethods.test.ts

@@ -64,6 +64,16 @@ buildTemplateTest('fromNodeImage with variant', async ({ buildTemplate }) => {
   await buildTemplate(template)
 })
 
+buildTemplateTest('fromBunImage', async ({ buildTemplate }) => {
+  const template = Template().fromBunImage()
+  await buildTemplate(template)
+})
+
+buildTemplateTest('fromBunImage with variant', async ({ buildTemplate }) => {
+  const template = Template().fromBunImage('1.3')
+  await buildTemplate(template)
+})
+
 buildTemplateTest('fromImage', async ({ buildTemplate }) => {
   const template = Template().fromImage('ubuntu:22.04')
   await buildTemplate(template)

packages/js-sdk/tests/template/methods/npmInstall.test.ts

@@ -2,15 +2,25 @@ import { Template } from '../../../src'
 import { buildTemplateTest } from '../../setup'
 
 buildTemplateTest('npm install', async ({ buildTemplate }) => {
-  const template = Template().fromNodeImage('24').npmInstall(['lodash', 'ms'])
+  const template = Template()
+    .fromNodeImage('24')
+    .npmInstall(['lodash', 'axios'])
 
   await buildTemplate(template)
 })
 
 buildTemplateTest('npm install global', async ({ buildTemplate }) => {
   const template = Template()
     .fromNodeImage('24')
-    .npmInstall(['lodash', 'ms'], { g: true })
+    .npmInstall(['tsx'], { g: true })
+
+  await buildTemplate(template)
+})
+
+buildTemplateTest('npm install dev', async ({ buildTemplate }) => {
+  const template = Template()
+    .fromNodeImage('24')
+    .npmInstall(['typescript'], { dev: true })
 
   await buildTemplate(template)
 })

packages/python-sdk/e2b/template/main.py

@@ -365,12 +365,14 @@ def npm_install(
         self,
         packages: Optional[Union[str, List[str]]] = None,
         g: Optional[bool] = False,
+        dev: Optional[bool] = False,
     ) -> "TemplateBuilder":
         """
         Install Node.js packages using npm.
 
         :param packages: Package name(s) to install. If None, installs from package.json
         :param g: Install packages globally
+        :param dev: Install packages as dev dependencies
 
         :return: `TemplateBuilder` class
 
@@ -388,6 +390,47 @@ def npm_install(
         args = ["npm", "install"]
         if g:
             args.append("-g")
+        if dev:
+            args.append("--save-dev")
+        if packages:
+            args.extend(packages)
+
+        return self._template._run_in_new_stack_trace_context(
+            lambda: self.run_cmd(" ".join(args), user="root" if g else None)
+        )
+
+    def bun_install(
+        self,
+        packages: Optional[Union[str, List[str]]] = None,
+        g: Optional[bool] = False,
+        dev: Optional[bool] = False,
+    ) -> "TemplateBuilder":
+        """
+        Install Bun packages using bun.
+
+        :param packages: Package name(s) to install. If None, installs from package.json
+        :param g: Install packages globally
+        :param dev: Install packages as dev dependencies
+
+        :return: `TemplateBuilder` class
+
+        Example
+        ```python
+        template.bun_install('express')
+        template.bun_install(['lodash', 'axios'])
+        template.bun_install('tsx', g=True)
+        template.bun_install('typescript', dev=True)
+        template.bun_install()  // Installs from package.json
+        ```
+        """
+        if isinstance(packages, str):
+            packages = [packages]
+
+        args = ["bun", "install"]
+        if g:
+            args.append("-g")
+        if dev:
+            args.append("--dev")
         if packages:
             args.extend(packages)
 
@@ -924,6 +967,18 @@ def from_node_image(self, variant: str = "lts") -> TemplateBuilder:
             lambda: self.from_image(f"node:{variant}")
         )
 
+    def from_bun_image(self, variant: str = "latest") -> TemplateBuilder:
+        """
+        Start template from a Bun base image.
+
+        :param variant: Bun image variant (default: 'latest')
+
+        :return: `TemplateBuilder` class
+        """
+        return self._run_in_new_stack_trace_context(
+            lambda: self.from_image(f"oven/bun:{variant}")
+        )
+
     def from_base_image(self) -> TemplateBuilder:
         """
         Start template from the E2B base image (e2bdev/base:latest).

packages/python-sdk/tests/async/template_async/methods/test_bun_install.py

@@ -0,0 +1,26 @@
+import pytest
+
+from e2b import AsyncTemplate
+
+
+@pytest.mark.skip_debug()
+async def test_bun_install(async_build):
+    template = AsyncTemplate().from_bun_image("1.3").bun_install(["lodash", "axios"])
+
+    await async_build(template)
+
+
+@pytest.mark.skip_debug()
+async def test_bun_install_global(async_build):
+    template = AsyncTemplate().from_bun_image("1.3").bun_install(["tsx"], g=True)
+
+    await async_build(template)
+
+
+@pytest.mark.skip_debug()
+async def test_bun_install_dev(async_build):
+    template = (
+        AsyncTemplate().from_bun_image("1.3").bun_install(["typescript"], dev=True)
+    )
+
+    await async_build(template)

packages/python-sdk/tests/async/template_async/methods/test_from_methods.py

@@ -70,6 +70,18 @@ async def test_from_node_image(async_build):
     await async_build(template)
 
 
+@pytest.mark.skip_debug()
+async def test_from_bun_image(async_build):
+    template = AsyncTemplate().from_bun_image()
+    await async_build(template)
+
+
+@pytest.mark.skip_debug()
+async def test_from_bun_image_with_variant(async_build):
+    template = AsyncTemplate().from_bun_image("1.3")
+    await async_build(template)
+
+
 @pytest.mark.skip_debug()
 async def test_from_node_image_with_variant(async_build):
     template = AsyncTemplate().from_node_image("24")

packages/python-sdk/tests/async/template_async/methods/test_npm_install.py

@@ -5,15 +5,22 @@
 
 @pytest.mark.skip_debug()
 async def test_npm_install(async_build):
-    template = AsyncTemplate().from_node_image("24").npm_install(["lodash", "ms"])
+    template = AsyncTemplate().from_node_image("24").npm_install(["lodash", "axios"])
 
     await async_build(template)
 
 
 @pytest.mark.skip_debug()
 async def test_npm_install_global(async_build):
+    template = AsyncTemplate().from_node_image("24").npm_install(["tsx"], g=True)
+
+    await async_build(template)
+
+
+@pytest.mark.skip_debug()
+async def test_npm_install_dev(async_build):
     template = (
-        AsyncTemplate().from_node_image("24").npm_install(["lodash", "ms"], g=True)
+        AsyncTemplate().from_node_image("24").npm_install(["typescript"], dev=True)
     )
 
     await async_build(template)