lib-common-angular 0.0.9 → 0.0.11

package/lib-core-dtos/.github/workflows/validate-raml.yml

@@ -0,0 +1,58 @@
+name: Validate RAML Files
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+jobs:
+  validate-raml:
+    name: RAML Validation
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+        
+    - name: Install dependencies
+      run: npm install
+        
+    - name: Run RAML validation
+      run: |
+        echo "🔍 Validating RAML files with custom script..."
+        npm run validate:raml
+        
+    - name: Check for syntax issues
+      run: |
+        echo "🔍 Checking for common syntax issues..."
+        # Verificar tabs vs espacios
+        if grep -r $'\t' --include="*.raml" .; then
+          echo "❌ Found tabs in RAML files. Please use spaces for indentation."
+          exit 1
+        fi
+        
+        # Verificar cabeceras RAML
+        find . -name "*.raml" -not -path "./node_modules/*" | while read file; do
+          if ! head -n1 "$file" | grep -q "#%RAML"; then
+            echo "❌ Missing RAML header in: $file"
+            exit 1
+          fi
+        done
+        
+        echo "✅ Syntax checks passed"
+        
+    - name: Summary
+      if: always()
+      run: |
+        if [ ${{ job.status }} == 'success' ]; then
+          echo "✅ All RAML validations passed - Ready for merge!"
+        else
+          echo "❌ RAML validation failed - Merge blocked!"
+          exit 1
+        fi

package/lib-core-dtos/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package/lib-core-dtos/README.md

@@ -0,0 +1,2 @@
+# lib-core-dtos
+Libreria de raml para generar dtos en front y back

package/lib-core-dtos/api.raml

@@ -0,0 +1,63 @@
+#%RAML 1.0
+title: Core DTOs API
+version: v1
+
+types:
+  # Tipos mcs-usuarios-sp de usuarios
+  PhoneDTO: !include ./mcs-usuarios-Sp/users/phoneDTO.raml
+  KeycloakBuilderDTO: !include ./mcs-usuarios-Sp/users/keycloakBuilderDTO.raml
+  PropertyTypeDTO: !include ./mcs-usuarios-Sp/users/propertyTypeDTO.raml
+  CountryDTO: !include ./mcs-usuarios-Sp/users/countryDTO.raml
+  AddresDTO: !include ./mcs-usuarios-Sp/users/addresDTO.raml
+  DatesUserDTO: !include ./mcs-usuarios-Sp/users/datesUserDTO.raml
+  CityDTO: !include ./mcs-usuarios-Sp/users/cityDTO.raml
+  
+  # Tipos de request de usuarios
+  RegisterUserDTO: !include ./mcs-usuarios-Sp/request/registerUserDTO.raml
+  
+  # Tipos mcs-bussines-n negociocaca
+     # requests
+  CreateBusinessDTO: !include ./mcs-bussines-n/request/create.bussinesRq.DTO.raml
+  
+     # productos
+  CategoriaDTO: !include ./mcs-bussines-n/productos/categorias/categoriaDTO.raml
+  TipoCategoriaDTO: !include ./mcs-bussines-n/productos/categorias/tipoCategoriaDTO.raml
+  MonedaDTO: !include ./mcs-bussines-n/productos/monedaDTO.raml
+  ProductoDTO: !include ./mcs-bussines-n/productos/productoDTO.raml
+  CarritoDTO: !include ./mcs-bussines-n/productos/carrito/carritoDTO.raml
+  CarritoItemDTO: !include ./mcs-bussines-n/productos/carrito/carritoItemDTO.raml
+  PedidoDTO: !include ./mcs-bussines-n/productos/pedidoproductos/pedido.raml
+  PedidoProductoDTO: !include ./mcs-bussines-n/productos/pedidoproductos/pedidoProducto.raml
+     # bussines
+  ImagenDTO: !include ./mcs-bussines-n/bussines/imagenDTO.raml
+  SliderDTO: !include ./mcs-bussines-n/bussines/sliderDTO.raml
+  ColoresDTO: !include ./mcs-bussines-n/bussines/coloresDTO.raml
+  ModuloDTO: !include ./mcs-bussines-n/bussines/moduloDTO.raml
+  ComponentesDTO: !include ./mcs-bussines-n/bussines/componentesDTO.raml
+  ModulosComponentesDTO: !include ./mcs-bussines-n/bussines/modulosComponentesDTO.raml
+  MenuDTO: !include ./mcs-bussines-n/bussines/menuDTO.raml
+  BusinessModuleDTO: !include ./mcs-bussines-n/bussines/businessModuleDTO.raml
+  BusinessDTO: !include ./mcs-bussines-n/bussines/businessDTO.raml
+  PlantillaDTO: !include ./mcs-bussines-n/bussines/plantillaDTO.raml
+  TrabajosDTO: !include ./mcs-bussines-n/bussines/trabajosDTO.raml
+  DisingImagenDTO: !include ./mcs-bussines-n/bussines/dising-imagenDTO.raml
+  DisingDTO: !include ./mcs-bussines-n/bussines/disingDTO.raml
+  MediosPagosDTO: !include ./mcs-bussines-n/bussines/mediosPagosDTO.raml
+
+
+  
+  # Tipos de componentes common-lib-angular (importados desde la librería)
+  FieldType: !include ./componentes-common-lib-angular/tabla1/fieldType.DTO.raml
+  DynamicField: !include ./componentes-common-lib-angular/tabla1/dynamicField.DTO.raml
+  Column: !include ./componentes-common-lib-angular/tabla1/column.DTO.raml
+  ExcelExportConfig: !include ./componentes-common-lib-angular/tabla1/excelExportConfig.DTO.raml
+  ExportColumn: !include ./componentes-common-lib-angular/tabla1/exportColumn.raml
+
+ # menu
+  MenuEvent: !include ./componentes-common-lib-angular/Menu/menuEvent.raml
+  MenuConfig: !include ./componentes-common-lib-angular/Menu/menuConfig.raml
+  MenuItem: !include ./componentes-common-lib-angular/Menu/menuItem.raml
+
+
+  # auth
+    loginDTO: !include ./mcs-bussines-n/auth/loginDTO.raml

