feat(types): optional refresh token for GitHub Apps (#494)

octokit · Jan 22, 2024 · 01076fe · 01076fe
1 parent 9abb4a7
commit 01076fe
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 17 deletions.
diff --git a/src/methods/create-token.ts b/src/methods/create-token.ts
@@ -1,6 +1,10 @@
 import * as OAuthAppAuth from "@octokit/auth-oauth-app";
 
-import type { ClientType, State } from "../types.js";
+import type {
+  ClientType,
+  GithubAppUserAuthenticationWithOptionalExpiration,
+  State,
+} from "../types.js";
 import { emitEvent } from "../emit-event.js";
 
 export type CreateTokenWebFlowOptions = Omit<
@@ -61,12 +65,9 @@ export interface CreateTokenInterface<TClientType extends ClientType> {
   // web flow
   (options: CreateTokenWebFlowOptions): TClientType extends "oauth-app"
     ? Promise<{ authentication: OAuthAppAuth.OAuthAppUserAuthentication }>
-    : Promise<
-        | { authentication: OAuthAppAuth.GitHubAppUserAuthentication }
-        | {
-            authentication: OAuthAppAuth.GitHubAppUserAuthenticationWithExpiration;
-          }
-      >;
+    : Promise<{
+        authentication: GithubAppUserAuthenticationWithOptionalExpiration;
+      }>;
 
   // device flow
   (
@@ -75,10 +76,7 @@ export interface CreateTokenInterface<TClientType extends ClientType> {
       : CreateTokenGitHubAppDeviceFlowOptions,
   ): TClientType extends "oauth-app"
     ? Promise<{ authentication: OAuthAppAuth.OAuthAppUserAuthentication }>
-    : Promise<
-        | { authentication: OAuthAppAuth.GitHubAppUserAuthentication }
-        | {
-            authentication: OAuthAppAuth.GitHubAppUserAuthenticationWithExpiration;
-          }
-      >;
+    : Promise<{
+        authentication: GithubAppUserAuthenticationWithOptionalExpiration;
+      }>;
 }
diff --git a/src/types.ts b/src/types.ts
@@ -9,12 +9,15 @@ import { OAuthAppOctokit } from "./oauth-app-octokit";
 
 export type ClientType = "oauth-app" | "github-app";
 export type OAuthAppOctokitClassType = typeof OAuthAppOctokit;
-
+export type GithubAppUserAuthenticationWithOptionalExpiration =
+  GitHubAppUserAuthentication &
+    Partial<GitHubAppUserAuthenticationWithExpiration>;
 export type Scope = string;
 export type ClientId = string;
 export type ClientSecret = string;
 export type Token = string;
 export type EventName = "token" | "authorization";
+
 export type ActionName =
   | "created"
   | "reset"
@@ -110,9 +113,7 @@ export type EventHandlerContext<TOptions extends Options<ClientType>> =
         action: ActionName;
         token: Token;
         octokit: OctokitTypeFromOptions<TOptions>;
-        authentication?:
-          | GitHubAppUserAuthentication
-          | GitHubAppUserAuthenticationWithExpiration;
+        authentication?: GithubAppUserAuthenticationWithOptionalExpiration;
       };
 export type EventHandler<TOptions extends Options<ClientType>> = (
   context: EventHandlerContext<TOptions>,

diff --git a/test/typescript-validate.ts b/test/typescript-validate.ts
@@ -99,6 +99,10 @@ export async function GitHubAppTest() {
   // @ts-expect-error scopes are not used by GitHub Apps
   result.scopes;
 
+  result.authentication.expiresAt;
+  result.authentication.refreshTokenExpiresAt;
+  result.authentication.refreshToken;
+
   // @ts-expect-error scopes option not permitted for GitHub Apps
   await githubApp.createToken({
     onVerification() {},