@communecter/cocolight-api-client 1.0.9 → 1.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@communecter/cocolight-api-client",
-    "version": "1.0.9",
+    "version": "1.0.10",
     "description": "Client Axios simplifié pour l'API cocolight",
     "repository": {
         "type": "git",
@@ -32,7 +32,8 @@
         "generate:testdata": "node ./scripts/generate-test-data.js",
         "generate:reponses": "node ./scripts/generate-constant-response-200.js",
         "generate:methodeapi": "node ./scripts/generate-methode-api.js",
-        "generate:ajv-standalone": "node ./scripts/generate-validate-function-ajv.js"
+        "generate:ajv-standalone": "node ./scripts/generate-validate-function-ajv.js",
+        "generate:entities": "node scripts/generate-entities.js"
     },
     "keywords": [
         "communecter",

package/src/Api.js

@@ -1,5 +1,6 @@
 // Api.js
 import EndpointApi from "./api/EndpointApi.js";
+import { News } from "./api/News.js";
 import { Organization } from "./api/Organization.js";
 import { Project } from "./api/Project.js";
 import { User } from "./api/User.js";
@@ -76,12 +77,14 @@ export default class Api {
   /**
    * Retourne l'utilisateur connecté.
    *
-   * @returns {User} L'utilisateur connecté.
+   * @returns {Promise<User>} L'utilisateur connecté.
+   * @throws {ApiAuthenticationError} Si l'utilisateur n'est pas authentifié.
    */
-  me() {
+  async me() {
     if (!this._loggedUser) {
       throw new ApiAuthenticationError("Accès refusé : utilisateur non authentifié.");
     }
+    await this._loggedUser.get();
     return this._loggedUser;
   }
 
@@ -89,11 +92,18 @@ export default class Api {
    * Crée une instance User pour un utilisateur donné (autre que le connecté).
    *
    * @param {Object} userData - Les données de l'utilisateur public.
-   * @returns {User}
+   * @returns {Promise<User>} Une promesse qui résout l'instance User.
+   * @throws {Error} Si une erreur se produit lors de la création de l'utilisateur.
    */
-  user(userData) {
+  async user(userData) {
     try {
-      return new User(this._client, userData, {}, { EndpointApi });
+      if (!userData.id && !userData.slug) {
+        return new User(this._client, userData, { EndpointApi, Organization, Project, News });
+      } else {
+        const user = new User(this._client, userData, { EndpointApi, Organization, Project, News });
+        await user.get();
+        return user;
+      }
     } catch (error) {
       console.error("[Api.user] Erreur lors de la création d'un objet utilisateur public :", error.message);
       throw error;
@@ -105,18 +115,17 @@ export default class Api {
    * Creates an Organization object and optionally retrieves its profile.
    *
    * @param {Object} organizationData - The data required to initialize the Organization object.
-   * @param {Object} [options={ getProfile: true }] - Additional options for the organization creation.
-   * @param {boolean} [options.getProfile=true] - Whether to fetch the organization's profile after creation.
    * @returns {Promise<Organization>} A promise that resolves to the created Organization object.
    * @throws {Error} Throws an error if the organization creation or profile retrieval fails.
    */
-  async organization(organizationData, options = { getProfile: true }) {
+  async organization(organizationData) {
     try {
-      const oraganization = new Organization(this._client, organizationData, { EndpointApi });
-      if (options.getProfile) {
-        await oraganization.getProfil();
+      const organization = new Organization(this._client, organizationData, { EndpointApi, User, Project, News });
+      if (!organizationData.id && !organizationData.slug) {
+        throw new Error("Vous devez fournir un id ou un slug pour créer une instance Organization.");
       }
-      return oraganization;
+      await organization.get();
+      return organization;
     } catch (error) {
       console.error("[Api.organization] Erreur lors de la création d'un objet organisation :", error.message);
       throw error;
@@ -127,17 +136,16 @@ export default class Api {
    * Creates a new Project instance and optionally retrieves its profile.
    *
    * @param {Object} projectData - The data used to initialize the Project instance.
-   * @param {Object} [options={ getProfile: true }] - Additional options for project creation.
-   * @param {boolean} [options.getProfile=true] - Whether to retrieve the project's profile after creation.
    * @returns {Promise<Project>} A promise that resolves to the created Project instance.
    * @throws {Error} If an error occurs during project creation or profile retrieval.
    */
-  async project(projectData, options = { getProfile: true }) {
+  async project(projectData) {
     try {
-      const project = new Project(this._client, projectData, { EndpointApi });
-      if (options.getProfile) {
-        await project.getProfil();
+      const project = new Project(this._client, projectData, { User, News, EndpointApi });
+      if (!projectData.id && !projectData.slug) {
+        throw new Error("Vous devez fournir un id ou un slug pour créer une instance Project.");
       }
+      await project.get();
       return project;
     } catch (error) {
       console.error("[Api.project] Erreur lors de la création d'un objet projet :", error.message);
@@ -150,11 +158,15 @@ export default class Api {
    *
    * @returns {ApiClient}
    */
-
   get client() {
     return this._client;
   }
 
+  /**
+   * Retourne l'instance d'EndpointApi.
+   * 
+   * @returns {EndpointApi}
+   */
   get endpointApi() {
     return new EndpointApi(this._client);
   }

package/src/ApiClient.js

@@ -51,6 +51,8 @@ export default class ApiClient extends EventEmitter {
       throw new ApiClientError("Le paramètre \"baseURL\" est obligatoire.", 500);
     }
 
+    this.__entityTag = "ApiClient";
+    
     this._baseURL = baseURL;
     this._refreshToken = refreshToken;
     this._refreshUrl = refreshUrl;
@@ -86,7 +88,6 @@ export default class ApiClient extends EventEmitter {
     });
 
     // Pino logger
-    // (Ici en mode pretty-print sur la console, tu peux configurer comme tu veux)
     this._logger = pino({
       transport: {
         target: "pino-pretty",
@@ -1379,5 +1380,13 @@ export default class ApiClient extends EventEmitter {
   };
   
 
+  getRequestSchema(constant) {
+    const endpoint = this._endpoints.find(e => e.constant === constant);
+    return endpoint?.request || null;
+  }
+
+  getPathSchema(constant) {
+    return this._endpoints.find(e => e.constant === constant)?.pathParams || null;
+  }
 
 }

package/src/api/News.js

@@ -1,51 +1,70 @@
 import { ApiError } from "../error.js";
-import { NewsMixin } from "../mixin/NewsMixin.js";
+import { DraftStateMixin } from "../mixin/DraftStateMixin.js";
 import { UtilMixin } from "../mixin/UtilMixin.js";
 
 // News.js
 export class News {
-  // Champs privés pour protéger l'état
   #draftData = {};
-  // Data d'une news venant du serveur
+  #initialDraftData = {};
   #serverData = null;
 
+  static entityType = "news";
+
+  static SCHEMA_CONSTANTS = [
+    "ADD_NEWS"
+  ];
+
   /**
    * Crée une instance de News.
    * @param {(Organization|Project|User)} parent - L'instance de l'element parent (ex: Organization, Project, User).
-   * @param {Object} identifier - Objet contenant { id }
+   * @param {Object} data - Objet contenant { id }
    * @param {Object} deps - Dépendances injectées (ex: User).
    * @param {EndpointApi} deps.EndpointApi - Classe EndpointApi pour éviter les dépendances circulaires.
    * @param {User} deps.User - Classe User pour éviter les dépendances circulaires.
    */
 
   constructor(parent, data = {}, deps = {}) {
-    if(!deps.EndpointApi){
-      throw new ApiError("EndpointApi class must be injected to avoid circular dependency.");
-    }
-    if (!deps.User) {
-      throw new ApiError("User class must be injected to avoid circular dependency.");
-    }
-    if (!parent) {
-      throw new ApiError("Parent is required.");
-    }
+    this.__entityTag = "News";
+  
+    if (!deps.EndpointApi) throw new ApiError("EndpointApi class must be injected to avoid circular dependency.");
+    if (!deps.User) throw new ApiError("User class must be injected.");
+  
+    if (!parent) throw new ApiError("Parent is required.");
     this.deps = deps;
-    this.UserClass = deps.User;
-    this.apiClient = parent.apiClient;
-
-    // Gérer les deux cas : fonction constructeur ou instance
-    if (typeof deps.EndpointApi === "function") {
-      this.endpointApi = new deps.EndpointApi(this.apiClient);
-    } else if (typeof deps.EndpointApi === "object") {
-      this.endpointApi = deps.EndpointApi;
+    this.EndpointApiClass = deps.EndpointApi;
+  
+    if (parent?.__entityTag === "User" || parent?.__entityTag === "Organization" || parent?.__entityTag === "Project") {
+      this.apiClient = parent.apiClient;
+      this.parent = parent;
     } else {
-      throw new ApiError("deps.EndpointApi doit être une classe ou une instance valide.");
+      throw new ApiError("Invalid parent for News.");
     }
+  
+    this.endpointApi = typeof deps.EndpointApi === "function"
+      ? new deps.EndpointApi(this.apiClient)
+      : (typeof deps.EndpointApi === "object"
+        ? deps.EndpointApi
+        : (() => { throw new ApiError("deps.EndpointApi must be a class or instance."); })());
+  
+
+    this.#serverData = null;
 
-    this.#draftData = { ...data };
-    this.parent = parent;
+    const { draft, proxy } = this.buildDraftAndProxy({
+      data: { ...data, ...this.defaultFields },
+      serverData: this.#serverData,
+      constant: News.SCHEMA_CONSTANTS,
+      apiClient: this.apiClient,
+      transforms: this.transforms,
+      removeFields: this.removeFields
+    });
+    
+    this.#initialDraftData = JSON.parse(JSON.stringify(draft)); // snapshot propre
+    this.#draftData = draft;
+    this.data = proxy;
 
   }
   
+  
   // Getters en lecture seule pour chaque propriété
   get id() {
     return this.#draftData.id || null;
@@ -58,6 +77,10 @@ export class News {
   get draftData() {
     return this.#draftData;
   }
+
+  get initialDraftData() {
+    return this.#initialDraftData;
+  }
   
   get serverData() {
     return this.#serverData;
@@ -71,18 +94,41 @@ export class News {
     return this.isConnected && this.userId === this.parent.id;
   }
 
+  _setData(newData) {
+    this.#serverData = { ...newData };
+
+    const { draft, proxy } = this.buildDraftAndProxy({
+      data: { ...newData, ...this.defaultFields },
+      serverData: this.#serverData,
+      constant: News.SCHEMA_CONSTANTS,
+      apiClient: this.apiClient,
+      transforms: this.transforms,
+      removeFields: this.removeFields
+    });
+    this.#initialDraftData = JSON.parse(JSON.stringify(draft));
+    this.#draftData = draft;
+    this.data = proxy;
+  }
+
   getEntityType() {
-    return "news";
+    return News.entityType;
   }
 
   static fromServerData(data, parent, deps) {
-    const instance = new News(parent, { id: data.id }, deps);
-  
-    // Injecte les données serveur
+    const instance = new News(parent, {}, deps);
     instance.#serverData = { ...data };
   
-    // Construit les données draft à partir du serverData
-    instance.#draftData = instance._getDraftFromServerData(data);
+    const { draft, proxy } = instance.buildDraftAndProxy({
+      data: { ...data, ...instance.defaultFields },
+      serverData: instance.#serverData,
+      constant: News.SCHEMA_CONSTANTS,
+      apiClient: instance.apiClient,
+      transforms: instance.transforms,
+      removeFields: instance.removeFields
+    });
+    
+    instance.#draftData = draft;
+    instance.data = proxy;
   
     return instance;
   }
@@ -97,64 +143,23 @@ export class News {
    * Constant : GET_NEWS_BY_ID
    */
   async get() {
-    if(!this.id) {
-      throw new ApiError("Vous devez fournir un id pour récupérer une news.");
-    }
-    const newsArray = await this.callIsConnected(() => this.endpointApi.getNewsById({ ids: [this.id] }));
-    if (newsArray && newsArray.length > 0) {
-      this.#serverData = newsArray[0];
-      this.#draftData = this._getDraftFromServerData(this.#serverData);
+    if (!this.id) throw new ApiError("Impossible de rafraîchir sans ID.");
+
+    const newsArray = await this.callIsConnected(() =>
+      this.endpointApi.getNewsById({ ids: [this.id] })
+    );
+
+    if (newsArray && Array.isArray(newsArray) && newsArray.length === 1) {
+      const data = newsArray[0];
+      this.#serverData = { ...data };
+
+      this._setData(data);
+      
       return this.#serverData;
     }
     throw new ApiError(`Aucune actualité trouvée pour l'ID ${this.id}`);
   }
 
-  _getDraftFromServerData(data) {
-    // je veux copier que certaine info si présente dans le draftData
-    // - newsArray[0].scope.type > draftData.scope
-    // - newsArray[0].text > draftData.text
-    // - newsArray[0].tags > draftData.tags
-    // - newsArray[0].mentions > draftData.mentions > draftData.mentions.count integer
-    // - newsArray[0].mediaImg > draftData.mediaImg > draftData.mediaImg.images > un array id
-    // - newsArray[0].mediaFile > draftData.mediaFile > draftData.mediaFile.files > un array id
-    const transformed = this._pickProps(
-      data,
-      ["scope", "text", "tags", "mentions", "mediaImg", "mediaFile"],
-      {
-        scope: (val) => val?.type,
-        mentions: (val) =>
-          Array.isArray(val)
-            ? val.map((mention) => ({
-              ...mention,
-              count: parseInt(mention.count)
-            }))
-            : [],
-        mediaImg: (val) => {
-          const images = val?.images?.map((img) => img.id).filter(Boolean) || [];
-          return images.length > 0
-            ? {
-              countImages: parseInt(val.countImages) || images.length,
-              images
-            }
-            : undefined;
-        },
-        mediaFile: (val) => {
-          const files = val?.files?.map((file) => file.id).filter(Boolean) || [];
-          return files.length > 0
-            ? {
-              countFiles: parseInt(val.countFiles) || files.length,
-              files
-            }
-            : undefined;
-        }
-      }
-    );
-  
-    return {
-      id: data.id,
-      ...Object.fromEntries(Object.entries(transformed).filter(([, v]) => v !== undefined))
-    };
-  }
   
   /**
    * Ajouter une actualité : Ajoute une nouvelle actualité.
@@ -162,6 +167,10 @@ export class News {
    */
   async save() {
 
+    if(!this.isConnected){
+      throw new ApiError("Impossible de sauvegarder sans être connecté.");
+    }
+
     // si le texte est vide, on met un espace pour que le champ soit pris en compte car sur le serveur
     // il y a une vérification de la taille du texte je pense
     if(this.#draftData?.text === ""){
@@ -203,8 +212,8 @@ export class News {
       if (!slug && !id) {
         throw new ApiError("Vous devez fournir un slug ou un id pour ajouter une mention.");
       }
-      const userInstance = new this.UserClass(this.apiClient, { id, slug }, null , { EndpointApi: this.endpointApi  });
-      const user = await userInstance.getProfil();
+      const userInstance = new this.deps.User(this.apiClient, { id, slug }, { EndpointApi: this.endpointApi  });
+      const user = userInstance.serverData;
       if (!this.#draftData.mentions) {
         this.#draftData.mentions = [];
       }
@@ -229,6 +238,7 @@ export class News {
 
   }
 
+  
   /**
    * Ajouter une image à une actualité : Ajoute une images à une actualité.
    * Constant : ADD_IMAGE_NEWS
@@ -278,9 +288,40 @@ export class News {
     this.#draftData.id = null;
     this._isDeleted = true;
   }
-    
+  
+  _updateInitialDraftSnapshot() {
+    this.#initialDraftData = JSON.parse(JSON.stringify(this.#draftData));
+  }
+
+  hasChanges() {
+    return JSON.stringify(this.#draftData) !== JSON.stringify(this.#initialDraftData);
+  }
+
+  defaultFields = {
+
+  };
+
+  removeFields = [
+
+  ];
+
+  transforms = {
+    scope: val => val?.type,
+    mentions: val =>
+      Array.isArray(val)
+        ? val.map(m => ({ ...m, count: parseInt(m.count) }))
+        : [],
+    mediaImg: val => {
+      const images = val?.images?.map(img => img.id).filter(Boolean) || [];
+      return images.length > 0 ? { countImages: images.length, images } : undefined;
+    },
+    mediaFile: val => {
+      const files = val?.files?.map(f => f.id).filter(Boolean) || [];
+      return files.length > 0 ? { countFiles: files.length, files } : undefined;
+    }
+  };
+
 }
 
 // Incorporation du mixin dans Organization
-Object.assign(News.prototype, UtilMixin, NewsMixin);
-  
+Object.assign(News.prototype, UtilMixin, DraftStateMixin);