@daytonaio/sdk 0.0.0-dev

package/src/Sandbox.js

@@ -0,0 +1,389 @@
+"use strict";
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sandbox = void 0;
+const FileSystem_1 = require("./FileSystem");
+const Git_1 = require("./Git");
+const Process_1 = require("./Process");
+const LspServer_1 = require("./LspServer");
+const DaytonaError_1 = require("./errors/DaytonaError");
+const Path_1 = require("./utils/Path");
+/**
+ * Represents a Daytona Sandbox.
+ *
+ * @property {FileSystem} fs - File system operations interface
+ * @property {Git} git - Git operations interface
+ * @property {Process} process - Process execution interface
+ * @property {string} id - Unique identifier for the Sandbox
+ * @property {string} organizationId - Organization ID of the Sandbox
+ * @property {string} [snapshot] - Daytona snapshot used to create the Sandbox
+ * @property {string} user - OS user running in the Sandbox
+ * @property {Record<string, string>} env - Environment variables set in the Sandbox
+ * @property {Record<string, string>} labels - Custom labels attached to the Sandbox
+ * @property {boolean} public - Whether the Sandbox is publicly accessible
+ * @property {string} target - Target location of the runner where the Sandbox runs
+ * @property {number} cpu - Number of CPUs allocated to the Sandbox
+ * @property {number} gpu - Number of GPUs allocated to the Sandbox
+ * @property {number} memory - Amount of memory allocated to the Sandbox in GiB
+ * @property {number} disk - Amount of disk space allocated to the Sandbox in GiB
+ * @property {SandboxState} state - Current state of the Sandbox (e.g., "started", "stopped")
+ * @property {string} [errorReason] - Error message if Sandbox is in error state
+ * @property {SandboxBackupStateEnum} [backupState] - Current state of Sandbox backup
+ * @property {string} [backupCreatedAt] - When the backup was created
+ * @property {number} [autoStopInterval] - Auto-stop interval in minutes
+ * @property {number} [autoArchiveInterval] - Auto-archive interval in minutes
+ * @property {string} [runnerDomain] - Domain name of the Sandbox runner
+ * @property {Array<SandboxVolume>} [volumes] - Volumes attached to the Sandbox
+ * @property {BuildInfo} [buildInfo] - Build information for the Sandbox if it was created from dynamic build
+ * @property {string} [createdAt] - When the Sandbox was created
+ * @property {string} [updatedAt] - When the Sandbox was last updated
+ *
+ * @class
+ */
+class Sandbox {
+    sandboxApi;
+    toolboxApi;
+    codeToolbox;
+    fs;
+    git;
+    process;
+    id;
+    organizationId;
+    snapshot;
+    user;
+    env;
+    labels;
+    public;
+    target;
+    cpu;
+    gpu;
+    memory;
+    disk;
+    state;
+    errorReason;
+    backupState;
+    backupCreatedAt;
+    autoStopInterval;
+    autoArchiveInterval;
+    runnerDomain;
+    volumes;
+    buildInfo;
+    createdAt;
+    updatedAt;
+    rootDir;
+    /**
+     * Creates a new Sandbox instance
+     *
+     * @param {SandboxDto} sandboxDto - The API Sandbox instance
+     * @param {SandboxApi} sandboxApi - API client for Sandbox operations
+     * @param {ToolboxApi} toolboxApi - API client for toolbox operations
+     * @param {SandboxCodeToolbox} codeToolbox - Language-specific toolbox implementation
+     */
+    constructor(sandboxDto, sandboxApi, toolboxApi, codeToolbox) {
+        this.sandboxApi = sandboxApi;
+        this.toolboxApi = toolboxApi;
+        this.codeToolbox = codeToolbox;
+        this.processSandboxDto(sandboxDto);
+        this.rootDir = '';
+        this.fs = new FileSystem_1.FileSystem(this.id, this.toolboxApi, async () => await this.getRootDir());
+        this.git = new Git_1.Git(this.id, this.toolboxApi, async () => await this.getRootDir());
+        this.process = new Process_1.Process(this.id, this.codeToolbox, this.toolboxApi, async () => await this.getRootDir());
+    }
+    /**
+     * Gets the root directory path for the logged in user inside the Sandbox.
+     *
+     * @returns {Promise<string | undefined>} The absolute path to the Sandbox root directory for the logged in user
+     *
+     * @example
+     * const rootDir = await sandbox.getUserRootDir();
+     * console.log(`Sandbox root: ${rootDir}`);
+     */
+    async getUserRootDir() {
+        const response = await this.toolboxApi.getProjectDir(this.id);
+        return response.data.dir;
+    }
+    /**
+     * Creates a new Language Server Protocol (LSP) server instance.
+     *
+     * The LSP server provides language-specific features like code completion,
+     * diagnostics, and more.
+     *
+     * @param {LspLanguageId} languageId - The language server type (e.g., "typescript")
+     * @param {string} pathToProject - Path to the project root directory. Relative paths are resolved based on the user's
+     * root directory.
+     * @returns {LspServer} A new LSP server instance configured for the specified language
+     *
+     * @example
+     * const lsp = await sandbox.createLspServer('typescript', 'workspace/project');
+     */
+    async createLspServer(languageId, pathToProject) {
+        return new LspServer_1.LspServer(languageId, (0, Path_1.prefixRelativePath)(await this.getRootDir(), pathToProject), this.toolboxApi, this.id);
+    }
+    /**
+     * Sets labels for the Sandbox.
+     *
+     * Labels are key-value pairs that can be used to organize and identify Sandboxes.
+     *
+     * @param {Record<string, string>} labels - Dictionary of key-value pairs representing Sandbox labels
+     * @returns {Promise<void>}
+     *
+     * @example
+     * // Set sandbox labels
+     * await sandbox.setLabels({
+     *   project: 'my-project',
+     *   environment: 'development',
+     *   team: 'backend'
+     * });
+     */
+    async setLabels(labels) {
+        this.labels = (await this.sandboxApi.replaceLabels(this.id, { labels })).data.labels;
+        return this.labels;
+    }
+    /**
+     * Start the Sandbox.
+     *
+     * This method starts the Sandbox and waits for it to be ready.
+     *
+     * @param {number} [timeout] - Maximum time to wait in seconds. 0 means no timeout.
+     *                            Defaults to 60-second timeout.
+     * @returns {Promise<void>}
+     * @throws {DaytonaError} - `DaytonaError` - If Sandbox fails to start or times out
+     *
+     * @example
+     * const sandbox = await daytona.getCurrentSandbox('my-sandbox');
+     * await sandbox.start(40);  // Wait up to 40 seconds
+     * console.log('Sandbox started successfully');
+     */
+    async start(timeout = 60) {
+        if (timeout < 0) {
+            throw new DaytonaError_1.DaytonaError('Timeout must be a non-negative number');
+        }
+        const startTime = Date.now();
+        await this.sandboxApi.startSandbox(this.id, undefined, { timeout: timeout * 1000 });
+        await this.refreshData();
+        const timeElapsed = Date.now() - startTime;
+        await this.waitUntilStarted(timeout ? timeout - timeElapsed / 1000 : 0);
+    }
+    /**
+     * Stops the Sandbox.
+     *
+     * This method stops the Sandbox and waits for it to be fully stopped.
+     *
+     * @param {number} [timeout] - Maximum time to wait in seconds. 0 means no timeout.
+     *                            Defaults to 60-second timeout.
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const sandbox = await daytona.getCurrentSandbox('my-sandbox');
+     * await sandbox.stop();
+     * console.log('Sandbox stopped successfully');
+     */
+    async stop(timeout = 60) {
+        if (timeout < 0) {
+            throw new DaytonaError_1.DaytonaError('Timeout must be a non-negative number');
+        }
+        const startTime = Date.now();
+        await this.sandboxApi.stopSandbox(this.id, undefined, { timeout: timeout * 1000 });
+        await this.refreshData();
+        const timeElapsed = Date.now() - startTime;
+        await this.waitUntilStopped(timeout ? timeout - timeElapsed / 1000 : 0);
+    }
+    /**
+     * Deletes the Sandbox.
+     * @returns {Promise<void>}
+     */
+    async delete(timeout = 60) {
+        await this.sandboxApi.deleteSandbox(this.id, true, undefined, { timeout: timeout * 1000 });
+        await this.refreshData();
+    }
+    /**
+     * Waits for the Sandbox to reach the 'started' state.
+     *
+     * This method polls the Sandbox status until it reaches the 'started' state
+     * or encounters an error.
+     *
+     * @param {number} [timeout] - Maximum time to wait in seconds. 0 means no timeout.
+     *                               Defaults to 60 seconds.
+     * @returns {Promise<void>}
+     * @throws {DaytonaError} - `DaytonaError` - If the sandbox ends up in an error state or fails to start within the timeout period.
+     */
+    async waitUntilStarted(timeout = 60) {
+        if (timeout < 0) {
+            throw new DaytonaError_1.DaytonaError('Timeout must be a non-negative number');
+        }
+        const checkInterval = 100; // Wait 100 ms between checks
+        const startTime = Date.now();
+        while (this.state !== 'started') {
+            await this.refreshData();
+            if (this.state === 'error') {
+                const errMsg = `Sandbox ${this.id} failed to start with status: ${this.state}, error reason: ${this.errorReason}`;
+                throw new DaytonaError_1.DaytonaError(errMsg);
+            }
+            if (timeout !== 0 && Date.now() - startTime > timeout * 1000) {
+                throw new DaytonaError_1.DaytonaError('Sandbox failed to become ready within the timeout period');
+            }
+            await new Promise((resolve) => setTimeout(resolve, checkInterval));
+        }
+    }
+    /**
+     * Wait for Sandbox to reach 'stopped' state.
+     *
+     * This method polls the Sandbox status until it reaches the 'stopped' state
+     * or encounters an error.
+     *
+     * @param {number} [timeout] - Maximum time to wait in seconds. 0 means no timeout.
+     *                               Defaults to 60 seconds.
+     * @returns {Promise<void>}
+     * @throws {DaytonaError} - `DaytonaError` - If the sandbox fails to stop within the timeout period.
+     */
+    async waitUntilStopped(timeout = 60) {
+        if (timeout < 0) {
+            throw new DaytonaError_1.DaytonaError('Timeout must be a non-negative number');
+        }
+        const checkInterval = 100; // Wait 100 ms between checks
+        const startTime = Date.now();
+        while (this.state !== 'stopped') {
+            await this.refreshData();
+            if (this.state === 'error') {
+                const errMsg = `Sandbox failed to stop with status: ${this.state}, error reason: ${this.errorReason}`;
+                throw new DaytonaError_1.DaytonaError(errMsg);
+            }
+            if (timeout !== 0 && Date.now() - startTime > timeout * 1000) {
+                throw new DaytonaError_1.DaytonaError('Sandbox failed to become stopped within the timeout period');
+            }
+            await new Promise((resolve) => setTimeout(resolve, checkInterval));
+        }
+    }
+    /**
+     * Refreshes the Sandbox data from the API.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * await sandbox.refreshData();
+     * console.log(`Sandbox ${sandbox.id}:`);
+     * console.log(`State: ${sandbox.state}`);
+     * console.log(`Resources: ${sandbox.cpu} CPU, ${sandbox.memory} GiB RAM`);
+     */
+    async refreshData() {
+        const response = await this.sandboxApi.getSandbox(this.id);
+        this.processSandboxDto(response.data);
+    }
+    /**
+     * Set the auto-stop interval for the Sandbox.
+     *
+     * The Sandbox will automatically stop after being idle (no new events) for the specified interval.
+     * Events include any state changes or interactions with the Sandbox through the sdk.
+     * Interactions using Sandbox Previews are not included.
+     *
+     * @param {number} interval - Number of minutes of inactivity before auto-stopping.
+     *                           Set to 0 to disable auto-stop. Default is 15 minutes.
+     * @returns {Promise<void>}
+     * @throws {DaytonaError} - `DaytonaError` - If interval is not a non-negative integer
+     *
+     * @example
+     * // Auto-stop after 1 hour
+     * await sandbox.setAutostopInterval(60);
+     * // Or disable auto-stop
+     * await sandbox.setAutostopInterval(0);
+     */
+    async setAutostopInterval(interval) {
+        if (!Number.isInteger(interval) || interval < 0) {
+            throw new DaytonaError_1.DaytonaError('autoStopInterval must be a non-negative integer');
+        }
+        await this.sandboxApi.setAutostopInterval(this.id, interval);
+        this.autoStopInterval = interval;
+    }
+    /**
+     * Set the auto-archive interval for the Sandbox.
+     *
+     * The Sandbox will automatically archive after being continuously stopped for the specified interval.
+     *
+     * @param {number} interval - Number of minutes after which a continuously stopped Sandbox will be auto-archived.
+     *                           Set to 0 for the maximum interval. Default is 7 days.
+     * @returns {Promise<void>}
+     * @throws {DaytonaError} - `DaytonaError` - If interval is not a non-negative integer
+     *
+     * @example
+     * // Auto-archive after 1 hour
+     * await sandbox.setAutoArchiveInterval(60);
+     * // Or use the maximum interval
+     * await sandbox.setAutoArchiveInterval(0);
+     */
+    async setAutoArchiveInterval(interval) {
+        if (!Number.isInteger(interval) || interval < 0) {
+            throw new DaytonaError_1.DaytonaError('autoArchiveInterval must be a non-negative integer');
+        }
+        await this.sandboxApi.setAutoArchiveInterval(this.id, interval);
+        this.autoArchiveInterval = interval;
+    }
+    /**
+     * Retrieves the preview link for the sandbox at the specified port. If the port is closed,
+     * it will be opened automatically. For private sandboxes, a token is included to grant access
+     * to the URL.
+     *
+     * @param {number} port - The port to open the preview link on.
+     * @returns {PortPreviewUrl} The response object for the preview link, which includes the `url`
+     * and the `token` (to access private sandboxes).
+     *
+     * @example
+     * const previewLink = await sandbox.getPreviewLink(3000);
+     * console.log(`Preview URL: ${previewLink.url}`);
+     * console.log(`Token: ${previewLink.token}`);
+     */
+    async getPreviewLink(port) {
+        return (await this.sandboxApi.getPortPreviewUrl(this.id, port)).data;
+    }
+    /**
+     * Archives the sandbox, making it inactive and preserving its state. When sandboxes are archived, the entire filesystem
+     * state is moved to cost-effective object storage, making it possible to keep sandboxes available for an extended period.
+     * The tradeoff between archived and stopped states is that starting an archived sandbox takes more time, depending on its size.
+     * Sandbox must be stopped before archiving.
+     */
+    async archive() {
+        await this.sandboxApi.archiveSandbox(this.id);
+        await this.refreshData();
+    }
+    async getRootDir() {
+        if (!this.rootDir) {
+            this.rootDir = (await this.getUserRootDir()) || '';
+        }
+        return this.rootDir;
+    }
+    /**
+     * Assigns the API sandbox data to the Sandbox object.
+     *
+     * @param {SandboxDto} sandboxDto - The API sandbox instance to assign data from
+     * @returns {void}
+     */
+    processSandboxDto(sandboxDto) {
+        this.id = sandboxDto.id;
+        this.organizationId = sandboxDto.organizationId;
+        this.snapshot = sandboxDto.snapshot;
+        this.user = sandboxDto.user;
+        this.env = sandboxDto.env;
+        this.labels = sandboxDto.labels;
+        this.public = sandboxDto.public;
+        this.target = sandboxDto.target;
+        this.cpu = sandboxDto.cpu;
+        this.gpu = sandboxDto.gpu;
+        this.memory = sandboxDto.memory;
+        this.disk = sandboxDto.disk;
+        this.state = sandboxDto.state;
+        this.errorReason = sandboxDto.errorReason;
+        this.backupState = sandboxDto.backupState;
+        this.backupCreatedAt = sandboxDto.backupCreatedAt;
+        this.autoStopInterval = sandboxDto.autoStopInterval;
+        this.autoArchiveInterval = sandboxDto.autoArchiveInterval;
+        this.runnerDomain = sandboxDto.runnerDomain;
+        this.volumes = sandboxDto.volumes;
+        this.buildInfo = sandboxDto.buildInfo;
+        this.createdAt = sandboxDto.createdAt;
+        this.updatedAt = sandboxDto.updatedAt;
+    }
+}
+exports.Sandbox = Sandbox;
+//# sourceMappingURL=Sandbox.js.map

