@communecter/cocolight-api-client 1.0.166 → 1.0.167

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@communecter/cocolight-api-client",
-    "version": "1.0.166",
+    "version": "1.0.167",
     "description": "Client Axios simplifié pour l'API cocolight",
     "repository": {
         "type": "git",

package/types/api/BaseEntity.d.ts

@@ -708,6 +708,48 @@ export declare class BaseEntity<TServerData = any> {
      * await news.deleteFile(imageDocId);
      */
     deleteFile(docId: string): Promise<void>;
+    /**
+     * Champs de contexte costum à joindre à un upload multipart (profil/bannière/galerie) pour que le
+     * backend stampe `source.key` (Document.php:228-232). Dérivés de `_costumCtx` (résolu du `source.key`
+     * de l'élément) → un POI scopé "parent62" envoie `costumSlug="parent62"`. `{}` hors contexte costum.
+     */
+    protected _costumUploadFields(): {
+        costumSlug?: string;
+        costumId?: string;
+        costumType?: string;
+    };
+    /**
+     * Uploade un document (image/fichier) rattaché à CET élément, avec `contentKey`/`docType`
+     * PARAMÉTRABLES — ex. `contentKey:"slider"` pour une galerie (Option C). La provenance costum
+     * (`source.key`) est injectée automatiquement depuis `_costumCtx` (résolu du `source.key` de
+     * l'élément). L'élément DOIT préexister (pas d'auto-création, contraste avec `Answer.uploadFile`).
+     * Endpoint générique `UPLOAD_DOCUMENT` (backend `co2/document/upload-save`, route wildcard).
+     *
+     * STATELESS : ne rafraîchit PAS `serverData` (pas de push local façon `News.addImage`). Pour refléter
+     * la nouvelle image dans `getGalleryImages()`, re-fetch l'élément via `about` après upload (le
+     * consommateur peut afficher optimistement via le `docPath` retourné en attendant). Cf. patron
+     * `Answer.processUploads` : la galerie s'uploade APRÈS `save()` (l'élément doit avoir un `id`).
+     *
+     * @returns `{ docId, docPath }` — id du document créé + URL relative servie.
+     * @throws {ApiError} 404 si l'entité n'est pas enregistrée (pas d'`id`).
+     */
+    uploadDocument(file: UploadInput, opts: {
+        contentKey: string;
+        docType?: "image" | "file";
+        subKey?: string;
+        folder?: string;
+        ownerId?: string;
+    }): Promise<{
+        docId: string;
+        docPath: string;
+    }>;
+    /**
+     * Images d'une galerie de CET élément, lues depuis le champ `images` fusionné par `about`/getById
+     * (backend `enrichAbout` — {Poi,Classified}::getById), filtrées par `contentKey` (défaut `"slider"`).
+     * SYNCHRONE : nécessite que l'entité ait été chargée via `about` (sinon `[]`). Forme = getListOfImage
+     * (`{ id, _id, contentKey, imagePath, imageThumbPath, imageMediumPath, subKey, name, ... }`).
+     */
+    getGalleryImages(contentKey?: string): Array<Record<string, unknown>>;
     /**
      * Liste les documents (images/fichiers) attachés à CETTE entité (`id` + `type`) via `DOCUMENT_LIST`
      * (port legacy `document/list`). Renvoie un tableau plat `{ id, name, path, author, contentKey }`.
@@ -721,6 +763,26 @@ export declare class BaseEntity<TServerData = any> {
         author?: string;
         contentKey?: string;
     }>>;
+    /**
+     * Liste les FICHIERS (documents non-image, `doctype:"file"`) attachés à CETTE entité via `GET_GALLERY`
+     * (`co2/gallery/index`, branche fichier : `docs` = OBJET keyé par `_id`, records BRUTS + `docPath`
+     * absolutisé par `_imageFields`). Source UNIQUE et uniforme tous types (org/projet/citoyen/poi/events/
+     * classifieds — l'`IndexAction` legacy est type-agnostique). Contraste `getGalleryImages` (images,
+     * synchrone via `about`) et `getDocuments` (DOCUMENT_LIST, forme réduite sans `size`/`docType`, `path`
+     * = dossier seul). Les fichiers rangés en dossier (`folderId`) sont exclus par défaut (parité
+     * `IndexAction` : `folderId:{$exists:false}`).
+     *
+     * @returns `{ docId, docPath, name, size, contentKey }[]` — `contentKey` = valeur DÉRIVÉE stockée
+     *   (`pdf`/`spreadsheet`/`text`/`presentation`), utilisable pour choisir l'icône.
+     * @throws {ApiError} 404 si l'entité n'est pas enregistrée.
+     */
+    getGalleryFiles(): Promise<Array<{
+        docId: string;
+        docPath?: string;
+        name?: string;
+        size?: number;
+        contentKey?: string;
+    }>>;
     /**
      * Supprime l'image de PROFIL de cette entité : récupère le `docId` du document `contentKey:"profil"`
      * (via `getDocuments`) puis `deleteFile`. No-op (`false`) s'il n'y a pas d'image. Pendant exact de

package/types/api/EndpointApi.d.ts

@@ -1,5 +1,5 @@
 import type ApiClient from "../ApiClient.js";
-import type { DocumentListData, 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, GlobalAutocompleteAdminCostumData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetUserEligiblePlacesData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, SearchEventsCostumData, ShareEventsData, InviteMembersData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, NavigatorGettlData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, GetCoformByIdData, CoformUploadAnswerFileData, DeleteCoformAnswerFileData, 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, ImportPreviewData, ExportElementsData, ImportElementsData, GeocodageData, ValidateGroupData, SetSourceData, ModerateData, NewsModerateData, CommentModerateData } from "./EndpointApi.types.js";
+import type { DocumentListData, 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, GlobalAutocompleteAdminCostumData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetUserEligiblePlacesData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, SearchEventsCostumData, ShareEventsData, InviteMembersData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, NavigatorGettlData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, GetCoformByIdData, CoformUploadAnswerFileData, DeleteCoformAnswerFileData, 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, ImportPreviewData, ExportElementsData, ImportElementsData, GeocodageData, ValidateGroupData, SetSourceData, ModerateData, NewsModerateData, CommentModerateData, UploadDocumentData } from "./EndpointApi.types.js";
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
  */
@@ -1502,5 +1502,15 @@ export declare class EndpointApi {
      * @throws {Error} - En cas d'erreur inattendue.
      */
     commentModerate(data: CommentModerateData): Promise<any>;
+    /**
+     * Uploader un document/image sur un élément (galerie) : Uploade un document (image/fichier) rattaché à un ÉLÉMENT, avec docType/contentKey PARAMÉTRABLES (ex. contentKey=slider pour une galerie) et provenance costum optionnelle (costumSlug/costumId/costumType stampent source.key). Backend: co2/document/upload-save (route wildcard, parseKv). L'élément doit préexister.
+     * Constant : UPLOAD_DOCUMENT
+     * @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.
+     */
+    uploadDocument(data: UploadDocumentData): Promise<any>;
 }
 export default EndpointApi;

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

@@ -364,6 +364,18 @@ export interface ProfilImageData {
     profil_avatar: {
         [k: string]: unknown;
     };
+    /**
+     * Slug du costum actif (stampe source.key côté backend) — optionnel
+     */
+    costumSlug?: string;
+    /**
+     * ID du contexte costum — optionnel
+     */
+    costumId?: string;
+    /**
+     * Type (collection) du contexte costum — optionnel
+     */
+    costumType?: string;
     pathParams?: {
         /**
          * Type d'entité
@@ -391,6 +403,18 @@ export interface ProfilBannerData {
     cropH: number;
     cropX: number;
     cropY: number;
+    /**
+     * Slug du costum actif (stampe source.key côté backend) — optionnel
+     */
+    costumSlug?: string;
+    /**
+     * ID du contexte costum — optionnel
+     */
+    costumId?: string;
+    /**
+     * Type (collection) du contexte costum — optionnel
+     */
+    costumType?: string;
     pathParams?: {
         /**
          * Type d'entité
@@ -4912,9 +4936,9 @@ export interface GetGalleryData {
          */
         id: string;
         /**
-         * Type d'entité
+         * Type d'entité (IndexAction legacy est type-agnostique ; poi/events/classifieds ajoutés pour la lecture des documents/fichiers via getGalleryFiles)
          */
-        type: "citoyens" | "organizations" | "projects";
+        type: "citoyens" | "organizations" | "projects" | "poi" | "events" | "classifieds";
         /**
          * Type de document
          */
@@ -6348,3 +6372,51 @@ export interface CommentModerateData {
     isAnAbuse?: "true" | "false";
     [k: string]: unknown;
 }
+export interface UploadDocumentData {
+    /**
+     * Fichier à uploader
+     */
+    qqfile: {
+        [k: string]: unknown;
+    };
+    /**
+     * Slug du costum actif (stampe source.key=costumSlug)
+     */
+    costumSlug?: string;
+    /**
+     * ID du contexte costum
+     */
+    costumId?: string;
+    /**
+     * Type (collection) du contexte costum
+     */
+    costumType?: string;
+    /**
+     * Sous-clé de galerie (optionnelle)
+     */
+    subKey?: string;
+    /**
+     * Dossier d'album cible (optionnel)
+     */
+    folderId?: string;
+    pathParams?: {
+        /**
+         * Type (collection) de l'élément porteur
+         */
+        folder: "citoyens" | "projects" | "organizations" | "events" | "poi" | "classifieds";
+        /**
+         * ID de l'élément porteur (doit exister)
+         */
+        ownerId: string;
+        /**
+         * Nature du document
+         */
+        docType: "image" | "file";
+        /**
+         * Clé de contenu (ex: 'slider' pour galerie, 'file', 'profil', 'banner'...)
+         */
+        contentKey: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}

package/types/costum/runtime.d.ts

@@ -121,12 +121,18 @@ export declare class CostumScope {
  */
 export declare function resolveCostumCtxFromSource(sourceKey: string | undefined | null, collection: Collection, type?: string | null): CostumRuntimeContext | null;
 /**
- * Ouvre un scope costum FIELDLESS depuis une entité DÉJÀ CHARGÉE (zéro fetch) : `costumSlug` = slug de
- * l'entité (= `source.key` posé par le backend), `costumId/costumType` = l'entité porteuse. Pendant runtime
- * exact de `_withCostumContext` (BaseEntity), pour la voie « entité tenue » (un site nu sans form). Le
- * backend re-gate `found` sur l'existence d'un costum sur l'entité → un site sans costum n'estampille rien.
+ * Ouvre un scope costum depuis une entité DÉJÀ CHARGÉE (org/projet/event porteur d'un costum) : `costumSlug`
+ * = slug de l'entité (= `source.key` posé par le backend), `costumId/costumType` = l'entité porteuse. C'est
+ * la voie AMBIANTE (« costum du déploiement ») de `me.costum(entity)`.
+ *
+ * Le scope porte les DÉFINITIONS du costum (champs + presets de sous-type, ex. `type:"article"`), PAS
+ * seulement l'identité : sinon un CREATE de sous-type sous l'ambiant perd le `type` forcé → rejet enum ADD_*.
+ * Résolution (dégradée, jamais throw) : 1) cache live frais (zéro fetch — le costum est déjà chargé au rendu
+ * du site) ; 2) digest live `getcostumjson` (comble presets/champs + peuple le cache) ; 3) fieldless
+ * (identité seule — site nu sans costum, ou offline = comportement historique). Le backend re-gate `found`
+ * sur l'existence d'un costum → un site sans costum n'estampille rien.
  */
-export declare function costumScopeFromEntity(user: BaseEntity, entity: BaseEntity): CostumScope;
+export declare function costumScopeFromEntity(user: BaseEntity, entity: BaseEntity): Promise<CostumScope>;
 /**
  * Résout un `CostumScope` par SLUG pour un user connecté.
  *  - slug à champs (meta + loader) → charge le module généré (code-split via dynamic import).