@theholocron/github-client 1.50.0 → 1.51.0

package/dist/index.d.mts

@@ -391,6 +391,29 @@ interface TeamMember {
   type?: string;
 }
 //#endregion
+//#region ../../../../../src/variables/variables.d.ts
+type VariableScope = {
+  kind: "repo";
+} | {
+  kind: "environment";
+  name: string;
+} | {
+  kind: "organization";
+  org: string;
+};
+/**
+ * Which repositories of an organization can read a variable. Only organization variables have one. This client does
+ * not read or set the repositories behind `"selected"`; use `"all"` or `"private"` where the access has to be reconciled.
+ */
+type VariableVisibility = "all" | "private" | "selected";
+/** A GitHub Actions variable. Unlike a secret its value is readable, so a reconcile can tell whether it differs. */
+interface GitHubVariable {
+  name: string;
+  value: string;
+  /** Present on organization variables only. */
+  visibility?: VariableVisibility;
+}
+//#endregion
 //#region ../../../../../src/user/user.d.ts
 interface GitHubUser {
   login: string;
@@ -617,6 +640,13 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
   topics: {
     setTopics: (repo: string, names: string[]) => Promise<void>;
   };
+  variables: {
+    listVariables: (repo: string, scope: VariableScope) => Promise<GitHubVariable[]>;
+    getVariable: (repo: string, scope: VariableScope, name: string) => Promise<GitHubVariable | null>;
+    createVariable: (repo: string, scope: VariableScope, body: Record<string, unknown>) => Promise<void>;
+    updateVariable: (repo: string, scope: VariableScope, name: string, body: Record<string, unknown>) => Promise<void>;
+    deleteVariable: (repo: string, scope: VariableScope, name: string) => Promise<void>;
+  };
   user: {
     getCurrentUser: () => Promise<GitHubUser>;
   };
@@ -628,4 +658,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, MAX_CHECK_RUN_ANNOTATIONS, type PagesBuildStatus, type PagesBuildType, type PutContentsInput, type PutContentsResult, type ReviewThread, type SecretScope, type TeamMember, 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 GitHubVariable, 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 PutContentsInput, type PutContentsResult, type ReviewThread, type SecretScope, type TeamMember, type TeamPermission, type UpdateCheckRunInput, type UpdatePagesPayload, type VariableScope, type VariableVisibility, type WorkflowRunFilter, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };

package/dist/index.mjs

@@ -417,7 +417,7 @@ function rulesets(rest) {
 }
 //#endregion
 //#region ../../../../../src/secrets/secrets.ts
