@theholocron/github-client 1.5.5 → 1.6.0

package/README.md

@@ -5,7 +5,7 @@ TypeScript client for the GitHub REST API, built on `@theholocron/http-client`.
 ## Install
 
 ```bash
-npm i @theholocron/github-client
+pnpm add @theholocron/github-client
 ```
 
 ## Usage

package/dist/index.d.mts

@@ -113,6 +113,36 @@ interface GitHubLabel {
   description: string | null;
 }
 //#endregion
+//#region src/pages/pages.d.ts
+type PagesBuildType = "workflow" | "legacy";
+interface GitHubPages {
+  status: "built" | "building" | "errored" | "unknown" | null;
+  build_type: PagesBuildType | null;
+  source?: {
+    branch: string;
+    path: string;
+  };
+  https_enforced: boolean;
+  custom_domain: string | null;
+}
+interface CreatePagesPayload {
+  build_type: PagesBuildType;
+  /** Required when build_type is "legacy". */
+  source?: {
+    branch: string;
+    path: string;
+  };
+}
+interface UpdatePagesPayload {
+  build_type?: PagesBuildType;
+  source?: {
+    branch: string;
+    path: string;
+  };
+  cname?: string | null;
+  https_enforced?: boolean;
+}
+//#endregion
 //#region src/repos/repos.d.ts
 interface GitHubRepo {
   default_branch: string;
@@ -232,6 +262,11 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
     }) => Promise<GitHubLabel>;
     deleteLabel: (repo: string, name: string) => Promise<void>;
   };
+  pages: {
+    getPages: (repo: string) => Promise<GitHubPages | null>;
+    createPages: (repo: string, payload: CreatePagesPayload) => Promise<GitHubPages>;
+    updatePages: (repo: string, payload: UpdatePagesPayload) => Promise<void>;
+  };
   properties: {
     setProperties: (repo: string, values: Record<string, string>) => Promise<void>;
   };
@@ -276,4 +311,4 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
 };
 type GitHubClient = ReturnType<typeof createGitHubClient>;
 //#endregion
-export { type CodeScanningSetupResult, type CreatePullInput, type GitBlob, type GitCommit, type GitContents, GitHubClient, type GitHubClientOptions, type GitHubContents, type GitHubEnvironment, type GitHubIssue, type GitHubLabel, type GitHubMilestone, type GitHubPublicKey, type GitHubRepo, type GitHubRuleset, type GitHubUser, type GitHubWorkflowRun, type GitPull, type GitRef, type GitTree, type GitTreeItem, type IssueSearchParams, type SecretScope, type TeamPermission, type WorkflowRunFilter, createGitHubClient };
+export { type CodeScanningSetupResult, type CreatePagesPayload, type CreatePullInput, type GitBlob, type GitCommit, type GitContents, GitHubClient, type GitHubClientOptions, type GitHubContents, type GitHubEnvironment, type GitHubIssue, type GitHubLabel, type GitHubMilestone, type GitHubPages, type GitHubPublicKey, type GitHubRepo, type GitHubRuleset, type GitHubUser, type GitHubWorkflowRun, type GitPull, type GitRef, type GitTree, type GitTreeItem, type IssueSearchParams, type PagesBuildType, type SecretScope, type TeamPermission, type UpdatePagesPayload, type WorkflowRunFilter, createGitHubClient };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { createRestClient } from "@theholocron/http-client";
+import { ProviderApiError, createRestClient } from "@theholocron/http-client";
 //#region src/utils.ts
 function createGitHubRestClient(opts) {
 	return createRestClient({
@@ -148,6 +148,38 @@ function labels(rest) {
 	};
 }
 //#endregion
+//#region src/pages/pages.ts
+function pages(rest) {
+	return {
+		/** Returns null when Pages is not yet enabled (404). */
+		getPages: async (repo) => {
+			try {
+				return await rest.request(`${repoBase(repo)}/pages`);
+			} catch (err) {
+				if (err instanceof ProviderApiError && err.status === 404) return null;
+				throw err;
+			}
+		},
+		/**
+		* Enables Pages for the first time.
+		* Throws on all errors except 409 Conflict (already enabled — callers
+		* should catch that and fall through to updatePages).
+		*/
+		createPages: (repo, payload) => rest.request(`${repoBase(repo)}/pages`, {
+			method: "POST",
+			body: payload
+		}),
+		/**
+		* Updates Pages settings on an existing site (build type, cname, https).
+		* GitHub returns 204 No Content.
+		*/
+		updatePages: (repo, payload) => rest.request(`${repoBase(repo)}/pages`, {
+			method: "PUT",
+			body: payload
+		})
+	};
+}
+//#endregion
 //#region src/properties/properties.ts
 function properties(rest) {
 	return { setProperties: (repo, values) => {
@@ -305,6 +337,7 @@ function createGitHubClient(opts) {
 		git: git(rest),
 		issues: issues(rest),
 		labels: labels(rest),
+		pages: pages(rest),
 		properties: properties(rest),
 		repos: repos(rest),
 		rulesets: rulesets(rest),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.5.5",
+  "version": "1.6.0",
   "description": "A TypeScript client for the GitHub REST API",
   "homepage": "https://github.com/theholocron/clients/tree/main/packages/github-client#readme",
   "bugs": "https://github.com/theholocron/clients/issues",
@@ -30,7 +30,7 @@
     }
   },
   "dependencies": {
-    "@theholocron/http-client": "^1.5.5"
+    "@theholocron/http-client": "^1.6.0"
   },
   "devDependencies": {
     "@types/node": "^26.1.2",