@daytonaio/sdk 0.0.0-dev

package/src/LspServer.d.ts

@@ -0,0 +1,173 @@
+import { CompletionList, LspSymbol, ToolboxApi } from '@daytonaio/api-client';
+/**
+ * Supported language server types.
+ */
+export declare enum LspLanguageId {
+    PYTHON = "python",
+    TYPESCRIPT = "typescript",
+    JAVASCRIPT = "javascript"
+}
+/**
+ * Represents a zero-based position within a text document,
+ * specified by line number and character offset.
+ *
+ * @interface
+ * @property {number} line - Zero-based line number in the document
+ * @property {number} character - Zero-based character offset on the line
+ *
+ * @example
+ * const position: Position = {
+ *   line: 10,     // Line 11 (zero-based)
+ *   character: 15  // Character 16 on the line (zero-based)
+ * };
+ */
+export type Position = {
+    /** Zero-based line number */
+    line: number;
+    /** Zero-based character offset */
+    character: number;
+};
+/**
+ * Provides Language Server Protocol functionality for code intelligence to provide
+ * IDE-like features such as code completion, symbol search, and more.
+ *
+ * @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;
+    private readonly pathToProject;
+    private readonly toolboxApi;
+    private readonly sandboxId;
+    constructor(languageId: LspLanguageId, pathToProject: string, toolboxApi: ToolboxApi, sandboxId: string);
+    /**
+     * 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>}
+     *
+     * @example
+     * const lsp = await sandbox.createLspServer('typescript', 'workspace/project');
+     * await lsp.start();  // Initialize the server
+     * // Now ready for LSP operations
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the language server, should be called when the LSP server is no longer needed to
+     * free up system resources.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // When done with LSP features
+     * await lsp.stop();  // Clean up resources
+     */
+    stop(): Promise<void>;
+    /**
+     * 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.
+     *
+     * @param {string} path - Path to the opened file. Relative paths are resolved based on the user's
+     * root directory.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // When opening a file for editing
+     * await lsp.didOpen('workspace/project/src/index.ts');
+     * // Now can get completions, symbols, etc. for this file
+     */
+    didOpen(path: string): Promise<void>;
+    /**
+     * 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 - Path to the closed file. Relative paths are resolved based on the project path
+     * set in the LSP server constructor.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // When done editing a file
+     * await lsp.didClose('workspace/project/src/index.ts');
+     */
+    didClose(path: string): Promise<void>;
+    /**
+     * Get symbol information (functions, classes, variables, etc.) from a document.
+     *
+     * @param {string} path - Path to the file to get symbols from. Relative paths are resolved based on the project path
+     * set in the LSP server constructor.
+     * @returns {Promise<LspSymbol[]>} List of symbols in the document. Each symbol includes:
+     *                                 - name: The symbol's name
+     *                                 - kind: The symbol's kind (function, class, variable, etc.)
+     *                                 - location: The location of the symbol in the file
+     *
+     * @example
+     * // Get all symbols in a file
+     * const symbols = await lsp.documentSymbols('workspace/project/src/index.ts');
+     * symbols.forEach(symbol => {
+     *   console.log(`${symbol.kind} ${symbol.name}: ${symbol.location}`);
+     * });
+     */
+    documentSymbols(path: string): Promise<LspSymbol[]>;
+    /**
+     * 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:
+     *                                 - name: The symbol's name
+     *                                 - kind: The symbol's kind (function, class, variable, etc.)
+     *                                 - location: The location of the symbol in the file
+     *
+     * @deprecated Use `sandboxSymbols` instead. This method will be removed in a future version.
+     */
+    workspaceSymbols(query: string): Promise<LspSymbol[]>;
+    /**
+     * 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:
+     *                                 - name: The symbol's name
+     *                                 - kind: The symbol's kind (function, class, variable, etc.)
+     *                                 - location: The location of the symbol in the file
+     *
+     * @example
+     * // Search for all symbols containing "User"
+     * const symbols = await lsp.sandboxSymbols('User');
+     * symbols.forEach(symbol => {
+     *   console.log(`${symbol.name} (${symbol.kind}) in ${symbol.location}`);
+     * });
+     */
+    sandboxSymbols(query: string): Promise<LspSymbol[]>;
+    /**
+     * Gets completion suggestions at a position in a file.
+     *
+     * @param {string} path - Path to the file. Relative paths are resolved based on the project path
+     * set in the LSP server constructor.
+     * @param {Position} position - The position in the file where completion was requested
+     * @returns {Promise<CompletionList>} List of completion suggestions. The list includes:
+     *                                    - isIncomplete: Whether more items might be available
+     *                                    - items: List of completion items, each containing:
+     *                                      - label: The text to insert
+     *                                      - kind: The kind of completion
+     *                                      - detail: Additional details about the item
+     *                                      - documentation: Documentation for the item
+     *                                      - sortText: Text used to sort the item in the list
+     *                                      - filterText: Text used to filter the item
+     *                                      - insertText: The actual text to insert (if different from label)
+     *
+     * @example
+     * // Get completions at a specific position
+     * const completions = await lsp.completions('workspace/project/src/index.ts', {
+     *   line: 10,
+     *   character: 15
+     * });
+     * completions.items.forEach(item => {
+     *   console.log(`${item.label} (${item.kind}): ${item.detail}`);
+     * });
+     */
+    completions(path: string, position: Position): Promise<CompletionList>;
+}

