@communecter/cocolight-api-client 1.0.54 → 1.0.56

package/src/api/UserApi.ts

@@ -0,0 +1,148 @@
+import ApiClient from "../ApiClient.js";
+import { ApiError, ApiResponseError } from "../error.js";
+import { Badge } from "./Badge.js";
+import { Comment } from "./Comment.js";
+import EndpointApi from "./EndpointApi.js";
+import { Event } from "./Event.js";
+import { News } from "./News.js";
+import { Organization } from "./Organization.js";
+import { Poi } from "./Poi.js";
+import { Project } from "./Project.js";
+import { User } from "./User.js";
+
+type AxiosResponse = import("axios").AxiosResponse;
+
+function isAxiosResponse(r: any): r is AxiosResponse {
+  return r && typeof r === "object" && "status" in r && "data" in r;
+}
+
+/**
+ * API orientée utilisateur pour gérer l'authentification et
+ * récupérer l'utilisateur connecté.
+ */
+export class UserApi {
+  client: ApiClient;
+  loggedUser: User | null = null;
+
+  /**
+   * @param clientOrOptions - Soit une instance ApiClient, soit des options pour en créer une
+   */
+  constructor(clientOrOptions: ApiClient | ConstructorParameters<typeof ApiClient>[0]) {
+    if (clientOrOptions instanceof ApiClient) {
+      this.client = clientOrOptions;
+    } else {
+      // Injection de dépendance : ApiClient est créé à partir des options
+      this.client = new ApiClient(clientOrOptions);
+    }
+  }
+
+  /**
+   * Indique si un utilisateur est connecté.
+   */
+  get isConnected(): boolean {
+    return this.client.isConnected;
+  }
+
+  /**
+   * Retourne l'ID de l'utilisateur connecté ou `null` s'il n'y a pas de session.
+   */
+  get userId(): string | null {
+    return this.client.userId;
+  }
+
+  /**
+   * Authentifie un utilisateur et retourne l'instance `User` correspondante.
+   *
+   * @param email - Adresse email de l'utilisateur.
+   * @param password - Mot de passe de l'utilisateur.
+   * @returns {Promise<User>}
+   * @throws {ApiError} En cas d'échec de connexion réseau ou de problème interne.
+   * @throws {ApiResponseError} Si l'API retourne une erreur d'authentification.
+   */
+  async login(email: string, password: string): Promise<User> {
+    return this.client.safeCall(async () => {
+      const response = await this.client.callEndpoint("AUTHENTICATE_URL", { email, password });
+
+      this.loggedUser = new User(
+        this.client,
+        response.data.user,
+        { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment }
+      );
+      return this.loggedUser;
+    });
+  }
+
+  /**
+   * Récupère l'instance `User` correspondant à l'utilisateur actuellement connecté.
+   *
+   * @returns {Promise<User>}
+   * @throws {ApiError} Si aucun utilisateur n'est connecté (`isConnected` faux ou `userId` absent).
+   */
+  async meIsconnected(): Promise<User> {
+    if (!this.client.isConnected || !this.client.userId) {
+      throw new ApiError("User not connected", 401);
+    }
+
+    this.client._logger.info("UserApi", "meIsconnected", this.client.userId);
+
+    this.loggedUser = new User(
+      this.client,
+      { id: this.client.userId },
+      { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment }
+    );
+
+    return this.loggedUser;
+  }
+
+  /**
+   * Enregistre un nouvel utilisateur.
+   *
+   * @param params
+   * @param params.name - Nom complet.
+   * @param params.username - Nom d'utilisateur.
+   * @param params.email - Adresse email.
+   * @param params.pwd - Mot de passe.
+   * @returns Réponse brute de l'API.
+   * @throws {ApiResponseError} Si l'API retourne un échec (`result === false`).
+   */
+  async register({ name, username, email, pwd }: { name: string; username: string; email: string; pwd: string }): Promise<any> {
+    return this.client.safeCall(async () => {
+      const response = await this.client.callEndpoint("PERSON_REGISTER", {
+        name, username, email, pwd
+      });
+
+      if (!isAxiosResponse(response)) {
+        throw new ApiError("Requête mise en file (offline/circuit breaker)", 503, response);
+      }
+
+      if (response?.data?.result === false) {
+        throw new ApiResponseError(response.data.msg, response.status, response.data);
+      }
+
+      return response.data;
+    });
+  }
+
+  /**
+   * Lance une procédure de récupération de mot de passe.
+   *
+   * @param email - Adresse email de l'utilisateur.
+   * @returns Réponse brute de l'API.
+   * @throws {ApiResponseError} Si l'API retourne un échec (`result === false`).
+   */
+  async recoverPassword(email: string): Promise<any> {
+    return this.client.safeCall(async () => {
+      const response = await this.client.callEndpoint("PASSWORD_RECOVERY", { email });
+
+      if (!isAxiosResponse(response)) {
+        throw new ApiError("Requête mise en file (offline/circuit breaker)", 503, response);
+      }
+
+      if (response?.data?.result === false) {
+        throw new ApiResponseError(response.data.msg, response.status, response.data);
+      }
+
+      return response.data;
+    });
+  }
+}