package/lib-core-dtos/componentes-common-lib-angular/Menu/menuConfig.raml

@@ -0,0 +1,83 @@
+#%RAML 1.0 DataType
+uses:
+  MenuItem: ./menuItem.raml
+
+type: object
+displayName: MenuConfig
+description: |
+  Configuración global para un sistema de menús.
+  Define la estructura, apariencia y comportamiento del menú completo.
+
+properties:
+  id:
+    type: string
+    required: true
+    description: Identificador único de la configuración del menú
+    example: "main-menu-config"
+  name:
+    type: string
+    required: true
+    description: Nombre descriptivo del menú
+    example: "Menú Principal"
+  items:
+    type: MenuItem[]
+    items: MenuItem
+    required: true
+    description: Lista de elementos que componen el menú
+  theme:
+    type: string
+    enum: ["light", "dark"]
+    required: false
+    description: Tema visual del menú
+    default: "light"
+    example: "dark"
+  orientation:
+    type: string
+    enum: ["horizontal", "vertical"]
+    required: false
+    description: Orientación del menú
+    default: "vertical"
+    example: "horizontal"
+  collapsed:
+    type: boolean
+    required: false
+    description: Si el menú está colapsado inicialmente
+    default: false
+  collapsible:
+    type: boolean
+    required: false
+    description: Si el menú puede ser colapsado por el usuario
+    default: true
+  showIcons:
+    type: boolean
+    required: false
+    description: Si se muestran los iconos de los elementos
+    default: true
+  showBadges:
+    type: boolean
+    required: false
+    description: Si se muestran las badges de los elementos
+    default: true
+  maxDepth:
+    type: number
+    required: false
+    description: Profundidad máxima de anidamiento permitida
+    example: 3
+
+example:
+  id: "dashboard-menu-config"
+  name: "Dashboard Navigation"
+  items:
+    - id: "home"
+      label: "Inicio"
+      icon: "pi pi-home"
+      routerLink: ["/", "home"]
+      type: "item"
+      order: 1
+  theme: "light"
+  orientation: "vertical"
+  collapsed: false
+  collapsible: true
+  showIcons: true
+  showBadges: true
+  maxDepth: 2

package/lib-core-dtos/componentes-common-lib-angular/Menu/menuEvent.raml

