rl-core-api 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rodrigo Liberti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -69,6 +69,22 @@ O pacote **não traz `.env`** — ele declara o que precisa e quebra no boot se
 faltar. Cada projeto tem os valores dele (banco próprio, segredo JWT próprio).
 Comece pelo `.env.example` do repositório.
 
+### Identidade do sistema
+
+O core não tem nome próprio. `APP_NAME` é o do projeto, e dele saem o título do
+Swagger, o remetente dos emails e o emissor exibido no app autenticador:
+
+| Variável | Para quê | Sem declarar |
+|---|---|---|
+| `APP_NAME` | Nome do sistema | `Core App` |
+| `APP_LOGO_URL` | Logo no cabeçalho dos emails — **URL absoluta e pública**, porque o cliente de email busca a imagem do servidor dele | só o nome, em texto |
+| `APP_BRAND_COLOR` | Cor **dos emails** — botões, código 2FA e o nome no cabeçalho. Não é a cor da interface, que vem do `tailwind-preset`. Escreva entre aspas: `APP_BRAND_COLOR="#16A34A"`, senão o dotenv lê o `#` como comentário e o valor chega vazio | `#007bff` |
+| `TOTP_ISSUER` | Emissor no app autenticador | segue o `APP_NAME` |
+| `EMAIL_FROM_NAME` | Nome do remetente | segue o `APP_NAME` |
+
+Quem já declarava `TOTP_ISSUER` ou `EMAIL_FROM_NAME` continua igual: eles só
+caem no `APP_NAME` quando estão ausentes.
+
 Para acrescentar variáveis suas, estenda o schema:
 
 ```ts
@@ -94,6 +110,11 @@ sozinho.
 | [`rl-core-front`](https://www.npmjs.com/package/rl-core-front) | as telas em Next.js |
 | `rl_core_app` | o app Flutter, consumido por tag do git |
 
+## Changelog
+
+As três versões andam juntas e saem de uma tag só — o que mudou em cada uma
+está em [CHANGELOG.md](https://github.com/liberti1991/aplication-core/blob/main/CHANGELOG.md).
+
 ## Licença
 
 MIT © Rodrigo Liberti

package/dist/core/bootstrap/bootstrapCore.util.js

@@ -45,9 +45,10 @@ const bootstrapCore = async (appModule, options = {}) => {
         transformOptions: { enableImplicitConversion: true },
     }));
     app.useGlobalInterceptors(new common_1.ClassSerializerInterceptor(app.get(core_1.Reflector)));
+    const appName = options.title ?? env.get("APP_NAME");
     if (env.get("NODE_ENV") !== "production") {
         const config = new swagger_1.DocumentBuilder()
-            .setTitle(options.title ?? "Core API")
+            .setTitle(appName)
             .setDescription(options.description ?? "Auth + 2FA obrigatório (TOTP) + RBAC + auditoria")
             .setVersion(options.version ?? "1.0")
             .addBearerAuth()
@@ -58,7 +59,7 @@ const bootstrapCore = async (appModule, options = {}) => {
     }
     const port = env.get("PORT");
     await app.listen(port);
-    logger.log(`${options.title ?? "Core API"} rodando em http://localhost:${port}/${prefix}`);
+    logger.log(`${appName} rodando em http://localhost:${port}/${prefix}`);
     if (env.get("NODE_ENV") !== "production") {
         logger.log(`Swagger em http://localhost:${port}/${prefix}/docs`);
     }

package/dist/core/config/appBrand.interface.d.ts

@@ -0,0 +1,7 @@
+export interface AppBrand {
+    name: string;
+    logoUrl: string | null;
+    color: string;
+    totpIssuer: string;
+    emailFromName: string;
+}

package/dist/core/config/appBrand.interface.js

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

package/dist/core/config/env.schema.d.ts

