@jrosadob/ms-sophia-framework-mysql 0.0.1 → 0.0.2

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/README.md

@@ -1,5 +1,26 @@
 # Sophia Framework
 
+node -v
+npm -v
+nest --version
+npm i -g @nestjs/cli
+# Revisar disponibilidad
+npm view ms-sophia-framework-mysql version
+# Crear el workspace (No funciona con pnpm)
+nest new ms-sophia-framework-mysql --package-manager npm
+# Ingresar
+cd ms-sophia-framework-mysql
+# Generar la libreria
+nest g library ms-sophia-framework-mysql
+# Compilar
+npm run build
+# Validsate
+nest build ms-sophia-framework-mysql
+# Pack en tg.gz para despliegue local
+npm pack
+# Publish
+npm publish --access public
+
 ## v47
 Define propiedes dinamicas para el datasource:
 entities, subscribers, synchronize, logging, logger: typeOrmLogger

package/bootstrap.yml

@@ -0,0 +1,193 @@
+app:
+  name: gestor-backend
+  module: './dist/app.module.js'
+  version: 1.0.0
+  port: 3002
+  prefix: ''
+
+swagger:
+  title: 'GestorCMS Backend API'
+  description: 'The Authentication API description (versión MySQL)'
+  version: '1.0'
+  prefix: 'swagger'
+
+firebase:
+  storageBucket: ${FIREBASE_STORAGE_BUCKET}
+  basePath: ${FIREBASE_BASE_PATH}
+  serviceAccount:
+    projectId: ${FIREBASE_PROJECT_ID}
+    privateKey: '${FIREBASE_PRIVATE_KEY}'
+    clientEmail: ${FIREBASE_CLIENT_EMAIL}
+
+cors:
+  origin:
+    - 'http://localhost:3000'
+    - 'http://localhost:3001'
+    - 'http://localhost:4200'
+    - 'https://localhost:3000'
+    - 'https://localhost:3001'
+    - 'https://localhost:4200'
+    - 'https://admin-appmovil.uwiener.edu.pe'
+    - 'https://dev-admin-appmovil.uwiener.edu.pe'
+    - 'https://test-admin-appmovil.uwiener.edu.pe'
+    - 'https://gestor-cms.mantix.com.pe'
+  methods:
+    - 'GET'
+    - 'PATCH'
+    - 'POST'
+    - 'PUT'
+    - 'DELETE'
+    - 'OPTIONS'
+  allowedHeaders:
+    - 'Content-Type'
+    - 'Authorization'
+  exposedHeaders:
+    - 'X-API-KEY'
+  credentials: true
+  maxAge: 3600
+
+AMQP:
+  urls:
+    - 'amqp://MyRabbitUser:MyPassw0rdRMQ@localhost:5672'
+  queue: 'ms-accounts'
+  prefetchCount: 10
+  isGlobalPrefetchCount: false
+  noAck: false
+  queueOptions:
+    durable: true
+    arguments:
+      x-message-ttl: 60000
+      x-dead-letter-exchange: 'ms-accounts-dlx'
+      x-dead-letter-routing-key: 'ms-accounts-dlq'
+    persistent: true
+    exchange: 'exchange'
+    exchangeType: 'topic'
+    wildcards: true
+
+AMQPClients:
+  common:
+    urls:
+      - amqp://localhost:5672
+    queueOptions:
+      durable: true
+    noAck: false
+    persistent: true
+
+  clients:
+    ms-account:
+      queue: ms-account
+      prefetchCount: 20
+
+    ms-auth:
+      queue: ms-auth
+      prefetchCount: 10
+
+    ms-sse:
+      queue: ms-sse
+      prefetchCount: 5
+
+typeorm:
+  mysql:
+    type: mysql
+    host: ${TYPEORM_MYSQL_HOST}
+    port: ${TYPEORM_MYSQL_PORT}
+    database: ${TYPEORM_MYSQL_DATABASE}
+    username: ${TYPEORM_MYSQL_USERNAME}
+    password: ${TYPEORM_MYSQL_PASSWORD}
+    entities: ${TYPEORM_MYSQL_ENTITIES}
+    synchronize: ${TYPEORM_MYSQL_SYNCHRONIZE}
+    logging: ${TYPEORM_MYSQL_LOGGING}
+
+Jwt:
+  SecretKey: ${JWT_SECRETKEY}
+  SignOptions:
+    ExpiresIn: ${JWT_SIGNOPTIONS_EXPIRESIN}
+  RefreshOptions:
+    ExpiresIn: ${JWT_REFRESHOPTIONS_EXPIRESIN}
+
+httpServices:
+  niubizSecurity:
+    baseUrl: ${NIUBIZ_SECURITY_BASE_URL}
+  niubizSession:
+    baseUrl: ${NIUBIZ_SESSION_BASE_URL}
+  niubizCertificate:
+    baseUrl: ${NIUBIZ_CERTIFICATE_BASE_URL}
+  wienerService:
+    baseUrl: ${WIENER_SERVICE_BASE_URL}
+    # propagatedHeaders:
+    #   - Authorization
+    #   - X-Request-Id
+    # headers:
+    #   name: ms-wiener
+    retryOptions:
+      maxRetries: 3
+      baseDelayMs: 1000
+    credentials:
+      typeId: ${WIENER_SERVICE_CREDENTIALS_TYPEID}
+      username: ${WIENER_SERVICE_CREDENTIALS_USERNAME}
+      password: ${WIENER_SERVICE_CREDENTIALS_PASSWORD}
+  userService:
+    baseUrl: 'https://api.com'
+    propagatedHeaders:
+      - Authorization
+      - X-Request-Id
+    headers:
+      name: ms-user
+  paymentService:
+    baseUrl: 'https://pay.com'
+    propagatedHeaders:
+      - Authorization
+      - X-Correlation-Id
+    headers:
+      name: ms-payment
+
+logger:
+  http:
+    # host: http://localhost:5044
+
+# Enable Entity Logs
+entityLogs:
+  insertEnabled: false
+  updateEnabled: false
+  removeEnabled: false
+
+# Global Pipes Configuration
+validationPipe:
+  transform: true
+  whitelist: true
+  transformOptions:
+    enableImplicitConversion: true
+# parseIntPipe:
+#   errorHttpStatusCode: 422
+
+# parseArrayPipe:
+#   items: Number
+#   separator: ','
+
+staticAssets:
+  path: '/public'
+
+teams:
+  lengthResetPassword: 6
+
+niubiz:
+  security:
+    url: ${NIUBIZ_SECURITY_BASE_URL}
+    path: ${NIUBIZ_SECURITY_BASE_PATH}
+  session:
+    url: ${NIUBIZ_SESSION_BASE_URL}
+    path: ${NIUBIZ_SESSION_BASE_PATH}
+  certificate:
+    url: ${NIUBIZ_CERTIFICATE_BASE_URL}
+    path: ${NIUBIZ_CERTIFICATE_BASE_PATH}
+  purchaseNumberLength: ${NIUBIZ_PURCHASE_NUMBER_LENGTH}
+  merchants:
+    - id: ${NIUBIZ_MERCHANTID01}
+      user: ${NIUBIZ_USER01}
+      password: ${NIUBIZ_PASSWORD01}
+    - id: ${NIUBIZ_MERCHANTID02}
+      user: ${NIUBIZ_USER02}
+      password: ${NIUBIZ_PASSWORD02}
+    - id: ${NIUBIZ_MERCHANTID03}
+      user: ${NIUBIZ_USER03}
+      password: ${NIUBIZ_PASSWORD03}

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      "prettier/prettier": ["error", { endOfLine: "auto" }],
+    },
+  },
+);