@@ -0,0 +1,42 @@
+#%RAML 1.0 DataType
+uses:
+  MenuItem: ./menuItem.raml
+
+type: object
+displayName: MenuEvent
+description: |
+  Evento que se dispara cuando ocurre una interacción con un elemento del menú.
+  Contiene información sobre el tipo de evento, el elemento afectado y metadatos adicionales.
+
+properties:
+  type:
+    type: string
+    enum: ["click", "hover", "expand", "collapse"]
+    required: true
+    description: Tipo de evento que ocurrió en el menú
+    example: "click"
+  item:
+    type: MenuItem
+    required: true
+    description: Elemento del menú que disparó el evento
+  event:
+    type: event
+    required: false
+    description: Objeto Event nativo del navegador
+  timestamp:
+    type: datetime
+    required: false
+    description: Fecha y hora cuando ocurrió el evento
+    format: "yyyy/MM/dd HH:mm"
+    example: "2024/01/15 10:30"
+
+example:
+  type: "click"
+  item:
+    id: "dashboard-menu"
+    label: "Dashboard"
+    icon: "pi pi-home"
+    routerLink: ["/", "dashboard"]
+    type: "item"
+    order: 1
+  timestamp: "2024/01/15 10:30"

package/lib-core-dtos/componentes-common-lib-angular/Menu/menuItem.raml

@@ -0,0 +1,107 @@
+#%RAML 1.0 DataType
+
+type: object
+displayName: MenuItem
+description: |
+  Interfaz para un elemento de menú individual del sistema.
+  Soporta elementos anidados, separadores y configuración de permisos.
+
+properties:
+  id:
+    type: string
+    required: true
+    description: Identificador único del elemento del menú
+    example: "dashboard-menu"
+  label:
+    type: string
+    required: true
+    description: Etiqueta visible del elemento del menú
+    example: "Dashboard"
+  icon:
+    type: string
+    required: false
+    description: Icono del elemento del menú
+    example: "pi pi-home"
+  routerLink:
+    type: array
+    items: string
+    required: false
+    description: Ruta de navegación como array
+    example: ["/", "dashboard"]
+  url:
+    type: string
+    required: false
+    description: URL externa del elemento
+    example: "https://example.com"
+  target:
+    type: string
+    enum: ["_blank", "_self", "_parent", "_top"]
+    required: false
+    description: Target para la navegación
+    default: "_self"
+  disabled:
+    type: boolean
+    required: false
+    description: Si el elemento está deshabilitado
+    default: false
+  visible:
+    type: boolean
+    required: false
+    description: Si el elemento es visible
+    default: true
+  badge:
+    type: string
+    required: false
+    description: Texto del badge del elemento
+    example: "3"
+  badgeClass:
+    type: string
+    required: false
+    description: Clase CSS del badge
+    example: "p-badge-danger"
+  class:
+    type: string
+    required: false
+    description: Clase CSS del elemento
+    example: "menu-item-custom"
+  style:
+    type: string
+    required: false
+    description: Estilos inline del elemento
+    example: "color: red;"
+  separator:
+    type: boolean
+    required: false
+    description: Si el elemento es un separador
+    default: false
+  type:
+    type: string
+    enum: ["item", "separator", "group"]
+    required: true
+    description: Tipo del elemento del menú
+    example: "item"
+  items:
+    type: array
+    items: MenuItem
+    required: false
+    description: Elementos hijos del menú (para menús anidados)
+  order:
+    type: number
+    required: false
+    description: Orden de visualización del elemento
+    example: 1
+  permissions:
+    type: array
+    items: string
+    required: false
+    description: Permisos requeridos para mostrar el elemento
+    example: ["admin", "user"]
+
+example:
+  id: "dashboard-menu"
+  label: "Dashboard"
+  icon: "pi pi-home"
+  routerLink: ["/", "dashboard"]
+  type: "item"
+  order: 1
+  permissions: ["user"]

package/lib-core-dtos/componentes-common-lib-angular/tabla1/column.DTO.raml

@@ -0,0 +1,48 @@
+#%RAML 1.0 DataType
+
+type: object
+displayName: Column
+description: |
+  Configuración de columna para componentes de tabla.
+  Define las propiedades de visualización y comportamiento de cada columna.
+
+properties:
+  field:
+    type: string
+    required: true
+    description: Nombre del campo que representa la columna
+    example: "name"
+  header:
+    type: string
+    required: true
+    description: Texto del encabezado de la columna
+    example: "Nombre"
+  sortable:
+    type: boolean
+    required: false
+    description: Si la columna es ordenable
+    default: true
+  filterable:
+    type: boolean
+    required: false
+    description: Si la columna es filtrable
+    default: true
+  width:
+    type: string
+    required: false
+    description: Ancho de la columna
+    example: "200px"
+  align:
+    type: string
+    enum: [left, center, right]
+    required: false
+    description: Alineación del contenido
+    default: "left"
+
+example:
+  field: "name"
+  header: "Nombre"
+  sortable: true
+  filterable: true
+  width: "200px"
+  align: "left"

