@mikro-orm/core 6.3.14-dev.69 → 6.3.14-dev.70

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/core",
-  "version": "6.3.14-dev.69",
+  "version": "6.3.14-dev.70",
   "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.",
   "main": "index.js",
   "module": "index.mjs",
@@ -64,7 +64,7 @@
     "esprima": "4.0.1",
     "fs-extra": "11.2.0",
     "globby": "11.1.0",
-    "mikro-orm": "6.3.14-dev.69",
+    "mikro-orm": "6.3.14-dev.70",
     "reflect-metadata": "0.2.2"
   }
 }

package/utils/ConfigurationLoader.d.ts

@@ -6,7 +6,33 @@ import { Configuration, type Options } from './Configuration';
  * @internal
  */
 export declare class ConfigurationLoader {
-    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(contextName: string | undefined, paths: string[], options?: Partial<Options>): Promise<Configuration<D, EM>>;
+    /**
+     * Gets a named configuration from a set of paths
+     *
+     * @param contextName Name of context to load from the config. Used when config file exports array or factory function.
+     * @param paths Array of possible paths for a configuration file. Files will be checked in order, and the first existing one will be used.
+     * @param options Additional options to augment the final configuration with.
+     */
+    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(contextName: string, paths: string[], options?: Partial<Options>): Promise<Configuration<D, EM>>;
+    /**
+     * Gets a named configuration from a set of paths
+     *
+     * @param contextName Name of context to load from the config. Used when config file exports array or factory function. Defaults to "default".
+     * @param paths Array of possible paths for a configuration file. Files will be checked in order, and the first existing one will be used. Defaults to the output of {@link ConfigurationLoader.getConfigPaths}
+     * @param options Additional options to augment the final configuration with.
+     *
+     * @deprecated Prefer to explicitly set the parameter values. The defaults are available for backwards compatibility.
+     */
+    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(contextName?: string, paths?: string[], options?: Partial<Options>): Promise<Configuration<D, EM>>;
+    /**
+     * Gets default configuration
+     *
+     * @param validate It was used to control Configuration constructor's validate parameter. Currently is no-op. Set to `true` to enable cross-version calls that also check for --config in process.argv.
+     * @param options Additional options to augment the final configuration with.
+     *
+     * @deprecated Use the other overload of this method. This signature will be removed in v7.
+     */
+    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(validate: true, options?: Partial<Options>): Promise<Configuration<D, EM>>;
     static getPackageConfig(basePath?: string): Dictionary;
     static getSettings(): Settings;
     static configPathsFromArg(): string[] | undefined;

package/utils/ConfigurationLoader.js

@@ -16,7 +16,15 @@ const Utils_1 = require("./Utils");
  * @internal
  */
 class ConfigurationLoader {
-    static async getConfiguration(contextName = 'default', paths, options = {}) {
+    static async getConfiguration(contextName = 'default', paths = ConfigurationLoader.getConfigPaths(), options = {}) {
+        if (contextName === true || !Array.isArray(paths)) {
+            const configPathFromArg = ConfigurationLoader.configPathsFromArg();
+            const config = (await ConfigurationLoader.getConfiguration(process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default', configPathFromArg ?? ConfigurationLoader.getConfigPaths(), Array.isArray(paths) ? undefined : paths));
+            if (configPathFromArg) {
+                config.getLogger().warn('deprecated', 'Path for config file was inferred from the command line arguments. Instead, you should set the MIKRO_ORM_CLI_CONFIG environment variable to specify the path, or if you really must use the command line arguments, import the config manually based on them, and pass it to init.', { label: 'D0001' });
+            }
+            return config;
+        }
         const env = this.loadEnvironmentVars();
         const configFinder = (cfg) => {
             return typeof cfg === 'object' && cfg !== null && ('contextName' in cfg ? cfg.contextName === contextName : (contextName === 'default'));