@communecter/cocolight-api-client 1.0.96 → 1.0.98

package/package.json

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

package/src/Api.ts

@@ -190,6 +190,23 @@ export default class Api {
     }
   }
 
+  /**
+   * Creates a new Poi instance and optionally retrieves its profile.
+   */
+  async poi(poiData: EntityData): Promise<Poi> {
+    try {
+      const poi = new Poi(this._client, poiData, { EndpointApi, User, Organization, Project, Poi, Badge, News, Comment });
+      if (!poiData.id && !poiData.slug) {
+        throw new Error("Vous devez fournir un id ou un slug pour créer une instance Poi.");
+      }
+      await poi.get();
+      return poi;
+    } catch (error) {
+      console.error("[Api.poi] Erreur lors de la création d'un objet poi :", (error as Error).message);
+      throw error;
+    }
+  }
+
   /**
    * Creates a new Answer instance and optionally retrieves answer data.
    */

package/src/api/EntityRegistry.ts

@@ -120,7 +120,7 @@ function _getEntityMeta(entityType: CollectionKey, __entityTag: EntityTag): Enti
     organizations:{ entityClass: commonDeps.Organization as EntityClass, deps: commonDeps },
     projects:     { entityClass: commonDeps.Project as EntityClass,      deps: commonDeps },
     events:       { entityClass: commonDeps.Event as EntityClass,        deps: { ...commonDeps, Badge: undefined } },
-    poi:          { entityClass: commonDeps.Poi as EntityClass,          deps: { ...commonDeps, Badge: undefined, News: undefined } },
+    poi:          { entityClass: commonDeps.Poi as EntityClass,          deps: { ...commonDeps, Badge: undefined, News: undefined, Comment: undefined } },
     news:         { entityClass: commonDeps.News as EntityClass,         deps: { ...commonDeps } },
     badges:       { entityClass: commonDeps.Badge as EntityClass,        deps: { 
       EndpointApi: commonDeps.EndpointApi, 
@@ -163,7 +163,7 @@ export function createFromCollection(collection: CollectionKey, parent: ApiClien
     },
     poi: {
       entityTag: "Poi",
-      meta: tag => _buildMeta(tag, { remove: ["Badge","News"] })
+      meta: tag => _buildMeta(tag, { remove: ["Badge","News","Comments"] })
     },
     news: {
       entityTag: "News",

package/src/api/Poi.ts

@@ -1,9 +1,10 @@
 import { ApiError } from "../error.js";
 import { BaseEntity } from "./BaseEntity.js";
+import { PoiItemNormalized } from "./serverDataType/Poi.js";
 
 import type { AddPoiData } from "./EndpointApi.types.js";
 
-export class Poi extends BaseEntity<any> {
+export class Poi extends BaseEntity<PoiItemNormalized> {
   static override entityType = "poi";
 
   static override entityTag = "Poi";
@@ -133,16 +134,20 @@ export class Poi extends BaseEntity<any> {
    *
    * Récupère les actualités du POI.
    */
-  override async getNews(data: Parameters<BaseEntity<any>["getNews"]>[0] = {}) {
-    return super.getNews(data);
+  // override async getNews(data: Parameters<BaseEntity<PoiItemNormalized>["getNews"]>[0] = {}) {
+  //   return super.getNews(data);
+  // }
+  override async getNews(): Promise<never> {
+    throw new ApiError(`getNews n'existe pas dans ${this.constructor.name}`, 501);
   }
 
+
   /**
    * {@inheritDoc BaseEntity#getSubscribers}
    *
    * Récupère les abonnés du POI.
    */
-  override async getSubscribers(data: Parameters<BaseEntity<any>["getSubscribers"]>[0] = {}) {
+  override async getSubscribers(data: Parameters<BaseEntity<PoiItemNormalized>["getSubscribers"]>[0] = {}) {
     return super.getSubscribers(data);
   }
 
@@ -167,8 +172,11 @@ export class Poi extends BaseEntity<any> {
    *
    * Crée une instance de news et la récupère si nécessaire.
    */
-  override async news(newsData: Parameters<BaseEntity<any>["news"]>[0] = {}) {
-    return super.news(newsData);
+  // override async news(newsData: Parameters<BaseEntity<PoiItemNormalized>["news"]>[0] = {}) {
+  //   return super.news(newsData);
+  // }
+  override async news(): Promise<never> {
+    throw new ApiError(`news n'existe pas dans ${this.constructor.name}`, 501);
   }
 
   /**

package/src/api/serverDataType/Poi.ts

@@ -0,0 +1,75 @@
+import type {
+  GeoCoordinates,
+  GeoPosition,
+  IdObject,
+  ParentsMap,
+  PostalAddress,
+  DateValue
+} from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+
+/**
+ * Types de poi supportés
+ */
+export const POI_TYPES = [
+  "link", "tool", "machine", "software", "rh",
+  "Resource material", "Financial Ressource", "ficheBlanche",
+  "geoJson", "compostPickup", "video", "sharedLibrary",
+  "recoveryCenter", "trash", "history", "something2See",
+  "funPlace", "place", "artPiece", "streetArts",
+  "openScene", "stand", "parking", "other"
+] as const;
+
+export type PoiType = (typeof POI_TYPES)[number];
+
+export interface PoiItemJson {
+  _id: IdObject;
+  collection: "poi";
+  name: string;
+  type: PoiType;
+  created?: DateValue;
+  updated?: DateValue;
+  modified?: DateValue;
+  parent?: ParentsMap;
+  description?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  urls?: string[];
+  creator?: string;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  [key: string]: unknown;
+}
+
+export interface PoiItemNormalized {
+  id: string;
+  _id: ObjectID;
+  collection: "poi";
+  name: string;
+  type: PoiType;
+  created?: Date;
+  updated?: Date;
+  modified?: Date;
+  parent?: ParentsMap;
+  description?: string;
+  slug?: string;
+  address?: PostalAddress;
+  geo?: GeoCoordinates;
+  geoPosition?: GeoPosition;
+  tags?: string[];
+  urls?: string[];
+  creator?: string;
+  profilImageUrl?: string;
+  profilMediumImageUrl?: string;
+  profilThumbImageUrl?: string;
+  profilMarkerImageUrl?: string;
+  [key: string]: unknown;
+}