@adonisjs/env 4.2.0-4 → 4.2.0-6

package/build/src/editor.js

@@ -1,67 +1,67 @@
-/*
- * @adonisjs/env
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import splitLines from 'split-lines';
-import lodash from '@poppinss/utils/lodash';
-import { writeFile } from 'node:fs/promises';
-import { EnvLoader } from './loader.js';
-export class EnvEditor {
-    #appRoot;
-    #loader;
-    #files = [];
-    /**
-     * Creates an instance of env editor and loads .env files
-     * contents.
-     */
-    static async create(appRoot) {
-        const editor = new EnvEditor(appRoot);
-        await editor.load();
-        return editor;
-    }
-    constructor(appRoot) {
-        this.#appRoot = appRoot;
-        this.#loader = new EnvLoader(this.#appRoot, true);
-    }
-    /**
-     * Loads .env files for editing. Only ".env" and ".env.example"
-     * files are picked for editing.
-     */
-    async load() {
-        const envFiles = await this.#loader.load();
-        this.#files = envFiles
-            .filter((envFile) => envFile.fileExists &&
-            (envFile.path.endsWith('.env') || envFile.path.endsWith('.env.example')))
-            .map((envFile) => {
-            return {
-                contents: splitLines(envFile.contents.trim()),
-                path: envFile.path,
-            };
-        });
-    }
-    /**
-     * Add key-value pair to the dot-env files.
-     */
-    add(key, value) {
-        this.#files.forEach((file) => {
-            let entryIndex = file.contents.findIndex((line) => line.startsWith(`${key}=`));
-            entryIndex = entryIndex === -1 ? file.contents.length : entryIndex;
-            lodash.set(file.contents, entryIndex, `${key}=${String(value)}`);
-        });
-    }
-    toJSON() {
-        return this.#files;
-    }
-    /**
-     * Save changes to the disk
-     */
-    async save() {
-        await Promise.all(this.#files.map((file) => {
-            return writeFile(file.path, file.contents.join('\n'));
-        }));
-    }
-}
+import {
+  EnvLoader
+} from "../chunk-NSHYMAZE.js";
+
+// src/editor.ts
+import splitLines from "split-lines";
+import lodash from "@poppinss/utils/lodash";
+import { writeFile } from "node:fs/promises";
+var EnvEditor = class _EnvEditor {
+  #appRoot;
+  #loader;
+  #files = [];
+  /**
+   * Creates an instance of env editor and loads .env files
+   * contents.
+   */
+  static async create(appRoot) {
+    const editor = new _EnvEditor(appRoot);
+    await editor.load();
+    return editor;
+  }
+  constructor(appRoot) {
+    this.#appRoot = appRoot;
+    this.#loader = new EnvLoader(this.#appRoot, true);
+  }
+  /**
+   * Loads .env files for editing. Only ".env" and ".env.example"
+   * files are picked for editing.
+   */
+  async load() {
+    const envFiles = await this.#loader.load();
+    this.#files = envFiles.filter(
+      (envFile) => envFile.fileExists && (envFile.path.endsWith(".env") || envFile.path.endsWith(".env.example"))
+    ).map((envFile) => {
+      return {
+        contents: splitLines(envFile.contents.trim()),
+        path: envFile.path
+      };
+    });
+  }
+  /**
+   * Add key-value pair to the dot-env files.
+   */
+  add(key, value) {
+    this.#files.forEach((file) => {
+      let entryIndex = file.contents.findIndex((line) => line.startsWith(`${key}=`));
+      entryIndex = entryIndex === -1 ? file.contents.length : entryIndex;
+      lodash.set(file.contents, entryIndex, `${key}=${String(value)}`);
+    });
+  }
+  toJSON() {
+    return this.#files;
+  }
+  /**
+   * Save changes to the disk
+   */
+  async save() {
+    await Promise.all(
+      this.#files.map((file) => {
+        return writeFile(file.path, file.contents.join("\n"));
+      })
+    );
+  }
+};
+export {
+  EnvEditor
+};

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@adonisjs/env",
-  "version": "4.2.0-4",
+  "version": "4.2.0-6",
   "description": "Environment variable manager for Node.js",
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "build/src",
-    "build/index.d.ts",
-    "build/index.js"
+    "build"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -21,7 +19,7 @@
     "test": "cross-env NODE_DEBUG=adonisjs:env c8 npm run quick:test",
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
-    "compile": "npm run lint && npm run clean && tsc",
+    "compile": "npm run lint && npm run clean && tsup-node",
     "build": "npm run compile",
     "release": "np",
     "version": "npm run build",
@@ -41,27 +39,28 @@
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
     "@adonisjs/tsconfig": "^1.1.8",
