feat: remove support for * event

BREAKING CHANGE: passing `*` as an event name is no longer supported

scripts/generate-types.ts

@@ -126,9 +126,8 @@ const asLink = (event: string): string => {
 const updateReadme = (properties: string[]) => {
   const headers = "| Event | Actions |";
 
-  const events = properties
-    .filter((property) => property !== "*")
-    .reduce<Record<string, string[]>>((events, property) => {
+  const events = properties.reduce<Record<string, string[]>>(
+    (events, property) => {
       console.log(property);
       const [event, action] = property.split(".");
 
@@ -139,7 +138,9 @@ const updateReadme = (properties: string[]) => {
       }
 
       return events;
-    }, {});
+    },
+    {}
+  );
 
   const rows = Object.entries(events).map(
     ([event, actions]) =>
@@ -193,7 +194,6 @@ const run = () => {
     "// make edits in scripts/generate-types.ts",
     "",
     "export const emitterEventNames = [",
-    '"*",',
     ...properties.map(([key]) => `"${key}",`),
     "];",
   ]);

src/event-handler/index.ts

@@ -1,5 +1,4 @@
 import type {
-  EmitterAnyEvent,
   EmitterEventName,
   EmitterWebhookEvent,
   HandlerFunction,
@@ -20,7 +19,7 @@ interface EventHandler<TTransformed = unknown> {
     event: E | E[],
     callback: HandlerFunction<E, TTransformed>
   ): void;
-  onAny(handler: (event: EmitterAnyEvent) => any): void;
+  onAny(handler: (event: EmitterWebhookEvent) => any): void;
   onError(handler: (event: WebhookEventHandlerError) => any): void;
   removeListener<E extends EmitterEventName>(
     event: E | E[],

src/event-handler/on.ts

@@ -1,14 +1,14 @@
 import { emitterEventNames } from "../generated/webhook-names";
 import {
-  EmitterAnyEvent,
   EmitterEventName,
+  EmitterWebhookEvent,
   State,
   WebhookEventHandlerError,
 } from "../types";
 
 function handleEventHandlers(
   state: State,
-  webhookName: EmitterEventName | "error",
+  webhookName: EmitterEventName | "error" | "*",
   handler: Function
 ) {
   if (!state.hooks[webhookName]) {
@@ -35,18 +35,12 @@ export function receiverOn(
     );
   }
 
-  if (webhookNameOrNames === "*") {
-    console.warn(
-      `Using the "${webhookNameOrNames}" event with the regular Webhooks.on() function is deprecated. Please use the Webhooks.onAny() method instead`
-    );
-  }
-
   handleEventHandlers(state, webhookNameOrNames, handler);
 }
 
 export function receiverOnAny(
   state: State,
-  handler: (event: EmitterAnyEvent) => any
+  handler: (event: EmitterWebhookEvent) => any
 ) {
   handleEventHandlers(state, "*", handler);
 }

src/generated/webhook-names.ts

@@ -2,7 +2,6 @@
 // make edits in scripts/generate-types.ts
 
 export const emitterEventNames = [
-  "*",
   "check_run",
   "check_run.completed",
   "check_run.created",

src/index.ts

@@ -8,7 +8,6 @@ import {
 } from "./middleware/verify-and-receive";
 import { sign } from "./sign/index";
 import {
-  EmitterAnyEvent,
   EmitterEventName,
   EmitterWebhookEvent,
   EmitterWebhookEventMap,
@@ -31,7 +30,7 @@ class Webhooks<
     event: E | E[],
     callback: HandlerFunction<E, TTransformed>
   ) => void;
-  public onAny: (callback: (event: EmitterAnyEvent) => any) => void;
+  public onAny: (callback: (event: EmitterWebhookEvent) => any) => void;
   public onError: (callback: (event: WebhookEventHandlerError) => any) => void;
   public removeListener: <E extends EmitterEventName>(
     event: E | E[],

src/types.ts

@@ -1,8 +1,7 @@
 import type { RequestError } from "@octokit/request-error";
-import type { Schema } from "@octokit/webhooks-definitions/schema";
 import type { EmitterEventWebhookPayloadMap } from "./generated/get-webhook-payload-type-from-event";
 
-type EmitterEventPayloadMap = { "*": Schema } & EmitterEventWebhookPayloadMap;
+type EmitterEventPayloadMap = EmitterEventWebhookPayloadMap;
 
 export type EmitterWebhookEventMap = {
   [K in keyof EmitterEventPayloadMap]: BaseWebhookEvent<K>;
@@ -19,8 +18,6 @@ export type EmitterEventMap = EmitterWebhookEventMap;
 export type EmitterEventName = keyof EmitterEventMap;
 export type EmitterEvent = EmitterEventMap[EmitterEventName];
 
-export type EmitterAnyEvent = EmitterWebhookEventMap["*"];
-
 export type ToWebhookEvent<
   TEmitterEvent extends string
 > = TEmitterEvent extends `${infer TWebhookEvent}.${string}`

test/typescript-validate.ts

@@ -18,26 +18,11 @@ import { HandlerFunction, EmitterWebhookEventName } from "../src/types";
 // ************************************************************
 
 const fn = (webhookEvent: EmitterWebhookEvent) => {
-  if (webhookEvent.name === "*") {
-    if (
-      "action" in webhookEvent.payload &&
-      webhookEvent.payload.action === "completed"
-    ) {
-      console.log(webhookEvent.payload.sender);
-    }
-  }
   // @ts-expect-error TS2367:
-  //  This condition will always return 'false' since the types '"*" | "check_run" | ... many more ... | "workflow_run"' and '"check_run.completed"' have no overlap.
+  //  This condition will always return 'false' since the types '"check_run" | ... many more ... | "workflow_run"' and '"check_run.completed"' have no overlap.
   if (webhookEvent.name === "check_run.completed") {
     //
   }
-
-  if (webhookEvent.name === "*") {
-    // @ts-expect-error TS2339:
-    //  Property 'action' does not exist on type 'Schema'.
-    //    Property 'action' does not exist on type 'CreateEvent'.
-    console.log(webhookEvent.payload.action);
-  }
 };
 
 declare const on: <E extends EmitterWebhookEventName>(
@@ -119,13 +104,6 @@ export default async function () {
 
   verify("randomSecret", {}, "randomSignature");
 
-  // This is deprecated usage
-  webhooks.on("*", ({ id, name, payload }) => {
-    console.log(name, "event received", id);
-    const sig = webhooks.sign(payload);
-    webhooks.verify(payload, sig);
-  });
-
   webhooks.onAny(({ id, name, payload }) => {
     console.log(name, "event received", id);
     const sig = webhooks.sign(payload);

test/unit/event-handler-on-test.ts

@@ -21,14 +21,3 @@ test("receiver.on with invalid event name", () => {
     '"foo" is not a known webhook name (https://developer.github.com/v3/activity/events/types/)'
   );
 });
-
-test("receiver.on with event name of '*' logs deprecation notice", () => {
-  const consoleWarnSpy = jest.spyOn(console, "warn").mockImplementation(noop);
-
-  receiverOn(state, "*", noop);
-
-  expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
-  expect(consoleWarnSpy).toHaveBeenLastCalledWith(
-    'Using the "*" event with the regular Webhooks.on() function is deprecated. Please use the Webhooks.onAny() method instead'
-  );
-});