@communecter/cocolight-api-client 1.0.47 → 1.0.49

package/package.json

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

package/src/ApiClient.js

@@ -1074,7 +1074,7 @@ export default class ApiClient extends EventEmitter {
         data.results = Object.keys(data.results).map((key) => {
           return this._normalizeJsonData({ id: key, ...data.results[key] });
         });
-      } else if (Array.isArray(data.results)) {
+      } else if (Array.isArray(data.results) && data.results.length > 0) {
         data.results = data.results.map((item) => this._normalizeJsonData(item));
       } else if (data.news && Array.isArray(data.news) && data.news.length === 0) {
         data = data.news;
@@ -1441,7 +1441,9 @@ export default class ApiClient extends EventEmitter {
     "profilRealBannerUrl",
     "imagePath",
     "imageThumbPath",
-    "docPath"
+    "docPath",
+    "imageThumb",
+    "imageMediumPath"
   ];
 
   /**

package/src/api/BaseEntity.js

@@ -2171,6 +2171,24 @@ export class BaseEntity {
     return this._createFilteredProxy(rawList);
   }
 
+  /**
+   * Récupérer la galerie d'une entité.
+   * Constant : GET_GALLERY
+   * @param {Object} data - Les données à envoyer.
+   * @param {string} data.pathParams.docType - Type de document (default: "image")
+   * @param {string} data.contentKey - Clé de contenu pour la galerie (default: "null")
+   * @param {string} data.folderId - ID du dossier pour la galerie (default: "null")
+   * @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 getGallery(data = {}) {
+    data.pathParams = { type: this.getEntityType(), id: this.id, docType: data.pathParams?.docType || "image" };
+    const arrayObjet =  await this.endpointApi.getGallery(data);
+
+    return arrayObjet;
+  }
+
   /**
    * Soumet une demande pour rejoindre l'entité courante (ex. organisation, projet, événement...).
    * Si une invitation est en attente, elle est automatiquement acceptée.

package/src/api/EndpointApi.js

@@ -1513,6 +1513,21 @@ class EndpointApi {
     return this.call("COSTUM_EVENT_REQUEST_LOAD_CONTEXT_TAG", data);
   }
     
+  /**
+   * Récupération de la galerie : Renvoie soit la liste d’albums associés à une entité, soit les images d’un album spécifique.
+   * Constant : GET_GALLERY
+   * @param {import("./EndpointApi.types").GetGalleryData} 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 getGallery(data) {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.call("GET_GALLERY", data);
+  }
+    
 }
 
 export default EndpointApi;

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

@@ -283,62 +283,54 @@ export interface UpdateBlockLocalityData {
    * Périmètre de mise à jour
    */
   scope?: string;
-  /**
-   * Coordonnées géographiques
-   */
-  geo?: {
-    "@type"?: "GeoCoordinates";
-    latitude: string | number;
-    longitude: string | number;
-  };
-  /**
-   * Position géographique GeoJSON
-   */
-  geoPosition?: {
-    /**
-     * Type GeoJSON (doit être 'Point')
-     */
-    type: "Point";
-    /**
-     * Tableau contenant [longitude, latitude]
-     *
-     * @minItems 2
-     * @maxItems 2
-     */
-    coordinates: [number, number];
-    /**
-     * Indicateur pour forcer la conversion en float côté serveur
-     */
-    float: true;
-    [k: string]: unknown;
-  };
-  address: {
-    "@type": "PostalAddress";
-    addressCountry: string;
-    codeInsee: string;
-    addressLocality: string;
-    localityId: string;
-    level1: string;
-    level1Name: string;
-    /**
-     * ID du département. Peut être vide pour les pays étrangers.
-     */
-    level3?: string;
-    /**
-     * Nom du département. Peut être vide pour les pays étrangers.
-     */
-    level3Name?: string;
-    /**
-     * ID de la commune. Peut être vide pour les pays étrangers.
-     */
-    level4?: string;
-    /**
-     * Nom de la commune. Peut être vide pour les pays étrangers.
-     */
-    level4Name?: string;
-    postalCode?: string;
-    streetAddress?: string;
-  };
+  geo?:
+    | ""
+    | {
+        "@type"?: "GeoCoordinates";
+        latitude: string | number;
+        longitude: string | number;
+      };
+  geoPosition?:
+    | ""
+    | {
+        type: "Point";
+        /**
+         * @minItems 2
+         * @maxItems 2
+         */
+        coordinates: [number, number];
+        float: true;
+        [k: string]: unknown;
+      };
+  address:
+    | ""
+    | {
+        "@type": "PostalAddress";
+        addressCountry: string;
+        codeInsee: string;
+        addressLocality: string;
+        localityId: string;
+        level1: string;
+        level1Name: string;
+        /**
+         * ID du département. Peut être vide pour les pays étrangers.
+         */
+        level3?: string;
+        /**
+         * Nom du département. Peut être vide pour les pays étrangers.
+         */
+        level3Name?: string;
+        /**
+         * ID de la commune. Peut être vide pour les pays étrangers.
+         */
+        level4?: string;
+        /**
+         * Nom de la commune. Peut être vide pour les pays étrangers.
+         */
+        level4Name?: string;
+        postalCode?: string;
+        streetAddress?: string;
+      };
   [k: string]: unknown;
 }
 