-    "@commitlint/cli": "^17.6.7",
-    "@commitlint/config-conventional": "^17.6.7",
-    "@japa/assert": "^2.0.0-1",
-    "@japa/expect-type": "^2.0.0-0",
-    "@japa/file-system": "^2.0.0-1",
-    "@japa/runner": "^3.0.0-3",
-    "@swc/core": "^1.3.71",
-    "@types/node": "^20.4.5",
+    "@commitlint/cli": "^17.8.0",
+    "@commitlint/config-conventional": "^17.8.0",
+    "@japa/assert": "^2.0.0",
+    "@japa/expect-type": "^2.0.0",
+    "@japa/file-system": "^2.0.0",
+    "@japa/runner": "^3.0.2",
+    "@swc/core": "1.3.82",
+    "@types/node": "^20.8.6",
     "c8": "^8.0.1",
     "cross-env": "^7.0.3",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.45.0",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.51.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
     "np": "^8.0.4",
-    "prettier": "^3.0.0",
+    "prettier": "^3.0.3",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@poppinss/utils": "^6.5.0-3",
+    "@poppinss/utils": "^6.5.0",
     "@poppinss/validator-lite": "^1.0.3",
     "dotenv": "^16.3.1",
     "split-lines": "^3.0.0"
@@ -101,5 +100,16 @@
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
-  "prettier": "@adonisjs/prettier-config"
+  "prettier": "@adonisjs/prettier-config",
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/editor.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": true,
+    "target": "esnext"
+  }
 }

package/build/src/debug.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-declare const _default: import("util").DebugLogger;
-export default _default;

package/build/src/debug.js

@@ -1,10 +0,0 @@
-/*
- * @adonisjs/env
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { debuglog } from 'node:util';
-export default debuglog('adonisjs:env');

package/build/src/env.d.ts

@@ -1,82 +0,0 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-import { type ValidateFn } from '@poppinss/validator-lite';
-import { EnvValidator } from './validator.js';
-/**
- * A wrapper over "process.env" with types information.
- *
- * ```ts
- * const validate = Env.rules({
- *   PORT: Env.schema.number()
- * })
- *
- * const validatedEnvVars = validate(process.env)
- *
- * const env = new EnvValues(validatedEnvVars)
- * env.get('PORT') // type === number
- * ```
- */
-export declare class Env<EnvValues extends Record<string, any>> {
-    #private;
-    constructor(values: EnvValues);
-    /**
-     * Create an instance of the env class by validating the
-     * environment variables. Also, the `.env` files are
-     * loaded from the appRoot
-     */
-    static create<Schema extends {
-        [key: string]: ValidateFn<unknown>;
-    }>(appRoot: URL, schema: Schema): Promise<Env<{
-        [K in keyof Schema]: ReturnType<Schema[K]>;
-    }>>;
-    /**
-     * The schema builder for defining validation rules
-     */
-    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;
-    };
-    /**
-     * Define the validation rules for validating environment
-     * variables. The return value is an instance of the
-     * env validator
-     */
-    static rules<T extends {
-        [key: string]: ValidateFn<unknown>;
-    }>(schema: T): EnvValidator<T>;
-    /**
-     * Get the value of an environment variable by key. The values are
-     * lookedup inside the validated environment and "process.env"
-     * is used as a fallback.
-     *
-     * The second param is the default value, which is returned when
-     * the environment variable does not exist.
-     *
-     * ```ts
-     * Env.get('PORT')
-     *
-     * // With default value
-     * Env.get('PORT', 3000)
-     * ```
-     */
-    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;
-    /**
-     * Update/set value of an environment variable.
-     *
-     * The value is not casted/validated using the validator, so make sure
-     * to set the correct data type.
-     *
-     * ```ts
-     * Env.set('PORT', 3000)
-     *
-     * Env.get('PORT') === 3000 // true
-     * process.env.PORT === '3000' // true
-     * ```
-     */
-    set<K extends keyof EnvValues>(key: K, value: EnvValues[K]): void;
-    set(key: string, value: string): void;
-}

package/build/src/env.js

