@communecter/cocolight-api-client 1.0.51 → 1.0.54

package/types/api/EntityRegistry.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Enregistre une entité dans la registry.
+ * @param {string} tag - ex: "User", "Organization"
+ * @param {Function} EntityClass - la classe constructeur
+ */
+export function registerEntity(tag: string, EntityClass: Function): void;
+/**
+ * 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: any, parent?: any): BaseEntity | null;
+/**
+ * Crée une instance d'entité basée sur le seul nom de la collection.
+ * @param {string} collection - ex: "citoyens", "projects", ...
+ * @param {Object} parent - ApiClient ou entité parente
+ * @returns {BaseEntity|null}
+ */
+export function createFromCollection(collection: string, parent?: any, data?: {}): BaseEntity | null;
+export const EntityRegistry: Map<any, any>;

package/types/api/Event.d.ts

@@ -0,0 +1,38 @@
+export class Event extends BaseEntity {
+    static entityType: string;
+    static SCHEMA_CONSTANTS: string[];
+    static ADD_BLOCKS: Map<string, string>;
+    static UPDATE_BLOCKS: Map<string, string>;
+    defaultFields: {
+        typeElement: string;
+    };
+    transforms: {
+        parent: (val: any) => {
+            [k: string]: {
+                type: any;
+                name: any;
+            };
+        };
+        organizer: (val: any) => {
+            [k: string]: {
+                type: any;
+                name: any;
+            };
+        };
+    };
+    _add(payload: any): Promise<void>;
+    _update(payload: any): Promise<boolean>;
+    addEvent(data?: {}): Promise<any>;
+    getOrganizations(): Promise<void>;
+    getProjects(): Promise<void>;
+    getEvents(): Promise<void>;
+    getPois(): Promise<void>;
+    getBadgesIssuer(): Promise<void>;
+    getNews(data?: {}): Promise<any>;
+    getSubscribers(data?: {}): Promise<any>;
+    project(): Promise<void>;
+    poi(): Promise<void>;
+    event(): Promise<void>;
+    badge(): Promise<void>;
+}
+import BaseEntity from "./BaseEntity.js";

package/types/api/News.d.ts

@@ -0,0 +1,45 @@
+export class News extends BaseEntity {
+    static entityType: string;
+    static SCHEMA_CONSTANTS: string[];
+    static ADD_BLOCKS: Map<string, string>;
+    static UPDATE_BLOCKS: Map<string, string>;
+    defaultFields: {};
+    removeFields: any[];
+    transforms: {
+        scope: (val: any) => any;
+        mentions: (val: any) => any[];
+        mediaImg: (val: any) => {
+            countImages: any;
+            images: any;
+        };
+        mediaFile: (val: any) => {
+            countFiles: any;
+            files: any;
+        };
+    };
+    _add(payload: any): Promise<void>;
+    _update(payload: any): Promise<boolean>;
+    addNews(data?: {}): Promise<any>;
+    updateNews(data?: {}): Promise<any>;
+    addMention({ slug, id }: {
+        slug: any;
+        id: any;
+    }): Promise<any>;
+    /**
+     * Ajouter une image à une actualité : Ajoute une images à une actualité.
+     * Constant : ADD_IMAGE_NEWS
+     */
+    addImage(image: any): Promise<any>;
+    /**
+     * Ajouter un fichier à une actualité : Ajoute un fichier à une actualité.
+     * Constant : ADD_FILE_NEWS
+     */
+    addFile(file: any): Promise<any>;
+    /**
+     * Supprimer une actualité : Supprime une actualité existante.
+     * Constant : DELETE_NEWS
+     */
+    delete(): Promise<void>;
+    _isDeleted: boolean;
+}
+import BaseEntity from "./BaseEntity.js";

package/types/api/Organization.d.ts

