ngx-dsxlibrary 2.21.2 → 2.21.3

package/fesm2022/ngx-dsxlibrary.mjs

@@ -3258,7 +3258,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.7", ngImpor
 /**
  * Servicio genérico para consumir endpoints REST de la API.
  *
- * @typeParam T Tipo de dato que representa el recurso manejado por el endpoint.
+ * @typeParam T Tipo base de la entidad. Puede sobrescribirse por método.
  */
 class EndpointService {
     /** Cliente HTTP de Angular utilizado para realizar las peticiones. */
@@ -3277,9 +3277,10 @@ class EndpointService {
     /**
      * Obtiene un listado de recursos del endpoint especificado.
      *
+     * @typeParam TList Tipo de cada elemento del listado (por defecto `T`).
      * @param endpoint Segmento del endpoint (sin la parte de `api/`).
      * @param invalidateCache Indica si se invalida la caché del lado del servidor.
-     * @returns Observable con un arreglo de elementos del tipo `T`.
+     * @returns Observable con un arreglo de elementos del tipo `TList`.
      */
     list(endpoint, invalidateCache = false) {
         return this.http.get(`${this.getUrl(endpoint)}/listar/${invalidateCache}`);
@@ -3287,9 +3288,10 @@ class EndpointService {
     /**
      * Obtiene un recurso por su identificador.
      *
+     * @typeParam TEdit Tipo del recurso retornado (por defecto `T`).
      * @param endpoint Segmento del endpoint (sin la parte de `api/`).
      * @param id Identificador del recurso a recuperar.
-     * @returns Observable con el elemento del tipo `T`.
+     * @returns Observable con el elemento del tipo `TEdit`.
      */
     edit(endpoint, id) {
         return this.http.get(`${this.getUrl(endpoint)}/get-id/${id}`);
@@ -3297,9 +3299,11 @@ class EndpointService {
     /**
      * Crea o actualiza un recurso en el endpoint especificado.
      *
+     * @typeParam TSave Tipo del payload enviado al backend (por defecto `T`).
+     * @typeParam TResponse Tipo de la entidad en la respuesta (por defecto `T`).
      * @param endpoint Segmento del endpoint (sin la parte de `api/`).
      * @param values Objeto con los datos del recurso a guardar.
-     * @returns Observable con el resultado del servicio que envuelve al tipo `T`.
+     * @returns Observable con el resultado del servicio que envuelve `TResponse`.
      */
     save(endpoint, values) {
         return this.http.put(`${this.getUrl(endpoint)}/save`, values);
@@ -3308,7 +3312,7 @@ class EndpointService {
      * Elimina un recurso del endpoint especificado.
      *
      * @param endpoint Segmento del endpoint (sin la parte de `api/`).
-     * @param id Identificador del recurso a eliminar.
+     * @param id Identificador del recurso a eliminar (numérico o textual).
      * @param softDelete Indica si la eliminación es lógica (por defecto) o física.
      * @returns Observable con el modelo de respuesta HTTP genérico.
      */
@@ -3325,19 +3329,46 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.7", ngImpor
                 }]
         }] });
 
+/**
+ * Clase base para servicios CRUD tipados.
+ *
+ * @typeParam TBase Modelo base que representa la entidad principal.
+ * @typeParam TEdit Modelo de respuesta para la operación de edición/consulta por id.
+ * @typeParam TSave Modelo de entrada para guardar (create/update).
+ * @typeParam TList Modelo de cada elemento del listado.
+ * @typeParam TDelete Tipo del identificador usado para eliminar (number o string).
+ */
 class BaseCRUDService {
-    _endpointService = inject((EndpointService));
+    /** Servicio HTTP base para operaciones REST. */
+    _endpointService = inject(EndpointService);
+    /**
+     * Obtiene el listado de registros.
+     * @param invalidateCache Si es true, solicita invalidar caché en backend.
+     */
     list(invalidateCache = false) {
         return this._endpointService.list(this.endpoint, invalidateCache);
     }
+    /**
+     * Obtiene un registro por id para edición.
+     * @param id Identificador numérico del registro.
+     */
     edit(id) {
         return this._endpointService.edit(this.endpoint, id);
     }
+    /**
+     * Guarda un registro (creación o actualización).
+     * @param values Payload tipado para persistir.
+     */
     save(values) {
         return this._endpointService.save(this.endpoint, values);
     }
-    delete(id, softDelete = true) {
-        return this._endpointService.delete(this.endpoint, id, softDelete);
+    /**
+     * Elimina un registro por identificador.
+     * @param value Identificador del registro a eliminar.
+     * @param softDelete Si es true, realiza eliminación lógica.
+     */
+    delete(value, softDelete = true) {
+        return this._endpointService.delete(this.endpoint, value, softDelete);
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.7", ngImport: i0, type: BaseCRUDService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.7", ngImport: i0, type: BaseCRUDService, providedIn: 'root' });