@communecter/cocolight-api-client 1.0.31 → 1.0.33

package/src/api/EntityRegistry.js

@@ -0,0 +1,66 @@
+export const EntityRegistry = new Map();
+
+/**
+ * Enregistre une entité dans la registry.
+ * @param {string} tag - ex: "User", "Organization"
+ * @param {Function} EntityClass - la classe constructeur
+ */
+export function registerEntity(tag, EntityClass) {
+  EntityRegistry.set(tag, EntityClass);
+}
+
+/**
+ * Récupère une instance depuis un JSON générique.
+ * @param {Object} json - doit contenir __entityTag
+ * @param {Object} parent - ApiClient ou entité parent
+ * @param {Object} deps - dépendances (comme dans le constructeur)
+ * @returns {BaseEntity|null}
+ */
+export function fromEntityJSON(json, parent = null) {
+  if (!json?.__entityTag) return null;
+  if (!json._serverData?.collection) return json;
+  const meta = _getEntityMeta(json._serverData.collection, json.__entityTag);
+  if (!meta) return json;
+  if (!meta?.entityClass?.fromJSON) throw new Error(`Classe inconnue ou fromJSON manquant pour ${json.__entityTag}`);
+  return meta.entityClass.fromJSON(json, parent, meta.deps);
+}
+
+/**
+   * Récupère la classe d'entité et ses dépendances à partir du type d'entité.
+   * 
+   * @param {string} entityType - Le type d'entité.
+   * @param {string} __entityTag - Le tag de l'entité.
+   * @returns {Object|null} - Un objet contenant la classe d'entité et ses dépendances, ou null si le type d'entité n'est pas trouvé.
+   */
+function _getEntityMeta(entityType, __entityTag) {
+  const selfClass = EntityRegistry.get(__entityTag);
+  const selfTag = __entityTag;
+  
+  const commonDeps = {
+    EndpointApi: EntityRegistry.get("EndpointApi"),
+    User: selfTag === "User" ? selfClass : EntityRegistry.get("User"),
+    Organization: selfTag === "Organization" ? selfClass : EntityRegistry.get("Organization"),
+    Project: selfTag === "Project" ? selfClass : EntityRegistry.get("Project"),
+    Event: selfTag === "Event" ? selfClass : EntityRegistry.get("Event"),
+    Poi: selfTag === "Poi" ? selfClass : EntityRegistry.get("Poi"),
+    Badge: selfTag === "Badge" ? selfClass : EntityRegistry.get("Badge"),
+    News: selfTag === "News" ? selfClass : EntityRegistry.get("News")
+  };
+  
+  const map = {
+    citoyens:     { entityClass: commonDeps.User,         deps: commonDeps },
+    organizations:{ entityClass: commonDeps.Organization, deps: commonDeps },
+    projects:      { entityClass: commonDeps.Project,      deps: commonDeps },
+    events:       { entityClass: commonDeps.Event,        deps: { ...commonDeps, Badge: undefined } },
+    poi:          { entityClass: commonDeps.Poi,          deps: { ...commonDeps, Badge: undefined, News: undefined } },
+    news:         { entityClass: commonDeps.News,         deps: { ...commonDeps } },
+    badges:       { entityClass: commonDeps.Badge,        deps: { 
+      EndpointApi: commonDeps.EndpointApi, 
+      User: commonDeps.User, 
+      Organization: commonDeps.Organization, 
+      Project: commonDeps.Project 
+    } }
+  };
+  
+  return map[entityType] || null;
+}

package/src/api/Organization.js

