@lenne.tech/nest-server 10.7.1 → 10.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "10.7.1",
+  "version": "10.8.0",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",
@@ -83,6 +83,7 @@
     "class-validator": "0.14.1",
     "compression": "1.7.5",
     "cookie-parser": "1.4.7",
+    "dotenv": "16.4.7",
     "ejs": "3.1.10",
     "graphql": "16.9.0",
     "graphql-query-complexity": "1.0.0",

package/src/config.env.ts

@@ -1,12 +1,14 @@
 import { CronExpression } from '@nestjs/schedule';
+import * as dotenv from 'dotenv';
 import { join } from 'path';
 
-import { merge } from './core/common/helpers/config.helper';
+import { getEnvironmentConfig } from './core/common/helpers/config.helper';
 import { IServerOptions } from './core/common/interfaces/server-options.interface';
 
 /**
  * Configuration for the different environments
  */
+dotenv.config();
 const config: { [env: string]: IServerOptions } = {
   // ===========================================================================
   // Development environment
@@ -330,47 +332,6 @@ const config: { [env: string]: IServerOptions } = {
 };
 
 /**
- * Environment specific config
- *
- * default: local
+ * Export config merged with other configs and environment variables as default
  */
-const env = process.env['NODE' + '_ENV'] || 'local';
-const envConfig = config[env] || config.local;
-console.info(`Configured for: ${envConfig.env}${env !== envConfig.env ? ` (requested: ${env})` : ''}`);
-// Merge with localConfig (e.g. config.json)
-if (envConfig.loadLocalConfig) {
-  let localConfig;
-  if (typeof envConfig.loadLocalConfig === 'string') {
-    import(envConfig.loadLocalConfig)
-      .then((loadedConfig) => {
-        localConfig = loadedConfig.default || loadedConfig;
-        merge(envConfig, localConfig);
-      })
-      .catch(() => {
-        console.info(`Configuration ${envConfig.loadLocalConfig} not found!`);
-      });
-  } else {
-    // get config from src directory
-    import(join(__dirname, 'config.json'))
-      .then((loadedConfig) => {
-        localConfig = loadedConfig.default || loadedConfig;
-        merge(envConfig, localConfig);
-      })
-      .catch(() => {
-        // if not found try to find in project directory
-        import(join(__dirname, '..', 'config.json'))
-          .then((loadedConfig) => {
-            localConfig = loadedConfig.default || loadedConfig;
-            merge(envConfig, localConfig);
-          })
-          .catch(() => {
-            console.info('No local config.json found!');
-          });
-      });
-  }
-}
-
-/**
- * Export envConfig as default
- */
-export default envConfig;
+export default getEnvironmentConfig({ config });

package/src/core/common/helpers/config.helper.ts

@@ -1,3 +1,6 @@
+import * as dotenv from 'dotenv';
+import { join } from 'path';
+
 import _ = require('lodash');
 
 /**
@@ -46,3 +49,128 @@ export function merge(obj: Record<string, any>, ...sources: any[]): any {
     }
   });
 }
+
+/**
+ * Get environment configuration (deeply merged into config object set via options)
+ *
+ * The configuration is extended via deep merge in the following order:
+ * 1. config[env] (if set)
+ * 2.
+ *
+ * @param options options for processing
+ * @param options.config config object with different environments as main keys (see config.env.ts) to merge environment configurations into (default: {})
+ * @param options.defaultEnv default environment to use if no NODE_ENV is set (default: 'local')
+ */
+export function getEnvironmentConfig(options: { config?: Record<string, any>; defaultEnv?: string }) {
+  const { config, defaultEnv } = {
+    config: {},
+    defaultEnv: 'local',
+    ...options,
+  };
+
+  dotenv.config();
+  const env = process.env['NODE' + '_ENV'] || defaultEnv;
+  const envConfig = config[env] || config.local || {};
+
+  // Merge with localConfig (e.g. config.json)
+  if (envConfig.loadLocalConfig) {
+    let localConfig: Record<string, any>;
+    if (typeof envConfig.loadLocalConfig === 'string') {
+      import(envConfig.loadLocalConfig)
+        .then((loadedConfig) => {
+          localConfig = loadedConfig.default || loadedConfig;
+          merge(envConfig, localConfig);
+        })
+        .catch(() => {
+          console.info(`Configuration ${envConfig.loadLocalConfig} not found!`);
+        });
+    } else {
+      // get config from src directory
+      import(join(__dirname, 'config.json'))
+        .then((loadedConfig) => {
+          localConfig = loadedConfig.default || loadedConfig;
+          merge(envConfig, localConfig);
+        })
+        .catch(() => {
+          // if not found try to find in project directory
+          import(join(__dirname, '..', 'config.json'))
+            .then((loadedConfig) => {
+              localConfig = loadedConfig.default || loadedConfig;
+              merge(envConfig, localConfig);
+            })
+            .catch(() => {
+              console.info('No local config.json found!');
+            });
+        });
+    }
+  }
+
+  // .env handling via dotenv
+  if (process.env['NEST_SERVER_CONFIG']) {
+    try {
+      const dotEnvConfig = JSON.parse(process.env['NEST_SERVER_CONFIG']);
+      if (dotEnvConfig && Object.keys(dotEnvConfig).length > 0) {
+        merge(envConfig, dotEnvConfig);
+        console.info('NEST_SERVER_CONFIG used from .env');
+      }
+    } catch (e) {
+      console.error('Error parsing NEST_SERVER_CONFIG from .env: ', e);
+      console.error(
+        'Maybe the JSON is invalid? Please check the value of NEST_SERVER_CONFIG in .env file (e.g. via https://jsonlint.com/)',
+      );
+    }
+  }
+
+  // Merge with environment variables
+  const environmentObject = getEnvironmentObject();
+  const environmentObjectKeyCount = Object.keys(environmentObject).length;
+  if (environmentObjectKeyCount > 0) {
+    merge(envConfig, environmentObject);
+    console.info(
+      `Environment object from the environment integrated into the configuration with ${environmentObjectKeyCount} keys`,
+    );
+  }
+
+  console.info(`Configured for: ${envConfig.env}${env !== envConfig.env ? ` (requested: ${env})` : ''}`);
+  return envConfig;
+}
+
+/**
+ * Get environment object from environment variables
+ */
+export function getEnvironmentObject(options?: { prefix?: string; processEnv?: Record<string, number | string> }) {
+  const config = {
+    prefix: 'NSC__',
+    processEnv: process.env,
+    ...options,
+  };
+  const output = {};
+
+  Object.entries(config.processEnv)
+    .filter(([key]) => key.startsWith(config.prefix))
+    .forEach(([key, value]) => {
+      // Remove prefix from key
+      const adjustedKey = key.slice(config.prefix?.length || 0);
+
+      // Convert key to path
+      const path = adjustedKey.split('__').map(part =>
+        part
+          .split('_')
+          .map((s, i) => (i === 0 ? s.toLowerCase() : s[0].toUpperCase() + s.slice(1).toLowerCase()))
+          .join(''),
+      );
+
+      // Set value in output object
+      let current = output;
+      for (let i = 0; i < path.length; i++) {
+        const segment = path[i];
+        if (i === path.length - 1) {
+          current[segment] = value;
+        } else {
+          current = current[segment] = current[segment] || {};
+        }
+      }
+    });
+
+  return output;
+}