-function scopeBase(repo, scope) {
+function scopeBase$1(repo, scope) {
 	switch (scope.kind) {
 		case "repo": return `${repoBase(repo)}/actions`;
 		case "environment": return `${repoBase(repo)}/environments/${scope.name}`;
@@ -426,14 +426,14 @@ function scopeBase(repo, scope) {
 }
 function secrets(rest) {
 	return {
-		listSecrets: (repo, scope) => rest.request(`${scopeBase(repo, scope)}/secrets`).then((r) => r.secrets.map((s) => s.name)),
-		getPublicKey: (repo, scope) => rest.request(`${scopeBase(repo, scope)}/secrets/public-key`),
-		putSecret: (repo, scope, name, body) => rest.request(`${scopeBase(repo, scope)}/secrets/${name}`, {
+		listSecrets: (repo, scope) => rest.request(`${scopeBase$1(repo, scope)}/secrets`).then((r) => r.secrets.map((s) => s.name)),
+		getPublicKey: (repo, scope) => rest.request(`${scopeBase$1(repo, scope)}/secrets/public-key`),
+		putSecret: (repo, scope, name, body) => rest.request(`${scopeBase$1(repo, scope)}/secrets/${name}`, {
 			method: "PUT",
 			body,
 			expectNoContent: true
 		}),
-		deleteSecret: (repo, scope, name) => rest.request(`${scopeBase(repo, scope)}/secrets/${name}`, {
+		deleteSecret: (repo, scope, name) => rest.request(`${scopeBase$1(repo, scope)}/secrets/${name}`, {
 			method: "DELETE",
 			expectNoContent: true
 		})
@@ -487,9 +487,9 @@ function security(rest) {
 }
 //#endregion
 //#region ../../../../../src/teams/teams.ts
-const PAGE = 100;
+const PAGE$1 = 100;
 /** A guard so a runaway listing cannot loop forever: 50 pages of 100 is far more than any team. */
-const MAX_PAGES = 50;
+const MAX_PAGES$1 = 50;
 function teams(rest) {
 	return {
 		/**
@@ -499,14 +499,14 @@ function teams(rest) {
 		members: async (org, teamSlug) => {
 			const path = `/orgs/${segment(org)}/teams/${segment(teamSlug)}/members`;
 			const read = (page) => rest.request(path, { query: {
-				per_page: String(PAGE),
+				per_page: String(PAGE$1),
 				page: String(page)
 			} });
 			const all = [];
-			for (let page = 1; page <= MAX_PAGES; page++) {
+			for (let page = 1; page <= MAX_PAGES$1; page++) {
 				const batch = await read(page);
 				all.push(...batch);
-				if (batch.length < PAGE) return all;
+				if (batch.length < PAGE$1) return all;
 			}
 			if ((await read(51)).length > 0) throw new Error(`team ${org}/${teamSlug} has more than 5000 members; refusing to read them all`);
 			return all;
@@ -531,6 +531,69 @@ function user(rest) {
 	return { getCurrentUser: () => rest.request("/user") };
 }
 //#endregion
+//#region ../../../../../src/variables/variables.ts
+/** GitHub's maximum page size for this listing is 30, not the usual 100. */
+const PAGE = 30;
+/** A guard so a runaway listing cannot loop forever: 100 pages of 30 is more than GitHub allows. */
+const MAX_PAGES = 100;
+/** `/repos/owner/name`, refusing anything but exactly two safe segments, so a caller's `repo` cannot address another resource. */
+function repoPath(repo) {
+	const parts = repo.split("/");
+	if (parts.length !== 2) throw new Error(`invalid repository: ${JSON.stringify(repo)} (expected "owner/name")`);
+	return `/repos/${parts.map(segment).join("/")}`;
+}
+function scopeBase(repo, scope) {
+	switch (scope.kind) {
+		case "repo": return `${repoPath(repo)}/actions/variables`;
+		case "environment": return `${repoPath(repo)}/environments/${segment(scope.name)}/variables`;
+		case "organization": return `/orgs/${segment(scope.org)}/actions/variables`;
+	}
+}
+function variables(rest) {
+	return {
+		/** Every variable in the scope, read page by page, with its value. */
+		listVariables: async (repo, scope) => {
+			const path = scopeBase(repo, scope);
+			const all = [];
+			for (let page = 1; page <= MAX_PAGES; page++) {
+				const batch = await rest.request(path, { query: {
+					per_page: String(PAGE),
+					page: String(page)
+				} });
+				all.push(...batch.variables);
+				if (batch.variables.length < PAGE || all.length >= batch.total_count) return all;
+			}
+			throw new Error(`more than 3000 variables in ${path}; refusing to read them all`);
+		},
+		/** One variable, or `null` when the scope has none of that name. */
+		getVariable: async (repo, scope, name) => {
+			try {
+				return await rest.request(`${scopeBase(repo, scope)}/${segment(name)}`);
+			} catch (err) {
+				if (err instanceof ProviderApiError && err.status === 404) return null;
+				throw err;
+			}
+		},
+		createVariable: (repo, scope, body) => rest.request(scopeBase(repo, scope), {
+			method: "POST",
+			body,
+			expectNoContent: true
+		}),
+		updateVariable: async (repo, scope, name, body) => rest.request(`${scopeBase(repo, scope)}/${segment(name)}`, {
+			method: "PATCH",
+			body: {
+				name,
+				...body
+			},
+			expectNoContent: true
+		}),
+		deleteVariable: async (repo, scope, name) => rest.request(`${scopeBase(repo, scope)}/${segment(name)}`, {
+			method: "DELETE",
+			expectNoContent: true
+		})
+	};
+}
+//#endregion
 //#region ../../../../../src/workflows/workflows.ts
 function workflows(rest) {
 	return {
@@ -787,6 +850,7 @@ function createGitHubClient(opts) {
 		security: security(rest),
 		teams: teams(rest),
 		topics: topics(rest),
+		variables: variables(rest),
 		user: user(rest),
 		workflows: workflows(rest)
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.50.0",
+  "version": "1.51.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.50.0"
+    "@theholocron/http-client": "^1.51.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",