@theholocron/github-client 1.58.0-alpha.11 → 1.58.0-alpha.13

package/dist/index.d.mts

@@ -15,6 +15,10 @@ import { ErrorSink, Logger } from "@theholocron/observability/core";
  * which transport they're talking to.
  */
 interface GraphQLClient {
+  /**
+   * Sends one query or mutation to `POST /graphql` and returns its `data`. Throws a `ProviderApiError` (status `200`, with the
+   * response's `errors` array) when GitHub answers with errors, and the transport's own `ProviderApiError` for a network or HTTP failure.
+   */
   query<T>(document: string, variables?: Record<string, unknown>): Promise<T>;
 }
 /** Options for creating a GitHub client. */
@@ -115,6 +119,8 @@ interface GitHubCheckRun {
   conclusion: CheckRunConclusion | null;
   /** The URL of the check run's page on GitHub. */
   html_url: string;
+  /** The check's own "Details" link, when it set one. */
+  details_url?: string | null;
 }
 /** The body of an `updateCheckRun()` request; every field is optional. */
 interface UpdateCheckRunInput {
@@ -433,6 +439,40 @@ interface GitHubPullRequest {
     /** The head commit. */
     sha: string;
   };
+  /** Whether the pull request is a draft. */
+  draft?: boolean;
+  /** When the pull request was opened, as an ISO 8601 timestamp. */
+  created_at?: string;
+  /** The author. */
+  user?: {
+    /** The author's login. */
+    login: string;
+    /** The account type: `User` or `Bot` (Dependabot is a `Bot`). */
+    type: string;
+  };
+  /** Who merged it; `null` for a pull request that is not merged. */
+  merged_by?: {
+    login: string;
+  } | null;
+  /** The base branch. */
+  base?: {
+    /** The base branch's name, e.g. `alpha`. */
+    ref: string;
+  };
+  /** The people whose review is still asked for. */
+  requested_reviewers?: {
+    login: string;
+  }[];
+  /** Lines added, as the single-pull-request endpoint returns it (the list endpoint omits it). */
+  additions?: number;
+  /** Lines removed; see `additions`. */
+  deletions?: number;
+  /** Files changed; see `additions`. */
+  changed_files?: number;
+  /** Whether it merges cleanly; `null` while GitHub is still working it out. */
+  mergeable?: boolean | null;
+  /** `dirty` means it conflicts with its base; see `mergeable`. */
+  mergeable_state?: string;
 }
 /** A commit's name/email as git itself recorded it — `commit.author`/`commit.committer`, distinct from the GitHub-account `author` below (a commit can carry any email, linked to a GitHub account or not). */
 interface GitHubCommitIdentity {
@@ -511,6 +551,12 @@ interface GitHubPullRequestReview {
   id: number;
   /** The URL of the review on GitHub. */
   html_url: string;
+  /** `APPROVED`, `CHANGES_REQUESTED`, `COMMENTED`, `DISMISSED` or `PENDING`; set on a review read back. */
+  state?: string;
+  /** The reviewer; set on a review read back. */
+  user?: {
+    login: string;
+  } | null;
 }
 /**
  * One review thread — GraphQL-only (`resolveReviewThread`, the mutation
@@ -546,6 +592,8 @@ interface GitHubRepo {
   default_branch: string;
   /** The repository's `owner/name`. */
   full_name: string;
+  /** Whether the repository is archived (read-only). */
+  archived?: boolean;
   /** The repository description. */
   description?: string | null;
   /** The repository homepage URL. */
@@ -855,6 +903,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
     removeBranch: (repo: string, branch: string) => Promise<void>;
   };
   checks: {
+    listCheckRunsForRef: (repo: string, ref: string) => Promise<GitHubCheckRun[]>;
     createCheckRun: (repo: string, input: CreateCheckRunInput) => Promise<GitHubCheckRun>;
     updateCheckRun: (repo: string, checkRunId: number, input: UpdateCheckRunInput) => Promise<GitHubCheckRun>;
   };
