@adonisjs/env 3.0.9 → 4.0.0-1

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-1",
+  "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
+  }
 }

package/build/adonis-typings/env.d.ts

@@ -1,127 +0,0 @@
-declare module '@ioc:Adonis/Core/Env' {
-    /**
-     * An interface meant to be extended in the user land that holds
-     * types for environment variables extracted using env.validate
-     * method.
-     */
-    export interface EnvTypes {
-    }
-    /**
-     * The shape of the validate fn
-     */
-    export type ValidateFn<T extends unknown> = (key: string, value?: string) => T;
-    /**
-     * A standard set of options accepted by the schema validation
-     * functions
-     */
-    export type SchemaFnOptions = {
-        message?: string;
-    };
-    export type StringFnUrlOptions = SchemaFnOptions & {
-        format: 'url';
-        /**
-         * Whether the URL must have a valid TLD in their domain.
-         * Defaults to `true`.
-         */
-        tld?: boolean;
-        /**
-         * Whether the URL must start with a valid protocol.
-         * Defaults to `true`.
-         */
-        protocol?: boolean;
-    };
-    /**
-     * Options accepted by the string schema function
-     */
-    export type StringFnOptions = (SchemaFnOptions & {
-        format?: 'host' | 'email';
-    }) | StringFnUrlOptions;
-    /**
-     * Shape of the number validator
-     */
-    export interface NumberType {
-        (options?: SchemaFnOptions): ValidateFn<number>;
-        optional: (options?: SchemaFnOptions) => ValidateFn<number | undefined>;
-    }
-    /**
-     * Shape of the string validator
-     */
-    export interface StringType {
-        (options?: StringFnOptions): ValidateFn<string>;
-        optional: (options?: StringFnOptions) => ValidateFn<string | undefined>;
-    }
-    /**
-     * Shape of the boolean validator
-     */
-    export interface BooleanType {
-        (options?: SchemaFnOptions): ValidateFn<boolean>;
-        optional: (options?: SchemaFnOptions) => ValidateFn<boolean | undefined>;
-    }
-    /**
-     * Shape of the enum validator
-     */
-    export interface EnumType {
-        <K extends any>(choices: readonly K[], options?: SchemaFnOptions): ValidateFn<K>;
-        optional: <K extends any>(choices: readonly K[], options?: SchemaFnOptions) => ValidateFn<K | undefined>;
-    }
-    /**
-     * Available schema functions. The end user can also define their
-     * own
-     */
-    export interface EnvSchema {
-        /**
-         * Number function to enforce value to be a strict number
-         */
-        number: NumberType;
-        /**
-         * String function to enforce value to be a string. Optionally
-         * the format can also be defined
-         */
-        string: StringType;
-        /**
-         * Boolean function to enforce value to be a boolean value.
-         */
-        boolean: BooleanType;
-        /**
-         * Boolean function to enforce value to be one of the defined values.
-         */
-        enum: EnumType;
-    }
-    /**
-     * Env contract
-     */
-    export interface EnvContract {
-        /**
-         * Get value for a given environment variable
-         */
-        get<K extends keyof EnvTypes>(key: K): EnvTypes[K];
-        get<K extends keyof EnvTypes>(key: K, defaultValue: Exclude<EnvTypes[K], undefined>): Exclude<EnvTypes[K], undefined>;
-        get(key: string, defaultValue?: any): any;
-        /**
-         * Update/set value for a given environment variable. Ideally one should
-         * avoid updating values during runtime
-         */
-        set<K extends keyof EnvTypes>(key: K, value: EnvTypes[K]): void;
-        set(key: string, value: any): void;
-        /**
-         * Validate environment variables
-         */
-        rules<T extends {
-            [key: string]: ValidateFn<unknown>;
-        }>(values: T): {
-            [K in keyof T]: ReturnType<T[K]>;
-        };
-        /**
-         * Processes environment variables and performs the registered
-         * validations
-         */
-        process(): void;
-        /**
-         * Reference to the schema object for defining validation
-         * rules
-         */
-        schema: EnvSchema;
-    }
-    const Env: EnvContract;
-    export default Env;
-}

package/build/adonis-typings/env.js

@@ -1,8 +0,0 @@
-/*
- * @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.
- */

package/build/src/Env/index.d.ts

@@ -1,59 +0,0 @@
-/// <reference path="../../adonis-typings/env.d.ts" />
-import { DotenvParseOutput } from 'dotenv';
-import { EnvContract, ValidateFn } from '@ioc:Adonis/Core/Env';
-/**
- * The ENV module enables the use of environment variables by parsing dotfiles syntax
- * and updates the `process.env` object in Node.js.
- *
- * AdonisJs automatically reads and passes the contents of `.env` file to this class.
- */
-export declare class Env implements EnvContract {
-    private valuesToProcess;
-    /**
-     * A boolean to know if the values have been processed or
-     * not
-     */
-    private hasProcessedValues;
-    /**
-     * A cache of env values
-     */
-    private envCache;
-    /**
-     * The schema to be used for validating and casting environment
-     * variables
-     */
-    private validationSchema;
-    constructor(valuesToProcess: {
-        values: DotenvParseOutput;
-        overwriteExisting: boolean;
-    }[]);
-    /**
-     * Reference to the underlying schema
-     */
-    schema: import("@ioc:Adonis/Core/Env").EnvSchema;
-    /**
-     * Process parsed env variables. The values will be validated
-     * against the validation schema
-     */
-    process(): void;
-    /**
-     * Register the validation schema
-     */
-    rules(schema: {
-        [key: string]: ValidateFn<unknown>;
-    }): any;
-    /**
-     * Returns the environment variable value. First the cached
-     * values are preferred. When missing, the value from
-     * "process.env" is used
-     */
-    get(key: string, defaultValue?: any): any;
-    /**
-     * Set key-value pair. The value will be validated using
-     * the validation rule if exists.
-     *
-     * The original value is also updated on the `process.env`
-     * object
-     */
-    set(key: string, value: any): void;
-}

