@mikro-orm/mongodb 7.0.0-dev.11 → 7.0.0-dev.111

package/MongoMikroORM.js

@@ -1,24 +1,28 @@
 import { defineConfig, MikroORM, } from '@mikro-orm/core';
 import { MongoDriver } from './MongoDriver.js';
+export function defineMongoConfig(options) {
+    return defineConfig({ driver: MongoDriver, ...options });
+}
 /**
  * @inheritDoc
  */
 export class MongoMikroORM extends MikroORM {
-    static DRIVER = MongoDriver;
     /**
      * @inheritDoc
      */
     static async init(options) {
-        return super.init(options);
+        return super.init(defineMongoConfig(options));
     }
     /**
      * @inheritDoc
      */
-    static initSync(options) {
-        return super.initSync(options);
+    constructor(options) {
+        super(defineMongoConfig(options));
+    }
+    /**
+     * Gets the Migrator.
+     */
+    get migrator() {
+        return this.driver.getPlatform().getExtension('Migrator', '@mikro-orm/migrator', '@mikro-orm/migrations-mongodb', this.em);
     }
-}
-/* v8 ignore next 3 */
-export function defineMongoConfig(options) {
-    return defineConfig({ driver: MongoDriver, ...options });
 }

package/MongoPlatform.d.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from 'mongodb';
-import { Platform, type IPrimaryKey, type Primary, type NamingStrategy, type Constructor, type EntityRepository, type EntityProperty, type PopulateOptions, type EntityMetadata, type IDatabaseDriver, type EntityManager, type Configuration, type MikroORM } from '@mikro-orm/core';
+import { Platform, type IPrimaryKey, type Primary, type NamingStrategy, type Constructor, type EntityRepository, type EntityProperty, type PopulateOptions, type EntityMetadata, type IDatabaseDriver, type EntityManager, type Configuration, type MikroORM, type TransformContext } from '@mikro-orm/core';
 import { MongoExceptionConverter } from './MongoExceptionConverter.js';
 import { MongoSchemaGenerator } from './MongoSchemaGenerator.js';
 export declare class MongoPlatform extends Platform {
@@ -16,12 +16,10 @@ export declare class MongoPlatform extends Platform {
     getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): MongoSchemaGenerator;
     normalizePrimaryKey<T extends number | string = number | string>(data: Primary<T> | IPrimaryKey | ObjectId): T;
     denormalizePrimaryKey(data: number | string): IPrimaryKey;
-    getSerializedPrimaryKeyField(field: string): string;
-    usesDifferentSerializedPrimaryKey(): boolean;
     usesImplicitTransactions(): boolean;
     convertsJsonAutomatically(): boolean;
     convertJsonToDatabaseValue(value: unknown): unknown;
-    convertJsonToJSValue(value: unknown, prop: EntityProperty): unknown;
+    convertJsonToJSValue(value: unknown, context?: TransformContext): unknown;
     marshallArray(values: string[]): string;
     cloneEmbeddable<T>(data: T): T;
     shouldHaveColumn<T>(prop: EntityProperty<T>, populate: PopulateOptions<T>[], exclude?: string[]): boolean;

package/MongoPlatform.js

@@ -32,24 +32,18 @@ export class MongoPlatform extends Platform {
         /* v8 ignore next */
         return super.getExtension(extensionName, extensionKey, moduleName, em);
     }
-    /* v8 ignore next 3: kept for type inference only */
+    /* v8 ignore next: kept for type inference only */
     getSchemaGenerator(driver, em) {
         return new MongoSchemaGenerator(em ?? driver);
     }
     normalizePrimaryKey(data) {
-        if (Utils.isObjectID(data)) {
+        if (Utils.isObject(data) && data.constructor?.name === 'ObjectId') {
             return data.toHexString();
         }
         return data;
     }
     denormalizePrimaryKey(data) {
-        return new ObjectId(data);
-    }
-    getSerializedPrimaryKeyField(field) {
-        return 'id';
-    }
-    usesDifferentSerializedPrimaryKey() {
-        return true;
+        return new ObjectId('' + data);
     }
     usesImplicitTransactions() {
         return false;
@@ -60,7 +54,7 @@ export class MongoPlatform extends Platform {
     convertJsonToDatabaseValue(value) {
         return Utils.copy(value);
     }
-    convertJsonToJSValue(value, prop) {
+    convertJsonToJSValue(value, context) {
         return value;
     }
     marshallArray(values) {

package/MongoSchemaGenerator.d.ts

@@ -2,13 +2,13 @@ import { AbstractSchemaGenerator, type CreateSchemaOptions, type MikroORM } from
 import type { MongoDriver } from './MongoDriver.js';
 export declare class MongoSchemaGenerator extends AbstractSchemaGenerator<MongoDriver> {
     static register(orm: MikroORM): void;
-    createSchema(options?: MongoCreateSchemaOptions): Promise<void>;
-    dropSchema(options?: {
+    create(options?: MongoCreateSchemaOptions): Promise<void>;
+    drop(options?: {
         dropMigrationsTable?: boolean;
     }): Promise<void>;
-    updateSchema(options?: MongoCreateSchemaOptions): Promise<void>;
+    update(options?: MongoCreateSchemaOptions): Promise<void>;
     ensureDatabase(): Promise<boolean>;
-    refreshDatabase(options?: MongoCreateSchemaOptions): Promise<void>;
+    refresh(options?: MongoCreateSchemaOptions): Promise<void>;
     dropIndexes(options?: {
         skipIndexes?: {
             collection: string;
@@ -17,7 +17,9 @@ export declare class MongoSchemaGenerator extends AbstractSchemaGenerator<MongoD
         collectionsWithFailedIndexes?: string[];
     }): Promise<void>;
     ensureIndexes(options?: EnsureIndexesOptions): Promise<void>;
+    private mapIndexProperties;
     private createIndexes;
+    private executeQuery;
     private createUniqueIndexes;
     private createPropertyIndexes;
 }

package/MongoSchemaGenerator.js

@@ -1,14 +1,14 @@
-import { AbstractSchemaGenerator, Utils, } from '@mikro-orm/core';
+import { AbstractSchemaGenerator, Utils, inspect, } from '@mikro-orm/core';
 export class MongoSchemaGenerator extends AbstractSchemaGenerator {
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/schema-generator', () => new MongoSchemaGenerator(orm.em));
     }
-    async createSchema(options = {}) {
+    async create(options = {}) {
         await this.connection.ensureConnection();
         options.ensureIndexes ??= true;
         const existing = await this.connection.listCollections();
         const metadata = this.getOrderedMetadata();
-        /* v8 ignore start */
+        /* v8 ignore next */
         const promises = metadata
             .filter(meta => !existing.includes(meta.collection))
             .map(meta => this.connection.createCollection(meta.collection).catch(err => {
@@ -18,13 +18,12 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
                 throw err;
             }
         }));
-        /* v8 ignore stop */
         if (options.ensureIndexes) {
             await this.ensureIndexes({ ensureCollections: false });
         }
         await Promise.all(promises);
     }
-    async dropSchema(options = {}) {
+    async drop(options = {}) {
         await this.connection.ensureConnection();
         const existing = await this.connection.listCollections();
         const metadata = this.getOrderedMetadata();
@@ -36,16 +35,16 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
             .map(meta => this.connection.dropCollection(meta.collection));
         await Promise.all(promises);
     }
-    async updateSchema(options = {}) {
-        await this.createSchema(options);
+    async update(options = {}) {
+        await this.create(options);
     }
     async ensureDatabase() {
         return false;
     }
-    async refreshDatabase(options = {}) {
+    async refresh(options = {}) {
         await this.ensureDatabase();
-        await this.dropSchema();
-        await this.createSchema(options);
+        await this.drop();
+        await this.create(options);
     }
     async dropIndexes(options) {
         await this.connection.ensureConnection();
@@ -59,9 +58,9 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
             const indexes = await db.collection(collection.name).listIndexes().toArray();
             for (const index of indexes) {
                 const isIdIndex = index.key._id === 1 && Utils.getObjectKeysSize(index.key) === 1;
-                /* v8 ignore next 3 */
+                /* v8 ignore next */
                 if (!isIdIndex && !options?.skipIndexes?.find(idx => idx.collection === collection.name && idx.indexName === index.name)) {
-                    promises.push(db.collection(collection.name).dropIndex(index.name));
+                    promises.push(this.executeQuery(db.collection(collection.name), 'dropIndex', index.name));
                 }
             }
         }
@@ -72,7 +71,7 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
         options.ensureCollections ??= true;
         options.retryLimit ??= 3;
         if (options.ensureCollections) {
-            await this.createSchema({ ensureIndexes: false });
+            await this.create({ ensureIndexes: false });
         }
         const promises = [];
         for (const meta of this.getOrderedMetadata()) {
@@ -113,11 +112,21 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
             });
         }
     }
+    mapIndexProperties(index, meta) {
+        return Utils.flatten(Utils.asArray(index.properties).map(propName => {
+            const rootPropName = propName.split('.')[0];
+            const prop = meta.properties[rootPropName];
+            if (propName.includes('.')) {
+                return [prop.fieldNames[0] + propName.substring(propName.indexOf('.'))];
+            }
+            return prop?.fieldNames ?? propName;
+        }));
+    }
     createIndexes(meta) {
         const res = [];
         meta.indexes.forEach(index => {
             let fieldOrSpec;
-            const properties = Utils.flatten(Utils.asArray(index.properties).map(prop => meta.properties[prop].fieldNames));
+            const properties = this.mapIndexProperties(index, meta);
             const collection = this.connection.getCollection(meta.className);
             if (Array.isArray(index.options) && index.options.length === 2 && properties.length === 0) {
                 res.push([collection.collectionName, collection.createIndex(index.options[0], index.options[1])]);
@@ -138,7 +147,7 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
             else {
                 fieldOrSpec = properties.reduce((o, i) => { o[i] = 1; return o; }, {});
             }
-            res.push([collection.collectionName, collection.createIndex(fieldOrSpec, {
+            res.push([collection.collectionName, this.executeQuery(collection, 'createIndex', fieldOrSpec, {
                     name: index.name,
                     unique: false,
                     ...index.options,
@@ -146,13 +155,26 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
         });
         return res;
     }
+    async executeQuery(collection, method, ...args) {
+        const now = Date.now();
+        return collection[method](...args).then((res) => {
+            Utils.dropUndefinedProperties(args);
+            const query = `db.getCollection('${collection.collectionName}').${method}(${args.map(arg => inspect(arg)).join(', ')});`;
+            this.config.getLogger().logQuery({
+                level: 'info',
+                query,
+                took: Date.now() - now,
+            });
+            return res;
+        });
+    }
     createUniqueIndexes(meta) {
         const res = [];
         meta.uniques.forEach(index => {
-            const properties = Utils.flatten(Utils.asArray(index.properties).map(prop => meta.properties[prop].fieldNames));
+            const properties = this.mapIndexProperties(index, meta);
             const fieldOrSpec = properties.reduce((o, i) => { o[i] = 1; return o; }, {});
             const collection = this.connection.getCollection(meta.className);
-            res.push([collection.collectionName, collection.createIndex(fieldOrSpec, {
+            res.push([collection.collectionName, this.executeQuery(collection, 'createIndex', fieldOrSpec, {
                     name: index.name,
                     unique: true,
                     ...index.options,
@@ -168,8 +190,8 @@ export class MongoSchemaGenerator extends AbstractSchemaGenerator {
         const fieldOrSpec = prop.embeddedPath
             ? prop.embeddedPath.join('.')
             : prop.fieldNames.reduce((o, i) => { o[i] = 1; return o; }, {});
-        return [[collection.collectionName, collection.createIndex(fieldOrSpec, {
-                    name: (Utils.isString(prop[type]) ? prop[type] : undefined),
+        return [[collection.collectionName, this.executeQuery(collection, 'createIndex', fieldOrSpec, {
+                    name: typeof prop[type] === 'string' ? prop[type] : undefined,
                     unique: type === 'unique',
                     sparse: prop.nullable === true,
                 })]];

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/index.d.ts

@@ -8,4 +8,4 @@ export * from './MongoEntityRepository.js';
 export * from './MongoSchemaGenerator.js';
 export { MongoEntityManager as EntityManager } from './MongoEntityManager.js';
 export { MongoEntityRepository as EntityRepository } from './MongoEntityRepository.js';
-export { MongoMikroORM as MikroORM, MongoOptions as Options, defineMongoConfig as defineConfig, } from './MongoMikroORM.js';
+export { MongoMikroORM as MikroORM, type MongoOptions as Options, defineMongoConfig as defineConfig, } from './MongoMikroORM.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/mongodb",
   "type": "module",
-  "version": "7.0.0-dev.11",
+  "version": "7.0.0-dev.111",
   "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,10 +38,10 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 22.11.0"
+    "node": ">= 22.17.0"
   },
   "scripts": {
-    "build": "yarn clean && yarn compile && yarn copy",
+    "build": "yarn compile && yarn copy",
     "clean": "yarn run -T rimraf ./dist",
     "compile": "yarn run -T tsc -p tsconfig.build.json",
     "copy": "node ../../scripts/copy.mjs"
@@ -50,12 +50,12 @@
     "access": "public"
   },
   "dependencies": {
-    "mongodb": "6.15.0"
+    "mongodb": "7.0.0"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.4.13"
+    "@mikro-orm/core": "^6.6.2"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.11"
+    "@mikro-orm/core": "7.0.0-dev.111"
   }
 }