@gitkraken/provider-apis 0.6.1

package/dist/providers/gitProvider.d.ts

@@ -0,0 +1,166 @@
+import { EnterpriseProviderConfigInit, PagedResult, ProviderConfigInit, Result } from '../types';
+import { Provider } from './provider';
+export interface SharedOptions {
+    token?: string;
+    isPAT?: boolean;
+}
+export interface BasicOptions extends SharedOptions {
+    baseUrl?: string;
+}
+export interface User {
+    name: string | null;
+    email: string | null;
+    avatarUrl: string | null;
+}
+export interface Account extends User {
+    id: string;
+    graphQLId?: string;
+    username: string | null;
+}
+export interface GitRepository {
+    id: string;
+    graphQLId?: string;
+    namespace: string;
+    name: string;
+    project?: string;
+    webUrl: string | null;
+    httpsUrl: string | null;
+    sshUrl: string | null;
+    defaultBranch: GitRef | null;
+    permission: string | null;
+}
+export interface GitRef {
+    name: string;
+}
+export interface GitRefWithCommit extends GitRef {
+    commit: GitCommit | null;
+}
+export interface GitCommit {
+    oid: string;
+    authoredDate: Date | null;
+    committedDate: Date | null;
+}
+export interface GitBlame {
+    ranges: {
+        startingLine: number;
+        endingLine: number;
+        commit: GitCommit & {
+            parentOids: string[];
+            message: string;
+            author: User | null;
+            committer: User | null;
+            fileCount: number | null;
+            additions: number | null;
+            deletions: number | null;
+        };
+    }[];
+}
+export declare enum GitPullRequestState {
+    Open = "OPEN",
+    Closed = "CLOSED",
+    Merged = "MERGED"
+}
+export declare enum GitPullRequestReviewState {
+    Approved = "APPROVED",
+    ChangesRequested = "CHANGES_REQUESTED",
+    Commented = "COMMENTED",
+    ReviewRequested = "REVIEW_REQUESTED"
+}
+export interface GitPullRequest {
+    id: string;
+    graphQLId?: string;
+    number: number;
+    title: string;
+    url: string | null;
+    state: GitPullRequestState;
+    isDraft: boolean;
+    createdDate: Date;
+    updatedDate: Date;
+    closedDate: Date | null;
+    baseRef: GitRef | null;
+    headRef: GitRef | null;
+    commentCount: number | null;
+    upvoteCount: number | null;
+    commitCount: number | null;
+    fileCount: number | null;
+    additions: number | null;
+    deletions: number | null;
+    author: Account | null;
+    assignees: Account[] | null;
+    reviews: {
+        reviewer: Account;
+        state: GitPullRequestReviewState;
+    }[] | null;
+    repository: {
+        name: string;
+        owner: {
+            login?: string;
+        };
+    };
+    headRepository: {
+        name: string;
+        owner: {
+            login: string;
+        };
+        remoteInfo: {
+            cloneUrlHTTPS: string;
+            cloneUrlSSH: string;
+        };
+    } | null;
+    headCommit: {
+        buildStatus: {
+            context: string;
+            state: string;
+            description: string;
+            targetUrl?: string;
+        } | null;
+    } | null;
+}
+export interface GetRepoInput {
+    namespace: string;
+    name: string;
+    project?: string;
+}
+export interface GetReposInput {
+    repos: GetRepoInput[];
+}
+export type GetPRsForReposInput = GetReposInput | {
+    repoIds: (string | number)[];
+};
+export interface CursorPageInput {
+    cursor?: string | null;
+}
+export interface NumberedPageInput {
+    page?: number | null;
+}
+export type PageInput = CursorPageInput | NumberedPageInput;
+export declare abstract class GitProvider<Config extends ProviderConfigInit = ProviderConfigInit> extends Provider<Config> {
+    abstract getCurrentUser(options: SharedOptions): Promise<Result<Account>>;
+    abstract getUserForCommit(input: {
+        repo: GetRepoInput;
+        oid: string;
+    }, options: SharedOptions): Promise<Result<User>>;
+    getAccountForEmail?(input: {
+        email: string;
+    }, options: SharedOptions): Promise<Result<Account>>;
+    getAccountForUsername?(input: {
+        username: string;
+    }, options: SharedOptions): Promise<Result<Account>>;
+    abstract getRepo(input: GetRepoInput, options: SharedOptions): Promise<Result<GitRepository>>;
+    abstract getRepos(inputs: GetRepoInput[], options: SharedOptions): Promise<Result<GitRepository[]>>;
+    abstract getBranches(input: {
+        repo: GetRepoInput;
+    } & PageInput, options: SharedOptions): Promise<PagedResult<GitRefWithCommit>>;
+    abstract getTags(input: {
+        repo: GetRepoInput;
+    } & PageInput, options: SharedOptions): Promise<PagedResult<GitRefWithCommit>>;
+    getBlame?(input: {
+        repo: GetRepoInput;
+        ref: string;
+        path: string;
+    }, options: SharedOptions): Promise<Result<GitBlame>>;
+    abstract getPullRequestsForRepos(input: GetPRsForReposInput, options: SharedOptions): Promise<Result<GitPullRequest[]>>;
+}
+export declare abstract class EnterpriseGitProvider extends GitProvider<EnterpriseProviderConfigInit> {
+}
+export declare const MAX_PAGE_SIZE = 100;

