feat: installationId strategy option

Author: gr2m

src/auth.ts

@@ -1,16 +1,26 @@
 import { request } from "@octokit/request";
 
-import { StrategyOptionsWithDefaults, AuthOptions, Permissions } from "./types";
+import {
+  Authentication,
+  AuthOptions,
+  Permissions,
+  StrategyOptionsWithDefaults,
+  WithInstallationId
+} from "./types";
 import { isAppRoute } from "./is-app-route";
 import { toTokenAuthentication } from "./to-token-authentication";
 import { toAppAuthentication } from "./to-app-authentication";
 import { get, set } from "./cache";
 
 export async function auth(
   state: StrategyOptionsWithDefaults,
-  options?: AuthOptions
+  options: AuthOptions = {}
 ) {
-  if (options && !options.refresh) {
+  // installationId is never 0, so a simple check here is fine
+  const installationId = (options.installationId ||
+    state.installationId) as number;
+
+  if (installationId && !options.refresh) {
     const result = get(state.cache, options);
     if (result) {
       const {
@@ -22,7 +32,7 @@ export async function auth(
       } = result;
 
       return toTokenAuthentication(
-        options.installationId,
+        installationId,
         token,
         expiresAt,
         permissions,
@@ -34,7 +44,7 @@ export async function auth(
 
   const appAuthentication = toAppAuthentication(state.id, state.privateKey);
 
-  if (!options || isAppRoute(options.url)) {
+  if (isAppRoute(options) || !installationId) {
     return appAuthentication;
   }
 
@@ -43,7 +53,7 @@ export async function auth(
   } = await state.request(
     "POST /app/installations/:installation_id/access_tokens",
     {
-      installation_id: options.installationId,
+      installation_id: installationId,
       repository_ids: options.repositoryIds,
       permissions: options.permissions,
       previews: ["machine-man"],
@@ -58,7 +68,7 @@ export async function auth(
   const {
     data: { permissions, single_file_name: singleFileName }
   } = await state.request("GET /app/installations/:installation_id", {
-    installation_id: options.installationId,
+    installation_id: options.installationId || state.installationId,
     previews: ["machine-man"],
     headers: appAuthentication.headers
   });
@@ -72,7 +82,7 @@ export async function auth(
   });
 
   return toTokenAuthentication(
-    options.installationId,
+    installationId,
     token,
     expires_at,
     permissions,

src/cache.ts

@@ -1,6 +1,7 @@
 // https://github.com/isaacs/node-lru-cache#readme
 import LRU from "lru-cache";
 
+/* istanbul ignore next */
 import { AuthOptions, Cache, CacheData, Permissions } from "./types";
 
 export function getCache() {

src/is-app-route.ts

@@ -47,6 +47,11 @@ function routeMatcher(paths: string[]) {
 
 const REGEX = routeMatcher(PATHS);
 
-export function isAppRoute(path?: string): Boolean {
-  return !!path && REGEX.test(path);
+type Options = {
+  url?: string;
+  [key: string]: any;
+};
+
+export function isAppRoute(options: Options): Boolean {
+  return !!options.url && REGEX.test(options.url);
 }

src/types.ts

@@ -8,9 +8,52 @@ export type Cache =
       set: (key: string, value: string) => any;
     };
 
+export interface AppAuthStrategy {
+  (options?: StrategyOptions): AppAuth;
+}
+
+export interface AppAuth {
+  (options: AuthOptions): Promise<Authentication>;
+}
+
+export type JWT = string;
+export type UTC_TIMESTAMP = string;
+
+type AppAuthentication = {
+  type: "app";
+  token: JWT;
+  appId: number;
+  exporation: number;
+  headers: {
+    authorization: string;
+  };
+  query: {};
+};
+
+type InstallationAccessTokenAuthentication = {
+  type: "token";
+  token: string;
+  tokenType: "installation";
+  expiresAt: UTC_TIMESTAMP;
+  permissions: {
+    [permission: string]: "read" | "write";
+  };
+  singleFileName?: string;
+  repositoryIds?: number[];
+  headers: {
+    authorization: string;
+  };
+  query: {};
+};
+
+export type Authentication =
+  | AppAuthentication
+  | InstallationAccessTokenAuthentication;
+
 export type StrategyOptions = {
   id: number;
   privateKey: string;
+  installationId?: number;
   request?: typeof request;
   cache?: Cache;
 };
@@ -25,7 +68,7 @@ export type Permissions = {
 };
 
 export type AuthOptions = {
-  installationId: number;
+  installationId?: number;
   repositoryIds?: number[];
   permissions?: Permissions;
   url?: string;
@@ -39,3 +82,7 @@ export type CacheData = {
   repositoryIds?: number[];
   singleFileName?: string;
 };
+
+export type WithInstallationId = {
+  installationId: number;
+};