@communecter/cocolight-api-client 1.0.118 → 1.0.120

package/types/api/BaseEntity.d.ts

@@ -1,5 +1,6 @@
-import type { UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, GetNewsData, GetGalleryData, GlobalAutocompleteCostumData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestDatesData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetOrganizationsAdminData, GetOrganizationsNoAdminData, GetProjectsAdminData, GetProjectsNoAdminData, GetPoisAdminData, GetPoisNoAdminData, GetSubscribersData, GetBadgesData, CoformAnswersSearchData, SearchMemberAutocompleteData, GetEventsData } from "./EndpointApi.types.js";
+import type { UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, GetNewsData, GetGalleryData, GlobalAutocompleteCostumData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestDatesData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetOrganizationsAdminData, GetOrganizationsNoAdminData, GetProjectsAdminData, GetProjectsNoAdminData, GetPoisAdminData, GetPoisNoAdminData, GetSubscribersData, GetBadgesData, CoformAnswersSearchData, SearchMemberAutocompleteData, GetEventsData, CostumFilterCoformData, SearchZonesData } from "./EndpointApi.types.js";
 import type { TransformsMap } from "../types/entities.js";
+import type { ZoneItemNormalized } from "./serverDataType/Zone.js";
 /**
  * Types pour les méthodes d'entité (organization, project, poi, event, badge, news)
  * Permettent soit de récupérer une entité existante (GET), soit de créer une nouvelle instance (CREATE)
@@ -1614,6 +1615,43 @@ export declare class BaseEntity<TServerData = any> {
     coformAnswersSearch(data?: Partial<CoformAnswersSearchData>, options?: {
         restoredState?: PaginatorState;
     }): Promise<PaginatorPage<any>>;
+    /**
+     * Récupère les filtres disponibles basés sur les réponses CoForm de l'entité courante.
+     * Utilise le contexte Communecter (costumSlug, contextId, contextType) de l'entité.
+     *
+     * La réponse est un objet indexé par nom de filtre, chaque entrée contenant :
+     * - `count` : nombre de résultats par catégorie
+     * - `results` : valeurs disponibles pour ce filtre (libellé, image, etc.)
+     *
+     * @param data - Paramètres optionnels de recherche
+     * @param data.searchedData - Filtres actifs : clé → `{ label, forms, path, finderPath }`
+     * @returns Objet `Record<filterName, { count, results }>` des filtres disponibles
+     *
+     * @example
+     * const filters = await project.coformFiltersSearch({
+     *   searchedData: {
+     *     "activités": {
+     *       label: "Activités",
+     *       forms: "6486d24e9cad105cbf29a777",
+     *       path: "lesCommunsDesTierslieux...",
+     *       finderPath: "answers.lesCommunsDesTierslieux..."
+     *     }
+     *   }
+     * });
+     * filters["activités"].count; // { "Atelier": 12, "Coworking": 8 }
+     */
+    coformFiltersSearch(data?: Partial<CostumFilterCoformData>): Promise<any>;
+    /**
+     * Recherche des zones géographiques selon un pays et un niveau administratif.
+     * Utilise le contexte Communecter de l'entité courante.
+     *
+     * @param data - Paramètres de recherche
+     * @param data.countryCode - Code(s) pays ISO (ex: `["FR"]`)
+     * @param data.level - Niveau(x) administratif(s) (ex: `["1"]`)
+     * @returns Liste des zones correspondantes
+     * @throws {ApiError} Si `countryCode` ou `level` sont absents
+     */
+    searchZone(data: SearchZonesData): Promise<ZoneItemNormalized[]>;
     /**
      * ───────────────────────────────
      * Pagination restoration methods

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, 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, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData, DemoteAdminData } 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, 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, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData, CoformAnswersSearchData, CoformAnswersByIdData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData, DemoteAdminData, CostumFilterCoformData, SearchZonesData } from "./EndpointApi.types.js";
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
  */
@@ -1059,5 +1059,23 @@ export declare class EndpointApi {
      * @throws {Error} - En cas d'erreur inattendue.
      */
     demoteAdmin(data: DemoteAdminData): Promise<any>;
+    /**
+     * Filtre par reponses CoForm : Recuperer tous les filtres possibles via l'answers
+     * Constant : COSTUM_FILTER_COFORM
+     * @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.
+     */
+    costumFilterCoform(data: CostumFilterCoformData): Promise<any>;
+    /**
+     * Rechercher des zones géographiques : Rechercher des zones géographiques
+     * Constant : SEARCH_ZONES
+     * @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.
+     */
+    searchZones(data: SearchZonesData): Promise<any>;
 }
 export default EndpointApi;

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

