db-model-router 1.0.5 → 1.0.7

package/demo/seeds/saas-seed.js

@@ -0,0 +1,329 @@
+"use strict";
+
+const path = require("path");
+const fs = require("fs");
+const { hashPassword } = require("../commons/password");
+
+/**
+ * Super Admin email address.
+ */
+const SUPER_ADMIN_EMAIL = "admin@system.local";
+
+/**
+ * Generated password for the Super Admin.
+ * This is cryptographically random and unique per generation.
+ */
+const SUPER_ADMIN_PASSWORD = "64c2b0d97c199df8b674e4854baa4d28";
+
+/**
+ * Super Admin permissions: all actions for all modules with global scope.
+ */
+const SUPER_ADMIN_PERMISSIONS = [
+  {
+    "module": "users",
+    "action": "read",
+    "scope": "global"
+  },
+  {
+    "module": "users",
+    "action": "write",
+    "scope": "global"
+  },
+  {
+    "module": "users",
+    "action": "update",
+    "scope": "global"
+  },
+  {
+    "module": "users",
+    "action": "delete",
+    "scope": "global"
+  },
+  {
+    "module": "users",
+    "action": "export",
+    "scope": "global"
+  },
+  {
+    "module": "users",
+    "action": "approve",
+    "scope": "global"
+  },
+  {
+    "module": "users",
+    "action": "global",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "read",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "write",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "update",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "delete",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "export",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "approve",
+    "scope": "global"
+  },
+  {
+    "module": "tenants",
+    "action": "global",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "read",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "write",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "update",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "delete",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "export",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "approve",
+    "scope": "global"
+  },
+  {
+    "module": "roles",
+    "action": "global",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "read",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "write",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "update",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "delete",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "export",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "approve",
+    "scope": "global"
+  },
+  {
+    "module": "permissions",
+    "action": "global",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "read",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "write",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "update",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "delete",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "export",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "approve",
+    "scope": "global"
+  },
+  {
+    "module": "webhooks",
+    "action": "global",
+    "scope": "global"
+  }
+];
+
+/**
+ * Tenant Admin permissions: CRUD for users and roles with tenant scope.
+ */
+const TENANT_ADMIN_PERMISSIONS = [
+  {
+    "module": "users",
+    "action": "read",
+    "scope": "tenant"
+  },
+  {
+    "module": "users",
+    "action": "write",
+    "scope": "tenant"
+  },
+  {
+    "module": "users",
+    "action": "update",
+    "scope": "tenant"
+  },
+  {
+    "module": "users",
+    "action": "delete",
+    "scope": "tenant"
+  },
+  {
+    "module": "roles",
+    "action": "read",
+    "scope": "tenant"
+  },
+  {
+    "module": "roles",
+    "action": "write",
+    "scope": "tenant"
+  },
+  {
+    "module": "roles",
+    "action": "update",
+    "scope": "tenant"
+  },
+  {
+    "module": "roles",
+    "action": "delete",
+    "scope": "tenant"
+  }
+];
+
+/**
+ * Write the credentials.md file with the super admin login details.
+ */
+function writeCredentials() {
+  const content = `# Super Admin Credentials
+
+**Email:** ${SUPER_ADMIN_EMAIL}
+**Password:** ${SUPER_ADMIN_PASSWORD}
+
+> ⚠️ **WARNING:** Change this password after first login. This file should not be committed to version control.
+`;
+  fs.writeFileSync(path.join(process.cwd(), "credentials.md"), content, "utf8");
+}
+
+/**
+ * Seed the database with Super Admin user and Tenant Admin Role.
+ *
+ * @param {object} db - Database connection/query interface
+ * @returns {Promise<void>}
+ */
+async function seed(db) {
+  const passwordHash = await hashPassword(SUPER_ADMIN_PASSWORD);
+
+  // Insert Super Admin role with all permissions
+  const superAdminRoleResult = await db("roles").insert({
+    tenant_id: null,
+    name: "Super Admin",
+    created_at: new Date(),
+    modified_at: new Date(),
+  });
+  const superAdminRoleId = Array.isArray(superAdminRoleResult)
+    ? superAdminRoleResult[0]
+    : superAdminRoleResult;
+
+  // Insert Super Admin permissions
+  for (const perm of SUPER_ADMIN_PERMISSIONS) {
+    await db("role_permissions").insert({
+      role_id: superAdminRoleId,
+      permission: JSON.stringify(perm),
+      created_at: new Date(),
+      modified_at: new Date(),
+    });
+  }
+
+  // Insert Super Admin user
+  await db("users").insert({
+    email: SUPER_ADMIN_EMAIL,
+    password_hash: passwordHash,
+    name: "Super Admin",
+    tenant_id: null,
+    role_id: superAdminRoleId,
+    created_at: new Date(),
+    modified_at: new Date(),
+  });
+
+  // Insert Tenant Admin Role
+  const tenantAdminRoleResult = await db("roles").insert({
+    tenant_id: null,
+    name: "Tenant Admin",
+    created_at: new Date(),
+    modified_at: new Date(),
+  });
+  const tenantAdminRoleId = Array.isArray(tenantAdminRoleResult)
+    ? tenantAdminRoleResult[0]
+    : tenantAdminRoleResult;
+
+  // Insert Tenant Admin permissions
+  for (const perm of TENANT_ADMIN_PERMISSIONS) {
+    await db("role_permissions").insert({
+      role_id: tenantAdminRoleId,
+      permission: JSON.stringify(perm),
+      created_at: new Date(),
+      modified_at: new Date(),
+    });
+  }
+
+  // Write credentials file
+  writeCredentials();
+
+  console.log("SaaS seed completed successfully.");
+  console.log("Super Admin:", SUPER_ADMIN_EMAIL);
+  console.log("Credentials written to credentials.md");
+}
+
+module.exports = { seed, SUPER_ADMIN_PERMISSIONS, TENANT_ADMIN_PERMISSIONS, SUPER_ADMIN_EMAIL, SUPER_ADMIN_PASSWORD };

