@atlantjs/backend 1.1.3 → 1.1.5

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

@@ -1,7 +1,6 @@
 import { NodeEnvs } from "@atlantjs/arch";
-export declare const IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256: string | undefined;
-export declare const APP_PORT: number;
+export declare const APP_PORT: string | string[];
 export declare const LOAD_MODULES: string[];
-export declare const CORS_ALLOWED_ORIGINS: string;
+export declare const CORS_ALLOWED_ORIGINS: "*";
 export declare const ENVIRONMENT: NodeEnvs;
 export declare const isProdOrHomolog: () => boolean;

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

@@ -1,28 +1,32 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isProdOrHomolog = exports.ENVIRONMENT = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = exports.IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256 = void 0;
+exports.isProdOrHomolog = exports.ENVIRONMENT = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = void 0;
+const env_var_1 = require("../../../setup/env-var");
 const arch_1 = require("@atlantjs/arch");
-const env_var_1 = __importDefault(require("env-var"));
-exports.IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256 = env_var_1.default
-    .get("KEYCLOAK_MOVINGAPP_REALM_PUBLIC_KEY_RS256")
-    .asString();
-exports.APP_PORT = env_var_1.default.get("APP_PORT").required().asPortNumber();
-exports.LOAD_MODULES = env_var_1.default.get("LOAD_MODULES").required().asArray(",");
-exports.CORS_ALLOWED_ORIGINS = env_var_1.default
-    .get("CORS_ALLOWED_ORIGINS")
-    .default("*")
-    .asString();
-exports.ENVIRONMENT = env_var_1.default
-    .get("ENVIRONMENT")
-    .required()
-    .asEnum([
-    arch_1.NodeEnvs.test,
-    arch_1.NodeEnvs.development,
-    arch_1.NodeEnvs.production,
-    arch_1.NodeEnvs.homolog,
-]);
+exports.APP_PORT = new env_var_1.EnvVar({
+    name: "APP_PORT",
+    type: "port-number",
+    isRequired: true,
+}).get();
+exports.LOAD_MODULES = new env_var_1.EnvVar({
+    name: "LOAD_MODULES",
+    type: "array",
+    isRequired: true,
+}).get();
+exports.CORS_ALLOWED_ORIGINS = new env_var_1.EnvVar({
+    name: "CORS_ALLOWED_ORIGINS",
+    defaultValue: "*",
+}).get();
+exports.ENVIRONMENT = new env_var_1.EnvVar({
+    name: "ENVIRONMENT",
+    type: "enum",
+    isRequired: true,
+    referenceValues: [
+        arch_1.NodeEnvs.test,
+        arch_1.NodeEnvs.development,
+        arch_1.NodeEnvs.production,
+        arch_1.NodeEnvs.homolog,
+    ],
+}).get();
 const isProdOrHomolog = () => [arch_1.NodeEnvs.homolog, arch_1.NodeEnvs.production].includes(exports.ENVIRONMENT);
 exports.isProdOrHomolog = isProdOrHomolog;

package/index.d.ts

@@ -1,9 +1,12 @@
 import "reflect-metadata";
 export { Injections } from "./backend/application/injections.abstract.type";
 export { getFromContainer, Get, JsonController, Res, Body, Post, Req, UseBefore, } from "routing-controllers";
+export { NextFunction, Request, RequestHandler, Response } from "express";
+export * from "class-validator";
 export { DatabaseConfigAbstract } from "./backend/application/databases/database.config";
 export { DatabaseHelperAbstract } from "./backend/application/databases/database.helper.abstract";
-export { IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256, APP_PORT, LOAD_MODULES, CORS_ALLOWED_ORIGINS, } from "./backend/application/env/env-vars";
+export { APP_PORT, LOAD_MODULES, CORS_ALLOWED_ORIGINS, } from "./backend/application/env/env-vars";
+export { EnvVar } from "./setup/env-var";
 export { InjectionsAbstract } from "./backend/application/injections.abstract";
 export { EntityAbstract } from "./backend/domain/entities/entity.abstract";
 export { MiddlewareHandlerAbstract } from "./backend/domain/middlewares/middleware.handler.abstract";
@@ -24,5 +27,3 @@ export { DefaultErrorHandlerMiddleware } from "./setup/server/default-error-hand
 export { Server } from "./setup/server/server";
 export { Container, inject, injectable } from "inversify";
 export { initializeApi } from "./setup";
-export { NextFunction, Request, RequestHandler, Response } from "express";
-export * from "class-validator";