package/dist/providers/github/github.d.ts

@@ -0,0 +1,122 @@
+import { Account, BasicOptions, CursorPageInput, EnterpriseGitProvider, GetRepoInput, GitPullRequest, GitRepository } from '../gitProvider';
+import { Issue } from '../issueProvider';
+import { FetchIssuesData, FetchPullRequestsData } from './githubTypes';
+export declare class GitHub extends EnterpriseGitProvider {
+    private _scopesCache;
+    private getScopes;
+    private getEnterpriseAvatarUrlIfNeeded;
+    getCurrentUser(options?: BasicOptions): Promise<{
+        data: Account;
+    }>;
+    getUserForCommit(input: {
+        repo: GetRepoInput;
+        oid: string;
+        avatarSize?: number;
+    }, options?: BasicOptions): Promise<{
+        data: {
+            name: string | null;
+            email: string | null;
+            avatarUrl: string;
+        };
+    }>;
+    /**
+     * Note: 'email' is only returned if the token has the required scope.
+     */
+    getAccountForEmail(input: {
+        email: string;
+        avatarSize?: number;
+    }, options?: BasicOptions): Promise<{
+        data: Account;
+    }>;
+    getAccountForUsername(input: {
+        username: string;
+        avatarSize?: number;
+    }, options?: BasicOptions): Promise<{
+        data: Account;
+    }>;
+    getRepo(input: GetRepoInput, options?: BasicOptions): Promise<{
+        data: GitRepository;
+    }>;
+    getRepos(inputs: GetRepoInput[], options?: BasicOptions): Promise<{
+        data: GitRepository[];
+    }>;
+    private getRefs;
+    getBranches(input: {
+        repo: GetRepoInput;
+    } & CursorPageInput, options?: BasicOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        };
+        data: {
+            name: string;
+            commit: {
+                oid: string;
+                authoredDate: Date;
+                committedDate: Date;
+            } | null;
+        }[];
+    }>;
+    getTags(input: {
+        repo: GetRepoInput;
+    } & CursorPageInput, options?: BasicOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        };
+        data: {
+            name: string;
+            commit: {
+                oid: string;
+                authoredDate: Date;
+                committedDate: Date;
+            } | null;
+        }[];
+    }>;
+    getBlame(input: {
+        repo: GetRepoInput;
+        ref: string;
+        path: string;
+    }, options?: BasicOptions): Promise<{
+        data: {
+            ranges: {
+                startingLine: number;
+                endingLine: number;
+                commit: {
+                    oid: string;
+                    parentOids: string[];
+                    authoredDate: Date;
+                    author: {
+                        name: string | null;
+                        email: string | null;
+                        avatarUrl: string;
+                    } | null;
+                    committedDate: Date;
+                    committer: {
+                        name: string | null;
+                        email: string | null;
+                        avatarUrl: string;
+                    } | null;
+                    message: string;
+                    fileCount: number | null;
+                    additions: number;
+                    deletions: number;
+                };
+            }[];
+        };
+    }>;
+    getPullRequestsForRepos(input: FetchPullRequestsData & CursorPageInput, options?: BasicOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        } | undefined;
+        data: GitPullRequest[];
+    }>;
+    getIssuesForRepos(input: FetchIssuesData & CursorPageInput, options?: BasicOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        };
+        data: Issue[];
+    }>;
+}