package/src/Sandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sandbox.js","sourceRoot":"","sources":["../../../../libs/sdk-typescript/src/Sandbox.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAaH,6CAAyC;AACzC,+BAA2B;AAC3B,uCAAkD;AAClD,2CAAsD;AACtD,wDAAoD;AACpD,uCAAiD;AAWjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,OAAO;IAyCC;IACA;IACA;IA1CH,EAAE,CAAY;IACd,GAAG,CAAK;IACR,OAAO,CAAS;IAEzB,EAAE,CAAS;IACX,cAAc,CAAS;IACvB,QAAQ,CAAS;IACjB,IAAI,CAAS;IACb,GAAG,CAAyB;IAC5B,MAAM,CAAyB;IAC/B,MAAM,CAAU;IAChB,MAAM,CAAS;IACf,GAAG,CAAS;IACZ,GAAG,CAAS;IACZ,MAAM,CAAS;IACf,IAAI,CAAS;IACb,KAAK,CAAe;IACpB,WAAW,CAAS;IACpB,WAAW,CAAyB;IACpC,eAAe,CAAS;IACxB,gBAAgB,CAAS;IACzB,mBAAmB,CAAS;IAC5B,YAAY,CAAS;IACrB,OAAO,CAAuB;IAC9B,SAAS,CAAY;IACrB,SAAS,CAAS;IAClB,SAAS,CAAS;IAEjB,OAAO,CAAQ;IAEvB;;;;;;;OAOG;IACH,YACE,UAAsB,EACL,UAAsB,EACtB,UAAsB,EACtB,WAA+B;QAF/B,eAAU,GAAV,UAAU,CAAY;QACtB,eAAU,GAAV,UAAU,CAAY;QACtB,gBAAW,GAAX,WAAW,CAAoB;QAEhD,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAA;QAClC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,EAAE,GAAG,IAAI,uBAAU,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACvF,IAAI,CAAC,GAAG,GAAG,IAAI,SAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACjF,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;IAC7G,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC7D,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,eAAe,CAAC,UAAkC,EAAE,aAAqB;QACpF,OAAO,IAAI,qBAAS,CAClB,UAA2B,EAC3B,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,EAC1D,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,EAAE,CACR,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,SAAS,CAAC,MAA8B;QACnD,IAAI,CAAC,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;QACpF,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE;QAC7B,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,2BAAY,CAAC,uCAAuC,CAAC,CAAA;QACjE,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,CAAC,CAAA;QACnF,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;QAC1C,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE;QAC5B,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,2BAAY,CAAC,uCAAuC,CAAC,CAAA;QACjE,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,CAAC,CAAA;QAClF,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;QAC1C,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,OAAO,GAAG,EAAE;QAC9B,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,CAAC,CAAA;QAC1F,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAAO,GAAG,EAAE;QACxC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,2BAAY,CAAC,uCAAuC,CAAC,CAAA;QACjE,CAAC;QAED,MAAM,aAAa,GAAG,GAAG,CAAA,CAAC,6BAA6B;QACvD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAE5B,OAAO,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;YAExB,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC3B,MAAM,MAAM,GAAG,WAAW,IAAI,CAAC,EAAE,iCAAiC,IAAI,CAAC,KAAK,mBAAmB,IAAI,CAAC,WAAW,EAAE,CAAA;gBACjH,MAAM,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;gBAC7D,MAAM,IAAI,2BAAY,CAAC,0DAA0D,CAAC,CAAA;YACpF,CAAC;YAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAA;QACpE,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAAO,GAAG,EAAE;QACxC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,2BAAY,CAAC,uCAAuC,CAAC,CAAA;QACjE,CAAC;QAED,MAAM,aAAa,GAAG,GAAG,CAAA,CAAC,6BAA6B;QACvD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAE5B,OAAO,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;YAExB,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC3B,MAAM,MAAM,GAAG,uCAAuC,IAAI,CAAC,KAAK,mBAAmB,IAAI,CAAC,WAAW,EAAE,CAAA;gBACrG,MAAM,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;gBAC7D,MAAM,IAAI,2BAAY,CAAC,4DAA4D,CAAC,CAAA;YACtF,CAAC;YAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAA;QACpE,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC1D,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,mBAAmB,CAAC,QAAgB;QAC/C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,2BAAY,CAAC,iDAAiD,CAAC,CAAA;QAC3E,CAAC;QAED,MAAM,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;QAC5D,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,sBAAsB,CAAC,QAAgB;QAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,2BAAY,CAAC,oDAAoD,CAAC,CAAA;QAC9E,CAAC;QACD,MAAM,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;QAC/D,IAAI,CAAC,mBAAmB,GAAG,QAAQ,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY;QACtC,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IACtE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC7C,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;IAC1B,CAAC;IAEO,KAAK,CAAC,UAAU;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,CAAA;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;;;;OAKG;IACK,iBAAiB,CAAC,UAAsB;QAC9C,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAA;QACvB,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC3B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAA;QACzB,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC3B,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAA;QAC7B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAA;QACzC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAA;QACzC,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CAAA;QACjD,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAA;QACnD,IAAI,CAAC,mBAAmB,GAAG,UAAU,CAAC,mBAAmB,CAAA;QACzD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAA;QAC3C,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAA;QACjC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;IACvC,CAAC;CACF;AAtXD,0BAsXC"}

