@communecter/cocolight-api-client 1.0.7 → 1.0.8

package/src/api/Organization.js

@@ -1,4 +1,6 @@
 import { EntityMixin } from "./EntityMixin.js";
+import { NewsMixin } from "./NewsMixin.js";
+import { UtilMixin } from "./UtilMixin.js";
 
 // Organization.js
 export class Organization {
@@ -26,6 +28,10 @@ export class Organization {
   get id() {
     return this.#id;
   }
+
+  _id(newId) {
+    this.#id = newId;
+  }
       
   get slug() {
     return this.#slug;
@@ -64,16 +70,62 @@ export class Organization {
      *
      * @returns {Promise<Object>} Le profil complet.
      */
-  async getProfile() {
+  async getProfil() {
     return this.apiClient.safeCall(async () => {
-      const response = await this.getPublicProfile();
-      this._setData(response.data);
-      return response.data;
+      const data = await this.getPublicProfile();
+      this._setData(data);
+      return data;
     });
   }
   
+  /**
+   * Récupérer les actualités : Récupère la liste d’actualités selon plusieurs critères.
+   * Constant : GET_NEWS
+   * @param {Object} data - Les données à envoyer.
+   * @param {number} data.dateLimit - Limite de date timestamp ou 0 (default: 0)
+   * @param {object} data.search - data.search
+   * @param {string} data.search.name - Nom ou terme recherché (default: "")
+   * @param {number} data.indexStep - Nombre de résultats par page (default: 12)
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async getNews(data = {}) {
+    data.pathParams = { type: this.getEntityType(), id: this.id };
+    return this._getNews(data);
+  }
+
+  /**
+   * Ajouter une actualité : Ajoute une nouvelle actualité.
+   * Constant : ADD_NEWS
+   * @param {Object} data - Les données à envoyer.
+   * @param {string} data.text - Contenu de l’actualité
+   * @param {string} data.scope - Portée de l'actualité (ex: public, privé...) (default: "public")
+   * @param {boolean} data.markdownActive - Markdown activé (true/false) (default: true)
+   * @param {string} data.type - Type de l'objet, toujours 'news'. (default: "news")
+   * @param {boolean} data.json - Indique que la réponse est au format JSON. (default: true)
+   * @param {array | string} data.tags - Tags : "" pour effacer tous les tags, ou tableau de mots-clés.
+   * @param {object} data.mediaImg - Optionnel. Informations sur les images associées à la news.
+   * @param {number} data.mediaImg.countImages - Nombre d'images.
+   * @param {Array<string>} data.mediaImg.images - Liste des identifiants ou chemins d'images.
+   * @param {object} data.mediaFile - Optionnel. Informations sur les fichiers associés à la news.
+   * @param {number} data.mediaFile.countFiles - Nombre de fichiers.
+   * @param {Array<string>} data.mediaFile.files - Liste des identifiants ou chemins de fichiers.
+   * @param {object} data.mentions - Liste des mentions sous forme d'objet avec des clés dynamiques représentant l'indice de la mention.
+   * @param {Object.<string, object>} data.mentions - Objet dont les clés keys matching ^[0-9]+$
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async addNews(data = {}) {
+    data.parentId = this.id;
+    data.parentType = this.getEntityType();
+    return this.callIsConnected(() => this._addNews(data));
+  }
+    
 }
 
 // Incorporation du mixin dans Organization
-Object.assign(Organization.prototype, EntityMixin);
+Object.assign(Organization.prototype, EntityMixin, UtilMixin, NewsMixin);
   

package/src/api/Project.js

@@ -1,4 +1,6 @@
 import { EntityMixin } from "./EntityMixin.js";
+import { NewsMixin } from "./NewsMixin.js";
+import { UtilMixin } from "./UtilMixin.js";
 
 // Project.js
 export class Project {
@@ -26,6 +28,10 @@ export class Project {
   get id() {
     return this.#id;
   }
+
+  _id(newId) {
+    this.#id = newId;
+  }
       
   get slug() {
     return this.#slug;
@@ -64,16 +70,62 @@ export class Project {
      *
      * @returns {Promise<Object>} Le profil complet.
      */
-  async getProfile() {
+  async getProfil() {
     return this.apiClient.safeCall(async () => {
-      const response = await this.getPublicProfile();
-      this._setData(response.data);
-      return response.data;
+      const data = await this.getPublicProfile();
+      this._setData(data);
+      return data;
     });
   }
+
+  /**
+   * Récupérer les actualités : Récupère la liste d’actualités selon plusieurs critères.
+   * Constant : GET_NEWS
+   * @param {Object} data - Les données à envoyer.
+   * @param {number} data.dateLimit - Limite de date timestamp ou 0 (default: 0)
+   * @param {object} data.search - data.search
+   * @param {string} data.search.name - Nom ou terme recherché (default: "")
+   * @param {number} data.indexStep - Nombre de résultats par page (default: 12)
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async getNews(data = {}) {
+    data.pathParams = { type: this.getEntityType(), id: this.id };
+    return this._getNews(data);
+  }
+
+  /**
+   * Ajouter une actualité : Ajoute une nouvelle actualité.
+   * Constant : ADD_NEWS
+   * @param {Object} data - Les données à envoyer.
+   * @param {string} data.text - Contenu de l’actualité
+   * @param {string} data.scope - Portée de l'actualité (ex: public, privé...) (default: "public")
+   * @param {boolean} data.markdownActive - Markdown activé (true/false) (default: true)
+   * @param {string} data.type - Type de l'objet, toujours 'news'. (default: "news")
+   * @param {boolean} data.json - Indique que la réponse est au format JSON. (default: true)
+   * @param {array | string} data.tags - Tags : "" pour effacer tous les tags, ou tableau de mots-clés.
+   * @param {object} data.mediaImg - Optionnel. Informations sur les images associées à la news.
+   * @param {number} data.mediaImg.countImages - Nombre d'images.
+   * @param {Array<string>} data.mediaImg.images - Liste des identifiants ou chemins d'images.
+   * @param {object} data.mediaFile - Optionnel. Informations sur les fichiers associés à la news.
+   * @param {number} data.mediaFile.countFiles - Nombre de fichiers.
+   * @param {Array<string>} data.mediaFile.files - Liste des identifiants ou chemins de fichiers.
+   * @param {object} data.mentions - Liste des mentions sous forme d'objet avec des clés dynamiques représentant l'indice de la mention.
+   * @param {Object.<string, object>} data.mentions - Objet dont les clés keys matching ^[0-9]+$
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async addNews(data = {}) {
+    data.parentId = this.id;
+    data.parentType = this.getEntityType();
+    return this.callIsConnected(() => this._addNews(data));
+  }
   
 }
 
 // Incorporation du mixin dans Project
-Object.assign(Project.prototype, EntityMixin);
+Object.assign(Project.prototype, EntityMixin, UtilMixin, NewsMixin);
   

package/src/api/User.js

@@ -1,4 +1,8 @@
+import { ApiResponseError } from "../error.js";
 import { EntityMixin } from "./EntityMixin.js";
+import { NewsMixin } from "./NewsMixin.js";
+import { UserMixin } from "./UserMixin.js";
+import { UtilMixin } from "./UtilMixin.js";
 
 // User.js
 export class User {
@@ -28,6 +32,10 @@ export class User {
   get id() {
     return this.#id;
   }
+
+  _id(newId) {
+    this.#id = newId;
+  }
   
   get slug() {
     return this.#slug;
@@ -70,20 +78,149 @@ export class User {
      *
      * @returns {Promise<Object>} Le profil complet.
      */
-  async getProfile() {
+  async getProfil() {
     return this.apiClient.safeCall(async () => {
       if (this.isMe) {
-        const response = await this.apiClient.callEndpoint("ME_INFO_URL", {});
-        return response.data;
+        const data = await this._meInfoUrl();
+        return data;
       } else {
-        const response = await this.getPublicProfile();
-        return response.data;
+        const data = await this.getPublicProfile();
+        return data;
       }
     });
   }
+
+  /**
+   * Changer le mot de passe : Permet de changer le mot de passe d'un utilisateur.
+   * Constant : CHANGE_PASSWORD
+   */
+  async changePassword(data = {}) {
+    return this.callIsMe(() => this._changePassword(data));
+  }
+
+  /**
+   * Supprimer un compte : Permet de supprimer un compte utilisateur.
+   * Constant : DELETE_ACCOUNT
+   */
+  async delete(data = {}) {
+    return this.callIsMe(() => this._deleteAccount(data));
+  }
+  
+  /**
+   * Mettre à jour les paramètres utilisateur : Mise à jour des paramètres spécifiques d'un utilisateur.
+   * Constant : UPDATE_SETTINGS
+   */
+  async updateSettings(data = {}) {
+    return this.callIsMe(() => this._updateSettings(data));
+  }
+
+  /**
+   * Mettre à jour la description d'un élément : Permet de mettre à jour la description courte et complète d'un élément.
+   * Constant : UPDATE_BLOCK_DESCRIPTION
+   */
+  async updateDescription(data = {}) {
+    return this.callIsMe(() => this._updateBlockDescription(data));
+  }
+  
+  /**
+     * Mettre à jour les informations d'un élément : Permet de mettre à jour les informations générales d'un élément (nom, contacts, etc.).
+     * Constant : UPDATE_BLOCK_INFO
+     */
+  async updateInfo(data = {}) {
+    return this.callIsMe(() => this._updateBlockInfo(data));
+  }
+  
+  /**
+     * Mettre à jour les réseaux sociaux d'un élément : Permet de mettre à jour les liens vers les réseaux sociaux d'un élément.
+     * Constant : UPDATE_BLOCK_SOCIAL
+     */
+  async updateSocial(data = {}) {
+    return this.callIsMe(() => this._updateBlockSocial(data));
+  }
   
+  /**
+     * Mettre à jour les localités d'un élément : Permet de mettre à jour l'adresse et les informations géographiques d'un élément.
+     * Constant : UPDATE_BLOCK_LOCALITY
+     */
+  async updateLocality(data = {}) {
+    return this.callIsMe(() => this._updateBlockLocality(data));
+  }
+  
+  /**
+     * Mettre à jour le slug d'un élément : Permet de mettre à jour le slug pour une URL simplifiée.
+     * Constant : UPDATE_BLOCK_SLUG
+     */
+  async updateSlug(slug) {
+    try {
+      await this._check({ slug });
+    } catch (error) {
+      if(error instanceof ApiResponseError) {
+        throw new ApiResponseError("Erreur lors de la vérification du slug.", error.status, error.data);
+      }
+      throw error;
+    }
+    return this.callIsMe(() => this._updateBlockSlug({ slug }));
+  }
+
+  /**
+   * Mettre à jour l'image de profil : Permet de mettre à jour l'image de profil d'un utilisateur ou d'une entité.
+   * Constant : PROFIL_IMAGE
+   */
+  async updateImageProfil(image) {
+    image = await this.validateImage(image);
+    return this.callIsMe(() => this._profilImage({ profil_avatar: image }));
+  }
+
+  /**
+   * Récupérer les actualités : Récupère la liste d’actualités selon plusieurs critères.
+   * Constant : GET_NEWS
+   */
+  async getNews(data = {}) {
+    if (data.pathParams) {
+      delete data.pathParams;
+    }
+    if (!this.isMe){
+      // is not me add id
+      data.pathParams = { id: this.id };
+    }
+    return this._getNews(data);
+  }
+
+  /**
+   * Ajouter une actualité : Ajoute une nouvelle actualité.
+   * Constant : ADD_NEWS
+   * @param {Object} data - Les données à envoyer.
+   * @param {string} data.text - Contenu de l’actualité
+   * @param {string} data.scope - Portée de l'actualité (ex: public, privé...) (default: "public")
+   * @param {boolean} data.markdownActive - Markdown activé (true/false) (default: true)
+   * @param {string} data.type - Type de l'objet, toujours 'news'. (default: "news")
+   * @param {boolean} data.json - Indique que la réponse est au format JSON. (default: true)
+   * @param {array | string} data.tags - Tags : "" pour effacer tous les tags, ou tableau de mots-clés.
+   * @param {object} data.mediaImg - Optionnel. Informations sur les images associées à la news.
+   * @param {number} data.mediaImg.countImages - Nombre d'images.
+   * @param {Array<string>} data.mediaImg.images - Liste des identifiants ou chemins d'images.
+   * @param {object} data.mediaFile - Optionnel. Informations sur les fichiers associés à la news.
+   * @param {number} data.mediaFile.countFiles - Nombre de fichiers.
+   * @param {Array<string>} data.mediaFile.files - Liste des identifiants ou chemins de fichiers.
+   * @param {object} data.mentions - Liste des mentions sous forme d'objet avec des clés dynamiques représentant l'indice de la mention.
+   * @param {Object.<string, object>} data.mentions - Objet dont les clés keys matching ^[0-9]+$
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async addNews(data = {}) {
+    if (data.parentId) {
+      delete data.parentId;
+    }
+    if (data.parentType) {
+      delete data.parentType;
+    }
+    return this.callIsMe(() => this._addNews(data));
+  }
+    
 }
 
-// Incorporation du mixin dans User
-Object.assign(User.prototype, EntityMixin);
+// Incorporation des mixins dans User
+Object.assign(User.prototype, EntityMixin, UtilMixin, UserMixin, NewsMixin);
   

package/src/api/UserMixin.js

@@ -0,0 +1,59 @@
+// eslint-disable-next-line no-unused-vars
+import { ApiResponseError } from "../error.js";
+
+// UserMixin.js
+export const UserMixin = {
+
+  /**
+   * Récupérer les informations utilisateur : Récupère les informations du profil utilisateur pour un token donné.
+   * Constant : ME_INFO_URL
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async _meInfoUrl() {
+    return this.callIsConnected("ME_INFO_URL");
+  },
+
+  /**
+   * Changer le mot de passe : Permet de changer le mot de passe d'un utilisateur.
+   * Constant : CHANGE_PASSWORD
+   * @param {Object} data - Les données à envoyer.
+   * @param {string} data.oldPassword - Ancien mot de passe
+   * @param {string} data.newPassword - Nouveau mot de passe
+   * @param {string} data.newPassword2 - Confirmation du nouveau mot de passe
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async _changePassword(data = {}) {
+    if(data.userId) {
+      delete data.userId;
+    }
+    if(data.mode) {
+      delete data.mode;
+    }
+    return this.callIsConnected("CHANGE_PASSWORD", data);
+  },
+
+  /**
+   * Supprimer un compte : Permet de supprimer un compte utilisateur.
+   * Constant : DELETE_ACCOUNT
+   * @param {Object} data - Les données à envoyer.
+   * @param {string} data.reason - Raison de la suppression (default: "")
+   * @returns {Promise<Object>} - Les données de réponse.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async _deleteAccount(data = {}) {
+    if (data.pathParams) {
+      delete data.pathParams;
+    }
+    return this.callIsConnected("DELETE_ACCOUNT", data);
+  }
+
+};
+  

package/src/api/UtilMixin.js

@@ -0,0 +1,82 @@
+import { fileTypeFromBuffer } from "file-type";
+
+import { ApiAuthenticationError, ApiValidationError } from "../error.js";
+
+// UtilMixin.js
+export const UtilMixin = {
+
+  async call(constant, data = {}) {
+    return this.apiClient.safeCall(async () => {
+      const response = await this.apiClient.callEndpoint(constant, data);
+      this.apiClient.checkAndThrowApiResponseError(response);
+      return response.data;
+    });
+  },
+
+  async callNoConnected(constant, data = {}) {
+    if(this.isConnected) {
+      throw new ApiAuthenticationError("Vous devez ne devez pas être connecté pour faire cette action.");
+    }
+    return this.call(constant, data);
+  },
+
+  async callIsConnected(param, data = {}) {
+    if(!this.isConnected) {
+      throw new ApiAuthenticationError("Vous devez être connecté pour faire cette action.");
+    }
+    // Si le premier paramètre est une fonction, on l'exécute en tant que callback
+    if (typeof param === "function") {
+      return await param();
+    }
+    return this.call(param, data);
+  },
+
+  async callIsMe(param, data = {}) {
+    if (!this.isMe) {
+      throw new ApiAuthenticationError("Vous devez être vous-même pour faire cette action.");
+    }
+    // Si le premier paramètre est une fonction, on l'exécute en tant que callback
+    if (typeof param === "function") {
+      return await param();
+    }
+    // Sinon, on considère qu'il s'agit d'un constant et on appelle la méthode par défaut
+    return await this.callIsConnected(param, data);
+  },
+
+  async validateImage(image) {
+    if (!image) {
+      throw new ApiValidationError("Le fichier est requis.");
+    }
+    let mimeType = "";
+    
+    // Vérification en navigateur : File et Blob
+    if (typeof File !== "undefined" && image instanceof File) {
+      mimeType = image.type;
+      if (!mimeType || !mimeType.startsWith("image/") || !["image/jpg", "image/jpeg", "image/png"].includes(mimeType)) {
+        throw new ApiValidationError("Le fichier doit être une image valide.");
+      }
+    } else if (typeof Blob !== "undefined" && image instanceof Blob) {
+      mimeType = image.type;
+      // rajouter un name au blob avce timestamp et la bonne extension
+      const fileName = `${Date.now()}.${mimeType.split("/")[1]}`;
+      image = new File([image], fileName, { type: mimeType });
+      console.log(fileName);
+
+      if (!mimeType || !mimeType.startsWith("image/") || !["image/jpg", "image/jpeg", "image/png"].includes(mimeType)) {
+        throw new ApiValidationError("Le fichier doit être une image valide (jpg ou png).");
+      }
+    }
+    // Vérification en Node : image peut être un Buffer
+    else if (typeof Buffer !== "undefined" && Buffer.isBuffer(image)) {
+      const fileTypeResult = await fileTypeFromBuffer(image);
+      if (!fileTypeResult || !fileTypeResult.mime.startsWith("image/") || !["image/jpg", "image/jpeg", "image/png"].includes(fileTypeResult.mime)) {
+        throw new ApiValidationError("Le fichier doit être une image valide.");
+      }
+      mimeType = fileTypeResult.mime;
+    } else {
+      throw new ApiValidationError("Le fichier doit être de type File (navigateur) ou Buffer (Node).");
+    }
+    return image;
+  }
+};
+