@mikro-orm/core 6.3.14-dev.72 → 6.3.14-dev.74

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/core",
-  "version": "6.3.14-dev.72",
+  "version": "6.3.14-dev.74",
   "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.72",
+    "mikro-orm": "6.3.14-dev.74",
     "reflect-metadata": "0.2.2"
   }
 }

package/utils/ConfigurationLoader.d.ts

@@ -7,32 +7,29 @@ import { Configuration, type Options } from './Configuration';
  */
 export declare class ConfigurationLoader {
     /**
-     * Gets a named configuration from a set of paths
+     * Gets a named configuration
      *
-     * @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 contextName Load a config with the given `contextName` value. Used when config file exports array or factory function. Setting it to "default" matches also config objects without `contextName` set.
+     * @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.
      */
-    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(contextName: string, paths: string[], options?: Partial<Options>): Promise<Configuration<D, EM>>;
+    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
+     * Gets the default config from the default 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.
+     * @deprecated Prefer to explicitly set the `contextName` at the first argument. This signature is available for backwards compatibility, and may be removed in v7.
      */
-    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(contextName?: string, paths?: string[], options?: Partial<Options>): Promise<Configuration<D, EM>>;
+    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(): Promise<Configuration<D, EM>>;
     /**
-     * Gets default configuration
+     * Gets default configuration out of the default paths, and possibly from `process.argv`
      *
-     * @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.
+     * @param validate Whether to validate the final configuration.
+     * @param options Additional options to augment the final configuration with (just before validation).
      *
-     * @deprecated Use the other overload of this method. This signature will be removed in v7.
+     * @deprecated Use the other overloads 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 getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(validate: boolean, options?: Partial<Options>): Promise<Configuration<D, EM>>;
+    static getConfigFile(paths: string[]): Promise<[string, unknown] | []>;
     static getPackageConfig(basePath?: string): Dictionary;
     static getSettings(): Settings;
     static configPathsFromArg(): string[] | undefined;

package/utils/ConfigurationLoader.js

@@ -17,9 +17,25 @@ const Utils_1 = require("./Utils");
  */
 class ConfigurationLoader {
     static async getConfiguration(contextName = 'default', paths = ConfigurationLoader.getConfigPaths(), options = {}) {
-        if (contextName === true || !Array.isArray(paths)) {
+        // Backwards compatibility layer
+        if (typeof contextName === 'boolean' || !Array.isArray(paths)) {
+            this.commonJSCompat(options);
+            this.registerDotenv(options);
             const configPathFromArg = ConfigurationLoader.configPathsFromArg();
-            const config = (await ConfigurationLoader.getConfiguration(process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default', configPathFromArg ?? ConfigurationLoader.getConfigPaths(), Array.isArray(paths) ? undefined : paths));
+            const configPaths = configPathFromArg ?? (Array.isArray(paths) ? paths : ConfigurationLoader.getConfigPaths());
+            const config = contextName
+                ? (await ConfigurationLoader.getConfiguration(process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default', configPaths, Array.isArray(paths) ? {} : paths))
+                : await (async () => {
+                    const env = this.loadEnvironmentVars();
+                    const [path, tmp] = await this.getConfigFile(configPaths);
+                    if (!path) {
+                        if (Utils_1.Utils.hasObjectKeys(env)) {
+                            return new Configuration_1.Configuration(Utils_1.Utils.mergeConfig({}, options, env), false);
+                        }
+                        throw new Error(`MikroORM config file not found in ['${configPaths.join(`', '`)}']`);
+                    }
+                    return new Configuration_1.Configuration(Utils_1.Utils.mergeConfig(tmp, options, env), false);
+                })();
             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' });
             }
@@ -32,63 +48,71 @@ class ConfigurationLoader {
         const isValidConfigFactoryResult = (cfg) => {
             return typeof cfg === 'object' && cfg !== null && (!('contextName' in cfg) || cfg.contextName === contextName);
         };
+        const result = await this.getConfigFile(paths);
+        if (!result[0]) {
+            if (Utils_1.Utils.hasObjectKeys(env)) {
+                return new Configuration_1.Configuration(Utils_1.Utils.mergeConfig({ contextName }, options, env));
+            }
+            throw new Error(`MikroORM config file not found in ['${paths.join(`', '`)}']`);
+        }
+        const path = result[0];
+        let tmp = result[1];
+        if (Array.isArray(tmp)) {
+            const tmpFirstIndex = tmp.findIndex(configFinder);
+            if (tmpFirstIndex === -1) {
+                // Static config not found. Try factory functions
+                let configCandidate;
+                for (let i = 0, l = tmp.length; i < l; ++i) {
+                    const f = tmp[i];
+                    if (typeof f !== 'function') {
+                        continue;
+                    }
+                    configCandidate = await f(contextName);
+                    if (!isValidConfigFactoryResult(configCandidate)) {
+                        continue;
+                    }
+                    tmp = configCandidate;
+                    break;
+                }
+                if (Array.isArray(tmp)) {
+                    throw new Error(`MikroORM config '${contextName}' was not found within the config file '${path}'. Either add a config with this name to the array, or add a function that when given this name will return a configuration object without a name, or with name set to this name.`);
+                }
+            }
+            else {
+                const tmpLastIndex = tmp.findLastIndex(configFinder);
+                if (tmpLastIndex !== tmpFirstIndex) {
+                    throw new Error(`MikroORM config '${contextName}' is not unique within the array exported by '${path}' (first occurrence index: ${tmpFirstIndex}; last occurrence index: ${tmpLastIndex})`);
+                }
+                tmp = tmp[tmpFirstIndex];
+            }
+        }
+        else {
+            if (tmp instanceof Function) {
+                tmp = await tmp(contextName);
+                if (!isValidConfigFactoryResult(tmp)) {
+                    throw new Error(`MikroORM config '${contextName}' was not what the function exported from '${path}' provided. Ensure it returns a config object with no name, or name matching the requested one.`);
+                }
+            }
+            else {
+                if (!configFinder(tmp)) {
+                    throw new Error(`MikroORM config '${contextName}' was not what the default export from '${path}' provided.`);
+                }
+            }
+        }
+        const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {};
+        return new Configuration_1.Configuration(Utils_1.Utils.mergeConfig({}, esmConfigOptions, tmp, options, env));
+    }
+    static async getConfigFile(paths) {
         for (let path of paths) {
             path = Utils_1.Utils.absolutePath(path);
             path = Utils_1.Utils.normalizePath(path);
             if ((0, fs_extra_1.pathExistsSync)(path)) {
                 const config = await Utils_1.Utils.dynamicImport(path);
                 /* istanbul ignore next */
-                let tmp = await (config.default ?? config);
-                if (Array.isArray(tmp)) {
-                    const tmpFirstIndex = tmp.findIndex(configFinder);
-                    if (tmpFirstIndex === -1) {
-                        // Static config not found. Try factory functions
-                        let configCandidate;
-                        for (let i = 0, l = tmp.length; i < l; ++i) {
-                            const f = tmp[i];
-                            if (typeof f !== 'function') {
-                                continue;
-                            }
-                            configCandidate = await f(contextName);
-                            if (!isValidConfigFactoryResult(configCandidate)) {
-                                continue;
-                            }
-                            tmp = configCandidate;
-                            break;
-                        }
-                        if (Array.isArray(tmp)) {
-                            throw new Error(`MikroORM config '${contextName}' was not found within the config file '${path}'. Either add a config with this name to the array, or add a function that when given this name will return a configuration object without a name, or with name set to this name.`);
-                        }
-                    }
-                    else {
-                        const tmpLastIndex = tmp.findLastIndex(configFinder);
-                        if (tmpLastIndex !== tmpFirstIndex) {
-                            throw new Error(`MikroORM config '${contextName}' is not unique within the array exported by '${path}' (first occurrence index: ${tmpFirstIndex}; last occurrence index: ${tmpLastIndex})`);
-                        }
-                        tmp = tmp[tmpFirstIndex];
-                    }
-                }
-                else {
-                    if (tmp instanceof Function) {
-                        tmp = await tmp(contextName);
-                        if (!isValidConfigFactoryResult(tmp)) {
-                            throw new Error(`MikroORM config '${contextName}' was not what the function exported from '${path}' provided. Ensure it returns a config object with no name, or name matching the requested one.`);
-                        }
-                    }
-                    else {
-                        if (!configFinder(tmp)) {
-                            throw new Error(`MikroORM config '${contextName}' was not what the default export from '${path}' provided.`);
-                        }
-                    }
-                }
-                const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {};
-                return new Configuration_1.Configuration(Utils_1.Utils.mergeConfig({}, esmConfigOptions, tmp, options, env));
+                return [path, await (config.default ?? config)];
             }
         }
-        if (Utils_1.Utils.hasObjectKeys(env)) {
-            return new Configuration_1.Configuration(Utils_1.Utils.mergeConfig({ contextName }, options, env));
-        }
-        throw new Error(`MikroORM config file not found in ['${paths.join(`', '`)}']`);
+        return [];
     }
     static getPackageConfig(basePath = process.cwd()) {
         if ((0, fs_extra_1.pathExistsSync)(`${basePath}/package.json`)) {