package/src/LspServer.js

@@ -0,0 +1,209 @@
+"use strict";
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LspServer = exports.LspLanguageId = void 0;
+const Path_1 = require("./utils/Path");
+/**
+ * Supported language server types.
+ */
+var LspLanguageId;
+(function (LspLanguageId) {
+    LspLanguageId["PYTHON"] = "python";
+    LspLanguageId["TYPESCRIPT"] = "typescript";
+    LspLanguageId["JAVASCRIPT"] = "javascript";
+})(LspLanguageId || (exports.LspLanguageId = LspLanguageId = {}));
+/**
+ * Provides Language Server Protocol functionality for code intelligence to provide
+ * IDE-like features such as code completion, symbol search, and more.
+ *
+ * @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 {
+    languageId;
+    pathToProject;
+    toolboxApi;
+    sandboxId;
+    constructor(languageId, pathToProject, toolboxApi, sandboxId) {
+        this.languageId = languageId;
+        this.pathToProject = pathToProject;
+        this.toolboxApi = toolboxApi;
+        this.sandboxId = sandboxId;
+        if (!Object.values(LspLanguageId).includes(this.languageId)) {
+            throw new Error(`Invalid languageId: ${this.languageId}. Supported values are: ${Object.values(LspLanguageId).join(', ')}`);
+        }
+    }
+    /**
+     * 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>}
+     *
+     * @example
+     * const lsp = await sandbox.createLspServer('typescript', 'workspace/project');
+     * await lsp.start();  // Initialize the server
+     * // Now ready for LSP operations
+     */
+    async start() {
+        await this.toolboxApi.lspStart(this.sandboxId, {
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+        });
+    }
+    /**
+     * Stops the language server, should be called when the LSP server is no longer needed to
+     * free up system resources.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // When done with LSP features
+     * await lsp.stop();  // Clean up resources
+     */
+    async stop() {
+        await this.toolboxApi.lspStop(this.sandboxId, {
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+        });
+    }
+    /**
+     * 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.
+     *
+     * @param {string} path - Path to the opened file. Relative paths are resolved based on the user's
+     * root directory.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // When opening a file for editing
+     * await lsp.didOpen('workspace/project/src/index.ts');
+     * // Now can get completions, symbols, etc. for this file
+     */
+    async didOpen(path) {
+        await this.toolboxApi.lspDidOpen(this.sandboxId, {
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+            uri: 'file://' + (0, Path_1.prefixRelativePath)(this.pathToProject, path),
+        });
+    }
+    /**
+     * 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 - Path to the closed file. Relative paths are resolved based on the project path
+     * set in the LSP server constructor.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // When done editing a file
+     * await lsp.didClose('workspace/project/src/index.ts');
+     */
+    async didClose(path) {
+        await this.toolboxApi.lspDidClose(this.sandboxId, {
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+            uri: 'file://' + (0, Path_1.prefixRelativePath)(this.pathToProject, path),
+        });
+    }
+    /**
+     * Get symbol information (functions, classes, variables, etc.) from a document.
+     *
+     * @param {string} path - Path to the file to get symbols from. Relative paths are resolved based on the project path
+     * set in the LSP server constructor.
+     * @returns {Promise<LspSymbol[]>} List of symbols in the document. Each symbol includes:
+     *                                 - name: The symbol's name
+     *                                 - kind: The symbol's kind (function, class, variable, etc.)
+     *                                 - location: The location of the symbol in the file
+     *
+     * @example
+     * // Get all symbols in a file
+     * const symbols = await lsp.documentSymbols('workspace/project/src/index.ts');
+     * symbols.forEach(symbol => {
+     *   console.log(`${symbol.kind} ${symbol.name}: ${symbol.location}`);
+     * });
+     */
+    async documentSymbols(path) {
+        const response = await this.toolboxApi.lspDocumentSymbols(this.sandboxId, this.languageId, this.pathToProject, 'file://' + (0, Path_1.prefixRelativePath)(this.pathToProject, path));
+        return response.data;
+    }
+    /**
+     * 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:
+     *                                 - name: The symbol's name
+     *                                 - kind: The symbol's kind (function, class, variable, etc.)
+     *                                 - location: The location of the symbol in the file
+     *
+     * @deprecated Use `sandboxSymbols` instead. This method will be removed in a future version.
+     */
+    async workspaceSymbols(query) {
+        return await this.sandboxSymbols(query);
+    }
+    /**
+     * 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:
+     *                                 - name: The symbol's name
+     *                                 - kind: The symbol's kind (function, class, variable, etc.)
+     *                                 - location: The location of the symbol in the file
+     *
+     * @example
+     * // Search for all symbols containing "User"
+     * const symbols = await lsp.sandboxSymbols('User');
+     * symbols.forEach(symbol => {
+     *   console.log(`${symbol.name} (${symbol.kind}) in ${symbol.location}`);
+     * });
+     */
+    async sandboxSymbols(query) {
+        const response = await this.toolboxApi.lspWorkspaceSymbols(this.sandboxId, this.languageId, this.pathToProject, query);
+        return response.data;
+    }
+    /**
+     * Gets completion suggestions at a position in a file.
+     *
+     * @param {string} path - Path to the file. Relative paths are resolved based on the project path
+     * set in the LSP server constructor.
+     * @param {Position} position - The position in the file where completion was requested
+     * @returns {Promise<CompletionList>} List of completion suggestions. The list includes:
+     *                                    - isIncomplete: Whether more items might be available
+     *                                    - items: List of completion items, each containing:
+     *                                      - label: The text to insert
+     *                                      - kind: The kind of completion
+     *                                      - detail: Additional details about the item
+     *                                      - documentation: Documentation for the item
+     *                                      - sortText: Text used to sort the item in the list
+     *                                      - filterText: Text used to filter the item
+     *                                      - insertText: The actual text to insert (if different from label)
+     *
+     * @example
+     * // Get completions at a specific position
+     * const completions = await lsp.completions('workspace/project/src/index.ts', {
+     *   line: 10,
+     *   character: 15
+     * });
+     * completions.items.forEach(item => {
+     *   console.log(`${item.label} (${item.kind}): ${item.detail}`);
+     * });
+     */
+    async completions(path, position) {
+        const response = await this.toolboxApi.lspCompletions(this.sandboxId, {
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+            uri: 'file://' + (0, Path_1.prefixRelativePath)(this.pathToProject, path),
+            position,
+        });
+        return response.data;
+    }
+}
+exports.LspServer = LspServer;
+//# sourceMappingURL=LspServer.js.map

