@platformatic/next 4.0.0-new-config.2 → 4.0.0-new-config.5

package/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseCapability, BaseContext, BaseOptions } from '@platformatic/basic'
+import { ApplicationDefinition, BaseCapability, BaseContext, BaseOptions, CapabilityFactoryOptions, ConfigContext, DeferredApplicationDefinition } from '@platformatic/basic'
 import { Configuration, ConfigurationOptions } from '@platformatic/foundation'
 import { JSONSchemaType } from 'ajv'
 import { FastifyError } from 'fastify'
@@ -6,6 +6,26 @@ import type { PlatformaticNextJsConfig } from './config.d.ts'
 
 export type { PlatformaticNextJsConfig } from './config.d.ts'
 
+/*
+  The option types this capability's configuration is built from, generated from the audited schema.
+  `NextHttpsOptions` is Next's own and sits next to `AppServerOptions['https']`, which is
+  `HttpsOptions`: two adjacent keys spelled almost alike, which is exactly why both have names.
+*/
+export type {
+  AppLoggerOptions,
+  AppServerOptions,
+  ApplicationHealthOptions,
+  ApplicationTelemetryOverrides,
+  ApplicationWorkersOptions,
+  BuildableApplicationOptions,
+  HttpsOptions,
+  ImageOptimizerOptions,
+  NextCacheOptions,
+  NextHttpsOptions,
+  PermissionsOptions,
+  WatchOptions
+} from './config.d.ts'
+
 export interface NextContext extends BaseContext {}
 
 export type NextConfiguration = Configuration<PlatformaticNextJsConfig>
@@ -55,3 +75,10 @@ export namespace errors {
   export const StandaloneServerNotFound: () => FastifyError
   export const CannotParseStandaloneServer: () => FastifyError
 }
+
+export type NextConfigOptions = CapabilityFactoryOptions<PlatformaticNextJsConfig, 'next', never>
+
+export declare function next (options?: NextConfigOptions): ApplicationDefinition
+export declare function next (
+  callback: (context: ConfigContext) => NextConfigOptions | Promise<NextConfigOptions>
+): DeferredApplicationDefinition

package/lib/capability.js

