@theholocron/github-client 1.58.0-alpha.1 → 1.58.0-alpha.3

package/dist/index.d.mts

@@ -242,6 +242,13 @@ interface OrgProperty {
   /** The values a `single_select` or `multi_select` property accepts; `null` for any other type. */
   allowed_values?: string[] | null;
 }
+/** One custom property value set on a repository. */
+interface RepoPropertyValue {
+  /** The property's name. */
+  property_name: string;
+  /** A string, a string array for `multi_select`, or `null` when unset. */
+  value: string | string[] | null;
+}
 interface GitHubPullRequest {
   number: number;
   title: string;
@@ -351,6 +358,36 @@ interface ReviewThread {
 interface GitHubRepo {
   default_branch: string;
   full_name: string;
+  /** The repository description. */
+  description?: string | null;
+  /** The repository homepage URL. */
+  homepage?: string | null;
+  /** The topics set on the repository. */
+  topics?: string[];
+  /** Whether squash merging is allowed. */
+  allow_squash_merge?: boolean;
+  /** Whether merge commits are allowed. */
+  allow_merge_commit?: boolean;
+  /** Whether rebase merging is allowed. */
+  allow_rebase_merge?: boolean;
+  /** Whether auto-merge is allowed. */
+  allow_auto_merge?: boolean;
+  /** Whether a pull request branch can be updated from its base. */
+  allow_update_branch?: boolean;
+  /** Whether a merged pull request's branch is deleted. */
+  delete_branch_on_merge?: boolean;
+  /** Whether issues are enabled. */
+  has_issues?: boolean;
+  /** Whether discussions are enabled. */
+  has_discussions?: boolean;
+  /** Whether projects are enabled. */
+  has_projects?: boolean;
+  /** Whether the wiki is enabled. */
+  has_wiki?: boolean;
+  /** Each feature's `status` (`enabled` / `disabled`). Only an admin token sees it; absent for the rest. */
+  security_and_analysis?: Record<string, {
+    status: string;
+  } | undefined> | null;
 }
 interface GitHubContents {
   content: string;
@@ -361,6 +398,16 @@ interface GitHubRuleset {
   name: string;
   enforcement: string;
 }
+/** One ruleset in full, as `GET /repos/{repo}/rulesets/{id}` returns it. */
+interface GitHubRulesetDetail extends GitHubRuleset {
+  /** What the ruleset applies to, e.g. `branch`. */
+  target?: string;
+  /** Each rule has a `type`; some carry `parameters`. */
+  rules?: Array<{
+    type: string;
+    parameters?: Record<string, unknown>;
+  }>;
+}
 type SecretScope = {
   kind: "repo";
 } | {
@@ -379,6 +426,13 @@ interface CodeScanningSetupResult {
   run_url: string;
 }
 type TeamPermission = "pull" | "triage" | "push" | "maintain" | "admin";
+/** A team with access to a repository, and the permission it has there. */
+interface RepoTeam {
+  /** The team's slug. */
+  slug: string;
+  /** The team's permission on the repository. */
+  permission: TeamPermission;
+}
 /** A member of a team, as GitHub lists it. `id` is the numeric user id, which survives a rename; `login` does not. */
 interface TeamMember {
   id: number;
@@ -411,6 +465,18 @@ interface GitHubUser {
   name: string | null;
   email: string | null;
 }
+/** The authenticated user and, for a token that expires, when. */
+interface GitHubUserWithExpiry {
+  /** The authenticated user. */
+  user: GitHubUser;
+  /** When the token stops working, ISO 8601 in UTC. Absent for a token that never expires. */
+  expiresAt?: string;
+}
+/**
+ * The expiry GitHub reports in the `github-authentication-token-expiration` header (`2026-11-19 03:46:04 UTC`) as
+ * ISO 8601, or `undefined` when the header is missing or is not a date.
+ */
+export declare function parseTokenExpiration(header: string | null): string | undefined;
 interface GitHubWorkflowRun {
   id: number;
   name: string | null;
@@ -583,6 +649,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
     updatePages: (repo: string, payload: UpdatePagesPayload) => Promise<void>;
   };
   properties: {
+    getValues: (repo: string) => Promise<RepoPropertyValue[]>;
     orgSchema: (org: string) => Promise<OrgProperty[]>;
     setProperties: (repo: string, values: Record<string, string | string[]>) => Promise<void>;
   };
@@ -601,6 +668,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
     getContents: (repo: string, path: string) => Promise<GitHubContents>;
   };
   rulesets: {
+    getRuleset: (repo: string, id: number) => Promise<GitHubRulesetDetail>;
     listRulesets: (repo: string) => Promise<GitHubRuleset[]>;
     createRuleset: (repo: string, payload: Record<string, unknown>) => Promise<GitHubRuleset>;
     updateRuleset: (repo: string, id: number, payload: Record<string, unknown>) => Promise<GitHubRuleset>;
@@ -612,6 +680,10 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
     deleteSecret: (repo: string, scope: SecretScope, name: string) => Promise<void>;
   };
   security: {
+    vulnerabilityAlertsEnabled: (repo: string) => Promise<boolean>;
+    automatedSecurityFixesEnabled: (repo: string) => Promise<boolean>;
+    privateVulnerabilityReportingEnabled: (repo: string) => Promise<boolean>;
+    codeScanningDefaultSetupState: (repo: string) => Promise<string>;
     enableVulnerabilityAlerts: (repo: string) => Promise<void>;
     enableAutomatedSecurityFixes: (repo: string) => Promise<void>;
     enableSecretScanning: (repo: string) => Promise<void>;
@@ -622,6 +694,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
   };
   teams: {
     members: (org: string, teamSlug: string) => Promise<TeamMember[]>;
+    listForRepo: (repo: string) => Promise<RepoTeam[]>;
     addRepo: (org: string, teamSlug: string, owner: string, repo: string, permission: TeamPermission) => Promise<void>;
   };
   topics: {
@@ -636,6 +709,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
   };
   user: {
     getCurrentUser: () => Promise<GitHubUser>;
+    getCurrentUserWithExpiry(): Promise<GitHubUserWithExpiry>;
   };
   workflows: {
     listRuns: (repo: string, filter?: WorkflowRunFilter) => Promise<GitHubWorkflowRun[]>;
@@ -644,4 +718,4 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
   };
 };
 export type GitHubClient = ReturnType<typeof createGitHubClient>;
-export type { CheckRunAnnotation, CheckRunAnnotationLevel, CheckRunConclusion, CheckRunOutput, CheckRunStatus, CodeScanningSetupResult, CreateCheckRunInput, CreatePagesPayload, CreatePullInput, CreateReviewComment, CreateReviewInput, GitBlob, GitCommit, GitContents, GitHubAppCredentials, GitHubCheckRun, GitHubClientOptions, GitHubContents, GitHubEnvironment, GitHubInstallationWebhookPayload, GitHubIssue, GitHubLabel, GitHubMilestone, GitHubPages, GitHubPublicKey, GitHubPullRequest, GitHubPullRequestCommit, GitHubPullRequestFile, GitHubPullRequestReview, GitHubPullRequestWebhookPayload, GitHubPushWebhookPayload, GitHubRepo, GitHubRuleset, GitHubUser, GitHubVariable, GitHubWebhookHeaders, GitHubWorkflowRun, GitPull, GitRef, GitTree, GitTreeItem, InstallationAccessToken, IssueSearchParams, OrgProperty, PagesBuildStatus, PagesBuildType, PutContentsInput, PutContentsResult, ReviewThread, SecretScope, TeamMember, TeamPermission, UpdateCheckRunInput, UpdatePagesPayload, VariableScope, VariableVisibility, WorkflowRunFilter };
+export type { CheckRunAnnotation, CheckRunAnnotationLevel, CheckRunConclusion, CheckRunOutput, CheckRunStatus, CodeScanningSetupResult, CreateCheckRunInput, CreatePagesPayload, CreatePullInput, CreateReviewComment, CreateReviewInput, GitBlob, GitCommit, GitContents, GitHubAppCredentials, GitHubCheckRun, GitHubClientOptions, GitHubContents, GitHubEnvironment, GitHubInstallationWebhookPayload, GitHubIssue, GitHubLabel, GitHubMilestone, GitHubPages, GitHubPublicKey, GitHubPullRequest, GitHubPullRequestCommit, GitHubPullRequestFile, GitHubPullRequestReview, GitHubPullRequestWebhookPayload, GitHubPushWebhookPayload, GitHubRepo, GitHubRuleset, GitHubRulesetDetail, GitHubUser, GitHubUserWithExpiry, GitHubVariable, GitHubWebhookHeaders, GitHubWorkflowRun, GitPull, GitRef, GitTree, GitTreeItem, InstallationAccessToken, IssueSearchParams, OrgProperty, PagesBuildStatus, PagesBuildType, PutContentsInput, PutContentsResult, RepoPropertyValue, RepoTeam, ReviewThread, SecretScope, TeamMember, TeamPermission, UpdateCheckRunInput, UpdatePagesPayload, VariableScope, VariableVisibility, WorkflowRunFilter };

package/dist/index.mjs

@@ -293,6 +293,8 @@ function pages(rest) {
 // src/properties/properties.ts
 function properties(rest) {
 	return {
+		/** The custom property values set on a repository (read-only). */
+		getValues: (repo) => rest.request(`${repoBase(repo)}/properties/values`),
 		/**
 		* The custom properties an organization defines, with their types and allowed values (read-only).
 		* The token needs read access to the organization's custom properties.
@@ -431,6 +433,7 @@ function repos(rest) {
 // src/rulesets/rulesets.ts
 function rulesets(rest) {
 	return {
+		getRuleset: (repo, id) => rest.request(`${repoBase(repo)}/rulesets/${id}`),
 		listRulesets: (repo) => rest.request(`${repoBase(repo)}/rulesets`),
 		createRuleset: (repo, payload) => rest.request(`${repoBase(repo)}/rulesets`, {
 			method: "POST",
@@ -468,6 +471,22 @@ function secrets(rest) {
 // src/security/security.ts
 function security(rest) {
 	return {
+		/** Whether vulnerability alerts are on: GitHub answers 204 when they are and 404 when they are not. */
+		vulnerabilityAlertsEnabled: async (repo) => {
+			try {
+				await rest.request(`${repoBase(repo)}/vulnerability-alerts`, { expectNoContent: true });
+				return true;
+			} catch (err) {
+				if (err instanceof ProviderApiError && err.status === 404) return false;
+				throw err;
+			}
+		},
+		/** Whether Dependabot security updates are on. */
+		automatedSecurityFixesEnabled: async (repo) => (await rest.request(`${repoBase(repo)}/automated-security-fixes`)).enabled,
+		/** Whether private vulnerability reporting is on. */
+		privateVulnerabilityReportingEnabled: async (repo) => (await rest.request(`${repoBase(repo)}/private-vulnerability-reporting`)).enabled,
+		/** The state of CodeQL default setup: `configured` or `not-configured`. */
+		codeScanningDefaultSetupState: async (repo) => (await rest.request(`${repoBase(repo)}/code-scanning/default-setup`)).state,
 		enableVulnerabilityAlerts: (repo) => rest.request(`${repoBase(repo)}/vulnerability-alerts`, {
 			method: "PUT",
 			expectNoContent: true
@@ -535,6 +554,8 @@ function teams(rest) {
 			if ((await read(51)).length > 0) throw new Error(`team ${org}/${teamSlug} has more than 5000 members; refusing to read them all`);
 			return all;
 		},
+		/** The teams that have access to a repository, with each team's permission there (read-only). */
+		listForRepo: (repo) => rest.request(`${repoBase(repo)}/teams`, { query: { per_page: String(PAGE$1) } }),
 		addRepo: (org, teamSlug, owner, repo, permission) => rest.request(`/orgs/${org}/teams/${teamSlug}/repos/${owner}/${repo}`, {
 			method: "PUT",
 			body: { permission }
@@ -549,8 +570,31 @@ function topics(rest) {
 	}) };
 }
 // src/user/user.ts
+/**
+* The expiry GitHub reports in the `github-authentication-token-expiration` header (`2026-11-19 03:46:04 UTC`) as
+* ISO 8601, or `undefined` when the header is missing or is not a date.
+*/
+function parseTokenExpiration(header) {
+	if (!header) return void 0;
+	const time = Date.parse(header.replace(/ UTC$/, "Z").replace(" ", "T"));
+	return Number.isNaN(time) ? void 0 : new Date(time).toISOString();
+}
 function user(rest) {
-	return { getCurrentUser: () => rest.request("/user") };
+	return {
+		getCurrentUser: () => rest.request("/user"),
+		/** The authenticated user plus when the token expires, read from the response header on the same call. */
+		async getCurrentUserWithExpiry() {
+			let header = null;
+			const me = await rest.request("/user", { onResponse: (headers) => {
+				header = headers.get("github-authentication-token-expiration");
+			} });
+			const expiresAt = parseTokenExpiration(header);
+			return expiresAt ? {
+				user: me,
+				expiresAt
+			} : { user: me };
+		}
+	};
 }
 // src/variables/variables.ts
 /** GitHub's maximum page size for this listing is 30, not the usual 100. */
@@ -871,4 +915,4 @@ function createGitHubClient(opts) {
 		workflows: workflows(rest)
 	};
 }
-export { MAX_CHECK_RUN_ANNOTATIONS, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };
+export { MAX_CHECK_RUN_ANNOTATIONS, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, parseTokenExpiration, verifyGitHubWebhookSignature };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.58.0-alpha.1",
+  "version": "1.58.0-alpha.3",
   "description": "A TypeScript client for the GitHub REST API",
   "keywords": [
     "github",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/http-client": "^1.58.0-alpha.1",
+    "@theholocron/http-client": "^1.58.0-alpha.3",
     "@theholocron/observability": "^0.6.1-alpha.1"
   },
   "devDependencies": {
@@ -45,8 +45,8 @@
     "tsdown": "^0.23.3",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3",
     "@theholocron/eslint-config": "^8.9.0-alpha.3",
+    "@theholocron/tsconfig": "^8.9.0-alpha.3",
     "@theholocron/tsdown-config": "^8.9.0-alpha.3",
     "@theholocron/vitest-config": "^8.9.0-alpha.3"
   },