@communecter/cocolight-api-client 1.0.62 → 1.0.63

package/package.json

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

package/src/api/Comment.ts

@@ -1,7 +1,7 @@
 import { ApiError } from "../error.js";
 import { BaseEntity } from "./BaseEntity.js";
 
-import type { AddCommentsData, DeleteCommentsData, UpdateCommentsData } from "./EndpointApi.types.js";
+import type { AddCommentsData, AddReportAbuseData, AddVoteData, DeleteCommentsData, UpdateCommentsData } from "./EndpointApi.types.js";
 import type { CommentItemNormalized } from "./serverDataType/Comment.js";
 
 export class Comment extends BaseEntity<CommentItemNormalized> {
@@ -197,4 +197,55 @@ export class Comment extends BaseEntity<CommentItemNormalized> {
     return entity as Comment;
   }
 
+  /**
+   * Ajoute un vote sur ce commentaire
+   *
+   * @param status - Statut du vote (ex: 'like', 'dislike', 'love', etc.)
+   * @returns Promise contenant la réponse de l'API après l'ajout du vote
+   * @throws {ApiError} Si la news n'a pas d'ID (non enregistrée)
+   */
+  async addVote(status: string){
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`, 404);
+    }
+  
+    const payload: AddVoteData = {
+      collection: "comments",
+      id: this.id,
+      action: "vote",
+      details: {
+        status
+      }
+    };
+
+    return await this.callIsConnected(() => this.endpointApi.addVote(payload));
+  }
+
+  /**
+   * Signale un abus sur ce commentaire
+   *
+   * @param params - Paramètres du signalement
+   * @param params.reason - Raison du signalement
+   * @param params.comment - Commentaire expliquant le signalement (optionnel)
+   * @returns Promise contenant la réponse de l'API après le signalement
+   * @throws {ApiError} Si la news n'a pas d'ID (non enregistrée)
+   */
+  async addReportAbuse({ reason, comment }: { reason: string, comment?: string}){
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`, 404);
+    }
+  
+    const payload: AddReportAbuseData = {
+      collection: "comments",
+      id: this.id,
+      action: "reportAbuse",
+      details: {
+        reason,
+        comment
+      }
+    };
+  
+    return await this.callIsConnected(() => this.endpointApi.addReportAbuse(payload));;
+  }
+
 }

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, 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 } from "./EndpointApi.types.js";
+import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, 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 } from "./EndpointApi.types.js";
 
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
@@ -1624,6 +1624,38 @@ export class EndpointApi {
     return this.call("COFORM_ANSWERS_BY_ID", data);
   }
     
+  /**
+   * Voter sur un élément (commentaire ou news) : Permet de voter sur un commentaire ou une news en spécifiant un statut de vote
+   * Constant : ADD_VOTE
+   * @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 addVote(data: AddVoteData): Promise<any> {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.callIsConnected("ADD_VOTE", data);
+  }
+    
+  /**
+   * Signaler un abus sur un élément (commentaire ou news) : Permet de signaler un abus sur un commentaire ou une news en spécifiant une raison et un commentaire
+   * Constant : ADD_REPORT_ABUSE
+   * @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 addReportAbuse(data: AddReportAbuseData): Promise<any> {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.callIsConnected("ADD_REPORT_ABUSE", data);
+  }
+    
 }
 
 export default EndpointApi;

package/src/api/EndpointApi.types.ts

@@ -4767,3 +4767,53 @@ export interface CoformAnswersByIdData {
   fields?: string[];
   [k: string]: unknown;
 }
+
+
+export interface AddVoteData {
+  /**
+   * ID de l'élément (commentaire ou news) sur lequel voter
+   */
+  id: string;
+  /**
+   * Type de collection concernée
+   */
+  collection: "comments" | "news";
+  /**
+   * Type d'action à effectuer (vote)
+   */
+  action: "vote";
+  details: {
+    /**
+     * Statut du vote (ex: 'like', 'dislike', etc.)
+     */
+    status: string;
+  };
+  [k: string]: unknown;
+}
+
+
+export interface AddReportAbuseData {
+  /**
+   * ID de l'élément (commentaire ou news) à signaler
+   */
+  id: string;
+  /**
+   * Type de collection concernée
+   */
+  collection: "comments" | "news";
+  /**
+   * Type d'action à effectuer (signalement d'abus)
+   */
+  action: "reportAbuse";
+  details: {
+    /**
+     * Raison du signalement (requis)
+     */
+    reason: string;
+    /**
+     * Commentaire expliquant le signalement (optionelle)
+     */
+    comment?: string;
+  };
+  [k: string]: unknown;
+}

package/src/api/News.ts

@@ -2,7 +2,7 @@ import { ApiError, ApiResponseError } from "../error.js";
 import { BaseEntity } from "./BaseEntity.js";
 
 import type { Comment } from "./Comment.js";
-import type { AddNewsData, UpdateNewsData, DeleteNewsData, AddImageNewsData, AddFileNewsData, GetCommentsData } from "./EndpointApi.types.js";
+import type { AddNewsData, UpdateNewsData, DeleteNewsData, AddImageNewsData, AddFileNewsData, GetCommentsData, AddVoteData, AddReportAbuseData } from "./EndpointApi.types.js";
 import type { NewsItemNormalized } from "./serverDataType/News.js";
 
 export class News extends BaseEntity<NewsItemNormalized> {
@@ -326,4 +326,55 @@ export class News extends BaseEntity<NewsItemNormalized> {
     return this._createFilteredProxy(rawList);
   }
 
+  /**
+   * Ajoute un vote sur cette news
+   *
+   * @param status - Statut du vote (ex: 'like', 'dislike', 'love', etc.)
+   * @returns Promise contenant la réponse de l'API après l'ajout du vote
+   * @throws {ApiError} Si la news n'a pas d'ID (non enregistrée)
+   */
+  async addVote(status: string){
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`, 404);
+    }
+
+    const payload: AddVoteData = {
+      collection: "news",
+      id: this.id,
+      action: "vote",
+      details: {
+        status
+      }
+    };
+
+    return await this.callIsConnected(() => this.endpointApi.addVote(payload));
+  }
+
+  /**
+   * Signale un abus sur cette news
+   *
+   * @param params - Paramètres du signalement
+   * @param params.reason - Raison du signalement
+   * @param params.comment - Commentaire expliquant le signalement (optionnel)
+   * @returns Promise contenant la réponse de l'API après le signalement
+   * @throws {ApiError} Si la news n'a pas d'ID (non enregistrée)
+   */
+  async addReportAbuse({ reason, comment }: { reason: string, comment?: string}){
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`, 404);
+    }
+
+    const payload: AddReportAbuseData = {
+      collection: "news",
+      id: this.id,
+      action: "reportAbuse",
+      details: {
+        reason,
+        comment
+      }
+    };
+
+    return await this.callIsConnected(() =>this.endpointApi.addReportAbuse(payload));
+  }
+
 }