Adapt the types to the OpenAPI spec types

[wolfy1339]

The types will need to be adapted to make use of the OpenAPI spec.

We can make use of my package @wolfy1339/openapi-webhooks-types to help with the transition.

---

Some points which I see as potential issues:

The types format is not the same, the webhooks are not on their own interface like they are currently in @octokit/webhooks-types.
In the OpanAPI spec types, the way to get a webhook resembles like so:

import { webhooks } from `@wolfy1339/openapi-webhooks-types`;

type TEventIdentifier = "check-suite-completed";
type CheckSuiteCompletedEvent = webhooks[TEventIdentifier]["post"]["requestBody"]["content"]["application/json"];

Each webhook definition's name is made like so in reference to the names we accept in the event handlers

const webhookIdentifier = "check_suite.completed".replaceAll(/_|\./g, "-");
// webhookIdentifier: check-suite-completed

The name is seperated by - and dots are replaced by -

There are currently no types for events and all their possible actions, eg: check_suite.

I'm not sure how we can get around this easily without having to resort to a lookup table. If you have any ideas, please comment

[wolfy1339]

In #444, we switched from a map of event names and their payloads, to an approach that only uses TypeScript to infer the correct types.

In order to switch to OpenAPI, I had to bring that map back.

I created a PoC, beta...openapi based on my openapi types package

Does anyone have an idea on how to get rid of the map, and stay with a completely typescript approach?

[wolfy1339]

I managed to create this handy utility that can help us convert the webhook event names we get from the event handler to the format used in the openapi spec

type SnakeCaseToKebabCase<TString extends string> =
  TString extends `${infer TPart1}_${infer TRest}`
    ? `${TPart1}-${SnakeCaseToKebabCase<TRest>}`
    : TString;

With this new utility I managed to remove most of the need for a map.
f84e6f1

[github-actions]

🎉 This issue has been resolved in version 12.2.0-beta.1 🎉

The release is available on:

• GitHub release
• npm package (@beta dist-tag)

Your semantic-release bot 📦🚀