@anpdgovbr/shared-types
Version:
Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)
118 lines • 5.73 kB
TypeScript
/**
* @file index.ts
* @module enums
* @description
* Exportação centralizada de todos os enums utilizados no sistema ANPD.
*
* @remarks
* Este módulo reúne e exporta todos os enums definidos no sistema, facilitando a importação
* em outros módulos e promovendo organização e reutilização de código.
*
* @example
* ```typescript
* import { AcaoAuditoria, StatusInterno } from '@anpdgovbr/shared-types';
* ```
*
* @author Sistema ANPD
* @since 2025
*/
/**
* Reexporta o enum AcaoAuditoria e seus auxiliares.
*
* @remarks
* AcaoAuditoria descreve as ações possíveis registradas em auditoria (CREATE, UPDATE, DELETE, etc.).
* Os auxiliares exportados (valores, guards, asserts e coerções) são úteis para validação e
* manipulação segura em tempo de compilação e execução.
*/
export { AcaoAuditoria } from "./acao-auditoria.enum";
export { ACAO_AUDITORIA_VALUES, type AcaoAuditoriaLiteral, isAcaoAuditoria, assertAcaoAuditoria, coerceAcaoAuditoria, } from "./acao-auditoria.enum";
/**
* Reexports relacionados a permissões (Ações e Recursos).
*
* @remarks
* Inclui listas de valores possíveis, type guards, asserts e funções de coerção para
* as ações e recursos de permissão usados no sistema.
*/
export { ACOES_PERMISSAO_VALUES, RECURSOS_PERMISSAO_VALUES, isAcaoPermissao, isRecursoPermissao, assertAcaoPermissao, assertRecursoPermissao, coerceAcaoPermissao, coerceRecursoPermissao, } from "./permissao.enum";
/**
* Reexporta o enum StatusInterno e seus auxiliares.
*
* @remarks
* StatusInterno representa os estados internos de processamento. Os utilitários
* associados ajudam em validação, asserção e coerção de valores.
*/
export { StatusInterno, STATUS_INTERNO_VALUES, type StatusInternoLiteral, isStatusInterno, assertStatusInterno, coerceStatusInterno, } from "./status-interno.enum";
/**
* Reexports de tipos de controlador (Pessoa Jurídica / Natural).
*
* @remarks
* Exporta o enum TipoControlador e funções auxiliares para validação e coerção.
*/
export { TipoControlador } from "./tipo-controlador.enum";
export { TIPO_CONTROLADOR_VALUES, type TipoControladorLiteral, isTipoControlador, assertTipoControlador, coerceTipoControlador, } from "./tipo-controlador.enum";
/**
* Reexports do enum TipoPessoaEnum e auxiliares.
*
* @remarks
* Contrato usado pelos DTOs de Encarregado da API Quarkus.
*/
export { TipoPessoaEnum } from "./tipo-pessoa.enum";
export { TIPO_PESSOA_VALUES, type TipoPessoaLiteral, isTipoPessoa, assertTipoPessoa, coerceTipoPessoa, } from "./tipo-pessoa.enum";
/**
* Reexports do enum SetorEmpresarial e auxiliares.
*
* @remarks
* Indica se o controlador pertence ao setor público ou privado.
*/
export { SetorEmpresarial } from "./setor-empresarial.enum";
export { SETOR_EMPRESARIAL_VALUES, type SetorEmpresarialLiteral, isSetorEmpresarial, assertSetorEmpresarial, coerceSetorEmpresarial, } from "./setor-empresarial.enum";
/**
* Reexports do enum Esfera e auxiliares.
*
* @remarks
* Representa a esfera federativa (municipal, estadual ou federal).
*/
export { Esfera } from "./esfera.enum";
export { ESFERA_VALUES, type EsferaLiteral, isEsfera, assertEsfera, coerceEsfera, } from "./esfera.enum";
/**
* Reexports do enum Poder e auxiliares.
*
* @remarks
* Representa os poderes da república (executivo, legislativo ou judiciário).
*/
export { Poder } from "./poder.enum";
export { PODER_VALUES, type PoderLiteral, isPoder, assertPoder, coercePoder, } from "./poder.enum";
/**
* Reexporta TipoParticipacaoSocietaria e auxiliares.
*
* @remarks
* Representa os tipos de participação societária e fornece helpers para verificar e
* coerir valores em tempo de execução.
*/
export { TipoParticipacaoSocietaria } from "./tipo-participacao-societaria.enum";
export { TIPO_PARTICIPACAO_SOCIETARIA_VALUES, type TipoParticipacaoSocietariaLiteral, isTipoParticipacaoSocietaria, assertTipoParticipacaoSocietaria, coerceTipoParticipacaoSocietaria, } from "./tipo-participacao-societaria.enum";
/**
* Reexports do enum TipoRequerimento e seus auxiliares.
*
* @remarks
* Disponibiliza o enum e helpers para validação/coerção de tipos de requerimento.
*/
export { TipoRequerimento } from "./tipo-requerimento.enum";
export { TIPO_REQUERIMENTO_VALUES, type TipoRequerimentoLiteral, isTipoRequerimento, assertTipoRequerimento, coerceTipoRequerimento, } from "./tipo-requerimento.enum";
/**
* Tipos relacionados a permissões.
*
* @remarks
* Exporta as unions e tipos auxiliares usados para descrever ações de permissão,
* recursos e a estrutura de permissão concedida no sistema.
*/
export type { AcaoPermissao, RecursoPermissao, PermissaoConcedida, } from "./permissao.enum";
/**
* Reexports específicos do domínio de RH (unidades, vínculos, família funcional, etc.).
*/
export { TipoUnidade, TIPO_UNIDADE_VALUES, type TipoUnidadeLiteral, isTipoUnidade, assertTipoUnidade, coerceTipoUnidade, } from "./tipo-unidade.enum";
export { FamiliaFuncional, FAMILIA_FUNCIONAL_VALUES, type FamiliaFuncionalLiteral, isFamiliaFuncional, assertFamiliaFuncional, coerceFamiliaFuncional, } from "./familia-funcional.enum";
export { TipoVinculo, TIPO_VINCULO_VALUES, type TipoVinculoLiteral, isTipoVinculo, assertTipoVinculo, coerceTipoVinculo, } from "./tipo-vinculo.enum";
export { NivelSenioridade, NIVEL_SENIORIDADE_VALUES, type NivelSenioridadeLiteral, isNivelSenioridade, assertNivelSenioridade, coerceNivelSenioridade, } from "./nivel-senioridade.enum";
export { StatusIntegracao, STATUS_INTEGRACAO_VALUES, type StatusIntegracaoLiteral, isStatusIntegracao, assertStatusIntegracao, coerceStatusIntegracao, } from "./status-integracao.enum";
//# sourceMappingURL=index.d.ts.map