@mikro-orm/core 7.0.0-dev.71 → 7.0.0-dev.73

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.71",
+  "version": "7.0.0-dev.73",
   "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",

package/unit-of-work/UnitOfWork.js

@@ -327,7 +327,8 @@ export class UnitOfWork {
             this.filterCollectionUpdates();
             // nothing to do, do not start transaction
             if (this.changeSets.size === 0 && this.collectionUpdates.size === 0 && this.extraUpdates.size === 0) {
-                return void (await this.eventManager.dispatchEvent(EventType.afterFlush, { em: this.em, uow: this }));
+                await this.eventManager.dispatchEvent(EventType.afterFlush, { em: this.em, uow: this });
+                return;
             }
             const groups = this.getChangeSetGroups();
             const platform = this.em.getPlatform();

package/utils/Configuration.d.ts

@@ -230,181 +230,757 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
  * Type helper to make it easier to use `mikro-orm.config.js`.
  */
 export declare function defineConfig<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<D> = EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Options<D, EM, Entities>): Options<D, EM, Entities>;
+/**
+ * Connection configuration options for database connections.
+ * @see https://mikro-orm.io/docs/configuration#connection
+ */
 export interface ConnectionOptions {
+    /** Name of the database to connect to. */
     dbName?: string;
+    /** Default database schema to use. */
     schema?: string;
+    /** Name of the connection (used for logging when replicas are used). */
     name?: string;
+    /** Full client connection URL. Overrides individual connection options. */
     clientUrl?: string;
+    /** Database server hostname. */
     host?: string;
+    /** Database server port number. */
     port?: number;
+    /** Database user name. */
     user?: string;
+    /**
+     * Database password. Can be a string or a callback function that returns the password.
+     * The callback is useful for short-lived tokens from cloud providers.
+     * @example
+     * password: async () => someCallToGetTheToken()
+     */
     password?: string | (() => MaybePromise<string>);
+    /** Character set for the connection. */
     charset?: string;
+    /** Collation for the connection. */
     collate?: string;
+    /**
+     * Enable multiple statements in a single query.
+     * Required for importing database dump files.
+     * Should be disabled in production for security.
+     * @default false
+     */
     multipleStatements?: boolean;
+    /** Connection pool configuration. */
     pool?: PoolConfig;
+    /**
+     * Additional driver-specific options.
+     * The object will be deeply merged with internal driver options.
+     */
     driverOptions?: Dictionary;
+    /** Callback to execute when a new connection is created. */
     onCreateConnection?: (connection: unknown) => Promise<void>;
 }
+/**
+ * Configuration options for database migrations.
+ * @see https://mikro-orm.io/docs/migrations
+ */
 export type MigrationsOptions = {
+    /**
+     * Name of the migrations table.
+     * @default 'mikro_orm_migrations'
+     */
     tableName?: string;
+    /**
+     * Path to the folder with migration files (for compiled JavaScript files).
+     * @default './migrations'
+     */
     path?: string;
+    /**
+     * Path to the folder with migration files (for TypeScript source files).
+     * Used when running in TypeScript mode.
+     */
     pathTs?: string;
+    /**
+     * Glob pattern to match migration files.
+     * @default '!(*.d).{js,ts,cjs}'
+     */
     glob?: string;
+    /**
+     * Disable logging for migration operations.
+     * @default false
+     */
     silent?: boolean;
+    /**
+     * Run each migration inside a transaction.
+     * @default true
+     */
     transactional?: boolean;
+    /**
+     * Try to disable foreign key checks during migrations.
+     * @default false
+     */
     disableForeignKeys?: boolean;
+    /**
+     * Run all migrations in the current batch in a master transaction.
+     * @default true
+     */
     allOrNothing?: boolean;
+    /**
+     * Allow dropping tables during schema diff.
+     * @default true
+     */
     dropTables?: boolean;
+    /**
+     * Safe mode - only allow adding new tables and columns, never dropping existing ones.
+     * @default false
+     */
     safe?: boolean;
+    /**
+     * Create a snapshot of the current schema after migration generation.
+     * @default true
+     */
     snapshot?: boolean;
+    /** Custom name for the snapshot file. */
     snapshotName?: string;
+    /**
+     * File extension for generated migration files.
+     * @default 'ts'
+     */
     emit?: 'js' | 'ts' | 'cjs';
+    /** Custom migration generator class. */
     generator?: Constructor<IMigrationGenerator>;
+    /**
+     * Custom function to generate migration file names.
+     * @default (timestamp, name) => `Migration${timestamp}${name ? '_' + name : ''}`
+     */
     fileName?: (timestamp: string, name?: string) => string;
+    /** List of migration classes or objects to use instead of file-based discovery. */
     migrationsList?: (MigrationObject | Constructor<Migration>)[];
 };