package/libs/ms-sophia-framework-mysql/src/app.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common'
+import { ConfigModule } from './core/config/config.module'
+import { DatabaseModule } from './core/database/database.module'
+import { LoggerModule } from './core/logger/logger.module'
+import { Logger } from './core/logger/logger'
+// import { HealthController } from './core/health/health.controller'
+import { HealthModule } from './core/health/health.module'
+
+@Module({
+  imports: [ConfigModule, DatabaseModule, LoggerModule, HealthModule],
+  providers: [Logger],
+  exports: [Logger],
+})
+export class AppModule {}

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-clients.module.ts

@@ -0,0 +1,43 @@
+import { DynamicModule, Module, Provider } from '@nestjs/common'
+import { ClientProxyFactory, Transport } from '@nestjs/microservices'
+import { AmqpRegisterOptions } from './amqp-register.options'
+import { AmqpConfig } from './amqp-config'
+
+@Module({})
+export class AmqpClientsModule {
+  static register(options: AmqpRegisterOptions): DynamicModule {
+    const root = 'AMQPClients'
+
+    const providers: Provider[] = options.clientTokens.map((token) => ({
+      provide: token,
+      inject: [options.configServiceToken],
+      useFactory: (config: AmqpConfig) => {
+        // Regla interna: MS_ACCOUNTS -> ms-accounts
+        const clientKey = token.toLowerCase().replace(/^ms_/, 'ms-').replace(/_/g, '-')
+
+        const common = config.get<Record<string, any>>(`${root}.common`) ?? {}
+        const client = config.get<Record<string, any>>(`${root}.clients.${clientKey}`) ?? {}
+
+        return ClientProxyFactory.create({
+          transport: Transport.RMQ,
+          options: {
+            urls: client.urls ?? common.urls,
+            queue: client.queue ?? clientKey,
+            queueOptions: client.queueOptions ?? common.queueOptions,
+            noAck: client.noAck ?? common.noAck,
+            prefetchCount: client.prefetchCount ?? common.prefetchCount,
+            isGlobalPrefetchCount:
+              client.isGlobalPrefetchCount ?? common.isGlobalPrefetchCount,
+            persistent: client.persistent ?? common.persistent,
+          },
+        })
+      },
+    }))
+
+    return {
+      module: AmqpClientsModule,
+      providers,
+      exports: providers,
+    }
+  }
+}

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-clients.ts

