Avez-vous une question? (216) 97 656 803 hajjriadh@gmail.com
NestJS

Les mapped types (PartialType, PickType, OmitType)

Cette leçon montre comment éviter de dupliquer les DTO grâce aux mapped types de NestJS (@nestjs/mapped-types) : PartialType rend tous les champs facultatifs pour une modification partielle, PickType ...

0 chapitres 0 QCM Accès gratuit
Les mapped types (PartialType, PickType, OmitType)

À propos de ce cours

Cette leçon montre comment éviter de dupliquer les DTO grâce aux mapped types de NestJS (@nestjs/mapped-types) : PartialType rend tous les champs facultatifs pour une modification partielle, PickType ne garde que certains champs, OmitType en retire, IntersectionType fusionne deux DTO. Les règles de validation sont héritées, ce que démontrent dix requêtes exécutées. La leçon explique la composition des mapped types, la différence avec les types utilitaires de TypeScript et une limite importante : les objets imbriqués ne deviennent pas facultatifs en profondeur. Activités corrigées.

Objectifs de la leçon

  • Comprendre pourquoi dériver un DTO plutôt que le recopier.
  • Utiliser PartialType, PickType, OmitType et IntersectionType.
  • Composer plusieurs mapped types.
  • Distinguer les mapped types de NestJS des types utilitaires de TypeScript.
Le problème de la duplication

Pour une ressource, on a besoin de plusieurs DTO très proches : création (tous les champs obligatoires), modification (tous facultatifs), changement de groupe (un seul champ)… Les recopier signifie recopier aussi toutes les règles de validation, et les oublier lors de la prochaine modification. Les mapped types créent un DTO à partir d'un autre, en conservant ses décorateurs.

npm install @nestjs/mapped-types

Si vous utilisez Swagger (chapitre 14), on importera les mêmes fonctions depuis @nestjs/swagger, pour que la documentation suive aussi. Le fonctionnement est identique.

Les quatre mapped types de NestJS

Chaque mapped type crée une nouvelle classe à partir du DTO de création.

Les quatre mapped types

📄 src/stagiaires/dto/stagiaire.dto.ts

import { IntersectionType, OmitType, PartialType, PickType } from '@nestjs/mapped-types';
import { IsEmail, IsIn, IsInt, IsNotEmpty, IsOptional, IsString, Length, Max, Min } from 'class-validator';

export class CreerStagiaireDto {
  @IsString()
  @Length(2, 50)
  nom: string;

  @IsString()
  @IsNotEmpty()
  prenom: string;

  @IsEmail()
  email: string;

  @IsIn(['DEV101', 'DEV102', 'RES201'])
  groupe: string;

  @IsString()
  @Length(8, 8, { message: 'Le CIN doit contenir exactement 8 caractères' })
  cin: string;
}

// Tous les champs deviennent facultatifs, avec les MÊMES règles
export class ModifierStagiaireDto extends PartialType(CreerStagiaireDto) {}

// Seulement certains champs
export class ChangerGroupeDto extends PickType(CreerStagiaireDto, ['groupe'] as const) {}

// Tous les champs sauf certains (le CIN ne se modifie pas), puis facultatifs
export class ModifierProfilDto extends PartialType(OmitType(CreerStagiaireDto, ['cin', 'groupe'] as const)) {}

// Fusion de deux DTO
class PaginationDto {
  @IsOptional()
  @IsInt()
  @Min(1)
  page?: number;

  @IsOptional()
  @IsInt()
  @Max(50)
  limite?: number;
}
class CriteresDto extends PickType(PartialType(CreerStagiaireDto), ['groupe', 'nom'] as const) {}
export class RechercheStagiairesDto extends IntersectionType(CriteresDto, PaginationDto) {}

📄 src/stagiaires/stagiaires.controller.ts

import { Body, Controller, Param, ParseIntPipe, Patch, Post } from '@nestjs/common';
import {
  ChangerGroupeDto, CreerStagiaireDto, ModifierProfilDto, ModifierStagiaireDto, RechercheStagiairesDto,
} from './stagiaire.dto';

@Controller('stagiaires')
export class StagiairesController {
  @Post()
  creer(@Body() dto: CreerStagiaireDto) {
    return dto;
  }