package/src/api/serverDataType/Comment.ts

@@ -0,0 +1,88 @@
+import type {
+  IdObject,
+  DateValue
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+import type { Organization } from "../Organization.js";
+import type { User } from "../User.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+/**
+ * Auteur d'un commentaire (version brute de l'API)
+ */
+export interface CommentAuthorJson {
+  id: string;
+  name: string;
+  username?: string;
+  email?: string;
+  profilImageUrl?: string;
+  profilThumbImageUrl?: string;
+  typeSig?: string;
+  [k: string]: unknown;
+}
+
+/**
+ * Auteur d'un commentaire (version normalisée côté client)
+ */
+export interface CommentAuthor extends CommentAuthorJson {
+  type?: string;
+}
+
+/**
+ * Vues d'un commentaire (qui a vu et quand)
+ */
+export interface CommentViews {
+  [userId: string]: {
+    date: DateValue;
+    [k: string]: unknown;
+  };
+}
+
+/**
+ * Structure JSON brute retournée par l'API
+ */
+export interface CommentItemJson {
+  _id: IdObject;
+  collection: "comments";
+  contextId: string;
+  contextType: string;
+  parentId: string;
+  text: string;
+  created: DateValue;
+  author: CommentAuthorJson;
+  tags?: string[] | null;
+  status: string;
+  views?: CommentViews;
+  postedDate: number;
+  markdownActive: boolean;
+  argval?: string;
+  replies?: CommentItemJson[];
+  [key: string]: unknown;
+}
+
+/**
+ * Structure normalisée utilisée côté client
+ * Les dates sont converties en objets Date
+ * Le champ author peut être une instance d'entité (User ou Organization)
+ */
+export interface CommentItemNormalized {
+  id: string;
+  _id: ObjectID;
+  collection: "comments";
+  contextId: string;
+  contextType: string;
+  parentId: string;
+  text: string;
+  created: Date;
+  author: CommentAuthor | User | Organization;
+  tags?: string[] | null;
+  status: string;
+  views?: Record<string, { date: Date; [k: string]: unknown }>;
+  postedDate: number;
+  markdownActive: boolean;
+  argval?: string;
+  replies?: CommentItemNormalized[];
+  [key: string]: unknown;
+}

package/src/api/serverDataType/Event.ts

