@communecter/cocolight-api-client 1.0.23 → 1.0.25

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@communecter/cocolight-api-client",
-    "version": "1.0.23",
+    "version": "1.0.25",
     "description": "Client Axios simplifié pour l'API cocolight",
     "repository": {
         "type": "git",

package/src/api/Badge.js

@@ -1,3 +1,4 @@
+import { ApiError } from "../error.js";
 import BaseEntity from "./BaseEntity.js";
 
 export class Badge extends BaseEntity {
@@ -25,6 +26,9 @@ export class Badge extends BaseEntity {
   };
 
   async _add(payload) {
+    if (!this._calledFromSave) {
+      throw new ApiError("utilisation invalide de _add, utilisez save");
+    }
     payload.id = this._newId?.();
     if (payload.slug) delete payload.slug;
 
@@ -46,6 +50,10 @@ export class Badge extends BaseEntity {
   }
 
   async _update(payload) {
+    // TODO: qui peut modifier un badge ?
+    if (!this._calledFromSave) {
+      throw new ApiError("utilisation invalide de _update, utilisez save");
+    }
     if (payload.id) delete payload.id;
     let hasChanged = false;
 
@@ -67,51 +75,51 @@ export class Badge 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() {
-    throw new Error(`getNews n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getNews n'existe pas dans ${this.constructor.name}`);
   }
 
   async getSubscribers() {
-    throw new Error(`getSubscribers n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`getSubscribers n'existe pas dans ${this.constructor.name}`);
   }
 
   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}`);
   }
 
   async news() {
-    throw new Error(`news n'existe pas dans ${this.constructor.name}`);
+    throw new ApiError(`news n'existe pas dans ${this.constructor.name}`);
   }
 
 }

package/src/api/BaseEntity.js

@@ -61,10 +61,16 @@ export class BaseEntity {
       /** @type {ApiClient} */
       this.apiClient = parent;
       this.parent = null;
+      this.userContext = null;
     } else if (parent?.apiClient) {
       /** @type {ApiClient} */
       this.apiClient = parent.apiClient;
       this.parent = parent;
+      if (parent?.__entityTag === "User") {
+        this.userContext = parent;
+      } else if (parent?.userContext) {
+        this.userContext = parent.userContext;
+      }
     } else {
       throw new ApiError("Parent invalide ou ApiClient manquant.");
     }
@@ -101,6 +107,11 @@ export class BaseEntity {
     return this._draftData.id || null;
   }
 
+  /** @returns {string|null} Slug de l'entité */
+  get slug() {
+    return this._draftData.slug || null;
+  }
+
   /** Définit un ID (utilisé en interne) */
   _id(newId) {
     this._draftData.id = newId;
@@ -133,7 +144,7 @@ export class BaseEntity {
 
   /** @returns {boolean} Indique si cette entité représente l'utilisateur connecté */
   get isMe() {
-    return this.isConnected && this.userId === this.parent?.id;
+    return this.isConnected && this.userId === this.userContext?.id;
   }
 
   /** @returns {string} Type de l'entité (ex: 'citoyens') */
@@ -170,6 +181,10 @@ export class BaseEntity {
 
       if (!this.id && typeof this._add === "function") {
         await this._add(payload);
+        // on refresh le contexte utilisateur si besoin
+        if(this.userContext) {
+          await this.userContext.refresh();
+        }
         return await this.refresh();
       } else if (typeof this._update === "function") {
         const hasChanged = await this._update(payload);
@@ -204,6 +219,9 @@ export class BaseEntity {
    * @private
    */
   _setData(newData) {
+    if (this.userContext && this.userContext !== this) {
+      this.apiClient._logger?.info?.(`[${this.__entityTag}] Mise à jour liée à userContext : ${this.userContext.id}`);
+    }
     this._serverData = reactive({ ...newData });
 
     const { draft, proxy } = this._buildDraftAndProxy({
@@ -1120,8 +1138,8 @@ export class BaseEntity {
 
       const fetchKeysByEntity = {
         citoyens: ["id", "slug"],
-        organisations: ["id", "slug"],
-        projets: ["id", "slug"],
+        organizations: ["id", "slug"],
+        projects: ["id", "slug"],
         events: ["id", "slug"],
         poi: ["id", "slug"],
         news: ["id"],
@@ -1281,7 +1299,7 @@ export class BaseEntity {
    */
   _getLinkFromConnectedUser() {
     const { linkType } = this._getLinkMeta();
-    return this.parent?.serverData?.links?.[linkType]?.[this.id] || null;
+    return this?.userContext?.serverData?.links?.[linkType]?.[this.id] || null;
   }
 
   /**
@@ -1312,7 +1330,7 @@ export class BaseEntity {
 
       // TODO : reflechir au moyen de remplir parent.serverData et this.serverData avec les data de retour pour eviter un refresh
       const retour = await this.callIsMe(() => this.endpointApi.connect(data));
-      await this.parent.refresh();
+      await this.userContext.refresh();
       return retour;
     }
 
@@ -1355,7 +1373,7 @@ export class BaseEntity {
 
       // TODO : reflechir au moyen de remplir parent.serverData et this.serverData avec les data de retour pour eviter un refresh
       const retour = await this.callIsMe(() => this.endpointApi.connect(data));
-      await this.parent.refresh();
+      await this.userContext.refresh();
       return retour;
     }
 
@@ -1401,7 +1419,7 @@ export class BaseEntity {
       };
       // TODO : reflechir au moyen de remplir parent.serverData et this.serverData avec les data de retour pour eviter un refresh
       const retour = await this.callIsMe(() => this.endpointApi.linkValidate(data));
-      await this.parent.refresh();
+      await this.userContext.refresh();
       return retour;
     }
 
@@ -1438,7 +1456,7 @@ export class BaseEntity {
     
     // TODO : reflechir au moyen de remplir parent.serverData et this.serverData avec les data de retour pour eviter un refresh
     const retour = await this.callIsMe(() => this.endpointApi.disconnect(data));
-    await this.parent.refresh();
+    await this.userContext.refresh();
     return retour;
   }
 
@@ -1937,7 +1955,7 @@ export class BaseEntity {
       throw new ApiError(`${this.constructor.name} non enregistrée.`);
     }
 
-    const userLink = this.parent?.serverData?.links?.["follows"]?.[this.id] || null;
+    const userLink = this.userContext?.serverData?.links?.["follows"]?.[this.id] || null;
 
     if (!userLink) {
       const data = {
@@ -1946,7 +1964,7 @@ export class BaseEntity {
       };
       const retour = await this.callIsMe(() => this.endpointApi.follow(data));
       // TODO : reflechir au moyen de remplir parent.serverData et this.serverData avec les data de retour pour eviter un refresh
-      await this.parent.refresh();
+      await this.userContext.refresh();
       return retour;
     }
 
@@ -1968,7 +1986,7 @@ export class BaseEntity {
       throw new ApiError(`${this.constructor.name} non enregistrée.`);
     }
 
-    const userLink = this.parent?.serverData?.links?.["follows"]?.[this.id] || null;
+    const userLink = this.userContext?.serverData?.links?.["follows"]?.[this.id] || null;
 
     if (userLink) {
       const data = {
@@ -1978,13 +1996,174 @@ export class BaseEntity {
       };
       const retour = await this.callIsMe(() => this.endpointApi.disconnect(data));
       // TODO : reflechir au moyen de remplir parent.serverData et this.serverData avec les data de retour pour eviter un refresh
-      await this.parent.refresh();
+      await this.userContext.refresh();
       return retour;
     }
 
     throw new ApiError("Vous n'êtes pas abonné à cette entité.");
   }
   
+
+  /**
+   * Vérifie si l'utilisateur est connecté et a accès à l'entité.
+   * 
+   * @param {string} action - Action à effectuer.
+   * @returns {void}
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité n'est pas enregistrée.
+   * @private
+   */
+  _checkAccess(action = "effectuer cette action") {
+    if (!this.isMe) {
+      throw new ApiError(`Vous devez être connecté pour ${action}`);
+    }
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`);
+    }
+  }
+
+  /**
+   * Vérifie si l'utilisateur a un lien valide avec l'entité.
+   * 
+   * @param {Object} userLink - Lien de l'utilisateur avec l'entité.
+   * @param {boolean} userLink.toBeValidated - Indique si le lien est en attente de validation.
+   * @param {boolean} userLink.isInviting - Indique si l'utilisateur a été invité.
+   * @returns {boolean} - `true` si le lien est valide, `false` sinon.
+   * @private
+   */
+  _validateUserLink(userLink) {
+    if (!userLink) return false;
+    const { toBeValidated, isInviting } = userLink;
+    return !toBeValidated && !isInviting;
+  }
+
+  /**
+   * Vérifie si l'entité est d'un type spécifique.
+   * 
+   * @param {...string} types - Types d'entité attendus.
+   * @throws {ApiError} - Si l'entité n'est pas du type attendu.
+   * @private
+   */
+  _assertEntityType(...types) {
+    const expectedTypes = Array.isArray(types[0]) ? types[0] : types;
+    if (!expectedTypes.includes(this.getEntityType())) {
+      throw new ApiError(`L'entité doit être de type : ${expectedTypes.join(", ")}, reçu : ${this.getEntityType()}`);
+    }
+  }
+
+  /**
+   * Vérifie si l'entité est liée à un type de lien spécifique.
+   * 
+   * @param {string} linkType - Type de lien à vérifier.
+   * @returns {boolean} - `true` si l'entité est liée, `false` sinon.
+   * @private
+   */
+  _isLinked(linkType) {
+    return !!this.userContext?.serverData?.links?.[linkType]?.[this.id];
+  }
+
+  /**
+   * Vérifie si l'utilisateur est l'auteur de l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est l'auteur, `false` sinon.
+   * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si les données du serveur ne sont pas disponibles.
+   */
+  isAuthor() {
+    this._checkAccess("vérifier l'auteur");
+    if (!this.serverData) {
+      throw new ApiError("Aucune donnée serveur disponible.");
+    }
+    return this.userId && this.serverData?.creator === this.userId;
+  }
+
+  /**
+   * Vérifie si l'utilisateur est administrateur de l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est administrateur, `false` sinon.
+   * @throws {ApiError}
+   */
+  isAdmin() {
+    this._checkAccess("vérifier l'administrateur.");
+    this._assertEntityType("organizations", "projects", "events");
+    const userLink = this._getLinkFromConnectedUser();
+    return this._validateUserLink(userLink) && userLink?.isAdmin === true && !userLink?.isAdminPending;
+  }
+
+  /**
+   * Vérifie si l'utilisateur est soit l'auteur, soit administrateur de l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est l'auteur ou administrateur, `false` sinon.
+   * @throws {ApiError}
+   */
+  isAuthorOrAdmin() {
+    this._checkAccess("vérifier l'auteur ou l'administrateur.");
+    return this.isAuthor() || this.isAdmin();
+  }
+
+  /**
+   * Vérifie si l'utilisateur est membre de l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est membre, `false` sinon.
+   * @throws {ApiError}
+   */
+  isMember() {
+    this._checkAccess("vérifier le membre.");
+    this._assertEntityType("organizations");
+    const userLink = this._getLinkFromConnectedUser();
+    return this._validateUserLink(userLink);
+  }
+
+  /**
+   * Vérifie si l'utilisateur est contributeur de l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est contributeur, `false` sinon.
+   * @throws {ApiError}
+   */
+  isContributor() {
+    this._checkAccess("vérifier le contributeur.");
+    this._assertEntityType("projects");
+    const userLink = this._getLinkFromConnectedUser();
+    return this._validateUserLink(userLink);
+  }
+
+  /**
+   * Vérifie si l'utilisateur est participant de l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est participant, `false` sinon.
+   * @throws {ApiError}
+   */
+  isAttendee() {
+    this._checkAccess("vérifier si vous êtes un participant.");
+    this._assertEntityType("events");
+    const userLink = this._getLinkFromConnectedUser();
+    return this._validateUserLink(userLink);
+  }
+
+  /**
+   * Vérifie si l'utilisateur suit l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur suit l'entité, `false` sinon.
+   * @throws {ApiError}
+   */
+  isFollower() {
+    this._checkAccess("vérifier si il vous suit.");
+    this._assertEntityType("citoyens","organizations", "projects", "events", "poi");
+    return this._isLinked("followers");
+  }
+
+  /**
+   * Vérifie si l'utilisateur est abonné à l'entité.
+   * 
+   * @returns {boolean} - `true` si l'utilisateur est abonné, `false` sinon.
+   * @throws {ApiError}
+   */
+  isFollowing() {
+    this._checkAccess("vérifier si vous le suivez.");
+    this._assertEntityType("citoyens","organizations", "projects", "events", "poi");
+    return this._isLinked("follows");
+  }
+
+
+
 }
 
 export default BaseEntity;

package/src/api/EndpointApi.js

@@ -1348,6 +1348,21 @@ class EndpointApi {
     return this.callIsConnected("FOLLOW", data);
   }
     
+  /**
+   * Récuperer les data d'un JSON d'un costum : Récuperer les data d'un JSON d'un costum
+   * Constant : GET_COSTUM_JSON
+   * @param {import("./EndpointApi.types").GetCostumJsonData} 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 getCostumJson(data) {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.call("GET_COSTUM_JSON", data);
+  }
+    
 }
 
 export default EndpointApi;

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

@@ -3482,3 +3482,11 @@ export interface FollowData {
   parentId: string;
   [k: string]: unknown;
 }
+
+
+export interface GetCostumJsonData {
+  pathParams?: {
+    [k: string]: unknown;
+  };
+  [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}`);
   }
 
   /**

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 = {}) {
@@ -215,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);
   }
 
@@ -227,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);
   }
 
@@ -239,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);
   }
 
@@ -251,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);
   }
 
@@ -263,6 +275,7 @@ 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);
   }