fix: correct some type discrepencies (#970)

Fixes #969

Author: wolfy1339

src/event-handler/index.ts

@@ -5,6 +5,7 @@ import type {
   HandlerFunction,
   Options,
   State,
+  WebhookError,
   WebhookEventHandlerError,
 } from "../types.js";
 import {
@@ -15,7 +16,7 @@ import {
 import { receiverHandle as receive } from "./receive.js";
 import { removeListener } from "./remove-listener.js";
 
-interface EventHandler<TTransformed> {
+export interface EventHandler<TTransformed> {
   on<E extends EmitterWebhookEventName>(
     event: E | E[],
     callback: HandlerFunction<E, TTransformed>,
@@ -34,7 +35,7 @@ interface EventHandler<TTransformed> {
     event: E | E[],
     callback: HandlerFunction<E, TTransformed>,
   ): void;
-  receive(event: EmitterWebhookEvent): Promise<void>;
+  receive(event: EmitterWebhookEvent | WebhookError): Promise<void>;
 }
 
 export function createEventHandler<TTransformed>(

src/event-handler/receive.ts

@@ -2,9 +2,9 @@
 import AggregateError from "aggregate-error";
 import type {
   EmitterWebhookEvent,
-  EmitterWebhookEventName,
   State,
   WebhookError,
+  WebhookEventName,
   WebhookEventHandlerError,
 } from "../types.js";
 import { wrapErrorHandler } from "./wrap-error-handler.js";
@@ -17,7 +17,7 @@ type EventAction = Extract<
 function getHooks(
   state: State,
   eventPayloadAction: EventAction | null,
-  eventName: EmitterWebhookEventName,
+  eventName: WebhookEventName,
 ): Function[] {
   const hooks = [state.hooks[eventName], state.hooks["*"]];
 
@@ -29,7 +29,10 @@ function getHooks(
 }
 
 // main handler function
-export function receiverHandle(state: State, event: EmitterWebhookEvent) {
+export function receiverHandle(
+  state: State,
+  event: EmitterWebhookEvent | WebhookError,
+) {
   const errorHandlers = state.hooks.error || [];
 
   if (event instanceof Error) {

src/index.ts

@@ -1,5 +1,8 @@
 import { createLogger } from "./createLogger.js";
-import { createEventHandler } from "./event-handler/index.js";
+import {
+  createEventHandler,
+  type EventHandler,
+} from "./event-handler/index.js";
 import { sign, verify } from "@octokit/webhooks-methods";
 import { verifyAndReceive } from "./verify-and-receive.js";
 import type {
@@ -49,7 +52,10 @@ class Webhooks<TTransformed = unknown> {
       throw new Error("[@octokit/webhooks] options.secret required");
     }
 
-    const state: State & { secret: string } = {
+    const state: State & {
+      secret: string;
+      eventHandler: EventHandler<TTransformed>;
+    } = {
       eventHandler: createEventHandler(options),
       secret: options.secret,
       hooks: {},

src/types.ts

@@ -3,7 +3,9 @@ import type {
   WebhookEventMap,
   WebhookEventName,
 } from "@octokit/webhooks-types";
+export type { WebhookEventName } from "@octokit/webhooks-types";
 import type { Logger } from "./createLogger.js";
+import type { EventHandler } from "./event-handler/index.js";
 import type { emitterEventNames } from "./generated/webhook-names.js";
 
 export type EmitterWebhookEventName = (typeof emitterEventNames)[number];
@@ -17,7 +19,7 @@ export type EmitterWebhookEvent<
 
 export type EmitterWebhookEventWithStringPayloadAndSignature = {
   id: string;
-  name: EmitterWebhookEventName;
+  name: WebhookEventName;
   payload: string;
   signature: string;
 };
@@ -51,7 +53,7 @@ type Hooks = {
 };
 
 export interface State extends Options<any> {
-  eventHandler?: any;
+  eventHandler?: EventHandler<unknown>;
   hooks: Hooks;
   log: Logger;
 }

src/verify-and-receive.ts

@@ -6,10 +6,12 @@ import type {
   EmitterWebhookEvent,
   EmitterWebhookEventWithStringPayloadAndSignature,
   State,
+  WebhookError,
 } from "./types.js";
+import type { EventHandler } from "./event-handler/index.js";
 
 export async function verifyAndReceive(
-  state: State & { secret: string },
+  state: State & { secret: string; eventHandler: EventHandler<unknown> },
   event: EmitterWebhookEventWithStringPayloadAndSignature,
 ): Promise<void> {
   // verify will validate that the secret is not undefined
@@ -25,7 +27,7 @@ export async function verifyAndReceive(
     );
 
     return state.eventHandler.receive(
-      Object.assign(error, { event, status: 400 }),
+      Object.assign(error, { event, status: 400 }) as WebhookError,
     );
   }
 
@@ -42,5 +44,5 @@ export async function verifyAndReceive(
     id: event.id,
     name: event.name,
     payload,
-  });
+  } as EmitterWebhookEvent);
 }