Convert webhooks directory JS files to TypeScript (#55608)

Co-authored-by: Copilot <[email protected]>

Author: heiskr

src/webhooks/lib/index.js src/webhooks/lib/index.tssrc/webhooks/lib/index.js renamed to src/webhooks/lib/index.ts

@@ -7,32 +7,44 @@ export const WEBHOOK_DATA_DIR = 'src/webhooks/data'
 export const WEBHOOK_SCHEMA_FILENAME = 'schema.json'
 
 // cache for webhook data per version
-const webhooksCache = new Map()
+const webhooksCache = new Map<string, Promise<Record<string, any>>>()
 // cache for webhook data for when you first visit the webhooks page where we
 // show all webhooks for the current version but only 1 action type per webhook
 // and also no nested parameters
-const initialWebhooksCache = new Map()
+const initialWebhooksCache = new Map<string, InitialWebhook[]>()
+
+interface InitialWebhook {
+  name: string
+  actionTypes: string[]
+  data: {
+    bodyParameters?: Array<{
+      childParamsGroups?: any[]
+      [key: string]: any
+    }>
+    [key: string]: any
+  }
+}
 
 // return the webhoook data as described for `initialWebhooksCache` for the given
 // version
-export async function getInitialPageWebhooks(version) {
+export async function getInitialPageWebhooks(version: string): Promise<InitialWebhook[]> {
   if (initialWebhooksCache.has(version)) {
-    return initialWebhooksCache.get(version)
+    return initialWebhooksCache.get(version) || []
   }
   const allWebhooks = await getWebhooks(version)
-  const initialWebhooks = []
+  const initialWebhooks: InitialWebhook[] = []
 
   // The webhooks page shows all webhooks but for each webhook only a single
   // webhook action type at a time.  We pick the first webhook type from each
   // webhook's set of action types to show.
   for (const [key, webhook] of Object.entries(allWebhooks)) {
     const actionTypes = Object.keys(webhook)
-    const defaultAction = actionTypes ? actionTypes[0] : null
+    const defaultAction = actionTypes.length > 0 ? actionTypes[0] : ''
 
-    const initialWebhook = {
+    const initialWebhook: InitialWebhook = {
       name: key,
       actionTypes,
-      data: webhook[defaultAction],
+      data: defaultAction ? webhook[defaultAction] : {},
     }
 
     // remove all nested params for the initial webhooks page, we'll load
@@ -54,13 +66,16 @@ export async function getInitialPageWebhooks(version) {
 // returns the webhook data for the given version and webhook category (e.g.
 // `check_run`) -- this includes all the data per webhook action type and all
 // nested parameters
-export async function getWebhook(version, webhookCategory) {
+export async function getWebhook(
+  version: string,
+  webhookCategory: string,
+): Promise<Record<string, any> | undefined> {
   const webhooks = await getWebhooks(version)
   return webhooks[webhookCategory]
 }
 
 // returns all the webhook data for the given version
-export async function getWebhooks(version) {
+export async function getWebhooks(version: string): Promise<Record<string, any>> {
   const openApiVersion = getOpenApiVersion(version)
   if (!webhooksCache.has(openApiVersion)) {
     // The `readCompressedJsonFileFallback()` function
@@ -73,5 +88,5 @@ export async function getWebhooks(version) {
     )
   }
 
-  return webhooksCache.get(openApiVersion)
+  return webhooksCache.get(openApiVersion) || Promise.resolve({})
 }

src/webhooks/middleware/webhooks.js src/webhooks/middleware/webhooks.tssrc/webhooks/middleware/webhooks.js renamed to src/webhooks/middleware/webhooks.ts

@@ -10,7 +10,7 @@ const router = express.Router()
 // Example request:
 //
 //   /api/webhooks/v1?category=check_run&version=free-pro-team%40latest
-router.get('/v1', async function webhooks(req, res, next) {
+router.get('/v1', async function webhooks(req, res) {
   if (!req.query.category) {
     return res.status(400).json({ error: "Missing 'category' in query string" })
   }
@@ -27,7 +27,7 @@ router.get('/v1', async function webhooks(req, res, next) {
     return res.status(404).json({ error: notFoundError })
   }
 
-  const webhook = await getWebhook(webhookVersion, req.query.category)
+  const webhook = await getWebhook(webhookVersion, req.query.category as string)
 
   if (webhook) {
     if (process.env.NODE_ENV !== 'development') {