CompanyRepository

This project was generated using Angular CLI version 20.1.0.

Code scaffolding

Angular CLI includes powerful code scaffolding tools. To generate a new component, run:

ng generate component component-name

For a complete list of available schematics (such as components, directives, or pipes), run:

ng generate --help

Building

To build the library, run:

Librería: company-repository

Esta librería provee un cliente HTTP tipado para gestionar recursos de "companies" (empresas) contra un backend REST. Está pensada para integrarse en aplicaciones Angular como una librería reutilizable.

Contenido principal exportado

• CbmCompanyModule — módulo para configurar la librería (ver sección "Configuración").
• CbmCompanyService — servicio con métodos HTTP para operar sobre empresas. Está registrado con providedIn: 'root'.
• CbmCompanyRepository — envoltorio (repository) que delega en CbmCompanyService y expone la misma API.
• Tipos y modelos: CbmCompanyModel — interfaces y tipos TypeScript que describen los cuerpos de petición y respuestas.

Instalación

1. Añade la dependencia de la librería a tu proyecto (ejemplo si publicaste el paquete):

# desde la raíz del proyecto Angular
npm install @mi-scope/company-repository

Configuración (Angular)

La librería se configura pasando la URL base del endpoint a través de CbmCompanyModule.forRoot({ baseUrl }).

En AppModule (o módulo que corresponda):

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { CbmCompanyModule } from '@mi-scope/company-repository';

@NgModule({
   imports: [
      BrowserModule,
      CbmCompanyModule.forRoot({ baseUrl: 'https://api.example.com/companies' }),
   ],
})
export class AppModule {}

Nota: baseUrl será concatenado con los fragmentos de ruta definidos en el servicio (por ejemplo: ${baseUrl}/list, ${baseUrl}/{id}, etc.).

API pública del servicio

Los principales métodos expuestos por CbmCompanyService / CbmCompanyRepository son:

• list(params: ListParams): Observable
  • Lista paginada de empresas. Parámetros: page, size, filter, status, date_begin, date_end, country_id, deleted.
• listAll(params: ListAllParams): Observable
  • Lista completa con filtro opcional.
• getOne(id: string): Observable
  • Obtiene la empresa por su id.
• getInfo(id: string): Observable
  • Información acotada y rápida sobre la empresa (resumen).
• save(data: SaveBody): Observable
  • Crea una nueva empresa con el payload especificado.
• saveBulk(data: BulkBody): Observable
  • Operación en lote (payload según BulkBody).
• update(id: string, data: UpdateBody): Observable
  • Actualiza una empresa existente.
• changeStatus(id: string, data: ChangeStatusBody): Observable
  • Cambia el estado de la empresa (p. ej. active, suspended).
• uploadFileSignature(data: UploadFileSignatureRequest, file: FormData): Observable
  • Sube un archivo de firma para la empresa. data lleva { id, password } y file es un FormData con el archivo.

Modelos y tipos relevantes

Los tipos están definidos en CbmCompanyModel y cubren:

• ListParams, ListResponse — listado paginado.
• ListAllParams, ListAllResponse — listado completo.
• GetOneResponse, GetInfoResponse — respuestas para detalle y resumen.
• SaveBody, UpdateBody — cuerpos para creación/actualización.
• ChangeStatusBody, ConfirmResponse — cuerpo para cambiar estado y respuesta genérica de confirmación.
• UploadFileSignatureRequest — { id: string; password: string }.

Ejemplo de uso en un componente

import { Component, OnInit } from '@angular/core';
import { CbmCompanyRepository, CbmCompanyModel } from '@mi-scope/company-repository';

@Component({ selector: 'app-companies', template: '' })
export class CompaniesComponent implements OnInit {
   constructor(private repo: CbmCompanyRepository) {}

   ngOnInit() {
      this.repo.list({ page: 1, size: 20 }).subscribe(resp => {
         console.log('Empresas', resp.items);
      });
   }
}

Ejemplo de subida de firma (uploadFileSignature)

const form = new FormData();
form.append('file', fileBlob, 'signature.p12');
repo.uploadFileSignature({ id: companyId, password: 'miPassword' }, form)
   .subscribe(r => console.log('subida', r));

Notas de integración y personalización

• La librería expone la configuración por token (COMPANY_MODULE_CONFIG) que contiene { baseUrl: string }.
• CbmCompanyService usa HttpClient internamente; es posible añadir interceptores a la aplicación (p. ej. para token de autorización) sin modificar la librería.
• Si tu backend requiere encabezados especiales o tratamiento de errores global, instala interceptores a nivel de la aplicación o envuelve CbmCompanyRepository con adaptadores locales.

Recomendaciones de pruebas

• Añade tests unitarios que mockeen HttpClient (o use HttpTestingController) para verificar que las rutas se forman correctamente a partir de baseUrl.

Preguntas frecuentes

• ¿Dónde configuro la URL base? -> Con CbmCompanyModule.forRoot({ baseUrl }) en el módulo raíz.
• ¿Puedo usar un CompanyHttpService personalizado? -> La implementación actual usa HttpClient directamente; si necesitas un wrapper con lógica compartida (p. ej. gestión de errores), crea un servicio en la app que envuelva CbmCompanyRepository.

Contribuciones

Si deseas mejorar la librería (añadir interceptores incorporados, soporte multi-entorno, pruebas), crea un fork y un PR con cambios documentados.

Licencia

Incluye aquí la información de licencia que aplique a tu organización/proyecto.