@@ -316,10 +316,6 @@ export class NextCapability extends BaseCapability {
 
     if (command) {
       const childManagerScripts = this.#getChildManagerScripts()
-
-      if (this.#nextVersion.major < 15 || (this.#nextVersion.major <= 15 && this.#nextVersion.minor < 1)) {
-        childManagerScripts.push(new URL('./create-context-patch.js', import.meta.url))
-      }
       return this.startWithCommand(command, loaderUrl, childManagerScripts)
     }
 
@@ -345,6 +341,7 @@ export class NextCapability extends BaseCapability {
     try {
       updateGlobals({ config: this.config })
       await this.childManager.inject()
+      await this.childManager.register()
       const { nextStart } = await importFile(resolvePath(this.#next, './dist/cli/next-start.js'))
 
       const { hostname, port } = this.serverConfig ?? {}
@@ -353,8 +350,6 @@ export class NextCapability extends BaseCapability {
         port: port || 0
       }
 
-      await this.childManager.register()
-
       const serverPromise = createServerListener()
 
       if (this.#nextVersion.major === 14 && this.#nextVersion.minor < 2) {
@@ -443,6 +438,10 @@ export class NextCapability extends BaseCapability {
       scripts.push(new URL('./loader-next-15.cjs', import.meta.url))
     }
 
+    if (this.#nextVersion.major < 15 || (this.#nextVersion.major === 15 && this.#nextVersion.minor < 1)) {
+      scripts.push(new URL('./create-context-patch.js', import.meta.url))
+    }
+
     return scripts
   }
 

package/lib/commands/pack.js

@@ -37,7 +37,16 @@ export async function packCommand (logger, configFile, args, context) {
 
   let config
   try {
-    config = await loadConfiguration(configFile)
+    /*
+      v4 hands a command the application's already-resolved configuration as data -- the loader
+      evaluated it once, main-side, and validated it against this capability's schema -- so
+      `resolved` says the reading is done. A path is still accepted, which is what a caller outside
+      a running project supplies, and it is loaded the way a boot loads one.
+    */
+    config =
+      typeof configFile === 'string'
+        ? await loadConfiguration(configFile)
+        : await loadConfiguration(context.application?.path ?? process.cwd(), configFile, { resolved: true })
   } catch (error) {
     return logFatalError(
       logger,

package/lib/config.js

@@ -1,5 +1,4 @@
-import { transform as basicTransform, resolve, validationOptions } from '@platformatic/basic'
-import { loadConfiguration as utilsLoadConfiguration } from '@platformatic/foundation'
+import { transform as basicTransform, loadCapabilityConfiguration, validationOptions } from '@platformatic/basic'
 import { schema } from './schema.js'
 
 export async function transform (config, schema, options) {
@@ -14,13 +13,11 @@ export async function transform (config, schema, options) {
 }
 
 export async function loadConfiguration (configOrRoot, sourceOrConfig, context) {
-  const { root, source } = await resolve(configOrRoot, sourceOrConfig, 'application')
-
-  return utilsLoadConfiguration(source, context?.schema ?? schema, {
+  return loadCapabilityConfiguration(configOrRoot, sourceOrConfig, context, {
+    schema,
+    scope: import.meta.filename,
+    suffixes: 'application',
     validationOptions,
-    transform,
-    replaceEnv: true,
-    root,
-    ...context
+    transform
   })
 }

package/lib/create-context-patch.js

@@ -1,7 +1,7 @@
 'use strict'
 
 import { createRequire } from 'node:module'
-import { getGlobalDispatcher } from 'undici'
+import { fetch, getGlobalDispatcher } from 'undici'
 
 // Next.js runs middlewares in it's own patched vm context. So the global dispatcher in
 // the middleware context is different from an application global dispatcher. This
@@ -16,12 +16,16 @@ export function patchVmCreateContext () {
     const globalDispatcher = getGlobalDispatcher()
     const context = originalCreateContext(contextObject, opts)
     queueMicrotask(() => {
-      if (contextObject.fetch === undefined) return
+      if (context.fetch === undefined) return
 
-      const originalFetch = contextObject.fetch
-      contextObject.fetch = (input, init = {}) => {
-        init.dispatcher = globalDispatcher
-        return originalFetch(input, init)
+      const originalFetch = context.fetch
+      context.fetch = (input, init = {}) => {
+        const url = typeof input === 'string' ? input : input?.url
+        if (!url?.startsWith('http://') && !url?.startsWith('https://')) {
+          return originalFetch(input, init)
+        }
+
+        return fetch(input, { ...init, dispatcher: globalDispatcher })
       }
     })
     return context

package/lib/pack.js

@@ -15,7 +15,7 @@ import {
   symlink,
   writeFile
 } from 'node:fs/promises'
-import { createRequire } from 'node:module'
+import { findPackageJSON } from 'node:module'
 import { tmpdir } from 'node:os'
 import { dirname, isAbsolute, relative, resolve as resolvePath } from 'node:path'
 import { version as platformaticVersion } from './schema.js'
@@ -169,60 +169,15 @@ async function loadPackageFromRoot (root, fallbackName) {
 }
 
 async function resolvePackageRoot (name, from) {
-  const require = createRequire(from)
-
   try {
-    const packageJsonPath = require.resolve(`${name}/package.json`)
-    return dirname(packageJsonPath)
+    return dirname(findPackageJSON(name, from))
   } catch (error) {
-    const packageJsonPath = resolvePackageJsonFromSearchPaths(require, name)
-    if (packageJsonPath) {
-      return dirname(packageJsonPath)
-    }
-
-    try {
-      const resolvedEntry = require.resolve(name)
-      return await findPackageRoot(dirname(resolvedEntry))
-    } catch (resolveError) {
-      const workspacePackage = resolveWorkspacePackageRoot(name)
-      if (workspacePackage) {
-        return workspacePackage
-      }
-
-      throw resolveError
-    }
-  }
-}
-
-function resolvePackageJsonFromSearchPaths (require, name) {
-  const searchPaths = require.resolve.paths(name) ?? []
-  const packageSegments = name.split('/')
-
-  for (const searchPath of searchPaths) {
-    const candidate = resolvePath(searchPath, ...packageSegments, 'package.json')
-    if (existsSync(candidate)) {
-      return candidate
-    }
-  }
-
-  return null
-}
-
-async function findPackageRoot (directory) {
-  let current = directory
-
-  while (true) {
-    const candidate = resolvePath(current, 'package.json')
-    if (existsSync(candidate)) {
-      return current
-    }
-
-    const parent = resolvePath(current, '..')
-    if (parent === current) {
-      throw new Error(`Cannot determine package root for ${directory}.`)
+    const workspacePackage = resolveWorkspacePackageRoot(name)
+    if (workspacePackage) {
+      return workspacePackage
     }
 
-    current = parent
+    throw error
   }
 }
 

package/lib/schema.js

@@ -243,6 +243,15 @@ const next = {
   additionalProperties: false
 }
 
+/*
+  The names the generated types carry -- see the table in `foundation/lib/schema.js` for why they
+  are assigned rather than written at each site. `https` is Next's own, distinct from `server.https`
+  next to it, and the two names are what keeps that adjacency legible.
+*/
+next.properties.https.title = 'NextHttpsOptions'
+next.properties.imageOptimizer.title = 'ImageOptimizerOptions'
+cache.title = 'NextCacheOptions'
+
 export const schemaComponents = { next }
 
 export const schema = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/next",
-  "version": "4.0.0-new-config.2",
+  "version": "4.0.0-new-config.5",
   "description": "Platformatic Next.js Capability",
   "main": "index.js",
   "type": "module",
@@ -31,9 +31,9 @@
     "light-my-request": "^6.0.0",
     "msgpackr": "^1.11.2",
     "semver": "^7.6.3",
-    "@platformatic/basic": "4.0.0-new-config.2",
-    "@platformatic/globals": "4.0.0-new-config.2",
-    "@platformatic/foundation": "4.0.0-new-config.2"
+    "@platformatic/basic": "4.0.0-new-config.5",
+    "@platformatic/foundation": "4.0.0-new-config.5",
+    "@platformatic/globals": "4.0.0-new-config.5"
   },
   "devDependencies": {
     "@fastify/reply-from": "^12.0.0",
@@ -50,8 +50,8 @@
     "next": "^16.1.0",
     "typescript": "~6.0.3",
     "ws": "^8.18.0",
-    "@platformatic/gateway": "4.0.0-new-config.2",
-    "@platformatic/service": "4.0.0-new-config.2"
+    "@platformatic/service": "4.0.0-new-config.5",
+    "@platformatic/gateway": "4.0.0-new-config.5"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/next/4.0.0-new-config.2.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/next/4.0.0-new-config.5.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Next.js Config",
   "type": "object",
@@ -178,7 +178,8 @@
         }
       },
       "default": {},
-      "additionalProperties": true
+      "additionalProperties": true,
+      "title": "AppLoggerOptions"
     },
     "server": {
       "type": "object",
@@ -302,10 +303,12 @@
           "required": [
             "key",
             "cert"
-          ]
+          ],
+          "title": "HttpsOptions"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "title": "AppServerOptions"
     },
     "watch": {
       "anyOf": [
@@ -341,7 +344,8 @@
               "default": null
             }
           },
-          "additionalProperties": false
+          "additionalProperties": false,
+          "title": "WatchOptions"
         },
         {
           "type": "boolean"
@@ -390,9 +394,6 @@
           "default": {},
           "additionalProperties": false
         },
-        "entrypointPort": {
-          "type": "number"
-        },
         "changeDirectoryBeforeExecution": {
           "type": "boolean",
           "default": false
@@ -407,7 +408,8 @@
       },
       "additionalProperties": false,
       "required": [],
-      "default": {}
+      "default": {},
+      "title": "BuildableApplicationOptions"
     },
     "runtime": {
       "type": "object",
@@ -452,7 +454,8 @@
                   "type": "boolean",
                   "default": false
                 }
-              }
+              },
+              "title": "ExtensionEntry"
             },
             {
               "type": "array",
@@ -481,7 +484,8 @@
                         "type": "boolean",
                         "default": false
                       }
-                    }
+                    },
+                    "title": "ExtensionEntry"
                   }
                 ]
               }