+/**
+ * Configuration options for database seeders.
+ * @see https://mikro-orm.io/docs/seeding
+ */
 export interface SeederOptions {
+    /**
+     * Path to the folder with seeder files (for compiled JavaScript files).
+     * @default './seeders'
+     */
     path?: string;
+    /**
+     * Path to the folder with seeder files (for TypeScript source files).
+     * Used when running in TypeScript mode.
+     */
     pathTs?: string;
+    /**
+     * Glob pattern to match seeder files.
+     * @default '!(*.d).{js,ts}'
+     */
     glob?: string;
+    /**
+     * Name of the default seeder class to run.
+     * @default 'DatabaseSeeder'
+     */
     defaultSeeder?: string;
+    /**
+     * File extension for generated seeder files.
+     * @default 'ts'
+     */
     emit?: 'js' | 'ts';
+    /**
+     * Custom function to generate seeder file names.
+     * @default (className) => className
+     */
     fileName?: (className: string) => string;
 }
+/**
+ * Connection pool configuration.
+ * @see https://mikro-orm.io/docs/configuration#connection
+ */
 export interface PoolConfig {
+    /** Minimum number of connections to keep in the pool. */
     min?: number;
+    /** Maximum number of connections allowed in the pool. */
     max?: number;
+    /** Time in milliseconds before an idle connection is closed. */
     idleTimeoutMillis?: number;
 }
+/**
+ * Configuration options for metadata discovery.
+ * @see https://mikro-orm.io/docs/configuration#entity-discovery
+ */
 export interface MetadataDiscoveryOptions {
+    /**
+     * Throw an error when no entities are discovered.
+     * @default true
+     */
     warnWhenNoEntities?: boolean;
+    /**
+     * Check for duplicate table names and throw an error if found.
+     * @default true
+     */
     checkDuplicateTableNames?: boolean;
+    /**
+     * Check for duplicate field names and throw an error if found.
+     * @default true
+     */
     checkDuplicateFieldNames?: boolean;
+    /**
+     * Check for duplicate entities and throw an error if found.
+     * @default true
+     */
     checkDuplicateEntities?: boolean;
+    /**
+     * Check for composite primary keys marked as `persist: false` and throw an error if found.
+     * @default true
+     */
     checkNonPersistentCompositeProps?: boolean;
+    /**
+     * Infer default values from property initializers when possible
+     * (if the constructor can be invoked without parameters).
+     * @default true
+     */
     inferDefaultValues?: boolean;
+    /**
+     * Custom callback to override default type mapping.
+     * Allows customizing how property types are mapped to database column types.
+     * @example
+     * getMappedType(type, platform) {
+     *   if (type === 'string') {
+     *     return Type.getType(TextType);
+     *   }
+     *   return platform.getDefaultMappedType(type);
+     * }
+     */
     getMappedType?: (type: string, platform: Platform) => Type<unknown> | undefined;
+    /**
+     * Hook called for each entity metadata during discovery.
+     * Can be used to modify metadata dynamically before defaults are filled in.
+     * The hook can be async when using `MikroORM.init()`.
+     */
     onMetadata?: (meta: EntityMetadata, platform: Platform) => MaybePromise<void>;
+    /**
+     * Hook called after all entities are discovered.
+     * Can be used to access and modify all metadata at once.
+     */
     afterDiscovered?: (storage: MetadataStorage, platform: Platform) => MaybePromise<void>;
+    /** Path to the TypeScript configuration file for ts-morph metadata provider. */
     tsConfigPath?: string;
     /** @internal */
     skipSyncDiscovery?: boolean;
 }