  @Patch(':id')
  modifier(@Param('id', ParseIntPipe) id: number, @Body() dto: ModifierStagiaireDto) {
    return { id, champsModifies: Object.keys(dto) };
  }

  @Patch(':id/groupe')
  changerGroupe(@Param('id', ParseIntPipe) id: number, @Body() dto: ChangerGroupeDto) {
    return { id, ...dto };
  }

  @Patch(':id/profil')
  profil(@Param('id', ParseIntPipe) id: number, @Body() dto: ModifierProfilDto) {
    return { id, ...dto };
  }

  @Post('recherche')
  recherche(@Body() dto: RechercheStagiairesDto) {
    return dto;
  }
}
await appel('PATCH', '/api/stagiaires/1', { corps: {} });
await appel('PATCH', '/api/stagiaires/1', { corps: { email: 'nouvelle@exemple.tn' } });
await appel('PATCH', '/api/stagiaires/1', { corps: { email: 'invalide' } });
await appel('PATCH', '/api/stagiaires/1/groupe', { corps: { groupe: 'RES201' } });
await appel('PATCH', '/api/stagiaires/1/groupe', { corps: { groupe: 'RES201', nom: 'Autre' } });
await appel('PATCH', '/api/stagiaires/1/groupe', { corps: {} });
await appel('PATCH', '/api/stagiaires/1/profil', { corps: { prenom: 'Samia' } });
await appel('PATCH', '/api/stagiaires/1/profil', { corps: { cin: '01234567' } });
await appel('POST', '/api/stagiaires/recherche', { corps: { groupe: 'DEV101', page: 2, limite: 20 } });
await appel('POST', '/api/stagiaires/recherche', { corps: { groupe: 'XXX', limite: 100 } });

Résultat réellement obtenu (ValidationPipe global avec whitelist, forbidNonWhitelisted et transform) :

PATCH /api/stagiaires/1 → 200 {"id":1,"champsModifies":[]}
PATCH /api/stagiaires/1 → 200 {"id":1,"champsModifies":["email"]}
PATCH /api/stagiaires/1 → 400 {"message":["email must be an email"],"error":"Bad Request","statusCode":400}
PATCH /api/stagiaires/1/groupe → 200 {"id":1,"groupe":"RES201"}
PATCH /api/stagiaires/1/groupe → 400 {"message":["property nom should not exist"],"error":"Bad Request","statusCode":400}
PATCH /api/stagiaires/1/groupe → 400 {"message":["groupe must be one of the following values: DEV101, DEV102, RES201"],"error":"Bad Request","statusCode":400}
PATCH /api/stagiaires/1/profil → 200 {"id":1,"prenom":"Samia"}
PATCH /api/stagiaires/1/profil → 400 {"message":["property cin should not exist"],"error":"Bad Request","statusCode":400}
POST /api/stagiaires/recherche → 201 {"groupe":"DEV101","page":2,"limite":20}
POST /api/stagiaires/recherche → 400 {"message":["groupe must be one of the following values: DEV101, DEV102, RES201","limite must not be greater than 50"],"error":"Bad Request","statusCode":400}
Lecture des résultats
Mapped typeCe qui est démontré
PartialType(Creer…)un corps vide est accepté, un seul champ aussi ; mais un e-mail présent doit toujours être valide : les règles sont héritées, avec un @IsOptional() ajouté
PickType(Creer…, ['groupe'])seul groupe est autorisé (nom refusé) et il reste obligatoire (corps vide refusé)
PartialType(OmitType(…, ['cin', 'groupe']))composition : on retire d'abord les champs non modifiables, puis on rend le reste facultatif ; cin est refusé
IntersectionType(A, B)les champs et les règles des deux classes sont réunis : erreurs sur groupe et sur limite

