just-git 1.5.9 → 1.5.11

package/dist/repo/index.d.ts

@@ -1,5 +1,6 @@
 import { g as GitRepo, Z as RefEntry, e as Commit, a3 as TreeEntry, i as ObjectId, h as Identity, a4 as TreeDiffEntry, d as GitContext, F as FileSystem } from '../hooks-CimfP56a.js';
-export { B as BuildCommitOptions, C as CommitAuthor, a as CommitIdentity, b as CommitOptions, c as CommitResult, d as CreateAnnotatedTagOptions, e as CreateCommitOptions, T as TreeEntryInput, f as TreeUpdate, g as buildCommit, h as commit, i as createAnnotatedTag, j as createCommit, u as updateTree, w as writeBlob, k as writeTree } from '../writing-IwfRRrts.js';
+import { C as CommitIdentity } from '../writing-CEP3N60d.js';
+export { B as BuildCommitOptions, a as CommitAuthor, b as CommitOptions, c as CommitResult, d as CreateAnnotatedTagOptions, e as CreateCommitOptions, T as TreeEntryInput, f as TreeUpdate, g as buildCommit, h as commit, i as createAnnotatedTag, j as createCommit, u as updateTree, w as writeBlob, k as writeTree } from '../writing-CEP3N60d.js';
 
 /** Extract the short branch name from a full ref path like "refs/heads/main" → "main". */
 declare function branchNameFromRef(ref: string): string;
