@daytonaio/sdk 0.127.0 → 0.128.0-alpha.1

package/esm/Daytona.d.ts

@@ -0,0 +1,354 @@
+import { SandboxVolume } from '@daytonaio/api-client';
+import { Image } from './Image.js';
+import { Sandbox, PaginatedSandboxes } from './Sandbox.js';
+import { SnapshotService } from './Snapshot.js';
+import { VolumeService } from './Volume.js';
+/**
+ * Represents a volume mount for a Sandbox.
+ *
+ * @interface
+ * @property {string} volumeId - ID of the Volume to mount
+ * @property {string} mountPath - Path on the Sandbox to mount the Volume
+ */
+export interface VolumeMount extends SandboxVolume {
+    volumeId: string;
+    mountPath: string;
+}
+/**
+ * Configuration options for initializing the Daytona client.
+ *
+ * @interface
+ * @property {string} apiKey - API key for authentication with the Daytona API
+ * @property {string} jwtToken - JWT token for authentication with the Daytona API. If not set, it must be provided
+ * via the environment variable `DAYTONA_JWT_TOKEN`, or an API key must be provided instead.
+ * @property {string} organizationId - Organization ID used for JWT-based authentication. Required if a JWT token
+ * is provided, and must be set either here or in the environment variable `DAYTONA_ORGANIZATION_ID`.
+ * @property {string} apiUrl - URL of the Daytona API. Defaults to 'https://app.daytona.io/api'
+ * if not set here and not set in environment variable DAYTONA_API_URL.
+ * @property {string} target - Target location for Sandboxes
+ *
+ * @example
+ * const config: DaytonaConfig = {
+ *     apiKey: "your-api-key",
+ *     apiUrl: "https://your-api.com",
+ *     target: "us"
+ * };
+ * const daytona = new Daytona(config);
+ */
+export interface DaytonaConfig {
+    /** API key for authentication with the Daytona API */
+    apiKey?: string;
+    /** JWT token for authentication with the Daytona API */
+    jwtToken?: string;
+    /** Organization ID for authentication with the Daytona API */
+    organizationId?: string;
+    /** URL of the Daytona API.
+     */
+    apiUrl?: string;
+    /**
+     * @deprecated Use `apiUrl` instead. This property will be removed in future versions.
+     */
+    serverUrl?: string;
+    /** Target environment for sandboxes */
+    target?: string;
+}
+/**
+ * Supported programming languages for code execution
+ *
+ * Python is used as the default sandbox language when no language is explicitly specified.
+ */
+export declare enum CodeLanguage {
+    PYTHON = "python",
+    TYPESCRIPT = "typescript",
+    JAVASCRIPT = "javascript"
+}
+/**
+ * Resource allocation for a Sandbox.
+ *
+ * @interface
+ * @property {number} [cpu] - CPU allocation for the Sandbox in cores
+ * @property {number} [gpu] - GPU allocation for the Sandbox in units
+ * @property {number} [memory] - Memory allocation for the Sandbox in GiB
+ * @property {number} [disk] - Disk space allocation for the Sandbox in GiB
+ *
+ * @example
+ * const resources: SandboxResources = {
+ *     cpu: 2,
+ *     memory: 4,  // 4GiB RAM
+ *     disk: 20    // 20GiB disk
+ * };
+ */
+export interface Resources {
+    /** CPU allocation for the Sandbox */
+    cpu?: number;
+    /** GPU allocation for the Sandbox */
+    gpu?: number;
+    /** Memory allocation for the Sandbox in GiB */
+    memory?: number;
+    /** Disk space allocation for the Sandbox in GiB */
+    disk?: number;
+}
+/**
+ * Base parameters for creating a new Sandbox.
+ *
+ * @interface
+ * @property {string} [user] - Optional os user to use for the Sandbox
+ * @property {CodeLanguage | string} [language] - Programming language for direct code execution. Defaults to "python" if not specified.
+ * @property {Record<string, string>} [envVars] - Optional environment variables to set in the Sandbox
+ * @property {Record<string, string>} [labels] - Sandbox labels
+ * @property {boolean} [public] - Is the Sandbox port preview public
+ * @property {number} [autoStopInterval] - Auto-stop interval in minutes (0 means disabled). Default is 15 minutes.
+ * @property {number} [autoArchiveInterval] - Auto-archive interval in minutes (0 means the maximum interval will be used). Default is 7 days.
+ * @property {number} [autoDeleteInterval] - Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping). By default, auto-delete is disabled.
+ * @property {VolumeMount[]} [volumes] - Optional array of volumes to mount to the Sandbox
+ * @property {boolean} [networkBlockAll] - Whether to block all network access for the Sandbox
+ * @property {string} [networkAllowList] - Comma-separated list of allowed CIDR network addresses for the Sandbox
+ * @property {boolean} [ephemeral] - Whether the Sandbox should be ephemeral. If true, autoDeleteInterval will be set to 0.
+ */
+export type CreateSandboxBaseParams = {
+    name?: string;
+    user?: string;
+    language?: CodeLanguage | string;
+    envVars?: Record<string, string>;
+    labels?: Record<string, string>;
+    public?: boolean;
+    autoStopInterval?: number;
+    autoArchiveInterval?: number;
+    autoDeleteInterval?: number;
+    volumes?: VolumeMount[];
+    networkBlockAll?: boolean;
+    networkAllowList?: string;
+    ephemeral?: boolean;
+};
+/**
+ * Parameters for creating a new Sandbox.
+ *
+ * @interface
+ * @property {string | Image} [image] - Custom Docker image to use for the Sandbox. If an Image object is provided,
+ * the image will be dynamically built.
+ * @property {Resources} [resources] - Resource allocation for the Sandbox. If not provided, sandbox will
+ * have default resources.
+ */
+export type CreateSandboxFromImageParams = CreateSandboxBaseParams & {
+    image: string | Image;
+    resources?: Resources;
+};
+/**
+ * Parameters for creating a new Sandbox from a snapshot.
+ *
+ * @interface
+ * @property {string} [snapshot] - Name of the snapshot to use for the Sandbox.
+ */
+export type CreateSandboxFromSnapshotParams = CreateSandboxBaseParams & {
+    snapshot?: string;
+};
+/**
+ * Filter for Sandboxes.
+ *
+ * @interface
+ * @property {string} [idOrName] - The ID or name of the Sandbox to retrieve
+ * @property {Record<string, string>} [labels] - Labels to filter Sandboxes
+ */
+export type SandboxFilter = {
+    idOrName?: string;
+    labels?: Record<string, string>;
+};
+/**
+ * Main class for interacting with the Daytona API.
+ * Provides methods for creating, managing, and interacting with Daytona Sandboxes.
+ * Can be initialized either with explicit configuration or using environment variables.
+ *
+ * @property {VolumeService} volume - Service for managing Daytona Volumes
+ * @property {SnapshotService} snapshot - Service for managing Daytona Snapshots
+ *
+ * @example
+ * // Using environment variables
+ * // Uses DAYTONA_API_KEY, DAYTONA_API_URL, DAYTONA_TARGET
+ * const daytona = new Daytona();
+ * const sandbox = await daytona.create();
+ *
+ * @example
+ * // Using explicit configuration
+ * const config: DaytonaConfig = {
+ *     apiKey: "your-api-key",
+ *     apiUrl: "https://your-api.com",
+ *     target: "us"
+ * };
+ * const daytona = new Daytona(config);
+ *
+ * @class
+ */
+export declare class Daytona {
+    private readonly clientConfig;
+    private readonly sandboxApi;
+    private readonly objectStorageApi;
+    private readonly configApi;
+    private readonly target?;
+    private readonly apiKey?;
+    private readonly jwtToken?;
+    private readonly organizationId?;
+    private readonly apiUrl;
+    private proxyToolboxUrl?;
+    readonly volume: VolumeService;
+    readonly snapshot: SnapshotService;
+    /**
+     * Creates a new Daytona client instance.
+     *
+     * @param {DaytonaConfig} [config] - Configuration options
+     * @throws {DaytonaError} - `DaytonaError` - When API key is missing
+     */
+    constructor(config?: DaytonaConfig);
+    /**
+     * Creates Sandboxes from specified or default snapshot. You can specify various parameters,
+     * including language, image, environment variables, and volumes.
+     *
+     * @param {CreateSandboxFromSnapshotParams} [params] - Parameters for Sandbox creation from snapshot
+     * @param {object} [options] - Options for the create operation
+     * @param {number} [options.timeout] - Timeout in seconds (0 means no timeout, default is 60)
+     * @returns {Promise<Sandbox>} The created Sandbox instance
+     *
+     * @example
+     * const sandbox = await daytona.create();
+     *
+     * @example
+     * // Create a custom sandbox
+     * const params: CreateSandboxFromSnapshotParams = {
+     *     language: 'typescript',
+     *     snapshot: 'my-snapshot-id',
+     *     envVars: {
+     *         NODE_ENV: 'development',
+     *         DEBUG: 'true'
+     *     },
+     *     autoStopInterval: 60,
+     *     autoArchiveInterval: 60,
+     *     autoDeleteInterval: 120
+     * };
+     * const sandbox = await daytona.create(params, { timeout: 100 });
+     */
+    create(params?: CreateSandboxFromSnapshotParams, options?: {
+        timeout?: number;
+    }): Promise<Sandbox>;
+    /**
+     * Creates Sandboxes from specified image available on some registry or declarative Daytona Image. You can specify various parameters,
+     * including resources, language, image, environment variables, and volumes. Daytona creates snapshot from
+     * provided image and uses it to create Sandbox.
+     *
+     * @param {CreateSandboxFromImageParams} [params] - Parameters for Sandbox creation from image
+     * @param {object} [options] - Options for the create operation
+     * @param {number} [options.timeout] - Timeout in seconds (0 means no timeout, default is 60)
+     * @param {function} [options.onSnapshotCreateLogs] - Callback function to handle snapshot creation logs.
+     * @returns {Promise<Sandbox>} The created Sandbox instance
+     *
+     * @example
+     * const sandbox = await daytona.create({ image: 'debian:12.9' }, { timeout: 90, onSnapshotCreateLogs: console.log });
+     *
+     * @example
+     * // Create a custom sandbox
+     * const image = Image.base('alpine:3.18').pipInstall('numpy');
+     * const params: CreateSandboxFromImageParams = {
+     *     language: 'typescript',
+     *     image,
+     *     envVars: {
+     *         NODE_ENV: 'development',
+     *         DEBUG: 'true'
+     *     },
+     *     resources: {
+     *         cpu: 2,
+     *         memory: 4 // 4GB RAM
+     *     },
+     *     autoStopInterval: 60,
+     *     autoArchiveInterval: 60,
+     *     autoDeleteInterval: 120
+     * };
+     * const sandbox = await daytona.create(params, { timeout: 100, onSnapshotCreateLogs: console.log });
+     */
+    create(params?: CreateSandboxFromImageParams, options?: {
+        onSnapshotCreateLogs?: (chunk: string) => void;
+        timeout?: number;
+    }): Promise<Sandbox>;
+    /**
+     * Gets a Sandbox by its ID or name.
+     *
+     * @param {string} sandboxIdOrName - The ID or name of the Sandbox to retrieve
+     * @returns {Promise<Sandbox>} The Sandbox
+     *
+     * @example
+     * const sandbox = await daytona.get('my-sandbox-id-or-name');
+     * console.log(`Sandbox state: ${sandbox.state}`);
+     */
+    get(sandboxIdOrName: string): Promise<Sandbox>;
+    /**
+     * Finds a Sandbox by its ID or name or labels.
+     *
+     * @param {SandboxFilter} filter - Filter for Sandboxes
+     * @returns {Promise<Sandbox>} First Sandbox that matches the ID or name or labels.
+     *
+     * @example
+     * const sandbox = await daytona.findOne({ labels: { 'my-label': 'my-value' } });
+     * console.log(`Sandbox ID: ${sandbox.id}, State: ${sandbox.state}`);
+     */
+    findOne(filter: SandboxFilter): Promise<Sandbox>;
+    /**
+     * Returns paginated list of Sandboxes filtered by labels.
+     *
+     * @param {Record<string, string>} [labels] - Labels to filter Sandboxes
+     * @param {number} [page] - Page number for pagination (starting from 1)
+     * @param {number} [limit] - Maximum number of items per page
+     * @returns {Promise<PaginatedSandboxes>} Paginated list of Sandboxes that match the labels.
+     *
+     * @example
+     * const result = await daytona.list({ 'my-label': 'my-value' }, 2, 10);
+     * for (const sandbox of result.items) {
+     *     console.log(`${sandbox.id}: ${sandbox.state}`);
+     * }
+     */
+    list(labels?: Record<string, string>, page?: number, limit?: number): Promise<PaginatedSandboxes>;
+    /**
+     * Starts a Sandbox and waits for it to be ready.
+     *
+     * @param {Sandbox} sandbox - The Sandbox to start
+     * @param {number} [timeout] - Optional timeout in seconds (0 means no timeout)
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const sandbox = await daytona.get('my-sandbox-id');
+     * // Wait up to 60 seconds for the sandbox to start
+     * await daytona.start(sandbox, 60);
+     */
+    start(sandbox: Sandbox, timeout?: number): Promise<void>;
+    /**
+     * Stops a Sandbox.
+     *
+     * @param {Sandbox} sandbox - The Sandbox to stop
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const sandbox = await daytona.get('my-sandbox-id');
+     * await daytona.stop(sandbox);
+     */
+    stop(sandbox: Sandbox): Promise<void>;
+    /**
+     * Deletes a Sandbox.
+     *
+     * @param {Sandbox} sandbox - The Sandbox to delete
+     * @param {number} timeout - Timeout in seconds (0 means no timeout, default is 60)
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const sandbox = await daytona.get('my-sandbox-id');
+     * await daytona.delete(sandbox);
+     */
+    delete(sandbox: Sandbox, timeout?: number): Promise<void>;
+    /**
+     * Gets the appropriate code toolbox based on language.
+     *
+     * @private
+     * @param {CodeLanguage} [language] - Programming language for the toolbox
+     * @returns {SandboxCodeToolbox} The appropriate code toolbox instance
+     * @throws {DaytonaError} - `DaytonaError` - When an unsupported language is specified
+     */
+    private getCodeToolbox;
+    private createAxiosInstance;
+    getProxyToolboxUrl(): Promise<string>;
+}
+//# sourceMappingURL=Daytona.d.ts.map