@@ -180,32 +180,38 @@ export class Organization extends BaseEntity {
    * 
    * 
    */
-  async getMembers(data = {}, options = {}, isNext = false) {
+  async getMembers(data = {}, options = {}) {
     data.searchType = this._getDefaultFromEndpoint("GET_MEMBERS_ADMIN", "searchType");
     // data.searchBy = "ALL";
-    return this._paginateWith(data, isNext, async (finalData) => {
-
-      const { toBeValidated, isAdmin, isAdminPending, isInviting, roles = [] } = options;
-
-      if(this.isMe){
-        finalData.pathParams = { type: this.getEntityType(), id: this.id };
-        // finalData.filters = {
-        //   [`links.memberOf.${this.id}`]: { "$exists": true },
-        //   [`links.memberOf.${this.id}.toBeValidated`]: { "$exists": false },
-        //   [`links.memberOf.${this.id}.isInviting`]: { "$exists": false }
-        // };
-        finalData.filters = this._buildLinkFilters(this.id, { linkType: "memberOf", toBeValidated, isAdmin, isAdminPending, isInviting, roles });
-      } else {
-        delete finalData?.pathParams;
-        finalData.filters = this._buildLinkFilters(this.id, { linkType: "memberOf", toBeValidated: false, isAdmin, isInviting, roles });
-      }
+
+    const paginator = this._createPaginatorEngine({
+      initialData: data,
+      finalizer: async (finalData) => {
+
+        const { toBeValidated, isAdmin, isAdminPending, isInviting, roles = [] } = options;
+
+        if(this.isMe){
+          finalData.pathParams = { type: this.getEntityType(), id: this.id };
+          // finalData.filters = {
+          //   [`links.memberOf.${this.id}`]: { "$exists": true },
+          //   [`links.memberOf.${this.id}.toBeValidated`]: { "$exists": false },
+          //   [`links.memberOf.${this.id}.isInviting`]: { "$exists": false }
+          // };
+          finalData.filters = this._buildLinkFilters(this.id, { linkType: "memberOf", toBeValidated, isAdmin, isAdminPending, isInviting, roles });
+        } else {
+          delete finalData?.pathParams;
+          finalData.filters = this._buildLinkFilters(this.id, { linkType: "memberOf", toBeValidated: false, isAdmin, isInviting, roles });
+        }
   
-      const fetchFn = this.isMe
-        ? () => this.callIsMe(() => this.endpointApi.getMembersAdmin(finalData))
-        : () => this.endpointApi.getMembersNoAdmin(finalData);
+        const fetchFn = this.isMe
+          ? () => this.callIsMe(() => this.endpointApi.getMembersAdmin(finalData))
+          : () => this.endpointApi.getMembersNoAdmin(finalData);
 
-      return fetchFn();
+        return fetchFn();
+      }
     });
+
+    return paginator.next();
   }
 
   /**
@@ -372,8 +378,8 @@ export class Organization extends BaseEntity {
    * @returns {Promise<Object>} - Résultat de la recherche.
    * @throws {ApiError} - Si le slug ou l'id de l'organisation n'est pas défini.
    */
-  async searchCostum(data = {}, isNext = false) {
-    return super.searchCostum(data, isNext);
+  async searchCostum(data = {}) {
+    return super.searchCostum(data);
   }
 
 }

package/src/api/Project.js

@@ -190,33 +190,39 @@ export class Project extends BaseEntity {
    * const invitingContributors = await project.getContributors({}, { isInviting: true });
    * 
    */
-  async getContributors(data = {}, options = {}, isNext = false) {
+  async getContributors(data = {}, options = {}) {
     data.searchType = this._getDefaultFromEndpoint("GET_CONTRIBUTORS_ADMIN", "searchType");
     // data.searchBy = "ALL";
-    return this._paginateWith(data, isNext, async (finalData) => {
-
-      const { toBeValidated, isAdmin, isInviting, isAdminPending, roles = [] } = options;
-
-      if(this.isMe){
-        finalData.pathParams = { type: this.getEntityType(), id: this.id };
-        // NOTE : dans le schema je crois que si pas de finalData.filters alors le default ce fait avec finalData.pathParams
-        // finalData.filters = {
-        //   [`links.projects.${this.id}`]: { "$exists": true },
-        //   [`links.projects.${this.id}.toBeValidated`]: { "$exists": false },
-        //   [`links.projects.${this.id}.isInviting`]: { "$exists": false }
-        // };
-        finalData.filters = this._buildLinkFilters(this.id, { linkType: "projects", toBeValidated, isAdmin, isAdminPending, isInviting, roles });
-      } else {
-        delete finalData?.pathParams;
-        finalData.filters = this._buildLinkFilters(this.id, { linkType: "projects", toBeValidated: false, isAdmin, isInviting, roles });
-      }
+
+    const paginator = this._createPaginatorEngine({
+      initialData: data,
+      finalizer: async (finalData) => {
+
+        const { toBeValidated, isAdmin, isInviting, isAdminPending, roles = [] } = options;
+
+        if(this.isMe){
+          finalData.pathParams = { type: this.getEntityType(), id: this.id };
+          // NOTE : dans le schema je crois que si pas de finalData.filters alors le default ce fait avec finalData.pathParams
+          // finalData.filters = {
+          //   [`links.projects.${this.id}`]: { "$exists": true },
+          //   [`links.projects.${this.id}.toBeValidated`]: { "$exists": false },
+          //   [`links.projects.${this.id}.isInviting`]: { "$exists": false }
+          // };
+          finalData.filters = this._buildLinkFilters(this.id, { linkType: "projects", toBeValidated, isAdmin, isAdminPending, isInviting, roles });
+        } else {
+          delete finalData?.pathParams;
+          finalData.filters = this._buildLinkFilters(this.id, { linkType: "projects", toBeValidated: false, isAdmin, isInviting, roles });
+        }
   
-      const fetchFn = this.isMe
-        ? () => this.callIsMe(() => this.endpointApi.getContributorsAdmin(finalData))
-        : () => this.endpointApi.getContributorsNoAdmin(finalData);
+        const fetchFn = this.isMe
+          ? () => this.callIsMe(() => this.endpointApi.getContributorsAdmin(finalData))
+          : () => this.endpointApi.getContributorsNoAdmin(finalData);
 
-      return fetchFn();
+        return fetchFn();
+      }
     });
+
+    return paginator.next();
   }
 
   /**

package/src/api/User.js

@@ -1,4 +1,4 @@
-import { ApiError, ApiResponseError } from "../error.js";
+import { ApiError } from "../error.js";
 import BaseEntity from "./BaseEntity.js";
 import { UserMixin } from "../mixin/UserMixin.js";
 
@@ -284,26 +284,32 @@ export class User extends BaseEntity {
    * Récupérer les organisations d'un utilisateur : Récupère la liste des organisations auxquelles l'utilisateur appartient.
    * Constant : GET_ORGANIZATIONS_ADMIN | GET_ORGANIZATIONS_NO_ADMIN
    */
-  async getOrganizations(data = {}, isNext = false) {
+  async getOrganizations(data = {}) {
     data.searchType = this._getDefaultFromEndpoint("GET_ORGANIZATIONS_NO_ADMIN", "searchType");
     // data.searchBy = "ALL";
-    return this._paginateWith(data, isNext, async (finalData) => {
-      delete finalData?.pathParams;
 
-      const fetchFn = this.isMe
-        ? () => this.callIsMe(() => this.endpointApi.getOrganizationsAdmin(finalData))
-        : () => this.endpointApi.getOrganizationsNoAdmin(finalData);
+    const paginator = this._createPaginatorEngine({
+      initialData: data,
+      finalizer: async (finalData) => {
+        delete finalData?.pathParams;
+
+        const fetchFn = this.isMe
+          ? () => this.callIsMe(() => this.endpointApi.getOrganizationsAdmin(finalData))
+          : () => this.endpointApi.getOrganizationsNoAdmin(finalData);
   
-      if (!this.isMe && !finalData.filters) {
-        finalData.filters = {
-          [`links.members.${this.id}`]: { "$exists": true },
-          [`links.members.${this.id}.toBeValidated`]: { "$exists": false },
-          [`links.members.${this.id}.isInviting`]: { "$exists": false }
-        };
+        if (!this.isMe && !finalData.filters) {
+          finalData.filters = {
+            [`links.members.${this.id}`]: { "$exists": true },
+            [`links.members.${this.id}.toBeValidated`]: { "$exists": false },
+            [`links.members.${this.id}.isInviting`]: { "$exists": false }
+          };
+        }
+
+        return fetchFn();
       }
-
-      return fetchFn();
     });
+
+    return paginator.next();
   }
 
   /**
@@ -337,50 +343,56 @@ export class User extends BaseEntity {
    * actuellement, c'est tous les utilisateurs connectés
    */
   async getFriends(data = {}) {
-    delete data?.pathParams;
-
-    if (!this.isMe){
-      // is not me add id
-      data.pathParams = { id: this.id };
-    }
+    data.searchType = this._getDefaultFromEndpoint("GET_FRIENDS_ADMIN", "searchType");
+    // data.searchBy = "ALL";
 
-    const arrayObjet = await this.endpointApi.getFriendsAdmin(data);
-    if (!Array.isArray(arrayObjet.results)){
-      throw new ApiResponseError("Erreur lors de la récupération des amis administrables.", 500, arrayObjet);
+    const paginator = this._createPaginatorEngine({
+      initialData: data,
+      finalizer: async (finalData) => {
 
-    }
+        delete finalData?.pathParams;
+  
+        if (!this.isMe){
+          // is not me add id
+          finalData.pathParams = { id: this.id };
+        }
 
-    const rawList = this._linkEntities(arrayObjet.results);
+        return this.endpointApi.getFriendsAdmin(finalData);;
+      }
+    });
 
-    return {
-      count: arrayObjet?.count?.citoyens ?? 0,
-      results: rawList
-    };
+    return paginator.next();
   }
 
   /**
    * Récupérer les suivis
    * Constant : GET_SUBSCRIPTIONS / GET_SUBSCRIPTIONS_ADMIN
    */
-  async getSubscriptions(data = {}, isNext = false) {
+  async getSubscriptions(data = {}) {
     data.searchType = this._getDefaultFromEndpoint("GET_SUBSCRIPTIONS", "searchType");
     // data.searchBy = "ALL";
-    return this._paginateWith(data, isNext, async (finalData) => {
 
-      delete finalData?.pathParams;
+    const paginator = this._createPaginatorEngine({
+      initialData: data,
+      finalizer: async (finalData) => {
+
+        delete finalData?.pathParams;
   
-      const fetchFn = this.isMe
-        ? () => this.callIsMe(() => this.endpointApi.getSubscriptionsAdmin(finalData))
-        : () => this.endpointApi.getSubscriptions(finalData);
+        const fetchFn = this.isMe
+          ? () => this.callIsMe(() => this.endpointApi.getSubscriptionsAdmin(finalData))
+          : () => this.endpointApi.getSubscriptions(finalData);
   
-      if (!this.isMe && !finalData.filters) {
-        finalData.filters = {
-          [`links.followers.${this.id}`]: { "$exists": true },
-        };
-      }
+        if (!this.isMe && !finalData.filters) {
+          finalData.filters = {
+            [`links.followers.${this.id}`]: { "$exists": true },
+          };
+        }
 
-      return fetchFn();
+        return fetchFn();
+      }
     });
+
+    return paginator.next();
   }
 
   /**

package/src/index.js

@@ -1,3 +1,4 @@
+import { fromEntityJSON } from "./api/EntityRegistry.js";
 import Api from "./Api.js";
 import ApiClient from "./ApiClient.js";
 import * as error from "./error.js";
@@ -25,6 +26,9 @@ export default {
     createDefaultMultiServerTokenStorageStrategy,
     MultiServerTokenStorageStrategy
   },
+  helper: {
+    fromEntityJSON
+  },
 
   OfflineClientManager
 };