@@ -924,6 +973,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
     listPullRequests: (repo: string, state: "open" | "closed") => Promise<GitHubPullRequest[]>;
     listCommits: (repo: string, number: number) => Promise<GitHubPullRequestCommit[]>;
     listFiles: (repo: string, number: number) => Promise<GitHubPullRequestFile[]>;
+    listReviews: (repo: string, number: number) => Promise<GitHubPullRequestReview[]>;
     createReview: (repo: string, number: number, input: CreateReviewInput) => Promise<GitHubPullRequestReview>;
     listReviewThreads: (repo: string, number: number) => Promise<ReviewThread[]>;
     resolveReviewThread: (threadId: string) => Promise<void>;

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import { ProviderApiError, createRestClient } from "@theholocron/http-client";
 import { createHmac, timingSafeEqual } from "node:crypto";
 // src/graphql/graphql.ts
+/** A {@link GraphQLClient} for GitHub's GraphQL API, built on the shared REST transport. */
 function createGitHubGraphQLClient(config) {
 	const rest = createRestClient({
 		baseUrl: config.baseUrl ?? "https://api.github.com",
@@ -107,8 +108,21 @@ function branches(rest) {
 * do for you; slice with it rather than hardcoding the number.
 */
 const MAX_CHECK_RUN_ANNOTATIONS = 50;
+/** Page size and the most pages {@link checks}`.listCheckRunsForRef` reads: 100 a page over 10 pages, so 1,000 check runs. */
+const CHECK_RUN_PAGE_SIZE = 100;
+const CHECK_RUN_MAX_PAGES = 10;
 function checks(rest) {
 	return {
+		/** Every check run on a commit, read a page at a time until a page comes back short. */
+		listCheckRunsForRef: async (repo, ref) => {
+			const all = [];
+			for (let page = 1; page <= CHECK_RUN_MAX_PAGES; page++) {
+				const batch = await rest.request(`${repoBase(repo)}/commits/${ref}/check-runs?per_page=${CHECK_RUN_PAGE_SIZE}&page=${page}`);
+				all.push(...batch.check_runs);
+				if (batch.check_runs.length < CHECK_RUN_PAGE_SIZE) break;
+			}
+			return all;
+		},
 		createCheckRun: (repo, input) => rest.request(`${repoBase(repo)}/check-runs`, {
 			method: "POST",
 			body: input
@@ -413,6 +427,8 @@ function pulls(rest, graphql) {
 		* is an edge case no consumer here needs to paginate for today.
 		*/
 		listFiles: (repo, number) => rest.request(`${repoBase(repo)}/pulls/${number}/files?per_page=100`),
+		/** A PR's reviews, oldest first. `per_page=100` covers every real PR in this org. */
+		listReviews: (repo, number) => rest.request(`${repoBase(repo)}/pulls/${number}/reviews?per_page=100`),
 		/**
 		* Submits a review in one call — GitHub has no separate "create draft,
 		* then submit" step when `event` is provided directly (the multi-step

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.58.0-alpha.11",
+  "version": "1.58.0-alpha.13",
   "description": "A TypeScript client for the GitHub REST API",
   "keywords": [
     "github",
@@ -33,7 +33,7 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.7.0-alpha.1",
-    "@theholocron/http-client": "^1.58.0-alpha.11"
+    "@theholocron/http-client": "^1.58.0-alpha.13"
   },
   "devDependencies": {
     "@types/node": "^26",
@@ -45,10 +45,10 @@
     "tsdown": "^0.23.4",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/tsconfig": "^8.9.0-alpha.8",
-    "@theholocron/vitest-config": "^8.9.0-alpha.8",
-    "@theholocron/eslint-config": "^8.9.0-alpha.8",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.8"
+    "@theholocron/eslint-config": "^8.9.0-alpha.9",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.9",
+    "@theholocron/vitest-config": "^8.9.0-alpha.9",
+    "@theholocron/tsconfig": "^8.9.0-alpha.9"
   },
   "engines": {
     "node": ">=22.0.0"