package/esm/Daytona.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Daytona.d.ts","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/Daytona.ts"],"names":[],"mappings":"AAKA,OAAO,EAOL,aAAa,EAEd,MAAM,uBAAuB,CAAA;AAM9B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAKxC;;;;;;GAMG;AAEH,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;OACG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,UAAU,eAAe;CAC1B;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,SAAS;IACxB,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,YAAY,GAAG,MAAM,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,4BAA4B,GAAG,uBAAuB,GAAG;IACnE,KAAK,EAAE,MAAM,GAAG,KAAK,CAAA;IACrB,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG,uBAAuB,GAAG;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,eAAe,CAAC,CAAQ;IAChC,SAAgB,MAAM,EAAE,aAAa,CAAA;IACrC,SAAgB,QAAQ,EAAE,eAAe,CAAA;IAEzC;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,aAAa;IAsElC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAC/G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,MAAM,CACjB,MAAM,CAAC,EAAE,4BAA4B,EACrC,OAAO,CAAC,EAAE;QAAE,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7E,OAAO,CAAC,OAAO,CAAC;IA6JnB;;;;;;;;;OASG;IACU,GAAG,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgB3D;;;;;;;;;OASG;IACU,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAa7D;;;;;;;;;;;;;OAaG;IACU,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4B9G;;;;;;;;;;;OAWG;IACU,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM;IAIrD;;;;;;;;;OASG;IACU,IAAI,CAAC,OAAO,EAAE,OAAO;IAIlC;;;;;;;;;;OAUG;IACU,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,SAAK;IAIlD;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,mBAAmB;IA4Cd,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;CAQnD"}