@theholocron/github-client 1.29.0 → 1.31.0

package/dist/index.d.mts

@@ -14,10 +14,34 @@ interface GitHubClientOptions {
 //#region src/checks/checks.d.ts
 type CheckRunStatus = "queued" | "in_progress" | "completed";
 type CheckRunConclusion = "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped";
+type CheckRunAnnotationLevel = "notice" | "warning" | "failure";
+interface CheckRunAnnotation {
+  /** File path relative to the repo root. */
+  path: string;
+  /** 1-indexed. */
+  start_line: number;
+  end_line: number;
+  /** Only valid when `start_line === end_line`. */
+  start_column?: number;
+  end_column?: number;
+  annotation_level: CheckRunAnnotationLevel;
+  /** Max 64KB. */
+  message: string;
+  /** Max 255 characters. */
+  title?: string;
+  /** Max 64KB. */
+  raw_details?: string;
+}
 interface CheckRunOutput {
   title: string;
   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.
+   */
+  annotations?: CheckRunAnnotation[];
 }
 interface CreateCheckRunInput {
   name: string;
@@ -392,7 +416,7 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
     getRef: (repo: string, branch: string) => Promise<GitRef>;
     getCommit: (repo: string, sha: string) => Promise<GitCommit>;
     getTree: (repo: string, sha: string, recursive?: boolean) => Promise<GitTree>;
-    getContents: (repo: string, path: string) => Promise<GitContents>;
+    getContents: (repo: string, path: string, ref?: string) => Promise<GitContents>;
     createBlob: (repo: string, content: string, encoding?: string) => Promise<GitBlob>;
     createTree: (repo: string, tree: Array<{
       path: string;
@@ -485,4 +509,4 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
 };
 type GitHubClient = ReturnType<typeof createGitHubClient>;
 //#endregion
-export { type CheckRunConclusion, type CheckRunOutput, type CheckRunStatus, type CodeScanningSetupResult, type CreateCheckRunInput, type CreatePagesPayload, type CreatePullInput, 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 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 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 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 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 SecretScope, type TeamPermission, type UpdateCheckRunInput, type UpdatePagesPayload, type WorkflowRunFilter, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };

package/dist/index.mjs

@@ -65,7 +65,15 @@ function git(rest) {
 		getRef: (repo, branch) => rest.request(`${repoBase(repo)}/git/ref/heads/${branch}`),
 		getCommit: (repo, sha) => rest.request(`${repoBase(repo)}/git/commits/${sha}`),
 		getTree: (repo, sha, recursive = false) => rest.request(`${repoBase(repo)}/git/trees/${sha}${recursive ? "?recursive=1" : ""}`),
-		getContents: (repo, path) => rest.request(`${repoBase(repo)}/contents/${path}`),
+		/**
+		* `ref` defaults to the repo's default branch (GitHub's own default)
+		* when omitted — the security-relevant choice every existing caller
+		* relies on (D4/D6, `validateConfig()`'s own docstring). Pass it
+		* explicitly to read a specific commit/branch's content instead — a
+		* same-repo PR branch is no longer a new trust boundary for this org
+		* (D6-amended, `tech-sentinel-ci-runner.spec.md`), just never a fork's.
+		*/
+		getContents: (repo, path, ref) => rest.request(`${repoBase(repo)}/contents/${path}`, ref ? { query: { ref } } : void 0),
 		createBlob: (repo, content, encoding = "utf-8") => rest.request(`${repoBase(repo)}/git/blobs`, {
 			method: "POST",
 			body: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.29.0",
+  "version": "1.31.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.29.0"
+    "@theholocron/http-client": "^1.31.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.33",