seb/dashlibstorage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rewrite store JSDoc, split quote/order into modules, and generate typed API docs

Browse Source 
- Rewrite JSDoc across all store methods to document the actual async
  methods (real params, returns, throws) instead of the internal wrappers
- Split quote/order into individual module files backed by shared
  manifestDoc helpers; remove the createStore factory and thin wrappers
- Deduplicate manifest line helpers into src/store/manifestLines.js
- Extend generate-api-doc.js to render parameter/return/throws types and
  emit per-namespace API.<module>.md files with an API.md index
- Regenerate all API docs
This commit is contained in:
seb
2026-08-07 06:23:17 +02:00
parent 396389457f
commit aefd97a171
127 changed files with 3956 additions and 1684 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.cursor/rules/sibling-repos.mdc
View File

@@ -29,7 +29,9 @@ Wenn ein Vertrag unklar oder fehlt: **nicht weiterwursteln**. Human fragen, Vors
| Repo | Pfad | Inhalt |
|------|------|--------|
| **dieses** | `README.md` | Store-Methoden, Signaturen, Returns — Vertrag für dashback |
| **dieses** | `README.md` | Store-Übersicht, Konventionen, HTTP-Mapping — Vertrag für dashback |
| **dieses** | `API.md` | Store-API-Index (TOC → `API.<modul>.md`) |
| **dieses** | `API.<modul>.md` | pro Namespace: Methoden, Signaturen, JSDoc-Beispiele (`npm run api-doc`) |
| **dieses** | `src/schema.js`, `src/store/` | Schema + Implementierung |
| dashback | `../dashback/docs/api/README.md` | HTTP-Routen-Index |
| dashback | `../dashback/docs/api/routes/` | eine Markdown-Datei pro Endpoint |
@@ -38,6 +40,6 @@ Wenn ein Vertrag unklar oder fehlt: **nicht weiterwursteln**. Human fragen, Vors
## Was der Human / dashback von dir erwarten
1. **README.md aktuell halten**, wenn Store-Methoden oder Returns sich ändern — dashback baut Services darauf.
1. **README.md** und **`API.md` / `API.<modul>.md`** aktuell halten, wenn Store-Methoden oder Returns sich ändern (`npm run api-doc`) — dashback baut Services darauf.
2. Schema-Änderungen so, dass `npm run reset-db` den Zielzustand abbildet; Live-DB nur manuell per `sqlcmd` (Human).
3. Bei API-Bedarf aus dem Frontend: dashback-Docs/Logs lesen; fehlende HTTP-Schicht dem Human melden, nicht in dashback implementieren.