rl-core-api 0.1.0

package/dist/features/audit/presentation/audit.controller.js

@@ -0,0 +1,107 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditController = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const requirePermission_decorator_1 = require("../../../core/auth/decorators/requirePermission.decorator");
+const permissions_guard_1 = require("../../../core/auth/guards/permissions.guard");
+const filterSchema_response_1 = require("../../../core/query/filterSchema.response");
+const pagination_util_1 = require("../../../core/utils/pagination.util");
+const audit_service_1 = require("../domain/audit.service");
+const audit_filters_1 = require("./filters/audit.filters");
+const auditDataChange_response_1 = require("./responses/auditDataChange.response");
+const log_response_1 = require("./responses/log.response");
+let AuditController = class AuditController {
+    constructor(audit) {
+        this.audit = audit;
+    }
+    changes(query) {
+        return this.audit.listChanges(query);
+    }
+    changesFilterSchema() {
+        return (0, filterSchema_response_1.toFilterSchema)(audit_filters_1.AUDIT_CHANGES_FILTER_CATALOG);
+    }
+    errors(query) {
+        return this.audit.listErrors(query);
+    }
+    errorsFilterSchema() {
+        return (0, filterSchema_response_1.toFilterSchema)(audit_filters_1.ERROR_LOGS_FILTER_CATALOG);
+    }
+    dataChanges(query) {
+        return this.audit.listDataChanges(query);
+    }
+    dataChangesFilterSchema() {
+        return (0, filterSchema_response_1.toFilterSchema)(audit_filters_1.AUDIT_DATA_CHANGES_FILTER_CATALOG);
+    }
+};
+exports.AuditController = AuditController;
+__decorate([
+    (0, common_1.Get)("changes"),
+    (0, requirePermission_decorator_1.RequirePermission)("audit:read:any"),
+    (0, swagger_1.ApiOkResponse)({ type: log_response_1.PaginatedRequestLogsResponse }),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [pagination_util_1.PaginationQuery]),
+    __metadata("design:returntype", Promise)
+], AuditController.prototype, "changes", null);
+__decorate([
+    (0, common_1.Get)("changes/filter-schema"),
+    (0, requirePermission_decorator_1.RequirePermission)("audit:read:any"),
+    (0, swagger_1.ApiOkResponse)({ type: filterSchema_response_1.FilterFieldResponse, isArray: true }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Array)
+], AuditController.prototype, "changesFilterSchema", null);
+__decorate([
+    (0, common_1.Get)("errors"),
+    (0, requirePermission_decorator_1.RequirePermission)("audit:read:any"),
+    (0, swagger_1.ApiOkResponse)({ type: log_response_1.PaginatedErrorLogsResponse }),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [pagination_util_1.PaginationQuery]),
+    __metadata("design:returntype", Promise)
+], AuditController.prototype, "errors", null);
+__decorate([
+    (0, common_1.Get)("errors/filter-schema"),
+    (0, requirePermission_decorator_1.RequirePermission)("audit:read:any"),
+    (0, swagger_1.ApiOkResponse)({ type: filterSchema_response_1.FilterFieldResponse, isArray: true }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Array)
+], AuditController.prototype, "errorsFilterSchema", null);
+__decorate([
+    (0, common_1.Get)("data-changes"),
+    (0, requirePermission_decorator_1.RequirePermission)("audit:read-trail:any"),
+    (0, swagger_1.ApiOkResponse)({ type: auditDataChange_response_1.PaginatedAuditDataChangesResponse }),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [pagination_util_1.PaginationQuery]),
+    __metadata("design:returntype", Promise)
+], AuditController.prototype, "dataChanges", null);
+__decorate([
+    (0, common_1.Get)("data-changes/filter-schema"),
+    (0, requirePermission_decorator_1.RequirePermission)("audit:read-trail:any"),
+    (0, swagger_1.ApiOkResponse)({ type: filterSchema_response_1.FilterFieldResponse, isArray: true }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Array)
+], AuditController.prototype, "dataChangesFilterSchema", null);
+exports.AuditController = AuditController = __decorate([
+    (0, swagger_1.ApiTags)("Audit"),
+    (0, swagger_1.ApiBearerAuth)(),
+    (0, common_1.UseGuards)(permissions_guard_1.PermissionsGuard),
+    (0, common_1.Controller)({ path: "audit", version: "1" }),
+    __metadata("design:paramtypes", [audit_service_1.AuditService])
+], AuditController);

package/dist/features/audit/presentation/audit.interceptor.d.ts