@@ -3641,7 +3641,7 @@ export interface GlobalAutocompleteCostumData {
             /**
              * Type de la localité : 'cities' pour une ville ou 'level1' pour une région
              */
-            type: "cities" | "level1";
+            type: "cities" | "level1" | "level2" | "level3" | "level4" | "level5";
         };
     };
     /**
@@ -4550,3 +4550,55 @@ export interface DemoteAdminData {
     isAdmin: false;
     [k: string]: unknown;
 }
+export interface CostumFilterCoformData {
+    /**
+     * Données de recherche pour le filtre
+     */
+    searchedData?: {
+        [k: string]: unknown;
+    };
+    /**
+     * Slug du costume
+     */
+    costumSlug?: string;
+    /**
+     * ID du costume
+     */
+    costumId?: string;
+    /**
+     * Type du costume
+     */
+    costumType?: string;
+    [k: string]: unknown;
+}
+export interface SearchZonesData {
+    /**
+     * Code du pays pour la recherche
+     */
+    countryCode: unknown[];
+    /**
+     * Niveau de la zone géographique pour la recherche
+     */
+    level: unknown[];
+    /**
+     * Critère de tri des résultats
+     */
+    sortBy?: string;
+    /**
+     * ID du niveau supérieur pour la recherche
+     */
+    upperLevelId?: string;
+    /**
+     * Slug du costume
+     */
+    costumSlug?: string;
+    /**
+     * ID du costume
+     */
+    costumId?: string;
+    /**
+     * Type du costume
+     */
+    costumType?: string;
+    [k: string]: unknown;
+}

package/types/api/User.d.ts

@@ -318,25 +318,34 @@ export declare class User extends BaseEntity<UserItemNormalized> {
     unfollow(): Promise<unknown>;
     /**
      * Vérifie si l'utilisateur connecté est ami avec cet utilisateur.
-     *
+     * @param options - Options de vérification.
+     * @param options.silent - Si `true`, retourne `false` au lieu de lever une exception. Par défaut `true`.
      * @returns - True si l'utilisateur connecté est ami, sinon false.
      * @throws {ApiError} - Si l'utilisateur n'est pas connecté.
      */
-    isFriend(): boolean;
+    isFriend(options?: {
+        silent?: boolean;
+    }): boolean;
     /**
      * Vérifie si l'utilisateur suit l'entité.
-     *
+     * @param options - Options de vérification.
+     * @param options.silent - Si `true`, retourne `false` au lieu de lever une exception. Par défaut `true`.
      * @returns - `true` si l'utilisateur suit l'entité, `false` sinon.
      * @throws {ApiError}
      */
-    isFollower(): boolean;
+    isFollower(options?: {
+        silent?: boolean;
+    }): boolean;
     /**
      * Vérifie si l'utilisateur est abonné à l'entité.
-     *
+     * @param options - Options de vérification.
+     * @param options.silent - Si `true`, retourne `false` au lieu de lever une exception. Par défaut `true`.
      * @returns - `true` si l'utilisateur est abonné, `false` sinon.
      * @throws {ApiError}
      */
-    isFollowing(): boolean;
+    isFollowing(options?: {
+        silent?: boolean;
+    }): boolean;
     /**
      * Retourne une entité à partir d'un slug.
      * @param slug - Le slug de l'entité à récupérer.

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

@@ -0,0 +1,30 @@
+import { GeoCoordinates, GeoPosition, IdObject } from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+export interface ZoneItemNormalized {
+    _id: IdObject;
+    countryCode: string;
+    geo: GeoCoordinates;
+    geoPosition: GeoPosition;
+    level: string[];
+    name: string;
+    osmID?: string;
+    wikidataID?: string;
+    translateId: string;
+    [key: string]: unknown;
+}
+export interface ZoneItemJson {
+    id: string;
+    _id: ObjectID;
+    countryCode: string;
+    geo: GeoCoordinates;
+    geoPosition: GeoPosition;
+    level: string[];
+    name: string;
+    osmID?: string;
+    wikidataID?: string;
+    translateId: string;
+    [key: string]: unknown;
+}
+export {};