feat: export WebhooksEvents from @octokit/webhooks.js (#321)

* fix: typscript import Events from @octokit/webhooks.js

* Install npm dependencies, just in case

* Rename this to WebhooksEvents as in future we will have Events which have all Github events

* Fix lint

* Rename to WebhooksEvents

scripts/generate-types.js

@@ -59,7 +59,7 @@ export interface EventTypesPayload {
   ${eventPayloadMapping.map(([name, type]) => `"${name}": ${type}`).join(`,\n`)}
 }
 
-export type All = keyof EventTypesPayload
+export type WebhookEvents = keyof EventTypesPayload
 `;
 
 generateFile(

src/event-handler/on.ts

@@ -1,10 +1,10 @@
-import { All } from "../generated/get-webhook-payload-type-from-event";
+import { WebhookEvents } from "../generated/get-webhook-payload-type-from-event";
 import { webhookNames } from "../generated/webhook-names";
 import { State } from "../types";
 
 export function receiverOn(
   state: State,
-  webhookNameOrNames: All | All[],
+  webhookNameOrNames: WebhookEvents | WebhookEvents[],
   handler: Function
 ) {
   if (Array.isArray(webhookNameOrNames)) {

src/event-handler/receive.ts

@@ -8,12 +8,12 @@ import {
   WebhookError,
   WebhookEventHandlerError,
 } from "../types";
-import { All } from "../generated/get-webhook-payload-type-from-event";
+import { WebhookEvents } from "../generated/get-webhook-payload-type-from-event";
 
 function getHooks(
   state: State,
   eventPayloadAction: string,
-  eventName: All
+  eventName: WebhookEvents
 ): Function[] {
   const hooks = [state.hooks[`${eventName}.${eventPayloadAction}`]];
 

src/generated/get-webhook-payload-type-from-event.ts

@@ -358,4 +358,4 @@ export interface EventTypesPayload {
   >;
 }
 
-export type All = keyof EventTypesPayload;
+export type WebhookEvents = keyof EventTypesPayload;

src/index.ts

@@ -12,17 +12,17 @@ import {
   HandlerFunction,
 } from "./types";
 import { IncomingMessage, ServerResponse } from "http";
-import { All } from "./generated/get-webhook-payload-type-from-event";
+import { WebhookEvents } from "./generated/get-webhook-payload-type-from-event";
 
 // U holds the return value of `transform` function in Options
 class Webhooks<T extends WebhookEvent = WebhookEvent, U = {}> {
   public sign: (payload: string | object) => string;
   public verify: (eventPayload?: object, signature?: string) => boolean;
-  public on: <E extends All>(
+  public on: <E extends WebhookEvents>(
     event: E | E[],
     callback: HandlerFunction<E, U>
   ) => void;
-  public removeListener: <E extends All>(
+  public removeListener: <E extends WebhookEvents>(
     event: E | E[],
     callback: HandlerFunction<E, U>
   ) => void;
@@ -65,6 +65,7 @@ class Webhooks<T extends WebhookEvent = WebhookEvent, U = {}> {
 const createWebhooksApi = Webhooks.prototype.constructor;
 
 export { EventPayloads } from "./generated/event-payloads";
+export { WebhookEvents } from "./generated/get-webhook-payload-type-from-event";
 
 export {
   createEventHandler,

src/middleware/middleware.ts

@@ -5,7 +5,7 @@ import { verifyAndReceive } from "./verify-and-receive";
 import { debug } from "debug";
 import { IncomingMessage, ServerResponse } from "http";
 import { State, WebhookEventHandlerError } from "../types";
-import { All } from "../generated/get-webhook-payload-type-from-event";
+import { WebhookEvents } from "../generated/get-webhook-payload-type-from-event";
 
 const debugWebhooks = debug("webhooks:receiver");
 
@@ -41,7 +41,7 @@ export function middleware(
     });
   }
 
-  const eventName = request.headers["x-github-event"] as All;
+  const eventName = request.headers["x-github-event"] as WebhookEvents;
   const signature = request.headers["x-hub-signature"] as string;
   const id = request.headers["x-github-delivery"] as string;
 

src/types.ts

@@ -1,12 +1,12 @@
 import type { RequestError } from "@octokit/request-error";
 import {
-  All,
+  WebhookEvents,
   EventTypesPayload,
 } from "./generated/get-webhook-payload-type-from-event";
 
 export interface WebhookEvent<T = any> {
   id: string;
-  name: All;
+  name: WebhookEvents;
   payload: T;
 }
 
@@ -20,7 +20,7 @@ type TransformMethod<T extends WebhookEvent, V = T> = (
   event: WebhookEvent
 ) => V | PromiseLike<V>;
 
-export type HandlerFunction<E extends All, U> = (
+export type HandlerFunction<E extends WebhookEvents, U> = (
   event: EventTypesPayload[E] & U
 ) => any;
 

test/typescript-validate.ts

@@ -8,9 +8,9 @@ import {
   EventPayloads,
   WebhookEvent,
   WebhookError,
+  WebhookEvents,
 } from "../src/index";
 import { createServer } from "http";
-import { All } from "../src/generated/get-webhook-payload-type-from-event";
 
 // ************************************************************
 // THIS CODE IS NOT EXECUTED. IT IS FOR TYPECHECKING ONLY
@@ -24,7 +24,7 @@ const myWebhook: WebhookEvent<{ foo: string }> = {
   },
 };
 
-const myEventName: All = "check_run.completed";
+const myEventName: WebhookEvents = "check_run.completed";
 
 const myEvenTPayload: EventPayloads.WebhookPayloadCheckRunCheckRunOutput = {
   annotations_count: 0,