@@ -0,0 +1,8 @@
+import { CallHandler, ExecutionContext, NestInterceptor } from "@nestjs/common";
+import { Observable } from "rxjs";
+import { AuditService } from "../domain/audit.service";
+export declare class AuditInterceptor implements NestInterceptor {
+    private readonly audit;
+    constructor(audit: AuditService);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
+}

package/dist/features/audit/presentation/audit.interceptor.js

@@ -0,0 +1,78 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditInterceptor = void 0;
+const node_crypto_1 = require("node:crypto");
+const common_1 = require("@nestjs/common");
+const rxjs_1 = require("rxjs");
+const auditContext_1 = require("../../../core/context/auditContext");
+const ip_util_1 = require("../../../core/utils/ip.util");
+const audit_service_1 = require("../domain/audit.service");
+const classifyError_util_1 = require("../domain/classifyError.util");
+const REQUEST_ID_HEADER = "x-request-id";
+let AuditInterceptor = class AuditInterceptor {
+    constructor(audit) {
+        this.audit = audit;
+    }
+    intercept(context, next) {
+        const req = context.switchToHttp().getRequest();
+        const res = context.switchToHttp().getResponse();
+        const user = req.user;
+        const method = req.method;
+        const start = Date.now();
+        const ipAddress = (0, ip_util_1.normalizeIp)(req.ip);
+        const requestId = req.headers[REQUEST_ID_HEADER] || (0, node_crypto_1.randomUUID)();
+        res.setHeader("X-Request-Id", requestId);
+        req.requestId = requestId;
+        res.once("finish", () => {
+            void this.audit.recordChange({
+                userId: user?.id ?? null,
+                action: `${method} ${req.path}`,
+                method,
+                path: req.path,
+                ipAddress,
+                statusCode: res.statusCode,
+                durationMs: Date.now() - start,
+                requestId,
+            });
+        });
+        return new rxjs_1.Observable((subscriber) => {
+            auditContext_1.auditContext.run({ userId: user?.id ?? null, ipAddress, requestId }, () => {
+                next
+                    .handle()
+                    .pipe((0, rxjs_1.tap)({
+                    error: (err) => {
+                        const status = err?.status ?? 500;
+                        if (status >= 400) {
+                            void this.audit.recordError({
+                                statusCode: status,
+                                type: (0, classifyError_util_1.classifyError)(err, status),
+                                message: err?.message ?? "Erro desconhecido",
+                                stack: err?.stack ?? null,
+                                method,
+                                path: req.path,
+                                userId: user?.id ?? null,
+                                ipAddress,
+                                requestId,
+                            });
+                        }
+                    },
+                }))
+                    .subscribe(subscriber);
+            });
+        });
+    }
+};
+exports.AuditInterceptor = AuditInterceptor;
+exports.AuditInterceptor = AuditInterceptor = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [audit_service_1.AuditService])
+], AuditInterceptor);

package/dist/features/audit/presentation/filters/audit.filters.d.ts

@@ -0,0 +1,4 @@
+import { FilterCatalog } from "../../../../core/query/filterField.interface";
+export declare const AUDIT_CHANGES_FILTER_CATALOG: FilterCatalog;
+export declare const ERROR_LOGS_FILTER_CATALOG: FilterCatalog;
+export declare const AUDIT_DATA_CHANGES_FILTER_CATALOG: FilterCatalog;

