cqrs-boilerplate-code 1.0.6 → 1.0.9

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "cqrs-boilerplate-code",
-  "version": "1.0.6",
+  "version": "1.0.9",
   "description": "AI Platform Service API Gateway",
   "private": false,
   "license": "UNLICENSED",
   "author": "ankitdetroja",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "package.json",
+    "tsconfig.json",
+    "tsconfig.build.json"
+  ],
   "scripts": {
     "clean": "rimraf dist coverage",
     "build": "nest build",
@@ -15,6 +24,13 @@
     "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
     "lint": "eslint \"{src,tests}/**/*.ts\" --fix"
   },
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "dependencies": {
     "@nestjs/common": "^11.1.3",
     "@nestjs/config": "^4.0.2",
@@ -64,4 +80,4 @@
     "tsc-files": "^1.1.4",
     "typescript": "^5.4.5"
   }
-}
+}

package/src/common-infra/common-infra.module.ts

@@ -1,17 +0,0 @@
-import { DynamicModule, Module } from "@nestjs/common";
-import { ConfigModule } from "@nestjs/config";
-import { DBModule } from "./database/database.module";
-
-@Module({})
-export class CommonInfraModule {
-  static forRoot(): DynamicModule {
-    return {
-      module: CommonInfraModule,
-      imports: [
-        ConfigModule, // assumes consumer app config
-        DBModule,
-      ],
-      exports: [DBModule],
-    };
-  }
-}

package/src/common-infra/database/database.module.ts

@@ -1,23 +0,0 @@
-// src/database/database.module.ts
-import { DynamicModule, Module } from "@nestjs/common";
-import { ConfigModule, ConfigService } from "@nestjs/config";
-import { TypeOrmModule } from "@nestjs/typeorm";
-import { typeOrmConfig } from "./typeorm.config";
-
-@Module({})
-export class DBModule {
-  static forRoot(): DynamicModule {
-    return {
-      module: DBModule,
-      imports: [
-        TypeOrmModule.forRootAsync({
-          imports: [ConfigModule],
-          inject: [ConfigService],
-          useFactory: (configService: ConfigService) =>
-            typeOrmConfig(configService),
-        }),
-      ],
-      exports: [TypeOrmModule],
-    };
-  }
-}

package/src/common-infra/database/typeorm.config.ts

@@ -1,18 +0,0 @@
-import { TypeOrmModuleOptions } from "@nestjs/typeorm";
-import { ConfigService } from "@nestjs/config";
-
-export const typeOrmConfig = (
-  configService: ConfigService,
-): TypeOrmModuleOptions => ({
-  type: "postgres",
-  host: configService.get<string>("DB_HOST"),
-  port: configService.get<number>("DB_PORT"),
-  username: configService.get<string>("DB_USERNAME"),
-  password: configService.get<string>("DB_PASSWORD"),
-  database: configService.get<string>("DB_NAME"),
-  autoLoadEntities: true,
-  synchronize: configService.get<string>("NODE_ENV") !== "production",
-  migrations: ["dist/migrations/*.js"],
-  migrationsRun: true,
-  logging: configService.get<string>("NODE_ENV") !== "production",
-});

package/src/common-infra/index.ts

@@ -1,2 +0,0 @@
-export * from "./common-infra.module";
-export * from "./database/typeorm.config";

package/src/core-common/constant/app.constant.ts

@@ -1,2 +0,0 @@
-export const PORT = 3001;
-export const BASE_URL = '/api/retail'

package/src/core-common/core-common.module.ts

@@ -1,19 +0,0 @@
-// src/core-common.module.ts
-import { DynamicModule, Global, Module } from "@nestjs/common";
-import { LoggerModule } from "./logger/logger.module";
-
-@Global()
-@Module({})
-export class CoreCommonModule {
-  static forRoot(): DynamicModule {
-    return {
-      module: CoreCommonModule,
-      imports: [
-        LoggerModule.forRoot(),
-      ],
-      exports: [
-        LoggerModule,
-      ],
-    };
-  }
-}

package/src/core-common/error/custom-error/already-exists.error.ts

@@ -1,17 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-/**
- * Custom error class for representing the scenario where an entity already exists/Conflict with existing.
- * Extends the GenericError class.
- */
-export class AlreadyExistsError extends GenericError {
-  /**
-   * Constructor for the AlreadyExistsError class.
-   * @param code - Short code associated with the error.
-   * @param message - Detailed error information.
-   */
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.CONFLICT);
-  }
-}

package/src/core-common/error/custom-error/bad-request.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class BadRequestError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.BAD_REQUEST);
-  }
-}

package/src/core-common/error/custom-error/conflict.error.ts