package/src/LspServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LspServer.js","sourceRoot":"","sources":["../../../../libs/sdk-typescript/src/LspServer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,uCAAiD;AAEjD;;GAEG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;AAC3B,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAuBD;;;;;;;;;;GAUG;AACH,MAAa,SAAS;IAED;IACA;IACA;IACA;IAJnB,YACmB,UAAyB,EACzB,aAAqB,EACrB,UAAsB,EACtB,SAAiB;QAHjB,eAAU,GAAV,UAAU,CAAe;QACzB,kBAAa,GAAb,aAAa,CAAQ;QACrB,eAAU,GAAV,UAAU,CAAY;QACtB,cAAS,GAAT,SAAS,CAAQ;QAElC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CACb,uBAAuB,IAAI,CAAC,UAAU,2BAA2B,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC3G,CAAA;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;YAC7C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAC5C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,OAAO,CAAC,IAAY;QAC/B,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE;YAC/C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,GAAG,EAAE,SAAS,GAAG,IAAA,yBAAkB,EAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC;SAC9D,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,QAAQ,CAAC,IAAY;QAChC,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE;YAChD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,GAAG,EAAE,SAAS,GAAG,IAAA,yBAAkB,EAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC;SAC9D,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,eAAe,CAAC,IAAY;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,kBAAkB,CACvD,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,SAAS,GAAG,IAAA,yBAAkB,EAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CACzD,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,gBAAgB,CAAC,KAAa;QACzC,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IACzC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,cAAc,CAAC,KAAa;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,mBAAmB,CACxD,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,KAAK,CACN,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,QAAkB;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;YACpE,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,GAAG,EAAE,SAAS,GAAG,IAAA,yBAAkB,EAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC;YAC7D,QAAQ;SACT,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AAnMD,8BAmMC"}

