@daytonaio/sdk 0.127.0 → 0.128.0-alpha.1

package/esm/Git.d.ts

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

package/esm/Git.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.d.ts","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/Git.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAErF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;;GAIG;AACH,qBAAa,GAAG;IACF,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,MAAM;IAE9C;;;;;;;;;;;;;;;OAeG;IACU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;OASG;IACU,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAKhE;;;;;;;;;OASG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpE;;;;;;;;;OASG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpE;;;;;;;;;OASG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,KAAK,CAChB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAWhB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,MAAM,CACjB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,OAAO,GACnB,OAAO,CAAC,iBAAiB,CAAC;IAa7B;;;;;;;;;;;;;;;;;;;OAmBG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpF;;;;;;;;;;;;;;;;;;;OAmBG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpF;;;;;;;;;;;;;;;;OAgBG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAItD"}

package/esm/Git.js

@@ -0,0 +1,260 @@
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Provides Git operations within a Sandbox.
+ *
+ * @class
+ */
+export class Git {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /**
+     * 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', ['.']);
+     */
+    async add(path, files) {
+        await this.apiClient.addFiles({
+            path,
+            files,
+        });
+    }
+    /**
+     * 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}`);
+     */
+    async branches(path) {
+        const response = await this.apiClient.listBranches(path);
+        return response.data;
+    }
+    /**
+     * 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');
+     */
+    async createBranch(path, name) {
+        await this.apiClient.createBranch({
+            path,
+            name,
+        });
+        return;
+    }
+    /**
+     * 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');
+     */
+    async deleteBranch(path, name) {
+        await this.apiClient.deleteBranch({
+            path,
+            name,
+        });
+        return;
+    }
+    /**
+     * 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');
+     */
+    async checkoutBranch(path, branch) {
+        await this.apiClient.checkoutBranch({
+            path,
+            branch,
+        });
+        return;
+    }
+    /**
+     * 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'
+     * );
+     */
+    async clone(url, path, branch, commitId, username, password) {
+        await this.apiClient.cloneRepository({
+            url: url,
+            branch: branch,
+            path,
+            username,
+            password,
+            commit_id: commitId,
+        });
+    }
+    /**
+     * 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
+     * );
+     *
+     */
+    async commit(path, message, author, email, allowEmpty) {
+        const response = await this.apiClient.commitChanges({
+            path,
+            message,
+            author,
+            email,
+            allow_empty: allowEmpty,
+        });
+        return {
+            sha: response.data.hash,
+        };
+    }
+    /**
+     * 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'
+     * );
+     */
+    async push(path, username, password) {
+        await this.apiClient.pushChanges({
+            path,
+            username,
+            password,
+        });
+    }
+    /**
+     * 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'
+     * );
+     */
+    async pull(path, username, password) {
+        await this.apiClient.pullChanges({
+            path,
+            username,
+            password,
+        });
+    }
+    /**
+     * 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}`);
+     */
+    async status(path) {
+        const response = await this.apiClient.getStatus(path);
+        return response.data;
+    }
+}
+//# sourceMappingURL=Git.js.map

package/esm/Git.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.js","sourceRoot":"","sources":["../../../../../libs/sdk-typescript/src/Git.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAcH;;;;GAIG;AACH,MAAM,OAAO,GAAG;IACe;IAA7B,YAA6B,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IAElD;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,GAAG,CAAC,IAAY,EAAE,KAAe;QAC5C,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC5B,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,QAAQ,CAAC,IAAY;QAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QACxD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAY;QAClD,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAChC,IAAI;YACJ,IAAI;SACL,CAAC,CAAA;QACF,OAAM;IACR,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAY;QAClD,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAChC,IAAI;YACJ,IAAI;SACL,CAAC,CAAA;QACF,OAAM;IACR,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,MAAc;QACtD,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;YAClC,IAAI;YACJ,MAAM;SACP,CAAC,CAAA;QACF,OAAM;IACR,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACI,KAAK,CAAC,KAAK,CAChB,GAAW,EACX,IAAY,EACZ,MAAe,EACf,QAAiB,EACjB,QAAiB,EACjB,QAAiB;QAEjB,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;YACnC,GAAG,EAAE,GAAG;YACR,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,QAAQ;YACR,QAAQ;YACR,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,MAAM,CACjB,IAAY,EACZ,OAAe,EACf,MAAc,EACd,KAAa,EACb,UAAoB;QAEpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;YAClD,IAAI;YACJ,OAAO;YACP,MAAM;YACN,KAAK;YACL,WAAW,EAAE,UAAU;SACxB,CAAC,CAAA;QACF,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI;SACxB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,QAAiB,EAAE,QAAiB;QAClE,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;YAC/B,IAAI;YACJ,QAAQ;YACR,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,QAAiB,EAAE,QAAiB;QAClE,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;YAC/B,IAAI;YACJ,QAAQ;YACR,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,MAAM,CAAC,IAAY;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACrD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF"}