@mikro-orm/migrations 7.0.0-dev.9 → 7.0.0-dev.91

package/JSMigrationGenerator.js

@@ -11,7 +11,7 @@ export class JSMigrationGenerator extends MigrationGenerator {
         ret += `  async up() {\n`;
         diff.up.forEach(sql => ret += this.createStatement(sql, 4));
         ret += `  }\n\n`;
-        /* v8 ignore next 5 */
+        /* v8 ignore next */
         if (diff.down.length > 0) {
             ret += `  async down() {\n`;
             diff.down.forEach(sql => ret += this.createStatement(sql, 4));

package/MigrationGenerator.js

@@ -1,4 +1,5 @@
 import { Utils, } from '@mikro-orm/core';
+import { fs } from '@mikro-orm/core/fs-utils';
 import { writeFile } from 'node:fs/promises';
 export class MigrationGenerator {
     driver;
@@ -16,7 +17,7 @@ export class MigrationGenerator {
         /* v8 ignore next */
         const defaultPath = this.options.emit === 'ts' && this.options.pathTs ? this.options.pathTs : this.options.path;
         path = Utils.normalizePath(this.driver.config.get('baseDir'), path ?? defaultPath);
-        Utils.ensureDir(path);
+        fs.ensureDir(path);
         const timestamp = new Date().toISOString().replace(/[-T:]|\.\d{3}z$/ig, '');
         const className = this.namingStrategy.classToMigrationName(timestamp, name);
         const fileName = `${this.options.fileName(timestamp, name)}.${this.options.emit}`;

package/MigrationRunner.js

@@ -39,7 +39,7 @@ export class MigrationRunner {
         let queries = migration.getQueries();
         queries.unshift(...this.helper.getSchemaBeginning(charset, this.options.disableForeignKeys).split('\n'));
         queries.push(...this.helper.getSchemaEnd(this.options.disableForeignKeys).split('\n'));
-        queries = queries.filter(sql => !Utils.isString(sql) || sql.trim().length > 0);
+        queries = queries.filter(sql => typeof sql !== 'string' || sql.trim().length > 0);
         return queries;
     }
 }

package/MigrationStorage.js

@@ -75,7 +75,7 @@ export class MigrationStorage {
             length,
         });
         const sql = this.helper.createTable(table);
-        await this.connection.execute(sql.join(';\n'));
+        await this.connection.execute(sql.join(';\n'), [], 'run', this.masterTransaction);
     }
     setMasterMigration(trx) {
         this.masterTransaction = trx;

package/Migrator.d.ts

@@ -1,5 +1,5 @@
 import { type MigrationParams, type RunnableMigration } from 'umzug';
-import { type Constructor, type IMigrator, type MikroORM, type MigratorEvent, type MaybePromise } from '@mikro-orm/core';
+import { type Constructor, type IMigrator, type MaybePromise, type MigratorEvent, type MikroORM } from '@mikro-orm/core';
 import { DatabaseSchema, type EntityManager } from '@mikro-orm/knex';
 import type { Migration } from './Migration.js';
 import { MigrationStorage } from './MigrationStorage.js';
@@ -17,16 +17,25 @@ export declare class Migrator implements IMigrator {
     private readonly absolutePath;
     private readonly snapshotPath;
     constructor(em: EntityManager);
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    private detectSourceFolder;
     static register(orm: MikroORM): void;
     /**
      * @inheritDoc
      */
-    createMigration(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
-    checkMigrationNeeded(): Promise<boolean>;
+    create(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
+    checkSchema(): Promise<boolean>;
     /**
      * @inheritDoc
      */
-    createInitialMigration(path?: string, name?: string, blank?: boolean): Promise<MigrationResult>;
+    createInitial(path?: string, name?: string, blank?: boolean): Promise<MigrationResult>;
     /**
      * @inheritDoc
      */
@@ -48,12 +57,12 @@ export declare class Migrator implements IMigrator {
     /**
      * @inheritDoc
      */
-    getExecutedMigrations(): Promise<MigrationRow[]>;
+    getExecuted(): Promise<MigrationRow[]>;
     private ensureDatabase;
     /**
      * @inheritDoc
      */
-    getPendingMigrations(): Promise<UmzugMigration[]>;
+    getPending(): Promise<UmzugMigration[]>;
     /**
      * @inheritDoc
      */

package/Migrator.js

@@ -1,8 +1,9 @@
-import { Umzug } from 'umzug';
+import { Umzug, } from 'umzug';
 import { basename, join } from 'node:path';
 import { existsSync, writeFileSync } from 'node:fs';
 import { t, Type, UnknownType, Utils, } from '@mikro-orm/core';
-import { DatabaseSchema, DatabaseTable, SqlSchemaGenerator, } from '@mikro-orm/knex';
+import { fs } from '@mikro-orm/core/fs-utils';
+import { DatabaseSchema, DatabaseTable, } from '@mikro-orm/knex';
 import { MigrationRunner } from './MigrationRunner.js';
 import { MigrationStorage } from './MigrationStorage.js';
 import { TSMigrationGenerator } from './TSMigrationGenerator.js';
@@ -22,9 +23,10 @@ export class Migrator {
     constructor(em) {
         this.em = em;
         this.driver = this.em.getDriver();
-        this.schemaGenerator = new SqlSchemaGenerator(this.em);
         this.config = this.em.config;
         this.options = this.config.get('migrations');
+        this.schemaGenerator = this.config.getExtension('@mikro-orm/schema-generator');
+        this.detectSourceFolder();
         /* v8 ignore next */
         const key = (this.config.get('preferTs', Utils.detectTypeScriptSupport()) && this.options.pathTs) ? 'pathTs' : 'path';
         this.absolutePath = Utils.absolutePath(this.options[key], this.config.get('baseDir'));
@@ -37,15 +39,42 @@ export class Migrator {
         this.snapshotPath = Utils.normalizePath(absoluteSnapshotPath, `${snapshotName}.json`);
         this.createUmzug();
     }
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    detectSourceFolder() {
+        const baseDir = this.config.get('baseDir');
+        const defaultPath = './migrations';
+        if (!fs.pathExists(baseDir + '/src')) {
+            this.options.path ??= defaultPath;
+            return;
+        }
+        const exists = fs.pathExists(`${baseDir}/${defaultPath}`);
+        const distDir = fs.pathExists(baseDir + '/dist');
+        const buildDir = fs.pathExists(baseDir + '/build');
+        // if neither `dist` nor `build` exist, we use the `src` folder as it might be a JS project without building, but with `src` folder
+        /* v8 ignore next */
+        const path = distDir ? './dist' : (buildDir ? './build' : './src');
+        // only if the user did not provide any values and if the default path does not exist
+        if (!this.options.path && !this.options.pathTs && !exists) {
+            this.options.path = `${path}/migrations`;
+            this.options.pathTs = './src/migrations';
+        }
+    }
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/migrator', () => new Migrator(orm.em));
     }
     /**
      * @inheritDoc
      */
-    async createMigration(path, blank = false, initial = false, name) {
+    async create(path, blank = false, initial = false, name) {
         if (initial) {
-            return this.createInitialMigration(path, name, blank);
+            return this.createInitial(path, name, blank);
         }
         this.ensureMigrationsDirExists();
         const diff = await this.getSchemaDiff(blank, initial);
@@ -60,7 +89,7 @@ export class Migrator {
             diff,
         };
     }
-    async checkMigrationNeeded() {
+    async checkSchema() {
         this.ensureMigrationsDirExists();
         const diff = await this.getSchemaDiff(false, false);
         return diff.up.length > 0;
@@ -68,7 +97,7 @@ export class Migrator {
     /**
      * @inheritDoc
      */
-    async createInitialMigration(path, name, blank = false) {
+    async createInitial(path, name, blank = false) {
         this.ensureMigrationsDirExists();
         const schemaExists = await this.validateInitialMigration(blank);
         const diff = await this.getSchemaDiff(blank, true);
@@ -117,6 +146,7 @@ export class Migrator {
             logger: undefined,
             migrations,
         });
+        /* v8 ignore else */
         if (!this.options.silent) {
             const logger = this.config.getLogger();
             this.umzug.on('migrating', event => logger.log('migrator', `Processing '${event.name}'`, { enabled: true }));
@@ -143,8 +173,8 @@ export class Migrator {
      * If only some of the tables are present, exception is thrown.
      */
     async validateInitialMigration(blank) {
-        const executed = await this.getExecutedMigrations();
-        const pending = await this.getPendingMigrations();
+        const executed = await this.getExecuted();
+        const pending = await this.getPending();
         if (executed.length > 0 || pending.length > 0) {
             throw new Error('Initial migration cannot be created, as some migrations already exist');
         }
@@ -175,14 +205,14 @@ export class Migrator {
     /**
      * @inheritDoc
      */
-    async getExecutedMigrations() {
+    async getExecuted() {
         await this.ensureDatabase();
         return this.storage.getExecutedMigrations();
     }
     async ensureDatabase() {
         this.ensureMigrationsDirExists();
         const created = await this.schemaGenerator.ensureDatabase();
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (created) {
             this.createUmzug();
         }
@@ -191,7 +221,7 @@ export class Migrator {
     /**
      * @inheritDoc
      */
-    async getPendingMigrations() {
+    async getPending() {
         await this.ensureDatabase();
         return this.umzug.pending();
     }
@@ -213,7 +243,7 @@ export class Migrator {
     resolve(params) {
         const createMigrationHandler = async (method) => {
             const migration = await Utils.dynamicImport(params.path);
-            const MigrationClass = Object.values(migration)[0];
+            const MigrationClass = Object.values(migration).find(cls => typeof cls === 'function' && typeof cls.constructor === 'function');
             const instance = new MigrationClass(this.driver, this.config);
             await this.runner.run(instance, method);
         };
@@ -227,7 +257,7 @@ export class Migrator {
         if (!this.options.snapshot || !existsSync(this.snapshotPath)) {
             return undefined;
         }
-        const data = Utils.readJSONSync(this.snapshotPath);
+        const data = fs.readJSONSync(this.snapshotPath);
         const schema = new DatabaseSchema(this.driver.getPlatform(), this.config.get('schema'));
         const { tables, namespaces, ...rest } = data;
         const tableInstances = tables.map((tbl) => {
@@ -298,7 +328,7 @@ export class Migrator {
         return name.match(/^\d{14}$/) ? this.options.fileName(name) : name;
     }
     prefix(options) {
-        if (Utils.isString(options) || Array.isArray(options)) {
+        if (typeof options === 'string' || Array.isArray(options)) {
             return { migrations: Utils.asArray(options).map(name => this.getMigrationFilename(name)) };
         }
         if (!options) {
@@ -333,7 +363,7 @@ export class Migrator {
     }
     ensureMigrationsDirExists() {
         if (!this.options.migrationsList) {
-            Utils.ensureDir(this.absolutePath);
+            fs.ensureDir(this.absolutePath);
         }
     }
 }

package/README.md

@@ -11,7 +11,6 @@ TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-or
 [![Chat on discord](https://img.shields.io/discord/1214904142443839538?label=discord&color=blue)](https://discord.gg/w8bjxFHS7X)
 [![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://www.npmjs.com/package/@mikro-orm/core)
 [![Coverage Status](https://img.shields.io/coveralls/mikro-orm/mikro-orm.svg)](https://coveralls.io/r/mikro-orm/mikro-orm?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/27999651d3adc47cfa40/maintainability)](https://codeclimate.com/github/mikro-orm/mikro-orm/maintainability)
 [![Build Status](https://github.com/mikro-orm/mikro-orm/workflows/tests/badge.svg?branch=master)](https://github.com/mikro-orm/mikro-orm/actions?workflow=tests)
 
 ## 🤔 Unit of What?
@@ -141,7 +140,7 @@ There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit m
 - [Composite and Foreign Keys as Primary Key](https://mikro-orm.io/docs/composite-keys)
 - [Filters](https://mikro-orm.io/docs/filters)
 - [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder)
-- [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate)
+- [Populating relations](https://mikro-orm.io/docs/populating-relations)
 - [Property Validation](https://mikro-orm.io/docs/property-validation)
 - [Lifecycle Hooks](https://mikro-orm.io/docs/events#hooks)
 - [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js)
@@ -382,6 +381,8 @@ See also the list of contributors who [participated](https://github.com/mikro-or
 
 Please ⭐️ this repository if this project helped you!
 
+> If you'd like to support my open-source work, consider sponsoring me directly at [github.com/sponsors/b4nan](https://github.com/sponsors/b4nan).
+
 ## 📝 License
 
 Copyright © 2018 [Martin Adámek](https://github.com/b4nan).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/migrations",
   "type": "module",
-  "version": "7.0.0-dev.9",
+  "version": "7.0.0-dev.91",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "exports": {
     "./package.json": "./package.json",
@@ -38,7 +38,7 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 22.11.0"
+    "node": ">= 22.17.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
@@ -50,13 +50,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/knex": "7.0.0-dev.9",
+    "@mikro-orm/knex": "7.0.0-dev.91",
     "umzug": "3.8.2"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.4.13"
+    "@mikro-orm/core": "^6.6.2"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.9"
+    "@mikro-orm/core": "7.0.0-dev.91"
   }
 }

package/typings.d.ts

@@ -1 +1 @@
-export { UmzugMigration, MigrateOptions, MigrationResult, MigrationRow } from '@mikro-orm/core';
+export type { UmzugMigration, MigrateOptions, MigrationResult, MigrationRow } from '@mikro-orm/core';