@communecter/cocolight-api-client 1.0.57 → 1.0.58

package/package.json

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

package/src/Api.ts

@@ -16,6 +16,7 @@ import { ApiAuthenticationError, ApiClientError, ApiError, ApiResponseError } fr
 import type ApiClient from "./ApiClient.js";
 import type { ApiClientOptions } from "./ApiClient.js";
 import type { GetElementsKeyResponse } from "./types/api-responses.js";
+import type { EntityData, EntityTypes } from "./types/entities.js";
 
 registerEntity("User", User);
 registerEntity("Organization", Organization);
@@ -29,19 +30,7 @@ registerEntity("News", News);
 registerEntity("Comment", Comment);
 registerEntity("Answer", Answer);
 
-/**
- * Union type for all possible entity types
- */
-type EntityTypes = User | Organization | Project | Event | Poi | Badge | News | Comment | Answer;
 
-/**
- * Type pour récupérer une entité existante via l'API publique.
- * Nécessite soit un id, soit un slug.
- * Les propriétés additionnelles sont autorisées mais ignorées lors de la récupération.
- */
-type EntityData =
-  | { id: string; slug?: string; [key: string]: any }
-  | { slug: string; id?: string; [key: string]: any };
 
 export default class Api {
   private _loggedUser: User | null;

package/src/api/User.ts

@@ -1,5 +1,6 @@
-import { ApiError } from "../error.js";
+import { ApiError, ApiResponseError } from "../error.js";
 import { BaseEntity } from "./BaseEntity.js";
+import { createFromCollection } from "./EntityRegistry.js";
 import { UserMixin } from "../mixin/UserMixin.js";
 
 import type { Badge } from "./Badge.js";
@@ -18,6 +19,8 @@ import type {
   GetFriendsAdminData
 } from "./EndpointApi.types.js";
 import type { Organization } from "./Organization.js";
+import type { GetElementsKeyResponse } from "@/types/api-responses.js";
+import type { EntityTypes } from "@/types/entities.js";
 
 type ApiClient = import("../ApiClient.js").default;
 type UserItemNormalized = import("./serverDataType/User.js").UserItemNormalized;
@@ -861,6 +864,44 @@ export class User extends BaseEntity<UserItemNormalized> {
     this._assertEntityType("citoyens");
     return this._isLinked("follows");
   }
+
+  /**
+   * Retourne une entité à partir d'un slug.
+   */
+  async entitySlug(slug: string): Promise<EntityTypes> {
+    if(!this.isMe){
+      throw new ApiError("Vous devez être connecté et être l'utilisateur pour créer cet entité.", 401);
+    }
+    if (!slug) {
+      throw new ApiError("slug requis", 400);
+    }
+    try {
+      const data = await this.endpointApi.getElementsKey({
+        pathParams:{
+          slug: slug
+        }
+      }) as GetElementsKeyResponse;
+  
+      if(data.contextId && data.contextType) {
+        const entity = createFromCollection(data.contextType, this, { id: data.contextId });
+        if (!entity) {
+          throw new ApiResponseError(`Le type d'entité pour le slug ${slug} n'est pas reconnu`, 200, data as object);
+        }
+        await entity.get();
+        // On sait que c'est l'un des types concrets → on caste
+        return entity as EntityTypes;
+      } else {
+        throw new ApiResponseError(`Le slug ${slug} n'est pas valide`, 200, data as object);
+      }
+    } catch (error) {
+      if(error instanceof ApiResponseError) {
+        throw new ApiResponseError(`Impossible de récupérer l'identifiant pour le slug ${slug}`, error.status, error.responseData);
+      } else {
+        throw error;
+      }
+    }
+  
+  }
 }
 
 // Incorporation des mixins dans User

package/src/index.ts

@@ -69,11 +69,17 @@ export type { Event } from "./api/Event.js";
 export type { Poi } from "./api/Poi.js";
 export type { Badge } from "./api/Badge.js";
 export type { News } from "./api/News.js";
+export type { Comment } from "./api/Comment.js";
+export type { Answer } from "./api/Answer.js";
 
 // Types ServerData (données normalisées reçues du serveur)
 export type * from "./api/serverDataType/User.js";
 export type * from "./api/serverDataType/Organization.js";
 export type * from "./api/serverDataType/Project.js";
+export type * from "./api/serverDataType/Event.js";
+export type * from "./api/serverDataType/News.js";
+export type * from "./api/serverDataType/Comment.js";
+export type * from "./api/serverDataType/Answer.js";
 export type * from "./api/serverDataType/common.js";
 
 // Types utilitaires

package/src/types/entities.ts

@@ -1,5 +1,29 @@
 // types/entities.ts - Types partagés pour éviter les dépendances circulaires
 
+import type { Answer } from "../api/Answer.js";
+import type { Badge } from "../api/Badge.js";
+import type { Comment } from "../api/Comment.js";
+import type { Event } from "../api/Event.js";
+import type { News } from "../api/News.js";
+import type { Organization } from "../api/Organization.js";
+import type { Poi } from "../api/Poi.js";
+import type { Project } from "../api/Project.js";
+import type { User } from "../api/User.js";
+
+/**
+ * Union type for all possible entity types
+ */
+export type EntityTypes = User | Organization | Project | Event | Poi | Badge | News | Comment | Answer;
+
+/**
+ * Type pour récupérer une entité existante via l'API publique.
+ * Nécessite soit un id, soit un slug.
+ * Les propriétés additionnelles sont autorisées mais ignorées lors de la récupération.
+ */
+export type EntityData =
+  | { id: string; slug?: string; [key: string]: any }
+  | { slug: string; id?: string; [key: string]: any };
+
 /**
  * Types de collection possibles
  */

