diff --git a/README.md b/README.md index a4212272..b96f9ec0 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,26 @@ En fullstack-applikation för hantering av hemmavaror och recept. Håll koll på ## Funktioner -- **Hemmavaror** — lägg till, redigera och konsumera varor. Filtrera på plats och bäst före-datum. -- **Recept** — skapa och redigera recept med ingredienser och tillagningsinstruktioner (Markdown-stöd). -- **Receptjämförelse** — se direkt vilka ingredienser du har hemma och vad som saknas. -- **Importera recept från Markdown** — klistra in ett recept i ett enkelt textformat, granska matchade produkter och spara med ett klick. -- **Admin: Produkter** — hantera produktnamn och slå ihop dubbletter. +### Inventorie (Hemmavaror) +- **Lägg till, redigera och ta bort varor** — hantera produkt, kvantitet, enhet, plats, märke och bäst före-datum +- **Filtrera och sortera** — efter plats (kyl, frys, skafferi), bäst före-datum, och namn (A–Ö) +- **Konsumera varor** — registrera förbrukad mängd med eventuell kommentar +- **Konsumtionshistorik** — spåra vad som använts när och i vilken mängd +- **Utförlig information** — stöd för varumärke, lagringsnot, tillkomsttid, mera detaljer + +### Recept +- **Skapa och redigera recept** — med ingredienser, kvantiteter, enheter och instruktioner (Markdown-stöd) +- **Receptjämförelse mot inventorie** — se direkt vilka ingredienser du har hemma, vad som saknas och enhetskonflikt +- **Importera recept från Markdown** — klistra in ett recept i enkelt format, låt systemet matcha ingredienser, granska och spara med ett klick +- **Intelligenta matchningar** — Levenshtein-baserad likhetsbedömning hittar rätt produkt även på osäker stavning +- **Enhetskonvertering** — automatisk konvertering mellan viktenheter (g/kg), volymenheter (ml/dl) och portionsenheter (tsk/msk) + +### Admin: Produkter +- **Hantera produktnamn** — uppdatera canonical name för varje produkt (användes vid receptmatchning) +- **Hitta dubbletter** — identifiera produkter med samma normaliserade namn +- **Slå ihop produkter** — merge två produktposter, flytta alla inventarieföremål till målprodukten (källan soft-deleteras) +- **Förhandsvisning** — granska vad som kommer att hända innan merge genomförs +- **Återställ produkter** — restore tidigare raderade produkter --- @@ -21,28 +36,54 @@ En fullstack-applikation för hantering av hemmavaror och recept. Håll koll på ### Förutsättningar - Docker och Docker Compose -- En `proxy`-nätverk i Docker (extern, hanteras av Caddy eller liknande) +- En extern `proxy`-nätverk i Docker för Caddy (rekommenderat) eller localhost-konfiguration ### Starta applikationen ```bash -# Bygg och starta alla tjänster +# Bygg alla images (första gånger) docker compose build + +# Starta alla tjänster i bakgrunden docker compose up -d ``` -### Bygg om enbart backend (t.ex. efter kodändringar) +Frontend är tillgänglig på `http://localhost:3000` (eller via Caddy proxy) +Backend API är tillgänglig på `http://localhost:8080` (eller via Caddy proxy) + +### Bygg bara backend eller frontend om behövligt ```bash +# Bygg enbart backend (t.ex. efter kodändringar) docker compose build recipe-api + +# Starta bara backend (övriga tjänster fortsätter) docker compose up -d recipe-api + +# Liknande för frontend +docker compose build recipe-frontend +docker compose up -d recipe-frontend +``` + +### Kontrollera hälsa + +```bash +# Hälsokontroll via HTTP (backend måste köra) +curl http://localhost:8080/health + +# Databasspecifik hälsokontroll +curl http://localhost:8080/health/db ``` --- ## Importera recept från Markdown -Gå till **Recept → Lägg till nytt recept → Importera från Markdown** och klistra in ett recept i följande format: +### Steg 1: Gå till receptsidan +Navigera till **Recept** och välj **Lägg till nytt recept → Importera från Markdown** + +### Steg 2: Klistra in receptet +Använd följande format: ```markdown # Köttfärssås @@ -54,12 +95,54 @@ En klassisk köttfärssås med massa smak. - 1 st lök - 2 msk tomatpuré - 1 dl grädde (vispgrädde) +- salt och peppar ## Tillvägagångssätt -Hacka löken och stek den mjuk i lite olja. Tillsätt köttfärsen... +Hacka löken och stek den mjuk i lite olja. Tillsätt köttfärsen och bräsera tills den är genomstekt. Tillsätt tomatpuré och låt det småkoka ett par minuter innan du tillsätter grädde. Smaka av med salt och peppar. ``` -Systemet tolkar texten, föreslår matchande produkter från databasen och låter dig granska och justera innan receptet sparas. +### Steg 3: Granska +Systemet: +- Tolkar receptnamn, beskrivning och instruktioner +- Försöker matcha varje ingrediens mot databasen (Levenshtein-likhet) +- Visar förslag för varje ingrediens i prioriteringsordning + +Du kan: +- Redigera nombres, beskrivning och instruktioner +- Välj rätt produkt från förslagen för varje ingrediens +- Ta bort ingredienser som inte behövs +- Ändra kvantiteter och enheter + +### Steg 4: Spara +Klicka "Spara recept" — basrecepet sparas med dina valida ingredienser + +### Receptformat — regler + +| Sektion | Beskrivning | +|---------|------------| +| **H1 (# titel)** | Receptnamn | +| **Text efter H1, före ## Ingredienser** | Receptbeskrivning (valfritt) | +| **## Ingredienser** | Rubrik för ingredienslistan | +| **Ingrediensrader** | Mönster: `- ANTAL ENHET NAMN` eller `- ANTAL NAMN` (standard: st) | +| **Parentes i ingrediens** | Text i `(parentes)` sparas som ingrediensnot, t.ex. `(vispgrädde)`, `(eller crème fraiche)` | +| **## Tillvägagångssätt** (eller `## Instruktioner`) | Rubrik för tillagningsinstruktioner | +| **Text under instruktioner** | Instruktionstexten (kan fortsätta över flera rader) | + +### Matchningsalgoritm + +Systemet använder tre metoder för att hitta rätt produkt: + +1. **Exakt match** (100 poäng) + - Ingrediensnamn matchar exakt efter normalisering (lowercase, utan skiljetecken) + +2. **Delsträng-match** (70 poäng) + - Ingrediensnamn förekommer som del av produktnamnet eller vice versa + +3. **Levenshtein-likhet** (40–100 poäng) + - Likhetspoäng baserat på tecknenskillnad + - Mindre än 40 poäng filtreras bort + +Systemet visar upp till 5 bästa förslag per ingrediens. --- diff --git a/TEKNISK_BESKRIVNING.md b/TEKNISK_BESKRIVNING.md index 19574a9b..19394a51 100644 --- a/TEKNISK_BESKRIVNING.md +++ b/TEKNISK_BESKRIVNING.md @@ -4,7 +4,7 @@ ## Översikt -Recipe App är en fullstack-applikation för hantering av hemmavaror, recept och inköpsplanering. Systemet är byggt med Next.js (frontend), NestJS (backend), Prisma ORM och MariaDB. Applikationen är containeriserad med Docker och använder Caddy som reverse proxy. +Recipe App är en fullstack-applikation för hantering av hemmavaror, recept och matplanering. Systemet är byggt med Next.js (frontend), NestJS (backend), Prisma ORM och MariaDB. Applikationen är containeriserad med Docker och använder Caddy som reverse proxy. --- @@ -15,14 +15,15 @@ Recipe App är en fullstack-applikation för hantering av hemmavaror, recept och | Frontend | Next.js | 16.2 | | | React | 19.2 | | | TypeScript | 5.4.5 | -| | Node | 22.x (via @types/node 22.15.29) | +| | Node | 22.x (@types/node 22.15.29) | | Backend | NestJS | 10.3 | | | Prisma | 6.12.0 | | | TypeScript | 5.4.5 | -| | Node | 22.x (via @types/node 22.15.29) | +| | Node | 22.x (@types/node 22.15.29) | | Databas | MariaDB | 11 | | Proxy | Caddy | 2.x | | Container | Docker | 24+ | +| Converter | Node.js (TypeScript) | Noll externa beroenden | --- @@ -35,126 +36,312 @@ Recipe App är en fullstack-applikation för hantering av hemmavaror, recept och - **API-anrop:** Fetch mot backend och Next.js API routes - **Felhantering:** Global parseErrorResponse utility, svenska felmeddelanden -### Funktioner (frontend) +### Frontend-sidor och komponenter -- **Inventarielista:** - - Sök, filtrera och sortera hemmavaror (namn, plats, bäst före, A–Ö) - - Lägg till, redigera, konsumera och ta bort varor - - Konsumtionshistorik med enheter -- **Recept:** - - Lista, skapa, redigera och ta bort recept - - Jämför recept mot hemmavaror (räcker/saknas/enhetskonflikt) - - Visar instruktioner och saknade ingredienser för valt recept - - Sidebar med snabblista över recept -- **Admin: Produkter:** - - Sök och sortera produkter (A–Ö, senast tillagda) - - Redigera canonical name - - Merge preview för produktnamn -- **Felhantering:** - - Svenska felmeddelanden, tydliga varningar vid valideringsfel -- **Responsiv design:** - - Fungerar på mobil, surfplatta och desktop +| Sida | Fil | Funktionalitet | +|------|-----|---| +| **Hem** | `app/page.tsx` | Startsida | +| **Navigering** | `app/Navigation.tsx` | Huvudmeny | +| **Inventorie** | `app/inventory/page.tsx` | Lista, filtrera, sortera varor | +| | `InventoryList.tsx` | Ritning av inventarieföremål | +| | `InventoryForm.tsx` | Skapa nytt inventarieföremål | +| | `InventoryEditForm.tsx` | Redigera inventarieföremål | +| | `InventoryConsumeForm.tsx` | Konsumera (brukat) inventarieföremål | +| | `InventoryConsumptionHistory.tsx` | Visa konsumtionshistorik | +| | `ProductForm.tsx` | Välja produkt för inventarieföremål | +| | `actions.ts` | Server actions för inventarie | +| **Recept** | `app/recipes/page.tsx` | Lista recept | +| | `RecipePreview.tsx` | Receptförhandsvisning med inventariestatus | +| **Skapa recept** | `app/recipes/create/page.tsx` | Receptkreation (manual form) | +| | `app/recipes/create/CreateRecipePage.tsx` | Komponenter för receptskapande | +| **Importera recept** | `app/recipes/import/page.tsx` | Startpunkt för Markdown-import | +| | `app/recipes/import/ImportRecipePage.tsx` | 3-stegsvyn för Markdown-import | +| **Recipe detail** | `app/recipes/[id]/` | Enskilt recept (detaljer, redigering) | +| **Admin: Produkter** | `app/admin/products/page.tsx` | Produktadmin-panel | +| | `AdminProductList.tsx` | Lista produkter, sök, sortera | +| | `NameForm.tsx` | Redigera produktnamn | +| | `CanonicalNameForm.tsx` | Redigera canonical name | +| | `MergePreviewForm.tsx` | Förhandsgranska merge | + +### API-proxy routes (Next.js) + +| Route | Metod | Syfte | +|-------|-------|-------| +| `/api/parse-markdown-proxy` | POST | Proxies `POST /api/recipes/parse-markdown` (Markdown-tolkning) | +| `/api/inventory-history-proxy` | GET | Proxies konsumtionshistorik | +| `/api/recipe-preview-proxy` | GET | Proxies receptförhandsvisning | +| `/api/admin/merge-preview-proxy` | GET | Proxies produktmerge-preview | +| `/api/products` | GET | Lista/proxies produkter | + +### Frontend utbyggbarhet + +- Svenska felmeddelanden via `lib/error-handler.ts` (`parseErrorResponse`) +- Centraliserad API-access via `lib/api.ts` (`fetchJson`) +- Typade inventory/recipe data i `features/inventory/types.ts` --- -## Backend +## Backend (NestJS) - **Framework:** NestJS 10.3 - **Språk:** TypeScript 5.4.5 -- **Databas:** MariaDB 11 (via Prisma 6.12.0) +- **Databas:** MariaDB 11 (via Prisma 6.12.0 ORM) - **API:** REST, validering med class-validator - **Felhantering:** GlobalExceptionFilter (svenska felmeddelanden) -- **Hälsokontroll:** /health endpoint med status, uptime, DB-latens -- **Bygg:** Körs i Docker-container, byggs med nest build +- **Hälsokontroll:** /health endpoints +- **Bygg:** `nest build`, körs i Docker-container -### Funktioner (backend) +### Backend-moduler och strukturen läsa -- **Inventarie-API:** - - CRUD för hemmavaror - - Konsumtionshistorik (med enheter) - - Sortering och filtrering (plats, bäst före, namn) -- **Recept-API:** - - CRUD för recept och ingredienser - - Preview mot hemmavaror (räcker/saknas/enhetskonflikt) -- **Produkt-API:** - - CRUD för produkter - - Merge preview och canonical name -- **Felhantering:** - - Svenska felmeddelanden, 400/503 status -- **Hälsokontroll:** - - /health endpoint (200/503, DB-status, uptime) +``` +backend/src/ +├── app.module.ts # Root module +├── main.ts # Startpunkt (port 8080) +├── common/ +│ ├── filters/ +│ │ └── global-exception.filter.ts # Centraliserad felhantering +│ └── utils/ +│ └── normalize-name.ts # Namnormalisering +├── health/ +│ ├── health.controller.ts # GET /health, /health/db +│ ├── health.service.ts # Hälsotillstånd-logik +│ └── health.module.ts +├── inventory/ +│ ├── inventory.controller.ts # CRUD endpoints +│ ├── inventory.service.ts # CRUD + konsumtion +│ ├── inventory.module.ts +│ └── dto/ +│ ├── create-inventory.dto.ts +│ ├── update-inventory.dto.ts +│ └── consume-inventory.dto.ts +├── prisma/ +│ ├── prisma.service.ts # PrismaClient wrapper +│ └── prisma.module.ts +├── products/ +│ ├── products.controller.ts # CRUD, merge, duplicates +│ ├── products.service.ts # Produktlogik +│ ├── products.module.ts +│ └── dto/ +│ ├── create-product.dto.ts +│ ├── update-product.dto.ts +│ ├── merge-products.dto.ts +│ └── update-canonical-name.dto.ts +└── recipes/ + ├── recipes.controller.ts # Recept endpoints + ├── recipes.service.ts # Recept + Markdown-parsing + ├── recipes.module.ts + └── dto/ + ├── create-recipe.dto.ts + ├── parse-markdown.dto.ts + └── create-recipe-ingredient.dto.ts +``` + +### Backend-funktioner + +**Health API:** +- Övergripande systemstatus (uptime, service info) +- Databasspecifik hälsokontroll (responseTime, connection test) +- Returnerar statusCode 200 eller 503 + +**Inventarie-API:** +- CRUD för inventarieföremål (produktreferens, kvantitet, enhet, plats, märke, bäst före, mm) +- Konsumtionshistorik-tracking (registrera brukat amount och kommentar) +- Sortering: efter plats, bäst före-datum, namn (A–Ö) +- Filtrera utgående varor +- **Enhetskonvertering:** Stöd för viktenheter (g/kg), volymenheter (ml/dl), portionsenheter (tsk/msk) + - Normalisering av enheter (t.ex. "tesked" → "tsk", "gram" → "g") + - Konverteringsregler per enhet-typ + - Kan endast konvertera inom samma enhet-typ (error om blandning) + +**Recept-API:** +- CRUD för recept och ingredienser +- **Parse-markdown endpoint:** Tolkar Markdown-format, matchar ingredienser mot databas +- **Matchningsalgoritm (3 nivåer):** + 1. Exakt match (normalizedName eller canonicalName efter normalisering): **100 poäng** + 2. Delsträng-match (ingrediens i produktnamn eller vice versa): **70 poäng** + 3. Levenshtein-distans-baserad likhet: **40–100 poäng** (under 40 filtreras bort) + - Top 5 förslag per ingrediens + - Sortering: Högsta poäng först +- **Inventory-preview:** Jämför recept mot inventarie + - Returnerar status för varje ingrediens: räcker | saknas | enhetskonflikt + - Automatisk enhetskonvertering vid jämförelse +- **Normalisering:** `normalize-name()` utility för consistent namn-matching + +**Produkt-API:** +- CRUD för produkter (create, read, update, delete) +- **Duplicate detection:** `findDuplicates()` - Hitta produkter med samma normalizedName +- **Merge-preview:** `previewMerge()` - Förhandsgranska merge operation (visa inventory-counts, outcome) +- **Merge operation:** `merge()` - Slå ihop två produkter + - Flytta alla inventarieföremål från källa till mål + - Soft-delete källan (isActive = false, deletedAt = nu) + - Uppdatera recept-ingredienser från källa till mål +- **Canonical name management:** + - `updateCanonicalName()` - Uppdatera canonical name för ett produktnamn + - `backfillCanonical()` - Fylla på canonical names för alla produkter (admin-funktion) +- **Soft delete & restore:** + - `remove()` - Soft-delete produkt (isActive = false) + - `restore()` - Återställ borttagen produkt --- -## Infrastruktur & DevOps +## API-endpoints (fullständig lista) -- **Docker Compose:** Orkestrerar frontend, backend, databas och proxy -- **Caddy:** Reverse proxy, hanterar Next.js API routes och backend -- **Miljövariabler:** Hanterar DB-url, ports etc -- **Backup-script:** backup_recipe_app.sh +### 🏥 Health endpoints +``` +GET /health Övergripande hälsakontroll (200/503) +GET /health/db Databasspecifik hälsa + responseTime +``` + +### 📦 Inventarie-endpoints +``` +GET /api/inventory Lista inventarieföremål + Params: ?location=... &sort=... +GET /api/inventory/expiring Utgångna/snart utgångna varor +POST /api/inventory Skapa nytt inventarieföremål +PATCH /api/inventory/:id Uppdatera inventarieföremål +POST /api/inventory/:id/consume Konsumera (registrera brukat amount) +GET /api/inventory/:id/consumption-history Konsumtionshistorik +``` + +### 🍽️ Recept-endpoints +``` +POST /api/recipes/parse-markdown Tolka Markdown-recept (matchningslogik) +GET /api/recipes Lista alla recept +POST /api/recipes Skapa nytt recept +GET /api/recipes/:id Hämta specifikt recept +PATCH /api/recipes/:id Uppdatera recept +DELETE /api/recipes/:id Ta bort recept (204 No Content) +GET /api/recipes/:id/inventory-preview Jämför recept mot inventarie +``` + +### 🏷️ Produkt-endpoints +``` +GET /api/products Lista alla aktiva produkter +POST /api/products Skapa ny produkt +GET /api/products/:id Hämta specifik produkt +PATCH /api/products/:id Uppdatera produktens namn +DELETE /api/products/:id Soft-delete produkt +POST /api/products/:id/restore Återställ raderad produkt + +GET /api/products/duplicates Lista duplicerade namn (grupperade) +GET /api/products/merge-preview Förhandsgranska merge + ?sourceProductId=X &targetProductId=Y +POST /api/products/merge Slå ihop två produkter +PATCH /api/products/:id/canonical-name Uppdatera canonical name +POST /api/products/backfill-canonical Backfill canonical names (admin) +``` --- -## Viktiga filer & mappar +## Datamodell (Prisma ORM) -- `frontend/app/` – Next.js app directory (pages, komponenter) -- `backend/src/` – NestJS API (controllers, services, modules) -- `backend/prisma/schema.prisma` – Prisma datamodell -- `compose.yml` – Docker Compose setup -- `Caddyfile` – Proxyregler +### Product +```prisma +model Product { + id Int @id @default(autoincrement()) + name String # Visningsnamn + normalizedName String @unique # Normaliserat namn (lowercase, utan skiljetecken) + canonicalName String? # Canonical namn för receptmatchning + category String? # Produktkategori + isActive Boolean @default(true) # Soft-delete flag + deletedAt DateTime? # Tidpunkt för soft-delete + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt + + inventoryItems InventoryItem[] + recipeIngredients RecipeIngredient[] +} +``` + +### InventoryItem +```prisma +model InventoryItem { + id Int @id @default(autoincrement()) + productId Int # Foreign key till Product + quantity Decimal @db.Decimal(10, 2) # Kvantitet (decimal för precision) + unit String # Enhet (g, kg, ml, dl, st, tsk, msk, etc) + brand String? # Varumärke + location String? # Lagerplats (Kyl, Frys, Skafferi, etc) + priority Int? # Prioritetsordning + purchaseDate DateTime? # Köpdatum + opened Boolean? # Markering för öppnad produkt + shelfNote String? # Lagringsnot + suitableFor String? # Lämplighetsmärkning (t.ex. "vegetarian") + isOnSale Boolean? # Är på rea + priceLevel Int? # Priskategori (1–5) + bestBeforeDate DateTime? # Bäst före-datum + proteinType String? # Proteintyp (t.ex. "beef", "chicken") + isLeftover Boolean? # Är från tidigare lagnning + comment String? # Fri kommentar + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt + + product Product @relation(fields: [productId], references: [id], onDelete: Cascade) + consumptions InventoryConsumption[] + + @@index([productId]) +} +``` + +### InventoryConsumption +```prisma +model InventoryConsumption { + id Int @id @default(autoincrement()) + inventoryItemId Int # Foreign key till InventoryItem + amountUsed Decimal @db.Decimal(10, 2) # Konsumerad kvantitet + comment String? # Kommentar + createdAt DateTime @default(now()) + + inventoryItem InventoryItem @relation(fields: [inventoryItemId], references: [id]) +} +``` + +### Recipe +```prisma +model Recipe { + id Int @id @default(autoincrement()) + name String # Receptnamn + description String? # Receptbeskrivning + instructions String? @db.Text # Tillagningsinstruktioner (kan vara långt, stöder Markdown) + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt + + ingredients RecipeIngredient[] +} +``` + +### RecipeIngredient +```prisma +model RecipeIngredient { + id Int @id @default(autoincrement()) + recipeId Int # Foreign key till Recipe + productId Int # Foreign key till Product + quantity Decimal @db.Decimal(10, 2) # Receptkvantitet + unit String # Enhet enligt recept + note String? # Ingrediensnot (t.ex. variation) + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt + + recipe Recipe @relation(fields: [recipeId], references: [id]) + product Product @relation(fields: [productId], references: [id]) +} +``` --- -## Funktionell översikt - -### Hemmavaror -- Lägg till, redigera, ta bort och konsumera varor -- Sök, filtrera (plats), sortera (bäst före, namn) -- Konsumtionshistorik med enheter - -### Recept -- Skapa, redigera, ta bort recept -- Jämför mot hemmavaror (räcker/saknas/enhetskonflikt) -- Visar instruktioner och saknade ingredienser -- **Importera recept från Markdown** (se nedan) - -### Produkter (Admin) -- Sök, sortera, redigera canonical name -- Merge preview - -### Hälsa & Fel -- /health endpoint (status, uptime, DB) -- Svenska felmeddelanden i hela systemet - ---- - -## Exempel på API-endpoints - -- `GET /api/inventory` – Lista hemmavaror -- `POST /api/inventory` – Lägg till vara -- `PATCH /api/inventory/:id` – Uppdatera vara -- `DELETE /api/inventory/:id` – Ta bort vara -- `GET /api/recipes` – Lista recept -- `POST /api/recipes` – Skapa recept -- `PATCH /api/recipes/:id` – Uppdatera recept -- `DELETE /api/recipes/:id` – Ta bort recept -- `POST /api/recipes/parse-markdown` – Tolka Markdown-recept (se nedan) -- `GET /api/products` – Lista produkter -- `PATCH /api/products/:id` – Uppdatera produkt -- `GET /health` – Hälsokontroll - ---- - ---- - -## Receptimport via Markdown +## Receptimport via Markdown — Detaljerad arkitektur ### Syfte -Användaren kan importera ett recept skrivet i ett enkelt Markdown-format istället för att fylla i formularet manuellt. Systemet tolkar texten, föreslår matchande produkter från databasen och låter användaren granska och bekräfta innan receptet sparas. +Användaren kan importera ett recept skrivet i Markdown-format istället för att fylla i formularet manuellt. Systemet: +1. Tolkar Markdown-format (namn, beskrivning, ingredienser, instruktioner) +2. Matchar varje ingrediens mot produktdatabasen (intelligenta matchningar) +3. Låter användaren granska förslag och välja rätt produkt +4. Sparar receptet med valida ingredienser -### Markdown-format +### Markdown-format och parsningsregler +**Format:** ```markdown # Receptnamn @@ -163,195 +350,327 @@ Valfri beskrivning av receptet. ## Ingredienser - 500 g köttfärs - 1 st lök -- 2 msk tomatpuré +- 2.5 msk tomatpuré - 1 dl grädde (vispgrädde) +- salt ## Tillvägagångssätt -Stek löken i lite smör. Tillsats köttfärsen... +Stek löken i lite smör. Tillsätt köttfärsen… ``` -Regler: -- Rad med `#` tolkas som receptnamn -- Text mellan `#`-rubriken och `## Ingredienser` tolkas som beskrivning -- Rader under `## Ingredienser` med mönstret `- ANTAL ENHET NAMN` tolkas som ingredienser -- Text i parentes efter ingrediensnamnet (`(vispgrädde)`) sparas som anteckning -- Text under `## Tillvägagångssätt` (eller `## Instruktioner`) tolkas som instruktioner - -### Arkitektur +**Parsningsregler i detalj:** +| Element | Tolkning | +|---------|----------| +| `# Rubrik` | Receptnamn (första H1) | +| Text mellan H1 och `## Ingredienser` | Receptbeskrivning (flera rader OK, valfritt) | +| `## Ingredienser` | Ingred markerare (case-insensitive) | +| `- ANTAL ENHET NAMN` | Ingrediens: quantity=ANTAL, unit=ENHET, name=NAMN | +| `- ANTAL NAMN` | Ingrediens utan enhet: unit sätts till "st" | +| `- NAMN` | Ingrediens utan kvantitet: quantity=0, unit="" | +| `(text i parentes)` | Ingrediensnot (sparas, t.ex. "vispgrädde") | +| `## Tillvägagångssätt` / `## Instruktioner` | Instruktionssektion markerare | +| Text under instruktioner | Tillagningsinstruktioner (flera rader OK) | +**Exempel ingrediensparsning:** ``` -Användaren Frontend Backend Bibliotek -(klistrar in MD) → /recipes/import → POST /api/ → recipe-document- - ImportRecipePage recipes/ converter/ - parse-markdown parseRecipeMarkdown() - ↑ - Granskar förslag - Väljer produkter - ↓ - POST /api/recipes (befintlig endpoint) +"- 500 g köttfärs" → {quantity: 500, unit: "g", rawName: "köttfärs"} +"- 1,5 dl grädde (vispgrädde)" → {quantity: 1.5, unit: "dl", rawName: "grädde", note: "vispgrädde"} +"- 3 ägg" → {quantity: 3, unit: "st", rawName: "ägg"} +"- salt" → {quantity: 0, unit: "", rawName: "salt"} ``` -### Komponenterna +### Komponenter och dataflöde -#### `recipe-document-converter/` (fristående TypeScript-bibliotek) +#### 1. `recipe-document-converter/` bibliotek -Ett eget npm-paket som inte har externa beroenden. Det enda som exporteras är: +**Modulstruktur:** +- `src/parser.ts` — Markdown-parser med ingrediensparsning +- `src/index.ts` — Biblioteksexport +- `package.json` — npm-paket (noll externa beroenden) +- `tsconfig.json` — TypeScript-konfiguration +**Huvudexport:** ```typescript -parseRecipeMarkdown(markdown: string): ParsedRecipe -``` +export function parseRecipeMarkdown(markdown: string): ParsedRecipe -Returnerar: -```typescript -type ParsedRecipe = { +interface ParsedRecipe { name: string; - description?: string; - instructions?: string; - ingredients: Array<{ - rawName: string; // fråntext, t.ex. "köttfärs" - quantity: number; // t.ex. 500 - unit: string; // t.ex. "g" - note?: string; // text i parentes, t.ex. "nötfärs" - }>; -}; + description: string; # Kan vara tom + instructions: string; # Kan vara tom + ingredients: ParsedIngredient[]; +} + +interface ParsedIngredient { + rawName: string; # Extraherat ingrediensnamn + quantity: number; # Numerisk kvantitet (eller 0 om ingen) + unit: string; # Enhet (eller "" om ingen) + note: string | null; # Text i parentes (eller null) +} ``` -Biblioteket kompileras i ett separat Docker-byggsteg och länkas till backend via `"recipe-document-converter": "file:../recipe-document-converter"` i `backend/package.json`. +**Ingrediensparsning i detalj:** +- Försöker matcha regex `(\d+(?:[.,]\d+)?)\s+(\S+)\s+(.+)` för "ANTAL ENHET NAMN" +- Fallback: `(\d+(?:[.,]\d+)?)\s+(.+)` för "ANTAL NAMN" (unit → "st") +- Fallback: bara namn, quantity=0, unit="" +- Kommatecken i tal: `,` → `.` (t.ex. "1,5" blir 1.5) +- Parentes-extraktion: Matchar sista `(text)` i raden -#### Backend — `POST /api/recipes/parse-markdown` +**Byggning:** +- TypeScript → JavaScript via `tsc` +- Separerad npm-modul +- Kompileras i Docker-build steg 1 (converter-build) -Endpoint som tar emot `{ markdown: string }` och returnerar det tolkade receptet åtsamman med produktmatchförslag för varje ingrediens. +#### 2. Backend: `POST /api/recipes/parse-markdown` endpoint -Matchningslogik: -1. Anropar `parseRecipeMarkdown()` från biblioteket -2. Hämtar alla aktiva produkter ur databasen -3. Jämför varje ingrediensnamn mot `product.canonicalName` / `product.normalizedName` med tre metoder i ordning: - - **Exakt match** (efter normalisering) → 100 poäng - - **Delsträngsmatch** → 70 poäng - - **Levenshtein-likhet** → 0–100 poäng (filtreras under 40) -4. Returnerar upp till 5 förslag per ingrediens, sorterade efter poäng +**Klassbank:** +- `recipe-document-converter` — Markdown-parser +- `@prisma/client` — Databasaccess +- Common utils: `normalize-name.ts` -Svar: +**Processflöde:** + +``` +1. Motta: ParseMarkdownDto { markdown: string } +2. Anropa parseRecipeMarkdown() → ParsedRecipe +3. Hämta alla aktiva produkter från DB +4. För varje ingrediens: + a. Normalisera: lowercase + trim + remove accents/punctuation + b. Matchningsalgoritm (se nedan) + c. Top 5 förslag sortera efter score +5. Returnera ParsedRecipe + suggestions +``` + +**Matchningsalgoritm:** +``` +Normalisering: lowercase + trim + åäö-handling + skilljetecken-borttagning + +1. EXAKT MATCH (100 poäng) + IF (ingrediens == product.canonicalName_normalized) OR + (ingrediens == product.normalizedName_normalized) + THEN score = 100 + +2. DELSTRÄNG-MATCH (70 poäng) + IF (ingrediens IN product.name_normalized) OR + (product.name_normalized IN ingrediens) + THEN score = 70 + +3. LEVENSHTEIN-LIKHET (40–100 poäng) + Calculate Levenshtein distance between ingrediens and product.name_normalized + similarity% = (1 - (distance / max_length)) * 100 + IF similarity% >= 40 THEN score = similarity% + ELSE filter out + +Sortering: Högsta poäng först +Top 5: Max 5 förslag per ingrediens +``` + +**Svarsobjekt:** ```json { "name": "Köttfärssås", - "description": "En klassisk...", - "instructions": "Stek löken...", + "description": "En klassisk…", + "instructions": "Stek löken…", "ingredients": [ { "rawName": "köttfärs", "quantity": 500, "unit": "g", + "note": null, "suggestions": [ { "productId": 12, "productName": "Köttfärs", "score": 100 }, - { "productId": 34, "productName": "Blandfärs", "score": 55 } + { "productId": 34, "productName": "Blandfärs", "score": 65 }, + { "productId": 56, "productName": "Nötfärs", "score": 55 } ] } ] } ``` -#### Frontend — `/recipes/import` +#### 3. Frontend: `/recipes/import` page -En 3-stegsvy (client component): +**Komponenter:** +- `ImportRecipePage.tsx` — Main client component (3-steps state machine) +- Använder `/api/parse-markdown-proxy` för backend-anrop (Next.js proxy) -| Steg | Innehåll | -|------|----------| -| 1. Klistra in | Textarea för Markdown + "Tolka recept"-knapp | -| 2. Granska | Redigerbara fält för namn/beskrivning/instruktioner; varje ingrediens har en dropdown med föreslagna produkter överst, sedan alla produkter | -| 3. Spara | Knapp som POSTar till befintlig `POST /api/recipes` | +**Steg 1: Klistra in Markdown** +- `