@anpd/shared-types

shared-types

Tipos, DTOs, enums e interfaces compartilhados para projetos da ANPD

Visão Geral

Este pacote centraliza todos os tipos TypeScript reutilizáveis, Data Transfer Objects (DTOs), enums, interfaces e contratos base utilizados em diferentes módulos e serviços da aplicação ANPD. O objetivo é garantir padronização, reuso e consistência tipada em toda a stack.

Publicado no npm: @anpd/shared-types

Estrutura do Projeto

shared-types/
├── src/
│   ├── base/         # Entidades e contratos base (ex: BaseEntity, SoftDelete)
│   ├── dto/          # Data Transfer Objects (DTOs)
│   ├── enums/        # Enumerações de domínio
│   ├── interfaces/   # Interfaces utilitárias e de resposta
│   └── index.ts      # Exportação centralizada
├── package.json
├── tsconfig.json
└── README.md

Como Usar

• Instalação:

  npm install @anpd/shared-types
  # ou
  yarn add @anpd/shared-types
  

• Importação de tipos:

  import { UserDto, AcaoAuditoria, BaseQueryParams } from "@anpd/shared-types"
  

• Importação por domínio (opcional):

  import { GrupoEconomicoDto } from "@anpd/shared-types/dto"
  import { StatusInterno } from "@anpd/shared-types/enums"
  

Conteúdo

• DTOs: Estruturas para transferência de dados entre camadas e serviços.
• Enums: Constantes e valores fixos do domínio.
• Interfaces: Contratos para padronização de respostas, queries e entidades.
• Entidades Base: Contratos reutilizáveis para entidades de domínio.

Convenções

• Toda documentação é feita em português (pt-BR) e utiliza TSDoc.
• Os arquivos index.ts de cada pasta facilitam importações centralizadas.
• O arquivo src/index.ts exporta tudo de forma global.

Manutenção

• Sempre documente novos tipos e mantenha a padronização.
• Atualize este README ao adicionar novos domínios ou contratos relevantes.

Projeto mantido pela equipe DDSS/CGTI/ANPD. Para dúvidas ou sugestões, entre em contato com o time de desenvolvimento.