@daytonaio/sdk 0.11.2 → 0.12.0

package/dist/Git.js

@@ -1,48 +1,11 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = void 0;
 /**
- * The Daytona SDK provides built-in Git support. This guide covers all available Git
- * operations and best practices. Daytona SDK provides an option to clone, check status,
- * and manage Git repositories in Sandboxes. You can interact with Git repositories using
- * the `git` module.
- *
- * @module Git
- *
- * @example
- * // Basic Git workflow
- * // Create and initialize sandbox
- * const sandbox = await daytona.create();
- *
- * // Clone a repository
- * await sandbox.git.clone(
- *   'https://github.com/user/repo.git',
- *   '/workspace/repo'
- * );
- *
- * // Make some changes
- * await sandbox.fs.uploadFile(
- *   '/workspace/repo/test.txt',
- *   new File([Buffer.from('Hello, World!')], 'test.txt')
- * );
- *
- * // Stage and commit changes
- * await sandbox.git.add('/workspace/repo', ['test.txt']);
- * await sandbox.git.commit(
- *   '/workspace/repo',
- *   'Add test file',
- *   'John Doe',
- *   'john@example.com'
- * );
- *
- * // Push changes (with authentication)
- * await sandbox.git.push(
- *   '/workspace/repo',
- *   'user',
- *   'token'
- * );
+ * Provides Git operations within a Sandbox.
  *
+ * @class
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Git = void 0;
 class Git {
     constructor(sandbox, toolboxApi, instance) {
         this.sandbox = sandbox;
@@ -50,9 +13,7 @@ class Git {
         this.instance = instance;
     }
     /**
-     * Stages files for commit.
-     *
-     * This method stages the specified files for the next commit, similar to
+     * Stages the specified files for the next commit, similar to
      * running 'git add' on the command line.
      *
      * @param {string} path - Absolute path to the Git repository root
@@ -76,8 +37,6 @@ class Git {
     /**
      * List branches in the repository.
      *
-     * This method returns information about all branches in the repository.
-     *
      * @param {string} path - Absolute path to the Git repository root
      * @returns {Promise<ListBranchResponse>} List of branches in the repository
      *
@@ -90,9 +49,7 @@ class Git {
         return response.data;
     }
     /**
-     * Clones a Git repository.
-     *
-     * This method clones a Git repository into the specified path. It supports
+     * Clones a Git repository into the specified path. It supports
      * cloning specific branches or commits, and can authenticate with the remote
      * repository if credentials are provided.
      *
@@ -142,9 +99,6 @@ class Git {
     /**
      * Commits staged changes.
      *
-     * This method creates a new commit with the staged changes. Make sure to stage
-     * changes using the add() method before committing.
-     *
      * @param {string} path - Absolute path to the Git repository root
      * @param {string} message - Commit message describing the changes
      * @param {string} author - Name of the commit author
@@ -162,19 +116,19 @@ class Git {
      * );
      */
     async commit(path, message, author, email) {
-        await this.toolboxApi.gitCommitChanges(this.instance.id, {
+        const response = await this.toolboxApi.gitCommitChanges(this.instance.id, {
             path,
             message,
             author,
             email,
         });
+        return {
+            sha: response.data.hash,
+        };
     }
     /**
      * Push local changes to the remote repository.
      *
-     * This method pushes committed changes to the remote repository. If the remote
-     * requires authentication, username and password/token must be provided.
-     *
      * @param {string} path - Absolute path to the Git repository root
      * @param {string} [username] - Git username for authentication
      * @param {string} [password] - Git password or token for authentication
@@ -202,9 +156,6 @@ class Git {
     /**
      * Pulls changes from the remote repository.
      *
-     * This method fetches and merges changes from the remote repository. If the remote
-     * requires authentication, username and password/token must be provided.
-     *
      * @param {string} path - Absolute path to the Git repository root
      * @param {string} [username] - Git username for authentication
      * @param {string} [password] - Git password or token for authentication
@@ -232,9 +183,6 @@ class Git {
     /**
      * Gets the current status of the Git repository.
      *
-     * This method returns information about the current state of the repository,
-     * including staged and unstaged changes, current branch, and untracked files.
-     *
      * @param {string} path - Absolute path to the Git repository root
      * @returns {Promise<GitStatus>} Current repository status including:
      *                               - currentBranch: Name of the current branch

package/dist/LspServer.d.ts

@@ -1,42 +1,3 @@
-/**
- * The Daytona SDK provides Language Server Protocol (LSP) support through Sandbox instances.
- * This enables advanced language features like code completion, diagnostics, and more.
- *
- * The LSP server must be started with start() before using any other methods,
- * and should be stopped with stop() when no longer needed to free resources.
- *
- * @module LspServer
- *
- * @example
- * // Basic LSP server usage
- * // Create and initialize sandbox
- * const sandbox = await daytona.create();
- *
- * // Create and start LSP server
- * const lsp = sandbox.createLspServer('typescript', '/workspace/project');
- * await lsp.start();
- *
- * // Open a file for editing
- * await lsp.didOpen('/workspace/project/src/index.ts');
- *
- * // Get completions at a position
- * const completions = await lsp.completions(
- *   '/workspace/project/src/index.ts',
- *   { line: 10, character: 15 }
- * );
- * console.log('Completions:', completions);
- *
- * // Get document symbols
- * const symbols = await lsp.documentSymbols('/workspace/project/src/index.ts');
- * symbols.forEach(symbol => {
- *   console.log(`${symbol.name}: ${symbol.kind}`);
- * });
- *
- * // Clean up
- * await lsp.didClose('/workspace/project/src/index.ts');
- * await lsp.stop();
- *
- */
 import { CompletionList, LspSymbol, ToolboxApi } from '@daytonaio/api-client';
 import { SandboxInstance } from './Sandbox';
 /**
@@ -48,12 +9,10 @@ export declare enum LspLanguageId {
     JAVASCRIPT = "javascript"
 }
 /**
- * Represents a position in a text document.
- *
- * This interface represents a zero-based position within a text document,
+ * Represents a zero-based position within a text document,
  * specified by line number and character offset.
  *
- * @interface Position
+ * @interface
  * @property {number} line - Zero-based line number in the document
  * @property {number} character - Zero-based character offset on the line
  *
@@ -70,17 +29,15 @@ export type Position = {
     character: number;
 };
 /**
- * Provides Language Server Protocol functionality for code intelligence.
- *
- * This class implements a subset of the Language Server Protocol (LSP) to provide
+ * Provides Language Server Protocol functionality for code intelligence to provide
  * IDE-like features such as code completion, symbol search, and more.
  *
- * @class LspServer
- *
  * @property {LspLanguageId} languageId - The language server type (e.g., "typescript")
  * @property {string} pathToProject - Absolute path to the project root directory
  * @property {ToolboxApi} toolboxApi - API client for Sandbox operations
  * @property {SandboxInstance} instance - The Sandbox instance this server belongs to
+ *
+ * @class
  */
 export declare class LspServer {
     private readonly languageId;
@@ -89,9 +46,7 @@ export declare class LspServer {
     private readonly instance;
     constructor(languageId: LspLanguageId, pathToProject: string, toolboxApi: ToolboxApi, instance: SandboxInstance);
     /**
-     * Starts the language server.
-     *
-     * This method must be called before using any other LSP functionality.
+     * Starts the language server, must be called before using any other LSP functionality.
      * It initializes the language server for the specified language and project.
      *
      * @returns {Promise<void>}
@@ -103,9 +58,7 @@ export declare class LspServer {
      */
     start(): Promise<void>;
     /**
-     * Stops the language server.
-     *
-     * This method should be called when the LSP server is no longer needed to
+     * Stops the language server, should be called when the LSP server is no longer needed to
      * free up system resources.
      *
      * @returns {Promise<void>}
@@ -116,9 +69,7 @@ export declare class LspServer {
      */
     stop(): Promise<void>;
     /**
-     * Notifies the language server that a file has been opened.
-     *
-     * This method should be called when a file is opened in the editor to enable
+     * Notifies the language server that a file has been opened, enabling
      * language features like diagnostics and completions for that file. The server
      * will begin tracking the file's contents and providing language features.
      *
@@ -132,10 +83,8 @@ export declare class LspServer {
      */
     didOpen(path: string): Promise<void>;
     /**
-     * Notifies the language server that a file has been closed.
-     *
-     * This method should be called when a file is closed in the editor to allow
-     * the language server to clean up any resources associated with that file.
+     * Notifies the language server that a file has been closed, should be called when a file is closed
+     * in the editor to allow the language server to clean up any resources associated with that file.
      *
      * @param {string} path - Absolute path to the closed file
      * @returns {Promise<void>}
@@ -146,10 +95,7 @@ export declare class LspServer {
      */
     didClose(path: string): Promise<void>;
     /**
-     * Get symbol information from a document.
-     *
-     * This method returns information about all symbols (functions, classes,
-     * variables, etc.) defined in the specified document.
+     * Get symbol information (functions, classes, variables, etc.) from a document.
      *
      * @param {string} path - Absolute path to the file to get symbols from
      * @returns {Promise<LspSymbol[]>} List of symbols in the document. Each symbol includes:
@@ -166,11 +112,7 @@ export declare class LspServer {
      */
     documentSymbols(path: string): Promise<LspSymbol[]>;
     /**
-     * Searches for symbols across the entire Sandbox.
-     *
-     * This method searches for symbols matching the query string across all files
-     * in the Sandbox. It's useful for finding declarations and definitions
-     * without knowing which file they're in.
+     * Searches for symbols matching the query string across the entire Sandbox.
      *
      * @param {string} query - Search query to match against symbol names
      * @returns {Promise<LspSymbol[]>} List of matching symbols from all files. Each symbol includes:
@@ -182,11 +124,7 @@ export declare class LspServer {
      */
     workspaceSymbols(query: string): Promise<LspSymbol[]>;
     /**
-     * Searches for symbols across the entire Sandbox.
-     *
-     * This method searches for symbols matching the query string across all files
-     * in the Sandbox. It's useful for finding declarations and definitions
-     * without knowing which file they're in.
+     * Searches for symbols matching the query string across the entire Sandbox.
      *
      * @param {string} query - Search query to match against symbol names
      * @returns {Promise<LspSymbol[]>} List of matching symbols from all files. Each symbol includes:

package/dist/LspServer.js

@@ -1,43 +1,4 @@
 "use strict";
-/**
- * The Daytona SDK provides Language Server Protocol (LSP) support through Sandbox instances.
- * This enables advanced language features like code completion, diagnostics, and more.
- *
- * The LSP server must be started with start() before using any other methods,
- * and should be stopped with stop() when no longer needed to free resources.
- *
- * @module LspServer
- *
- * @example
- * // Basic LSP server usage
- * // Create and initialize sandbox
- * const sandbox = await daytona.create();
- *
- * // Create and start LSP server
- * const lsp = sandbox.createLspServer('typescript', '/workspace/project');
- * await lsp.start();
- *
- * // Open a file for editing
- * await lsp.didOpen('/workspace/project/src/index.ts');
- *
- * // Get completions at a position
- * const completions = await lsp.completions(
- *   '/workspace/project/src/index.ts',
- *   { line: 10, character: 15 }
- * );
- * console.log('Completions:', completions);
- *
- * // Get document symbols
- * const symbols = await lsp.documentSymbols('/workspace/project/src/index.ts');
- * symbols.forEach(symbol => {
- *   console.log(`${symbol.name}: ${symbol.kind}`);
- * });
- *
- * // Clean up
- * await lsp.didClose('/workspace/project/src/index.ts');
- * await lsp.stop();
- *
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LspServer = exports.LspLanguageId = void 0;
 /**
@@ -50,17 +11,15 @@ var LspLanguageId;
     LspLanguageId["JAVASCRIPT"] = "javascript";
 })(LspLanguageId || (exports.LspLanguageId = LspLanguageId = {}));
 /**
- * Provides Language Server Protocol functionality for code intelligence.
- *
- * This class implements a subset of the Language Server Protocol (LSP) to provide
+ * Provides Language Server Protocol functionality for code intelligence to provide
  * IDE-like features such as code completion, symbol search, and more.
  *
- * @class LspServer
- *
  * @property {LspLanguageId} languageId - The language server type (e.g., "typescript")
  * @property {string} pathToProject - Absolute path to the project root directory
  * @property {ToolboxApi} toolboxApi - API client for Sandbox operations
  * @property {SandboxInstance} instance - The Sandbox instance this server belongs to
+ *
+ * @class
  */
 class LspServer {
     constructor(languageId, pathToProject, toolboxApi, instance) {
@@ -73,9 +32,7 @@ class LspServer {
         }
     }
     /**
-     * Starts the language server.
-     *
-     * This method must be called before using any other LSP functionality.
+     * Starts the language server, must be called before using any other LSP functionality.
      * It initializes the language server for the specified language and project.
      *
      * @returns {Promise<void>}
@@ -92,9 +49,7 @@ class LspServer {
         });
     }
     /**
-     * Stops the language server.
-     *
-     * This method should be called when the LSP server is no longer needed to
+     * Stops the language server, should be called when the LSP server is no longer needed to
      * free up system resources.
      *
      * @returns {Promise<void>}
@@ -110,9 +65,7 @@ class LspServer {
         });
     }
     /**
-     * Notifies the language server that a file has been opened.
-     *
-     * This method should be called when a file is opened in the editor to enable
+     * Notifies the language server that a file has been opened, enabling
      * language features like diagnostics and completions for that file. The server
      * will begin tracking the file's contents and providing language features.
      *
@@ -132,10 +85,8 @@ class LspServer {
         });
     }
     /**
-     * Notifies the language server that a file has been closed.
-     *
-     * This method should be called when a file is closed in the editor to allow
-     * the language server to clean up any resources associated with that file.
+     * Notifies the language server that a file has been closed, should be called when a file is closed
+     * in the editor to allow the language server to clean up any resources associated with that file.
      *
      * @param {string} path - Absolute path to the closed file
      * @returns {Promise<void>}
@@ -152,10 +103,7 @@ class LspServer {
         });
     }
     /**
-     * Get symbol information from a document.
-     *
-     * This method returns information about all symbols (functions, classes,
-     * variables, etc.) defined in the specified document.
+     * Get symbol information (functions, classes, variables, etc.) from a document.
      *
      * @param {string} path - Absolute path to the file to get symbols from
      * @returns {Promise<LspSymbol[]>} List of symbols in the document. Each symbol includes:
@@ -175,11 +123,7 @@ class LspServer {
         return response.data;
     }
     /**
-     * Searches for symbols across the entire Sandbox.
-     *
-     * This method searches for symbols matching the query string across all files
-     * in the Sandbox. It's useful for finding declarations and definitions
-     * without knowing which file they're in.
+     * Searches for symbols matching the query string across the entire Sandbox.
      *
      * @param {string} query - Search query to match against symbol names
      * @returns {Promise<LspSymbol[]>} List of matching symbols from all files. Each symbol includes:
@@ -193,11 +137,7 @@ class LspServer {
         return await this.sandboxSymbols(query);
     }
     /**
-     * Searches for symbols across the entire Sandbox.
-     *
-     * This method searches for symbols matching the query string across all files
-     * in the Sandbox. It's useful for finding declarations and definitions
-     * without knowing which file they're in.
+     * Searches for symbols matching the query string across the entire Sandbox.
      *
      * @param {string} query - Search query to match against symbol names
      * @returns {Promise<LspSymbol[]>} List of matching symbols from all files. Each symbol includes:

package/dist/Process.d.ts

@@ -1,42 +1,8 @@
-/**
- * The Daytona SDK provides powerful process and code execution capabilities through
- * the `process` module in Sandboxes. This guide covers all available process operations
- * and best practices.
- *
- * @module Process
- *
- * @example
- * // Execute a shell command
- * const response = await sandbox.process.executeCommand('ls -la');
- * console.log(response.result);
- *
- * // Run TypeScript code
- * const response = await sandbox.process.codeRun('console.log("Hello, World!")');
- * console.log(response.result);
- *
- * @example
- * // Using interactive sessions
- * // Create a new session
- * const sessionId = 'my-session';
- * await sandbox.process.createSession(sessionId);
- *
- * // Execute commands in the session
- * const response = await sandbox.process.executeSessionCommand(sessionId, {
- *   command: 'cd /workspace'
- * });
- *
- * const response2 = await sandbox.process.executeSessionCommand(sessionId, {
- *   command: 'pwd'
- * });
- * console.log(response2.result);  // Should print "/workspace"
- *
- * // Clean up
- * await sandbox.process.deleteSession(sessionId);
- */
-import { Command, ExecuteResponse, Session, SessionExecuteRequest, SessionExecuteResponse, ToolboxApi } from '@daytonaio/api-client';
+import { Command, Session, SessionExecuteRequest, SessionExecuteResponse, ToolboxApi } from '@daytonaio/api-client';
 import { SandboxCodeToolbox, SandboxInstance } from './Sandbox';
+import { ExecuteResponse } from './types/ExecuteResponse';
 /**
- * Parameters for code execution
+ * Parameters for code execution.
  */
 export declare class CodeRunParams {
     /**
@@ -48,6 +14,11 @@ export declare class CodeRunParams {
      */
     env?: Record<string, string>;
 }
+/**
+ * Handles process and code execution within a Sandbox.
+ *
+ * @class
+ */
 export declare class Process {
     private readonly codeToolbox;
     private readonly toolboxApi;
@@ -62,11 +33,12 @@ export declare class Process {
      * @returns {Promise<ExecuteResponse>} Command execution results containing:
      *                                    - exitCode: The command's exit status
      *                                    - result: Standard output from the command
+     *                                    - artifacts: ExecutionArtifacts object containing `stdout` (same as result) and `charts` (matplotlib charts metadata)
      *
      * @example
      * // Simple command
      * const response = await process.executeCommand('echo "Hello"');
-     * console.log(response.result);  // Prints: Hello
+     * console.log(response.artifacts.stdout);  // Prints: Hello
      *
      * @example
      * // Command with working directory
@@ -82,9 +54,11 @@ export declare class Process {
      *
      * @param {string} code - Code to execute
      * @param {CodeRunParams} params - Parameters for code execution
+     * @param {number} [timeout] - Maximum time in seconds to wait for execution to complete
      * @returns {Promise<ExecuteResponse>} Code execution results containing:
      *                                    - exitCode: The execution's exit status
      *                                    - result: Standard output from the code
+     *                                    - artifacts: ExecutionArtifacts object containing `stdout` (same as result) and `charts` (matplotlib charts metadata)
      *
      * @example
      * // Run TypeScript code
@@ -93,7 +67,45 @@ export declare class Process {
      *   const y = 20;
      *   console.log(\`Sum: \${x + y}\`);
      * `);
-     * console.log(response.result);  // Prints: Sum: 30
+     * console.log(response.artifacts.stdout);  // Prints: Sum: 30
+     *
+     * @example
+     * // Run Python code with matplotlib
+     * const response = await process.codeRun(`
+     * import matplotlib.pyplot as plt
+     * import numpy as np
+     *
+     * x = np.linspace(0, 10, 30)
+     * y = np.sin(x)
+     *
+     * plt.figure(figsize=(8, 5))
+     * plt.plot(x, y, 'b-', linewidth=2)
+     * plt.title('Line Chart')
+     * plt.xlabel('X-axis (seconds)')
+     * plt.ylabel('Y-axis (amplitude)')
+     * plt.grid(True)
+     * plt.show()
+     * `);
+     *
+     * if (response.artifacts?.charts) {
+     *   const chart = response.artifacts.charts[0];
+     *
+     *   console.log(`Type: ${chart.type}`);
+     *   console.log(`Title: ${chart.title}`);
+     *   if (chart.type === ChartType.LINE) {
+     *     const lineChart = chart as LineChart
+     *     console.log('X Label:', lineChart.x_label)
+     *     console.log('Y Label:', lineChart.y_label)
+     *     console.log('X Ticks:', lineChart.x_ticks)
+     *     console.log('Y Ticks:', lineChart.y_ticks)
+     *     console.log('X Tick Labels:', lineChart.x_tick_labels)
+     *     console.log('Y Tick Labels:', lineChart.y_tick_labels)
+     *     console.log('X Scale:', lineChart.x_scale)
+     *     console.log('Y Scale:', lineChart.y_scale)
+     *     console.log('Elements:')
+     *     console.dir(lineChart.elements, { depth: null })
+     *   }
+     * }
      */
     codeRun(code: string, params?: CodeRunParams, timeout?: number): Promise<ExecuteResponse>;
     /**