feat: add types for the plugin

src/error-request.ts

@@ -1,6 +1,13 @@
-// @ts-ignore
+import type { RequestError } from "@octokit/request-error";
+import type { State, Octokit } from "./types";
+import type { EndpointDefaults } from "@octokit/types";
 
-export async function errorRequest(state, octokit, error, options) {
+export async function errorRequest(
+  state: State,
+  octokit: Octokit,
+  error: RequestError,
+  options: Required<EndpointDefaults>,
+) {
   if (!error.request || !error.request.request) {
     // address https://github.com/octokit/plugin-retry.js/issues/8
     throw error;
@@ -9,8 +16,10 @@ export async function errorRequest(state, octokit, error, options) {
   // retry all >= 400 && not doNotRetry
   if (error.status >= 400 && !state.doNotRetry.includes(error.status)) {
     const retries =
-      options.request.retries != null ? options.request.retries : state.retries;
-    const retryAfter = Math.pow((options.request.retryCount || 0) + 1, 2);
+      options.request?.retries != null
+        ? options.request.retries
+        : state.retries;
+    const retryAfter = Math.pow((options.request?.retryCount || 0) + 1, 2);
     throw octokit.retry.retryRequest(error, retries, retryAfter);
   }
 

src/index.ts

@@ -1,13 +1,18 @@
-import { Octokit } from "@octokit/core";
+import type { Octokit as OctokitCore } from "@octokit/core";
 import type { RequestError } from "@octokit/request-error";
-
+import type { OctokitOptions } from "@octokit/core/dist-types/types.d";
 import { errorRequest } from "./error-request";
 import { wrapRequest } from "./wrap-request";
+import type { RetryOptions, State } from "./types";
+import type { WrapHook } from "before-after-hook";
+
+import { VERSION } from "./version.js";
+import type { EndpointDefaults, OctokitResponse } from "@octokit/types";
 
-export const VERSION = "0.0.0-development";
+export { VERSION };
 
-export function retry(octokit: Octokit, octokitOptions: any) {
-  const state = Object.assign(
+export function retry(octokit: OctokitCore, octokitOptions: OctokitOptions) {
+  const state: State = Object.assign(
     {
       enabled: true,
       retryAfterBaseValue: 1000,
@@ -18,7 +23,13 @@ export function retry(octokit: Octokit, octokitOptions: any) {
   );
 
   if (state.enabled) {
+    // @ts-expect-error
     octokit.hook.error("request", errorRequest.bind(null, state, octokit));
+    // The types for `before-after-hook` do not let us only pass through a Promise return value
+    // the types expect that the function can return either a Promise of the response, or diectly return the response.
+    // This is due to the fact that `@octokit/request` uses aysnc functions
+    // Also, since we add the custom `retryCount` property to the request argument, the types are not compatible.
+    // @ts-expect-error
     octokit.hook.wrap("request", wrapRequest.bind(null, state, octokit));
   }
 
@@ -40,3 +51,9 @@ export function retry(octokit: Octokit, octokitOptions: any) {
   };
 }
 retry.VERSION = VERSION;
+
+declare module "@octokit/core/dist-types/types.d" {
+  interface OctokitOptions {
+    retry?: RetryOptions;
+  }
+}

src/types.ts

@@ -0,0 +1,20 @@
+import { Octokit as OctokitCore } from "@octokit/core";
+import type { RequestError } from "@octokit/request-error";
+
+export type RetryOptions = {
+  enabled?: boolean;
+  doNotRetry?: number[];
+  retries?: number;
+  retryAfterBaseValue?: number;
+};
+
+export type State = Required<RetryOptions>;
+export type Octokit = OctokitCore & {
+  retry: {
+    retryRequest: (
+      error: RequestError,
+      retries: number,
+      retryAfter: number,
+    ) => RequestError;
+  };
+};

src/wrap-request.ts

@@ -1,10 +1,24 @@
-// @ts-nocheck
+// @ts-expect-error
 import Bottleneck from "bottleneck/light";
+import type TBottleneck from "bottleneck";
 import { RequestError } from "@octokit/request-error";
 import { errorRequest } from "./error-request";
+import type { Octokit, State } from "./types";
+import type { EndpointDefaults, OctokitResponse } from "@octokit/types";
 
-export async function wrapRequest(state, octokit, request, options) {
-  const limiter = new Bottleneck();
+type Request = (
+    request: Request,
+    options: Required<EndpointDefaults>,
+  ) => Promise<OctokitResponse<any>>;
+export async function wrapRequest(
+  state: State,
+  octokit: Octokit,
+  request: (
+    options: Required<EndpointDefaults>,
+  ) => Promise<OctokitResponse<any>>,
+  options: Required<EndpointDefaults>,
+) {
+  const limiter: TBottleneck = new Bottleneck();
 
   limiter.on("failed", function (error, info) {
     const maxRetries = ~~error.request.request.retries;
@@ -19,16 +33,20 @@ export async function wrapRequest(state, octokit, request, options) {
   });
 
   return limiter.schedule(
+    // @ts-expect-error
     requestWithGraphqlErrorHandling.bind(null, state, octokit, request),
     options,
   );
 }
 
 async function requestWithGraphqlErrorHandling(
-  state,
-  octokit,
-  request,
-  options,
+  state: State,
+  octokit: Octokit,
+  request: (
+    request: Request,
+    options: Required<EndpointDefaults>,
+  ) => Promise<OctokitResponse<any>>,
+  options: Required<EndpointDefaults>,
 ) {
   const response = await request(request, options);
 

test/retry.test.ts

@@ -426,6 +426,7 @@ describe("errorRequest", function () {
     delete error.request;
 
     try {
+      // @ts-expect-error
       await errorRequest(state, octokit, error, errorOptions);
       expect(1).not.toBe(1);
     } catch (e: any) {
@@ -454,6 +455,7 @@ describe("errorRequest", function () {
     const error = new RequestError("Internal server error", 500, errorOptions);
 
     try {
+      // @ts-expect-error
       await errorRequest(state, octokit, error, errorOptions);
       expect(1).not.toBe(1);
     } catch (e: any) {