db-model-router 1.0.6 → 1.0.7

package/src/cli/saas/generate-saas-migrations.js

@@ -0,0 +1,480 @@
+"use strict";
+
+/**
+ * SaaS migration generator.
+ *
+ * Generates CREATE TABLE migration files for all SaaS tables with proper
+ * column types, foreign key constraints, and unique constraints per adapter.
+ * Supports SQL adapters (postgres, mysql, sqlite3, mssql, oracle, cockroachdb)
+ * and NoSQL adapters (mongodb, dynamodb, redis).
+ */
+
+const { mapColumnType } = require("../generate-migration");
+
+// ---------------------------------------------------------------------------
+// Constants
+// ---------------------------------------------------------------------------
+
+const SQL_ADAPTERS = [
+  "mysql",
+  "postgres",
+  "sqlite3",
+  "mssql",
+  "cockroachdb",
+  "oracle",
+];
+
+/**
+ * Map a TEXT column type per adapter.
+ * Used for columns that need unbounded text storage (e.g. response_body).
+ * @param {string} adapter
+ * @returns {string}
+ */
+function textType(adapter) {
+  if (adapter === "oracle") return "CLOB";
+  if (adapter === "mssql") return "NVARCHAR(MAX)";
+  return "TEXT";
+}
+
+/**
+ * Table definitions in dependency order.
+ * Each entry defines columns, primary key, foreign keys, and unique constraints.
+ */
+const TABLE_DEFINITIONS = [
+  {
+    name: "tenants",
+    columns: [
+      { name: "tenant_id", rule: "auto_increment", pk: true },
+      { name: "name", rule: "required|string" },
+      { name: "slug", rule: "required|string" },
+      { name: "attributes", rule: "object" },
+      { name: "created_at", rule: "datetime", timestamp: true },
+      { name: "modified_at", rule: "datetime", timestamp: true },
+    ],
+    foreignKeys: [],
+    unique: [["slug"]],
+  },
+  {
+    name: "roles",
+    columns: [
+      { name: "role_id", rule: "auto_increment", pk: true },
+      { name: "tenant_id", rule: "integer" },
+      { name: "name", rule: "required|string" },
+      { name: "created_at", rule: "datetime", timestamp: true },
+      { name: "modified_at", rule: "datetime", timestamp: true },
+    ],
+    foreignKeys: [
+      { column: "tenant_id", references: "tenants", refColumn: "tenant_id" },
+    ],
+    unique: [["tenant_id", "name"]],
+  },
+  {
+    name: "users",
+    columns: [
+      { name: "user_id", rule: "auto_increment", pk: true },
+      { name: "email", rule: "required|string" },
+      { name: "phone", rule: "string" },
+      { name: "password_hash", rule: "required|string" },
+      { name: "name", rule: "required|string" },
+      { name: "unique_attribute", rule: "required|string" },
+      { name: "tenant_id", rule: "integer" },
+      { name: "role_id", rule: "required|integer" },
+      { name: "attributes", rule: "object" },
+      { name: "created_at", rule: "datetime", timestamp: true },
+      { name: "modified_at", rule: "datetime", timestamp: true },
+    ],
+    foreignKeys: [
+      { column: "tenant_id", references: "tenants", refColumn: "tenant_id" },
+      { column: "role_id", references: "roles", refColumn: "role_id" },
+    ],
+    unique: [["tenant_id", "unique_attribute"]],
+  },
+  {
+    name: "role_permissions",
+    columns: [
+      { name: "role_permission_id", rule: "auto_increment", pk: true },
+      { name: "role_id", rule: "required|integer" },
+      { name: "permission", rule: "required|object" },
+      { name: "created_at", rule: "datetime", timestamp: true },
+      { name: "modified_at", rule: "datetime", timestamp: true },
+    ],
+    foreignKeys: [
+      { column: "role_id", references: "roles", refColumn: "role_id" },
+    ],
+    unique: [],
+  },
+  {
+    name: "webhooks",
+    columns: [
+      { name: "webhook_id", rule: "auto_increment", pk: true },
+      { name: "tenant_id", rule: "required|integer" },
+      { name: "url", rule: "required|string" },
+      { name: "key", rule: "required|string" },
+      { name: "secret", rule: "required|string" },
+      { name: "created_at", rule: "datetime", timestamp: true },
+      { name: "modified_at", rule: "datetime", timestamp: true },
+    ],
+    foreignKeys: [
+      { column: "tenant_id", references: "tenants", refColumn: "tenant_id" },
+    ],
+    unique: [],
+  },
+  {
+    name: "webhook_logs",
+    columns: [
+      { name: "webhook_log_id", rule: "auto_increment", pk: true },
+      { name: "webhook_id", rule: "required|integer" },
+      { name: "tenant_id", rule: "required|integer" },
+      { name: "event_type", rule: "required|string" },
+      { name: "payload", rule: "required|object" },
+      { name: "status", rule: "required|string" },
+      { name: "response_body", rule: "text" },
+      { name: "response_status_code", rule: "integer" },
+      { name: "created_at", rule: "datetime", timestamp: true },
+    ],
+    foreignKeys: [
+      { column: "webhook_id", references: "webhooks", refColumn: "webhook_id" },
+    ],
+    unique: [],
+  },
+];
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+/**
+ * Quote an identifier based on adapter.
+ * @param {string} name
+ * @param {string} adapter
+ * @returns {string}
+ */
+function quoteIdent(name, adapter) {
+  if (adapter === "mssql") return `[${name}]`;
+  if (adapter === "oracle") return `"${name.toUpperCase()}"`;
+  return name;
+}
+
+/**
+ * Format a Date as YYYYMMDDHHMMSS (14-digit string).
+ * @param {Date} date
+ * @returns {string}
+ */
+function migrationTimestamp(date) {
+  const y = String(date.getFullYear()).padStart(4, "0");
+  const mo = String(date.getMonth() + 1).padStart(2, "0");
+  const d = String(date.getDate()).padStart(2, "0");
+  const h = String(date.getHours()).padStart(2, "0");
+  const mi = String(date.getMinutes()).padStart(2, "0");
+  const s = String(date.getSeconds()).padStart(2, "0");
+  return `${y}${mo}${d}${h}${mi}${s}`;
+}
+
+/**
+ * Default timestamp expression per adapter.
+ * @param {string} adapter
+ * @returns {string}
+ */
+function defaultTimestamp(adapter) {
+  switch (adapter) {
+    case "mssql":
+      return " DEFAULT GETDATE()";
+    default:
+      return " DEFAULT CURRENT_TIMESTAMP";
+  }
+}
+
+// ---------------------------------------------------------------------------
+// SQL Migration Generation
+// ---------------------------------------------------------------------------
+
+/**
+ * Generate a CREATE TABLE SQL statement for a SaaS table definition.
+ *
+ * @param {object} tableDef - Table definition from TABLE_DEFINITIONS
+ * @param {string} adapter - Database adapter name
+ * @returns {string} SQL CREATE TABLE statement
+ */
+function generateCreateTableSQL(tableDef, adapter) {
+  const lines = [];
+
+  for (const col of tableDef.columns) {
+    let line;
+
+    // Handle "text" type specially (not supported by mapColumnType)
+    if (col.rule === "text") {
+      const sqlType = textType(adapter);
+      line = `  ${quoteIdent(col.name, adapter)} ${sqlType}`;
+      // text columns are nullable by default
+    } else {
+      const { sqlType, nullable, isAutoIncrement } = mapColumnType(
+        col.rule,
+        adapter,
+      );
+
+      if (col.pk) {
+        if (isAutoIncrement && adapter === "sqlite3") {
+          line = `  ${quoteIdent(col.name, adapter)} INTEGER PRIMARY KEY AUTOINCREMENT`;
+        } else {
+          line = `  ${quoteIdent(col.name, adapter)} ${sqlType} PRIMARY KEY`;
+        }
+      } else {
+        line = `  ${quoteIdent(col.name, adapter)} ${sqlType}`;
+        if (!nullable) {
+          line += " NOT NULL";
+        }
+        if (col.timestamp) {
+          line += defaultTimestamp(adapter);
+        }
+      }
+    }
+
+    lines.push(line);
+  }
+
+  // Foreign key constraints
+  for (const fk of tableDef.foreignKeys) {
+    lines.push(
+      `  FOREIGN KEY (${quoteIdent(fk.column, adapter)}) REFERENCES ${quoteIdent(fk.references, adapter)}(${quoteIdent(fk.refColumn, adapter)})`,
+    );
+  }
+
+  // Unique constraints
+  for (const cols of tableDef.unique) {
+    const quotedCols = cols.map((c) => quoteIdent(c, adapter)).join(", ");
+    lines.push(`  UNIQUE (${quotedCols})`);
+  }
+
+  const createPrefix =
+    adapter === "oracle" || adapter === "mssql"
+      ? `CREATE TABLE ${quoteIdent(tableDef.name, adapter)}`
+      : `CREATE TABLE IF NOT EXISTS ${quoteIdent(tableDef.name, adapter)}`;
+
+  return `${createPrefix} (\n${lines.join(",\n")}\n);\n`;
+}
+
+// ---------------------------------------------------------------------------
+// NoSQL Migration Generation
+// ---------------------------------------------------------------------------
+
+/**
+ * Generate a MongoDB migration JS file for a SaaS table (collection).
+ * @param {object} tableDef - Table definition
+ * @returns {string}
+ */
+function generateMongoDBMigration(tableDef) {
+  const indexLines = [];
+
+  // Unique indexes
+  for (const cols of tableDef.unique) {
+    const indexObj = cols.map((c) => `${c}: 1`).join(", ");
+    indexLines.push(
+      `  await db.collection("${tableDef.name}").createIndex({ ${indexObj} }, { unique: true });`,
+    );
+  }
+
+  return `"use strict";
+
+module.exports = {
+  async up(db) {
+    await db.createCollection("${tableDef.name}");
+${indexLines.length > 0 ? indexLines.join("\n") + "\n" : ""}  },
+
+  async down(db) {
+    await db.collection("${tableDef.name}").drop();
+  },
+};
+`;
+}
+
+/**
+ * Generate a DynamoDB migration JS file for a SaaS table.
+ * @param {object} tableDef - Table definition
+ * @returns {string}
+ */
+function generateDynamoDBMigration(tableDef) {
+  const pk = tableDef.columns.find((c) => c.pk);
+  const pkName = pk ? pk.name : "id";
+
+  return `import { CreateTableCommand, DeleteTableCommand } from "@aws-sdk/client-dynamodb";
+
+export async function up(db) {
+  await db.send(new CreateTableCommand({
+    TableName: "${tableDef.name}",
+    KeySchema: [{ AttributeName: "${pkName}", KeyType: "HASH" }],
+    AttributeDefinitions: [{ AttributeName: "${pkName}", AttributeType: "N" }],
+    BillingMode: "PAY_PER_REQUEST",
+  }));
+}
+
+export async function down(db) {
+  await db.send(new DeleteTableCommand({ TableName: "${tableDef.name}" }));
+}
+`;
+}
+
+/**
+ * Generate a Redis migration JS file for a SaaS table.
+ * @param {object} tableDef - Table definition
+ * @returns {string}
+ */
+function generateRedisMigration(tableDef) {
+  return `"use strict";
+
+module.exports = {
+  async up(db) {
+    // Redis is schema-less. This migration is a placeholder.
+    // Data for "${tableDef.name}" will be stored as hash keys: ${tableDef.name}:<id>
+    console.log("Redis: ${tableDef.name} collection ready (schema-less).");
+  },
+
+  async down(db) {
+    // Warning: this deletes ALL keys matching the pattern
+    // In production, use SCAN instead of KEYS
+    const keys = await db.keys("${tableDef.name}:*");
+    if (keys.length > 0) {
+      await db.del(...keys);
+    }
+  },
+};
+`;
+}
+
+// ---------------------------------------------------------------------------
+// Public API
+// ---------------------------------------------------------------------------
+
+/**
+ * Generate migration files for all SaaS tables.
+ *
+ * For SQL adapters: produces a single .sql file with all CREATE TABLE statements.
+ * For NoSQL adapters: produces a single .js file with all collection setups.
+ *
+ * @param {string} adapter - Database adapter name
+ * @param {Date|number} [timestamp] - Base timestamp (Date object or ms since epoch). Defaults to new Date().
+ * @returns {Array<{ relPath: string, content: string }>}
+ */
+function generateSaasMigrations(adapter, timestamp) {
+  const baseDate =
+    timestamp instanceof Date
+      ? timestamp
+      : typeof timestamp === "number"
+        ? new Date(timestamp)
+        : new Date();
+
+  const isSql = SQL_ADAPTERS.includes(adapter);
+  const tsStr = migrationTimestamp(baseDate);
+
+  if (isSql) {
+    // Single SQL file with all CREATE TABLE statements
+    const statements = [];
+    for (const tableDef of TABLE_DEFINITIONS) {
+      statements.push(generateCreateTableSQL(tableDef, adapter));
+    }
+    const content = statements.join("\n");
+    return [
+      {
+        relPath: `migrations/${tsStr}_create_saas_tables.sql`,
+        content,
+      },
+    ];
+  } else if (adapter === "mongodb") {
+    // Single JS file with all MongoDB collection setups
+    const parts = TABLE_DEFINITIONS.map((td) => generateMongoDBMigration(td));
+    const content = `"use strict";
+
+module.exports = {
+  async up(db) {
+${TABLE_DEFINITIONS.map((td) => {
+  const indexLines = [];
+  for (const cols of td.unique) {
+    const indexObj = cols.map((c) => `${c}: 1`).join(", ");
+    indexLines.push(
+      `    await db.collection("${td.name}").createIndex({ ${indexObj} }, { unique: true });`,
+    );
+  }
+  return `    await db.createCollection("${td.name}");\n${indexLines.join("\n")}`;
+}).join("\n")}
+  },
+
+  async down(db) {
+${TABLE_DEFINITIONS.map((td) => `    await db.collection("${td.name}").drop();`).join("\n")}
+  },
+};
+`;
+    return [
+      {
+        relPath: `migrations/${tsStr}_create_saas_tables.js`,
+        content,
+      },
+    ];
+  } else if (adapter === "dynamodb") {
+    const pkNames = TABLE_DEFINITIONS.map((td) => {
+      const pk = td.columns.find((c) => c.pk);
+      return { table: td.name, pk: pk ? pk.name : "id" };
+    });
+    const content = `import { CreateTableCommand, DeleteTableCommand } from "@aws-sdk/client-dynamodb";
+
+export async function up(db) {
+${pkNames
+  .map(
+    (t) => `  await db.send(new CreateTableCommand({
+    TableName: "${t.table}",
+    KeySchema: [{ AttributeName: "${t.pk}", KeyType: "HASH" }],
+    AttributeDefinitions: [{ AttributeName: "${t.pk}", AttributeType: "N" }],
+    BillingMode: "PAY_PER_REQUEST",
+  }));`,
+  )
+  .join("\n")}
+}
+
+export async function down(db) {
+${pkNames.map((t) => `  await db.send(new DeleteTableCommand({ TableName: "${t.table}" }));`).join("\n")}
+}
+`;
+    return [
+      {
+        relPath: `migrations/${tsStr}_create_saas_tables.js`,
+        content,
+      },
+    ];
+  } else if (adapter === "redis") {
+    const content = `"use strict";
+
+module.exports = {
+  async up(db) {
+    // Redis is schema-less. This migration is a placeholder.
+${TABLE_DEFINITIONS.map((td) => `    console.log("Redis: ${td.name} collection ready (schema-less).");`).join("\n")}
+  },
+
+  async down(db) {
+${TABLE_DEFINITIONS.map(
+  (td) => `    const ${td.name}Keys = await db.keys("${td.name}:*");
+    if (${td.name}Keys.length > 0) await db.del(...${td.name}Keys);`,
+).join("\n")}
+  },
+};
+`;
+    return [
+      {
+        relPath: `migrations/${tsStr}_create_saas_tables.js`,
+        content,
+      },
+    ];
+  }
+
+  // Fallback
+  return [
+    {
+      relPath: `migrations/${tsStr}_create_saas_tables.js`,
+      content: `// Migration for SaaS tables\n`,
+    },
+  ];
+}
+
+module.exports = {
+  generateSaasMigrations,
+  generateCreateTableSQL,
+  TABLE_DEFINITIONS,
+  SQL_ADAPTERS,
+};

