@anpdgovbr/shared-types
Version:
Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)
46 lines • 1.29 kB
TypeScript
import type { SoftDelete, UUID } from "../base";
/**
* Representa um DTO (Data Transfer Object) para um CNAE (Classificação Nacional de Atividades Econômicas).
*
* @remarks
* Estende {@link SoftDelete} e foi atualizado na versão 0.2.0 para utilizar UUID como identificador.
* Os aliases `code`/`name` permanecem temporariamente para facilitar a migração, mas estão marcados como deprecados.
*
* @see [CNAE - IBGE](https://concla.ibge.gov.br/classificacoes/cnae.html)
*
* @example
* ```ts
* const cnae: CnaeDto = {
* id: "550e8400-e29b-41d4-a716-446655440000",
* codigo: "47.89-0-99",
* nome: "Comércio varejista",
* active: true,
* exclusionDate: null
* }
* ```
*
* @since 0.2.0
*/
export interface CnaeDto extends SoftDelete {
/**
* Identificador único do CNAE (UUID v4).
*/
id: UUID;
/**
* Código do CNAE, seguindo o padrão nacional de classificação de atividades econômicas.
*/
codigo: string;
/**
* Nome/descrição do CNAE.
*/
nome: string;
/**
* @deprecated Use `codigo`. Será removido na próxima major.
*/
code?: string;
/**
* @deprecated Use `nome`. Será removido na próxima major.
*/
name?: string;
}
//# sourceMappingURL=cnae.dto.d.ts.map