@pukujan/create-modular-monolith 2.0.0 → 2.2.0

package/template/docs/model-condenser/API.md

@@ -0,0 +1,102 @@
+# Model condenser — HTTP API
+
+**Base path:** `/api/model-condenser`
+
+Scans the repo and writes a **schema inventory** (`models/consolidated-models.json`). This is unrelated to case eval reports or `eval-bundles/`.
+
+**Routes:** [`backend/src/modules/model-condenser/routes/modelCondenser.routes.js`](../../backend/src/modules/model-condenser/routes/modelCondenser.routes.js)
+
+**Contract:** [API documentation contract](../architecture/API_DOCUMENTATION_CONTRACT.md)
+
+---
+
+## Endpoint quick reference
+
+| Method | Path | Description |
+|--------|------|-------------|
+| GET | `/health` | Module health |
+| POST | `/condense` | Regenerate consolidated-models.json |
+| GET | `/consolidated` | Read consolidated schema inventory |
+
+---
+
+## Health
+
+| Method | Path | Description |
+|--------|------|-------------|
+| GET | `/health` | Module health |
+
+---
+
+## Condense
+
+### `POST /condense`
+
+Regenerate `models/consolidated-models.json` from repo sources.
+
+**Body (JSON, optional):**
+
+```json
+{ "includePayload": false }
+```
+
+| Field | Default | Description |
+|-------|---------|-------------|
+| `includePayload` | `false` | If `true`, include full consolidated document in response |
+
+**Response 201:**
+
+```json
+{
+  "status": "written",
+  "outputPath": "/abs/path/models/consolidated-models.json",
+  "outputRelativePath": "models/consolidated-models.json",
+  "modelCount": 42,
+  "exampleInstanceCount": 10,
+  "generatedAt": "2026-05-23T..."
+}
+```
+
+**CLI equivalent:** `npm run condense-models` (from `backend/`)
+
+---
+
+## Read consolidated file
+
+### `GET /consolidated`
+
+**Query:**
+
+| Param | Description |
+|-------|-------------|
+| `includePayload=true` | Return full `consolidated` object in addition to summary |
+
+**Response 200 (summary):**
+
+```json
+{
+  "status": "ready | missing",
+  "exists": true,
+  "outputPath": "...",
+  "outputRelativePath": "models/consolidated-models.json",
+  "generatedAt": "...",
+  "modelCount": 42
+}
+```
+
+**404** if file missing — run `POST /condense` first.
+
+---
+
+## Environment variables
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `MODEL_CONDENSER_OUTPUT_DIR` | `{repo}/models` | Output directory |
+| `MODEL_CONDENSER_OUTPUT_FILE` | `consolidated-models.json` | Output filename |
+
+---
+
+## Tests
+
+`backend/src/modules/model-condenser/tests/integration/modelCondenser.routes.test.js`

package/template/file-exchange/README.md

@@ -0,0 +1,41 @@
+# File exchange
+
+Dated folders for human ↔ agent file handoff. **No sensitive filing text in git** — use synthetic fixtures only.
+
+## Layout
+
+```text
+file-exchange/
+  imports/{2026-05-23_15-59-43Z}/          ← inbound bundles
+  exports/{2026-05-23_15-59-43Z_...}/      ← session deliverables (batch runs, curl logs)
+  exports/consolidated-models.json         ← repo snapshots (regenerate with condense:all)
+  exports/consolidated-prompts.json
+  exports/consolidated-file-structure.json
+```
+
+**Stamp format:** `YYYY-MM-DD_HH-MM-SSZ` via `formatExchangeTimestamp()` in `backend/src/shared/utils/formatExchangeTimestamp.js`.
+
+## Consolidated exports (in `exports/`)
+
+```bash
+npm run condense:all
+```
+
+| File in `exports/` | Mirror (API) |
+|--------------------|--------------|
+| `consolidated-models.json` | `models/consolidated-models.json` |
+| `consolidated-prompts.json` | `models/consolidated-prompts.json` |
+| `consolidated-file-structure.json` | `models/consolidated-file-structure.json` |
+
+**Open `file-exchange/exports/`** — all three consolidated files sit next to dated batch export folders.
+
+## Workflow
+
+1. Triage loose files into `imports/{stamp}/` (`npm run import:file-exchange -- <path>`).
+2. Process via your domain module APIs using files **under that stamp** only.
+3. Copy batch bundles / reports to `exports/{stamp}/` when done.
+4. Refresh consolidated snapshots: `npm run condense:all`.
+
+**Cursor agents:** mandatory — see [AGENTS.md](../AGENTS.md) and `.cursor/rules/file-exchange-inbox.mdc`.
+
+See [docs/architecture/REPO_ARTIFACT_LAYOUT.md](../docs/architecture/REPO_ARTIFACT_LAYOUT.md).