package/src/Snapshot.d.ts

@@ -0,0 +1,116 @@
+import { ObjectStorageApi, SnapshotDto, SnapshotsApi } from '@daytonaio/api-client';
+import { Image } from './Image';
+import { Resources } from './Daytona';
+/**
+ * Represents a Daytona Snapshot which is a pre-configured sandbox.
+ *
+ * @property {string} id - Unique identifier for the Snapshot.
+ * @property {string} organizationId - Organization ID that owns the Snapshot.
+ * @property {boolean} general - Whether the Snapshot is general.
+ * @property {string} name - Name of the Snapshot.
+ * @property {string} imageName - Name of the Image of the Snapshot.
+ * @property {boolean} enabled - Whether the Snapshot is enabled.
+ * @property {SnapshotState} state - Current state of the Snapshot.
+ * @property {number} size - Size of the Snapshot.
+ * @property {string[]} entrypoint - Entrypoint of the Snapshot.
+ * @property {number} cpu - CPU of the Snapshot.
+ * @property {number} gpu - GPU of the Snapshot.
+ * @property {number} mem - Memory of the Snapshot in GiB.
+ * @property {number} disk - Disk of the Snapshot in GiB.
+ * @property {string} errorReason - Error reason of the Snapshot.
+ * @property {Date} createdAt - Timestamp when the Snapshot was created.
+ * @property {Date} updatedAt - Timestamp when the Snapshot was last updated.
+ * @property {Date} lastUsedAt - Timestamp when the Snapshot was last used.
+ */
+export type Snapshot = SnapshotDto & {
+    __brand: 'Snapshot';
+};
+/**
+ * Parameters for creating a new snapshot.
+ *
+ * @property {string} name - Name of the snapshot.
+ * @property {string | Image} image - Image of the snapshot. If a string is provided, it should be available on some registry.
+ * If an Image instance is provided, it will be used to create a new image in Daytona.
+ * @property {Resources} resources - Resources of the snapshot.
+ * @property {string[]} entrypoint - Entrypoint of the snapshot.
+ */
+export type CreateSnapshotParams = {
+    name: string;
+    image: string | Image;
+    resources?: Resources;
+    entrypoint?: string[];
+};
+/**
+ * Service for managing Daytona Snapshots. Can be used to list, get, create and delete Snapshots.
+ *
+ * @class
+ */
+export declare class SnapshotService {
+    private snapshotsApi;
+    private objectStorageApi;
+    constructor(snapshotsApi: SnapshotsApi, objectStorageApi: ObjectStorageApi);
+    /**
+     * List all Snapshots.
+     *
+     * @returns {Promise<Snapshot[]>} List of all Snapshots accessible to the user
+     *
+     * @example
+     * const daytona = new Daytona();
+     * const snapshots = await daytona.snapshot.list();
+     * console.log(`Found ${snapshots.length} snapshots`);
+     * snapshots.forEach(snapshot => console.log(`${snapshot.name} (${snapshot.imageName})`));
+     */
+    list(): Promise<Snapshot[]>;
+    /**
+     * Gets a Snapshot by its name.
+     *
+     * @param {string} name - Name of the Snapshot to retrieve
+     * @returns {Promise<Snapshot>} The requested Snapshot
+     * @throws {Error} If the Snapshot does not exist or cannot be accessed
+     *
+     * @example
+     * const daytona = new Daytona();
+     * const snapshot = await daytona.snapshot.get("snapshot-name");
+     * console.log(`Snapshot ${snapshot.name} is in state ${snapshot.state}`);
+     */
+    get(name: string): Promise<Snapshot>;
+    /**
+     * Deletes a Snapshot.
+     *
+     * @param {Snapshot} snapshot - Snapshot to delete
+     * @returns {Promise<void>}
+     * @throws {Error} If the Snapshot does not exist or cannot be deleted
+     *
+     * @example
+     * const daytona = new Daytona();
+     * const snapshot = await daytona.snapshot.get("snapshot-name");
+     * await daytona.snapshot.delete(snapshot);
+     * console.log("Snapshot deleted successfully");
+     */
+    delete(snapshot: Snapshot): Promise<void>;
+    /**
+     * Creates and registers a new snapshot from the given Image definition.
+     *
+     * @param {CreateSnapshotParams} params - Parameters for snapshot creation.
+     * @param {object} options - Options for the create operation.
+     * @param {boolean} options.onLogs - This callback function handles snapshot creation logs.
+     * @param {number} options.timeout - Default is no timeout. Timeout in seconds (0 means no timeout).
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const image = Image.debianSlim('3.12').pipInstall('numpy');
+     * await daytona.snapshot.create({ name: 'my-snapshot', image: image }, { onLogs: console.log });
+     */
+    create(params: CreateSnapshotParams, options?: {
+        onLogs?: (chunk: string) => void;
+        timeout?: number;
+    }): Promise<Snapshot>;
+    /**
+     * Processes the image contexts by uploading them to object storage
+     *
+     * @private
+     * @param {Image} image - The Image instance.
+     * @returns {Promise<string[]>} The list of context hashes stored in object storage.
+     */
+    static processImageContext(objectStorageApi: ObjectStorageApi, image: Image): Promise<string[]>;
+}