@mikro-orm/mongodb 7.0.4-dev.9 → 7.0.4

package/MongoConnection.d.ts

@@ -1,78 +1,159 @@
-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';
+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);
-    connect(options?: {
-        skipOnConnect?: boolean;
-    }): Promise<void>;
-    createClient(): void;
-    close(force?: boolean): Promise<void>;
-    isConnected(): Promise<boolean>;
-    checkConnection(): Promise<{
+  #private;
+  constructor(config: Configuration, options?: ConnectionOptions, type?: ConnectionType);
+  connect(options?: { skipOnConnect?: boolean }): Promise<void>;
+  createClient(): void;
+  close(force?: boolean): Promise<void>;
+  isConnected(): Promise<boolean>;
+  checkConnection(): Promise<
+    | {
         ok: true;
-    } | {
+      }
+    | {
         ok: false;
         reason: string;
         error?: Error;
-    }>;
-    getClient(): MongoClient;
-    getCollection<T extends object>(name: EntityName<T> | string): Collection<T>;
-    createCollection<T extends object>(name: EntityName<T>): Promise<Collection<T>>;
-    listCollections(): Promise<string[]>;
-    dropCollection(name: EntityName<AnyEntity>): Promise<boolean>;
-    mapOptions(overrides: MongoClientOptions): MongoClientOptions;
-    getDb(): Db;
-    execute(query: string): Promise<any>;
-    find<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, opts?: MongoFindOptions<T>): Promise<EntityData<T>[]>;
-    stream<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, opts?: MongoFindOptions<T>): AsyncIterableIterator<T>;
-    private _find;
-    insertOne<T extends object>(entityName: EntityName<T>, data: Partial<T>, ctx?: Transaction<ClientSession>): Promise<QueryResult<T>>;
-    insertMany<T extends object>(entityName: EntityName<T>, data: Partial<T>[], ctx?: Transaction<ClientSession>): Promise<QueryResult<T>>;
-    updateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, data: Partial<T>, ctx?: Transaction<ClientSession>, upsert?: boolean, upsertOptions?: UpsertOptions<T>): Promise<QueryResult<T>>;
-    bulkUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: Partial<T>[], ctx?: Transaction<ClientSession>, upsert?: boolean, upsertOptions?: UpsertManyOptions<T>): Promise<QueryResult<T>>;
-    deleteMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, ctx?: Transaction<ClientSession>): Promise<QueryResult<T>>;
-    aggregate<T extends object = any>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, loggerContext?: LoggingOptions): Promise<T[]>;
-    streamAggregate<T extends object>(entityName: EntityName<T>, pipeline: any[], ctx?: Transaction<ClientSession>, loggerContext?: LoggingOptions, stream?: boolean): AsyncIterableIterator<T>;
-    countDocuments<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, opts?: MongoCountOptions): Promise<number>;
-    transactional<T>(cb: (trx: Transaction<ClientSession>) => Promise<T>, options?: {
-        isolationLevel?: IsolationLevel;
-        ctx?: Transaction<ClientSession>;
-        eventBroadcaster?: TransactionEventBroadcaster;
-    } & TransactionOptions): Promise<T>;
-    begin(options?: {
-        isolationLevel?: IsolationLevel;
-        ctx?: ClientSession;
-        eventBroadcaster?: TransactionEventBroadcaster;
-    } & TransactionOptions): Promise<ClientSession>;
-    commit(ctx: ClientSession, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
-    rollback(ctx: ClientSession, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
-    private runQuery;
-    private rethrow;
-    private createUpdatePayload;
-    private transformResult;
-    private getCollectionName;
-    private logObject;
+      }
+  >;
+  getClient(): MongoClient;
+  getCollection<T extends object>(name: EntityName<T> | string): Collection<T>;
+  createCollection<T extends object>(name: EntityName<T>): Promise<Collection<T>>;
+  listCollections(): Promise<string[]>;
+  dropCollection(name: EntityName<AnyEntity>): Promise<boolean>;
+  mapOptions(overrides: MongoClientOptions): MongoClientOptions;
+  getDb(): Db;
+  execute(query: string): Promise<any>;
+  find<T extends object>(
+    entityName: EntityName<T>,
+    where: FilterQuery<T>,
+    opts?: MongoFindOptions<T>,
+  ): Promise<EntityData<T>[]>;
+  stream<T extends object>(
+    entityName: EntityName<T>,
+    where: FilterQuery<T>,
+    opts?: MongoFindOptions<T>,
+  ): AsyncIterableIterator<T>;
+  private _find;
+  insertOne<T extends object>(
+    entityName: EntityName<T>,
+    data: Partial<T>,
+    ctx?: Transaction<ClientSession>,
+  ): Promise<QueryResult<T>>;
+  insertMany<T extends object>(
+    entityName: EntityName<T>,
+    data: Partial<T>[],
+    ctx?: Transaction<ClientSession>,
+  ): Promise<QueryResult<T>>;
+  updateMany<T extends object>(
+    entityName: EntityName<T>,
+    where: FilterQuery<T>,
+    data: Partial<T>,
+    ctx?: Transaction<ClientSession>,
+    upsert?: boolean,
+    upsertOptions?: UpsertOptions<T>,
+  ): Promise<QueryResult<T>>;
+  bulkUpdateMany<T extends object>(
+    entityName: EntityName<T>,
+    where: FilterQuery<T>[],
+    data: Partial<T>[],
+    ctx?: Transaction<ClientSession>,
+    upsert?: boolean,
+    upsertOptions?: UpsertManyOptions<T>,
+  ): Promise<QueryResult<T>>;
+  deleteMany<T extends object>(
+    entityName: EntityName<T>,
+    where: FilterQuery<T>,
+    ctx?: Transaction<ClientSession>,
+  ): Promise<QueryResult<T>>;
+  aggregate<T extends object = any>(
+    entityName: EntityName<T>,
+    pipeline: any[],
+    ctx?: Transaction<ClientSession>,
+    loggerContext?: LoggingOptions,
+  ): Promise<T[]>;
+  streamAggregate<T extends object>(
+    entityName: EntityName<T>,
+    pipeline: any[],
+    ctx?: Transaction<ClientSession>,
+    loggerContext?: LoggingOptions,
+    stream?: boolean,
+  ): AsyncIterableIterator<T>;
+  countDocuments<T extends object>(
+    entityName: EntityName<T>,
+    where: FilterQuery<T>,
+    opts?: MongoCountOptions,
+  ): Promise<number>;
+  transactional<T>(
+    cb: (trx: Transaction<ClientSession>) => Promise<T>,
+    options?: {
+      isolationLevel?: IsolationLevel;
+      ctx?: Transaction<ClientSession>;
+      eventBroadcaster?: TransactionEventBroadcaster;
+    } & TransactionOptions,
+  ): Promise<T>;
+  begin(
+    options?: {
+      isolationLevel?: IsolationLevel;
+      ctx?: ClientSession;
+      eventBroadcaster?: TransactionEventBroadcaster;
+    } & TransactionOptions,
+  ): Promise<ClientSession>;
+  commit(ctx: ClientSession, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+  rollback(ctx: ClientSession, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+  private runQuery;
+  private rethrow;
+  private createUpdatePayload;
+  private transformResult;
+  private getCollectionName;
+  private logObject;
 }
 /** Options shared across MongoDB query operations. */
 export interface MongoQueryOptions {
-    collation?: CollationOptions;
-    indexHint?: string | Dictionary;
-    maxTimeMS?: number;
-    allowDiskUse?: boolean;
+  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;
-    offset?: number;
-    fields?: string[];
-    ctx?: Transaction<ClientSession>;
-    loggerContext?: LoggingOptions;
+  orderBy?: QueryOrderMap<T> | QueryOrderMap<T>[];
+  limit?: number;
+  offset?: number;
+  fields?: string[];
+  ctx?: Transaction<ClientSession>;
+  loggerContext?: LoggingOptions;
 }
 /** Options for MongoDB count operations. */
 export interface MongoCountOptions extends Omit<MongoQueryOptions, 'allowDiskUse'> {
-    ctx?: Transaction<ClientSession>;
-    loggerContext?: LoggingOptions;
+  ctx?: Transaction<ClientSession>;
+  loggerContext?: LoggingOptions;
 }