fix: remove deprecated { id } option

BREAKING CHANGE: `createAppAuth({ id, privateKey })` is no longer supported. Use `createAppAuth({ appId, privateKey })` instead
octokit · Feb 19, 2021 · 7cb0a8d · 7cb0a8d
1 parent 76115c2
commit 7cb0a8d
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 62 deletions.
diff --git a/src/get-app-authentication.ts b/src/get-app-authentication.ts
@@ -6,7 +6,7 @@ export async function getAppAuthentication({
   appId,
   privateKey,
   timeDifference,
-}: State): Promise<AppAuthentication> {
+}: State & { timeDifference?: number }): Promise<AppAuthentication> {
   const appAuthentication = await githubAppJwt({
     id: +appId,
     privateKey,

diff --git a/src/get-oauth-authentication.ts b/src/get-oauth-authentication.ts
@@ -1,13 +1,13 @@
 import {
   RequestInterface,
   OAuthOptions,
-  StrategyOptionsWithDefaults,
+  State,
   OAuthAccesTokenAuthentication,
 } from "./types";
 import { RequestError } from "@octokit/request-error";
 
 export async function getOAuthAuthentication(
-  state: StrategyOptionsWithDefaults,
+  state: State,
   options: OAuthOptions,
   customRequest?: RequestInterface
 ): Promise<OAuthAccesTokenAuthentication> {

diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,5 @@
 import { getUserAgent } from "universal-user-agent";
 import { request } from "@octokit/request";
-import { Deprecation } from "deprecation";
 
 import { auth } from "./auth";
 import { hook } from "./hook";
@@ -30,14 +29,6 @@ export const createAppAuth: StrategyInterface = function createAppAuth(
     options.log
   );
 
-  if ("id" in options) {
-    log.warn(
-      new Deprecation(
-        '[@octokit/auth-app] "createAppAuth({ id })" is deprecated, use "createAppAuth({ appId })" instead'
-      )
-    );
-  }
-
   const state: State = Object.assign(
     {
       request: request.defaults({
@@ -48,9 +39,6 @@ export const createAppAuth: StrategyInterface = function createAppAuth(
       cache: getCache(),
     },
     options,
-    {
-      appId: Number("appId" in options ? options.appId : options.id),
-    },
     options.installationId
       ? { installationId: Number(options.installationId) }
       : {},

diff --git a/src/types.ts b/src/types.ts
@@ -78,6 +78,7 @@ type OAuthStrategyOptions = {
 };
 
 type CommonStrategyOptions = {
+  appId: number | string;
   privateKey: string;
   installationId?: number | string;
   request?: OctokitTypes.RequestInterface;
@@ -88,34 +89,12 @@ type CommonStrategyOptions = {
   };
 };
 
-type DeprecatedStrategyOptions = OAuthStrategyOptions &
-  CommonStrategyOptions & {
-    /**
-     * @deprecated id is deprecated, use appId instead
-     */
-    id: number | string;
-  };
-
-type CurrentStrategyOptions = OAuthStrategyOptions &
-  CommonStrategyOptions & {
-    appId: number | string;
-  };
+export type StrategyOptions = OAuthStrategyOptions &
+  CommonStrategyOptions & { [key: string]: unknown };
 
-export type StrategyOptions = (
-  | DeprecatedStrategyOptions
-  | CurrentStrategyOptions
-) & { [key: string]: unknown };
-
-export type FactoryOptions = Required<
-  Omit<CurrentStrategyOptions, keyof State>
-> &
+export type FactoryOptions = Required<Omit<StrategyOptions, keyof State>> &
   State;
 
-export type StrategyOptionsWithDefaults = CurrentStrategyOptions &
-  Required<
-    Omit<CurrentStrategyOptions, keyof OAuthStrategyOptions | "installationId">
-  >;
-
 export type Permissions = {
   [name: string]: string;
 };
@@ -146,6 +125,6 @@ export type WithInstallationId = {
   installationId: number;
 };
 
-export type State = StrategyOptionsWithDefaults & {
-  timeDifference: number;
-};
+export type State = Required<Omit<CommonStrategyOptions, "installationId">> & {
+  installationId?: number;
+} & OAuthStrategyOptions;
diff --git a/test/deprecations.test.ts b/test/deprecations.test.ts
@@ -1,23 +1,24 @@
-import { Deprecation } from "deprecation";
-import { createAppAuth } from "../src/index";
-
 describe("deprecations", () => {
-  test("createAppAuth({ id }) - #44", () => {
-    const warn = jest.fn();
+  test("There are currently no deprecations", () => {});
+
+  // example:
+  //
+  // test("createAppAuth({ id }) - #44", () => {
+  //   const warn = jest.fn();
 
-    createAppAuth({
-      id: 1,
-      privateKey: "...",
-      log: {
-        warn,
-      },
-    });
+  //   createAppAuth({
+  //     id: 1,
+  //     privateKey: "...",
+  //     log: {
+  //       warn,
+  //     },
+  //   });
 
-    expect(warn).toHaveBeenCalledTimes(1);
-    expect(warn).toHaveBeenCalledWith(
-      new Deprecation(
-        '[@octokit/auth-app] "createAppAuth({ id })" is deprecated, use "createAppAuth({ appId })" instead'
-      )
-    );
-  });
+  //   expect(warn).toHaveBeenCalledTimes(1);
+  //   expect(warn).toHaveBeenCalledWith(
+  //     new Deprecation(
+  //       '[@octokit/auth-app] "createAppAuth({ id })" is deprecated, use "createAppAuth({ appId })" instead'
+  //     )
+  //   );
+  // });
 });