@communecter/cocolight-api-client 1.0.141 → 1.0.143

package/types/api/User.d.ts

@@ -1,8 +1,10 @@
 import { BaseEntity } from "./BaseEntity.js";
+import { Notifications } from "./Notifications.js";
 import type { Badge } from "./Badge.js";
 import type { PaginatorPage, PaginatorState } from "./BaseEntity.js";
-import type { ChangePasswordData, DeleteAccountData, GetSubscriptionsAdminData, GetSubscriptionsData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetFriendsAdminData } from "./EndpointApi.types.js";
+import type { ChangePasswordData, DeleteAccountData, GetSubscriptionsAdminData, GetSubscriptionsData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetUserEligiblePlacesData, GetFriendsAdminData } from "./EndpointApi.types.js";
 import type { Organization } from "./Organization.js";
+import type { NotificationItemData } from "./serverDataType/Notification.js";
 import type { EntityTypes } from "@/types/entities.js";
 type ApiClient = import("../ApiClient.js").default;
 type UserItemNormalized = import("./serverDataType/User.js").UserItemNormalized;
@@ -159,6 +161,20 @@ export declare class User extends BaseEntity<UserItemNormalized> {
     getOrganizations(data?: Partial<GetOrganizationsAdminData | GetOrganizationsNoAdminData>, options?: {
         restoredState?: PaginatorState;
     }): Promise<PaginatorPage<Organization>>;
+    /**
+     * Récupère les lieux (organizations) memberOf de l'utilisateur, filtrés
+     * côté serveur par des filters arbitraires (tags, source.key, etc.) et
+     * un flag `notSourceKey` configurables.
+     *
+     * Mirroir de `getOrganizations` mais permet de passer dynamiquement les
+     * filtres du finder du formulaire (vue collaborative coform/place), pour
+     * que la pagination soit correcte (filtrage côté serveur, pas côté client).
+     *
+     * Constant : GET_USER_ELIGIBLE_PLACES
+     */
+    getEligiblePlaces(data?: Partial<GetUserEligiblePlacesData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<Organization>>;
     /**
      * {@inheritDoc BaseEntity#getProjects}
      *
@@ -786,5 +802,33 @@ export declare class User extends BaseEntity<UserItemNormalized> {
      * ```
      */
     demoteFromAdmin(): Promise<unknown>;
+    /** Gestionnaire de notifications, créé paresseusement et mis en cache. */
+    private _notifications?;
+    /**
+     * Point d'entrée `me.notifications` (composition, PAS une entité BaseEntity).
+     * Sûr : endpointApi/apiClient sont initialisés dans le constructeur avant tout accès getter.
+     */
+    get notifications(): Notifications;
+    /**
+     * Récupère les notifications (mode liste). STATELESS + plat (`NotificationItemData[]`),
+     * idéal comme `queryFn` React Query / prefetch SSR — ne touche PAS le manager réactif
+     * (`me.notifications`). `ApiClient._transformData` garantit `notif` = tableau (map -> array
+     * + `id` injecté), donc on fait confiance à la normalisation amont.
+     * pathParams.id est OBLIGATOIRE : le défaut "@userId" ne matche pas le pattern de l'endpoint.
+     */
+    fetchNotifications({ indexMin }?: {
+        indexMin?: number;
+    }): Promise<NotificationItemData[]>;
+    /**
+     * Compte les notifications NON VUES (badge). STATELESS. refreshTimestamp = maintenant ->
+     * le serveur renvoie `countNotif` (total non-vus) + une liste vide.
+     */
+    fetchNotificationsCount(): Promise<number>;
+    /** Marque une notification comme lue (MARK_NOTIFICATION_AS_READ). */
+    markNotificationAsRead(id: string): Promise<unknown>;
+    /** Marque toutes les notifications comme vues/lues (NOTIFICATION_UPDATE). */
+    markAllNotifications(action: "seen" | "read"): Promise<unknown>;
+    /** Supprime toutes les notifications de l'utilisateur (REMOVE_ALL_NOTIFICATIONS). */
+    removeAllNotifications(): Promise<unknown>;
 }
 export {};

package/types/api/serverDataType/Form.d.ts

@@ -133,4 +133,24 @@ export interface FormItemNormalized {
     useBannerImg?: boolean;
     [key: string]: unknown;
 }
+/**
+ * Une contribution individuelle à une table commune (commonTable) d'un coform.
+ * Retournée par `Form.getCommonTableContributors()` (endpoint GET_COFORM_COMMONTABLE_CONTRIBUTORS).
+ * Plusieurs entrées possibles pour un même `userId` (plusieurs solutions au même usage).
+ */
+export interface CoformCommonTableContributor {
+    userId: string;
+    userName?: string;
+    userSlug?: string;
+    criteriaId: string;
+    /** Nom de la solution saisie. */
+    criteria: string;
+    /** love | happySmile | neutral | sad | cry | "" */
+    happiness?: string;
+    /** Note de 0 à 5. */
+    note?: number;
+    comment?: string;
+    fromAnswerId?: string;
+    [k: string]: unknown;
+}
 export {};

package/types/api/serverDataType/Notification.d.ts

@@ -0,0 +1,73 @@
+import type { DateValue, IdObject } from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+type ObjectIDInstance = InstanceType<typeof EJSONType["ObjectID"]>;
+export type NotificationId = ObjectIDInstance | IdObject | string;
+/** Auteur APRÈS aplatissement par _transformData (la map oid->objet devient un objet). */
+export interface NotificationAuthor {
+    id?: string;
+    type?: string;
+    name: string;
+    profilThumbImageUrl?: string;
+    [k: string]: unknown;
+}
+export interface NotificationTarget {
+    type: string;
+    id: string;
+    parent?: {
+        id: string;
+        type: string;
+    };
+}
+/** État lu/vu, par destinataire. Un champ ABSENT (clé unset côté serveur) = état "faux". */
+export interface NotificationReadState {
+    isUnread?: boolean;
+    isUnseen?: boolean;
+}
+export interface NotificationNotify {
+    objectType?: string;
+    /** keyé par oid de destinataire -> état lu/vu de CE destinataire. */
+    id: Record<string, NotificationReadState>;
+    displayName?: string;
+    icon?: string;
+    url?: string;
+    label?: string;
+    labelArray?: Record<string, string[]>;
+    labelAuthorObject?: string;
+    repeat?: boolean;
+    [k: string]: unknown;
+}
+/** Un élément du tableau `notif` (forme transformée). created/updated : Date instance OU {sec,usec}. */
+export interface NotificationItemData {
+    id: string;
+    _id: NotificationId;
+    type: string;
+    verb: string;
+    author: NotificationAuthor;
+    created: Date | DateValue;
+    updated: Date | DateValue;
+    target: NotificationTarget;
+    notify: NotificationNotify;
+    timestamp?: number;
+    timeAgo?: string;
+    [k: string]: unknown;
+}
+/**
+ * Réponse de GET_NOTIFICATIONS (mode liste, body indexMin) APRÈS transform :
+ * `notif` est un tableau (la map oid->item est convertie). Vide => [].
+ */
+export interface GetNotificationsResult {
+    notif: NotificationItemData[];
+    [k: string]: unknown;
+}
+/**
+ * Réponse de GET_NOTIFICATIONS_COUNT (mode badge, body refreshTimestamp non-nul) :
+ * `notif` = notifications mises à jour APRÈS le timestamp (souvent [] si timestamp = maintenant),
+ * `countNotif` = nombre TOTAL de notifications NON VUES (isUnseen) — indépendant du timestamp.
+ * countNotif n'est présent QUE si refreshTimestamp est fourni et non-nul (sinon mode liste).
+ */
+export interface GetNotificationsCountResult {
+    notif: NotificationItemData[];
+    countNotif?: number;
+    [k: string]: unknown;
+}
+export {};