db-model-router 1.0.5 → 1.0.6

package/src/cli/generate-model.js

@@ -544,7 +544,9 @@ function generateModelFile(m) {
     if (opt.modified_at) parts.push(`modified_at: "${opt.modified_at}"`);
     optionStr = `\n  { ${parts.join(", ")} },`;
   }
-  return `const { db, model } = require("db-model-router");
+  return `import dbModelRouter from "db-model-router";
+
+const { db, model } = dbModelRouter;
 
 const ${varName} = model(
   db,
@@ -554,7 +556,7 @@ const ${varName} = model(
   ${uniqueStr},${optionStr}
 );
 
-module.exports = ${varName};
+export default ${varName};
 `;
 }
 
@@ -563,11 +565,14 @@ function generateIndexFile(models) {
   let exports = "";
   for (const m of models) {
     const varName = safeVarName(m.table);
-    imports += `const ${varName} = require("./${m.table}");\n`;
+    imports += `import ${varName} from "./${m.table}.js";\n`;
     exports += `  ${varName},\n`;
   }
   return `${imports}
-module.exports = {
+export {
+${exports}};
+
+export default {
 ${exports}};
 `;
 }

package/src/cli/generate-openapi.js

@@ -5,6 +5,13 @@ function generateOpenAPISpec(models, options = {}) {
   const basePath = options.basePath || "/api";
   const title = options.title || "REST Router API";
   const version = options.version || "1.0.0";
+  const relationships = options.relationships || [];
+
+  // Build a lookup: child table -> { parent, foreignKey }
+  const childMap = {};
+  for (const rel of relationships) {
+    childMap[rel.child] = { parent: rel.parent, foreignKey: rel.foreignKey };
+  }
 
   const spec = {
     openapi: "3.0.3",
@@ -39,14 +46,34 @@ function generateOpenAPISpec(models, options = {}) {
     };
 
     const ref = { $ref: `#/components/schemas/${schemaName}` };
-    const prefix = `${basePath}/${m.table}`;
+
+    // Determine path prefix: nested under parent if this is a child table
+    let prefix;
+    const isChild = !!childMap[m.table];
+    let fkParam = null;
+    if (isChild) {
+      const { parent, foreignKey } = childMap[m.table];
+      prefix = `${basePath}/${parent}/{${foreignKey}}/${m.table}`;
+      fkParam = {
+        name: foreignKey,
+        in: "path",
+        required: true,
+        schema: { type: "string" },
+        description: `${capitalize(parent)} foreign key`,
+      };
+    } else {
+      prefix = `${basePath}/${m.table}`;
+    }
+
+    // Helper: prepend FK path param for child routes
+    const withFk = (params) => (fkParam ? [fkParam, ...params] : params);
 
     // GET / — list
     spec.paths[`${prefix}/`] = {
       get: {
         tags: [tag],
         summary: `List ${m.table}`,
-        parameters: [
+        parameters: withFk([
           {
             name: "page",
             in: "query",
@@ -69,7 +96,7 @@ function generateOpenAPISpec(models, options = {}) {
             in: "query",
             schema: { type: "string", enum: ["json", "csv", "xml"] },
           },
-        ],
+        ]),
         responses: {
           200: {
             description: "Success",
@@ -141,7 +168,7 @@ function generateOpenAPISpec(models, options = {}) {
       get: {
         tags: [tag],
         summary: `Get ${m.table} by ${pk}`,
-        parameters: [
+        parameters: withFk([
           { name: pk, in: "path", required: true, schema: { type: "string" } },
           { name: "select_columns", in: "query", schema: { type: "string" } },
           {
@@ -149,7 +176,7 @@ function generateOpenAPISpec(models, options = {}) {
             in: "query",
             schema: { type: "string", enum: ["json", "csv", "xml"] },
           },
-        ],
+        ]),
         responses: {
           200: {
             description: "Success",
@@ -161,9 +188,9 @@ function generateOpenAPISpec(models, options = {}) {
       post: {
         tags: [tag],
         summary: `Insert a ${m.table}`,
-        parameters: [
+        parameters: withFk([
           { name: pk, in: "path", required: true, schema: { type: "string" } },
-        ],
+        ]),
         requestBody: { content: { "application/json": { schema: ref } } },
         responses: {
           200: {
@@ -175,9 +202,9 @@ function generateOpenAPISpec(models, options = {}) {
       put: {
         tags: [tag],
         summary: `Update a ${m.table}`,
-        parameters: [
+        parameters: withFk([
           { name: pk, in: "path", required: true, schema: { type: "string" } },
-        ],
+        ]),
         requestBody: { content: { "application/json": { schema: ref } } },
         responses: {
           200: {
@@ -190,9 +217,9 @@ function generateOpenAPISpec(models, options = {}) {
       patch: {
         tags: [tag],
         summary: `Partial update a ${m.table}`,
-        parameters: [
+        parameters: withFk([
           { name: pk, in: "path", required: true, schema: { type: "string" } },
-        ],
+        ]),
         requestBody: {
           content: { "application/json": { schema: { type: "object" } } },
         },
@@ -207,9 +234,9 @@ function generateOpenAPISpec(models, options = {}) {
       delete: {
         tags: [tag],
         summary: `Delete a ${m.table}`,
-        parameters: [
+        parameters: withFk([
           { name: pk, in: "path", required: true, schema: { type: "string" } },
-        ],
+        ]),
         responses: {
           200: { description: "Deleted" },
           404: { description: "Not Found" },

package/src/cli/generate-route.js

@@ -100,6 +100,12 @@ function generateRoutesIndexFile(tableNames, relationships = [], options = {}) {
     imports += `router.use("/docs", docsRoute);\n`;
   }
 
+  // Mount child routes BEFORE parent routes to prevent path clashing
+  for (const rel of relationships) {
+    const childVar = safeVarName(rel.child);
+    imports += `router.use("/${rel.parent}/:${rel.foreignKey}/${rel.child}", ${childVar}ChildRoute);\n`;
+  }
+
   // Mount top-level routes
   for (const table of tableNames) {
     if (nestedChildren.has(table)) continue;
@@ -107,12 +113,6 @@ function generateRoutesIndexFile(tableNames, relationships = [], options = {}) {
     imports += `router.use("/${table}", ${varName}Route);\n`;
   }
 
-  // Mount child routes under parent path
-  for (const rel of relationships) {
-    const childVar = safeVarName(rel.child);
-    imports += `router.use("/${rel.parent}/:${rel.foreignKey}/${rel.child}", ${childVar}ChildRoute);\n`;
-  }
-
   imports += "\nexport default router;\n";
   return imports;
 }
@@ -472,7 +472,7 @@ async function main() {
       }
     }
     if (modelMeta.length > 0) {
-      const spec = generateOpenAPISpec(modelMeta);
+      const spec = generateOpenAPISpec(modelMeta, { relationships });
       const specPath = path.join(routesDir, "openapi.json");
       fs.writeFileSync(specPath, JSON.stringify(spec, null, 2));
       console.log(`  Created ${specPath}`);

package/src/cli/init/generators.js

@@ -367,21 +367,21 @@ function generateAppJs(answers) {
     answers.framework === "ultimate-express" ? "ultimate-express" : "express";
 
   // Imports
-  let imports = `const express = require("${frameworkPkg}");
-const { init, db } = require("db-model-router");
-const session = require("express-session");`;
+  let imports = `import express from "${frameworkPkg}";
+import { init, db } from "db-model-router";
+import session from "express-session";`;
 
   if (answers.session === "redis") {
-    imports += `\nconst RedisStore = require("connect-redis").default;
-const { Redis } = require("ioredis");`;
+    imports += `\nimport RedisStore from "connect-redis";
+import { Redis } from "ioredis";`;
   }
   if (answers.rateLimiting) {
-    imports += `\nconst rateLimit = require("express-rate-limit");`;
+    imports += `\nimport rateLimit from "express-rate-limit";`;
   }
   if (answers.helmet) {
-    imports += `\nconst helmet = require("helmet");`;
+    imports += `\nimport helmet from "helmet";`;
   }
-  imports += `\nconst logger = require("./middleware/logger");`;
+  imports += `\nimport logger from "./middleware/logger.js";`;
 
   // Rate limiting block
   const rateLimitBlock = answers.rateLimiting
@@ -396,9 +396,7 @@ const { Redis } = require("ioredis");`;
   const helmetBlock = answers.helmet ? `app.use(helmet());` : "";
 
   return `${imports}
-
-// Load environment variables
-require("dotenv").config();
+import "dotenv/config";
 
 // Initialize database adapter
 init("${answers.database}");
@@ -428,7 +426,7 @@ app.listen(PORT, () => {
   console.log(\`Server running on port \${PORT}\`);
 });
 
-module.exports = app;
+export default app;
 `;
 }
 
@@ -551,14 +549,15 @@ function generateMigrateScript(answers) {
 
   if (isNoSql) {
     return `#!/usr/bin/env node
-"use strict";
+import fs from "fs";
+import path from "path";
+import crypto from "crypto";
+import { fileURLToPath } from "url";
+import "dotenv/config";
 
-const fs = require("fs");
-const path = require("path");
-const crypto = require("crypto");
-require("dotenv").config();
+import { init, db } from "db-model-router";
 
-const { init, db } = require("db-model-router");
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 init("${answers.database}");
 
@@ -598,7 +597,7 @@ async function migrate() {
     const content = fs.readFileSync(filePath, "utf8");
     const checksum = crypto.createHash("md5").update(content).digest("hex");
 
-    const migration = require(filePath);
+    const migration = await import(filePath);
     console.log(\`  Running migration: \${file}\`);
     await migration.up(db);
     await recordMigration(file, checksum);
@@ -622,14 +621,15 @@ migrate().catch(err => {
   }
 
   return `#!/usr/bin/env node
-"use strict";
+import fs from "fs";
+import path from "path";
+import crypto from "crypto";
+import { fileURLToPath } from "url";
+import "dotenv/config";
 
-const fs = require("fs");
-const path = require("path");
-const crypto = require("crypto");
-require("dotenv").config();
+import { init, db } from "db-model-router";
 
-const { init, db } = require("db-model-router");
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 init("${answers.database}");
 
@@ -700,14 +700,15 @@ function generateAddMigrationScript(answers) {
   const isNoSql = NOSQL_DATABASES.includes(answers.database);
   const ext = isNoSql ? "js" : "sql";
   const template = isNoSql
-    ? `"use strict";\\n\\nmodule.exports = {\\n  async up(db) {\\n    // Write your migration here\\n  },\\n\\n  async down(db) {\\n    // Write your rollback here\\n  },\\n};\\n`
+    ? `export async function up(db) {\\n  // Write your migration here\\n}\\n\\nexport async function down(db) {\\n  // Write your rollback here\\n}\\n`
     : `-- Write your migration SQL here\\n`;
 
   return `#!/usr/bin/env node
-"use strict";
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 
-const fs = require("fs");
-const path = require("path");
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 const migrationsDir = path.join(__dirname, "migrations");
 
@@ -1422,6 +1423,8 @@ if (isMain) {
   const pkg = await import("db-model-router");
   const mod = pkg.default || pkg;
   mod.init("${answers.database}");
+  mod.db.connect({
+  ${dbConnectArgs(answers.database)}});
   const migrationsDir = path.join(__dirname, "${migrationsRel}");
   runMigrations(mod.db, migrationsDir)
     .then(() => process.exit(0))
@@ -1490,6 +1493,8 @@ if (isMain) {
   const pkg = await import("db-model-router");
   const mod = pkg.default || pkg;
   mod.init("${answers.database}");
+  mod.db.connect({
+  ${dbConnectArgs(answers.database)}});
   const migrationsDir = path.join(__dirname, "${migrationsRel}");
   runMigrations(mod.db, migrationsDir)
     .then(() => process.exit(0))
@@ -1726,7 +1731,8 @@ import configureSession from "${commonsPrefix}/session.js";
 import applySecurity from "${commonsPrefix}/security.js";
 import logger from "${middlewarePrefix}/logger.js";
 import route from "${routePrefix}/index.js";
-
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const app = express();
 const PORT = process.env.PORT || 3000;
 

package/src/cli/main.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 "use strict";
 
 const { parseFlags, OutputContext } = require("./flags");
@@ -64,7 +64,7 @@ const COMMAND_FLAGS = {
     ["--routes", "Generate only route files"],
     ["--openapi", "Generate only OpenAPI spec"],
     ["--tests", "Generate only test files"],
-    ["--llm-docs", "Generate only LLM documentation"],
+    ["--db-manager", "Generate DB Manager UI (SQL adapters only)"],
   ],
   doctor: [["--from <path>", "Schema file (default: dbmr.schema.json)"]],
   diff: [["--from <path>", "Schema file (default: dbmr.schema.json)"]],

package/src/sqlite3/db.js

@@ -16,6 +16,17 @@ function connect(config) {
 }
 
 function query(sql, parameter = []) {
+  // Use exec() for multi-statement SQL (e.g., migration files)
+  if (
+    parameter.length === 0 &&
+    sql
+      .replace(/--[^\n]*/g, "")
+      .split(";")
+      .filter((s) => s.trim()).length > 1
+  ) {
+    db.exec(sql);
+    return { changes: 0 };
+  }
   const stmt = db.prepare(sql);
   if (sql.trimStart().match(/^(SELECT|PRAGMA|WITH\s)/i)) {
     return stmt.all(...parameter);

package/demo/.dockerignore

@@ -1,7 +0,0 @@
-node_modules
-npm-debug.log
-.env
-.env.example
-.git
-.gitignore
-data

package/demo/.env.example

@@ -1,13 +0,0 @@
-# Server
-PORT=3000
-
-# Database
-DB_NAME=./data/data.db
-
-# Session
-SESSION_SECRET=your_session_secret
-
-# Logging
-APP_NAME=your_app_name
-LOG_LEVEL=info
-LOKI_HOST=http://your-loki-host:3100

package/demo/Dockerfile

@@ -1,20 +0,0 @@
-FROM node:alpine
-
-WORKDIR /app
-
-# Install dependencies
-COPY package*.json ./
-RUN npm ci --omit=dev
-
-# Copy application files
-COPY app.js ./
-COPY commons/ ./commons/
-COPY middleware/ ./middleware/
-COPY route/ ./route/
-COPY migrations/ ./migrations/
-
-# Expose port
-EXPOSE 3000
-
-# Start the application
-CMD ["node", "app.js"]

package/demo/app.js

@@ -1,37 +0,0 @@
-import express from "express";
-import "./commons/db.js";
-import configureSession from "./commons/session.js";
-import applySecurity from "./commons/security.js";
-import logger from "./middleware/logger.js";
-import route from "./routes/index.js";
-
-const app = express();
-const PORT = process.env.PORT || 3000;
-
-// Middleware
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
-
-// Security (helmet, rate limiting, custom headers)
-applySecurity(app);
-
-// Session
-app.use(configureSession());
-
-// Logger
-app.use(logger);
-
-// Routes
-app.use(route);
-
-// Error handler
-app.use((err, req, res, next) => {
-  console.error(err.stack);
-  res.status(500).json({ type: "danger", message: "Internal Server Error" });
-});
-
-app.listen(PORT, () => {
-  console.log(`Server running on port ${PORT}`);
-});
-
-export default app;

package/demo/commons/add_migration.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-/**
- * Create a new timestamped migration file.
- * @param {string} migrationsDir - absolute path to migrations folder
- * @param {string} [name] - migration name (default: "migration")
- * @returns {string} the created filename
- */
-export default function addMigration(migrationsDir, name) {
-  const migrationName = name || "migration";
-  const now = new Date();
-  const y = String(now.getFullYear()).padStart(4, "0");
-  const mo = String(now.getMonth() + 1).padStart(2, "0");
-  const d = String(now.getDate()).padStart(2, "0");
-  const h = String(now.getHours()).padStart(2, "0");
-  const mi = String(now.getMinutes()).padStart(2, "0");
-  const s = String(now.getSeconds()).padStart(2, "0");
-  const ts = `${y}${mo}${d}${h}${mi}${s}`;
-
-  const filename = `${ts}_${migrationName}.sql`;
-  const filePath = path.join(migrationsDir, filename);
-
-  if (!fs.existsSync(migrationsDir)) {
-    fs.mkdirSync(migrationsDir, { recursive: true });
-  }
-
-  fs.writeFileSync(filePath, "-- Write your migration SQL here\n");
-  console.log(`Created migration: ${filename}`);
-  return filename;
-}
-
-// Run as standalone script
-const isMain = process.argv[1] && fs.realpathSync(process.argv[1]) === fs.realpathSync(fileURLToPath(import.meta.url));
-if (isMain) {
-  const migrationsDir = path.join(__dirname, "../migrations");
-  const name = process.argv[2] || "migration";
-  addMigration(migrationsDir, name);
-}

package/demo/commons/db.js

@@ -1,17 +0,0 @@
-import "dotenv/config";
-import dbModelRouter from "db-model-router";
-
-// Initialize database adapter
-dbModelRouter.init("sqlite3");
-
-// Connect to database
-dbModelRouter.db.connect({
-  database: process.env.DB_NAME || "./data/data.db",
-});
-
-// Make db available globally across the application
-const db = dbModelRouter.db;
-global.db = db;
-
-export { db };
-export default db;

package/demo/commons/migrate.js

@@ -1,65 +0,0 @@
-#!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import crypto from "crypto";
-import { fileURLToPath } from "url";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-/**
- * Run all pending SQL migrations from the migrations directory.
- * @param {object} db - db-model-router db instance
- * @param {string} migrationsDir - absolute path to migrations folder
- */
-export default async function runMigrations(db, migrationsDir) {
-  const files = fs.readdirSync(migrationsDir)
-    .filter(f => f.endsWith(".sql"))
-    .sort();
-
-  let executed;
-  try {
-    const result = await db.query("SELECT filename FROM _migrations");
-    executed = new Set((result || []).map(r => r.filename));
-  } catch (e) {
-    executed = new Set();
-  }
-
-  let ran = 0;
-  for (const file of files) {
-    if (executed.has(file)) {
-      console.log(`  Skipping (already executed): ${file}`);
-      continue;
-    }
-    const filePath = path.join(migrationsDir, file);
-    const content = fs.readFileSync(filePath, "utf8");
-    const checksum = crypto.createHash("md5").update(content).digest("hex");
-
-    console.log(`  Running migration: ${file}`);
-    await db.query(content);
-    await db.query(
-      "INSERT INTO _migrations (filename, checksum) VALUES (?, ?)",
-      [file, checksum]
-    );
-    console.log(`  Completed: ${file}`);
-    ran++;
-  }
-
-  if (ran === 0) {
-    console.log("No pending migrations.");
-  } else {
-    console.log(`\n${ran} migration(s) complete.`);
-  }
-}
-
-// Run as standalone script
-const isMain = process.argv[1] && fs.realpathSync(process.argv[1]) === fs.realpathSync(fileURLToPath(import.meta.url));
-if (isMain) {
-  await import("dotenv/config");
-  const pkg = await import("db-model-router");
-  const mod = pkg.default || pkg;
-  mod.init("sqlite3");
-  const migrationsDir = path.join(__dirname, "../migrations");
-  runMigrations(mod.db, migrationsDir)
-    .then(() => process.exit(0))
-    .catch(err => { console.error("Migration failed:", err); process.exit(1); });
-}

package/demo/commons/security.js

@@ -1,30 +0,0 @@
-import helmet from "helmet";
-import rateLimit from "express-rate-limit";
-
-/**
- * Apply security middleware to the Express app.
- * Includes: Helmet, rate limiting, custom security headers.
- * @param {import("express").Application} app
- */
-export default function applySecurity(app) {
-  // Helmet — sets various HTTP headers for security
-  app.use(helmet());
-
-  // Rate limiting
-  app.use(rateLimit({
-    windowMs: 15 * 60 * 1000,
-    max: 100,
-    standardHeaders: true,
-    legacyHeaders: false,
-  }));
-
-  // Custom security headers (override or extend as needed)
-  app.use((req, res, next) => {
-    res.setHeader("X-Content-Type-Options", "nosniff");
-    res.setHeader("X-Frame-Options", "DENY");
-    res.setHeader("X-XSS-Protection", "1; mode=block");
-    res.setHeader("Referrer-Policy", "strict-origin-when-cross-origin");
-    res.removeHeader("X-Powered-By");
-    next();
-  });
-}

package/demo/commons/session.js

@@ -1,13 +0,0 @@
-import session from "express-session";
-
-/**
- * Configure and return session middleware.
- * Session store: memory
- */
-export default function configureSession() {
-  return session({
-    secret: process.env.SESSION_SECRET || "change-me",
-    resave: false,
-    saveUninitialized: false,
-  });
-}