blob: 43e06a4081e5fc8d8abeea17450d84de3d7dfbe4 [file] [log] [blame]
/**
* @license
* Copyright 2019 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {DiffLayer as DiffLayerApi} from '../api/diff';
import {MessageTag, Side} from '../constants/constants';
import {
AccountInfo,
BasePatchSetNum,
ChangeViewChangeInfo,
CommitInfo,
EditPatchSet,
PatchSetNum,
PatchSetNumber,
ReviewerUpdateInfo,
RevisionInfo,
RevisionPatchSetNum,
Timestamp,
} from './common';
// A finalizable object has a single method `finalize` that is called when
// the object is no longer needed and should clean itself up.
export interface Finalizable {
finalize(): void;
}
export function isDefined<T>(x: T): x is NonNullable<T> {
return x !== undefined && x !== null;
}
export type {CoverageRange} from '../api/diff';
export {CoverageType} from '../api/diff';
export enum ErrorType {
AUTH = 'AUTH',
NETWORK = 'NETWORK',
GENERIC = 'GENERIC',
}
export enum LoadingStatus {
NOT_LOADED = 'NOT_LOADED',
LOADING = 'LOADING',
RELOADING = 'RELOADING',
LOADED = 'LOADED',
}
export interface AuthRequestInit extends RequestInit {
// RequestInit define headers as HeadersInit, i.e.
// Headers | string[][] | Record<string, string>
// Auth class supports only Headers in options
headers?: Headers;
}
/*
export interface OwnerRoot {
host?: HTMLElement;
}
/** https://highlightjs.readthedocs.io/en/latest/api.html */
export interface HighlightJSResult {
value: string;
top: unknown;
}
/** https://highlightjs.readthedocs.io/en/latest/api.html */
export interface HighlightJS {
configure(options: {classPrefix: string}): void;
getLanguage(languageName: string): unknown | undefined;
highlight(
languageName: string,
code: string,
ignore_illegals: boolean,
continuation?: unknown
): HighlightJSResult;
}
export type DiffLayerListener = (
/** 1-based inclusive */
start: number,
/** 1-based inclusive */
end: number,
side: Side
) => void;
export interface DiffLayer extends DiffLayerApi {
addListener?(listener: DiffLayerListener): void;
removeListener?(listener: DiffLayerListener): void;
}
export interface PatchSetFile {
path: string;
basePath?: string;
patchNum?: PatchSetNum;
}
export interface PatchNumOnly {
patchNum: PatchSetNum;
}
export function isPatchSetFile(
x: PatchSetFile | PatchNumOnly
): x is PatchSetFile {
return !!(x as PatchSetFile).path;
}
export function isPatchSetNumber(
x?:
| PatchSetNum
| PatchSetNumber
| RevisionPatchSetNum
| BasePatchSetNum
| null
): x is PatchSetNumber {
return !!x && Number.isInteger(x) && (x as number) > 0;
}
export interface FetchRequest {
url: string;
fetchOptions?: AuthRequestInit;
anonymizedUrl?: string;
}
export interface FormattedReviewerUpdateInfo {
author: AccountInfo;
date: Timestamp;
type: 'REVIEWER_UPDATE';
tag: MessageTag.TAG_REVIEWER_UPDATE;
updates: {message: string; reviewers: AccountInfo[]}[];
}
/**
* https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#edit-info
*/
export interface EditRevisionInfo extends Partial<RevisionInfo> {
// EditRevisionInfo has less required properties then RevisionInfo
// TODO: Explicitly list which props are required and optional here.
_number: EditPatchSet;
basePatchNum: BasePatchSetNum;
commit: CommitInfo;
}
export interface ParsedChangeInfo
extends Omit<ChangeViewChangeInfo, 'reviewer_updates' | 'revisions'> {
revisions: {[revisionId: string]: RevisionInfo | EditRevisionInfo};
reviewer_updates?: ReviewerUpdateInfo[] | FormattedReviewerUpdateInfo[];
}