package/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeApi = 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.UsecaseAbstract = exports.ServiceAbstract = exports.RepositoryAbstract = exports.ProviderAbstract = exports.MiddlewareHandlerAbstract = exports.EntityAbstract = exports.InjectionsAbstract = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = exports.IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256 = exports.DatabaseHelperAbstract = exports.DatabaseConfigAbstract = exports.UseBefore = exports.Req = exports.Post = exports.Body = exports.Res = exports.JsonController = exports.Get = exports.getFromContainer = void 0;
+exports.initializeApi = 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.UsecaseAbstract = exports.ServiceAbstract = exports.RepositoryAbstract = exports.ProviderAbstract = exports.MiddlewareHandlerAbstract = exports.EntityAbstract = exports.InjectionsAbstract = exports.EnvVar = exports.CORS_ALLOWED_ORIGINS = exports.LOAD_MODULES = exports.APP_PORT = exports.DatabaseHelperAbstract = exports.DatabaseConfigAbstract = exports.UseBefore = exports.Req = exports.Post = exports.Body = exports.Res = exports.JsonController = exports.Get = exports.getFromContainer = void 0;
 require("reflect-metadata");
 const setup_1 = require("./setup");
 (0, setup_1.synthesizePaths)();
@@ -27,15 +27,17 @@ Object.defineProperty(exports, "Body", { enumerable: true, get: function () { re
 Object.defineProperty(exports, "Post", { enumerable: true, get: function () { return routing_controllers_1.Post; } });
 Object.defineProperty(exports, "Req", { enumerable: true, get: function () { return routing_controllers_1.Req; } });
 Object.defineProperty(exports, "UseBefore", { enumerable: true, get: function () { return routing_controllers_1.UseBefore; } });
+__exportStar(require("class-validator"), exports);
 var database_config_1 = require("./backend/application/databases/database.config");
 Object.defineProperty(exports, "DatabaseConfigAbstract", { enumerable: true, get: function () { return database_config_1.DatabaseConfigAbstract; } });
 var database_helper_abstract_1 = require("./backend/application/databases/database.helper.abstract");
 Object.defineProperty(exports, "DatabaseHelperAbstract", { enumerable: true, get: function () { return database_helper_abstract_1.DatabaseHelperAbstract; } });
 var env_vars_1 = require("./backend/application/env/env-vars");
-Object.defineProperty(exports, "IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256", { enumerable: true, get: function () { return env_vars_1.IAM_MOVINGAPP_REALM_PUBLIC_KEY_RS256; } });
 Object.defineProperty(exports, "APP_PORT", { enumerable: true, get: function () { return env_vars_1.APP_PORT; } });
 Object.defineProperty(exports, "LOAD_MODULES", { enumerable: true, get: function () { return env_vars_1.LOAD_MODULES; } });
 Object.defineProperty(exports, "CORS_ALLOWED_ORIGINS", { enumerable: true, get: function () { return env_vars_1.CORS_ALLOWED_ORIGINS; } });
+var env_var_1 = require("./setup/env-var");
+Object.defineProperty(exports, "EnvVar", { enumerable: true, get: function () { return env_var_1.EnvVar; } });
 var injections_abstract_1 = require("./backend/application/injections.abstract");
 Object.defineProperty(exports, "InjectionsAbstract", { enumerable: true, get: function () { return injections_abstract_1.InjectionsAbstract; } });
 var entity_abstract_1 = require("./backend/domain/entities/entity.abstract");
@@ -79,4 +81,3 @@ Object.defineProperty(exports, "inject", { enumerable: true, get: function () {
 Object.defineProperty(exports, "injectable", { enumerable: true, get: function () { return inversify_1.injectable; } });
 var setup_2 = require("./setup");
 Object.defineProperty(exports, "initializeApi", { enumerable: true, get: function () { return setup_2.initializeApi; } });
-__exportStar(require("class-validator"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlantjs/backend",
-	"version": "1.1.3",
+	"version": "1.1.5",
 	"main": "index.js",
 	"license": "UNLICENSED",
 	"publishConfig": {
@@ -14,10 +14,6 @@
 		"type": "git",
 		"url": "git+ssh://git@github.com/MovingApp/lib-atlantjs-guardian.git"
 	},
-	"author": "movingapp",
-	"bugs": {
-		"url": "https://github.com/MovingApp/lib-atlantjs-guardian/issues"
-	},
 	"homepage": "https://github.com/MovingApp/lib-atlantjs-guardian#readme",
 	"scripts": {
 		"build": "rm -rf dist && tsc --project tsconfig.json && tscpaths -p tsconfig.json -s ./src -o ./dist",
@@ -32,44 +28,44 @@
 		"test:unit:cov": "yarn test:unit --coverage --runInBand"
 	},
 	"dependencies": {
-		"@atlantjs/arch": "^4.1.8",
+		"@atlantjs/arch": "^4.1.10",
 		"body-parser": "^1.20.3",
 		"class-transformer": "^0.5.1",
 		"class-validator": "^0.14.1",
 		"cookie-parser": "^1.4.7",
 		"cors": "^2.8.5",
-		"dotenv": "^16.4.5",
-		"env-var": "^7.5.0",
-		"express": "^4.21.1",
+		"dotenv": "^16.4.7",
+		"express": "^4.21.2",
 		"helmet": "^8.0.0",
-		"inversify": "^6.0.3",
+		"inversify": "^6.2.1",
 		"module-alias": "^2.2.3",
 		"reflect-metadata": "^0.2.2",
 		"routing-controllers": "^0.10.4",
 		"routing-controllers-openapi": "^4.0.0"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "1.8.3",
+		"@biomejs/biome": "1.9.4",
 		"@types/axios": "^0.14.4",
-		"@types/cookie-parser": "^1.4.7",
+		"@types/cookie-parser": "^1.4.8",
 		"@types/cors": "^2.8.17",
 		"@types/dotenv": "^8.2.3",
 		"@types/express": "^5.0.0",
-		"@types/jest": "^29.5.12",
+		"@types/jest": "^29.5.14",
 		"@types/jsonwebtoken": "^9.0.7",
 		"@types/jwk-to-pem": "^2.0.3",
-		"@types/node": "^22.8.0",
+		"@types/node": "^22.10.2",
 		"@types/uuid": "^10.0.0",
 		"copyfiles": "^2.4.1",
 		"cross-env": "^7.0.3",
 		"jest": "^29.7.0",
+		"npm-check-updates": "^17.1.12",
 		"ts-jest": "^29.2.5",
-		"ts-node": "^10.9.1",
+		"ts-node": "^10.9.2",
 		"ts-node-dev": "^2.0.0",
 		"ts-prune": "^0.10.3",
 		"tsconfig-paths": "^4.2.0",
 		"tscpaths": "^0.0.9",
-		"tslib": "^2.7.0",
-		"typescript": "^5.2.2"
+		"tslib": "^2.8.1",
+		"typescript": "^5.7.2"
 	}
 }

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

@@ -0,0 +1,2 @@
+export declare class PickEnvError extends Error {
+}

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickEnvError = void 0;
+class PickEnvError extends Error {
+}
+exports.PickEnvError = PickEnvError;

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

@@ -0,0 +1,8 @@
+export type EnvTypes = "string" | "port-number" | "array" | "enum" | "url-string" | "int" | "float";
+export interface PickEnvType<Type> {
+    name: string;
+    type?: EnvTypes;
+    isRequired?: boolean;
+    defaultValue?: Type;
+    referenceValues?: Type[];
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+import { PickEnvType } from "./env-var.type";
+export declare class EnvVar<Type extends string | string[]> {
+    private variableValue;
+    private variableName;
+    private variableType;
+    private variableReferenceValues?;
+    constructor({ name, type, isRequired, defaultValue, referenceValues, }: PickEnvType<Type>);
+    get(): Type;
+    private asArray;
+    private asBoolean;
+    private asEnum;
+}

package/setup/env-var/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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, referenceValues, }) {
+        this.variableValue = process.env[name] || defaultValue;
+        this.variableName = name;
+        this.variableType = type;
+        this.variableReferenceValues = referenceValues;
+        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`);
+        }
+    }
+    get() {
+        if (arch_1.Guardian.isEqual(this.variableType, "boolean")) {
+            this.asBoolean();
+        }
+        if (arch_1.Guardian.isEqual(this.variableType, "array")) {
+            this.asArray();
+        }
+        if (arch_1.Guardian.isNotUndefined(this.variableReferenceValues) &&
+            arch_1.Guardian.isEqual(this.variableType, "enum")) {
+            this.asEnum(this.variableReferenceValues);
+        }
+        return this.variableValue;
+    }
+    asArray() {
+        if (arch_1.Guardian.isEmpty(this.variableValue)) {
+            return [];
+        }
+        const array = this.variableValue.split(",");
+        return array;
+    }
+    asBoolean() {
+        if (arch_1.Guardian.isEmpty(this.variableValue)) {
+            return undefined;
+        }
+        if (arch_1.Guardian.isFalsy(arch_1.Guardian.isAnyOf(this.variableValue, ["false", "true"]))) {
+            throw new env_var_error_1.PickEnvError(`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;
+        return false;
+    }
+    asEnum(validValues) {
+        if (arch_1.Guardian.isUndefined(this.variableValue)) {
+            return "";
+        }
+        if (!validValues.includes(this.variableValue)) {
+            throw new env_var_error_1.PickEnvError(`A variável ${this.variableName} deve conter algum dos seguintes valores: [${validValues.join(", ")}]`);
+        }
+        return this.variableValue;
+    }
+}
+exports.EnvVar = EnvVar;

package/setup/server/cors-middleware.d.ts

@@ -3,7 +3,7 @@ export declare class CorsMiddleware {
     private readonly corsSpecs;
     private readonly cors;
     constructor(corsSpecs: string);
-    static create(corsSpecs?: string): RequestHandler;
+    static create(corsSpecs?: "*"): RequestHandler;
     use(request: Request, response: Response, next: NextFunction): void;
     private parseCorsAllowedOrigins;
     private stringToRegex;