@mikro-orm/cli 7.1.4-dev.7 → 7.1.4-dev.9

package/CLIHelper.js

@@ -4,6 +4,7 @@ import { fileURLToPath, pathToFileURL } from 'node:url';
 import yargs from 'yargs';
 import { colors, Configuration, loadEnvironmentVars, loadOptionalDependencies, MikroORM, Utils, } from '@mikro-orm/core';
 import { fs } from '@mikro-orm/core/fs-utils';
+import { searchConfiguration } from './searchConfiguration.js';
 /**
  * @internal
  */
@@ -24,13 +25,6 @@ export class CLIHelper {
         }
         contextName ??= process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default';
         const env = await this.loadEnvironmentVars();
-        // oxfmt-ignore
-        const configFinder = (cfg) => {
-            return typeof cfg === 'object' && cfg !== null && ('contextName' in cfg ? cfg.contextName === contextName : contextName === 'default');
-        };
-        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.hasObjectKeys(env)) {
@@ -40,50 +34,8 @@ export class CLIHelper {
             }
             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 [path, configExports] = result;
+        const tmp = await searchConfiguration(configExports, contextName, path);
         const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {};
         await loadOptionalDependencies(tmp);
         const preferEnvVars = options.preferEnvVars ?? tmp.preferEnvVars;

package/index.d.ts

@@ -4,3 +4,4 @@
  */
 export * from './CLIHelper.js';
 export * from './CLIConfigurator.js';
+export * from './searchConfiguration.js';

package/index.js

@@ -4,3 +4,4 @@
  */
 export * from './CLIHelper.js';
 export * from './CLIConfigurator.js';
+export * from './searchConfiguration.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/cli",
-  "version": "7.1.4-dev.7",
+  "version": "7.1.4-dev.9",
   "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.",
   "keywords": [
     "data-mapper",
@@ -50,8 +50,8 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/core": "7.1.4-dev.7",
-    "mikro-orm": "7.1.4-dev.7",
+    "@mikro-orm/core": "7.1.4-dev.9",
+    "mikro-orm": "7.1.4-dev.9",
     "yargs": "17.7.2"
   },
   "engines": {

package/searchConfiguration.d.ts

@@ -0,0 +1,12 @@
+import { type AnyEntity, type EntityClass, type EntityManager, type EntityManagerType, type EntitySchema, type IDatabaseDriver, type Options } from '@mikro-orm/core';
+/**
+ * Search a config file for a given contextName.
+ *
+ * @param configExports The exports from a config file. Importing is left to the caller.
+ * @param contextName The context name to search the config for.
+ * @param path Path to display in error messages. Callers can use this to match the path the exports were imported from.
+ *
+ * @return A promise that resolves with The matching configuration options, as defined in the configExports.
+ * The caller is responsible for further adjustments or dependency imports.
+ */
+export declare function searchConfiguration<Driver extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<Driver> & Driver[typeof EntityManagerType] = EntityManager<Driver> & Driver[typeof EntityManagerType], Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(configExports: unknown, contextName?: string, path?: string): Promise<Options<Driver, EM, Entities>>;

package/searchConfiguration.js

@@ -0,0 +1,63 @@
+/**
+ * Search a config file for a given contextName.
+ *
+ * @param configExports The exports from a config file. Importing is left to the caller.
+ * @param contextName The context name to search the config for.
+ * @param path Path to display in error messages. Callers can use this to match the path the exports were imported from.
+ *
+ * @return A promise that resolves with The matching configuration options, as defined in the configExports.
+ * The caller is responsible for further adjustments or dependency imports.
+ */
+export async function searchConfiguration(configExports, contextName = 'default', path = '') {
+    let tmp = configExports;
+    // oxfmt-ignore
+    const configFinder = (cfg) => {
+        return typeof cfg === 'object' && cfg !== null && ('contextName' in cfg ? cfg.contextName === contextName : contextName === 'default');
+    };
+    const isValidConfigFactoryResult = (cfg) => {
+        return typeof cfg === 'object' && cfg !== null && (!('contextName' in cfg) || cfg.contextName === contextName);
+    };
+    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.`);
+            }
+        }
+    }
+    return tmp;
+}