@mikro-orm/core 7.0.0-dev.9 → 7.0.0-dev.90

package/utils/Configuration.js

@@ -1,137 +1,132 @@
-import { FileCacheAdapter } from '../cache/FileCacheAdapter.js';
 import { NullCacheAdapter } from '../cache/NullCacheAdapter.js';
 import { ObjectHydrator } from '../hydration/ObjectHydrator.js';
 import { NullHighlighter } from '../utils/NullHighlighter.js';
 import { DefaultLogger } from '../logging/DefaultLogger.js';
 import { colors } from '../logging/colors.js';
 import { Utils } from '../utils/Utils.js';
-import { ReflectMetadataProvider } from '../metadata/ReflectMetadataProvider.js';
+import { MetadataProvider } from '../metadata/MetadataProvider.js';
 import { NotFoundError } from '../errors.js';
 import { RequestContext } from './RequestContext.js';
 import { DataloaderType, FlushMode, LoadStrategy, PopulateHint } from '../enums.js';
 import { MemoryCacheAdapter } from '../cache/MemoryCacheAdapter.js';
 import { EntityComparator } from './EntityComparator.js';
+const DEFAULTS = {
+    pool: {},
+    entities: [],
+    entitiesTs: [],
+    extensions: [],
+    subscribers: [],
+    filters: {},
+    discovery: {
+        warnWhenNoEntities: true,
+        checkDuplicateTableNames: true,
+        checkDuplicateFieldNames: true,
+        checkDuplicateEntities: true,
+        checkNonPersistentCompositeProps: true,
+        inferDefaultValues: true,
+    },
+    validateRequired: true,
+    context: (name) => RequestContext.getEntityManager(name),
+    contextName: 'default',
+    allowGlobalContext: false,
+    // eslint-disable-next-line no-console
+    logger: console.log.bind(console),
+    colors: true,
+    findOneOrFailHandler: (entityName, where) => NotFoundError.findOneFailed(entityName, where),
+    findExactlyOneOrFailHandler: (entityName, where) => NotFoundError.findExactlyOneFailed(entityName, where),
+    baseDir: process.cwd(),
+    hydrator: ObjectHydrator,
+    flushMode: FlushMode.AUTO,
+    loadStrategy: LoadStrategy.BALANCED,
+    dataloader: DataloaderType.NONE,
+    populateWhere: PopulateHint.ALL,
+    ignoreUndefinedInQuery: false,
+    onQuery: (sql) => sql,
+    autoJoinOneToOneOwner: true,
+    autoJoinRefsForFilters: true,
+    filtersOnRelations: true,
+    propagationOnPrototype: true,
+    populateAfterFlush: true,
+    serialization: {
+        includePrimaryKeys: true,
+    },
+    assign: {
+        updateNestedEntities: true,
+        updateByPrimaryKey: true,
+        mergeObjectProperties: false,
+        mergeEmbeddedProperties: true,
+        ignoreUndefined: false,
+    },
+    persistOnCreate: true,
+    upsertManaged: true,
+    forceEntityConstructor: false,
+    forceUndefined: false,
+    processOnCreateHooksEarly: true,
+    ensureDatabase: true,
+    ensureIndexes: false,
+    batchSize: 300,
+    debug: false,
+    ignoreDeprecations: false,
+    verbose: false,
+    driverOptions: {},
+    migrations: {
+        tableName: 'mikro_orm_migrations',
+        glob: '!(*.d).{js,ts,cjs}',
+        silent: false,
+        transactional: true,
+        disableForeignKeys: false,
+        allOrNothing: true,
+        dropTables: true,
+        safe: false,
+        snapshot: true,
+        emit: 'ts',
+        fileName: (timestamp, name) => `Migration${timestamp}${name ? '_' + name : ''}`,
+    },
+    schemaGenerator: {
+        disableForeignKeys: false,
+        createForeignKeyConstraints: true,
+        ignoreSchema: [],
+        skipTables: [],
+        skipColumns: {},
+    },
+    embeddables: {
+        prefixMode: 'relative',
+    },
+    entityGenerator: {
+        forceUndefined: true,
+        undefinedDefaults: false,
+        scalarTypeInDecorator: false,
+        bidirectionalRelations: true,
+        identifiedReferences: true,
+        scalarPropertiesForRelations: 'never',
+        entityDefinition: 'defineEntity',
+        decorators: 'legacy',
+        enumMode: 'dictionary',
+        /* v8 ignore next */
+        fileName: (className) => className,
+        onlyPurePivotTables: false,
+        outputPurePivotTables: false,
+        readOnlyPivotTables: false,
+        useCoreBaseEntity: false,
+    },
+    metadataCache: {},
+    resultCache: {
+        adapter: MemoryCacheAdapter,
+        expiration: 1000, // 1s
+        options: {},
+    },
+    metadataProvider: MetadataProvider,
+    highlighter: new NullHighlighter(),
+    seeder: {
+        defaultSeeder: 'DatabaseSeeder',
+        glob: '!(*.d).{js,ts}',
+        emit: 'ts',
+        fileName: (className) => className,
+    },
+    preferReadReplicas: true,
+    dynamicImportProvider: /* v8 ignore next */ (id) => import(id),
+};
 export class Configuration {
-    static DEFAULTS = {
-        pool: {},
-        entities: [],
-        entitiesTs: [],
-        extensions: [],
-        subscribers: [],
-        filters: {},
-        discovery: {
-            warnWhenNoEntities: true,
-            requireEntitiesArray: false,
-            checkDuplicateTableNames: true,
-            checkDuplicateFieldNames: true,
-            checkDuplicateEntities: true,
-            checkNonPersistentCompositeProps: true,
-            alwaysAnalyseProperties: true,
-            disableDynamicFileAccess: false,
-            inferDefaultValues: true,
-        },
-        strict: false,
-        validate: false,
-        validateRequired: true,
-        context: (name) => RequestContext.getEntityManager(name),
-        contextName: 'default',
-        allowGlobalContext: false,
-        // eslint-disable-next-line no-console
-        logger: console.log.bind(console),
-        colors: true,
-        findOneOrFailHandler: (entityName, where) => NotFoundError.findOneFailed(entityName, where),
-        findExactlyOneOrFailHandler: (entityName, where) => NotFoundError.findExactlyOneFailed(entityName, where),
-        baseDir: process.cwd(),
-        hydrator: ObjectHydrator,
-        flushMode: FlushMode.AUTO,
-        loadStrategy: LoadStrategy.JOINED,
-        dataloader: DataloaderType.NONE,
-        populateWhere: PopulateHint.ALL,
-        connect: true,
-        ignoreUndefinedInQuery: false,
-        onQuery: sql => sql,
-        autoJoinOneToOneOwner: true,
-        autoJoinRefsForFilters: true,
-        propagationOnPrototype: true,
-        populateAfterFlush: true,
-        serialization: {
-            includePrimaryKeys: true,
-        },
-        assign: {
-            updateNestedEntities: true,
-            updateByPrimaryKey: true,
-            mergeObjectProperties: false,
-            mergeEmbeddedProperties: true,
-            ignoreUndefined: false,
-        },
-        persistOnCreate: true,
-        upsertManaged: true,
-        forceEntityConstructor: false,
-        forceUndefined: false,
-        ensureDatabase: true,
-        ensureIndexes: false,
-        batchSize: 300,
-        debug: false,
-        ignoreDeprecations: false,
-        verbose: false,
-        driverOptions: {},
-        migrations: {
-            tableName: 'mikro_orm_migrations',
-            path: './migrations',
-            glob: '!(*.d).{js,ts,cjs}',
-            silent: false,
-            transactional: true,
-            disableForeignKeys: false,
-            allOrNothing: true,
-            dropTables: true,
-            safe: false,
-            snapshot: true,
-            emit: 'ts',
-            fileName: (timestamp, name) => `Migration${timestamp}${name ? '_' + name : ''}`,
-        },
-        schemaGenerator: {
-            disableForeignKeys: false,
-            createForeignKeyConstraints: true,
-            ignoreSchema: [],
-        },
-        embeddables: {
-            prefixMode: 'absolute',
-        },
-        entityGenerator: {
-            forceUndefined: true,
-            undefinedDefaults: false,
-            bidirectionalRelations: false,
-            identifiedReferences: false,
-            scalarTypeInDecorator: false,
-            scalarPropertiesForRelations: 'never',
-            fileName: (className) => className,
-            onlyPurePivotTables: false,
-            outputPurePivotTables: false,
-            readOnlyPivotTables: false,
-            useCoreBaseEntity: false,
-        },
-        metadataCache: {
-            pretty: false,
-            adapter: FileCacheAdapter,
-            options: { cacheDir: process.cwd() + '/temp' },
-        },
-        resultCache: {
-            adapter: MemoryCacheAdapter,
-            expiration: 1000, // 1s
-            options: {},
-        },
-        metadataProvider: ReflectMetadataProvider,
-        highlighter: new NullHighlighter(),
-        seeder: {
-            path: './seeders',
-            defaultSeeder: 'DatabaseSeeder',
-            glob: '!(*.d).{js,ts}',
-            emit: 'ts',
-            fileName: (className) => className,
-        },
-        preferReadReplicas: true,
-        dynamicImportProvider: /* v8 ignore next */ (id) => import(id),
-    };
     options;
     logger;
     driver;
@@ -140,11 +135,10 @@ export class Configuration {
     extensions = new Map();
     constructor(options, validate = true) {
         if (options.dynamicImportProvider) {
-            Utils.setDynamicImportProvider(options.dynamicImportProvider);
+            Utils.dynamicImportProvider = options.dynamicImportProvider;
         }
-        this.options = Utils.mergeConfig({}, Configuration.DEFAULTS, options);
+        this.options = Utils.mergeConfig({}, DEFAULTS, options);
         this.options.baseDir = Utils.absolutePath(this.options.baseDir);
-        this.options.preferTs ??= options.preferTs;
         if (validate) {
             this.validateOptions();
         }
@@ -160,7 +154,6 @@ export class Configuration {
             this.driver = new this.options.driver(this);
             this.platform = this.driver.getPlatform();
             this.platform.setConfig(this);
-            this.detectSourceFolder(options);
             this.init(validate);
         }
     }
@@ -190,7 +183,7 @@ export class Configuration {
      * Resets the configuration to its default value
      */
     reset(key) {
-        this.options[key] = Configuration.DEFAULTS[key];
+        this.options[key] = DEFAULTS[key];
     }
     /**
      * Gets Logger instance.
@@ -204,15 +197,6 @@ export class Configuration {
         }
         return this.options.dataloader;
     }
-    /**
-     * Gets current client URL (connection string).
-     */
-    getClientUrl(hidePassword = false) {
-        if (hidePassword) {
-            return this.options.clientUrl.replace(/\/\/([^:]+):(.+)@/, '//$1:*****@');
-        }
-        return this.options.clientUrl;
-    }
     getSchema(skipDefaultSchema = false) {
         if (skipDefaultSchema && this.options.schema === this.platform.getDefaultSchemaName()) {
             return undefined;
@@ -233,7 +217,7 @@ export class Configuration {
             return this.cache.get(name);
         }
         const ext = this.extensions.get(name);
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!ext) {
             return undefined;
         }
@@ -293,8 +277,7 @@ export class Configuration {
      */
     getCachedService(cls, ...args) {
         if (!this.cache.has(cls.name)) {
-            const Class = cls;
-            this.cache.set(cls.name, new Class(...args));
+            this.cache.set(cls.name, new cls(...args));
         }
         return this.cache.get(cls.name);
     }
@@ -302,26 +285,25 @@ export class Configuration {
         this.cache.clear();
     }
     init(validate) {
-        if (!this.getMetadataProvider().useCache()) {
-            this.options.metadataCache.adapter = NullCacheAdapter;
+        const useCache = this.getMetadataProvider().useCache();
+        const metadataCache = this.options.metadataCache;
+        if (!useCache) {
+            metadataCache.adapter = NullCacheAdapter;
         }
-        if (!('enabled' in this.options.metadataCache)) {
-            this.options.metadataCache.enabled = this.getMetadataProvider().useCache();
-        }
-        if (!this.options.clientUrl) {
-            this.options.clientUrl = this.platform.getDefaultClientUrl();
-        }
-        if (!('implicitTransactions' in this.options)) {
-            this.options.implicitTransactions = this.platform.usesImplicitTransactions();
+        metadataCache.enabled ??= useCache;
+        this.options.clientUrl ??= this.platform.getDefaultClientUrl();
+        this.options.implicitTransactions ??= this.platform.usesImplicitTransactions();
+        if (metadataCache.enabled && !metadataCache.adapter) {
+            throw new Error('No metadata cache adapter specified, please fill in `metadataCache.adapter` option or use the async MikroORM.init() method which can autoload it.');
         }
         try {
-            const url = new URL(this.getClientUrl());
+            const url = new URL(this.options.clientUrl);
             if (url.pathname) {
                 this.options.dbName = this.get('dbName', decodeURIComponent(url.pathname).substring(1));
             }
         }
         catch {
-            const url = this.getClientUrl().match(/:\/\/.*\/([^?]+)/);
+            const url = this.options.clientUrl.match(/:\/\/.*\/([^?]+)/);
             if (url) {
                 this.options.dbName = this.get('dbName', decodeURIComponent(url[1]));
             }
@@ -329,16 +311,15 @@ export class Configuration {
         if (validate && !this.options.dbName && this.options.clientUrl) {
             throw new Error("No database specified, `clientUrl` option provided but it's missing the pathname.");
         }
-        if (!this.options.schema) {
-            this.options.schema = this.platform.getDefaultSchemaName();
-        }
-        if (!this.options.charset) {
-            this.options.charset = this.platform.getDefaultCharset();
-        }
+        this.options.schema ??= this.platform.getDefaultSchemaName();
+        this.options.charset ??= this.platform.getDefaultCharset();
         Object.keys(this.options.filters).forEach(key => {
             this.options.filters[key].default ??= true;
         });
-        this.options.subscribers = Utils.unique(this.options.subscribers).map(subscriber => {
+        if (!this.options.filtersOnRelations) {
+            this.options.autoJoinRefsForFilters ??= false;
+        }
+        this.options.subscribers = [...this.options.subscribers].map(subscriber => {
             return subscriber.constructor.name === 'Function' ? new subscriber() : subscriber;
         });
         this.sync();
@@ -350,37 +331,8 @@ export class Configuration {
         process.env.MIKRO_ORM_COLORS = '' + this.options.colors;
         this.logger.setDebugMode(this.options.debug);
     }
-    /**
-     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
-     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
-     * used for the TS variant (`pathTs` option).
-     *
-     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
-     * break existing projects, only help with the new ones.
-     */
-    detectSourceFolder(options) {
-        if (!Utils.pathExistsSync(this.options.baseDir + '/src')) {
-            return;
-        }
-        const migrationsPathExists = Utils.pathExistsSync(this.options.baseDir + '/' + this.options.migrations.path);
-        const seedersPathExists = Utils.pathExistsSync(this.options.baseDir + '/' + this.options.seeder.path);
-        const distDir = Utils.pathExistsSync(this.options.baseDir + '/dist');
-        const buildDir = Utils.pathExistsSync(this.options.baseDir + '/build');
-        // if neither `dist` nor `build` exist, we use the `src` folder as it might be a JS project without building, but with `src` folder
-        const path = distDir ? './dist' : (buildDir ? './build' : './src');
-        // only if the user did not provide any values and if the default path does not exist
-        if (!options.migrations?.path && !options.migrations?.pathTs && !migrationsPathExists) {
-            this.options.migrations.path = `${path}/migrations`;
-            this.options.migrations.pathTs = './src/migrations';
-        }
-        // only if the user did not provide any values and if the default path does not exist
-        if (!options.seeder?.path && !options.seeder?.pathTs && !seedersPathExists) {
-            this.options.seeder.path = `${path}/seeders`;
-            this.options.seeder.pathTs = './src/seeders';
-        }
-    }
     validateOptions() {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if ('type' in this.options) {
             throw new Error('The `type` option has been removed in v6, please fill in the `driver` option instead or use `defineConfig` helper (to define your ORM config) or `MikroORM` class (to call the `init` method) exported from the driver package (e.g. `import { defineConfig } from \'@mikro-orm/mysql\'; export default defineConfig({ ... })`).');
         }

package/utils/ConfigurationLoader.d.ts

@@ -1,54 +1 @@
-import type { EntityManager } from '../EntityManager.js';
-import type { EntityManagerType, IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
-import type { Dictionary } from '../typings.js';
-import { Configuration, type Options } from './Configuration.js';
-/**
- * @internal
- */
-export declare class ConfigurationLoader {
-    /**
-     * Gets a named configuration
-     *
-     * @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>>;
-    /**
-     * Gets the default config from the default paths
-     *
-     * @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>(): Promise<Configuration<D, EM>>;
-    /**
-     * Gets default configuration out of the default paths, and possibly from `process.argv`
-     *
-     * @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 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: 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;
-    static getConfigPaths(): string[];
-    static isESM(): boolean;
-    static registerTypeScriptSupport(configPath?: string): Promise<boolean>;
-    static registerDotenv<D extends IDatabaseDriver>(options?: Options<D>): void;
-    static loadEnvironmentVars<D extends IDatabaseDriver>(): Promise<Partial<Options<D>>>;
-    static loadEnvironmentVarsSync<D extends IDatabaseDriver>(): Partial<Options<D>>;
-    static getORMPackages(): Set<string>;
-    /** @internal */
-    static commonJSCompat(options: Partial<Options>): void;
-    static getORMPackageVersion(name: string): string | undefined;
-    static checkPackageVersion(): string;
-}
-export interface Settings {
-    alwaysAllowTs?: boolean;
-    verbose?: boolean;
-    preferTs?: boolean;
-    tsConfigPath?: string;
-    configPaths?: string[];
-}
+export {};