mod.d.ts

export type GhrapiOptions = {
  entrypoint?: string;
  token?: string;
  orgs?: string[];
  me: string;
}

export type RateLimit = {
  resources: {
    core: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    search: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    graphql: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    integration_manifest: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    source_import: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    code_scanning_upload: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    actions_runner_registration: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    scim: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    },
    dependency_snapshots: {
      limit: number,
      used: number,
      remaining: number,
      reset: number
    }
  },
  rate: {
    limit: number,
    used: number,
    remaining: number,
    reset: number
  }
}

export type OrgReposOptions = {
    type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal";
    sort?: "created" | "updated" | "pushed" | "full_name";
    direction?: "asc" | "desc";
    per_page?: number;
    page?: number;
}

export type UserReposOptions = OrgReposOptions & {
    visibility?: "all" | "public" | "private",
    affiliation?: string,
    type?: "all" | "owner" | "public" | "private" | "member",
    since?: string,
    before?: string,
}

export type Language = {
  name: string;
  files: number;
  percentage: number;
}

export type RepoMini = {
  name: string;
  full_name: string;
  description: string;
  html_url: string;
  homepage: string | null;
  languages: Language[];
  topics: string[];
  release: {
    name: string;
    url: string;
  } | null;
  license: string | null;
  created_at: Date;
  updated_at: Date;
};

export type Owner = {
  login: string;
  id: number;
  node_id: string;
  avatar_url: string;
  gravatar_id: string;
  url: string;
  html_url: string;
  followers_url: string;
  following_url: string;
  gists_url: string;
  starred_url: string;
  subscriptions_url: string;
  organizations_url: string;
  repos_url: string;
  events_url: string;
  received_events_url: string;
  type: string;
  site_admin: boolean;
}

export type License = {
  key: string;
  name: string;
  spdx_id: string;
  url: string;
  node_id: string;
}

export type Repo = {
  id: number;
  node_id: string;
  name: string;
  full_name: string;
  private: boolean;
  owner: Owner,
  html_url: string;
  description: string;
  fork: boolean;
  url: string;
  forks_url: string;
  keys_url: string;
  collaborators_url: string;     
  teams_url: string;
  hooks_url: string;
  issue_events_url: string;
  events_url: string;
  assignees_url: string;
  branches_url: string;
  tags_url: string;
  blobs_url: string;
  git_tags_url: string;
  git_refs_url: string;
  trees_url: string;
  statuses_url: string;
  languages_url: string;
  stargazers_url: string;
  contributors_url: string;
  subscribers_url: string;
  subscription_url: string;
  commits_url: string;
  git_commits_url: string;
  comments_url: string;
  issue_comment_url: string;
  contents_url: string;
  compare_url: string;
  merges_url: string;
  archive_url: string;
  downloads_url: string;
  issues_url: string;
  pulls_url: string;
  milestones_url: string;
  notifications_url: string;
  labels_url: string;
  releases_url: string;
  deployments_url: string;
  created_at: Date;
  updated_at: Date;
  pushed_at: Date;
  git_url: string;
  ssh_url: string;
  clone_url: string;
  svn_url: string;
  homepage: string | null;
  size: number;
  stargazers_count: number;
  watchers_count: number;
  language: string;
  has_issues: boolean;
  has_projects: boolean;
  has_downloads: boolean;
  has_wiki: boolean;
  has_pages: boolean;
  forks_count: number;
  mirror_url: URL | null;
  archived: boolean;
  disabled: boolean;
  open_issues_count: number;
  license: null | License;
  allow_forking: boolean;
  is_template: boolean;
  web_commit_signoff_required: boolean;
  topics: string[],
  visibility: string;
  forks: number;
  open_issues: number;
  watchers: number;
  default_branch: string;
  permissions: {
    admin: boolean;
    maintain: boolean;
    push: boolean;
    triage: boolean;
    pull: boolean;
  }
}