@communecter/cocolight-api-client 1.0.19 → 1.0.21

package/src/mixin/DraftStateMixin.js

@@ -1,176 +0,0 @@
-// DraftStateMixin.js
-import { ApiError, ApiValidationError } from "../error.js";
-
-export const DraftStateMixin = {
-
-  /**
-   * Crée un proxy combinant draft + serveur, avec transformations facultatives.
-   * @param {Object} server
-   * @param {Object} draft
-   * @param {Array} allowedFields - champs autorisés dans le draft
-   * @param {Object} [transforms={}] - transformateurs de lecture
-   * @param {Object} [options={}] - options
-   * @returns {Proxy}
-   */
-  _createDraftProxy(apiClient, server = {}, draft = {}, allowedFields = [], transforms = {}, options = {}) {
-    return new Proxy({}, {
-      get: (_, prop) => {
-        const val = prop in draft ? draft[prop] : server[prop];
-        const transformer = transforms[prop];
-        return typeof transformer === "function" ? transformer(val) : val;
-      },
-
-      set: (_, prop, value) => {
-        if (!allowedFields.includes(prop)) {
-          const message = `[DraftProxy] Le champ "${prop}" n'est pas autorisé.`;
-          if (options.throwOnError) {
-            throw new ApiValidationError(message, 400, null, {
-              field: prop,
-              value,
-              allowedFields
-            });
-          }
-          apiClient._logger.warn(message);
-          return false;
-        }
-        draft[prop] = value;
-        return true;
-      },
-
-      deleteProperty: (_, prop) => {
-        if (!allowedFields.includes(prop)) return false;
-        delete draft[prop];
-        return true;
-      },
-
-      has: (_, prop) => prop in draft || prop in server,
-      ownKeys: () => [...new Set([...Object.keys(server), ...Object.keys(draft)])],
-      getOwnPropertyDescriptor: () => ({ enumerable: true, configurable: true })
-    });
-  },
-
-  _extractWritableFields(schema = {}, data = {}, ctx = { defs: {}, visited: new Set() }) {
-    if (!schema || typeof schema !== "object") return [];
-    if (schema.$id && ctx.visited.has(schema.$id)) return [];
-    if (schema.$id) ctx.visited.add(schema.$id);
-    ctx.defs = schema.$defs || schema.definitions || ctx.defs;
-
-    const fields = [];
-
-    if (schema.$ref) {
-      const refKey = schema.$ref.replace(/^#\/?(\$defs|definitions)\//, "");
-      const resolved = ctx.defs?.[refKey];
-      if (resolved) fields.push(...this._extractWritableFields(resolved, data, ctx));
-    }
-
-    if (schema.allOf) {
-      schema.allOf.forEach(s => fields.push(...this._extractWritableFields(s, data, ctx)));
-    }
-
-    if (schema.if && schema.then) {
-      const condition = schema.if?.properties;
-      let matches = true;
-      if (condition) {
-        for (const key in condition) {
-          const expected = condition[key]?.const;
-          if (data[key] !== expected) {
-            matches = false;
-            break;
-          }
-        }
-      }
-      if (matches && schema.then) {
-        fields.push(...this._extractWritableFields(schema.then, data, ctx));
-      } else if (!matches && schema.else) {
-        fields.push(...this._extractWritableFields(schema.else, data, ctx));
-      }
-    }
-
-    if (schema.properties) {
-      fields.push(...Object.entries(schema.properties)
-        // eslint-disable-next-line no-unused-vars
-        .filter(([_, def]) => def.readOnly !== true && def.const === undefined)
-        .map(([key]) => key));
-    }
-
-    return [...new Set(fields)];
-  },
-
-  _buildDraftAndProxy({ data = {}, serverData = null, constant, apiClient, transforms = {}, throwOnError = true, removeFields = [] }) {
-    const constants = Array.isArray(constant) ? constant : [constant];
-    const combinedSchema = {
-      allOf: [],
-      $defs: {}
-    };
-    
-    for (const key of constants) {
-      const sch = apiClient.getRequestSchema(key);
-      if (!sch) throw new ApiError(`Unable to find schema for ${key}.`);
-    
-      // Extraire et fusionner les $defs
-      if (sch.$defs) {
-        for (const [defKey, defVal] of Object.entries(sch.$defs)) {
-          if (combinedSchema.$defs[defKey]) {
-            apiClient._logger.warn(`Duplicate $defs key '${defKey}' from schema '${key}'`);
-          } else {
-            combinedSchema.$defs[defKey] = defVal;
-          }
-        }
-      }
-    
-      combinedSchema.allOf.push(sch);
-    }
-    const draft = {};
-    let allowed = this._extractWritableFields(combinedSchema, data);
-
-    if (data.id && allowed.indexOf("id") === -1) {
-      allowed.push("id");
-    }
-    if (data.slug && allowed.indexOf("slug") === -1) {  
-      allowed.push("slug");
-    }
-
-    allowed = allowed.filter(k => !removeFields.includes(k));
-
-    for (const key of allowed) {
-      const raw = data[key];
-      const transformed = typeof transforms[key] === "function" ? transforms[key](raw, data) : raw;
-      if (transformed !== undefined) draft[key] = transformed;
-    }
-
-    const proxy = this._createDraftProxy(apiClient, serverData, draft, allowed, transforms, { throwOnError });
-
-    return { draft, proxy };
-  },
-
-  _extractChangedFieldsFromSchema(apiClient, constant, data = {}, getInitialDraft, removeFields = []) {
-    const schema = apiClient.getRequestSchema(constant);
-    let allowed = this._extractWritableFields(schema, data);
-    const changed = {};
-    const initialDraft = getInitialDraft?.() || {};
-  
-    // on enlève les champs qui ne sont pas dans le draft
-    // ou qui sont dans removeFields
-    allowed = allowed.filter(k => !removeFields.includes(k));
-
-    for (const key of allowed) {
-      // on verifie que le champ existe dans le draft
-      // sinon on ne le prend pas en compte
-
-      if (data[key] === undefined) continue;
-  
-      const current = data[key];
-      const initial = initialDraft[key];
-  
-      const changedValue =
-        JSON.stringify(current) !== JSON.stringify(initial);
-  
-      if (changedValue) {
-        changed[key] = current;
-      }
-    }
-  
-    return Object.keys(changed).length > 0 ? changed : null;
-  }
-  
-};

package/src/mixin/EntityMixin.js

@@ -1,428 +0,0 @@
-import { ApiError, ApiResponseError } from "../error.js";
-
-// EntityMixin.js
-export const EntityMixin = {
-  /**
-     * Récupère le profil complet de l'organisation.
-     *
-     * @returns {Promise<Object>} Le profil complet.
-     */
-  async get() {
-    return this.apiClient.safeCall(async () => {
-      const data = await this.getPublicProfile();
-      this._setData(data);
-      return data;
-    });
-  },
-  
-  /**
-   * Mettre à jour les paramètres d'un élément : Mise à jour des paramètres spécifiques d'un élément.
-   * Constant : UPDATE_SETTINGS
-   * @param {Object} data - Les données à envoyer.
-   * @param {string} data.type - data.type
-   * @param {undefined} data.value - data.value
-   * @returns {Promise<Object>} - 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 updateSettings(data = {}) {
-    data.idEntity = this.id;
-    data.typeEntity = this.getEntityType();
-    return this.callIsConnected(() => this.endpointApi.updateSettings(data));
-  },
-  
-  /**
-   * Mettre à jour la description d'un élément : Permet de mettre à jour la description courte et complète d'un élément.
-   * Constant : UPDATE_BLOCK_DESCRIPTION
-   * @param {Object} data - Les données à envoyer.
-   * @param {string} data.descMentions - Mentions dans la description (default: "")
-   * @param {string} data.shortDescription - Courte description
-   * @param {string} data.description - Description complète
-   * @returns {Promise<Object>} - 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 updateDescription(data = {}) {
-    data.typeElement = this.getEntityType();
-    data.id = this.id;
-    return this.callIsConnected(() => this.endpointApi.updateBlockDescription(data));
-  },
-    
-  /**
-     * Mettre à jour les informations d'un élément : Permet de mettre à jour les informations générales d'un élément (nom, contacts, etc.).
-     * Constant : UPDATE_BLOCK_INFO
-     */
-  async updateInfo(data = {}) {
-    data.typeElement = this.getEntityType();
-    data.id = this.id;
-    return this.callIsConnected(() => this.endpointApi.updateBlockInfo(data));
-  },
-    
-  /**
-   * Mettre à jour les réseaux sociaux d'un élément : Permet de mettre à jour les liens vers les réseaux sociaux d'un élément.
-   * Constant : UPDATE_BLOCK_SOCIAL
-   */
-  async updateSocial(data = {}) {
-    data.typeElement = this.getEntityType();
-    data.id = this.id;
-    return this.callIsConnected(() => this.endpointApi.updateBlockSocial(data));
-  },
-    
-  /**
-   * Mettre à jour les localités d'un élément : Permet de mettre à jour l'adresse et les informations géographiques d'un élément.
-   * Constant : UPDATE_BLOCK_LOCALITY
-   */
-  async updateLocality(data = {}) {
-    data.typeElement = this.getEntityType();
-    data.id = this.id;
-    return this.callIsConnected(() => this.endpointApi.updateBlockLocality(data));
-  },
-    
-  /**
-   * Mettre à jour le slug d'un élément : Permet de mettre à jour le slug pour une URL simplifiée.
-   * Constant : UPDATE_BLOCK_SLUG
-   */
-  async updateSlug({ slug }) {
-    try {
-      await this.endpointApi.check({ type: this.getEntityType(), id: this.id, slug });
-    } catch (error) {
-      if(error instanceof ApiResponseError) {
-        throw new ApiResponseError("Erreur lors de la vérification du slug.", error.status, error.data);
-      }
-      throw error;
-    }
-    return this.callIsConnected(() => this.endpointApi.updateBlockSlug({ typeElement: this.getEntityType(), id: this.id, slug }));
-  },
-    
-  /**
-   * Mettre à jour l'image de profil : Permet de mettre à jour l'image de profil d'un utilisateur ou d'une entité.
-   * Constant : PROFIL_IMAGE
-   */
-  async updateImageProfil({ profil_avatar: image  }) {
-    image = await this._validateImage(image);
-    const data = { pathParams: { folder: this.getEntityType(), ownerId: this.id },  profil_avatar: image };
-    return this.callIsConnected(() => this.endpointApi.profilImage(data));
-  },
-
-  /**
-   * Crée une instance d'organisation et récupère son profil si nécessaire.
-   *
-   * @param {Object} organizationData - Les données nécessaires pour initialiser l'organisation.
-   * @returns {Promise<Organization>} Une promesse qui résout l'objet Organisation créé.
-   * @throws {Error} Si une erreur se produit lors de la création de l'organisation.
-   */
-  async organization(organizationData = {}) {
-    if(!this.isMe){
-      throw new ApiError("Vous devez être connecté et être l'utilisateur pour créer une organisation.");
-    }
-    return this.entity("organizations", organizationData);
-  },
-
-  /**
-   * Crée une instance de projet et récupère son profil si nécessaire.
-   *
-   * @param {Object} projectData - Les données nécessaires pour initialiser le projet.
-   * @returns {Promise<Project>} Une promesse qui résout l'objet Projet créé.
-   * @throws {Error} Si une erreur se produit lors de la création du projet.
-   */
-  async project(projectData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
-    if(!this.isConnected){
-      throw new ApiError("Vous devez être connecté pour créer un projet.");
-    }
-    return this.entity("projects", projectData);
-  },
-
-  /**
-   * Crée une instance de POI et la récupère si nécessaire.
-   * 
-   * @param {Object} poiData - Les données nécessaires pour initialiser le POI.
-   * @returns {Promise<Poi>} Une promesse qui résout l'objet POI créé.
-   * @throws {Error} Si une erreur se produit lors de la création du POI.
-   */
-  async poi(poiData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
-    if(!this.isConnected){
-      throw new ApiError("Vous devez être connecté pour créer un POI.");
-    }
-    return this.entity("poi", poiData);
-  },
-
-  /**
-   * Crée une instance d'événement et la récupère si nécessaire.
-   * 
-   * @param {Object} eventData - Les données nécessaires pour initialiser l'événement.
-   * @returns {Promise<Event>} Une promesse qui résout l'objet Événement créé.
-   * @throws {Error} Si une erreur se produit lors de la création de l'événement.
-   */
-  async event(eventData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
-    if(!this.isConnected){
-      throw new ApiError("Vous devez être connecté pour créer un événement.");
-    }
-    return this.entity("events", eventData);
-  },
-
-  /**
-   * Crée une instance de badge et la récupère si nécessaire.
-   * 
-   * @param {Object} badgeData - Les données nécessaires pour initialiser le badge.
-   * @returns {Promise<Badge>} Une promesse qui résout l'objet Badge créé.
-   * @throws {Error} Si une erreur se produit lors de la création du badge.
-   */
-  async badge(badgeData = {}) {
-    // TODO: Vérifier si l'utilisateur est admin de l'organisation
-    if(!this.isConnected){
-      throw new ApiError("Vous devez être connecté pour créer un badge.");
-    }
-    return this.entity("badges", badgeData);
-  },
-
-  /**
-   * Crée une instance de news et la récupère si nécessaire.
-   * 
-   * @param {Object} newsData - Les données nécessaires pour initialiser la news.
-   * @returns {Promise<News>} Une promesse qui résout l'objet News créé.
-   * @throws {Error} Si une erreur se produit lors de la création de la news.
-   */
-  async news(newsData = {}) {
-    if(!this.isConnected){
-      throw new ApiError("Vous devez être connecté.");
-    }
-    return this.entity("news", newsData);
-  },
-
-  /**
-   * Récupérer les organisations d'une entitée : la liste des organisations dont l'entité est membre ou admin valide.
-   * Constant : GET_ORGANIZATIONS_ADMIN | GET_ORGANIZATIONS_NO_ADMIN
-   * @param {Object} data - Les données à envoyer.
-   * @returns {Promise<Object>} - Les données de réponse.
-   */
-  async getOrganizations(data = {}) {
-
-    if(this.isMe){
-      data.pathParams = { type: this.getEntityType(), id: this.id };
-      // NOTE : dans le schema je crois que si pas de data.filters alors le default ce fait avec data.pathParams
-      // data.filters = {
-      //   [`links.members.${this.id}`]: { "$exists": true },
-      //   [`links.members.${this.id}.toBeValidated`]: { "$exists": false },
-      //   [`links.members.${this.id}.isInviting`]: { "$exists": false }
-      // };
-    } else {
-      delete data?.pathParams;
-      data.filters = {
-        [`links.members.${this.id}`]: { "$exists": true },
-        [`links.members.${this.id}.toBeValidated`]: { "$exists": false },
-        [`links.members.${this.id}.isInviting`]: { "$exists": false }
-      };
-    }
-  
-    const fetchFn = this.isMe
-      ? () => this.callIsMe(() => this.endpointApi.getOrganizationsAdmin(data))
-      : () => this.endpointApi.getOrganizationsNoAdmin(data);
-  
-    const arrayObjetOrganizations = await fetchFn();
-  
-    if (!Array.isArray(arrayObjetOrganizations.results)) {
-      throw new ApiResponseError("Erreur lors de la récupération des organisations.", 500, arrayObjetOrganizations.results);
-    }
-  
-    // nettoyage du count
-    delete arrayObjetOrganizations?.count?.spam;
-  
-    // calcul du total
-    const totalCount = Object.values(arrayObjetOrganizations.count || {}).reduce((acc, val) => acc + val, 0);
-    arrayObjetOrganizations.count.total = totalCount;
-  
-    const rawOrganizationsList = arrayObjetOrganizations.results.map(
-      (d) => this.linkEntity?.(d.collection, d) ?? d
-    );
-  
-    return {
-      count: arrayObjetOrganizations.count,
-      results: rawOrganizationsList
-    };
-  },
-
-  /**
-     * Récupérer les projets d'une entitée : liste des projets de l'entité ou elle est "parent" ou "contributeur".
-     * Constant : GET_PROJECTS_ADMIN | GET_PROJECTS_NO_ADMIN
-     * @param {Object} data - Les données à envoyer.
-     * @returns {Promise<Object>} - Les données de réponse.
-     */
-  async getProjects(data = {}) {
-
-    if(this.isMe){
-      data.pathParams = { type: this.getEntityType(), id: this.id };
-      // NOTE : dans le schema je crois que si pas de data.filters alors le default ce fait avec data.pathParams
-      // data.filters = {
-      //   "$or": {
-      //     [`links.contributors.${this.id}`]: { "$exists": true },
-      //     [`parent.${this.id}`]: { "$exists": true }
-      //   },
-      //   [`links.contributors.${this.id}`]: { "$exists": true }
-      // };
-    } else {
-      delete data?.pathParams;
-      data.filters = {
-        "$or": {
-          [`links.contributors.${this.id}`]: { "$exists": true },
-          [`parent.${this.id}`]: { "$exists": true }
-        },
-        [`links.contributors.${this.id}`]: { "$exists": true }
-      };
-    }
-    
-    const fetchFn = this.isMe
-      ? () => this.callIsMe(() => this.endpointApi.getProjectsAdmin(data))
-      : () => this.endpointApi.getProjectsNoAdmin(data);
-    
-    
-    const arrayObjetProjects = await fetchFn();
-    
-    if (!Array.isArray(arrayObjetProjects.results)) {
-      throw new ApiResponseError("Erreur lors de la récupération des projets.", 500, arrayObjetProjects.results);
-    }
-  
-    const rawProjectsList = arrayObjetProjects.results.map(
-      (d) => this.linkEntity?.(d.collection, d) ?? d
-    );
-    
-    return {
-      count: arrayObjetProjects?.count?.projects ?? 0,
-      results: rawProjectsList
-    };
-  },
-
-  /**
-   * Récupérer les POIs d'une entité : liste des POIs de l'entité ou elle est "parent".
-   * Constant : GET_POIS_NO_ADMIN / GET_POIS_ADMIN
-   * @param {Object} data - Les données à envoyer.
-   * @returns {Promise<Object>} - Les données de réponse.
-   */
-  async getPois(data = {}) {
-
-    if(this.isMe){
-      data.pathParams = { type: this.getEntityType(), id: this.id };
-      // NOTE : dans le schema je crois que si pas de data.filters alors le default ce fait avec data.pathParams
-      // data.filters = {
-      //   [`parent.${this.id}`]: { "$exists": true },
-      // };
-    } else {
-      delete data?.pathParams;
-      data.filters = {
-        [`parent.${this.id}`]: { "$exists": true },
-      };
-    }
-  
-    const fetchFn = this.isMe
-      ? () => this.callIsMe(() => this.endpointApi.getPoisAdmin(data))
-      : () => this.endpointApi.getPoisNoAdmin(data);
-  
-    const arrayObjetPois = await fetchFn();
-    if (!Array.isArray(arrayObjetPois.results)) {
-      throw new ApiResponseError("Erreur lors de la récupération des POIs.", 500, arrayObjetPois.results);
-    }
-
-    // lier les entités au objets
-    const rawPoisList = arrayObjetPois.results.map(
-      (d) => this.linkEntity?.(d.collection, d) ?? d
-    );
-
-    return {
-      count: arrayObjetPois.count?.poi ?? 0,
-      results: rawPoisList
-    };
-  },
-
-  /**
-   * Récupérer les abonnés d'une entité
-   * Constant : GET_SUBSCRIBERS
-   * @param {Object} data - Les données à envoyer.
-   * @returns {Promise<Object>} - Les données de réponse.
-   */
-  async getSubscribers(data = {}) {
-    delete data?.pathParams;
-
-    data.filters =  {
-      [`links.follows.${this.id}`]: { "$exists": true },
-      [`links.follows.${this.id}.toBeValidated`]: { "$exists": false },
-      [`links.follows.${this.id}.isInviting`]: { "$exists": false }
-    };
-  
-    const arrayObjetSubscribers = await  this.endpointApi.getSubscribers(data);
-    if (!Array.isArray(arrayObjetSubscribers.results)) {
-      throw new ApiResponseError("Erreur lors de la récupération des abonnés.", 500, arrayObjetSubscribers.results);
-    }
-
-    // lier les entités au objets
-    const rawSubscribersList = arrayObjetSubscribers.results.map(
-      (d) => this.linkEntity?.(d.collection, d) ?? d
-    );
-
-    return {
-      count: arrayObjetSubscribers.count,
-      results: rawSubscribersList
-    };
-  },
-
-  /**
-   * Liste des badges créés par l'entité
-   * Constant : GET_BADGES
-   * @param {Object} data - Les données à envoyer.
-   * @returns {Promise<Object>} - Les données de réponse. 
-   */
-  async getBadgesIssuer(data = {}) {
-    delete data?.pathParams;
-  
-    data.filters = data.filters || {};
-    data.filters["$or"] = {};
-    data.filters["$or"][`issuer.${this.id}`] = { "$exists": true };
-
-    const arrayObjetBadges = await this.endpointApi.getBadges(data);
-    if (!Array.isArray(arrayObjetBadges.results)) {
-      throw new ApiResponseError("Erreur lors de la récupération des badges.", 500, arrayObjetBadges.results);
-    }
-
-    // lier les entités au objets
-    const rawBadgesList = arrayObjetBadges.results.map(
-      (d) => this.linkEntity?.(d.collection, d) ?? d
-    );
-
-    return {
-      count: arrayObjetBadges.count?.badges ?? 0,
-      results: rawBadgesList
-    };
-  },
-
-  /**
-   * Récupérer les actualités : Récupère la liste d’actualités selon plusieurs critères.
-   * Constant : GET_NEWS
-   * @param {Object} data - Les données à envoyer.
-   * @param {number} data.dateLimit - Limite de date timestamp ou 0 (default: 0)
-   * @param {object} data.search - data.search
-   * @param {string} data.search.name - Nom ou terme recherché (default: "")
-   * @param {number} data.indexStep - Nombre de résultats par page (default: 12)
-   * @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 getNews(data = {}) {
-    data.pathParams = { type: this.getEntityType(), id: this.id };
-    const arrayObjetNews =  await this.endpointApi.getNews(data);
-    if(!Array.isArray(arrayObjetNews)){
-      throw new ApiResponseError("Erreur lors de la récupération des actualités.", 500, arrayObjetNews);
-    }
-
-    const rawNewsList = arrayObjetNews.map(
-      (d) => this.linkEntity?.(d.collection, d) ?? d
-    );
-
-    return this._createFilteredProxy(rawNewsList);
-  }
-
-
-};
-