@daytonaio/sdk 0.127.0 → 0.128.0-alpha.1

package/esm/LspServer.d.ts

@@ -0,0 +1,172 @@
+import { CompletionList, LspSymbol, LspApi } from '@daytonaio/toolbox-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 - Path to the project root directory. Relative paths are resolved based on the sandbox working directory.
+ * @property {LspApi} apiClient - API client for Sandbox lsp operations
+ * @property {SandboxInstance} instance - The Sandbox instance this server belongs to
+ *
+ * @class
+ */
+export declare class LspServer {
+    private readonly languageId;
+    private readonly pathToProject;
+    private readonly apiClient;
+    constructor(languageId: LspLanguageId, pathToProject: string, apiClient: LspApi);
+    /**
+     * 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 sandbox working 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>;
+}
+//# sourceMappingURL=LspServer.d.ts.map

package/esm/LspServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LspServer.d.ts","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/LspServer.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAEjF;;GAEG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,UAAU,eAAe;CAC1B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;;;;;GAUG;AACH,qBAAa,SAAS;IAElB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAFT,UAAU,EAAE,aAAa,EACzB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM;IASpC;;;;;;;;;;OAUG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAOnC;;;;;;;;;OASG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAOlC;;;;;;;;;;;;OAYG;IACU,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjD;;;;;;;;;;;OAWG;IACU,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlD;;;;;;;;;;;;;;;;OAgBG;IACU,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAKhE;;;;;;;;;;OAUG;IACU,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAIlE;;;;;;;;;;;;;;;OAeG;IACU,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAKhE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;CAYpF"}

package/esm/LspServer.js

@@ -0,0 +1,204 @@
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Supported language server types.
+ */
+export var LspLanguageId;
+(function (LspLanguageId) {
+    LspLanguageId["PYTHON"] = "python";
+    LspLanguageId["TYPESCRIPT"] = "typescript";
+    LspLanguageId["JAVASCRIPT"] = "javascript";
+})(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 - Path to the project root directory. Relative paths are resolved based on the sandbox working directory.
+ * @property {LspApi} apiClient - API client for Sandbox lsp operations
+ * @property {SandboxInstance} instance - The Sandbox instance this server belongs to
+ *
+ * @class
+ */
+export class LspServer {
+    languageId;
+    pathToProject;
+    apiClient;
+    constructor(languageId, pathToProject, apiClient) {
+        this.languageId = languageId;
+        this.pathToProject = pathToProject;
+        this.apiClient = apiClient;
+        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.apiClient.start({
+            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.apiClient.stop({
+            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 sandbox working 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.apiClient.didOpen({
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+            uri: 'file://' + 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.apiClient.didClose({
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+            uri: 'file://' + 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.apiClient.documentSymbols(this.languageId, this.pathToProject, 'file://' + 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.apiClient.workspaceSymbols(query, this.languageId, this.pathToProject);
+        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.apiClient.completions({
+            languageId: this.languageId,
+            pathToProject: this.pathToProject,
+            uri: 'file://' + path,
+            position: {
+                line: position.line,
+                character: position.character,
+            },
+        });
+        return response.data;
+    }
+}
+//# sourceMappingURL=LspServer.js.map

package/esm/LspServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LspServer.js","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/LspServer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;AAC3B,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAuBD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAS;IAED;IACA;IACA;IAHnB,YACmB,UAAyB,EACzB,aAAqB,EACrB,SAAiB;QAFjB,eAAU,GAAV,UAAU,CAAe;QACzB,kBAAa,GAAb,aAAa,CAAQ;QACrB,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,SAAS,CAAC,KAAK,CAAC;YACzB,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,SAAS,CAAC,IAAI,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,OAAO,CAAC,IAAY;QAC/B,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,GAAG,EAAE,SAAS,GAAG,IAAI;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,QAAQ,CAAC,IAAY;QAChC,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC5B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,GAAG,EAAE,SAAS,GAAG,IAAI;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,eAAe,CAAC,IAAY;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,IAAI,CAAC,CAAA;QAC5G,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,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;QAClG,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,QAAkB;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;YAChD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,GAAG,EAAE,SAAS,GAAG,IAAI;YACrB,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,SAAS,EAAE,QAAQ,CAAC,SAAS;aAC9B;SACF,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF"}

package/esm/ObjectStorage.d.ts

@@ -0,0 +1,79 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=ObjectStorage.d.ts.map

package/esm/ObjectStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectStorage.d.ts","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/ObjectStorage.ts"],"names":[],"mappings":"AAYA;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,QAAQ,CAAU;gBAEd,MAAM,EAAE,mBAAmB;IAcvC;;;;;;;OAOG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA0B5F;;;;;;OAMG;YACW,qBAAqB;IAmBnC;;;;;;;OAOG;YACW,aAAa;IA2B3B;;;;;;OAMG;YACW,QAAQ;IAWtB;;;;;OAKG;YACW,gBAAgB;IAY9B;;;;;;OAMG;YACW,WAAW;IA2CzB,OAAO,CAAC,gBAAgB;CAIzB"}

package/esm/ObjectStorage.js

@@ -0,0 +1,187 @@
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ListObjectsV2Command, S3Client } from '@aws-sdk/client-s3';
+import { Upload } from '@aws-sdk/lib-storage';
+import * as crypto from 'crypto';
+import * as pathe from 'pathe';
+import { DaytonaError } from './errors/DaytonaError.js';
+import { dynamicImport } from './utils/Import.js';
+/**
+ * ObjectStorage class for interacting with object storage services.
+ *
+ * @class
+ * @param {ObjectStorageConfig} config - The configuration for the object storage service.
+ */
+export class ObjectStorage {
+    bucketName;
+    s3Client;
+    constructor(config) {
+        this.bucketName = config.bucketName || 'daytona-volume-builds';
+        this.s3Client = new S3Client({
+            region: this.extractAwsRegion(config.endpointUrl) || 'us-east-1',
+            endpoint: config.endpointUrl,
+            credentials: {
+                accessKeyId: config.accessKeyId,
+                secretAccessKey: config.secretAccessKey,
+                sessionToken: config.sessionToken,
+            },
+            forcePathStyle: true,
+        });
+    }
+    /**
+     * 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.
+     */
+    async upload(path, organizationId, archiveBasePath) {
+        const fs = await dynamicImport('fs', '"upload" is not supported: ');
+        if (!fs.existsSync(path)) {
+            const errMsg = `Path does not exist: ${path}`;
+            throw new DaytonaError(errMsg);
+        }
+        // Compute hash for the path
+        const pathHash = await this.computeHashForPathMd5(path, archiveBasePath);
+        // Define the S3 prefix
+        const prefix = `${organizationId}/${pathHash}/`;
+        const s3Key = `${prefix}context.tar`;
+        // Check if it already exists in S3
+        if (await this.folderExistsInS3(prefix)) {
+            return pathHash;
+        }
+        // Upload to S3
+        await this.uploadAsTar(s3Key, path, archiveBasePath);
+        return pathHash;
+    }
+    /**
+     * 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.
+     */
+    async computeHashForPathMd5(pathStr, archiveBasePath) {
+        const fs = await dynamicImport('fs', '"computeHashForPathMd5" is not supported: ');
+        const md5Hasher = crypto.createHash('md5');
+        const absPathStr = pathe.resolve(pathStr);
+        md5Hasher.update(archiveBasePath);
+        if (fs.statSync(absPathStr).isFile()) {
+            // For files, hash the content
+            await this.hashFile(absPathStr, md5Hasher);
+        }
+        else {
+            // For directories, recursively hash all files and their paths
+            await this.hashDirectory(absPathStr, pathStr, md5Hasher);
+        }
+        return md5Hasher.digest('hex');
+    }
+    /**
+     * 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.
+     */
+    async hashDirectory(dirPath, basePath, hasher) {
+        const fs = await dynamicImport('fs', '"hashDirectory" is not supported: ');
+        const entries = fs.readdirSync(dirPath, { withFileTypes: true });
+        const hasSubdirs = entries.some((e) => e.isDirectory());
+        const hasFiles = entries.some((e) => e.isFile());
+        if (!hasSubdirs && !hasFiles) {
+            // Empty directory
+            const relDir = pathe.relative(basePath, dirPath);
+            hasher.update(relDir);
+        }
+        for (const entry of entries) {
+            const fullPath = pathe.join(dirPath, entry.name);
+            if (entry.isDirectory()) {
+                await this.hashDirectory(fullPath, basePath, hasher);
+            }
+            else if (entry.isFile()) {
+                const relPath = pathe.relative(basePath, fullPath);
+                hasher.update(relPath);
+                await this.hashFile(fullPath, hasher);
+            }
+        }
+    }
+    /**
+     * 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.
+     */
+    async hashFile(filePath, hasher) {
+        const fs = await dynamicImport('fs', '"hashFile" is not supported: ');
+        await new Promise((resolve, reject) => {
+            const stream = fs.createReadStream(filePath, { highWaterMark: 8192 });
+            stream.on('data', (chunk) => hasher.update(chunk));
+            stream.on('end', resolve);
+            stream.on('error', reject);
+        });
+    }
+    /**
+     * 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.
+     */
+    async folderExistsInS3(prefix) {
+        const response = await this.s3Client.send(new ListObjectsV2Command({
+            Bucket: this.bucketName,
+            Prefix: prefix,
+            MaxKeys: 1,
+        }));
+        return !!response.Contents && response.Contents.length > 0;
+    }
+    /**
+     * 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.
+     */
+    async uploadAsTar(s3Key, sourcePath, archiveBasePath) {
+        const importErrorPrefix = '"uploadAsTar" is not supported: ';
+        const tar = await dynamicImport('tar', importErrorPrefix);
+        const stream = await dynamicImport('stream', importErrorPrefix);
+        sourcePath = pathe.resolve(sourcePath);
+        const normalizedSourcePath = pathe.normalize(sourcePath);
+        const normalizedArchiveBasePath = pathe.normalize(archiveBasePath);
+        let basePrefix;
+        if (normalizedArchiveBasePath === '.') {
+            // When archiveBasePath is empty (normalized to '.'), use the normalizedSourcePath as cwd and the '.' as target
+            basePrefix = normalizedSourcePath;
+        }
+        else {
+            // Normal case: extract the base prefix by removing archiveBasePath from the end
+            basePrefix = normalizedSourcePath.slice(0, normalizedSourcePath.length - normalizedArchiveBasePath.length);
+        }
+        const tarStream = tar.create({
+            cwd: basePrefix,
+            portable: true,
+            gzip: false,
+        }, [normalizedArchiveBasePath]);
+        const pass = new stream.PassThrough();
+        tarStream.pipe(pass);
+        const uploader = new Upload({
+            client: this.s3Client,
+            params: {
+                Bucket: this.bucketName,
+                Key: s3Key,
+                Body: pass,
+            },
+        });
+        await uploader.done();
+    }
+    extractAwsRegion(endpoint) {
+        const match = endpoint.match(/s3[.-]([a-z0-9-]+)\.amazonaws\.com/);
+        return match?.[1];
+    }
+}
+//# sourceMappingURL=ObjectStorage.js.map

package/esm/ObjectStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectStorage.js","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/ObjectStorage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAA;AAC7C,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAChC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAoB9C;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IAChB,UAAU,CAAQ;IAClB,QAAQ,CAAU;IAE1B,YAAY,MAA2B;QACrC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,uBAAuB,CAAA;QAC9D,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC3B,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,WAAW;YAChE,QAAQ,EAAE,MAAM,CAAC,WAAW;YAC5B,WAAW,EAAE;gBACX,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC;YACD,cAAc,EAAE,IAAI;SACrB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,cAAsB,EAAE,eAAuB;QACxE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,6BAA6B,CAAC,CAAA;QAEnE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,wBAAwB,IAAI,EAAE,CAAA;YAC7C,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QAChC,CAAC;QAED,4BAA4B;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAA;QAExE,uBAAuB;QACvB,MAAM,MAAM,GAAG,GAAG,cAAc,IAAI,QAAQ,GAAG,CAAA;QAC/C,MAAM,KAAK,GAAG,GAAG,MAAM,aAAa,CAAA;QAEpC,mCAAmC;QACnC,IAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;YACxC,OAAO,QAAQ,CAAA;QACjB,CAAC;QAED,eAAe;QACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,eAAe,CAAC,CAAA;QAEpD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,qBAAqB,CAAC,OAAe,EAAE,eAAuB;QAC1E,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,4CAA4C,CAAC,CAAA;QAElF,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAEzC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;QAEjC,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;YACrC,8BAA8B;YAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;QAC5C,CAAC;aAAM,CAAC;YACN,8DAA8D;YAC9D,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,QAAgB,EAAE,MAAmB;QAChF,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,oCAAoC,CAAC,CAAA;QAE1E,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;QAChE,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA;QAEhD,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC7B,kBAAkB;YAClB,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;YAChD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACvB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;YAEhD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;YACtD,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;gBAClD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBAEtB,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,MAAmB;QAC1D,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,+BAA+B,CAAC,CAAA;QAErE,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,MAAM,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;YACrE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAClD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;YACzB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,gBAAgB,CAAC,MAAc;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACvC,IAAI,oBAAoB,CAAC;YACvB,MAAM,EAAE,IAAI,CAAC,UAAU;YACvB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,CAAC;SACX,CAAC,CACH,CAAA;QAED,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,UAAkB,EAAE,eAAuB;QAClF,MAAM,iBAAiB,GAAG,kCAAkC,CAAA;QAC5D,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAA;QACzD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAA;QAE/D,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACtC,MAAM,oBAAoB,GAAG,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACxD,MAAM,yBAAyB,GAAG,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;QAElE,IAAI,UAAkB,CAAA;QAEtB,IAAI,yBAAyB,KAAK,GAAG,EAAE,CAAC;YACtC,+GAA+G;YAC/G,UAAU,GAAG,oBAAoB,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,gFAAgF;YAChF,UAAU,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC,EAAE,oBAAoB,CAAC,MAAM,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAA;QAC5G,CAAC;QAED,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAC1B;YACE,GAAG,EAAE,UAAU;YACf,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,KAAK;SACZ,EACD,CAAC,yBAAyB,CAAC,CAC5B,CAAA;QAED,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAA;QACrC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEpB,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC;YAC1B,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,MAAM,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,UAAU;gBACvB,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,IAAI;aACX;SACF,CAAC,CAAA;QAEF,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IACvB,CAAC;IAEO,gBAAgB,CAAC,QAAgB;QACvC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClE,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;IACnB,CAAC;CACF"}