@@ -1,17 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-/**
- * Custom error class for representing conflict errors.
- * Extends the GenericError class.
- */
-export class ConflictError extends GenericError {
-  /**
-   * Constructor for the ConflictError class.
-   * @param code - Short code associated with the error.
-   * @param message - Detailed error information.
-   */
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.CONFLICT);
-  }
-}

package/src/core-common/error/custom-error/custom-validation-error.ts

@@ -1,9 +0,0 @@
-import { BadRequestError } from "./bad-request.error";
-
-export class CustomValidationError extends BadRequestError {
-  constructor(
-    public validationErrors: any
-  ) {
-    super("ValidationError", "There are issues found in the input provided.");
-  }
-}

package/src/core-common/error/custom-error/forbidden.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class ForbiddenError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.FORBIDDEN);
-  }
-}

package/src/core-common/error/custom-error/internal-server.error.ts

@@ -1,11 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class InternalServerError extends GenericError {
-  constructor(
-    code = "INTERNAL_SERVER_ERROR",
-    message = "An unexpected error occurred",
-  ) {
-    super(code, message, HttpStatus.INTERNAL_SERVER_ERROR);
-  }
-}

package/src/core-common/error/custom-error/not-found.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class NotFoundError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.NOT_FOUND);
-  }
-}

package/src/core-common/error/custom-error/service-unavailable.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class ServiceUnavailableError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.SERVICE_UNAVAILABLE);
-  }
-}

package/src/core-common/error/custom-error/unauthorized.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class UnauthorizedError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.UNAUTHORIZED);
-  }
-}

package/src/core-common/error/custom-error/unprocess-entity.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class UnprocessableEntityError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.UNPROCESSABLE_ENTITY);
-  }
-}

package/src/core-common/error/custom-error/validation.error.ts

@@ -1,8 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { GenericError } from "../generic.error";
-
-export class ValidationError extends GenericError {
-  constructor(code: string, message: string) {
-    super(code, message, HttpStatus.UNPROCESSABLE_ENTITY);
-  }
-}

package/src/core-common/error/generic.error.ts

@@ -1,31 +0,0 @@
-import { HttpStatus } from "@nestjs/common";
-import { ApiProperty } from "@nestjs/swagger";
-
-/**
- * Custom error class which needs to be returned from the lower layers to the higher calling layers
- */
-export class GenericError {
-  @ApiProperty({ description: "Short error code" })
-  public code: string;
-
-  @ApiProperty({ description: "Detailed error description" })
-  public message: string;
-
-  @ApiProperty({ description: "Detailed error description" })
-  public statusCode: HttpStatus;
-
-  /**
-   * Default constructor
-   * @param code - Short error code  e.g. "InvaliOperation", "ItemNotFound" etc
-   * @param message  - Detailed error message
-   */
-  constructor(
-    code: string,
-    message: string,
-    statusCode: HttpStatus = HttpStatus.INTERNAL_SERVER_ERROR,
-  ) {
-    this.code = code;
-    this.message = message;
-    this.statusCode = statusCode;
-  }
-}

package/src/core-common/error/index.ts

@@ -1,14 +0,0 @@
-export * from "./generic.error";
-export * from "./custom-error/bad-request.error";
-export * from "./custom-error/unauthorized.error";
-export * from "./custom-error/forbidden.error";
-export * from "./custom-error/not-found.error";
-export * from "./custom-error/conflict.error";
-export * from "./custom-error/already-exists.error";
-export * from "./custom-error/validation.error";
-export * from "./custom-error/unprocess-entity.error";
-export * from "./custom-error/service-unavailable.error";
-
-export * from "./custom-error/internal-server.error";
-export * from "./custom-error/validation.error";
-export * from "./custom-error/custom-validation-error"

package/src/core-common/index.ts

@@ -1,17 +0,0 @@
-export * from './constant/app.constant'
-export * from './error/custom-error/already-exists.error'
-export * from './error/custom-error/not-found.error'
-export * from './error/custom-error/validation.error'
-export * from './error/custom-error/internal-server.error'
-export * from './error/custom-error/unauthorized.error'
-export * from './error/custom-error/service-unavailable.error'
-export * from './error/generic.error'
-export * from './result-model/result'
-
-export * from './logger/index'
-
-export * from './response-model/generic-error-response.model'
-export * from './response-model/generic-success-response.model'
-
-export * from './core-common.module'
-export * from './constant/app.constant'

package/src/core-common/logger/index.ts

@@ -1,3 +0,0 @@
-export * from './logger.interface'
-export * from './logger.module'
-export * from './logger.service'

package/src/core-common/logger/logger.interface.ts