package/dist/providers/github/githubHelpers.d.ts

@@ -0,0 +1,19 @@
+import { GraphQLBody, GraphQLResponse, ProviderConfig } from '../../types';
+import { BasicOptions, CursorPageInput } from '../gitProvider';
+import { FetchPullRequestsData, GraphQLPullRequest } from './githubTypes';
+export declare const GITHUB_API_URL = "https://api.github.com";
+export declare const GITHUB_GRAPHQL_API_URL: string;
+export declare const makeGitHubGraphQLRequest: <T>(config: ProviderConfig, data: GraphQLBody, options: BasicOptions) => Promise<import("../../types").Response<GraphQLResponse<T>>>;
+export declare const hasEmailScope: (scopes: string[]) => boolean;
+export declare const getAccountFields: (withAvatarSizeVar?: boolean, includeEmail?: boolean) => string;
+export declare const GithubSearchSyntaxQualifiers: Record<string, string>;
+export declare const getProjectGithubSearchSyntax: (search: string) => string[];
+export declare const fetchPullRequests: (config: ProviderConfig, input: FetchPullRequestsData & CursorPageInput, options: BasicOptions, shouldFetchDraft?: boolean, includeEmail?: boolean) => Promise<import("../../types").Response<GraphQLResponse<{
+    [key: string]: {
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        };
+        nodes?: GraphQLPullRequest[] | undefined;
+    };
+}>>>;

package/dist/providers/github/githubTypes.d.ts

@@ -0,0 +1,159 @@
+import { GetRepoInput } from '../gitProvider';
+export declare enum GraphQLViewerPermission {
+    ADMIN = "ADMIN",
+    MAINTAIN = "MAINTAIN",
+    READ = "READ",
+    TRIAGE = "TRIAGE",
+    WRITE = "WRITE"
+}
+export interface GraphQLRepository {
+    id: string;
+    databaseId: number;
+    owner: {
+        login: string;
+    };
+    name: string;
+    url: string;
+    sshUrl: string;
+    defaultBranchRef: {
+        name: string;
+    } | null;
+    viewerPermission: GraphQLViewerPermission;
+}
+export declare enum GitHubPullRequestReviewState {
+    Approved = "APPROVED",
+    ChangesRequested = "CHANGES_REQUESTED",
+    Commented = "COMMENTED",
+    ReviewRequested = "REVIEW_REQUESTED"
+}
+export interface GraphQLUser {
+    id: string;
+    databaseId: number;
+    name: string | null;
+    login: string;
+    email?: string;
+    avatarUrl: string;
+}
+export type PullRequestState = 'OPEN' | 'CLOSED' | 'MERGED';
+export interface GraphQLPullRequest {
+    id: string;
+    databaseId: number;
+    title: string;
+    number: number;
+    state: PullRequestState;
+    comments: {
+        totalCount: number;
+    };
+    reactions: {
+        totalCount: number;
+    };
+    createdAt: string;
+    closedAt: string | null;
+    isDraft: boolean;
+    changedFiles: number;
+    additions: number;
+    deletions: number;
+    assignees: {
+        nodes: GraphQLUser[] | null;
+    };
+    author: GraphQLUser | Record<string, never> | null;
+    commits: {
+        nodes: {
+            commit: {
+                oid: string;
+                status?: {
+                    contexts?: {
+                        context: string;
+                        state: string;
+                        description: string;
+                        targetUrl?: string | undefined;
+                    }[];
+                };
+            };
+        }[] | null;
+        totalCount: number;
+    };
+    baseRef: {
+        name: string;
+        target: {
+            oid: string;
+        } | null;
+    } | null;
+    headRef: {
+        name: string;
+        target: {
+            oid: string;
+        } | null;
+    } | null;
+    headRepository: {
+        name: string;
+        owner: {
+            login: string;
+        };
+        sshUrl: string;
+        url: string;
+    };
+    repository: {
+        name: string;
+        owner: {
+            login: string;
+        };
+    };
+    reviewRequests: {
+        nodes: {
+            asCodeOwner: boolean;
+            requestedReviewer: GraphQLUser;
+        }[] | null;
+    } | null;
+    latestReviews: {
+        nodes: {
+            author: GraphQLUser;
+            state: GitHubPullRequestReviewState;
+        }[] | null;
+    } | null;
+    url: string;
+    updatedAt: string;
+}
+export interface GraphQLIssue {
+    id: string;
+    databaseId: number;
+    number: string;
+    title: string;
+    url: string;
+    repository: {
+        name: string;
+        owner: {
+            login: string;
+        };
+    };
+    assignees: {
+        nodes: GraphQLUser[] | null;
+    };
+    author: GraphQLUser | Record<string, never> | null;
+    createdAt: string;
+    updatedAt: string;
+    comments: {
+        totalCount: number;
+    };
+    reactions: {
+        totalCount: number;
+    };
+}
+export interface FetchPullRequestsData {
+    repos: GetRepoInput[];
+    assigneeLogins?: string[];
+    updatedBefore?: string;
+    isDraft?: boolean;
+    authorLogin?: string;
+    mentionLogin?: string;
+    reviewRequestedLogin?: string;
+    startQuery?: string;
+}
+export interface FetchIssuesData {
+    repos: GetRepoInput[];
+    assigneeLogins?: string[];
+    updatedBefore?: string;
+    authorLogin?: string;
+    mentionLogin?: string;
+    startQuery?: string;
+}

