279e63f65f
We previously held off with updating Octokit to v18 due to their more noticable issues with typings. This commit updates us to the latest version in order to take advantage of the new pagination API (which is also strongly-typed), and to not fall behind too much over time (Octokit seems to change quite often..) We work around the problem with the types for `getContent` by just using a type cast with a TODO (and link to the issue). Similarly we work around a problem where the Octokit types have an incorrect type for the name of the labels array in an API response. PR Close #42666
75 lines
2.6 KiB
TypeScript
75 lines
2.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {OctokitOptions} from '@octokit/core/dist-types/types';
|
|
import {graphql} from '@octokit/graphql';
|
|
import {PaginateInterface} from '@octokit/plugin-paginate-rest';
|
|
import {RestEndpointMethods} from '@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types';
|
|
import {Octokit} from '@octokit/rest';
|
|
import {RequestParameters} from '@octokit/types';
|
|
import {query} from 'typed-graphqlify';
|
|
|
|
/**
|
|
* An object representation of a Graphql Query to be used as a response type and
|
|
* to generate a Graphql query string.
|
|
*/
|
|
export type GraphqlQueryObject = Parameters<typeof query>[1];
|
|
|
|
/** Interface describing a Github repository. */
|
|
export interface GithubRepo {
|
|
/** Owner login of the repository. */
|
|
owner: string;
|
|
/** Name of the repository. */
|
|
name: string;
|
|
}
|
|
|
|
/** Error for failed Github API requests. */
|
|
export class GithubApiRequestError extends Error {
|
|
constructor(public status: number, message: string) {
|
|
super(message);
|
|
}
|
|
}
|
|
|
|
/** A Github client for interacting with the Github APIs. */
|
|
export class GithubClient {
|
|
/** The octokit instance actually performing API requests. */
|
|
private _octokit = new Octokit(this._octokitOptions);
|
|
|
|
readonly pulls = this._octokit.pulls;
|
|
readonly repos = this._octokit.repos;
|
|
readonly issues = this._octokit.issues;
|
|
readonly git = this._octokit.git;
|
|
readonly rateLimit = this._octokit.rateLimit;
|
|
|
|
// Note: These are properties from `Octokit` that are brought in by optional plugins.
|
|
// TypeScript requires us to provide an explicit type for these.
|
|
readonly rest: RestEndpointMethods = this._octokit.rest;
|
|
readonly paginate: PaginateInterface = this._octokit.paginate;
|
|
|
|
constructor(private _octokitOptions?: OctokitOptions) {}
|
|
}
|
|
|
|
/**
|
|
* Extension of the `GithubClient` that provides utilities which are specific
|
|
* to authenticated instances.
|
|
*/
|
|
export class AuthenticatedGithubClient extends GithubClient {
|
|
/** The graphql instance with authentication set during construction. */
|
|
private _graphql = graphql.defaults({headers: {authorization: `token ${this._token}`}});
|
|
|
|
constructor(private _token: string) {
|
|
// Set the token for the octokit instance.
|
|
super({auth: _token});
|
|
}
|
|
|
|
/** Perform a query using Github's Graphql API. */
|
|
async graphql<T extends GraphqlQueryObject>(queryObject: T, params: RequestParameters = {}) {
|
|
return (await this._graphql(query(queryObject).toString(), params)) as T;
|
|
}
|
|
}
|