@communecter/cocolight-api-client 1.0.158 → 1.0.159
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.
- package/dist/cocolight-api-client.browser.js +1 -1
- package/dist/cocolight-api-client.cjs +1 -1
- package/dist/cocolight-api-client.vite.mjs.js +1 -1
- package/dist/cocolight-api-client.vite.mjs.js.map +1 -1
- package/package.json +1 -1
- package/types/api/BaseEntity.d.ts +16 -0
- package/types/api/EndpointApi.d.ts +11 -1
- package/types/api/EndpointApi.types.d.ts +19 -0
- package/types/endpoints.module.d.ts +361 -3
package/package.json
CHANGED
|
@@ -1806,6 +1806,22 @@ export declare class BaseEntity<TServerData = any> {
|
|
|
1806
1806
|
results: unknown[];
|
|
1807
1807
|
fields: unknown;
|
|
1808
1808
|
}>;
|
|
1809
|
+
/**
|
|
1810
|
+
* (Dé)VALIDE un élément POUR le costum de cette entité (VALIDATE_GROUP / ValidateGroupAction). Méthode
|
|
1811
|
+
* haut niveau : `costumSlug` est dérivé du `_costumCtx` (source.key) — pas de paramètre costum à fournir.
|
|
1812
|
+
* (Dé)pose `preferences.toBeValidated[slug]` sur l'élément AVEC CASCADE sur les enfants liés
|
|
1813
|
+
* (`source.keys ∋ slug`, hors citoyens) et les classifieds `parent.<id>`.
|
|
1814
|
+
*
|
|
1815
|
+
* @param type - Collection de l'élément (organizations/projects/poi/events/citoyens…).
|
|
1816
|
+
* @param id - ID de l'élément à (dé)valider.
|
|
1817
|
+
* @param valid - `true` = valider (retire le flag) ; `false` = dévalider (repose le flag).
|
|
1818
|
+
* @returns `{ result, elt (doc mis à jour), sub (map key→write-result des enfants) }`.
|
|
1819
|
+
*/
|
|
1820
|
+
validateGroup(type: string, id: string, valid: boolean): Promise<{
|
|
1821
|
+
result: boolean;
|
|
1822
|
+
elt: unknown;
|
|
1823
|
+
sub: Record<string, unknown>;
|
|
1824
|
+
}>;
|
|
1809
1825
|
/** UUID v4 compatible browser + Node (`crypto.randomUUID()` si dispo, sinon fallback). @private */
|
|
1810
1826
|
private _uuidV4;
|
|
1811
1827
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type ApiClient from "../ApiClient.js";
|
|
2
|
-
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, 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 } from "./EndpointApi.types.js";
|
|
2
|
+
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, 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 } from "./EndpointApi.types.js";
|
|
3
3
|
/**
|
|
4
4
|
* Classe EndpointApi générée automatiquement depuis endpoints-copie.json
|
|
5
5
|
*/
|
|
@@ -1442,5 +1442,15 @@ export declare class EndpointApi {
|
|
|
1442
1442
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1443
1443
|
*/
|
|
1444
1444
|
geocodage(data: GeocodageData): Promise<any>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Valider/dévalider un élément (statut costum) : (Dé)valide un élément pour le costum courant en (dé)posant preferences.toBeValidated[slug], avec cascade sur les enfants liés (source.keys ∋ slug) et les classifieds parent.<id>. Port de ValidateGroupAction.
|
|
1447
|
+
* Constant : VALIDATE_GROUP
|
|
1448
|
+
* @param data - Données envoyées à l'API
|
|
1449
|
+
* @returns Les données de réponse.
|
|
1450
|
+
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1451
|
+
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1452
|
+
* @throws {Error} - En cas d'erreur inattendue.
|
|
1453
|
+
*/
|
|
1454
|
+
validateGroup(data: ValidateGroupData): Promise<any>;
|
|
1445
1455
|
}
|
|
1446
1456
|
export default EndpointApi;
|
|
@@ -6075,3 +6075,22 @@ export interface GeocodageData {
|
|
|
6075
6075
|
data: string;
|
|
6076
6076
|
[k: string]: unknown;
|
|
6077
6077
|
}
|
|
6078
|
+
export interface ValidateGroupData {
|
|
6079
|
+
/**
|
|
6080
|
+
* Collection de l'élément (organizations, projects, poi, events, citoyens…).
|
|
6081
|
+
*/
|
|
6082
|
+
type: string;
|
|
6083
|
+
/**
|
|
6084
|
+
* ID de l'élément à (dé)valider.
|
|
6085
|
+
*/
|
|
6086
|
+
id: string;
|
|
6087
|
+
/**
|
|
6088
|
+
* "true" = valider (unset toBeValidated) ; sinon dévalider (repose le flag).
|
|
6089
|
+
*/
|
|
6090
|
+
valid: "true" | "false";
|
|
6091
|
+
/**
|
|
6092
|
+
* Slug du costum courant (scope). Posé automatiquement par BaseEntity.validateGroup.
|
|
6093
|
+
*/
|
|
6094
|
+
costumSlug?: string;
|
|
6095
|
+
[k: string]: unknown;
|
|
6096
|
+
}
|