db-model-router 1.0.3 → 1.0.5

package/src/cli/generate-route.js

@@ -25,10 +25,12 @@ function safeVarName(name) {
  */
 function generateRouteFile(tableName, modelsRelPath) {
   const varName = safeVarName(tableName);
-  return `const { route } = require("db-model-router");
-const ${varName} = require("${modelsRelPath}/${tableName}");
+  return `import dbModelRouter from "db-model-router";
+import ${varName} from "${modelsRelPath}/${tableName}.js";
 
-module.exports = route(${varName});
+const { route } = dbModelRouter;
+
+export default route(${varName});
 `;
 }
 
@@ -43,20 +45,29 @@ function generateChildRouteFile(
   modelsRelPath,
 ) {
   const varName = safeVarName(childTable);
-  return `const { route } = require("db-model-router");
-const ${varName} = require("${modelsRelPath}/${childTable}");
+  return `import dbModelRouter from "db-model-router";
+import ${varName} from "${modelsRelPath}/${childTable}.js";
+
+const { route } = dbModelRouter;
 
 // Child route: scoped by parent ${parentTable} via ${fkColumn}
-module.exports = route(${varName}, { ${fkColumn}: "params.${fkColumn}" });
+export default route(${varName}, { ${fkColumn}: "params.${fkColumn}" });
 `;
 }
 
 /**
  * Generate the routes index file that mounts all routes on an express Router.
  * Supports parent-child nesting: parent/:pk/child
+ *
+ * Child routes are placed in subfolders: routes/<parent>/<child>.js
+ * Children are only mounted under their parent path (no duplicate top-level route).
+ *
+ * @param {string[]} tableNames
+ * @param {Array<{parent, child, foreignKey}>} relationships
+ * @param {{ includeDocs?: boolean }} [options]
  */
-function generateRoutesIndexFile(tableNames, relationships = []) {
-  let imports = `let express;\ntry { express = require("ultimate-express"); } catch (_) { express = require("express"); }\nconst router = express.Router();\n\n`;
+function generateRoutesIndexFile(tableNames, relationships = [], options = {}) {
+  let imports = `import express from "express";\n\nconst router = express.Router();\n\n`;
 
   // Collect child tables that are nested under parents
   const nestedChildren = new Set();
@@ -64,40 +75,45 @@ function generateRoutesIndexFile(tableNames, relationships = []) {
     nestedChildren.add(rel.child);
   }
 
+  // Import top-level routes only (not children)
   for (const table of tableNames) {
+    if (nestedChildren.has(table)) continue;
     const varName = safeVarName(table);
-    imports += `const ${varName}Route = require("./${table}");\n`;
+    imports += `import ${varName}Route from "./${table}.js";\n`;
   }
-  // Import child routes with _child suffix for nested ones
+
+  // Import child routes from subfolders
   for (const rel of relationships) {
     const varName = safeVarName(rel.child);
-    imports += `const ${varName}ChildRoute = require("./${rel.child}_child_of_${rel.parent}");\n`;
+    imports += `import ${varName}ChildRoute from "./${rel.parent}/${rel.child}.js";\n`;
+  }
+
+  // Import docs route if openapi is generated
+  if (options.includeDocs) {
+    imports += `import docsRoute from "./docs.js";\n`;
   }
 
   imports += "\n";
 
-  // Mount top-level routes (skip tables that are ONLY children)
+  // Mount docs route first
+  if (options.includeDocs) {
+    imports += `router.use("/docs", docsRoute);\n`;
+  }
+
+  // Mount top-level routes
   for (const table of tableNames) {
     if (nestedChildren.has(table)) continue;
     const varName = safeVarName(table);
     imports += `router.use("/${table}", ${varName}Route);\n`;
   }
 
-  // Mount nested child routes under parent
+  // Mount child routes under parent path
   for (const rel of relationships) {
-    const parentVar = safeVarName(rel.parent);
     const childVar = safeVarName(rel.child);
-    // Find parent PK from model file name convention — use fkColumn without _id suffix as parent pk param
-    imports += `router.use("/${rel.parent}/:${rel.fkColumn}/${rel.child}", ${childVar}ChildRoute);\n`;
-  }
-
-  // Also mount children as top-level for direct access
-  for (const rel of relationships) {
-    const varName = safeVarName(rel.child);
-    imports += `router.use("/${rel.child}", ${varName}Route);\n`;
+    imports += `router.use("/${rel.parent}/:${rel.foreignKey}/${rel.child}", ${childVar}ChildRoute);\n`;
   }
 
-  imports += "\nmodule.exports = router;\n";
+  imports += "\nexport default router;\n";
   return imports;
 }
 
@@ -114,13 +130,15 @@ function generateSimpleRoutesIndexFile(tableNames) {
  */
 function generateTestFile(tableName, pk) {
   const varName = safeVarName(tableName);
-  return `const assert = require("assert");
-const express = require("express");
-const request = require("supertest");
-const { route } = require("db-model-router");
+  return `import assert from "assert";
+import express from "express";
+import request from "supertest";
+import dbModelRouter from "db-model-router";
+
+const { route } = dbModelRouter;
 
 // Adjust the path to your model file as needed
-const ${varName} = require("../models/${tableName}");
+import ${varName} from "../models/${tableName}.js";
 
 function createApp() {
   const app = express();
@@ -220,12 +238,14 @@ describe("${tableName} routes", function () {
  */
 function generateChildTestFile(childTable, parentTable, fkColumn, pk) {
   const childVar = safeVarName(childTable);
-  return `const assert = require("assert");
-const express = require("express");
-const request = require("supertest");
-const { route } = require("db-model-router");
+  return `import assert from "assert";
+import express from "express";
+import request from "supertest";
+import dbModelRouter from "db-model-router";
+
+const { route } = dbModelRouter;
 
-const ${childVar} = require("../models/${childTable}");
+import ${childVar} from "../models/${childTable}.js";
 
 function createApp() {
   const app = express();
@@ -381,7 +401,7 @@ async function main() {
         const fkColumn = parent.replace(/s$/, "") + "_id";
         // Only add if both tables exist in our model set
         if (tableNames.includes(parent) && tableNames.includes(child)) {
-          relationships.push({ parent, child, fkColumn });
+          relationships.push({ parent, child, foreignKey: fkColumn });
         }
       }
     }
@@ -392,23 +412,36 @@ async function main() {
     fs.mkdirSync(routesDir, { recursive: true });
   }
 
+  // Collect child tables to skip top-level route files
+  const nestedChildren = new Set();
+  for (const rel of relationships) {
+    nestedChildren.add(rel.child);
+  }
+
   for (const table of tableNames) {
+    if (nestedChildren.has(table)) continue;
     const filePath = path.join(routesDir, table + ".js");
     fs.writeFileSync(filePath, generateRouteFile(table, modelsRelPath));
     console.log(`  Created ${filePath}`);
   }
 
-  // Write child route files for parent-child relationships
+  // Write child route files in subfolders: routes/<parent>/<child>.js
   for (const rel of relationships) {
-    const fileName = `${rel.child}_child_of_${rel.parent}.js`;
-    const filePath = path.join(routesDir, fileName);
+    const parentDir = path.join(routesDir, rel.parent);
+    if (!fs.existsSync(parentDir)) {
+      fs.mkdirSync(parentDir, { recursive: true });
+    }
+    const filePath = path.join(parentDir, `${rel.child}.js`);
+    const childModelsRelPath = path
+      .relative(parentDir, path.resolve(modelsDir))
+      .replace(/\\/g, "/");
     fs.writeFileSync(
       filePath,
       generateChildRouteFile(
         rel.child,
         rel.parent,
-        rel.fkColumn,
-        modelsRelPath,
+        rel.foreignKey,
+        childModelsRelPath,
       ),
     );
     console.log(`  Created ${filePath}`);
@@ -467,7 +500,7 @@ async function main() {
     console.log(`  Created ${testPath}`);
   }
 
-  // Generate child route test files
+  // Generate child route test files in subfolders
   for (const rel of relationships) {
     let pk = "id";
     const modelPath = path.join(modelsDir, rel.child + ".js");
@@ -478,13 +511,14 @@ async function main() {
       );
       if (meta && meta.primary_key) pk = meta.primary_key;
     }
-    const testPath = path.join(
-      testsDir,
-      `${rel.child}_child_of_${rel.parent}.test.js`,
-    );
+    const parentTestDir = path.join(testsDir, rel.parent);
+    if (!fs.existsSync(parentTestDir)) {
+      fs.mkdirSync(parentTestDir, { recursive: true });
+    }
+    const testPath = path.join(parentTestDir, `${rel.child}.test.js`);
     fs.writeFileSync(
       testPath,
-      generateChildTestFile(rel.child, rel.parent, rel.fkColumn, pk),
+      generateChildTestFile(rel.child, rel.parent, rel.foreignKey, pk),
     );
     console.log(`  Created ${testPath}`);
   }

package/src/cli/init/dependencies.js

@@ -5,6 +5,7 @@
  */
 const DRIVER_MAP = {
   mysql: ["mysql2"],
+  mariadb: ["mysql2"],
   postgres: ["pg"],
   sqlite3: ["better-sqlite3"],
   mongodb: ["mongodb"],
@@ -53,26 +54,37 @@ function collectDependencies(answers) {
     dependencies["helmet"] = "latest";
   }
   if (answers.logger) {
-    dependencies["express-mung"] = "latest";
+    dependencies["winston"] = "latest";
+    if (answers.loki) {
+      dependencies["winston-loki"] = "latest";
+    }
   }
 
   // Dev dependencies
   devDependencies["nodemon"] = "latest";
 
+  // Swagger UI for API documentation
+  dependencies["swagger-ui-express"] = "latest";
+
   return { dependencies, devDependencies };
 }
 
 /**
- * Returns the 5 package.json scripts.
+ * Returns the package.json scripts.
+ * @param {string} [outputDir] - relative output directory for source files
  * @returns {Record<string, string>}
  */
-function getScripts() {
+function getScripts(outputDir) {
+  const prefix = outputDir ? `${outputDir}/` : "";
   return {
     start: "node app.js",
     dev: "nodemon app.js",
     test: 'echo "Error: no test specified" && exit 1',
-    migrate: "node migrate.js",
-    add_migration: "node add_migration.js",
+    migrate: `node ${prefix}commons/migrate.js`,
+    add_migration: `node ${prefix}commons/add_migration.js`,
+    "docker:build": "docker build -t app .",
+    "docker:up": "docker compose up -d",
+    "docker:down": "docker compose down",
   };
 }