@daytona/sdk 0.161.0-alpha.1

package/src/FileSystem.js

@@ -0,0 +1,412 @@
+"use strict";
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileSystem = void 0;
+const tslib_1 = require("tslib");
+const pathe = tslib_1.__importStar(require("pathe"));
+const Import_1 = require("./utils/Import");
+const Runtime_1 = require("./utils/Runtime");
+const DaytonaError_1 = require("./errors/DaytonaError");
+const FileTransfer_1 = require("./utils/FileTransfer");
+const otel_decorator_1 = require("./utils/otel.decorator");
+/**
+ * Provides file system operations within a Sandbox.
+ *
+ * @class
+ */
+class FileSystem {
+    clientConfig;
+    apiClient;
+    constructor(clientConfig, apiClient) {
+        this.clientConfig = clientConfig;
+        this.apiClient = apiClient;
+    }
+    /**
+     * Create a new directory in the Sandbox with specified permissions.
+     *
+     * @param {string} path - Path where the directory should be created. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} mode - Directory permissions in octal format (e.g. "755")
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Create a directory with standard permissions
+     * await fs.createFolder('app/data', '755');
+     */
+    async createFolder(path, mode) {
+        const response = await this.apiClient.createFolder(path, mode);
+        return response.data;
+    }
+    /**
+     * Deletes a file or directory from the Sandbox.
+     *
+     * @param {string} path - Path to the file or directory to delete. Relative paths are resolved based on the sandbox working directory.
+     * @param {boolean} [recursive] - If the file is a directory, this must be true to delete it.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Delete a file
+     * await fs.deleteFile('app/temp.log');
+     */
+    async deleteFile(path, recursive) {
+        const response = await this.apiClient.deleteFile(path, recursive);
+        return response.data;
+    }
+    async downloadFile(src, dst, timeout = 30 * 60) {
+        const remotePath = src;
+        if (typeof dst !== 'string') {
+            if (dst) {
+                timeout = dst;
+            }
+            const response = await this.downloadFiles([{ source: remotePath }], timeout);
+            if (response[0].error) {
+                throw new DaytonaError_1.DaytonaError(response[0].error);
+            }
+            return response[0].result;
+        }
+        const response = await this.downloadFiles([{ source: remotePath, destination: dst }], timeout);
+        if (response[0].error) {
+            throw new DaytonaError_1.DaytonaError(response[0].error);
+        }
+    }
+    /**
+     * Downloads multiple files from the Sandbox. If the files already exist locally, they will be overwritten.
+     *
+     * @param {FileDownloadRequest[]} files - Array of file download requests.
+     * @param {number} [timeoutSec] - Timeout for the download operation in seconds. 0 means no timeout.
+     * Default is 30 minutes.
+     * @returns {Promise<FileDownloadResponse[]>} Array of download results.
+     *
+     * @throws {DaytonaError} If the request itself fails (network issues, invalid request/response, etc.). Individual
+     * file download errors are returned in the `FileDownloadResponse.error` field.
+     *
+     * @example
+     * // Download multiple files
+     * const results = await fs.downloadFiles([
+     *   { source: 'tmp/data.json' },
+     *   { source: 'tmp/config.json', destination: 'local_config.json' }
+     * ]);
+     * results.forEach(result => {
+     *   if (result.error) {
+     *     console.error(`Error downloading ${result.source}: ${result.error}`);
+     *   } else if (result.result) {
+     *     console.log(`Downloaded ${result.source} to ${result.result}`);
+     *   }
+     * });
+     */
+    async downloadFiles(files, timeoutSec = 30 * 60) {
+        if (files.length === 0)
+            return [];
+        const isNonStreamingRuntime = Runtime_1.RUNTIME === Runtime_1.Runtime.BROWSER || Runtime_1.RUNTIME === Runtime_1.Runtime.SERVERLESS;
+        // Prepare destinations and metadata
+        const metadataMap = new Map();
+        for (const f of files) {
+            metadataMap.set(f.source, { destination: f.destination });
+            if (f.destination) {
+                const fs = await (0, Import_1.dynamicImport)('fs', 'Downloading files to local files is not supported: ');
+                await fs.promises.mkdir(pathe.dirname(f.destination), { recursive: true });
+            }
+        }
+        const response = await this.apiClient.downloadFiles({ paths: files.map((f) => f.source) }, {
+            responseType: isNonStreamingRuntime ? 'arraybuffer' : 'stream',
+            timeout: timeoutSec * 1000,
+        });
+        const stream = (0, FileTransfer_1.normalizeResponseStream)(response.data);
+        // Node.js path: use busboy for efficient streaming
+        if (isNonStreamingRuntime) {
+            await (0, FileTransfer_1.processDownloadFilesResponseWithBuffered)(stream, response.headers, metadataMap);
+        }
+        else {
+            await (0, FileTransfer_1.processDownloadFilesResponseWithBusboy)(stream, response.headers, metadataMap);
+        }
+        return files.map((f) => {
+            const metadata = metadataMap.get(f.source);
+            const error = metadata?.error || (!metadata?.result ? 'No data received for this file' : undefined);
+            return {
+                source: f.source,
+                result: error ? undefined : metadata.result,
+                error,
+            };
+        });
+    }
+    /**
+     * Searches for text patterns within files in the Sandbox.
+     *
+     * @param {string} path - Directory to search in. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} pattern - Search pattern
+     * @returns {Promise<Array<Match>>} Array of matches with file and line information
+     *
+     * @example
+     * // Find all TODO comments in TypeScript files
+     * const matches = await fs.findFiles('app/src', 'TODO:');
+     * matches.forEach(match => {
+     *   console.log(`${match.file}:${match.line}: ${match.content}`);
+     * });
+     */
+    async findFiles(path, pattern) {
+        const response = await this.apiClient.findInFiles(path, pattern);
+        return response.data;
+    }
+    /**
+     * Retrieves detailed information about a file or directory.
+     *
+     * @param {string} path - Path to the file or directory. Relative paths are resolved based on the sandbox working directory.
+     * @returns {Promise<FileInfo>} Detailed file information including size, permissions, modification time
+     *
+     * @example
+     * // Get file details
+     * const info = await fs.getFileDetails('app/config.json');
+     * console.log(`Size: ${info.size}, Modified: ${info.modTime}`);
+     */
+    async getFileDetails(path) {
+        const response = await this.apiClient.getFileInfo(path);
+        return response.data;
+    }
+    /**
+     * Lists contents of a directory in the Sandbox.
+     *
+     * @param {string} path - Directory path to list. Relative paths are resolved based on the sandbox working directory.
+     * @returns {Promise<FileInfo[]>} Array of file and directory information
+     *
+     * @example
+     * // List directory contents
+     * const files = await fs.listFiles('app/src');
+     * files.forEach(file => {
+     *   console.log(`${file.name} (${file.size} bytes)`);
+     * });
+     */
+    async listFiles(path) {
+        const response = await this.apiClient.listFiles(path);
+        return response.data;
+    }
+    /**
+     * Moves or renames a file or directory.
+     *
+     * @param {string} source - Source path. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} destination - Destination path. Relative paths are resolved based on the sandbox working directory.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Move a file to a new location
+     * await fs.moveFiles('app/temp/data.json', 'app/data/data.json');
+     */
+    async moveFiles(source, destination) {
+        const response = await this.apiClient.moveFile(source, destination);
+        return response.data;
+    }
+    /**
+     * Replaces text content in multiple files.
+     *
+     * @param {string[]} files - Array of file paths to process. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} pattern - Pattern to replace
+     * @param {string} newValue - Replacement text
+     * @returns {Promise<Array<ReplaceResult>>} Results of the replace operation for each file
+     *
+     * @example
+     * // Update version number across multiple files
+     * const results = await fs.replaceInFiles(
+     *   ['app/package.json', 'app/version.ts'],
+     *   '"version": "1.0.0"',
+     *   '"version": "1.1.0"'
+     * );
+     */
+    async replaceInFiles(files, pattern, newValue) {
+        const replaceRequest = {
+            files,
+            newValue,
+            pattern,
+        };
+        const response = await this.apiClient.replaceInFiles(replaceRequest);
+        return response.data;
+    }
+    /**
+     * Searches for files and directories by name pattern in the Sandbox.
+     *
+     * @param {string} path - Directory to search in. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} pattern - File name pattern (supports globs)
+     * @returns {Promise<SearchFilesResponse>} Search results with matching files
+     *
+     * @example
+     * // Find all TypeScript files
+     * const result = await fs.searchFiles('app', '*.ts');
+     * result.files.forEach(file => console.log(file));
+     */
+    async searchFiles(path, pattern) {
+        const response = await this.apiClient.searchFiles(path, pattern);
+        return response.data;
+    }
+    /**
+     * Sets permissions and ownership for a file or directory.
+     *
+     * @param {string} path - Path to the file or directory. Relative paths are resolved based on the sandbox working directory.
+     * @param {FilePermissionsParams} permissions - Permission settings
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Set file permissions and ownership
+     * await fs.setFilePermissions('app/script.sh', {
+     *   owner: 'daytona',
+     *   group: 'users',
+     *   mode: '755'  // Execute permission for shell script
+     * });
+     */
+    async setFilePermissions(path, permissions) {
+        const response = await this.apiClient.setFilePermissions(path, permissions.owner, permissions.group, permissions.mode);
+        return response.data;
+    }
+    async uploadFile(src, dst, timeout = 30 * 60) {
+        await this.uploadFiles([{ source: src, destination: dst }], timeout);
+    }
+    /**
+     * Uploads multiple files to the Sandbox. If files already exist at the destination paths,
+     * they will be overwritten.
+     *
+     * @param {FileUpload[]} files - Array of files to upload.
+     * @param {number} [timeout] - Timeout for the upload operation in seconds. 0 means no timeout.
+     * Default is 30 minutes.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Upload multiple text files
+     * const files = [
+     *   {
+     *     source: Buffer.from('Content of file 1'),
+     *     destination: '/tmp/file1.txt'
+     *   },
+     *   {
+     *     source: 'app/data/file2.txt',
+     *     destination: '/tmp/file2.txt'
+     *   },
+     *   {
+     *     source: Buffer.from('{"key": "value"}'),
+     *     destination: '/tmp/config.json'
+     *   }
+     * ];
+     * await fs.uploadFiles(files);
+     */
+    async uploadFiles(files, timeout = 30 * 60) {
+        const isNonStreamingRuntime = Runtime_1.RUNTIME === Runtime_1.Runtime.DENO || Runtime_1.RUNTIME === Runtime_1.Runtime.BROWSER || Runtime_1.RUNTIME === Runtime_1.Runtime.SERVERLESS;
+        const FormDataClass = isNonStreamingRuntime
+            ? FormData
+            : (await (0, Import_1.dynamicImport)('form-data', 'Uploading files is not supported: '));
+        const form = new FormDataClass();
+        for (const [i, { source, destination }] of files.entries()) {
+            form.append(`files[${i}].path`, destination);
+            const payload = await this.makeFilePayload(source);
+            form.append(`files[${i}].file`, payload, destination);
+        }
+        if (isNonStreamingRuntime) {
+            const url = `${this.clientConfig.basePath}/files/bulk-upload`;
+            await fetch(url, {
+                method: 'POST',
+                headers: this.clientConfig.baseOptions.headers,
+                body: form,
+                signal: timeout ? AbortSignal.timeout(timeout * 1000) : undefined,
+            });
+        }
+        else {
+            await this.apiClient.uploadFiles({
+                data: form,
+                maxRedirects: 0,
+                timeout: timeout * 1000,
+            });
+        }
+    }
+    async makeFilePayload(source) {
+        // String = file path
+        if (typeof source === 'string') {
+            const fs = await (0, Import_1.dynamicImport)('fs', 'Uploading file from local file system is not supported: ');
+            return fs.createReadStream(source);
+        }
+        // Blob
+        if (Runtime_1.RUNTIME === Runtime_1.Runtime.BROWSER || Runtime_1.RUNTIME === Runtime_1.Runtime.SERVERLESS || Runtime_1.RUNTIME === Runtime_1.Runtime.DENO) {
+            // Use .slice() to ensure we have a concrete ArrayBuffer, not ArrayBufferLike
+            return new Blob([source.slice()], { type: 'application/octet-stream' });
+        }
+        // Readable stream
+        const stream = await (0, Import_1.dynamicImport)('stream', 'Uploading file is not supported: ');
+        return stream.Readable.from(source);
+    }
+}
+exports.FileSystem = FileSystem;
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "createFolder", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Boolean]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "deleteFile", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Object, Number]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "downloadFile", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Array, Number]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "downloadFiles", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "findFiles", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "getFileDetails", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "listFiles", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "moveFiles", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Array, String, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "replaceInFiles", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "searchFiles", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "setFilePermissions", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, String, Number]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "uploadFile", null);
+tslib_1.__decorate([
+    (0, otel_decorator_1.WithInstrumentation)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Array, Number]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FileSystem.prototype, "uploadFiles", null);
+//# sourceMappingURL=FileSystem.js.map

