@mikro-orm/mongodb 7.0.2-dev.12 → 7.0.2-dev.14

package/MongoConnection.d.ts

@@ -1,5 +1,6 @@
 import { type ClientSession, type Collection, type Db, MongoClient, type MongoClientOptions, type TransactionOptions } from 'mongodb';
 import { type AnyEntity, type CollationOptions, type Configuration, Connection, type ConnectionOptions, type ConnectionType, type Dictionary, type EntityData, type EntityName, type FilterQuery, type IsolationLevel, type LoggingOptions, type QueryOrderMap, type QueryResult, type Transaction, type TransactionEventBroadcaster, type UpsertManyOptions, type UpsertOptions } from '@mikro-orm/core';
+/** MongoDB database connection using the official `mongodb` driver. */
 export declare class MongoConnection extends Connection {
     #private;
     constructor(config: Configuration, options?: ConnectionOptions, type?: ConnectionType);
@@ -54,12 +55,14 @@ export declare class MongoConnection extends Connection {
     private getCollectionName;
     private logObject;
 }
+/** Options shared across MongoDB query operations. */
 export interface MongoQueryOptions {
     collation?: CollationOptions;
     indexHint?: string | Dictionary;
     maxTimeMS?: number;
     allowDiskUse?: boolean;
 }
+/** Options for MongoDB find operations. */
 export interface MongoFindOptions<T extends object> extends MongoQueryOptions {
     orderBy?: QueryOrderMap<T> | QueryOrderMap<T>[];
     limit?: number;
@@ -68,6 +71,7 @@ export interface MongoFindOptions<T extends object> extends MongoQueryOptions {
     ctx?: Transaction<ClientSession>;
     loggerContext?: LoggingOptions;
 }
+/** Options for MongoDB count operations. */
 export interface MongoCountOptions extends Omit<MongoQueryOptions, 'allowDiskUse'> {
     ctx?: Transaction<ClientSession>;
     loggerContext?: LoggingOptions;

package/MongoConnection.js

@@ -1,5 +1,6 @@
 import { MongoClient, ObjectId, } from 'mongodb';
 import { Connection, EventType, inspect, QueryOrder, Utils, ValidationError, } from '@mikro-orm/core';
+/** MongoDB database connection using the official `mongodb` driver. */
 export class MongoConnection extends Connection {
     #client;
     #db;

package/MongoDriver.d.ts

@@ -4,6 +4,7 @@ import { MongoConnection } from './MongoConnection.js';
 import { MongoPlatform } from './MongoPlatform.js';
 import { MongoEntityManager } from './MongoEntityManager.js';
 import { MongoMikroORM } from './MongoMikroORM.js';
+/** Database driver for MongoDB. */
 export declare class MongoDriver extends DatabaseDriver<MongoConnection> {
     [EntityManagerType]: MongoEntityManager<this>;
     protected readonly connection: MongoConnection;

package/MongoDriver.js

@@ -4,6 +4,7 @@ import { MongoConnection } from './MongoConnection.js';
 import { MongoPlatform } from './MongoPlatform.js';
 import { MongoEntityManager } from './MongoEntityManager.js';
 import { MongoMikroORM } from './MongoMikroORM.js';
+/** Database driver for MongoDB. */
 export class MongoDriver extends DatabaseDriver {
     [EntityManagerType];
     connection = new MongoConnection(this.config);

package/MongoEntityRepository.d.ts

@@ -1,6 +1,7 @@
 import { EntityRepository, type EntityName } from '@mikro-orm/core';
 import type { Collection } from 'mongodb';
 import type { MongoEntityManager } from './MongoEntityManager.js';
+/** Entity repository with MongoDB-specific methods such as `aggregate()`. */
 export declare class MongoEntityRepository<T extends object> extends EntityRepository<T> {
     protected readonly em: MongoEntityManager;
     constructor(em: MongoEntityManager, entityName: EntityName<T>);

package/MongoEntityRepository.js

@@ -1,4 +1,5 @@
 import { EntityRepository } from '@mikro-orm/core';
+/** Entity repository with MongoDB-specific methods such as `aggregate()`. */
 export class MongoEntityRepository extends EntityRepository {
     em;
     constructor(em, entityName) {

package/MongoExceptionConverter.d.ts

@@ -1,4 +1,5 @@
 import { ExceptionConverter, type Dictionary, type DriverException } from '@mikro-orm/core';
+/** Converts MongoDB native errors into typed MikroORM driver exceptions. */
 export declare class MongoExceptionConverter extends ExceptionConverter {
     /**
      * @see https://gist.github.com/rluvaton/a97a8da46ab6541a3e5702e83b9d357b

package/MongoExceptionConverter.js

@@ -1,4 +1,5 @@
 import { UniqueConstraintViolationException, ExceptionConverter, TableExistsException, } from '@mikro-orm/core';
+/** Converts MongoDB native errors into typed MikroORM driver exceptions. */
 export class MongoExceptionConverter extends ExceptionConverter {
     /**
      * @see https://gist.github.com/rluvaton/a97a8da46ab6541a3e5702e83b9d357b

package/MongoMikroORM.d.ts

@@ -1,7 +1,9 @@
 import { type AnyEntity, type EntityClass, type EntitySchema, MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType, type IMigrator } from '@mikro-orm/core';
 import { MongoDriver } from './MongoDriver.js';
 import type { MongoEntityManager } from './MongoEntityManager.js';
+/** Configuration options for the MongoDB driver. */
 export type MongoOptions<EM extends MongoEntityManager = MongoEntityManager, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<MongoDriver, EM, Entities>>;
+/** Creates a type-safe configuration object for the MongoDB driver. */
 export declare function defineMongoConfig<EM extends MongoEntityManager = MongoEntityManager, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: MongoOptions<EM, Entities>): MongoOptions<EM, Entities>;
 /**
  * @inheritDoc

package/MongoMikroORM.js

@@ -1,5 +1,6 @@
 import { defineConfig, MikroORM, } from '@mikro-orm/core';
 import { MongoDriver } from './MongoDriver.js';
+/** Creates a type-safe configuration object for the MongoDB driver. */
 export function defineMongoConfig(options) {
     return defineConfig({ driver: MongoDriver, ...options });
 }

package/MongoPlatform.d.ts

@@ -2,6 +2,7 @@ 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, type TransformContext } from '@mikro-orm/core';
 import { MongoExceptionConverter } from './MongoExceptionConverter.js';
 import { MongoSchemaGenerator } from './MongoSchemaGenerator.js';
+/** Platform implementation for MongoDB. */
 export declare class MongoPlatform extends Platform {
     protected readonly exceptionConverter: MongoExceptionConverter;
     setConfig(config: Configuration): void;

package/MongoPlatform.js

@@ -3,6 +3,7 @@ import { Platform, MongoNamingStrategy, Utils, ReferenceKind, MetadataError, } f
 import { MongoExceptionConverter } from './MongoExceptionConverter.js';
 import { MongoEntityRepository } from './MongoEntityRepository.js';
 import { MongoSchemaGenerator } from './MongoSchemaGenerator.js';
+/** Platform implementation for MongoDB. */
 export class MongoPlatform extends Platform {
     exceptionConverter = new MongoExceptionConverter();
     setConfig(config) {

package/MongoSchemaGenerator.d.ts

@@ -1,6 +1,7 @@
 import { type CreateSchemaOptions, type MikroORM } from '@mikro-orm/core';
 import { AbstractSchemaGenerator } from '@mikro-orm/core/schema';
 import type { MongoDriver } from './MongoDriver.js';
+/** Schema generator for MongoDB that manages collections and indexes. */
 export declare class MongoSchemaGenerator extends AbstractSchemaGenerator<MongoDriver> {
     static register(orm: MikroORM): void;
     create(options?: MongoCreateSchemaOptions): Promise<void>;
@@ -28,6 +29,7 @@ export interface MongoCreateSchemaOptions extends CreateSchemaOptions {
     /** create indexes? defaults to true */
     ensureIndexes?: boolean;
 }
+/** Options for the `ensureIndexes()` method of `MongoSchemaGenerator`. */
 export interface EnsureIndexesOptions {
     ensureCollections?: boolean;
     retry?: boolean | string[];

package/MongoSchemaGenerator.js

@@ -1,5 +1,6 @@
 import { Utils, inspect, } from '@mikro-orm/core';
 import { AbstractSchemaGenerator } from '@mikro-orm/core/schema';
+/** Schema generator for MongoDB that manages collections and indexes. */
 export class MongoSchemaGenerator extends AbstractSchemaGenerator {
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/schema-generator', () => new MongoSchemaGenerator(orm.em));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mongodb",
-  "version": "7.0.2-dev.12",
+  "version": "7.0.2-dev.14",
   "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.",
   "keywords": [
     "data-mapper",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^7.0.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.2-dev.12"
+    "@mikro-orm/core": "7.0.2-dev.14"
   },
   "engines": {
     "node": ">= 22.17.0"