@anpdgovbr/shared-types/dist/cjs/interfaces/index.d.ts

Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)

/**
 * @fileoverview
 * Exportação centralizada das interfaces compartilhadas do sistema.
 *
 * @remarks
 * Este arquivo facilita a importação das interfaces em outros módulos, permitindo
 * importações simplificadas como `import { BaseQueryParams } from '@/interfaces'`.
 *
 * @author @lucianoedipo
 * @since 2025
 */
/**
 * Parâmetros comuns de consulta usados para listagens e filtros.
 *
 * @remarks
 * Inclui campos típicos como `page`, `limit`, `sort` e quaisquer filtros adicionais
 * padronizados pela API. Utilizado como contrato para endpoints que recebem parâmetros
 * de paginação e filtragem via query string.
 */
export type { BaseQueryParams, BaseOrderByField, } from "./base-query-params.interface";
/**
 * Representação genérica de dados de enums para consumo em UIs.
 *
 * @remarks
 * Tipo usado para descrever entradas de enum com uma chave/valor legível,
 * útil para popular seletores e exibir rótulos amigáveis.
 */
export type { EnumData } from "./enum-data.interface";
/**
 * Estrutura padrão para respostas paginadas retornadas pela API.
 *
 * @remarks
 * Define o formato do envelope de resposta quando dados são paginados, incluindo
 * metadados de paginação (total, page, limit) e o array de itens.
 */
export type { BasePaginatedResponse } from "./base-paginated-response.interface";
/**
 * Metadados de paginação e utilitários associados.
 *
 * @remarks
 * Exporta o tipo `PaginationMeta` e diferentes helpers para calcular meta de paginação,
 * validar parâmetros, construir respostas paginadas e utilitários auxiliares como
 * cálculo de offset e verificação de páginas válidas.
 */
export { type PaginationMeta, calculatePaginationMeta, validatePaginationParams, createPaginatedResponse, calculateOffset, isValidPage, getPageRange, createEmptyPaginatedResponse, } from "./pagination.helpers";
/**
 * Nó genérico de árvore utilizado por estruturas hierárquicas.
 *
 * @remarks
 * Tipo utilitário que representa um nó em uma árvore (por exemplo, organogramas ou categorias),
 * contendo referência ao valor do nó e possíveis filhos.
 */
export type { TreeNode } from "./tree.interface";
//# sourceMappingURL=index.d.ts.map