@daytonaio/sdk 0.18.0-alpha.1 → 0.18.0-alpha.2

package/dist/Image.d.ts

@@ -1,5 +1,5 @@
-declare const SUPPORTED_PYTHON_SERIES: readonly ["3.9", "3.10", "3.11", "3.12", "3.13"];
-type SupportedPythonSeries = (typeof SUPPORTED_PYTHON_SERIES)[number];
+declare const SUPPORTED_PYTHON_SERIES: readonly ['3.9', '3.10', '3.11', '3.12', '3.13']
+type SupportedPythonSeries = (typeof SUPPORTED_PYTHON_SERIES)[number]
 /**
  * Represents a context file to be added to the image.
  *
@@ -8,8 +8,8 @@ type SupportedPythonSeries = (typeof SUPPORTED_PYTHON_SERIES)[number];
  * @property {string} archivePath - The path inside the archive file in object storage.
  */
 export interface Context {
-    sourcePath: string;
-    archivePath?: string;
+  sourcePath: string
+  archivePath?: string
 }
 /**
  * Options for the pip install command.
@@ -22,11 +22,11 @@ export interface Context {
  * @property {string} extraOptions - The extra options to use for the pip install command. Given string is passed directly to the pip install command.
  */
 export interface PipInstallOptions {
-    findLinks?: string[];
-    indexUrl?: string;
-    extraIndexUrls?: string[];
-    pre?: boolean;
-    extraOptions?: string;
+  findLinks?: string[]
+  indexUrl?: string
+  extraIndexUrls?: string[]
+  pre?: boolean
+  extraOptions?: string
 }
 /**
  * Options for the pip install command from a pyproject.toml file.
@@ -37,7 +37,7 @@ export interface PipInstallOptions {
  * @extends {PipInstallOptions}
  */
 export interface PyprojectOptions extends PipInstallOptions {
-    optionalDependencies?: string[];
+  optionalDependencies?: string[]
 }
 /**
  * Represents an image definition for a Daytona sandbox.
@@ -49,213 +49,213 @@ export interface PyprojectOptions extends PipInstallOptions {
  * @property {Context[]} contextList - The list of context files to be added to the image.
  */
 export declare class Image {
-    private _dockerfile;
-    private _contextList;
-    private constructor();
-    get dockerfile(): string;
-    get contextList(): Context[];
-    /**
-     * Adds commands to install packages using pip.
-     *
-     * @param {string | string[]} packages - The packages to install.
-     * @param {Object} options - The options for the pip install command.
-     * @param {string[]} options.findLinks - The find-links to use for the pip install command.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image.debianSlim('3.12').pipInstall('numpy', { findLinks: ['https://pypi.org/simple'] })
-     */
-    pipInstall(packages: string | string[], options?: PipInstallOptions): Image;
-    /**
-     * Installs dependencies from a requirements.txt file.
-     *
-     * @param {string} requirementsTxt - The path to the requirements.txt file.
-     * @param {PipInstallOptions} options - The options for the pip install command.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image.debianSlim('3.12')
-     * image.pipInstallFromRequirements('requirements.txt', { findLinks: ['https://pypi.org/simple'] })
-     */
-    pipInstallFromRequirements(requirementsTxt: string, options?: PipInstallOptions): Image;
-    /**
-     * Installs dependencies from a pyproject.toml file.
-     *
-     * @param {string} pyprojectToml - The path to the pyproject.toml file.
-     * @param {PyprojectOptions} options - The options for the pip install command.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image.debianSlim('3.12')
-     * image.pipInstallFromPyproject('pyproject.toml', { optionalDependencies: ['dev'] })
-     */
-    pipInstallFromPyproject(pyprojectToml: string, options?: PyprojectOptions): Image;
-    /**
-     * Adds a local file to the image.
-     *
-     * @param {string} localPath - The path to the local file.
-     * @param {string} remotePath - The path of the file in the image.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .addLocalFile('requirements.txt', '/home/daytona/requirements.txt')
-     */
-    addLocalFile(localPath: string, remotePath: string): Image;
-    /**
-     * Adds a local directory to the image.
-     *
-     * @param {string} localPath - The path to the local directory.
-     * @param {string} remotePath - The path of the directory in the image.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .addLocalDir('src', '/home/daytona/src')
-     */
-    addLocalDir(localPath: string, remotePath: string): Image;
-    /**
-     * Runs commands in the image.
-     *
-     * @param {string | string[]} commands - The commands to run.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .runCommands('echo "Hello, world!"')
-     */
-    runCommands(...commands: (string | string[])[]): Image;
-    /**
-     * Sets environment variables in the image.
-     *
-     * @param {Record<string, string>} envVars - The environment variables to set.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .env({ FOO: 'bar' })
-     */
-    env(envVars: Record<string, string>): Image;
-    /**
-     * Sets the working directory in the image.
-     *
-     * @param {string} dirPath - The path to the working directory.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .workdir('/home/daytona')
-     */
-    workdir(dirPath: string): Image;
-    /**
-     * Sets the entrypoint for the image.
-     *
-     * @param {string[]} entrypointCommands - The commands to set as the entrypoint.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .entrypoint(['/bin/bash'])
-     */
-    entrypoint(entrypointCommands: string[]): Image;
-    /**
-     * Sets the default command for the image.
-     *
-     * @param {string[]} cmd - The command to set as the default command.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .cmd(['/bin/bash'])
-     */
-    cmd(cmd: string[]): Image;
-    /**
-     * Extends an image with arbitrary Dockerfile-like commands.
-     *
-     * @param {string | string[]} dockerfileCommands - The commands to add to the Dockerfile.
-     * @param {string} contextDir - The path to the context directory.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image
-     *  .debianSlim('3.12')
-     *  .dockerfileCommands(['RUN echo "Hello, world!"'])
-     */
-    dockerfileCommands(dockerfileCommands: (string | string[])[], contextDir?: string): Image;
-    /**
-     * Creates an Image from an existing Dockerfile.
-     *
-     * @param {string} path - The path to the Dockerfile.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image.fromDockerfile('Dockerfile')
-     */
-    static fromDockerfile(path: string): Image;
-    /**
-     * Creates an Image from an existing base image.
-     *
-     * @param {string} image - The base image to use.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image.base('python:3.12-slim-bookworm')
-     */
-    static base(image: string): Image;
-    /**
-     * Creates a Debian slim image based on the official Python Docker image.
-     *
-     * @param {string} pythonVersion - The Python version to use.
-     * @returns {Image} The Image instance.
-     *
-     * @example
-     * const image = Image.debianSlim('3.12')
-     */
-    static debianSlim(pythonVersion?: SupportedPythonSeries): Image;
-    /**
-     * Formats pip install arguments in a single string.
-     *
-     * @param {PipInstallOptions} options - The options for the pip install command.
-     * @returns {string} The formatted pip install arguments.
-     */
-    private formatPipInstallArgs;
-    /**
-     * Flattens a string argument.
-     *
-     * @param {string} functionName - The name of the function.
-     * @param {string} argName - The name of the argument.
-     * @param {any} args - The argument to flatten.
-     * @returns {string[]} The flattened argument.
-     */
-    private flattenStringArgs;
-    /**
-     * Processes the Python version.
-     *
-     * @param {string} pythonVersion - The Python version to use.
-     * @returns {string} The processed Python version.
-     */
-    private static processPythonVersion;
-    /**
-     * Extracts source files from COPY commands in a Dockerfile.
-     *
-     * @param {string} dockerfileContent - The content of the Dockerfile.
-     * @param {string} pathPrefix - The path prefix to use for the sources.
-     * @returns {Array<[string, string]>} The list of the actual file path and its corresponding COPY-command source path.
-     */
-    private static extractCopySources;
-    /**
-     * Parses a COPY command to extract sources and destination.
-     *
-     * @param {string} line - The line to parse.
-     * @returns {Object} The parsed sources and destination.
-     */
-    private static parseCopyCommand;
+  private _dockerfile
+  private _contextList
+  private constructor()
+  get dockerfile(): string
+  get contextList(): Context[]
+  /**
+   * Adds commands to install packages using pip.
+   *
+   * @param {string | string[]} packages - The packages to install.
+   * @param {Object} options - The options for the pip install command.
+   * @param {string[]} options.findLinks - The find-links to use for the pip install command.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image.debianSlim('3.12').pipInstall('numpy', { findLinks: ['https://pypi.org/simple'] })
+   */
+  pipInstall(packages: string | string[], options?: PipInstallOptions): Image
+  /**
+   * Installs dependencies from a requirements.txt file.
+   *
+   * @param {string} requirementsTxt - The path to the requirements.txt file.
+   * @param {PipInstallOptions} options - The options for the pip install command.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image.debianSlim('3.12')
+   * image.pipInstallFromRequirements('requirements.txt', { findLinks: ['https://pypi.org/simple'] })
+   */
+  pipInstallFromRequirements(requirementsTxt: string, options?: PipInstallOptions): Image
+  /**
+   * Installs dependencies from a pyproject.toml file.
+   *
+   * @param {string} pyprojectToml - The path to the pyproject.toml file.
+   * @param {PyprojectOptions} options - The options for the pip install command.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image.debianSlim('3.12')
+   * image.pipInstallFromPyproject('pyproject.toml', { optionalDependencies: ['dev'] })
+   */
+  pipInstallFromPyproject(pyprojectToml: string, options?: PyprojectOptions): Image
+  /**
+   * Adds a local file to the image.
+   *
+   * @param {string} localPath - The path to the local file.
+   * @param {string} remotePath - The path of the file in the image.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .addLocalFile('requirements.txt', '/home/daytona/requirements.txt')
+   */
+  addLocalFile(localPath: string, remotePath: string): Image
+  /**
+   * Adds a local directory to the image.
+   *
+   * @param {string} localPath - The path to the local directory.
+   * @param {string} remotePath - The path of the directory in the image.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .addLocalDir('src', '/home/daytona/src')
+   */
+  addLocalDir(localPath: string, remotePath: string): Image
+  /**
+   * Runs commands in the image.
+   *
+   * @param {string | string[]} commands - The commands to run.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .runCommands('echo "Hello, world!"')
+   */
+  runCommands(...commands: (string | string[])[]): Image
+  /**
+   * Sets environment variables in the image.
+   *
+   * @param {Record<string, string>} envVars - The environment variables to set.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .env({ FOO: 'bar' })
+   */
+  env(envVars: Record<string, string>): Image
+  /**
+   * Sets the working directory in the image.
+   *
+   * @param {string} dirPath - The path to the working directory.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .workdir('/home/daytona')
+   */
+  workdir(dirPath: string): Image
+  /**
+   * Sets the entrypoint for the image.
+   *
+   * @param {string[]} entrypointCommands - The commands to set as the entrypoint.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .entrypoint(['/bin/bash'])
+   */
+  entrypoint(entrypointCommands: string[]): Image
+  /**
+   * Sets the default command for the image.
+   *
+   * @param {string[]} cmd - The command to set as the default command.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .cmd(['/bin/bash'])
+   */
+  cmd(cmd: string[]): Image
+  /**
+   * Extends an image with arbitrary Dockerfile-like commands.
+   *
+   * @param {string | string[]} dockerfileCommands - The commands to add to the Dockerfile.
+   * @param {string} contextDir - The path to the context directory.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image
+   *  .debianSlim('3.12')
+   *  .dockerfileCommands(['RUN echo "Hello, world!"'])
+   */
+  dockerfileCommands(dockerfileCommands: (string | string[])[], contextDir?: string): Image
+  /**
+   * Creates an Image from an existing Dockerfile.
+   *
+   * @param {string} path - The path to the Dockerfile.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image.fromDockerfile('Dockerfile')
+   */
+  static fromDockerfile(path: string): Image
+  /**
+   * Creates an Image from an existing base image.
+   *
+   * @param {string} image - The base image to use.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image.base('python:3.12-slim-bookworm')
+   */
+  static base(image: string): Image
+  /**
+   * Creates a Debian slim image based on the official Python Docker image.
+   *
+   * @param {string} pythonVersion - The Python version to use.
+   * @returns {Image} The Image instance.
+   *
+   * @example
+   * const image = Image.debianSlim('3.12')
+   */
+  static debianSlim(pythonVersion?: SupportedPythonSeries): Image
+  /**
+   * Formats pip install arguments in a single string.
+   *
+   * @param {PipInstallOptions} options - The options for the pip install command.
+   * @returns {string} The formatted pip install arguments.
+   */
+  private formatPipInstallArgs
+  /**
+   * Flattens a string argument.
+   *
+   * @param {string} functionName - The name of the function.
+   * @param {string} argName - The name of the argument.
+   * @param {any} args - The argument to flatten.
+   * @returns {string[]} The flattened argument.
+   */
+  private flattenStringArgs
+  /**
+   * Processes the Python version.
+   *
+   * @param {string} pythonVersion - The Python version to use.
+   * @returns {string} The processed Python version.
+   */
+  private static processPythonVersion
+  /**
+   * Extracts source files from COPY commands in a Dockerfile.
+   *
+   * @param {string} dockerfileContent - The content of the Dockerfile.
+   * @param {string} pathPrefix - The path prefix to use for the sources.
+   * @returns {Array<[string, string]>} The list of the actual file path and its corresponding COPY-command source path.
+   */
+  private static extractCopySources
+  /**
+   * Parses a COPY command to extract sources and destination.
+   *
+   * @param {string} line - The line to parse.
+   * @returns {Object} The parsed sources and destination.
+   */
+  private static parseCopyCommand
 }
-export {};
+export {}

package/dist/ObjectStorage.d.ts

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

package/dist/Process.d.ts

@@ -243,4 +243,5 @@ export declare class Process {
      * await process.deleteSession('my-session');
      */
     deleteSession(sessionId: string): Promise<void>;
+    private streamWithStatusPoll;
 }