feat: add support for authentication using @octokit/auth strategies

Author: gr2m

src/index.ts

@@ -51,9 +51,14 @@ export class Octokit {
     }
 
     if (options.auth) {
-      requestDefaults.headers.authorization = withAuthorizationPrefix(
-        options.auth
-      );
+      if (typeof options.auth === "string") {
+        requestDefaults.headers.authorization = withAuthorizationPrefix(
+          options.auth
+        );
+      } else {
+        // @ts-ignore
+        hook.wrap("request", options.auth.hook);
+      }
     }
 
     this.request = request.defaults(requestDefaults);

src/types.ts

@@ -1,13 +1,23 @@
 import { Agent } from "http";
 
+import { request as Request } from "@octokit/request";
 import { Octokit } from ".";
 
 export type OctokitOptions = {
-  auth?: string;
+  auth?: string | AutenticationHook;
   request?: OctokitRequestOptions;
   [option: string]: any;
 };
 
+interface AutenticationHook {
+  (options?: any): any;
+
+  hook: (
+    request: typeof Request,
+    options: Endpoint
+  ) => ReturnType<typeof Request>;
+}
+
 export type Plugin = (octokit: Octokit, options?: OctokitOptions) => void;
 
 // TODO: deduplicate
@@ -60,6 +70,21 @@ export type Parameters = {
   [parameter: string]: any;
 };
 
+/**
+ * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar`
+ */
+export type Url = string;
+
+/**
+ * Request method
+ */
+export type Method = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT";
+
+export type Endpoint = Parameters & {
+  method: Method;
+  url: Url;
+};
+
 export type RequestHeaders = {
   /**
    * Avoid setting `accept`, use `mediaFormat.{format|previews}` instead.