Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chataigne.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Principes Fondamentaux

​
1. Structure de Base

class EntityName {
  // Propriétés privées avec underscore
  private _id: string;
  private _createdAt?: Date;
  private _updatedAt?: Date;

  // Autres propriétés privées
  private _property: PropertyType;

  // Constructeur avec objet de paramètres
  constructor(data: EntityNameData) {
    this._id = data.id;
    this._createdAt = data.createdAt;
    this._updatedAt = data.updatedAt;
    this._property = data.property;
  }

  // Getters publics
  public get id(): string {
    return this._id;
  }

  // Setters avec validation si nécessaire
  public set property(value: PropertyType) {
    this.validateProperty(value);
    this._property = value;
  }
}

​
2. Gestion des Relations

2.1 Relations Simples 
class Entity {
  private _relatedEntity: RelatedEntity | null = null;

  public get relatedEntity(): RelatedEntity | null {
    return this._relatedEntity;
  }

  public set relatedEntity(value: RelatedEntity | null) {
    this._relatedEntity = value;
  }
}
2.2 Collections 
class Entity {
  private _items: Item[] = [];

  // Retourner une copie pour éviter les modifications externes
  public get items(): Item[] {
    return [...this._items];
  }

  // Méthodes pour manipuler la collection
  public addItem(item: Item): void {
    this._items.push(item);
  }

  public removeItem(itemId: string): void {
    this._items = this._items.filter((item) => item.id !== itemId);
  }
}

​
3. Entités Enrichies

Pour gérer les différents niveaux de chargement des relations, nous utilisons des classes distinctes : 
// Entité de base
class Customer {
  private _id: string;
  private _name: string;
  // ... autres propriétés de base
}

// Entité enrichie avec des relations
class CustomerWithOrders extends Customer {
  private _orders: Order[];

  constructor(customer: Customer, orders: Order[]) {
    super(customer);
    this._orders = orders;
  }

  // Getters spécifiques aux relations
  public get orders(): Order[] {
    return this._orders;
  }

  // Méthodes calculées sur les relations
  public getTotalOrderAmount(): number {
    return this._orders.reduce((total, order) => total + order.total, 0);
  }
}

​
4. Value Objects

Pour les concepts qui n’ont pas d’identité propre, nous utilisons des Value Objects : 
class Address {
  private readonly _street: string;
  private readonly _city: string;
  private readonly _postalCode: string;

  constructor(data: AddressData) {
    this._street = data.street;
    this._city = data.city;
    this._postalCode = data.postalCode;
  }

  // Getters immutables
  public get street(): string {
    return this._street;
  }

  // Méthodes de validation
  private validatePostalCode(code: string): void {
    if (!this.isValidPostalCode(code)) {
      throw new DomainException("Invalid postal code", "INVALID_POSTAL_CODE");
    }
  }
}

​
5. Validation

La validation se fait à plusieurs niveaux :
  1. Dans les setters pour les validations simples
  2. Dans le constructeur pour les invariants de base
  3. Dans des méthodes privées pour les validations complexes
class Entity {
  private validateInvariants(): void {
    // Validation des invariants complexes
  }

  public set property(value: PropertyType) {
    this.validateProperty(value);
    this._property = value;
  }

  private validateProperty(value: PropertyType): void {
    // Validation spécifique
  }
}

​
Bonnes Pratiques

1

Immutabilité

• Utiliser readonly pour les propriétés qui ne doivent pas changer• Retourner des copies des collections dans les getters
2

Encapsulation

• Toutes les propriétés sont privées• Accès via getters/setters• Validation dans les setters
3

Relations

• Distinguer clairement les relations chargées/non chargées• Utiliser des classes distinctes pour les différents niveaux de chargement• Encapsuler les collections dans des Value Objects
4

Validation

• Valider dans les setters• Valider dans le constructeur• Utiliser des exceptions de domaine
5

Documentation

• Documenter les invariants• Documenter les validations• Documenter les relations