@communecter/cocolight-api-client 1.0.81 → 1.0.83
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 +2 -2
- 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 +57 -24
- package/src/api/User.ts +128 -117
- package/types/api/BaseEntity.d.ts +33 -1
- package/types/api/User.d.ts +30 -25
package/types/api/User.d.ts
CHANGED
|
@@ -342,17 +342,30 @@ export declare class User extends BaseEntity<UserItemNormalized> {
|
|
|
342
342
|
*/
|
|
343
343
|
entityBySlug(slug: string): Promise<EntityTypes>;
|
|
344
344
|
/**
|
|
345
|
-
* Valide les préconditions
|
|
345
|
+
* Valide les préconditions pour les méthodes nécessitant d'être membre.
|
|
346
|
+
* @private
|
|
347
|
+
* @param methodName - Nom de la méthode appelante (pour les messages d'erreur).
|
|
348
|
+
* @param expectedTypes - Types d'entité parent autorisés.
|
|
349
|
+
* @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
|
|
350
|
+
* @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré.
|
|
351
|
+
* @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée.
|
|
352
|
+
* @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas membre de l'entité parente.
|
|
353
|
+
* @throws {ApiError} 400 - Si le type d'entité parent n'est pas valide.
|
|
354
|
+
*/
|
|
355
|
+
private _validateMemberPreconditions;
|
|
356
|
+
/**
|
|
357
|
+
* Valide les préconditions pour les méthodes nécessitant d'être administrateur.
|
|
346
358
|
* @private
|
|
347
359
|
* @param methodName - Nom de la méthode appelante (pour les messages d'erreur).
|
|
348
360
|
* @param expectedTypes - Types d'entité parent autorisés.
|
|
349
361
|
* @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
|
|
350
|
-
* @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
|
|
351
362
|
* @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré.
|
|
352
363
|
* @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée.
|
|
364
|
+
* @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas membre de l'entité parente.
|
|
365
|
+
* @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
|
|
353
366
|
* @throws {ApiError} 400 - Si le type d'entité parent n'est pas valide.
|
|
354
367
|
*/
|
|
355
|
-
private
|
|
368
|
+
private _validateAdminPreconditions;
|
|
356
369
|
/**
|
|
357
370
|
* Récupère le lien parent pour l'utilisateur actuel.
|
|
358
371
|
*
|
|
@@ -360,6 +373,11 @@ export declare class User extends BaseEntity<UserItemNormalized> {
|
|
|
360
373
|
* @private
|
|
361
374
|
*/
|
|
362
375
|
private _getParentLinkForUser;
|
|
376
|
+
/**
|
|
377
|
+
* Rafraîchit l'utilisateur et l'entité parente après une action.
|
|
378
|
+
* @private
|
|
379
|
+
*/
|
|
380
|
+
private _refreshWithParent;
|
|
363
381
|
/**
|
|
364
382
|
* Vérifie si l'utilisateur est administrateur de l'entité parente.
|
|
365
383
|
*
|
|
@@ -562,6 +580,8 @@ export declare class User extends BaseEntity<UserItemNormalized> {
|
|
|
562
580
|
* vers l'organisation ou le projet parent. Si l'utilisateur n'a pas encore de lien,
|
|
563
581
|
* une demande de connexion est créée.
|
|
564
582
|
*
|
|
583
|
+
* @param {Object} [options] - Options de la méthode
|
|
584
|
+
* @param {boolean} [options.admin=false] - Si true, utilise "admin" comme connectType au lieu du type par défaut (connectTypeConnect)
|
|
565
585
|
* @returns {Promise<unknown>} La réponse de l'API après création de la demande
|
|
566
586
|
* @throws {ApiError} Si l'utilisateur n'est pas connecté, pas admin, ou si le parent n'est pas défini
|
|
567
587
|
* @throws {ApiError} Si l'utilisateur est déjà en attente de validation
|
|
@@ -569,14 +589,19 @@ export declare class User extends BaseEntity<UserItemNormalized> {
|
|
|
569
589
|
*
|
|
570
590
|
* @example
|
|
571
591
|
* ```typescript
|
|
572
|
-
* // Un admin récupère les membres et envoie une invitation
|
|
592
|
+
* // Un admin récupère les membres et envoie une invitation (type par défaut)
|
|
573
593
|
* const org = await me.organization({ slug: "myOrg" });
|
|
574
594
|
* const users = await org.getMembers();
|
|
575
595
|
* const user = users.results[0];
|
|
576
596
|
* await user.sendRequestToJoinParent();
|
|
597
|
+
*
|
|
598
|
+
* // Avec le type admin explicite
|
|
599
|
+
* await user.sendRequestToJoinParent({ admin: true });
|
|
577
600
|
* ```
|
|
578
601
|
*/
|
|
579
|
-
sendRequestToJoinParent(
|
|
602
|
+
sendRequestToJoinParent({ admin }?: {
|
|
603
|
+
admin: boolean;
|
|
604
|
+
}): Promise<unknown>;
|
|
580
605
|
/**
|
|
581
606
|
* Valide une demande de membre en attente de validation.
|
|
582
607
|
*
|
|
@@ -598,26 +623,6 @@ export declare class User extends BaseEntity<UserItemNormalized> {
|
|
|
598
623
|
* ```
|
|
599
624
|
*/
|
|
600
625
|
validateMemberRequest(): Promise<unknown>;
|
|
601
|
-
/**
|
|
602
|
-
* Valide une invitation en attente d'acceptation.
|
|
603
|
-
*
|
|
604
|
-
* Cette méthode permet à un admin de valider une invitation envoyée à un utilisateur
|
|
605
|
-
* qui est en attente (`isInviting: true`). Après validation, l'utilisateur devient
|
|
606
|
-
* membre actif de l'entité parente.
|
|
607
|
-
*
|
|
608
|
-
* @returns {Promise<unknown>} La réponse de l'API après validation
|
|
609
|
-
* @throws {ApiError} Si l'utilisateur n'est pas connecté, pas admin, ou si le parent n'est pas défini
|
|
610
|
-
* @throws {ApiError} Si l'utilisateur n'a pas d'invitation en attente
|
|
611
|
-
*
|
|
612
|
-
* @example
|
|
613
|
-
* ```typescript
|
|
614
|
-
* // Un admin valide une invitation en attente
|
|
615
|
-
* const org = await me.organization({ slug: "myOrg" });
|
|
616
|
-
* const members = await org.getMembers();
|
|
617
|
-
* const invitedUser = members.results.find(u => u.serverData.links?.memberOf?.[org.id]?.isInviting);
|
|
618
|
-
* await invitedUser.validateInvitation();
|
|
619
|
-
* ```
|
|
620
|
-
*/
|
|
621
626
|
/**
|
|
622
627
|
* Valide une demande d'admin en attente.
|
|
623
628
|
*
|