@pristine-ts/configuration 2.0.4 → 2.0.6

package/dist/types/managers/configuration.manager.d.ts

@@ -2,12 +2,14 @@ import { DependencyContainer } from "tsyringe";
 import { ModuleConfigurationValue } from "../types/module-configuration.value";
 import { ConfigurationParser } from "../parsers/configuration.parser";
 import { ConfigurationDefinition } from "@pristine-ts/common";
+import { PristineConfigFileLoader } from "../loaders/pristine-config-file.loader";
 export declare class ConfigurationManager {
     private readonly configurationParser;
+    private readonly pristineConfigFileLoader;
     configurationDefinitions: {
         [key: string]: ConfigurationDefinition;
     };
-    constructor(configurationParser: ConfigurationParser);
+    constructor(configurationParser: ConfigurationParser, pristineConfigFileLoader: PristineConfigFileLoader);
     /**
      * This method registers the configuration definition that a module has defined. This method will be called for each
      * configuration definition defined in each module.
@@ -16,18 +18,35 @@ export declare class ConfigurationManager {
      */
     register(configurationDefinition: ConfigurationDefinition): void;
     /**
-     * This method loads the configuration values passed dynamically when instantiating the Kernel. This method
-     * will verify that a corresponding configurationDefinition exists and if it does, it will resolve the value.
+     * Loads configuration values into the container using the precedence chain:
      *
-     * This method will also check to make sure that all the expected values are being passed. For example, if a module expects
-     * a configuration value to be passed, this method will throw if none are passed.
+     *   1. `moduleConfigurationValues` — explicit overrides passed to `kernel.start()`.
+     *      Highest precedence; wins all conflicts.
+     *   2. `pristine.config.ts:config` — values from the user-authored config file.
+     *      Beats `configDefaults` and the resolver chain.
+     *   3. `configDefaults` — merged from every module's `ModuleInterface.configDefaults`.
+     *      Beats the resolver chain.
+     *   4. `configurationDefinition.defaultResolvers` — per-key resolver list (env vars,
+     *      secrets manager, etc.). First successful resolver wins.
+     *   5. `configurationDefinition.defaultValue` — hard fallback.
      *
-     * @param moduleConfigurationValues
-     * @param container
+     * Conflicts:
+     *   - **Same key in `moduleConfigurationValues` and the file** → stderr warning naming
+     *     both sources (never the value, which may be a secret); the overrides win.
+     *   - **Unknown key** in any of the explicit sources (overrides / file / configDefaults)
+     *     → validation error; throws at end of `load`.
+     *   - **Two modules' `configDefaults` disagree** — handled by the kernel before this
+     *     method runs (throws at registration). The merged `configDefaults` reaching this
+     *     method is already conflict-free.
+     *
+     * @param moduleConfigurationValues Explicit overrides from `kernel.start()`.
+     * @param container The DI container to register resolved values into.
+     * @param configDefaults Merged `ModuleInterface.configDefaults` from every module in the
+     *   graph. Optional; defaults to empty.
      */
     load(moduleConfigurationValues: {
         [key: string]: ModuleConfigurationValue;
-    }, container: DependencyContainer): Promise<void>;
+    }, container: DependencyContainer, configDefaults?: Record<string, unknown>): Promise<void>;
     /**
      * Returns the registered required parameters that are missing a value, without mutating state and without
      * invoking default resolvers (which would require a container and could throw). A parameter is reported as
@@ -49,4 +68,11 @@ export declare class ConfigurationManager {
      * @param container
      */
     registerConfigurationValue(configurationKey: string, value: boolean | number | string, container: DependencyContainer): void;
+    /**
+     * Reads the `config:` block from `pristine.config.{ts,js}` (if present). The file is
+     * optional — its absence is not an error, just produces an empty map. Failures to
+     * parse a present file are also swallowed (and reported via stderr) so misconfigured
+     * config files don't take down the whole boot.
+     */
+    private readFileConfigSafely;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/configuration",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "",
   "module": "dist/lib/esm/configuration.module.js",
   "main": "dist/lib/cjs/configuration.module.js",
@@ -15,7 +15,7 @@
     "dist"
   ],
   "dependencies": {
-    "@pristine-ts/common": "^2.0.4"
+    "@pristine-ts/common": "^2.0.6"
   },
   "author": "",
   "license": "ISC",
@@ -56,7 +56,7 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "f376d34e13c1b17b7764c0b47708148e4e51390b",
+  "gitHead": "539029d624372f9bb1e22e09da7152eabb95c105",
   "repository": {
     "type": "git",
     "url": "https://github.com/magieno/pristine-ts.git",