@innv/nest-initializer 0.1.0

package/dist/types/features/metrics/metrics.tokens.d.ts

@@ -0,0 +1,2 @@
+export declare const METRICS_REGISTRY = "METRICS_REGISTRY";
+export declare const METRICS_HTTP_HISTOGRAM = "METRICS_HTTP_HISTOGRAM";

package/dist/types/features/terminus-health-check.module.d.ts

@@ -0,0 +1,11 @@
+import { DynamicModule } from '@nestjs/common';
+export interface TerminusHealthCheckOptions {
+    database?: boolean;
+    memory?: {
+        heapThreshold?: number;
+        rssThreshold?: number;
+    };
+}
+export declare class TerminusHealthCheckModule {
+    static forRoot(options: TerminusHealthCheckOptions): DynamicModule;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './core/app-initializer';
+export { TypeOrmStarterOptions } from './starters/typeorm.starter';
+export { MongooseStarterOptions } from './starters/mongoose.starter';
+export { CachingStarterOptions } from './starters/caching.starter';
+export { TerminusHealthCheckOptions } from './features/terminus-health-check.module';
+export * from './plugins';

package/dist/types/plugins/index.d.ts

@@ -0,0 +1,3 @@
+export * from './rate-limiter.plugin';
+export * from './request-logger.plugin';
+export * from './typeorm-migration.plugin';

package/dist/types/plugins/rate-limiter.plugin.d.ts

@@ -0,0 +1,8 @@
+import { INestApplication } from '@nestjs/common';
+import { Options as RateLimitOptions } from 'express-rate-limit';
+import { AppInitializerPlugin } from '../core';
+export declare class RateLimiterPlugin implements AppInitializerPlugin {
+    private readonly options;
+    constructor(options?: Partial<RateLimitOptions>);
+    apply(app: INestApplication): void;
+}

package/dist/types/plugins/request-logger.plugin.d.ts

@@ -0,0 +1,5 @@
+import { INestApplication } from '@nestjs/common';
+import { AppInitializerPlugin } from '../core';
+export declare class RequestLoggerPlugin implements AppInitializerPlugin {
+    apply(app: INestApplication): void;
+}

package/dist/types/plugins/typeorm-migration.plugin.d.ts

@@ -0,0 +1,15 @@
+import { INestApplication } from '@nestjs/common';
+import { AppInitializerPlugin } from '../core';
+/**
+ * Um plugin do AppInitializer que executa automaticamente as migrations
+ * do TypeORM na inicialização da aplicação.
+ */
+export declare class TypeOrmMigrationPlugin implements AppInitializerPlugin {
+    private readonly logger;
+    /**
+     * Método 'apply' que será chamado pelo AppInitializer durante o bootstrap.
+     * Este método é assíncrono para poder aguardar a conclusão das migrations.
+     * @param app A instância da aplicação NestJS.
+     */
+    apply(app: INestApplication): Promise<void>;
+}

package/dist/types/starters/caching.starter.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Opções para o "Starter" de Cache (Redis).
+ */
+export interface CachingStarterOptions {
+    /**
+     * Chave do .env que contém a URL de conexão com o Redis.
+     * (Padrão: 'REDIS_URL')
+     */
+    redisUrlEnvKey?: string;
+    /**
+     * Tempo de vida (TTL) padrão para os itens em cache, em segundos.
+     * (Padrão: 300 segundos / 5 minutos)
+     */
+    defaultTtlInSeconds?: number;
+}
+/**
+ * Cria o módulo dinâmico para o "Starter" de Cache.
+ * Configura o CacheModule para ser global e usar o Redis.
+ */
+export declare function createCachingStarter(options?: CachingStarterOptions): import("@nestjs/common").DynamicModule;

package/dist/types/starters/index.d.ts

@@ -0,0 +1,3 @@
+export * from './typeorm.starter';
+export * from './mongoose.starter';
+export * from './caching.starter';

package/dist/types/starters/mongoose.starter.d.ts

@@ -0,0 +1,24 @@
+import { MongooseModuleOptions } from '@nestjs/mongoose';
+/**
+ * Opções para o "Starter" de Mongoose (MongoDB).
+ */
+export interface MongooseStarterOptions {
+    /**
+     * Chave do .env que contém a URI de conexão com o MongoDB.
+     * (Padrão: 'MONGO_URI')
+     */
+    uriEnvKey?: string;
+    /**
+     * Permite sobrescrever qualquer outra opção de configuração do Mongoose
+     * (ex: { retryAttempts: 2 }).
+     */
+    mongooseOptions?: Omit<MongooseModuleOptions, 'uri'>;
+}
+/**
+ * Cria o módulo dinâmico para o "Starter" de Mongoose.
+ * Configura o MongooseModule para ser global e usar a URI do .env.
+ */
+export declare function createMongooseStarter(options?: MongooseStarterOptions): {
+    module: import("@nestjs/common").DynamicModule;
+    plugins: never[];
+};

package/dist/types/starters/typeorm.starter.d.ts

@@ -0,0 +1,19 @@
+import { TypeOrmModuleOptions } from '@nestjs/typeorm';
+import { AppInitializerPlugin } from '../core';
+/**
+ * Opções para o "Starter" de TypeORM.
+ */
+export interface TypeOrmStarterOptions {
+    autoLoadEntities?: boolean;
+    runMigrationsOnStartup?: boolean;
+    databaseUrlEnvKey?: string;
+    typeOrmOptions?: Omit<TypeOrmModuleOptions, 'url' | 'autoLoadEntities' | 'synchronize'>;
+}
+/**
+ * Cria o módulo dinâmico para o "Starter" de TypeORM.
+ * Esta função constrói toda a configuração necessária para o TypeOrmModule.
+ */
+export declare function createTypeOrmStarter(options?: TypeOrmStarterOptions): {
+    module: import("@nestjs/common").DynamicModule;
+    plugins: AppInitializerPlugin[];
+};

package/package.json

@@ -0,0 +1,159 @@
+{
+  "name": "@innv/nest-initializer",
+  "version": "0.1.0",
+  "description": "Uma plataforma fluente e opinativa para inicializar e configurar aplicações NestJS com as melhores práticas.",
+  "author": "Innovare",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/innovare-tech/nest-initializer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/innovare-tech/nest-initializer/issues"
+  },
+  "homepage": "https://github.com/innovare-tech/nest-initializer/issues#readme",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "test": "jest --coverage",
+    "test:watch": "jest --watch",
+    "build:clean": "rimraf dist",
+    "build:cjs": "tsc -p tsconfig.build-cjs.json",
+    "build:esm": "tsc -p tsconfig.build-esm.json",
+    "build:types": "tsc -p tsconfig.build-types.json",
+    "build": "npm run build:clean && npm run build:cjs && npm run build:esm && npm run build:types",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"{src,test}/**/*.ts\"",
+    "prepare": "husky install",
+    "prepublishOnly": "npm run lint && npm test && npm run build"
+  },
+  "dependencies": {
+    "cache-manager-redis-store": "3.0.1",
+    "compression": "1.8.1",
+    "glob": "11.0.3",
+    "helmet": "8.1.0",
+    "morgan": "^1.10.1",
+    "zod": "4.1.12"
+  },
+  "peerDependencies": {
+    "@nestjs/axios": "^4.0.1",
+    "@nestjs/cache-manager": "^3.0.1",
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "@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/terminus": "^10.0.0 || ^11.0.0",
+    "@nestjs/typeorm": "^10.0.0",
+    "axios": "^1.6.0",
+    "mongoose": "^8.0.0",
+    "prom-client": "^15.0.0",
+    "reflect-metadata": "^0.1.13 || ^0.2.0",
+    "rxjs": "^7.0.0",
+    "typeorm": "^0.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/axios": {
+      "optional": true
+    },
+    "@nestjs/cache-manager": {
+      "optional": true
+    },
+    "@nestjs/config": {
+      "optional": true
+    },
+    "@nestjs/mongoose": {
+      "optional": true
+    },
+    "@nestjs/platform-express": {
+      "optional": true
+    },
+    "@nestjs/platform-fastify": {
+      "optional": true
+    },
+    "@nestjs/swagger": {
+      "optional": true
+    },
+    "@nestjs/terminus": {
+      "optional": true
+    },
+    "@nestjs/typeorm": {
+      "optional": true
+    },
+    "axios": {
+      "optional": true
+    },
+    "mongoose": {
+      "optional": true
+    },
+    "prom-client": {
+      "optional": true
+    },
+    "typeorm": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@eslint/js": "^9.38.0",
+    "@nestjs/axios": "^4.0.1",
+    "@nestjs/cache-manager": "^3.0.1",
+    "@nestjs/common": "^11.1.6",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^11.1.6",
+    "@nestjs/mongoose": "^11.0.3",
+    "@nestjs/platform-express": "^11.1.6",
+    "@nestjs/swagger": "^11.2.1",
+    "@nestjs/terminus": "^11.0.0",
+    "@nestjs/testing": "^11.1.7",
+    "@nestjs/typeorm": "^11.0.0",
+    "@types/compression": "^1.7.5",
+    "@types/jest": "^29.5.14",
+    "@types/morgan": "^1.9.10",
+    "@types/node": "^18.19.3",
+    "@typescript-eslint/eslint-plugin": "^7.10.0",
+    "@typescript-eslint/parser": "^7.10.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.2",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "express-rate-limit": "^8.1.0",
+    "globals": "^15.0.0",
+    "husky": "^9.0.11",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "prom-client": "^15.1.3",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^5.0.7",
+    "rxjs": "^7.8.1",
+    "ts-jest": "^29.4.5",
+    "typeorm": "^0.3.27",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^8.46.2"
+  },
+  "keywords": [
+    "nestjs",
+    "nest",
+    "initializer",
+    "bootstrap",
+    "builder",
+    "configuration",
+    "fluent",
+    "opinionated",
+    "starter",
+    "actuator",
+    "auto-discovery"
+  ]
+}