sigo-entities 1.2.389 → 1.2.390

package/.ai_context.md

@@ -0,0 +1,50 @@
+# Contexto del Proyecto
+
+**Nombre:** Ingeniero Brayan Valero
+**Preferencias de idioma:** Español (Indispensable)
+**Formato de Planes y Tareas:** Siempre en Español
+**Contexto del proyecto:** Librería transversal para entidades compartidas (Front y Back)
+**Nombre del Asistente:** Latas
+
+**Tipo de Proyecto:** Shared Library
+**Ubicación Raíz:** `d:\16_SIGO_ENTITYS\sigo-entities`
+
+Este archivo contiene la visión general del proyecto `sigo-entities`.
+
+## Descripción
+`sigo-entities` es la librería donde se alojan las entidades compartidas por front y back. En ambos hay un archivo de contexto llamado `.ai_context.md`, donde almacenamos la configuración del proyecto, estructura del mismo y contexto de workflows para tareas futuras.
+
+## Normas Generales
+1.  **Archivos de Contexto**: Mantener actualizados los `.ai_context.md` locales.
+2.  **Git Ignore**: Asegurarse de que `**/.ai_context.md` esté ignorado.
+3.  **sigo-entities**: Librería transversal para tipos compartidos.
+
+## Guía de Desarrollo de Entidades y DTOs
+
+### Estructura de Carpetas
+- **DTOs compartidos**: `src/programados/procesos/[Entidad]/shared`
+- **Request DTOs**: `src/programados/procesos/[Entidad]/shared/requestDto`
+
+### Convenciones de Nombres
+- **Archivos**: `kebab-case` con sufijo `-dto.ts` (ej. `job-macro-request-dto.ts`).
+- **Clases**: `PascalCase` con sufijo `DTO` (ej. `JobMacroRequestDTO`).
+
+### Reglas de Implementación
+1.  **Librerías**: Usar `class-transformer` (@Expose, @Type) y `class-validator` (IsString, IsNumber, etc.).
+2.  **Mensajes de Validación**: Deben ser en español (ej. "debe ser un texto", "es requerido").
+3.  **Inicialización**: Todas las propiedades deben tener valor inicial (ej. `string = ''`, `number = 0`).
+4.  **Exposición**: Decorar todas las propiedades con `@Expose()`.
+
+## Proceso de Despliegue (sigo-entities)
+
+1.  **Validación**: Confirmar que la nueva entidad o DTO es correcto y cumple con las normas (preguntar al usuario).
+    - *Aprendizaje*: No incluir campos como `UsuarioEdicion` si el backend puede obtenerlos del token. Los DTOs de actualización deben ser lo más minimalistas posible (ID, nuevos valores, observaciones).
+2.  **Sincronización Inicial**: Bajar cambios (`git pull`) y subir cambios de la nueva entidad (`git push`).
+3.  **Versionamiento**: Incrementar la versión en el `package.json` (ej: `1.2.205` -> `1.2.206`).
+4.  **Sincronización de Versión**: Bajar y subir cambios nuevamente para asegurar la versión en el repositorio.
+5.  **Publicación**: Ejecutar `npm publish`.
+6.  **Actualización en Servicios**:
+    -   Posicionarse en el servicio (Back/Front) objetivo mediante el comando `cd`.
+    -   Ejecutar `npm i sigo-entities@latest`.
+    -   Verificar importaciones.
+    - *Aprendizaje*: Los DTOs de procesos deben exportarse desde el `index.ts` principal de la entidad (ej. `obra/index.ts`) y no solo desde el `shared/index.ts`.

package/dist/index.d.mts

@@ -9494,6 +9494,7 @@ declare class CountryEntity extends BaseEntity {
 }
 
 declare enum CompanyType {
+    OPERATIVA = "Operativa",
     PROVEEDOR = "Proveedor"
 }
 

package/dist/index.d.ts

@@ -9494,6 +9494,7 @@ declare class CountryEntity extends BaseEntity {
 }
 
 declare enum CompanyType {
+    OPERATIVA = "Operativa",
     PROVEEDOR = "Proveedor"
 }
 

