@communecter/cocolight-api-client 1.0.22 → 1.0.24

package/src/api/EndpointApi.js

@@ -792,17 +792,17 @@ class EndpointApi {
     
   /**
    * Récupérer les contributeurs non administrables : Récupère les contributeurs sans droits d’admin.
-   * Constant : GET_CONTRIBUTORS
-   * @param {import("./EndpointApi.types").GetContributorsData} data - Données envoyées à l'API
+   * Constant : GET_CONTRIBUTORS_NO_ADMIN
+   * @param {import("./EndpointApi.types").GetContributorsNoAdminData} data - Données envoyées à l'API
    * @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 getContributors(data) {
+  async getContributorsNoAdmin(data) {
     if (!data || typeof data !== "object") {
       throw new TypeError("Le paramètre data doit être un objet.");
     }
-    return this.call("GET_CONTRIBUTORS", data);
+    return this.call("GET_CONTRIBUTORS_NO_ADMIN", data);
   }
     
   /**
@@ -1332,6 +1332,22 @@ class EndpointApi {
     return this.callIsConnected("INVITE_EVENT", data);
   }
     
+  /**
+   * Suivre un utilisateur ou un élément : Suivre un utilisateur ou un élément.
+   * Constant : FOLLOW
+   * @param {import("./EndpointApi.types").FollowData} data - Données envoyées à l'API
+   * @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 follow(data) {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.callIsConnected("FOLLOW", data);
+  }
+    
 }
 
 export default EndpointApi;

package/src/api/EndpointApi.types.d.ts

@@ -1809,7 +1809,7 @@ export interface GetSubscribersAdminData {
 }
 
 
-export interface GetContributorsData {
+export interface GetContributorsNoAdminData {
   /**
    * Nom ou terme recherché
    */
@@ -2116,7 +2116,7 @@ export interface DisconnectData {
   /**
    * Type de connexion
    */
-  connectType: "admin" | "member" | "contributor" | "attendee" | "friend";
+  connectType: "members" | "contributors" | "attendees" | "friends" | "followers";
   [k: string]: unknown;
 }
 
@@ -3461,3 +3461,24 @@ export interface InviteEventData {
   };
   [k: string]: unknown;
 }
+
+
+export interface FollowData {
+  /**
+   * ID de l'élément à suivre (projet, organisation...)
+   */
+  childId: string;
+  /**
+   * Type de l'élément à suivre
+   */
+  childType: "citoyens";
+  /**
+   * Type de l'élément parent (projet, organisation...)
+   */
+  parentType: "citoyens" | "organizations" | "projects" | "events";
+  /**
+   * ID de l'élément parent
+   */
+  parentId: string;
+  [k: string]: unknown;
+}

package/src/api/Event.js

