@frenchbaas/js 0.1.0 → 0.2.0

package/README.md

@@ -14,7 +14,7 @@ npm install @frenchbaas/js
 import { FrenchBaas } from '@frenchbaas/js'
 
 const client = new FrenchBaas({
-  url:    'https://api.frenchbaas.fr',
+  url:    'https://app.frenchbaas.com',
   apiKey: 'votre-clé-api',
 })
 ```
@@ -59,17 +59,27 @@ const schema = await col.schema()
 
 ## Gestion des erreurs
 
-```js
-import { AuthError, ValidationError, NotFoundError, QuotaError, NetworkError } from '@frenchbaas/js'
+```ts
+import {
+  AuthError,
+  ValidationError,
+  NotFoundError,
+  QuotaError,
+  RateLimitError,
+  NetworkError,
+  ServerError,
+} from '@frenchbaas/js'
 
 try {
   await client.collection('col-id').create({ title: 'Test' })
 } catch (e) {
-  if (e instanceof AuthError)            console.error('Non connecté')
-  if (e instanceof ValidationError)      console.error('Données invalides', e.errors)
-  if (e instanceof NotFoundError)        console.error('Introuvable')
-  if (e instanceof QuotaError)           console.error('Quota dépassé')
-  if (e instanceof NetworkError)         console.error('Hors ligne')
+  if (e instanceof AuthError)       console.error('Non connecté ou session expirée')
+  if (e instanceof ValidationError) console.error('Données invalides', e.errors)
+  if (e instanceof NotFoundError)   console.error('Introuvable')
+  if (e instanceof QuotaError)      console.error('Quota dépassé')
+  if (e instanceof RateLimitError)  console.error('Trop de requêtes, réessayez dans quelques instants')
+  if (e instanceof NetworkError)    console.error('Hors ligne')
+  if (e instanceof ServerError)     console.error('Erreur interne du serveur')
 }
 ```
 
@@ -78,7 +88,7 @@ try {
 ```js
 // Persister la session dans localStorage (rechargement de page)
 const client = new FrenchBaas({
-  url:     'https://api.frenchbaas.fr',
+  url:     'https://app.frenchbaas.com',
   apiKey:  'votre-clé-api',
   storage: 'localStorage', // défaut : 'memory'
 })
@@ -96,3 +106,4 @@ const client = new FrenchBaas({
 ## License
 
 MIT
+# frenchbaas-js

package/dist/index.cjs

@@ -215,6 +215,22 @@ var CollectionClient = class {
     );
     return { data: res.data, meta: res.meta };
   }
+  /**
+   * Récupère un document par son ID.
+   * La visibilité (public/authenticated/private) est vérifiée côté serveur.
+   *
+   * - Collection public       : X-Api-Key uniquement
+   * - Collection authenticated : token SDK requis
+   * - Collection private       : token SDK requis + être le créateur
+   *
+   * @param documentId UUID du document à récupérer
+   */
+  async getById(documentId) {
+    const res = await this._http.get(
+      `/sdk/documents/${documentId}`
+    );
+    return res.data;
+  }
   /**
    * Crée un nouveau document dans la collection.
    * Les champs sont validés contre le schéma côté serveur.

package/dist/index.d.mts

@@ -214,6 +214,17 @@ declare class CollectionClient<T = Record<string, unknown>> {
      * @param options.perPage Documents par page, max 100 (défaut: 50)
      */
     get(options?: GetOptions): Promise<DocumentsPage<T>>;
+    /**
+     * Récupère un document par son ID.
+     * La visibilité (public/authenticated/private) est vérifiée côté serveur.
+     *
+     * - Collection public       : X-Api-Key uniquement
+     * - Collection authenticated : token SDK requis
+     * - Collection private       : token SDK requis + être le créateur
+     *
+     * @param documentId UUID du document à récupérer
+     */
+    getById(documentId: string): Promise<Document<T>>;
     /**
      * Crée un nouveau document dans la collection.
      * Les champs sont validés contre le schéma côté serveur.

package/dist/index.d.ts

@@ -214,6 +214,17 @@ declare class CollectionClient<T = Record<string, unknown>> {
      * @param options.perPage Documents par page, max 100 (défaut: 50)
      */
     get(options?: GetOptions): Promise<DocumentsPage<T>>;
+    /**
+     * Récupère un document par son ID.
+     * La visibilité (public/authenticated/private) est vérifiée côté serveur.
+     *
+     * - Collection public       : X-Api-Key uniquement
+     * - Collection authenticated : token SDK requis
+     * - Collection private       : token SDK requis + être le créateur
+     *
+     * @param documentId UUID du document à récupérer
+     */
+    getById(documentId: string): Promise<Document<T>>;
     /**
      * Crée un nouveau document dans la collection.
      * Les champs sont validés contre le schéma côté serveur.

package/dist/index.js

@@ -181,6 +181,22 @@ var CollectionClient = class {
     );
     return { data: res.data, meta: res.meta };
   }
+  /**
+   * Récupère un document par son ID.
+   * La visibilité (public/authenticated/private) est vérifiée côté serveur.
+   *
+   * - Collection public       : X-Api-Key uniquement
+   * - Collection authenticated : token SDK requis
+   * - Collection private       : token SDK requis + être le créateur
+   *
+   * @param documentId UUID du document à récupérer
+   */
+  async getById(documentId) {
+    const res = await this._http.get(
+      `/sdk/documents/${documentId}`
+    );
+    return res.data;
+  }
   /**
    * Crée un nouveau document dans la collection.
    * Les champs sont validés contre le schéma côté serveur.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frenchbaas/js",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "SDK JavaScript officiel pour FrenchBaas",
   "author": "FrenchBaas",
   "license": "MIT",
@@ -18,7 +18,8 @@
     "dist/**/*.js",
     "dist/**/*.cjs",
     "dist/**/*.d.ts",
-    "dist/**/*.d.mts"
+    "dist/**/*.d.mts",
+    "README.md"
   ],
   "scripts": {
     "build": "tsup",