@@ -0,0 +1,22 @@
+export const AmqpClients = {
+  MS_ACCOUNTS: 'MS_ACCOUNTS',   // Accounts, Usuarios, Roles, Permisos
+  MS_AUTH: 'MS_AUTH',         // Autenticación, JWT, OAuth
+  MS_MENUS: 'MS_MENUS',         // Menús, Submenús, Permisos de menú
+  MS_SEND_EMAILS: 'MS_SEND_EMAILS', // Envío de correos electrónicos
+  MS_SEND_NOTIFICATIONS: 'MS_SEND_NOTIFICATIONS', // Envío de notificaciones
+  MS_SSE: 'MS_SSE', // Server-Sent Events
+
+  MS_CORE: 'MS_CORE', // Core de negocio (Sistema simple de gestión empresarial)
+
+  MS_CUSTOMER: 'MS_CUSTOMER', // Clientes
+  MS_SALES_ORDERS: 'MS_SALES_ORDERS', // Pedidos
+  MS_SALES_DOCUMENTS: 'MS_SALES_DOCUMENTS', // Comprobantes de ventas
+  MS_ACCOUNTS_RECEIVABLE: 'MS_ACCOUNTS_RECEIVABLE', // Cuentas por cobrar
+  
+  MS_SUPPLIERS: 'MS_SUPPLIERS', // Proveedores
+  MS_PURCHASE_ORDERS: 'MS_PURCHASE_ORDERS', // Pedidos
+  MS_PURCHASE_DOCUMENTS: 'MS_PURCHASE_DOCUMENTS', // Comprobantes de compras
+  MS_ACCOUNTS_PAYABLE: 'MS_ACCOUNTS_PAYABLE', // Cuentas por pagar
+
+  MS_ACCOUNTING: 'MS_ACCOUNTING', // Contabilidad
+} as const

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-config.ts

@@ -0,0 +1,3 @@
+export type AmqpConfig = {
+  get<T = unknown>(key: string): T | undefined
+}

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-pattern.ts

@@ -0,0 +1,61 @@
+export class AmqpPattern {
+	microservice: string = '';
+	module: string = '';
+	action: string = '';
+}
+
+export class MsAccountPattern extends AmqpPattern {
+	constructor(module: string, action: string) {
+		super();
+		this.microservice = 'ms-account'
+		this.module = module
+		this.action = action
+	}
+}
+
+export class MsAuthPattern extends AmqpPattern {
+	constructor(module: string, action: string) {
+		super();
+		this.microservice = 'ms-auth'
+		this.module = module
+		this.action = action
+	}
+}
+
+export class MsSsePattern extends AmqpPattern {
+	constructor(module: string, action: string) {
+		super();
+		this.microservice = 'ms-sse'
+		this.module = module
+		this.action = action
+	}
+}
+
+export class MsSendEmailsPattern extends AmqpPattern {
+	constructor(module: string, action: string) {
+		super();
+		this.microservice = 'ms-send-emails'
+		this.module = module
+		this.action = action
+	}
+}
+
+export class MsSendNotificationsPattern extends AmqpPattern {
+	constructor(module: string, action: string) {
+		super();
+		this.microservice = 'ms-send-notifications'
+		this.module = module
+		this.action = action
+	}
+}
+// https://portal-backend.mantix.com.pe/api/account/Xxxx								ms-account
+// https://portal-backend.mantix.com.pe/api/auth/Xxxx									ms-auth
+// https://portal-backend.mantix.com.pe/api/sse/Xxxx										ms-sse
+// https://portal-backend.mantix.com.pe/api/send-emails/Xxxx						ms-send-emails
+// https://portal-backend.mantix.com.pe/api/send-notifications/Xxxx		ms-send-notifications
+
+// Microservices Core
+// ms-customer
+// ms-billing
+// ms-supply
+// ms-menu

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-register.options.ts

