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

package/JSMigrationGenerator.js

@@ -12,7 +12,7 @@ export class JSMigrationGenerator extends MigrationGenerator {
         /* v8 ignore next */
         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.d.ts

@@ -12,9 +12,7 @@ export declare abstract class MigrationGenerator implements IMigrationGenerator
         up: string[];
         down: string[];
     }, path?: string, name?: string): Promise<[string, string]>;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     createStatement(query: string, padLeft: number): string;
     /**
      * @inheritDoc

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}`;
@@ -24,10 +25,8 @@ export class MigrationGenerator {
         await writeFile(path + '/' + fileName, ret, { flush: true });
         return [ret, fileName];
     }
-    /* v8 ignore start */
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
+    /* v8 ignore next */
     createStatement(query, padLeft) {
         if (query) {
             const padding = ' '.repeat(padLeft);

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 type { EntityManager } from '@mikro-orm/mongodb';
 import type { Migration } from './Migration.js';
 import { MigrationStorage } from './MigrationStorage.js';
@@ -17,17 +17,24 @@ export declare class Migrator implements IMigrator {
     constructor(em: EntityManager);
     static register(orm: MikroORM): void;
     /**
-     * @inheritDoc
+     * 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.
      */
-    createMigration(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
+    private detectSourceFolder;
     /**
      * @inheritDoc
      */
-    checkMigrationNeeded(): Promise<boolean>;
+    create(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
+    /** @inheritDoc */
+    checkSchema(): Promise<boolean>;
     /**
      * @inheritDoc
      */
-    createInitialMigration(path?: string): Promise<MigrationResult>;
+    createInitial(path?: string): Promise<MigrationResult>;
     /**
      * @inheritDoc
      */
@@ -40,11 +47,11 @@ export declare class Migrator implements IMigrator {
     /**
      * @inheritDoc
      */
-    getExecutedMigrations(): Promise<MigrationRow[]>;
+    getExecuted(): Promise<MigrationRow[]>;
     /**
      * @inheritDoc
      */
-    getPendingMigrations(): Promise<UmzugMigration[]>;
+    getPending(): Promise<UmzugMigration[]>;
     /**
      * @inheritDoc
      */

package/Migrator.js

@@ -1,6 +1,7 @@
-import { Umzug } from 'umzug';
+import { Umzug, } from 'umzug';
 import { join } from 'node:path';
 import { Utils, } from '@mikro-orm/core';
+import { fs } from '@mikro-orm/core/fs-utils';
 import { MigrationRunner } from './MigrationRunner.js';
 import { MigrationStorage } from './MigrationStorage.js';
 import { TSMigrationGenerator } from './TSMigrationGenerator.js';
@@ -20,6 +21,7 @@ export class Migrator {
         this.driver = this.em.getDriver();
         this.config = this.em.config;
         this.options = this.config.get('migrations');
+        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'));
@@ -28,10 +30,37 @@ export class Migrator {
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/migrator', () => new Migrator(orm.em));
     }
+    /**
+     * 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';
+        }
+    }
     /**
      * @inheritDoc
      */
-    async createMigration(path, blank = false, initial = false, name) {
+    async create(path, blank = false, initial = false, name) {
         this.ensureMigrationsDirExists();
         const diff = { up: [], down: [] };
         const migration = await this.generator.generate(diff, path, name);
@@ -41,19 +70,16 @@ export class Migrator {
             diff,
         };
     }
-    /* v8 ignore start */
-    /**
-     * @inheritDoc
-     */
-    async checkMigrationNeeded() {
+    /** @inheritDoc */
+    /* v8 ignore next */
+    async checkSchema() {
         return true;
     }
-    /* v8 ignore stop */
     /**
      * @inheritDoc
      */
-    async createInitialMigration(path) {
-        return this.createMigration(path);
+    async createInitial(path) {
+        return this.create(path);
     }
     /**
      * @inheritDoc
@@ -76,7 +102,7 @@ export class Migrator {
             glob: join(this.absolutePath, this.options.glob).replace(/\\/g, '/'),
             resolve: (params) => this.resolve(params),
         };
-        /* v8 ignore next 8 */
+        /* v8 ignore next */
         if (this.options.migrationsList) {
             migrations = this.options.migrationsList.map(migration => {
                 if (typeof migration === 'function') {
@@ -97,7 +123,7 @@ export class Migrator {
             this.umzug.on('reverting', event => logger.log('migrator', `Processing '${event.name}'`, { enabled: true }));
             this.umzug.on('reverted', event => logger.log('migrator', `Reverted '${event.name}'`, { enabled: true }));
         }
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (this.options.generator) {
             this.generator = new this.options.generator(this.driver, this.config.getNamingStrategy(), this.options);
         }
@@ -111,14 +137,14 @@ export class Migrator {
     /**
      * @inheritDoc
      */
-    async getExecutedMigrations() {
+    async getExecuted() {
         this.ensureMigrationsDirExists();
         return this.storage.getExecutedMigrations();
     }
     /**
      * @inheritDoc
      */
-    async getPendingMigrations() {
+    async getPending() {
         this.ensureMigrationsDirExists();
         return this.umzug.pending();
     }
@@ -140,7 +166,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);
         };
@@ -164,7 +190,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) {
@@ -199,7 +225,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/TSMigrationGenerator.js

@@ -10,7 +10,7 @@ export class TSMigrationGenerator extends MigrationGenerator {
         /* v8 ignore next */
         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(): Promise<void> {\n`;
             diff.down.forEach(sql => ret += this.createStatement(sql, 4));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/migrations-mongodb",
   "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,14 +50,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/mongodb": "7.0.0-dev.9",
-    "mongodb": "6.15.0",
+    "@mikro-orm/mongodb": "7.0.0-dev.91",
+    "mongodb": "6.20.0",
     "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"
   }
 }