@anpdgovbr/shared-types
Version:
Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)
53 lines • 1.6 kB
TypeScript
import type { SoftDelete } from "../base";
/**
* Data Transfer Object (DTO) que representa um usuário do sistema.
*
* Mantido nome em inglês para compatibilidade com o sistema de autenticação.
*
* @extends SoftDelete
*
* @remarks
* Esta interface define os dados essenciais para identificação e autenticação de um usuário,
* além de informações opcionais relacionadas ao perfil e imagem.
*/
export interface UserDto extends SoftDelete {
/**
* Identificador único do usuário (UUID).
*
* Utilizado para autenticação e identificação única do usuário no sistema.
* É do tipo `string` intencionalmente, diferente de `BaseEntity` que utiliza `number`.
*/
id: string;
/**
* Endereço de e-mail do usuário.
*
* Utilizado para autenticação e comunicação.
*/
email: string;
/**
* Nome completo do usuário.
*
* Este campo é opcional.
*/
nome?: string;
/**
* Identificador do perfil associado ao usuário.
*
* Este campo é opcional e pode ser utilizado para controle de permissões.
*/
perfilId?: number;
/**
* URL ou caminho da imagem de perfil do usuário.
*
* Este campo é opcional.
*/
image?: string;
/**
* Identificador do responsável vinculado ao usuário.
*
* Específico do backlog-dim, indica o link entre o usuário e o responsável (nome do usuário no CSV de importação).
* Pode ser `null` ou um número.
*/
responsavelId?: number | null;
}
//# sourceMappingURL=user.dto.d.ts.map