helper.js

//Méthode permet de renvoie un méssage lors de la requêtes du client.
exports.success = (message, data) => {
  return {
    message,
    data,
  };
};

//Méthode permettant de généré un id unique
exports.getUniqueId = (data) => {
  const pokemonsIds = data.map(({ id }) => id);
  const idMax = pokemonsIds.reduce((a, b) => Math.max(a, b));
  const uniqueId = idMax + 1;
  return uniqueId;
};

/**************Les point de terminaises statiques *****/

/*************METHODE GET **************/
app.get("/", (req, res) => res.send("Hello again, Express !")); //méthode get pour affiché un méssage à l'utilisateur.

/* EXEMPLE : */
app.get("/api/pokemons/", (req, res) => {
  const message = "La liste des pokémon à bien été récupérée. 200";
  res.json(success(message, pokemons));
});

/*REQUETE SELON L'ID */
app.get("/api/pokemons/:id", (req, res) => {
  const id = parseInt(req.params.id); //Permmet de récupérer les paramètres contenus dans l'url

  const pokemon = pokemons.find((pokemon) => pokemon.id === id); //On stoke les paramètres du pokemon correspondant à l'id passée en requete dans notre variable pokemon.

  const message = "un pokémon à bien été trouvé 200"; //on écrit le méssage de la requette.

  res.json(success(message, pokemon)); //cette méthode nous permet d'affiché la réponse à la requette sous forme d'un fichier JSON.
});

/***********METHODE POST *******************/
app.post("/api/pokemons", (req, res) => {
  const id = getUniqueId(pokemons);
  const pokemonCreated = {
    ...req.body,
    ...{ id: id, created: new Date() },
  };
  pokemons.push(pokemonCreated);
  const message = `Le pokemon ${pokemonCreated.name} à bien été crée.`;
  res.json(success(message, pokemonCreated));
});

/*********METHODE PUT **********************/
app.put("/api/pokemons/:id", (req, res) => {
  const id = parseInt(req.params.id);
  const pokemonUpdated = { ...req.body, id: id };
  pokemons = pokemons.map((pokemon) => {
    return pokemon.id === id ? pokemonUpdated : pokemon;
  });
  const message = `Le pokémon ${pokemonUpdated.name} à bien été modifié`;
  res.json(success(message, pokemonUpdated));
});

/************METHODE DELETE *******************/
app.delete("/api/pokemons/:id", async (req, res) => {
  const id = parseInt(req.params.id);
  const pokemonDeleted = pokemons.find((pokemon) => pokemon.id === id);
  pokemons = pokemons.map((pokemon) => {
    if (pokemon.id !== id) return pokemon;
  });
  const message = `Le pokemonde ${pokemonDeleted.name} à bien été supprimé`;
  res.json(success(message, pokemonDeleted));
});

/*app.get("/api/pokemons/:id/:name", (req, res) => {
    const id = req.params.id; //Permmet de récupérer les paramètre contenus dans l'url
    const name = req.params.name;
    res.send(`Vous avez demander le pokémon n° : ${id} qui est ${name}`);
  });*/

//PATCH : contrairement à PUT où on doit modifié toute une ressource, PATCH nous permet de modifié un élément particulier de cette ressource. Néanmoins, il n'est pas conseiller de l'utilisé pour les API Rest car si deux personnes essaient de modifié le même élément en même temps, il y'aura un gros risque de conflit ce qui fera cracher notre application.

//BACKEND : Serveur (Node JS) + API Rest(Express) + BDD(SQL)

//Paramètre d'URL :
//api/pokemons/:id <- req.params.id

//Paramètre de REQUETE :
//api/pokemons?name=Bulbizzare <- req.query.name

/*********************************LES CODE DE STATUS ERREURS HTTP *******************/
/*
  - 1XX : L'information
        Communique des informations au niveau du protocole de transfert. Aucune données n'est échanger entre le client et le serveur, on parle de MetaDonnées.

  - 2XX : Le Succès(200, 201, ...)
        Indique que la requête du client à été accepté et traité avec succès et tous s'est passé correctement.
        Il y'a bien eu transfert de la donnée demandé.

  -3XX : La Redirection(301, 302, ...)
        Indique que le client souhaite accéder à une ressource qui à été déplacé.Il faudra éffectuer une deuxième reqête pour aller chercher les données au bon endroit.

  -4XX : Erreur du client(401, 404, ...) de manière gnénérale
        Indique que le client s'est planté dans la requête.
        Exemple : - 404 la ressource n'existe pas ou plus, 
                  - 401 vous n'ête pas authentifié donc pas autorisé à accéder à cette ressource.
                  - 403 le client est authentifié et demande à accédé une ressource non autoriser

  -5XX : Erruer du serveur(500, 503, ...)
        La c'est de la faute du Devéloppeur.Il y'a un problème au niveau du serveur.

*/

