@atlantjs/backend 4.1.0 → 5.0.1

package/backend/application/databases/database.config.js

@@ -23,7 +23,7 @@ class DatabaseConfigAbstract {
             password: this.props.adminPassword,
             database: this.props.name,
             schema: this.props.schemaName,
-            synchronize: env_vars_1.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED,
+            synchronize: arch_1._.isEqual(env_vars_1.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED, "true"),
             entities: this.props.schemaPaths,
             migrations: this.props.migrationPaths,
         };
@@ -34,7 +34,7 @@ class DatabaseConfigAbstract {
                 resourceArn: this.props.resourceArn ?? "",
             });
         }
-        if (arch_1._.isTruthy(env_vars_1.DATABASE_SSL_ENABLED)) {
+        if (arch_1._.isEqual(env_vars_1.DATABASE_SSL_ENABLED, "true")) {
             Object.assign(baseConfig, this.sslConfig);
         }
         this.configs = new typeorm_1.DataSource(baseConfig);

package/backend/application/env/env-vars.d.ts

@@ -5,11 +5,11 @@ export declare const DATABASE_NAME: string;
 export declare const DATABASE_DEFAULT_SCHEMA: string;
 export declare const DATABASE_HOST: string;
 export declare const DATABASE_ADMIN_PASSWORD: string;
-export declare const DATABASE_PORT: string;
+export declare const DATABASE_PORT: number;
 export declare const DATABASE_ADMIN_USER: string;
 export declare const DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED: boolean;
 export declare const DATABASE_SSL_ENABLED: boolean;
-export declare const APP_PORT: string;
-export declare const LOAD_MODULES: string;
+export declare const APP_PORT: number;
+export declare const LOAD_MODULES: string[];
 export declare const CORS_ALLOWED_ORIGINS: string;
 export declare const ENVIRONMENT: NodeEnvs;

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

@@ -2,65 +2,83 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENVIRONMENT = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = exports.DATABASE_SSL_ENABLED = exports.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED = exports.DATABASE_ADMIN_USER = exports.DATABASE_PORT = exports.DATABASE_ADMIN_PASSWORD = exports.DATABASE_HOST = exports.DATABASE_DEFAULT_SCHEMA = exports.DATABASE_NAME = exports.DATABASE_TYPE = void 0;
 const arch_1 = require("@atlantjs/arch");
-const env_var_1 = require("../../../setup/env-var");
-exports.DATABASE_TYPE = env_var_1.EnvVar.get({
+const parchment_1 = require("../../../setup/parchment/parchment");
+exports.DATABASE_TYPE = parchment_1.Parchment.verse({
     name: "DATABASE_TYPE",
     type: "enum",
     description: "The type of the database",
     default: "postgres",
     values: ["aurora-postgres", "postgres", "sqlite"],
+    isRequired: true,
 });
-exports.DATABASE_NAME = env_var_1.EnvVar.get({
+exports.DATABASE_NAME = parchment_1.Parchment.verse({
     name: "DATABASE_NAME",
+    type: "text",
     description: "The name of the database",
+    isRequired: true,
 });
-exports.DATABASE_DEFAULT_SCHEMA = env_var_1.EnvVar.get({
+exports.DATABASE_DEFAULT_SCHEMA = parchment_1.Parchment.verse({
     name: "DATABASE_DEFAULT_SCHEMA",
+    type: "text",
     description: "The name of default schema the database",
+    isRequired: true,
 });
-exports.DATABASE_HOST = env_var_1.EnvVar.get({
+exports.DATABASE_HOST = parchment_1.Parchment.verse({
     name: "DATABASE_HOST",
     description: "The host address of the database server",
+    type: "text",
+    isRequired: true,
 });
-exports.DATABASE_ADMIN_PASSWORD = env_var_1.EnvVar.get({
+exports.DATABASE_ADMIN_PASSWORD = parchment_1.Parchment.verse({
     name: "DATABASE_ADMIN_PASSWORD",
     description: "The password for the database user",
+    type: "text",
+    isRequired: true,
 });
-exports.DATABASE_PORT = env_var_1.EnvVar.get({
+exports.DATABASE_PORT = parchment_1.Parchment.verse({
     name: "DATABASE_PORT",
     type: "port-number",
     description: "The port number on which the database server is running",
+    isRequired: true,
 });
-exports.DATABASE_ADMIN_USER = env_var_1.EnvVar.get({
+exports.DATABASE_ADMIN_USER = parchment_1.Parchment.verse({
     name: "DATABASE_ADMIN_USER",
     description: "The username for the database database",
+    type: "text",
+    isRequired: true,
 });
-exports.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED = env_var_1.EnvVar.get({
+exports.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED = parchment_1.Parchment.verse({
     name: "DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED",
     type: "boolean",
     description: "Flag indicating whether the ORM automatically creates tables in the database based on .schema.ts files",
+    isRequired: true,
 });
-exports.DATABASE_SSL_ENABLED = env_var_1.EnvVar.get({
+exports.DATABASE_SSL_ENABLED = parchment_1.Parchment.verse({
     name: "DATABASE_SSL_ENABLED",
     type: "boolean",
     description: "Flag indicating whether the database requires an SSL connection",
+    isRequired: true,
 });
-exports.APP_PORT = env_var_1.EnvVar.get({
+exports.APP_PORT = parchment_1.Parchment.verse({
     name: "APP_PORT",
     type: "port-number",
     description: "The port number on which the application will run",
+    isRequired: true,
 });
-exports.LOAD_MODULES = env_var_1.EnvVar.get({
+exports.LOAD_MODULES = parchment_1.Parchment.verse({
     name: "LOAD_MODULES",
     type: "array",
     description: "List of modules, separated by commas, to be loaded by the application",
+    isRequired: true,
 });
-exports.CORS_ALLOWED_ORIGINS = env_var_1.EnvVar.get({
+exports.CORS_ALLOWED_ORIGINS = parchment_1.Parchment.verse({
     name: "CORS_ALLOWED_ORIGINS",
     default: "*",
     description: "Allowed origins for CORS",
+    type: "text",
+    isRequired: true,
 });
-exports.ENVIRONMENT = env_var_1.EnvVar.get({
+exports.ENVIRONMENT = parchment_1.Parchment.verse({
     name: "ENVIRONMENT",
     type: "enum",
     isRequired: true,

package/index.d.ts

@@ -9,7 +9,7 @@ export { IsTimeString } from "./backend/infrastructure/controllers/validators/is
 export { DatabaseConfigAbstract } from "./backend/application/databases/database.config";
 export { DatabaseHelperAbstract } from "./backend/application/databases/database.helper.abstract";
 export { APP_PORT, LOAD_MODULES, CORS_ALLOWED_ORIGINS, ENVIRONMENT, DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED, DATABASE_SSL_ENABLED, DATABASE_TYPE, DATABASE_NAME, DATABASE_DEFAULT_SCHEMA, DATABASE_HOST, DATABASE_ADMIN_USER, DATABASE_ADMIN_PASSWORD, DATABASE_PORT, } from "./backend/application/env/env-vars";
-export { EnvVar } from "./setup/env-var";
+export { Parchment } from "./setup/parchment/parchment";
 export { InjectionsAbstract } from "./backend/application/injections.abstract";
 export { PrimaryColumn, Column, Entity, JoinColumn, ManyToOne, OneToMany, OneToOne, ManyToMany, BeforeInsert, BeforeUpdate, } from "typeorm";
 export { EntityAbstract } from "./backend/domain/entities/entity.abstract";

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatabaseConfigAbstract = exports.IsTimeString = exports.IsPayload = exports.registerDecorator = exports.IsNotEmptyObject = exports.IsDateString = exports.IsObject = exports.IsArray = exports.IsString = exports.IsInt = exports.IsEnum = exports.IsNumber = exports.IsDate = exports.IsBoolean = exports.IsNumberString = exports.IsUrl = exports.IsUUID = exports.IsJWT = exports.IsJSON = exports.IsPort = exports.IsIP = exports.IsCurrency = exports.IsEmail = exports.IsBase64 = exports.IsDecimal = exports.MaxDate = exports.MinDate = exports.Min = exports.Max = exports.IsNegative = exports.IsPositive = exports.IsNotEmpty = exports.IsEmpty = exports.IsLongitude = exports.IsLatitude = exports.IsLatLong = exports.ValidateInner = exports.IsOptional = exports.Params = exports.Param = exports.Req = exports.Body = exports.Res = exports.JsonController = exports.UseBefore = exports.Patch = exports.Delete = exports.Post = exports.Get = exports.getFromContainer = void 0;
-exports.initializeApi = exports.DatabaseLiteConfigAbstract = exports.injectable = exports.inject = exports.Container = exports.Server = exports.DefaultErrorHandlerMiddleware = exports.CorsMiddleware = exports.BodyParserMiddleware = exports.DiContainerAbstract = exports.diContainer = exports.startContainer = exports.SchemaAbstract = exports.ResponseAbstract = exports.ValidatorAbstract = exports.PayloadAbstract = exports.ControllerAbstract = exports.CommandAbstract = exports.ServiceAbstract = exports.RepositoryAbstract = exports.ProviderAbstract = exports.MiddlewareHandlerAbstract = exports.EntityAbstract = exports.BeforeUpdate = exports.BeforeInsert = exports.ManyToMany = exports.OneToOne = exports.OneToMany = exports.ManyToOne = exports.JoinColumn = exports.Entity = exports.Column = exports.PrimaryColumn = exports.InjectionsAbstract = exports.EnvVar = exports.DATABASE_PORT = exports.DATABASE_ADMIN_PASSWORD = exports.DATABASE_ADMIN_USER = exports.DATABASE_HOST = exports.DATABASE_DEFAULT_SCHEMA = exports.DATABASE_NAME = exports.DATABASE_TYPE = exports.DATABASE_SSL_ENABLED = exports.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED = exports.ENVIRONMENT = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = exports.DatabaseHelperAbstract = void 0;
+exports.initializeApi = exports.DatabaseLiteConfigAbstract = exports.injectable = exports.inject = exports.Container = exports.Server = exports.DefaultErrorHandlerMiddleware = exports.CorsMiddleware = exports.BodyParserMiddleware = exports.DiContainerAbstract = exports.diContainer = exports.startContainer = exports.SchemaAbstract = exports.ResponseAbstract = exports.ValidatorAbstract = exports.PayloadAbstract = exports.ControllerAbstract = exports.CommandAbstract = exports.ServiceAbstract = exports.RepositoryAbstract = exports.ProviderAbstract = exports.MiddlewareHandlerAbstract = exports.EntityAbstract = exports.BeforeUpdate = exports.BeforeInsert = exports.ManyToMany = exports.OneToOne = exports.OneToMany = exports.ManyToOne = exports.JoinColumn = exports.Entity = exports.Column = exports.PrimaryColumn = exports.InjectionsAbstract = exports.Parchment = exports.DATABASE_PORT = exports.DATABASE_ADMIN_PASSWORD = exports.DATABASE_ADMIN_USER = exports.DATABASE_HOST = exports.DATABASE_DEFAULT_SCHEMA = exports.DATABASE_NAME = exports.DATABASE_TYPE = exports.DATABASE_SSL_ENABLED = exports.DATABASE_AUTOMATICALLY_CREATE_TABLES_ENABLED = exports.ENVIRONMENT = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = exports.DatabaseHelperAbstract = void 0;
 require("./backend/application/env/load-envs");
 require("reflect-metadata");
 const setup_1 = require("./setup");
@@ -77,8 +77,8 @@ Object.defineProperty(exports, "DATABASE_HOST", { enumerable: true, get: functio
 Object.defineProperty(exports, "DATABASE_ADMIN_USER", { enumerable: true, get: function () { return env_vars_1.DATABASE_ADMIN_USER; } });
 Object.defineProperty(exports, "DATABASE_ADMIN_PASSWORD", { enumerable: true, get: function () { return env_vars_1.DATABASE_ADMIN_PASSWORD; } });
 Object.defineProperty(exports, "DATABASE_PORT", { enumerable: true, get: function () { return env_vars_1.DATABASE_PORT; } });
-var env_var_1 = require("./setup/env-var");
-Object.defineProperty(exports, "EnvVar", { enumerable: true, get: function () { return env_var_1.EnvVar; } });
+var parchment_1 = require("./setup/parchment/parchment");
+Object.defineProperty(exports, "Parchment", { enumerable: true, get: function () { return parchment_1.Parchment; } });
 var injections_abstract_1 = require("./backend/application/injections.abstract");
 Object.defineProperty(exports, "InjectionsAbstract", { enumerable: true, get: function () { return injections_abstract_1.InjectionsAbstract; } });
 var typeorm_1 = require("typeorm");

package/package.json

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

package/setup/parchment/parchment.d.ts

@@ -0,0 +1,5 @@
+import { PickVerseType } from "./parchment.type";
+export declare class Parchment {
+    static verse<VerseType>({ ...verse }: PickVerseType<VerseType>): VerseType;
+    private static convertSetValue;
+}

package/setup/parchment/parchment.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parchment = void 0;
+const arch_1 = require("@atlantjs/arch");
+const parchment_error_1 = require("./parchment.error");
+class Parchment {
+    static verse({ ...verse }) {
+        const setValue = process.env[verse.name] || verse.default?.toString();
+        if (arch_1._.isEmpty(setValue) && verse.isRequired.truthy()) {
+            throw new parchment_error_1.PickEnvError(verse.name, verse.description, "The environment variable must have its value defined");
+        }
+        return Parchment.convertSetValue(verse, setValue);
+    }
+    static convertSetValue(verse, value) {
+        if (arch_1._.isUndefined(value)) {
+            return undefined;
+        }
+        if (verse.type === "array") {
+            return value.split(",");
+        }
+        if (verse.type === "boolean") {
+            if (arch_1._.isAnyOf(value, ["false", "true"]).falsy()) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `The value of the environment variable ${value} must be "false" or "true"`);
+            }
+            return arch_1._.isEqual(value, "true");
+        }
+        if (verse.type === "enum") {
+            if (arch_1._.isUndefined(verse.values)) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `A definição da variável de ambiente ${verse.name} deve conter os valores de referencia`);
+            }
+            if (verse.values.includes(value).falsy()) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `A variável ${verse.name} deve conter algum dos seguintes valores: [${verse.values.join(", ")}]`);
+            }
+            return value;
+        }
+        if (verse.type === "float") {
+            const floatValue = Number.parseFloat(value);
+            if (Number.isNaN(floatValue)) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `The value of the environment variable ${verse.name} must be a valid float number`);
+            }
+            return floatValue;
+        }
+        if (verse.type === "int") {
+            const intValue = Number.parseInt(value, 10);
+            if (Number.isNaN(intValue)) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `O valor da variável de ambiente ${verse.name} deve ser um número inteiro válido`);
+            }
+            return intValue;
+        }
+        if (verse.type === "port-number") {
+            const portNumber = Number.parseInt(value, 10);
+            if (Number.isNaN(portNumber) || portNumber < 1 || portNumber > 65535) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `O valor da variável de ambiente ${verse.name} deve ser um número de porta válido entre 1 e 65535`);
+            }
+            return portNumber;
+        }
+        if (verse.type === "text") {
+            return value;
+        }
+        if (verse.type === "url-https") {
+            const urlPattern = /^https?:\/\/[^\s/$.?#].[^\s]*$/i;
+            if (!urlPattern.test(value)) {
+                throw new parchment_error_1.PickEnvError(verse.name, verse.description, `O valor da variável de ambiente ${verse.name} deve ser uma URL válida começando com http ou https`);
+            }
+            return value;
+        }
+    }
+}
+exports.Parchment = Parchment;

package/setup/parchment/parchment.type.d.ts

@@ -0,0 +1,9 @@
+export type VerseTypes = "text" | "port-number" | "array" | "enum" | "url-https" | "int" | "boolean" | "float";
+export interface PickVerseType<VerseType> {
+    name: string;
+    description: string;
+    type: VerseTypes;
+    values?: string[];
+    isRequired: boolean;
+    default?: VerseType;
+}