@communecter/cocolight-api-client 1.0.75 → 1.0.77

package/package.json

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

package/src/api/BaseEntity.ts

@@ -320,6 +320,8 @@ export class BaseEntity<TServerData = any> {
   static entityTag = "BaseEntity";
   static entityType?: string;
   static SCHEMA_CONSTANTS?: string | string[];
+  static VIRTUAL_SCHEMAS?: Record<string, any>;
+  static CUSTOM_FIELD_HANDLERS?: Map<string, { updateMethod: string; schemaConstant?: string }>;
 
   /**
    * Vérifie que l'objet n'a pas été supprimé.
@@ -1487,7 +1489,15 @@ export class BaseEntity<TServerData = any> {
     };
 
     for (const key of constants) {
-      const sch = apiClient.getRequestSchema(key);
+      let sch = apiClient.getRequestSchema(key);
+
+      // Injecter le schéma virtuel si disponible
+      const Ctor = this._getCtor();
+      const virtualSchema = Ctor.VIRTUAL_SCHEMAS?.[key];
+      if (virtualSchema) {
+        sch = this._mergeSchemas(sch, virtualSchema);
+      }
+
       if (!sch) throw new ApiError(`Unable to find schema for ${key}.`, 404);
 
       // Extraire et fusionner les $defs
@@ -1623,6 +1633,58 @@ export class BaseEntity<TServerData = any> {
     return JSON.stringify(this._toRawDeep(current)) !== JSON.stringify(this._toRawDeep(initial));
   }
 
+  /**
+   * Merge deux schémas JSON en combinant leurs propriétés.
+   * @param base - Schéma de base (peut être null/undefined)
+   * @param virtual - Schéma virtuel à fusionner
+   * @returns Schéma combiné
+   * @private
+   */
+  private _mergeSchemas(base: any, virtual: any): any {
+    if (!base) return virtual;
+    if (!virtual) return base;
+
+    return {
+      allOf: [base, virtual],
+      $defs: { ...base.$defs, ...virtual.$defs }
+    };
+  }
+
+  /**
+   * Vérifie si un champ a changé par rapport à l'état initial.
+   * @param fieldName - Nom du champ
+   * @returns true si le champ a changé
+   * @protected
+   */
+  protected _hasFieldChanged(fieldName: string): boolean {
+    const current = this._draftData[fieldName];
+    const initial = this._initialDraftData[fieldName];
+    return this._compareValues(current, initial);
+  }
+
+  /**
+   * Invoque un handler personnalisé pour un champ spécifique.
+   * @param methodName - Nom de la méthode à appeler
+   * @param value - Valeur du champ
+   * @param fieldName - Nom du champ (pour les messages d'erreur)
+   * @returns Résultat de l'appel de la méthode
+   * @protected
+   */
+  protected async _invokeCustomFieldHandler(
+    methodName: string,
+    value: any,
+    fieldName: string
+  ): Promise<any> {
+    const method = (this as any)[methodName];
+    if (typeof method !== "function") {
+      throw new ApiError(
+        `Custom handler "${methodName}" not found for field "${fieldName}"`,
+        500
+      );
+    }
+    return await method.call(this, value);
+  }
+
   _extractChangedFieldsFromSchema(apiClient: ApiClient, constant: string, data: Record<string, any> = {}, getInitialDraft: () => Record<string, any> | void, removeFields: string[] = []): Record<string, any> | null {
     const schema = apiClient.getRequestSchema(constant);
     let allowed = this._extractWritableFields(schema, data);

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 } 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
@@ -1672,6 +1672,38 @@ export class EndpointApi {
     return this.callIsConnected("ADD_REPORT_ABUSE", data);
   }
     
+  /**
+   * Mettre à jour une valeur de chemin pour une entité : Met à jour une valeur spécifique dans le chemin donné pour une entité.
+   * Constant : UPDATE_PATH_VALUE
+   * @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 updatePathValue(data: UpdatePathValueData): Promise<any> {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    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

@@ -4846,3 +4846,56 @@ export interface AddReportAbuseData {
   };
   [k: string]: unknown;
 }
+
+
+export interface UpdatePathValueData {
+  /**
+   * ID de l’utilisateur
+   */
+  id: string;
+  /**
+   * Collection de l’entité
+   */
+  collection: "citoyens" | "organizations" | "projects" | "events" | "poi";
+  /**
+   * Chemin de la valeur à mettre à jour
+   */
+  path: string;
+  arrayForm?: boolean;
+  /**
+   * Valeur à mettre à jour (peut être un objet, un tableau, une chaîne, etc.)
+   */
+  value: {
+    [k: string]: unknown;
+  };
+  [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

@@ -7,6 +7,7 @@ import type {
   GetMembersAdminData,
   GetMembersNoAdminData
 } from "./EndpointApi.types.js";
+import type { OpeningHoursEntry } from "./serverDataType/common.js";
 import type { OrganizationItemNormalized } from "./serverDataType/Organization.js";
 import type { User } from "./User.js";
 
@@ -23,9 +24,72 @@ export class Organization extends BaseEntity<OrganizationItemNormalized> {
     "UPDATE_BLOCK_SOCIAL",
     "UPDATE_BLOCK_LOCALITY",
     "UPDATE_BLOCK_SLUG",
-    "PROFIL_IMAGE"
+    "PROFIL_IMAGE",
+    "VIRTUAL_OPENING_HOURS"
   ];
 
+  static override VIRTUAL_SCHEMAS = {
+    VIRTUAL_OPENING_HOURS: {
+      type: "object",
+      properties: {
+        openingHours: {
+          type: "array",
+          description: "Horaires d'ouverture (7 jours de la semaine)",
+          minItems: 7,
+          maxItems: 7,
+          items: {
+            oneOf: [
+              {
+                type: "string",
+                const: ""
+              },
+              {
+                type: "object",
+                properties: {
+                  dayOfWeek: {
+                    type: "string",
+                    enum: ["Mo", "Tu", "We", "Th", "Fr", "Sa", "Su"],
+                    description: "Jour de la semaine"
+                  },
+                  hours: {
+                    type: "array",
+                    description: "Liste des créneaux horaires",
+                    items: {
+                      type: "object",
+                      properties: {
+                        opens: {
+                          type: "string",
+                          pattern: "^([01]\\d|2[0-3]):[0-5]\\d$",
+                          description: "Heure d'ouverture (HH:MM)"
+                        },
+                        closes: {
+                          type: "string",
+                          pattern: "^([01]\\d|2[0-3]):[0-5]\\d$",
+                          description: "Heure de fermeture (HH:MM)"
+                        }
+                      },
+                      required: ["opens", "closes"],
+                      additionalProperties: false
+                    }
+                  }
+                },
+                required: ["dayOfWeek", "hours"],
+                additionalProperties: false
+              }
+            ]
+          }
+        }
+      }
+    }
+  };
+
+  static override CUSTOM_FIELD_HANDLERS = new Map([
+    ["openingHours", {
+      updateMethod: "updateOpeningHours",
+      schemaConstant: "VIRTUAL_OPENING_HOURS"
+    }]
+  ] as const);
+
   static ADD_BLOCKS = new Map([
     ["ADD_ORGANIZATION", "addOrganization"],
     ["PROFIL_IMAGE", "updateImageProfil"]
@@ -99,6 +163,28 @@ export class Organization extends BaseEntity<OrganizationItemNormalized> {
     if (payload.id) delete payload.id;
     let hasChanged = false;
 
+    // 1. Traiter les champs personnalisés AVANT les block updates
+    const customHandlers = Organization.CUSTOM_FIELD_HANDLERS;
+    if (customHandlers) {
+      const processedFields = new Set<string>();
+
+      for (const [fieldName, config] of customHandlers) {
+        if (fieldName in payload && this._hasFieldChanged(fieldName)) {
+          await this._invokeCustomFieldHandler(
+            config.updateMethod,
+            payload[fieldName],
+            fieldName
+          );
+          processedFields.add(fieldName);
+          hasChanged = true;
+        }
+      }
+
+      // Retirer les champs traités du payload pour éviter qu'ils soient traités par les blocks
+      processedFields.forEach(f => delete payload[f]);
+    }
+
+    // 2. Traiter les block updates normaux
     for (const [constant, methodName] of Array.from(Organization.UPDATE_BLOCKS)) {
       const blockData = this._extractChangedFieldsFromSchema(
         this.apiClient,
@@ -249,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 },
@@ -338,7 +424,36 @@ export class Organization extends BaseEntity<OrganizationItemNormalized> {
     // TODO: qui peut créer une news sur l'organisation ?
     return super.news(newsData);
   }
-  
+
+  /**
+   * Met à jour les horaires d'ouverture de l'organisation.
+   * Utilise UPDATE_PATH_VALUE pour modifier le champ openingHours.
+   *
+   * @param hours - Tableau de 7 entrées (une par jour de la semaine)
+   * @returns Résultat de l'appel API
+   * @throws {ApiError} Si l'organisation n'a pas d'ID
+   *
+   * @example
+   * const openingHours = [
+   *   { dayOfWeek: "Mo", hours: [{ opens: "09:00", closes: "18:00" }] },
+   *   { dayOfWeek: "Tu", hours: [{ opens: "09:00", closes: "18:00" }] },
+   *   // ... pour les 7 jours
+   * ];
+   * await org.updateOpeningHours(openingHours);
+   */
+  async updateOpeningHours(hours: OpeningHoursEntry[]): Promise<unknown> {
+    if (!this.id) {
+      throw new ApiError("L'organisation n'a pas d'ID, impossible de mettre à jour les horaires d'ouverture.", 400);
+    }
+
+    return this.endpointApi.updatePathValue({
+      id: this.id,
+      collection: "organizations",
+      path: "openingHours",
+      value: hours as unknown as { [k: string]: unknown }
+    });
+  }
+
   /**
    * ───────────────────────────────
    *  Lien utilisateur ↔ organisation