@e2b/code-interpreter 0.0.9-beta.7 → 0.0.9-beta.71

package/README.md

@@ -24,7 +24,7 @@ const sandbox = await CodeInterpreter.create()
 await sandbox.notebook.execCell('x = 1')
 
 const execution = await sandbox.notebook.execCell('x+=1; x')
-console.log(execution.text)  // outputs 2
+console.log(execution.text) // outputs 2
 
 await sandbox.close()
 ```
@@ -48,7 +48,7 @@ plt.show()
 `
 
 // you can install dependencies in "jupyter notebook style"
-await sandbox.notebook.execCell("!pip install matplotlib")
+await sandbox.notebook.execCell('!pip install matplotlib')
 
 const execution = await sandbox.notebook.execCell(code)
 
@@ -80,7 +80,7 @@ const sandbox = await CodeInterpreter.create()
 await sandbox.notebook.execCell(code, {
   onStdout: (out) => console.log(out),
   onStderr: (outErr) => console.error(outErr),
-  onResult: (result) => console.log(result.text)
+  onResult: (result) => console.log(result.text),
 })
 
 await sandbox.close()

package/dist/index.d.mts

@@ -1,6 +1,98 @@
-import { ConnectionConfig, Sandbox } from 'e2b';
+import { ConnectionConfig, Sandbox as Sandbox$1 } from 'e2b';
 export * from 'e2b';
 
+/**
+ * Graph types
+ */
+declare enum GraphType {
+    LINE = "line",
+    SCATTER = "scatter",
+    BAR = "bar",
+    PIE = "pie",
+    BOX_AND_WHISKER = "box_and_whisker",
+    SUPERGRAPH = "supergraph",
+    UNKNOWN = "unknown"
+}
+/**
+ * Ax scale types
+ */
+declare enum ScaleType {
+    LINEAR = "linear",
+    DATETIME = "datetime",
+    CATEGORICAL = "categorical",
+    LOG = "log",
+    SYMLOG = "symlog",
+    LOGIT = "logit",
+    FUNCTION = "function",
+    FUNCTIONLOG = "functionlog",
+    ASINH = "asinh"
+}
+type Graph = {
+    type: GraphType;
+    title: string;
+    elements: any[];
+};
+type Graph2D = Graph & {
+    x_label?: string;
+    y_label?: string;
+    x_unit?: string;
+    y_unit?: string;
+};
+type PointData = {
+    label: string;
+    points: [number | string, number | string][];
+};
+type PointGraph = Graph2D & {
+    x_ticks: (number | string)[];
+    x_scale: ScaleType;
+    x_tick_labels: string[];
+    y_ticks: (number | string)[];
+    y_scale: ScaleType;
+    y_tick_labels: string[];
+    elements: PointData[];
+};
+type LineGraph = PointGraph & {
+    type: GraphType.LINE;
+};
+type ScatterGraph = PointGraph & {
+    type: GraphType.SCATTER;
+};
+type BarData = {
+    label: string;
+    value: string;
+    group: string;
+};
+type BarGraph = Graph2D & {
+    type: GraphType.BAR;
+    elements: BarData[];
+};
+type PieData = {
+    label: string;
+    angle: number;
+    radius: number;
+};
+type PieGraph = Graph & {
+    type: GraphType.PIE;
+    elements: PieData[];
+};
+type BoxAndWhiskerData = {
+    label: string;
+    min: number;
+    first_quartile: number;
+    median: number;
+    third_quartile: number;
+    max: number;
+};
+type BoxAndWhiskerGraph = Graph2D & {
+    type: GraphType.BOX_AND_WHISKER;
+    elements: BoxAndWhiskerData[];
+};
+type SuperGraph = Graph & {
+    type: GraphType.SUPERGRAPH;
+    elements: Graph[];
+};
+type GraphTypes = LineGraph | ScatterGraph | BarGraph | PieGraph | BoxAndWhiskerGraph | SuperGraph;
+
 declare class OutputMessage {
     readonly line: string;
     /**
@@ -50,12 +142,16 @@ declare class ExecutionError {
  * Represents a MIME type.
  */
 type MIMEType = string;
+type E2BData = {
+    data: Record<string, unknown>;
+    graph: GraphTypes;
+};
 /**
- * Dictionary that maps MIME types to their corresponding string representations of the data.
+ * Dictionary that maps MIME types to their corresponding representations of the data.
  */
 type RawData = {
     [key: MIMEType]: string;
-};
+} & E2BData;
 /**
  * Represents the data to be displayed as a result of executing a cell in a Jupyter notebook.
  * The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics
@@ -107,6 +203,14 @@ declare class Result {
      * JavaScript representation of the data.
      */
     readonly javascript?: string;
