isomorphic-git/src/index.d.ts

A pure JavaScript implementation of git for node and browsers!

import { EventEmitter } from "events";

// Type definitions for isomorphic-git 0.x.x
// Project: isomorphic-git
// Definitions by: William Hilton <wmhilton.com>

/*~ This is the module template file. You should rename it to index.d.ts
 *~ and place it in a folder with the same name as the module.
 *~ For example, if you were writing a file for "super-greeter", this
 *~ file should be 'super-greeter/index.d.ts'
 */

/*~ If this module is a UMD module that exposes a global variable 'myLib' when
 *~ loaded outside a module loader environment, declare that global here.
 *~ Otherwise, delete this declaration.
 */
export as namespace git;

/*~ You can declare types that are available via importing the module */
export interface GitObjectDescription {
  oid: string,
  type?: 'blob' | 'tree' | 'commit' | 'tag',
  format: 'deflated' | 'wrapped' | 'content' | 'parsed',
  object: Buffer | CommitDescription | TreeDescription,
  source?: string
}

export interface CommitDescription {
  oid: string,      // SHA1 object id of this commit
  message: string,  // Commit message
  tree: string,     // SHA1 object id of corresponding file tree
  parent: string[], // an array of zero or more SHA1 object ids
  author: {
    name: string,          // The author's name
    email: string,         // The author's email
    timestamp: number,     // UTC Unix timestamp in seconds
    timezoneOffset: number // Timezone difference from UTC in minutes
  },
  committer: {
    name: string,          // The committer's name
    email: string,         // The committer's email
    timestamp: number,     // UTC Unix timestamp in seconds
    timezoneOffset: number // Timezone difference from UTC in minutes
  }
  gpgsig?: string   // PGP signature (if present)
}

export interface CommitDescriptionWithPayload extends CommitDescription {
  payload: string
}

export interface TreeDescription {
  entries: Array<TreeEntry>
}

export interface TreeEntry {
  mode: string,
  path: string,
  oid: string,
  type?: string
}

export interface PushResponse {
  ok?: string[],
  errors?: string[]
}

export interface FetchResponse {
  defaultBranch: string
}

export interface RemoteDescription {
  capabilities: string[],
  refs?: {
    heads?: object,
    pull?: object,
    tags?: object
  }
}

export interface MergeReport {
  oid: string,
  createdMergeCommit?: boolean,
  fastForward?: boolean
}

/*~ If this module has methods, declare them as functions like so.
 */
export function add(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  filepath: string
}): Promise<void>;

export function branch(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  ref: string
}): Promise<void>;

export function checkout(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  remote?: string,
  ref?: string
}): Promise<void>;

export function clone(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  emitter?: EventEmitter,
  url: string,
  ref?: string,
  remote?: string,
  authUsername?: string,
  authPassword?: string,
  depth?: number,
  since?: Date,
  exclude?: string[],
  relative?: boolean,
  singleBranch?: boolean,
  noCheckout?: boolean
}): Promise<void>;

export function commit(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  message: string,
  author: {
    name?: string,
    email?: string,
    date?: Date,
    timestamp?: number,
  },
  committer: {
    name?: string,
    email?: string,
    date?: Date,
    timestamp?: number,
  }
}): Promise<string>

export function config(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  path: string,
  value?: string | undefined
}): Promise<any>

export function currentBranch(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  fullname?: boolean,
}): Promise<string>

export function fetch(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  emitter?: EventEmitter,
  url?: string,
  ref?: string,
  remote?: string,
  authUsername?: string,
  authPassword?: string,
  depth?: number,
  since?: Date,
  exclude?: string[],
  relative?: boolean,
  tags?: boolean,
  singleBranch?: boolean
}): Promise<FetchResponse>;

export function findRoot(args: {
  fs: any,
  filepath: string
}): Promise<string>;

export function getRemoteInfo(args: {
  url: string,
  authUsername?: string,
  authPassword?: string
}): Promise<RemoteDescription>;

export function indexPack(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  filepath: string
}): Promise<void>

export function init(args: {
  fs: any,
  dir: string,
  gitdir?: string
}): Promise<void>;

export function listBranches(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  remote?: string
}): Promise<Array<string>>;

export function listFiles(args: {
  fs: any,
  dir: string,
  gitdir?: string
}): Promise<Array<string>>;

export function listTags(args: {
  fs: any,
  dir: string,
  gitdir?: string
}): Promise<Array<string>>;

export function log(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ref?: string,
  depth?: number,
  since?: Date
}): Promise<Array<CommitDescription>>
export function log(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ref?: string,
  depth?: number,
  since?: Date,
  signing: false
}): Promise<Array<CommitDescription>>
export function log(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ref?: string,
  depth?: number,
  since?: Date,
  signing: true
}): Promise<Array<CommitDescriptionWithPayload>>

export function merge(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ours: string,
  theirs: string,
  fastForwardOnly?: boolean
}): Promise<MergeReport>;

export function pull(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ref?: string,
  singleBranch?: boolean,
  fastForwardOnly?: boolean,
  authUsername?: string,
  authPassword?: string,
  emitter?: EventEmitter
}): Promise<void>;

export function push(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ref?: string,
  remote?: string,
  url?: string,
  authUsername?: string,
  authPassword?: string
}): Promise<PushResponse>

export function readObject(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  oid: string,
  format: 'deflated' | 'wrapped' | 'content' | 'parsed',
  filepath: string,
  encoding: string
}): Promise<GitObjectDescription>

export function remove(args: {
  fs: any,
  dir: string,
  gitdir?: string
  filepath: string
}): Promise<void>

export function resolveRef(args: {
  fs: any,
  dir: string,
  gitdir?: string,
  ref: string,
  depth?: number
}): Promise<string>

export function sign(args: {
  fs: any,
  dir: string,
  gitdir?: string
  privateKeys: string
}): Promise<string>

export function status(args: {
  fs: any,
  dir: string,
  gitdir?: string
  filepath: string
}): Promise<string>

export const utils: {
  auth: (username: string, password: string) => ({ username: string, password: string }),
  oauth2: (company: string, token: string) => ({ username: string, password: string })
};

export function verify(args: {
  fs: any,
  dir: string,
  gitdir?: string
  ref: string,
  publickKeys: string
}): Promise<false | Array<string>>

export function version(): string