@nirelc/microconf 0.0.1 → 0.0.2

package/README.md

@@ -87,13 +87,20 @@ env({
   prefix: "APP_", // optional, default: undefined
   delimiter: "__", // optional, default: "__"
   forceCoerce: true, // optional, default: true
+  renames: {
+    APP_NESTED__KEY: "RANDOM_KEY", // optional
+  },
 });
 ```
 
 `prefix` - prefix for env variable names. e.g., with prefix `APP_`, `token` becomes `APP_TOKEN`
+
 `delimiter` - delimiter for nested keys. default: `__`
+
 `forceCoerce` - boolean to force type coercion. default: `true`. e.g. if set to `false`, `t.boolean()` willn't coerce `"true"` to `true` and will return a parse error instead
 
+`renames` - optional map of env variable names to schema paths. e.g., with `renames: { APP_NESTED__KEY: "RANDOM_KEY" }`, the env variable `RANDOM_KEY` instead of `APP_NESTED__KEY`
+
 ## Errors
 
 With `APP_PORT=abc`, `prefix: "APP_"` and a numeric `port` schema:

package/dist/sources/env.d.mts

@@ -1,6 +1,7 @@
 import { SchemaMeta, Source } from "../types.mjs";
 import { ParseResult } from "@nirelc/microtype";
 //#region src/sources/env.d.ts
+export type RenameMap = Record<string, string>;
 export type EnvSourceOptions = {
   prefix?: string;
   delimiter?: string;
@@ -9,14 +10,17 @@ export type EnvSourceOptions = {
    * useful, because env variables are always strings, and we want to coerce them to the correct type
    */
   forceCoerce?: boolean;
+  renames?: RenameMap;
 };
 export declare class EnvSource implements Source {
   prefix: string;
   delimiter: string;
   forceCoerce: boolean;
+  renames: RenameMap;
   name: string;
-  constructor({ prefix, delimiter, forceCoerce }?: EnvSourceOptions);
+  constructor({ prefix, delimiter, forceCoerce, renames }?: EnvSourceOptions);
   getKeyByPath(path: PropertyKey[]): string;
+  getKeyWithRenames(path: PropertyKey[]): string;
   getValueByPath(path: PropertyKey[]): string | undefined;
   load(meta: SchemaMeta): ParseResult<unknown> | undefined;
 }

package/dist/sources/env.mjs

@@ -10,11 +10,13 @@ var EnvSource = class {
 	prefix;
 	delimiter;
 	forceCoerce;
+	renames;
 	name = "env";
-	constructor({ prefix = "", delimiter = "__", forceCoerce = true } = {}) {
+	constructor({ prefix = "", delimiter = "__", forceCoerce = true, renames = {} } = {}) {
 		this.prefix = prefix.trim();
 		this.delimiter = delimiter;
 		this.forceCoerce = forceCoerce;
+		this.renames = renames;
 	}
 	getKeyByPath(path) {
 		return `${this.prefix}${path.map((p) => {
@@ -22,15 +24,19 @@ var EnvSource = class {
 			return p;
 		}).join(this.delimiter)}`.toUpperCase();
 	}
+	getKeyWithRenames(path) {
+		const key = this.getKeyByPath(path);
+		return this.renames[key] ?? key;
+	}
 	getValueByPath(path) {
-		return process.env[this.getKeyByPath(path)];
+		return process.env[this.getKeyWithRenames(path)];
 	}
 	load(meta) {
 		const value = this.getValueByPath(meta.path);
 		if (value === void 0) return;
 		const result = (this.forceCoerce ? enableCoercion(meta.schema) : meta.schema)._parse(value);
 		if (result.success) return result;
-		const key = this.getKeyByPath(meta.path);
+		const key = this.getKeyWithRenames(meta.path);
 		return {
 			success: false,
 			issues: result.issues.map((issue) => ({

package/package.json

@@ -2,7 +2,7 @@
   "name": "@nirelc/microconf",
   "description": "Lightweight and simple type-safety config library over microtype",
   "author": "Toil",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "type": "module",
   "homepage": "https://github.com/nirelc/microconf#readme",