@communecter/cocolight-api-client 1.0.72 → 1.0.74

package/package.json

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

package/src/api/BaseEntity.ts

@@ -41,7 +41,8 @@ import type {
   GetPoisNoAdminData,
   GetSubscribersData,
   GetBadgesData,
-  CoformAnswersSearchData
+  CoformAnswersSearchData,
+  ProfilBannerData
 } from "./EndpointApi.types.js";
 import type { GetElementsKeyResponse } from "../types/api-responses.js";
 import type { TransformsMap } from "../types/entities.js";
@@ -2752,6 +2753,36 @@ export class BaseEntity<TServerData = any> {
     return this.callIsConnected(() => this.endpointApi.profilImage(data));
   }
 
+  /**
+   * Mettre à jour l'image de bannière : Permet de mettre à jour l'image de bannière d'un utilisateur ou d'une entité.
+   * Constant : PROFIL_BANNER
+   * @param data - Les données à envoyer.
+   * @param data.banner - L'image de bannière à mettre à jour.
+   * @param data.cropW - Largeur du recadrage.
+   * @param data.cropH - Hauteur du recadrage.
+   * @param data.cropX - Position X du recadrage.
+   * @param data.cropY - Position Y du recadrage.
+   * @returns - Les données de réponse.
+   */
+  async updateImageBanner({ banner: image, cropW, cropH, cropX, cropY  }: { banner: UploadInput, cropW: number, cropH: number, cropX: number, cropY: number }): Promise<unknown> {
+
+    if (!this.id) {
+      throw new ApiError(`${this.constructor.name} non enregistrée.`, 404);
+    }
+
+    const t = this.getEntityType();
+    if (t === "badges" || t === "news" || t === "comments" || t === "answers") {
+      throw new ApiError(`Le type d'entité "${t}" n'est pas supporté par UPDATE_BLOCK_LOCALITY.`, 400);
+    }
+
+    const folder: NonNullable<ProfilBannerData["pathParams"]>["folder"] = t;
+
+    image = await this._validateImage(image);
+
+    const data: ProfilBannerData = { pathParams: { folder, ownerId: this.id }, parentType: folder, parentId: this.id, formOrigin: "banner", cropW, cropH, cropX, cropY, banner: image as unknown as Record<string, unknown>, };
+    return this.callIsConnected(() => this.endpointApi.profilBanner(data));
+  }
+
   /**
    * Crée une instance d'organisation et récupère son profil si nécessaire.
    *

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, AddVoteData, AddReportAbuseData } 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 } from "./EndpointApi.types.js";
 
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
@@ -328,6 +328,22 @@ export class EndpointApi {
     return this.callIsConnected("PROFIL_IMAGE", data);
   }
     
+  /**
+   * Mettre à jour l'image de bannière : Permet de mettre à jour l'image de la bannière d'un utilisateur ou d'une entité.
+   * Constant : PROFIL_BANNER
+   * @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 profilBanner(data: ProfilBannerData): Promise<any> {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.callIsConnected("PROFIL_BANNER", data);
+  }
+    
   /**
    * Obtenir les éléments liés : Récupère les informations détaillées d'un élément et de ses éléments liés.
    * Constant : GET_ELEMENTS_ABOUT

package/src/api/EndpointApi.types.ts

@@ -404,6 +404,35 @@ export interface ProfilImageData {
 }
 
 
+export interface ProfilBannerData {
+  /**
+   * Fichier image de profil au format binaire
+   */
+  banner: {
+    [k: string]: unknown;
+  };
+  parentId: string;
+  parentType: "citoyens" | "projects" | "organizations" | "events" | "poi";
+  formOrigin: "banner";
+  cropW: number;
+  cropH: number;
+  cropX: number;
+  cropY: number;
+  pathParams?: {
+    /**
+     * Type d'entité
+     */
+    folder: "citoyens" | "projects" | "organizations" | "events" | "poi";
+    /**
+     * ID de l'utilisateur ou de l'entité
+     */
+    ownerId: string;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}
+
+
 export interface GetElementsAboutData {
   /**
    * Template utilisé (ex: ficheInfoElement)

package/src/api/User.ts

@@ -340,7 +340,21 @@ export class User extends BaseEntity<UserItemNormalized> {
     }
     return super.updateImageProfil(data);
   }
+
+
+  /**
+   * {@inheritDoc BaseEntity#updateImageBanner}
+   *
+   * Mettre à jour l'image de bannière : Permet de mettre à jour l'image de bannière d'un utilisateur ou d'une entité.
+   */
+  override async updateImageBanner(data: Parameters<BaseEntity<UserItemNormalized>["updateImageBanner"]>[0]) {
+    if(!this.isMe){
+      throw new ApiError("Vous devez être connecté et être l'utilisateur pour mettre à jour l'image de bannière.", 401);
+    }
+    return super.updateImageBanner(data);
+  }
   
+
   /**
    * {@inheritDoc BaseEntity#getOrganizations}
    * @param [data]