@communecter/cocolight-api-client 1.0.76 → 1.0.78

package/package.json

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

package/src/api/BaseEntity.ts

@@ -2231,9 +2231,8 @@ export class BaseEntity<TServerData = any> {
    * - `connectTypeConnect` : valeur envoyée pour `connect()`
    * - `connectTypeDisconnect` : valeur envoyée pour `disconnect()`
    * @throws {ApiError} - Si le type d'entité est inconnu.
-   * @protected
    */
-  protected _getLinkMeta(): LinkMeta {
+  _getLinkMeta(): LinkMeta {
     const map = {
       organizations: {
         linkType: "memberOf",

package/src/api/EndpointApi.ts

@@ -2,7 +2,7 @@
 import { ApiAuthenticationError } from "../error.js";
 
 import type ApiClient from "../ApiClient.js";
-import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, ProfilBannerData, GetElementsAboutData, MulticonnectData, GetNewsData, GetNewsByIdData, AddNewsData, AddImageNewsData, AddFileNewsData, DeleteNewsData, UpdateNewsData, ShareNewsData, GetCommentsData, AddCommentsData, DeleteCommentsData, UpdateCommentsData, SearchTagsData, ShowVoteData, GlobalAutocompleteData, CityAutocompleteData, CityAutocompleteByCountryData, SuggestionInputData, GetProjectsNoAdminData, GetProjectsAdminData, GetPoisNoAdminData, GetPoisAdminData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeletePoiData, DeleteEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, ShareEventsData, InviteEventData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, AddVoteData, AddReportAbuseData, UpdatePathValueData } from "./EndpointApi.types.js";
+import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, ProfilBannerData, GetElementsAboutData, MulticonnectData, GetNewsData, GetNewsByIdData, AddNewsData, AddImageNewsData, AddFileNewsData, DeleteNewsData, UpdateNewsData, ShareNewsData, GetCommentsData, AddCommentsData, DeleteCommentsData, UpdateCommentsData, SearchTagsData, ShowVoteData, GlobalAutocompleteData, CityAutocompleteData, CityAutocompleteByCountryData, SuggestionInputData, GetProjectsNoAdminData, GetProjectsAdminData, GetPoisNoAdminData, GetPoisAdminData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeletePoiData, DeleteEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, ShareEventsData, InviteEventData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData } from "./EndpointApi.types.js";
 
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
@@ -1688,6 +1688,22 @@ export class EndpointApi {
     return this.callIsConnected("UPDATE_PATH_VALUE", data);
   }
     
+  /**
+   * Supprimer une image/document par contexte d’entité : Supprimer des documents associés à une entité dans un contexte spécifique
+   * Constant : DELETE_DOCUMENT_BY_CONTEXT
+   * @param data - Données envoyées à l'API
+   * @returns 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 deleteDocumentByContext(data: DeleteDocumentByContextData): Promise<any> {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.callIsConnected("DELETE_DOCUMENT_BY_CONTEXT", data);
+  }
+    
 }
 
 export default EndpointApi;

package/src/api/EndpointApi.types.ts

@@ -4870,3 +4870,32 @@ export interface UpdatePathValueData {
   };
   [k: string]: unknown;
 }
+
+
+export interface DeleteDocumentByContextData {
+  /**
+   * ID de l’utilisateur
+   */
+  parentId?: string;
+  /**
+   * Type de contexte de l’entité
+   */
+  parentType?: "citoyens" | "organizations" | "projects" | "events" | "poi";
+  path: "communecter";
+  /**
+   * ID image/document à supprimer
+   */
+  ids?: string;
+  pathParams?: {
+    /**
+     * ID du contexte de l’entité
+     */
+    contextId: string;
+    /**
+     * Type de contexte de l’entité
+     */
+    contextType: "citoyens" | "organizations" | "projects" | "events" | "poi";
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}

package/src/api/News.ts

@@ -163,12 +163,26 @@ export class News extends BaseEntity<NewsItemNormalized> {
     payload.idNews = this.id;
 
     let hasChanged = false;
-    await this.callIsConnected(() => this.endpointApi.updateNews(payload as UpdateNewsData)) as any;
-    // TODO : voir si j'ai ce qui faut dans data de UPDATE_NEWS pour mettre à jour #serverData
-    // c'est dans data.object
-    // if(data?.object){
-    //   this._serverData = { ...data.object };
+
+    
+    // il faut que j'ai les ids des images et fichiers avant la mise à jour venant de serverData
+    // if (this._serverData?.mediaImg?.images && this._serverData?.mediaImg?.images.length > 0) {
+    //   imagesIds = this._serverData.mediaImg.images.map((img: any) => img.id);
     // }
+
+    // if (this._serverData?.mediaFile?.files && this._serverData?.mediaFile?.files.length > 0) {
+    //   filesIds = this._serverData.mediaFile.files.map((f: any) => f.id);
+    // }
+
+    // comparer avec this._draftData.mediaImg.images pour voir si des images ont été supprimées
+    // comparer avec this._draftData.mediaFile.files pour voir si des fichiers ont été supprimés
+
+
+    await this.callIsConnected(() => this.endpointApi.updateNews(payload as UpdateNewsData)) as any;
+
+    // TODO : je voudrais pouvoir comparer les images et fichiers pour supprimer ceux qui ont été enlevés
+    // avec deleteDocumentByContext() mais il faut que j'ai les ids des images et fichiers avant la mise à jour
+
     hasChanged = true;
     return hasChanged;
   };
@@ -262,6 +276,8 @@ export class News extends BaseEntity<NewsItemNormalized> {
     return dataFile;
   }
 
+
+
   /**
    * Supprimer une actualité : Supprime une actualité existante.
    * Constant : DELETE_NEWS

package/src/api/Organization.ts

@@ -335,7 +335,7 @@ export class Organization extends BaseEntity<OrganizationItemNormalized> {
         const { toBeValidated, isAdmin, isAdminPending, isInviting, roles = [] } = options;
 
         if(this.isMe){
-          finalData.pathParams = { type: this.getEntityType(), id: this.id };
+          finalData.pathParams = { id: this.id };
           // finalData.filters = {
           //   [`links.memberOf.${this.id}`]: { "$exists": true },
           //   [`links.memberOf.${this.id}.toBeValidated`]: { "$exists": false },

package/src/api/User.ts

@@ -888,6 +888,191 @@ export class User extends BaseEntity<UserItemNormalized> {
     }
     return super.entityBySlug(slug);
   }
+
+  /**
+   * Valide les préconditions communes pour les méthodes de vérification de rôle.
+   * @private
+   * @param methodName - Nom de la méthode appelante (pour les messages d'erreur).
+   * @param expectedTypes - Types d'entité parent autorisés.
+   * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+   * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+   * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré.
+   * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée.
+   * @throws {ApiError} 400 - Si le type d'entité parent n'est pas valide.
+   */
+  private _validateRoleCheckPreconditions(methodName: string, expectedTypes: string[]): void {
+    if (!this.userId) {
+      throw new ApiError(`Vous devez être connecté pour ${methodName}.`, 401);
+    }
+
+    if(!this.parent?.isAdmin()){
+      throw new ApiError("Vous devez être administrateur pour effectuer cette action.", 401);
+    }
+
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`, 404);
+    }
+
+    if(!this.parent?.id){
+      throw new ApiError("L'entité parente n'est pas enregistrée.", 404);
+    }
+
+    if (!expectedTypes.includes(this.parent.getEntityType())) {
+      throw new ApiError(`L'entité doit être de type : ${expectedTypes.join(", ")}, reçu : ${this.parent.getEntityType()}`, 400);
+    }
+  }
+
+  /**
+   * Récupère le lien utilisateur pour l'entité parente.
+   * @private
+   * @returns Le lien utilisateur ou null.
+   */
+  private _getUserLinkForParent(): any {
+    const { linkType } = this.parent!._getLinkMeta();
+    const parentId = this.parent!.id;
+    if (!parentId) return null;
+    return this?.serverData?.links?.[linkType]?.[parentId] || null;
+  }
+
+  /**
+   * Vérifie si l'utilisateur est administrateur de l'entité parente.
+   *
+   * Cette méthode permet de vérifier si un utilisateur possède les droits d'administration
+   * sur l'organisation ou le projet parent. Elle est particulièrement utile après avoir
+   * récupéré des membres via `getMembers()` pour déterminer leur niveau de permissions.
+   *
+   * @returns `true` si l'utilisateur est administrateur de l'entité parente, `false` sinon.
+   *
+   * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+   * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+   * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+   * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+   * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "organizations" ou "projects".
+   *
+   * @example
+   * // Vérifier les admins d'une organisation
+   * const org = await me.organization({ slug: "openAtlas" });
+   * const members = await org.getMembers();
+   *
+   * for (const member of members.results) {
+   *   if (member.getEntityType() === "citoyens") {
+   *     if (member.isAdmin()) {
+   *       console.log(`${member.data.name} est administrateur`);
+   *     }
+   *   }
+   * }
+   *
+   * @example
+   * // Récupérer uniquement les membres admins
+   * const org = await me.organization({ slug: "myOrg" });
+   * const adminMembers = await org.getMembers({}, { isAdmin: true });
+   *
+   * // Vérifier chaque admin
+   * for (const admin of adminMembers.results) {
+   *   if (admin.getEntityType() === "citoyens" && admin.isAdmin()) {
+   *     console.log(`${admin.data.name} a les droits admin`);
+   *   }
+   * }
+   */
+  override isAdmin(): boolean {
+    this._validateRoleCheckPreconditions("isAdmin", ["organizations", "projects"]);
+    const userLink = this._getUserLinkForParent();
+    return this._validateUserLink(userLink) && userLink?.isAdmin === true && !userLink?.isAdminPending;
+  }
+
+  /**
+   * Vérifie si l'utilisateur est membre de l'organisation parente.
+   *
+   * Cette méthode permet de vérifier si un utilisateur est membre actif d'une organisation.
+   * Elle est utile pour déterminer si un utilisateur a accès aux ressources de l'organisation.
+   *
+   * @returns `true` si l'utilisateur est membre validé de l'organisation parente, `false` sinon.
+   *
+   * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+   * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+   * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+   * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+   * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "organizations".
+   *
+   * @example
+   * // Vérifier les membres d'une organisation
+   * const org = await me.organization({ slug: "myOrg" });
+   * const members = await org.getMembers();
+   *
+   * for (const member of members.results) {
+   *   if (member.getEntityType() === "citoyens" && member.isMember()) {
+   *     console.log(`${member.data.name} est membre de l'organisation`);
+   *   }
+   * }
+   */
+  override isMember(): boolean {
+    this._validateRoleCheckPreconditions("isMember", ["organizations"]);
+    const userLink = this._getUserLinkForParent();
+    return this._validateUserLink(userLink);
+  }
+
+  /**
+   * Vérifie si l'utilisateur est contributeur du projet parent.
+   *
+   * Cette méthode permet de vérifier si un utilisateur est contributeur actif d'un projet.
+   * Elle est utile pour déterminer si un utilisateur peut participer aux activités du projet.
+   *
+   * @returns `true` si l'utilisateur est contributeur validé du projet parent, `false` sinon.
+   *
+   * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+   * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+   * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+   * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+   * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "projects".
+   *
+   * @example
+   * // Vérifier les contributeurs d'un projet
+   * const project = await me.project({ slug: "myProject" });
+   * const contributors = await project.getContributors();
+   *
+   * for (const contributor of contributors.results) {
+   *   if (contributor.getEntityType() === "citoyens" && contributor.isContributor()) {
+   *     console.log(`${contributor.data.name} est contributeur du projet`);
+   *   }
+   * }
+   */
+  override isContributor(): boolean {
+    this._validateRoleCheckPreconditions("isContributor", ["projects"]);
+    const userLink = this._getUserLinkForParent();
+    return this._validateUserLink(userLink);
+  }
+
+  /**
+   * Vérifie si l'utilisateur est participant de l'événement parent.
+   *
+   * Cette méthode permet de vérifier si un utilisateur est inscrit comme participant à un événement.
+   * Elle est utile pour déterminer si un utilisateur a confirmé sa participation à l'événement.
+   *
+   * @returns `true` si l'utilisateur est participant validé de l'événement parent, `false` sinon.
+   *
+   * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+   * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+   * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+   * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+   * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "events".
+   *
+   * @example
+   * // Vérifier les participants d'un événement
+   * const event = await me.event({ slug: "myEvent" });
+   * const attendees = await event.getAttendees();
+   *
+   * for (const attendee of attendees.results) {
+   *   if (attendee.getEntityType() === "citoyens" && attendee.isAttendee()) {
+   *     console.log(`${attendee.data.name} participe à l'événement`);
+   *   }
+   * }
+   */
+  override isAttendee(): boolean {
+    this._validateRoleCheckPreconditions("isAttendee", ["events"]);
+    const userLink = this._getUserLinkForParent();
+    return this._validateUserLink(userLink);
+  }
+
 }
 
 // Incorporation des mixins dans User