barecheck
Version:
Barecheck core Node.js library
438 lines (437 loc) • 12.2 kB
TypeScript
import { Octokit } from '@octokit/core';
export { createOctokitClient } from './client';
declare type TFindCommentParams = {
repo: string;
owner: string;
issueNumber: number;
searchBody: string;
};
declare type TUpdateCommentParams = {
repo: string;
owner: string;
commentId: number;
body: string;
};
declare type TCreateCommentParams = {
repo: string;
owner: string;
issueNumber: number;
body: string;
};
declare type TCreateUpdateCommentParams = {
repo: string;
owner: string;
issueNumber: number;
searchBody: string;
body: string;
};
declare type TChangedFilesParams = {
repo: string;
owner: string;
pullNumber: number;
};
export declare const findComment: (octokit: Octokit, { repo, owner, issueNumber, searchBody }: TFindCommentParams) => Promise<{
id: number;
node_id: string;
url: string;
body?: string;
body_text?: string;
body_html?: string;
html_url: string;
user: {
name?: string;
email?: string;
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;
starred_at?: string;
};
created_at: string;
updated_at: string;
issue_url: string;
author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
performed_via_github_app?: {
id: number;
slug?: string;
node_id: string;
owner: {
name?: string;
email?: string;
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;
starred_at?: string;
};
name: string;
description: string;
external_url: string;
html_url: string;
created_at: string;
updated_at: string;
permissions: {
issues?: string;
checks?: string;
metadata?: string;
contents?: string;
deployments?: string;
} & {
[key: string]: string;
};
events: string[];
installations_count?: number;
client_id?: string;
client_secret?: string;
webhook_secret?: string;
pem?: string;
};
reactions?: {
url: string;
total_count: number;
"+1": number;
"-1": number;
laugh: number;
confused: number;
heart: number;
hooray: number;
eyes: number;
rocket: number;
};
}>;
export declare const updateComment: (octokit: Octokit, { repo, owner, commentId, body }: TUpdateCommentParams) => Promise<{
id: number;
node_id: string;
url: string;
body?: string;
body_text?: string;
body_html?: string;
html_url: string;
user: {
name?: string;
email?: string;
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;
starred_at?: string;
};
created_at: string;
updated_at: string;
issue_url: string;
author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
performed_via_github_app?: {
id: number;
slug?: string;
node_id: string;
owner: {
name?: string;
email?: string;
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;
starred_at?: string;
};
name: string;
description: string;
external_url: string;
html_url: string;
created_at: string;
updated_at: string;
permissions: {
issues?: string;
checks?: string;
metadata?: string;
contents?: string;
deployments?: string;
} & {
[key: string]: string;
};
events: string[];
installations_count?: number;
client_id?: string;
client_secret?: string;
webhook_secret?: string;
pem?: string;
};
reactions?: {
url: string;
total_count: number;
"+1": number;
"-1": number;
laugh: number;
confused: number;
heart: number;
hooray: number;
eyes: number;
rocket: number;
};
}>;
export declare const createComment: (octokit: Octokit, { repo, owner, issueNumber, body }: TCreateCommentParams) => Promise<{
id: number;
node_id: string;
url: string;
body?: string;
body_text?: string;
body_html?: string;
html_url: string;
user: {
name?: string;
email?: string;
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;
starred_at?: string;
};
created_at: string;
updated_at: string;
issue_url: string;
author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
performed_via_github_app?: {
id: number;
slug?: string;
node_id: string;
owner: {
name?: string;
email?: string;
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;
starred_at?: string;
};
name: string;
description: string;
external_url: string;
html_url: string;
created_at: string;
updated_at: string;
permissions: {
issues?: string;
checks?: string;
metadata?: string;
contents?: string;
deployments?: string;
} & {
[key: string]: string;
};
events: string[];
installations_count?: number;
client_id?: string;
client_secret?: string;
webhook_secret?: string;
pem?: string;
};
reactions?: {
url: string;
total_count: number;
"+1": number;
"-1": number;
laugh: number;
confused: number;
heart: number;
hooray: number;
eyes: number;
rocket: number;
};
}>;
export declare const createOrUpdateComment: (octokit: Octokit, { owner, repo, issueNumber, searchBody, body }: TCreateUpdateCommentParams) => Promise<{
id: number;
node_id: string;
url: string;
body?: string;
body_text?: string;
body_html?: string;
html_url: string;
user: {
name?: string;
email?: string;
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;
starred_at?: string;
};
created_at: string;
updated_at: string;
issue_url: string;
author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
performed_via_github_app?: {
id: number;
slug?: string;
node_id: string;
owner: {
name?: string;
email?: string;
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;
starred_at?: string;
};
name: string;
description: string;
external_url: string;
html_url: string;
created_at: string;
updated_at: string;
permissions: {
issues?: string;
checks?: string;
metadata?: string;
contents?: string;
deployments?: string;
} & {
[key: string]: string;
};
events: string[];
installations_count?: number;
client_id?: string;
client_secret?: string;
webhook_secret?: string;
pem?: string;
};
reactions?: {
url: string;
total_count: number;
"+1": number;
"-1": number;
laugh: number;
confused: number;
heart: number;
hooray: number;
eyes: number;
rocket: number;
};
}>;
/**
* Returns first 100 files that were changed
* TODO: decide if we need to show more than that in the details report
* */
export declare const getChangedFiles: (octokit: Octokit, { repo, owner, pullNumber }: TChangedFilesParams) => Promise<{
sha: string;
filename: string;
status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
additions: number;
deletions: number;
changes: number;
blob_url: string;
raw_url: string;
contents_url: string;
patch?: string;
previous_filename?: string;
}[]>;