@communecter/cocolight-api-client 1.0.154 → 1.0.155
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.mjs.js +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/src/api/BaseEntity.ts +46 -0
- package/src/api/EndpointApi.ts +5 -5
- package/src/api/EndpointApi.types.ts +3 -3
- package/src/endpoints.module.ts +1 -1
- package/types/api/BaseEntity.d.ts +22 -0
- package/types/api/EndpointApi.d.ts +4 -4
- package/types/api/EndpointApi.types.d.ts +3 -3
|
@@ -1709,6 +1709,28 @@ export declare class BaseEntity<TServerData = any> {
|
|
|
1709
1709
|
* @throws {ApiError} - Si l'utilisateur n'est pas connecté ou si l'entité n'est pas enregistrée.
|
|
1710
1710
|
*/
|
|
1711
1711
|
unfollow(): Promise<unknown>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Invite des personnes PAR EMAIL à rejoindre CETTE entité (organisation, projet ou événement).
|
|
1714
|
+
*
|
|
1715
|
+
* Méthode de haut niveau à PRÉFÉRER à un appel direct `endpointApi.inviteMembers`.
|
|
1716
|
+
* Wrappe INVITE_MEMBERS (POST /co2/link/multiconnect, `listInvite.invites`) : le backend
|
|
1717
|
+
* crée un citoyen « pending » par email puis envoie un mail d'invitation. Les clés des
|
|
1718
|
+
* invités sont des UUID v4 générés ici (le contrat l'exige).
|
|
1719
|
+
*
|
|
1720
|
+
* @param invites - Liste d'invités `{ name, mail, msg?, isAdmin?, roles? }` (clé `mail`,
|
|
1721
|
+
* comme le legacy `Link::invite` ; `isAdmin:"admin"` pour inviter en admin).
|
|
1722
|
+
* @returns Réponse de l'API (par invité : citoyens/invites/organizations).
|
|
1723
|
+
* @throws {ApiError} Si l'entité n'a pas d'id, n'est pas une orga/projet/événement, ou liste vide.
|
|
1724
|
+
*/
|
|
1725
|
+
inviteByEmail(invites: Array<{
|
|
1726
|
+
name: string;
|
|
1727
|
+
mail: string;
|
|
1728
|
+
msg?: string;
|
|
1729
|
+
isAdmin?: "" | "admin";
|
|
1730
|
+
roles?: string[];
|
|
1731
|
+
}>): Promise<unknown>;
|
|
1732
|
+
/** UUID v4 compatible browser + Node (`crypto.randomUUID()` si dispo, sinon fallback). @private */
|
|
1733
|
+
private _uuidV4;
|
|
1712
1734
|
/**
|
|
1713
1735
|
* Vérifie si l'utilisateur est connecté et a accès à l'entité.
|
|
1714
1736
|
*
|
|
@@ -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,
|
|
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, 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 } from "./EndpointApi.types.js";
|
|
3
3
|
/**
|
|
4
4
|
* Classe EndpointApi générée automatiquement depuis endpoints-copie.json
|
|
5
5
|
*/
|
|
@@ -863,15 +863,15 @@ export declare class EndpointApi {
|
|
|
863
863
|
*/
|
|
864
864
|
shareEvents(data: ShareEventsData): Promise<any>;
|
|
865
865
|
/**
|
|
866
|
-
* Inviter des
|
|
867
|
-
* Constant :
|
|
866
|
+
* Inviter des personnes (organisation / projet / événement) : Invite des personnes à rejoindre une organisation, un projet ou un événement : nouvelles par email (`listInvite.invites` → crée des comptes citoyens « pending » + mail d'invitation) ou existantes par id (`listInvite.citoyens`/`organizations`). Membre / contributeur / participant selon le parent ; `isAdmin:"admin"` pour inviter en admin. Port de Link::invite (multiconnect).
|
|
867
|
+
* Constant : INVITE_MEMBERS
|
|
868
868
|
* @param data - Données envoyées à l'API
|
|
869
869
|
* @returns Les données de réponse.
|
|
870
870
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
871
871
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
872
872
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
873
873
|
*/
|
|
874
|
-
|
|
874
|
+
inviteMembers(data: InviteMembersData): Promise<any>;
|
|
875
875
|
/**
|
|
876
876
|
* Suivre un utilisateur ou un élément : Suivre un utilisateur ou un élément.
|
|
877
877
|
* Constant : FOLLOW
|
|
@@ -430,7 +430,7 @@ export interface MulticonnectData {
|
|
|
430
430
|
/**
|
|
431
431
|
* Type de l'entité parente
|
|
432
432
|
*/
|
|
433
|
-
parentType: "citoyens" | "projects" | "organizations";
|
|
433
|
+
parentType: "citoyens" | "projects" | "organizations" | "events";
|
|
434
434
|
/**
|
|
435
435
|
* Liste des citoyens invités
|
|
436
436
|
*/
|
|
@@ -3830,7 +3830,7 @@ export interface ShareEventsData {
|
|
|
3830
3830
|
comment?: string;
|
|
3831
3831
|
[k: string]: unknown;
|
|
3832
3832
|
}
|
|
3833
|
-
export interface
|
|
3833
|
+
export interface InviteMembersData {
|
|
3834
3834
|
/**
|
|
3835
3835
|
* ID de l'entité parente
|
|
3836
3836
|
*/
|
|
@@ -3838,7 +3838,7 @@ export interface InviteEventData {
|
|
|
3838
3838
|
/**
|
|
3839
3839
|
* Type de l'entité parente
|
|
3840
3840
|
*/
|
|
3841
|
-
parentType: "citoyens" | "projects" | "organizations";
|
|
3841
|
+
parentType: "citoyens" | "projects" | "organizations" | "events";
|
|
3842
3842
|
/**
|
|
3843
3843
|
* Liste des citoyens invités
|
|
3844
3844
|
*/
|