feat: impl Repository class and remote methods (#11)

* impl repository

* fix test

* fix

* test

* impl more

* biome

* windows busy error

* docs

Author: seokju-na

.gitattributes

@@ -1,4 +1,3 @@
 /.yarn/**            linguist-vendored
 /.yarn/releases/*    binary
-/index.js            linguist-generated=true text=auto eol=lf
-/index.d.ts          linguist-generated=true text=auto eol=lf
+/index.js           linguist-generated=true text=auto eol=lf

.gitignore

@@ -201,3 +201,6 @@ Cargo.lock
 
 # npm folders
 npm
+
+# Generated
+es-git.d.ts

Cargo.toml

@@ -7,8 +7,8 @@ version = "0.0.0"
 crate-type = ["cdylib"]
 
 [dependencies]
+git2 = { version = "0.19.0", features = ["vendored-libgit2", "vendored-openssl"] }
 # Default enable napi4 feature, see https://nodejs.org/api/n-api.html#node-api-version-matrix
-git2        = { version = "0.19.0", features = ["vendored-libgit2", "vendored-openssl"] }
 napi        = { version = "2.16.13", default-features = false, features = ["napi4"] }
 napi-derive = "2.16.12"
 serde       = { version = "1", features = ["derive"] }

biome.json

@@ -9,7 +9,7 @@
     "useIgnoreFile": true
   },
   "files": {
-    "ignore": ["./.yarn/**", "*.json", "./index.js", "./index.d.ts"]
+    "ignore": ["./.yarn/**", "*.json", "./index.js", "./es-git.d.ts", "./index.d.ts"]
   },
   "formatter": {
     "enabled": true,

index.d.ts

@@ -1,48 +1,232 @@
 /* tslint:disable */
 /* eslint-disable */
 
-/* auto-generated by NAPI-RS */
+import { RepositoryState } from './es-git';
 
-export interface Branch {
-  name: string
-  oid: string
-}
-export interface CreateBranchOptions {
-  branchName: string
-  targetSha: string
-  force?: boolean
-}
-export interface GetBranchOptions {
-  branchName: string
-}
-export interface DeleteBranchOptions {
-  branchName: string
-}
-export declare function createBranch(options: CreateBranchOptions, context: GitContext): Branch
-export declare function getBranch(options: GetBranchOptions, context: GitContext): Branch
-export declare function deleteBranch(options: DeleteBranchOptions, context: GitContext): void
-export interface GitContext {
-  dir: string
-}
-export declare function removeRef(gitRef: string, context: GitContext): void
-export declare function getRemoteUrl(name: string, context: GitContext): string | null
-export declare function getSha(gitRef: string, context: GitContext): string
-export declare function getHeadSha(context: GitContext): string
-export declare function getGitRootPath(context: GitContext): string
-export declare function hasMergeConflicts(ref1: string, ref2: string, context: GitContext): boolean
-export interface Conflict {
-  ancestor?: string
-  our?: string
-  their?: string
-}
-export declare function getConflictingFiles(ref1: string, ref2: string, context: GitContext): Array<Conflict>
-export interface CreateTagOptions {
-  name: string
-  message: string
-  sha: string
-}
-export interface CreateTagResult {
-  oid: string
-}
-export declare function createTag(options: CreateTagOptions, context: GitContext): CreateTagResult
-export declare function deleteTag(name: string, context: GitContext): void
+/**
+ * TODO:
+ * napi does not support union types when converting rust enum types to TypeScript.
+ * This feature will be provided starting from v3, so create a custom TypeScript until the v3 stable releases.
+ */
+
+export interface RemoteObject {
+  name: string;
+  url: string;
+  pushUrl?: string;
+  refspecs: Array<RefspecObject>;
+}
+export const enum Direction {
+  Fetch = 'Fetch',
+  Push = 'Push'
+}
+export interface RefspecObject {
+  direction: Direction;
+  src: string;
+  dst: string;
+  force: boolean;
+}
+export type Credential =
+  /** Create a "default" credential usable for Negotiate mechanisms like NTLM or Kerberos authentication. */
+  | { type: 'Default' }
+  /**
+   * Create a new ssh key credential object used for querying an ssh-agent.
+   * The username specified is the username to authenticate.
+   */
+  | { type: 'SSHKeyFromAgent'; username?: string }
+  /** Create a new passphrase-protected ssh key credential object. */
+  | { type: 'SSHKeyFromPath'; username?: string; publicKeyPath?: string; privateKeyPath: string; passphrase?: string }
+  /** Create a new ssh key credential object reading the keys from memory. */
+  | { type: 'SSHKey'; username?: string; publicKey?: string; privateKey: string; passphrase?: string }
+  /** Create a new plain-text username and password credential object. */
+  | { type: 'Plain'; username?: string; password: string };
+/** Options which can be specified to various fetch operations. */
+export interface ProxyOptions {
+  /**
+   * Try to auto-detect the proxy from the git configuration.
+   *
+   * Note that this will override `url` specified before.
+   */
+  auto?: boolean
+  /**
+   * Specify the exact URL of the proxy to use.
+   *
+   * Note that this will override `auto` specified before.
+   */
+  url?: string
+}
+export type FetchPrune =
+  /** Use the setting from the configuration */
+  | 'Unspecified'
+  /** Force pruning on */
+  | 'On'
+  /** Force pruning off */
+  | 'Off';
+/** Automatic tag following options. */
+export type AutotagOption =
+  /** Use the setting from the remote's configuration */
+  | 'Unspecified'
+  /** Ask the server for tags pointing to objects we're already downloading */
+  | 'Auto'
+  /** Don't ask for any tags beyond the refspecs */
+  | 'None'
+  /** Ask for all the tags */
+  | 'All';
+/**
+ * Remote redirection settings; whether redirects to another host are
+ * permitted.
+ *
+ * By default, git will follow a redirect on the initial request
+ * (`/info/refs`), but not subsequent requests.
+ */
+export type RemoteRedirect =
+  /** Do not follow any off-site redirects at any stage of the fetch or push. */
+  | 'None'
+  /**
+   * Allow off-site redirects only upon the initial request. This is the
+   * default.
+   */
+  | 'Initial'
+  /** Allow redirects at any stage in the fetch or push. */
+  | 'All';
+/** Options which can be specified to various fetch operations. */
+export interface FetchOptions {
+  credential?: Credential;
+  /** Set the proxy options to use for the fetch operation. */
+  proxy?: ProxyOptions;
+  /** Set whether to perform a prune after the fetch. */
+  prune?: FetchPrune;
+  /**
+   * Set fetch depth, a value less or equal to 0 is interpreted as pull
+   * everything (effectively the same as not declaring a limit depth).
+   */
+  depth?: number;
+  /**
+   * Set how to behave regarding tags on the remote, such as auto-downloading
+   * tags for objects we're downloading or downloading all of them.
+   *
+   * The default is to auto-follow tags.
+   */
+  downloadTags?: AutotagOption;
+  /**
+   * Set remote redirection settings; whether redirects to another host are
+   * permitted.
+   *
+   * By default, git will follow a redirect on the initial request
+   * (`/info/refs`), but not subsequent requests.
+   */
+  followRedirects?: RemoteRedirect;
+  /** Set extra headers for this fetch operation. */
+  customHeaders?: Array<string>;
+}
+/** Options to control the behavior of a git push. */
+export interface PushOptions {
+  credential?: Credential;
+  /** Set the proxy options to use for the push operation. */
+  proxy?: ProxyOptions;
+  /**
+   * If the transport being used to push to the remote requires the creation
+   * of a pack file, this controls the number of worker threads used by the
+   * packbuilder when creating that pack file to be sent to the remote.
+   *
+   * if set to 0 the packbuilder will auto-detect the number of threads to
+   * create, and the default value is 1.
+   */
+  pbParallelism?: number;
+  /**
+   * Set remote redirection settings; whether redirects to another host are
+   * permitted.
+   *
+   * By default, git will follow a redirect on the initial request
+   * (`/info/refs`), but not subsequent requests.
+   */
+  followRedirects?: RemoteRedirect;
+  /** Set extra headers for this push operation. */
+  customHeaders?: Array<string>;
+  /** Set "push options" to deliver to the remote. */
+  remoteOptions?: Array<string>;
+}
+export interface CreateRemoteOptions {
+  fetchRefspec?: string;
+}
+export interface FetchRemoteOptions {
+  fetch?: FetchOptions;
+  reflogMsg?: string;
+}
+export interface PruneOptions {
+  credential?: Credential;
+}
+export type RepositoryState =
+  | 'Clean'
+  | 'Merge'
+  | 'Revert'
+  | 'RevertSequence'
+  | 'CherryPick'
+  | 'CherryPickSequence'
+  | 'Bisect'
+  | 'Rebase'
+  | 'RebaseInteractive'
+  | 'RebaseMerge'
+  | 'ApplyMailbox'
+  | 'ApplyMailboxOrRebase';
+export interface RepositoryInitOptions {
+  bare?: boolean;
+  initialHead?: string;
+  originUrl?: string;
+}
+export interface RepositoryOpenOptions {
+  flags: RepositoryOpenFlags;
+  ceilingDirs?: Array<string>;
+}
+export type RepositoryOpenFlags =
+/** Only open the specified path; don't walk upward searching. */
+  | 'NoSearch'
+  /** Search across filesystem boundaries. */
+  | 'CrossFS'
+  /** Force opening as bare repository, and defer loading its config. */
+  | 'Bare'
+  /** Don't try appending `/.git` to the specified repository path. */
+  | 'NoDotGit'
+  /** Respect environment variables like `$GIT_DIR`. */
+  | 'FromEnv';
+export interface RepositoryCloneOptions {
+  recursive?: boolean;
+  fetch?: FetchOptions;
+}
+
+export declare function initRepository(path: string, options?: RepositoryInitOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<Repository>
+export declare function openRepository(path: string, options?: RepositoryOpenOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<Repository>
+export declare function discoverRepository(path: string, signal?: AbortSignal | undefined | null): Promise<Repository>
+export declare function cloneRepository(url: string, path: string, options?: RepositoryCloneOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<Repository>
+export declare class Repository {
+  /** List all remotes for a given repository */
+  remoteNames(): Array<string>
+  /** Get remote or throws error is not exists. */
+  getRemote(name: string): RemoteObject
+  /** Find remote */
+  findRemote(name: string): RemoteObject | null
+  /** Add a remote with the default fetch refspec to the repository’s configuration. */
+  createRemote(name: string, url: string, options?: CreateRemoteOptions | undefined | null): RemoteObject
+  /**
+   * Download new data and update tips
+   *
+   * Convenience function to connect to a remote, download the data, disconnect and update the remote-tracking branches.
+   */
+  fetchRemote(name: string, refspecs: Array<string>, options?: FetchRemoteOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<void>
+  /**
+   * Perform a push
+   *
+   * Perform all the steps for a push. If no refspecs are passed then the configured refspecs will be used.
+   */
+  pushRemote(name: string, refspecs: Array<string>, options?: PushOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<void>
+  /** Prune tracking refs that are no longer present on remote */
+  pruneRemote(name: string, options?: PruneOptions | undefined | null, signal?: AbortSignal | undefined | null): Promise<void>
+  /** Get the remote’s default branch. */
+  getRemoteDefaultBranch(name: string, signal?: AbortSignal | undefined | null): Promise<string>
+  isBare(): boolean
+  isShallow(): boolean
+  isWorktree(): boolean
+  isEmpty(): boolean
+  path(): string
+  state(): RepositoryState
+  workdir(): string | null
+}

index.js

@@ -32,8 +32,8 @@
   },
   "scripts": {
     "prepublishOnly": "napi prepublish -t npm",
-    "build": "napi build --platform --release",
-    "build:debug": "napi build --platform",
+    "build": "napi build --platform --release --dts=es-git.d.ts",
+    "build:debug": "napi build --platform --dts=es-git.d.ts",
     "check": "biome check",
     "check:fix": "biome check --write --unsafe"
   },