@@ -0,0 +1,87 @@
+export class Organization extends BaseEntity {
+    static entityType: string;
+    static SCHEMA_CONSTANTS: string[];
+    static ADD_BLOCKS: Map<string, string>;
+    static UPDATE_BLOCKS: Map<string, string>;
+    defaultFields: {
+        typeElement: string;
+    };
+    transforms: {
+        github: (val: any, full: any) => any;
+        gitlab: (val: any, full: any) => any;
+        facebook: (val: any, full: any) => any;
+        twitter: (val: any, full: any) => any;
+        instagram: (val: any, full: any) => any;
+        diaspora: (val: any, full: any) => any;
+        mastodon: (val: any, full: any) => any;
+        telegram: (val: any, full: any) => any;
+        signal: (val: any, full: any) => any;
+    };
+    _add(payload: any): Promise<void>;
+    _update(payload: any): Promise<boolean>;
+    addOrganization(data?: {}): Promise<any>;
+    getOrganizations(): Promise<void>;
+    getProjects(data?: {}): Promise<any>;
+    getEvents(): Promise<void>;
+    getPois(data?: {}): Promise<any>;
+    getBadgesIssuer(data?: {}): Promise<any>;
+    getNews(data?: {}): Promise<any>;
+    getSubscribers(data?: {}): Promise<any>;
+    /**
+     * Récupérer les membres de l'organisation.
+     * Constant : GET_MEMBERS_ADMIN / GET_MEMBERS_NO_ADMIN
+     * @param {Object} data - Les données de requête.
+     * @param {Object} options - Options supplémentaires.
+     * @param {boolean} options.toBeValidated - Indique si les membres doivent être validés.
+     * @param {boolean} options.isAdmin - Indique si l'utilisateur est admin.
+     * @param {boolean} options.isAdminPending - Indique si l'utilisateur est en attente de validation pour être admin.
+     * @param {boolean} options.isInviting - Indique si l'utilisateur est en attente d'invitation.
+     * @param {Array} options.roles - Liste des rôles à filtrer.
+     * @param {boolean} isNext - Indique si c'est une recherche suivante (pagination).
+     * @returns {Promise<Object>} - Un objet contenant le nombre de membres et la liste des membres.
+     * @throws {ApiResponseError} - Si une erreur se produit lors de la récupération des contributeurs.
+     *
+     * @example
+     * // Récupérer tous les membres
+     * const members = await organization.getMembers();
+     *
+     * // Récupérer les membres avec validation en attente
+     * const membersToBeValidated = await organization.getMembers({}, { toBeValidated: true });
+     *
+     * // Récupérer les membres avec un rôle spécifique
+     * const membersWithRole = await organization.getMembers({}, { roles: ['admin'] });
+     *
+     * // Récupérer les membres en attente d'invitation
+     * const invitingMembers = await organization.getMembers({}, { isInviting: true });
+     *
+     * // Récupérer les membres admin
+     * const adminMembers = await organization.getMembers({}, { isAdmin: true });
+     *
+     * // Récupérer les membres admin et en attente d'invitation
+     * const adminInvitingMembers = await organization.getMembers({}, { isAdmin: true, isInviting: true });
+     *
+     * // Récupérer les membres avec validation en attente et admin
+     * const adminToBeValidatedMembers = await organization.getMembers({}, { toBeValidated: true, isAdmin: true });
+     *
+     * // Récupérer les membres en attente de validation pour être admin
+     * const adminPendingMembers = await organization.getMembers({}, { isAdminPending: true });
+     *
+     *
+     */
+    getMembers(data?: any, options?: {
+        toBeValidated: boolean;
+        isAdmin: boolean;
+        isAdminPending: boolean;
+        isInviting: boolean;
+        roles: any[];
+    }): Promise<any>;
+    /**
+     * recherche lié à l'organisation
+     *
+     * @param {Object} data - Les données de recherche.
+     * @returns {Promise<Object>} - Résultat de la recherche.
+     * @throws {ApiError} - Si le slug ou l'id de l'organisation n'est pas défini.
+     */
+    searchCostum(data?: any): Promise<any>;
+}
+import BaseEntity from "./BaseEntity.js";

package/types/api/Poi.d.ts

@@ -0,0 +1,25 @@
+export class Poi extends BaseEntity {
+    static entityType: string;
+    static SCHEMA_CONSTANTS: string[];
+    static ADD_BLOCKS: Map<string, string>;
+    static UPDATE_BLOCKS: Map<string, string>;
+    defaultFields: {
+        typeElement: string;
+    };
+    transforms: {};
+    _add(payload: any): Promise<void>;
+    _update(payload: any): Promise<boolean>;
+    addPoi(data?: {}): Promise<any>;
+    getOrganizations(): Promise<void>;
+    getProjects(): Promise<void>;
+    getEvents(): Promise<void>;
+    getPois(): Promise<void>;
+    getBadgesIssuer(): Promise<void>;
+    getNews(data?: {}): Promise<any>;
+    getSubscribers(data?: {}): Promise<any>;
+    project(): Promise<void>;
+    poi(): Promise<void>;
+    event(): Promise<void>;
+    badge(): Promise<void>;
+}
+import BaseEntity from "./BaseEntity.js";