package/dist/index.js

@@ -50392,6 +50392,7 @@ __decorateClass([
 
 // src/v2/enums/CompanyType.ts
 var CompanyType = /* @__PURE__ */ ((CompanyType2) => {
+  CompanyType2["OPERATIVA"] = "Operativa";
   CompanyType2["PROVEEDOR"] = "Proveedor";
   return CompanyType2;
 })(CompanyType || {});

package/dist/index.mjs

@@ -49910,6 +49910,7 @@ __decorateClass([
 
 // src/v2/enums/CompanyType.ts
 var CompanyType = /* @__PURE__ */ ((CompanyType2) => {
+  CompanyType2["OPERATIVA"] = "Operativa";
   CompanyType2["PROVEEDOR"] = "Proveedor";
   return CompanyType2;
 })(CompanyType || {});

package/functionGenerateDto.ts

@@ -1,169 +1,169 @@
-import * as fs from 'fs';
-import { ClassDeclaration, Project, PropertyDeclaration } from 'ts-morph'
-
-/**
- * Obtiene todas las propiedades de una clase, incluyendo las heredadas de otros archivos.
- */
-function getAllProperties(entityClass: ClassDeclaration): { allProperties: PropertyDeclaration[], imports: string[] } {
-    let allProperties: PropertyDeclaration[] = [...entityClass.getProperties()];
-    let baseClass = entityClass.getBaseClass();
-    let imports: string[] = [];
-    const baseSourceFile = entityClass.getSourceFile();
-    baseSourceFile.getImportDeclarations().forEach(importDecl => {
-        imports.push(importDecl.getText())
-    });
-
-    while (baseClass) {
-        // Asegurarse de agregar las propiedades de la clase base
-        allProperties = [...baseClass.getProperties(), ...allProperties];
-
-        const baseClassSource = baseClass.getSourceFile();
-
-        const baseSourceFile = baseClass.getSourceFile();
-        baseSourceFile.getImportDeclarations().forEach(importDecl => {
-            imports.push(importDecl.getText())
-        });
-
-        if (!baseClassSource.wasForgotten()) {
-            baseClass = baseClass.getBaseClass();
-        } else {
-            break; // Si no puede seguir buscando, detenemos el proceso
-        }
-    }
-
-    return { allProperties, imports };
-}
-
-function buildImports(imports: string[]) {
-    const mergedMap: Map<string, Map<string, boolean>> = imports.reduce((ac: Map<string, Map<string, boolean>>, el: string) => {
-        const normalizedImport: string = el.replace(/\s+/g, ' ').trim();
-        const matchModuleName = normalizedImport.match(/from\s+['"]([^'"]+)['"]/);
-        if (matchModuleName) {
-            const moduleName: string = matchModuleName[1];
-            const matchImports = normalizedImport.match(/import\s*{([^}]+)}/);
-            if (matchImports) {
-                const importsArray: string[] = matchImports[1]
-                    .split(',')
-                    .map((item: string) => item.trim())
-                    .filter((item: string) => item.length > 0);
-                if (importsArray.length) {
-                    if (!ac.has(moduleName)) {
-                        ac.set(moduleName, new Map<string, boolean>());
-                    }
-                    const innerMap = ac.get(moduleName)!;
-                    importsArray.forEach((symbol: string) => innerMap.set(symbol, true));
-                }
-            }
-        }
-        return ac;
-    }, new Map<string, Map<string, boolean>>());
-
-    const uniqueImportStatements: string = Array.from(mergedMap.entries())
-        .map(([moduleName, symbolsMap]: [string, Map<string, boolean>]) => {
-            const symbolsArray: string[] = Array.from(symbolsMap.keys());
-            return `import { ${symbolsArray.join(', ')} } from '${moduleName}';`;
-        })
-        .join('\n');
-    return uniqueImportStatements
-}
-
-/**
- * Genera un DTO parcial a partir de una entidad TypeScript, manteniendo validaciones y valores por defecto.
- * @param entityFilePath Ruta del archivo que contiene la entidad (ej: './entities/UserENTITY.ts')
- * @param entityClassName Nombre de la clase dentro del archivo (ej: 'UserENTITY')
- * @param dtoName Nombre de la clase DTO a generar (ej: 'PartialUserDTO')
- * @param fields Campos que deben incluirse en el DTO (ej: ['_id', 'email', 'identity'])
- * @param outputDir Directorio donde se guardará el DTO (ej: './dtos')
- */
-export function generateDTO<T>(
-    entityFilePath: string,
-    entityClassName: string,
-    dtoName: string,
-    fields: (keyof T)[],
-    outputDir: string = './src/v2/dtos',
-    entityAux?: { entityFilePath: string, entityClassName: string },
-    base: boolean = false
-) {
-    // Inicializar ts-morph y cargar el archivo de la entidad
-    const project = new Project({
-        tsConfigFilePath: './tsconfig.json', // Asegura que se analicen correctamente las importaciones
-    });
-    const sourceFile = project.addSourceFileAtPath(entityFilePath);
-
-    // Obtener la clase de la entidad
-    const entityClass = sourceFile.getClass(entityClassName);
-    if (!entityClass) {
-        console.error(`❌ No se encontró la clase ${entityClassName} en ${entityFilePath}`);
-        return;
-    }
-
-    const dtoProperties: string[] = [];
-
-    const { allProperties, imports } = getAllProperties(entityClass)
-
-    allProperties.forEach(prop => {
-        const propName = prop.getName() as keyof T
-        if (!fields.includes(propName)) return
-        dtoProperties.push(prop.getFullText());
-    });
-
-    //#region EntityAux
-    if (entityAux) {
-        const sourceFile = project.addSourceFileAtPath(entityAux.entityFilePath);
-
-        // Obtener la clase de la entidad
-        const entityClass = sourceFile.getClass(entityAux.entityClassName);
-        if (!entityClass) {
-            console.error(`❌ No se encontró la clase auxiliar ${entityAux.entityClassName} en ${entityAux.entityFilePath}`);
-            return;
-        }
-
-        const { allProperties, imports: _imports } = getAllProperties(entityClass)
-
-        allProperties.forEach(prop => {
-            dtoProperties.push(prop.getFullText());
-        })
-
-        imports.push(..._imports)
-    }
-    //#endregion
-
-    // Generar el código del DTO
-    const dtoCode = `
-${buildImports(imports)}
-
-export class ${dtoName}${base ? ` extends BaseEntity` : ''} {${dtoProperties.join('')}
-}
-`
-
-    // Crear el directorio si no existe
-    if (!fs.existsSync(outputDir)) {
-        fs.mkdirSync(outputDir);
-    }
-
-    // Guardar el archivo DTO
-    const dtoFilePath = `${outputDir}/${dtoName.split('Dto')[0]}.ts`;
-    fs.writeFileSync(dtoFilePath, dtoCode);
-
-    console.log(`✅ Dto ${dtoName} generado en ${dtoFilePath}`);
-
-    // Actualizar index.ts
-    const indexPath = `${outputDir}/index.ts`
-    const exportLine = `export * from './${dtoName.split('Dto')[0]}'`
-
-    let indexContent = ''
-
-    if (fs.existsSync(indexPath)) {
-        indexContent = fs.readFileSync(indexPath, 'utf8')
-    }
-
-    if (!indexContent.includes(exportLine)) {
-        const newContent = indexContent
-            ? `${indexContent.trimEnd()}\n${exportLine}\n`
-            : `${exportLine}\n`
-
-        fs.writeFileSync(indexPath, newContent)
-    }
-
-    console.log(`✅ Export agregado en ${indexPath}`)
+import * as fs from 'fs';
+import { ClassDeclaration, Project, PropertyDeclaration } from 'ts-morph'
+
+/**
+ * Obtiene todas las propiedades de una clase, incluyendo las heredadas de otros archivos.
+ */
+function getAllProperties(entityClass: ClassDeclaration): { allProperties: PropertyDeclaration[], imports: string[] } {
+    let allProperties: PropertyDeclaration[] = [...entityClass.getProperties()];
+    let baseClass = entityClass.getBaseClass();
+    let imports: string[] = [];
+    const baseSourceFile = entityClass.getSourceFile();
+    baseSourceFile.getImportDeclarations().forEach(importDecl => {
+        imports.push(importDecl.getText())
+    });
+
+    while (baseClass) {
+        // Asegurarse de agregar las propiedades de la clase base
+        allProperties = [...baseClass.getProperties(), ...allProperties];
+
+        const baseClassSource = baseClass.getSourceFile();
+
+        const baseSourceFile = baseClass.getSourceFile();
+        baseSourceFile.getImportDeclarations().forEach(importDecl => {
+            imports.push(importDecl.getText())
+        });
+
+        if (!baseClassSource.wasForgotten()) {
+            baseClass = baseClass.getBaseClass();
+        } else {
+            break; // Si no puede seguir buscando, detenemos el proceso
+        }
+    }
+
+    return { allProperties, imports };
+}
+
+function buildImports(imports: string[]) {
+    const mergedMap: Map<string, Map<string, boolean>> = imports.reduce((ac: Map<string, Map<string, boolean>>, el: string) => {
+        const normalizedImport: string = el.replace(/\s+/g, ' ').trim();
+        const matchModuleName = normalizedImport.match(/from\s+['"]([^'"]+)['"]/);
+        if (matchModuleName) {
+            const moduleName: string = matchModuleName[1];
+            const matchImports = normalizedImport.match(/import\s*{([^}]+)}/);
+            if (matchImports) {
+                const importsArray: string[] = matchImports[1]
+                    .split(',')
+                    .map((item: string) => item.trim())
+                    .filter((item: string) => item.length > 0);
+                if (importsArray.length) {
+                    if (!ac.has(moduleName)) {
+                        ac.set(moduleName, new Map<string, boolean>());
+                    }
+                    const innerMap = ac.get(moduleName)!;
+                    importsArray.forEach((symbol: string) => innerMap.set(symbol, true));
+                }
+            }
+        }
+        return ac;
+    }, new Map<string, Map<string, boolean>>());
+
+    const uniqueImportStatements: string = Array.from(mergedMap.entries())
+        .map(([moduleName, symbolsMap]: [string, Map<string, boolean>]) => {
+            const symbolsArray: string[] = Array.from(symbolsMap.keys());
+            return `import { ${symbolsArray.join(', ')} } from '${moduleName}';`;
+        })
+        .join('\n');
+    return uniqueImportStatements
+}
+
+/**
+ * Genera un DTO parcial a partir de una entidad TypeScript, manteniendo validaciones y valores por defecto.
+ * @param entityFilePath Ruta del archivo que contiene la entidad (ej: './entities/UserENTITY.ts')
+ * @param entityClassName Nombre de la clase dentro del archivo (ej: 'UserENTITY')
+ * @param dtoName Nombre de la clase DTO a generar (ej: 'PartialUserDTO')
+ * @param fields Campos que deben incluirse en el DTO (ej: ['_id', 'email', 'identity'])
+ * @param outputDir Directorio donde se guardará el DTO (ej: './dtos')
+ */
+export function generateDTO<T>(
+    entityFilePath: string,
+    entityClassName: string,
+    dtoName: string,
+    fields: (keyof T)[],
+    outputDir: string = './src/v2/dtos',
+    entityAux?: { entityFilePath: string, entityClassName: string },
+    base: boolean = false
+) {
+    // Inicializar ts-morph y cargar el archivo de la entidad
+    const project = new Project({
+        tsConfigFilePath: './tsconfig.json', // Asegura que se analicen correctamente las importaciones
+    });
+    const sourceFile = project.addSourceFileAtPath(entityFilePath);
+
+    // Obtener la clase de la entidad
+    const entityClass = sourceFile.getClass(entityClassName);
+    if (!entityClass) {
+        console.error(`❌ No se encontró la clase ${entityClassName} en ${entityFilePath}`);
+        return;
+    }
+
+    const dtoProperties: string[] = [];
+
+    const { allProperties, imports } = getAllProperties(entityClass)
+
+    allProperties.forEach(prop => {
+        const propName = prop.getName() as keyof T
+        if (!fields.includes(propName)) return
+        dtoProperties.push(prop.getFullText());
+    });
+
+    //#region EntityAux
+    if (entityAux) {
+        const sourceFile = project.addSourceFileAtPath(entityAux.entityFilePath);
+
+        // Obtener la clase de la entidad
+        const entityClass = sourceFile.getClass(entityAux.entityClassName);
+        if (!entityClass) {
+            console.error(`❌ No se encontró la clase auxiliar ${entityAux.entityClassName} en ${entityAux.entityFilePath}`);
+            return;
+        }
+
+        const { allProperties, imports: _imports } = getAllProperties(entityClass)
+
+        allProperties.forEach(prop => {
+            dtoProperties.push(prop.getFullText());
+        })
+
+        imports.push(..._imports)
+    }
+    //#endregion
+
+    // Generar el código del DTO
+    const dtoCode = `
+${buildImports(imports)}
+
+export class ${dtoName}${base ? ` extends BaseEntity` : ''} {${dtoProperties.join('')}
+}
+`
+
+    // Crear el directorio si no existe
+    if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir);
+    }
+
+    // Guardar el archivo DTO
+    const dtoFilePath = `${outputDir}/${dtoName.split('Dto')[0]}.ts`;
+    fs.writeFileSync(dtoFilePath, dtoCode);
+
+    console.log(`✅ Dto ${dtoName} generado en ${dtoFilePath}`);
+
+    // Actualizar index.ts
+    const indexPath = `${outputDir}/index.ts`
+    const exportLine = `export * from './${dtoName.split('Dto')[0]}'`
+
+    let indexContent = ''
+
+    if (fs.existsSync(indexPath)) {
+        indexContent = fs.readFileSync(indexPath, 'utf8')
+    }
+
+    if (!indexContent.includes(exportLine)) {
+        const newContent = indexContent
+            ? `${indexContent.trimEnd()}\n${exportLine}\n`
+            : `${exportLine}\n`
+
+        fs.writeFileSync(indexPath, newContent)
+    }
+
+    console.log(`✅ Export agregado en ${indexPath}`)
 }

package/generateDtos.ts

@@ -1,33 +1,33 @@
-import { generateDTO } from './functionGenerateDto'
-import { ProfileEntity } from '@Entities/Profile'
-import { UserEntity } from '@Entities/User'
-const path = './src/v2/entities'
-
-function Bootstrap() {
-    generateDTO<UserEntity>(
-        `${path}/User.ts`,
-        'UserEntity',
-        'AuthUserDto',
-        ['profileId', 'email', 'firstNames', 'identification', 'maternalLastName', 'paternalLastName', 'root']
-    )
-    generateDTO<ProfileEntity>(
-        `${path}/Profile.ts`,
-        'ProfileEntity',
-        'CreateProfileDto',
-        ['_id', 'name', 'description', 'systemOptions']
-    )
-    generateDTO<ProfileEntity>(
-        `${path}/Profile.ts`,
-        'ProfileEntity',
-        'UpdateProfileDto',
-        ['name', 'description', 'systemOptions', 'active']
-    )
-    generateDTO<ProfileEntity>(
-        `${path}/Profile.ts`,
-        'ProfileEntity',
-        'ProfileDto',
-        ['name', 'description']
-    )
-}
-
+import { generateDTO } from './functionGenerateDto'
+import { ProfileEntity } from '@Entities/Profile'
+import { UserEntity } from '@Entities/User'
+const path = './src/v2/entities'
+
+function Bootstrap() {
+    generateDTO<UserEntity>(
+        `${path}/User.ts`,
+        'UserEntity',
+        'AuthUserDto',
+        ['profileId', 'email', 'firstNames', 'identification', 'maternalLastName', 'paternalLastName', 'root']
+    )
+    generateDTO<ProfileEntity>(
+        `${path}/Profile.ts`,
+        'ProfileEntity',
+        'CreateProfileDto',
+        ['_id', 'name', 'description', 'systemOptions']
+    )
+    generateDTO<ProfileEntity>(
+        `${path}/Profile.ts`,
+        'ProfileEntity',
+        'UpdateProfileDto',
+        ['name', 'description', 'systemOptions', 'active']
+    )
+    generateDTO<ProfileEntity>(
+        `${path}/Profile.ts`,
+        'ProfileEntity',
+        'ProfileDto',
+        ['name', 'description']
+    )
+}
+
 Bootstrap()

package/package.json

@@ -1,39 +1,39 @@
-{
-    "name": "sigo-entities",
-    "version": "1.2.389",
-    "description": "Desarrollo de modelos de datos SIGO",
-    "main": "dist/index.js",
-    "module": "dist/index.mjs",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "build": "tsup && tsc-alias",
-        "prepare": "npm run build",
-        "gen-dto": "ts-node ./generateDtos.ts"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git@github.com-trabajo:GRUPOCOBRA/sigo-entities.git"
-    },
-    "keywords": [],
-    "author": "usuario088",
-    "license": "ISC",
-    "devDependencies": {
-        "@types/express": "^5.0.1",
-        "sigo-package": "^1.2.132",
-        "ts-morph": "^28.0.0",
-        "tsc-alias": "^1.8.15",
-        "tsconfig-paths": "^4.2.0",
-        "tsup": "^8.1.0",
-        "typescript": "^5.4.5"
-    },
-    "dependencies": {
-        "class-transformer": "^0.5.1",
-        "class-validator": "^0.14.1"
-    },
-    "peerDependencies": {
-        "reflect-metadata": "^0.2.2"
-    },
-    "overrides": {
-        "esbuild": "^0.28.0"
-    }
+{
+    "name": "sigo-entities",
+    "version": "1.2.390",
+    "description": "Desarrollo de modelos de datos SIGO",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsup && tsc-alias",
+        "prepare": "npm run build",
+        "gen-dto": "ts-node ./generateDtos.ts"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git@github.com-trabajo:GRUPOCOBRA/sigo-entities.git"
+    },
+    "keywords": [],
+    "author": "usuario088",
+    "license": "ISC",
+    "devDependencies": {
+        "@types/express": "^5.0.1",
+        "sigo-package": "^1.2.132",
+        "ts-morph": "^28.0.0",
+        "tsc-alias": "^1.8.15",
+        "tsconfig-paths": "^4.2.0",
+        "tsup": "^8.1.0",
+        "typescript": "^5.4.5"
+    },
+    "dependencies": {
+        "class-transformer": "^0.5.1",
+        "class-validator": "^0.14.1"
+    },
+    "peerDependencies": {
+        "reflect-metadata": "^0.2.2"
+    },
+    "overrides": {
+        "esbuild": "^0.28.0"
+    }
 }

package/test.ts

@@ -1,13 +1,13 @@
-import { validateAndFormatData, CubicacionColombia9612ENTITY } from './src'
-import { convertDates } from 'sigo-package'
-import fs from 'fs'
-
-// ts-node -r tsconfig-paths/register test.ts
-
-async function test() {
-    const data = JSON.parse(fs.readFileSync('./body_testing.json', 'utf-8'))
-    convertDates(data)
-    console.log(await validateAndFormatData(data, CubicacionColombia9612ENTITY))
-}
-
+import { validateAndFormatData, CubicacionColombia9612ENTITY } from './src'
+import { convertDates } from 'sigo-package'
+import fs from 'fs'
+
+// ts-node -r tsconfig-paths/register test.ts
+
+async function test() {
+    const data = JSON.parse(fs.readFileSync('./body_testing.json', 'utf-8'))
+    convertDates(data)
+    console.log(await validateAndFormatData(data, CubicacionColombia9612ENTITY))
+}
+
 test()