@communecter/cocolight-api-client 1.0.145 → 1.0.147

package/types/ApiClient.d.ts

@@ -24,6 +24,17 @@ export interface ApiClientOptions {
     circuitBreakerThreshold?: number;
     circuitBreakerResetTime?: number;
     fromJSONValue?: boolean;
+    /**
+     * Mode de dialogue avec le backend cocolight-backend :
+     *  - `legacy` (défaut) : réponses byte-compatibles PHP ; la lib applique TOUTES ses
+     *    normalisations côté client (_transformData/_normalizeJsonData) + validation AJV.
+     *  - `clean` : envoie `X-Coco-Mode: clean` ; le SERVEUR applique les normalisations et
+     *    répond {success, data|error}. La lib unwrap l'enveloppe, lève ApiResponseError sur
+     *    success:false, SAUTE _transformData et la validation AJV (schémas legacy), et revive
+     *    (dates ISO -> Date, id -> _id ObjectID) pour rendre à l'app le MÊME shape qu'avant.
+     *  NB : l'intercepteur refresh-token reste en legacy (appel interne sans le header).
+     */
+    mode?: "legacy" | "clean";
     tokenStorageStrategy?: TokenStorageStrategy | null;
 }
 /**
@@ -81,7 +92,8 @@ export default class ApiClient extends EventEmitter {
     private _accessToken;
     private _refreshToken;
     private _setUserId;
-    constructor({ baseURL, accessToken, refreshToken, refreshUrl, endpoints, timeout, debug, maxRetries, circuitBreakerThreshold, circuitBreakerResetTime, fromJSONValue, tokenStorageStrategy }: ApiClientOptions);
+    private _mode;
+    constructor({ baseURL, accessToken, refreshToken, refreshUrl, endpoints, timeout, debug, maxRetries, circuitBreakerThreshold, circuitBreakerResetTime, fromJSONValue, mode, tokenStorageStrategy }: ApiClientOptions);
     /**
      * Sets the access token for the API client and updates the authorization header.
      */