package/src/FileSystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystem.js","sourceRoot":"","sources":["../../../../libs/sdk-typescript/src/FileSystem.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,qDAA8B;AAU9B,2CAA8C;AAC9C,6CAAkD;AAClD,wDAAoD;AACpD,uDAI6B;AAC7B,2DAA4D;AAmF5D;;;;GAIG;AACH,MAAa,UAAU;IAEF;IACA;IAFnB,YACmB,YAA2B,EAC3B,SAAwB;QADxB,iBAAY,GAAZ,YAAY,CAAe;QAC3B,cAAS,GAAT,SAAS,CAAe;IACxC,CAAC;IAEJ;;;;;;;;;;OAUG;IAEU,AAAN,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAY;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC9D,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IAEU,AAAN,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,SAAmB;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QACjE,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAiCY,AAAN,KAAK,CAAC,YAAY,CAAC,GAAW,EAAE,GAAqB,EAAE,UAAkB,EAAE,GAAG,EAAE;QACrF,MAAM,UAAU,GAAG,GAAG,CAAA;QAEtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,GAAG,EAAE,CAAC;gBACR,OAAO,GAAG,GAAa,CAAA;YACzB,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;YAE5E,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBACtB,MAAM,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;YAC3C,CAAC;YAED,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAgB,CAAA;QACrC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;QAE9F,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEU,AAAN,KAAK,CAAC,aAAa,CACxB,KAA4B,EAC5B,aAAqB,EAAE,GAAG,EAAE;QAE5B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAA;QAEjC,MAAM,qBAAqB,GAAG,iBAAO,KAAK,iBAAO,CAAC,OAAO,IAAI,iBAAO,KAAK,iBAAO,CAAC,UAAU,CAAA;QAE3F,oCAAoC;QACpC,MAAM,WAAW,GAAG,IAAI,GAAG,EAA4B,CAAA;QAEvD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;YACzD,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;gBAClB,MAAM,EAAE,GAAG,MAAM,IAAA,sBAAa,EAAC,IAAI,EAAE,qDAAqD,CAAC,CAAA;gBAC3F,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;YAC5E,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CACjD,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EACrC;YACE,YAAY,EAAE,qBAAqB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ;YAC9D,OAAO,EAAE,UAAU,GAAG,IAAI;SAC3B,CACF,CAAA;QAED,MAAM,MAAM,GAAG,IAAA,sCAAuB,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAErD,mDAAmD;QACnD,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,IAAA,uDAAwC,EAAC,MAAM,EAAE,QAAQ,CAAC,OAAiC,EAAE,WAAW,CAAC,CAAA;QACjH,CAAC;aAAM,CAAC;YACN,MAAM,IAAA,qDAAsC,EAAC,MAAM,EAAE,QAAQ,CAAC,OAAiC,EAAE,WAAW,CAAC,CAAA;QAC/G,CAAC;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrB,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YAC1C,MAAM,KAAK,GAAG,QAAQ,EAAE,KAAK,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,gCAAgC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAEnG,OAAO;gBACL,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,QAAS,CAAC,MAA0B;gBACjE,KAAK;aACN,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IAEU,AAAN,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,OAAe;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAChE,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IAEU,AAAN,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACvD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IAEU,AAAN,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACrD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IAEU,AAAN,KAAK,CAAC,SAAS,CAAC,MAAc,EAAE,WAAmB;QACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACnE,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IAEU,AAAN,KAAK,CAAC,cAAc,CAAC,KAAe,EAAE,OAAe,EAAE,QAAgB;QAC5E,MAAM,cAAc,GAAmB;YACrC,KAAK;YACL,QAAQ;YACR,OAAO;SACR,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,CAAA;QACpE,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IAEU,AAAN,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,OAAe;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAChE,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IAEU,AAAN,KAAK,CAAC,kBAAkB,CAAC,IAAY,EAAE,WAAkC;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,kBAAkB,CACtD,IAAI,EACJ,WAAW,CAAC,KAAM,EAClB,WAAW,CAAC,KAAM,EAClB,WAAW,CAAC,IAAK,CAClB,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAiCY,AAAN,KAAK,CAAC,UAAU,CAAC,GAAoB,EAAE,GAAW,EAAE,UAAkB,EAAE,GAAG,EAAE;QAClF,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,AAAN,KAAK,CAAC,WAAW,CAAC,KAAmB,EAAE,UAAkB,EAAE,GAAG,EAAE;QACrE,MAAM,qBAAqB,GACzB,iBAAO,KAAK,iBAAO,CAAC,IAAI,IAAI,iBAAO,KAAK,iBAAO,CAAC,OAAO,IAAI,iBAAO,KAAK,iBAAO,CAAC,UAAU,CAAA;QAC3F,MAAM,aAAa,GAAG,qBAAqB;YACzC,CAAC,CAAC,QAAQ;YACV,CAAC,CAAE,CAAC,MAAM,IAAA,sBAAa,EAAC,WAAW,EAAE,oCAAoC,CAAC,CAAS,CAAA;QACrF,MAAM,IAAI,GAAG,IAAI,aAAa,EAAE,CAAA;QAEhC,KAAK,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;YAC5C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;YAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAc,EAAE,WAAW,CAAC,CAAA;QAC9D,CAAC;QAED,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,oBAAoB,CAAA;YAC7D,MAAM,KAAK,CAAC,GAAG,EAAE;gBACf,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO;gBAC9C,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;aAClE,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;gBAC/B,IAAI,EAAE,IAAI;gBACV,YAAY,EAAE,CAAC;gBACf,OAAO,EAAE,OAAO,GAAG,IAAI;aACxB,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,MAA2B;QACvD,qBAAqB;QACrB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,EAAE,GAAG,MAAM,IAAA,sBAAa,EAAC,IAAI,EAAE,0DAA0D,CAAC,CAAA;YAChG,OAAO,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACpC,CAAC;QAED,OAAO;QACP,IAAI,iBAAO,KAAK,iBAAO,CAAC,OAAO,IAAI,iBAAO,KAAK,iBAAO,CAAC,UAAU,IAAI,iBAAO,KAAK,iBAAO,CAAC,IAAI,EAAE,CAAC;YAC9F,6EAA6E;YAC7E,OAAO,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAA;QACzE,CAAC;QAED,kBAAkB;QAClB,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAa,EAAC,QAAQ,EAAE,mCAAmC,CAAC,CAAA;QACjF,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACrC,CAAC;CACF;AAzaD,gCAyaC;AAvZc;IADZ,IAAA,oCAAmB,GAAE;;;;8CAIrB;AAcY;IADZ,IAAA,oCAAmB,GAAE;;;;4CAIrB;AAiCY;IADZ,IAAA,oCAAmB,GAAE;;;;8CAuBrB;AA4BY;IADZ,IAAA,oCAAmB,GAAE;;;;+CA+CrB;AAiBY;IADZ,IAAA,oCAAmB,GAAE;;;;2CAIrB;AAcY;IADZ,IAAA,oCAAmB,GAAE;;;;gDAIrB;AAgBY;IADZ,IAAA,oCAAmB,GAAE;;;;2CAIrB;AAcY;IADZ,IAAA,oCAAmB,GAAE;;;;2CAIrB;AAmBY;IADZ,IAAA,oCAAmB,GAAE;;;;gDAUrB;AAeY;IADZ,IAAA,oCAAmB,GAAE;;;;6CAIrB;AAkBY;IADZ,IAAA,oCAAmB,GAAE;;;;oDASrB;AAiCY;IADZ,IAAA,oCAAmB,GAAE;;;;4CAGrB;AA8BY;IADZ,IAAA,oCAAmB,GAAE;;;;6CA8BrB"}

