fix(gatsby): update script to generate apis.json to accomodate Typescript (#24023)

* Fix script to generate apis.json

* add snapshot test

* fix tests

Author: blainekasten

packages/gatsby/scripts/__tests__/api.js

@@ -0,0 +1,73 @@
+import fs from "fs-extra"
+import childProcess from "child_process"
+import systemPath from "path"
+
+const apiPath = systemPath.join(__dirname, "../../apis.json")
+
+it("generates the expected api output", done => {
+  childProcess.exec("node ../output-api-file.js", async () => {
+    const json = await fs.readJSON(apiPath)
+
+    expect(json).toMatchInlineSnapshot(`
+      Object {
+        "browser": Object {
+          "disableCorePrefetching": Object {},
+          "onClientEntry": Object {},
+          "onInitialClientRender": Object {},
+          "onPostPrefetchPathname": Object {},
+          "onPreRouteUpdate": Object {},
+          "onPrefetchPathname": Object {},
+          "onRouteUpdate": Object {},
+          "onRouteUpdateDelayed": Object {},
+          "onServiceWorkerActive": Object {},
+          "onServiceWorkerInstalled": Object {},
+          "onServiceWorkerRedundant": Object {},
+          "onServiceWorkerUpdateFound": Object {},
+          "onServiceWorkerUpdateReady": Object {},
+          "registerServiceWorker": Object {},
+          "replaceComponentRenderer": Object {
+            "deprecated": true,
+          },
+          "replaceHydrateFunction": Object {},
+          "shouldUpdateScroll": Object {},
+          "wrapPageElement": Object {},
+          "wrapRootElement": Object {},
+        },
+        "node": Object {
+          "createPages": Object {},
+          "createPagesStatefully": Object {},
+          "createResolvers": Object {
+            "version": "2.2.0",
+          },
+          "createSchemaCustomization": Object {
+            "version": "2.12.0",
+          },
+          "generateSideEffects": Object {},
+          "onCreateBabelConfig": Object {},
+          "onCreateDevServer": Object {},
+          "onCreateNode": Object {},
+          "onCreatePage": Object {},
+          "onCreateWebpackConfig": Object {},
+          "onPostBootstrap": Object {},
+          "onPostBuild": Object {},
+          "onPreBootstrap": Object {},
+          "onPreBuild": Object {},
+          "onPreExtractQueries": Object {},
+          "onPreInit": Object {},
+          "preprocessSource": Object {},
+          "resolvableExtensions": Object {},
+          "setFieldsOnGraphQLNodeType": Object {},
+          "sourceNodes": Object {},
+        },
+        "ssr": Object {
+          "onPreRenderHTML": Object {},
+          "onRenderBody": Object {},
+          "replaceRenderer": Object {},
+          "wrapPageElement": Object {},
+          "wrapRootElement": Object {},
+        },
+      }
+    `)
+    done()
+  })
+})

packages/gatsby/scripts/output-api-file.js

@@ -1,49 +1,50 @@
-const path = require('path')
-const documentation = require('documentation')
-const fs = require('fs-extra')
+const path = require("path")
+const documentation = require("documentation")
+const fs = require("fs-extra")
 
 const OUTPUT_FILE_NAME = `apis.json`
 
 async function outputFile() {
-  const apis = await Promise.all([
-    path.join('cache-dir', 'api-ssr-docs.js'),
-    path.join('src', 'utils', 'api-browser-docs.ts'),
-    path.join('src', 'utils', 'api-node-docs.ts')
-  ]
-    .map(filePath => {
+  const apis = await Promise.all(
+    [
+      path.join("cache-dir", "api-ssr-docs.js"),
+      path.join("src", "utils", "api-browser-docs.ts"),
+      path.join("src", "utils", "api-node-docs.ts")
+    ].map(filePath => {
       const resolved = path.resolve(filePath)
-      const [,api] = path.basename(filePath).split('-')
-      return documentation.build(resolved, {
-        shallow: true
-      })
+      const [, api] = path.basename(filePath).split("-")
+      return documentation
+        .build(resolved, {
+          shallow: true
+        })
         .then(contents => {
-          return [
-            contents,
-            api
-          ]
+          return [contents, api]
         })
     })
   )
 
   const output = apis.reduce((merged, [output, api]) => {
-    merged[api] = output.reduce((mergedOutput, doc) => {
-      const isAPI = doc.namespace.startsWith('.')
-      if (isAPI) {
-        const tags = doc.tags.reduce((mergedTags, tag) => {
-          mergedTags[tag.title] = tag.description
-          return mergedTags
-        }, {})
-        mergedOutput[doc.name] = {
-          deprecated: !!tags.deprecated || undefined,
-          version: tags.gatsbyVersion
-        }
+    merged[api] = output.reduce((mergedOutput, doc, i) => {
+      if (doc.kind === "typedef") return mergedOutput
+
+      const tags = doc.tags.reduce((mergedTags, tag) => {
+        mergedTags[tag.title] = tag.description
+        return mergedTags
+      }, {})
+      mergedOutput[doc.name] = {
+        deprecated: !!tags.deprecated || undefined,
+        version: tags.gatsbyVersion
       }
       return mergedOutput
     }, {})
     return merged
   }, {})
 
-  return fs.writeFile(path.resolve(OUTPUT_FILE_NAME), JSON.stringify(output, null, 2), 'utf8')
+  return fs.writeFile(
+    path.resolve(OUTPUT_FILE_NAME),
+    JSON.stringify(output, null, 2),
+    "utf8"
+  )
 }
 
 outputFile()