@@ -1,8 +0,0 @@
-// src/logger/logger.options.ts
-export interface LoggerModuleOptions {
-  level?: string;
-  deploymentEnv?: string;
-  serviceVersion?: string;
-  otelAgentHost?: string;
-  overrideConsole?: boolean;
-}

package/src/core-common/logger/logger.module.ts

@@ -1,23 +0,0 @@
-// src/logger/logger.module.ts
-import { DynamicModule, Module } from "@nestjs/common";
-import { LoggerService } from "./logger.service";
-import { LoggerModuleOptions } from "./logger.interface";
-
-export const LOGGER_OPTIONS = Symbol("LOGGER_OPTIONS");
-
-@Module({})
-export class LoggerModule {
-  static forRoot(options: LoggerModuleOptions = {}): DynamicModule {
-    return {
-      module: LoggerModule,
-      providers: [
-        LoggerService,
-        {
-          provide: LOGGER_OPTIONS,
-          useValue: options,
-        },
-      ],
-      exports: [LoggerService],
-    };
-  }
-}

package/src/core-common/logger/logger.service.ts

@@ -1,175 +0,0 @@
-import winston, { Logger } from "winston";
-
-/* ---------------------------------- Types --------------------------------- */
-
-enum SeverityText {
-  INFO = "Information",
-  DEBUG = "Debug",
-  WARNING = "Warning",
-  ERROR = "Error",
-}
-
-type LogMetadata = {
-  ClassName?: string;
-  MethodName?: string;
-};
-
-export type OrgContext = {
-  orgId?: string;
-  orgFid?: string;
-  userId?: string;
-};
-
-/* --------------------------------- Service -------------------------------- */
-
-export class LoggerService {
-  private readonly logger: Logger;
-  private readonly deploymentEnv: string;
-  private readonly hostImageVersion: string;
-  private readonly otelAgentHost: string;
-
-  constructor(logLevel: string = "debug") {
-    this.deploymentEnv = "rls-dev";
-    this.hostImageVersion = process.env.SERVICE_VERSION ?? "202501.1";
-    this.otelAgentHost = process.env.OTEL_AGENT_HOST ?? "10.0.0.1";
-    this.logger = this.createLogger(logLevel);
-    this.overrideConsole();
-  }
-
-  /* ------------------------------- Public API ------------------------------- */
-
-  log(message: string, metadata?: LogMetadata) {
-    this.write("info", SeverityText.INFO, message, metadata);
-  }
-
-  debug(message: string, metadata?: LogMetadata) {
-    this.write("debug", SeverityText.DEBUG, message, metadata);
-  }
-
-  warn(message: string, metadata?: LogMetadata) {
-    this.write("warn", SeverityText.WARNING, message, metadata);
-  }
-
-  error(message: string, metadata?: LogMetadata, error?: Error) {
-    this.write("error", SeverityText.ERROR, message, metadata, error);
-  }
-
-  /* ------------------------------ Logger Core ------------------------------ */
-
-  private write(
-    level: keyof Logger,
-    severity: SeverityText,
-    message: string,
-    metadata: LogMetadata = {},
-    error?: Error,
-  ) {
-    const body = {
-      SeverityText: severity,
-      ...metadata,
-      ...(error && {
-        ErrorMessage: error.message,
-        StackTrace: error.stack,
-      }),
-    };
-
-    this.logger[level](this.redactSecrets(message), body);
-  }
-
-  private createLogger(level: string): Logger {
-    return winston.createLogger({
-      level,
-      levels: winston.config.npm.levels,
-      format: winston.format.combine(
-        winston.format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }),
-        winston.format.printf(({ level, message, timestamp, ...meta }) =>
-          JSON.stringify({
-            message: this.safeStringify(message),
-            attributes: this.buildAttributes(level),
-            timestamp: timestamp,
-            ...this.cleanMeta(meta),
-          }),
-        ),
-      ),
-      transports: [new winston.transports.Console()],
-    });
-  }
-
-  /* ------------------------------- Context -------------------------------- */
-
-  private buildAttributes(level: string) {
-    return {
-      "service.image.version": this.hostImageVersion,
-      "deployment.environment": this.deploymentEnv,
-      "otel.agent.host": this.otelAgentHost,
-      "service.log.level": level,
-    };
-  }
-
-  /* ------------------------------- Helpers -------------------------------- */
-
-  private cleanMeta(meta: Record<string, unknown>) {
-    return Object.fromEntries(
-      Object.entries(meta).filter(
-        ([_, value]) => value !== undefined && value !== "None",
-      ),
-    );
-  }
-
-  private safeStringify(input: unknown): string {
-    try {
-      return typeof input === "string"
-        ? input
-        : JSON.stringify(input, this.circularReplacer());
-    } catch {
-      return "[Unserializable Object]";
-    }
-  }
-
-  private circularReplacer() {
-    const seen = new WeakSet();
-    return (_: string, value: any) => {
-      if (typeof value === "object" && value !== null) {
-        if (seen.has(value)) return "[Circular]";
-        seen.add(value);
-      }
-      return value;
-    };
-  }
-
-  /* ----------------------------- Redaction -------------------------------- */
-
-  private redactSecrets(message: string): string {
-    const patterns = [
-      {
-        name: "JWT",
-        regex: /eyJ[a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+/g,
-        visible: 10,
-      },
-      {
-        name: "BEARER",
-        regex: /Bearer\s+eyJ[A-Za-z0-9\-._~+/]+=*/gi,
-        visible: 15,
-      },
-      { name: "API_KEY", regex: /\b[A-Za-z0-9]{32,}\b/g, visible: 8 },
-      { name: "AWS_SECRET", regex: /AKIA[0-9A-Z]{16}/g, visible: 8 },
-    ];
-
-    return patterns.reduce((msg, { regex, visible, name }) => {
-      return msg.replace(
-        regex,
-        (m) => `${m.slice(0, visible)}...[REDACTED_${name}]`,
-      );
-    }, message);
-  }
-
-  /* --------------------------- Console Override ---------------------------- */
-
-  private overrideConsole() {
-    const blocked = ["NodeSDK", "AuthToken"];
-    console.log = (...args: unknown[]) => {
-      const msg = args.map(String).join(" ");
-      if (blocked.some((k) => msg.includes(k))) return;
-      this.log(msg);
-    };
-  }
-}