+    /**
+     * Contains the data from DataFrame.
+     */
+    readonly data?: Record<string, unknown>;
+    /**
+     * Contains the graph data.
+     */
+    readonly graph?: GraphTypes;
     /**
      * Extra data that can be included. Not part of the standard types.
      */
@@ -200,33 +304,79 @@ declare class Execution {
     };
 }
 
+/**
+ * Code interpreter module for executing code in a stateful context.
+ */
 declare class JupyterExtension {
     private readonly url;
     private readonly connectionConfig;
     private static readonly execTimeoutMs;
     private static readonly defaultKernelID;
     constructor(url: string, connectionConfig: ConnectionConfig);
+    /**
+     * Runs the code in the specified context, if not specified, the default context is used.
+     * You can reference previously defined variables, imports, and functions in the code.
+     *
+     * @param code The code to execute
+     * @param opts Options for executing the code
+     * @param opts.kernelID The context ID to run the code in
+     * @param opts.onStdout Callback for handling stdout messages
+     * @param opts.onStderr Callback for handling stderr messages
+     * @param opts.onResult Callback for handling the final result
+     * @param opts.envs Environment variables to set for the execution
+     * @param opts.timeoutMs Max time to wait for the execution to finish
+     * @param opts.requestTimeoutMs Max time to wait for the request to finish
+     * @returns Execution object
+     */
     execCell(code: string, opts?: {
         kernelID?: string;
         onStdout?: (output: OutputMessage) => (Promise<any> | any);
         onStderr?: (output: OutputMessage) => (Promise<any> | any);
         onResult?: (data: Result) => (Promise<any> | any);
+        envs?: Record<string, string>;
         timeoutMs?: number;
         requestTimeoutMs?: number;
     }): Promise<Execution>;
+    /**
+     * Creates a new context to run code in.
+     *
+     * @param cwd The working directory for the context
+     * @param kernelName The name of the context
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     * @returns The context ID
+     */
     createKernel({ cwd, kernelName, requestTimeoutMs, }?: {
         cwd?: string;
         kernelName?: string;
         requestTimeoutMs?: number;
     }): Promise<string>;
+    /**
+     * Restarts the context.
+     * Restarting will clear all variables, imports, and other settings set during previous executions.
+     *
+     * @param kernelID The context ID to restart
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     */
     restartKernel({ kernelID, requestTimeoutMs, }?: {
         kernelID?: string;
         requestTimeoutMs?: number;
     }): Promise<void>;
+    /**
+     * Shuts down the context.
+     *
+     * @param kernelID The context ID to shut down
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     */
     shutdownKernel({ kernelID, requestTimeoutMs, }?: {
         kernelID?: string;
         requestTimeoutMs?: number;
     }): Promise<void>;
+    /**
+     * Lists all available contexts.
+     *
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     * @returns List of context IDs and names
+     */
     listKernels({ requestTimeoutMs, }?: {
         requestTimeoutMs?: number;
     }): Promise<{
@@ -234,10 +384,13 @@ declare class JupyterExtension {
         name: string;
     }[]>;
 }
-declare class CodeInterpreter extends Sandbox {
+/**
+ * Code interpreter module for executing code in a stateful context.
+ */
+declare class Sandbox extends Sandbox$1 {
     protected static readonly defaultTemplate: string;
     protected static readonly jupyterPort = 49999;
     readonly notebook: JupyterExtension;
 }
 
-export { CodeInterpreter, Execution, ExecutionError, JupyterExtension, type Logs, type MIMEType, OutputMessage, type RawData, Result, CodeInterpreter as default };
+export { type BarData, type BarGraph, type BoxAndWhiskerData, type BoxAndWhiskerGraph, Execution, ExecutionError, type Graph, GraphType, type GraphTypes, JupyterExtension, type LineGraph, type Logs, type MIMEType, OutputMessage, type PieData, type PieGraph, type PointData, type RawData, Result, Sandbox, ScaleType, type ScatterGraph, type SuperGraph, Sandbox as default };

package/dist/index.d.ts

@@ -1,6 +1,98 @@
-import { ConnectionConfig, Sandbox } from 'e2b';
+import { ConnectionConfig, Sandbox as Sandbox$1 } from 'e2b';
 export * from 'e2b';
 
+/**
+ * Graph types
+ */
+declare enum GraphType {
+    LINE = "line",
+    SCATTER = "scatter",
+    BAR = "bar",
+    PIE = "pie",
+    BOX_AND_WHISKER = "box_and_whisker",
+    SUPERGRAPH = "supergraph",
+    UNKNOWN = "unknown"
+}
+/**
+ * Ax scale types
+ */
+declare enum ScaleType {
+    LINEAR = "linear",
+    DATETIME = "datetime",
+    CATEGORICAL = "categorical",
+    LOG = "log",
+    SYMLOG = "symlog",
+    LOGIT = "logit",
+    FUNCTION = "function",
+    FUNCTIONLOG = "functionlog",
+    ASINH = "asinh"
+}
+type Graph = {
+    type: GraphType;
+    title: string;
+    elements: any[];
+};
+type Graph2D = Graph & {
+    x_label?: string;
+    y_label?: string;
+    x_unit?: string;
+    y_unit?: string;
+};
+type PointData = {
+    label: string;
+    points: [number | string, number | string][];
+};
+type PointGraph = Graph2D & {
+    x_ticks: (number | string)[];
+    x_scale: ScaleType;
+    x_tick_labels: string[];
+    y_ticks: (number | string)[];
+    y_scale: ScaleType;
+    y_tick_labels: string[];
+    elements: PointData[];
+};
+type LineGraph = PointGraph & {
+    type: GraphType.LINE;
+};
+type ScatterGraph = PointGraph & {
+    type: GraphType.SCATTER;
+};
+type BarData = {
+    label: string;
+    value: string;
+    group: string;
+};
+type BarGraph = Graph2D & {
+    type: GraphType.BAR;
+    elements: BarData[];
+};
+type PieData = {
+    label: string;
+    angle: number;
+    radius: number;
+};
+type PieGraph = Graph & {
+    type: GraphType.PIE;
+    elements: PieData[];
+};
+type BoxAndWhiskerData = {
+    label: string;
+    min: number;
+    first_quartile: number;
+    median: number;
+    third_quartile: number;
+    max: number;
+};
+type BoxAndWhiskerGraph = Graph2D & {
+    type: GraphType.BOX_AND_WHISKER;
+    elements: BoxAndWhiskerData[];
+};
+type SuperGraph = Graph & {
+    type: GraphType.SUPERGRAPH;
+    elements: Graph[];
+};
+type GraphTypes = LineGraph | ScatterGraph | BarGraph | PieGraph | BoxAndWhiskerGraph | SuperGraph;
+
 declare class OutputMessage {
     readonly line: string;
     /**
@@ -50,12 +142,16 @@ declare class ExecutionError {
  * Represents a MIME type.
  */
 type MIMEType = string;
+type E2BData = {
+    data: Record<string, unknown>;
+    graph: GraphTypes;
+};
 /**
- * Dictionary that maps MIME types to their corresponding string representations of the data.
+ * Dictionary that maps MIME types to their corresponding representations of the data.
  */
 type RawData = {
     [key: MIMEType]: string;
-};
+} & E2BData;
 /**
  * Represents the data to be displayed as a result of executing a cell in a Jupyter notebook.
  * The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics
@@ -107,6 +203,14 @@ declare class Result {
      * JavaScript representation of the data.
      */
     readonly javascript?: string;
+    /**
+     * Contains the data from DataFrame.
+     */
+    readonly data?: Record<string, unknown>;
+    /**
+     * Contains the graph data.
+     */
+    readonly graph?: GraphTypes;
     /**
      * Extra data that can be included. Not part of the standard types.
      */
@@ -200,33 +304,79 @@ declare class Execution {
     };
 }
 
+/**
+ * Code interpreter module for executing code in a stateful context.
+ */
 declare class JupyterExtension {
     private readonly url;
     private readonly connectionConfig;
     private static readonly execTimeoutMs;
     private static readonly defaultKernelID;
     constructor(url: string, connectionConfig: ConnectionConfig);
+    /**
+     * Runs the code in the specified context, if not specified, the default context is used.
+     * You can reference previously defined variables, imports, and functions in the code.
+     *
+     * @param code The code to execute
+     * @param opts Options for executing the code
+     * @param opts.kernelID The context ID to run the code in
+     * @param opts.onStdout Callback for handling stdout messages
+     * @param opts.onStderr Callback for handling stderr messages
+     * @param opts.onResult Callback for handling the final result
+     * @param opts.envs Environment variables to set for the execution
+     * @param opts.timeoutMs Max time to wait for the execution to finish
+     * @param opts.requestTimeoutMs Max time to wait for the request to finish
+     * @returns Execution object
+     */
     execCell(code: string, opts?: {
         kernelID?: string;
         onStdout?: (output: OutputMessage) => (Promise<any> | any);
         onStderr?: (output: OutputMessage) => (Promise<any> | any);
         onResult?: (data: Result) => (Promise<any> | any);
+        envs?: Record<string, string>;
         timeoutMs?: number;
         requestTimeoutMs?: number;
     }): Promise<Execution>;
+    /**
+     * Creates a new context to run code in.
+     *
+     * @param cwd The working directory for the context
+     * @param kernelName The name of the context
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     * @returns The context ID
+     */
     createKernel({ cwd, kernelName, requestTimeoutMs, }?: {
         cwd?: string;
         kernelName?: string;
         requestTimeoutMs?: number;
     }): Promise<string>;
+    /**
+     * Restarts the context.
+     * Restarting will clear all variables, imports, and other settings set during previous executions.
+     *
+     * @param kernelID The context ID to restart
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     */
     restartKernel({ kernelID, requestTimeoutMs, }?: {
         kernelID?: string;
         requestTimeoutMs?: number;
     }): Promise<void>;
+    /**
+     * Shuts down the context.
+     *
+     * @param kernelID The context ID to shut down
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     */
     shutdownKernel({ kernelID, requestTimeoutMs, }?: {
         kernelID?: string;
         requestTimeoutMs?: number;
     }): Promise<void>;
+    /**
+     * Lists all available contexts.
+     *
+     * @param requestTimeoutMs Max time to wait for the request to finish
+     * @returns List of context IDs and names
+     */
     listKernels({ requestTimeoutMs, }?: {
         requestTimeoutMs?: number;
     }): Promise<{
@@ -234,10 +384,13 @@ declare class JupyterExtension {
         name: string;
     }[]>;
 }
-declare class CodeInterpreter extends Sandbox {
+/**
+ * Code interpreter module for executing code in a stateful context.
+ */
+declare class Sandbox extends Sandbox$1 {
     protected static readonly defaultTemplate: string;
     protected static readonly jupyterPort = 49999;
     readonly notebook: JupyterExtension;
 }
 
-export { CodeInterpreter, Execution, ExecutionError, JupyterExtension, type Logs, type MIMEType, OutputMessage, type RawData, Result, CodeInterpreter as default };
+export { type BarData, type BarGraph, type BoxAndWhiskerData, type BoxAndWhiskerGraph, Execution, ExecutionError, type Graph, GraphType, type GraphTypes, JupyterExtension, type LineGraph, type Logs, type MIMEType, OutputMessage, type PieData, type PieGraph, type PointData, type RawData, Result, Sandbox, ScaleType, type ScatterGraph, type SuperGraph, Sandbox as default };