@@ -1,80 +0,0 @@
-/*
- * @adonisjs/env
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { schema as envSchema } from '@poppinss/validator-lite';
-import { EnvValidator } from './validator.js';
-import { EnvProcessor } from './processor.js';
-/**
- * A wrapper over "process.env" with types information.
- *
- * ```ts
- * const validate = Env.rules({
- *   PORT: Env.schema.number()
- * })
- *
- * const validatedEnvVars = validate(process.env)
- *
- * const env = new EnvValues(validatedEnvVars)
- * env.get('PORT') // type === number
- * ```
- */
-export class Env {
-    /**
-     * A cache of env values
-     */
-    #values;
-    constructor(values) {
-        this.#values = values;
-    }
-    /**
-     * Create an instance of the env class by validating the
-     * environment variables. Also, the `.env` files are
-     * loaded from the appRoot
-     */
-    static async create(appRoot, schema) {
-        const values = await new EnvProcessor(appRoot).process();
-        const validator = this.rules(schema);
-        return new Env(validator.validate(values));
-    }
-    /**
-     * The schema builder for defining validation rules
-     */
-    static schema = envSchema;
-    /**
-     * Define the validation rules for validating environment
-     * variables. The return value is an instance of the
-     * env validator
-     */
-    static rules(schema) {
-        const validator = new EnvValidator(schema);
-        return validator;
-    }
-    get(key, defaultValue) {
-        /**
-         * Return cached value
-         */
-        if (this.#values[key] !== undefined) {
-            return this.#values[key];
-        }
-        /**
-         * Get value from "process.env" and update the cache
-         */
-        const envValue = process.env[key];
-        if (envValue) {
-            return envValue;
-        }
-        /**
-         * Return default value when unable to lookup any other value
-         */
-        return defaultValue;
-    }
-    set(key, value) {
-        this.#values[key] = value;
-        process.env[key] = value;
-    }
-}

package/build/src/exceptions.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-/**
- * Exception raised when one or more env variables
- * are invalid
- */
-export declare const E_INVALID_ENV_VARIABLES: {
-    new (message?: string | undefined, options?: (ErrorOptions & {
-        code?: string | undefined;
-        status?: number | undefined;
-    }) | undefined): {
-        help: string;
-        name: string;
-        code?: string | undefined;
-        status: number;
-        toString(): string;
-        readonly [Symbol.toStringTag]: string;
-        message: string;
-        stack?: string | undefined;
-        cause?: unknown;
-    };
-    message: string;
-    code: string;
-    help?: string | undefined;
-    status?: number | undefined;
-    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
-    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
-    stackTraceLimit: number;
-};

package/build/src/exceptions.js

@@ -1,18 +0,0 @@
-/*
- * @adonisjs/env
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@poppinss/utils';
-/**
- * Exception raised when one or more env variables
- * are invalid
- */
-export const E_INVALID_ENV_VARIABLES = class EnvValidationException extends Exception {
-    static message = 'Validation failed for one or more environment variables';
-    static code = 'E_INVALID_ENV_VARIABLES';
-    help = '';
-};

package/build/src/loader.d.ts

@@ -1,36 +0,0 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-/**
- * Read the contents of one or more dot-env files. Following is how the files
- * are read.
- *
- * - Load file from the "ENV_PATH" environment file.
- *    (Raise error if file is missing)
- *
- * - If "ENV_PATH" is not defined, then find ".env" file in the app root.
- *    (Ignore if file is missing)
- *
- * - Find ".env.[NODE_ENV]" file in the app root.
- *    (Ignore if file is missing)
- *
- * ```ts
- * const loader = new EnvLoader(new URL('./', import.meta.url))
- *
- * const { envContents, currentEnvContents } = await loader.load()
- *
- * // envContents: Contents of .env or file specified via ENV_PATH
- * // currentEnvContents: Contents of .env.[NODE_ENV] file
- * ```
- */
-export declare class EnvLoader {
-    #private;
-    constructor(appRoot: string | URL, loadExampleFile?: boolean);
-    /**
-     * Load contents of the main dot-env file and the current
-     * environment dot-env file
-     */
-    load(): Promise<{
-        contents: string;
-        path: string;
-        fileExists: boolean;
-    }[]>;
-}

package/build/src/loader.js