package/src/Git.d.ts

@@ -0,0 +1,202 @@
+import { GitApi, ListBranchResponse, GitStatus } from '@daytonaio/toolbox-api-client';
+/**
+ * Response from the git commit.
+ *
+ * @interface
+ * @property {string} sha - The SHA of the commit
+ */
+export interface GitCommitResponse {
+    sha: string;
+}
+/**
+ * Provides Git operations within a Sandbox.
+ *
+ * @class
+ */
+export declare class Git {
+    private readonly apiClient;
+    constructor(apiClient: GitApi);
+    /**
+     * Stages the specified files for the next commit, similar to
+     * running 'git add' on the command line.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string[]} files - List of file paths or directories to stage, relative to the repository root
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Stage a single file
+     * await git.add('workspace/repo', ['file.txt']);
+     *
+     * @example
+     * // Stage whole repository
+     * await git.add('workspace/repo', ['.']);
+     */
+    add(path: string, files: string[]): Promise<void>;
+    /**
+     * List branches in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @returns {Promise<ListBranchResponse>} List of branches in the repository
+     *
+     * @example
+     * const response = await git.branches('workspace/repo');
+     * console.log(`Branches: ${response.branches}`);
+     */
+    branches(path: string): Promise<ListBranchResponse>;
+    /**
+     * Create branch in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} name - Name of the new branch to create
+     * @returns {Promise<void>}
+     *
+     * @example
+     * await git.createBranch('workspace/repo', 'new-feature');
+     */
+    createBranch(path: string, name: string): Promise<void>;
+    /**
+     * Delete branche in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} name - Name of the branch to delete
+     * @returns {Promise<void>}
+     *
+     * @example
+     * await git.deleteBranch('workspace/repo', 'new-feature');
+     */
+    deleteBranch(path: string, name: string): Promise<void>;
+    /**
+     * Checkout branche in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} branch - Name of the branch to checkout
+     * @returns {Promise<void>}
+     *
+     * @example
+     * await git.checkoutBranch('workspace/repo', 'new-feature');
+     */
+    checkoutBranch(path: string, branch: string): Promise<void>;
+    /**
+     * 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.
+     *
+     * @param {string} url - Repository URL to clone from
+     * @param {string} path - Path where the repository should be cloned. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} [branch] - Specific branch to clone. If not specified, clones the default branch
+     * @param {string} [commitId] - Specific commit to clone. If specified, the repository will be left in a detached HEAD state at this commit
+     * @param {string} [username] - Git username for authentication
+     * @param {string} [password] - Git password or token for authentication
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Clone the default branch
+     * await git.clone(
+     *   'https://github.com/user/repo.git',
+     *   'workspace/repo'
+     * );
+     *
+     * @example
+     * // Clone a specific branch with authentication
+     * await git.clone(
+     *   'https://github.com/user/private-repo.git',
+     *   'workspace/private',
+     *   branch='develop',
+     *   username='user',
+     *   password='token'
+     * );
+     *
+     * @example
+     * // Clone a specific commit
+     * await git.clone(
+     *   'https://github.com/user/repo.git',
+     *   'workspace/repo-old',
+     *   commitId='abc123'
+     * );
+     */
+    clone(url: string, path: string, branch?: string, commitId?: string, username?: string, password?: string): Promise<void>;
+    /**
+     * Commits staged changes.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} message - Commit message describing the changes
+     * @param {string} author - Name of the commit author
+     * @param {string} email - Email address of the commit author
+     * @param {boolean} [allowEmpty] - Allow creating an empty commit when no changes are staged
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Stage and commit changes
+     * await git.add('workspace/repo', ['README.md']);
+     * await git.commit(
+     *   'workspace/repo',
+     *   'Update documentation',
+     *   'John Doe',
+     *   'john@example.com',
+     *   true
+     * );
+     *
+     */
+    commit(path: string, message: string, author: string, email: string, allowEmpty?: boolean): Promise<GitCommitResponse>;
+    /**
+     * Push local changes to the remote repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} [username] - Git username for authentication
+     * @param {string} [password] - Git password or token for authentication
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Push to a public repository
+     * await git.push('workspace/repo');
+     *
+     * @example
+     * // Push to a private repository
+     * await git.push(
+     *   'workspace/repo',
+     *   'user',
+     *   'token'
+     * );
+     */
+    push(path: string, username?: string, password?: string): Promise<void>;
+    /**
+     * Pulls changes from the remote repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @param {string} [username] - Git username for authentication
+     * @param {string} [password] - Git password or token for authentication
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Pull from a public repository
+     * await git.pull('workspace/repo');
+     *
+     * @example
+     * // Pull from a private repository
+     * await git.pull(
+     *   'workspace/repo',
+     *   'user',
+     *   'token'
+     * );
+     */
+    pull(path: string, username?: string, password?: string): Promise<void>;
+    /**
+     * Gets the current status of the Git repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the sandbox working directory.
+     * @returns {Promise<GitStatus>} Current repository status including:
+     *                               - currentBranch: Name of the current branch
+     *                               - ahead: Number of commits ahead of the remote branch
+     *                               - behind: Number of commits behind the remote branch
+     *                               - branchPublished: Whether the branch has been published to the remote repository
+     *                               - fileStatus: List of file statuses
+     *
+     * @example
+     * const status = await sandbox.git.status('workspace/repo');
+     * console.log(`Current branch: ${status.currentBranch}`);
+     * console.log(`Commits ahead: ${status.ahead}`);
+     * console.log(`Commits behind: ${status.behind}`);
+     */
+    status(path: string): Promise<GitStatus>;
+}