feat(typescript): export types (#266)

* feat(typescript): export types

* docs: update ToC for README.md

Co-authored-by: prettier-toc-me[bot] <56236715+prettier-toc-me[bot]@users.noreply.github.com>

Author: gr2m

README.md

@@ -29,6 +29,7 @@
   - [GitHub APP user authentication token with expiring disabled](#github-app-user-authentication-token-with-expiring-disabled)
   - [GitHub APP user authentication token with expiring enabled](#github-app-user-authentication-token-with-expiring-enabled)
 - [`auth.hook(request, route, parameters)` or `auth.hook(request, options)`](#authhookrequest-route-parameters-or-authhookrequest-options)
+- [Types](#types)
 - [Implementation details](#implementation-details)
 - [License](#license)
 
@@ -1349,6 +1350,29 @@ const requestWithAuth = request.defaults({
 });
 ```
 
+## Types
+
+```ts
+import {
+  // strategy options
+  StrategyOptions,
+  // auth options
+  AuthOptions,
+  AppAuthOptions,
+  OAuthAppAuthOptions,
+  InstallationAuthOptions,
+  OAuthWebFlowAuthOptions,
+  OAuthDeviceFlowAuthOptions,
+  // authentication objects
+  Authentication,
+  AppAuthentication,
+  OAuthAppAuthentication,
+  InstallationAccessTokenAuthentication,
+  GitHubAppUserAuthentication,
+  GitHubAppUserAuthenticationWithExpiration,
+} from "@octokit/auth-app";
+```
+
 ## Implementation details
 
 When creating a JSON Web Token, it sets the "issued at time" (iat) to 30s in the past as we have seen people running situations where the GitHub API claimed the iat would be in future. It turned out the clocks on the different machine were not in sync.

src/index.ts

@@ -9,6 +9,24 @@ import { StrategyInterface, State, StrategyOptions } from "./types";
 import { VERSION } from "./version";
 
 export { createOAuthUserAuth } from "@octokit/auth-oauth-user";
+export {
+  // strategy options
+  StrategyOptions,
+  // auth options
+  AuthOptions,
+  AppAuthOptions,
+  OAuthAppAuthOptions,
+  InstallationAuthOptions,
+  OAuthWebFlowAuthOptions,
+  OAuthDeviceFlowAuthOptions,
+  // authentication objects
+  Authentication,
+  AppAuthentication,
+  OAuthAppAuthentication,
+  InstallationAccessTokenAuthentication,
+  GitHubAppUserAuthentication,
+  GitHubAppUserAuthenticationWithExpiration,
+} from "./types";
 
 export const createAppAuth: StrategyInterface = function createAppAuth(
   options: StrategyOptions

src/types.ts

@@ -1,14 +1,15 @@
 import * as OctokitTypes from "@octokit/types";
 import LRUCache from "lru-cache";
-import {
-  GitHubAuthInterface,
-  AppAuthentication as OAuthAppAuthentication,
-  GitHubAppUserAuthentication,
-  GitHubAppUserAuthenticationWithExpiration,
-  AppAuthOptions as OAuthAppAuthOptions,
-  WebFlowAuthOptions,
-  GitHubAppDeviceFlowAuthOptions,
-} from "@octokit/auth-oauth-app";
+// import {
+//   GitHubAuthInterface as OAuthAppGitHubAuthInterface,
+//   AppAuthentication as OAuthAppAuthentication,
+//   GitHubAppUserAuthentication,
+//   GitHubAppUserAuthenticationWithExpiration,
+//   AppAuthOptions as OAuthAppAuthOptions,
+//   WebFlowAuthOptions,
+//   GitHubAppDeviceFlowAuthOptions,
+// } from "@octokit/auth-oauth-app";
+import * as OAuthAppAuth from "@octokit/auth-oauth-app";
 
 export type AnyResponse = OctokitTypes.OctokitResponse<any>;
 export type EndpointDefaults = OctokitTypes.EndpointDefaults;
@@ -70,6 +71,10 @@ export type InstallationAccessTokenAuthentication = InstallationAccessTokenData
   tokenType: INSTALLATION_TOKEN_TYPE;
 };
 
+export type OAuthAppAuthentication = OAuthAppAuth.AppAuthentication;
+export type GitHubAppUserAuthentication = OAuthAppAuth.GitHubAppUserAuthentication;
+export type GitHubAppUserAuthenticationWithExpiration = OAuthAppAuth.GitHubAppUserAuthenticationWithExpiration;
+
 export type Authentication =
   | AppAuthentication
   | OAuthAppAuthentication
@@ -104,17 +109,6 @@ export type Permissions = {
   [name: string]: string;
 };
 
-type CommonAuthOptions = {
-  installationId?: number | string;
-  repositoryIds?: number[];
-  permissions?: Permissions;
-  refresh?: boolean;
-  // TODO: return type of `auth({ type: "installation", installationId, factory })`
-  //       should be Promise<ReturnType<factory>>
-  factory?: (options: FactoryOptions) => unknown;
-  [key: string]: unknown;
-};
-
 export type AuthType =
   | "app"
   | "installation"
@@ -138,12 +132,16 @@ export type InstallationAuthOptions = {
   [key: string]: unknown;
 };
 
+export type OAuthAppAuthOptions = OAuthAppAuth.AppAuthOptions;
+export type OAuthWebFlowAuthOptions = OAuthAppAuth.WebFlowAuthOptions;
+export type OAuthDeviceFlowAuthOptions = OAuthAppAuth.GitHubAppDeviceFlowAuthOptions;
+
 export type AuthOptions =
   | AppAuthOptions
   | OAuthAppAuthOptions
   | InstallationAuthOptions
-  | WebFlowAuthOptions
-  | GitHubAppDeviceFlowAuthOptions;
+  | OAuthWebFlowAuthOptions
+  | OAuthDeviceFlowAuthOptions;
 
 export type WithInstallationId = {
   installationId: number;
@@ -152,5 +150,5 @@ export type WithInstallationId = {
 export type State = Required<Omit<CommonStrategyOptions, "installationId">> & {
   installationId?: number;
 } & OAuthStrategyOptions & {
-    oauthApp: GitHubAuthInterface;
+    oauthApp: OAuthAppAuth.GitHubAuthInterface;
   };