package/lib-core-dtos/componentes-common-lib-angular/tabla1/dynamicField.DTO.raml

@@ -0,0 +1,54 @@
+#%RAML 1.0 DataType
+
+type: object
+displayName: DynamicField
+description: DTO para definir un campo dinámico en formularios y tablas
+properties:
+  key:
+    type: string
+    required: true
+    description: Clave del campo en el objeto
+    example: "name"
+  type:
+    type: string
+    required: true
+    description: Tipo de renderizado del campo
+    enum:
+      - img
+      - checkbox  
+      - number
+      - text
+      - select
+    example: "text"
+  label:
+    type: string
+    required: true
+    description: Etiqueta para mostrar al usuario
+    example: "Nombre del Usuario"
+  value:
+    type: any
+    required: true
+    description: Valor del campo
+    example: "Juan Pérez"
+  order:
+    type: integer
+    required: false
+    description: Orden de visualización
+    example: 1
+  accept:
+    type: string
+    required: false
+    description: Tipos de archivo aceptados (para type 'file')
+    example: "image/*"
+  maxFileSize:
+    type: integer
+    required: false
+    description: Tamaño máximo en bytes (para type 'file')
+    example: 2097152
+
+example:
+  key: "email"
+  type: "text"
+  label: "Correo Electrónico"
+  value: "usuario@ejemplo.com"
+  order: 2

package/lib-core-dtos/componentes-common-lib-angular/tabla1/excelExportConfig.DTO.raml

@@ -0,0 +1,58 @@
+#%RAML 1.0 DataType
+
+type: object
+displayName: ExcelExportConfig
+description: DTO de configuración para exportación a Excel
+
+properties:
+  data:
+    type: array
+    items: any
+    required: true
+    description: Array de objetos con los datos a exportar (Record<string, unknown>[])
+    example:
+      - name: "Producto 1"
+        price: 99.99
+        category: "Tech"
+      - name: "Producto 2"
+        price: 149.99
+        category: "Electronics"
+  fieldOrder:
+    type: array
+    items: string
+    required: true
+    description: Orden de los campos en la exportación
+    example: ["name", "category", "price"]
+  fieldLabels:
+    type: any
+    required: true
+    description: Etiquetas personalizadas para los campos (Record<string, string>)
+    example:
+      name: "Nombre del Producto"
+      price: "Precio ($)"
+      category: "Categoría"
+  excludeFields:
+    type: array
+    items: string
+    required: true
+    description: Campos a excluir de la exportación
+    example: ["id", "internalNotes"]
+  fileName:
+    type: string
+    required: false
+    description: Nombre personalizado del archivo (sin extensión)
+    example: "reporte_productos"
+
+example:
+  data:
+    - name: "Laptop Dell"
+      price: 799.99
+      category: "Computers"
+      id: "prod-001"
+  fieldOrder: ["name", "category", "price"]
+  fieldLabels:
+    name: "Nombre del Producto"
+    category: "Categoría"
+    price: "Precio (USD)"
+  excludeFields: ["id"]
+  fileName: "catalogo_productos"

package/lib-core-dtos/componentes-common-lib-angular/tabla1/exportColumn.raml

@@ -0,0 +1,23 @@
+#%RAML 1.0 DataType
+
+type: object
+displayName: ExportColumn
+description: |
+  Configuración de columna para exportación de datos.
+  Define cómo se debe mapear y mostrar una columna en los archivos exportados.
+
+properties:
+  title:
+    type: string
+    required: true
+    description: Título de la columna que aparecerá en el archivo exportado
+    example: "Nombre del Producto"
+  dataKey:
+    type: string
+    required: true
+    description: Clave del campo en el objeto de datos que se va a exportar
+    example: "productName"
+
+example:
+  title: "Precio (USD)"
+  dataKey: "price"

package/lib-core-dtos/componentes-common-lib-angular/tabla1/fieldType.DTO.raml