package/dist/features/audit/presentation/filters/audit.filters.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUDIT_DATA_CHANGES_FILTER_CATALOG = exports.ERROR_LOGS_FILTER_CATALOG = exports.AUDIT_CHANGES_FILTER_CATALOG = void 0;
+const filterFieldType_enum_1 = require("../../../../core/query/filterFieldType.enum");
+const auditDataChange_schema_1 = require("../../infra/schema/auditDataChange.schema");
+const errorLog_schema_1 = require("../../infra/schema/errorLog.schema");
+const TRACKED_ENTITIES = [
+    "User",
+    "Role",
+    "Permission",
+    "Group",
+    "Resource",
+    "Action",
+    "Scope",
+];
+const optionsFromValues = (values) => values.map((value) => ({ value, label: value }));
+exports.AUDIT_CHANGES_FILTER_CATALOG = [
+    {
+        field: "action",
+        column: "action",
+        label: "Ação",
+        type: filterFieldType_enum_1.FilterFieldType.Text,
+        sortable: true,
+    },
+    {
+        field: "method",
+        column: "method",
+        label: "Método",
+        type: filterFieldType_enum_1.FilterFieldType.Enum,
+        options: optionsFromValues([
+            "GET",
+            "POST",
+            "PATCH",
+            "PUT",
+            "DELETE",
+        ]),
+        sortable: true,
+    },
+    {
+        field: "path",
+        column: "path",
+        label: "Rota",
+        type: filterFieldType_enum_1.FilterFieldType.Text,
+        sortable: true,
+    },
+    {
+        field: "statusCode",
+        column: "statusCode",
+        label: "Status HTTP",
+        type: filterFieldType_enum_1.FilterFieldType.Number,
+        sortable: true,
+        filterable: false,
+    },
+    {
+        field: "durationMs",
+        column: "durationMs",
+        label: "Duração (ms)",
+        type: filterFieldType_enum_1.FilterFieldType.Number,
+        sortable: true,
+        filterable: false,
+    },
+    {
+        field: "userId",
+        column: "userId",
+        label: "Usuário",
+        type: filterFieldType_enum_1.FilterFieldType.Uuid,
+    },
+];
+exports.ERROR_LOGS_FILTER_CATALOG = [
+    {
+        field: "type",
+        column: "type",
+        label: "Tipo",
+        type: filterFieldType_enum_1.FilterFieldType.Enum,
+        options: optionsFromValues(Object.values(errorLog_schema_1.ErrorType)),
+        sortable: true,
+    },
+    {
+        field: "statusCode",
+        column: "statusCode",
+        label: "Status HTTP",
+        type: filterFieldType_enum_1.FilterFieldType.Number,
+        sortable: true,
+        filterable: false,
+    },
+    {
+        field: "message",
+        column: "message",
+        label: "Mensagem",
+        type: filterFieldType_enum_1.FilterFieldType.Text,
+    },
+    {
+        field: "method",
+        column: "method",
+        label: "Método",
+        type: filterFieldType_enum_1.FilterFieldType.Enum,
+        options: optionsFromValues(["GET", "POST", "PATCH", "PUT", "DELETE"]),
+    },
+    {
+        field: "path",
+        column: "path",
+        label: "Rota",
+        type: filterFieldType_enum_1.FilterFieldType.Text,
+    },
+    {
+        field: "userId",
+        column: "userId",
+        label: "Usuário",
+        type: filterFieldType_enum_1.FilterFieldType.Uuid,
+    },
+];
+exports.AUDIT_DATA_CHANGES_FILTER_CATALOG = [
+    {
+        field: "entity",
+        column: "entity",
+        label: "Entidade",
+        type: filterFieldType_enum_1.FilterFieldType.Enum,
+        options: optionsFromValues(TRACKED_ENTITIES),
+        sortable: true,
+    },
+    {
+        field: "entityId",
+        column: "entityId",
+        label: "ID da entidade",
+        type: filterFieldType_enum_1.FilterFieldType.Uuid,
+    },
+    {
+        field: "action",
+        column: "action",
+        label: "Ação",
+        type: filterFieldType_enum_1.FilterFieldType.Enum,
+        options: optionsFromValues(Object.values(auditDataChange_schema_1.AuditDataAction)),
+        sortable: true,
+    },
+    {
+        field: "userId",
+        column: "userId",
+        label: "Usuário",
+        type: filterFieldType_enum_1.FilterFieldType.Uuid,
+    },
+    {
+        field: "ipAddress",
+        column: "ipAddress",
+        label: "IP",
+        type: filterFieldType_enum_1.FilterFieldType.Text,
+    },
+    {
+        field: "createdAt",
+        column: "createdAt",
+        label: "Data",
+        type: filterFieldType_enum_1.FilterFieldType.DateTime,
+        sortable: true,
+    },
+];

package/dist/features/audit/presentation/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./audit.controller";
+export * from "./audit.interceptor";

package/dist/features/audit/presentation/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./audit.controller"), exports);
+__exportStar(require("./audit.interceptor"), exports);

package/dist/features/audit/presentation/responses/auditDataChange.response.d.ts

@@ -0,0 +1,25 @@
+import { PaginationMetaResponse } from "../../../../core/utils/paginationMeta.response";
+import { AuditDataAction } from "../../infra/schema/auditDataChange.schema";
+export declare class AuditUserRefResponse {
+    id: string;
+    name: string;
+    email: string;
+}
+export declare class AuditDataChangeResponse {
+    id: string;
+    entity: string;
+    entityId?: string | null;
+    action: AuditDataAction;
+    oldData?: Record<string, unknown> | null;
+    newData?: Record<string, unknown> | null;
+    userId?: string | null;
+    user?: AuditUserRefResponse | null;
+    ipAddress?: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+}
+export declare class PaginatedAuditDataChangesResponse {
+    items: AuditDataChangeResponse[];
+    meta: PaginationMetaResponse;
+}

