@mikro-orm/mongodb 7.0.5 → 7.0.6-dev.1

package/MongoEntityManager.d.ts

@@ -1,12 +1,4 @@
-import {
-  EntityManager,
-  type EntityName,
-  type EntityRepository,
-  type GetRepository,
-  type TransactionOptions,
-  type StreamOptions,
-  type Loaded,
-} from '@mikro-orm/core';
+import { EntityManager, type EntityName, type EntityRepository, type GetRepository, type TransactionOptions, type StreamOptions, type Loaded } from '@mikro-orm/core';
 import type { Collection, Document, TransactionOptions as MongoTransactionOptions } from 'mongodb';
 import type { MongoDriver } from './MongoDriver.js';
 import type { MongoEntityRepository } from './MongoEntityRepository.js';
@@ -14,39 +6,29 @@ import type { MongoEntityRepository } from './MongoEntityRepository.js';
  * @inheritDoc
  */
 export declare class MongoEntityManager<Driver extends MongoDriver = MongoDriver> extends EntityManager<Driver> {
-  /**
-   * Shortcut to driver's aggregate method. Available in MongoDriver only.
-   */
-  aggregate(entityName: EntityName, pipeline: any[]): Promise<any[]>;
-  /**
-   * Shortcut to driver's aggregate method. Returns a stream. Available in MongoDriver only.
-   */
-  streamAggregate<T extends object>(entityName: EntityName, pipeline: any[]): AsyncIterableIterator<T>;
-  /**
-   * @inheritDoc
-   */
-  stream<
-    Entity extends object,
-    Hint extends string = never,
-    Fields extends string = never,
-    Excludes extends string = never,
-  >(
-    entityName: EntityName<Entity>,
-    options?: StreamOptions<NoInfer<Entity>, Hint, Fields, Excludes>,
-  ): AsyncIterableIterator<Loaded<Entity, Hint, Fields, Excludes>>;
-  getCollection<T extends Document>(entityOrCollectionName: EntityName<T> | string): Collection<T>;
-  /**
-   * @inheritDoc
-   */
-  getRepository<T extends object, U extends EntityRepository<T> = MongoEntityRepository<T>>(
-    entityName: EntityName<T>,
-  ): GetRepository<T, U>;
-  /**
-   * @inheritDoc
-   */
-  begin(options?: Omit<TransactionOptions, 'ignoreNestedTransactions'> & MongoTransactionOptions): Promise<void>;
-  /**
-   * @inheritDoc
-   */
-  transactional<T>(cb: (em: this) => Promise<T>, options?: TransactionOptions & MongoTransactionOptions): Promise<T>;
+    /**
+     * Shortcut to driver's aggregate method. Available in MongoDriver only.
+     */
+    aggregate(entityName: EntityName, pipeline: any[]): Promise<any[]>;
+    /**
+     * Shortcut to driver's aggregate method. Returns a stream. Available in MongoDriver only.
+     */
+    streamAggregate<T extends object>(entityName: EntityName, pipeline: any[]): AsyncIterableIterator<T>;
+    /**
+     * @inheritDoc
+     */
+    stream<Entity extends object, Hint extends string = never, Fields extends string = never, Excludes extends string = never>(entityName: EntityName<Entity>, options?: StreamOptions<NoInfer<Entity>, Hint, Fields, Excludes>): AsyncIterableIterator<Loaded<Entity, Hint, Fields, Excludes>>;
+    getCollection<T extends Document>(entityOrCollectionName: EntityName<T> | string): Collection<T>;
+    /**
+     * @inheritDoc
+     */
+    getRepository<T extends object, U extends EntityRepository<T> = MongoEntityRepository<T>>(entityName: EntityName<T>): GetRepository<T, U>;
+    /**
+     * @inheritDoc
+     */
+    begin(options?: Omit<TransactionOptions, 'ignoreNestedTransactions'> & MongoTransactionOptions): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    transactional<T>(cb: (em: this) => Promise<T>, options?: TransactionOptions & MongoTransactionOptions): Promise<T>;
 }

package/MongoEntityManager.js

