chore: convert functions helper to TS (#875)

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: ascorbic

src/constants.ts

@@ -17,7 +17,7 @@ export const HIDDEN_PATHS = [
 
 export const ODB_FUNCTION_PATH = `/.netlify/builders/${ODB_FUNCTION_NAME}`
 export const HANDLER_FUNCTION_PATH = `/.netlify/functions/${HANDLER_FUNCTION_NAME}`
-
+export const DEFAULT_FUNCTIONS_SRC = 'netlify/functions'
 export const CATCH_ALL_REGEX = /\/\[\.{3}(.*)](.json)?$/
 export const OPTIONAL_CATCH_ALL_REGEX = /\/\[{2}\.{3}(.*)]{2}(.json)?$/
 export const DYNAMIC_PARAMETER_REGEX = /\/\[(.*?)]/g

src/helpers/config.ts

@@ -1,16 +1,28 @@
 import { readJSON } from 'fs-extra'
+import type { NextConfigComplete } from 'next/dist/server/config-shared'
 import { join, dirname, relative } from 'pathe'
 import slash from 'slash'
 
 import { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME } from '../constants'
 
-import { RequiredServerFiles } from './requiredServerFilesType'
+export interface RequiredServerFiles {
+  version?: number
+  config?: NextConfigComplete
+  appDir?: string
+  files?: string[]
+  ignore?: string[]
+}
+
+export type NextConfig = Pick<RequiredServerFiles, 'appDir' | 'ignore'> & NextConfigComplete
 
 const defaultFailBuild = (message: string, { error }): never => {
   throw new Error(`${message}\n${error && error.stack}`)
 }
 
-export const getNextConfig = async function getNextConfig({ publish, failBuild = defaultFailBuild }) {
+export const getNextConfig = async function getNextConfig({
+  publish,
+  failBuild = defaultFailBuild,
+}): Promise<NextConfig> {
   try {
     const { config, appDir, ignore }: RequiredServerFiles = await readJSON(join(publish, 'required-server-files.json'))
     if (!config) {

src/helpers/functions.js src/helpers/functions.tssrc/helpers/functions.js renamed to src/helpers/functions.ts

@@ -1,23 +1,23 @@
-const { copyFile, ensureDir, writeFile, writeJSON } = require('fs-extra')
-const { join, relative } = require('pathe')
+import { NetlifyConfig, NetlifyPluginConstants } from '@netlify/build'
+import { copyFile, ensureDir, writeFile, writeJSON } from 'fs-extra'
+import type { ImageConfigComplete } from 'next/dist/server/image-config'
+import { join, relative } from 'pathe'
 
-const { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME, IMAGE_FUNCTION_NAME } = require('../constants')
-const getHandler = require('../templates/getHandler')
-const { getPageResolver } = require('../templates/getPageResolver')
+import { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME, IMAGE_FUNCTION_NAME, DEFAULT_FUNCTIONS_SRC } from '../constants'
+import getHandler from '../templates/getHandler'
+import { getPageResolver } from '../templates/getPageResolver'
 
-const DEFAULT_FUNCTIONS_SRC = 'netlify/functions'
-
-exports.generateFunctions = async (
-  { FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC, PUBLISH_DIR },
-  appDir,
-) => {
+export const generateFunctions = async (
+  { FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC, PUBLISH_DIR }: NetlifyPluginConstants,
+  appDir: string,
+): Promise<void> => {
   const functionsDir = INTERNAL_FUNCTIONS_SRC || FUNCTIONS_SRC
   const bridgeFile = require.resolve('@vercel/node/dist/bridge')
 
   const functionDir = join(process.cwd(), functionsDir, HANDLER_FUNCTION_NAME)
   const publishDir = relative(functionDir, join(process.cwd(), PUBLISH_DIR))
 
-  const writeHandler = async (func, isODB) => {
+  const writeHandler = async (func: string, isODB: boolean) => {
     const handlerSource = await getHandler({ isODB, publishDir, appDir: relative(functionDir, appDir) })
     await ensureDir(join(functionsDir, func))
     await writeFile(join(functionsDir, func, `${func}.js`), handlerSource)
@@ -36,11 +36,15 @@ exports.generateFunctions = async (
  * Writes a file in each function directory that contains references to every page entrypoint.
  * This is just so that the nft bundler knows about them. We'll eventually do this better.
  */
-exports.generatePagesResolver = async ({
+export const generatePagesResolver = async ({
   constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC },
   netlifyConfig,
   target,
-}) => {
+}: {
+  constants: NetlifyPluginConstants
+  netlifyConfig: NetlifyConfig
+  target: string
+}): Promise<void> => {
   const functionsPath = INTERNAL_FUNCTIONS_SRC || FUNCTIONS_SRC
 
   const jsSource = await getPageResolver({
@@ -53,12 +57,17 @@ exports.generatePagesResolver = async ({
 }
 
 // Move our next/image function into the correct functions directory
-exports.setupImageFunction = async ({
+export const setupImageFunction = async ({
   constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC },
   imageconfig = {},
   netlifyConfig,
   basePath,
-}) => {
+}: {
+  constants: NetlifyPluginConstants
+  netlifyConfig: NetlifyConfig
+  basePath: string
+  imageconfig: Partial<ImageConfigComplete>
+}): Promise<void> => {
   const functionsPath = INTERNAL_FUNCTIONS_SRC || FUNCTIONS_SRC
   const functionName = `${IMAGE_FUNCTION_NAME}.js`
   const functionDirectory = join(functionsPath, IMAGE_FUNCTION_NAME)