@adonisjs/env 3.0.9 → 4.0.0-0

package/build/index.d.ts

@@ -1,3 +1,3 @@
-export { Env } from './src/Env';
-export { EnvParser } from './src/Parser';
-export { envLoader } from './src/loader';
+export { Env } from './src/env.js';
+export { EnvParser } from './src/parser.js';
+export { EnvLoader } from './src/loader.js';

package/build/index.js

@@ -1,17 +1,3 @@
-"use strict";
-/*
- * @adonisjs/env
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.envLoader = exports.EnvParser = exports.Env = void 0;
-var Env_1 = require("./src/Env");
-Object.defineProperty(exports, "Env", { enumerable: true, get: function () { return Env_1.Env; } });
-var Parser_1 = require("./src/Parser");
-Object.defineProperty(exports, "EnvParser", { enumerable: true, get: function () { return Parser_1.EnvParser; } });
-var loader_1 = require("./src/loader");
-Object.defineProperty(exports, "envLoader", { enumerable: true, get: function () { return loader_1.envLoader; } });
+export { Env } from './src/env.js';
+export { EnvParser } from './src/parser.js';
+export { EnvLoader } from './src/loader.js';

package/build/src/env.d.ts

@@ -0,0 +1,21 @@
+import { EnvValidator } from './validator.js';
+import { type ValidateFn } from '@poppinss/validator-lite';
+export declare class Env<EnvValues extends Record<string, any>> {
+    #private;
+    constructor(values: EnvValues);
+    static schema: {
+        number: typeof import("@poppinss/validator-lite/build/src/schema/number.js").number;
+        string: typeof import("@poppinss/validator-lite/build/src/schema/string.js").string;
+        boolean: typeof import("@poppinss/validator-lite/build/src/schema/boolean.js").boolean;
+        enum: typeof import("@poppinss/validator-lite/build/src/schema/oneOf.js").oneOf;
+    };
+    static rules<T extends {
+        [key: string]: ValidateFn<unknown>;
+    }>(schema: T): EnvValidator<T>['validate'];
+    get<K extends keyof EnvValues>(key: K): EnvValues[K];
+    get<K extends keyof EnvValues>(key: K, defaultValue: Exclude<EnvValues[K], undefined>): Exclude<EnvValues[K], undefined>;
+    get(key: string): string | undefined;
+    get(key: string, defaultValue: string): string;
+    set<K extends keyof EnvValues>(key: K, value: EnvValues[K]): void;
+    set(key: string, value: string): void;
+}

package/build/src/env.js

@@ -0,0 +1,27 @@
+import { EnvValidator } from './validator.js';
+import { schema as envSchema } from '@poppinss/validator-lite';
+export class Env {
+    #values;
+    constructor(values) {
+        this.#values = values;
+    }
+    static schema = envSchema;
+    static rules(schema) {
+        const validator = new EnvValidator(schema);
+        return validator.validate.bind(validator);
+    }
+    get(key, defaultValue) {
+        if (this.#values[key] !== undefined) {
+            return this.#values[key];
+        }
+        const envValue = process.env[key];
+        if (envValue) {
+            return envValue;
+        }
+        return defaultValue;
+    }
+    set(key, value) {
+        this.#values[key] = value;
+        process.env[key] = value;
+    }
+}

package/build/src/exceptions/missing_env_path_file.d.ts

@@ -0,0 +1,5 @@
+import { Exception } from '@poppinss/utils';
+export declare class MissingEnvPathFileException extends Exception {
+    static status: number;
+    static code: string;
+}

package/build/src/exceptions/missing_env_path_file.js

@@ -0,0 +1,5 @@
+import { Exception } from '@poppinss/utils';
+export class MissingEnvPathFileException extends Exception {
+    static status = 500;
+    static code = 'E_MISSING_ENV_PATH_FILE';
+}

package/build/src/loader.d.ts

@@ -1,7 +1,9 @@
-/**
- * Reads `.env` file contents
- */
-export declare function envLoader(appRoot: string): {
-    envContents: string;
-    testEnvContent: string;
-};
+/// <reference types="node" resolution-mode="require"/>
+export declare class EnvLoader {
+    #private;
+    constructor(appRoot: string | URL);
+    load(): Promise<{
+        envContents: string;
+        currentEnvContents: string;
+    }>;
+}

