db-model-router 1.0.3 → 1.0.5

package/dbmr.schema.json

@@ -0,0 +1,333 @@
+{
+  "adapter": "sqlite3",
+  "framework": "express",
+  "options": {
+    "session": "redis",
+    "rateLimiting": true,
+    "helmet": true,
+    "logger": true,
+    "loki": false
+  },
+  "tables": {
+    "users": {
+      "columns": {
+        "user_id": "auto_increment",
+        "name": "required|string",
+        "email": "required|string",
+        "password_hash": "required|string",
+        "phone": "string",
+        "avatar_url": "string",
+        "role": "required|string",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "user_id",
+      "unique": ["email"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "addresses": {
+      "columns": {
+        "address_id": "auto_increment",
+        "user_id": "required|integer",
+        "label": "string",
+        "line1": "required|string",
+        "line2": "string",
+        "city": "required|string",
+        "state": "required|string",
+        "postal_code": "required|string",
+        "country": "required|string",
+        "is_default": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "address_id",
+      "unique": ["address_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "categories": {
+      "columns": {
+        "category_id": "auto_increment",
+        "name": "required|string",
+        "slug": "required|string",
+        "description": "string",
+        "parent_category_id": "integer",
+        "image_url": "string",
+        "sort_order": "integer",
+        "is_active": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "category_id",
+      "unique": ["slug"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "products": {
+      "columns": {
+        "product_id": "auto_increment",
+        "category_id": "required|integer",
+        "name": "required|string",
+        "slug": "required|string",
+        "description": "string",
+        "short_description": "string",
+        "sku": "required|string",
+        "price": "required|numeric",
+        "compare_at_price": "numeric",
+        "cost_price": "numeric",
+        "currency": "required|string",
+        "stock_quantity": "required|integer",
+        "low_stock_threshold": "integer",
+        "weight": "numeric",
+        "weight_unit": "string",
+        "is_active": "boolean",
+        "is_featured": "boolean",
+        "is_deleted": "boolean",
+        "meta": "object",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "product_id",
+      "unique": ["sku", "slug"],
+      "softDelete": "is_deleted",
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "product_images": {
+      "columns": {
+        "product_image_id": "auto_increment",
+        "product_id": "required|integer",
+        "url": "required|string",
+        "alt_text": "string",
+        "sort_order": "integer",
+        "is_primary": "boolean",
+        "created_at": "datetime"
+      },
+      "pk": "product_image_id",
+      "unique": ["product_image_id"],
+      "timestamps": {
+        "created_at": "created_at"
+      },
+      "parent": "products"
+    },
+    "product_variants": {
+      "columns": {
+        "variant_id": "auto_increment",
+        "product_id": "required|integer",
+        "name": "required|string",
+        "sku": "required|string",
+        "price": "required|numeric",
+        "stock_quantity": "required|integer",
+        "attributes": "object",
+        "is_active": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "variant_id",
+      "unique": ["sku"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": "products"
+    },
+    "product_reviews": {
+      "columns": {
+        "review_id": "auto_increment",
+        "product_id": "required|integer",
+        "user_id": "required|integer",
+        "rating": "required|integer",
+        "title": "string",
+        "body": "string",
+        "is_verified": "boolean",
+        "is_approved": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "review_id",
+      "unique": ["review_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": "products"
+    },
+    "carts": {
+      "columns": {
+        "cart_id": "auto_increment",
+        "user_id": "integer",
+        "session_id": "string",
+        "currency": "required|string",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "cart_id",
+      "unique": ["cart_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "cart_items": {
+      "columns": {
+        "cart_item_id": "auto_increment",
+        "cart_id": "required|integer",
+        "product_id": "required|integer",
+        "variant_id": "integer",
+        "quantity": "required|integer",
+        "unit_price": "required|numeric",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "cart_item_id",
+      "unique": ["cart_item_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": "carts"
+    },
+    "orders": {
+      "columns": {
+        "order_id": "auto_increment",
+        "user_id": "required|integer",
+        "order_number": "required|string",
+        "status": "required|string",
+        "subtotal": "required|numeric",
+        "tax_amount": "required|numeric",
+        "shipping_amount": "required|numeric",
+        "discount_amount": "numeric",
+        "total": "required|numeric",
+        "currency": "required|string",
+        "shipping_address_id": "integer",
+        "billing_address_id": "integer",
+        "notes": "string",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "order_id",
+      "unique": ["order_number"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "order_items": {
+      "columns": {
+        "order_item_id": "auto_increment",
+        "order_id": "required|integer",
+        "product_id": "required|integer",
+        "variant_id": "integer",
+        "product_name": "required|string",
+        "sku": "required|string",
+        "quantity": "required|integer",
+        "unit_price": "required|numeric",
+        "total_price": "required|numeric",
+        "created_at": "datetime"
+      },
+      "pk": "order_item_id",
+      "unique": ["order_item_id"],
+      "timestamps": {
+        "created_at": "created_at"
+      },
+      "parent": "orders"
+    },
+    "payments": {
+      "columns": {
+        "payment_id": "auto_increment",
+        "order_id": "required|integer",
+        "method": "required|string",
+        "provider": "string",
+        "provider_transaction_id": "string",
+        "amount": "required|numeric",
+        "currency": "required|string",
+        "status": "required|string",
+        "paid_at": "datetime",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "payment_id",
+      "unique": ["payment_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": "orders"
+    },
+    "shipments": {
+      "columns": {
+        "shipment_id": "auto_increment",
+        "order_id": "required|integer",
+        "carrier": "required|string",
+        "tracking_number": "string",
+        "status": "required|string",
+        "shipped_at": "datetime",
+        "delivered_at": "datetime",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "shipment_id",
+      "unique": ["shipment_id"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": "orders"
+    },
+    "coupons": {
+      "columns": {
+        "coupon_id": "auto_increment",
+        "code": "required|string",
+        "description": "string",
+        "discount_type": "required|string",
+        "discount_value": "required|numeric",
+        "min_order_amount": "numeric",
+        "max_uses": "integer",
+        "used_count": "integer",
+        "starts_at": "datetime",
+        "expires_at": "datetime",
+        "is_active": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "coupon_id",
+      "unique": ["code"],
+      "timestamps": {
+        "created_at": "created_at",
+        "modified_at": "updated_at"
+      },
+      "parent": null
+    },
+    "wishlists": {
+      "columns": {
+        "wishlist_id": "auto_increment",
+        "user_id": "required|integer",
+        "product_id": "required|integer",
+        "created_at": "datetime"
+      },
+      "pk": "wishlist_id",
+      "unique": ["wishlist_id"],
+      "timestamps": {
+        "created_at": "created_at"
+      },
+      "parent": null
+    }
+  }
+}

package/demo/.dockerignore

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

package/demo/.env.example

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,43 @@
+#!/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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,65 @@
+#!/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

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,13 @@
+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,
+  });
+}