@@ -0,0 +1,6 @@
+import { InjectionToken } from '@nestjs/common'
+
+export type AmqpRegisterOptions = {
+  clientTokens: string[]
+  configServiceToken: InjectionToken
+}

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-sample.module.ts

@@ -0,0 +1,20 @@
+import { Module } from '@nestjs/common'
+import { AmqpClientsModule } from './amqp-clients.module'
+import { AmqpClients } from './amqp-clients'
+import { ConfigService } from '../config'
+
+@Module({
+  imports: [
+    AmqpClientsModule.register({
+      clientTokens: [
+        AmqpClients.MS_ACCOUNTS, 
+        AmqpClients.MS_AUTH, 
+        AmqpClients.MS_SSE,
+        AmqpClients.MS_SEND_EMAILS,
+        AmqpClients.MS_SEND_NOTIFICATIONS,
+      ],
+      configServiceToken: ConfigService,
+    }),
+  ],
+})
+export class MessagingModule {}

package/libs/ms-sophia-framework-mysql/src/core/amqp-clients/amqp-sample.service.ts

@@ -0,0 +1,34 @@
+import { Inject, Injectable } from '@nestjs/common'
+import { ClientProxy } from '@nestjs/microservices'
+import { firstValueFrom } from 'rxjs'
+import { AmqpClients } from './amqp-clients';
+import { MsAccountPattern, MsAuthPattern, MsSsePattern } from './amqp-pattern';
+
+@Injectable()
+export class AmqpSampleService {
+  constructor(
+    @Inject(AmqpClients.MS_ACCOUNTS)
+    private readonly msAccountClient: ClientProxy,
+
+    @Inject(AmqpClients.MS_AUTH)
+    private readonly msAuthClient: ClientProxy,
+
+    @Inject(AmqpClients.MS_SSE)
+    private readonly msSseClient: ClientProxy,
+  ) {}
+
+  async emitAccountCreated(payload: any) {
+    const pattern = new MsAccountPattern('account', 'created')
+    await firstValueFrom(this.msAccountClient.emit(pattern, payload))
+  }
+
+  async sendValidateToken(payload: any) {
+    const pattern = new MsAuthPattern('auth', 'validate-token')
+    return await firstValueFrom(this.msAuthClient.send(pattern, payload))
+  }
+
+  async emitSseNotification(payload: any) {
+    const pattern = new MsSsePattern('sse', 'notify')
+    await firstValueFrom(this.msSseClient.emit(pattern, payload))
+  }
+}

package/libs/ms-sophia-framework-mysql/src/core/common/base/error.ts

@@ -0,0 +1,5 @@
+export class Error {
+  loggerId: string
+  statusCode: number
+  message: string
+}

package/libs/ms-sophia-framework-mysql/src/core/common/base/result.ts

@@ -0,0 +1,15 @@
+import { Error } from './error';
+import { PaginationDto } from '../dto/pagination.dto';
+
+export class Result<T> {
+  entity: T | null | undefined;
+  entities: T[] | null | undefined;
+  hasError: boolean = false;
+  errors: Error[] | null = null;
+  pagination: PaginationDto | undefined;
+  addError(loggerId: string, statusCode: number, message: string) {
+    this.hasError = true;
+    this.errors ??= [];
+    this.errors.push({ loggerId, statusCode, message });
+  }
+}

package/libs/ms-sophia-framework-mysql/src/core/common/base/status-base.ts

@@ -0,0 +1,12 @@
+import { Column, Entity } from "typeorm";
+
+export class StatusBase {
+  @Column({ name: 'status_id', type: 'int', default: 1 })
+  statusId: number;
+
+  @Column({ name: 'reason_status', type: 'varchar', length: 128, nullable: true, default: 'Add record' })
+  reasonStatus: string;
+
+  @Column({ name: 'date_status', type: 'timestamp', nullable: true, default: () => 'CURRENT_TIMESTAMP' })
+  dateStatus: Date;
+}

package/libs/ms-sophia-framework-mysql/src/core/common/dto/change-status.dto.ts

@@ -0,0 +1,13 @@
+import { IsInt, IsNotEmpty, IsString } from "class-validator"
+
+export class ChangeStatusDto {
+  @IsInt()
+  @IsNotEmpty()
+  fromStatusId: number
+  @IsInt()
+  @IsNotEmpty()
+  toStatusId: number
+  @IsString()
+  @IsNotEmpty()
+  reasonStatus: string
+}