package/src/core-common/response-model/generic-error-response.model.ts

@@ -1,44 +0,0 @@
-import { Result } from "../result-model/result";
-
-/**
- * Standard error response to be returned to the caller of the API.
- * This class represents the structure of an error response returned by the API
- * in case of failures.
- */
-
-export class ErrorDisplay {
-  code: string;
-  message: string;
-  validationError?: any;
-}
-export class GenericErrorResponse {
-  statusCode: number;
-  success: boolean = false;
-  error: ErrorDisplay;
-  timestamp: string;
-  data: any;
-
-  constructor() {
-    this.statusCode = 500; // Default value
-    this.success = false;
-    this.timestamp = new Date().toISOString(); // Default value
-  }
-  /**
-   * Sets the properties from the Result object.
-   * @param result - Result object instance returned from the controller method.
-   * @param statusCode - HTTP status code.
-   */
-  initialize(
-    result: Result<any>,
-    statusCode: number,
-  ) {
-    this.statusCode = statusCode;
-    this.error = {
-      code: result.error?.code || "ERROR",
-      message: result.error?.message || "An error occurred.",
-    };
-    this.data = result.data
-    this.success = result.success || false;
-    this.timestamp = result.timestamp || new Date().toISOString();
-  }
-}

package/src/core-common/response-model/generic-success-response.model.ts

@@ -1,25 +0,0 @@
-import { Result } from "../result-model/result";
-
-/**
- * Standard response object to be returned to the caller of the API.
- * This class represents the structure of a success response returned by the API.
- * @typeparam T - The type of data included in the response.
- */
-export class GenericSuccessResponse<T> {
-  statusCode: number;
-  success: boolean;
-  data: T;
-  timestamp: string;
-
-  /**
-   * Sets the properties from the Result object.
-   * @param result - Result object instance returned from the controller method.
-   * @param statusCode - HTTP status code.
-   */
-  initialize(result: Result<T>, statusCode: number) {
-    this.statusCode = statusCode;
-    this.success = result.success;
-    this.data = result.data;
-    this.timestamp = new Date().toISOString();
-  }
-}

package/src/core-common/result-model/result.ts

@@ -1,38 +0,0 @@
-import { GenericError } from "../error/generic.error";
-
-export class Result<T> {
-  success: boolean;
-  data: T;
-  error: GenericError;
-  timestamp: string;
-
-  public static success<T>(data: T): Result<T> {
-    const result = new Result<T>();
-    result.success = true;
-    result.data = data;
-    result.timestamp = new Date().toISOString();
-    return result;
-  }
-
-  public static failed<T>(error: GenericError, data?: T): Result<T> {
-    const result = new Result<T>();
-    result.success = false;
-    result.timestamp = new Date().toISOString();
-    result.error = error;
-    if (data) {
-      result.data = data;
-    }
-    return result;
-  }
-
-  public static throwError<T>(error: GenericError, data?: T): Result<T> {
-    const result = new Result<T>();
-    result.success = false;
-    result.timestamp = new Date().toISOString();
-    result.error = error;
-    if (data) {
-      result.data = data;
-    }
-    throw result;
-  }
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './core-common/index'
-export * from './common-infra/index'