package/build/src/loader.js

@@ -1,53 +1,34 @@
-"use strict";
-/*
- * @adonisjs/env
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.envLoader = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const utils_1 = require("@poppinss/utils");
-/**
- * Loads file from the disk and optionally ignores the missing
- * file errors
- */
-function loadFile(filePath, optional = false) {
-    try {
-        return (0, fs_1.readFileSync)(filePath, 'utf-8');
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+import { isAbsolute, join } from 'node:path';
+import { MissingEnvPathFileException } from './exceptions/missing_env_path_file.js';
+export class EnvLoader {
+    #appRoot;
+    constructor(appRoot) {
+        this.#appRoot = typeof appRoot === 'string' ? appRoot : fileURLToPath(appRoot);
     }
-    catch (error) {
-        if (error.code !== 'ENOENT') {
-            throw error;
+    async #loadFile(filePath, optional = false) {
+        try {
+            return await readFile(filePath, 'utf-8');
         }
-        if (!optional) {
-            throw new utils_1.Exception(`The "${filePath}" file is missing`, 500, 'E_MISSING_ENV_FILE');
+        catch (error) {
+            if (error.code !== 'ENOENT') {
+                throw error;
+            }
+            if (optional) {
+                return '';
+            }
+            throw new MissingEnvPathFileException(`Cannot find env file from "ENV_PATH"`, {
+                cause: error,
+            });
         }
     }
-    return '';
-}
-/**
- * Reads `.env` file contents
- */
-function envLoader(appRoot) {
-    const envPath = process.env.ENV_PATH || '.env';
-    const absPath = (0, path_1.isAbsolute)(envPath) ? envPath : (0, path_1.join)(appRoot, envPath);
-    const envContents = loadFile(absPath, true);
-    /**
-     * Optionally load the `.env.test` and `.env.testing` files
-     * in test environment
-     */
-    let testEnvContent = '';
-    if (process.env.NODE_ENV === 'testing') {
-        testEnvContent = loadFile((0, path_1.join)(appRoot, '.env.testing'), true);
-    }
-    else if (process.env.NODE_ENV === 'test') {
-        testEnvContent = loadFile((0, path_1.join)(appRoot, '.env.test'), true);
+    async load() {
+        const envFile = process.env.ENV_PATH || '.env';
+        const envPath = isAbsolute(envFile) ? envFile : join(this.#appRoot, envFile);
+        const envContents = await this.#loadFile(envPath, !process.env.ENV_PATH);
+        const currentEnvPath = join(this.#appRoot, `.env.${process.env.NODE_ENV}`);
+        const currentEnvContents = await this.#loadFile(currentEnvPath, true);
+        return { envContents, currentEnvContents };
     }
-    return { testEnvContent, envContents };
 }
-exports.envLoader = envLoader;

package/build/src/parser.d.ts

@@ -0,0 +1,6 @@
+import { DotenvParseOutput } from 'dotenv';
+export declare class EnvParser {
+    #private;
+    constructor(envContents: string);
+    parse(): DotenvParseOutput;
+}

package/build/src/parser.js

@@ -0,0 +1,60 @@
+import dotenv from 'dotenv';
+export class EnvParser {
+    #envContents;
+    constructor(envContents) {
+        this.#envContents = envContents;
+    }
+    #getValue(key, parsed) {
+        if (parsed[key]) {
+            return this.#interpolate(parsed[key], parsed);
+        }
+        return '';
+    }
+    #interpolateMustache(token, parsed) {
+        const closingBrace = token.indexOf('}');
+        if (closingBrace === -1) {
+            return token;
+        }
+        const varReference = token.slice(1, closingBrace).trim();
+        return `${this.#getValue(varReference, parsed)}${token.slice(closingBrace + 1)}`;
+    }
+    #interpolateVariable(token, parsed) {
+        return token.replace(/[a-zA-Z0-9_]+/, (key) => {
+            return this.#getValue(key, parsed);
+        });
+    }
+    #interpolate(value, parsed) {
+        const tokens = value.split('$');
+        let newValue = '';
+        let skipNextToken = true;
+        tokens.forEach((token) => {
+            if (token === '\\') {
+                newValue += '$';
+                skipNextToken = true;
+                return;
+            }
+            if (skipNextToken) {
+                newValue += token.replace(/\\$/, '$');
+                if (token.endsWith('\\')) {
+                    return;
+                }
+            }
+            else {
+                if (token.startsWith('{')) {
+                    newValue += this.#interpolateMustache(token, parsed);
+                    return;
+                }
+                newValue += this.#interpolateVariable(token, parsed);
+            }
+            skipNextToken = false;
+        });
+        return newValue;
+    }
+    parse() {
+        const envCollection = dotenv.parse(this.#envContents.trim());
+        return Object.keys(envCollection).reduce((result, key) => {
+            result[key] = this.#interpolate(envCollection[key], envCollection);
+            return result;
+        }, {});
+    }
+}

package/build/src/validator.d.ts

@@ -0,0 +1,12 @@
+import { ValidateFn } from '@poppinss/validator-lite';
+export declare class EnvValidator<Schema extends {
+    [key: string]: ValidateFn<unknown>;
+}> {
+    #private;
+    constructor(schema: Schema);
+    validate(values: {
+        [K: string]: string | undefined;
+    }): {
+        [K in keyof Schema]: ReturnType<Schema[K]>;
+    };
+}

package/build/src/validator.js

@@ -0,0 +1,12 @@
+export class EnvValidator {
+    #schema;
+    constructor(schema) {
+        this.#schema = schema;
+    }
+    validate(values) {
+        return Object.keys(this.#schema).reduce((result, key) => {
+            result[key] = this.#schema[key](key, values[key]);
+            return result;
+        }, { ...values });
+    }
+}

package/package.json

@@ -1,142 +1,118 @@
 {
-	"name": "@adonisjs/env",
-	"version": "3.0.9",
-	"description": "Environment variable manager for Node.js",
-	"main": "build/index.js",
-	"files": [
-		"build/adonis-typings",
-		"build/src",
-		"build/index.d.ts",
-		"build/index.js"
-	],
-	"scripts": {
-		"mrm": "mrm --preset=@adonisjs/mrm-preset",
-		"pretest": "npm run lint",
-		"test": "node -r @adonisjs/require-ts/build/register bin/test.ts",
-		"clean": "del-cli build",
-		"compile": "npm run lint && npm run clean && tsc",
-		"build": "npm run compile",
-		"commit": "git-cz",
-		"release": "np --message=\"chore(release): %s\"",
-		"version": "npm run build",
-		"prepublishOnly": "npm run build",
-		"lint": "eslint . --ext=.ts",
-		"format": "prettier --write .",
-		"sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/env"
-	},
-	"keywords": [
-		"env",
-		"adonisjs"
-	],
-	"author": "virk,adonisjs",
-	"license": "MIT",
-	"devDependencies": {
-		"@adonisjs/mrm-preset": "^5.0.3",
-		"@adonisjs/require-ts": "^2.0.10",
-		"@japa/assert": "^1.2.3",
-		"@japa/run-failed-tests": "^1.0.3",
-		"@japa/runner": "^2.0.6",
-		"@japa/spec-reporter": "^1.1.7",
-		"@poppinss/dev-utils": "^2.0.2",
-		"@types/node": "^17.0.23",
-		"commitizen": "^4.2.4",
-		"cz-conventional-changelog": "^3.3.0",
-		"del-cli": "^4.0.1",
-		"eslint": "^8.12.0",
-		"eslint-config-prettier": "^8.5.0",
-		"eslint-plugin-adonis": "^2.1.0",
-		"eslint-plugin-prettier": "^4.0.0",
-		"github-label-sync": "^2.1.1",
-		"husky": "^7.0.1",
-		"mrm": "^4.0.0",
-		"np": "^7.6.1",
-		"prettier": "^2.6.2",
-		"typescript": "^4.6.3"
-	},
-	"nyc": {
-		"exclude": [
-			"test"
-		],
-		"extension": [
-			".ts"
-		]
-	},
-	"husky": {
-		"hooks": {
-			"commit-msg": "node ./node_modules/@adonisjs/mrm-preset/validateCommit/conventional/validate.js"
-		}
-	},
-	"config": {
-		"commitizen": {
-			"path": "cz-conventional-changelog"
-		}
-	},
-	"np": {
-		"contents": ".",
-		"anyBranch": false
-	},
-	"dependencies": {
-		"@poppinss/utils": "^4.0.2",
-		"dotenv": "^16.0.0",
-		"validator": "^13.7.0"
-	},
-	"directories": {
-		"doc": "docs",
-		"test": "test"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/adonisjs/env.git"
-	},
-	"bugs": {
-		"url": "https://github.com/adonisjs/env/issues"
-	},
-	"homepage": "https://github.com/adonisjs/env#readme",
-	"publishConfig": {
-		"access": "public",
-		"tag": "latest"
-	},
-	"mrmConfig": {
-		"core": true,
-		"license": "MIT",
-		"services": [
-			"github-actions"
-		],
-		"minNodeVersion": "14.15.4",
-		"probotApps": [
-			"stale",
-			"lock"
-		],
-		"runGhActionsOnWindows": false
-	},
-	"eslintConfig": {
-		"extends": [
-			"plugin:adonis/typescriptPackage",
-			"prettier"
-		],
-		"plugins": [
-			"prettier"
-		],
-		"rules": {
-			"prettier/prettier": [
-				"error",
-				{
-					"endOfLine": "auto"
-				}
-			]
-		}
-	},
-	"eslintIgnore": [
-		"build"
-	],
-	"prettier": {
-		"trailingComma": "es5",
-		"semi": false,
-		"singleQuote": true,
-		"useTabs": false,
-		"quoteProps": "consistent",
-		"bracketSpacing": true,
-		"arrowParens": "always",
-		"printWidth": 100
-	}
+  "name": "@adonisjs/env",
+  "version": "4.0.0-0",
+  "description": "Environment variable manager for Node.js",
+  "main": "build/index.js",
+  "type": "module",
+  "files": [
+    "build/src",
+    "build/index.d.ts",
+    "build/index.js"
+  ],
+  "exports": {
+    ".": "./build/index.js"
+  },
+  "scripts": {
+    "pretest": "npm run lint",
+    "test": "npm run vscode:test",
+    "clean": "del-cli build",
+    "compile": "npm run lint && npm run clean && tsc",
+    "build": "npm run compile",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint . --ext=.ts",
+    "format": "prettier --write .",
+    "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/env",
+    "vscode:test": "node --loader=ts-node/esm bin/test.ts"
+  },
+  "keywords": [
+    "env",
+    "adonisjs"
+  ],
+  "author": "virk,adonisjs",
+  "license": "MIT",
+  "devDependencies": {
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "@japa/assert": "^1.3.6",
+    "@japa/expect-type": "^1.0.2",
+    "@japa/run-failed-tests": "^1.1.0",
+    "@japa/runner": "^2.2.2",
+    "@japa/spec-reporter": "^1.3.2",
+    "@poppinss/dev-utils": "^2.0.3",
+    "@swc/core": "^1.3.9",
+    "@types/fs-extra": "^9.0.13",
+    "@types/node": "^18.11.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.25.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-adonis": "^3.0.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "fs-extra": "^10.1.0",
+    "github-label-sync": "^2.2.0",
+    "husky": "^8.0.1",
+    "np": "^7.6.2",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "@poppinss/utils": "^6.0.0-1",
+    "@poppinss/validator-lite": "^1.0.1",
+    "dotenv": "^16.0.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adonisjs/env.git"
+  },
+  "bugs": {
+    "url": "https://github.com/adonisjs/env/issues"
+  },
+  "homepage": "https://github.com/adonisjs/env#readme",
+  "eslintConfig": {
+    "extends": [
+      "plugin:adonis/typescriptPackage",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "endOfLine": "auto"
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "build"
+  ],
+  "prettier": {
+    "trailingComma": "es5",
+    "semi": false,
+    "singleQuote": true,
+    "useTabs": false,
+    "quoteProps": "consistent",
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "printWidth": 100
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "next",
+    "branch": "main",
+    "anyBranch": false
+  }
 }