package/types/Api.d.ts

@@ -1,34 +1,13 @@
 import { Answer } from "./api/Answer.js";
-import { Badge } from "./api/Badge.js";
-import { Comment } from "./api/Comment.js";
 import EndpointApi from "./api/EndpointApi.js";
 import { Event } from "./api/Event.js";
-import { News } from "./api/News.js";
 import { Organization } from "./api/Organization.js";
-import { Poi } from "./api/Poi.js";
 import { Project } from "./api/Project.js";
 import { User } from "./api/User.js";
 import { UserApi } from "./api/UserApi.js";
 import type ApiClient from "./ApiClient.js";
 import type { ApiClientOptions } from "./ApiClient.js";
-/**
- * Union type for all possible entity types
- */
-type EntityTypes = User | Organization | Project | Event | Poi | Badge | News | Comment | Answer;
-/**
- * Type pour récupérer une entité existante via l'API publique.
- * Nécessite soit un id, soit un slug.
- * Les propriétés additionnelles sont autorisées mais ignorées lors de la récupération.
- */
-type EntityData = {
-    id: string;
-    slug?: string;
-    [key: string]: any;
-} | {
-    slug: string;
-    id?: string;
-    [key: string]: any;
-};
+import type { EntityData, EntityTypes } from "./types/entities.js";
 export default class Api {
     private _loggedUser;
     private _client;
@@ -91,4 +70,3 @@ export default class Api {
      */
     logout(): void;
 }
-export {};

package/types/api/Organization.d.ts

@@ -7,7 +7,7 @@ export declare class Organization extends BaseEntity<OrganizationItemNormalized>
     static entityType: string;
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_ORGANIZATION", "addOrganization" | "updateImageProfil">;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_ORGANIZATION", "updateImageProfil" | "addOrganization">;
     static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];

package/types/api/Project.d.ts

@@ -9,7 +9,7 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
     static entityType: string;
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_PROJECT", "updateImageProfil" | "addProject">;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_PROJECT", "addProject" | "updateImageProfil">;
     static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];

package/types/api/User.d.ts

@@ -3,6 +3,7 @@ import type { Badge } from "./Badge.js";
 import type { PaginatorPage } from "./BaseEntity.js";
 import type { ChangePasswordData, DeleteAccountData, GetSubscriptionsAdminData, GetSubscriptionsData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetFriendsAdminData } from "./EndpointApi.types.js";
 import type { Organization } from "./Organization.js";
+import type { EntityTypes } from "@/types/entities.js";
 type ApiClient = import("../ApiClient.js").default;
 type UserItemNormalized = import("./serverDataType/User.js").UserItemNormalized;
 export declare class User extends BaseEntity<UserItemNormalized> {
@@ -328,5 +329,9 @@ export declare class User extends BaseEntity<UserItemNormalized> {
      * @throws {ApiError}
      */
     isFollowing(): boolean;
+    /**
+     * Retourne une entité à partir d'un slug.
+     */
+    entitySlug(slug: string): Promise<EntityTypes>;
 }
 export {};

package/types/index.d.ts

@@ -50,9 +50,15 @@ export type { Event } from "./api/Event.js";
 export type { Poi } from "./api/Poi.js";
 export type { Badge } from "./api/Badge.js";
 export type { News } from "./api/News.js";
+export type { Comment } from "./api/Comment.js";
+export type { Answer } from "./api/Answer.js";
 export type * from "./api/serverDataType/User.js";
 export type * from "./api/serverDataType/Organization.js";
 export type * from "./api/serverDataType/Project.js";
+export type * from "./api/serverDataType/Event.js";
+export type * from "./api/serverDataType/News.js";
+export type * from "./api/serverDataType/Comment.js";
+export type * from "./api/serverDataType/Answer.js";
 export type * from "./api/serverDataType/common.js";
 export type { PaginatorPage } from "./api/BaseEntity.js";
 export type * from "./types/index.js";

package/types/types/entities.d.ts

@@ -1,3 +1,30 @@
+import type { Answer } from "../api/Answer.js";
+import type { Badge } from "../api/Badge.js";
+import type { Comment } from "../api/Comment.js";
+import type { Event } from "../api/Event.js";
+import type { News } from "../api/News.js";
+import type { Organization } from "../api/Organization.js";
+import type { Poi } from "../api/Poi.js";
+import type { Project } from "../api/Project.js";
+import type { User } from "../api/User.js";
+/**
+ * Union type for all possible entity types
+ */
+export type EntityTypes = User | Organization | Project | Event | Poi | Badge | News | Comment | Answer;
+/**
+ * Type pour récupérer une entité existante via l'API publique.
+ * Nécessite soit un id, soit un slug.
+ * Les propriétés additionnelles sont autorisées mais ignorées lors de la récupération.
+ */
+export type EntityData = {
+    id: string;
+    slug?: string;
+    [key: string]: any;
+} | {
+    slug: string;
+    id?: string;
+    [key: string]: any;
+};
 /**
  * Types de collection possibles
  */