@gitkraken/core-gitlens 0.5.116 → 0.7.0

package/src/plus/git-github/models.ts

@@ -1,623 +0,0 @@
-import type { Endpoints } from '@octokit/types';
-import { GitFileIndexStatus } from '../../git/models/fileStatus.js';
-import type { IssueLabel } from '../../git/models/issue.js';
-import { Issue, RepositoryAccessLevel } from '../../git/models/issue.js';
-import type { PullRequestMember, PullRequestStackInfo, PullRequestState } from '../../git/models/pullRequest.js';
-import {
-	PullRequest,
-	PullRequestMergeableState,
-	PullRequestReviewDecision,
-	PullRequestReviewState,
-	PullRequestStatusCheckRollupState,
-} from '../../git/models/pullRequest.js';
-import type { Provider } from '../../git/models/remoteProvider.js';
-
-export interface GitHubBlame {
-	ranges: GitHubBlameRange[];
-	viewer?: string;
-}
-
-export interface GitHubBlameRange {
-	startingLine: number;
-	endingLine: number;
-	commit: GitHubCommit;
-}
-
-export interface GitHubBranch {
-	name: string;
-	target: {
-		oid: string;
-		authoredDate: string;
-		committedDate: string;
-	};
-}
-
-export interface GitHubCommit {
-	oid: string;
-	parents: { nodes: { oid: string }[] };
-	message: string;
-	additions?: number | undefined;
-	changedFiles?: number | undefined;
-	deletions?: number | undefined;
-	author: { avatarUrl: string | undefined; date: string; email: string | undefined; name: string };
-	committer: { date: string; email: string | undefined; name: string };
-
-	files?: Endpoints['GET /repos/{owner}/{repo}/commits/{ref}']['response']['data']['files'];
-}
-
-export interface GitHubCommitRef {
-	oid: string;
-}
-
-export type GitHubContributor = Endpoints['GET /repos/{owner}/{repo}/contributors']['response']['data'][0];
-
-export type GitHubSshSigningKey = Endpoints['GET /users/{username}/ssh_signing_keys']['response']['data'][0];
-
-export interface GitHubMember {
-	login: string;
-	avatarUrl: string;
-	url: string;
-}
-
-export interface GitHubPagedResult<T> {
-	pageInfo: GitHubPageInfo;
-	totalCount: number;
-	values: T[];
-}
-export interface GitHubPageInfo {
-	startCursor?: string | null;
-	endCursor?: string | null;
-	hasNextPage: boolean;
-	hasPreviousPage: boolean;
-}
-
-export interface GitHubTag {
-	name: string;
-	target: {
-		oid: string;
-		authoredDate?: string;
-		committedDate?: string;
-		message?: string | null;
-		tagger?: {
-			date: string;
-		} | null;
-
-		target?: {
-			oid?: string;
-			authoredDate?: string;
-			committedDate?: string;
-			message?: string | null;
-		};
-	};
-}
-
-export type GitHubCommitFileStatus = NonNullable<
-	Endpoints['GET /repos/{owner}/{repo}/commits/{ref}']['response']['data']['files']
->[0]['status'];
-
-export function fromCommitFileStatus(status: GitHubCommitFileStatus): GitFileIndexStatus | undefined {
-	switch (status) {
-		case 'added':
-			return GitFileIndexStatus.Added;
-		case 'changed':
-		case 'modified':
-			return GitFileIndexStatus.Modified;
-		case 'removed':
-			return GitFileIndexStatus.Deleted;
-		case 'renamed':
-			return GitFileIndexStatus.Renamed;
-		case 'copied':
-			return GitFileIndexStatus.Copied;
-	}
-	return undefined;
-}
-
-export interface GitHubIssueOrPullRequest {
-	__typename: 'Issue' | 'PullRequest';
-
-	closed: boolean;
-	closedAt: string | null;
-	createdAt: string;
-	id: string;
-	number: number;
-	state: GitHubIssueOrPullRequestState;
-	title: string;
-	updatedAt: string;
-	url: string;
-}
-
-export type GitHubIssueState = 'OPEN' | 'CLOSED';
-export type GitHubPullRequestState = 'OPEN' | 'CLOSED' | 'MERGED';
-export type GitHubIssueOrPullRequestState = GitHubIssueState | GitHubPullRequestState;
-
-export interface GitHubPullRequestLite extends Omit<GitHubIssueOrPullRequest, '__typename'> {
-	/** `Actor` is nullable in GitHub's schema — `null` once the author's account is deleted */
-	author: GitHubMember | null;
-	body: string | null;
-
-	baseRefName: string;
-	baseRefOid: string;
-
-	headRefName: string;
-	headRefOid: string;
-	headRepository: {
-		isFork: boolean;
-		name: string;
-		owner: {
-			login: string;
-		};
-		sshUrl: string;
-		url: string;
-	};
-
-	isCrossRepository: boolean;
-	isDraft: boolean;
-	mergedAt: string | null;
-	permalink: string;
-
-	repository: {
-		isFork: boolean;
-		name: string;
-		owner: {
-			login: string;
-		};
-		sshUrl: string;
-		url: string;
-		viewerPermission: GitHubViewerPermission;
-	};
-
-	/** Only selected against github.com — GitHub Enterprise Server schemas lag and reject the field. */
-	stack?: GitHubPullRequestStack | null;
-	/** Only selected against github.com — see `stack`. */
-	stackEntry?: { position: number } | null;
-}
-
-/** GitHub's stacked-pull-request object. Read-only; all stack mutations are REST-only. */
-export interface GitHubPullRequestStack {
-	id: string;
-	number: number;
-	size: number;
-	/** The branch the bottom of the stack targets — the stack's trunk. */
-	baseRefName: string;
-}
-
-export interface GitHubIssue extends Omit<GitHubIssueOrPullRequest, '__typename'> {
-	/** `Actor` is nullable in GitHub's schema — `null` once the author's account is deleted */
-	author: GitHubMember | null;
-	assignees: { nodes: GitHubMember[] };
-	comments?: {
-		totalCount: number;
-	};
-	labels?: { nodes: IssueLabel[] };
-	reactions?: {
-		totalCount: number;
-	};
-	repository: {
-		name: string;
-		owner: {
-			login: string;
-		};
-		viewerPermission: GitHubViewerPermission;
-		url: string;
-	};
-	body: string;
-}
-
-export type GitHubPullRequestReviewDecision = 'CHANGES_REQUESTED' | 'APPROVED' | 'REVIEW_REQUIRED';
-export type GitHubPullRequestMergeableState = 'MERGEABLE' | 'CONFLICTING' | 'UNKNOWN';
-export type GitHubPullRequestStatusCheckRollupState = 'SUCCESS' | 'FAILURE' | 'PENDING' | 'EXPECTED' | 'ERROR';
-export type GitHubPullRequestReviewState = 'APPROVED' | 'CHANGES_REQUESTED' | 'COMMENTED' | 'DISMISSED' | 'PENDING';
-
-type GitHubPullRequestReview = {
-	id: string;
-	author: GitHubMember | null;
-	state: GitHubPullRequestReviewState;
-	commit?: { oid: string } | null;
-};
-
-export interface GitHubPullRequest extends GitHubPullRequestLite {
-	additions: number;
-	assignees: {
-		nodes: GitHubMember[];
-	};
-	changedFiles: number;
-	checksUrl: string;
-	deletions: number;
-	mergeable: GitHubPullRequestMergeableState;
-	reviewDecision: GitHubPullRequestReviewDecision;
-	latestReviews: {
-		nodes: GitHubPullRequestReview[];
-	};
-	/**
-	 * The current user's own latest review. `latestReviews` is capped, so on a heavily-reviewed pull request
-	 * the viewer's own review can fall outside that window — which is exactly the row a "needs my review"
-	 * surface is asking about.
-	 */
-	viewerLatestReview: GitHubPullRequestReview | null;
-	reviewRequests: {
-		nodes: {
-			asCodeOwner: boolean;
-			requestedReviewer: GitHubMember | null;
-		}[];
-	};
-	commits: {
-		totalCount: number;
-		nodes: {
-			commit: {
-				statusCheckRollup: {
-					state: 'SUCCESS' | 'FAILURE' | 'PENDING' | 'EXPECTED' | 'ERROR';
-				} | null;
-			};
-		}[];
-	};
-	totalCommentsCount: number;
-	viewerCanUpdate: boolean;
-}
-
-export type GitHubViewerPermission =
-	| 'ADMIN' // Can read, clone, and push to this repository. Can also manage issues, pull requests, and repository settings, including adding collaborators
-	| 'MAINTAIN' // Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings
-	| 'WRITE' // Can read, clone, and push to this repository. Can also manage issues and pull requests
-	| 'TRIAGE' // Can read and clone this repository. Can also manage issues and pull requests
-	| 'READ' // Can read and clone this repository. Can also open and comment on issues and pull requests
-	| 'NONE';
-
-/** `ghost` is how github.com renders an actor whose account was deleted */
-function fromGitHubMemberOrGhost(member: GitHubMember | null | undefined): PullRequestMember {
-	if (member == null) return { id: 'ghost', name: 'ghost' };
-
-	return {
-		id: member.login,
-		name: member.login,
-		username: member.login,
-		avatarUrl: member.avatarUrl,
-		url: member.url,
-	};
-}
-
-export function fromGitHubPullRequestLite(pr: GitHubPullRequestLite, provider: Provider): PullRequest {
-	return new PullRequest(
-		provider,
-		fromGitHubMemberOrGhost(pr.author),
-		String(pr.number),
-		pr.id,
-		pr.title,
-		pr.permalink,
-		{
-			owner: pr.repository.owner.login,
-			repo: pr.repository.name,
-			accessLevel: fromGitHubViewerPermissionToAccessLevel(pr.repository.viewerPermission),
-		},
-		fromGitHubIssueOrPullRequestState(pr.state),
-		new Date(pr.createdAt),
-		new Date(pr.updatedAt),
-		pr.closedAt == null ? undefined : new Date(pr.closedAt),
-		pr.mergedAt == null ? undefined : new Date(pr.mergedAt),
-		undefined,
-		undefined,
-		{
-			head: {
-				exists: pr.headRepository != null,
-				owner: pr.headRepository?.owner.login,
-				repo: pr.headRepository?.name,
-				sha: pr.headRefOid,
-				branch: pr.headRefName,
-				url: pr.headRepository?.url,
-				cloneHttps: pr.headRepository != null ? `${pr.headRepository.url}.git` : undefined,
-				cloneSsh: pr.headRepository?.sshUrl,
-				isFork: pr.headRepository?.isFork,
-			},
-			base: {
-				exists: pr.repository != null,
-				owner: pr.repository?.owner.login,
-				repo: pr.repository?.name,
-				sha: pr.baseRefOid,
-				branch: pr.baseRefName,
-				url: pr.repository?.url,
-				cloneHttps: pr.repository != null ? `${pr.repository.url}.git` : undefined,
-				cloneSsh: pr.repository?.sshUrl,
-				isFork: pr.repository?.isFork,
-			},
-			isCrossRepository: pr.isCrossRepository,
-		},
-		pr.isDraft,
-		// The lite fragment selects nothing between `isDraft` and `stack`.
-		undefined, // additions
-		undefined, // deletions
-		undefined, // commentsCount
-		undefined, // thumbsUpCount
-		undefined, // reviewDecision
-		undefined, // reviewRequests
-		undefined, // latestReviews
-		undefined, // assignees
-		undefined, // statusCheckRollupState
-		undefined, // project
-		undefined, // version
-		undefined, // commitCount
-		fromGitHubPullRequestStack(pr),
-		undefined, // filesChanged
-		pr.body ?? undefined,
-	);
-}
-
-/** Both fields are absent on GitHub Enterprise Server (never selected) and `null` when unstacked. */
-function fromGitHubPullRequestStack(pr: GitHubPullRequestLite): PullRequestStackInfo | undefined {
-	if (pr.stack == null || pr.stackEntry == null) return undefined;
-
-	return {
-		id: pr.stack.id,
-		number: pr.stack.number,
-		size: pr.stack.size,
-		position: pr.stackEntry.position,
-		baseRef: pr.stack.baseRefName,
-	};
-}
-
-export function fromGitHubIssueOrPullRequestState(state: GitHubPullRequestState): PullRequestState {
-	return state === 'MERGED' ? 'merged' : state === 'CLOSED' ? 'closed' : 'opened';
-}
-
-export function toGitHubPullRequestState(state: PullRequestState): GitHubPullRequestState {
-	return state === 'merged' ? 'MERGED' : state === 'closed' ? 'CLOSED' : 'OPEN';
-}
-
-export function fromGitHubPullRequestReviewDecision(
-	reviewDecision: GitHubPullRequestReviewDecision,
-): PullRequestReviewDecision {
-	switch (reviewDecision) {
-		case 'APPROVED':
-			return PullRequestReviewDecision.Approved;
-		case 'CHANGES_REQUESTED':
-			return PullRequestReviewDecision.ChangesRequested;
-		case 'REVIEW_REQUIRED':
-			return PullRequestReviewDecision.ReviewRequired;
-	}
-}
-
-export function fromGitHubPullRequestReviewState(state: GitHubPullRequestReviewState): PullRequestReviewState {
-	switch (state) {
-		case 'APPROVED':
-			return PullRequestReviewState.Approved;
-		case 'CHANGES_REQUESTED':
-			return PullRequestReviewState.ChangesRequested;
-		case 'COMMENTED':
-			return PullRequestReviewState.Commented;
-		case 'DISMISSED':
-			return PullRequestReviewState.Dismissed;
-		case 'PENDING':
-			return PullRequestReviewState.Pending;
-	}
-}
-
-export function toGitHubPullRequestReviewDecision(
-	reviewDecision: PullRequestReviewDecision,
-): GitHubPullRequestReviewDecision {
-	switch (reviewDecision) {
-		case PullRequestReviewDecision.Approved:
-			return 'APPROVED';
-		case PullRequestReviewDecision.ChangesRequested:
-			return 'CHANGES_REQUESTED';
-		case PullRequestReviewDecision.ReviewRequired:
-			return 'REVIEW_REQUIRED';
-	}
-}
-
-export function fromGitHubPullRequestMergeableState(
-	mergeableState: GitHubPullRequestMergeableState,
-): PullRequestMergeableState {
-	switch (mergeableState) {
-		case 'MERGEABLE':
-			return PullRequestMergeableState.Mergeable;
-		case 'CONFLICTING':
-			return PullRequestMergeableState.Conflicting;
-		case 'UNKNOWN':
-			return PullRequestMergeableState.Unknown;
-	}
-}
-
-export function toGitHubPullRequestMergeableState(
-	mergeableState: PullRequestMergeableState,
-): GitHubPullRequestMergeableState {
-	switch (mergeableState) {
-		case PullRequestMergeableState.Mergeable:
-			return 'MERGEABLE';
-		case PullRequestMergeableState.Conflicting:
-			return 'CONFLICTING';
-		case PullRequestMergeableState.FailingChecks:
-			return 'UNKNOWN';
-		case PullRequestMergeableState.BlockedByPolicy:
-			return 'UNKNOWN';
-		case PullRequestMergeableState.Unknown:
-			return 'UNKNOWN';
-	}
-}
-
-export function fromGitHubPullRequestStatusCheckRollupState(
-	state: GitHubPullRequestStatusCheckRollupState | null | undefined,
-): PullRequestStatusCheckRollupState | undefined {
-	switch (state) {
-		case 'SUCCESS':
-		case 'EXPECTED':
-			return PullRequestStatusCheckRollupState.Success;
-		case 'FAILURE':
-		case 'ERROR':
-			return PullRequestStatusCheckRollupState.Failed;
-		case 'PENDING':
-			return PullRequestStatusCheckRollupState.Pending;
-		default:
-			return undefined;
-	}
-}
-
-export function fromGitHubPullRequest(pr: GitHubPullRequest, provider: Provider): PullRequest {
-	// `latestReviews` is capped, so keep the viewer's own review even when it falls outside that window, deduped
-	// by review id since the two selections overlap. Unsubmitted drafts are dropped from the union rather than
-	// from the viewer's side alone: `PENDING` is in GitHub's review-state enum on both selections, and the field
-	// this feeds is documented as reviews already SUBMITTED — a draft there tells a "needs my review" consumer
-	// the review is done, and a reviewer with a submitted review plus a draft would get two conflicting rows.
-	const viewerLatestReview = pr.viewerLatestReview;
-	const latestReviews = [
-		...pr.latestReviews.nodes,
-		...(viewerLatestReview != null && !pr.latestReviews.nodes.some(r => r.id === viewerLatestReview.id)
-			? [viewerLatestReview]
-			: []),
-	].filter(review => review.state !== 'PENDING');
-
-	return new PullRequest(
-		provider,
-		fromGitHubMemberOrGhost(pr.author),
-		String(pr.number),
-		pr.id,
-		pr.title,
-		pr.permalink,
-		{
-			owner: pr.repository.owner.login,
-			repo: pr.repository.name,
-			accessLevel: fromGitHubViewerPermissionToAccessLevel(pr.repository.viewerPermission),
-		},
-		fromGitHubIssueOrPullRequestState(pr.state),
-		new Date(pr.createdAt),
-		new Date(pr.updatedAt),
-		pr.closedAt == null ? undefined : new Date(pr.closedAt),
-		pr.mergedAt == null ? undefined : new Date(pr.mergedAt),
-		fromGitHubPullRequestMergeableState(pr.mergeable),
-		pr.viewerCanUpdate,
-		{
-			head: {
-				exists: pr.headRepository != null,
-				owner: pr.headRepository?.owner.login,
-				repo: pr.headRepository?.name,
-				sha: pr.headRefOid,
-				branch: pr.headRefName,
-				url: pr.headRepository?.url,
-				cloneHttps: pr.headRepository != null ? `${pr.headRepository.url}.git` : undefined,
-				cloneSsh: pr.headRepository?.sshUrl,
-				isFork: pr.headRepository?.isFork,
-			},
-			base: {
-				exists: pr.repository != null,
-				owner: pr.repository?.owner.login,
-				repo: pr.repository?.name,
-				sha: pr.baseRefOid,
-				branch: pr.baseRefName,
-				url: pr.repository?.url,
-				cloneHttps: pr.repository != null ? `${pr.repository.url}.git` : undefined,
-				cloneSsh: pr.repository?.sshUrl,
-				isFork: pr.repository?.isFork,
-			},
-			isCrossRepository: pr.isCrossRepository,
-		},
-		pr.isDraft,
-		pr.additions,
-		pr.deletions,
-		pr.totalCommentsCount,
-		0, //pr.reactions.totalCount,
-		fromGitHubPullRequestReviewDecision(pr.reviewDecision),
-		pr.reviewRequests.nodes
-			.map(r =>
-				r.requestedReviewer != null
-					? {
-							isCodeOwner: r.asCodeOwner,
-							reviewer: {
-								id: r.requestedReviewer.login,
-								name: r.requestedReviewer.login,
-								username: r.requestedReviewer.login,
-								avatarUrl: r.requestedReviewer.avatarUrl,
-								url: r.requestedReviewer.url,
-							},
-							state: PullRequestReviewState.ReviewRequested,
-						}
-					: undefined,
-			)
-			.filter(<T>(r?: T): r is T => Boolean(r)),
-		latestReviews.map(r => ({
-			reviewer: fromGitHubMemberOrGhost(r.author),
-			state: fromGitHubPullRequestReviewState(r.state),
-			commitOid: r.commit?.oid,
-		})),
-		pr.assignees.nodes.map(r => ({
-			id: r.login,
-			name: r.login,
-			username: r.login,
-			avatarUrl: r.avatarUrl,
-			url: r.url,
-		})),
-		fromGitHubPullRequestStatusCheckRollupState(pr.commits.nodes?.[0]?.commit.statusCheckRollup?.state),
-		undefined, // project
-		undefined, // version
-		pr.commits.totalCount,
-		fromGitHubPullRequestStack(pr),
-		pr.changedFiles,
-		pr.body ?? undefined,
-	);
-}
-
-export function fromGitHubIssue(value: GitHubIssue, provider: Provider): Issue {
-	return new Issue(
-		{
-			id: provider.id,
-			name: provider.name,
-			domain: provider.domain,
-			icon: provider.icon,
-		},
-		String(value.number),
-		value.id,
-		value.title,
-		value.url,
-		new Date(value.createdAt),
-		new Date(value.updatedAt),
-		value.closed,
-		fromGitHubIssueOrPullRequestState(value.state),
-		value.author == null
-			? undefined
-			: {
-					id: value.author.login,
-					name: value.author.login,
-					username: value.author.login,
-					avatarUrl: value.author.avatarUrl,
-					url: value.author.url,
-				},
-		value.assignees.nodes.map(assignee => ({
-			id: assignee.login,
-			name: assignee.login,
-			username: assignee.login,
-			avatarUrl: assignee.avatarUrl,
-			url: assignee.url,
-		})),
-		{
-			owner: value.repository.owner.login,
-			repo: value.repository.name,
-			accessLevel: fromGitHubViewerPermissionToAccessLevel(value.repository.viewerPermission),
-			url: value.repository.url,
-		},
-		value.closedAt == null ? undefined : new Date(value.closedAt),
-		value.labels?.nodes == null
-			? undefined
-			: value.labels.nodes.map(label => ({
-					color: label.color,
-					name: label.name,
-				})),
-		value.comments?.totalCount,
-		value.reactions?.totalCount,
-		value.body,
-	);
-}
-
-function fromGitHubViewerPermissionToAccessLevel(
-	permission: GitHubViewerPermission | null | undefined,
-): RepositoryAccessLevel {
-	switch (permission) {
-		case 'ADMIN':
-			return RepositoryAccessLevel.Admin;
-		case 'MAINTAIN':
-			return RepositoryAccessLevel.Maintain;
-		case 'WRITE':
-			return RepositoryAccessLevel.Write;
-		case 'TRIAGE':
-			return RepositoryAccessLevel.Triage;
-		case 'READ':
-			return RepositoryAccessLevel.Read;
-		default:
-			return RepositoryAccessLevel.None;
-	}
-}