@fc/calculos-previdenciarios
O núcleo previdenciário: o que o RGPS e o RPPS têm em comum. Não é o motor de nenhum dos dois — é o vocabulário e a estrutura que os dois falam.
Os regimes vivem em pacotes próprios, irmãos, e ambos estendem este:
| pacote | o que é |
|---|---|
@fc/calculos-rgps | Regime Geral: RMI, atrasados, evolução de benefício, fator previdenciário, qualidade de segurado, leitura dos documentos do INSS |
@fc/calculos-rpps | Regime Próprio dos servidores do Judiciário da União |
Depende de @fc/comum, @fc/calculos-judiciais, @fc/indices, @fc/utils, @fc/parsers e @fc/arquivos-calc.
O que faz um símbolo pertencer a este pacote
O critério é positivo: está aqui o que é comum aos dois regimes, medido por três lentes.
| lente | pergunta |
|---|---|
| uso | os dois regimes importam o mesmo arquivo? |
| duplicação | o mesmo código existe nos dois em cópia? |
| semântica | é o mesmo conceito sob nomes diferentes? |
A terceira é a que orienta o desenho: onde há conceito comum, há superclasse. O que não passa em nenhuma das três sai daqui para o pacote do regime que o usa — independentemente de como se chame.
Regra de nomenclatura: o conceito neutro fica com o nome genérico do domínio; as duas especializações levam o sufixo do regime. PeriodoContribuicao é o período de qualquer regime; PeriodoRgps e PeriodoRpps são os irmãos.
A hierarquia
| base (aqui) | estende | filho RGPS | filho RPPS | ponto de variação |
|---|---|---|---|---|
CalendarioContagem | — | Calendario360 | Calendario365, CalendarioCorrido | adicionarDias(), dias() |
PeriodoContribuicao | Periodo (@fc/calculos-judiciais) | PeriodoRgps | PeriodoRpps | obterParcialTempo(), tempoEmDias(), peso, tempo |
PeriodosContribuicao | Periodos | PeriodosRgps | PeriodosRpps | invalidarMemos(); a divisão por preponderância usa obterDataDivisaoPorPreponderancia com o calendário do período |
Segurado | Entidade (@fc/comum) | SeguradoRgps | SeguradoRpps | idadeEmDias() — o calendário |
Historico | — | HistoricoRgps | HistoricoRpps | periodosContribuicao; divide os parciais por preponderância com o parcial da linha e a soma do total do regime |
DadosCalculo | Entidade | DadosCalculoRgps | DadosCalculoRpps | der, dataApuracao, historico |
Requisito | — | RequisitoRgps | RequisitoRpps | formatar(), implementadoEm(), calcular() |
RegrasConcessao | — | RegrasConcessaoRgps | RegrasConcessaoRpps | obter(), percorrerRequisitos(), filtrarResultados() |
AnaliseBeneficios | — | AnaliseBeneficiosRgps | AnaliseBeneficiosRpps | apurar() |
Os dois eixos de variação entre os regimes são a aritmética de dias (o RGPS conta em ano de 360; o RPPS em 365 ou data a data) e os períodos postergados. O primeiro é o que CalendarioContagem isola.
Módulos
A pasta de primeiro nível é um conceito do glossário, não uma camada (entidades) nem uma etapa de app (calculo-tc). Dentro do conceito, a base e os contratos ficam na raiz e as regras concretas em subpastas nomeadas pelo que calculam; o auxiliar privado fica ao lado de quem o usa. As exceções transversais são parametros/ (vocabulário de domínio) e persistencia/ (formato .calc).
| módulo | conteúdo |
|---|---|
parametros | o vocabulário que os dois regimes falam: Sexo, FormaContagem, TipoContagem, GrauDeficiencia, MotivoContagem, Origem, NaturezaVinculo, PESOS, MARCOS_TEMPORAIS |
segurado | Segurado: identidade, histórico e aritmética de idade; recusa a apuração anterior ao nascimento |
dados-calculo | DadosCalculo: DER, data de apuração e histórico |
salarios | Salario: o salário de uma competência, com a origem de cada valor; SalariosPorCompetencia: a coleção, sem política de origem nem limites |
periodos-pcd | PeriodoPcd e PeriodosPcd: os períodos com deficiência que a pessoa informa, com o grau de cada um |
contagem-tempo | como um período vira tempo — calendario/ (CalendarioContagem), periodos/, historico/, tempo-parcial/ (calcularParcialTempo, aplicarModificador), preponderancia/, totais/, analise-periodos/ e os tipos de tempo em tipos.ts |
requisitos | o contrato Requisito, o ResultadoRequisito e o PeriodoPostergado comuns e as regras que os dois regimes aplicam iguais, cada requisito com a sua implementação na própria pasta: tempo/ (o motor de tempo, com os períodos postergados pelo "computável desde", genérico no calendário e na soma dos totais; data de cumprimento conferida pela contagem na data candidata; requisito pelo preponderante do período; requisito especial e PcD, mínimo para pontos, seleção das colunas), pontos/ (tabelas da EC 103, tempo para pontos), pedagio/ e deficiencia/ |
analise-beneficios | o motor que diz se há direito: RegrasConcessao (o pipeline como template method), AnaliseBeneficios, os contratos e o resultado em tipos.ts, data-implementacao/ (data de implementação e aviso de inconsistência) e agrupamento/ (grupos básicos e progressivas, percurso pelas transições anuais da EC 103) |
coeficiente | o que diz quanto: cálculos compartilhados entre os regimes e a classe abstrata Coeficiente, com a forma comum de definir(apuracao, fundamentacao) que CoeficienteRgps e CoeficienteRpps especializam (coeficiente fixo, resolução e admissão da fundamentação, projeção do apurado) |
persistencia | migração do vocabulário legado dos .calc: ordinais do vocabulário comum |
A conta pura de idade no ano comercial (idadeEmDias360 e idadeEmAnos360) e caiNoAniversario moram em @fc/utils/datas/; migrarParametroLegado e a normalização das chaves de competência (migrarChaveCompetenciaLegada, migrarRegistroPorCompetencia), que não conhecem domínio, em @fc/arquivos-calc/migracao/. Os três calendários (Calendario360, Calendario365 e CalendarioCorrido) moram aqui, em contagem-tempo/calendario/: são aritmética sem regra de regime, e cada regime escolhe o seu.
A fronteira, por regra
Uma cerca de lint (fc/cerca-nucleo-previdenciario, em @fc/eslint-config) impede que este pacote importe qualquer um dos dois regimes — se importasse, deixaria de ser o que eles têm em comum. Duas cercas irmãs impedem que um regime importe o outro.
O RPPS pode consumir o RGPS em dois contextos delimitados: na contagem recíproca/importação dos documentos do INSS e, dentro de demonstrativos/, nas peças neutras de apresentação de @fc/calculos-rgps/demonstrativos/**. Essa reutilização não autoriza aplicar a contagem ou os requisitos do RGPS ao servidor.
Consumo pelas aplicações
As aplicações e camadas usam diretamente apenas parametros/, salarios/ e periodos-pcd/ do núcleo: vocabulário e entidades de entrada. A mecânica de contagem, requisitos, análise e coeficiente chega às aplicações pelo pacote do regime. A regra de lint fc/cerca-nucleo-apps verifica essa fronteira, inclusive nos testes.
Como consumir
Os exemplos de bases abaixo destinam-se à implementação dos pacotes de regime; aplicações devem respeitar a superfície descrita acima.
O pacote não tem barrel: nem src/index.ts de raiz nem index.ts de pasta. O exports publica cada pasta de src/ por wildcard (@fc/calculos-previdenciarios/<pasta>/*), e o consumidor importa o arquivo que declara o símbolo:
ts
import { PeriodoContribuicao } from '@fc/calculos-previdenciarios/contagem-tempo/periodos/PeriodoContribuicao'
import { Segurado } from '@fc/calculos-previdenciarios/segurado/Segurado'
import { FormaContagem } from '@fc/calculos-previdenciarios/parametros/forma-contagem/FormaContagem'
import { RegrasConcessao } from '@fc/calculos-previdenciarios/analise-beneficios/RegrasConcessao'Os regimes importam qualquer pasta; as apps, só as da face pública. Nos exemplos acima, apenas o import de FormaContagem pertence à face consumida diretamente pelas apps. O import pela raiz não resolve e é barrado pela cerca fc/cerca-pacotes-sem-barrel-raiz.
Parâmetros de domínio
Cada parâmetro é um dicionário as const com tipo homônimo, em pasta própria em kebab-case (parametros/<parametro>/<Parametro>.ts), com chaves em CAPITAL_CASE — FormaContagem.ESPECIAL_25, Sexo.MASCULINO. As auxiliares são funções livres, uma por arquivo: obterOpcoes<Nome>, obterRotulo<Nome>, eh<Nome>Valido. Sem enum, sem namespace, sem barrel — travado por teste de arquitetura (tests/arquitetura/parametros-por-pasta.spec.ts).
Instalação (monorepo)
jsonc
// package.json
{ "dependencies": { "@fc/calculos-previdenciarios": "workspace:*" } }