package/libs/ms-sophia-framework-mysql/src/core/common/dto/log.dto.ts

@@ -0,0 +1,29 @@
+export class LogDto {
+  entity: string
+  primaryKeyGuid: string
+  primaryKeyNumber: number
+  action: string
+  reason: string
+  typeId: number
+  userId: string
+  roleId: number
+  bossId: string
+  statusId: number
+
+  get primaryKey(): string | number {
+    if (this.primaryKeyGuid === null) {
+      return this.primaryKeyNumber
+    } else {
+      return this.primaryKeyGuid
+    }
+  }
+
+  set primaryKey(value: string | number) {
+    if (typeof value === 'string') {
+      this.primaryKeyGuid = value
+    }
+    if (typeof value === 'number') {
+      this.primaryKeyNumber = value
+    }
+  }
+}

package/libs/ms-sophia-framework-mysql/src/core/common/dto/order-by.dto.ts

@@ -0,0 +1,9 @@
+import { IsIn, IsString } from 'class-validator';
+
+export class OrderByDto {
+  @IsString()
+  orderBy: string;
+  @IsString()
+  @IsIn(['ASC', 'DESC'])
+  orderSort: 'ASC' | 'DESC';
+}

package/libs/ms-sophia-framework-mysql/src/core/common/dto/pagination.dto.ts

@@ -0,0 +1,10 @@
+import { IsNumber } from 'class-validator';
+
+export class PaginationDto {
+  @IsNumber()
+  page: number;
+  @IsNumber()
+  pageSize: number;
+  @IsNumber()
+  totalPages: number;
+}

package/libs/ms-sophia-framework-mysql/src/core/common/dto/search.dto.ts

@@ -0,0 +1,8 @@
+import { IsString } from "class-validator";
+
+export class SearchDto {
+  @IsString()
+  text: string;
+  @IsString({ each: true })
+  properties: string[];
+}

package/libs/ms-sophia-framework-mysql/src/core/common/dto/select.dto.ts

@@ -0,0 +1,23 @@
+import { Type } from 'class-transformer';
+import { OrderByDto } from './order-by.dto';
+import { PaginationDto } from './pagination.dto';
+import { IsOptional } from 'class-validator';
+import { SearchDto } from './search.dto';
+
+export class SelectDto<T> {
+  @IsOptional()
+  @Type(() => SearchDto)
+  search: SearchDto;
+
+  @IsOptional()
+  @Type(() => Object)
+  where: T;
+
+  @IsOptional()
+  @Type(() => OrderByDto)
+  orderBy: OrderByDto[];
+
+  @IsOptional()
+  @Type(() => PaginationDto)
+  pagination: PaginationDto;
+}

package/libs/ms-sophia-framework-mysql/src/core/common/entity/base.entity.ts

@@ -0,0 +1,16 @@
+import { Column } from "typeorm";
+import { LogDto } from "..";
+
+export class BaseEntity {
+  // @Column({ type: 'int', update: false, select: false, insert: false })
+  log: LogDto
+  
+  @Column({ type: 'int', default: 1, nullable: false })
+  statusId: number;
+
+  @Column({ type: 'varchar', length: 128, nullable: false, default: 'Add record' })
+  reasonStatus: string;
+
+  @Column({ type: 'timestamp', nullable: false, default: () => 'CURRENT_TIMESTAMP' })
+  dateStatus: Date;
+}

package/libs/ms-sophia-framework-mysql/src/core/common/exceptions/app-badrequest.exception.ts

@@ -0,0 +1,31 @@
+import { BadRequestException, HttpStatus, Logger } from '@nestjs/common';
+// import { nanoid } from 'src/core/tools';
+import { BadRequestResult } from '../result/bad-request.result';
+import { nanoid } from '../../tools';
+
+export class AppBadRequestException extends BadRequestException {
+  constructor(message: string) {
+    super(message);
+  }
+
+  getResponse(): BadRequestResult {
+    const response = super.getResponse();
+    const loggerId = nanoid();
+    if (typeof response === 'string') {
+      Logger.log(`[${loggerId}]: ${response}`, 'AppBadRequestException');
+      return {
+        message: response,
+        error: 'Bad Request',
+        statusCode: HttpStatus.BAD_REQUEST,
+        loggerId: loggerId,
+      } as BadRequestResult;
+    }
+    // @ts-ignore: This line is to ignore the TypeScript error in response.message and response.error
+    const message = response.message ?? response.error;
+    Logger.log(`[${loggerId}]: ${message}`, 'AppBadRequestException');
+    return {
+      ...response,
+      loggerId: loggerId,
+    } as BadRequestResult;
+  }
+}