ngx-dsxlibrary 1.21.40 → 1.21.42

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-dsxlibrary",
-  "version": "1.21.40",
+  "version": "1.21.42",
   "description": "Libreria para control de código automatizado.",
   "author": "DevSoftXela",
   "dependencies": {

package/types/ngx-dsxlibrary.d.ts

@@ -1086,13 +1086,55 @@ declare class DteService {
     static ɵprov: i0.ɵɵInjectableDeclaration<DteService>;
 }
 
+/**
+ * Servicio genérico para consumir endpoints REST de la API.
+ *
+ * @typeParam T Tipo de dato que representa el recurso manejado por el endpoint.
+ */
 declare class EndpointService<T> {
+    /** Cliente HTTP de Angular utilizado para realizar las peticiones. */
     private http;
+    /** Configuración de entorno que contiene la URL base de la API. */
     private environment;
+    /**
+     * Construye la URL completa del endpoint a partir de la configuración de entorno.
+     *
+     * @param endpoint Segmento del endpoint (por ejemplo: 'usuarios', 'facturas').
+     * @returns URL absoluta del endpoint.
+     */
     private getUrl;
+    /**
+     * Obtiene un listado de recursos del endpoint especificado.
+     *
+     * @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`.
+     */
     list(endpoint: string, invalidateCache?: boolean): Observable<T[]>;
+    /**
+     * Obtiene un recurso por su identificador.
+     *
+     * @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`.
+     */
     edit(endpoint: string, id: number): Observable<T>;
-    save(endpoint: string, values: T): Observable<ResponseHttpModel>;
+    /**
+     * Crea o actualiza un recurso en el endpoint especificado.
+     *
+     * @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`.
+     */
+    save(endpoint: string, values: T): Observable<ServiceResult<T>>;
+    /**
+     * Elimina un recurso del endpoint especificado.
+     *
+     * @param endpoint Segmento del endpoint (sin la parte de `api/`).
+     * @param id Identificador del recurso a eliminar.
+     * @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.
+     */
     delete(endpoint: string, id: number, softDelete?: boolean): Observable<ResponseHttpModel>;
     static ɵfac: i0.ɵɵFactoryDeclaration<EndpointService<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EndpointService<any>>;
@@ -1611,6 +1653,36 @@ declare class UtilityAddService {
      *   - Muestra alerta visual personalizada con icono de error.
      */
     handleResponse(response: ResponseHttpModel, urlHome: string, form: FormGroup, getForm: () => void, id: number): void;
+    /**
+     * Maneja la respuesta estándar de una operación HTTP que devuelve un ServiceResult<T>,
+     * mostrando alertas y realizando acciones comunes en formularios.
+     *
+     * @typeParam T - Tipo de dato contenido en la propiedad data de ServiceResult.
+     * @param response - Respuesta del servicio (debe tener isSuccess, title, message, etc.).
+     * @param urlHome - Ruta a la que se navega si la operación es exitosa y el id es mayor a 0.
+     * @param form - Formulario reactivo a resetear si la operación es exitosa.
+     * @param getForm - Función para recargar el formulario (por ejemplo, para obtener datos actualizados).
+     * @param id - Identificador usado para decidir si se navega a urlHome tras éxito.
+     *
+     * @example
+     * // Uso típico en un componente con ServiceResult
+     * this.utilityAddService.handleResponseService<MiModelo>(
+     *   response,
+     *   '/home',
+     *   this.form,
+     *   () => this.getForm(),
+     *   this.id
+     * );
+     *
+     * @description
+     * - Si response.isSuccess es true:
+     *   - Muestra alerta tipo toastr.
+     *   - Si id > 0, navega a urlHome.
+     *   - Resetea el formulario y ejecuta getForm().
+     * - Si response.isSuccess es false:
+     *   - Muestra alerta visual personalizada con icono de error.
+     */
+    handleResponseService<T>(response: ServiceResult<T>, urlHome: string, form: FormGroup, getForm: () => void, id: number): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<UtilityAddService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<UtilityAddService>;
 }