package/src/cli/saas/generate-saas-models.js

@@ -0,0 +1,211 @@
+"use strict";
+
+/**
+ * SaaS model generator.
+ *
+ * Generates model files for all SaaS tables following the existing
+ * `generateModelFile` pattern with `model(db, table, structure, pk, unique, option)`.
+ * Models are adapter-agnostic (validation rules, not SQL types).
+ */
+
+// ---------------------------------------------------------------------------
+// Model Definitions
+// ---------------------------------------------------------------------------
+
+/**
+ * SaaS model definitions in the format expected by the model system.
+ * Each entry defines: table name, structure (validation rules), primary key,
+ * unique constraints, and option (timestamp columns).
+ */
+const MODEL_DEFINITIONS = [
+  {
+    table: "tenants",
+    structure: {
+      name: "required|string",
+      slug: "required|string",
+      attributes: "object",
+    },
+    primary_key: "tenant_id",
+    unique: ["slug"],
+    option: { created_at: "created_at", modified_at: "modified_at" },
+  },
+  {
+    table: "roles",
+    structure: {
+      tenant_id: "integer",
+      name: "required|string",
+    },
+    primary_key: "role_id",
+    unique: ["tenant_id", "name"],
+    option: { created_at: "created_at", modified_at: "modified_at" },
+  },
+  {
+    table: "users",
+    structure: {
+      email: "required|string",
+      phone: "string",
+      password_hash: "required|string",
+      name: "required|string",
+      unique_attribute: "required|string",
+      tenant_id: "integer",
+      role_id: "required|integer",
+      attributes: "object",
+    },
+    primary_key: "user_id",
+    unique: ["tenant_id", "unique_attribute"],
+    option: { created_at: "created_at", modified_at: "modified_at" },
+  },
+  {
+    table: "role_permissions",
+    structure: {
+      role_id: "required|integer",
+      permission: "required|object",
+    },
+    primary_key: "role_permission_id",
+    unique: ["role_permission_id"],
+    option: { created_at: "created_at", modified_at: "modified_at" },
+  },
+  {
+    table: "webhooks",
+    structure: {
+      tenant_id: "required|integer",
+      url: "required|string",
+      key: "required|string",
+      secret: "required|string",
+    },
+    primary_key: "webhook_id",
+    unique: ["webhook_id"],
+    option: { created_at: "created_at", modified_at: "modified_at" },
+  },
+  {
+    table: "webhook_logs",
+    structure: {
+      webhook_id: "required|integer",
+      tenant_id: "required|integer",
+      event_type: "required|string",
+      payload: "required|object",
+      status: "required|string",
+      response_body: "string",
+      response_status_code: "integer",
+    },
+    primary_key: "webhook_log_id",
+    unique: ["webhook_log_id"],
+    option: { created_at: "created_at" },
+  },
+];
+
+// ---------------------------------------------------------------------------
+// Code Generation
+// ---------------------------------------------------------------------------
+
+/**
+ * Generate the content of a single model file following the existing pattern.
+ *
+ * @param {object} def - Model definition object
+ * @returns {string} Generated model file content
+ */
+function generateModelContent(def) {
+  const varName = def.table;
+  const structStr = JSON.stringify(def.structure, null, 4);
+  const uniqueStr = JSON.stringify(def.unique);
+
+  const optionParts = [];
+  if (def.option.created_at)
+    optionParts.push(`created_at: "${def.option.created_at}"`);
+  if (def.option.modified_at)
+    optionParts.push(`modified_at: "${def.option.modified_at}"`);
+  const optionStr = `{ ${optionParts.join(", ")} }`;
+
+  return `import dbModelRouter from "db-model-router";
+
+const { db, model } = dbModelRouter;
+
+const ${varName} = model(
+  db,
+  "${def.table}",
+  ${structStr},
+  "${def.primary_key}",
+  ${uniqueStr},
+  ${optionStr},
+);
+
+export default ${varName};
+`;
+}
+
+// ---------------------------------------------------------------------------
+// Public API
+// ---------------------------------------------------------------------------
+
+/**
+ * Generate model files for all SaaS tables.
+ *
+ * @param {string} adapter - Database adapter name (accepted for API consistency, not used for model content)
+ * @param {string[]} [additionalTables] - Additional table names from dbmr schema to include in models/index.js
+ * @returns {Array<{ relPath: string, content: string }>}
+ */
+function generateSaasModels(adapter, additionalTables) {
+  const results = [];
+
+  for (const def of MODEL_DEFINITIONS) {
+    results.push({
+      relPath: `models/${def.table}.js`,
+      content: generateModelContent(def),
+    });
+  }
+
+  // Generate models/index.js that re-exports all models (SaaS + dbmr) as named exports
+  results.push({
+    relPath: "models/index.js",
+    content: generateModelsIndex(additionalTables || []),
+  });
+
+  return results;
+}
+
+/**
+ * Generate the models/index.js barrel file.
+ * Imports all SaaS models and any additional dbmr schema models,
+ * then re-exports them all as named exports.
+ *
+ * @param {string[]} additionalTables - Additional table names from dbmr schema
+ * @returns {string}
+ */
+function generateModelsIndex(additionalTables) {
+  const saasTableNames = MODEL_DEFINITIONS.map((def) => def.table);
+  // Filter out dbmr tables that overlap with SaaS tables
+  const dbmrTables = (additionalTables || []).filter(
+    (t) => !saasTableNames.includes(t),
+  );
+
+  let code = "";
+  // SaaS model imports
+  for (const def of MODEL_DEFINITIONS) {
+    code += `import ${def.table} from "./${def.table}.js";\n`;
+  }
+  // dbmr schema model imports
+  for (const table of dbmrTables) {
+    code += `import ${safeVarName(table)} from "./${table}.js";\n`;
+  }
+
+  code += "\nexport {\n";
+  for (const def of MODEL_DEFINITIONS) {
+    code += `  ${def.table},\n`;
+  }
+  for (const table of dbmrTables) {
+    code += `  ${safeVarName(table)},\n`;
+  }
+  code += "};\n";
+  return code;
+}
+
+function safeVarName(name) {
+  if (/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name)) return name;
+  return name.replace(/[^a-zA-Z0-9_$]/g, "_");
+}
+
+module.exports = {
+  generateSaasModels,
+  generateModelContent,
+  MODEL_DEFINITIONS,
+};