@frenchbaas/js 0.2.0 → 0.2.2

package/README.md

@@ -44,6 +44,9 @@ const col = client.collection('collection-uuid')
 // Lire (paginé)
 const { data, meta } = await col.get({ page: 1, perPage: 20 })
 
+// Récupérer un document par son ID
+const doc = await col.getById('doc-id')
+
 // Créer
 const doc = await col.create({ title: 'Hello', published: true })
 

package/dist/index.cjs

@@ -235,6 +235,10 @@ var CollectionClient = class {
    * Crée un nouveau document dans la collection.
    * Les champs sont validés contre le schéma côté serveur.
    *
+   * Si un `before_create_url` est configuré sur la collection, FrenchBaas appelle
+   * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+   * avec le message retourné par votre webhook (ex : "Stock insuffisant").
+   *
    * @param data Données du document (doit respecter le schéma de la collection)
    */
   async create(data) {
@@ -248,6 +252,10 @@ var CollectionClient = class {
    * Met à jour partiellement un document (merge).
    * Seuls les champs fournis sont mis à jour, les autres restent inchangés.
    *
+   * Si un `before_update_url` est configuré sur la collection, FrenchBaas appelle
+   * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+   * avec le message retourné par votre webhook (ex : "Modification refusée").
+   *
    * - Collection private : seul le créateur peut modifier.
    * - Collection authenticated/public : tout utilisateur authentifié peut modifier.
    *

package/dist/index.d.mts

@@ -229,6 +229,10 @@ declare class CollectionClient<T = Record<string, unknown>> {
      * Crée un nouveau document dans la collection.
      * Les champs sont validés contre le schéma côté serveur.
      *
+     * Si un `before_create_url` est configuré sur la collection, FrenchBaas appelle
+     * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+     * avec le message retourné par votre webhook (ex : "Stock insuffisant").
+     *
      * @param data Données du document (doit respecter le schéma de la collection)
      */
     create(data: Partial<T>): Promise<Document<T>>;
@@ -236,6 +240,10 @@ declare class CollectionClient<T = Record<string, unknown>> {
      * Met à jour partiellement un document (merge).
      * Seuls les champs fournis sont mis à jour, les autres restent inchangés.
      *
+     * Si un `before_update_url` est configuré sur la collection, FrenchBaas appelle
+     * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+     * avec le message retourné par votre webhook (ex : "Modification refusée").
+     *
      * - Collection private : seul le créateur peut modifier.
      * - Collection authenticated/public : tout utilisateur authentifié peut modifier.
      *
@@ -328,7 +336,11 @@ declare class NetworkError extends FrenchBaasError {
 }
 /**
  * Erreur de validation.
- * Levée sur : 400 (paramètres manquants), 413 (document trop grand), 422 (schéma invalide).
+ * Levée sur : 400 (paramètres manquants), 413 (document trop grand),
+ * 422 (schéma invalide, ou webhook before_create/before_update qui rejette la requête).
+ *
+ * Quand un webhook rejette, `message` contient le message renvoyé par votre endpoint
+ * (ex : "Stock insuffisant"). `errors` est vide dans ce cas.
  */
 declare class ValidationError extends FrenchBaasError {
     readonly errors: string[];

package/dist/index.d.ts

@@ -229,6 +229,10 @@ declare class CollectionClient<T = Record<string, unknown>> {
      * Crée un nouveau document dans la collection.
      * Les champs sont validés contre le schéma côté serveur.
      *
+     * Si un `before_create_url` est configuré sur la collection, FrenchBaas appelle
+     * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+     * avec le message retourné par votre webhook (ex : "Stock insuffisant").
+     *
      * @param data Données du document (doit respecter le schéma de la collection)
      */
     create(data: Partial<T>): Promise<Document<T>>;
@@ -236,6 +240,10 @@ declare class CollectionClient<T = Record<string, unknown>> {
      * Met à jour partiellement un document (merge).
      * Seuls les champs fournis sont mis à jour, les autres restent inchangés.
      *
+     * Si un `before_update_url` est configuré sur la collection, FrenchBaas appelle
+     * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+     * avec le message retourné par votre webhook (ex : "Modification refusée").
+     *
      * - Collection private : seul le créateur peut modifier.
      * - Collection authenticated/public : tout utilisateur authentifié peut modifier.
      *
@@ -328,7 +336,11 @@ declare class NetworkError extends FrenchBaasError {
 }
 /**
  * Erreur de validation.
- * Levée sur : 400 (paramètres manquants), 413 (document trop grand), 422 (schéma invalide).
+ * Levée sur : 400 (paramètres manquants), 413 (document trop grand),
+ * 422 (schéma invalide, ou webhook before_create/before_update qui rejette la requête).
+ *
+ * Quand un webhook rejette, `message` contient le message renvoyé par votre endpoint
+ * (ex : "Stock insuffisant"). `errors` est vide dans ce cas.
  */
 declare class ValidationError extends FrenchBaasError {
     readonly errors: string[];

package/dist/index.js

@@ -201,6 +201,10 @@ var CollectionClient = class {
    * Crée un nouveau document dans la collection.
    * Les champs sont validés contre le schéma côté serveur.
    *
+   * Si un `before_create_url` est configuré sur la collection, FrenchBaas appelle
+   * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+   * avec le message retourné par votre webhook (ex : "Stock insuffisant").
+   *
    * @param data Données du document (doit respecter le schéma de la collection)
    */
   async create(data) {
@@ -214,6 +218,10 @@ var CollectionClient = class {
    * Met à jour partiellement un document (merge).
    * Seuls les champs fournis sont mis à jour, les autres restent inchangés.
    *
+   * Si un `before_update_url` est configuré sur la collection, FrenchBaas appelle
+   * votre endpoint avant d'écrire en base. Un rejet lève une `ValidationError`
+   * avec le message retourné par votre webhook (ex : "Modification refusée").
+   *
    * - Collection private : seul le créateur peut modifier.
    * - Collection authenticated/public : tout utilisateur authentifié peut modifier.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frenchbaas/js",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "SDK JavaScript officiel pour FrenchBaas",
   "author": "FrenchBaas",
   "license": "MIT",