@@ -1,134 +0,0 @@
-/*
- * @adonisjs/env
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { fileURLToPath } from 'node:url';
-import { readFile } from 'node:fs/promises';
-import { isAbsolute, join } from 'node:path';
-import debug from './debug.js';
-/**
- * Read the contents of one or more dot-env files. Following is how the files
- * are read.
- *
- * - Load file from the "ENV_PATH" environment file.
- *    (Raise error if file is missing)
- *
- * - If "ENV_PATH" is not defined, then find ".env" file in the app root.
- *    (Ignore if file is missing)
- *
- * - Find ".env.[NODE_ENV]" file in the app root.
- *    (Ignore if file is missing)
- *
- * ```ts
- * const loader = new EnvLoader(new URL('./', import.meta.url))
- *
- * const { envContents, currentEnvContents } = await loader.load()
- *
- * // envContents: Contents of .env or file specified via ENV_PATH
- * // currentEnvContents: Contents of .env.[NODE_ENV] file
- * ```
- */
-export class EnvLoader {
-    #appRoot;
-    #loadExampleFile;
-    constructor(appRoot, loadExampleFile = false) {
-        this.#appRoot = typeof appRoot === 'string' ? appRoot : fileURLToPath(appRoot);
-        this.#loadExampleFile = loadExampleFile;
-    }
-    /**
-     * Optionally read a file from the disk
-     */
-    async #loadFile(filePath) {
-        try {
-            const contents = await readFile(filePath, 'utf-8');
-            return { contents, fileExists: true };
-        }
-        catch (error) {
-            /* c8 ignore next 3 */
-            if (error.code !== 'ENOENT') {
-                throw error;
-            }
-            return { contents: '', fileExists: false };
-        }
-    }
-    /**
-     * Load contents of the main dot-env file and the current
-     * environment dot-env file
-     */
-    async load() {
-        const ENV_PATH = process.env.ENV_PATH;
-        const NODE_ENV = process.env.NODE_ENV;
-        const envFiles = [];
-        if (debug.enabled) {
-            debug('ENV_PATH variable is %s', ENV_PATH ? 'set' : 'not set');
-            debug('NODE_ENV variable is %s', NODE_ENV ? 'set' : 'not set');
-        }
-        /**
-         * Base path to load .env files from
-         */
-        const baseEnvPath = ENV_PATH
-            ? isAbsolute(ENV_PATH)
-                ? ENV_PATH
-                : join(this.#appRoot, ENV_PATH)
-            : this.#appRoot;
-        if (debug.enabled) {
-            debug('dot-env files base path "%s"', baseEnvPath);
-        }
-        /**
-         * 1st
-         * The top most priority is given to the ".env.[NODE_ENV].local" file
-         */
-        if (NODE_ENV) {
-            const nodeEnvLocalFile = join(baseEnvPath, `.env.${NODE_ENV}.local`);
-            envFiles.push({
-                path: nodeEnvLocalFile,
-                ...(await this.#loadFile(nodeEnvLocalFile)),
-            });
-        }
-        /**
-         * 2nd
-         * Next, we give priority to the ".env.local" file
-         */
-        if (!NODE_ENV || !['test', 'testing'].includes(NODE_ENV)) {
-            const envLocalFile = join(baseEnvPath, '.env.local');
-            envFiles.push({
-                path: envLocalFile,
-                ...(await this.#loadFile(envLocalFile)),
-            });
-        }
-        /**
-         * 3rd
-         * Next, we give priority to the ".env.[NODE_ENV]" file
-         */
-        if (NODE_ENV) {
-            const nodeEnvFile = join(baseEnvPath, `.env.${NODE_ENV}`);
-            envFiles.push({
-                path: nodeEnvFile,
-                ...(await this.#loadFile(nodeEnvFile)),
-            });
-        }
-        /**
-         * Finally, we push the contents of the ".env" file.
-         */
-        const envFile = join(baseEnvPath, '.env');
-        envFiles.push({
-            path: envFile,
-            ...(await this.#loadFile(envFile)),
-        });
-        /**
-         * Load example file
-         */
-        if (this.#loadExampleFile) {
-            const envExampleFile = join(baseEnvPath, '.env.example');
-            envFiles.push({
-                path: envExampleFile,
-                ...(await this.#loadFile(envExampleFile)),
-            });
-        }
-        return envFiles;
-    }
-}

package/build/src/parser.d.ts

@@ -1,51 +0,0 @@
-import { DotenvParseOutput } from 'dotenv';
-/**
- * Env parser parses the environment variables from a string formatted
- * as a key-value pair seperated using an `=`. For example:
- *
- * ```dotenv
- * PORT=3333
- * HOST=127.0.0.1
- * ```
- *
- * The variables can reference other environment variables as well using `$`.
- * For example:
- *
- * ```dotenv
- * PORT=3333
- * REDIS_PORT=$PORT
- * ```
- *
- * The variables using characters other than letters can wrap variable
- * named inside a curly brace.
- *
- * ```dotenv
- * APP-PORT=3333
- * REDIS_PORT=${APP-PORT}
- * ```
- *
- * You can escape the `$` sign with a backtick.
- *
- * ```dotenv
- * REDIS_PASSWORD=foo\$123
- * ```
- *
- * ## Usage
- *
- * ```ts
- * const parser = new EnvParser(envContents)
- * const output = parser.parse()
- *
- * // The output is a key-value pair
- * ```
- */
-export declare class EnvParser {
-    #private;
-    constructor(envContents: string, options?: {
-        ignoreProcessEnv: boolean;
-    });
-    /**
-     * Parse the env string to an object of environment variables.
-     */
-    parse(): DotenvParseOutput;
-}