@communecter/cocolight-api-client 1.0.9 → 1.0.11

package/README.md

@@ -221,7 +221,287 @@ pathParams: {
 }
 ```
 
-Ces valeurs seront automatiquement résolues à partir du contexte du client.
+## 🎩 API de façade : `Api`
+
+La classe `Api` fournit une interface unifiée pour gérer les utilisateurs, organisations, projets et actualités. Elle encapsule les appels à `ApiClient` et permet de manipuler les entités comme des objets métier avec des méthodes pratiques.
+
+### 🧪 Authentification
+
+#### `Api.userLogin(email, password, options)`
+Crée une instance d’`Api` authentifiée.
+
+```js
+const api = await Api.userLogin("john@doe.com", "password123", { baseURL: "https://api.monapp.com" });
+const user = await api.me();
+```
+
+#### `Api.userApi(options)`
+Retourne une instance `UserApi` si tu veux gérer manuellement l’authentification :
+
+```js
+const userApi = Api.userApi({ baseURL: "..." });
+const user = await userApi.login("email", "mdp");
+```
+
+---
+
+### 🔐 Session et utilisateur courant
+
+#### `api.me()`
+Retourne l'utilisateur actuellement connecté (`User`).
+
+```js
+const user = await api.me();
+console.log(user.data.email);
+```
+
+---
+
+### 👤 Utilisateurs
+
+#### `api.user(userData)`
+Crée une instance `User` (autre que le connecté).
+
+```js
+const otherUser = await api.user({ slug: "caroline" });
+console.log(otherUser.data.description);
+```
+
+---
+
+### 🏛️ Organisations
+
+#### `api.organization({ id | slug })`
+Retourne une instance d’`Organization`. Récupère automatiquement le profil public.
+
+```js
+const orga = await api.organization({ slug: "asso-verte" });
+console.log(orga.data.name);
+```
+
+---
+
+### 🏗️ Projets
+
+#### `api.project({ id | slug })`
+Retourne une instance `Project`. Récupère automatiquement le profil public.
+
+```js
+const projet = await api.project({ id: "647..." });
+```
+
+---
+
+## 📦 Entités métiers
+
+Les entités suivantes partagent une API commune grâce aux mixins : `User`, `Organization`, `Project`, `News`.
+
+### Propriétés
+
+| Propriété         | Description |
+|------------------|-------------|
+| `data`           | Proxy combiné `serverData + draftData` |
+| `draftData`      | Données modifiables avant `save()` |
+| `initialDraftData` | Snapshot initial pour détection des changements |
+| `serverData`     | Dernières données serveur |
+| `isConnected`    | Vrai si `ApiClient` a un token |
+| `userId`         | ID de l'utilisateur connecté |
+| `isMe`           | Vrai si l'entité correspond à l'utilisateur courant |
+
+---
+
+### Méthodes génériques
+
+#### `entity.save()`
+Sauvegarde les données via les blocs modifiés (`UPDATE_BLOCK_*`, `ADD_*`).
+
+#### `entity.refresh()`
+Recharge les données depuis le serveur.
+
+#### `entity.hasChanges()`
+Retourne `true` si le draft est différent du snapshot initial.
+
+---
+
+## ✏️ Méthodes d’édition (communes à toutes les entités)
+
+| Méthode                | Description |
+|------------------------|-------------|
+| `updateDescription`    | Met à jour les champs `shortDescription`, `description`, `descMentions` |
+| `updateInfo`           | Nom, email, téléphone, etc. |
+| `updateSocial`         | Réseaux sociaux (Facebook, GitHub...) |
+| `updateLocality`       | Adresse, géolocalisation |
+| `updateSlug`           | Slug de l’URL |
+| `updateImageProfil`    | Upload de l’avatar |
+
+---
+
+## 📰 Actualités (`News`)
+
+Créées à partir d’un `User`, `Organization` ou `Project`.
+
+### Création
+
+```js
+const news = await orga.news();
+news.data.text = "Nouvelle actu !";
+await news.save();
+```
+
+### Gestion
+
+| Méthode        | Description |
+|----------------|-------------|
+| `addMention({ slug \| id })` | Ajoute une mention à la news |
+| `addImage(file)`            | Ajoute une image (via validation MIME) |
+| `addFile(file)`             | Ajoute un fichier (PDF, CSV...) |
+| `delete()`                  | Supprime la news |
+| `refresh()`                 | Recharge la news |
+| `get()`                     | Récupère les données à partir de l’ID |
+
+---
+
+## 🔄 Utilisation des schémas de validation (AJV)
+
+Toutes les entités sont basées sur les constantes de schéma :
+- `ADD_*`
+- `UPDATE_BLOCK_*`
+- `PROFIL_IMAGE`
+
+Ces constantes sont mappées automatiquement pour les appels `save()`, `updateX()`, etc.
+
+---
+
+## ✅ Exemple : mise à jour d’un projet
+
+```js
+const projet = await api.project({ slug: "bio-bazar" });
+projet.data.description = "Nouveau descriptif de mon projet.";
+if (projet.hasChanges()) {
+  await projet.save();
+}
+```
+
+## 👤 API : Utilisateur (`User`)
+
+Une instance `User` offre un ensemble de méthodes métier pour interagir avec les projets, organisations et actualités de l’utilisateur.
+
+---
+
+### 🔍 Chargement
+
+```js
+const user = await api.user({ slug: "caroline" });
+await user.get();
+```
+
+---
+
+### 🏭 Création d'entités depuis `User`
+
+Un utilisateur peut **créer** :
+
+#### ➕ Organisation
+
+```js
+const orga = await user.organization({ name: "Ma nouvelle asso" });
+await orga.save(); // appelle ADD_ORGANIZATION puis rafraîchit les données
+```
+
+#### ➕ Projet
+
+```js
+const projet = await user.project({ name: "Mon projet citoyen" });
+await projet.save(); // appelle ADD_PROJECT
+```
+
+#### ➕ Actualité
+
+```js
+const news = await user.news({ text: "Hello world 🌍" });
+await news.save(); // appelle ADD_NEWS
+```
+
+---
+
+### 📦 Récupération des projets de l'utilisateur
+
+#### `user.getProjects()`
+
+Retourne la liste des projets créés ou co-administrés par l’utilisateur.
+
+```js
+const { results: projets } = await user.getProjects();
+console.log("Projets liés à l'utilisateur :", projets.map(p => p.data.name));
+```
+
+---
+
+### 🧑‍🤝‍🧑 Récupération des organisations de l'utilisateur
+
+#### `user.getOrganizations()`
+
+Retourne les organisations où il est membre (admin ou non).
+
+```js
+const { results: orgs } = await user.getOrganizations();
+console.log("Organisations :", orgs.map(o => o.data.name));
+```
+
+---
+
+### 📰 Actualités associées
+
+#### `user.getNews()`
+
+Retourne toutes les actualités liées à l’utilisateur.
+
+```js
+const newsList = await user.getNews({ indexStep: 5 });
+```
+
+#### `user.news(newsData)`
+
+Crée une nouvelle actualité, ou charge une existante si `id` est fourni.
+
+```js
+const actu = await user.news({ text: "Ceci est une nouvelle actu" });
+await actu.save();
+```
+
+---
+
+### ⚙️ Mise à jour du profil utilisateur
+
+Les méthodes `updateX` disponibles sont :
+
+- `updateDescription(data)`
+- `updateInfo(data)`
+- `updateSocial(data)`
+- `updateLocality(data)`
+- `updateSlug({ slug })`
+- `updateImageProfil({ profil_avatar })`
+- `updateSettings({ type, value })`
+
+---
+
+### 🔑 Sécurité et gestion de compte
+
+#### Modifier mot de passe
+
+```js
+await user.changePassword({
+  oldPassword: "secret1",
+  newPassword: "secret2",
+  newPassword2: "secret2"
+});
+```
+
+#### Supprimer son compte
+
+```js
+await user.delete({ reason: "Je souhaite quitter la plateforme" });
+```
 
 ## Licence
 

package/dist/405.cocolight-api-client.browser.js

@@ -0,0 +1 @@
+(this.webpackChunkCocolightApiClient=this.webpackChunkCocolightApiClient||[]).push([[405],{870:()=>{},4061:()=>{},6497:()=>{},8405:(e,i,t)=>{"use strict";t.d(i,{FileStorageStrategy:()=>h});var r=t(6497),s=t(870),n=t(4061),c=t(1027);class h extends c.u3{constructor(e="tokens.json",i=n.join(s.homedir(),".config","cocolight")){super(),this.dir=i,this.filePath=n.join(i,e),this._ensureDirectoryExists()}_ensureDirectoryExists(){r.existsSync(this.dir)||r.mkdirSync(this.dir,{recursive:!0})}_readFile(){if(!r.existsSync(this.filePath))return{};try{return JSON.parse(r.readFileSync(this.filePath,"utf8"))}catch(e){return console.error("Error reading token file:",e),{}}}_writeFile(e){r.writeFileSync(this.filePath,JSON.stringify(e,null,2),"utf8")}getAccessToken(){return this._readFile().accessToken||null}setAccessToken(e){const i=this._readFile();i.accessToken=e,this._writeFile(i)}getRefreshToken(){return this._readFile().refreshToken||null}setRefreshToken(e){const i=this._readFile();i.refreshToken=e,this._writeFile(i)}clear(){this._writeFile({})}}}}]);

package/dist/405.cocolight-api-client.cjs

@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_communecter_cocolight_api_client=self.webpackChunk_communecter_cocolight_api_client||[]).push([[405],{405:(e,i,t)=>{t.d(i,{FileStorageStrategy:()=>o});var r=t(383),s=t(366),n=t(3),c=t(27);class o extends c.u3{constructor(e="tokens.json",i=n.join(s.homedir(),".config","cocolight")){super(),this.dir=i,this.filePath=n.join(i,e),this._ensureDirectoryExists()}_ensureDirectoryExists(){r.existsSync(this.dir)||r.mkdirSync(this.dir,{recursive:!0})}_readFile(){if(!r.existsSync(this.filePath))return{};try{return JSON.parse(r.readFileSync(this.filePath,"utf8"))}catch(e){return console.error("Error reading token file:",e),{}}}_writeFile(e){r.writeFileSync(this.filePath,JSON.stringify(e,null,2),"utf8")}getAccessToken(){return this._readFile().accessToken||null}setAccessToken(e){const i=this._readFile();i.accessToken=e,this._writeFile(i)}getRefreshToken(){return this._readFile().refreshToken||null}setRefreshToken(e){const i=this._readFile();i.refreshToken=e,this._writeFile(i)}clear(){this._writeFile({})}}}}]);

package/dist/790.cocolight-api-client.mjs.js

@@ -0,0 +1 @@
+export const __webpack_id__=790;export const __webpack_ids__=[790];export const __webpack_modules__={790:(e,t,r)=>{r.d(t,{FileStorageStrategy:()=>o});var i=r(421),s=r(116),n=r(521),l=r(72);class o extends l.u3{constructor(e="tokens.json",t=n.default.join(s.default.homedir(),".config","cocolight")){super(),this.dir=t,this.filePath=n.default.join(t,e),this._ensureDirectoryExists()}_ensureDirectoryExists(){i.default.existsSync(this.dir)||i.default.mkdirSync(this.dir,{recursive:!0})}_readFile(){if(!i.default.existsSync(this.filePath))return{};try{return JSON.parse(i.default.readFileSync(this.filePath,"utf8"))}catch(e){return console.error("Error reading token file:",e),{}}}_writeFile(e){i.default.writeFileSync(this.filePath,JSON.stringify(e,null,2),"utf8")}getAccessToken(){return this._readFile().accessToken||null}setAccessToken(e){const t=this._readFile();t.accessToken=e,this._writeFile(t)}getRefreshToken(){return this._readFile().refreshToken||null}setRefreshToken(e){const t=this._readFile();t.refreshToken=e,this._writeFile(t)}clear(){this._writeFile({})}}}};