forge-sql-orm 1.0.18 → 1.0.19

package/scripts/actions/migrations-create.ts

@@ -1,193 +0,0 @@
-import "reflect-metadata";
-import fs from "fs";
-import path from "path";
-import {MikroORM} from "@mikro-orm/mysql";
-import { execSync } from 'child_process';
-import { rmSync } from 'fs';
-
-/**
- * Cleans SQL statements by removing unnecessary database options.
- * @param sql - The raw SQL statement.
- * @returns The cleaned SQL statement.
- */
-function cleanSQLStatement(sql: string): string {
-  return sql.replace(/\s+default\s+character\s+set\s+utf8mb4\s+engine\s*=\s*InnoDB;?/gi, "").trim();
-}
-
-/**
- * Generates a migration file using the provided SQL statements.
- * @param createStatements - Array of SQL statements.
- * @param version - Migration version number.
- * @returns TypeScript migration file content.
- */
-function generateMigrationFile(createStatements: string[], version: number): string {
-  const versionPrefix = `v${version}_MIGRATION`;
-
-  // Clean each SQL statement and generate migration lines with .enqueue()
-  const migrationLines = createStatements
-    .map(
-      (stmt, index) =>
-        `        .enqueue("${versionPrefix}${index}", \"${cleanSQLStatement(stmt)}\")`, // eslint-disable-line no-useless-escape
-    )
-    .join("\n");
-
-  // Migration template
-  return `import { MigrationRunner } from "@forge/sql/out/migration";
-
-export default (migrationRunner: MigrationRunner): MigrationRunner => {
-    return migrationRunner
-${migrationLines};
-};`;
-}
-
-/**
- * Saves the generated migration file along with `migrationCount.ts` and `index.ts`.
- * @param migrationCode - The migration code to be written to the file.
- * @param version - Migration version number.
- * @param outputDir - Directory where the migration files will be saved.
- */
-function saveMigrationFiles(migrationCode: string, version: number, outputDir: string) {
-  if (!fs.existsSync(outputDir)) {
-    fs.mkdirSync(outputDir, { recursive: true });
-  }
-
-  const migrationFilePath = path.join(outputDir, `migrationV${version}.ts`);
-  const migrationCountPath = path.join(outputDir, `migrationCount.ts`);
-  const indexFilePath = path.join(outputDir, `index.ts`);
-
-  // Write the migration file
-  fs.writeFileSync(migrationFilePath, migrationCode);
-
-  // Write the migration count file
-  fs.writeFileSync(migrationCountPath, `export const MIGRATION_VERSION = ${version};`);
-
-  // Generate the migration index file
-  const indexFileContent = `import { MigrationRunner } from "@forge/sql/out/migration";
-import { MIGRATION_VERSION } from "./migrationCount";
-
-export type MigrationType = (
-  migrationRunner: MigrationRunner,
-) => MigrationRunner;
-
-export default async (
-  migrationRunner: MigrationRunner,
-): Promise<MigrationRunner> => {
-  for (let i = 1; i <= MIGRATION_VERSION; i++) {
-    const migrations = (await import(\`./migrationV\${i}\`)) as {
-      default: MigrationType;
-    };
-    migrations.default(migrationRunner);
-  }
-  return migrationRunner;
-};`;
-
-  fs.writeFileSync(indexFilePath, indexFileContent);
-
-  console.log(`✅ Migration file created: ${migrationFilePath}`);
-  console.log(`✅ Migration count file updated: ${migrationCountPath}`);
-  console.log(`✅ Migration index file created: ${indexFilePath}`);
-}
-
-/**
- * Extracts only the relevant SQL statements for migration.
- * @param schema - The full database schema as SQL.
- * @returns Filtered list of SQL statements.
- */
-const extractCreateStatements = (schema: string): string[] => {
-  const statements = schema.split(";").map((s) => s.trim());
-
-  return statements.filter(
-    (stmt) =>
-      stmt.startsWith("create table") ||
-      (stmt.startsWith("alter table") && stmt.includes("add index")) ||
-      stmt.startsWith("primary"),
-  );
-};
-
-/**
- * Dynamically loads `entities` from `index.ts` in the specified directory.
- * @param entitiesPath - Path to the directory containing `index.ts`.
- * @returns Array of entity classes.
- */
-const loadEntities = async (entitiesPath: string) => {
-  try {
-    const indexFilePath = path.resolve(path.join(entitiesPath, "index.ts"));
-    if (!fs.existsSync(indexFilePath)) {
-      console.error(`❌ Error: index.ts not found in ${indexFilePath}`);
-      process.exit(1);
-    }
-
-    const { default: entities } = await import(indexFilePath);
-    console.log(`✅ Loaded ${entities.length} entities from ${entitiesPath}`);
-    return entities;
-  } catch (error) {
-    console.error(`❌ Error loading index.ts from ${entitiesPath}:`, error);
-    process.exit(1);
-  }
-};
-
-/**
- * Loads the current migration version from `migrationCount.ts`.
- * @param migrationPath - Path to the migration folder.
- * @returns The latest migration version.
- */
-const loadMigrationVersion = async (migrationPath: string): Promise<number> => {
-  try {
-    const migrationCountFilePath = path.resolve(path.join(migrationPath, "migrationCount.ts"));
-    if (!fs.existsSync(migrationCountFilePath)) {
-      return 0;
-    }
-
-    const { MIGRATION_VERSION } = await import(migrationCountFilePath);
-    console.log(`✅ Current migration version: ${MIGRATION_VERSION}`);
-    return MIGRATION_VERSION as number;
-  } catch (error) {
-    console.error(`❌ Error loading migrationCount:`, error);
-    process.exit(1);
-  }
-};
-
-/**
- * Creates a full database migration.
- * @param options - Database connection settings and output paths.
- */
-export const createMigration = async (options: any) => {
-  try {
-    let version = await loadMigrationVersion(options.output);
-
-    if (version > 0) {
-      console.error(`❌ Error: Migration has already been created.`);
-      process.exit(1);
-    }
-
-    // Start from version 1 if no previous migrations exist
-    version = 1;
-
-    // Load entities dynamically from index.ts
-    const entities = await loadEntities(options.entitiesPath);
-
-    // Initialize MikroORM
-    const orm = MikroORM.initSync({
-      host: options.host,
-      port: options.port,
-      user: options.user,
-      password: options.password,
-      dbName: options.dbName,
-      entities: entities,
-    });
-
-    // Generate SQL schema
-    const createSchemaSQL = await orm.schema.getCreateSchemaSQL({ wrap: true });
-    const statements = extractCreateStatements(createSchemaSQL);
-
-    // Generate and save migration files
-    const migrationFile = generateMigrationFile(statements, version);
-    saveMigrationFiles(migrationFile, version, options.output);
-
-    console.log(`✅ Migration successfully created!`);
-    process.exit(0);
-  } catch (error) {
-    console.error(`❌ Error during migration creation:`, error);
-    process.exit(1);
-  }
-};

