@adonisjs/env 7.0.0-next.1 → 7.0.0-next.2

package/build/index.js

@@ -4,11 +4,10 @@ import {
   debug_default
 } from "./chunk-KE5AFOK2.js";
 
-// src/env.ts
-import { schema as envSchema } from "@poppinss/validator-lite";
-
 // src/parser.ts
+import { readFile } from "fs/promises";
 import dotenv from "dotenv";
+import { RuntimeException } from "@poppinss/utils/exception";
 
 // src/errors.ts
 var errors_exports = {};
@@ -29,8 +28,6 @@ var E_IDENTIFIER_ALREADY_DEFINED = createError(
 );
 
 // src/parser.ts
-import { readFile } from "fs/promises";
-import { RuntimeException } from "@poppinss/utils/exception";
 var EnvParser = class _EnvParser {
   /**
    * Raw environment file contents
@@ -260,8 +257,8 @@ var EnvValidator = class {
    *
    * @param schema - The validation schema object
    */
-  constructor(schema) {
-    this.#schema = schema;
+  constructor(schema2) {
+    this.#schema = schema2;
     this.#error = new E_INVALID_ENV_VARIABLES();
   }
   /**
@@ -363,6 +360,38 @@ var EnvProcessor = class {
   }
 };
 
+// src/schema.ts
+import { Secret } from "@poppinss/utils";
+import { schema as envSchema } from "@poppinss/validator-lite";
+function secret(options) {
+  return function validate(key, value) {
+    if (!value) {
+      throw new Error(options?.message ?? `Missing environment variable "${key}"`);
+    }
+    return new Secret(value);
+  };
+}
+secret.optional = function optionalString() {
+  return function validate(_, value) {
+    if (!value) {
+      return void 0;
+    }
+    return new Secret(value);
+  };
+};
+secret.optionalWhen = function optionalWhenString(condition, options) {
+  return function validate(key, value) {
+    if (typeof condition === "function" ? condition(key, value) : condition) {
+      return secret.optional()(key, value);
+    }
+    return secret(options)(key, value);
+  };
+};
+var schema = {
+  ...envSchema,
+  secret
+};
+
 // src/env.ts
 var Env = class _Env {
   /**
@@ -386,9 +415,9 @@ var Env = class _Env {
    * @param schema - Validation schema for environment variables
    * @returns Promise resolving to an Env instance with validated values
    */
-  static async create(appRoot, schema) {
+  static async create(appRoot, schema2) {
     const values = await new EnvProcessor(appRoot).process();
-    const validator = this.rules(schema);
+    const validator = this.rules(schema2);
     return new _Env(validator.validate(values));
   }
   /**
@@ -434,7 +463,7 @@ var Env = class _Env {
   /**
    * The schema builder for defining validation rules
    */
-  static schema = envSchema;
+  static schema = schema;
   /**
    * Define the validation rules for validating environment
    * variables. The return value is an instance of the
@@ -443,8 +472,8 @@ var Env = class _Env {
    * @param schema - Validation schema object
    * @returns EnvValidator instance
    */
-  static rules(schema) {
-    const validator = new EnvValidator(schema);
+  static rules(schema2) {
+    const validator = new EnvValidator(schema2);
     return validator;
   }
   get(key, defaultValue) {

package/build/src/env.d.ts

@@ -1,6 +1,6 @@
-import { schema as envSchema } from '@poppinss/validator-lite';
 import type { ValidateFn } from '@poppinss/validator-lite/types';
 import { EnvValidator } from './validator.ts';
+import { schema as envSchema } from './schema.ts';
 /**
  * A wrapper over "process.env" with types information.
  *

package/build/src/parser.d.ts

@@ -3,7 +3,7 @@ import { type 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
  * ```
@@ -11,7 +11,7 @@ import { type DotenvParseOutput } from 'dotenv';
  * The variables can reference other environment variables as well using `$`.
  * For example:
  *
- * ```dotenv
+ * ```
  * PORT=3333
  * REDIS_PORT=$PORT
  * ```
@@ -19,14 +19,14 @@ import { type DotenvParseOutput } from 'dotenv';
  * 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
  * ```
  *

package/build/src/schema.d.ts

@@ -0,0 +1,13 @@
+import { Secret } from '@poppinss/utils';
+import { type Prettify } from '@poppinss/utils/types';
+import { schema as envSchema } from '@poppinss/validator-lite';
+import { type SchemaFnOptions } from '@poppinss/validator-lite/types';
+declare function secret(options?: SchemaFnOptions): (key: string, value?: string) => Secret<string>;
+declare namespace secret {
+    var optional: () => (_: string, value?: string) => Secret<string> | undefined;
+    var optionalWhen: (condition: boolean | ((key: string, value?: string) => boolean), options?: SchemaFnOptions) => (key: string, value?: string) => Secret<string> | undefined;
+}
+export declare const schema: Prettify<typeof envSchema & {
+    secret: typeof secret;
+}>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/env",
-  "version": "7.0.0-next.1",
+  "version": "7.0.0-next.2",
   "description": "Environment variable manager for Node.js",
   "main": "build/index.js",
   "type": "module",
@@ -43,20 +43,21 @@
     "@japa/runner": "^4.4.0",
     "@poppinss/ts-exec": "^1.4.1",
     "@release-it/conventional-changelog": "^10.0.1",
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.3.1",
     "c8": "^10.1.3",
     "cross-env": "^10.0.0",
     "del-cli": "^6.0.0",
-    "eslint": "^9.34.0",
+    "eslint": "^9.35.0",
     "prettier": "^3.6.2",
     "release-it": "^19.0.4",
     "tsup": "^8.5.0",
+    "typedoc": "^0.28.12",
     "typescript": "^5.9.2"
   },
   "dependencies": {
     "@poppinss/utils": "^7.0.0-next.3",
     "@poppinss/validator-lite": "^2.1.2",
-    "dotenv": "^17.2.1",
+    "dotenv": "^17.2.2",
     "split-lines": "^3.0.0"
   },
   "homepage": "https://github.com/adonisjs/env#readme",