+/**
+ * MikroORM configuration options.
+ * @see https://mikro-orm.io/docs/configuration
+ */
 export interface Options<Driver extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<Driver> & Driver[typeof EntityManagerType] = EntityManager<Driver> & Driver[typeof EntityManagerType], Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends ConnectionOptions {
+    /**
+     * Array of entity classes or paths to entity modules.
+     * Paths support glob patterns for automatic discovery.
+     * @example
+     * entities: [Author, Book, Publisher] // class references
+     * entities: ['./dist/entities'] // folder paths
+     */
     entities?: Entities;
+    /**
+     * Array of TypeScript entity source paths.
+     * Used when running in TypeScript mode (e.g., via `tsx` or `swc`).
+     * Should always be specified when using folder-based discovery.
+     * @example
+     * entitiesTs: ['./src/entities']
+     */
     entitiesTs?: Entities;
+    /**
+     * ORM extensions to register (e.g., Migrator, EntityGenerator, SeedManager).
+     * Extensions registered here are available via shortcuts like `orm.migrator`.
+     * @example
+     * extensions: [Migrator, EntityGenerator, SeedManager]
+     */
     extensions?: {
         register: (orm: MikroORM) => void;
     }[];
+    /**
+     * Event subscribers to register.
+     * Can be class references or instances.
+     */
     subscribers?: (EventSubscriber | Constructor<EventSubscriber>)[];
+    /**
+     * Global entity filters to apply.
+     * Filters are applied by default unless explicitly disabled.
+     * @see https://mikro-orm.io/docs/filters
+     */
     filters?: Dictionary<{
         name?: string;
     } & Omit<FilterDef, 'name'>>;
+    /**
+     * Metadata discovery configuration options.
+     * Controls how entities are discovered and validated.
+     */
     discovery?: MetadataDiscoveryOptions;
+    /**
+     * Database driver class to use.
+     * Should be imported from the specific driver package (e.g. `@mikro-orm/mysql`, `@mikro-orm/postgresql`).
+     * Alternatively, use the `defineConfig` helper or `MikroORM` class exported from the driver package.
+     * @example
+     * import { MySqlDriver } from '@mikro-orm/mysql';
+     *
+     * MikroORM.init({
+     *   driver: MySqlDriver,
+     *   dbName: 'my_db',
+     * });
+     */
     driver?: {
         new (config: Configuration): Driver;
     };
+    /**
+     * Custom naming strategy class for mapping entity/property names to database table/column names.
+     * Built-in options: `UnderscoreNamingStrategy`, `MongoNamingStrategy`, `EntityCaseNamingStrategy`.
+     * @see https://mikro-orm.io/docs/naming-strategy
+     */
     namingStrategy?: {
         new (): NamingStrategy;
     };
+    /**
+     * Enable implicit transactions for all write operations.
+     * When enabled, all queries will be wrapped in a transaction.
+     * Disabled for MongoDB driver by default.
+     */
     implicitTransactions?: boolean;
+    /**
+     * Disable all transactions.
+     * When enabled, no queries will be wrapped in transactions, even when explicitly requested.
+     * @default false
+     */
     disableTransactions?: boolean;
+    /**
+     * Enable verbose logging of internal operations.
+     * @default false
+     */
     verbose?: boolean;
+    /**
+     * Ignore `undefined` values in find queries instead of treating them as `null`.
+     * @default false
+     * @example
+     * // With ignoreUndefinedInQuery: true
+     * em.find(User, { email: undefined }) // resolves to em.find(User, {})
+     */
     ignoreUndefinedInQuery?: boolean;
+    /**
+     * Hook to modify SQL queries before execution.
+     * Useful for adding observability hints or query modifications.
+     * @param sql - The generated SQL query
+     * @param params - Query parameters
+     * @returns Modified SQL query
+     */
     onQuery?: (sql: string, params: readonly unknown[]) => string;
+    /**
+     * Automatically join the owning side of 1:1 relations when querying the inverse side.
+     * @default true
+     */
     autoJoinOneToOneOwner?: boolean;
+    /**
+     * Automatically join M:1 and 1:1 relations when filters are defined on them.
+     * Important for implementing soft deletes via filters.
+     * @default true
+     */
     autoJoinRefsForFilters?: boolean;
+    /**
+     * Apply filters to relations in queries.
+     * @default true
+     */
     filtersOnRelations?: boolean;
+    /**
+     * Enable propagation of changes on entity prototypes.
+     * @default true
+     */
     propagationOnPrototype?: boolean;
+    /**
+     * Mark all relations as populated after flush for new entities.
+     * This aligns serialized output of loaded entities and just-inserted ones.
+     * @default true
+     */
     populateAfterFlush?: boolean;
+    /**
+     * Serialization options for `toJSON()` and `serialize()` methods.
+     */
     serialization?: {
+        /**
+         * Include primary keys in serialized output.
+         * @default true
+         */
         includePrimaryKeys?: boolean;
-        /** Enforce unpopulated references to be returned as objects, e.g. `{ author: { id: 1 } }` instead of `{ author: 1 }`. */
+        /**
+         * Enforce unpopulated references to be returned as objects.
+         * When enabled, references are serialized as `{ author: { id: 1 } }` instead of `{ author: 1 }`.
+         * @default false
+         */
         forceObject?: boolean;
     };
+    /**
+     * Default options for entity assignment via `em.assign()`.
+     * @see https://mikro-orm.io/docs/entity-helper
+     */
     assign?: AssignOptions<boolean>;
+    /**
+     * Automatically call `em.persist()` on entities created via `em.create()`.
+     * @default true
+     */
     persistOnCreate?: boolean;
+    /**
+     * When upsert creates a new entity, mark it as managed in the identity map.
+     * @default true
+     */
     upsertManaged?: boolean;
+    /**
+     * Force use of entity constructors when creating entity instances.
+     * Required when using native private properties inside entities.
+     * Can be `true` for all entities or an array of specific entity classes/names.
+     * @default false
+     */
     forceEntityConstructor?: boolean | (Constructor<AnyEntity> | string)[];
+    /**
+     * Convert `null` values from database to `undefined` when hydrating entities.
+     * @default false
+     */
     forceUndefined?: boolean;
     /**
      * Property `onCreate` hooks are normally executed during `flush` operation.
      * With this option, they will be processed early inside `em.create()` method.
+     * @default false
      */
     processOnCreateHooksEarly?: boolean;
+    /**
+     * Force `Date` values to be stored in UTC for datetime columns without timezone.
+     * Works for MySQL (`datetime` type) and PostgreSQL (`timestamp` type).
+     * SQLite does this by default.
+     * @default false
+     */
     forceUtcTimezone?: boolean;
+    /**
+     * Timezone to use for date operations.
+     * @example '+02:00'
+     */
     timezone?: string;
+    /**
+     * Ensure the database exists when initializing the ORM.
+     * When `true`, will create the database if it doesn't exist.
+     * @default true
+     */
     ensureDatabase?: boolean | EnsureDatabaseOptions;
+    /**
+     * Ensure database indexes exist on startup. This option works only with the MongoDB driver.
+     * When enabled, indexes will be created based on entity metadata.
+     * @default false
+     */
     ensureIndexes?: boolean;
+    /**
+     * Use batch insert queries for better performance.
+     * @default true
+     */
     useBatchInserts?: boolean;
+    /**
+     * Use batch update queries for better performance.
+     * @default true
+     */
     useBatchUpdates?: boolean;
+    /**
+     * Number of entities to process in each batch for batch inserts/updates.
+     * @default 300
+     */
     batchSize?: number;
+    /**
+     * Custom hydrator class for assigning database values to entities.
+     * @default ObjectHydrator
+     */
     hydrator?: HydratorConstructor;
+    /**
+     * Default loading strategy for relations.
+     * - `'joined'`: Use SQL JOINs (single query, may cause cartesian product)
+     * - `'select-in'`: Use separate SELECT IN queries (multiple queries)
+     * - `'balanced'`: Decides based on relation type and context.
+     * @default 'balanced'
+     */
     loadStrategy?: LoadStrategy | `${LoadStrategy}`;
+    /**
+     * Enable dataloader for batching reference loading.
+     * - `true` or `DataloaderType.ALL`: Enable for all relation types
+     * - `false` or `DataloaderType.NONE`: Disable dataloader
+     * - `DataloaderType.REFERENCE`: Enable only for scalar references
+     * - `DataloaderType.COLLECTION`: Enable only for collections
+     * @default DataloaderType.NONE
+     */
     dataloader?: DataloaderType | boolean;
+    /**
+     * Determines how where conditions are applied during population.
+     * - `'all'`: Populate all matching relations (default in v5+)
+     * - `'infer'`: Infer conditions from the original query (v4 behavior)
+     * @default 'all'
+     */
     populateWhere?: PopulateHint | `${PopulateHint}`;
+    /**
+     * Default flush mode for the entity manager.
+     * - `'commit'`: Flush only on explicit commit
+     * - `'auto'`: Flush before queries when needed
+     * - `'always'`: Always flush before queries
+     * @default 'auto'
+     */
     flushMode?: FlushMode | `${FlushMode}`;
+    /**
+     * Custom base repository class for all entities.
+     * Entity-specific repositories can still be defined and will take precedence.
+     * @see https://mikro-orm.io/docs/repositories
+     */
     entityRepository?: EntityClass<EntityRepository<any>>;
+    /**
+     * Custom entity manager class to use.
+     */
     entityManager?: Constructor<EM>;
+    /**
+     * Read replica connection configurations.
+     * Each replica can override parts of the main connection options.
+     * @see https://mikro-orm.io/docs/read-connections
+     */
     replicas?: ConnectionOptions[];
+    /**
+     * Enable strict mode which disables automatic data type conversion.
+     * In strict mode, the ORM throws errors instead of fixing wrong data types.
+     * @default false
+     * @see https://mikro-orm.io/docs/property-validation
+     */
     strict?: boolean;
+    /**
+     * Enable runtime property validation before persisting.
+     * Has performance implications and is usually not needed.
+     * @default false
+     * @see https://mikro-orm.io/docs/property-validation
+     */
     validate?: boolean;
+    /**
+     * Validate that required properties are set on new entities before insert.
+     * @default true
+     */
     validateRequired?: boolean;
+    /**
+     * Callback to get the current request context's EntityManager.
+     * Used for automatic context propagation in web frameworks.
+     * @default RequestContext.getEntityManager
+     */
     context?: (name: string) => EntityManager | undefined;
+    /**
+     * Name of the context for multi-ORM setups.
+     * @default 'default'
+     */
     contextName?: string;
+    /**
+     * Allow using the global EntityManager without a request context.
+     * Not recommended for production - each request should have its own context.
+     * Can also be set via `MIKRO_ORM_ALLOW_GLOBAL_CONTEXT` environment variable.
+     * @default false
+     */
     allowGlobalContext?: boolean;
+    /**
+     * Disable the identity map.
+     * When disabled, each query returns new entity instances.
+     * Not recommended for most use cases.
+     * @default false
+     */
     disableIdentityMap?: boolean;
+    /**
+     * Custom logger function for ORM output.
+     * @default console.log
+     */
     logger?: (message: string) => void;
+    /**
+     * Enable colored output in logs.
+     * @default true
+     */
     colors?: boolean;
+    /**
+     * Factory function to create a custom logger instance.
+     * @default DefaultLogger.create
+     */
     loggerFactory?: (options: LoggerOptions) => Logger;
+    /**
+     * Custom error handler for `em.findOneOrFail()` when no entity is found.
+     * @param entityName - Name of the entity being queried
+     * @param where - Query conditions
+     * @returns Error instance to throw
+     */
     findOneOrFailHandler?: (entityName: string, where: Dictionary | IPrimaryKey) => Error;
+    /**
+     * Custom error handler for `em.findExactlyOneOrFail()` when entity count is not exactly one.
+     * Used when strict mode is enabled.
+     * @param entityName - Name of the entity being queried
+     * @param where - Query conditions
+     * @returns Error instance to throw
+     */
     findExactlyOneOrFailHandler?: (entityName: string, where: Dictionary | IPrimaryKey) => Error;
+    /**
+     * Enable debug logging.
+     * Can be `true` for all namespaces or an array of specific namespaces.
+     * Available namespaces: `'query'`, `'query-params'`, `'discovery'`, `'info'`.
+     * @default false
+     * @see https://mikro-orm.io/docs/logging
+     */
     debug?: boolean | LoggerNamespace[];
+    /**
+     * Ignore deprecation warnings.
+     * Can be `true` to ignore all or an array of specific deprecation labels.
+     * @default false
+     * @see https://mikro-orm.io/docs/logging#deprecation-warnings
+     */
     ignoreDeprecations?: boolean | string[];
+    /**
+     * Syntax highlighter for SQL queries in logs.
+     * @default NullHighlighter
+     */
     highlighter?: Highlighter;
     /**
-     * Using this option, you can force the ORM to use the TS options regardless of whether the TypeScript support
-     * is detected or not. This effectively means using `entitiesTs` for discovery and `pathTs` for migrations and
-     * seeders. Should be used only for tests and stay disabled for production builds.
+     * Force the ORM to use TypeScript options regardless of detection.
+     * Uses `entitiesTs` for discovery and `pathTs` for migrations/seeders.
+     * Should only be used for tests, not production builds.
+     * @default false
      */
     preferTs?: boolean;
+    /**
+     * Base directory for resolving relative paths.
+     * @default process.cwd()
+     */
     baseDir?: string;
+    /**
+     * Migration configuration options.
+     * @see https://mikro-orm.io/docs/migrations
+     */
     migrations?: MigrationsOptions;
+    /**
+     * Schema generator configuration options.
+     */
     schemaGenerator?: {
+        /**
+         * Try to disable foreign key checks during schema operations.
+         * @default false
+         */
         disableForeignKeys?: boolean;
+        /**
+         * Generate foreign key constraints.
+         * @default true
+         */
         createForeignKeyConstraints?: boolean;
+        /**
+         * Schema names to ignore when comparing schemas.
+         * @default []
+         */
         ignoreSchema?: string[];
+        /**
+         * Table names or patterns to skip during schema generation.
+         * @default []
+         */
         skipTables?: (string | RegExp)[];
+        /**
+         * Column names or patterns to skip during schema generation, keyed by table name.
+         * @default {}
+         */
         skipColumns?: Dictionary<(string | RegExp)[]>;
+        /**
+         * Database name to use for management operations (e.g., creating/dropping databases).
+         */
         managementDbName?: string;
     };
+    /**
+     * Embeddable entity configuration options.
+     */
     embeddables?: {
+        /**
+         * Mode for generating column prefixes for embedded properties.
+         * @default 'relative'
+         */
         prefixMode: EmbeddedPrefixMode;
     };
+    /**
+     * Entity generator (code generation) configuration options.
+     * @see https://mikro-orm.io/docs/entity-generator
+     */
     entityGenerator?: GenerateOptions;
+    /**
+     * Metadata cache configuration for improved startup performance.
+     * @see https://mikro-orm.io/docs/metadata-cache
+     */
     metadataCache?: {
+        /**
+         * Enable metadata caching.
+         * Defaults based on the metadata provider's `useCache()` method.
+         */
         enabled?: boolean;
+        /**
+         * Combine all metadata into a single cache file.
+         * Can be `true` for default path or a custom path string.
+         */
         combined?: boolean | string;
+        /**
+         * Pretty print JSON cache files.
+         * @default false
+         */
         pretty?: boolean;
+        /**
+         * Cache adapter class to use.
+         * @default FileCacheAdapter
+         */
         adapter?: {
             new (...params: any[]): SyncCacheAdapter;
         };
+        /**
+         * Options passed to the cache adapter constructor.
+         * @default { cacheDir: process.cwd() + '/temp' }
+         */
         options?: Dictionary;
     };
+    /**
+     * Result cache configuration for query result caching.
+     */
     resultCache?: {
+        /**
+         * Default cache expiration time in milliseconds.
+         * @default 1000
+         */
         expiration?: number;
+        /**
+         * Cache adapter class to use.
+         * @default MemoryCacheAdapter
+         */
         adapter?: {
             new (...params: any[]): CacheAdapter;
         };
+        /**
+         * Options passed to the cache adapter constructor.
+         * @default {}
+         */
         options?: Dictionary;
+        /**
+         * Enable global result caching for all queries.
+         * Can be `true`, an expiration number, or a tuple of `[key, expiration]`.
+         */
         global?: boolean | number | [string, number];
     };
+    /**
+     * Metadata provider class for entity discovery.
+     * Built-in options: `ReflectMetadataProvider` (default), `TsMorphMetadataProvider`.
+     * @default ReflectMetadataProvider
+     * @see https://mikro-orm.io/docs/metadata-providers
+     */
     metadataProvider?: {
         new (config: Configuration): MetadataProvider;
     };
+    /**
+     * Seeder configuration options.
+     * @see https://mikro-orm.io/docs/seeding
+     */
     seeder?: SeederOptions;
+    /**
+     * Prefer read replicas for read operations when available.
+     * @default true
+     */
     preferReadReplicas?: boolean;
+    /**
+     * Custom dynamic import provider for loading modules.
+     * @default (id) => import(id)
+     */
     dynamicImportProvider?: (id: string) => Promise<unknown>;
 }
 type MarkRequired<T, D> = {

package/utils/ConfigurationLoader.js

@@ -7,78 +7,88 @@ import { colors } from '../logging/colors.js';
 export class ConfigurationLoader {
     static loadEnvironmentVars() {
         const ret = {};
+        const getEnvKey = (key, envPrefix = 'MIKRO_ORM_') => {
+            return envPrefix + key
+                .replace(/([a-z0-9])([A-Z])/g, '$1_$2')
+                .replace(/([A-Z])([A-Z][a-z])/g, '$1_$2')
+                .toUpperCase();
+        };
         const array = (v) => v.split(',').map(vv => vv.trim());
         const bool = (v) => ['true', 't', '1'].includes(v.toLowerCase());
         const num = (v) => +v;
-        const read = (o, envKey, key, mapper = v => v) => {
-            if (!(envKey in process.env)) {
-                return;
+        const read = (o, envPrefix, key, mapper = v => v) => {
+            const envKey = getEnvKey(key, envPrefix);
+            if (envKey in process.env) {
+                o[key] = mapper(process.env[envKey]);
             }
-            const val = process.env[envKey];
-            o[key] = mapper(val);
         };
         const cleanup = (o, k) => Utils.hasObjectKeys(o[k]) ? {} : delete o[k];
-        read(ret, 'MIKRO_ORM_BASE_DIR', 'baseDir');
-        read(ret, 'MIKRO_ORM_ENTITIES', 'entities', array);
-        read(ret, 'MIKRO_ORM_ENTITIES_TS', 'entitiesTs', array);
-        read(ret, 'MIKRO_ORM_CLIENT_URL', 'clientUrl');
-        read(ret, 'MIKRO_ORM_HOST', 'host');
-        read(ret, 'MIKRO_ORM_PORT', 'port', num);
-        read(ret, 'MIKRO_ORM_USER', 'user');
-        read(ret, 'MIKRO_ORM_PASSWORD', 'password');
-        read(ret, 'MIKRO_ORM_DB_NAME', 'dbName');
-        read(ret, 'MIKRO_ORM_SCHEMA', 'schema');
-        read(ret, 'MIKRO_ORM_LOAD_STRATEGY', 'loadStrategy');
-        read(ret, 'MIKRO_ORM_BATCH_SIZE', 'batchSize', num);
-        read(ret, 'MIKRO_ORM_USE_BATCH_INSERTS', 'useBatchInserts', bool);
-        read(ret, 'MIKRO_ORM_USE_BATCH_UPDATES', 'useBatchUpdates', bool);
-        read(ret, 'MIKRO_ORM_STRICT', 'strict', bool);
-        read(ret, 'MIKRO_ORM_VALIDATE', 'validate', bool);
-        read(ret, 'MIKRO_ORM_ALLOW_GLOBAL_CONTEXT', 'allowGlobalContext', bool);
-        read(ret, 'MIKRO_ORM_AUTO_JOIN_ONE_TO_ONE_OWNER', 'autoJoinOneToOneOwner', bool);
-        read(ret, 'MIKRO_ORM_POPULATE_AFTER_FLUSH', 'populateAfterFlush', bool);
-        read(ret, 'MIKRO_ORM_FORCE_ENTITY_CONSTRUCTOR', 'forceEntityConstructor', bool);
-        read(ret, 'MIKRO_ORM_FORCE_UNDEFINED', 'forceUndefined', bool);
-        read(ret, 'MIKRO_ORM_FORCE_UTC_TIMEZONE', 'forceUtcTimezone', bool);
-        read(ret, 'MIKRO_ORM_TIMEZONE', 'timezone');
-        read(ret, 'MIKRO_ORM_ENSURE_INDEXES', 'ensureIndexes', bool);
-        read(ret, 'MIKRO_ORM_IMPLICIT_TRANSACTIONS', 'implicitTransactions', bool);
-        read(ret, 'MIKRO_ORM_DEBUG', 'debug', bool);
-        read(ret, 'MIKRO_ORM_COLORS', 'colors', bool);
+        const read0 = read.bind(null, ret, 'MIKRO_ORM_');
+        read0('baseDir');
+        read0('entities', array);
+        read0('entitiesTs', array);
+        read0('clientUrl');
+        read0('host');
+        read0('port', num);
+        read0('user');
+        read0('password');
+        read0('dbName');
+        read0('schema');
+        read0('loadStrategy');
+        read0('batchSize', num);
+        read0('useBatchInserts', bool);
+        read0('useBatchUpdates', bool);
+        read0('strict', bool);
+        read0('validate', bool);
+        read0('allowGlobalContext', bool);
+        read0('autoJoinOneToOneOwner', bool);
+        read0('populateAfterFlush', bool);
+        read0('forceEntityConstructor', bool);
+        read0('forceUndefined', bool);
+        read0('forceUtcTimezone', bool);
+        read0('timezone');
+        read0('ensureIndexes', bool);
+        read0('implicitTransactions', bool);
+        read0('debug', bool);
+        read0('colors', bool);
         ret.discovery = {};
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_WARN_WHEN_NO_ENTITIES', 'warnWhenNoEntities', bool);
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_CHECK_DUPLICATE_TABLE_NAMES', 'checkDuplicateTableNames', bool);
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_CHECK_DUPLICATE_FIELD_NAMES', 'checkDuplicateFieldNames', bool);
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_CHECK_DUPLICATE_ENTITIES', 'checkDuplicateEntities', bool);
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_CHECK_NON_PERSISTENT_COMPOSITE_PROPS', 'checkNonPersistentCompositeProps', bool);
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_INFER_DEFAULT_VALUES', 'inferDefaultValues', bool);
-        read(ret.discovery, 'MIKRO_ORM_DISCOVERY_TS_CONFIG_PATH', 'tsConfigPath');
+        const read1 = read.bind(null, ret.discovery, 'MIKRO_ORM_DISCOVERY_');
+        read1('warnWhenNoEntities', bool);
+        read1('checkDuplicateTableNames', bool);
+        read1('checkDuplicateFieldNames', bool);
+        read1('checkDuplicateEntities', bool);
+        read1('checkNonPersistentCompositeProps', bool);
+        read1('inferDefaultValues', bool);
+        read1('tsConfigPath');
         cleanup(ret, 'discovery');
         ret.migrations = {};
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_TABLE_NAME', 'tableName');
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_PATH', 'path');
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_PATH_TS', 'pathTs');
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_GLOB', 'glob');
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_TRANSACTIONAL', 'transactional', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS', 'disableForeignKeys', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_ALL_OR_NOTHING', 'allOrNothing', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_DROP_TABLES', 'dropTables', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SAFE', 'safe', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SILENT', 'silent', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_EMIT', 'emit');
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SNAPSHOT', 'snapshot', bool);
-        read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SNAPSHOT_NAME', 'snapshotName');
+        const read2 = read.bind(null, ret.migrations, 'MIKRO_ORM_MIGRATIONS_');
+        read2('tableName');
+        read2('path');
+        read2('pathTs');
+        read2('glob');
+        read2('transactional', bool);
+        read2('disableForeignKeys', bool);
+        read2('allOrNothing', bool);
+        read2('dropTables', bool);
+        read2('safe', bool);
+        read2('silent', bool);
+        read2('emit');
+        read2('snapshot', bool);
+        read2('snapshotName');
         cleanup(ret, 'migrations');
         ret.schemaGenerator = {};
-        read(ret.schemaGenerator, 'MIKRO_ORM_SCHEMA_GENERATOR_DISABLE_FOREIGN_KEYS', 'disableForeignKeys', bool);
-        read(ret.schemaGenerator, 'MIKRO_ORM_SCHEMA_GENERATOR_CREATE_FOREIGN_KEY_CONSTRAINTS', 'createForeignKeyConstraints', bool);
+        const read3 = read.bind(null, ret.schemaGenerator, 'MIKRO_ORM_SCHEMA_GENERATOR_');
+        read3('disableForeignKeys', bool);
+        read3('createForeignKeyConstraints', bool);
         cleanup(ret, 'schemaGenerator');
         ret.seeder = {};
-        read(ret.seeder, 'MIKRO_ORM_SEEDER_PATH', 'path');
-        read(ret.seeder, 'MIKRO_ORM_SEEDER_PATH_TS', 'pathTs');
-        read(ret.seeder, 'MIKRO_ORM_SEEDER_GLOB', 'glob');
-        read(ret.seeder, 'MIKRO_ORM_SEEDER_EMIT', 'emit');
-        read(ret.seeder, 'MIKRO_ORM_SEEDER_DEFAULT_SEEDER', 'defaultSeeder');
+        const read4 = read.bind(null, ret.seeder, 'MIKRO_ORM_SEEDER_');
+        read4('path');
+        read4('pathTs');
+        read4('glob');
+        read4('emit');
+        read4('defaultSeeder');
         cleanup(ret, 'seeder');
         return ret;
     }

package/utils/Utils.d.ts

@@ -168,12 +168,6 @@ export declare class Utils {
      * @param [from] Location to start the node resolution
      */
     static requireFrom<T extends Dictionary>(id: string, from?: string): T;
-    /**
-     * Resolve path to a module.
-     * @param id The module to require
-     * @param [from] Location to start the node resolution
-     */
-    static resolveModulePath(id: string, from?: string): string;
     static dynamicImport<T = any>(id: string): Promise<T>;
     static ensureDir(path: string): void;
     static readJSONSync(path: string): Dictionary;

package/utils/Utils.js

@@ -762,21 +762,6 @@ export class Utils {
         }
         return createRequire(resolve(from))(id);
     }
-    /**
-     * Resolve path to a module.
-     * @param id The module to require
-     * @param [from] Location to start the node resolution
-     */
-    static resolveModulePath(id, from = process.cwd()) {
-        if (!extname(from)) {
-            from = join(from, '__fake.js');
-        }
-        const path = Utils.normalizePath(createRequire(resolve(from)).resolve(id));
-        const parts = path.split('/');
-        const idx = parts.lastIndexOf(id) + 1;
-        parts.splice(idx, parts.length - idx);
-        return parts.join('/');
-    }
     static async dynamicImport(id) {
         /* v8 ignore next */
         const specifier = id.startsWith('file://') ? id : pathToFileURL(id).href;