@frenchbaas/js 0.2.4 → 0.3.1

package/README.md

@@ -24,11 +24,11 @@ const client = new FrenchBaas({
 ## Auth
 
 ```js
-// Inscription
-const { user, access_token } = await client.auth.signUp({ email: 'a@b.com', password: 'secret' })
+// Inscription (mot de passe : 8 caractères minimum)
+const { user, access_token } = await client.auth.signUp({ email: 'a@b.com', password: 'monMotDePasse' })
 
 // Connexion
-const { user, access_token } = await client.auth.login({ email: 'a@b.com', password: 'secret' })
+const { user, access_token } = await client.auth.login({ email: 'a@b.com', password: 'monMotDePasse' })
 
 // Déconnexion
 await client.auth.logout()
@@ -49,6 +49,23 @@ 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 — valeur unique
+const { data: pending } = await col.get({ filter: { status: 'pending' } })
+
+// Filtrer OR — plusieurs valeurs (status pending OU delivered)
+const { data: multi } = await col.get({ filter: { status: ['pending', 'delivered'] } })
+
+// Filtrer par references — valeur unique (contient l'UUID)
+const { data: products } = await col.get({ filter: { category_ids: 'uuid-categorie' } })
+
+// Filtrer references OR — catégorie A OU B
+const { data: orProducts } = await col.get({ filter: { category_ids: ['uuid-cat-a', 'uuid-cat-b'] } })
+
+// Filtrer references AND — dans catégorie A ET B (uniquement pour references/array)
+const { data: andProducts } = await col.get({ filter: { category_ids: { and: ['uuid-cat-a', 'uuid-cat-b'] } } })
+
+// ⚠ Maximum 20 valeurs par filtre (OR ou AND)
+
 // Récupérer un document par ID
 const doc = await col.getById('doc-uuid')
 // doc → { id, data, created_at, updated_at }
@@ -200,6 +217,10 @@ const client = new FrenchBaas({
 Utilisez `localStorage` pour que la session survive au rechargement de page
 (applications web). Utilisez `memory` pour les environnements serveur (Node.js).
 
+> **Sécurité** : l'option `localStorage` expose les tokens à toute attaque XSS sur votre page.
+> Assurez-vous que votre application ne charge pas de scripts tiers non maîtrisés
+> et qu'elle applique une politique CSP stricte si vous utilisez ce mode.
+
 ---
 
 ## Fonctionnalités automatiques

package/dist/index.cjs

@@ -209,6 +209,18 @@ 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) continue;
+        if (typeof val === "string") {
+          params[`filter[${key}]`] = val;
+        } else if (Array.isArray(val)) {
+          params[`filter[${key}][]`] = val;
+        } else {
+          params[`filter[${key}][and][]`] = val.and;
+        }
+      }
+    }
     const res = await this._http.get(
       `/sdk/collections/${this._collectionId}/documents`,
       params
@@ -309,7 +321,12 @@ var HttpClient = class {
     const url = new URL(this._baseUrl + path);
     if (params) {
       for (const [k, v] of Object.entries(params)) {
-        if (v !== void 0) url.searchParams.set(k, String(v));
+        if (v === void 0) continue;
+        if (Array.isArray(v)) {
+          for (const item of v) url.searchParams.append(k, item);
+        } else {
+          url.searchParams.set(k, String(v));
+        }
       }
     }
     return this._request("GET", url.toString(), void 0, true);

package/dist/index.d.mts

@@ -47,6 +47,22 @@ interface GetOptions {
     page?: number;
     /** Documents par page — max 100 (défaut: 50) */
     perPage?: number;
+    /**
+     * Filtres sur les champs du document.
+     *
+     * - Valeur unique (string)   → égalité exacte ou contient (references/array)
+     * - Tableau string[]         → OR  : field = v1 OU v2 / contient v1 OU v2
+     * - { and: string[] }        → AND : uniquement pour references/array — contient tous les éléments
+     *
+     * @example { status: 'active' }
+     * @example { status: ['active', 'pending'] }
+     * @example { category_ids: 'uuid1' }
+     * @example { category_ids: ['uuid1', 'uuid2'] }
+     * @example { category_ids: { and: ['uuid1', 'uuid2'] } }
+     */
+    filter?: Record<string, string | string[] | {
+        and: string[];
+    }>;
 }
 type FieldType = 'string' | 'integer' | 'number' | 'boolean' | 'array' | 'object' | 'datetime';
 interface SchemaField {
@@ -125,7 +141,7 @@ declare class HttpClient {
     constructor(_baseUrl: string, _apiKey: string, _tokenStore: TokenStore);
     /** Enregistre la fonction de refresh (injectée par AuthModule). */
     setRefreshFn(fn: RefreshFn): void;
-    get<T>(path: string, params?: Record<string, string | number | undefined>): Promise<T>;
+    get<T>(path: string, params?: Record<string, string | number | string[] | undefined>): Promise<T>;
     post<T>(path: string, body?: unknown): Promise<T>;
     patch<T>(path: string, body?: unknown): Promise<T>;
     delete<T>(path: string): Promise<T>;

package/dist/index.d.ts

@@ -47,6 +47,22 @@ interface GetOptions {
     page?: number;
     /** Documents par page — max 100 (défaut: 50) */
     perPage?: number;
+    /**
+     * Filtres sur les champs du document.
+     *
+     * - Valeur unique (string)   → égalité exacte ou contient (references/array)
+     * - Tableau string[]         → OR  : field = v1 OU v2 / contient v1 OU v2
+     * - { and: string[] }        → AND : uniquement pour references/array — contient tous les éléments
+     *
+     * @example { status: 'active' }
+     * @example { status: ['active', 'pending'] }
+     * @example { category_ids: 'uuid1' }
+     * @example { category_ids: ['uuid1', 'uuid2'] }
+     * @example { category_ids: { and: ['uuid1', 'uuid2'] } }
+     */
+    filter?: Record<string, string | string[] | {
+        and: string[];
+    }>;
 }
 type FieldType = 'string' | 'integer' | 'number' | 'boolean' | 'array' | 'object' | 'datetime';
 interface SchemaField {
@@ -125,7 +141,7 @@ declare class HttpClient {
     constructor(_baseUrl: string, _apiKey: string, _tokenStore: TokenStore);
     /** Enregistre la fonction de refresh (injectée par AuthModule). */
     setRefreshFn(fn: RefreshFn): void;
-    get<T>(path: string, params?: Record<string, string | number | undefined>): Promise<T>;
+    get<T>(path: string, params?: Record<string, string | number | string[] | undefined>): Promise<T>;
     post<T>(path: string, body?: unknown): Promise<T>;
     patch<T>(path: string, body?: unknown): Promise<T>;
     delete<T>(path: string): Promise<T>;

package/dist/index.js

@@ -175,6 +175,18 @@ 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) continue;
+        if (typeof val === "string") {
+          params[`filter[${key}]`] = val;
+        } else if (Array.isArray(val)) {
+          params[`filter[${key}][]`] = val;
+        } else {
+          params[`filter[${key}][and][]`] = val.and;
+        }
+      }
+    }
     const res = await this._http.get(
       `/sdk/collections/${this._collectionId}/documents`,
       params
@@ -275,7 +287,12 @@ var HttpClient = class {
     const url = new URL(this._baseUrl + path);
     if (params) {
       for (const [k, v] of Object.entries(params)) {
-        if (v !== void 0) url.searchParams.set(k, String(v));
+        if (v === void 0) continue;
+        if (Array.isArray(v)) {
+          for (const item of v) url.searchParams.append(k, item);
+        } else {
+          url.searchParams.set(k, String(v));
+        }
       }
     }
     return this._request("GET", url.toString(), void 0, true);

package/package.json

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