package/types/api/Project.d.ts

@@ -0,0 +1,81 @@
+export class Project extends BaseEntity {
+    static entityType: string;
+    static SCHEMA_CONSTANTS: string[];
+    static ADD_BLOCKS: Map<string, string>;
+    static UPDATE_BLOCKS: Map<string, string>;
+    defaultFields: {
+        typeElement: string;
+    };
+    transforms: {
+        github: (val: any, full: any) => any;
+        gitlab: (val: any, full: any) => any;
+        facebook: (val: any, full: any) => any;
+        twitter: (val: any, full: any) => any;
+        instagram: (val: any, full: any) => any;
+        diaspora: (val: any, full: any) => any;
+        mastodon: (val: any, full: any) => any;
+        telegram: (val: any, full: any) => any;
+        signal: (val: any, full: any) => any;
+        parent: (val: any) => {
+            [k: string]: {
+                type: any;
+                name: any;
+            };
+        };
+    };
+    _add(payload: any): Promise<void>;
+    _update(payload: any): Promise<boolean>;
+    addProject(data?: {}): Promise<any>;
+    getOrganizations(): Promise<void>;
+    getProjects(data?: {}): Promise<any>;
+    getEvents(): Promise<void>;
+    getPois(data?: {}): Promise<any>;
+    getBadgesIssuer(data?: {}): Promise<any>;
+    getNews(data?: {}): Promise<any>;
+    getSubscribers(data?: {}): Promise<any>;
+    /**
+     * Récupérer les contributeurs d'un projet.
+     * Constant : GET_CONTRIBUTORS_ADMIN / GET_CONTRIBUTORS_NO_ADMIN
+     * @param {Object} data - Les données de requête.
+     * @param {Object} options - Options supplémentaires.
+     * @param {boolean} options.toBeValidated - Indique si les contributeurs doivent être validés.
+     * @param {boolean} options.isAdmin - Indique si l'utilisateur est admin.
+     * @param {boolean} options.isInviting - Indique si l'utilisateur est en attente d'invitation.
+     * @param {Array} options.roles - Liste des rôles à filtrer.
+     * @param {boolean} isNext - Indique si c'est une recherche suivante (pagination).
+     * @returns {Promise<Object>} - Un objet contenant le nombre de contributeurs et la liste des contributeurs.
+     * @throws {ApiResponseError} - Si une erreur se produit lors de la récupération des contributeurs.
+     *
+     * @example
+     * // Récupérer tous les contributeurs
+     * const contributors = await project.getContributors();
+     *
+     * // Récupérer les contributeurs avec validation en attente
+     * const contributorsToBeValidated = await project.getContributors({}, { toBeValidated: true });
+     *
+     * // Récupérer les contributeurs avec un rôle spécifique
+     * const contributorsWithRole = await project.getContributors({}, { roles: ["admin"] });
+     *
+     * // Récupérer les contributeurs administrateurs
+     * const adminContributors = await project.getContributors({}, { isAdmin: true });
+     *
+     * // Récupérer les contributeurs en attente d'invitation
+     * const invitingContributors = await project.getContributors({}, { isInviting: true });
+     *
+     */
+    getContributors(data?: any, options?: {
+        toBeValidated: boolean;
+        isAdmin: boolean;
+        isInviting: boolean;
+        roles: any[];
+    }): Promise<any>;
+    /**
+     * 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.
+     */
+    project(projectData?: any): Promise<Project>;
+}
+import BaseEntity from "./BaseEntity.js";

package/types/api/User.d.ts

