@communecter/cocolight-api-client 1.0.131 → 1.0.132

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist/cocolight-api-client.browser.js +3 -3
  2. package/dist/cocolight-api-client.cjs +1 -1
  3. package/dist/cocolight-api-client.mjs.js +1 -1
  4. package/dist/cocolight-api-client.vite.mjs.js +1 -1
  5. package/dist/cocolight-api-client.vite.mjs.js.map +1 -1
  6. package/package.json +1 -1
  7. package/src/Api.ts +4 -4
  8. package/src/ApiClient.ts +3 -1
  9. package/src/api/Action.ts +4 -0
  10. package/src/api/Answer.ts +4 -1
  11. package/src/api/Badge.ts +5 -0
  12. package/src/api/BaseEntity.ts +96 -7
  13. package/src/api/Classified.ts +4 -0
  14. package/src/api/Comment.ts +3 -0
  15. package/src/api/EndpointApi.ts +16 -1
  16. package/src/api/EndpointApi.types.ts +375 -44
  17. package/src/api/Event.ts +5 -0
  18. package/src/api/Form.ts +64 -2
  19. package/src/api/News.ts +3 -0
  20. package/src/api/Organization.ts +44 -2
  21. package/src/api/Poi.ts +4 -0
  22. package/src/api/Project.ts +47 -0
  23. package/src/api/User.ts +10 -0
  24. package/src/api/serverDataType/Answer.ts +25 -0
  25. package/src/api/serverDataType/Form.ts +84 -4
  26. package/src/api/serverDataType/Organization.ts +13 -0
  27. package/src/api/serverDataType/Project.ts +15 -0
  28. package/src/endpoints.module.ts +1185 -208
  29. package/types/api/Action.d.ts +1 -0
  30. package/types/api/Answer.d.ts +1 -0
  31. package/types/api/Badge.d.ts +1 -0
  32. package/types/api/BaseEntity.d.ts +45 -0
  33. package/types/api/Classified.d.ts +1 -0
  34. package/types/api/Comment.d.ts +1 -0
  35. package/types/api/EndpointApi.d.ts +10 -1
  36. package/types/api/EndpointApi.types.d.ts +334 -41
  37. package/types/api/Event.d.ts +1 -0
  38. package/types/api/Form.d.ts +34 -0
  39. package/types/api/News.d.ts +1 -0
  40. package/types/api/Organization.d.ts +20 -1
  41. package/types/api/Poi.d.ts +1 -0
  42. package/types/api/Project.d.ts +21 -0
  43. package/types/api/User.d.ts +7 -0
  44. package/types/api/serverDataType/Answer.d.ts +22 -0
  45. package/types/api/serverDataType/Form.d.ts +89 -4
  46. package/types/api/serverDataType/Organization.d.ts +13 -0
  47. package/types/api/serverDataType/Project.d.ts +15 -0
  48. package/types/endpoints.module.d.ts +1222 -1005
@@ -297,4 +297,5 @@ export declare class Action extends BaseEntity<ActionItemNormalized> {
297
297
  * Vérifie un format ISO 8601 date-time strict (avec T et option timezone Z ou ±HH:MM).
298
298
  */
299
299
  private _isIsoDateTime;
300
+ form(): Promise<never>;
300
301
  }
@@ -20,4 +20,5 @@ export declare class Answer extends BaseEntity<AnswerItemNormalized> {
20
20
  * Constant : COFORM_ANSWERS_BY_ID
21
21
  */
22
22
  get(): Promise<Record<string, any>>;
23
+ form(): Promise<never>;
23
24
  }
@@ -21,4 +21,5 @@ export declare class Badge extends BaseEntity<any> {
21
21
  event(): Promise<never>;
22
22
  badge(): Promise<never>;
23
23
  news(): Promise<never>;
24
+ form(): Promise<never>;
24
25
  }