@@ -3894,7 +3886,7 @@ export interface GlobalAutocompleteCostumData {
   /**
    * Nom ou mot-clé de la recherche
    */
-  name: string;
+  name?: string;
   /**
    * Liste des localités ciblées avec leur identifiant et leur type (city ou level1)
    */
@@ -3992,9 +3984,21 @@ export interface GlobalAutocompleteCostumData {
    */
   count: true;
   /**
-   * Filtres additionnels appliqués à la recherche (actuellement vide)
+   * Filtres additionnels appliqués à la recherche
    */
-  filters: "";
+  filters?: {
+    [k: string]: unknown;
+  };
+  /**
+   * Liste des champs à retourner
+   */
+  fields?: string[];
+  /**
+   * Champ de tri (clé = champ, valeur = 1 ou -1)
+   */
+  sortBy?: {
+    [k: string]: 1 | -1;
+  };
   /**
    * Indique si la recherche doit s'étendre au Fediverse (toujours désactivé)
    */
@@ -4003,6 +4007,10 @@ export interface GlobalAutocompleteCostumData {
    * Indique si la recherche est effectuée à partir d'une carte (toujours désactivé)
    */
   mapUsed: boolean;
+  /**
+   * Indique si on doit exclure les éléments avec une source
+   */
+  notSourceKey?: boolean;
   /**
    * ID du contexte de recherche (actuellement vide)
    */
@@ -4412,3 +4420,31 @@ export interface CostumEventRequestLoadContextTagData {
   };
   [k: string]: unknown;
 }
+
+
+export interface GetGalleryData {
+  /**
+   * Clé de contenu pour correspondre à l'album ou aux images
+   */
+  contentKey?: string;
+  /**
+   * ID du dossier à récupérer (pour les images d'un album)
+   */
+  folderId?: string;
+  pathParams?: {
+    /**
+     * ID de l'entité
+     */
+    id: string;
+    /**
+     * Type d'entité
+     */
+    type: "citoyens" | "organizations" | "projects";
+    /**
+     * Type de document
+     */
+    docType: "image" | "file" | "bookmarks";
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}

package/src/api/Event.js

@@ -8,6 +8,10 @@ export class Event extends BaseEntity {
 
   static SCHEMA_CONSTANTS = [
     "ADD_EVENT",
+    // "UPDATE_BLOCK_DESCRIPTION",
+    // "UPDATE_BLOCK_INFO",
+    // "UPDATE_BLOCK_SOCIAL",
+    // "UPDATE_BLOCK_LOCALITY",
     "UPDATE_BLOCK_SLUG",
     "PROFIL_IMAGE"
   ];
@@ -18,6 +22,10 @@ export class Event extends BaseEntity {
   ]);
 
   static UPDATE_BLOCKS = new Map([
+    // ["UPDATE_BLOCK_DESCRIPTION", "updateDescription"],
+    // ["UPDATE_BLOCK_SOCIAL", "updateSocial"],
+    // ["UPDATE_BLOCK_LOCALITY", "updateLocality"],
+    // ["UPDATE_BLOCK_INFO", "updateInfo"],
     ["UPDATE_BLOCK_SLUG", "updateSlug"],
     ["PROFIL_IMAGE", "updateImageProfil"]
   ]);

package/src/api/Organization.js

@@ -214,6 +214,18 @@ export class Organization extends BaseEntity {
     return paginator.next();
   }
 
+  /**
+   * Récupère la galerie de l'organisation.
+   *
+   * @param {Object} data - Les données de requête.
+   * @returns {Promise<Object>} - Un objet contenant les éléments de la galerie.
+   * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async getGallery(data = {}) {
+    return super.getGallery(data);
+  }
+
   /**
    * Crée une instance de projet et récupère son profil si nécessaire.
    *

package/src/api/Project.js

@@ -225,6 +225,18 @@ export class Project extends BaseEntity {
     return paginator.next();
   }
 
+  /**
+   * Récupère la galerie d'un projet.
+   * 
+   * @param {Object} data - Les données de requête pour la galerie.
+   * @returns {Promise<Object>} - Un objet contenant les images de la galerie.
+   * @throws {ApiResponseError} - Si une erreur se produit lors de la récupération de la galerie.
+   * @throws {Error} - En cas d'erreur inattendue.
+   */
+  async getGallery(data = {}) {
+    return super.getGallery(data);
+  }
+
   /**
    * Crée une instance de projet et récupère son profil si nécessaire.
    *

package/src/api/User.js

@@ -441,6 +441,14 @@ export class User extends BaseEntity {
     return filteredBadges;
   }
 
+  /**
+   * Récupérer la galerie de l'utilisateur
+   * Constant : GET_GALLERY
+   */
+  async getGallery(data = {}) {
+    return super.getGallery(data);
+  }
+
   async user(userData) {
     if(!this.isMe){
       throw new ApiError("Vous devez être connecté et être l'utilisateur");