@@ -0,0 +1,80 @@
+import type {
+  GeoCoordinates,
+  GeoPosition,
+  IdObject,
+  LinkAttendeesRef,
+  LinkOrganizerRef,
+  ParentsMap,
+  OrganizerMap,
+  PostalAddress,
+  DateValue
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+export interface EventLinksBlock {
+  attendees?: Record<string, LinkAttendeesRef>;
+  organizer?: Record<string, LinkOrganizerRef>;
+  [k: string]: unknown;
+}
+
+export interface EventItemJson {
+  _id: IdObject;
+  collection: "events";
+  name: string;
+  type: string;
+  startDate: DateValue;
+  endDate: DateValue;
+  created?: DateValue;
+  updated?: DateValue;
+  modified?: DateValue;
+  parent?: ParentsMap;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: EventLinksBlock;
+  organizer?: OrganizerMap;
+  creator?: string;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  timeZone?: string;
+  [key: string]: unknown;
+}
+
+export interface EventItemNormalized {
+  id: string;
+  _id: ObjectID;
+  collection: "events";
+  name: string;
+  type: string;
+  startDate: Date;
+  endDate: Date;
+  created?: Date;
+  updated?: Date;
+  modified?: Date;
+  parent?: ParentsMap;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: EventLinksBlock;
+  organizer?: OrganizerMap;
+  creator?: string;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  timeZone?: string;
+  [key: string]: unknown;
+}

package/src/api/serverDataType/News.ts

@@ -0,0 +1,138 @@
+import type {
+  IdObject,
+  DateValue,
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+import type { Organization } from "../Organization.js";
+import type { Project } from "../Project.js";
+import type { User } from "../User.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+/**
+ * Auteur d'une actualité
+ */
+export interface NewsAuthor {
+  id: string;
+  name: string;
+  type: string;
+  profilThumbImageUrl?: string;
+  [k: string]: unknown;
+}
+
+/**
+ * Personne ayant partagé l'actualité
+ */
+export interface NewsSharedBy {
+  id: string;
+  name: string;
+  type: string;
+  updated: DateValue;
+  comment: string | null;
+  profilThumbImageUrl?: string;
+  [k: string]: unknown;
+}
+
+/**
+ * Cible de l'actualité
+ */
+export interface NewsTarget {
+  id: string;
+  name: string;
+  type: string;
+  profilThumbImageUrl?: string;
+  [k: string]: unknown;
+}
+
+/**
+ * Mention dans une actualité
+ */
+export interface NewsMention {
+  id: string;
+  slug: string;
+  type: string;
+  name: string;
+  value: string;
+  count: string; // API returns as string
+  [k: string]: unknown;
+}
+
+/**
+ * Médias fichiers
+ */
+export interface NewsMediaFile {
+  countFiles: string; // API returns as string
+  files: any[];
+}
+
+/**
+ * Médias images
+ */
+export interface NewsMediaImg {
+  countImages: string; // API returns as string
+  images: any[];
+}
+
+/**
+ * Scope de l'actualité
+ */
+export interface NewsScope {
+  type: string;
+  [k: string]: unknown;
+}
+
+/**
+ * Structure JSON brute retournée par l'API
+ */
+export interface NewsItemJson {
+  _id: IdObject;
+  id: string;
+  type: "news";
+  collection: "news";
+  text: string;
+  date: DateValue;
+  created: DateValue;
+  updated: DateValue;
+  markdownActive: boolean;
+  scope: NewsScope;
+  comment: string | null;
+  typeSig: "news";
+  author: NewsAuthor;
+  sharedBy: NewsSharedBy[];
+  lastAuthorShare: NewsSharedBy;
+  target: NewsTarget;
+  mediaFile: NewsMediaFile;
+  mediaImg: NewsMediaImg;
+  mentions?: NewsMention[];
+  [key: string]: unknown;
+}
+
+/**
+ * Structure normalisée utilisée côté client
+ * Les dates sont converties en objets Date
+ * Les counts sont convertis en numbers
+ * Les champs author, target, sharedBy peuvent être des instances d'entités
+ */
+export interface NewsItemNormalized {
+  _id: ObjectID;
+  id: string;
+  type: "news";
+  collection: "news";
+  text: string;
+  date: Date;
+  created: Date;
+  updated: Date;
+  markdownActive: boolean;
+  scope: NewsScope;
+  comment: string | null;
+  typeSig: "news";
+  author: NewsAuthor | User | Organization;
+  sharedBy: Array<(Omit<NewsSharedBy, "updated"> & { updated: Date }) | User | Organization>;
+  lastAuthorShare: (Omit<NewsSharedBy, "updated"> & { updated: Date }) | User | Organization;
+  target: NewsTarget | User | Organization | Project;
+  mediaFile: NewsMediaFile;
+  mediaImg: NewsMediaImg;
+  mentions?: NewsMention[];
+  [key: string]: unknown;
+}

package/src/api/serverDataType/Organization.ts

@@ -0,0 +1,80 @@
+import type {
+  GeoCoordinates,
+  GeoPosition,
+  IdObject,
+  LinkMemberOfRef,
+  LinkMemberRef,
+  LinkProjectRef,
+  LinkEventsRef,
+  OpeningHoursEntry,
+  ParentsMap,
+  PostalAddress,
+  DateValue
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+export interface OrganizationLinksBlock {
+  members?: Record<string, LinkMemberRef>;
+  projects?: Record<string, LinkProjectRef>;
+  memberOf?: Record<string, LinkMemberOfRef>;
+  events?: Record<string, LinkEventsRef>;
+  [k: string]: unknown;
+}
+
+export interface OrganizationItemJson {
+  _id: IdObject;
+  collection: "organizations";
+  name: string;
+  created?: DateValue;
+  updated?: DateValue;
+  modified?: DateValue;
+  parent?: ParentsMap;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  type?: "NGO" | "LocalBusiness" | "Group" | "GovernmentOrganization" | "Cooperative";
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: OrganizationLinksBlock;
+  creator?: string;
+  openingHours?: OpeningHoursEntry[];
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  email?: string;
+  [key: string]: unknown;
+}
+
+export interface OrganizationItemNormalized {
+  id: string;
+  _id: ObjectID;
+  collection: "organizations";
+  name: string;
+  created?: Date;
+  updated?: Date;
+  modified?: Date;
+  parent?: ParentsMap;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  type?: "NGO" | "LocalBusiness" | "Group" | "GovernmentOrganization" | "Cooperative";
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: OrganizationLinksBlock;
+  creator?: string;
+  openingHours?: OpeningHoursEntry[];
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  email?: string;
+  [key: string]: unknown;
+}

package/src/api/serverDataType/Project.ts

@@ -0,0 +1,71 @@
+import type {
+  GeoCoordinates,
+  GeoPosition,
+  IdObject,
+  LinkContributorsRef,
+  LinkProjectRef,
+  LinkEventsRef,
+  ParentsMap,
+  PostalAddress,
+  DateValue
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+export interface ProjectLinksBlock {
+  contributors?: Record<string, LinkContributorsRef>;
+  projects?: Record<string, LinkProjectRef>;
+  events?: Record<string, LinkEventsRef>;
+  [k: string]: unknown;
+}
+
+export interface ProjectItemJson {
+  _id: IdObject;
+  collection: "projects";
+  name: string;
+  created?: DateValue;
+  updated?: DateValue;
+  modified?: DateValue;
+  parent?: ParentsMap;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: ProjectLinksBlock;
+  creator?: string;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  [key: string]: unknown;
+}
+
+export interface ProjectItemNormalized {
+  id: string;
+  _id: ObjectID;
+  collection: "projects";
+  name: string;
+  created?: Date;
+  updated?: Date;
+  modified?: Date;
+  parent?: ParentsMap;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: ProjectLinksBlock;
+  creator?: string;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  [key: string]: unknown;
+}

package/src/api/serverDataType/User.ts

@@ -0,0 +1,103 @@
+import type {
+  GeoCoordinates,
+  GeoPosition,
+  IdObject,
+  LinkMemberOfUserRef,
+  LinkProjectRef,
+  LinkEventsRef,
+  LinkfriendsRef,
+  LinkFollowsUserRef,
+  LinkFollowersUserRef,
+  PostalAddress,
+  DateValue
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+export interface UserLinksBlock {
+  projects?: Record<string, LinkProjectRef>;
+  memberOf?: Record<string, LinkMemberOfUserRef>;
+  events?: Record<string, LinkEventsRef>;
+  friends?: Record<string, LinkfriendsRef>;
+  followers?: Record<string, LinkFollowersUserRef>;
+  follows?: Record<string, LinkFollowsUserRef>;
+  [k: string]: unknown;
+}
+
+export interface UserRoles {
+  superAdmin?: boolean;
+  betaTester?: boolean;
+  standalonePageAccess?: boolean;
+  toBeValidated?: boolean;
+  [k: string]: unknown;
+}
+
+export interface UserPreferences {
+  isOpenData?: boolean;
+  badge?: boolean;
+  activitypub?: boolean;
+  [k: string]: unknown;
+}
+
+export interface UserItemJson {
+  _id: IdObject;
+  collection: "citoyens";
+  name: string;
+  username: string;
+  email: string;
+  roles: UserRoles;
+  created?: DateValue;
+  updated?: DateValue;
+  modified?: DateValue;
+  birthDate?: DateValue;
+  language?: string;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: UserLinksBlock;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  profilBannerUrl?: string;
+  profilRealBannerUrl?: string;
+  preferences?: UserPreferences;
+  [key: string]: unknown;
+}
+
+export interface UserItemNormalized {
+  id: string;
+  _id: ObjectID;
+  collection: "citoyens";
+  name: string;
+  username: string;
+  email: string;
+  roles: UserRoles;
+  created?: Date;
+  updated?: Date;
+  modified?: Date;
+  birthDate?: Date;
+  language?: string;
+  description?: string;
+  shortDescription?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  links?: UserLinksBlock;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  profilBannerUrl?: string;
+  profilRealBannerUrl?: string;
+  preferences?: UserPreferences;
+  [key: string]: unknown;
+}