@@ -548,6 +552,9 @@
               "url": {
                 "type": "string"
               },
+              "module": {
+                "type": "string"
+              },
               "gitBranch": {
                 "type": "string",
                 "default": "main"
@@ -589,7 +596,8 @@
                         "minimum": 0,
                         "maximum": 1
                       }
-                    }
+                    },
+                    "title": "ApplicationWorkersOptions"
                   }
                 ]
               },
@@ -742,7 +750,8 @@
                     ]
                   }
                 },
-                "additionalProperties": false
+                "additionalProperties": false,
+                "title": "ApplicationHealthOptions"
               },
               "restartOnError": {
                 "description": "Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.",
@@ -841,14 +850,15 @@
                     "additionalProperties": false
                   }
                 },
-                "additionalProperties": false
+                "additionalProperties": false,
+                "title": "PermissionsOptions"
               },
-              "telemetry": {
+              "tracing": {
                 "type": "object",
                 "properties": {
                   "instrumentations": {
                     "type": "array",
-                    "description": "An array of instrumentations loaded if telemetry is enabled",
+                    "description": "An array of instrumentations loaded if tracing is enabled",
                     "items": {
                       "oneOf": [
                         {
@@ -875,7 +885,8 @@
                       ]
                     }
                   }
-                }
+                },
+                "title": "ApplicationTelemetryOverrides"
               },
               "compileCache": {
                 "anyOf": [
@@ -895,7 +906,8 @@
                         "description": "Directory to store compile cache. Defaults to .plt/compile-cache in app root"
                       }
                     },
-                    "additionalProperties": false
+                    "additionalProperties": false,
+                    "title": "CompileCacheOptions"
                   }
                 ]
               },