package/dist/providers/gitlab/gitlab.d.ts

@@ -0,0 +1,157 @@
+import { Account, CursorPageInput, GetRepoInput, GitProvider, GitPullRequest, GitRepository, NumberedPageInput, SharedOptions } from '../gitProvider';
+import { GetIssueInput, Issue, IssueProvider } from '../issueProvider';
+import { Provider } from '../provider';
+export type PullRequestState = 'opened' | 'merged' | 'closed';
+export declare class GitLab extends Provider implements GitProvider, IssueProvider {
+    getCurrentUser(options?: SharedOptions): Promise<{
+        data: Account;
+    }>;
+    getUserForCommit(input: {
+        repo: GetRepoInput;
+        oid: string;
+    }, options?: SharedOptions): Promise<{
+        data: {
+            name: string | null;
+            email: string | null;
+            avatarUrl: string | null;
+        };
+    }>;
+    getAccountForEmail(input: {
+        email: string;
+    }, options?: SharedOptions): Promise<{
+        data: Account;
+    }>;
+    getAccountForUsername(input: {
+        username: string;
+    }, options?: SharedOptions): Promise<{
+        data: Account;
+    }>;
+    getRepo(input: GetRepoInput, options?: SharedOptions): Promise<{
+        data: GitRepository;
+    }>;
+    getRepos(inputs: GetRepoInput[], options?: SharedOptions): Promise<{
+        data: GitRepository[];
+    }>;
+    private getRefs;
+    getBranches(input: {
+        repo: GetRepoInput;
+    } & NumberedPageInput, options?: SharedOptions): Promise<{
+        pageInfo: {
+            hasNextPage: boolean;
+            nextPage: number | null;
+        };
+        data: {
+            name: string;
+            commit: {
+                oid: string;
+                authoredDate: Date;
+                committedDate: Date;
+            };
+        }[];
+    }>;
+    getTags(input: {
+        repo: GetRepoInput;
+    } & NumberedPageInput, options?: SharedOptions): Promise<{
+        pageInfo: {
+            hasNextPage: boolean;
+            nextPage: number | null;
+        };
+        data: {
+            name: string;
+            commit: {
+                oid: string;
+                authoredDate: Date;
+                committedDate: Date;
+            };
+        }[];
+    }>;
+    getBlame(input: {
+        repo: GetRepoInput;
+        ref: string;
+        path: string;
+    }, options?: SharedOptions): Promise<{
+        data: {
+            ranges: {
+                startingLine: number;
+                endingLine: number;
+                commit: {
+                    oid: string;
+                    parentOids: string[];
+                    authoredDate: Date;
+                    author: {
+                        name: string;
+                        email: string;
+                        avatarUrl: null;
+                    };
+                    committedDate: Date;
+                    committer: {
+                        name: string;
+                        email: string;
+                        avatarUrl: null;
+                    };
+                    message: string;
+                    fileCount: null;
+                    additions: null;
+                    deletions: null;
+                };
+            }[];
+        };
+    }>;
+    private getVariablesForPullRequests;
+    getPullRequestsForRepo(input: {
+        repo: GetRepoInput;
+        assigneeLogins?: string[];
+        updatedBefore?: string;
+        authorLogin?: string;
+        isDraft?: boolean;
+        reviewRequestedLogin?: string;
+    } & CursorPageInput, options?: SharedOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        } | undefined;
+        data: GitPullRequest[];
+    }>;
+    getPullRequestsForRepos(input: {
+        repoIds: (string | number)[];
+        assigneeLogins?: string[];
+        updatedBefore?: string;
+        authorLogin?: string;
+        isDraft?: boolean;
+        reviewRequestedLogin?: string;
+    } & CursorPageInput, options?: SharedOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        } | undefined;
+        data: GitPullRequest[];
+    }>;
+    getIssue(input: GetIssueInput, options?: SharedOptions): Promise<{
+        data: Issue;
+    }>;
+    private getVariablesForIssues;
+    getIssuesForRepo(input: {
+        repo: GetRepoInput;
+        assigneeLogins?: string[];
+        updatedBefore?: string;
+        authorLogin?: string;
+    } & CursorPageInput, options?: SharedOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        } | undefined;
+        data: Issue[];
+    }>;
+    getIssuesForRepos(input: {
+        repoIds: (string | number)[];
+        assigneeLogins?: string[];
+        updatedBefore?: string;
+        authorLogin?: string;
+    } & CursorPageInput, options?: SharedOptions): Promise<{
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        } | undefined;
+        data: Issue[];
+    }>;
+}