On écrit ['groupe'] as const pour que TypeScript connaisse le nom exact des champs et que le type de la nouvelle classe soit précis (l'autocomplétion ne proposera que groupe).

Mapped types de NestJS ou types utilitaires de TypeScript ?

TypeScript propose Partial<T>, Pick<T, K> et Omit<T, K> (leçon 4.6). Mais ce sont des types, effacés à la compilation : ils ne peuvent pas servir de DTO, car le ValidationPipe a besoin d'une classe portant des décorateurs. PartialType() et ses voisins sont des fonctions qui, à l'exécution, fabriquent une vraie classe et y recopient les métadonnées de validation et de transformation.

type ModifierStagiaire = Partial<CreerStagiaireDto>;              // ✗ un type : aucune validation possible
export class ModifierStagiaireDto extends PartialType(CreerStagiaireDto) {}   // ✓ une classe avec ses règles
Une limite : les objets imbriqués

PartialType rend facultatif le champ adresse, mais pas les champs de l'adresse. Si le client envoie { "adresse": { "ville": "Sousse" } }, la rue et le code postal manquants seront signalés. C'est souvent le comportement souhaité (une adresse se remplace en entier). Sinon, il faut un ModifierAdresseDto extends PartialType(AdresseDto) utilisé explicitement. Le TP 5 vous fera constater ce comportement.

Activités

Activité 1 Choisir le bon mapped type

À partir de CreerFormationDto (code, intitule, heures, niveau, dateDebut), écrivez : (a) le DTO de modification partielle ; (b) le DTO de report, qui ne contient que dateDebut obligatoire ; (c) le DTO de modification où le code ne peut pas changer.

Voir le corrigé
export class ModifierFormationDto extends PartialType(CreerFormationDto) {}
export class ReporterFormationDto extends PickType(CreerFormationDto, ['dateDebut'] as const) {}
export class ModifierFormationSansCodeDto extends PartialType(OmitType(CreerFormationDto, ['code'] as const)) {}

Activité 2 Ajouter des champs

Le DTO de modification d'une note doit reprendre les champs de CreerNoteDto (facultatifs) et ajouter un champ obligatoire motif (10 caractères au moins), pour tracer toute modification. Écrivez-le.

Voir le corrigé
export class ModifierNoteDto extends PartialType(OmitType(CreerNoteDto, ['stagiaireId'] as const)) {
  @IsString()
  @MinLength(10, { message: 'Le motif doit contenir au moins 10 caractères' })
  motif: string;
}

La classe obtenue est une classe normale : on peut l'étendre et lui ajouter des propriétés décorées. On a aussi retiré stagiaireId: une note ne change pas de stagiaire.

Activité 3 Pagination réutilisable

Créez un PaginationDto (page et limite avec @Type(() => Number) et valeurs par défaut) dans src/common/dto/, puis un FiltreStagiairesDto qui le combine avec des critères propres aux stagiaires. Comparez extends PaginationDto et IntersectionType: quand l'héritage simple ne suffit-il plus ?

Voir le corrigé

Avec un seul DTO commun, class FiltreStagiairesDto extends PaginationDto { … } suffit. Dès qu'il faut réunir deux DTO existants (pagination et tri, par exemple), l'héritage simple ne suffit plus, car une classe n'a qu'un parent : IntersectionType(PaginationDto, TriDto) le permet, et on peut encore étendre le résultat.

Activité 4 Partial ou PartialType ?

Un étudiant écrit @Patch(':id') modifier(@Body() dto: Partial<CreerStagiaireDto>). Le code compile. Envoyez { "email": "invalide", "role": "admin" }: que se passe-t-il, et pourquoi ?

Voir le corrigé

La requête est acceptée telle quelle (200), avec role! Partial<…> est un type : à l'exécution, metatype vaut Object. Le ValidationPipe n'a donc aucune règle à vérifier, et whitelist n'a aucune liste de propriétés autorisées. Il faut une classe : ModifierStagiaireDto extends PartialType(CreerStagiaireDto).

À retenir

  • Les mapped types créent un DTO à partir d'un autre en héritant de ses règles de validation.
  • PartialType : tout facultatif (PATCH) ; PickType : certains champs ; OmitType : tous sauf certains ; IntersectionType : fusion.
  • Ils se composent : PartialType(OmitType(Dto, ['cin'] as const)).
  • Ce sont des fonctions qui produisent des classes, contrairement à Partial de TypeScript (sans validation).
  • PartialType n'agit pas en profondeur sur les objets imbriqués.

Cet article vous a-t-il aidé ?