just-git 1.0.2 → 1.1.0

package/dist/index.d.ts

@@ -1,401 +1,5 @@
-interface FileStat {
-    isFile: boolean;
-    isDirectory: boolean;
-    isSymbolicLink: boolean;
-    mode: number;
-    size: number;
-    mtime: Date;
-}
-interface FileSystem {
-    readFile(path: string): Promise<string>;
-    readFileBuffer(path: string): Promise<Uint8Array>;
-    writeFile(path: string, content: string | Uint8Array): Promise<void>;
-    exists(path: string): Promise<boolean>;
-    stat(path: string): Promise<FileStat>;
-    mkdir(path: string, options?: {
-        recursive?: boolean;
-    }): Promise<void>;
-    readdir(path: string): Promise<string[]>;
-    rm(path: string, options?: {
-        recursive?: boolean;
-        force?: boolean;
-    }): Promise<void>;
-    /** Stat without following symlinks. Falls back to stat() semantics when not implemented. */
-    lstat?(path: string): Promise<FileStat>;
-    /** Read the target of a symbolic link. */
-    readlink?(path: string): Promise<string>;
-    /** Create a symbolic link pointing to target at the given path. */
-    symlink?(target: string, path: string): Promise<void>;
-}
-
-/**
- * Git object storage: compressed loose objects for new writes, with
- * retained packfiles from fetch/clone. Reads check loose first,
- * then fall back to pack indices.
- */
-declare class PackedObjectStore {
-    private fs;
-    private gitDir;
-    private hooks?;
-    private packs;
-    private loadedPackNames;
-    private discoverPromise;
-    constructor(fs: FileSystem, gitDir: string, hooks?: HookEmitter | undefined);
-    write(type: ObjectType, content: Uint8Array): Promise<ObjectId>;
-    read(hash: ObjectId): Promise<RawObject>;
-    exists(hash: ObjectId): Promise<boolean>;
-    ingestPack(packData: Uint8Array): Promise<number>;
-    /** Scan `.git/objects/pack/` for existing pack/idx pairs. */
-    private discover;
-    private doDiscover;
-}
-
-/** 40-character lowercase hex SHA-1 hash. */
-type ObjectId = string;
-/** The four Git object types. */
-type ObjectType = "blob" | "tree" | "commit" | "tag";
-/** An object as stored in .git/objects — type + raw content bytes. */
-interface RawObject {
-    type: ObjectType;
-    content: Uint8Array;
-}
-/** Author or committer identity with timestamp. */
-interface Identity {
-    name: string;
-    email: string;
-    /** Unix epoch seconds. */
-    timestamp: number;
-    /** Timezone offset string, e.g. "+0000", "-0500". */
-    timezone: string;
-}
-/** Stat-like metadata stored per index entry. */
-interface IndexStat {
-    ctimeSeconds: number;
-    ctimeNanoseconds: number;
-    mtimeSeconds: number;
-    mtimeNanoseconds: number;
-    dev: number;
-    ino: number;
-    uid: number;
-    gid: number;
-    size: number;
-}
-interface IndexEntry {
-    /** File path relative to the work tree root. */
-    path: string;
-    /** File mode as a numeric value (e.g. 0o100644). */
-    mode: number;
-    /** SHA-1 of the blob content. */
-    hash: ObjectId;
-    /** Merge stage: 0 = normal, 1 = base, 2 = ours, 3 = theirs. */
-    stage: number;
-    stat: IndexStat;
-}
-interface Index {
-    version: number;
-    entries: IndexEntry[];
-}
-/**
- * Bundles the filesystem handle with resolved repository paths.
- * Threaded through all library functions so they don't need to
- * re-discover the .git directory on every call.
- */
-interface GitContext {
-    fs: FileSystem;
-    /** Absolute path to the .git directory. */
-    gitDir: string;
-    /** Absolute path to the working tree root, or null for bare repos. */
-    workTree: string | null;
-    /** Hook emitter for operation hooks and low-level events. */
-    hooks?: HookEmitter;
-    /** Operator-provided credential resolver (bypasses env vars). */
-    credentialProvider?: CredentialProvider;
-    /** Operator-provided identity override for author/committer. */
-    identityOverride?: IdentityOverride;
-    /** Custom fetch function for HTTP transport. Falls back to globalThis.fetch. */
-    fetchFn?: FetchFunction;
-    /** Network access policy. `false` blocks all HTTP access. */
-    networkPolicy?: NetworkPolicy | false;
-    /** Resolves remote URLs to GitContexts on potentially different VFS instances. */
-    resolveRemote?: RemoteResolver;
-    /** Cached object store instance. Lazily created by object-db. */
-    objectStore?: PackedObjectStore;
-}
-
-type HttpAuth = {
-    type: "basic";
-    username: string;
-    password: string;
-} | {
-    type: "bearer";
-    token: string;
-};
-
-interface ExecResult {
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-}
-
-type CredentialProvider = (url: string) => HttpAuth | null | Promise<HttpAuth | null>;
-interface IdentityOverride {
-    name: string;
-    email: string;
-    locked?: boolean;
-}
-/**
- * Resolves a remote URL to a GitContext, enabling cross-VFS transport.
- * Called before local filesystem lookup for non-HTTP URLs.
- * Return null to fall back to local filesystem resolution.
- */
-type RemoteResolver = (url: string) => GitContext | null | Promise<GitContext | null>;
-type FetchFunction = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
-interface NetworkPolicy {
-    /**
-     * Allowed URL patterns. Can be:
-     * - A hostname: "github.com" (matches any URL whose host equals this)
-     * - A URL prefix: "https://github.com/myorg/" (matches URLs starting with this)
-     */
-    allowed?: string[];
-    /** Custom fetch function for HTTP transport. Falls back to globalThis.fetch. */
-    fetch?: FetchFunction;
-}
-interface PreCommitEvent {
-    readonly index: Index;
-    readonly treeHash: ObjectId;
-}
-interface CommitMsgEvent {
-    message: string;
-}
-interface MergeMsgEvent {
-    message: string;
-    readonly treeHash: ObjectId;
-    readonly headHash: ObjectId;
-    readonly theirsHash: ObjectId;
-}
-interface PostCommitEvent {
-    readonly hash: ObjectId;
-    readonly message: string;
-    readonly branch: string | null;
-    readonly parents: readonly ObjectId[];
-    readonly author: Identity;
-}
-interface PreMergeCommitEvent {
-    readonly mergeMessage: string;
-    readonly treeHash: ObjectId;
-    readonly headHash: ObjectId;
-    readonly theirsHash: ObjectId;
-}
-interface PostMergeEvent {
-    readonly headHash: ObjectId;
-    readonly theirsHash: ObjectId;
-    readonly strategy: "fast-forward" | "three-way";
-    readonly commitHash: ObjectId | null;
-}
-interface PostCheckoutEvent {
-    readonly prevHead: ObjectId | null;
-    readonly newHead: ObjectId;
-    readonly isBranchCheckout: boolean;
-}
-interface PrePushEvent {
-    readonly remote: string;
-    readonly url: string;
-    readonly refs: ReadonlyArray<{
-        srcRef: string | null;
-        srcHash: ObjectId | null;
-        dstRef: string;
-        dstHash: ObjectId | null;
-        force: boolean;
-        delete: boolean;
-    }>;
-}
-type PostPushEvent = PrePushEvent;
-interface PreRebaseEvent {
-    readonly upstream: string;
-    readonly branch: string | null;
-}
-interface PreCheckoutEvent {
-    readonly target: string;
-    readonly mode: "switch" | "detach" | "create-branch" | "paths";
-}
-interface PreFetchEvent {
-    readonly remote: string;
-    readonly url: string;
-    readonly refspecs: readonly string[];
-    readonly prune: boolean;
-    readonly tags: boolean;
-}
-interface PostFetchEvent {
-    readonly remote: string;
-    readonly url: string;
-    readonly refsUpdated: number;
-}
-interface PreCloneEvent {
-    readonly repository: string;
-    readonly targetPath: string;
-    readonly bare: boolean;
-    readonly branch: string | null;
-}
-interface PostCloneEvent {
-    readonly repository: string;
-    readonly targetPath: string;
-    readonly bare: boolean;
-    readonly branch: string | null;
-}
-interface PrePullEvent {
-    readonly remote: string;
-    readonly branch: string | null;
-}
-interface PostPullEvent {
-    readonly remote: string;
-    readonly branch: string | null;
-    readonly strategy: "up-to-date" | "fast-forward" | "three-way";
-    readonly commitHash: ObjectId | null;
-}
-interface PreResetEvent {
-    readonly mode: "soft" | "mixed" | "hard" | "paths";
-    readonly target: string | null;
-}
-interface PostResetEvent {
-    readonly mode: "soft" | "mixed" | "hard" | "paths";
-    readonly targetHash: ObjectId | null;
-}
-interface PreCleanEvent {
-    readonly dryRun: boolean;
-    readonly force: boolean;
-    readonly removeDirs: boolean;
-    readonly removeIgnored: boolean;
-    readonly onlyIgnored: boolean;
-}
-interface PostCleanEvent {
-    readonly removed: readonly string[];
-    readonly dryRun: boolean;
-}
-interface PreRmEvent {
-    readonly paths: readonly string[];
-    readonly cached: boolean;
-    readonly recursive: boolean;
-    readonly force: boolean;
-}
-interface PostRmEvent {
-    readonly removedPaths: readonly string[];
-    readonly cached: boolean;
-}
-interface PreCherryPickEvent {
-    readonly mode: "pick" | "continue" | "abort";
-    readonly commit: string | null;
-}
-interface PostCherryPickEvent {
-    readonly mode: "pick" | "continue" | "abort";
-    readonly commitHash: ObjectId | null;
-    readonly hadConflicts: boolean;
-}
-interface PreRevertEvent {
-    readonly mode: "revert" | "continue" | "abort";
-    readonly commit: string | null;
-}
-interface PostRevertEvent {
-    readonly mode: "revert" | "continue" | "abort";
-    readonly commitHash: ObjectId | null;
-    readonly hadConflicts: boolean;
-}
-interface PreStashEvent {
-    readonly action: "push" | "pop" | "apply" | "list" | "drop" | "show" | "clear";
-    readonly ref: string | null;
-}
-interface PostStashEvent {
-    readonly action: "push" | "pop" | "apply" | "list" | "drop" | "show" | "clear";
-    readonly ok: boolean;
-}
-interface RefUpdateEvent {
-    readonly ref: string;
-    readonly oldHash: ObjectId | null;
-    readonly newHash: ObjectId;
-}
-interface RefDeleteEvent {
-    readonly ref: string;
-    readonly oldHash: ObjectId | null;
-}
-interface ObjectWriteEvent {
-    readonly type: ObjectType;
-    readonly hash: ObjectId;
-}
-interface HookEventMap {
-    "pre-commit": PreCommitEvent;
-    "commit-msg": CommitMsgEvent;
-    "merge-msg": MergeMsgEvent;
-    "post-commit": PostCommitEvent;
-    "pre-merge-commit": PreMergeCommitEvent;
-    "post-merge": PostMergeEvent;
-    "pre-checkout": PreCheckoutEvent;
-    "post-checkout": PostCheckoutEvent;
-    "pre-push": PrePushEvent;
-    "post-push": PostPushEvent;
-    "pre-fetch": PreFetchEvent;
-    "post-fetch": PostFetchEvent;
-    "pre-clone": PreCloneEvent;
-    "post-clone": PostCloneEvent;
-    "pre-pull": PrePullEvent;
-    "post-pull": PostPullEvent;
-    "pre-rebase": PreRebaseEvent;
-    "pre-reset": PreResetEvent;
-    "post-reset": PostResetEvent;
-    "pre-clean": PreCleanEvent;
-    "post-clean": PostCleanEvent;
-    "pre-rm": PreRmEvent;
-    "post-rm": PostRmEvent;
-    "pre-cherry-pick": PreCherryPickEvent;
-    "post-cherry-pick": PostCherryPickEvent;
-    "pre-revert": PreRevertEvent;
-    "post-revert": PostRevertEvent;
-    "pre-stash": PreStashEvent;
-    "post-stash": PostStashEvent;
-    "ref:update": RefUpdateEvent;
-    "ref:delete": RefDeleteEvent;
-    "object:write": ObjectWriteEvent;
-}
-type PreHookName = "pre-commit" | "commit-msg" | "merge-msg" | "pre-merge-commit" | "pre-checkout" | "pre-push" | "pre-fetch" | "pre-clone" | "pre-pull" | "pre-rebase" | "pre-reset" | "pre-clean" | "pre-rm" | "pre-cherry-pick" | "pre-revert" | "pre-stash";
-interface AbortResult {
-    abort: true;
-    message?: string;
-}
-type PreHookHandler<E extends PreHookName> = (event: HookEventMap[E]) => void | AbortResult | Promise<void | AbortResult>;
-type PostHookHandler<E extends keyof HookEventMap> = (event: HookEventMap[E]) => void | Promise<void>;
-type HookHandler<E extends keyof HookEventMap> = E extends PreHookName ? PreHookHandler<E> : PostHookHandler<E>;
-
-interface CommandEvent {
-    /** The git subcommand being invoked (e.g. "commit", "push"). */
-    command: string | undefined;
-    /** Arguments after the subcommand. */
-    rawArgs: string[];
-    /** Virtual filesystem — same instance custom commands receive from just-bash. */
-    fs: FileSystem;
-    /** Current working directory. */
-    cwd: string;
-    /** Environment variables. */
-    env: Map<string, string>;
-    /** Standard input content. */
-    stdin: string;
-    /** Execute a subcommand in the shell. Available when running via just-bash. */
-    exec?: (command: string, options: CommandExecOptions) => Promise<ExecResult>;
-    /** Abort signal for cooperative cancellation. */
-    signal?: AbortSignal;
-}
-type Middleware = (event: CommandEvent, next: () => Promise<ExecResult>) => ExecResult | Promise<ExecResult>;
-declare class HookEmitter {
-    private listeners;
-    onError: (error: unknown) => void;
-    on<E extends keyof HookEventMap>(event: E, handler: HookHandler<E>): () => void;
-    /**
-     * Emit a pre-hook event. Returns an AbortResult if any handler aborts,
-     * or null if all handlers allow the operation to proceed.
-     */
-    emitPre<E extends PreHookName>(event: E, data: HookEventMap[E]): Promise<AbortResult | null>;
-    /** Emit a post-hook event and await all handlers in order. */
-    emitPost<E extends keyof HookEventMap>(event: E, data: HookEventMap[E]): Promise<void>;
-    /** Emit low-level events (synchronous, fire-and-forget). */
-    emit<E extends keyof HookEventMap>(event: E, data: HookEventMap[E]): void;
-}
+import { F as FileSystem, E as ExecResult, G as GitHooks, C as CredentialProvider, I as IdentityOverride, N as NetworkPolicy, R as RemoteResolver, O as ObjectStore, a as RefStore, b as FetchFunction, c as GitContext } from './hooks-jTfqkfs1.js';
+export { A as AfterCommandEvent, B as BeforeCommandEvent, d as CommitMsgEvent, e as FileStat, f as GitRepo, H as HttpAuth, M as MergeMsgEvent, g as ObjectWriteEvent, P as PostCheckoutEvent, h as PostCherryPickEvent, i as PostCleanEvent, j as PostCloneEvent, k as PostCommitEvent, l as PostFetchEvent, m as PostMergeEvent, n as PostPullEvent, o as PostPushEvent, p as PostResetEvent, q as PostRevertEvent, r as PostRmEvent, s as PostStashEvent, t as PreCheckoutEvent, u as PreCherryPickEvent, v as PreCleanEvent, w as PreCloneEvent, x as PreCommitEvent, y as PreFetchEvent, z as PreMergeCommitEvent, D as PrePullEvent, J as PrePushEvent, K as PreRebaseEvent, L as PreResetEvent, Q as PreRevertEvent, S as PreRmEvent, T as PreStashEvent, U as RefDeleteEvent, V as RefEntry, W as RefUpdateEvent, X as Rejection, Y as composeGitHooks, Z as isRejection } from './hooks-jTfqkfs1.js';
 
 /** Options for subcommand execution (mirrors just-bash's CommandExecOptions). */
 interface CommandExecOptions {
@@ -420,6 +24,7 @@ interface CommandContext {
 }
 type GitCommandName = "init" | "clone" | "fetch" | "pull" | "push" | "add" | "blame" | "commit" | "status" | "log" | "branch" | "tag" | "checkout" | "diff" | "reset" | "merge" | "cherry-pick" | "revert" | "rebase" | "mv" | "rm" | "remote" | "config" | "show" | "stash" | "rev-parse" | "ls-files" | "clean" | "switch" | "restore" | "reflog" | "repack" | "gc" | "bisect";
 interface GitOptions {
+    hooks?: GitHooks;
     credentials?: CredentialProvider;
     identity?: IdentityOverride;
     disabled?: GitCommandName[];
@@ -431,30 +36,40 @@ interface GitOptions {
      * Return null to fall back to local filesystem resolution.
      */
     resolveRemote?: RemoteResolver;
+    /**
+     * Override the object store discovered by `findRepo`.
+     * When set, all object reads/writes bypass the VFS `.git/objects/`
+     * and go through this store instead (e.g. SQLite-backed).
+     */
+    objectStore?: ObjectStore;
+    /**
+     * Override the ref store discovered by `findRepo`.
+     * When set, all ref reads/writes bypass the VFS `.git/refs/`
+     * and go through this store instead (e.g. SQLite-backed).
+     */
+    refStore?: RefStore;
 }
 /**
  * Bundle of operator-level extensions threaded into command handlers
  * via closures and merged onto GitContext after discovery.
  */
 interface GitExtensions {
-    hooks?: HookEmitter;
+    hooks?: GitHooks;
     credentialProvider?: CredentialProvider;
     identityOverride?: IdentityOverride;
     fetchFn?: FetchFunction;
     networkPolicy?: NetworkPolicy | false;
     resolveRemote?: RemoteResolver;
+    objectStore?: ObjectStore;
+    refStore?: RefStore;
 }
 declare class Git {
     readonly name = "git";
-    readonly hooks: HookEmitter;
-    private middlewares;
-    private extensions;
+    private blocked;
+    private hooks;
     private inner;
     constructor(options?: GitOptions);
-    on<E extends keyof HookEventMap>(event: E, handler: HookHandler<E>): () => void;
-    use(middleware: Middleware): () => void;
     execute: (args: string[], ctx: CommandContext) => Promise<ExecResult>;
-    private runMiddleware;
 }
 declare function createGit(options?: GitOptions): Git;
 
@@ -464,6 +79,6 @@ declare function createGit(options?: GitOptions): Git;
  * (`HEAD` + `objects/` + `refs/` directly in the directory).
  * Returns a GitContext if found, null otherwise.
  */
-declare function findGitDir(fs: FileSystem, startPath: string): Promise<GitContext | null>;
+declare function findRepo(fs: FileSystem, startPath: string): Promise<GitContext | null>;
 
-export { type AbortResult, type CommandContext, type CommandEvent, type CommandExecOptions, type CommitMsgEvent, type CredentialProvider, type ExecResult, type FetchFunction, type FileStat, type FileSystem, Git, type GitCommandName, type GitContext, type GitExtensions, type GitOptions, type HookEventMap, type HookHandler, type HttpAuth, type IdentityOverride, type MergeMsgEvent, type Middleware, type NetworkPolicy, type ObjectWriteEvent, type PostCheckoutEvent, type PostCherryPickEvent, type PostCleanEvent, type PostCloneEvent, type PostCommitEvent, type PostFetchEvent, type PostMergeEvent, type PostPullEvent, type PostPushEvent, type PostResetEvent, type PostRevertEvent, type PostRmEvent, type PostStashEvent, type PreCheckoutEvent, type PreCherryPickEvent, type PreCleanEvent, type PreCloneEvent, type PreCommitEvent, type PreFetchEvent, type PreMergeCommitEvent, type PrePullEvent, type PrePushEvent, type PreRebaseEvent, type PreResetEvent, type PreRevertEvent, type PreRmEvent, type PreStashEvent, type RefDeleteEvent, type RefUpdateEvent, type RemoteResolver, createGit, findGitDir };
+export { type CommandContext, type CommandExecOptions, CredentialProvider, ExecResult, FetchFunction, FileSystem, Git, type GitCommandName, GitContext, type GitExtensions, GitHooks, type GitOptions, IdentityOverride, NetworkPolicy, ObjectStore, RefStore, RemoteResolver, createGit, findRepo };