package/scripts/actions/migrations-update.ts

@@ -1,200 +0,0 @@
-import "reflect-metadata";
-import fs from "fs";
-import path from "path";
-import {MikroORM} from "@mikro-orm/mysql";
-
-/**
- * Cleans SQL statements by removing unnecessary database options.
- * @param sql - The raw SQL statement.
- * @returns The cleaned SQL statement.
- */
-function cleanSQLStatement(sql: string): string {
-  return sql.replace(/\s+default\s+character\s+set\s+utf8mb4\s+engine\s*=\s*InnoDB;?/gi, "").trim();
-}
-
-/**
- * Generates a migration file using the provided SQL statements.
- * @param createStatements - Array of SQL statements.
- * @param version - Migration version number.
- * @returns TypeScript migration file content.
- */
-function generateMigrationFile(createStatements: string[], version: number): string {
-  const versionPrefix = `v${version}_MIGRATION`;
-
-  // Clean each SQL statement and generate migration lines with .enqueue()
-  const migrationLines = createStatements
-    .map(
-      (stmt, index) =>
-        `        .enqueue("${versionPrefix}${index}", \"${cleanSQLStatement(stmt)}\")`, // eslint-disable-line no-useless-escape
-    )
-    .join("\n");
-
-  // Migration template
-  return `import { MigrationRunner } from "@forge/sql/out/migration";
-
-export default (migrationRunner: MigrationRunner): MigrationRunner => {
-    return migrationRunner
-${migrationLines};
-};`;
-}
-
-/**
- * Saves the generated migration file along with `migrationCount.ts` and `index.ts`.
- * @param migrationCode - The migration code to be written to the file.
- * @param version - Migration version number.
- * @param outputDir - Directory where the migration files will be saved.
- */
-function saveMigrationFiles(migrationCode: string, version: number, outputDir: string) {
-  if (!fs.existsSync(outputDir)) {
-    fs.mkdirSync(outputDir, { recursive: true });
-  }
-
-  const migrationFilePath = path.join(outputDir, `migrationV${version}.ts`);
-  const migrationCountPath = path.join(outputDir, `migrationCount.ts`);
-  const indexFilePath = path.join(outputDir, `index.ts`);
-
-  // Write the migration file
-  fs.writeFileSync(migrationFilePath, migrationCode);
-
-  // Write the migration count file
-  fs.writeFileSync(migrationCountPath, `export const MIGRATION_VERSION = ${version};`);
-
-  // Generate the migration index file
-  const indexFileContent = `import { MigrationRunner } from "@forge/sql/out/migration";
-import { MIGRATION_VERSION } from "./migrationCount";
-
-export type MigrationType = (
-  migrationRunner: MigrationRunner,
-) => MigrationRunner;
-
-export default async (
-  migrationRunner: MigrationRunner,
-): Promise<MigrationRunner> => {
-  for (let i = 1; i <= MIGRATION_VERSION; i++) {
-    const migrations = (await import(\`./migrationV\${i}\`)) as {
-      default: MigrationType;
-    };
-    migrations.default(migrationRunner);
-  }
-  return migrationRunner;
-};`;
-
-  fs.writeFileSync(indexFilePath, indexFileContent);
-
-  console.log(`✅ Migration file created: ${migrationFilePath}`);
-  console.log(`✅ Migration count file updated: ${migrationCountPath}`);
-  console.log(`✅ Migration index file created: ${indexFilePath}`);
-}
-
-/**
- * Extracts only the relevant SQL statements for migration.
- * @param schema - The full database schema as SQL.
- * @returns Filtered list of SQL statements.
- */
-const extractCreateStatements = (schema: string): string[] => {
-  const statements = schema.split(";").map((s) => s.trim());
-
-  return statements.filter(
-    (stmt) =>
-      stmt.startsWith("create table") ||
-      (stmt.startsWith("alter table") && stmt.includes("add index")) ||
-      (stmt.startsWith("alter table") && stmt.includes("add") && !stmt.includes("foreign")) ||
-      (stmt.startsWith("alter table") && stmt.includes("modify") && !stmt.includes("foreign")),
-  );
-};
-
-/**
- * Dynamically loads `entities` from `index.ts` in the specified directory.
- * @param entitiesPath - Path to the directory containing `index.ts`.
- * @returns Array of entity classes.
- */
-const loadEntities = async (entitiesPath: string) => {
-  try {
-    const indexFilePath = path.resolve(path.join(entitiesPath, "index.ts"));
-    if (!fs.existsSync(indexFilePath)) {
-      console.error(`❌ Error: index.ts not found in ${entitiesPath}`);
-      process.exit(1);
-    }
-
-    const { default: entities } = await import(indexFilePath);
-    console.log(`✅ Loaded ${entities.length} entities from ${entitiesPath}`);
-    return entities;
-  } catch (error) {
-    console.error(`❌ Error loading index.ts from ${entitiesPath}:`, error);
-    process.exit(1);
-  }
-};
-
-/**
- * Loads the current migration version from `migrationCount.ts`.
- * @param migrationPath - Path to the migration folder.
- * @returns The latest migration version.
- */
-const loadMigrationVersion = async (migrationPath: string): Promise<number> => {
-  try {
-    const migrationCountFilePath = path.resolve(path.join(migrationPath, "migrationCount.ts"));
-    if (!fs.existsSync(migrationCountFilePath)) {
-      console.warn(
-        `⚠️ Warning: migrationCount.ts not found in ${migrationCountFilePath}, assuming no previous migrations.`,
-      );
-      return 0;
-    }
-
-    const { MIGRATION_VERSION } = await import(migrationCountFilePath);
-    console.log(`✅ Current migration version: ${MIGRATION_VERSION}`);
-    return MIGRATION_VERSION as number;
-  } catch (error) {
-    console.error(`❌ Error loading migrationCount:`, error);
-    process.exit(1);
-  }
-};
-
-/**
- * Updates an existing database migration by generating schema modifications.
- * @param options - Database connection settings and output paths.
- */
-export const updateMigration = async (options: any) => {
-  try {
-    let version = await loadMigrationVersion(options.output);
-
-    if (version < 1) {
-      console.log(
-        `⚠️ Initial migration not found. Run "npx forge-sql-orm migrations:create" first.`,
-      );
-      process.exit(0);
-    }
-    version += 1;
-
-    // Load entities dynamically from index.ts
-    const entities = await loadEntities(options.entitiesPath);
-
-    // Initialize MikroORM
-    const orm = MikroORM.initSync({
-      host: options.host,
-      port: options.port,
-      user: options.user,
-      password: options.password,
-      dbName: options.dbName,
-      entities,
-      debug: true,
-    });
-
-    // Generate SQL schema updates
-    const createSchemaSQL = await orm.schema.getUpdateSchemaMigrationSQL({ wrap: true });
-    const statements = extractCreateStatements(createSchemaSQL?.down || "");
-
-    if (statements.length) {
-      const migrationFile = generateMigrationFile(statements, version);
-      saveMigrationFiles(migrationFile, version, options.output);
-
-      console.log(`✅ Migration successfully updated!`);
-      process.exit(0);
-    } else {
-      console.log(`⚠️ No new migration changes detected.`);
-      process.exit(0);
-    }
-  } catch (error) {
-    console.error(`❌ Error during migration update:`, error);
-    process.exit(1);
-  }
-};