@@ -17,6 +18,19 @@ interface GrepMatch {
 
 /** Resolve a ref name (e.g. "HEAD", "refs/heads/main") to a commit hash. Returns null if not found. */
 declare function resolveRef(repo: GitRepo, name: string): Promise<string | null>;
+/**
+ * Resolve a revision expression to an object hash.
+ *
+ * Supports branch names, tag names, `HEAD`, short hashes, special refs
+ * (`ORIG_HEAD`, `MERGE_HEAD`, etc.), remote tracking refs (`origin/main`),
+ * `~N`/`^N` suffixes, `^{commit}`/`^{tree}` peel syntax, and arbitrary
+ * chaining (`main~2^2`, `v1.0^{commit}~3`).
+ *
+ * Returns null if the revision cannot be resolved. Reflog syntax
+ * (`@{N}`) is not supported — reflog entries require filesystem access
+ * and are not available through `GitRepo`.
+ */
+declare function revParse(repo: GitRepo, rev: string): Promise<string | null>;
 /** List all local branches (`refs/heads/*`). */
 declare function listBranches(repo: GitRepo): Promise<RefEntry[]>;
 /** List all tags (`refs/tags/*`). */
@@ -580,6 +594,135 @@ type BisectSearchResult = {
  * ```
  */
 declare function bisect(repo: GitRepo, options: BisectOptions): Promise<BisectSearchResult>;
+/** Options for {@link cherryPick}. */
+interface CherryPickOptions {
+    /** The commit to cherry-pick (hash, branch, tag, or any rev-parse expression). */
+    commit: string;
+    /** The commit to apply on top of (hash, branch, tag, or any rev-parse expression). */
+    onto: string;
+    /** Branch to advance on clean result. No ref update when omitted. Ignored when `noCommit` is true. */
+    branch?: string;
+    /** Committer identity. Defaults to the original commit's author when omitted, so both author and committer will reflect the original — pass explicitly to record who performed the cherry-pick. */
+    committer?: CommitIdentity;
+    /** Parent number for merge commits (1-based). Required when cherry-picking a merge. */
+    mainline?: number;
+    /** Append "(cherry picked from commit ...)" trailer to the message. */
+    recordOrigin?: boolean;
+    /** Override the commit message. Defaults to the original commit's message. */
+    message?: string;
+    /** When true, perform the merge but don't create a commit. `hash` will be `null` in the result. */
+    noCommit?: boolean;
+    /** Custom merge driver for content conflicts. */
+    mergeDriver?: MergeDriver;
+}
+/** Clean result when a commit was created. */
+interface CleanPickCommitted {
+    clean: true;
+    hash: string;
+    treeHash: string;
+}
+/** Clean result when `noCommit` was set — no commit created. */
+interface CleanPickNoCommit {
+    clean: true;
+    treeHash: string;
+}
+/** Conflict result — no commit was created. */
+interface PickConflict {
+    clean: false;
+    treeHash: string;
+    conflicts: MergeConflict[];
+    messages: string[];
+}
+/**
+ * Result of {@link cherryPick} or {@link revert}.
+ *
+ * - `clean: true` with `hash` — commit was created.
+ * - `clean: true` without `hash` — `noCommit` was set, merge succeeded
+ *   but no commit was created.
+ * - `clean: false` — conflicts were found, no commit was created.
+ */
+type CherryPickResult = CleanPickCommitted | PickConflict;
+/** Result of {@link cherryPick} or {@link revert} when `noCommit` is true. */
+type NoCommitPickResult = CleanPickNoCommit | PickConflict;
+/**
+ * Cherry-pick a commit onto another commit.
+ *
+ * Applies the changes introduced by `commit` on top of `onto` using a
+ * three-way merge (base = parent of `commit`, ours = `onto`, theirs = `commit`).
+ * Operates purely on the object store — no filesystem, index, or working tree.
+ *
+ * On a clean result, creates a new commit preserving the original author.
+ * When `branch` is provided, the branch ref is advanced to the new commit.
+ *
+ * ```ts
+ * const result = await cherryPick(repo, {
+ *   commit: "feature~2",
+ *   onto: "main",
+ *   branch: "main",
+ *   committer: { name: "Bot", email: "bot@example.com" },
+ * });
+ * if (result.clean) {
+ *   console.log(`Cherry-picked as ${result.hash}`);
+ * } else {
+ *   console.log(`Conflicts: ${result.conflicts.length}`);
+ * }
+ * ```
+ */
+declare function cherryPick(repo: GitRepo, options: CherryPickOptions & {
+    noCommit: true;
+}): Promise<NoCommitPickResult>;
+declare function cherryPick(repo: GitRepo, options: CherryPickOptions): Promise<CherryPickResult>;
+/** Options for {@link revert}. */
+interface RevertOptions {
+    /** The commit to revert (hash, branch, tag, or any rev-parse expression). */
+    commit: string;
+    /** The commit to apply the revert on top of (hash, branch, tag, or any rev-parse expression). */
+    onto: string;
+    /** Branch to advance on clean result. No ref update when omitted. Ignored when `noCommit` is true. */
+    branch?: string;
+    /** Committer identity. Defaults to the caller's identity. When omitted, uses `author` as both author and committer. */
+    committer?: CommitIdentity;
+    /** Author identity for the revert commit. When omitted, uses `committer`. At least one of `author` or `committer` must be provided (unless `noCommit` is true). */
+    author?: CommitIdentity;
+    /** Parent number for merge commits (1-based). Required when reverting a merge. */
+    mainline?: number;
+    /** Override the commit message. Defaults to the auto-generated "Revert ..." message. */
+    message?: string;
+    /** When true, perform the merge but don't create a commit. `hash` will be `null` in the result. */
+    noCommit?: boolean;
+    /** Custom merge driver for content conflicts. */
+    mergeDriver?: MergeDriver;
+}
+/** Result of {@link revert}. Same shape as {@link CherryPickResult}. */
+type RevertResult = CherryPickResult;
+/** Result of {@link revert} when `noCommit` is true. */
+type NoCommitRevertResult = NoCommitPickResult;
+/**
+ * Revert a commit on top of another commit.
+ *
+ * Applies the inverse of the changes introduced by `commit` on top of
+ * `onto` using a three-way merge (base = `commit`, ours = `onto`,
+ * theirs = parent of `commit`). Operates purely on the object store.
+ *
+ * On a clean result, creates a new commit with a "Revert ..." message.
+ * When `branch` is provided, the branch ref is advanced.
+ *
+ * ```ts
+ * const result = await revert(repo, {
+ *   commit: "abc1234",
+ *   onto: "main",
+ *   branch: "main",
+ *   committer: { name: "Bot", email: "bot@example.com" },
+ * });
+ * if (result.clean) {
+ *   console.log(`Reverted as ${result.hash}`);
+ * }
+ * ```
+ */
+declare function revert(repo: GitRepo, options: RevertOptions & {
+    noCommit: true;
+}): Promise<NoCommitRevertResult>;
+declare function revert(repo: GitRepo, options: RevertOptions): Promise<RevertResult>;
 
 /**
  * Wrap a `GitRepo` so all write operations throw.
@@ -615,4 +758,4 @@ declare function readonlyRepo(repo: GitRepo): GitRepo;
  */
 declare function overlayRepo(repo: GitRepo): GitRepo;
 
-export { type BisectOptions, type BisectSearchResult, type BisectStepInfo, type BlameEntry, Commit, type CommitInfo, type CreateWorktreeOptions, type DiffHunk, type DiffOptions, type ExtractTreeResult, type FileDiff, type FlatTreeEntry, GitRepo, type GrepFileMatch, type GrepMatch, type GrepOptions, type HeadInfo, Identity, type MaterializeTarget, type MergeConflict, type MergeDriver, type MergeDriverResult, type MergeTreesResult, RefEntry, type TreeAccessor, TreeDiffEntry, TreeEntry, type WorktreeResult, bisect, blame, branchNameFromRef, countAheadBehind, createSandboxWorktree, createTreeAccessor, createWorktree, diffCommits, diffTrees, extractTree, findMergeBases, flattenTree, formatDiff, getChangedFiles, getNewCommits, grep, isAncestor, listBranches, listTags, mergeTrees, mergeTreesFromTreeHashes, overlayRepo, readBlob, readBlobText, readCommit, readFileAtCommit, readHead, readTree, readonlyRepo, resolveRef, tagNameFromRef, walkCommitHistory };
+export { type BisectOptions, type BisectSearchResult, type BisectStepInfo, type BlameEntry, type CherryPickOptions, type CherryPickResult, type CleanPickCommitted, type CleanPickNoCommit, Commit, CommitIdentity, type CommitInfo, type CreateWorktreeOptions, type DiffHunk, type DiffOptions, type ExtractTreeResult, type FileDiff, type FlatTreeEntry, GitRepo, type GrepFileMatch, type GrepMatch, type GrepOptions, type HeadInfo, Identity, type MaterializeTarget, type MergeConflict, type MergeDriver, type MergeDriverResult, type MergeTreesResult, type NoCommitPickResult, type NoCommitRevertResult, type PickConflict, RefEntry, type RevertOptions, type RevertResult, type TreeAccessor, TreeDiffEntry, TreeEntry, type WorktreeResult, bisect, blame, branchNameFromRef, cherryPick, countAheadBehind, createSandboxWorktree, createTreeAccessor, createWorktree, diffCommits, diffTrees, extractTree, findMergeBases, flattenTree, formatDiff, getChangedFiles, getNewCommits, grep, isAncestor, listBranches, listTags, mergeTrees, mergeTreesFromTreeHashes, overlayRepo, readBlob, readBlobText, readCommit, readFileAtCommit, readHead, readTree, readonlyRepo, resolveRef, revParse, revert, tagNameFromRef, walkCommitHistory };