xcally-nest-library 0.0.10 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcally-nest-library",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "lib:link": "pnpm link --global",
-    "lib:unlink": "pnpm unlink xcally-nest-libs"
+    "lib:unlink": "pnpm unlink xcally-nest-libs --global"
   },
   "dependencies": {
     "@nestjs/axios": "^3.0.2",

package/src/config/env.validation.ts

@@ -1,5 +1,5 @@
 import { plainToClass } from 'class-transformer';
-import { IsEnum, IsNumber, IsBoolean, IsString, validateSync, NotContains } from 'class-validator';
+import { IsEnum, IsNumber, IsBoolean, IsString, validateSync, NotContains, IsDefined } from 'class-validator';
 
 enum EnvironmentType {
   Dev = 'development',
@@ -10,6 +10,7 @@ enum EnvironmentType {
 }
 
 class EnvironmentVariables {
+  @IsDefined()
   @IsEnum(EnvironmentType)
   NODE_ENV: EnvironmentType;
 

package/src/db/typeorm/generic.repository.ts

@@ -94,4 +94,14 @@ export class GenericRepository<E extends ObjectLiteral> {
       id: Equal(id),
     } as unknown as FindOptionsWhere<E>);
   }
+
+  /**
+   * Removes an entity from the database based on its ID.
+   *
+   * @param id - The ID of the entity to remove.
+   * @returns A promise that resolves when the entity is successfully removed.
+   */
+  async remove(id: number): Promise<void> {
+    await this.repository.delete(id);
+  }
 }

package/src/interceptors/log-request.interceptor.ts

@@ -10,7 +10,8 @@ export class LogRequestInterceptor implements NestInterceptor {
     const req = context.switchToHttp().getRequest();
     this.logger.info('Before Middleware...', {
       traceId: req?.local?.traceId,
-      className: 'LogRequestInterceptor',
+      className: this.constructor.name,
+      methodName: 'intercept',
     });
     const now = Date.now();
 
@@ -22,6 +23,7 @@ export class LogRequestInterceptor implements NestInterceptor {
           this.logger.info(`After Middleware... ${method} ${url} ${Date.now() - now}ms`, {
             traceId: req?.local?.traceId,
             className: 'LogRequestInterceptor',
+            methodName: 'intercept',
           }),
         ),
       );

package/src/modules/logger/winston.service.ts

@@ -2,57 +2,52 @@
 import { Logger } from 'winston';
 import { IWinstonLogger } from './winston.interface';
 import { TraceLog } from './winston.decorator';
+import { LoggerCtx } from '../../types';
 
-export interface Meta {
-  traceId: string; // Ensures traceId is always present
-  className?: string;
-  methodName?: string;
-  [key: string]: any; // Allows for any number of additional properties
-}
 export class WinstonLoggerService implements IWinstonLogger {
   constructor(private readonly logger: Logger) {}
 
   @TraceLog()
-  info(message: string, meta: Meta): void {
+  info(message: string, meta: LoggerCtx): void {
     this.logger.info(message, meta);
   }
   @TraceLog()
-  warn(message: string, meta: Meta): void {
+  warn(message: string, meta: LoggerCtx): void {
     this.logger.warn(message, meta);
   }
   @TraceLog()
-  help(message: string, meta: Meta): void {
+  help(message: string, meta: LoggerCtx): void {
     this.logger.help(message, meta);
   }
   @TraceLog()
-  data(message: string, meta: Meta): void {
+  data(message: string, meta: LoggerCtx): void {
     this.logger.data(message, meta);
   }
   @TraceLog()
-  debug(message: string, meta: Meta): void {
+  debug(message: string, meta: LoggerCtx): void {
     this.logger.debug(message, meta);
   }
-  prompt(message: string, meta: Meta): void {
+  prompt(message: string, meta: LoggerCtx): void {
     this.logger.prompt(message, meta);
   }
   @TraceLog()
-  http(message: string, meta: Meta): void {
+  http(message: string, meta: LoggerCtx): void {
     this.logger.http(message, meta);
   }
   @TraceLog()
-  verbose(message: string, meta: Meta): void {
+  verbose(message: string, meta: LoggerCtx): void {
     this.logger.verbose(message, meta);
   }
   @TraceLog()
-  input(message: string, meta: Meta): void {
+  input(message: string, meta: LoggerCtx): void {
     this.logger.input(message, meta);
   }
   @TraceLog()
-  silly(message: string, meta: Meta): void {
+  silly(message: string, meta: LoggerCtx): void {
     this.logger.silly(message, meta);
   }
   @TraceLog()
-  error(message: string, meta: Meta): void {
+  error(message: string, meta: LoggerCtx): void {
     this.logger.error(message, meta);
   }
 

package/src/modules/tracer/tracer.middleware.ts

@@ -5,14 +5,12 @@ export const X_REQUEST_ID_HEADER = 'X-Request-ID';
 export const X_RESPONSE_ID_HEADER = 'X-Response-ID';
 import { ConfigurableModuleBuilder } from '@nestjs/common';
 import { RouteInfo } from '@nestjs/common/interfaces';
+import { Ctx } from '../../types';
 
 interface CtxLocal {
-  local: CtxLocalTraceID;
+  local: Ctx;
 }
-interface CtxLocalTraceID {
-  traceId: string;
-}
-type CtxLocalRequest = Request & CtxLocal;
+type CtxLocalRequest = Request & Ctx;
 
 export interface TracingModuleOptions {
   routes: (string | RouteInfo)[];

package/src/types/auth.ts

@@ -1,9 +1,37 @@
+export type UserPermission = {
+  sectionId: number;
+  name: string;
+  category: string;
+  crudPermissions: Array<'r' | 'e' | 'd'>;
+};
+
 export type User = {
-  roles: ERoles[];
+  id: number;
+  role: Role;
   name: string;
+  userProfileId: number;
+  permissions: UserPermission[];
+  // tenant:Tenant
+};
+
+export type Ctx = {
+  traceId: string;
+  user?: User;
+  auth?: Auth;
 };
 
-export enum ERoles {
-  admin = 'admin',
-  user = 'user',
+export type LoggerCtx = Ctx & {
+  className: string;
+  methodName: string;
+  [key: string]: any; // Allows for any number of additional properties
+};
+
+export enum Role {
+  User = 'user',
+  Admin = 'admin',
+  Agent = 'agent',
 }
+
+export type Auth = {
+  token: string;
+};