frontend/.github/scripts/github-script.d.ts

// The arguments actions/github-script passes to the scripts in this directory,
// limited to the parts they use.
import type { Octokit } from "@octokit/rest";

export type SummaryTableCell = string | { data: string; header?: boolean };

export interface Summary {
  addHeading(text: string, level?: number): Summary;
  addRaw(text: string): Summary;
  addTable(rows: SummaryTableCell[][]): Summary;
  write(): Promise<Summary>;
}

export interface AnnotationProperties {
  file?: string;
}

export interface Core {
  info(message: string): void;
  notice(message: string, properties?: AnnotationProperties): void;
  warning(message: string, properties?: AnnotationProperties): void;
  error(message: string, properties?: AnnotationProperties): void;
  setFailed(message: string): void;
  summary: Summary;
}

export interface User {
  login: string;
  type: string;
}

export interface PullRequestPayload {
  pull_request: {
    number: number;
    body: string | null;
    draft: boolean;
    user: User;
    labels: { name: string }[];
    base: { sha: string };
    head: { sha: string };
  };
}

export interface IssuePayload {
  issue: {
    user: User;
  };
}

export interface Context<Payload> {
  sha: string;
  repo: { owner: string; repo: string };
  issue: { owner: string; repo: string; number: number };
  payload: Payload;
}

export interface GitHubScriptArgs<Payload> {
  github: Octokit;
  context: Context<Payload>;
  core: Core;
}