@theholocron/github-client 1.57.1-alpha.1 → 1.57.1-alpha.2

package/dist/index.d.mts

@@ -226,6 +226,15 @@ interface UpdatePagesPayload {
   cname?: string | null;
   https_enforced?: boolean;
 }
+/** One custom property of an organization, as its schema defines it. */
+interface OrgProperty {
+  property_name: string;
+  /** `string`, `single_select`, `multi_select`, `true_false` or `url`. */
+  value_type: string;
+  required?: boolean;
+  /** The values a `single_select` or `multi_select` property accepts; `null` for any other type. */
+  allowed_values?: string[] | null;
+}
 interface GitHubPullRequest {
   number: number;
   title: string;
@@ -561,6 +570,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
     updatePages: (repo: string, payload: UpdatePagesPayload) => Promise<void>;
   };
   properties: {
+    orgSchema: (org: string) => Promise<OrgProperty[]>;
     setProperties: (repo: string, values: Record<string, string | string[]>) => Promise<void>;
   };
   pulls: {
@@ -620,4 +630,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, 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, GitHubUser, GitHubVariable, GitHubWebhookHeaders, GitHubWorkflowRun, GitPull, GitRef, GitTree, GitTreeItem, InstallationAccessToken, IssueSearchParams, OrgProperty, PagesBuildStatus, PagesBuildType, PutContentsInput, PutContentsResult, ReviewThread, SecretScope, TeamMember, TeamPermission, UpdateCheckRunInput, UpdatePagesPayload, VariableScope, VariableVisibility, WorkflowRunFilter };

package/dist/index.mjs

@@ -275,25 +275,31 @@ function pages(rest) {
 }
 // src/properties/properties.ts
 function properties(rest) {
-	return { 
-	/**
-	* `value` is a plain string for `string`/`single_select`/`true_false`
-	* custom properties, or a string array for `multi_select` ones —
-	* GitHub's own PATCH body accepts either per property. A single-string
-	* comma-joined value has no length ceiling GitHub documents, but real
-	* usage hits one in practice (a `string`-type property with enough
-	* joined values 422s as "too long"); `multi_select` has none.
-	*/
-setProperties: (repo, values) => {
-		const propertyList = Object.entries(values).map(([property_name, value]) => ({
-			property_name,
-			value
-		}));
-		return rest.request(`${repoBase(repo)}/properties/values`, {
-			method: "PATCH",
-			body: { properties: propertyList }
-		});
-	} };
+	return {
+		/**
+		* 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.
+		*/
+		orgSchema: (org) => rest.request(`/orgs/${segment(org)}/properties/schema`),
+		/**
+		* `value` is a plain string for `string`/`single_select`/`true_false`
+		* custom properties, or a string array for `multi_select` ones —
+		* GitHub's own PATCH body accepts either per property. A single-string
+		* comma-joined value has no length ceiling GitHub documents, but real
+		* usage hits one in practice (a `string`-type property with enough
+		* joined values 422s as "too long"); `multi_select` has none.
+		*/
+		setProperties: (repo, values) => {
+			const propertyList = Object.entries(values).map(([property_name, value]) => ({
+				property_name,
+				value
+			}));
+			return rest.request(`${repoBase(repo)}/properties/values`, {
+				method: "PATCH",
+				body: { properties: propertyList }
+			});
+		}
+	};
 }
 // src/pulls/pulls.ts
 const LIST_REVIEW_THREADS_QUERY = `

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.57.1-alpha.1",
+  "version": "1.57.1-alpha.2",
   "description": "A TypeScript client for the GitHub REST API",
   "keywords": [
     "github",
@@ -32,14 +32,10 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/observability": "^0.6.0",
-    "@theholocron/http-client": "^1.57.1-alpha.1"
+    "@theholocron/http-client": "^1.57.1-alpha.2",
+    "@theholocron/observability": "^0.6.1-alpha.1"
   },
   "devDependencies": {
-    "@theholocron/eslint-config": "^8.8.2",
-    "@theholocron/tsconfig": "^8.8.2",
-    "@theholocron/tsdown-config": "^8.8.2",
-    "@theholocron/vitest-config": "^8.8.2",
     "@types/node": "^26",
     "@vitest/coverage-v8": "^5.0.5",
     "@vitest/eslint-plugin": "^1.6.27",
@@ -48,7 +44,11 @@
     "globals": "^17.11.0",
     "tsdown": "^0.23.3",
     "typescript": "^5.9.3",
-    "vitest": "^5.0.5"
+    "vitest": "^5.0.5",
+    "@theholocron/tsconfig": "^8.9.0-alpha.3",
+    "@theholocron/eslint-config": "^8.9.0-alpha.3",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.3",
+    "@theholocron/vitest-config": "^8.9.0-alpha.3"
   },
   "engines": {
     "node": ">=22.0.0"