@@ -922,7 +934,8 @@
                   }
                 ]
               }
-            }
+            },
+            "title": "ApplicationEntry"
           }
         },
         "workers": {
@@ -979,7 +992,8 @@
                   "minimum": 0,
                   "maximum": 1
                 }
-              }
+              },
+              "title": "WorkersOptions"
             }
           ]
         },
@@ -1163,7 +1177,8 @@
             }
           },
           "default": {},
-          "additionalProperties": true
+          "additionalProperties": true,
+          "title": "AppLoggerOptions"
         },
         "reuseTcpPorts": {
           "type": "boolean",
@@ -1235,7 +1250,8 @@
             "runtime",
             "application"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "title": "GracefulShutdownOptions"
         },
         "health": {
           "type": "object",
@@ -1397,7 +1413,8 @@
               "default": 262144
             }
           },
-          "additionalProperties": false
+          "additionalProperties": false,
+          "title": "HealthOptions"
         },
         "healthProbes": {
           "anyOf": [
@@ -1514,7 +1531,8 @@
                   ]
                 }
               },
-              "additionalProperties": false
+              "additionalProperties": false,
+              "title": "HealthProbesOptions"
             }
           ],
           "default": true
@@ -1611,7 +1629,8 @@
                 }
               ]
             }
-          }
+          },
+          "title": "UndiciOptions"
         },
         "httpCache": {
           "oneOf": [
@@ -1667,7 +1686,8 @@
                   "default": "shared",
                   "description": "Cache type. \"shared\" caches may be shared between users, \"private\" caches are user-specific."
                 }
-              }
+              },
+              "title": "HttpCacheOptions"
             }
           ]
         },
