@mikro-orm/core 7.0.0-dev.8 → 7.0.0-dev.81

package/metadata/MetadataProvider.d.ts

@@ -1,13 +1,22 @@
 import type { EntityMetadata } from '../typings.js';
 import type { Logger } from '../logging/Logger.js';
+import type { SyncCacheAdapter } from '../cache/CacheAdapter.js';
+import type { Platform } from '../platforms/Platform.js';
 export interface IConfiguration {
     get(key: string, defaultValue?: any): any;
     getLogger(): Logger;
+    getMetadataCacheAdapter(): SyncCacheAdapter;
+    getPlatform(): Platform;
 }
-export declare abstract class MetadataProvider {
+export declare class MetadataProvider {
     protected readonly config: IConfiguration;
     constructor(config: IConfiguration);
-    abstract loadEntityMetadata(meta: EntityMetadata, name: string): void;
+    loadEntityMetadata(meta: EntityMetadata): void;
     loadFromCache(meta: EntityMetadata, cache: EntityMetadata): void;
+    static useCache(): boolean;
     useCache(): boolean;
+    saveToCache(meta: EntityMetadata): void;
+    getCachedMetadata<T>(meta: Pick<EntityMetadata<T>, 'className' | 'path' | 'root'>, root: EntityMetadata<T>): EntityMetadata<T> | undefined;
+    combineCache(): void;
+    getCacheKey(meta: Pick<EntityMetadata, 'className' | 'path'>): string;
 }

package/metadata/MetadataProvider.js

@@ -4,17 +4,59 @@ export class MetadataProvider {
     constructor(config) {
         this.config = config;
     }
+    loadEntityMetadata(meta) {
+        for (const prop of meta.props) {
+            if (typeof prop.entity === 'string') {
+                prop.type = prop.entity;
+            }
+            else if (prop.entity) {
+                const tmp = prop.entity();
+                prop.type = Array.isArray(tmp) ? tmp.map(t => Utils.className(t)).sort().join(' | ') : Utils.className(tmp);
+                /* v8 ignore next */
+            }
+            else if (!prop.type && !(prop.enum && (prop.items?.length ?? 0) > 0)) {
+                throw new Error(`Please provide either 'type' or 'entity' attribute in ${meta.className}.${prop.name}.`);
+            }
+        }
+    }
     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/MetadataStorage.d.ts

@@ -1,4 +1,4 @@
-import { EntityMetadata, type Dictionary, type EntityData, type EntityName } from '../typings.js';
+import { EntityMetadata, type Dictionary, type EntityName } from '../typings.js';
 import type { EntityManager } from '../EntityManager.js';
 export declare class MetadataStorage {
     static readonly PATH_SYMBOL: unique symbol;
@@ -8,13 +8,8 @@ export declare class MetadataStorage {
     static getMetadata(): Dictionary<EntityMetadata>;
     static getMetadata<T = any>(entity: string, path: string): EntityMetadata<T>;
     static isKnownEntity(name: string): boolean;
-    static getMetadataFromDecorator<T = any>(target: T & Dictionary & {
-        [MetadataStorage.PATH_SYMBOL]?: string;
-    }): EntityMetadata<T>;
-    static init(): MetadataStorage;
     static clear(): void;
     getAll(): Dictionary<EntityMetadata>;
-    getByDiscriminatorColumn<T>(meta: EntityMetadata<T>, data: EntityData<T>): EntityMetadata<T> | undefined;
     get<T = any>(entityName: EntityName<T>, init?: boolean, validate?: boolean): EntityMetadata<T>;
     find<T = any>(entityName: EntityName<T>): EntityMetadata<T> | undefined;
     has(entity: string): boolean;

package/metadata/MetadataStorage.js

@@ -2,9 +2,14 @@ import { EntityMetadata } from '../typings.js';
 import { Utils } from '../utils/Utils.js';
 import { MetadataError } from '../errors.js';
 import { EntityHelper } from '../entity/EntityHelper.js';
+function getGlobalStorage(namespace) {
+    const key = `mikro-orm-${namespace}`;
+    globalThis[key] = globalThis[key] || {};
+    return globalThis[key];
+}
 export class MetadataStorage {
     static PATH_SYMBOL = Symbol('MetadataStorage.PATH_SYMBOL');
-    static metadata = Utils.getGlobalStorage('metadata');
+    static metadata = getGlobalStorage('metadata');
     metadata;
     constructor(metadata = {}) {
         this.metadata = Utils.copy(metadata, false);
@@ -22,29 +27,12 @@ export class MetadataStorage {
     static isKnownEntity(name) {
         return !!Object.values(this.metadata).find(meta => meta.className === name);
     }
-    static getMetadataFromDecorator(target) {
-        if (!Object.hasOwn(target, MetadataStorage.PATH_SYMBOL)) {
-            Object.defineProperty(target, MetadataStorage.PATH_SYMBOL, { value: Utils.lookupPathFromDecorator(target.name), writable: true });
-        }
-        return MetadataStorage.getMetadata(target.name, target[MetadataStorage.PATH_SYMBOL]);
-    }
-    static init() {
-        return new MetadataStorage(MetadataStorage.metadata);
-    }
     static clear() {
         Object.keys(this.metadata).forEach(k => delete this.metadata[k]);
     }
     getAll() {
         return this.metadata;
     }
-    getByDiscriminatorColumn(meta, data) {
-        const value = data[meta.root.discriminatorColumn];
-        if (!value) {
-            return undefined;
-        }
-        const type = meta.root.discriminatorMap[value];
-        return this.metadata[type];
-    }
     get(entityName, init = false, validate = true) {
         entityName = Utils.className(entityName);
         if (validate && !init && !this.has(entityName)) {

package/metadata/MetadataValidator.d.ts

@@ -1,17 +1,10 @@
 import type { EntityMetadata } from '../typings.js';
 import { type MetadataDiscoveryOptions } from '../utils/Configuration.js';
-import { ReferenceKind } from '../enums.js';
 import type { MetadataStorage } from './MetadataStorage.js';
 /**
  * @internal
  */
 export declare class MetadataValidator {
-    /**
-     * Validate there is only one property decorator. This disallows using `@Property()` together with e.g. `@ManyToOne()`
-     * on the same property. One should use only `@ManyToOne()` in such case.
-     * We allow the existence of the property in metadata if the reference type is the same, this should allow things like HMR to work.
-     */
-    static validateSingleDecorator(meta: EntityMetadata, propertyName: string, reference: ReferenceKind): void;
     validateEntityDefinition<T>(metadata: MetadataStorage, name: string, options: MetadataDiscoveryOptions): void;
     validateDiscovered(discovered: EntityMetadata[], options: MetadataDiscoveryOptions): void;
     private validateReference;

package/metadata/MetadataValidator.js

@@ -5,16 +5,6 @@ import { ReferenceKind } from '../enums.js';
  * @internal
  */
 export class MetadataValidator {
-    /**
-     * Validate there is only one property decorator. This disallows using `@Property()` together with e.g. `@ManyToOne()`
-     * on the same property. One should use only `@ManyToOne()` in such case.
-     * We allow the existence of the property in metadata if the reference type is the same, this should allow things like HMR to work.
-     */
-    static validateSingleDecorator(meta, propertyName, reference) {
-        if (meta.properties[propertyName] && meta.properties[propertyName].kind !== reference) {
-            throw MetadataError.multipleDecorators(meta.className, propertyName);
-        }
-    }
     validateEntityDefinition(metadata, name, options) {
         const meta = metadata.get(name);
         if (meta.virtual || meta.expression) {
@@ -100,14 +90,15 @@ export class MetadataValidator {
         if (!prop.type) {
             throw MetadataError.fromWrongTypeDefinition(meta, prop);
         }
+        const targetMeta = metadata.find(prop.type);
         // references do have type of known entity
-        if (!metadata.find(prop.type)) {
+        if (!targetMeta) {
             throw MetadataError.fromWrongTypeDefinition(meta, prop);
         }
-        if (metadata.find(prop.type).abstract && !metadata.find(prop.type).discriminatorColumn) {
+        if (targetMeta.abstract && !targetMeta.discriminatorColumn && !targetMeta.embeddable) {
             throw MetadataError.targetIsAbstract(meta, prop);
         }
-        if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) && prop.persist === false && metadata.find(prop.type).compositePK && options.checkNonPersistentCompositeProps) {
+        if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) && prop.persist === false && targetMeta.compositePK && options.checkNonPersistentCompositeProps) {
             throw MetadataError.nonPersistentCompositeProp(meta, prop);
         }
     }

package/metadata/discover-entities.d.ts

@@ -0,0 +1,5 @@
+import { type Constructor } from '../typings.js';
+import { EntitySchema } from './EntitySchema.js';
+export declare function discoverEntities(paths: string | string[], options?: {
+    baseDir?: string;
+}): Promise<Iterable<EntitySchema | Constructor>>;

package/metadata/discover-entities.js

@@ -0,0 +1,40 @@
+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';
+async function getEntityClassOrSchema(filepath, allTargets, baseDir) {
+    const path = Utils.normalizePath(baseDir, filepath);
+    const exports = await Utils.dynamicImport(path);
+    const targets = Object.values(exports);
+    // ignore class implementations that are linked from an EntitySchema
+    for (const item of targets) {
+        if (item instanceof EntitySchema) {
+            for (const item2 of targets) {
+                if (item.meta.class === item2) {
+                    targets.splice(targets.indexOf(item2), 1);
+                }
+            }
+        }
+    }
+    for (const item of targets) {
+        const validTarget = item instanceof EntitySchema || (item instanceof Function && MetadataStorage.isKnownEntity(item.name));
+        if (validTarget && !allTargets.has(item)) {
+            allTargets.set(item, path);
+        }
+    }
+}
+export async function discoverEntities(paths, options) {
+    paths = Utils.asArray(paths).map(path => Utils.normalizePath(path));
+    const baseDir = options?.baseDir ?? process.cwd();
+    const files = fs.glob(paths, Utils.normalizePath(baseDir));
+    const found = new Map();
+    for (const filepath of files) {
+        const filename = basename(filepath);
+        if (!filename.match(/\.[cm]?[jt]s$/) || filename.match(/\.d\.[cm]?ts/)) {
+            continue;
+        }
+        await getEntityClassOrSchema(filepath, found, baseDir);
+    }
+    return found.keys();
+}

package/metadata/index.d.ts

@@ -1,6 +1,6 @@
+export * from './types.js';
 export * from './EntitySchema.js';
 export * from './MetadataDiscovery.js';
 export * from './MetadataStorage.js';
 export * from './MetadataProvider.js';
 export * from './MetadataValidator.js';
-export * from './ReflectMetadataProvider.js';

package/metadata/index.js

@@ -1,6 +1,6 @@
+export * from './types.js';
 export * from './EntitySchema.js';
 export * from './MetadataDiscovery.js';
 export * from './MetadataStorage.js';
 export * from './MetadataProvider.js';
 export * from './MetadataValidator.js';
-export * from './ReflectMetadataProvider.js';