@communecter/cocolight-api-client 1.0.154 → 1.0.156

package/src/api/UserApi.ts

@@ -1,192 +0,0 @@
-import ApiClient from "../ApiClient.js";
-import { Action } from "./Action.js";
-import { Answer } from "./Answer.js";
-import { Badge } from "./Badge.js";
-import { Classified } from "./Classified.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";
-import { COSTUM_REQUEST_ENVELOPE } from "../costum/symbol.js";
-import { ApiError, ApiResponseError } from "../error.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, Answer, Classified, Action }
-      );
-      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.debug("UserApi", "meIsconnected", this.client.userId);
-
-    this.loggedUser = new User(
-      this.client,
-      { id: this.client.userId },
-      { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment, Answer, Classified, Action }
-    );
-
-    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.
-   * @param params.costumSlug - (option) slug du costum de déploiement → estampille `source.key` du citoyen
-   *   côté backend (port Person::insert). `costumId`/`costumType` = entité porteuse (requis si le slug n'est
-   *   pas un doc `costum`, ex. un site porté par une org).
-   * @returns Réponse brute de l'API.
-   * @throws {ApiResponseError} Si l'API retourne un échec (`result === false`).
-   */
-  async register({ name, username, email, pwd, costumSlug, costumId, costumType }: { name: string; username: string; email: string; pwd: string; costumSlug?: string; costumId?: string; costumType?: string }): Promise<any> {
-    return this.client.safeCall(async () => {
-      const data: Record<string, unknown> = { name, username, email, pwd };
-      // Contexte costum (déploiement) injecté via l'enveloppe (cf. element/save) : `callEndpoint` fusionne le
-      // `context` dans le body + relâche l'AJV. Le backend lit costumSlug/Id/Type → estampille `source` (origin/key/keys).
-      if (costumSlug) {
-        (data as Record<symbol, unknown>)[COSTUM_REQUEST_ENVELOPE] = {
-          properties: {},
-          context: { costumSlug, ...(costumId ? { costumId } : {}), ...(costumType ? { costumType } : {}) },
-        };
-      }
-      const response = await this.client.callEndpoint("PERSON_REGISTER", data);
-
-      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;
-    });
-  }
-
-  /**
-   * Active (valide l'email) un compte via le lien reçu par email.
-   *
-   * Endpoint public (aucune authentification requise). La `validationKey`
-   * correspond à `sha256(user + email)`. En cas de succès, le rôle
-   * `tobeactivated` est retiré et le consentement `sendMail.source` posé.
-   *
-   * @param params
-   * @param params.user - Identifiant (`_id`) du compte à activer.
-   * @param params.validationKey - Clé de validation = `sha256(user + email)`.
-   * @returns Réponse brute de l'API (`{ result: true, msg: string }`).
-   * @throws {ApiError} En cas de mise en file (offline/circuit breaker).
-   * @throws {ApiResponseError} Si l'API retourne un échec (`result === false`).
-   */
-  async activateAccount({ user, validationKey }: { user: string; validationKey: string }): Promise<any> {
-    return this.client.safeCall(async () => {
-      const response = await this.client.callEndpoint("PERSON_ACTIVATE", { user, validationKey });
-
-      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/Action.ts

@@ -1,177 +0,0 @@
-import type {
-  IdObject,
-  LinkContributorsRef,
-  ParentsMap,
-  DateValue,
-} from "./common.js";
-import type EJSONType from "../../EJSONType.js";
-
-type ObjectIDCtor = typeof EJSONType["ObjectID"];
-type ObjectID = InstanceType<ObjectIDCtor>;
-
-/**
- * Statuts supportés par une action (cf. COSTUM_PROJECT_ACTION_REQUEST_NEW).
- */
-export const ACTION_STATUSES = [
-  "todo",
-  "done",
-  "tracking",
-  "discuter",
-  "next",
-  "totest",
-  "disabled",
-  "closed"
-] as const;
-
-export type ActionStatus = (typeof ACTION_STATUSES)[number];
-
-export interface ActionLinksBlock {
-  contributors?: Record<string, LinkContributorsRef>;
-  [k: string]: unknown;
-}
-
-export interface ActionMilestoneRef {
-  milestoneId: string;
-  startDate?: DateValue;
-  endDate?: DateValue;
-}
-
-export interface ActionCounts {
-  contributors?: number;
-  [k: string]: unknown;
-}
-
-/**
- * Historique des changements de statut (alimenté par /set_status côté backend).
- * `update` est un MongoDate (DateValue côté Json, Date côté Normalized).
- */
-export interface ActionUpdateStatusEntryJson {
-  status: ActionStatus;
-  author: string;
-  update: DateValue;
-}
-
-export interface ActionUpdateStatusEntryNormalized {
-  status: ActionStatus;
-  author: string;
-  update: Date;
-}
-
-/**
- * Sous-tâche d'une action. Stockée dans `tasks[]`.
- */
-export interface ActionTaskJson {
-  taskId?: string;
-  task?: string;
-  checked?: boolean;
-  userId?: string;
-  contributors?: Record<string, unknown>;
-  timeSpent?: number;
-  createdAt?: DateValue;
-  checkedAt?: DateValue;
-  [key: string]: unknown;
-}
-
-export interface ActionTaskNormalized {
-  taskId?: string;
-  task?: string;
-  checked?: boolean;
-  userId?: string;
-  contributors?: Record<string, unknown>;
-  timeSpent?: number;
-  createdAt?: Date;
-  checkedAt?: Date;
-  [key: string]: unknown;
-}
-
-/**
- * Bloc media : galerie d'images + fichiers attachés (par IDs de documents).
- */
-export interface ActionMedia {
-  type?: string;
-  countImages?: number;
-  images?: string[];
-  files?: string[];
-  [k: string]: unknown;
-}
-
-export interface ActionMediaFile {
-  files?: string[];
-  [k: string]: unknown;
-}
-
-export interface ActionItemJson {
-  _id: IdObject;
-  collection: "actions";
-  name: string;
-  description?: string;
-  status?: ActionStatus;
-  created?: DateValue;
-  updated?: DateValue;
-  modified?: DateValue;
-  startDate?: DateValue;
-  endDate?: DateValue;
-  parentId: string;
-  parentType: string;
-  parent?: ParentsMap;
-  tags?: string[];
-  links?: ActionLinksBlock;
-  creator?: string;
-  idUserAuthor?: string;
-  credits?: string;
-  idParentRoom?: string;
-  milestone?: ActionMilestoneRef;
-  importance?: string;
-  counts?: ActionCounts;
-  url?: string;
-  min?: number;
-  max?: number;
-  timeSpent?: number;
-  tracking?: boolean;
-  updateStatus?: ActionUpdateStatusEntryJson[];
-  rc?: unknown[];
-  tasks?: ActionTaskJson[];
-  media?: ActionMedia;
-  mediaFile?: ActionMediaFile;
-  [key: string]: unknown;
-}
-
-export interface ActionItemNormalized {
-  id: string;
-  _id: ObjectID;
-  collection: "actions";
-  name: string;
-  description?: string;
-  status?: ActionStatus;
-  created?: Date;
-  updated?: Date;
-  modified?: Date;
-  startDate?: Date;
-  endDate?: Date;
-  parentId: string;
-  parentType: string;
-  parent?: ParentsMap;
-  tags?: string[];
-  links?: ActionLinksBlock;
-  creator?: string;
-  idUserAuthor?: string;
-  credits?: number;
-  idParentRoom?: string;
-  milestone?: Omit<ActionMilestoneRef, "startDate" | "endDate"> & {
-    startDate?: Date;
-    endDate?: Date;
-  };
-  importance?: string;
-  counts?: ActionCounts;
-  url?: string;
-  min?: number;
-  max?: number;
-  timeSpent?: number;
-  tracking?: boolean;
-  updateStatus?: ActionUpdateStatusEntryNormalized[];
-  rc?: unknown[];
-  tasks?: ActionTaskNormalized[];
-  media?: ActionMedia;
-  mediaFile?: ActionMediaFile;
-  [key: string]: unknown;
-}

package/src/api/serverDataType/Answer.ts

@@ -1,106 +0,0 @@
-import { DateValue, IdObject, ParentsMap } from "./common.js";
-
-import type EJSONType from "../../EJSONType.js";
-import type { Answer } from "../Answer.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>;
-
-/**
- * Identifiant d'un Form (string 24 hex). Alias purement sémantique de `string` :
- * sert à lever l'ambiguïté dans `Record<FormId, ...>` — sans ce nom, on pourrait croire
- * qu'il s'agit d'un answerId ou autre.
- *
- * ⚠️ Ces formIds proviennent de la config costum (ex: `navigatorDesTierslieux`)
- * et ne correspondent **pas toujours** à des docs queriables via `api.form({id}).get()` —
- * il s'agit parfois de références internes au costum (templates, sous-forms, etc.).
- * À traiter comme un opaque token côté caller.
- */
-export type FormId = string;
-
-/**
- * Forme JSON brute : Answer docs (MongoDB) groupés par formId.
- * Apparaît dans `result.answers` du payload `/costum/navigator/gettl` avant linkage.
- */
-export type AnswerDocsByFormId = Record<FormId, AnswerItemJson[]>;
-
-/**
- * Forme normalisée : instances `Answer` groupées par formId.
- * Construite par `Organization/Project._transformServerData` à partir de `AnswerDocsByFormId`.
- */
-export type AnswersByFormId = Record<FormId, Answer[]>;
-
-export interface AnswerLinksBlock {
-    answered: string[];
-}
-
-export interface AnswerProjectRef {
-    id?: string;
-    type?: string;
-    name?: string;
-}
-
-export interface AnswerItemJson {
-    _id: IdObject;
-    collection: "answers";
-    created?: DateValue;
-    updated?: DateValue;
-    user?: string;
-    links?: AnswerLinksBlock;
-    draft?: boolean;
-    answers?: Record<string, unknown>;
-    context?: ParentsMap;
-    form?: string;
-    modified?: DateValue;
-    voteCount?: Record<string, number>;
-    vote?: Record<string, {
-        status: string;
-        date: DateValue;
-    }>;
-    project?: AnswerProjectRef;
-    [key: string]: unknown;
-}
-
-/**
- * Raisons de refus d'édition côté backend, calculées par `coformAnswersById`
- * et présentes dans la réponse normalisée. Utilisé par les UI pour distinguer
- * les modes readonly/edit et afficher des messages contextuels.
- */
-export type AnswerEditDeniedReason =
-    | "not_logged_in"
-    | "not_owner"
-    | "form_inactive"
-    | "form_closed";
-
-export interface AnswerItemNormalized {
-    id: string;
-    _id: ObjectID;
-    collection: "answers";
-    created?: Date;
-    updated?: Date;
-    user?: string | User;
-    links?: AnswerLinksBlock;
-    draft?: boolean;
-    finished?: boolean;
-    answers?: Record<string, unknown>;
-    context?: ParentsMap | Record<string, Organization | Project>;
-    form?: string;
-    modified?: Date;
-    voteCount?: Record<string, number>;
-    vote?: Record<string, {
-        status: string;
-        date: Date;
-    }>;
-    project?: AnswerProjectRef;
-    /**
-     * L'utilisateur courant peut-il éditer cette réponse ? Calculé côté backend.
-     * Présent par défaut, ou enrichi avec le contexte si `formId` est fourni.
-     */
-    canEdit?: boolean;
-    /** Raison si `canEdit === false`. `null` si `canEdit === true`. */
-    editDeniedReason?: AnswerEditDeniedReason | null;
-    [key: string]: unknown;
-}

package/src/api/serverDataType/Classified.ts

@@ -1,152 +0,0 @@
-import type {
-  GeoCoordinates,
-  GeoPosition,
-  IdObject,
-  ParentsMap,
-  PostalAddress,
-  DateValue
-} from "./common.js";
-import type EJSONType from "../../EJSONType.js";
-
-type ObjectIDCtor = typeof EJSONType["ObjectID"];
-type ObjectID = InstanceType<ObjectIDCtor>;
-
-// ============================================================================
-// SECTIONS
-// ============================================================================
-
-export const CLASSIFIED_SECTIONS = ["need", "offer"] as const;
-export type ClassifiedSection = (typeof CLASSIFIED_SECTIONS)[number];
-
-// ============================================================================
-// CATÉGORIES
-// ============================================================================
-
-export const CLASSIFIED_CATEGORIES = ["service", "competence", "material"] as const;
-export type ClassifiedCategory = (typeof CLASSIFIED_CATEGORIES)[number];
-
-// ============================================================================
-// SOUS-CATÉGORIES
-// ============================================================================
-
-export interface ClassifiedSubcatEntry {
-  key: string;
-  label: string;
-  icon: string;
-}
-
-export interface ClassifiedCategoryDef {
-  key: ClassifiedCategory;
-  icon: string;
-  label: string;
-  subcat: Record<string, ClassifiedSubcatEntry>;
-}
-
-export const CLASSIFIED_SUBCATEGORIES: Record<ClassifiedCategory, ClassifiedCategoryDef> = {
-  service: {
-    key: "service",
-    icon: "cogs",
-    label: "Service",
-    subcat: {
-      charity:            { key: "charity",            label: "Charité",                                      icon: "heart" },
-      education:          { key: "education",          label: "Aide éducative",                              icon: "book" },
-      househelp:          { key: "househelp",          label: "Aide ménagère",                               icon: "home" },
-      washing:            { key: "washing",            label: "Lavage",                                       icon: "droplets" },
-      gardening:          { key: "gardening",          label: "Jardinage",                                   icon: "flower" },
-      farming:            { key: "farming",            label: "Agriculture",                                  icon: "wheat" },
-      generalmaintenance: { key: "generalmaintenance", label: "Maintenance générale",                        icon: "wrench" },
-      childrencare:       { key: "childrencare",       label: "Garde d'enfants",                             icon: "baby" },
-      ederlycare:         { key: "ederlycare",         label: "Aide aux personnes âgées",                   icon: "user" },
-      disabledcare:       { key: "disabledcare",       label: "Aide aux personnes en situation de handicap", icon: "accessibility" },
-      hostinghelp:        { key: "hostinghelp",        label: "Aide à l'accueil",                            icon: "handshake" },
-      animalcare:         { key: "animalcare",         label: "Soins aux animaux",                          icon: "paw-print" },
-    },
-  },
-  competence: {
-    key: "competence",
-    icon: "bookmark",
-    label: "Compétence",
-    subcat: {
-      artistic:      { key: "artistic",      label: "Artistique",                   icon: "palette" },
-      laws:          { key: "laws",          label: "Droit",                         icon: "scale" },
-      itdevlopment:  { key: "itdevlopment",  label: "Développement informatique",   icon: "code" },
-      handcraft:     { key: "handcraft",     label: "Artisanat",                    icon: "scissors" },
-      animalcare:    { key: "animalcare",    label: "Soins aux animaux",            icon: "paw-print" },
-      agriculture:   { key: "agriculture",   label: "Agriculture",                  icon: "wheat" },
-      restauration:  { key: "restauration",  label: "Restauration",                 icon: "utensils" },
-      building:      { key: "building",      label: "Construction",                 icon: "hard-hat" },
-    },
-  },
-  material: {
-    key: "material",
-    icon: "wrench",
-    label: "Matériel",
-    subcat: {
-      electronic:        { key: "electronic",        label: "Électronique",            icon: "cpu" },
-      furniture:         { key: "furniture",         label: "Mobilier",                icon: "armchair" },
-      primaryressources: { key: "primaryressources", label: "Ressources primaires",    icon: "leaf" },
-      buildingtools:     { key: "buildingtools",     label: "Outils de construction",  icon: "hammer" },
-      gardeningtools:    { key: "gardeningtools",    label: "Outils de jardinage",     icon: "shovel" },
-      medicalstuff:      { key: "medicalstuff",      label: "Matériel médical",        icon: "stethoscope" },
-    },
-  },
-};
-
-// Union des clés de sous-catégories
-export type ServiceSubcat      = keyof typeof CLASSIFIED_SUBCATEGORIES.service.subcat;
-export type CompetenceSubcat   = keyof typeof CLASSIFIED_SUBCATEGORIES.competence.subcat;
-export type MaterialSubcat     = keyof typeof CLASSIFIED_SUBCATEGORIES.material.subcat;
-export type ClassifiedSubcat   = ServiceSubcat | CompetenceSubcat | MaterialSubcat;
-
-// ============================================================================
-// INTERFACES JSON / NORMALISÉES
-// ============================================================================
-
-export interface ClassifiedItemJson {
-  _id: IdObject;
-  collection: "classifieds";
-  name: string;
-  section: ClassifiedSection;
-  category: ClassifiedCategory;
-  subtype: ClassifiedSubcat;
-  created?: DateValue;
-  updated?: DateValue;
-  modified?: DateValue;
-  parent?: ParentsMap;
-  description?: string;
-  slug?: string;
-  address?: PostalAddress;
-  geo?: GeoCoordinates;
-  geoPosition?: GeoPosition;
-  tags?: string[];
-  creator?: string;
-  profilImageUrl?: string;
-  profilMediumImageUrl?: string;
-  profilThumbImageUrl?: string;
-  [key: string]: unknown;
-}
-
-export interface ClassifiedItemNormalized {
-  id: string;
-  _id: ObjectID;
-  collection: "classifieds";
-  name: string;
-  section: ClassifiedSection;
-  category: ClassifiedCategory;
-  subtype: ClassifiedSubcat;
-  created?: Date;
-  updated?: Date;
-  modified?: Date;
-  parent?: ParentsMap;
-  description?: string;
-  slug?: string;
-  address?: PostalAddress;
-  geo?: GeoCoordinates;
-  geoPosition?: GeoPosition;
-  tags?: string[];
-  creator?: string;
-  profilImageUrl?: string;
-  profilMediumImageUrl?: string;
-  profilThumbImageUrl?: string;
-  [key: string]: unknown;
-}