type frameworks api config

Author: pieh

src/adapter/adapter.ts

@@ -7,6 +7,7 @@ import {
   modifyConfig as modifyConfigForImageCDN,
   onBuildComplete as onBuildCompleteForImageCDN,
 } from './image-cdn.js'
+import { FrameworksAPIConfig } from './types.js'
 
 const NETLIFY_FRAMEWORKS_API_CONFIG_PATH = '.netlify/v1/config.json'
 
@@ -23,8 +24,7 @@ const adapter: NextAdapter = {
   async onBuildComplete(ctx) {
     console.log('onBuildComplete hook called')
 
-    // TODO: do we have a type for this? https://docs.netlify.com/build/frameworks/frameworks-api/#netlifyv1configjson
-    let frameworksAPIConfig: any = null
+    let frameworksAPIConfig: FrameworksAPIConfig = null
 
     frameworksAPIConfig = onBuildCompleteForImageCDN(ctx, frameworksAPIConfig)
 

src/adapter/image-cdn.ts

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url'
 import type { RemotePattern } from 'next-with-adapters/dist/shared/lib/image-config.js'
 import { makeRe } from 'picomatch'
 
-import type { NextConfigComplete, OnBuildCompleteContext } from './types.js'
+import type { FrameworksAPIConfig, NextConfigComplete, OnBuildCompleteContext } from './types.js'
 
 const NETLIFY_IMAGE_LOADER_FILE = fileURLToPath(import.meta.resolve(`./next-image-loader.cjs`))
 
@@ -20,8 +20,11 @@ function generateRegexFromPattern(pattern: string): string {
   return makeRe(pattern).source
 }
 
-export function onBuildComplete(ctx: OnBuildCompleteContext, frameworksAPIConfigArg: any) {
-  const frameworksAPIConfig: any = frameworksAPIConfigArg ?? {}
+export function onBuildComplete(
+  ctx: OnBuildCompleteContext,
+  frameworksAPIConfigArg: FrameworksAPIConfig,
+) {
+  const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
 
   // when migrating from @netlify/plugin-nextjs@4 image redirect to ipx might be cached in the browser
   frameworksAPIConfig.redirects ??= []
@@ -95,7 +98,7 @@ export function onBuildComplete(ctx: OnBuildCompleteContext, frameworksAPIConfig
 
     if (remoteImageSources.length !== 0) {
       // https://docs.netlify.com/build/frameworks/frameworks-api/#images
-      frameworksAPIConfig.images ??= {}
+      frameworksAPIConfig.images ??= { remote_images: [] }
       frameworksAPIConfig.images.remote_images = remoteImageSources
     }
   }

src/adapter/types.ts

@@ -1,4 +1,9 @@
+import type { NetlifyConfig } from '@netlify/build'
 import type { NextAdapter } from 'next-with-adapters'
 
 export type OnBuildCompleteContext = Parameters<Required<NextAdapter>['onBuildComplete']>[0]
 export type NextConfigComplete = OnBuildCompleteContext['config']
+
+export type FrameworksAPIConfig = Partial<
+  Pick<NetlifyConfig, 'edge_functions' | 'functions' | 'headers' | 'redirects' | 'images'>
+> | null