package/dist/features/audit/presentation/responses/auditDataChange.response.js

@@ -0,0 +1,96 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedAuditDataChangesResponse = exports.AuditDataChangeResponse = exports.AuditUserRefResponse = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const paginationMeta_response_1 = require("../../../../core/utils/paginationMeta.response");
+const auditDataChange_schema_1 = require("../../infra/schema/auditDataChange.schema");
+class AuditUserRefResponse {
+}
+exports.AuditUserRefResponse = AuditUserRefResponse;
+__decorate([
+    (0, swagger_1.ApiProperty)({ format: "uuid" }),
+    __metadata("design:type", String)
+], AuditUserRefResponse.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", String)
+], AuditUserRefResponse.prototype, "name", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: "admin@admin.com" }),
+    __metadata("design:type", String)
+], AuditUserRefResponse.prototype, "email", void 0);
+class AuditDataChangeResponse {
+}
+exports.AuditDataChangeResponse = AuditDataChangeResponse;
+__decorate([
+    (0, swagger_1.ApiProperty)({ format: "uuid" }),
+    __metadata("design:type", String)
+], AuditDataChangeResponse.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: "User" }),
+    __metadata("design:type", String)
+], AuditDataChangeResponse.prototype, "entity", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: String, required: false, nullable: true }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "entityId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ enum: auditDataChange_schema_1.AuditDataAction, enumName: "AuditDataAction" }),
+    __metadata("design:type", String)
+], AuditDataChangeResponse.prototype, "action", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: Object, required: false, nullable: true }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "oldData", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: Object, required: false, nullable: true }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "newData", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: String, required: false, nullable: true }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "userId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        type: AuditUserRefResponse,
+        required: false,
+        nullable: true,
+    }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "user", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: String, required: false, nullable: true, example: "10.0.0.1" }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "ipAddress", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ format: "date-time" }),
+    __metadata("design:type", Date)
+], AuditDataChangeResponse.prototype, "createdAt", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ format: "date-time" }),
+    __metadata("design:type", Date)
+], AuditDataChangeResponse.prototype, "updatedAt", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: String, format: "date-time", required: false, nullable: true }),
+    __metadata("design:type", Object)
+], AuditDataChangeResponse.prototype, "deletedAt", void 0);
+class PaginatedAuditDataChangesResponse {
+}
+exports.PaginatedAuditDataChangesResponse = PaginatedAuditDataChangesResponse;
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: [AuditDataChangeResponse] }),
+    __metadata("design:type", Array)
+], PaginatedAuditDataChangesResponse.prototype, "items", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: paginationMeta_response_1.PaginationMetaResponse }),
+    __metadata("design:type", paginationMeta_response_1.PaginationMetaResponse)
+], PaginatedAuditDataChangesResponse.prototype, "meta", void 0);

package/dist/features/audit/presentation/responses/log.response.d.ts

@@ -0,0 +1,45 @@
+import { PaginationMetaResponse } from "../../../../core/utils/paginationMeta.response";
+import { ErrorType } from "../../infra/schema/errorLog.schema";
+import { AuditUserRefResponse } from "./auditDataChange.response";
+export declare class RequestLogResponse {
+    id: string;
+    action: string;
+    entity?: string | null;
+    entityId?: string | null;
+    method?: string | null;
+    path?: string | null;
+    statusCode?: number | null;
+    durationMs?: number | null;
+    ipAddress?: string | null;
+    requestId?: string | null;
+    metadata?: Record<string, unknown> | null;
+    userId?: string | null;
+    user?: AuditUserRefResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+}
+export declare class PaginatedRequestLogsResponse {
+    items: RequestLogResponse[];
+    meta: PaginationMetaResponse;
+}
+export declare class ErrorLogResponse {
+    id: string;
+    type: ErrorType;
+    statusCode?: number | null;
+    message: string;
+    stack?: string | null;
+    method?: string | null;
+    path?: string | null;
+    ipAddress?: string | null;
+    requestId?: string | null;
+    userId?: string | null;
+    user?: AuditUserRefResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date | null;
+}
+export declare class PaginatedErrorLogsResponse {
+    items: ErrorLogResponse[];
+    meta: PaginationMetaResponse;
+}