@mikro-orm/core 7.0.0-dev.76 → 7.0.0-dev.78

package/metadata/MetadataProvider.js

@@ -22,14 +22,41 @@ export class MetadataProvider {
     loadFromCache(meta, cache) {
         Object.values(cache.properties).forEach(prop => {
             const metaProp = meta.properties[prop.name];
-            /* v8 ignore next 3 */
+            /* v8 ignore next */
             if (metaProp?.enum && Array.isArray(metaProp.items)) {
                 delete prop.items;
             }
         });
         Utils.mergeConfig(meta, cache);
     }
+    static useCache() {
+        return false;
+    }
     useCache() {
-        return this.config.get('metadataCache').enabled ?? false;
+        return this.config.get('metadataCache').enabled ?? MetadataProvider.useCache();
+    }
+    saveToCache(meta) {
+        //
+    }
+    getCachedMetadata(meta, root) {
+        if (!this.useCache()) {
+            return undefined;
+        }
+        const cache = meta.path && this.config.getMetadataCacheAdapter().get(this.getCacheKey(meta));
+        if (cache) {
+            this.loadFromCache(meta, cache);
+            meta.root = root;
+        }
+        return cache;
+    }
+    combineCache() {
+        const path = this.config.getMetadataCacheAdapter().combine?.();
+        // override the path in the options, so we can log it from the CLI in `cache:generate` command
+        if (path) {
+            this.config.get('metadataCache').combined = path;
+        }
+    }
+    getCacheKey(meta) {
+        return meta.className;
     }
 }

package/metadata/discover-entities.js

@@ -1,4 +1,5 @@
 import { basename } from 'node:path';
+import { fs } from '../utils/fs-utils.js';
 import { Utils } from '../utils/Utils.js';
 import { MetadataStorage } from './MetadataStorage.js';
 import { EntitySchema } from './EntitySchema.js';
