@innv/nest-initializer 0.1.2 → 0.2.0

package/dist/cjs/core/app-initializer.js

@@ -22,6 +22,7 @@ const config_validator_helper_1 = require("./config-validator.helper");
 const features_1 = require("../features");
 const plugins_1 = require("../plugins");
 const starters_1 = require("../starters");
+const response_pattern_interceptor_1 = require("../interceptors/response-pattern.interceptor");
 /**
  * Uma classe fluente (Builder) para inicializar uma aplicação NestJS de forma declarativa.
  */
@@ -41,6 +42,7 @@ class AppInitializer {
     advancedSwaggerUiOptions;
     autoDiscoveredComponents;
     globalProviders = [];
+    globalInterceptors = [];
     factoryGeneratedControllers = [];
     constructor(module, adapter) {
         this.module = module;
@@ -351,6 +353,22 @@ class AppInitializer {
         this.autoDiscoveredComponents = (0, auto_discovery_helper_1.discoverComponents)(options.basePath, reflector);
         return this;
     }
+    /**
+     * Adiciona um Interceptor global diretamente (instância).
+     * @param interceptor
+     */
+    addGlobalInterceptor(interceptor) {
+        this.globalInterceptors.push(interceptor);
+        return this;
+    }
+    /**
+     * Adiciona um ResponseMapper global para padronizar respostas.
+     * @param mapper
+     */
+    withResponseMapper(mapper) {
+        this.globalInterceptors.push(new response_pattern_interceptor_1.ResponsePatternInterceptor(mapper));
+        return this;
+    }
     async listen() {
         this.logger.log('Criando a instância da aplicação NestJS...');
         const rootImports = [this.module, ...this.featureModules];
@@ -388,36 +406,20 @@ class AppInitializer {
             this.logger.log(`Aplicando o plugin: ${plugin.constructor.name}`);
             await plugin.apply(this.app);
         }
+        for (const interceptor of this.globalInterceptors) {
+            this.app.useGlobalInterceptors(interceptor);
+        }
         if (this.swaggerOptions) {
-            const config = new swagger_1.DocumentBuilder()
+            const documentBuilder = new swagger_1.DocumentBuilder()
                 .setTitle(this.swaggerOptions.title)
                 .setDescription(this.swaggerOptions.description)
-                .setVersion(this.swaggerOptions.version)
-                .addBearerAuth()
-                .build();
-            const document = swagger_1.SwaggerModule.createDocument(this.app, config);
-            const swaggerSetupOptions = {};
-            if (this.advancedSwaggerUiOptions?.customCss) {
-                swaggerSetupOptions.customCssUrl =
-                    this.advancedSwaggerUiOptions.customCss;
-            }
-            if (this.advancedSwaggerUiOptions?.customJs) {
-                swaggerSetupOptions.customJsUrl =
-                    this.advancedSwaggerUiOptions.customJs;
+                .setVersion(this.swaggerOptions.version);
+            for (const tag of this.swaggerOptions.tags ?? []) {
+                documentBuilder.addTag(tag.name, tag.description);
             }
-            swaggerSetupOptions.swaggerOptions = {
-                docExpansion: 'none',
-                filter: true,
-                showRequestDuration: true,
-                deepLinking: true,
-                displayRequestDuration: true,
-                tryItOutEnabled: true,
-                persistAuthorization: true,
-                defaultModelsExpandDepth: -1,
-                operationsSorter: 'alpha',
-                tagsSorter: 'alpha',
-            };
-            swagger_1.SwaggerModule.setup(this.swaggerOptions.path ?? 'docs', this.app, document, swaggerSetupOptions);
+            const config = documentBuilder.build();
+            const document = swagger_1.SwaggerModule.createDocument(this.app, config, this.swaggerOptions.documentOptions);
+            swagger_1.SwaggerModule.setup(this.swaggerOptions.path ?? 'docs', this.app, document, this.swaggerOptions.customOptions);
         }
         await this.app.listen(this.port);
         const appUrl = await this.app.getUrl();

package/dist/cjs/interceptors/response-pattern.interceptor.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponsePatternInterceptor = void 0;
+const rxjs_1 = require("rxjs");
+class ResponsePatternInterceptor {
+    mapper;
+    constructor(mapper) {
+        this.mapper = mapper;
+    }
+    intercept(context, next) {
+        return next.handle().pipe((0, rxjs_1.map)((data) => this.mapper(data, context)));
+    }
+}
+exports.ResponsePatternInterceptor = ResponsePatternInterceptor;

package/dist/esm/core/app-initializer.js

@@ -22,6 +22,7 @@ const config_validator_helper_1 = require("./config-validator.helper");
 const features_1 = require("../features");
 const plugins_1 = require("../plugins");
 const starters_1 = require("../starters");
+const response_pattern_interceptor_1 = require("../interceptors/response-pattern.interceptor");
 /**
  * Uma classe fluente (Builder) para inicializar uma aplicação NestJS de forma declarativa.
  */
@@ -41,6 +42,7 @@ class AppInitializer {
     advancedSwaggerUiOptions;
     autoDiscoveredComponents;
     globalProviders = [];
+    globalInterceptors = [];
     factoryGeneratedControllers = [];
     constructor(module, adapter) {
         this.module = module;
@@ -351,6 +353,22 @@ class AppInitializer {
         this.autoDiscoveredComponents = (0, auto_discovery_helper_1.discoverComponents)(options.basePath, reflector);
         return this;
     }
+    /**
+     * Adiciona um Interceptor global diretamente (instância).
+     * @param interceptor
+     */
+    addGlobalInterceptor(interceptor) {
+        this.globalInterceptors.push(interceptor);
+        return this;
+    }
+    /**
+     * Adiciona um ResponseMapper global para padronizar respostas.
+     * @param mapper
+     */
+    withResponseMapper(mapper) {
+        this.globalInterceptors.push(new response_pattern_interceptor_1.ResponsePatternInterceptor(mapper));
+        return this;
+    }
     async listen() {
         this.logger.log('Criando a instância da aplicação NestJS...');
         const rootImports = [this.module, ...this.featureModules];
@@ -388,36 +406,20 @@ class AppInitializer {
             this.logger.log(`Aplicando o plugin: ${plugin.constructor.name}`);
             await plugin.apply(this.app);
         }
+        for (const interceptor of this.globalInterceptors) {
+            this.app.useGlobalInterceptors(interceptor);
+        }
         if (this.swaggerOptions) {
-            const config = new swagger_1.DocumentBuilder()
+            const documentBuilder = new swagger_1.DocumentBuilder()
                 .setTitle(this.swaggerOptions.title)
                 .setDescription(this.swaggerOptions.description)
-                .setVersion(this.swaggerOptions.version)
-                .addBearerAuth()
-                .build();
-            const document = swagger_1.SwaggerModule.createDocument(this.app, config);
-            const swaggerSetupOptions = {};
-            if (this.advancedSwaggerUiOptions?.customCss) {
-                swaggerSetupOptions.customCssUrl =
-                    this.advancedSwaggerUiOptions.customCss;
-            }
-            if (this.advancedSwaggerUiOptions?.customJs) {
-                swaggerSetupOptions.customJsUrl =
-                    this.advancedSwaggerUiOptions.customJs;
+                .setVersion(this.swaggerOptions.version);
+            for (const tag of this.swaggerOptions.tags ?? []) {
+                documentBuilder.addTag(tag.name, tag.description);
             }
-            swaggerSetupOptions.swaggerOptions = {
-                docExpansion: 'none',
-                filter: true,
-                showRequestDuration: true,
-                deepLinking: true,
-                displayRequestDuration: true,
-                tryItOutEnabled: true,
-                persistAuthorization: true,
-                defaultModelsExpandDepth: -1,
-                operationsSorter: 'alpha',
-                tagsSorter: 'alpha',
-            };
-            swagger_1.SwaggerModule.setup(this.swaggerOptions.path ?? 'docs', this.app, document, swaggerSetupOptions);
+            const config = documentBuilder.build();
+            const document = swagger_1.SwaggerModule.createDocument(this.app, config, this.swaggerOptions.documentOptions);
+            swagger_1.SwaggerModule.setup(this.swaggerOptions.path ?? 'docs', this.app, document, this.swaggerOptions.customOptions);
         }
         await this.app.listen(this.port);
         const appUrl = await this.app.getUrl();

package/dist/esm/interceptors/response-pattern.interceptor.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponsePatternInterceptor = void 0;
+const rxjs_1 = require("rxjs");
+class ResponsePatternInterceptor {
+    mapper;
+    constructor(mapper) {
+        this.mapper = mapper;
+    }
+    intercept(context, next) {
+        return next.handle().pipe((0, rxjs_1.map)((data) => this.mapper(data, context)));
+    }
+}
+exports.ResponsePatternInterceptor = ResponsePatternInterceptor;

package/dist/types/core/app-initializer.d.ts

@@ -1,8 +1,10 @@
 import { CanActivate, ExceptionFilter, INestApplication, NestInterceptor, PipeTransform, Type, ValidationPipeOptions, VersioningOptions } from '@nestjs/common';
 import { CorsOptions } from '@nestjs/common/interfaces/external/cors-options.interface';
 import { AbstractHttpAdapter } from '@nestjs/core';
+import { SwaggerCustomOptions, SwaggerDocumentOptions } from '@nestjs/swagger';
 import { TerminusHealthCheckOptions } from '../features';
 import { CachingStarterOptions, MongooseStarterOptions, TypeOrmStarterOptions } from '../starters';
+import { ResponseMapper } from '../interceptors/response-pattern.interceptor';
 /**
  * Interface que todos os plugins do AppInitializer devem implementar.
  */
@@ -14,6 +16,13 @@ export interface AppInitializerPlugin {
      */
     apply(app: INestApplication): Promise<void> | void;
 }
+/**
+ * Representa uma tag na documentação Swagger (OpenAPI).
+ */
+export type SwaggerDocumentTags = {
+    name: string;
+    description?: string;
+};
 /**
  * Opções para a configuração do Swagger (OpenAPI).
  */
@@ -21,7 +30,10 @@ export type SwaggerOptions = {
     title: string;
     description: string;
     version: string;
+    tags?: SwaggerDocumentTags[];
     path?: string;
+    documentOptions?: SwaggerDocumentOptions;
+    customOptions?: SwaggerCustomOptions;
 };
 /**
  * Assinatura da função de callback usada para configurar o inicializador.
@@ -47,6 +59,7 @@ export declare class AppInitializer<T extends INestApplication = INestApplicatio
     private advancedSwaggerUiOptions?;
     private autoDiscoveredComponents?;
     private readonly globalProviders;
+    private readonly globalInterceptors;
     private readonly factoryGeneratedControllers;
     private constructor();
     /**
@@ -201,6 +214,16 @@ export declare class AppInitializer<T extends INestApplication = INestApplicatio
     withAutoDiscovery(options: {
         basePath: string;
     }): this;
+    /**
+     * Adiciona um Interceptor global diretamente (instância).
+     * @param interceptor
+     */
+    addGlobalInterceptor(interceptor: NestInterceptor): this;
+    /**
+     * Adiciona um ResponseMapper global para padronizar respostas.
+     * @param mapper
+     */
+    withResponseMapper(mapper: ResponseMapper<T>): this;
     private listen;
 }
 export {};

package/dist/types/interceptors/response-pattern.interceptor.d.ts

@@ -0,0 +1,8 @@
+import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+export type ResponseMapper<T> = (data: any, context: ExecutionContext) => T;
+export declare class ResponsePatternInterceptor implements NestInterceptor {
+    private readonly mapper;
+    constructor(mapper: ResponseMapper<any>);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@innv/nest-initializer",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Uma plataforma fluente e opinativa para inicializar e configurar aplicações NestJS com as melhores práticas.",
   "author": "Innovare",
   "license": "MIT",
@@ -52,7 +52,7 @@
     "@nestjs/mongoose": "^10.0.0 || ^11.0.0",
     "@nestjs/platform-express": "^10.0.0 || ^11.0.0",
     "@nestjs/platform-fastify": "^10.0.0 || ^11.0.0",
-    "@nestjs/swagger": "^7.0.0",
+    "@nestjs/swagger": "^7.0.0 || ^11.0.0",
     "@nestjs/terminus": "^10.0.0 || ^11.0.0",
     "@nestjs/typeorm": "^10.0.0 || ^11.0.0",
     "axios": "^1.6.0",