c7714e3e8a
Migrations :
- import_batches (uuid id, organization_id FK CASCADE)
- import_drafts (uuid id, batch_id FK CASCADE, filename, pdf_storage_key nullable, extracted/edited/confidence en jsonb, status ENUM PG natif pending/validated/skipped, invoice_id FK SET NULL)
Schema rules : tape précisément extracted/edited/confidence (sinon `any`) + status enum.
Services :
- OcrProvider : interface (storageKey + filename → champs avec confiance par champ)
- MockOcrProvider : génère des champs plausibles depuis le filename (numero parsed via regex, montants random multiples de 50cts, dates ISO décalées) + 30 % de cas avec emails à confiance basse pour simuler la review UX
- getOcrProvider() : sélectionne via OCR_PROVIDER env var (default mock, mistral en attente d'ADR-020)
- createImportBatchFromFilenames : compose extracted/edited/confidence par draft, tente un match client immédiat (case-insensitive sur le nom) pour pré-remplir clientId
- resolveClient extrait dans un service partagé (3 priorités : clientId → match nom → création + email requis), réutilisé par invoices_controller et import_batches_controller
Endpoints (auth + scope par organization) :
- POST /invoices/upload : V1 mock body { filenames[] }, 201 → ImportBatch avec ses drafts. Multipart upload réel quand Mistral arrivera, contrat de réponse identique.
- GET /invoices/import-batch/:id : poll pendant la review
- POST /invoices/import-batch/:id/drafts/:draftId/validate : crée Invoice (résolution client) + draft.status=validated + draft.invoiceId
- POST .../drafts/:draftId/skip : draft.status=skipped (idempotent)
- DELETE /invoices/import-batch/:id : CASCADE drop drafts, les invoices validées restent
Routes : ordre soigné — /upload, /counts, /import-batch/* AVANT /:id pour éviter le shadowing.
Bruno : nouveau dossier 06-Imports avec 5 requêtes documentées + capture batchId/draftId dans l'env local. README mis à jour avec le parcours étendu (étapes 11-13).
63 lines
2.8 KiB
Markdown
63 lines
2.8 KiB
Markdown
# Rubis API — Collection Bruno
|
|
|
|
Collection [Bruno](https://www.usebruno.com/) qui répertorie toutes les routes de l'API et permet de les tester en suivant un parcours réaliste (signup → onboarding → création client → facture → encaissement).
|
|
|
|
## Installation
|
|
|
|
1. Installe Bruno : https://www.usebruno.com/downloads
|
|
2. Dans Bruno, **Open Collection** → sélectionne le dossier `bruno/` à la racine du repo.
|
|
3. Sélectionne l'environnement **local** dans le sélecteur en haut à droite.
|
|
|
|
## Démarrer l'API
|
|
|
|
```bash
|
|
pnpm dev:up # Postgres, Redis, MinIO, Mailpit
|
|
pnpm dev:api # API sur http://localhost:3333
|
|
```
|
|
|
|
Si la DB est neuve : `pnpm -F api exec node ace migration:run`
|
|
|
|
## Variables d'environnement
|
|
|
|
Définies dans `environments/local.bru`. Les valeurs **vides** (token, userId, etc.) sont remplies automatiquement par les `script:post-response` :
|
|
|
|
| Variable | Source | Utilisée par |
|
|
|---|---|---|
|
|
| `baseUrl` | en dur (`http://localhost:3333`) | toutes |
|
|
| `email` / `password` / `fullName` | en dur (login fixture) | Signup, Login |
|
|
| `token` | rempli après Signup/Login | toutes les routes auth |
|
|
| `userId` | rempli après Signup/Login | (info) |
|
|
| `organizationId` | rempli après Signup/Login | (info, debug) |
|
|
| `clientId` | rempli après Create client | détail/update client, création facture |
|
|
| `planSlug` | en dur (`standard-30j`) | détail/update plan |
|
|
| `invoiceId` | rempli après Create invoice OU Validate draft | détail/mark-paid |
|
|
| `batchId` / `draftId` | remplis après Upload (mock) | Get batch / Validate / Skip / Cancel |
|
|
|
|
## Parcours recommandé (premier run)
|
|
|
|
1. **Auth → 01 Signup** (récupère un token + crée l'org + provisionne les 4 plans)
|
|
2. **Account → 01 Get profile** (vérifie l'auth)
|
|
3. **Organizations → 02 Update my org** (onboarding step 2)
|
|
4. **Clients → 04 Create** (crée un client, capture `clientId`)
|
|
5. **Plans → 01 List** (vérifie les 4 plans pré-fournis)
|
|
6. **Invoices → 04 Create** (crée une facture liée au client)
|
|
7. **Invoices → 05 Get detail** (vérifie la timeline)
|
|
8. **Invoices → 06 Mark paid** (encaisse + bonus rubis)
|
|
9. **Organizations → 01 Get my org** (vérifie `rubisCount` incrémenté)
|
|
10. **Clients → 02 List with stats** (vérifie les compteurs)
|
|
11. **Imports → 01 Upload (mock)** (capture `batchId` + `draftId`)
|
|
12. **Imports → 02 Get batch** (review des drafts pending)
|
|
13. **Imports → 03 Validate draft** (transforme le draft en facture)
|
|
|
|
## Reset entre runs
|
|
|
|
L'email `alice@bruno.test` est unique en DB → 2e signup retourne 422 `email_taken`.
|
|
Pour repartir propre :
|
|
|
|
```bash
|
|
docker exec rubis-postgres psql -U rubis -d rubis_dev -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
|
|
pnpm -F api exec node ace migration:run
|
|
```
|
|
|
|
Ou change `email` dans l'environnement local pour forcer un nouveau signup à chaque run.
|