@@ -1,48 +1,48 @@
-import { EntityManager, Utils } from '@mikro-orm/core';
+import { EntityManager, Utils, } from '@mikro-orm/core';
 /**
  * @inheritDoc
  */
 export class MongoEntityManager extends EntityManager {
-  /**
-   * Shortcut to driver's aggregate method. Available in MongoDriver only.
-   */
-  async aggregate(entityName, pipeline) {
-    return this.getDriver().aggregate(entityName, pipeline, this.getTransactionContext());
-  }
-  /**
-   * Shortcut to driver's aggregate method. Returns a stream. Available in MongoDriver only.
-   */
-  async *streamAggregate(entityName, pipeline) {
-    yield* this.getDriver().streamAggregate(entityName, pipeline, this.getTransactionContext());
-  }
-  /**
-   * @inheritDoc
-   */
-  async *stream(entityName, options = {}) {
-    if (!Utils.isEmpty(options.populate)) {
-      throw new Error('Populate option is not supported when streaming results in MongoDB');
+    /**
+     * Shortcut to driver's aggregate method. Available in MongoDriver only.
+     */
+    async aggregate(entityName, pipeline) {
+        return this.getDriver().aggregate(entityName, pipeline, this.getTransactionContext());
+    }
+    /**
+     * Shortcut to driver's aggregate method. Returns a stream. Available in MongoDriver only.
+     */
+    async *streamAggregate(entityName, pipeline) {
+        yield* this.getDriver().streamAggregate(entityName, pipeline, this.getTransactionContext());
+    }
+    /**
+     * @inheritDoc
+     */
+    async *stream(entityName, options = {}) {
+        if (!Utils.isEmpty(options.populate)) {
+            throw new Error('Populate option is not supported when streaming results in MongoDB');
+        }
+        yield* super.stream(entityName, options);
+    }
+    getCollection(entityOrCollectionName) {
+        return this.getConnection().getCollection(entityOrCollectionName);
+    }
+    /**
+     * @inheritDoc
+     */
+    getRepository(entityName) {
+        return super.getRepository(entityName);
+    }
+    /**
+     * @inheritDoc
+     */
+    async begin(options = {}) {
+        return super.begin(options);
+    }
+    /**
+     * @inheritDoc
+     */
+    async transactional(cb, options = {}) {
+        return super.transactional(cb, options);
     }
-    yield* super.stream(entityName, options);
-  }
-  getCollection(entityOrCollectionName) {
-    return this.getConnection().getCollection(entityOrCollectionName);
-  }
-  /**
-   * @inheritDoc
-   */
-  getRepository(entityName) {
-    return super.getRepository(entityName);
-  }
-  /**
-   * @inheritDoc
-   */
-  async begin(options = {}) {
-    return super.begin(options);
-  }
-  /**
-   * @inheritDoc
-   */
-  async transactional(cb, options = {}) {
-    return super.transactional(cb, options);
-  }
 }

package/MongoEntityRepository.d.ts

@@ -3,15 +3,15 @@ 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>);
-  /**
-   * Shortcut to driver's aggregate method. Available in MongoDriver only.
-   */
-  aggregate(pipeline: any[]): Promise<any[]>;
-  getCollection(): Collection<T>;
-  /**
-   * @inheritDoc
-   */
-  getEntityManager(): MongoEntityManager;
+    protected readonly em: MongoEntityManager;
+    constructor(em: MongoEntityManager, entityName: EntityName<T>);
+    /**
+     * Shortcut to driver's aggregate method. Available in MongoDriver only.
+     */
+    aggregate(pipeline: any[]): Promise<any[]>;
+    getCollection(): Collection<T>;
+    /**
+     * @inheritDoc
+     */
+    getEntityManager(): MongoEntityManager;
 }

package/MongoEntityRepository.js

@@ -1,24 +1,24 @@
 import { EntityRepository } from '@mikro-orm/core';
 /** Entity repository with MongoDB-specific methods such as `aggregate()`. */
 export class MongoEntityRepository extends EntityRepository {
-  em;
-  constructor(em, entityName) {
-    super(em, entityName);
-    this.em = em;
-  }
-  /**
-   * Shortcut to driver's aggregate method. Available in MongoDriver only.
-   */
-  async aggregate(pipeline) {
-    return this.getEntityManager().aggregate(this.entityName, pipeline);
-  }
-  getCollection() {
-    return this.getEntityManager().getCollection(this.entityName);
-  }
-  /**
-   * @inheritDoc
-   */
-  getEntityManager() {
-    return this.em;
-  }
+    em;
+    constructor(em, entityName) {
+        super(em, entityName);
+        this.em = em;
+    }
+    /**
+     * Shortcut to driver's aggregate method. Available in MongoDriver only.
+     */
+    async aggregate(pipeline) {
+        return this.getEntityManager().aggregate(this.entityName, pipeline);
+    }
+    getCollection() {
+        return this.getEntityManager().getCollection(this.entityName);
+    }
+    /**
+     * @inheritDoc
+     */
+    getEntityManager() {
+        return this.em;
+    }
 }

package/MongoExceptionConverter.d.ts

@@ -1,8 +1,8 @@
 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
-   */
-  convertException(exception: Error & Dictionary): DriverException;
+    /**
+     * @see https://gist.github.com/rluvaton/a97a8da46ab6541a3e5702e83b9d357b
+     */
+    convertException(exception: Error & Dictionary): DriverException;
 }

package/MongoExceptionConverter.js

@@ -1,17 +1,17 @@
-import { UniqueConstraintViolationException, ExceptionConverter, TableExistsException } from '@mikro-orm/core';
+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
-   */
-  /* v8 ignore next */
-  convertException(exception) {
-    switch (exception.code) {
-      case 48:
-        return new TableExistsException(exception);
-      case 11000:
-        return new UniqueConstraintViolationException(exception);
+    /**
+     * @see https://gist.github.com/rluvaton/a97a8da46ab6541a3e5702e83b9d357b
+     */
+    /* v8 ignore next */
+    convertException(exception) {
+        switch (exception.code) {
+            case 48:
+                return new TableExistsException(exception);
+            case 11000:
+                return new UniqueConstraintViolationException(exception);
+        }
+        return super.convertException(exception);
     }
-    return super.convertException(exception);
-  }
 }