@@ -236,6 +248,13 @@ export default class ApiClient extends EventEmitter {
        *
        * @private
        */
+    /**
+     * Reviver du mode clean : redonne à l'app le shape exact qu'elle recevait après les
+     * normalisations legacy de la lib — dates ISO (champs _dateFields) -> instances Date,
+     * `id` oid-hex -> `_id` instance ObjectID (créée via EJSON.fromJSONValue, MÊME chemin
+     * que le mode legacy). Le serveur clean a déjà fait tout le reste.
+     */
+    private _reviveClean;
     private _transformData;
     /**
        * Normalizes JSON data by transforming specific fields and ensuring URLs are complete.

package/types/api/Answer.d.ts

@@ -7,6 +7,46 @@ type UploadInput = File | Blob | Buffer | import("stream").Readable;
  * Générique : la lib ne fait aucune supposition sur le type des valeurs.
  */
 export type AllStepsData = Record<string, Record<string, unknown>>;
+/**
+ * Une entrée de l'historique d'audit d'une réponse (réponse de
+ * `GET_COFORM_ANSWER_HISTORY`). `userName`/`userSlug` sont dénormalisés
+ * au moment de la modification : survivent à une suppression de l'user.
+ */
+export interface AnswerChange {
+    userId: string;
+    userName: string;
+    userSlug: string;
+    /** Timestamp unix en SECONDES (pas ms) — `new Date(at * 1000)`. */
+    at: number;
+    /** `""` possible : cast PHP `(string)` avec défaut vide si champ absent. */
+    mutationType: "create" | "update" | "";
+    changedFields: string[];
+}
+/** Un axe du radar multi-eval (= un input radioNew d'une step donnée). */
+export interface MultiEvalAxis {
+    key: string;
+    label: string;
+    options: string[];
+}
+/** Un dataset = la contribution d'un user à un step (1 dataset = 1 user). */
+export interface MultiEvalDataset {
+    userId: string;
+    userName: string;
+    userSlug: string;
+    evaluatedAt: number | null;
+    values: Record<string, number>;
+}
+/** Une step avec ses axes et ses contributeurs (élément de `getMultiEvalData`). */
+export interface MultiEvalStepData {
+    stepKey: string;
+    stepName: string;
+    axes: MultiEvalAxis[];
+    datasets: MultiEvalDataset[];
+}
+/** Réponse de `Answer.getMultiEvalData()`. */
+export interface MultiEvalDataResponse {
+    steps: MultiEvalStepData[];
+}
 /**
  * Valeur d'un upload en attente — objet `{ name?, data: "data:...;base64,..." }`
  * inséré par les inputs uploader avant le pré-upload backend.
@@ -286,6 +326,50 @@ export declare class Answer extends BaseEntity<AnswerItemNormalized> {
      * files[0].docPath;   // Chemin relatif (à concaténer avec baseURL pour affichage)
      */
     getFiles(opts: GetFilesOptions): Promise<AnswerFileItem[]>;
+    /**
+     * Récupère l'historique d'audit de cette Answer.
+     *
+     * Trace `create` + `update` triée du plus récent au plus ancien, max 200
+     * entrées (cap backend). Auth côté serveur : owner OU canAdminAnswer
+     * (admin du parent du form, admin/membre finder selon
+     * `membersCanEditSharedAnswer`, ou form `publicCanEditSharedAnswer`).
+     *
+     * Constant : `GET_COFORM_ANSWER_HISTORY` (POST
+     * `/survey/coform/getanswerhistory`, auth bearer).
+     *
+     * @returns Liste des changements ; tableau vide si l'historique est vide.
+     * @throws {ApiError} 400 si Answer sans id.
+     * @throws {ApiAuthenticationError} si non connecté.
+     *
+     * @example
+     * const form = await org.form({ id: formId });
+     * const answer = await form.answer({ id: answerId });
+     * const history = await answer.getHistory();
+     * new Date(history[0].at * 1000); // date de la dernière modif (at en SECONDES)
+     */
+    getHistory(): Promise<AnswerChange[]>;
+    /**
+     * Récupère les datasets agrégés des évaluations multiples (radar) de cette
+     * Answer. Pour une réponse partagée contenant des inputs `radioNew` avec
+     * `activeMultieval: true`, retourne un dataset par contributeur pour
+     * chaque step.
+     *
+     * Constant : `GET_COFORM_MULTIEVAL_DATA` (POST
+     * `/survey/coform/getmultievaldata`, auth bearer). Auth côté serveur :
+     * owner OU canAdminAnswer.
+     *
+     * @param opts.stepKey - Optionnel : filtrer aux datasets d'une seule
+     *                       step. Sinon retourne toutes les steps.
+     * @throws {ApiError} 400 si Answer sans id.
+     * @throws {ApiAuthenticationError} si non connecté.
+     *
+     * @example
+     * const data = await answer.getMultiEvalData();
+     * data.steps.forEach(s => renderRadar(s));
+     */
+    getMultiEvalData(opts?: {
+        stepKey?: string | null;
+    }): Promise<MultiEvalDataResponse>;
     /**
      * Upload un fichier rattaché à cette Answer via `COFORM_UPLOAD_ANSWER_FILE`.
      *

package/types/api/EndpointApi.d.ts

@@ -1,5 +1,5 @@
 import type ApiClient from "../ApiClient.js";
-import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, ProfilBannerData, GetElementsAboutData, MulticonnectData, GetNewsData, GetNewsByIdData, AddNewsData, AddImageNewsData, AddFileNewsData, DeleteNewsData, UpdateNewsData, ShareNewsData, GetCommentsData, AddCommentsData, DeleteCommentsData, UpdateCommentsData, SearchTagsData, ShowVoteData, GlobalAutocompleteData, CityAutocompleteData, CityAutocompleteByCountryData, SuggestionInputData, GetProjectsNoAdminData, GetProjectsAdminData, GetPoisNoAdminData, GetPoisAdminData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetUserEligiblePlacesData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeletePoiData, DeleteEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, ShareEventsData, InviteEventData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, NavigatorGettlData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, GetCoformByIdData, CoformUploadAnswerFileData, CoformGetAnswerFilesData, GetCoformCatalogsData, SaveCoformAnswerData, GetCoformAnswerHistoryData, GetCoformMultievalDataData, GetCoformCommontableContributorsData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData, DeleteDocumentByIdData, DemoteAdminData, CostumFilterCoformData, CostumFilterCoformByPathData, GetCountriesData, SearchZonesData, CoformAnswersByFormsData, GenerateAnswerFromFormData, FundingEnvelopeData, CoremuOperationData, CostumProjectActionRequestNewData, CostumProjectActionRequestSetStatusData, CostumProjectActionRequestSetDateData, CostumProjectActionRequestSetContributorsData, CostumProjectActionRequestCancelData, CostumProjectActionRequestArchiveData, LinkDiscourseAccountData, UnlinkDiscourseAccountData, DiscourseProfileData, DiscourseCheckEmailData, DiscourseDismissLinkData, LinkMediawikiAccountData, UnlinkMediawikiAccountData, GetMediawikiContributionsData, AddClassifiedData } from "./EndpointApi.types.js";
+import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, ProfilBannerData, GetElementsAboutData, MulticonnectData, GetNewsData, GetNewsByIdData, AddNewsData, AddImageNewsData, AddFileNewsData, DeleteNewsData, UpdateNewsData, ShareNewsData, GetCommentsData, AddCommentsData, DeleteCommentsData, UpdateCommentsData, SearchTagsData, ShowVoteData, GlobalAutocompleteData, CityAutocompleteData, CityAutocompleteByCountryData, SuggestionInputData, GetProjectsNoAdminData, GetProjectsAdminData, GetPoisNoAdminData, GetPoisAdminData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetUserEligiblePlacesData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeletePoiData, DeleteEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, ShareEventsData, InviteEventData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, NavigatorGettlData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, GetCoformByIdData, CoformUploadAnswerFileData, CoformGetAnswerFilesData, GetCoformCatalogsData, SaveCoformAnswerData, GetCoformAnswerHistoryData, GetCoformMultievalDataData, GetCoformCommontableContributorsData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData, DeleteDocumentByIdData, DemoteAdminData, CostumFilterCoformData, CostumFilterCoformByPathData, GetCountriesData, SearchZonesData, CoformAnswersByFormsData, GenerateAnswerFromFormData, FundingEnvelopeData, CoremuOperationData, CostumProjectActionRequestNewData, CostumProjectActionRequestSetStatusData, CostumProjectActionRequestSetDateData, CostumProjectActionRequestSetContributorsData, CostumProjectActionRequestCancelData, CostumProjectActionRequestArchiveData, LinkDiscourseAccountData, UnlinkDiscourseAccountData, DiscourseProfileData, DiscourseCheckEmailData, DiscourseDismissLinkData, LinkMediawikiAccountData, UnlinkMediawikiAccountData, GetMediawikiContributionsData, AddClassifiedData, PersonActivateData } from "./EndpointApi.types.js";
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
  */
@@ -1386,5 +1386,14 @@ export declare class EndpointApi {
      * @throws {Error} - En cas d'erreur inattendue.
      */
     addClassified(data: AddClassifiedData): Promise<any>;
+    /**
+     * Activation d’un compte (lien email) : Valide l’adresse email d’un compte via le lien reçu par email. validationKey = sha256(user + email). Retire roles.tobeactivated et pose le consentement preferences.sendMail.source (port ActivateAction + Person::validateEmailAccount/validateUser).
+     * Constant : PERSON_ACTIVATE
+     * @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 {Error} - En cas d'erreur inattendue.
+     */
+    personActivate(data: PersonActivateData): Promise<any>;
 }
 export default EndpointApi;

package/types/api/EndpointApi.types.d.ts

@@ -6107,3 +6107,14 @@ export interface AddClassifiedData {
     scope: "";
     [k: string]: unknown;
 }
+export interface PersonActivateData {
+    /**
+     * Identifiant (_id) du compte à activer
+     */
+    user: string;
+    /**
+     * Clé de validation = sha256(user + email)
+     */
+    validationKey: string;
+    [k: string]: unknown;
+}

package/types/api/Form.d.ts

@@ -3,6 +3,32 @@ import type { Answer } from "./Answer.js";
 import type { PaginatorPage, PaginatorState } from "./BaseEntity.js";
 import type { CoformAnswersSearchData } from "./EndpointApi.types.js";
 import type { CoformCommonTableContributor, FormItemNormalized } from "./serverDataType/Form.js";
+/**
+ * Une entrée de catalogue commonTable (une criteria agrégée cross-réponses).
+ * `label`/`usage`/`usageKey`/`coeff`/`count` toujours présents (le backend
+ * les construit avec défauts) ; `names`/`name` seulement si au moins une
+ * réponse `yesOrNo` non vide existe pour la criteria. Les champs echo
+ * (`label`, `usage`…) renvoient la valeur stockée brute, sans coercion.
+ */
+export interface CommonTableCatalogEntry {
+    label: unknown;
+    usage: unknown;
+    usageKey: unknown;
+    coeff: number | string | boolean | null;
+    count: number;
+    /** Distribution `{ solutionName → fréquence }` ; absent si aucune réponse. */
+    names?: Record<string, number>;
+    /** Mode (plus fréquent) de `names` ; présent ssi `names` présent. */
+    name?: string;
+}
+/**
+ * Catalogue collaboratif des inputs `commonTable` : map
+ * `inputKey → (criteriaId → CommonTableCatalogEntry)`. Les entrées sont
+ * DIRECTEMENT sous l'inputKey (pas de niveau intermédiaire `entries`).
+ * Format aligné sur la réponse backend de `GET_COFORM_CATALOGS`
+ * (`getCatalogs` normalise les `[]` PHP — catalogues vides — en `{}`).
+ */
+export type CommonTableCatalogs = Record<string, Record<string, CommonTableCatalogEntry>>;
 export declare class Form extends BaseEntity<FormItemNormalized> {
     static entityType: string;
     static entityTag: string;
@@ -105,4 +131,29 @@ export declare class Form extends BaseEntity<FormItemNormalized> {
         inputKey: string;
         criteriaIds: string | string[];
     }): Promise<CoformCommonTableContributor[]>;
+    /**
+     * Récupère en UN appel batch les catalogues collaboratifs des inputs
+     * `commonTable` de CE formulaire. Pour chaque `inputKey`, retourne les
+     * `criterias` agrégées par toutes les réponses + le comptage par
+     * `criteriaId`.
+     *
+     * Constant : `GET_COFORM_CATALOGS` (POST `/survey/coform/getformcatalogs`,
+     * auth: none — accessible aux visiteurs anonymes pour pré-remplir les
+     * suggestions côté input).
+     *
+     * Si `inputKeys` est vide, on lève une erreur — le caller doit gate
+     * l'appel en amont (cf. `useCoFormCatalogs` qui passe `enabled: false`).
+     *
+     * @param params.inputKeys - `fieldKey` de tous les inputs commonTable.
+     * @returns Map `inputKey → (criteriaId → entry)` ; `{}` pour un inputKey sans données.
+     * @throws {ApiError} 400 si Form sans id ou `inputKeys` vide.
+     *
+     * @example
+     * const form = await api.form({ id: formId });
+     * const catalogs = await form.getCatalogs({ inputKeys: ["usagesEtSolutions"] });
+     * catalogs["usagesEtSolutions"]; // {criteriaId: {label, count, name?, names?, ...}}
+     */
+    getCatalogs(params: {
+        inputKeys: string[];
+    }): Promise<CommonTableCatalogs>;
 }

package/types/api/UserApi.d.ts

@@ -61,4 +61,22 @@ export declare class UserApi {
      * @throws {ApiResponseError} Si l'API retourne un échec (`result === false`).
      */
     recoverPassword(email: string): Promise<any>;
+    /**
+     * 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`).
+     */
+    activateAccount({ user, validationKey }: {
+        user: string;
+        validationKey: string;
+    }): Promise<any>;
 }