fix: set expiresAt with token if present. Add GitHubAppAuthenticationWithExpirationEnabled, GitHubAppAuthenticationWithExpirationDisabled, GitHubAppAuthenticationWithRefreshToken types. Deprecates GitHubAppAuthentication, GitHubAppAuthenticationWithExpiration (#50)

baoshan · web-flow · commit 4d86a2def440 · 2021-10-05T14:04:31.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/check-token.ts b/src/check-token.ts
@@ -2,7 +2,11 @@ import { request as defaultRequest } from "@octokit/request";
 import { RequestInterface, Endpoints } from "@octokit/types";
 import btoa from "btoa-lite";
 
-import { OAuthAppAuthentication, GitHubAppAuthentication } from "./types";
+import {
+  OAuthAppAuthentication,
+  GitHubAppAuthenticationWithExpirationEnabled,
+  GitHubAppAuthenticationWithExpirationDisabled,
+} from "./types";
 
 export type CheckTokenOAuthAppOptions = {
   clientType: "oauth-app";
@@ -25,7 +29,9 @@ export type CheckTokenOAuthAppResponse =
   };
 export type CheckTokenGitHubAppResponse =
   Endpoints["POST /applications/{client_id}/token"]["response"] & {
-    authentication: GitHubAppAuthentication;
+    authentication:
+      | GitHubAppAuthenticationWithExpirationEnabled
+      | GitHubAppAuthenticationWithExpirationDisabled;
   };
 
 export async function checkToken(
@@ -61,6 +67,9 @@ export async function checkToken(
     scopes: response.data.scopes,
   };
 
+  if (response.data.expires_at)
+    authentication.expiresAt = response.data.expires_at;
+
   if (options.clientType === "github-app") {
     delete authentication.scopes;
   }
diff --git a/src/exchange-device-code.ts b/src/exchange-device-code.ts
@@ -3,8 +3,9 @@ import { OctokitResponse, RequestInterface } from "@octokit/types";
 
 import {
   OAuthAppAuthentication,
-  GitHubAppAuthentication,
-  GitHubAppAuthenticationWithExpiration,
+  GitHubAppAuthenticationWithExpirationEnabled,
+  GitHubAppAuthenticationWithExpirationDisabled,
+  GitHubAppAuthenticationWithRefreshToken,
   OAuthAppCreateTokenResponseData,
   GitHubAppCreateTokenResponseData,
   GitHubAppCreateTokenWithExpirationResponseData,
@@ -43,11 +44,12 @@ type OAuthAppAuthenticationWithoutClientSecret = Omit<
   "clientSecret"
 >;
 type GitHubAppAuthenticationWithoutClientSecret = Omit<
-  GitHubAppAuthentication,
+  | GitHubAppAuthenticationWithExpirationEnabled
+  | GitHubAppAuthenticationWithExpirationDisabled,
   "clientSecret"
 >;
 type GitHubAppAuthenticationWithExpirationWithoutClientSecret = Omit<
-  GitHubAppAuthenticationWithExpiration,
+  GitHubAppAuthenticationWithRefreshToken,
   "clientSecret"
 >;
 
@@ -66,8 +68,9 @@ export type ExchangeDeviceCodeGitHubAppResponse = OctokitResponse<
   | GitHubAppCreateTokenWithExpirationResponseData
 > & {
   authentication:
-    | GitHubAppAuthentication
-    | GitHubAppAuthenticationWithExpiration;
+    | GitHubAppAuthenticationWithExpirationEnabled
+    | GitHubAppAuthenticationWithExpirationDisabled
+    | GitHubAppAuthenticationWithRefreshToken;
 };
 
 export type ExchangeDeviceCodeGitHubAppResponseWithoutClientSecret =
diff --git a/src/exchange-web-flow-code.ts b/src/exchange-web-flow-code.ts
@@ -3,8 +3,9 @@ import { OctokitResponse, RequestInterface } from "@octokit/types";
 
 import {
   OAuthAppAuthentication,
-  GitHubAppAuthentication,
-  GitHubAppAuthenticationWithExpiration,
+  GitHubAppAuthenticationWithExpirationEnabled,
+  GitHubAppAuthenticationWithExpirationDisabled,
+  GitHubAppAuthenticationWithRefreshToken,
   OAuthAppCreateTokenResponseData,
   GitHubAppCreateTokenResponseData,
   GitHubAppCreateTokenWithExpirationResponseData,
@@ -39,8 +40,9 @@ export type ExchangeWebFlowCodeGitHubAppResponse = OctokitResponse<
   | GitHubAppCreateTokenWithExpirationResponseData
 > & {
   authentication:
-    | GitHubAppAuthentication
-    | GitHubAppAuthenticationWithExpiration;
+    | GitHubAppAuthenticationWithExpirationEnabled
+    | GitHubAppAuthenticationWithExpirationDisabled
+    | GitHubAppAuthenticationWithRefreshToken;
 };
 
 /**
diff --git a/src/index.ts b/src/index.ts
@@ -11,6 +11,9 @@ export * from "./delete-token";
 export * from "./delete-authorization";
 export {
   OAuthAppAuthentication,
+  GitHubAppAuthenticationWithExpirationDisabled,
+  GitHubAppAuthenticationWithExpirationEnabled,
+  GitHubAppAuthenticationWithRefreshToken,
   GitHubAppAuthentication,
   GitHubAppAuthenticationWithExpiration,
 } from "./types";
diff --git a/src/refresh-token.ts b/src/refresh-token.ts
@@ -2,7 +2,7 @@ import { request as defaultRequest } from "@octokit/request";
 import { OctokitResponse, RequestInterface } from "@octokit/types";
 
 import {
-  GitHubAppAuthenticationWithExpiration,
+  GitHubAppAuthenticationWithRefreshToken,
   GitHubAppCreateTokenWithExpirationResponseData,
 } from "./types";
 import { oauthRequest } from "./utils";
@@ -17,7 +17,7 @@ export type RefreshTokenOptions = {
 
 export type RefreshTokenResponse =
   OctokitResponse<GitHubAppCreateTokenWithExpirationResponseData> & {
-    authentication: GitHubAppAuthenticationWithExpiration;
+    authentication: GitHubAppAuthenticationWithRefreshToken;
   };
 
 export async function refreshToken(
@@ -40,7 +40,7 @@ export async function refreshToken(
   );
 
   const apiTimeInMs = new Date(response.headers.date as string).getTime();
-  const authentication: GitHubAppAuthenticationWithExpiration = {
+  const authentication: GitHubAppAuthenticationWithRefreshToken = {
     clientType: "github-app",
     clientId: options.clientId,
     clientSecret: options.clientSecret,
diff --git a/src/reset-token.ts b/src/reset-token.ts
@@ -2,7 +2,11 @@ import { request as defaultRequest } from "@octokit/request";
 import { RequestInterface, Endpoints } from "@octokit/types";
 import btoa from "btoa-lite";
 
-import { OAuthAppAuthentication, GitHubAppAuthentication } from "./types";
+import {
+  OAuthAppAuthentication,
+  GitHubAppAuthenticationWithExpirationEnabled,
+  GitHubAppAuthenticationWithExpirationDisabled,
+} from "./types";
 
 export type ResetTokenOAuthAppOptions = {
   clientType: "oauth-app";
@@ -25,7 +29,9 @@ export type ResetTokenOAuthAppResponse =
   };
 export type ResetTokenGitHubAppResponse =
   Endpoints["PATCH /applications/{client_id}/token"]["response"] & {
-    authentication: GitHubAppAuthentication;
+    authentication:
+      | GitHubAppAuthenticationWithExpirationEnabled
+      | GitHubAppAuthenticationWithExpirationDisabled;
   };
 
 export async function resetToken(
@@ -60,6 +66,9 @@ export async function resetToken(
     scopes: response.data.scopes,
   };
 
+  if (response.data.expires_at)
+    authentication.expiresAt = response.data.expires_at;
+
   if (options.clientType === "github-app") {
     delete authentication.scopes;
   }
diff --git a/src/scope-token.ts b/src/scope-token.ts
@@ -2,7 +2,10 @@ import { request as defaultRequest } from "@octokit/request";
 import { RequestInterface, Endpoints } from "@octokit/types";
 import btoa from "btoa-lite";
 
-import { GitHubAppAuthentication } from "./types";
+import {
+  GitHubAppAuthenticationWithExpirationEnabled,
+  GitHubAppAuthenticationWithExpirationDisabled,
+} from "./types";
 
 type CommonOptions = {
   clientType: "github-app";
@@ -35,7 +38,9 @@ export type ScopeTokenOptions =
   | (CommonOptions & TargetIdOption & RepositoryIdsOption);
 
 export type ScopeTokenResponse = Endpoint["response"] & {
-  authentication: GitHubAppAuthentication;
+  authentication:
+    | GitHubAppAuthenticationWithExpirationEnabled
+    | GitHubAppAuthenticationWithExpirationDisabled;
 };
 
 export async function scopeToken(
@@ -62,12 +67,17 @@ export async function scopeToken(
     ...requestOptions,
   });
 
-  const authentication: GitHubAppAuthentication = {
-    clientType,
-    clientId,
-    clientSecret,
-    token: response.data.token,
-  };
+  const authentication:
+    | GitHubAppAuthenticationWithExpirationEnabled
+    | GitHubAppAuthenticationWithExpirationDisabled = Object.assign(
+    {
+      clientType,
+      clientId,
+      clientSecret,
+      token: response.data.token,
+    },
+    response.data.expires_at ? { expiresAt: response.data.expires_at } : {}
+  );
 
   return { ...response, authentication };
 }
diff --git a/src/types.ts b/src/types.ts
@@ -6,13 +6,36 @@ export type OAuthAppAuthentication = {
   scopes: string[];
 };
 
+export type GitHubAppAuthenticationWithExpirationDisabled = {
+  clientType: "github-app";
+  clientId: string;
+  clientSecret: string;
+  token: string;
+};
+
+export type GitHubAppAuthenticationWithExpirationEnabled =
+  GitHubAppAuthenticationWithExpirationDisabled & { expiresAt: string };
+
+export type GitHubAppAuthenticationWithRefreshToken =
+  GitHubAppAuthenticationWithExpirationEnabled & {
+    refreshToken: string;
+    refreshTokenExpiresAt: string;
+  };
+
+/**
+ * @deprecated Use `GitHubAppAuthenticationWithExpirationDisabled` or
+ * `GitHubAppAuthenticationWithExpirationEnabled` instead.
+ */
 export type GitHubAppAuthentication = {
   clientType: "github-app";
   clientId: string;
   clientSecret: string;
   token: string;
 };
 
+/**
+ * @deprecated Use `GitHubAppAuthenticationWithRefreshToken` instead.
+ */
 export type GitHubAppAuthenticationWithExpiration = {
   clientType: "github-app";
   clientId: string;
diff --git a/test/check-token.test.ts b/test/check-token.test.ts
@@ -62,6 +62,7 @@ describe("checkToken()", () => {
     const mock = fetchMock.sandbox().postOnce(
       "https://api.github.com/applications/lv1.1234567890abcdef/token",
       {
+        expires_at: "2021-10-06T17:26:27Z",
         scopes: [],
       },
       {
@@ -95,6 +96,7 @@ describe("checkToken()", () => {
 
     expect(data).toMatchInlineSnapshot(`
       Object {
+        "expires_at": "2021-10-06T17:26:27Z",
         "scopes": Array [],
       }
     `);
@@ -103,6 +105,7 @@ describe("checkToken()", () => {
         "clientId": "lv1.1234567890abcdef",
         "clientSecret": "1234567890abcdef12347890abcdef12345678",
         "clientType": "github-app",
+        "expiresAt": "2021-10-06T17:26:27Z",
         "token": "token123",
       }
     `);
diff --git a/test/reset-token.test.ts b/test/reset-token.test.ts
@@ -64,6 +64,7 @@ describe("resetToken()", () => {
     const mock = fetchMock.sandbox().patchOnce(
       "https://api.github.com/applications/lv1.1234567890abcdef/token",
       {
+        expires_at: "2021-10-06T17:26:27Z",
         scopes: [],
         token: "token456",
       },
@@ -98,6 +99,7 @@ describe("resetToken()", () => {
 
     expect(data).toMatchInlineSnapshot(`
       Object {
+        "expires_at": "2021-10-06T17:26:27Z",
         "scopes": Array [],
         "token": "token456",
       }
@@ -107,6 +109,7 @@ describe("resetToken()", () => {
         "clientId": "lv1.1234567890abcdef",
         "clientSecret": "1234567890abcdef12347890abcdef12345678",
         "clientType": "github-app",
+        "expiresAt": "2021-10-06T17:26:27Z",
         "token": "token456",
       }
     `);
diff --git a/test/scope-token.test.ts b/test/scope-token.test.ts
@@ -68,4 +68,60 @@ describe("scopeToken()", () => {
       }
     `);
   });
+
+  it("passes `expires_at` through", async () => {
+    const mock = fetchMock
+      .sandbox()
+      .postOnce(
+        "https://api.github.com/applications/lv1.1234567890abcdef/token/scoped",
+        {
+          account: {
+            login: "octokit",
+            id: 1,
+          },
+          expires_at: "2021-10-06T17:26:27Z",
+          token: "usertoken456",
+        }
+      );
+
+    const { data, authentication } = await scopeToken({
+      clientType: "github-app",
+      clientId: "lv1.1234567890abcdef",
+      clientSecret: "1234567890abcdef12347890abcdef12345678",
+      token: "usertoken123",
+      target: "octokit",
+      repositories: ["oauth-methods.js"],
+      permissions: {
+        issues: "write",
+      },
+      request: request.defaults({
+        headers: {
+          "user-agent": "test",
+        },
+        request: {
+          fetch: mock,
+        },
+      }),
+    });
+
+    expect(data).toMatchInlineSnapshot(`
+      Object {
+        "account": Object {
+          "id": 1,
+          "login": "octokit",
+        },
+        "expires_at": "2021-10-06T17:26:27Z",
+        "token": "usertoken456",
+      }
+    `);
+    expect(authentication).toMatchInlineSnapshot(`
+      Object {
+        "clientId": "lv1.1234567890abcdef",
+        "clientSecret": "1234567890abcdef12347890abcdef12345678",
+        "clientType": "github-app",
+        "expiresAt": "2021-10-06T17:26:27Z",
+        "token": "usertoken456",
+      }
+    `);
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ describe("checkToken()", () => {`
`62`	`62`	`const mock = fetchMock.sandbox().postOnce(`
`63`	`63`	`"https://api.github.com/applications/lv1.1234567890abcdef/token",`
`64`	`64`	`{`
	`65`	`+ expires_at: "2021-10-06T17:26:27Z",`
`65`	`66`	`scopes: [],`
`66`	`67`	`},`
`67`	`68`	`{`
`@@ -95,6 +96,7 @@ describe("checkToken()", () => {`
`95`	`96`
`96`	`97`	expect(data).toMatchInlineSnapshot(`
`97`	`98`	`Object {`
	`99`	`+ "expires_at": "2021-10-06T17:26:27Z",`
`98`	`100`	`"scopes": Array [],`
`99`	`101`	`}`
`100`	`102`	`);
`@@ -103,6 +105,7 @@ describe("checkToken()", () => {`
`103`	`105`	`"clientId": "lv1.1234567890abcdef",`
`104`	`106`	`"clientSecret": "1234567890abcdef12347890abcdef12345678",`
`105`	`107`	`"clientType": "github-app",`
	`108`	`+ "expiresAt": "2021-10-06T17:26:27Z",`
`106`	`109`	`"token": "token123",`
`107`	`110`	`}`
`108`	`111`	`);