chore: use enum for api route type

Author: ascorbic

package-lock.json

@@ -4,34 +4,40 @@ import { extractExportedConstValue, UnsupportedValueError } from 'next/dist/buil
 import { parseModule } from 'next/dist/build/analysis/parse-module'
 import { relative } from 'pathe'
 
+// I have no idea what eslint is up to here but it gives an error
+// eslint-disable-next-line no-shadow
+export enum ApiRouteType {
+  SCHEDULED = 'experimental-scheduled',
+  BACKGROUND = 'experimental-background',
+}
+
 export interface ApiStandardConfig {
   type?: never
   runtime?: 'nodejs' | 'experimental-edge'
   schedule?: never
 }
 
 export interface ApiScheduledConfig {
-  type: 'experimental-scheduled'
+  type: ApiRouteType.SCHEDULED
   runtime?: 'nodejs'
   schedule: string
 }
 
 export interface ApiBackgroundConfig {
-  type: 'experimental-background'
+  type: ApiRouteType.BACKGROUND
   runtime?: 'nodejs'
   schedule?: never
 }
 
 export type ApiConfig = ApiStandardConfig | ApiScheduledConfig | ApiBackgroundConfig
 
 export const validateConfigValue = (config: ApiConfig, apiFilePath: string): config is ApiConfig => {
-  if (config.type === 'experimental-scheduled') {
+  if (config.type === ApiRouteType.SCHEDULED) {
     if (!config.schedule) {
       console.error(
-        `Invalid config value in ${relative(
-          process.cwd(),
-          apiFilePath,
-        )}: schedule is required when type is "experimental-scheduled"`,
+        `Invalid config value in ${relative(process.cwd(), apiFilePath)}: schedule is required when type is "${
+          ApiRouteType.SCHEDULED
+        }"`,
       )
       return false
     }
@@ -47,13 +53,12 @@ export const validateConfigValue = (config: ApiConfig, apiFilePath: string): con
     return true
   }
 
-  if (!config.type || config.type === 'experimental-background') {
+  if (!config.type || config.type === ApiRouteType.BACKGROUND) {
     if (config.schedule) {
       console.error(
-        `Invalid config value in ${relative(
-          process.cwd(),
-          apiFilePath,
-        )}: schedule is not allowed unless type is "experimental-scheduled"`,
+        `Invalid config value in ${relative(process.cwd(), apiFilePath)}: schedule is not allowed unless type is "${
+          ApiRouteType.SCHEDULED
+        }"`,
       )
       return false
     }

packages/runtime/src/helpers/analysis.ts

@@ -8,6 +8,7 @@ import { join } from 'pathe'
 
 import { OPTIONAL_CATCH_ALL_REGEX, CATCH_ALL_REGEX, DYNAMIC_PARAMETER_REGEX, HANDLER_FUNCTION_PATH } from '../constants'
 
+import { ApiRouteType } from './analysis'
 import type { ApiRouteConfig } from './functions'
 import { I18n } from './types'
 
@@ -148,26 +149,21 @@ export const getApiRewrites = (basePath: string, apiRoutes: Array<ApiRouteConfig
     const [from] = toNetlifyRoute(`${basePath}${apiRoute.route}`)
 
     // Scheduled functions can't be invoked directly, so we 404 them.
-    if (apiRoute.config.type === 'experimental-scheduled') {
+    if (apiRoute.config.type === ApiRouteType.SCHEDULED) {
       return { from, to: '/404.html', status: 404 }
     }
     return {
       from,
       to: `/.netlify/functions/${getFunctionNameForPage(
         apiRoute.route,
-        apiRoute.config.type === 'experimental-background',
+        apiRoute.config.type === ApiRouteType.BACKGROUND,
       )}`,
       status: 200,
     }
   })
 
   return [
     ...apiRewrites,
-    {
-      from: `${basePath}/api`,
-      to: HANDLER_FUNCTION_PATH,
-      status: 200,
-    },
     {
       from: `${basePath}/api/*`,
       to: HANDLER_FUNCTION_PATH,

packages/runtime/src/helpers/utils.ts

@@ -3,7 +3,7 @@ import type { Bridge as NodeBridge } from '@vercel/node-bridge/bridge'
 // Aliasing like this means the editor may be able to syntax-highlight the string
 import { outdent as javascript } from 'outdent'
 
-import { ApiConfig } from '../helpers/analysis'
+import { ApiConfig, ApiRouteType } from '../helpers/analysis'
 import type { NextConfig } from '../helpers/config'
 
 import type { NextServerType } from './handlerUtils'
@@ -133,7 +133,7 @@ export const getApiHandler = ({
   const { Bridge } = require("./bridge");
   const { getMaxAge, getMultiValueHeaders, getNextServer } = require('./handlerUtils')
 
-  ${config.type === 'experimental-scheduled' ? `const { schedule } = require("@netlify/functions")` : ''}
+  ${config.type === ApiRouteType.SCHEDULED ? `const { schedule } = require("@netlify/functions")` : ''}
 
 
   const { config }  = require("${publishDir}/required-server-files.json")
@@ -142,6 +142,6 @@ export const getApiHandler = ({
   const pageRoot = path.resolve(path.join(__dirname, "${publishDir}", "serverless", "pages"));
   const handler = (${makeHandler.toString()})(config, "${appDir}", pageRoot, ${JSON.stringify(page)})
   exports.handler = ${
-    config.type === 'experimental-scheduled' ? `schedule(${JSON.stringify(config.schedule)}, handler);` : 'handler'
+    config.type === ApiRouteType.SCHEDULED ? `schedule(${JSON.stringify(config.schedule)}, handler);` : 'handler'
   }
 `