package/dist/providers/gitlab/gitlabHelpers.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLBody, GraphQLResponse, ProviderConfig } from '../../types';
+import { SharedOptions } from '../gitProvider';
+export declare const GITLAB_GRAPHQL_API_URL = "https://gitlab.com/api/graphql";
+export declare const makeGitLabGraphQLRequest: <T>(config: ProviderConfig, data: GraphQLBody, options: SharedOptions) => Promise<import("../../types").Response<GraphQLResponse<T>>>;

package/dist/providers/gitlab/gitlabTypes.d.ts

@@ -0,0 +1,33 @@
+export interface RESTRef {
+    name: string;
+    commit: {
+        id: string;
+        short_id: string;
+        created_at: string;
+        parent_ids: string[];
+        title: string;
+        message: string;
+        author_name: string;
+        author_email: string;
+        authored_date: string;
+        committer_name: string;
+        committer_email: string;
+        committed_date: string;
+        trailers: unknown;
+        web_url: string;
+    };
+    protected: boolean;
+}
+export interface RESTBranch extends RESTRef {
+    merged: boolean;
+    developers_can_push: boolean;
+    developers_can_merge: boolean;
+    can_push: boolean;
+    default: boolean;
+    web_url: string;
+}
+export interface RESTTag extends RESTRef {
+    message: string;
+    target: string;
+    release: unknown;
+}

package/dist/providers/issueProvider.d.ts

@@ -0,0 +1,37 @@
+import { Result } from '../types';
+import { Account, GetReposInput, SharedOptions } from './gitProvider';
+import { Provider } from './provider';
+export interface GetIssueInput {
+    id: string;
+    name: string;
+    namespace: string;
+    project: string;
+}
+export type GetIssuesForReposInput = GetReposInput | {
+    repoIds: (string | number)[];
+};
+export interface Issue {
+    author: Account | null;
+    assignees: Account[];
+    commentCount: number | null;
+    createdDate: Date;
+    description: string | null;
+    graphQLId?: string;
+    id: string;
+    number: string;
+    repository: {
+        name: string;
+        owner: {
+            login?: string;
+        };
+    } | null;
+    state: string | null;
+    title: string;
+    updatedDate: Date | null;
+    upvoteCount: number | null;
+    url: string;
+}
+export declare abstract class IssueProvider extends Provider {
+    abstract getIssue(input: GetIssueInput, options: SharedOptions): Promise<Result<Issue>>;
+    abstract getIssuesForRepos(input: GetIssuesForReposInput, options: SharedOptions): Promise<Result<Issue[]>>;
+}