@communecter/cocolight-api-client 1.0.54 → 1.0.56

package/types/api/Project.d.ts

@@ -1,49 +1,72 @@
-export class Project extends BaseEntity {
+import { BaseEntity } from "./BaseEntity.js";
+import type { PaginatorPage } from "./BaseEntity.js";
+import type { AddProjectData, GetContributorsAdminData, GetContributorsNoAdminData } from "./EndpointApi.types.js";
+import type { Organization } from "./Organization.js";
+import type { User } from "./User.js";
+import type { ProjectTransforms } from "../types/transforms.js";
+type ProjectItemNormalized = import("./serverDataType/Project.js").ProjectItemNormalized;
+export declare class Project extends BaseEntity<ProjectItemNormalized> {
     static entityType: string;
+    static entityTag: 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>;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_PROJECT", "updateImageProfil" | "addProject">;
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
+    defaultFields: Record<string, any>;
+    removeFields: string[];
+    transforms: ProjectTransforms;
+    _add: (payload: Record<string, any>) => Promise<void>;
+    _update: (payload: Record<string, any>) => Promise<boolean>;
+    /**
+     * Ajoute un projet.
+     *
+     * @param data - Données du projet à ajouter.
+     * @returns - Résultat de l'ajout du projet.
+     * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité n'est pas enregistrée.
+     */
+    addProject(data?: Partial<AddProjectData>): Promise<unknown>;
+    getOrganizations(): Promise<never>;
+    /**
+     * {@inheritDoc BaseEntity#getProjects}
+     *
+     * Récupère les projets du projet.
+     */
+    getProjects(data?: Parameters<BaseEntity<ProjectItemNormalized>["getProjects"]>[0]): Promise<PaginatorPage<Project>>;
+    getEvents(): Promise<never>;
+    /**
+     * {@inheritDoc BaseEntity#getPois}
+     *
+     * Récupère les points d'intérêt d'un projet.
+     */
+    getPois(data?: Parameters<BaseEntity<ProjectItemNormalized>["getPois"]>[0]): Promise<PaginatorPage<import("./Poi.js").Poi>>;
+    /**
+     * {@inheritDoc BaseEntity#getBadgesIssuer}
+     *
+     * Récupère les émetteurs de badges d'un projet.
+     */
+    getBadgesIssuer(data?: Parameters<BaseEntity<ProjectItemNormalized>["getBadgesIssuer"]>[0]): Promise<PaginatorPage<import("./Badge.js").Badge>>;
+    /**
+     * {@inheritDoc BaseEntity#getNews}
+     *
+     * Récupère les actualités d'un projet.
+     */
+    getNews(data?: Parameters<BaseEntity<ProjectItemNormalized>["getNews"]>[0]): Promise<import("./News.js").News[]>;
+    /**
+     * {@inheritDoc BaseEntity#getSubscribers}
+     *
+     * Récupère les abonnés d'un projet.
+     */
+    getSubscribers(data?: Parameters<BaseEntity<ProjectItemNormalized>["getSubscribers"]>[0]): Promise<PaginatorPage<User>>;
     /**
      * 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.
+     * @param data - Paramètres (partiels) de recherche/pagination.
+     * @param options - Options supplémentaires.
+     * @param options.toBeValidated - Indique si les contributeurs doivent être validés.
+     * @param options.isAdmin - Indique si l'utilisateur est admin.
+     * @param options.isInviting - Indique si l'utilisateur est en attente d'invitation.
+     * @param options.roles - Liste des rôles à filtrer.
+     * @param isNext - Indique si c'est une recherche suivante (pagination).
+     * @returns - 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
@@ -63,19 +86,95 @@ export class Project extends BaseEntity {
      * const invitingContributors = await project.getContributors({}, { isInviting: true });
      *
      */
-    getContributors(data?: any, options?: {
-        toBeValidated: boolean;
-        isAdmin: boolean;
-        isInviting: boolean;
-        roles: any[];
-    }): Promise<any>;
+    getContributors(data?: Partial<GetContributorsAdminData | GetContributorsNoAdminData>, options?: {
+        toBeValidated?: boolean;
+        isAdmin?: boolean;
+        isAdminPending?: boolean;
+        isInviting?: boolean;
+        roles?: any[];
+    }): Promise<PaginatorPage<User | Organization>>;
+    /**
+     * {@inheritDoc BaseEntity#getGallery}
+     *
+     * Récupère la galerie d'un projet.
+     */
+    getGallery(data?: Parameters<BaseEntity<ProjectItemNormalized>["getGallery"]>[0]): Promise<Record<string, any>>;
     /**
+     * {@inheritDoc BaseEntity#project}
+     *
      * Crée une instance de projet et récupère son profil si nécessaire.
+     */
+    project(projectData?: Parameters<BaseEntity<ProjectItemNormalized>["project"]>[0]): Promise<Project>;
+    /**
+     * {@inheritDoc BaseEntity#poi}
+     *
+     * Crée une instance de POI et la récupère si nécessaire.
+     */
+    poi(poiData?: Parameters<BaseEntity<ProjectItemNormalized>["poi"]>[0]): Promise<import("./Poi.js").Poi>;
+    /**
+     * {@inheritDoc BaseEntity#event}
+     *
+     * Crée une instance d'événement et la récupère si nécessaire.
+     */
+    event(eventData?: Parameters<BaseEntity<ProjectItemNormalized>["event"]>[0]): Promise<import("./Event.js").Event>;
+    /**
+     * {@inheritDoc BaseEntity#badge}
+     *
+     * Crée une instance de badge et la récupère si nécessaire.
+     */
+    badge(badgeData?: Parameters<BaseEntity<ProjectItemNormalized>["badge"]>[0]): Promise<import("./Badge.js").Badge>;
+    /**
+     * {@inheritDoc BaseEntity#news}
+     *
+     * Crée une instance de news et la récupère si nécessaire.
+     */
+    news(newsData?: Parameters<BaseEntity<ProjectItemNormalized>["news"]>[0]): Promise<import("./News.js").News>;
+    /**
+     * ───────────────────────────────
+     *  Lien utilisateur ↔ projet
+     *  (rejoindre, valider, quitter, devenir admin)
+     * ───────────────────────────────
+     */
+    /**
+     * {@inheritDoc BaseEntity#requestToJoin}
+     *
+     * Envoie une demande pour rejoindre le projet en tant que contributeur.
+     * L'action est soumise à validation par un administrateur du projet.
+     */
+    requestToJoin(): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#requestToJoinAdmin}
+     *
+     * Envoie une demande pour devenir administrateur du projet.
+     * L'action est soumise à validation par un administrateur existant.
+     */
+    requestToJoinAdmin(): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#acceptInvitation}
+     *
+     * Accepte une invitation à rejoindre le projet.
+     * Cette action valide un lien en attente avec l'option `isInviting`.
+     */
+    acceptInvitation(): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#leave}
+     *
+     * Quitte le projet, que ce soit en tant que contributeur ou administrateur.
+     * Cette action supprime le lien entre l'utilisateur et le projet.
+     */
+    leave(): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#follow}
+     *
+     * Suivre un projet.
+     * Cette action permet à l'utilisateur de suivre le projet.
+     */
+    follow(): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#unfollow}
      *
-     * @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.
+     * Se désabonne d'un projet.
      */
-    project(projectData?: any): Promise<Project>;
+    unfollow(): Promise<unknown>;
 }
-import BaseEntity from "./BaseEntity.js";
+export {};

package/types/api/Project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Project.d.ts","sourceRoot":"","sources":["../../src/api/Project.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGpF,KAAK,qBAAqB,GAAG,OAAO,6BAA6B,EAAE,qBAAqB,CAAC;AACzF,qBAAa,OAAQ,SAAQ,UAAU,CAAC,qBAAqB,CAAC;IAC5D,MAAM,CAAC,UAAU,SAAc;IAE/B,MAAM,CAAC,SAAS,SAAa;IAE7B,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAQ/B;IAEF,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAGnC;IAEH,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAOtC;IAEH,aAAa,EAAE,GAAG,CAEhB;IAEF,YAAY,EAAE,MAAM,EAAE,CAEpB;IAGF,UAAU,EAAE,iBAAiB,CAW3B;IAEF,IAAI,GAAU,SAAS,iBAAiB,KAAG,OAAO,CAAC,IAAI,CAAC,CAuBtD;IAEF,OAAO,GAAU,SAAS,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC,CA2B/D;IAEF;;;;;;OAMG;IACG,UAAU,CAAC,IAAI,GAAE,OAAO,CAAC,GAAG,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAcvD,0CAA0C;IACpC,gBAAgB,IAAI,OAAO,CAAC,KAAK,CAAC;IAIxC;;;;OAIG;IACG,WAAW,CAAC,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/C,0CAA0C;IACpC,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC;IAIjC;;;;OAIG;IACG,OAAO,CAAC,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3C;;;;OAIG;IACG,eAAe,CAAC,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAInD;;;;OAIG;IACG,OAAO,CAAC,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3C;;;;OAIG;IACG,cAAc,CAAC,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,eAAe,CAAC,IAAI,GAAE,GAAQ,EAAE,OAAO,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAmCtE;;;;OAIG;IACG,UAAU,CAAC,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;;OAIG;IACG,OAAO,CAAC,WAAW,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAOlD;;;;OAIG;IACG,GAAG,CAAC,OAAO,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAO1C;;;;OAIG;IACG,KAAK,CAAC,SAAS,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9C;;;;OAIG;IACG,KAAK,CAAC,SAAS,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9C;;;;OAIG;IACG,IAAI,CAAC,QAAQ,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAK5C;;;;;OAKG;IAEH;;;;;OAKG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAInC;;;;;OAKG;IACG,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxC;;;;;OAKG;IACG,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAItC;;;;;OAKG;IACG,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAI3B;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAI5B;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;CAI/B"}

package/types/api/User.d.ts

@@ -1,41 +1,17 @@
-export class User extends BaseEntity {
-    static entityType: string;
+import { BaseEntity } from "./BaseEntity.js";
+import type { Badge } from "./Badge.js";
+import type { PaginatorPage } from "./BaseEntity.js";
+import type { ChangePasswordData, DeleteAccountData, GetSubscriptionsAdminData, GetSubscriptionsData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetFriendsAdminData } from "./EndpointApi.types.js";
+import type { Organization } from "./Organization.js";
+type ApiClient = import("../ApiClient.js").default;
+type UserItemNormalized = import("./serverDataType/User.js").UserItemNormalized;
+export declare class User extends BaseEntity<UserItemNormalized> {
+    static entityType: "citoyens";
+    static entityTag: 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;
-    };
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
+    defaultFields: Record<string, any>;
+    removeFields: string[];
     transforms: {
         github: (val: any, full: any) => any;
         gitlab: (val: any, full: any) => any;
@@ -47,117 +23,238 @@ export class User extends BaseEntity {
         telegram: (val: any, full: any) => any;
         signal: (val: any, full: any) => any;
     };
+    /**
+     * Crée une instance de `User`.
+     *
+     * @param parent
+     *        L'ApiClient, une entité parente, ou tout objet exposant `apiClient`.
+     * @param {{ id?: string, slug?: string }} data  Données initiales (il faut au moins `id` OU `slug`).
+     * @param {{
+     *   EndpointApi: EndpointApiDep,
+     *   Organization: typeof import("./Organization.js").Organization,
+     *   Project: typeof import("./Project.js").Project,
+     *   Event: typeof import("./Event.js").Event,
+     *   Poi: typeof import("./Poi.js").Poi,
+     *   Badge: typeof import("./Badge.js").Badge,
+     *   News: typeof import("./News.js").News
+     * }} deps
+     * @throws {ApiError} Si `EndpointApi` n'est pas injecté, ou si `id`/`slug` manquent,
+     *                    ou si une des classes dépendantes n'est pas injectée.
+     */
+    constructor(parent: ApiClient | any, data: {
+        id?: string;
+        slug?: string;
+    }, deps: {
+        EndpointApi: any;
+        Organization: typeof import("./Organization.js").Organization;
+        Project: typeof import("./Project.js").Project;
+        Event: typeof import("./Event.js").Event;
+        Poi: typeof import("./Poi.js").Poi;
+        Badge: typeof import("./Badge.js").Badge;
+        News: typeof import("./News.js").News;
+        Comment: typeof import("./Comment.js").Comment;
+    });
     get slug(): any;
+    get isMe(): boolean;
     get parentIsMe(): boolean;
     get isActingUser(): boolean;
+    /** @returns {"citoyens"} */
+    getEntityType(): "citoyens";
+    /**
+       * Récupère le profil complet de l'utilisateur.
+       * Si l'utilisateur est connecté, on appelle le endpoint ME_INFO_URL,
+       * sinon, on peut imaginer appeler un endpoint public.
+       *
+       * @returns Le profil complet.
+       */
+    get(): Promise<Record<string, any>>;
     /**
      * Changer le mot de passe : Permet de changer le mot de passe d'un utilisateur.
      * Constant : CHANGE_PASSWORD
+     * @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.
      */
-    changePassword(data?: {}): Promise<any>;
+    changePassword(data: ChangePasswordData): Promise<unknown>;
     /**
      * Supprimer un compte : Permet de supprimer un compte utilisateur.
      * Constant : DELETE_ACCOUNT
+     * @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.
+     */
+    delete(data: DeleteAccountData): Promise<unknown>;
+    /**
+     * Sauvegarde les modifications de l'utilisateur en appelant les endpoints correspondants.
+     * Seul l'utilisateur connecté peut se modifier lui-même.
+     *
+     * @returns - Données serveur mises à jour si applicable.
+     * @throws {ApiError} - Si l'utilisateur n'est pas autorisé.
      */
-    delete(data?: {}): Promise<any>;
-    _add(): Promise<void>;
+    save(): Promise<Record<string, any>>;
+    _add: () => Promise<never>;
     /**
      * 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.
+     * @param payload - Données courantes à comparer et envoyer.
+     * @returns - Indique s'il y a eu une modification réelle.
+     * @throws {ApiError} - Si l'utilisateur n'est pas autorisé à effectuer cette action.
      */
-    _update(payload: any): Promise<boolean>;
+    _update: (payload: Record<string, any>) => Promise<boolean>;
+    static fromServerData(data: any, parent: any, deps: any): User;
     /**
+     * {@inheritDoc BaseEntity#updateSettings}
+     *
      * 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>;
+    updateSettings(data: Parameters<BaseEntity<UserItemNormalized>["updateSettings"]>[0]): Promise<unknown>;
     /**
+     * {@inheritDoc BaseEntity#updateDescription}
+     *
      * 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>;
+    updateDescription(data: Parameters<BaseEntity<UserItemNormalized>["updateDescription"]>[0]): Promise<unknown>;
     /**
-       * 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>;
+     * {@inheritDoc BaseEntity#updateInfo}
+     *
+     * Mettre à jour les informations d'un élément : Permet de mettre à jour les informations générales d'un élément (nom, contacts, etc.).
+     */
+    updateInfo(data: Parameters<BaseEntity<UserItemNormalized>["updateInfo"]>[0]): Promise<unknown>;
     /**
+     * {@inheritDoc BaseEntity#updateSocial}
+     *
+     * 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.
+     */
+    updateSocial(data: Parameters<BaseEntity<UserItemNormalized>["updateSocial"]>[0]): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#updateLocality}
+     *
+     * Mettre à jour les localités d'un élément : Permet de mettre à jour l'adresse et les informations géographiques d'un élément.
+     */
+    updateLocality(data: Parameters<BaseEntity<UserItemNormalized>["updateLocality"]>[0]): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#updateSlug}
+     *
+     * Mettre à jour le slug d'un élément : Permet de mettre à jour le slug pour une URL simplifiée.
+     */
+    updateSlug(data: Parameters<BaseEntity<UserItemNormalized>["updateSlug"]>[0]): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#updateImageProfil}
+     *
      * 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>;
+    updateImageProfil(data: Parameters<BaseEntity<UserItemNormalized>["updateImageProfil"]>[0]): Promise<unknown>;
     /**
+     * {@inheritDoc BaseEntity#getOrganizations}
+     * @param [data]
+     *
      * 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>;
+    getOrganizations(data?: Partial<GetOrganizationsAdminData | GetOrganizationsNoAdminData>): Promise<PaginatorPage<Organization>>;
     /**
+     * {@inheritDoc BaseEntity#getProjects}
+     *
      * 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>;
+    getProjects(data?: Parameters<BaseEntity<UserItemNormalized>["getProjects"]>[0]): Promise<PaginatorPage<import("./Project.js").Project>>;
     /**
+     * {@inheritDoc BaseEntity#getPois}
+     *
      * Récupérer les POIs
-     * Constant : GET_POIS_NO_ADMIN / GET_POIS_ADMIN
      */
-    getPois(data?: {}): Promise<any>;
+    getPois(data?: Parameters<BaseEntity<UserItemNormalized>["getPois"]>[0]): Promise<PaginatorPage<import("./Poi.js").Poi>>;
     /**
+     * {@inheritDoc BaseEntity#getNews}
+     *
      * 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>;
+    getNews(data?: Parameters<BaseEntity<UserItemNormalized>["getNews"]>[0]): Promise<import("./News.js").News[]>;
     /**
      * 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>;
+    getFriends(data?: Partial<GetFriendsAdminData>): Promise<PaginatorPage<User>>;
     /**
      * Récupérer les suivis
      * Constant : GET_SUBSCRIPTIONS / GET_SUBSCRIPTIONS_ADMIN
      */
-    getSubscriptions(data?: {}): Promise<any>;
+    getSubscriptions(data?: Partial<GetSubscriptionsAdminData | GetSubscriptionsData>): Promise<PaginatorPage<BaseEntity<any>>>;
     /**
+     * {@inheritDoc BaseEntity#getSubscribers}
+     *
      * Récupérer les abonnés
-     * Constant : GET_SUBSCRIBERS
      */
-    getSubscribers(data?: {}): Promise<any>;
+    getSubscribers(data?: Parameters<BaseEntity<UserItemNormalized>["getSubscribers"]>[0]): Promise<PaginatorPage<User>>;
     /**
      * 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
      */
     /**
+     * {@inheritDoc BaseEntity#getBadgesIssuer}
+     *
      * Liste des badges créés par l'utilisateur
-     * Constant : GET_BADGES
      */
-    getBadgesIssuer(data?: {}): Promise<any>;
+    getBadgesIssuer(data?: Parameters<BaseEntity<UserItemNormalized>["getBadgesIssuer"]>[0]): Promise<PaginatorPage<Badge>>;
     /**
      * Liste des badges associés à l'utilisateur
      *
      * TODO : documenté le fonctionnement et sont utilisation avec un exemple
      */
-    getBadges(filter?: {}): Promise<any[]>;
+    getBadges(filter?: Record<string, any>): Promise<Badge[]>;
     /**
+     * {@inheritDoc BaseEntity#getGallery}
+     *
      * Récupérer la galerie de l'utilisateur
-     * Constant : GET_GALLERY
      */
-    getGallery(data?: {}): Promise<any>;
-    user(userData: any): Promise<User>;
+    getGallery(data?: Parameters<BaseEntity<UserItemNormalized>["getGallery"]>[0]): Promise<Record<string, any>>;
+    user(userData: {
+        id?: string;
+        slug?: string;
+    }): Promise<User>;
+    /**
+     * {@inheritDoc BaseEntity#organization}
+     *
+     * Crée une instance d'organisation et récupère son profil si nécessaire.
+     */
+    organization(organizationData?: Parameters<BaseEntity<UserItemNormalized>["organization"]>[0]): Promise<Organization>;
+    /**
+     * {@inheritDoc BaseEntity#project}
+     *
+     * Crée une instance de projet et récupère son profil si nécessaire.
+     */
+    project(projectData?: Parameters<BaseEntity<UserItemNormalized>["project"]>[0]): Promise<import("./Project.js").Project>;
+    /**
+     * {@inheritDoc BaseEntity#news}
+     *
+     * Crée une instance de news et la récupère si nécessaire.
+     */
+    news(newsData?: Parameters<BaseEntity<UserItemNormalized>["news"]>[0]): Promise<import("./News.js").News>;
+    /**
+     * {@inheritDoc BaseEntity#poi}
+     *
+     * Crée une instance de POI et la récupère si nécessaire.
+     */
+    poi(poiData?: Parameters<BaseEntity<UserItemNormalized>["poi"]>[0]): Promise<import("./Poi.js").Poi>;
+    /**
+     * {@inheritDoc BaseEntity#event}
+     *
+     * Crée une instance d'événement et la récupère si nécessaire.
+     */
+    event(eventData?: Parameters<BaseEntity<UserItemNormalized>["event"]>[0]): Promise<import("./Event.js").Event>;
+    /**
+     * {@inheritDoc BaseEntity#badge}
+     *
+     * Crée une instance de badge et la récupère si nécessaire.
+     */
+    badge(badgeData?: Parameters<BaseEntity<UserItemNormalized>["badge"]>[0]): Promise<Badge>;
     /**
      * ───────────────────────────────
      *  Lien utilisateur ↔ utilisateur (ami)
@@ -168,36 +265,68 @@ export class User extends BaseEntity {
      * 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.
+     * @returns - Résultat de la requête.
      * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'action est interdite.
      */
-    sendFriendRequest(): Promise<any>;
+    sendFriendRequest(): Promise<unknown>;
     /**
      * 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.
+     * @returns - 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>;
+    acceptFriendRequest(): Promise<unknown>;
     /**
      * 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.
+     * @returns - Résultat de la suppression.
      * @throws {ApiError} - Si aucune relation n'existe.
      */
-    removeFriend(): Promise<any>;
-    requestToJoin(): void;
-    requestToJoinAdmin(): void;
-    acceptInvitation(): void;
-    leave(): void;
+    removeFriend(): Promise<unknown>;
+    requestToJoin(): Promise<never>;
+    requestToJoinAdmin(): Promise<never>;
+    acceptInvitation(): Promise<never>;
+    leave(): Promise<never>;
+    /**
+     * Suivre un utilisateur
+     * Cette action permet à l'utilisateur connecté de suivre un autre utilisateur.
+     * Elle nécessite que l'utilisateur soit connecté.
+     *
+     * @returns - Résultat de la requête.
+     * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'action est interdite.
+     */
+    follow(): Promise<unknown>;
+    /**
+     * Se désabonner d'un utilisateur
+     * Cette action permet à l'utilisateur connecté de se désabonner d'un autre utilisateur.
+     * Elle nécessite que l'utilisateur soit connecté.
+     *
+     * @returns - Résultat de la requête.
+     * @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'action est interdite.
+     */
+    unfollow(): Promise<unknown>;
     /**
      * Vérifie si l'utilisateur connecté est ami avec cet utilisateur.
      *
-     * @returns {boolean} - True si l'utilisateur connecté est ami, sinon false.
+     * @returns - True si l'utilisateur connecté est ami, sinon false.
      * @throws {ApiError} - Si l'utilisateur n'est pas connecté.
      */
     isFriend(): boolean;
+    /**
+     * Vérifie si l'utilisateur suit l'entité.
+     *
+     * @returns - `true` si l'utilisateur suit l'entité, `false` sinon.
+     * @throws {ApiError}
+     */
+    isFollower(): boolean;
+    /**
+     * Vérifie si l'utilisateur est abonné à l'entité.
+     *
+     * @returns - `true` si l'utilisateur est abonné, `false` sinon.
+     * @throws {ApiError}
+     */
+    isFollowing(): boolean;
 }
-import BaseEntity from "./BaseEntity.js";
+export {};

package/types/api/User.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../src/api/User.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,KAAK,SAAS,GAAG,OAAO,iBAAiB,EAAE,OAAO,CAAC;AACnD,KAAK,kBAAkB,GAAG,OAAO,0BAA0B,EAAE,kBAAkB,CAAC;AAChF,qBAAa,IAAK,SAAQ,UAAU,CAAC,kBAAkB,CAAC;IAEtD,MAAM,CAAC,UAAU,EAAE,UAAU,CAAc;IAE3C,MAAM,CAAC,SAAS,SAAU;IAE1B,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAO/B;IAEF,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAOtC;IAEH,aAAa,EAAE,GAAG,CAEhB;IAEF,YAAY,EAAE,MAAM,EAAE,CAEpB;IAEF,UAAU,EAAE;QACV,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACrC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACrC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACvC,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACtC,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACxC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACvC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACvC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;QACvC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;KACtC,CAUC;IAEF;;;;;;;;;;;;;;;;;OAiBG;gBAED,MAAM,EAAE,SAAS,GAAG,GAAG,EACvB,IAAI,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EACpC,IAAI,EAAE;QACJ,WAAW,EAAE,GAAG,CAAC;QACjB,YAAY,EAAE,cAAc,mBAAmB,EAAE,YAAY,CAAC;QAC9D,OAAO,EAAE,cAAc,cAAc,EAAE,OAAO,CAAC;QAC/C,KAAK,EAAE,cAAc,YAAY,EAAE,KAAK,CAAC;QACzC,GAAG,EAAE,cAAc,UAAU,EAAE,GAAG,CAAC;QACnC,KAAK,EAAE,cAAc,YAAY,EAAE,KAAK,CAAC;QACzC,IAAI,EAAE,cAAc,WAAW,EAAE,IAAI,CAAC;KACvC;IAmBH,IAAI,IAAI,QAEP;IAED,IAAI,IAAI,YAEP;IAED,IAAI,UAAU,QAEb;IAED,IAAI,YAAY,QAEf;IAED,4BAA4B;IAC5B,aAAa;IAEb;;;;;;SAMK;IACC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAczB;;;;;;;;OAQG;IACG,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7C;;;;;;;;OAQG;IACG,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAO1B,IAAI,uBAEF;IAEF;;;;;;OAMG;IACH,OAAO,GAAU,YAAO,sBA2BtB;IAEF,2EAA2E;IAC3E,MAAM,CAAC,cAAc,CAAC,IAAI,KAAA,EAAE,MAAM,KAAA,EAAE,IAAI,KAAA;IASxC;;;;;;;OAOG;IACG,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAQ7C;;;;;;;OAOG;IACG,iBAAiB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAOhD;;;;;;;OAOG;IACG,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAOzC;;;;;;;OAOG;IACG,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAO3C;;;;;;;OAOG;IACG,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAO7C;;;;;;;OAOG;IACG,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAOzC;;;;;;;OAOG;IACG,iBAAiB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAOhD;;;;;;;;OAQG;IACG,gBAAgB,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IA4B/C;;;;;;;OAOG;IACG,WAAW,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1C;;;;;;;OAOG;IACG,OAAO,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAItC;;;;;;;OAOG;IACG,OAAO,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAItC;;;;;OAKG;IACG,UAAU,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,OAAO,iBAAiB,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAsBlF;;;OAGG;IACG,gBAAgB,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,OAAO,iBAAiB,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IA2BxF;;;;;;;OAOG;IACG,cAAc,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7C;;;;OAIG;IAEH;;;;;;;OAOG;IACG,eAAe,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;;OAIG;IACG,SAAS,CAAC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAmB5C;;;;;;;OAOG;IACG,UAAU,CAAC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAInC,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBxC;;;;;;;OAOG;IACG,YAAY,CAAC,gBAAgB,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAOvD;;;;;;;OAOG;IACG,OAAO,CAAC,WAAW,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAO7C;;;;;;;OAOG;IACG,IAAI,CAAC,QAAQ,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAOvC;;;;;;;OAOG;IACG,GAAG,CAAC,OAAO,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAOrC;;;;;;;OAOG;IACG,KAAK,CAAC,SAAS,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAOzC;;;;;;;OAOG;IACG,KAAK,CAAC,SAAS,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAOzC;;;;;OAKG;IAEH;;;;;;OAMG;IACG,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;IAuCvC;;;;;;OAMG;IACG,mBAAmB,IAAI,OAAO,CAAC,GAAG,CAAC;IA8BzC;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;IA8BlC,0CAA0C;IACpC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAGnC,0CAA0C;IACpC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC;IAGxC,0CAA0C;IACpC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAGtC,0CAA0C;IACpC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAI3B;;;;;;;OAOG;IACG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IA2B5B;;;;;;;OAOG;IACG,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IA4B9B;;;;;OAKG;IACH,QAAQ;IASR;;;;;OAKG;IACH,UAAU;IAWV;;;;;OAKG;IACH,WAAW;CAUZ"}