@@ -0,0 +1,20 @@
+#%RAML 1.0 DataType
+
+type: string
+displayName: FieldType
+description: |
+  Tipos de campo soportados para renderizado dinámico en componentes de tabla.
+  Cada tipo define cómo se renderiza y comporta el campo en la interfaz.
+enum:
+  - img       # Campo de imagen
+  - checkbox  # Campo de selección booleana
+  - number    # Campo numérico
+  - text      # Campo de texto simple
+  - select    # Campo de selección desplegable
+
+examples:
+  textoSimple: "text"
+  campoNumerico: "number" 
+  seleccionMultiple: "select"
+  imagenPerfil: "img"
+  activoInactivo: "checkbox"

package/lib-core-dtos/mcs-bussines-n/auth/loginDTO.raml

@@ -0,0 +1,11 @@
+#%RAML 1.0 DataType
+type: object
+properties:
+  email:
+    type: string
+    required: true
+    example: "usuario@example.com"
+  password:
+    type: string
+    required: true
+    example: "MiPassword123"

package/lib-core-dtos/mcs-bussines-n/bussines/businessDTO.raml

@@ -0,0 +1,102 @@
+#%RAML 1.0 DataType
+uses: 
+    BusinessModuleDTO:  ./businessModuleDTO.raml
+    ProductoDTO: ./productos/productoDTO.raml
+type: object
+properties:
+  idBussines:
+    type: integer
+    required: false
+    description: Identificador del negocio asociado
+    example: 101
+  nombreNegocio:
+    type: string
+    required: false
+    description: Nombre del negocio
+    example: "Mi Negocio"
+  numeroIdentificacionNegocio:
+    type: string
+    required: false
+    description: Número de identificación del negocio
+    example: "123456789"
+  codigoPais:
+    type: string
+    required: false
+    description: Código del país asociado al negocio
+    example: "57"
+  colores:
+    type: ColorsDTO
+    required: false
+    description: Colores asociados al negocio
+  logo:
+    type: string
+    required: false
+    description: URL del logo del negocio
+    example: "https://mi-negocio.com/logo.png"
+  keyWords:
+    type: array
+    items: string
+    required: false
+    description: Palabras clave asociadas al negocio
+    example: ["venta de ropa", "moda", "accesorios para mujeres"]
+  descripcion:
+    type: string
+    required: false
+    description: Descripción del negocio
+    example: "Este es un negocio dedicado a la venta de productos de alta calidad."
+  urlWhatssapp:
+    type: string
+    required: false
+    description: URL de WhatsApp del negocio
+    example: "https://wa.me/573001234567"
+  email:
+    type: string
+    required: false
+    description: Correo electrónico del negocio
+    example: "contacto@mi-negocio.com"
+  direccion:
+    type: string
+    required: false
+    description: Dirección del negocio
+    example: "Calle 123, Ciudad, País"
+  lenguaje:
+    type: string
+    required: false
+    description: Lenguaje principal del negocio
+    example: "es"
+  businessModule:
+    type: BusinessModuleDTO[]
+    items: BusinessModuleDTO
+    required: true
+    description: Lista de módulos asociados al negocio
+  productos:
+    type: ProductoDTO[]
+    items: ProductoDTO
+    required: false
+    description: Lista de productos asociados al negocio
+  telefono:
+    type: string
+    required: true
+    description: Número de teléfono del negocio. Debe ser un número válido de Colombia, Ecuador, Portugal, España o Alemania
+    example: "+573001234567"
+
+example:
+  idBussines: 101
+  nombreNegocio: "Mi Negocio"
+  numeroIdentificacionNegocio: "123456789"
+  codigoPais: "57"
+  colores:
+    primaryColor: "#FF5733"
+    secundaryColor: "#33FF57"
+    backgroundColor: "#FFFFFF"
+    textColor: "#000000"
+  logo: "https://mi-negocio.com/logo.png"
+  keyWords: ["venta de ropa", "moda", "accesorios para mujeres"]
+  descripcion: "Este es un negocio dedicado a la venta de productos de alta calidad."
+  urlWhatssapp: "https://wa.me/573001234567"
+  email: "contacto@mi-negocio.com"
+  direccion: "Calle 123, Ciudad, País"
+  lenguaje: "es"
+  businessModule: []
+  productos: []
+  telefono: "+573001234567"