feat(typescript): export all the method types \o/ (#5)

Author: gr2m

README.md

@@ -25,6 +25,7 @@
   - [OAuth APP authentication](#oauth-app-authentication)
   - [GitHub App with non-expiring user authentication](#github-app-with-non-expiring-user-authentication)
   - [GitHub App with expiring user authentication](#github-app-with-expiring-user-authentication)
+- [Types](#types)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -1568,6 +1569,43 @@ import {
   OAuthAppAuthentication,
   GitHubAppAuthentication,
   GitHubAppAuthenticationWithExpiration,
+  GetWebFlowAuthorizationUrlOAuthAppOptions,
+  GetWebFlowAuthorizationUrlGitHubAppOptions,
+  GetWebFlowAuthorizationUrlOAuthAppResult,
+  GetWebFlowAuthorizationUrlGitHubAppResult,
+  CheckTokenOAuthAppOptions,
+  CheckTokenGitHubAppOptions,
+  CheckTokenOAuthAppResponse,
+  CheckTokenGitHubAppResponse,
+  ExchangeWebFlowCodeOAuthAppOptions,
+  ExchangeWebFlowCodeGitHubAppOptions,
+  ExchangeWebFlowCodeOAuthAppResponse,
+  ExchangeWebFlowCodeGitHubAppResponse,
+  CreateDeviceCodeOAuthAppOptions,
+  CreateDeviceCodeGitHubAppOptions,
+  CreateDeviceCodeDeviceTokenResponse,
+  ExchangeDeviceCodeOAuthAppOptionsWithoutClientSecret,
+  ExchangeDeviceCodeOAuthAppOptions,
+  ExchangeDeviceCodeGitHubAppOptionsWithoutClientSecret,
+  ExchangeDeviceCodeGitHubAppOptions,
+  ExchangeDeviceCodeOAuthAppResponse,
+  ExchangeDeviceCodeOAuthAppResponseWithoutClientSecret,
+  ExchangeDeviceCodeGitHubAppResponse,
+  ExchangeDeviceCodeGitHubAppResponseWithoutClientSecret,
+  RefreshTokenOptions,
+  RefreshTokenResponse,
+  ScopeTokenOptions,
+  ScopeTokenResponse,
+  ResetTokenOAuthAppOptions,
+  ResetTokenGitHubAppOptions,
+  ResetTokenOAuthAppResponse,
+  ResetTokenGitHubAppResponse,
+  DeleteTokenOAuthAppOptions,
+  DeleteTokenGitHubAppOptions,
+  DeleteTokenResponse,
+  DeleteAuthorizationOAuthAppOptions,
+  DeleteAuthorizationGitHubAppOptions,
+  DeleteAuthorizationResponse,
 } from "@octokit/oauth-methods";
 ```
 

src/check-token.ts

@@ -4,37 +4,37 @@ import btoa from "btoa-lite";
 
 import { OAuthAppAuthentication, GitHubAppAuthentication } from "./types";
 
-type OAuthAppOptions = {
+export type CheckTokenOAuthAppOptions = {
   clientType: "oauth-app";
   clientId: string;
   clientSecret: string;
   token: string;
   request?: RequestInterface;
 };
-type GitHubAppOptions = {
+export type CheckTokenGitHubAppOptions = {
   clientType: "github-app";
   clientId: string;
   clientSecret: string;
   token: string;
   request?: RequestInterface;
 };
 
-type OAuthAppResult = Endpoints["POST /applications/{client_id}/token"]["response"] & {
+export type CheckTokenOAuthAppResponse = Endpoints["POST /applications/{client_id}/token"]["response"] & {
   authentication: OAuthAppAuthentication;
 };
-type GitHubAppResult = Endpoints["POST /applications/{client_id}/token"]["response"] & {
+export type CheckTokenGitHubAppResponse = Endpoints["POST /applications/{client_id}/token"]["response"] & {
   authentication: GitHubAppAuthentication;
 };
 
 export async function checkToken(
-  options: OAuthAppOptions
-): Promise<OAuthAppResult>;
+  options: CheckTokenOAuthAppOptions
+): Promise<CheckTokenOAuthAppResponse>;
 export async function checkToken(
-  options: GitHubAppOptions
-): Promise<GitHubAppResult>;
+  options: CheckTokenGitHubAppOptions
+): Promise<CheckTokenGitHubAppResponse>;
 
 export async function checkToken(
-  options: OAuthAppOptions | GitHubAppOptions
+  options: CheckTokenOAuthAppOptions | CheckTokenGitHubAppOptions
 ): Promise<any> {
   const request =
     options.request ||

src/create-device-code.ts

@@ -3,29 +3,29 @@ import { OctokitResponse, RequestInterface } from "@octokit/types";
 
 import { oauthRequest } from "./utils";
 
-type OAuthAppOptions = {
+export type CreateDeviceCodeOAuthAppOptions = {
   clientType: "oauth-app";
   clientId: string;
   scopes?: string[];
   request?: RequestInterface;
 };
-type GitHubAppOptions = {
+export type CreateDeviceCodeGitHubAppOptions = {
   clientType: "github-app";
   clientId: string;
   request?: RequestInterface;
 };
 
-type DeviceTokenResponse = {
+export type CreateDeviceCodeDeviceTokenResponse = OctokitResponse<{
   device_code: string;
   user_code: string;
   verification_uri: string;
   expires_in: number;
   interval: number;
-};
+}>;
 
 export async function createDeviceCode(
-  options: OAuthAppOptions | GitHubAppOptions
-): Promise<OctokitResponse<DeviceTokenResponse>> {
+  options: CreateDeviceCodeOAuthAppOptions | CreateDeviceCodeGitHubAppOptions
+): Promise<CreateDeviceCodeDeviceTokenResponse> {
   const request =
     options.request ||
     /* istanbul ignore next: we always pass a custom request in tests */

src/delete-authorization.ts

@@ -2,30 +2,33 @@ import { request as defaultRequest } from "@octokit/request";
 import { RequestInterface, Endpoints } from "@octokit/types";
 import btoa from "btoa-lite";
 
-type OAuthAppOptions = {
+export type DeleteAuthorizationOAuthAppOptions = {
   clientType: "oauth-app";
   clientId: string;
   clientSecret: string;
   token: string;
   request?: RequestInterface;
 };
-type GitHubAppOptions = {
+export type DeleteAuthorizationGitHubAppOptions = {
   clientType: "github-app";
   clientId: string;
   clientSecret: string;
   token: string;
   request?: RequestInterface;
 };
+export type DeleteAuthorizationResponse = Endpoints["DELETE /applications/{client_id}/grant"]["response"];
 
 export async function deleteAuthorization(
-  options: OAuthAppOptions
-): Promise<Endpoints["DELETE /applications/{client_id}/grant"]["response"]>;
+  options: DeleteAuthorizationOAuthAppOptions
+): Promise<DeleteAuthorizationResponse>;
 export async function deleteAuthorization(
-  options: GitHubAppOptions
-): Promise<Endpoints["DELETE /applications/{client_id}/grant"]["response"]>;
+  options: DeleteAuthorizationGitHubAppOptions
+): Promise<DeleteAuthorizationResponse>;
 
 export async function deleteAuthorization(
-  options: OAuthAppOptions | GitHubAppOptions
+  options:
+    | DeleteAuthorizationOAuthAppOptions
+    | DeleteAuthorizationGitHubAppOptions
 ): Promise<any> {
   const request =
     options.request ||

src/delete-token.ts

@@ -2,30 +2,32 @@ import { request as defaultRequest } from "@octokit/request";
 import { RequestInterface, Endpoints } from "@octokit/types";
 import btoa from "btoa-lite";
 
-type OAuthAppOptions = {
+export type DeleteTokenOAuthAppOptions = {
   clientType: "oauth-app";
   clientId: string;
   clientSecret: string;
   token: string;
   request?: RequestInterface;
 };
-type GitHubAppOptions = {
+export type DeleteTokenGitHubAppOptions = {
   clientType: "github-app";
   clientId: string;
   clientSecret: string;
   token: string;
   request?: RequestInterface;
 };
 
+export type DeleteTokenResponse = Endpoints["DELETE /applications/{client_id}/token"]["response"];
+
 export async function deleteToken(
-  options: OAuthAppOptions
-): Promise<Endpoints["DELETE /applications/{client_id}/token"]["response"]>;
+  options: DeleteTokenOAuthAppOptions
+): Promise<DeleteTokenResponse>;
 export async function deleteToken(
-  options: GitHubAppOptions
-): Promise<Endpoints["DELETE /applications/{client_id}/token"]["response"]>;
+  options: DeleteTokenGitHubAppOptions
+): Promise<DeleteTokenResponse>;
 
 export async function deleteToken(
-  options: OAuthAppOptions | GitHubAppOptions
+  options: DeleteTokenOAuthAppOptions | DeleteTokenGitHubAppOptions
 ): Promise<any> {
   const request =
     options.request ||

src/exchange-device-code.ts

@@ -11,18 +11,18 @@ import {
 } from "./types";
 import { oauthRequest } from "./utils";
 
-type OAuthAppOptionsWithoutClientSecret = {
+export type ExchangeDeviceCodeOAuthAppOptionsWithoutClientSecret = {
   clientType: "oauth-app";
   clientId: string;
   code: string;
   redirectUrl?: string;
   state?: string;
   request?: RequestInterface;
 };
-type OAuthAppOptions = OAuthAppOptionsWithoutClientSecret & {
+export type ExchangeDeviceCodeOAuthAppOptions = ExchangeDeviceCodeOAuthAppOptionsWithoutClientSecret & {
   clientSecret: string;
 };
-type GitHubAppOptionsWithoutClientSecret = {
+export type ExchangeDeviceCodeGitHubAppOptionsWithoutClientSecret = {
   clientType: "github-app";
   clientId: string;
   code: string;
@@ -31,7 +31,7 @@ type GitHubAppOptionsWithoutClientSecret = {
   request?: RequestInterface;
 };
 
-type GitHubAppOptions = GitHubAppOptionsWithoutClientSecret & {
+export type ExchangeDeviceCodeGitHubAppOptions = ExchangeDeviceCodeGitHubAppOptionsWithoutClientSecret & {
   clientSecret: string;
 };
 
@@ -48,78 +48,67 @@ type GitHubAppAuthenticationWithExpirationWithoutClientSecret = Omit<
   "clientSecret"
 >;
 
+export type ExchangeDeviceCodeOAuthAppResponse = OctokitResponse<OAuthAppCreateTokenResponseData> & {
+  authentication: OAuthAppAuthentication;
+};
+
+export type ExchangeDeviceCodeOAuthAppResponseWithoutClientSecret = OctokitResponse<OAuthAppCreateTokenResponseData> & {
+  authentication: OAuthAppAuthenticationWithoutClientSecret;
+};
+
+export type ExchangeDeviceCodeGitHubAppResponse = OctokitResponse<
+  | GitHubAppCreateTokenResponseData
+  | GitHubAppCreateTokenWithExpirationResponseData
+> & {
+  authentication:
+    | GitHubAppAuthentication
+    | GitHubAppAuthenticationWithExpiration;
+};
+
+export type ExchangeDeviceCodeGitHubAppResponseWithoutClientSecret = OctokitResponse<
+  | GitHubAppCreateTokenResponseData
+  | GitHubAppCreateTokenWithExpirationResponseData
+> & {
+  authentication:
+    | GitHubAppAuthenticationWithoutClientSecret
+    | GitHubAppAuthenticationWithExpirationWithoutClientSecret;
+};
+
 /**
  * Exchange the code from GitHub's OAuth Web flow for OAuth Apps.
  */
 export async function exchangeDeviceCode(
-  options: OAuthAppOptions
-): Promise<
-  OctokitResponse<OAuthAppCreateTokenResponseData> & {
-    authentication: OAuthAppAuthentication;
-  }
->;
+  options: ExchangeDeviceCodeOAuthAppOptions
+): Promise<ExchangeDeviceCodeOAuthAppResponse>;
 
 /**
  * Exchange the code from GitHub's OAuth Web flow for OAuth Apps without clientSecret
  */
 export async function exchangeDeviceCode(
-  options: OAuthAppOptionsWithoutClientSecret
-): Promise<
-  OctokitResponse<OAuthAppCreateTokenResponseData> & {
-    authentication: OAuthAppAuthenticationWithoutClientSecret;
-  }
->;
+  options: ExchangeDeviceCodeOAuthAppOptionsWithoutClientSecret
+): Promise<ExchangeDeviceCodeOAuthAppResponseWithoutClientSecret>;
 
 /**
  * Exchange the code from GitHub's OAuth Web flow for GitHub Apps. `scopes` are not supported by GitHub Apps.
  */
 export async function exchangeDeviceCode(
-  options: GitHubAppOptions
-): Promise<
-  OctokitResponse<
-    | GitHubAppCreateTokenResponseData
-    | GitHubAppCreateTokenWithExpirationResponseData
-  > & {
-    authentication:
-      | GitHubAppAuthentication
-      | GitHubAppAuthenticationWithExpiration;
-  }
->;
+  options: ExchangeDeviceCodeGitHubAppOptions
+): Promise<ExchangeDeviceCodeGitHubAppResponse>;
 
 /**
  * Exchange the code from GitHub's OAuth Web flow for GitHub Apps without using `clientSecret`. `scopes` are not supported by GitHub Apps.
  */
 export async function exchangeDeviceCode(
-  options: GitHubAppOptionsWithoutClientSecret
-): Promise<
-  OctokitResponse<
-    | GitHubAppCreateTokenResponseData
-    | GitHubAppCreateTokenWithExpirationResponseData
-  > & {
-    authentication:
-      | GitHubAppAuthenticationWithoutClientSecret
-      | GitHubAppAuthenticationWithExpirationWithoutClientSecret;
-  }
->;
+  options: ExchangeDeviceCodeGitHubAppOptionsWithoutClientSecret
+): Promise<ExchangeDeviceCodeGitHubAppResponseWithoutClientSecret>;
 
 export async function exchangeDeviceCode(
   options:
-    | OAuthAppOptions
-    | GitHubAppOptions
-    | OAuthAppOptionsWithoutClientSecret
-    | GitHubAppOptionsWithoutClientSecret
-): Promise<
-  OctokitResponse<
-    | GitHubAppCreateTokenWithExpirationResponseData
-    | GitHubAppCreateTokenResponseData
-    | GitHubAppCreateTokenWithExpirationResponseData
-    | OAuthAppAuthenticationWithoutClientSecret
-    | GitHubAppAuthenticationWithoutClientSecret
-    | GitHubAppAuthenticationWithExpirationWithoutClientSecret
-  > & {
-    authentication: any;
-  }
-> {
+    | ExchangeDeviceCodeOAuthAppOptions
+    | ExchangeDeviceCodeGitHubAppOptions
+    | ExchangeDeviceCodeOAuthAppOptionsWithoutClientSecret
+    | ExchangeDeviceCodeGitHubAppOptionsWithoutClientSecret
+): Promise<any> {
   const request =
     options.request ||
     /* istanbul ignore next: we always pass a custom request in tests */