package/docker-compose.yml

@@ -143,3 +143,64 @@ services:
       start_period: 90s
     networks:
       - db-network
+
+  zookeeper:
+    image: confluentinc/cp-zookeeper:7.6.0
+    container_name: db-model-router-zookeeper
+    restart: unless-stopped
+    ports:
+      - "2181:2181"
+    environment:
+      ZOOKEEPER_CLIENT_PORT: 2181
+      ZOOKEEPER_TICK_TIME: 2000
+    healthcheck:
+      test: ["CMD-SHELL", "echo srvr | nc localhost 2181 || exit 1"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 15s
+    networks:
+      - db-network
+
+  kafka:
+    image: confluentinc/cp-kafka:7.6.0
+    container_name: db-model-router-kafka
+    restart: unless-stopped
+    depends_on:
+      zookeeper:
+        condition: service_healthy
+    ports:
+      - "9092:9092"
+      - "29092:29092"
+    environment:
+      KAFKA_BROKER_ID: 1
+      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
+      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:29092,PLAINTEXT_HOST://localhost:9092
+      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
+      KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
+      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
+      KAFKA_AUTO_CREATE_TOPICS_ENABLE: "true"
+    healthcheck:
+      test: ["CMD-SHELL", "kafka-broker-api-versions --bootstrap-server localhost:9092"]
+      interval: 10s
+      timeout: 10s
+      retries: 10
+      start_period: 30s
+    networks:
+      - db-network
+
+  kafka-ui:
+    image: provectuslabs/kafka-ui:latest
+    container_name: db-model-router-kafka-ui
+    restart: unless-stopped
+    depends_on:
+      kafka:
+        condition: service_healthy
+    ports:
+      - "8090:8080"
+    environment:
+      KAFKA_CLUSTERS_0_NAME: local
+      KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS: kafka:29092
+      KAFKA_CLUSTERS_0_ZOOKEEPER: zookeeper:2181
+    networks:
+      - db-network

package/package.json

@@ -1,113 +1,120 @@
-{
-  "name": "db-model-router",
-  "version": "1.0.5",
-  "description": "Generative API Creation using mysql2 and express libraries in node js",
-  "main": "src/index.js",
-  "bin": {
-    "db-model-router": "src/cli/main.js"
-  },
-  "scripts": {
-    "dev": "nodemon src/serve.js",
-    "test": "dotenv -e env/.env.default -- mocha --exit",
-    "test:sqlite3": "dotenv -e env/.env.sqlite3 -- mocha test/adapters/sqlite3.*.test.js test/properties/sqlite3.filter.property.test.js --timeout 15000 --exit",
-    "test:mysql": "dotenv -e env/.env.mysql -- mocha test/adapters/mysql.*.test.js test/properties/mysql.filter.property.test.js --timeout 15000 --exit",
-    "test:postgres": "dotenv -e env/.env.postgres -- mocha test/adapters/postgres.*.test.js test/properties/postgres.filter.property.test.js --timeout 15000 --exit",
-    "test:oracle": "dotenv -e env/.env.oracle -- mocha test/adapters/oracle.*.test.js test/properties/oracle.filter.property.test.js --timeout 30000 --exit",
-    "test:mongodb": "dotenv -e env/.env.mongodb -- mocha test/adapters/mongodb.*.test.js test/properties/mongodb.filter.property.test.js --timeout 15000 --exit",
-    "test:dynamodb": "dotenv -e env/.env.dynamodb -- mocha test/adapters/dynamodb.*.test.js test/properties/dynamodb.filter.property.test.js --timeout 15000 --exit",
-    "test:redis": "dotenv -e env/.env.redis -- mocha test/adapters/redis.*.test.js --timeout 15000 --exit",
-    "test:cockroachdb": "dotenv -e env/.env.cockroachdb -- mocha test/adapters/cockroachdb.*.test.js --timeout 15000 --exit",
-    "test:mssql": "dotenv -e env/.env.mssql -- mocha test/adapters/mssql.*.test.js --timeout 30000 --exit",
-    "test:properties": "mocha test/properties/*.property.test.js --timeout 30000 --exit",
-    "test:all": "mocha test/adapters/*.test.js test/properties/*.property.test.js test/function.test.js --timeout 30000 --exit",
-    "demo:clear": "node -e \"var fs=require('fs'),p=require('path'),d=p.join(__dirname,'demo');fs.existsSync(d)&&fs.rmSync(d,{recursive:true,force:true});fs.mkdirSync(d,{recursive:true})\"",
-    "demo:create": "node scripts/demo-create.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/AvinashSKaranth/db-model-router"
-  },
-  "keywords": [
-    "mysql2",
-    "sqlite3",
-    "oracledb",
-    "postgres",
-    "pg",
-    "dynamodb",
-    "mongodb",
-    "mssql",
-    "express",
-    "ultimate-express",
-    "generative",
-    "rest",
-    "api"
-  ],
-  "author": "Avinash S Karanth",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/AvinashSKaranth/db-model-router/issues"
-  },
-  "homepage": "https://github.com/AvinashSKaranth/db-model-router#readme",
-  "dependencies": {
-    "dotenv": "^10.0.0",
-    "inquirer": "^8.2.6",
-    "lodash": "^4.17.21",
-    "node-input-validator": "^4.5.0"
-  },
-  "peerDependencies": {
-    "@aws-sdk/client-dynamodb": "^3.1039.0",
-    "@aws-sdk/lib-dynamodb": "^3.1039.0",
-    "better-sqlite3": "^12.9.0",
-    "express": "^4.17.2 || ^5.0.0",
-    "ioredis": "^5.10.1",
-    "mongodb": "^7.2.0",
-    "mssql": "^12.5.0",
-    "mysql2": "^3.22.3",
-    "oracledb": "^6.10.0",
-    "pg": "^8.20.0",
-    "ultimate-express": "^2.0.0"
-  },
-  "peerDependenciesMeta": {
-    "express": {
-      "optional": true
-    },
-    "ultimate-express": {
-      "optional": true
-    },
-    "@aws-sdk/client-dynamodb": {
-      "optional": true
-    },
-    "@aws-sdk/lib-dynamodb": {
-      "optional": true
-    },
-    "better-sqlite3": {
-      "optional": true
-    },
-    "ioredis": {
-      "optional": true
-    },
-    "mongodb": {
-      "optional": true
-    },
-    "mssql": {
-      "optional": true
-    },
-    "mysql2": {
-      "optional": true
-    },
-    "oracledb": {
-      "optional": true
-    },
-    "pg": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "dotenv-cli": "^11.0.0",
-    "express": "^4.21.0",
-    "faker": "^5.5.3",
-    "fast-check": "^4.6.0",
-    "mocha": "^11.7.2",
-    "supertest": "^6.2.4"
-  }
-}
+{
+  "name": "db-model-router",
+  "version": "1.0.7",
+  "description": "Generative API Creation using mysql2 and express libraries in node js",
+  "main": "src/index.js",
+  "bin": {
+    "db-model-router": "src/cli/main.js"
+  },
+  "scripts": {
+    "dev": "nodemon src/serve.js",
+    "test": "dotenv -e env/.env.default -- mocha --exit",
+    "test:sqlite3": "dotenv -e env/.env.sqlite3 -- mocha test/adapters/sqlite3.*.test.js test/properties/sqlite3.filter.property.test.js --timeout 15000 --exit",
+    "test:mysql": "dotenv -e env/.env.mysql -- mocha test/adapters/mysql.*.test.js test/properties/mysql.filter.property.test.js --timeout 15000 --exit",
+    "test:postgres": "dotenv -e env/.env.postgres -- mocha test/adapters/postgres.*.test.js test/properties/postgres.filter.property.test.js --timeout 15000 --exit",
+    "test:oracle": "dotenv -e env/.env.oracle -- mocha test/adapters/oracle.*.test.js test/properties/oracle.filter.property.test.js --timeout 30000 --exit",
+    "test:mongodb": "dotenv -e env/.env.mongodb -- mocha test/adapters/mongodb.*.test.js test/properties/mongodb.filter.property.test.js --timeout 15000 --exit",
+    "test:dynamodb": "dotenv -e env/.env.dynamodb -- mocha test/adapters/dynamodb.*.test.js test/properties/dynamodb.filter.property.test.js --timeout 15000 --exit",
+    "test:redis": "dotenv -e env/.env.redis -- mocha test/adapters/redis.*.test.js --timeout 15000 --exit",
+    "test:cockroachdb": "dotenv -e env/.env.cockroachdb -- mocha test/adapters/cockroachdb.*.test.js --timeout 15000 --exit",
+    "test:mssql": "dotenv -e env/.env.mssql -- mocha test/adapters/mssql.*.test.js --timeout 30000 --exit",
+    "test:kafka": "dotenv -e env/.env.kafka -- mocha test/kafka.test.js test/kafka.integration.test.js --timeout 30000 --exit",
+    "test:properties": "mocha test/properties/*.property.test.js --timeout 30000 --exit",
+    "test:all": "mocha test/adapters/*.test.js test/properties/*.property.test.js test/function.test.js --timeout 30000 --exit",
+    "demo:clear": "node -e \"var fs=require('fs'),p=require('path'),d=p.join(__dirname,'demo');fs.existsSync(d)&&fs.rmSync(d,{recursive:true,force:true});fs.mkdirSync(d,{recursive:true})\"",
+    "demo:create": "node scripts/demo-create.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AvinashSKaranth/db-model-router"
+  },
+  "keywords": [
+    "mysql2",
+    "sqlite3",
+    "oracledb",
+    "postgres",
+    "pg",
+    "dynamodb",
+    "mongodb",
+    "mssql",
+    "express",
+    "ultimate-express",
+    "generative",
+    "rest",
+    "api"
+  ],
+  "author": "Avinash S Karanth",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/AvinashSKaranth/db-model-router/issues"
+  },
+  "homepage": "https://github.com/AvinashSKaranth/db-model-router#readme",
+  "dependencies": {
+    "dotenv": "^10.0.0",
+    "ejs": "^5.0.2",
+    "inquirer": "^8.2.6",
+    "lodash": "^4.17.21",
+    "node-input-validator": "^4.5.0"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-dynamodb": "^3.1039.0",
+    "@aws-sdk/lib-dynamodb": "^3.1039.0",
+    "better-sqlite3": "^12.9.0",
+    "express": "^4.17.2 || ^5.0.0",
+    "ioredis": "^5.10.1",
+    "kafkajs": "^2.2.4",
+    "mongodb": "^7.2.0",
+    "mssql": "^12.5.0",
+    "mysql2": "^3.22.3",
+    "oracledb": "^6.10.0",
+    "pg": "^8.20.0",
+    "ultimate-express": "^2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    },
+    "ultimate-express": {
+      "optional": true
+    },
+    "@aws-sdk/client-dynamodb": {
+      "optional": true
+    },
+    "@aws-sdk/lib-dynamodb": {
+      "optional": true
+    },
+    "better-sqlite3": {
+      "optional": true
+    },
+    "ioredis": {
+      "optional": true
+    },
+    "kafkajs": {
+      "optional": true
+    },
+    "mongodb": {
+      "optional": true
+    },
+    "mssql": {
+      "optional": true
+    },
+    "mysql2": {
+      "optional": true
+    },
+    "oracledb": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "dotenv-cli": "^11.0.0",
+    "express": "^4.21.0",
+    "faker": "^5.5.3",
+    "fast-check": "^4.6.0",
+    "kafkajs": "^2.2.4",
+    "mocha": "^11.7.2",
+    "supertest": "^6.2.4"
+  }
+}

package/scripts/demo-create.js

@@ -44,4 +44,4 @@ run("node ../src/cli/main.js generate --from dbmr.schema.json", DEMO);
 run("npm install", DEMO);
 
 console.log("\n✔ Demo project ready in ./demo");
-console.log("  cd demo && npm run dev\n");
+console.log("cd demo && npm run migrate && npm run dev\n");