@frenchbaas/js 0.2.3 → 0.3.0

package/README.md

@@ -49,6 +49,12 @@ const col = client.collection('uuid-de-la-collection')
 const { data, meta } = await col.get({ page: 1, perPage: 20 })
 // meta → { total, page, per_page, total_pages }
 
+// Filtrer par champ (string, number, boolean)
+const { data: pending } = await col.get({ filter: { status: 'pending' } })
+
+// Filtrer par champ references (tableau d'UUIDs — contient l'UUID)
+const { data: products } = await col.get({ filter: { category_ids: 'uuid-categorie' } })
+
 // Récupérer un document par ID
 const doc = await col.getById('doc-uuid')
 // doc → { id, data, created_at, updated_at }
@@ -74,6 +80,32 @@ const { schema } = await col.schema()
 | `authenticated` | Token requis | Token requis |
 | `private` | Créateur uniquement | Créateur uniquement |
 
+### Permissions SDK sur les champs
+
+Le développeur peut configurer une permission sur chaque champ d'une collection.
+Ces règles sont appliquées **côté serveur**, de façon transparente pour le SDK.
+
+| Permission | Comportement à la création | Comportement à la mise à jour |
+|---|---|---|
+| `writable` | L'utilisateur écrit librement **(défaut)** | Modifiable |
+| `forced` | Remplacé par la valeur définie par le dev | Ignoré (non modifiable) |
+| `inject_user_id` | Injecté automatiquement avec l'ID de l'utilisateur | Ignoré |
+| `inject_user_email` | Injecté automatiquement avec l'email de l'utilisateur | Ignoré |
+| `inject_timestamp` | Injecté automatiquement avec la date/heure serveur | Ignoré |
+| `readonly` | Ignoré (seul le dev peut écrire ce champ) | Ignoré |
+
+```js
+// Même si vous envoyez role: 'admin', le serveur force 'client' si le champ est en mode forced
+await client.collection('users').create({ role: 'admin', email: 'x@x.com' })
+// → { role: 'client', email: 'x@x.com' }
+
+// Les champs inject_* n'ont pas besoin d'être envoyés
+await client.collection('orders').create({ total: 99.99 })
+// → { total: 99.99, created_by_email: 'user@example.com' }  ← injecté par le serveur
+```
+
+Ces permissions se configurent dans le Dashboard → collection → schéma → colonne **SDK permission**.
+
 ---
 
 ## Webhooks

package/dist/index.cjs

@@ -209,6 +209,11 @@ var CollectionClient = class {
       page: options.page,
       per_page: options.perPage
     };
+    if (options.filter) {
+      for (const [key, val] of Object.entries(options.filter)) {
+        if (val !== void 0) params[`filter[${key}]`] = val;
+      }
+    }
     const res = await this._http.get(
       `/sdk/collections/${this._collectionId}/documents`,
       params

package/dist/index.d.mts

@@ -47,6 +47,15 @@ interface GetOptions {
     page?: number;
     /** Documents par page — max 100 (défaut: 50) */
     perPage?: number;
+    /**
+     * Filtres sur les champs du document.
+     * - Champ string/number/boolean : égalité exacte
+     * - Champ references : l'UUID doit être présent dans le tableau
+     *
+     * @example { status: 'pending' }
+     * @example { category_ids: '3e0a5843-...' }
+     */
+    filter?: Record<string, string>;
 }
 type FieldType = 'string' | 'integer' | 'number' | 'boolean' | 'array' | 'object' | 'datetime';
 interface SchemaField {

package/dist/index.d.ts

@@ -47,6 +47,15 @@ interface GetOptions {
     page?: number;
     /** Documents par page — max 100 (défaut: 50) */
     perPage?: number;
+    /**
+     * Filtres sur les champs du document.
+     * - Champ string/number/boolean : égalité exacte
+     * - Champ references : l'UUID doit être présent dans le tableau
+     *
+     * @example { status: 'pending' }
+     * @example { category_ids: '3e0a5843-...' }
+     */
+    filter?: Record<string, string>;
 }
 type FieldType = 'string' | 'integer' | 'number' | 'boolean' | 'array' | 'object' | 'datetime';
 interface SchemaField {

package/dist/index.js

@@ -175,6 +175,11 @@ var CollectionClient = class {
       page: options.page,
       per_page: options.perPage
     };
+    if (options.filter) {
+      for (const [key, val] of Object.entries(options.filter)) {
+        if (val !== void 0) params[`filter[${key}]`] = val;
+      }
+    }
     const res = await this._http.get(
       `/sdk/collections/${this._collectionId}/documents`,
       params

package/package.json

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