@@ -1708,7 +1728,8 @@
                   "description": "Custom path for the control socket. If not specified, uses the default platform-specific location."
                 }
               },
-              "additionalProperties": false
+              "additionalProperties": false,
+              "title": "ManagementApiOptions"
             }
           ],
           "default": true
@@ -1861,7 +1882,8 @@
                   "required": [
                     "key",
                     "cert"
-                  ]
+                  ],
+                  "title": "HttpsOptions"
                 },
                 "auth": {
                   "type": "object",
@@ -2140,11 +2162,13 @@
                   }
                 }
               },
-              "additionalProperties": false
+              "additionalProperties": false,
+              "title": "MetricsOptions"
             }
-          ]
+          ],
+          "default": false
         },
-        "telemetry": {
+        "tracing": {
           "type": "object",
           "properties": {
             "enabled": {
@@ -2315,7 +2339,8 @@
           "required": [
             "applicationName"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "title": "TelemetryOptions"
         },
         "verticalScaler": {
           "type": "object",
@@ -2571,7 +2596,8 @@
                   "description": "Directory to store compile cache. Defaults to .plt/compile-cache in app root"
                 }
               },
-              "additionalProperties": false
+              "additionalProperties": false,
+              "title": "CompileCacheOptions"
             }
           ]
         },
@@ -2615,7 +2641,8 @@
                       "minimum": 0,
                       "maximum": 1
                     }
-                  }
+                  },
+                  "title": "ApplicationWorkersOptions"
                 }
               ]
             },
@@ -2768,7 +2795,8 @@
                   ]
                 }
               },
-              "additionalProperties": false
+              "additionalProperties": false,
+              "title": "ApplicationHealthOptions"
             },
             "restartOnError": {
               "description": "Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.",
@@ -2860,14 +2888,15 @@
                   "additionalProperties": false
                 }
               },
-              "additionalProperties": false
+              "additionalProperties": false,
+              "title": "PermissionsOptions"
             },
-            "telemetry": {
+            "tracing": {
               "type": "object",
               "properties": {
                 "instrumentations": {
                   "type": "array",
-                  "description": "An array of instrumentations loaded if telemetry is enabled",
+                  "description": "An array of instrumentations loaded if tracing is enabled",
                   "items": {
                     "oneOf": [
                       {
@@ -2894,7 +2923,8 @@
                     ]
                   }
                 }
-              }
+              },
+              "title": "ApplicationTelemetryOverrides"
             },
             "compileCache": {
               "anyOf": [
@@ -2914,7 +2944,8 @@
                       "description": "Directory to store compile cache. Defaults to .plt/compile-cache in app root"
                     }
                   },
-                  "additionalProperties": false
+                  "additionalProperties": false,
+                  "title": "CompileCacheOptions"
                 }
               ]
             }
@@ -2961,7 +2992,8 @@
               "type": "string"
             }
           },
-          "additionalProperties": false
+          "additionalProperties": false,
+          "title": "NextHttpsOptions"
         },
         "imageOptimizer": {
           "type": "object",
@@ -3088,7 +3120,8 @@
             "enabled",
             "fallback"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "title": "ImageOptimizerOptions"
         }
       },
       "default": {},
@@ -3173,7 +3206,8 @@
         "adapter",
         "url"
       ],
-      "additionalProperties": false
+      "additionalProperties": false,
+      "title": "NextCacheOptions"
     }
   },
   "additionalProperties": false