db-model-router 1.0.12 → 1.0.14

package/README.md

@@ -114,7 +114,8 @@ When a table has `parent` set, the CLI automatically:
 
 1. Creates a child route file scoped by the parent's PK as a URL parameter
 2. Mounts the child routes under the parent path
-3. Also mounts the child as a top-level route for direct access
+
+Intermediate tables that are both a child and a parent (e.g. `campaign` under `project`, with `campaign_recipient` under it) get a hybrid route file that scopes their own CRUD by the ancestor parameter and mounts their own children. Children are **only** available under their parent path — there is no duplicate top-level route.
 
 #### Best Practice: Don't Use System Tables as Parents
 
@@ -191,8 +192,7 @@ This generates routes:
 
 - `GET /users/`, `GET /users/:user_id` — top-level
 - `GET /posts/`, `GET /posts/:post_id` — top-level
-- `GET /posts/:post_id/comments/`, `GET /posts/:post_id/comments/:comment_id` — nested under posts
-- `GET /comments/`, `GET /comments/:comment_id` — also available as top-level
+- `GET /posts/:post_id/comments/`, `GET /posts/:post_id/comments/:comment_id` — nested under posts (not available as top-level)
 
 Note: `comments` has `user_id` as a foreign key column but `users` is NOT its parent — `posts` is. The `user_id` is just a data reference, not a route hierarchy.
 
@@ -202,7 +202,7 @@ Note: `comments` has `user_id` as a foreign key column but `users` is NOT its pa
 | ------------ | -------- | ------------------------------------------------------------------------ |
 | `columns`    | Yes      | Object mapping column names to Column_Rule strings (include ALL columns) |
 | `pk`         | Yes      | Primary key column name (convention: `<table>_id`)                       |
-| `unique`     | No       | Array of unique constraint columns (defaults to `[pk]`)                  |
+| `unique`     | No       | Unique constraint columns. Flat array = one composite group; array-of-arrays = multiple independent constraints. Defaults to `[[pk]]`. |
 | `softDelete` | No       | Column name used for soft-delete                                         |
 | `timestamps` | No       | Object with `created_at` and `modified_at` column name mapping           |
 | `parent`     | No       | Parent table name for route nesting, or `null` for top-level             |
@@ -278,7 +278,7 @@ All subcommands accept these flags:
 # 1. Introspect an existing database into a schema file
 db-model-router inspect --type postgres --env .env
 
-# 2. (Optional) Edit dbmr.schema.json to add relationships, tweak columns, etc.
+# 2. (Optional) Edit dbmr.schema.json to tweak columns, set parent for nesting, etc.
 
 # 3. Generate all artifacts from the schema
 db-model-router generate --from dbmr.schema.json
@@ -340,9 +340,7 @@ Generated project structure (with `--output backend`):
 ├── .gitignore
 ├── Dockerfile                # node:alpine production image
 ├── .dockerignore
-├── docker-compose.yml        # database + CloudBeaver + optional Loki/Grafana
-├── .cloudbeaver/
-│   └── data-sources.json     # auto-connects CloudBeaver to your DB
+├── docker-compose.yml        # database + optional Loki/Grafana
 ├── .grafana/                 # (only when --loki)
 │   └── datasources.yml       # auto-connects Grafana to Loki
 └── backend/
