@platformatic/foundation 3.63.0 → 3.65.0

package/index.d.ts

@@ -6,6 +6,7 @@ import { LevelWithSilentOrString, Logger } from 'pino'
 
 // Symbols
 export declare const kCanceled: unique symbol
+export declare const kEnvFileFallbackKeys: unique symbol
 export declare const kFailedImport: unique symbol
 export declare const kHandledError: unique symbol
 export declare const kMetadata: unique symbol
@@ -78,7 +79,17 @@ export interface ValidationError {
 export type ConfigurationOptions<T = {}> = Partial<{
   validate: boolean
   validationOptions: object
-  transform: (config: Configuration<T>) => Promise<Configuration<T>> | Configuration<T>
+  // Read directly off the context by every capability package (astro, basic,
+  // next, node, service, ...) to pick a development/production code path.
+  isProduction: boolean
+  // loadConfiguration() always invokes the caller-supplied transform hook
+  // with all three arguments (config, schema, options), mirroring the
+  // exported transform() function's own parameter list.
+  transform: (
+    config: Configuration<T>,
+    schema: object,
+    options: ConfigurationOptions<T>
+  ) => Promise<Configuration<T>> | Configuration<T>
   upgrade: (logger: Logger, config: RawConfiguration, version: string) => Promise<RawConfiguration> | RawConfiguration
   env: Record<string, string>
   ignoreProcessEnv: boolean
@@ -155,9 +166,13 @@ export declare function replaceEnv (
   onMissingEnv?: (key: string) => string | undefined,
   ignore?: string[]
 ): RawConfiguration
+// `config` also accepts an array: the exported `applications` schema is a
+// JSONSchemaType<object[]> (an ARRAY schema), and validate() is called with
+// a matching array of application configs before they are handed to
+// prepareApplication()/addApplications().
 export declare function validate (
   schema: JSONSchemaType<any>,
-  config: RawConfiguration,
+  config: RawConfiguration | RawConfiguration[],
   validationOptions?: object,
   fixPaths?: boolean,
   root?: string
@@ -167,7 +182,22 @@ export declare function loadConfiguration (
   schema?: any,
   options?: ConfigurationOptions
 ): Promise<Configuration>
-export declare function loadConfigurationModule (root: string, config: RawConfiguration | ModuleWithVersion): any
+
+// The capability module object returned by loadConfigurationModule(): the
+// object a capability exports (its shape is otherwise capability-defined,
+// hence the index signature).
+export interface ConfigurationModule {
+  loadConfiguration?: (configPath: string) => Promise<unknown>
+  skipTelemetryHooks?: boolean
+  createCommands?: (applicationId: string) => unknown
+  modulesToLoad?: string[]
+  [key: string]: unknown
+}
+export declare function loadConfigurationModule (
+  root: string,
+  config: RawConfiguration | ModuleWithVersion,
+  pkg?: string
+): Promise<ConfigurationModule>
 
 // Error types
 export declare const ERROR_PREFIX: string

package/lib/configuration.js

@@ -18,7 +18,7 @@ import {
 } from './errors.js'
 import { isFileAccessible } from './file-system.js'
 import { loadModule, splitModuleFromVersion } from './module.js'
-import { kMetadata } from './symbols.js'
+import { kEnvFileFallbackKeys, kMetadata } from './symbols.js'
 
 const { parse: parseJSON5, stringify: rawStringifyJSON5 } = JSON5
 const { parse: parseTOML, stringify: stringifyTOML } = toml
@@ -386,11 +386,21 @@ export async function loadEnv (root, ignoreProcessEnv = false, additionalEnv = {
   // The env file provides fallback defaults: variables already set in the real
   // environment (and explicit programmatic values) take precedence over it,
   // matching the dotenv/docker-compose/Vite convention.
-  return {
+  const env = {
     ...envFromFile,
     ...baseEnv,
     ...additionalEnv
   }
+
+  // Keys whose only source is the env file are not real environment variables, they are defaults:
+  // a more specific env file, like the one of a single application inside a runtime, must still be
+  // able to override them. The list is attached non enumerably, so spreading, Object.keys,
+  // JSON.stringify and structuredClone of the returned environment are all unchanged.
+  const fallbackKeys = Object.keys(envFromFile).filter(key => !(key in baseEnv) && !(key in additionalEnv))
+
+  Object.defineProperty(env, kEnvFileFallbackKeys, { value: fallbackKeys, enumerable: false })
+
+  return env
 }
 
 export function replaceEnv (config, env, onMissingEnv, ignore) {

package/lib/schema.js

@@ -596,6 +596,18 @@ export const fastifyServer = {
         }
       }
     },
+    ajv: {
+      type: 'object',
+      description:
+        'Options for the Fastify request-validation Ajv instance (the Fastify `ajv` server option). Only `customOptions` is configurable from the config file; for example set `customOptions.coerceTypes` to `false` to reject empty strings on fields that allow the `null` type instead of coercing them to `null`.',
+      properties: {
+        customOptions: {
+          type: 'object',
+          additionalProperties: true
+        }
+      },
+      additionalProperties: false
+    },
     caseSensitive: {
       type: 'boolean'
     },

package/lib/symbols.js

@@ -1,4 +1,5 @@
 export const kCanceled = Symbol('plt.foundation.canceled')
+export const kEnvFileFallbackKeys = Symbol('plt.foundation.envFileFallbackKeys')
 export const kFailedImport = Symbol('plt.foundation.failedImport')
 export const kHandledError = Symbol('plt.foundation.handledError')
 export const kMetadata = Symbol('plt.foundation.metadata')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/foundation",
-  "version": "3.63.0",
+  "version": "3.65.0",
   "description": "Platformatic Foundation",
   "main": "index.js",
   "types": "index.d.ts",