package/src/ObjectStorage.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Configuration for the ObjectStorage class.
+ *
+ * @interface
+ * @property {string} endpointUrl - The endpoint URL for the object storage service.
+ * @property {string} accessKeyId - The access key ID for the object storage service.
+ * @property {string} secretAccessKey - The secret access key for the object storage service.
+ * @property {string} [sessionToken] - The session token for the object storage service. Used for temporary credentials.
+ * @property {string} [bucketName] - The name of the bucket to use.
+ */
+export interface ObjectStorageConfig {
+    endpointUrl: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken?: string;
+    bucketName?: string;
+}
+/**
+ * ObjectStorage class for interacting with object storage services.
+ *
+ * @class
+ * @param {ObjectStorageConfig} config - The configuration for the object storage service.
+ */
+export declare class ObjectStorage {
+    private bucketName;
+    private s3Client;
+    constructor(config: ObjectStorageConfig);
+    /**
+     * Upload a file or directory to object storage.
+     *
+     * @param {string} path - The path to the file or directory to upload.
+     * @param {string} organizationId - The organization ID to use for the upload.
+     * @param {string} [archiveBasePath] - The base path to use for the archive.
+     * @returns {Promise<string>} The hash of the uploaded file or directory.
+     */
+    upload(path: string, organizationId: string, archiveBasePath?: string): Promise<string>;
+    /**
+     * Compute a hash for a file or directory.
+     *
+     * @param {string} pathStr - The path to the file or directory to hash.
+     * @param {string} [archiveBasePath] - The base path to use for the archive.
+     * @returns {Promise<string>} The hash of the file or directory.
+     */
+    private computeHashForPathMd5;
+    /**
+     * Recursively hash a directory and its contents.
+     *
+     * @param {string} dirPath - The path to the directory to hash.
+     * @param {string} basePath - The base path to use for the hash.
+     * @param {crypto.Hash} hasher - The hasher to use for the hash.
+     * @returns {Promise<void>} A promise that resolves when the directory has been hashed.
+     */
+    private hashDirectory;
+    /**
+     * Hash a file.
+     *
+     * @param {string} filePath - The path to the file to hash.
+     * @param {crypto.Hash} hasher - The hasher to use for the hash.
+     * @returns {Promise<void>} A promise that resolves when the file has been hashed.
+     */
+    private hashFile;
+    /**
+     * Check if a prefix (folder) exists in S3.
+     *
+     * @param {string} prefix - The prefix to check.
+     * @returns {Promise<boolean>} True if the prefix exists, false otherwise.
+     */
+    private folderExistsInS3;
+    /**
+     * Create a tar archive of the specified path and upload it to S3.
+     *
+     * @param {string} s3Key - The key to use for the uploaded file.
+     * @param {string} sourcePath - The path to the file or directory to upload.
+     * @param {string} [archiveBasePath] - The base path to use for the archive.
+     */
+    private uploadAsTar;
+    private extractAwsRegion;
+    /**
+     * Compute the base path for an archive. Returns normalized path without the root (drive letter or leading slash).
+     *
+     * @param {string} pathStr - The path to compute the base path for.
+     * @returns {string} The base path for the archive.
+     */
+    static computeArchiveBasePath(pathStr: string): string;
+}