@@ -8,6 +8,9 @@ export declare const envSchema: z.ZodObject<{
     PORT: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     API_PREFIX: z.ZodDefault<z.ZodString>;
     APP_URL: z.ZodDefault<z.ZodString>;
+    APP_NAME: z.ZodDefault<z.ZodString>;
+    APP_LOGO_URL: z.ZodOptional<z.ZodString>;
+    APP_BRAND_COLOR: z.ZodDefault<z.ZodString>;
     DB_HOST: z.ZodString;
     DB_PORT: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     DB_NAME: z.ZodString;
@@ -32,7 +35,7 @@ export declare const envSchema: z.ZodObject<{
         false: "false";
     }>, z.ZodTransform<boolean, "true" | "false">>>;
     COOKIE_DOMAIN: z.ZodDefault<z.ZodString>;
-    TOTP_ISSUER: z.ZodDefault<z.ZodString>;
+    TOTP_ISSUER: z.ZodOptional<z.ZodString>;
     TWO_FACTOR_EMAIL_CODE_EXPIRY: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     BACKUP_CODES_COUNT: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     LOGIN_MAX_ATTEMPTS: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
@@ -49,13 +52,14 @@ export declare const envSchema: z.ZodObject<{
     EMAIL_USER: z.ZodString;
     EMAIL_PASSWORD: z.ZodString;
     EMAIL_FROM: z.ZodString;
-    EMAIL_FROM_NAME: z.ZodDefault<z.ZodString>;
+    EMAIL_FROM_NAME: z.ZodOptional<z.ZodString>;
     PASSWORD_RESET_TOKEN_EXPIRY: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     FIRST_ACCESS_TOKEN_EXPIRY: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     PASSWORD_MAX_AGE_DAYS: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     TOKEN_CLEANUP_CRON: z.ZodDefault<z.ZodString>;
     AUDIT_LOG_CLEANUP_CRON: z.ZodDefault<z.ZodString>;
     AUDIT_LOG_RETENTION_DAYS: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    AUDIT_DATA_RETENTION_DAYS: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     NOTIFICATION_RETENTION_DAYS: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     SEED_ADMIN_NAME: z.ZodDefault<z.ZodString>;
     SEED_ADMIN_EMAIL: z.ZodDefault<z.ZodString>;

package/dist/core/config/env.schema.js

@@ -14,6 +14,12 @@ exports.envSchema = zod_1.z
     PORT: zod_1.z.coerce.number().int().positive().default(3108),
     API_PREFIX: zod_1.z.string().default("api"),
     APP_URL: zod_1.z.string().url().default("http://localhost:4000"),
+    APP_NAME: zod_1.z.string().min(1).default("Core App"),
+    APP_LOGO_URL: zod_1.z.string().url().optional(),
+    APP_BRAND_COLOR: zod_1.z
+        .string()
+        .regex(/^#[0-9a-fA-F]{6}$/, 'APP_BRAND_COLOR deve ser hex (#RRGGBB) e entre aspas no .env: APP_BRAND_COLOR="#007bff"')
+        .default("#007bff"),
     DB_HOST: zod_1.z.string().min(1),
     DB_PORT: zod_1.z.coerce.number().int().positive().default(3306),
     DB_NAME: zod_1.z.string().min(1),
@@ -35,7 +41,7 @@ exports.envSchema = zod_1.z
         .length(64, "TOTP_ENC_KEY deve ter 64 chars hex (32 bytes)"),
     COOKIE_SECURE: booleanFromString.default(false),
     COOKIE_DOMAIN: zod_1.z.string().default("localhost"),
-    TOTP_ISSUER: zod_1.z.string().default("Core App"),
+    TOTP_ISSUER: zod_1.z.string().min(1).optional(),
     TWO_FACTOR_EMAIL_CODE_EXPIRY: zod_1.z.coerce
         .number()
         .int()
@@ -53,7 +59,7 @@ exports.envSchema = zod_1.z
     EMAIL_USER: zod_1.z.string().min(1),
     EMAIL_PASSWORD: zod_1.z.string().min(1),
     EMAIL_FROM: zod_1.z.string().min(1),
-    EMAIL_FROM_NAME: zod_1.z.string().default("Core API"),
+    EMAIL_FROM_NAME: zod_1.z.string().min(1).optional(),
     PASSWORD_RESET_TOKEN_EXPIRY: zod_1.z.coerce.number().int().positive().default(15),
     FIRST_ACCESS_TOKEN_EXPIRY: zod_1.z.coerce
         .number()
@@ -63,7 +69,8 @@ exports.envSchema = zod_1.z
     PASSWORD_MAX_AGE_DAYS: zod_1.z.coerce.number().int().positive().default(90),
     TOKEN_CLEANUP_CRON: zod_1.z.string().default("0 */6 * * *"),
     AUDIT_LOG_CLEANUP_CRON: zod_1.z.string().default("0 3 * * *"),
-    AUDIT_LOG_RETENTION_DAYS: zod_1.z.coerce.number().int().positive().default(30),
+    AUDIT_LOG_RETENTION_DAYS: zod_1.z.coerce.number().int().positive().default(15),
+    AUDIT_DATA_RETENTION_DAYS: zod_1.z.coerce.number().int().positive().default(30),
     NOTIFICATION_RETENTION_DAYS: zod_1.z.coerce
         .number()
         .int()

package/dist/core/config/env.service.d.ts

@@ -1,7 +1,9 @@
 import { ConfigService } from "@nestjs/config";
+import { AppBrand } from "./appBrand.interface";
 import { Env } from "./env.schema";
 export declare class EnvService {
     private readonly config;
     constructor(config: ConfigService<Env, true>);
     get<K extends keyof Env>(key: K): Env[K];
+    brand(): AppBrand;
 }

package/dist/core/config/env.service.js

@@ -19,6 +19,16 @@ let EnvService = class EnvService {
     get(key) {
         return this.config.get(key, { infer: true });
     }
+    brand() {
+        const name = this.get("APP_NAME");
+        return {
+            name,
+            logoUrl: this.get("APP_LOGO_URL") ?? null,
+            color: this.get("APP_BRAND_COLOR"),
+            totpIssuer: this.get("TOTP_ISSUER") ?? name,
+            emailFromName: this.get("EMAIL_FROM_NAME") ?? name,
+        };
+    }
 };
 exports.EnvService = EnvService;
 exports.EnvService = EnvService = __decorate([

package/dist/core/mailer/mailer.service.d.ts

@@ -6,6 +6,7 @@ export declare class MailerService {
     constructor(env: EnvService);
     private send;
     private escapeHtml;
+    private header;
     private layout;
     sendTwoFactorCode(to: string, code: string, userName: string): Promise<void>;
     sendPasswordReset(to: string, token: string, userName: string): Promise<void>;

package/dist/core/mailer/mailer.service.js

@@ -62,7 +62,7 @@ let MailerService = MailerService_1 = class MailerService {
         });
     }
     async send(to, subject, html) {
-        const from = `"${this.env.get("EMAIL_FROM_NAME")}" <${this.env.get("EMAIL_FROM")}>`;
+        const from = `"${this.env.brand().emailFromName}" <${this.env.get("EMAIL_FROM")}>`;
         try {
             await this.transporter.sendMail({ from, to, subject, html });
             this.logger.log(`Email enviado: ${subject} -> ${to}`);
@@ -80,23 +80,36 @@ let MailerService = MailerService_1 = class MailerService {
             .replace(/"/g, "&quot;")
             .replace(/'/g, "&#39;");
     }
+    header(brand) {
+        if (brand.logoUrl) {
+            return `<img src="${brand.logoUrl}" alt="${this.escapeHtml(brand.name)}" style="max-height:40px;max-width:200px;">`;
+        }
+        return `<span style="font-size:20px;font-weight:bold;color:${brand.color};">${this.escapeHtml(brand.name)}</span>`;
+    }
     layout(title, body) {
+        const brand = this.env.brand();
         return `
       <div style="font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;">
+        <div style="padding-bottom:20px;border-bottom:1px solid #ddd;margin-bottom:24px;">
+          ${this.header(brand)}
+        </div>
         <h2 style="color: #333;">${title}</h2>
         ${body}
         <hr style="border: none; border-top: 1px solid #ddd; margin: 30px 0;">
-        <p style="color: #999; font-size: 12px;">Mensagem automática, não responda.</p>
+        <p style="color: #999; font-size: 12px;">
+          Mensagem automática de ${this.escapeHtml(brand.name)}, não responda.
+        </p>
       </div>`;
     }
     async sendTwoFactorCode(to, code, userName) {
         const expiry = this.env.get("TWO_FACTOR_EMAIL_CODE_EXPIRY");
+        const color = this.env.brand().color;
         const body = `
       <p>Olá ${this.escapeHtml(userName)},</p>
       <p>Seu código de verificação (2FA) é:</p>
       <div style="text-align:center;margin:30px 0;">
         <div style="background:#f5f5f5;padding:20px;border-radius:5px;display:inline-block;">
-          <h1 style="margin:0;font-size:36px;letter-spacing:8px;color:#007bff;">${code}</h1>
+          <h1 style="margin:0;font-size:36px;letter-spacing:8px;color:${color};">${code}</h1>
         </div>
       </div>
       <p><strong>Este código expira em ${expiry} minutos.</strong></p>
@@ -106,11 +119,12 @@ let MailerService = MailerService_1 = class MailerService {
     async sendPasswordReset(to, token, userName) {
         const url = `${this.env.get("APP_URL")}/reset-password?token=${token}`;
         const expiry = this.env.get("PASSWORD_RESET_TOKEN_EXPIRY");
+        const color = this.env.brand().color;
         const body = `
       <p>Olá ${this.escapeHtml(userName)},</p>
       <p>Recebemos uma solicitação para redefinir sua senha. Clique no botão abaixo:</p>
       <div style="text-align:center;margin:30px 0;">
-        <a href="${url}" style="background:#007bff;color:#fff;padding:12px 30px;text-decoration:none;border-radius:5px;display:inline-block;">Redefinir senha</a>
+        <a href="${url}" style="background:${color};color:#fff;padding:12px 30px;text-decoration:none;border-radius:5px;display:inline-block;">Redefinir senha</a>
       </div>
       <p>Ou copie e cole este link no navegador:</p>
       <p style="word-break:break-all;color:#666;">${url}</p>
@@ -128,11 +142,12 @@ let MailerService = MailerService_1 = class MailerService {
     async sendFirstAccess(to, token, userName) {
         const url = `${this.env.get("APP_URL")}/reset-password?token=${token}`;
         const expiry = this.formatExpiry(this.env.get("FIRST_ACCESS_TOKEN_EXPIRY"));
+        const brand = this.env.brand();
         const body = `
       <p>Olá ${this.escapeHtml(userName)},</p>
-      <p>Sua conta foi criada. Para acessar o sistema, defina sua senha clicando no botão abaixo:</p>
+      <p>Sua conta em ${this.escapeHtml(brand.name)} foi criada. Para acessar, defina sua senha clicando no botão abaixo:</p>
       <div style="text-align:center;margin:30px 0;">
-        <a href="${url}" style="background:#007bff;color:#fff;padding:12px 30px;text-decoration:none;border-radius:5px;display:inline-block;">Definir minha senha</a>
+        <a href="${url}" style="background:${brand.color};color:#fff;padding:12px 30px;text-decoration:none;border-radius:5px;display:inline-block;">Definir minha senha</a>
       </div>
       <p>Ou copie e cole este link no navegador:</p>
       <p style="word-break:break-all;color:#666;">${url}</p>

package/dist/features/audit/domain/audit.service.d.ts

@@ -23,6 +23,7 @@ export declare class AuditService {
     constructor(changeRepo: AuditChangeRepository, errorRepo: ErrorLogRepository, dataChangeRepo: AuditDataChangeRepository, userRepo: UserRepository);
     recordChange(data: Partial<AuditChange>): Promise<void>;
     recordError(data: Partial<ErrorLog>): Promise<void>;
+    cleanupOldDataChanges(retentionDays: number): Promise<number>;
     cleanupOldLogs(retentionDays: number): Promise<{
         changes: number;
         errors: number;

package/dist/features/audit/domain/audit.service.js

@@ -42,6 +42,13 @@ let AuditService = AuditService_1 = class AuditService {
             this.logger.warn(`Falha ao gravar ErrorLog: ${err.message}`);
         }
     }
+    async cleanupOldDataChanges(retentionDays) {
+        const cutoff = new Date(Date.now() - retentionDays * 24 * 60 * 60 * 1000);
+        const removed = await this.dataChangeRepo.delete({
+            createdAt: (0, typeorm_1.LessThan)(cutoff),
+        });
+        return removed.affected ?? 0;
+    }
     async cleanupOldLogs(retentionDays) {
         const cutoff = new Date(Date.now() - retentionDays * 24 * 60 * 60 * 1000);
         const changes = await this.changeRepo.delete({

package/dist/features/auth/domain/twoFactor.service.js

@@ -57,7 +57,7 @@ let TwoFactorService = TwoFactorService_1 = class TwoFactorService {
     }
     async generateSetup(accountEmail) {
         const secret = (0, otplib_1.generateSecret)();
-        const issuer = this.env.get("TOTP_ISSUER");
+        const issuer = this.env.brand().totpIssuer;
         const otpauthUrl = (0, otplib_1.generateURI)({ issuer, label: accountEmail, secret });
         const qrDataUrl = await QRCode.toDataURL(otpauthUrl);
         return { secret, otpauthUrl, qrDataUrl };

package/dist/features/maintenance/domain/cleanup.service.js

@@ -46,6 +46,11 @@ let CleanupService = CleanupService_1 = class CleanupService {
             if (changes > 0 || errors > 0) {
                 this.logger.log(`Logs operacionais removidos (> ${retentionDays}d): ${changes} requisições, ${errors} erros`);
             }
+            const dataRetentionDays = this.env.get("AUDIT_DATA_RETENTION_DAYS");
+            const dataChanges = await this.audit.cleanupOldDataChanges(dataRetentionDays);
+            if (dataChanges > 0) {
+                this.logger.log(`Trilha de dados removida (> ${dataRetentionDays}d): ${dataChanges} registros`);
+            }
         });
     }
     async handleNotificationCleanup() {

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { CoreDataSourceOptions, createCoreDataSource, } from "./core/database/cr
 export { coreMigrations, MigrationClass } from "./core/database/migrations";
 export { coreEntities } from "./coreEntities";
 export { RlCoreModule, RlCoreModuleOptions } from "./rlCore.module";
+export { AppBrand } from "./core/config/appBrand.interface";
 export { ConfigModule, ConfigModuleOptions, EnvValidator, } from "./core/config/config.module";
 export { Env, envSchema, validateEnv } from "./core/config/env.schema";
 export { EnvService } from "./core/config/env.service";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rl-core-api",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Core NestJS: autenticação com 2FA, RBAC, auditoria, notificações e listagens com filtro dinâmico",
   "author": "Rodrigo Liberti",
   "license": "MIT",