@atlantjs/backend 1.2.1 → 1.2.3

package/backend/application/env/env-vars.js

@@ -6,16 +6,17 @@ const arch_1 = require("@atlantjs/arch");
 exports.APP_PORT = new env_var_1.EnvVar({
     name: "APP_PORT",
     type: "port-number",
-    isRequired: true,
+    description: "The port number on which the application will run",
 }).get();
 exports.LOAD_MODULES = new env_var_1.EnvVar({
     name: "LOAD_MODULES",
     type: "array",
-    isRequired: true,
+    description: "List of modules, separated by commas, to be loaded by the application",
 }).get();
 exports.CORS_ALLOWED_ORIGINS = new env_var_1.EnvVar({
     name: "CORS_ALLOWED_ORIGINS",
     defaultValue: "*",
+    description: "Allowed origins for CORS",
 }).get();
 exports.ENVIRONMENT = new env_var_1.EnvVar({
     name: "ENVIRONMENT",
@@ -27,6 +28,7 @@ exports.ENVIRONMENT = new env_var_1.EnvVar({
         arch_1.NodeEnvs.production,
         arch_1.NodeEnvs.homolog,
     ],
+    description: "The current environment in which the application is running",
 }).get();
 const isProdOrHomolog = () => [arch_1.NodeEnvs.homolog, arch_1.NodeEnvs.production].includes(exports.ENVIRONMENT);
 exports.isProdOrHomolog = isProdOrHomolog;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlantjs/backend",
-	"version": "1.2.1",
+	"version": "1.2.3",
 	"main": "index.js",
 	"license": "UNLICENSED",
 	"publishConfig": {

package/setup/env-var/env-var.error.d.ts

@@ -1,2 +1,3 @@
 export declare class PickEnvError extends Error {
+    constructor(variableName: string, variableDescription: string, messageError: string);
 }

package/setup/env-var/env-var.error.js

@@ -2,5 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PickEnvError = void 0;
 class PickEnvError extends Error {
+    constructor(variableName, variableDescription, messageError) {
+        super(`${messageError}\n - ${variableName}: ${variableDescription}`);
+    }
 }
 exports.PickEnvError = PickEnvError;

package/setup/env-var/env-var.type.d.ts

@@ -1,8 +1,15 @@
 export type EnvTypes = "string" | "port-number" | "array" | "enum" | "url-https" | "int" | "boolean" | "float";
-export interface PickEnvType<ValueType> {
+interface BasePickEnvType<ValueType> {
     name: string;
-    type?: EnvTypes;
+    description: string;
+    type?: Exclude<EnvTypes, "enum">;
+    enumValues?: string[];
     isRequired?: boolean;
     defaultValue?: ValueType;
-    enumValues?: string[];
 }
+interface EnumPickEnvType<ValueType> extends Omit<BasePickEnvType<ValueType>, 'type'> {
+    type: "enum";
+    enumValues: string[];
+}
+export type PickEnvType<ValueType = string> = BasePickEnvType<ValueType> | EnumPickEnvType<ValueType>;
+export {};

package/setup/env-var/index.d.ts

@@ -3,8 +3,9 @@ export declare class EnvVar<ValueType> {
     private variableValue;
     private variableName;
     private variableType;
+    private variableDescription;
     private enumValues?;
-    constructor({ name, type, isRequired, defaultValue, enumValues, }: PickEnvType<ValueType>);
+    constructor({ name, type, isRequired, defaultValue, enumValues, description }: PickEnvType<ValueType>);
     get(): ValueType;
     private urlHttpVerify;
     private portNumberVerify;

package/setup/env-var/index.js

@@ -4,13 +4,14 @@ exports.EnvVar = void 0;
 const env_var_error_1 = require("./env-var.error");
 const arch_1 = require("@atlantjs/arch");
 class EnvVar {
-    constructor({ name, type = "string", isRequired = true, defaultValue, enumValues, }) {
+    constructor({ name, type = "string", isRequired = true, defaultValue, enumValues, description }) {
         this.variableValue = process.env[name] || defaultValue?.toString();
         this.variableType = type;
         this.variableName = name;
+        this.variableDescription = description;
         this.enumValues = enumValues;
         if (arch_1.Guardian.isEmpty(this.variableValue) && isRequired.truthy()) {
-            throw new env_var_error_1.PickEnvError(`A variável de ambiente ${name} tem que ter seu valor definido`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `A variável de ambiente tem que ter seu valor definido`);
         }
     }
     get() {
@@ -45,7 +46,7 @@ class EnvVar {
         }
         const urlPattern = /^https?:\/\/[^\s/$.?#].[^\s]*$/i;
         if (!urlPattern.test(this.variableValue)) {
-            throw new env_var_error_1.PickEnvError(`O valor da variável de ambiente ${this.variableName} deve ser uma URL válida começando com http ou https`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `O valor da variável de ambiente ${this.variableName} deve ser uma URL válida começando com http ou https`);
         }
         return this.variableValue;
     }
@@ -55,7 +56,7 @@ class EnvVar {
         }
         const portNumber = parseInt(this.variableValue, 10);
         if (isNaN(portNumber) || portNumber < 1 || portNumber > 65535) {
-            throw new env_var_error_1.PickEnvError(`O valor da variável de ambiente ${this.variableName} deve ser um número de porta válido entre 1 e 65535`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `O valor da variável de ambiente ${this.variableName} deve ser um número de porta válido entre 1 e 65535`);
         }
         return this.variableValue;
     }
@@ -65,7 +66,7 @@ class EnvVar {
         }
         const intValue = parseInt(this.variableValue, 10);
         if (isNaN(intValue)) {
-            throw new env_var_error_1.PickEnvError(`O valor da variável de ambiente ${this.variableName} deve ser um número inteiro válido`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `O valor da variável de ambiente ${this.variableName} deve ser um número inteiro válido`);
         }
         return intValue;
     }
@@ -75,7 +76,7 @@ class EnvVar {
         }
         const floatValue = parseFloat(this.variableValue);
         if (isNaN(floatValue)) {
-            throw new env_var_error_1.PickEnvError(`O valor da variável de ambiente ${this.variableName} deve ser um número float válido`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `O valor da variável de ambiente ${this.variableName} deve ser um número float válido`);
         }
         return floatValue;
     }
@@ -90,7 +91,7 @@ class EnvVar {
             return undefined;
         }
         if (arch_1.Guardian.isAnyOf(this.variableValue, ["false", "true"]).falsy()) {
-            throw new env_var_error_1.PickEnvError(`O valor da variável de ambiente ${this.variableValue} tem que ser "false" ou "true"`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `O valor da variável de ambiente ${this.variableValue} tem que ser "false" ou "true"`);
         }
         if (arch_1.Guardian.isEqual(this.variableValue, "true"))
             return true;
@@ -101,10 +102,10 @@ class EnvVar {
             return undefined;
         }
         if (arch_1.Guardian.isUndefined(this.enumValues)) {
-            throw new env_var_error_1.PickEnvError(`A definição da variável de ambiente ${this.variableName} deve conter os valores de referencia do enum`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `A definição da variável de ambiente ${this.variableName} deve conter os valores de referencia do enum`);
         }
         if (this.enumValues.includes(this.variableValue).falsy()) {
-            throw new env_var_error_1.PickEnvError(`A variável ${this.variableName} deve conter algum dos seguintes valores: [${this.enumValues.join(", ")}]`);
+            throw new env_var_error_1.PickEnvError(this.variableName, this.variableDescription, `A variável ${this.variableName} deve conter algum dos seguintes valores: [${this.enumValues.join(", ")}]`);
         }
         return this.variableValue;
     }