@jsnw/srv-utils 1.0.10 → 1.1.0

package/README.md

@@ -32,16 +32,27 @@ import {getRootPackageDirnameSync} from '@jsnw/srv-utils';
 const root = getRootPackageDirnameSync();
 ```
 
-### ConfigLoader.loadAndValidate(path, schema, addProps?)
-Loads a YAML file and validates it with a Zod schema. It also injects `isDev` based on `APP_CONTEXT`, `APPLICATION_CONTEXT`, or `NODE_ENV`. You can use `%pkgroot/` prefix in the path for automatic project-root resolution.
+### ConfigLoader.loadConfig(path, schema, addProps?)
+Loads a YAML file and validates it with a Zod schema. It also injects `isDev` based on `APP_CONTEXT`, `APPLICATION_CONTEXT`, or `NODE_ENV`.
+
+**Path resolution prefixes:**
+- `%pkgroot/` - Resolves to the project root directory
+- `%env:VAR_NAME/` - Resolves based on environment variable value
 
 ```ts
 import {ConfigLoader, configSchemas} from '@jsnw/srv-utils';
 
-const config = ConfigLoader.loadAndValidate(
+// Using project root
+const config = ConfigLoader.loadConfig(
   '%pkgroot/config.yml',
   configSchemas.mongodbConnection
 );
+
+// Using environment variable
+const config = ConfigLoader.loadConfig(
+  '%env:CONFIG_PATH/config.yml',
+  configSchemas.mongodbConnection
+);
 ```
 
 ### configSchemas

package/dist/config/config-loader.js

@@ -8,6 +8,7 @@ const yaml_1 = require("yaml");
 const file_exists_1 = require("../file-exists");
 const getRootPackageDirname_1 = require("../getRootPackageDirname");
 const PKG_ROOT_REGEX = /^%pkgroot(?:[\/\\]|$)/i;
+const ENV_VAR_REGEX = /^%env:(?<var_name>[A-Za-z0-9_]+)(?:[\/\\]|$)/i;
 class ConfigLoader {
     static _instance;
     /**
@@ -22,7 +23,9 @@ class ConfigLoader {
      * @template {z.ZodObject} S
      * @template {object} P
      * @param {string} path You can use %pkgroot prefix for automatic project root resolution by AppConfigLoader.
-     * Example: %pkgroot/config.yml
+     * Also, you can use %env:ENV_VARIABLE to resolve config path based on environment variable
+     * Example 1: %pkgroot/config.yml
+     * Example 2: %env:CONFIG_PATH/config.yml
      * @param {S} schema
      * @param {P} [addProps]
      * @returns {ResolvedConfig<S, P>}
@@ -62,7 +65,7 @@ class ConfigLoader {
      * @protected
      */
     loadYamlFile(path) {
-        path = this.resolvePkgRootPath(path);
+        path = this.resolveFilePath(path);
         if (!(0, file_exists_1.fileExistsSync)(path))
             return [null, new Error(`YAML file does not exists at path: ${path}`)];
         let data = undefined, parsedYml = undefined;
@@ -91,7 +94,7 @@ class ConfigLoader {
         const { data: parsed, error, success } = schema.safeParse(data);
         if (!success) {
             if (error && error instanceof zod_1.ZodError)
-                return [null, new Error(`Failed to validate yaml (#1)`)];
+                return [null, new Error(`Failed to validate yaml (#1). Error message: ${zod_1.z.prettifyError(error)}`)];
             return [null, new Error(`Failed to validate yaml (#2)`)];
         }
         return [parsed, null];
@@ -141,9 +144,17 @@ class ConfigLoader {
         return [yaml, errors];
     }
     //region Utils
-    resolvePkgRootPath(path) {
+    resolveFilePath(path) {
         if (PKG_ROOT_REGEX.test(path))
             path = path.replace(PKG_ROOT_REGEX, (0, getRootPackageDirname_1.getRootPackageDirnameSync)() + node_path_1.sep);
+        if (ENV_VAR_REGEX.test(path)) {
+            const m = path.match(ENV_VAR_REGEX);
+            if (m.groups?.['var_name']) {
+                if (process.env?.[m.groups['var_name']]) {
+                    path = path.replace(ENV_VAR_REGEX, process.env[m.groups['var_name']].replace(/[\/\\]+$/, '') + node_path_1.sep);
+                }
+            }
+        }
         return (0, node_path_1.resolve)(path);
     }
     /**
@@ -153,7 +164,7 @@ class ConfigLoader {
      * @private
      */
     resolveIncludePath(fromDirname, toPath) {
-        return (0, node_path_1.resolve)(this.resolvePkgRootPath(fromDirname), toPath);
+        return (0, node_path_1.resolve)(this.resolveFilePath(fromDirname), toPath);
     }
 }
 exports.ConfigLoader = ConfigLoader;

package/dist/types/config/config-loader.d.ts

@@ -11,7 +11,9 @@ export declare class ConfigLoader {
      * @template {z.ZodObject} S
      * @template {object} P
      * @param {string} path You can use %pkgroot prefix for automatic project root resolution by AppConfigLoader.
-     * Example: %pkgroot/config.yml
+     * Also, you can use %env:ENV_VARIABLE to resolve config path based on environment variable
+     * Example 1: %pkgroot/config.yml
+     * Example 2: %env:CONFIG_PATH/config.yml
      * @param {S} schema
      * @param {P} [addProps]
      * @returns {ResolvedConfig<S, P>}
@@ -39,7 +41,7 @@ export declare class ConfigLoader {
      * @protected
      */
     protected processIncludes(mainYamlDirname: string, yaml: any): ErrorResult<any, Error[]>;
-    private resolvePkgRootPath;
+    private resolveFilePath;
     /**
      * @param {string} fromDirname
      * @param {string} toPath

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsnw/srv-utils",
-  "version": "1.0.10",
+  "version": "1.1.0",
   "description": "Server-side utilities for Node.js/TypeScript: tsconfig paths, Nest helpers, and config loading.",
   "main": "./dist/index.js",
   "types": "./dist/types/index.d.ts",