@@ -38,6 +38,9 @@ type NewsInput = {
38
38
  type ActionInput = {
39
39
  id: string;
40
40
  } | Record<string, any>;
41
+ type FormInput = {
42
+ id: string;
43
+ } | Record<string, any>;
41
44
  type ApiClient = import("../ApiClient.js").default;
42
45
  type EndpointApi = import("./EndpointApi.js").default;
43
46
  type User = import("./User.js").User;
@@ -57,6 +60,15 @@ type ParentLike = BaseEntity<any> & {
57
60
  apiClient: ApiClient;
58
61
  userContext?: User | null;
59
62
  };
63
+ /**
64
+ * Variantes d'endpoint disponibles pour `searchCostum`.
65
+ * Tous les variants doivent accepter le même schéma de requête/réponse que
66
+ * `GLOBAL_AUTOCOMPLETE_COSTUM` (drop-in remplacement).
67
+ *
68
+ * - `default` → `/co2/search/globalautocomplete`
69
+ * - `navigator-tl` → `/costum/navigator/gettl`
70
+ */
71
+ export type SearchCostumVariant = "default" | "navigator-tl";
60
72
  type EndpointApiCtor = {
61
73
  new (apiClient: ApiClient): EndpointApi;
62
74
  };
@@ -118,6 +130,8 @@ export type CostumContextFields = {
118
130
  costumSlug: string;
119
131
  contextId: string;
120
132
  contextType: EntityType;
133
+ costumId: string;
134
+ costumType: EntityType;
121
135
  sourceKey: string[];
122
136
  };
123
137
  export type WithCostumContext<T> = T & CostumContextFields;
@@ -143,6 +157,12 @@ export type PaginatorState = {
143
157
  index: number;
144
158
  history: PaginationCursor[];
145
159
  sizes: number[];
160
+ /**
161
+ * Métadonnées libres survivant à la sérialisation JSON. Permet aux méthodes paginées
162
+ * de stocker des paramètres spécifiques (ex. `variant` pour `searchCostum`) qui doivent
163
+ * être restaurés lors d'un `restorePaginationFromJSON`.
164
+ */
165
+ meta?: Record<string, unknown>;
146
166
  };
147
167
  export interface PaginatorPage<T> {
148
168
  count: {
@@ -1158,6 +1178,23 @@ export declare class BaseEntity<TServerData = any> {
1158
1178
  * @throws {ApiError} Sur les entités non supportées.
1159
1179
  */
1160
1180
  action(_actionData?: ActionInput): Promise<Action>;
1181
+ /**
1182
+ * Crée une instance de Form **dans le contexte costum de l'entité courante**.
1183
+ *
1184
+ * Méthode autorisée uniquement sur `Organization` et `Project` (les entités qui
1185
+ * portent un costumContext). Les autres entités la bloquent via un override
1186
+ * qui throw — cf. `User.form()`, `Event.form()`, `Poi.form()`, etc.
1187
+ *
1188
+ * @param formData - `{ id: string }` (Form n'a pas de slug)
1189
+ * @returns Le Form, déjà fetché (`get()` est appelé par `entity()` quand `id` est fourni).
1190
+ *
1191
+ * @example
1192
+ * const org = await api.organization({ slug: "navigatorDesTierslieux" });
1193
+ * const form = await org.form({ id: "6925e2b05dd63b02ca70d6d9" });
1194
+ * console.log(form.serverData.name); // "Coworking"
1195
+ * const answers = await form.getAnswers(); // utilise le costumContext de l'org
1196
+ */
1197
+ form(formData?: FormInput): Promise<Form>;
1161
1198
  /**
1162
1199
  * Récupérer les organisations d'une entitée : la liste des organisations dont l'entité est membre ou admin valide.
1163
1200
  * Constant : GET_ORGANIZATIONS_ADMIN | GET_ORGANIZATIONS_NO_ADMIN
@@ -1600,9 +1637,17 @@ export declare class BaseEntity<TServerData = any> {
1600
1637
  * const nextPage = await page.next();
1601
1638
  * console.log(nextPage.pageNumber, nextPage.results.length);
1602
1639
  * }
1640
+ *
1641
+ * @example
1642
+ * // Cibler l'endpoint navigator/gettl (mêmes paramètres et même format de réponse)
1643
+ * const page = await entity.searchCostum(
1644
+ * { name: "marseille", searchType: ["projects"] },
1645
+ * { variant: "navigator-tl" }
1646
+ * );
1603
1647
  */
1604
1648
  searchCostum(data?: Partial<GlobalAutocompleteCostumData>, options?: {
1605
1649
  restoredState?: PaginatorState;
1650
+ variant?: SearchCostumVariant;
1606
1651
  }): Promise<PaginatorPage<any>>;
1607
1652
  /**
1608
1653
  * @param data
@@ -24,6 +24,7 @@ export declare class Classified extends BaseEntity<ClassifiedItemNormalized> {
24
24
  badge(): Promise<never>;
25
25
  news(): Promise<never>;
26
26
  classified(): Promise<never>;
27
+ form(): Promise<never>;
27
28
  follow(): Promise<never>;
28
29
  unfollow(): Promise<never>;
29
30
  getGallery(): Promise<never>;
@@ -54,4 +54,5 @@ export declare class Comment extends BaseEntity<CommentItemNormalized> {
54
54
  reason: string;
55
55
  comment?: string;
56
56
  }): Promise<unknown>;
57
+ form(): Promise<never>;
57
58
  }
@@ -1,5 +1,5 @@
1
1
  import type ApiClient from "../ApiClient.js";
2
- 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";
2
+ 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";
3
3
  /**
4
4
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
5
5
  */
@@ -891,6 +891,15 @@ export declare class EndpointApi {
891
891
  * @throws {Error} - En cas d'erreur inattendue.
892
892
  */
893
893
  globalAutocompleteCostum(data: GlobalAutocompleteCostumData): Promise<any>;
894
+ /**
895
+ * Navigator timeline (alias de globalautocomplete) : Recherche globale via navigator/gettl — schémas request/response identiques à GLOBAL_AUTOCOMPLETE_COSTUM
896
+ * Constant : NAVIGATOR_GETTL
897
+ * @param data - Données envoyées à l'API
898
+ * @returns Les données de réponse.
899
+ * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
900
+ * @throws {Error} - En cas d'erreur inattendue.
901
+ */
902
+ navigatorGettl(data: NavigatorGettlData): Promise<any>;
894
903
  /**
895
904
  * Récupérer les acteurs d'événement : Récupérer les acteurs (organizers, attendees, creators, animators) d'une entité événement.
896
905
  * Constant : COSTUM_EVENT_REQUEST_ACTORS