//ERREUR TECHNIQUES: qui concerne les catch()

/******************* Les erreurs METIERS : VALIDATEURS ET CONTRAINTES****************************/
//Les règles de VALIDATIONS : Vérifie la conformité des données, bloque la requête en cas de non conformité et génère une Erreur.
/*
    - notEmpty <- Pour vérifié que la valeur n'est pas Empty
    - notNull <- Pour vérifier que la valeur n'est pas Null
    - isInt <- Pour vérifier que c'est bien un entier
    - isUrl <- Pour vérifier que c'est bien un URL
    - isEmail <- Pour vérifier que c'est bien un Email
    - min {args: [valMin], msg: ""} <- Pour définir la valeur minimal d'un Integer
    - max {args: [valMax], msg: ""} <- Pour définir la valeur maxima d'un Integer
    - len {args:[minChar,maxChar], msg:""} <- Pour définir la longueur min et max d'une chaine de caractère.
    - allowNull <- est à la fois un validateur côté JS et d'une contrainte côté SQL
  */

/**/
//Les CONTRAINTES :sont des règles définit au niveau SQL. Donc la requête bonne ou mauvaise est exécuté, puis c'est au niveau du serveur SQL que la demande est rejeter pour que enfin sequilize nous informe ce que s'est passé.

//Validation: Evite une requête inutile -  CONTRAINTE: dernière vérification

//Les paramètres d'URL sont utilisés pour identifier des données spécifiques(Toujours en minuscule)
//Les paramètres de requêtes sont utilisés pour trier ou filtrer des ressources

/******LES OPERATEURS SEQUELIZE******/
/*
    - Op.eq <- fait une recherche en dur dans 
    la base de donnée identique à where {{name: name}} = {
                                                          name : {
                                                            [Op.eq] : name
                                                            }
                                                          }
    - Op.like <- Vérifie si le terme de recherche est contenue dans le nom du pokémon . Attention au %
        * ${name}% : recherche une pokémon qui commence par le terme de recherche
        * %${name} : recherche une pokémon qui se termine par le terme de recherche
        * %${name}% : recherche une pokémon qui commence ou se termine (contient) par le terme de recherche
        
    -limit <- permet de limité le nombre d'éléments retourné par la requête
    -findAndCountAll <- permet de retourné le nombre total d'éléments disponibles de la réponse à la requête ainsi qu'un nombre limité de résultats à retourné
    -findOne <- permet d'aller cherché un élément grâce à un paramètre fournis dans la requête.

    -Order <- Permet de trier une recherche par ordre :
        * Croissant: ['name', 'ASC']
        * Décroissant: ['name', 'DESC']
        * Par défault c'est croissant : ['name']
 */

/*AUTHENTIFICATION : SECURITE DE L'API */
//Il faudra une fonction de hashage
//Il faudra un token(jetton) JWT(JSON WEB TOKEN) : c'est une clé cryptée, avec une durée de validité dans le temps, et qui se présente sous la forme d'une chaîne de caractères.

/*
  authorization : Bearer <JWT>
  Exemple de syntaxe :
  authorization : Bearer jdE98zDdefze82XZDZZD
                                                                                                    
 */

/*
      LES OPTIONS DE LA METHODE SYNC:
      - sync() <- crée une table initiale si il y'en à pas, cependant supprime pas la table table existante en case de redémarage ou bien modification de la table (Utilisé en production).

      - sync({force: true}) <- crée un table, en supprimant celle qui est existante si elle existe bien sur. Exemple une modification, un redemarrage etc... (Utilsisé en dévéloppement).

      - sync({alter:true}) <- vérifie l'état de la table dans la BDD(colonnes, types de données, etc..), puis effectue des modifications nécéssaires de la table pour qu'elle corresponde au model.
                                                                                                    
  */

/*
    LES POLITIQUES DE SECURITES
    - SAME ORIGIN : Une page web hébergé sur un serveur ne peut intéragir qu'avec les ressources herberger sur le même serveur. (API REST - IMG - POLICES DE TEXTES - BDD).

    - CROSS ORIGIN (CORS) : Cross Origin Ressources Sharing elle nous permet d'effectuer des requêtes en dehors de l'origine de départ.
                  * QUI : peut accédé (GET, POST )
                  * Comment : requêtes autorisé (PATCH, DELETE, UPDATE, PUT)

*/