package/build/src/Env/index.js

@@ -1,140 +0,0 @@
-"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.Env = void 0;
-const Schema_1 = require("../Schema");
-/**
- * The ENV module enables the use of environment variables by parsing dotfiles syntax
- * and updates the `process.env` object in Node.js.
- *
- * AdonisJs automatically reads and passes the contents of `.env` file to this class.
- */
-class Env {
-    constructor(valuesToProcess) {
-        this.valuesToProcess = valuesToProcess;
-        /**
-         * A boolean to know if the values have been processed or
-         * not
-         */
-        this.hasProcessedValues = false;
-        /**
-         * A cache of env values
-         */
-        this.envCache = {};
-        /**
-         * The schema to be used for validating and casting environment
-         * variables
-         */
-        this.validationSchema = {};
-        /**
-         * Reference to the underlying schema
-         */
-        this.schema = Schema_1.schema;
-    }
-    /**
-     * Process parsed env variables. The values will be validated
-     * against the validation schema
-     */
-    process() {
-        /**
-         * Avoid re-processing the same values over and over
-         * again
-         */
-        if (this.hasProcessedValues) {
-            return;
-        }
-        this.hasProcessedValues = true;
-        /**
-         * Loop over the parsed object and set the value
-         * on the process.env and the local cache.
-         *
-         * At this stage we process the values like a regular env parser with
-         * no validation taking place
-         */
-        this.valuesToProcess.forEach(({ values, overwriteExisting }) => {
-            Object.keys(values).forEach((key) => {
-                /**
-                 * Use existing value when it already exists in process.env object
-                 * and [this.overwriteExisting] is set to false
-                 */
-                const existingValue = process.env[key];
-                if (existingValue && !overwriteExisting) {
-                    this.envCache[key] = existingValue;
-                    return;
-                }
-                /**
-                 * Otherwise set the value on "process.env"
-                 */
-                this.envCache[key] = values[key];
-                process.env[key] = values[key];
-            });
-        });
-        /**
-         * Release parsed values, since we don't need it anymore
-         */
-        this.valuesToProcess = [];
-        /**
-         * Perform validations by reading the environment variables
-         */
-        Object.keys(this.validationSchema).forEach((key) => {
-            this.envCache[key] = this.validationSchema[key](key, this.get(key));
-        });
-    }
-    /**
-     * Register the validation schema
-     */
-    rules(schema) {
-        this.validationSchema = schema;
-        return {};
-    }
-    /**
-     * Returns the environment variable value. First the cached
-     * values are preferred. When missing, the value from
-     * "process.env" is used
-     */
-    get(key, defaultValue) {
-        /**
-         * Return cached value
-         */
-        if (this.envCache[key] !== undefined) {
-            return this.envCache[key];
-        }
-        /**
-         * Get value from process.env and update the cache
-         */
-        const envValue = process.env[key];
-        if (envValue) {
-            this.envCache[key] = envValue;
-            return envValue;
-        }
-        /**
-         * Return default value when unable to lookup any other value
-         */
-        return defaultValue;
-    }
-    /**
-     * Set key-value pair. The value will be validated using
-     * the validation rule if exists.
-     *
-     * The original value is also updated on the `process.env`
-     * object
-     */
-    set(key, value) {
-        const validationFn = this.validationSchema[key];
-        if (validationFn) {
-            this.envCache[key] = validationFn(key, value);
-        }
-        else {
-            this.envCache[key] = value;
-        }
-        process.env[key] = value;
-    }
-}
-exports.Env = Env;

package/build/src/Parser/index.d.ts

@@ -1,54 +0,0 @@
-/**
- * Env parser parses the environment variables from a string formatted
- * as a key-value pair seperated using an `=`. For example:
- *
- * ```
- * PORT=3333
- * HOST=127.0.0.1
- * ```
- *
- * The variables can reference other environment variables as well using `$`.
- * For example:
- *
- * ```
- * PORT=3333
- * REDIS_PORT=$PORT
- * ```
- *
- * The variables using characters other than letters can use wrap variables inside
- * a curly brace.
- *
- * ```
- * APP-PORT=3333
- * REDIS_PORT=${APP-PORT}
- * ```
- */
-export declare class EnvParser {
-    private preferExistingEnvVariables;
-    constructor(preferExistingEnvVariables?: boolean);
-    /**
-     * Returns value for a given key from the environment variables. Also
-     * the current parsed object is used to pull the reference.
-     */
-    private getValue;
-    /**
-     * Interpolating the token wrapped inside the mustache
-     * braces.
-     */
-    private interpolateMustache;
-    /**
-     * Interpolating the variable reference starting with a
-     * `$`. We only capture numbers,letter and underscore.
-     * For other characters, one can use the mustache
-     * braces.
-     */
-    private interpolateVariable;
-    /**
-     * Interpolates the referenced values
-     */
-    private interpolate;
-    /**
-     * Parse the env string to an object of environment variables.
-     */
-    parse(envString: string): {};
-}