@@ -0,0 +1,203 @@
+export class User extends BaseEntity {
+    static entityType: string;
+    static SCHEMA_CONSTANTS: string[];
+    static UPDATE_BLOCKS: Map<string, string>;
+    static fromServerData(data: any, parent: any, deps: any): User;
+    /**
+     * Crée une instance de User.
+     *
+     * @param {ApiClient} apiClient - Le client API connecté.
+     * @param {Object} data - Données initiales (peuvent inclure `id`, `slug`, etc.).
+     * @param {string} [data.id] - ID de l'utilisateur.
+     * @param {string} [data.slug] - Slug de l'utilisateur.
+     * @param {Object} deps - Dépendances injectées.
+     * @param {function|object} deps.EndpointApi - Classe ou instance de EndpointApi.
+     * @param {function} deps.Organization - Classe Organization.
+     * @param {function} deps.Project - Classe Project.
+     * @param {function} deps.Event - Classe Events.
+     * @param {function} deps.Poi - Classe Poi.
+     * @param {function} deps.Badge - Classe Badge.
+     * @param {function} deps.News - Classe News.
+     *
+     * @throws {ApiError} - Si des dépendances nécessaires sont manquantes ou invalides.
+     */
+    constructor(parent: any, data?: {
+        id?: string;
+        slug?: string;
+    }, deps?: {
+        EndpointApi: Function | object;
+        Organization: Function;
+        Project: Function;
+        Event: Function;
+        Poi: Function;
+        Badge: Function;
+        News: Function;
+    });
+    defaultFields: {
+        typeElement: string;
+    };
+    transforms: {
+        github: (val: any, full: any) => any;
+        gitlab: (val: any, full: any) => any;
+        facebook: (val: any, full: any) => any;
+        twitter: (val: any, full: any) => any;
+        instagram: (val: any, full: any) => any;
+        diaspora: (val: any, full: any) => any;
+        mastodon: (val: any, full: any) => any;
+        telegram: (val: any, full: any) => any;
+        signal: (val: any, full: any) => any;
+    };
+    get slug(): any;
+    get parentIsMe(): boolean;
+    get isActingUser(): boolean;
+    /**
+     * Changer le mot de passe : Permet de changer le mot de passe d'un utilisateur.
+     * Constant : CHANGE_PASSWORD
+     */
+    changePassword(data?: {}): Promise<any>;
+    /**
+     * Supprimer un compte : Permet de supprimer un compte utilisateur.
+     * Constant : DELETE_ACCOUNT
+     */
+    delete(data?: {}): Promise<any>;
+    _add(): Promise<void>;
+    /**
+     * Met à jour les blocs modifiés de l'utilisateur via les constantes de schéma définies.
+     *
+     * @param {Object} payload - Données courantes à comparer et envoyer.
+     * @returns {Promise<boolean>} - Indique s'il y a eu une modification réelle.
+     */
+    _update(payload: any): Promise<boolean>;
+    /**
+     * Mettre à jour les paramètres utilisateur : Mise à jour des paramètres spécifiques d'un utilisateur.
+     * Constant : UPDATE_SETTINGS
+     * @param {Object} data - Données à mettre à jour.
+     * @param {"birthDate"|"email"|"locality"|"phone"|"directory"} data.type - Type de paramètre à mettre à jour.
+     * @param {"private"|"public"|"mask"} data.value - Nouvelle valeur du paramètre.
+     * @returns {Promise<void>} - Résultat de la mise à jour.
+     */
+    updateSettings(data?: {
+        type: "birthDate" | "email" | "locality" | "phone" | "directory";
+        value: "private" | "public" | "mask";
+    }): Promise<void>;
+    /**
+     * 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
+     */
+    updateDescription(data?: {}): Promise<any>;
+    /**
+       * Mettre à jour le slug d'un élément : Permet de mettre à jour le slug pour une URL simplifiée.
+       * Constant : UPDATE_BLOCK_SLUG
+       */
+    updateSlug({ slug }: {
+        slug: any;
+    }): Promise<any>;
+    /**
+     * Mettre à jour l'image de profil : Permet de mettre à jour l'image de profil d'un utilisateur ou d'une entité.
+     * Constant : PROFIL_IMAGE
+     */
+    updateImageProfil({ profil_avatar: image }: {
+        profil_avatar: any;
+    }): Promise<any>;
+    /**
+     * 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
+     */
+    getOrganizations(data?: {}): Promise<any>;
+    /**
+     * Récupérer les projets d'un utilisateur : Récupère la liste des projets auxquels l'utilisateur contribue.
+     * Constant : GET_PROJECTS_ADMIN | GET_PROJECTS_NO_ADMIN
+     */
+    getProjects(data?: {}): Promise<any>;
+    /**
+     * Récupérer les POIs
+     * Constant : GET_POIS_NO_ADMIN / GET_POIS_ADMIN
+     */
+    getPois(data?: {}): Promise<any>;
+    /**
+     * Récupérer les actualités : Récupère la liste des actualités liées à l'utilisateur.
+     * Constant : GET_NEWS
+     */
+    getNews(data?: {}): Promise<any>;
+    /**
+     * Récupérer les amis administrables : Récupère les amis administrée par l’utilisateur.
+     * Constant : GET_FRIENDS_ADMIN
+     * question : qui peut voir la liste d'amis, seulement l'utilisateur connecté ? ou tous les utilisateurs connectés ?
+     * actuellement, c'est tous les utilisateurs connectés
+     */
+    getFriends(data?: {}): Promise<any>;
+    /**
+     * Récupérer les suivis
+     * Constant : GET_SUBSCRIPTIONS / GET_SUBSCRIPTIONS_ADMIN
+     */
+    getSubscriptions(data?: {}): Promise<any>;
+    /**
+     * Récupérer les abonnés
+     * Constant : GET_SUBSCRIBERS
+     */
+    getSubscribers(data?: {}): Promise<any>;
+    /**
+     * Obtenir la liste des événements
+     * Constant : GET_EVENTS
+     * TODO : il n'est pas fait encore pour GET_EVENTS_ADMIN / GET_EVENTS_NO_ADMIN comme les autres dans endpointApi
+     */
+    /**
+     * Liste des badges créés par l'utilisateur
+     * Constant : GET_BADGES
+     */
+    getBadgesIssuer(data?: {}): Promise<any>;
+    /**
+     * Liste des badges associés à l'utilisateur
+     *
+     * TODO : documenté le fonctionnement et sont utilisation avec un exemple
+     */
+    getBadges(filter?: {}): Promise<any[]>;
+    /**
+     * Récupérer la galerie de l'utilisateur
+     * Constant : GET_GALLERY
+     */
+    getGallery(data?: {}): Promise<any>;
+    user(userData: any): Promise<User>;
+    /**
+     * ───────────────────────────────
+     *  Lien utilisateur ↔ utilisateur (ami)
+     *  (demander, valider, se retirer)
+     * ───────────────────────────────
+     */
+    /**
+     * Envoie une demande d'amitié à cet utilisateur.
+     * L'utilisateur ciblé devra valider la demande pour établir la relation.
+     *
+     * @returns {Promise<Object>} - Résultat de la requête.
+     * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'action est interdite.
+     */
+    sendFriendRequest(): Promise<any>;
+    /**
+     * Accepte une demande d'amitié envoyée par cet utilisateur.
+     * Cette action établit un lien entre les deux utilisateurs.
+     *
+     * @returns {Promise<Object>} - Résultat de la validation du lien.
+     * @throws {ApiError} - Si aucune invitation n'est en attente ou si l'action est interdite.
+     */
+    acceptFriendRequest(): Promise<any>;
+    /**
+     * Supprime la relation d'amitié avec cet utilisateur.
+     * Cette action annule tout lien existant entre les deux profils.
+     *
+     * @returns {Promise<Object>} - Résultat de la suppression.
+     * @throws {ApiError} - Si aucune relation n'existe.
+     */
+    removeFriend(): Promise<any>;
+    requestToJoin(): void;
+    requestToJoinAdmin(): void;
+    acceptInvitation(): void;
+    leave(): void;
+    /**
+     * Vérifie si l'utilisateur connecté est ami avec cet utilisateur.
+     *
+     * @returns {boolean} - True si l'utilisateur connecté est ami, sinon false.
+     * @throws {ApiError} - Si l'utilisateur n'est pas connecté.
+     */
+    isFriend(): boolean;
+}
+import BaseEntity from "./BaseEntity.js";

package/types/api/UserApi.d.ts

@@ -0,0 +1,13 @@
+export class UserApi {
+    constructor(clientOrOptions: any);
+    client: ApiClient;
+    loggedUser: User;
+    get isConnected(): boolean;
+    get userId(): any;
+    login(email: any, password: any): Promise<any>;
+    meIsconnected(): Promise<User>;
+    register({ name, username, email, pwd, }?: {}): Promise<any>;
+    recoverPassword(email: any): Promise<any>;
+}
+import ApiClient from "../ApiClient.js";
+import { User } from "./User.js";