@daytonaio/sdk 0.0.0-dev

package/src/Git.d.ts

@@ -0,0 +1,211 @@
+import { ToolboxApi, ListBranchResponse, GitStatus } from '@daytonaio/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 sandboxId;
+    private readonly toolboxApi;
+    private readonly getRootDir;
+    constructor(sandboxId: string, toolboxApi: ToolboxApi, getRootDir: () => Promise<string>);
+    /**
+     * 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 user's
+     * root 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 user's
+     * root 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 branche in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the user's
+     * root 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 user's
+     * root 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 user's
+     * root 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 user's
+     * root 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 user's
+     * root 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
+     * @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'
+     * );
+     */
+    commit(path: string, message: string, author: string, email: string): 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 user's
+     * root 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 user's
+     * root 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 user's
+     * root 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>;
+}

package/src/Git.js

@@ -0,0 +1,275 @@
+"use strict";
+/*
+ * Copyright 2025 Daytona Platforms Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = void 0;
+const Path_1 = require("./utils/Path");
+/**
+ * Provides Git operations within a Sandbox.
+ *
+ * @class
+ */
+class Git {
+    sandboxId;
+    toolboxApi;
+    getRootDir;
+    constructor(sandboxId, toolboxApi, getRootDir) {
+        this.sandboxId = sandboxId;
+        this.toolboxApi = toolboxApi;
+        this.getRootDir = getRootDir;
+    }
+    /**
+     * 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 user's
+     * root 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.toolboxApi.gitAddFiles(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), path),
+            files,
+        });
+    }
+    /**
+     * List branches in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the user's
+     * root 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.toolboxApi.gitListBranches(this.sandboxId, (0, Path_1.prefixRelativePath)(await this.getRootDir(), path));
+        return response.data;
+    }
+    /**
+     * Create branche in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the user's
+     * root 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.toolboxApi.gitCreateBranch(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), path),
+            name,
+        });
+        return;
+    }
+    /**
+     * Delete branche in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the user's
+     * root 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.toolboxApi.gitDeleteBranch(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), path),
+            name,
+        });
+        return;
+    }
+    /**
+     * Checkout branche in the repository.
+     *
+     * @param {string} path - Path to the Git repository root. Relative paths are resolved based on the user's
+     * root 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.toolboxApi.gitCheckoutBranch(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), 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 user's
+     * root 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.toolboxApi.gitCloneRepository(this.sandboxId, {
+            url: url,
+            branch: branch,
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), 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 user's
+     * root 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
+     * @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'
+     * );
+     */
+    async commit(path, message, author, email) {
+        const response = await this.toolboxApi.gitCommitChanges(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), path),
+            message,
+            author,
+            email,
+        });
+        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 user's
+     * root 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.toolboxApi.gitPushChanges(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), 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 user's
+     * root 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.toolboxApi.gitPullChanges(this.sandboxId, {
+            path: (0, Path_1.prefixRelativePath)(await this.getRootDir(), 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 user's
+     * root 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.toolboxApi.gitGetStatus(this.sandboxId, (0, Path_1.prefixRelativePath)(await this.getRootDir(), path));
+        return response.data;
+    }
+}
+exports.Git = Git;
+//# sourceMappingURL=Git.js.map

package/src/Git.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Git.js","sourceRoot":"","sources":["../../../../libs/sdk-typescript/src/Git.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,uCAAiD;AAYjD;;;;GAIG;AACH,MAAa,GAAG;IAEK;IACA;IACA;IAHnB,YACmB,SAAiB,EACjB,UAAsB,EACtB,UAAiC;QAFjC,cAAS,GAAT,SAAS,CAAQ;QACjB,eAAU,GAAV,UAAU,CAAY;QACtB,eAAU,GAAV,UAAU,CAAuB;IACjD,CAAC;IAEJ;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,GAAG,CAAC,IAAY,EAAE,KAAe;QAC5C,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE;YAChD,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ,CAAC,IAAY;QAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CACpD,IAAI,CAAC,SAAS,EACd,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,CAClD,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAY;QAClD,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE;YACpD,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,IAAI;SACL,CAAC,CAAA;QACF,OAAM;IACR,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAY;QAClD,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE;YACpD,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,IAAI;SACL,CAAC,CAAA;QACF,OAAM;IACR,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,MAAc;QACtD,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,EAAE;YACtD,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,MAAM;SACP,CAAC,CAAA;QACF,OAAM;IACR,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,KAAK,CAAC,KAAK,CAChB,GAAW,EACX,IAAY,EACZ,MAAe,EACf,QAAiB,EACjB,QAAiB,EACjB,QAAiB;QAEjB,MAAM,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE;YACvD,GAAG,EAAE,GAAG;YACR,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,QAAQ;YACR,QAAQ;YACR,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,OAAe,EAAE,MAAc,EAAE,KAAa;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE;YACtE,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,OAAO;YACP,MAAM;YACN,KAAK;SACN,CAAC,CAAA;QACF,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI;SACxB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,QAAiB,EAAE,QAAiB;QAClE,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;YACnD,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,QAAQ;YACR,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,QAAiB,EAAE,QAAiB;QAClE,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;YACnD,IAAI,EAAE,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC;YACvD,QAAQ;YACR,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,MAAM,CAAC,IAAY;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CACjD,IAAI,CAAC,SAAS,EACd,IAAA,yBAAkB,EAAC,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,CAClD,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AAvRD,kBAuRC"}