feat: export emitterEventNames (#626)

`emitterEventNames` is a list of possible webhook event + action name combinations that is useful in GUI or validation of input

Author: Paweł Mitka

README.md

@@ -21,6 +21,7 @@
   - [webhooks.removeListener()](#webhooksremovelistener)
   - [createNodeMiddleware()](#createnodemiddleware)
   - [Webhook events](#webhook-events)
+  - [emitterEventNames](#emittereventnames)
 - [TypeScript](#typescript)
   - [`EmitterWebhookEventName`](#emitterwebhookeventname)
   - [`EmitterWebhookEvent`](#emitterwebhookevent)
@@ -95,6 +96,7 @@ source.onmessage = (event) => {
 9. [webhooks.removeListener()](#webhooksremovelistener)
 10. [createNodeMiddleware()](#createnodemiddleware)
 11. [Webhook events](#webhook-events)
+12. [emitterEventNames](#emittereventnames)
 
 ### Constructor
 
@@ -694,6 +696,15 @@ If there are actions for a webhook, events are emitted for both, the webhook nam
 
 <!-- /autogenerated via scripts/generate-types.ts -->
 
+### emitterEventNames
+
+A read only tuple containing all the possible combinations of the webhook events + actions listed above. This might be useful in GUI and input validation.
+
+```js
+import { emitterEventNames } from "@octokit/webhooks";
+emitterEventNames; // ["check_run", "check_run.completed", ...]
+```
+
 ## TypeScript
 
 The types for the webhook payloads are sourced from [`@octokit/webhooks-types`](https://github.com/octokit/webhooks/tree/master/payload-types),

src/index.ts

@@ -16,6 +16,7 @@ import {
 } from "./types";
 
 export { createNodeMiddleware } from "./middleware/node/index";
+export { emitterEventNames } from "./generated/webhook-names";
 
 // U holds the return value of `transform` function in Options
 class Webhooks<TTransformed = unknown> {

test/integration/smoke-test.ts

@@ -1,4 +1,4 @@
-import { Webhooks, createEventHandler } from "../../src";
+import { Webhooks, createEventHandler, emitterEventNames } from "../../src";
 
 test("@octokit/webhooks", () => {
   const emitWarningSpy = jest.spyOn(process, "emitWarning");
@@ -23,3 +23,9 @@ test('require("@octokit/webhooks").createEventHandler', () => {
   }).not.toThrow();
   expect(emitWarningSpy).not.toHaveBeenCalled();
 });
+
+test('require("@octokit/webhooks").emitterEventNames', () => {
+  const allEvents = emitterEventNames;
+  expect(typeof allEvents).toBe("object");
+  expect(typeof allEvents[0]).toBe("string");
+});