package/scripts/cli.ts

@@ -1,221 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from "commander";
-import dotenv from "dotenv";
-import inquirer from "inquirer";
-import { generateModels } from "./actions/generate-models";
-import { createMigration } from "./actions/migrations-create";
-import { updateMigration } from "./actions/migrations-update";
-import {runPostInstallPatch} from "./actions/PatchPostinstall";
-
-// 🔄 Load environment variables from `.env` file
-dotenv.config();
-
-/**
- * Prompts the user for missing parameters using Inquirer.js.
- * @param config - The current configuration object.
- * @param defaultOutput - Default output path.
- * @param customAskMissingParams - Optional function for additional prompts.
- * @returns Updated configuration with user input.
- */
-const askMissingParams = async (
-  config: any,
-  defaultOutput: string,
-  customAskMissingParams?: (cfg: any, questions: unknown[]) => void,
-) => {
-  const questions: unknown[] = [];
-
-  if (!config.host)
-    questions.push({
-      type: "input",
-      name: "host",
-      message: "Enter database host:",
-      default: "localhost",
-    });
-
-  if (!config.port)
-    questions.push({
-      type: "input",
-      name: "port",
-      message: "Enter database port:",
-      default: "3306",
-      validate: (input: string) => !isNaN(parseInt(input, 10)),
-    });
-
-  if (!config.user)
-    questions.push({
-      type: "input",
-      name: "user",
-      message: "Enter database user:",
-      default: "root",
-    });
-
-  if (!config.password)
-    questions.push({
-      type: "password",
-      name: "password",
-      message: "Enter database password:",
-      mask: "*",
-    });
-
-  if (!config.dbName)
-    questions.push({
-      type: "input",
-      name: "dbName",
-      message: "Enter database name:",
-    });
-
-  if (!config.output)
-    questions.push({
-      type: "input",
-      name: "output",
-      message: "Enter output path:",
-      default: defaultOutput,
-    });
-
-  // Allow additional questions from the caller
-  if (customAskMissingParams) {
-    customAskMissingParams(config, questions);
-  }
-
-  // If there are missing parameters, prompt the user
-  if (questions.length > 0) {
-    // @ts-ignore - Ignore TypeScript warning for dynamic question type
-    const answers = await inquirer.prompt(questions);
-    return { ...config, ...answers, port: parseInt(answers.port, 10) };
-  }
-
-  return config;
-};
-
-/**
- * Retrieves configuration parameters from command-line arguments and environment variables.
- * If any required parameters are missing, prompts the user for input.
- * @param cmd - The command object containing CLI options.
- * @param defaultOutput - Default output directory.
- * @param customConfig - Optional function for additional configuration parameters.
- * @param customAskMissingParams - Optional function for additional prompts.
- * @returns A fully resolved configuration object.
- */
-const getConfig = async (
-  cmd: any,
-  defaultOutput: string,
-  customConfig?: () => any,
-  customAskMissingParams?: (cfg: any, questions: unknown[]) => void,
-) => {
-  let config = {
-    host: cmd.host || process.env.FORGE_SQL_ORM_HOST,
-    port: cmd.port
-      ? parseInt(cmd.port, 10)
-      : process.env.FORGE_SQL_ORM_PORT
-        ? parseInt(process.env.FORGE_SQL_ORM_PORT, 10)
-        : undefined,
-    user: cmd.user || process.env.FORGE_SQL_ORM_USER,
-    password: cmd.password || process.env.FORGE_SQL_ORM_PASSWORD,
-    dbName: cmd.dbName || process.env.FORGE_SQL_ORM_DBNAME,
-    output: cmd.output || process.env.FORGE_SQL_ORM_OUTPUT,
-  };
-
-  // Merge additional configurations if provided
-  if (customConfig) {
-    config = { ...config, ...customConfig() };
-  }
-
-  return await askMissingParams(config, defaultOutput, customAskMissingParams);
-};
-
-// 📌 Initialize CLI
-const program = new Command();
-program.version("1.0.0");
-
-// ✅ Command: Generate database models (Entities)
-program
-  .command("generate:model")
-  .description("Generate MikroORM models from the database.")
-  .option("--host <string>", "Database host")
-  .option("--port <number>", "Database port")
-  .option("--user <string>", "Database user")
-  .option("--password <string>", "Database password")
-  .option("--dbName <string>", "Database name")
-  .option("--output <string>", "Output path for entities")
-  .action(async (cmd) => {
-    const config = await getConfig(cmd, "./database/entities");
-    await generateModels(config);
-  });
-
-// ✅ Command: Create initial database migration
-program
-  .command("migrations:create")
-  .description("Generate an initial migration for the entire database.")
-  .option("--host <string>", "Database host")
-  .option("--port <number>", "Database port")
-  .option("--user <string>", "Database user")
-  .option("--password <string>", "Database password")
-  .option("--dbName <string>", "Database name")
-  .option("--output <string>", "Output path for migrations")
-  .option("--entitiesPath <string>", "Path to the folder containing entities")
-  .action(async (cmd) => {
-    const config = await getConfig(
-      cmd,
-      "./database/migration",
-      () => ({
-        entitiesPath: cmd.entitiesPath || process.env.FORGE_SQL_ORM_ENTITIES_PATH,
-      }),
-      (cfg, questions: unknown[]) => {
-        if (!cfg.entitiesPath)
-          questions.push({
-            type: "input",
-            name: "entitiesPath",
-            message: "Enter the path to entities:",
-            default: "./database/entities",
-          });
-      },
-    );
-    await createMigration(config);
-  });
-
-// ✅ Command: Update migration for schema changes
-program
-  .command("migrations:update")
-  .description("Generate a migration to update the database schema.")
-  .option("--host <string>", "Database host")
-  .option("--port <number>", "Database port")
-  .option("--user <string>", "Database user")
-  .option("--password <string>", "Database password")
-  .option("--dbName <string>", "Database name")
-  .option("--output <string>", "Output path for migrations")
-  .option("--entitiesPath <string>", "Path to the folder containing entities")
-  .action(async (cmd) => {
-    const config = await getConfig(
-      cmd,
-      "./database/migration",
-      () => ({
-        entitiesPath: cmd.entitiesPath || process.env.FORGE_SQL_ORM_ENTITIES_PATH,
-      }),
-      (cfg, questions: unknown[]) => {
-        if (!cfg.entitiesPath)
-          questions.push({
-            type: "input",
-            name: "entitiesPath",
-            message: "Enter the path to entities:",
-            default: "./database/entities",
-          });
-      },
-    );
-    await updateMigration(config);
-  });
-
-// Patch MikroORM and Knex
-program
-    .command("patch:mikroorm")
-    .description("Patch MikroORM and Knex dependencies to work properly with Forge")
-    .action(async () => {
-      console.log("Running MikroORM patch...");
-      await runPostInstallPatch();
-      await runPostInstallPatch();
-      await runPostInstallPatch();
-      console.log("✅ MikroORM patch applied successfully!");
-    });
-
-// 🔥 Execute CLI
-program.parse(process.argv);