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

package/dist/index.d.mts

@@ -411,6 +411,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;
@@ -636,6 +648,7 @@ export declare function createGitHubClient(opts: GitHubClientOptions): {
   };
   user: {
     getCurrentUser: () => Promise<GitHubUser>;
+    getCurrentUserWithExpiry(): Promise<GitHubUserWithExpiry>;
   };
   workflows: {
     listRuns: (repo: string, filter?: WorkflowRunFilter) => Promise<GitHubWorkflowRun[]>;
@@ -644,4 +657,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, GitHubUser, GitHubUserWithExpiry, 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

@@ -549,8 +549,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 +894,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.2",
   "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.2",
     "@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"
   },