@@ -26,7 +27,7 @@ async function getEntityClassOrSchema(filepath, allTargets, baseDir) {
 export async function discoverEntities(paths, options) {
     paths = Utils.asArray(paths).map(path => Utils.normalizePath(path));
     const baseDir = options?.baseDir ?? process.cwd();
-    const files = Utils.glob(paths, Utils.normalizePath(baseDir));
+    const files = fs.glob(paths, Utils.normalizePath(baseDir));
     const found = new Map();
     for (const filepath of files) {
         const filename = basename(filepath);

package/naming-strategy/AbstractNamingStrategy.js

@@ -14,7 +14,7 @@ export class AbstractNamingStrategy {
         return migrationName;
     }
     indexName(tableName, columns, type) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (tableName.includes('.')) {
             tableName = tableName.substring(tableName.indexOf('.') + 1);
         }

package/not-supported.d.ts

@@ -1 +1,2 @@
 export declare function discoverEntities(): void;
+export declare const fs: {};

package/not-supported.js

@@ -1,3 +1,4 @@
 export function discoverEntities() {
-    throw new Error('File discovery is not supported in this environment.');
+    throw new Error('Folder-based discovery is not supported in this environment.');
 }
+export const fs = new Proxy({}, { get: () => { throw new Error('File system is not supported in this environment.'); } });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.76",
+  "version": "7.0.0-dev.78",
   "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",
@@ -9,6 +9,10 @@
     "./file-discovery": {
       "node": "./metadata/discover-entities.js",
       "browser": "./not-supported.js"
+    },
+    "./fs-utils": {
+      "node": "./utils/fs-utils.js",
+      "browser": "./not-supported.js"
     }
   },
   "repository": {

package/platforms/ExceptionConverter.js

@@ -1,6 +1,6 @@
 import { DriverException } from '../exceptions.js';
 export class ExceptionConverter {
-    /* v8 ignore next 3 */
+    /* v8 ignore next */
     convertException(exception) {
         return new DriverException(exception);
     }

package/platforms/Platform.js

@@ -4,7 +4,7 @@ import { EntityRepository } from '../entity/EntityRepository.js';
 import { UnderscoreNamingStrategy } from '../naming-strategy/UnderscoreNamingStrategy.js';
 import { ExceptionConverter } from './ExceptionConverter.js';
 import { ArrayType, BigIntType, BlobType, BooleanType, CharacterType, DateTimeType, DateType, DecimalType, DoubleType, EnumType, FloatType, IntegerType, IntervalType, JsonType, MediumIntType, SmallIntType, StringType, TextType, TimeType, TinyIntType, Type, Uint8ArrayType, UnknownType, UuidType, } from '../types/index.js';
-import { parseJsonSafe, Utils } from '../utils/Utils.js';
+import { parseJsonSafe } from '../utils/Utils.js';
 import { ReferenceKind } from '../enums.js';
 import { RawQueryFragment } from '../utils/RawQueryFragment.js';
 export const JsonProperty = Symbol('JsonProperty');
@@ -257,7 +257,7 @@ export class Platform {
     getSearchJsonPropertyKey(path, type, aliased, value) {
         return path.join('.');
     }
-    /* v8 ignore next 3 */
+    /* v8 ignore next */
     getJsonIndexDefinition(index) {
         return index.columnNames;
     }
@@ -290,7 +290,7 @@ export class Platform {
     }
     parseDate(value) {
         const date = new Date(value);
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (isNaN(date.getTime())) {
             return value;
         }
@@ -320,19 +320,10 @@ export class Platform {
         if (extension) {
             return extension;
         }
-        /* v8 ignore next 4 */
-        const module = Utils.tryRequire({
-            module: moduleName,
-            warning: `Please install ${moduleName} package.`,
-        });
-        /* v8 ignore next 3 */
-        if (module) {
-            return this.config.getCachedService(module[extensionName], em);
-        }
-        /* v8 ignore next 2 */
-        throw new Error(`${extensionName} extension not registered.`);
+        /* v8 ignore next */
+        throw new Error(`${extensionName} extension not registered. Provide it in the ORM config, or use the async \`MikroORM.init()\` method to load extensions automatically.`);
     }
-    /* v8 ignore next 3: kept for type inference only */
+    /* v8 ignore next: kept for type inference only */
     getSchemaGenerator(driver, em) {
         throw new Error(`${driver.constructor.name} does not support SchemaGenerator`);
     }
@@ -349,7 +340,7 @@ export class Platform {
     quoteValue(value) {
         return value;
     }
-    /* v8 ignore next 3 */
+    /* v8 ignore next */
     escape(value) {
         return value;
     }
@@ -506,8 +497,8 @@ export class Platform {
     clone() {
         return this;
     }
-    /* v8 ignore next 4 */
     /** @ignore */
+    /* v8 ignore next */
     [inspect.custom]() {
         return `[${this.constructor.name}]`;
     }

package/serialization/EntitySerializer.js

@@ -113,7 +113,7 @@ export class EntitySerializer {
         return ret;
     }
     static propertyName(meta, prop) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (meta.properties[prop]?.serializedName) {
             return meta.properties[prop].serializedName;
         }
@@ -137,7 +137,7 @@ export class EntitySerializer {
             }
             return returnValue;
         }
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!options.ignoreSerializers && serializer) {
             return serializer(value);
         }
@@ -150,7 +150,7 @@ export class EntitySerializer {
         if (Utils.isScalarReference(value)) {
             return value.unwrap();
         }
-        /* v8 ignore next 9 */
+        /* v8 ignore next */
         if (property?.kind === ReferenceKind.EMBEDDED) {
             if (Array.isArray(value)) {
                 return value.map(item => helper(item).toJSON());

package/serialization/SerializationContext.js

@@ -36,7 +36,7 @@ export class SerializationContext {
     }
     leave(entityName, prop) {
         const last = this.path.pop();
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (last?.[0] !== entityName || last[1] !== prop) {
             throw new Error(`Trying to leave wrong property: ${entityName}.${prop} instead of ${last?.join('.')}`);
         }
@@ -98,7 +98,7 @@ export class SerializationContext {
         }
         let fields = [...this.fields];
         for (const segment of this.path) {
-            /* v8 ignore next 3 */
+            /* v8 ignore next */
             if (fields.length === 0) {
                 return true;
             }

package/types/ArrayType.js

@@ -15,7 +15,7 @@ export class ArrayType extends Type {
         if (Array.isArray(value)) {
             return platform.marshallArray(value.map(i => this.toDbValue(i)));
         }
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (context?.fromQuery) {
             return value;
         }

package/types/BigIntType.js

@@ -16,7 +16,7 @@ export class BigIntType extends Type {
         return '' + value;
     }
     convertToJSValue(value) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (value == null) {
             return value;
         }

package/types/DecimalType.js

@@ -8,7 +8,7 @@ export class DecimalType extends Type {
         super();
         this.mode = mode;
     }
-    /* v8 ignore next 7 */
+    /* v8 ignore next */
     convertToJSValue(value) {
         if ((this.mode ?? this.prop?.runtimeType) === 'number') {
             return +value;
@@ -19,7 +19,7 @@ export class DecimalType extends Type {
         return this.format(a) === this.format(b);
     }
     format(val) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (this.prop?.scale == null) {
             return +val;
         }

package/types/DoubleType.js

@@ -3,7 +3,7 @@ import { Type } from './Type.js';
  * Type that maps an SQL DOUBLE to a JS string or number.
  */
 export class DoubleType extends Type {
-    /* v8 ignore next 7 */
+    /* v8 ignore next */
     convertToJSValue(value) {
         if (this.prop?.runtimeType === 'number') {
             return +value;

package/types/TinyIntType.js

@@ -6,7 +6,7 @@ export class TinyIntType extends Type {
     compareAsType() {
         return 'number';
     }
-    /* v8 ignore next 3 */
+    /* v8 ignore next */
     ensureComparable() {
         return false;
     }

package/types/Uint8ArrayType.js

@@ -7,7 +7,7 @@ export class Uint8ArrayType extends Type {
         return Buffer.from(value);
     }
     convertToJSValue(value) {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!value) {
             return value;
         }

package/typings.js

@@ -32,7 +32,7 @@ export class EntityMetadata {
         }
         this.properties[prop.name] = prop;
         this.propertyOrder.set(prop.name, this.props.length);
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (sync) {
             this.sync();
         }
@@ -40,7 +40,7 @@ export class EntityMetadata {
     removeProperty(name, sync = true) {
         delete this.properties[name];
         this.propertyOrder.delete(name);
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (sync) {
             this.sync();
         }
@@ -181,7 +181,7 @@ export class EntityMetadata {
             this.indexes.push({ properties: prop.name });
             prop.index = false;
         }
-        /* v8 ignore next 4 */
+        /* v8 ignore next */
         if (owner && prop.fieldNames.length > 1 && prop.unique) {
             this.uniques.push({ properties: prop.name });
             prop.unique = false;

package/unit-of-work/UnitOfWork.js

@@ -435,7 +435,7 @@ export class UnitOfWork {
         }
         for (const entity of this.removeStack) {
             const wrapped = helper(entity);
-            /* v8 ignore next 3 */
+            /* v8 ignore next */
             if (wrapped.__processing) {
                 continue;
             }

package/utils/AbstractSchemaGenerator.js

@@ -47,7 +47,7 @@ export class AbstractSchemaGenerator {
         }
     }
     clearIdentityMap() {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!this.em) {
             return;
         }

package/utils/Configuration.d.ts

@@ -1,5 +1,4 @@
 import type { NamingStrategy } from '../naming-strategy/NamingStrategy.js';
-import { FileCacheAdapter } from '../cache/FileCacheAdapter.js';
 import { type CacheAdapter, type SyncCacheAdapter } from '../cache/CacheAdapter.js';
 import type { EntityRepository } from '../entity/EntityRepository.js';
 import type { AnyEntity, Constructor, Dictionary, EnsureDatabaseOptions, EntityClass, EntityMetadata, FilterDef, GenerateOptions, Highlighter, HydratorConstructor, IHydrator, IMigrationGenerator, IPrimaryKey, MaybePromise, Migration, MigrationObject } from '../typings.js';
@@ -35,10 +34,8 @@ declare const DEFAULTS: {
         readonly checkNonPersistentCompositeProps: true;
         readonly inferDefaultValues: true;
     };
-    readonly strict: false;
-    readonly validate: false;
     readonly validateRequired: true;
-    readonly context: (name: string) => EntityManager<IDatabaseDriver<import("../index.js").Connection>> | undefined;
+    readonly context: (name: string) => EntityManager<IDatabaseDriver<import("@mikro-orm/knex").Connection>> | undefined;
     readonly contextName: "default";
     readonly allowGlobalContext: false;
     readonly logger: (message?: any, ...optionalParams: any[]) => void;
@@ -82,7 +79,6 @@ declare const DEFAULTS: {
     readonly driverOptions: {};
     readonly migrations: {
         readonly tableName: "mikro_orm_migrations";
-        readonly path: "./migrations";
         readonly glob: "!(*.d).{js,ts,cjs}";
         readonly silent: false;
         readonly transactional: true;
@@ -120,13 +116,7 @@ declare const DEFAULTS: {
         readonly readOnlyPivotTables: false;
         readonly useCoreBaseEntity: false;
     };
-    readonly metadataCache: {
-        readonly pretty: false;
-        readonly adapter: typeof FileCacheAdapter;
-        readonly options: {
-            readonly cacheDir: string;
-        };
-    };
+    readonly metadataCache: {};
     readonly resultCache: {
         readonly adapter: typeof MemoryCacheAdapter;
         readonly expiration: 1000;
@@ -135,7 +125,6 @@ declare const DEFAULTS: {
     readonly metadataProvider: typeof MetadataProvider;
     readonly highlighter: NullHighlighter;
     readonly seeder: {
-        readonly path: "./seeders";
         readonly defaultSeeder: "DatabaseSeeder";
         readonly glob: "!(*.d).{js,ts}";
         readonly emit: "ts";
@@ -215,15 +204,6 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
     resetServiceCache(): void;
     private init;
     private sync;
-    /**
-     * 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.
-     */
-    private detectSourceFolder;
     private validateOptions;
 }
 /**
@@ -905,8 +885,7 @@ export interface Options<Driver extends IDatabaseDriver = IDatabaseDriver, EM ex
          */
         pretty?: boolean;
         /**
-         * Cache adapter class to use.
-         * @default FileCacheAdapter
+         * Cache adapter class to use. When cache is enabled, and no adapter is provided explicitly, {@link FileCacheAdapter} is used automatically - but only if you use the async `MikroORM.init()` method.
          */
         adapter?: {
             new (...params: any[]): SyncCacheAdapter;
@@ -952,6 +931,7 @@ export interface Options<Driver extends IDatabaseDriver = IDatabaseDriver, EM ex
      */
     metadataProvider?: {
         new (config: Configuration): MetadataProvider;
+        useCache?: MetadataProvider['useCache'];
     };
     /**
      * Seeder configuration options.

package/utils/Configuration.js

@@ -1,4 +1,3 @@
-import { FileCacheAdapter } from '../cache/FileCacheAdapter.js';
 import { NullCacheAdapter } from '../cache/NullCacheAdapter.js';
 import { ObjectHydrator } from '../hydration/ObjectHydrator.js';
 import { NullHighlighter } from '../utils/NullHighlighter.js';
@@ -26,8 +25,6 @@ const DEFAULTS = {
         checkNonPersistentCompositeProps: true,
         inferDefaultValues: true,
     },
-    strict: false,
-    validate: false,
     validateRequired: true,
     context: (name) => RequestContext.getEntityManager(name),
     contextName: 'default',
@@ -74,7 +71,6 @@ const DEFAULTS = {
     driverOptions: {},
     migrations: {
         tableName: 'mikro_orm_migrations',
-        path: './migrations',
         glob: '!(*.d).{js,ts,cjs}',
         silent: false,
         transactional: true,
@@ -106,17 +102,14 @@ const DEFAULTS = {
         entityDefinition: 'defineEntity',
         decorators: 'legacy',
         enumMode: 'dictionary',
+        /* v8 ignore next */
         fileName: (className) => className,
         onlyPurePivotTables: false,
         outputPurePivotTables: false,
         readOnlyPivotTables: false,
         useCoreBaseEntity: false,
     },
-    metadataCache: {
-        pretty: false,
-        adapter: FileCacheAdapter,
-        options: { cacheDir: process.cwd() + '/temp' },
-    },
+    metadataCache: {},
     resultCache: {
         adapter: MemoryCacheAdapter,
         expiration: 1000, // 1s
@@ -125,7 +118,6 @@ const DEFAULTS = {
     metadataProvider: MetadataProvider,
     highlighter: new NullHighlighter(),
     seeder: {
-        path: './seeders',
         defaultSeeder: 'DatabaseSeeder',
         glob: '!(*.d).{js,ts}',
         emit: 'ts',
@@ -162,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);
         }
     }
@@ -226,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;
         }
@@ -294,16 +285,17 @@ export class Configuration {
         this.cache.clear();
     }
     init(validate) {
-        if (!this.getMetadataProvider().useCache()) {
-            this.options.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();
+        const useCache = this.getMetadataProvider().useCache();
+        const metadataCache = this.options.metadataCache;
+        if (!useCache) {
+            metadataCache.adapter = NullCacheAdapter;
         }
+        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.options.clientUrl);
             if (url.pathname) {
@@ -339,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.pathExists(this.options.baseDir + '/src')) {
-            return;
-        }
-        const migrationsPathExists = Utils.pathExists(this.options.baseDir + '/' + this.options.migrations.path);
-        const seedersPathExists = Utils.pathExists(this.options.baseDir + '/' + this.options.seeder.path);
-        const distDir = Utils.pathExists(this.options.baseDir + '/dist');
-        const buildDir = Utils.pathExists(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,13 +1 @@
-import type { IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
-import type { Dictionary } from '../typings.js';
-import { type Options } from './Configuration.js';
-/**
- * @internal
- */
-export declare class ConfigurationLoader {
-    static loadEnvironmentVars<D extends IDatabaseDriver>(): Partial<Options<D>>;
-    static getPackageConfig(basePath?: string): Dictionary;
-    static getORMPackages(): Set<string>;
-    static getORMPackageVersion(name: string): string | undefined;
-    static checkPackageVersion(): string;
-}
+export {};