catalogs tested

Author: mendozagit

examples/main.ts

@@ -10,7 +10,7 @@ async function main() : Promise<void> {
     apiUrl: 'https://localhost:7173',
     apiKey: 'sk_development_833a58f9_8212_43ce_b544_f2fa93b1e895',
     tenant: 'e839651d-1765-4cd0-ba7f-547a4c20580f',
-    debug:false
+    debug:true
   };
 
   // Sellos SAT CSD del emisor para emisión de CFDI
@@ -204,6 +204,21 @@ async function main() : Promise<void> {
     // console.log('apiResponse:', apiResponse);
 
 
+    // Listar catálogos
+    // const apiResponse = await client.catalogs.getList(1, 100);
+    // console.log('apiResponse:', apiResponse);
+
+    // Obtener registro de catálogo por ID (Obtiene el registro '03' (Transferencia electrónica de fondos) en el catalogo de formas de pago (SatPaymentForms))
+    // const apiResponse = await client.catalogs.getRecordById("SatPaymentForms", "03");
+    // console.log('apiResponse:', apiResponse);
+
+    // Busca en un catálogo. (Busca en el catalogo de formas de pago (SatPaymentForms) los registros que contengan la palabra 'Tarjeta')
+    // const apiResponse = await client.catalogs.searchCatalog("SatPaymentForms", "Tarjeta", 1, 100);
+    // console.log('apiResponse:', apiResponse);
+
+ 
+
+
     console.log('End Fiscalapi node...'); 
   } catch (error: unknown) {
     console.error('Error inesperado:', error);    

src/abstractions/catalog-service.interface.ts

@@ -2,15 +2,38 @@
 import { IFiscalapiService } from './fiscalapi-service.interface';
 import { CatalogDto } from '../common/catalog-dto';
 import { ApiResponse } from '../common/api-response';
+import { PagedList } from '../common/paged-list';
 
 /**
  * Interfaz del servicio de catálogos
  */
 export interface ICatalogService extends IFiscalapiService<CatalogDto> {
+ 
+
+  /**
+   * /api/v4/catalogs/<catalogName>/key/<id>
+   * Recupera un registro específico por catalogName e id
+   * 
+   * @param catalogName - Nombre del catálogo
+   * @param id - Identificador del registro
+   */
+  getRecordById(catalogName: string, id: string): Promise<ApiResponse<CatalogDto>>;
+
   /**
-   * Obtiene un catálogo por su código
-   * @param {string} catalogType - Tipo de catálogo
-   * @returns {Promise<ApiResponse<CatalogDto[]>>} Lista de elementos del catálogo
+   * GET /api/v4/catalogs/{catalogName}/{searchText}
+   * Busca registros en un catálogo específico
+   * 
+   * @param catalogName - Nombre del catálogo
+   * @param searchText - Texto de búsqueda
+   * @param pageNumber - Número de página (opcional, default: 1)
+   * @param pageSize - Tamaño de página (opcional, default: 50)
    */
-  getCatalog(catalogType: string): Promise<ApiResponse<CatalogDto[]>>;
+  searchCatalog(
+      catalogName: string, 
+      searchText: string, 
+      pageNumber?: number, 
+      pageSize?: number
+  ): Promise<ApiResponse<PagedList<CatalogDto>>>;
+
+  
 }

src/services/catalog-service.ts

@@ -1,9 +1,8 @@
-
 import { CatalogDto } from '../common/catalog-dto';
 import { IFiscalapiHttpClient } from '../http/fiscalapi-http-client.interface';
 import { ApiResponse } from '../common/api-response';
 import { BaseFiscalapiService } from './base-fiscalapi-service';
-import { ICatalogService } from '..';
+import { ICatalogService, PagedList } from '..';
 
 /**
  * Implementación del servicio de catálogos
@@ -18,10 +17,46 @@ export class CatalogService extends BaseFiscalapiService<CatalogDto> implements
     super(httpClient, 'catalogs', apiVersion);
   }
 
-  /**
-   * @inheritdoc
-   */
-  async getCatalog(catalogType: string): Promise<ApiResponse<CatalogDto[]>> {
-    return this.httpClient.getAsync<CatalogDto[]>(this.buildEndpoint(catalogType));
-  }
+
+
+    /**
+    * Recupera un registro de un catálogo por catalogName y id.
+    * 
+    * @param catalogName - Nombre del catálogo
+    * @param id - Id del registro en el catalogName
+    * @returns Promise que resuelve en una respuesta API con CatalogDto
+    */
+    public async getRecordById(catalogName: string, id: string): Promise<ApiResponse<CatalogDto>> {
+      const path = `${catalogName}/key/${id}`;
+      const endpoint = this.buildEndpoint(path);
+      // api/v4/catalogs/<catalogName>/key/<id>
+      return this.httpClient.getAsync<CatalogDto>(endpoint);
+    }
+
+    /**
+    * Busca en un catálogo.
+    * 
+    * @param catalogName - Catalog name. Must be a catalog retrieved from getList()
+    * @param searchText - Criterio de búsqueda. Debe tener 4 caracteres de longitud como mínimo.
+    * @param pageNumber - Numero de pagina a recuperar (default: 1)
+    * @param pageSize - Tamaño de la página entre 1 y 100 registros por página (default: 50)
+    * @returns Promise que resuelve en una respuesta API con lista paginada de CatalogDto
+    */
+    public async searchCatalog(
+      catalogName: string, 
+      searchText: string,
+      pageNumber: number = 1, 
+      pageSize: number = 50
+    ): Promise<ApiResponse<PagedList<CatalogDto>>> {
+      const path = `${catalogName}/${searchText}`;
+      const queryParams = {
+          pageNumber: pageNumber.toString(),
+          pageSize: pageSize.toString()
+      };
+      const endpoint = this.buildEndpoint(path, queryParams);
+      const response = await this.httpClient.getAsync<PagedList<CatalogDto>>(endpoint);
+      return response;
+    }
+
+  
 }