@theholocron/github-client 1.34.0 → 1.36.0

package/README.md

@@ -53,6 +53,15 @@ const blob = await client.git.createBlob("owner/name", "file contents");
 | `git`          | `getRef`, `getCommit`, `getTree`, `getContents`, `createBlob`, `createTree`, `createCommit`, `createRef`, `updateRef`, `createPull`                                                                     |
 | `checks`       | `createCheckRun`                                                                                                                                                                                        |
 
+GitHub accepts at most 50 annotations per check-run request. Slice with the
+exported `MAX_CHECK_RUN_ANNOTATIONS` constant rather than hardcoding it:
+
+```ts
+import { MAX_CHECK_RUN_ANNOTATIONS } from "@theholocron/github-client";
+
+output.annotations = findings.slice(0, MAX_CHECK_RUN_ANNOTATIONS);
+```
+
 ## Webhooks
 
 GitHub's own inbound-webhook mechanics — signature verification and

package/dist/index.d.mts

@@ -15,6 +15,13 @@ interface GitHubClientOptions {
 type CheckRunStatus = "queued" | "in_progress" | "completed";
 type CheckRunConclusion = "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped";
 type CheckRunAnnotationLevel = "notice" | "warning" | "failure";
+/**
+ * GitHub's cap on `output.annotations` per `createCheckRun()` /
+ * `updateCheckRun()` request. More than this needs a follow-up
+ * `updateCheckRun()` PATCH per GitHub's own docs, which this client doesn't
+ * do for you; slice with it rather than hardcoding the number.
+ */
+declare const MAX_CHECK_RUN_ANNOTATIONS = 50;
 interface CheckRunAnnotation {
   /** File path relative to the repo root. */
   path: string;
@@ -37,9 +44,9 @@ interface CheckRunOutput {
   summary: string;
   text?: string;
   /**
-   * Inline PR annotations — up to 50 per request. Sending more requires a
-   * follow-up `updateCheckRun()` PATCH per GitHub's own docs; this client
-   * doesn't paginate them for you.
+   * Inline PR annotations — up to {@link MAX_CHECK_RUN_ANNOTATIONS} per
+   * request. Sending more requires a follow-up `updateCheckRun()` PATCH per
+   * GitHub's own docs; this client doesn't paginate them for you.
    */
   annotations?: CheckRunAnnotation[];
 }
@@ -250,6 +257,13 @@ interface GitHubPullRequestFile {
   status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
   /** Set only when `status === "renamed"`. */
   previous_filename?: string;
+  /**
+   * This file's unified-diff hunks (`@@ -a,b +c,d @@` headers plus
+   * context/added/removed lines) — what a consumer needs to know which
+   * RIGHT-side lines a PR review comment can anchor to. Absent for binary
+   * files and for diffs too large for GitHub to include.
+   */
+  patch?: string;
 }
 /** One inline comment in a `POST /pulls/{pull_number}/reviews` request body. */
 interface CreateReviewComment {
@@ -583,4 +597,4 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
 };
 type GitHubClient = ReturnType<typeof createGitHubClient>;
 //#endregion
-export { type CheckRunAnnotation, type CheckRunAnnotationLevel, type CheckRunConclusion, type CheckRunOutput, type CheckRunStatus, type CodeScanningSetupResult, type CreateCheckRunInput, type CreatePagesPayload, type CreatePullInput, type CreateReviewComment, type CreateReviewInput, type GitBlob, type GitCommit, type GitContents, type GitHubAppCredentials, type GitHubCheckRun, GitHubClient, type GitHubClientOptions, type GitHubContents, type GitHubEnvironment, type GitHubInstallationWebhookPayload, type GitHubIssue, type GitHubLabel, type GitHubMilestone, type GitHubPages, type GitHubPublicKey, type GitHubPullRequest, type GitHubPullRequestCommit, type GitHubPullRequestFile, type GitHubPullRequestReview, type GitHubPullRequestWebhookPayload, type GitHubPushWebhookPayload, type GitHubRepo, type GitHubRuleset, type GitHubUser, type GitHubWebhookHeaders, type GitHubWorkflowRun, type GitPull, type GitRef, type GitTree, type GitTreeItem, type InstallationAccessToken, type IssueSearchParams, type PagesBuildStatus, type PagesBuildType, type ReviewThread, type SecretScope, type TeamPermission, type UpdateCheckRunInput, type UpdatePagesPayload, type WorkflowRunFilter, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };
+export { type CheckRunAnnotation, type CheckRunAnnotationLevel, type CheckRunConclusion, type CheckRunOutput, type CheckRunStatus, type CodeScanningSetupResult, type CreateCheckRunInput, type CreatePagesPayload, type CreatePullInput, type CreateReviewComment, type CreateReviewInput, type GitBlob, type GitCommit, type GitContents, type GitHubAppCredentials, type GitHubCheckRun, GitHubClient, type GitHubClientOptions, type GitHubContents, type GitHubEnvironment, type GitHubInstallationWebhookPayload, type GitHubIssue, type GitHubLabel, type GitHubMilestone, type GitHubPages, type GitHubPublicKey, type GitHubPullRequest, type GitHubPullRequestCommit, type GitHubPullRequestFile, type GitHubPullRequestReview, type GitHubPullRequestWebhookPayload, type GitHubPushWebhookPayload, type GitHubRepo, type GitHubRuleset, type GitHubUser, type GitHubWebhookHeaders, type GitHubWorkflowRun, type GitPull, type GitRef, type GitTree, type GitTreeItem, type InstallationAccessToken, type IssueSearchParams, MAX_CHECK_RUN_ANNOTATIONS, type PagesBuildStatus, type PagesBuildType, type ReviewThread, type SecretScope, type TeamPermission, type UpdateCheckRunInput, type UpdatePagesPayload, type WorkflowRunFilter, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };

package/dist/index.mjs

@@ -68,6 +68,13 @@ function branches(rest) {
 }
 //#endregion
 //#region ../../../../../src/checks/checks.ts
+/**
+* GitHub's cap on `output.annotations` per `createCheckRun()` /
+* `updateCheckRun()` request. More than this needs a follow-up
+* `updateCheckRun()` PATCH per GitHub's own docs, which this client doesn't
+* do for you; slice with it rather than hardcoding the number.
+*/
+const MAX_CHECK_RUN_ANNOTATIONS = 50;
 function checks(rest) {
 	return {
 		createCheckRun: (repo, input) => rest.request(`${repoBase(repo)}/check-runs`, {
@@ -730,4 +737,4 @@ function createGitHubClient(opts) {
 	};
 }
 //#endregion
-export { createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };
+export { MAX_CHECK_RUN_ANNOTATIONS, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.34.0",
+  "version": "1.36.0",
   "description": "A TypeScript client for the GitHub REST API",
   "keywords": [
     "github",
@@ -33,7 +33,7 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.3.0",
-    "@theholocron/http-client": "^1.34.0"
+    "@theholocron/http-client": "^1.36.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",