db-model-router 1.0.2 → 1.0.4

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,11 +45,13 @@ 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}" });
 `;
 }
 
@@ -56,7 +60,7 @@ module.exports = route(${varName}, { ${fkColumn}: "params.${fkColumn}" });
  * Supports parent-child nesting: parent/:pk/child
  */
 function generateRoutesIndexFile(tableNames, relationships = []) {
-  let imports = `let express;\ntry { express = require("ultimate-express"); } catch (_) { express = require("express"); }\nconst router = express.Router();\n\n`;
+  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();
@@ -66,12 +70,12 @@ function generateRoutesIndexFile(tableNames, relationships = []) {
 
   for (const table of tableNames) {
     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
   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.child}_child_of_${rel.parent}.js";\n`;
   }
 
   imports += "\n";
@@ -85,9 +89,7 @@ function generateRoutesIndexFile(tableNames, relationships = []) {
 
   // Mount nested child routes under parent
   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`;
   }
 
@@ -97,7 +99,7 @@ function generateRoutesIndexFile(tableNames, relationships = []) {
     imports += `router.use("/${rel.child}", ${varName}Route);\n`;
   }
 
-  imports += "\nmodule.exports = router;\n";
+  imports += "\nexport default router;\n";
   return imports;
 }
 
@@ -108,6 +110,196 @@ function generateSimpleRoutesIndexFile(tableNames) {
   return generateRoutesIndexFile(tableNames, []);
 }
 
+/**
+ * Generate a test file for a route covering all CRUD methods.
+ * Uses supertest + the app's express setup.
+ */
+function generateTestFile(tableName, pk) {
+  const varName = safeVarName(tableName);
+  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
+import ${varName} from "../models/${tableName}.js";
+
+function createApp() {
+  const app = express();
+  app.use(express.json());
+  app.use("/${tableName}", route(${varName}));
+  return app;
+}
+
+describe("${tableName} routes", function () {
+  let app;
+
+  before(function () {
+    app = createApp();
+  });
+
+  describe("GET /${tableName}/", function () {
+    it("should list records", async function () {
+      const res = await request(app).get("/${tableName}/");
+      assert.strictEqual(res.status, 200);
+      assert.ok(Array.isArray(res.body.data));
+    });
+  });
+
+  describe("POST /${tableName}/add", function () {
+    it("should insert a single record", async function () {
+      const res = await request(app)
+        .post("/${tableName}/add")
+        .send({});
+      assert.ok([200, 201, 400].includes(res.status));
+    });
+  });
+
+  describe("POST /${tableName}/", function () {
+    it("should bulk insert records", async function () {
+      const res = await request(app)
+        .post("/${tableName}/")
+        .send({ data: [] });
+      assert.ok([200, 201, 400].includes(res.status));
+    });
+  });
+
+  describe("GET /${tableName}/:${pk}", function () {
+    it("should get a record by ID", async function () {
+      const res = await request(app).get("/${tableName}/1");
+      assert.ok([200, 404].includes(res.status));
+    });
+  });
+
+  describe("PUT /${tableName}/:${pk}", function () {
+    it("should update a record", async function () {
+      const res = await request(app)
+        .put("/${tableName}/1")
+        .send({});
+      assert.ok([200, 400, 404].includes(res.status));
+    });
+  });
+
+  describe("PATCH /${tableName}/:${pk}", function () {
+    it("should partially update a record", async function () {
+      const res = await request(app)
+        .patch("/${tableName}/1")
+        .send({});
+      assert.ok([200, 400, 404].includes(res.status));
+    });
+  });
+
+  describe("DELETE /${tableName}/:${pk}", function () {
+    it("should delete a record", async function () {
+      const res = await request(app).delete("/${tableName}/1");
+      assert.ok([200, 204, 404].includes(res.status));
+    });
+  });
+
+  describe("PUT /${tableName}/", function () {
+    it("should bulk update records", async function () {
+      const res = await request(app)
+        .put("/${tableName}/")
+        .send({ data: [] });
+      assert.ok([200, 400].includes(res.status));
+    });
+  });
+
+  describe("DELETE /${tableName}/", function () {
+    it("should bulk delete records", async function () {
+      const res = await request(app)
+        .delete("/${tableName}/")
+        .send({});
+      assert.ok([200, 204, 400].includes(res.status));
+    });
+  });
+});
+`;
+}
+
+/**
+ * Generate a child route test file that tests the nested parent/:fk/child endpoints.
+ */
+function generateChildTestFile(childTable, parentTable, fkColumn, pk) {
+  const childVar = safeVarName(childTable);
+  return `import assert from "assert";
+import express from "express";
+import request from "supertest";
+import dbModelRouter from "db-model-router";
+
+const { route } = dbModelRouter;
+
+import ${childVar} from "../models/${childTable}.js";
+
+function createApp() {
+  const app = express();
+  app.use(express.json());
+  app.use("/${parentTable}/:${fkColumn}/${childTable}", route(${childVar}, { ${fkColumn}: "params.${fkColumn}" }));
+  return app;
+}
+
+describe("${childTable} (child of ${parentTable}) routes", function () {
+  let app;
+  const parentId = 1;
+
+  before(function () {
+    app = createApp();
+  });
+
+  describe("GET /${parentTable}/:${fkColumn}/${childTable}/", function () {
+    it("should list child records scoped by parent", async function () {
+      const res = await request(app).get(\`/${parentTable}/\${parentId}/${childTable}/\`);
+      assert.strictEqual(res.status, 200);
+      assert.ok(Array.isArray(res.body.data));
+    });
+  });
+
+  describe("POST /${parentTable}/:${fkColumn}/${childTable}/add", function () {
+    it("should insert a child record", async function () {
+      const res = await request(app)
+        .post(\`/${parentTable}/\${parentId}/${childTable}/add\`)
+        .send({});
+      assert.ok([200, 201, 400].includes(res.status));
+    });
+  });
+
+  describe("GET /${parentTable}/:${fkColumn}/${childTable}/:${pk}", function () {
+    it("should get a child record by ID", async function () {
+      const res = await request(app).get(\`/${parentTable}/\${parentId}/${childTable}/1\`);
+      assert.ok([200, 404].includes(res.status));
+    });
+  });
+
+  describe("PUT /${parentTable}/:${fkColumn}/${childTable}/:${pk}", function () {
+    it("should update a child record", async function () {
+      const res = await request(app)
+        .put(\`/${parentTable}/\${parentId}/${childTable}/1\`)
+        .send({});
+      assert.ok([200, 400, 404].includes(res.status));
+    });
+  });
+
+  describe("PATCH /${parentTable}/:${fkColumn}/${childTable}/:${pk}", function () {
+    it("should partially update a child record", async function () {
+      const res = await request(app)
+        .patch(\`/${parentTable}/\${parentId}/${childTable}/1\`)
+        .send({});
+      assert.ok([200, 400, 404].includes(res.status));
+    });
+  });
+
+  describe("DELETE /${parentTable}/:${fkColumn}/${childTable}/:${pk}", function () {
+    it("should delete a child record", async function () {
+      const res = await request(app).delete(\`/${parentTable}/\${parentId}/${childTable}/1\`);
+      assert.ok([200, 204, 404].includes(res.status));
+    });
+  });
+});
+`;
+}
+
 /**
  * Read model directory to discover table names from generated model files.
  * Looks for .js files that are not index.js.
@@ -262,6 +454,51 @@ async function main() {
     // OpenAPI generation is optional, don't fail
   }
 
+  // Generate test files for all routes
+  const testsDir = path.resolve(path.dirname(routesDir), "tests");
+  if (!fs.existsSync(testsDir)) {
+    fs.mkdirSync(testsDir, { recursive: true });
+  }
+
+  for (const table of tableNames) {
+    // Try to extract PK from model file
+    let pk = "id";
+    const modelPath = path.join(modelsDir, table + ".js");
+    if (fs.existsSync(modelPath)) {
+      const meta = parseModelFile(fs.readFileSync(modelPath, "utf8"), table);
+      if (meta && meta.primary_key) pk = meta.primary_key;
+    }
+    const testPath = path.join(testsDir, table + ".test.js");
+    fs.writeFileSync(testPath, generateTestFile(table, pk));
+    console.log(`  Created ${testPath}`);
+  }
+
+  // Generate child route test files
+  for (const rel of relationships) {
+    let pk = "id";
+    const modelPath = path.join(modelsDir, rel.child + ".js");
+    if (fs.existsSync(modelPath)) {
+      const meta = parseModelFile(
+        fs.readFileSync(modelPath, "utf8"),
+        rel.child,
+      );
+      if (meta && meta.primary_key) pk = meta.primary_key;
+    }
+    const testPath = path.join(
+      testsDir,
+      `${rel.child}_child_of_${rel.parent}.test.js`,
+    );
+    fs.writeFileSync(
+      testPath,
+      generateChildTestFile(rel.child, rel.parent, rel.fkColumn, pk),
+    );
+    console.log(`  Created ${testPath}`);
+  }
+
+  console.log(
+    `Generated ${tableNames.length + relationships.length} test file(s) in ${testsDir}`,
+  );
+
   process.exit(0);
 }
 
@@ -271,7 +508,9 @@ async function main() {
 function parseModelFile(content, tableName) {
   try {
     // Extract structure JSON
-    const structMatch = content.match(/model\(\s*\n?\s*db,\s*\n?\s*"[^"]+",\s*\n?\s*(\{[\s\S]*?\}),/);
+    const structMatch = content.match(
+      /model\(\s*\n?\s*db,\s*\n?\s*"[^"]+",\s*\n?\s*(\{[\s\S]*?\}),/,
+    );
     if (!structMatch) return null;
     const structure = JSON.parse(structMatch[1]);
     // Extract primary key
@@ -281,7 +520,7 @@ function parseModelFile(content, tableName) {
   } catch (e) {
     return null;
   }
-
+}
 function parseArgs(argv) {
   const args = {};
   for (let i = 0; i < argv.length; i++) {
@@ -341,6 +580,8 @@ module.exports = {
   generateRouteFile,
   generateChildRouteFile,
   generateRoutesIndexFile,
+  generateTestFile,
+  generateChildTestFile,
   discoverModels,
   safeVarName,
 };

package/src/cli/init/dependencies.js

@@ -0,0 +1,92 @@
+"use strict";
+
+/**
+ * Maps each supported database to its driver package(s).
+ */
+const DRIVER_MAP = {
+  mysql: ["mysql2"],
+  mariadb: ["mysql2"],
+  postgres: ["pg"],
+  sqlite3: ["better-sqlite3"],
+  mongodb: ["mongodb"],
+  mssql: ["mssql"],
+  cockroachdb: ["pg"],
+  oracle: ["oracledb"],
+  redis: ["ioredis"],
+  dynamodb: ["@aws-sdk/client-dynamodb", "@aws-sdk/lib-dynamodb"],
+};
+
+/**
+ * Collect dependencies and devDependencies based on user answers.
+ * @param {import('./types').InitAnswers} answers
+ * @returns {{ dependencies: Record<string, string>, devDependencies: Record<string, string> }}
+ */
+function collectDependencies(answers) {
+  const dependencies = {};
+  const devDependencies = {};
+
+  // Always included
+  dependencies["db-model-router"] = "latest";
+  dependencies["dotenv"] = "latest";
+  dependencies[answers.framework] = "latest";
+  dependencies["express-session"] = "latest";
+
+  // Database driver(s)
+  const drivers = DRIVER_MAP[answers.database] || [];
+  for (const driver of drivers) {
+    dependencies[driver] = "latest";
+  }
+
+  // Session: redis
+  if (answers.session === "redis") {
+    dependencies["connect-redis"] = "latest";
+    // Only add ioredis if not already included via the database driver
+    if (answers.database !== "redis") {
+      dependencies["ioredis"] = "latest";
+    }
+  }
+
+  // Optional middleware
+  if (answers.rateLimiting) {
+    dependencies["express-rate-limit"] = "latest";
+  }
+  if (answers.helmet) {
+    dependencies["helmet"] = "latest";
+  }
+  if (answers.logger) {
+    dependencies["winston"] = "latest";
+    if (answers.loki) {
+      dependencies["winston-loki"] = "latest";
+    }
+  }
+
+  // Dev dependencies
+  devDependencies["nodemon"] = "latest";
+
+  return { dependencies, devDependencies };
+}
+
+/**
+ * Returns the package.json scripts.
+ * @param {string} [outputDir] - relative output directory for source files
+ * @returns {Record<string, string>}
+ */
+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 ${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",
+  };
+}
+
+module.exports = {
+  DRIVER_MAP,
+  collectDependencies,
+  getScripts,
+};