@@ -1,3 +1,4 @@
+import { ApiError } from "../error.js";
 import BaseEntity from "./BaseEntity.js";
 
 export class Event extends BaseEntity {
@@ -38,7 +39,7 @@ export class Event extends BaseEntity {
 
   async _add(payload) {
     if (!this._calledFromSave) {
-      throw new Error("utilisation invalide de _add, utilisez save");
+      throw new ApiError("utilisation invalide de _add, utilisez save");
     }
 
     payload.id = this._newId?.();
@@ -62,8 +63,12 @@ export class Event extends BaseEntity {
   }
 
   async _update(payload) {
+    if(!this.isAdmin()){
+      throw new ApiError("Vous n'avez pas les droits pour modifier cet événement", 403);
+    }
+
     if (!this._calledFromSave) {
-      throw new Error("utilisation invalide de _update, utilisez save");
+      throw new ApiError("utilisation invalide de _update, utilisez save");
     }
 
     if (payload.id) delete payload.id;
@@ -87,23 +92,23 @@ export class Event extends BaseEntity {
   }
 
   async getOrganizations() {
-    throw new Error(`getOrganizations n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getOrganizations n'existe pas dans ${this.constructor.name}`);
   }
 
   async getProjects() {
-    throw new Error(`getProjects n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getProjects n'existe pas dans ${this.constructor.name}`);
   }
 
   async getEvents() {
-    throw new Error(`getEvents - les sous-events ne sont pas encore implémentés dans ${this.constructor.name}`);
+    throw new ApiError(`getEvents - les sous-events ne sont pas encore implémentés dans ${this.constructor.name}`);
   }
 
   async getPois() {
-    throw new Error(`getPois n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getPois n'existe pas dans ${this.constructor.name}`);
   }
 
   async getBadgesIssuer() {
-    throw new Error(`getBadgesIssuer n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getBadgesIssuer n'existe pas dans ${this.constructor.name}`);
   }
 
   async getNews(data = {}) {
@@ -115,19 +120,19 @@ export class Event extends BaseEntity {
   }
 
   async project() {
-    throw new Error(`project n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`project n'existe pas dans ${this.constructor.name}`);
   }
 
   async poi() {
-    throw new Error(`poi n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`poi n'existe pas dans ${this.constructor.name}`);
   }
 
   async event() {
-    throw new Error(`les sous-events ne sont pas encore implémentés dans ${this.constructor.name}`);
+    throw new ApiError(`les sous-events ne sont pas encore implémentés dans ${this.constructor.name}`);
   }
 
   async badge() {
-    throw new Error(`badge n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`badge n'existe pas dans ${this.constructor.name}`);
   }
 
   /**
@@ -141,4 +146,26 @@ export class Event extends BaseEntity {
     return super.news(newsData);
   }
 
+  /**
+   * Suivre un événement.
+   * Cette action permet à l'utilisateur de suivre un événement.
+   * 
+   * @returns {Promise<Object>} - Résultat de l'action de suivi.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité ne supporte pas l'action.
+   */
+  async follow() {
+    return super.follow();
+  }
+
+  /**
+   * Se désabonne d'un événement.
+   * 
+   * @returns {Promise<Object>} - Résultat de la désinscription.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité n'est pas enregistrée.
+   */
+  async unfollow() {
+    return super.unfollow();
+  }
+  
+
 }

package/src/api/Organization.js

@@ -1,4 +1,4 @@
-import { ApiResponseError } from "../error.js";
+import { ApiError, ApiResponseError } from "../error.js";
 import BaseEntity from "./BaseEntity.js";
 
 export class Organization extends BaseEntity {
@@ -52,7 +52,7 @@ export class Organization extends BaseEntity {
 
   async _add(payload) {
     if (!this._calledFromSave) {
-      throw new Error("utilisation invalide de _add, utilisez save");
+      throw new ApiError("utilisation invalide de _add, utilisez save");
     }
 
     payload.id = this._newId?.();
@@ -76,8 +76,12 @@ export class Organization extends BaseEntity {
   }
 
   async _update(payload) {
+    if(!this.isAdmin()){
+      throw new ApiError("Vous n'avez pas les droits pour modifier cette organisation", 403);
+    }
+
     if (!this._calledFromSave) {
-      throw new Error("utilisation invalide de _update, utilisez save");
+      throw new ApiError("utilisation invalide de _update, utilisez save");
     }
 
     if (payload.id) delete payload.id;
@@ -106,7 +110,7 @@ export class Organization extends BaseEntity {
 
 
   async getOrganizations() {
-    throw new Error("getOrganizations n'existe pas dans Organization");
+    throw new ApiError("getOrganizations n'existe pas dans Organization");
   }
 
   async getProjects(data = {}) {
@@ -114,7 +118,7 @@ export class Organization extends BaseEntity {
   }
 
   async getEvents() {
-    throw new Error("getEvents pas encore implémenté dans Organization");
+    throw new ApiError("getEvents pas encore implémenté dans Organization");
   }
 
   async getPois(data = {}) {
@@ -138,25 +142,55 @@ export class Organization extends BaseEntity {
    * Constant : GET_MEMBERS_ADMIN / GET_MEMBERS_NO_ADMIN
    * @param {Object} data - Les données de requête.
    * @param {Object} options - Options supplémentaires.
+   * @param {boolean} options.toBeValidated - Indique si les membres doivent être validés.
    * @param {boolean} options.isAdmin - Indique si l'utilisateur est admin.
+   * @param {boolean} options.isAdminPending - Indique si l'utilisateur est en attente de validation pour être admin.
    * @param {boolean} options.isInviting - Indique si l'utilisateur est en attente d'invitation.
    * @param {Array} options.roles - Liste des rôles à filtrer.
    * @returns {Promise<Object>} - Un objet contenant le nombre de membres et la liste des membres.
+   * @throws {ApiResponseError} - Si une erreur se produit lors de la récupération des contributeurs.
+   * 
+   * @example
+   * // Récupérer tous les membres
+   * const members = await organization.getMembers();
+   * 
+   * // Récupérer les membres avec validation en attente
+   * const membersToBeValidated = await organization.getMembers({}, { toBeValidated: true });
+   * 
+   * // Récupérer les membres avec un rôle spécifique
+   * const membersWithRole = await organization.getMembers({}, { roles: ['admin'] });
+   * 
+   * // Récupérer les membres en attente d'invitation
+   * const invitingMembers = await organization.getMembers({}, { isInviting: true });
+   * 
+   * // Récupérer les membres admin
+   * const adminMembers = await organization.getMembers({}, { isAdmin: true });
+   * 
+   * // Récupérer les membres admin et en attente d'invitation
+   * const adminInvitingMembers = await organization.getMembers({}, { isAdmin: true, isInviting: true });
+   * 
+   * // Récupérer les membres avec validation en attente et admin
+   * const adminToBeValidatedMembers = await organization.getMembers({}, { toBeValidated: true, isAdmin: true });
+   * 
+   * // Récupérer les membres en attente de validation pour être admin
+   * const adminPendingMembers = await organization.getMembers({}, { isAdminPending: true });
+   * 
+   * 
    */
   async getMembers(data = {}, options = {}) {
-    const { isAdmin, isInviting, roles = [] } = options;
+    const { toBeValidated, isAdmin, isAdminPending, isInviting, roles = [] } = options;
 
     if(this.isMe){
       data.pathParams = { type: this.getEntityType(), id: this.id };
-      // NOTE : dans le schema je crois que si pas de data.filters alors le default ce fait avec data.pathParams
       // data.filters = {
       //   [`links.memberOf.${this.id}`]: { "$exists": true },
       //   [`links.memberOf.${this.id}.toBeValidated`]: { "$exists": false },
       //   [`links.memberOf.${this.id}.isInviting`]: { "$exists": false }
       // };
+      data.filters = this._buildLinkFilters(this.id, { linkType: "memberOf", toBeValidated, isAdmin, isAdminPending, isInviting, roles });
     } else {
       delete data?.pathParams;
-      data.filters = this._buildMemberFilters(this.id, { isAdmin, isInviting, roles });
+      data.filters = this._buildLinkFilters(this.id, { linkType: "memberOf", toBeValidated: "false", isAdmin, isInviting, roles });
     }
   
     const fetchFn = this.isMe
@@ -172,43 +206,11 @@ export class Organization extends BaseEntity {
     const rawList = this._linkEntities(arrayObjet.results);
 
     return {
-      count: arrayObjet.count?.poi ?? 0,
+      count: arrayObjet.count,
       results: rawList
     };
   }
 
-  _buildMemberFilters(id, { isAdmin, isInviting, roles }) {
-
-    if (typeof isAdmin !== "undefined" && typeof isAdmin !== "boolean") {
-      throw new TypeError("isAdmin doit être un booléen.");
-    }
-    if (typeof isInviting !== "undefined" && typeof isInviting !== "boolean") {
-      throw new TypeError("isInviting doit être un booléen.");
-    }
-    if (!Array.isArray(roles)) {
-      throw new TypeError("roles doit être un tableau de chaînes.");
-    }
-    
-    const filters = {
-      [`links.memberOf.${id}`]: { $exists: true },
-      [`links.memberOf.${id}.toBeValidated`]: { $exists: false }
-    };
-  
-    if (isInviting === true || isInviting === false) {
-      filters[`links.memberOf.${id}.isInviting`] = { $exists: isInviting };
-    }
-  
-    if (isAdmin === true) {
-      filters[`links.memberOf.${id}.isAdmin`] = { $exists: true };
-    }
-  
-    if (Array.isArray(roles) && roles.length > 0) {
-      filters[`links.memberOf.${id}.roles`] = { $in: roles };
-    }
-  
-    return filters;
-  }
-
   /**
    * Crée une instance de projet et récupère son profil si nécessaire.
    *
@@ -217,7 +219,9 @@ export class Organization extends BaseEntity {
    * @throws {Error} Si une erreur se produit lors de la création du projet.
    */
   async project(projectData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
+    if(!this.isAdmin()){
+      throw new ApiError("Vous n'avez pas les droits pour créer un projet dans cette organisation", 403);
+    }
     return super.project(projectData);
   }
 
@@ -229,7 +233,9 @@ export class Organization extends BaseEntity {
    * @throws {Error} Si une erreur se produit lors de la création du POI.
    */
   async poi(poiData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
+    if(!this.isAdmin()){
+      throw new ApiError("Vous n'avez pas les droits pour créer un projet dans cette organisation", 403);
+    }
     return super.poi(poiData);
   }
 
@@ -241,7 +247,9 @@ export class Organization extends BaseEntity {
    * @throws {Error} Si une erreur se produit lors de la création de l'événement.
    */
   async event(eventData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
+    if(!this.isAdmin()){
+      throw new ApiError("Vous n'avez pas les droits pour créer un projet dans cette organisation", 403);
+    }
     return super.event(eventData);
   }
 
@@ -253,7 +261,9 @@ export class Organization extends BaseEntity {
    * @throws {Error} Si une erreur se produit lors de la création du badge.
    */
   async badge(badgeData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
+    if(!this.isAdmin()){
+      throw new ApiError("Vous n'avez pas les droits pour créer un projet dans cette organisation", 403);
+    }
     return super.badge(badgeData);
   }
 
@@ -265,7 +275,81 @@ export class Organization extends BaseEntity {
    * @throws {Error} Si une erreur se produit lors de la création de la news.
    */
   async news(newsData = {}) {
+    // TODO: qui peut créer une news sur l'organisation ?
     return super.news(newsData);
   }
+  
+  /**
+   * ───────────────────────────────
+   *  Lien utilisateur ↔ organisation
+   *  (rejoindre, valider, quitter, devenir admin)
+   * ───────────────────────────────
+   */
+
+
+  /**
+   * Envoie une demande pour rejoindre l'organisation en tant que membre.
+   * L'action est soumise à validation par un administrateur de l'organisation.
+   *
+   * @returns {Promise<Object>} - Résultat de la requête d'adhésion.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité ne supporte pas l'action.
+   */
+  async requestToJoin(){
+    return super.requestToJoin();
+  }
+
+  /**
+   * Envoie une demande pour rejoindre l'organisation en tant qu'administrateur.
+   * L'action est soumise à validation par un administrateur existant.
+   *
+   * @returns {Promise<Object>} - Résultat de la requête d'administration.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité ne supporte pas l'action.
+   */
+  async requestToJoinAdmin(){
+    return super.requestToJoinAdmin();
+  }
+
+  /**
+   * Accepte une invitation à rejoindre l'organisation.
+   * Cette action valide un lien en attente avec l'option `isInviting`.
+   *
+   * @returns {Promise<Object>} - Résultat de la validation du lien.
+   * @throws {ApiError} - Si aucune invitation n'est en attente ou si l'entité ne supporte pas l'action.
+   */
+  async acceptInvitation(){
+    return super.acceptInvitation();
+  }
+
+  /**
+   * Quitte l'organisation, que ce soit en tant que membre ou administrateur.
+   * Cette action supprime le lien entre l'utilisateur et l'organisation.
+   *
+   * @returns {Promise<Object>} - Résultat de la déconnexion.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou non membre.
+   */
+  async leave() {
+    return super.leave();
+  }
+
+  /**
+   * Suivre une organisation.
+   * Cette action permet à l'utilisateur de suivre l'organisation.
+   * 
+   * @returns {Promise<Object>} - Résultat de l'action de suivi.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité ne supporte pas l'action.
+   */
+  async follow() {
+    return super.follow();
+  }
+
+  /**
+   * Se désabonne d'une organisation.
+   * 
+   * @returns {Promise<Object>} - Résultat de la désinscription.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité n'est pas enregistrée.
+   */
+  async unfollow() {
+    return super.unfollow();
+  }
 
 }

package/src/api/Poi.js

@@ -1,3 +1,4 @@
+import { ApiError } from "../error.js";
 import BaseEntity from "./BaseEntity.js";
 
 export class Poi extends BaseEntity {
@@ -39,7 +40,7 @@ export class Poi extends BaseEntity {
 
   async _add(payload) {
     if (!this._calledFromSave) {
-      throw new Error("utilisation invalide de _add, utilisez save");
+      throw new ApiError("utilisation invalide de _add, utilisez save");
     }
 
     payload.id = this._newId?.();
@@ -63,8 +64,11 @@ export class Poi extends BaseEntity {
   }
 
   async _update(payload) {
+    if(!this.isAuthor()){
+      throw new ApiError("Vous n'avez pas les droits pour modifier ce POI", 403);
+    }
     if (!this._calledFromSave) {
-      throw new Error("utilisation invalide de _update, utilisez save");
+      throw new ApiError("utilisation invalide de _update, utilisez save");
     }
 
     if (payload.id) delete payload.id;
@@ -101,23 +105,23 @@ export class Poi extends BaseEntity {
   }
 
   async getOrganizations() {
-    throw new Error(`getOrganizations n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getOrganizations n'existe pas dans ${this.constructor.name}`);
   }
 
   async getProjects() {
-    throw new Error(`getProjects n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getProjects n'existe pas dans ${this.constructor.name}`);
   }
 
   async getEvents() {
-    throw new Error(`getEvents n'existe pas dans${this.constructor.name}`);
+    throw new ApiError(`getEvents n'existe pas dans${this.constructor.name}`);
   }
 
   async getPois() {
-    throw new Error(`getPois n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getPois n'existe pas dans ${this.constructor.name}`);
   }
 
   async getBadgesIssuer() {
-    throw new Error(`getBadgesIssuer n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getBadgesIssuer n'existe pas dans ${this.constructor.name}`);
   }
 
   async getNews(data = {}) {
@@ -129,19 +133,19 @@ export class Poi extends BaseEntity {
   }
 
   async project() {
-    throw new Error(`project n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`project n'existe pas dans ${this.constructor.name}`);
   }
 
   async poi() {
-    throw new Error(`poi n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`poi n'existe pas dans ${this.constructor.name}`);
   }
 
   async event() {
-    throw new Error(`event n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`event n'existe pas dans ${this.constructor.name}`);
   }
 
   async badge() {
-    throw new Error(`badge n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`badge n'existe pas dans ${this.constructor.name}`);
   }
 
   /**
@@ -149,10 +153,32 @@ export class Poi extends BaseEntity {
    * 
    * @param {Object} newsData - Les données nécessaires pour initialiser la news.
    * @returns {Promise<News>} Une promesse qui résout l'objet News créé.
-   * @throws {Error} Si une erreur se produit lors de la création de la news.
+   * @throws {ApiError} Si une erreur se produit lors de la création de la news.
    */
   async news(newsData = {}) {
     return super.news(newsData);
   }
+
+  /**
+   * Suivre un POI.
+   * Cette action permet à l'utilisateur de suivre un POI.
+   * 
+   * @returns {Promise<Object>} - Résultat de l'action de suivi.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité ne supporte pas l'action.
+   */
+  async follow() {
+    return super.follow();
+  }
+
+  /**
+   * Se désabonne d'un POI.
+   * 
+   * @returns {Promise<Object>} - Résultat de la désinscription.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité n'est pas enregistrée.
+   */
+  async unfollow() {
+    return super.unfollow();
+  }
+
   
 }