@communecter/cocolight-api-client 1.0.131 → 1.0.132

package/package.json

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

package/src/Api.ts

@@ -132,9 +132,9 @@ export default class Api {
   async user(userData: EntityData): Promise<User> {
     try {
       if (!userData.id && !userData.slug) {
-        return new User(this._client, userData, { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment, Answer, Classified, Action });
+        return new User(this._client, userData, { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment, Answer, Form, Classified, Action });
       } else {
-        const user = new User(this._client, userData, { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment, Answer, Classified, Action });
+        const user = new User(this._client, userData, { EndpointApi, Organization, Project, Event, Poi, Badge, News, Comment, Answer, Form, Classified, Action });
         await user.get();
         return user;
       }
@@ -150,7 +150,7 @@ export default class Api {
    */
   async organization(organizationData: EntityData): Promise<Organization> {
     try {
-      const organization = new Organization(this._client, organizationData, { EndpointApi, User, Project, Event, Poi, Badge, News, Comment, Answer, Classified, Action });
+      const organization = new Organization(this._client, organizationData, { EndpointApi, User, Project, Event, Poi, Badge, News, Comment, Answer, Form, Classified, Action });
       if (!organizationData.id && !organizationData.slug) {
         throw new Error("Vous devez fournir un id ou un slug pour créer une instance Organization.");
       }
@@ -167,7 +167,7 @@ export default class Api {
    */
   async project(projectData: EntityData): Promise<Project> {
     try {
-      const project = new Project(this._client, projectData, { EndpointApi, User, Organization, Event, Poi, Badge, News, Comment, Answer, Classified, Action });
+      const project = new Project(this._client, projectData, { EndpointApi, User, Organization, Event, Poi, Badge, News, Comment, Answer, Form, Classified, Action });
       if (!projectData.id && !projectData.slug) {
         throw new Error("Vous devez fournir un id ou un slug pour créer une instance Project.");
       }

package/src/ApiClient.ts

@@ -1646,7 +1646,9 @@ export default class ApiClient extends EventEmitter {
     "imageThumbPath",
     "docPath",
     "imageThumb",
-    "imageMediumPath"
+    "imageMediumPath",
+    "logo",
+    "logoMin"
   ];
 
   /**

package/src/api/Action.ts

@@ -600,4 +600,8 @@ export class Action extends BaseEntity<ActionItemNormalized> {
   private _isIsoDateTime(value: string): boolean {
     return /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?$/.test(value);
   }
+
+  override async form(): Promise<never> {
+    throw new ApiError(`form n'existe pas dans ${this.constructor.name}`, 501);
+  }
 }

package/src/api/Answer.ts

@@ -65,5 +65,8 @@ export class Answer extends BaseEntity<AnswerItemNormalized> {
     }
     throw new ApiError(`Aucune réponse trouvée pour l'ID ${this.id}`, 404);
   }
-    
+
+  override async form(): Promise<never> {
+    throw new ApiError(`form n'existe pas dans ${this.constructor.name}`, 501);
+  }
 }

package/src/api/Badge.ts

@@ -135,4 +135,9 @@ export class Badge extends BaseEntity<any> {
     throw new ApiError(`news n'existe pas dans ${this.constructor.name}`, 501);
   }
 
+
+  override async form(): Promise<never> {
+    throw new ApiError(`form n'existe pas dans ${this.constructor.name}`, 501);
+  }
+
 }

package/src/api/BaseEntity.ts

@@ -78,6 +78,7 @@ type ClassifiedInput = { id: string } | Record<string, any>;
 type BadgeInput = { id: string } | Record<string, any>;
 type NewsInput = { id: string } | Record<string, any>;
 type ActionInput = { id: string } | Record<string, any>;
+type FormInput = { id: string } | Record<string, any>;
 
 /**
  * On force le type de l'import comme une fabrique qui renvoie un objet
@@ -106,6 +107,21 @@ type Action = import("./Action.js").Action;
 type AnyEntity = User | Organization | Project | Poi | EventEntity | Badge | News | Comment | Answer | Form | Classified | Action;
 type ParentLike = BaseEntity<any> & { apiClient: ApiClient, userContext?: User | null };
 
+/**
+ * Variantes d'endpoint disponibles pour `searchCostum`.
+ * Tous les variants doivent accepter le même schéma de requête/réponse que
+ * `GLOBAL_AUTOCOMPLETE_COSTUM` (drop-in remplacement).
+ *
+ * - `default`   → `/co2/search/globalautocomplete`
+ * - `navigator-tl` → `/costum/navigator/gettl`
+ */
+export type SearchCostumVariant = "default" | "navigator-tl";
+
+const SEARCH_COSTUM_ENDPOINTS = {
+  "default": "globalAutocompleteCostum",
+  "navigator-tl": "navigatorGettl",
+} as const satisfies Record<SearchCostumVariant, keyof EndpointApi>;
+
 // Types pour les dépendances
 type EndpointApiCtor = { new(apiClient: ApiClient): EndpointApi };
 type EndpointApiDep = EndpointApi | EndpointApiCtor;
@@ -179,6 +195,9 @@ export type CostumContextFields = {
   costumSlug: string;
   contextId: string;
   contextType: EntityType;
+  // Aliases historiques lus en fallback côté backend (cf. SearchNew::getQueries).
+  costumId: string;
+  costumType: EntityType;
   sourceKey: string[];
 };
 
@@ -205,6 +224,12 @@ export type PaginatorState = {
   index: number;
   history: PaginationCursor[];
   sizes: number[];
+  /**
+   * Métadonnées libres survivant à la sérialisation JSON. Permet aux méthodes paginées
+   * de stocker des paramètres spécifiques (ex. `variant` pour `searchCostum`) qui doivent
+   * être restaurés lors d'un `restorePaginationFromJSON`.
+   */
+  meta?: Record<string, unknown>;
 };
 
 // PaginatorPage interface pour les résultats paginés
@@ -2229,6 +2254,7 @@ export class BaseEntity<TServerData = any> {
         answers: ["id"],
         classifieds: ["id"],
         actions: ["id"],
+        forms: ["id"],
       };
 
       const fetchKeys = (fetchKeysByEntity as Record<string, string[] | undefined>)[entityType];
@@ -3278,6 +3304,27 @@ export class BaseEntity<TServerData = any> {
     throw new ApiError(`action n'existe pas dans ${this.constructor.name}`, 501);
   }
 
+  /**
+   * Crée une instance de Form **dans le contexte costum de l'entité courante**.
+   *
+   * Méthode autorisée uniquement sur `Organization` et `Project` (les entités qui
+   * portent un costumContext). Les autres entités la bloquent via un override
+   * qui throw — cf. `User.form()`, `Event.form()`, `Poi.form()`, etc.
+   *
+   * @param formData - `{ id: string }` (Form n'a pas de slug)
+   * @returns Le Form, déjà fetché (`get()` est appelé par `entity()` quand `id` est fourni).
+   *
+   * @example
+   * const org = await api.organization({ slug: "navigatorDesTierslieux" });
+   * const form = await org.form({ id: "6925e2b05dd63b02ca70d6d9" });
+   * console.log(form.serverData.name);              // "Coworking"
+   * const answers = await form.getAnswers();        // utilise le costumContext de l'org
+   */
+  async form(formData: FormInput = {}): Promise<Form> {
+    const entity = await this.entity("forms", formData);
+    return entity as Form;
+  }
+
   /**
    * Récupérer les organisations d'une entitée : la liste des organisations dont l'entité est membre ou admin valide.
    * Constant : GET_ORGANIZATIONS_ADMIN | GET_ORGANIZATIONS_NO_ADMIN
@@ -4279,6 +4326,16 @@ export class BaseEntity<TServerData = any> {
 
     const hasStep = (d: PaginationCursor | null | undefined) => Boolean(d?.indexStep && d.indexStep > 0);
 
+    // searchBy "actif" = truthy non-vide (cohérent avec `!empty($post["searchBy"])` côté PHP).
+    // Couvre les 3 formes acceptées par le backend : "ALL", CSV ("name,slug"), array (["name", "slug"]).
+    // Quand actif → pagination simple indexMin/indexMax (pas de ranges multi-collection).
+    const isSearchByActive = (sb: unknown): boolean => {
+      if (sb == null) return false;
+      if (typeof sb === "string") return sb.length > 0;
+      if (Array.isArray(sb)) return sb.length > 0;
+      return false;
+    };
+
     async function getPage(isNext = false) {
       const data: PaginationCursor = { ...initialData };
 
@@ -4291,14 +4348,14 @@ export class BaseEntity<TServerData = any> {
         // hydrate data pour le premier appel
         data.countType = data.searchType;
 
-        if (!data.searchBy && hasStep(data)) {
+        if (!isSearchByActive(data.searchBy) && hasStep(data)) {
           data.ranges = Entity._generateRanges(
             data.searchType as string[],
             data.indexStep as number
           );
           data.indexMin = data.indexMin ?? 0;
           data.indexMax = data.indexMax ?? data.indexStep;
-        } else if (data.searchBy === "ALL" && hasStep(data)) {
+        } else if (isSearchByActive(data.searchBy) && hasStep(data)) {
           data.indexMin = data.indexMin ?? 0;
           data.indexMax = data.indexMax ?? data.indexStep;
         }
@@ -4311,7 +4368,7 @@ export class BaseEntity<TServerData = any> {
       if (isNext && cursor) {
         state.history.push({ ...cursor });
 
-        if (!cursor.searchBy && hasStep(cursor)) {
+        if (!isSearchByActive(cursor.searchBy) && hasStep(cursor)) {
           cursor.ranges = Entity._generateRanges(
             cursor.searchType as string[],
             cursor.indexStep as number,
@@ -4319,7 +4376,7 @@ export class BaseEntity<TServerData = any> {
           );
           cursor.indexMin = cursor.indexMax ?? 0;
           cursor.indexMax = (cursor.indexMax ?? 0) + (cursor.indexStep as number);
-        } else if (cursor.searchBy === "ALL" && hasStep(cursor)) {
+        } else if (isSearchByActive(cursor.searchBy) && hasStep(cursor)) {
           cursor.indexMin = cursor.indexMax ?? 0;
           cursor.indexMax = (cursor.indexMax ?? 0) + (cursor.indexStep as number);
         }
@@ -4410,6 +4467,10 @@ export class BaseEntity<TServerData = any> {
         costumSlug: sd.slug,
         contextId: sd.id,
         contextType: this.getEntityType(),
+        // Aliases historiques lus en fallback par le backend (cf. SearchNew::getQueries) :
+        // `$contextId = isset($post['contextId']) ? $post['contextId'] : $post['costumId']`
+        costumId: sd.id,
+        costumType: this.getEntityType(),
         sourceKey: [...inSourceKey, sd.slug] as string[]
       } as TIn & CostumContextFields;
 
@@ -4452,20 +4513,48 @@ export class BaseEntity<TServerData = any> {
    *   const nextPage = await page.next();
    *   console.log(nextPage.pageNumber, nextPage.results.length);
    * }
+   *
+   * @example
+   * // Cibler l'endpoint navigator/gettl (mêmes paramètres et même format de réponse)
+   * const page = await entity.searchCostum(
+   *   { name: "marseille", searchType: ["projects"] },
+   *   { variant: "navigator-tl" }
+   * );
    */
   async searchCostum(
     data: Partial<GlobalAutocompleteCostumData> = {},
-    options?: { restoredState?: PaginatorState }
+    options?: { restoredState?: PaginatorState; variant?: SearchCostumVariant }
   ): Promise<PaginatorPage<any>> {
+    // Le variant peut être fourni explicitement OU restauré depuis le state d'une page sérialisée.
+    // Ainsi `JSON.stringify(page) → restorePaginationFromJSON → next()` conserve l'endpoint cible.
+    const restoredVariant = (options?.restoredState?.meta?.variant as SearchCostumVariant | undefined);
+    const variant: SearchCostumVariant = options?.variant ?? restoredVariant ?? "default";
+    const endpointMethod = SEARCH_COSTUM_ENDPOINTS[variant];
+
     const paginator = this._createPaginatorEngine({
       initialData: data,
+      // Toujours "searchCostum" (la vraie méthode) — sinon `restorePaginationFromJSON`
+      // ne pourrait pas la retrouver via `entity[methodName]`. Le variant est persisté dans `state.meta`.
       methodName: "searchCostum",
       restoredState: options?.restoredState,
       finalizer: this._withCostumContext(
-        (finalData: GlobalAutocompleteCostumData) => this.endpointApi.globalAutocompleteCostum(finalData)
+        (finalData: GlobalAutocompleteCostumData) => {
+          // Les variants partagent le même schéma request/response côté backend
+          // (cf. SEARCH_COSTUM_ENDPOINTS) — cast safe.
+          const fn = this.endpointApi[endpointMethod] as typeof this.endpointApi.globalAutocompleteCostum;
+          return fn.call(this.endpointApi, finalData);
+        }
       ),
     });
-    return paginator.next() as Promise<PaginatorPage<any>>;
+
+    const page = await paginator.next() as PaginatorPage<any>;
+
+    // Persiste le variant dans le state pour qu'il survive à JSON.stringify/restore.
+    if (page._state) {
+      page._state.meta = { ...(page._state.meta || {}), variant };
+    }
+
+    return page;
   }
 
   /**

package/src/api/Classified.ts

@@ -157,6 +157,10 @@ export class Classified extends BaseEntity<ClassifiedItemNormalized> {
     throw new ApiError(`classified n'existe pas dans ${this.constructor.name}`, 501);
   }
 
+  override async form(): Promise<never> {
+    throw new ApiError(`form n'existe pas dans ${this.constructor.name}`, 501);
+  }
+
   override async follow(): Promise<never> {
     throw new ApiError(`follow n'existe pas dans ${this.constructor.name}`, 501);
   }

package/src/api/Comment.ts

@@ -249,4 +249,7 @@ export class Comment extends BaseEntity<CommentItemNormalized> {
     return await this.callIsConnected(() => this.endpointApi.addReportAbuse(payload));
   }
 
+  override async form(): Promise<never> {
+    throw new ApiError(`form n'existe pas dans ${this.constructor.name}`, 501);
+  }
 }

package/src/api/EndpointApi.ts

@@ -2,7 +2,7 @@
 import { ApiAuthenticationError } from "../error.js";
 
 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, GetCoformByIdData, CoformUploadAnswerFileData, CoformGetAnswerFilesData, SaveCoformAnswerData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData, DeleteDocumentByIdData, DemoteAdminData, CostumFilterCoformData, 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, 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, SaveCoformAnswerData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData, DeleteDocumentByIdData, DemoteAdminData, CostumFilterCoformData, 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";
 
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
@@ -1444,6 +1444,21 @@ export class EndpointApi {
     return this.call("GLOBAL_AUTOCOMPLETE_COSTUM", data);
   }
 
+  /**
+   * Navigator timeline (alias de globalautocomplete) : Recherche globale via navigator/gettl — schémas request/response identiques à GLOBAL_AUTOCOMPLETE_COSTUM
+   * Constant : NAVIGATOR_GETTL
+   * @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.
+   */
+  async navigatorGettl(data: NavigatorGettlData): Promise<any> {
+    if (!data || typeof data !== "object") {
+      throw new TypeError("Le paramètre data doit être un objet.");
+    }
+    return this.call("NAVIGATOR_GETTL", data);
+  }
+
   /**
    * Récupérer les acteurs d'événement : Récupérer les acteurs (organizers, attendees, creators, animators) d'une entité événement.
    * Constant : COSTUM_EVENT_REQUEST_ACTORS