package/MongoMikroORM.d.ts

@@ -1,63 +1,24 @@
-import {
-  type AnyEntity,
-  type EntityClass,
-  type EntitySchema,
-  MikroORM,
-  type Options,
-  type IDatabaseDriver,
-  type EntityManager,
-  type EntityManagerType,
-  type IMigrator,
-} from '@mikro-orm/core';
+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>>;
+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>;
+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
  */
-export declare class MongoMikroORM<
-  EM extends MongoEntityManager = MongoEntityManager,
-  Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (
-    | string
-    | EntityClass<AnyEntity>
-    | EntitySchema
-  )[],
-> extends MikroORM<MongoDriver, EM, Entities> {
-  /**
-   * @inheritDoc
-   */
-  static init<
-    D extends IDatabaseDriver = MongoDriver,
-    EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>,
-    Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (
-      | string
-      | EntityClass<AnyEntity>
-      | EntitySchema
-    )[],
-  >(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
-  /**
-   * @inheritDoc
-   */
-  constructor(options: Partial<Options<MongoDriver, EM, Entities>>);
-  /**
-   * Gets the Migrator.
-   */
-  get migrator(): IMigrator;
+export declare class MongoMikroORM<EM extends MongoEntityManager = MongoEntityManager, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends MikroORM<MongoDriver, EM, Entities> {
+    /**
+     * @inheritDoc
+     */
+    static init<D extends IDatabaseDriver = MongoDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
+    /**
+     * @inheritDoc
+     */
+    constructor(options: Partial<Options<MongoDriver, EM, Entities>>);
+    /**
+     * Gets the Migrator.
+     */
+    get migrator(): IMigrator;
 }

package/MongoMikroORM.js

@@ -1,31 +1,31 @@
-import { defineConfig, MikroORM } from '@mikro-orm/core';
+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 });
+    return defineConfig({ driver: MongoDriver, ...options });
 }
 /**
  * @inheritDoc
  */
 export class MongoMikroORM extends MikroORM {
-  /**
-   * @inheritDoc
-   */
-  static async init(options) {
-    return super.init(defineMongoConfig(options));
-  }
-  /**
-   * @inheritDoc
-   */
-  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);
-  }
+    /**
+     * @inheritDoc
+     */
+    static async init(options) {
+        return super.init(defineMongoConfig(options));
+    }
+    /**
+     * @inheritDoc
+     */
+    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);
+    }
 }

package/MongoPlatform.d.ts

@@ -1,45 +1,30 @@
 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 { 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;
-  getNamingStrategy(): {
-    new (): NamingStrategy;
-  };
-  getRepositoryClass<T extends object>(): Constructor<EntityRepository<T>>;
-  /** @inheritDoc */
-  lookupExtensions(orm: MikroORM): void;
-  /** @inheritDoc */
-  getExtension<T>(extensionName: string, extensionKey: string, moduleName: string, em: EntityManager): T;
-  getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): MongoSchemaGenerator;
-  normalizePrimaryKey<T extends number | string = number | string>(data: Primary<T> | IPrimaryKey | ObjectId): T;
-  denormalizePrimaryKey(data: number | string): IPrimaryKey;
-  usesImplicitTransactions(): boolean;
-  convertsJsonAutomatically(): boolean;
-  convertJsonToDatabaseValue(value: unknown): 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;
-  validateMetadata(meta: EntityMetadata): void;
-  isAllowedTopLevelOperator(operator: string): boolean;
-  getDefaultClientUrl(): string;
+    protected readonly exceptionConverter: MongoExceptionConverter;
+    setConfig(config: Configuration): void;
+    getNamingStrategy(): {
+        new (): NamingStrategy;
+    };
+    getRepositoryClass<T extends object>(): Constructor<EntityRepository<T>>;
+    /** @inheritDoc */
+    lookupExtensions(orm: MikroORM): void;
+    /** @inheritDoc */
+    getExtension<T>(extensionName: string, extensionKey: string, moduleName: string, em: EntityManager): T;
+    getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): MongoSchemaGenerator;
+    normalizePrimaryKey<T extends number | string = number | string>(data: Primary<T> | IPrimaryKey | ObjectId): T;
+    denormalizePrimaryKey(data: number | string): IPrimaryKey;
+    usesImplicitTransactions(): boolean;
+    convertsJsonAutomatically(): boolean;
+    convertJsonToDatabaseValue(value: unknown): 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;
+    validateMetadata(meta: EntityMetadata): void;
+    isAllowedTopLevelOperator(operator: string): boolean;
+    getDefaultClientUrl(): string;
 }