@@ -367,7 +365,6 @@ Docker services included automatically:
 | ----------- | ------------------------------------- | ------ | -------------------------------------- |
 | Database    | Always (except sqlite3)               | Varies | Selected database with random password |
 | Redis       | `--session redis` (if DB isn't redis) | 6379   | Session store                          |
-| CloudBeaver | SQL/MongoDB databases                 | 8978   | Web-based DB admin, auto-connected     |
 | Loki        | `--loki`                              | 3100   | Log aggregation                        |
 | Grafana     | `--loki`                              | 3001   | Log visualization, Loki pre-configured |
 
@@ -397,6 +394,7 @@ Generate models, routes, tests, OpenAPI spec, and LLM docs from a schema file. A
 | Flag / Arg               | Description                                       |
 | ------------------------ | ------------------------------------------------- |
 | `--from <path>`          | Path to schema file (default: `dbmr.schema.json`) |
+| `--output <dir>`         | Directory for generated files (default: cwd)      |
 | `--models=false`         | Disable model file generation                     |
 | `--routes=false`         | Disable route file generation                     |
 | `--openapi=false`        | Disable OpenAPI spec generation                   |
@@ -427,6 +425,7 @@ db-model-router generate --tests=false --dry-run       # skip tests
 db-model-router generate --saas-structure=false        # skip SaaS generation
 db-model-router generate --openapi=false --tests=false # skip OpenAPI and tests
 db-model-router generate --from dbmr.schema.json --json
+db-model-router generate --from dbmr.schema.json --output ./backend
 ```
 
 #### `doctor`

package/dbmr.postgres.schema.json

@@ -0,0 +1,269 @@
+{
+  "adapter": "postgres",
+  "framework": "express",
+  "options": {
+    "session": "redis",
+    "rateLimiting": true,
+    "helmet": true,
+    "logger": true,
+    "loki": false
+  },
+  "tables": {
+    "projects": {
+      "columns": {
+        "project_id": "auto_increment",
+        "name": "required|string|minLength:3|maxLength:300",
+        "slug": "required|string|regex:^[a-z0-9-]+$|maxLength:300",
+        "description": "string:text|maxLength:5000",
+        "status": "required|string|in:active,archived,paused",
+        "priority": "integer|between:1,5",
+        "budget": "numeric:decimal(10,2)|min:0",
+        "currency": "string|minLength:3|maxLength:3",
+        "start_date": "datetime",
+        "due_date": "datetime",
+        "owner_id": "required|integer",
+        "settings": "object",
+        "settings.notifications": "boolean",
+        "settings.theme": "string|in:light,dark,auto",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "project_id",
+      "unique": ["slug"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": null
+    },
+    "tasks": {
+      "columns": {
+        "task_id": "auto_increment",
+        "project_id": "required|integer",
+        "title": "required|string|minLength:3|maxLength:500",
+        "description": "string:text|maxLength:10000",
+        "status": "required|string|in:todo,in_progress,in_review,done,blocked",
+        "priority": "required|string|in:low,medium,high,critical",
+        "assignee_id": "integer",
+        "estimated_hours": "numeric:decimal(6,2)|min:0",
+        "actual_hours": "numeric:decimal(6,2)|min:0",
+        "due_date": "datetime",
+        "completed_at": "datetime",
+        "tags": "object",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "task_id",
+      "unique": ["task_id"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": "projects"
+    },
+    "comments": {
+      "columns": {
+        "comment_id": "auto_increment",
+        "task_id": "required|integer",
+        "user_id": "required|integer",
+        "body": "required|string:text|maxLength:5000",
+        "is_edited": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "comment_id",
+      "unique": ["comment_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": "tasks"
+    },
+    "attachments": {
+      "columns": {
+        "attachment_id": "auto_increment",
+        "task_id": "required|integer",
+        "file_name": "required|string|maxLength:500",
+        "file_url": "required|string|url|maxLength:2048",
+        "mime_type": "required|string|maxLength:100",
+        "file_size": "integer:bigint|min:0",
+        "uploaded_by": "required|integer",
+        "created_at": "datetime"
+      },
+      "pk": "attachment_id",
+      "unique": ["attachment_id"],
+      "timestamps": {
+        "created_at": "created_at"
+      },
+      "parent": "tasks"
+    },
+    "customers": {
+      "columns": {
+        "customer_id": "auto_increment",
+        "email": "required|string|email|maxLength:300",
+        "phone": "string|phoneNumber|maxLength:20",
+        "first_name": "required|string|maxLength:200",
+        "last_name": "required|string|maxLength:200",
+        "company": "string|maxLength:300",
+        "notes": "string:text|maxLength:5000",
+        "metadata": "object",
+        "metadata.source": "string|in:web,api,import,in_person",
+        "metadata.verified": "boolean",
+        "is_active": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "customer_id",
+      "unique": ["email"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": null
+    },
+    "invoices": {
+      "columns": {
+        "invoice_id": "auto_increment",
+        "customer_id": "required|integer",
+        "invoice_number": "required|string|alphaDash|maxLength:50",
+        "status": "required|string|in:draft,sent,paid,overdue,cancelled",
+        "subtotal": "required|numeric:money|min:0",
+        "tax_rate": "numeric:decimal(5,4)|between:0,1",
+        "tax_amount": "required|numeric:money|min:0",
+        "total": "required|numeric:money|min:0",
+        "currency": "required|string|minLength:3|maxLength:3",
+        "due_date": "datetime",
+        "paid_at": "datetime",
+        "notes": "string:text|maxLength:5000",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "invoice_id",
+      "unique": ["invoice_number"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": "customers"
+    },
+    "invoice_items": {
+      "columns": {
+        "invoice_item_id": "auto_increment",
+        "invoice_id": "required|integer",
+        "description": "required|string|maxLength:500",
+        "quantity": "required|integer:unsigned|min:1",
+        "unit_price": "required|numeric:money|min:0",
+        "amount": "required|numeric:money|min:0",
+        "created_at": "datetime"
+      },
+      "pk": "invoice_item_id",
+      "unique": ["invoice_item_id"],
+      "timestamps": {
+        "created_at": "created_at"
+      },
+      "parent": "invoices"
+    },
+    "documents": {
+      "columns": {
+        "document_id": "auto_increment",
+        "title": "required|string|minLength:3|maxLength:500",
+        "slug": "required|string|regex:^[a-z0-9-]+$|maxLength:500",
+        "content": "required|string:text|maxLength:50000",
+        "excerpt": "string|maxLength:500",
+        "status": "required|string|in:draft,published,archived",
+        "author_id": "required|integer",
+        "featured": "boolean",
+        "tags": "object",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "document_id",
+      "unique": ["slug"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": null
+    },
+    "categories": {
+      "columns": {
+        "category_id": "auto_increment",
+        "name": "required|string|minLength:3|maxLength:200",
+        "slug": "required|string|regex:^[a-z0-9-]+$|maxLength:200",
+        "description": "string:text|maxLength:2000",
+        "sort_order": "integer",
+        "is_active": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "category_id",
+      "unique": ["slug"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": null
+    },
+    "events": {
+      "columns": {
+        "event_id": "auto_increment",
+        "name": "required|string|minLength:3|maxLength:300",
+        "description": "string:text|maxLength:5000",
+        "location": "required|string|maxLength:500",
+        "start_time": "required|datetime",
+        "end_time": "datetime",
+        "capacity": "integer:unsigned|min:1",
+        "price": "numeric:money|min:0",
+        "currency": "string|minLength:3|maxLength:3",
+        "status": "required|string|in:upcoming,ongoing,completed,cancelled",
+        "organizer_id": "required|integer",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "modified_at": "datetime"
+      },
+      "pk": "event_id",
+      "unique": ["event_id"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "modified_at"
+      },
+      "parent": null
+    }
+  },
+  "relationships": [
+    {
+      "parent": "projects",
+      "child": "tasks",
+      "foreignKey": "project_id"
+    },
+    {
+      "parent": "tasks",
+      "child": "comments",
+      "foreignKey": "task_id"
+    },
+    {
+      "parent": "tasks",
+      "child": "attachments",
+      "foreignKey": "task_id"
+    },
+    {
+      "parent": "customers",
+      "child": "invoices",
+      "foreignKey": "customer_id"
+    },
+    {
+      "parent": "invoices",
+      "child": "invoice_items",
+      "foreignKey": "invoice_id"
+    }
+  ]
+}