@mikro-orm/core 7.0.0-rc.0 → 7.0.0-rc.1

package/EntityManager.d.ts

@@ -515,7 +515,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
     private lockAndPopulate;
     private buildFields;
     /** @internal */
-    preparePopulate<Entity extends object>(entityName: EntityName<Entity>, options: Pick<FindOptions<Entity, any, any, any>, 'populate' | 'strategy' | 'fields' | 'flags' | 'filters' | 'exclude'>, validate?: boolean): Promise<PopulateOptions<Entity>[]>;
+    preparePopulate<Entity extends object>(entityName: EntityName<Entity>, options: Pick<FindOptions<Entity, any, any, any>, 'populate' | 'strategy' | 'fields' | 'flags' | 'filters' | 'exclude' | 'populateHints'>, validate?: boolean): Promise<PopulateOptions<Entity>[]>;
     /**
      * when the entity is found in identity map, we check if it was partially loaded or we are trying to populate
      * some additional lazy properties, if so, we reload and merge the data from database

package/EntityManager.js

@@ -17,7 +17,7 @@ import { EventType, FlushMode, LoadStrategy, LockMode, PopulateHint, PopulatePat
 import { EventManager } from './events/EventManager.js';
 import { TransactionEventBroadcaster } from './events/TransactionEventBroadcaster.js';
 import { OptimisticLockError, ValidationError } from './errors.js';
-import { getLoadingStrategy } from './entity/utils.js';
+import { applyPopulateHints, getLoadingStrategy } from './entity/utils.js';
 import { TransactionManager } from './utils/TransactionManager.js';
 /**
  * The EntityManager is the central access point to ORM functionality. It is a facade to all different ORM subsystems
@@ -1683,12 +1683,15 @@ export class EntityManager {
             throw ValidationError.invalidPropertyName(entityName, invalid.field);
         }
         await this.autoJoinRefsForFilters(meta, { ...options, populate });
-        return populate.map(field => {
+        for (const field of populate) {
             // force select-in strategy when populating all relations as otherwise we could cause infinite loops when self-referencing
             const all = field.all ?? (Array.isArray(options.populate) && options.populate.includes('*'));
             field.strategy = all ? LoadStrategy.SELECT_IN : (options.strategy ?? field.strategy);
-            return field;
-        });
+        }
+        if (options.populateHints) {
+            applyPopulateHints(populate, options.populateHints);
+        }
+        return populate;
     }
     /**
      * when the entity is found in identity map, we check if it was partially loaded or we are trying to populate

package/drivers/IDatabaseDriver.d.ts

@@ -1,4 +1,4 @@
-import type { ConnectionType, EntityData, EntityMetadata, EntityProperty, FilterQuery, Primary, Dictionary, IPrimaryKey, PopulateOptions, EntityDictionary, AutoPath, ObjectQuery, FilterObject, Populate, EntityName } from '../typings.js';
+import type { ConnectionType, EntityData, EntityMetadata, EntityProperty, FilterQuery, Primary, Dictionary, IPrimaryKey, PopulateOptions, EntityDictionary, AutoPath, ObjectQuery, FilterObject, Populate, EntityName, PopulateHintOptions, Prefixes } from '../typings.js';
 import type { Connection, QueryResult, Transaction } from '../connections/Connection.js';
 import type { FlushMode, LockMode, QueryOrderMap, QueryFlag, LoadStrategy, PopulateHint, PopulatePath } from '../enums.js';
 import type { Platform } from '../platforms/Platform.js';
@@ -107,6 +107,10 @@ export interface FindOptions<Entity, Hint extends string = never, Fields extends
     populateFilter?: ObjectQuery<Entity>;
     /** Used for ordering of the populate queries. If not specified, the value of `options.orderBy` is used. */
     populateOrderBy?: OrderDefinition<Entity>;
+    /** Per-relation overrides for populate loading behavior. Keys are populate paths (same as used in `populate`). */
+    populateHints?: [Hint] extends [never] ? never : {
+        [K in Prefixes<Hint>]?: PopulateHintOptions;
+    };
     /** Ordering of the results.Can be an object or array of objects, keys are property names, values are ordering (asc/desc) */
     orderBy?: OrderDefinition<Entity>;
     /** Control result caching for this query. Result cache is by default disabled, not to be confused with the identity map. */
@@ -155,12 +159,18 @@ export interface FindOptions<Entity, Hint extends string = never, Fields extends
     lockTableAliases?: string[];
     ctx?: Transaction;
     connectionType?: ConnectionType;
-    /** sql only */
-    indexHint?: string;
+    /** SQL: appended to FROM clause (e.g. `'force index(my_index)'`); MongoDB: index name or spec passed as `hint`. */
+    indexHint?: string | Dictionary;
     /** sql only */
     comments?: string | string[];
     /** sql only */
     hintComments?: string | string[];
+    /** SQL: collation name string applied as COLLATE to ORDER BY; MongoDB: CollationOptions object. */
+    collation?: CollationOptions | string;
+    /** mongodb only */
+    maxTimeMS?: number;
+    /** mongodb only */
+    allowDiskUse?: boolean;
     loggerContext?: LogContext;
     logging?: LoggingOptions;
     /** @internal used to apply filters to the auto-joined relations */
@@ -211,12 +221,16 @@ export interface CountOptions<T extends object, P extends string = never> {
     ctx?: Transaction;
     connectionType?: ConnectionType;
     flushMode?: FlushMode | `${FlushMode}`;
-    /** sql only */
-    indexHint?: string;
+    /** SQL: appended to FROM clause (e.g. `'force index(my_index)'`); MongoDB: index name or spec passed as `hint`. */
+    indexHint?: string | Dictionary;
     /** sql only */
     comments?: string | string[];
     /** sql only */
     hintComments?: string | string[];
+    /** SQL: collation name string applied as COLLATE; MongoDB: CollationOptions object. */
+    collation?: CollationOptions | string;
+    /** mongodb only */
+    maxTimeMS?: number;
     loggerContext?: LogContext;
     logging?: LoggingOptions;
     /** @internal used to apply filters to the auto-joined relations */
@@ -244,6 +258,16 @@ export interface DriverMethodOptions {
     schema?: string;
     loggerContext?: LogContext;
 }
+export interface CollationOptions {
+    locale: string;
+    caseLevel?: boolean;
+    caseFirst?: string;
+    strength?: number;
+    numericOrdering?: boolean;
+    alternate?: string;
+    maxVariable?: string;
+    backwards?: boolean;
+}
 export interface GetReferenceOptions {
     wrapped?: boolean;
     convertCustomTypes?: boolean;

package/entity/defineEntity.d.ts

@@ -345,7 +345,7 @@ export declare class UniversalPropertyOptionsBuilder<Value, Options, IncludeKeys
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
     referencedColumnNames(...referencedColumnNames: string[]): Pick<UniversalPropertyOptionsBuilder<Value, Options, IncludeKeys>, IncludeKeys>;
     /** Specify the property name on the target entity that this FK references instead of the primary key. */
-    targetKey(targetKey: string): Pick<UniversalPropertyOptionsBuilder<Value, Options, IncludeKeys>, IncludeKeys>;
+    targetKey(targetKey: keyof Value): Pick<UniversalPropertyOptionsBuilder<Value, Options, IncludeKeys>, IncludeKeys>;
     /** What to do when the target entity gets deleted. */
     deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): Pick<UniversalPropertyOptionsBuilder<Value, Options, IncludeKeys>, IncludeKeys>;
     /** What to do when the reference to the target entity gets updated. */
@@ -373,7 +373,7 @@ export declare class OneToManyOptionsBuilderOnlyMappedBy<Value extends object> e
     kind: '1:m';
 }, IncludeKeysForOneToManyOptions> {
     /** Point to the owning side property name. */
-    mappedBy(mappedBy: (AnyString & keyof Value) | ((e: Value) => any)): Pick<UniversalPropertyOptionsBuilder<Value, EmptyOptions & {
+    mappedBy(mappedBy: (keyof Value) | ((e: Value) => any)): Pick<UniversalPropertyOptionsBuilder<Value, EmptyOptions & {
         kind: '1:m';
     }, IncludeKeysForOneToManyOptions>, IncludeKeysForOneToManyOptions>;
 }

package/entity/utils.d.ts

@@ -1,4 +1,4 @@
-import type { EntityMetadata, PopulateOptions } from '../typings.js';
+import type { EntityMetadata, PopulateHintOptions, PopulateOptions } from '../typings.js';
 import { LoadStrategy, ReferenceKind } from '../enums.js';
 /**
  * @internal
@@ -10,3 +10,8 @@ export declare function expandDotPaths<Entity>(meta: EntityMetadata<Entity>, pop
  * @internal
  */
 export declare function getLoadingStrategy(strategy: LoadStrategy | `${LoadStrategy}`, kind: ReferenceKind): LoadStrategy.SELECT_IN | LoadStrategy.JOINED;
+/**
+ * Applies per-relation overrides from `populateHints` to the normalized populate tree.
+ * @internal
+ */
+export declare function applyPopulateHints<Entity>(populate: PopulateOptions<Entity>[], hints: Record<string, PopulateHintOptions>): void;

package/entity/utils.js

@@ -67,3 +67,36 @@ export function getLoadingStrategy(strategy, kind) {
     }
     return strategy;
 }
+/**
+ * Applies per-relation overrides from `populateHints` to the normalized populate tree.
+ * @internal
+ */
+export function applyPopulateHints(populate, hints) {
+    for (const [path, hint] of Object.entries(hints)) {
+        const entry = findPopulateEntry(populate, path.split('.'));
+        if (!entry) {
+            continue;
+        }
+        if (hint.strategy != null) {
+            entry.strategy = hint.strategy;
+        }
+        if (hint.joinType != null) {
+            entry.joinType = hint.joinType;
+        }
+    }
+}
+function findPopulateEntry(populate, parts) {
+    let current = populate;
+    for (let i = 0; i < parts.length; i++) {
+        const entry = current.find(p => p.field.split(':')[0] === parts[i]);
+        if (!entry) {
+            return undefined;
+        }
+        if (i === parts.length - 1) {
+            return entry;
+        }
+        current = (entry.children ?? []);
+    }
+    /* v8 ignore next */
+    return undefined;
+}

package/index.d.ts

@@ -3,7 +3,7 @@
  * @module core
  */
 export { EntityMetadata, PrimaryKeyProp, EntityRepositoryType, OptionalProps, EagerProps, HiddenProps, Config } from './typings.js';
-export type { CompiledFunctions, Constructor, ConnectionType, Dictionary, Primary, IPrimaryKey, ObjectQuery, FilterQuery, IWrappedEntity, EntityName, EntityData, Highlighter, MaybePromise, AnyEntity, EntityClass, EntityProperty, PopulateOptions, Populate, Loaded, New, LoadedReference, LoadedCollection, IMigrator, IMigrationGenerator, MigratorEvent, GetRepository, MigrationObject, DeepPartial, PrimaryProperty, Cast, IsUnknown, EntityDictionary, EntityDTO, MigrationDiff, GenerateOptions, FilterObject, IEntityGenerator, ISeedManager, RequiredEntityData, CheckCallback, IndexCallback, FormulaCallback, FormulaTable, SchemaTable, SchemaColumns, SimpleColumnMeta, Rel, Ref, ScalarRef, EntityRef, ISchemaGenerator, UmzugMigration, MigrateOptions, MigrationResult, MigrationRow, EntityKey, EntityValue, EntityDataValue, FilterKey, EntityType, FromEntityType, Selected, IsSubset, EntityProps, ExpandProperty, ExpandScalar, FilterItemValue, ExpandQuery, Scalar, ExpandHint, FilterValue, MergeLoaded, MergeSelected, TypeConfig, AnyString, ClearDatabaseOptions, CreateSchemaOptions, EnsureDatabaseOptions, UpdateSchemaOptions, DropSchemaOptions, RefreshDatabaseOptions, AutoPath, UnboxArray, MetadataProcessor, ImportsResolver, RequiredNullable, DefineConfig, Opt, Hidden, EntitySchemaWithMeta, InferEntity, CheckConstraint, GeneratedColumnCallback, FilterDef, EntityCtor, Subquery, } from './typings.js';
+export type { CompiledFunctions, Constructor, ConnectionType, Dictionary, Primary, IPrimaryKey, ObjectQuery, FilterQuery, IWrappedEntity, EntityName, EntityData, Highlighter, MaybePromise, AnyEntity, EntityClass, EntityProperty, PopulateOptions, Populate, Loaded, New, LoadedReference, LoadedCollection, IMigrator, IMigrationGenerator, MigratorEvent, GetRepository, MigrationObject, DeepPartial, PrimaryProperty, Cast, IsUnknown, EntityDictionary, EntityDTO, MigrationDiff, GenerateOptions, FilterObject, IEntityGenerator, ISeedManager, RequiredEntityData, CheckCallback, IndexCallback, FormulaCallback, FormulaTable, SchemaTable, SchemaColumns, SimpleColumnMeta, Rel, Ref, ScalarRef, EntityRef, ISchemaGenerator, UmzugMigration, MigrateOptions, MigrationResult, MigrationRow, EntityKey, EntityValue, EntityDataValue, FilterKey, EntityType, FromEntityType, Selected, IsSubset, EntityProps, ExpandProperty, ExpandScalar, FilterItemValue, ExpandQuery, Scalar, ExpandHint, FilterValue, MergeLoaded, MergeSelected, TypeConfig, AnyString, ClearDatabaseOptions, CreateSchemaOptions, EnsureDatabaseOptions, UpdateSchemaOptions, DropSchemaOptions, RefreshDatabaseOptions, AutoPath, UnboxArray, MetadataProcessor, ImportsResolver, RequiredNullable, DefineConfig, Opt, Hidden, EntitySchemaWithMeta, InferEntity, CheckConstraint, GeneratedColumnCallback, FilterDef, EntityCtor, Subquery, PopulateHintOptions, Prefixes, } from './typings.js';
 export * from './enums.js';
 export * from './errors.js';
 export * from './exceptions.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-rc.0",
+  "version": "7.0.0-rc.1",
   "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",

package/typings.d.ts

@@ -151,7 +151,7 @@ declare const __loadHint: unique symbol;
  * This reflects that loading 'a.b.c' means 'a' and 'a.b' are also loaded.
  * Special case: '*' returns string to ensure Loaded<T, '*'> is assignable to any Loaded<T, Hint>.
  */
-type Prefixes<S extends string> = S extends '*' ? string : S extends `${infer H}.${infer T}` ? H | `${H}.${Prefixes<T>}` : S;
+export type Prefixes<S extends string> = S extends '*' ? string : S extends `${infer H}.${infer T}` ? H | `${H}.${Prefixes<T>}` : S;
 export type UnwrapPrimary<T> = T extends Scalar ? T : T extends ReferenceShape<infer U> ? Primary<U> : Primary<T>;
 type PrimaryPropToType<T, Keys extends (keyof T)[]> = {
     [Index in keyof Keys]: UnwrapPrimary<T[Keys[Index]]>;
@@ -335,7 +335,7 @@ type ExplicitlyOptionalProps<T> = (T extends {
     [K in keyof T]: T[K] extends Opt ? K : never;
 }[keyof T] & {});
 type NullableKeys<T, V = null> = {
-    [K in keyof T]: V extends T[K] ? K : never;
+    [K in keyof T]: unknown extends T[K] ? never : V extends T[K] ? K : never;
 }[keyof T];
 type RequiredNullableKeys<T> = {
     [K in keyof T]: Exclude<T[K], null> extends RequiredNullable.Brand ? K : never;
@@ -924,6 +924,10 @@ export type PopulateOptions<T> = {
     /** When true, ignores `mapToPk` on the property and returns full entity data instead of just PKs. */
     dataOnly?: boolean;
 };
+export type PopulateHintOptions = {
+    strategy?: LoadStrategy.JOINED | LoadStrategy.SELECT_IN | 'joined' | 'select-in';
+    joinType?: 'inner join' | 'left join';
+};
 type ExtractType<T> = T extends CollectionShape<infer U> ? U : T extends ReferenceShape<infer U> ? U : T extends Ref<infer U> ? U : T extends readonly (infer U)[] ? U : T;
 type ExtractStringKeys<T> = {
     [K in keyof T]-?: CleanKeys<T, K>;

package/unit-of-work/ChangeSetComputer.d.ts

@@ -1,18 +1,15 @@
-import { type Configuration } from '../utils/Configuration.js';
-import type { MetadataStorage } from '../metadata/MetadataStorage.js';
 import type { AnyEntity } from '../typings.js';
 import { ChangeSet } from './ChangeSet.js';
 import { type Collection } from '../entity/Collection.js';
-import type { Platform } from '../platforms/Platform.js';
 import type { EntityManager } from '../EntityManager.js';
 export declare class ChangeSetComputer {
+    private readonly em;
     private readonly collectionUpdates;
+    private readonly comparator;
     private readonly metadata;
     private readonly platform;
     private readonly config;
-    private readonly em;
-    private readonly comparator;
-    constructor(collectionUpdates: Set<Collection<AnyEntity>>, metadata: MetadataStorage, platform: Platform, config: Configuration, em: EntityManager);
+    constructor(em: EntityManager, collectionUpdates: Set<Collection<AnyEntity>>);
     computeChangeSet<T extends object>(entity: T): ChangeSet<T> | null;
     /**
      * Traverses entity graph and executes `onCreate` and `onUpdate` methods, assigning the values to given properties.

package/unit-of-work/ChangeSetComputer.js

@@ -7,18 +7,18 @@ import { Reference } from '../entity/Reference.js';
 import { PolymorphicRef } from '../entity/PolymorphicRef.js';
 import { ReferenceKind } from '../enums.js';
 export class ChangeSetComputer {
+    em;
     collectionUpdates;
+    comparator;
     metadata;
     platform;
     config;
-    em;
-    comparator;
-    constructor(collectionUpdates, metadata, platform, config, em) {
-        this.collectionUpdates = collectionUpdates;
-        this.metadata = metadata;
-        this.platform = platform;
-        this.config = config;
+    constructor(em, collectionUpdates) {
         this.em = em;
+        this.collectionUpdates = collectionUpdates;
+        this.config = this.em.config;
+        this.metadata = this.em.getMetadata();
+        this.platform = this.em.getPlatform();
         this.comparator = this.config.getComparator(this.metadata);
     }
     computeChangeSet(entity) {

package/unit-of-work/ChangeSetPersister.d.ts

@@ -1,21 +1,18 @@
-import type { MetadataStorage } from '../metadata/MetadataStorage.js';
-import type { Dictionary, EntityDictionary, EntityMetadata, IHydrator } from '../typings.js';
-import { type EntityFactory } from '../entity/EntityFactory.js';
+import type { Dictionary, EntityDictionary, EntityMetadata } from '../typings.js';
 import { type ChangeSet } from './ChangeSet.js';
-import { type Configuration } from '../utils/Configuration.js';
-import type { DriverMethodOptions, IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
+import type { DriverMethodOptions } from '../drivers/IDatabaseDriver.js';
 import type { EntityManager } from '../EntityManager.js';
 export declare class ChangeSetPersister {
+    private readonly em;
+    private readonly platform;
+    private readonly comparator;
+    private readonly usesReturningStatement;
     private readonly driver;
     private readonly metadata;
     private readonly hydrator;
     private readonly factory;
     private readonly config;
-    private readonly em;
-    private readonly platform;
-    private readonly comparator;
-    private readonly usesReturningStatement;
-    constructor(driver: IDatabaseDriver, metadata: MetadataStorage, hydrator: IHydrator, factory: EntityFactory, config: Configuration, em: EntityManager);
+    constructor(em: EntityManager);
     executeInserts<T extends object>(changeSets: ChangeSet<T>[], options?: DriverMethodOptions, withSchema?: boolean): Promise<void>;
     executeUpdates<T extends object>(changeSets: ChangeSet<T>[], batched: boolean, options?: DriverMethodOptions, withSchema?: boolean): Promise<void>;
     executeDeletes<T extends object>(changeSets: ChangeSet<T>[], options?: DriverMethodOptions, withSchema?: boolean): Promise<void>;

package/unit-of-work/ChangeSetPersister.js

@@ -7,23 +7,23 @@ import { Utils } from '../utils/Utils.js';
 import { OptimisticLockError, ValidationError } from '../errors.js';
 import { ReferenceKind } from '../enums.js';
 export class ChangeSetPersister {
+    em;
+    platform;
+    comparator;
+    usesReturningStatement;
     driver;
     metadata;
     hydrator;
     factory;
     config;
-    em;
-    platform;
-    comparator;
-    usesReturningStatement;
-    constructor(driver, metadata, hydrator, factory, config, em) {
-        this.driver = driver;
-        this.metadata = metadata;
-        this.hydrator = hydrator;
-        this.factory = factory;
-        this.config = config;
+    constructor(em) {
         this.em = em;
+        this.driver = this.em.getDriver();
+        this.config = this.em.config;
+        this.metadata = this.em.getMetadata();
+        this.factory = this.em.getEntityFactory();
         this.platform = this.driver.getPlatform();
+        this.hydrator = this.config.getHydrator(this.metadata);
         this.comparator = this.config.getComparator(this.metadata);
         this.usesReturningStatement = this.platform.usesReturningStatement() || this.platform.usesOutputStatement();
     }

package/unit-of-work/UnitOfWork.js

@@ -42,8 +42,8 @@ export class UnitOfWork {
         this.identityMap = new IdentityMap(this.platform.getDefaultSchemaName());
         this.eventManager = this.em.getEventManager();
         this.comparator = this.em.getComparator();
-        this.changeSetComputer = new ChangeSetComputer(this.collectionUpdates, this.metadata, this.platform, this.em.config, this.em);
-        this.changeSetPersister = new ChangeSetPersister(this.em.getDriver(), this.metadata, this.em.config.getHydrator(this.metadata), this.em.getEntityFactory(), this.em.config, this.em);
+        this.changeSetComputer = new ChangeSetComputer(this.em, this.collectionUpdates);
+        this.changeSetPersister = new ChangeSetPersister(this.em);
     }
     merge(entity, visited) {
         const wrapped = helper(entity);

package/utils/Utils.js

@@ -123,7 +123,7 @@ export function parseJsonSafe(value) {
 }
 export class Utils {
     static PK_SEPARATOR = '~~~';
-    static #ORM_VERSION = '7.0.0-rc.0';
+    static #ORM_VERSION = '7.0.0-rc.1';
     /**
      * Checks if the argument is instance of `Object`. Returns false for arrays.
      */

package/utils/fs-utils.js

@@ -77,8 +77,8 @@ export const fs = {
     getPackageConfig(basePath = process.cwd()) {
         if (this.pathExists(`${basePath}/package.json`)) {
             try {
-                const path = import.meta.resolve(`${basePath}/package.json`);
-                return this.readJSONSync(fileURLToPath(path));
+                const path = this.normalizePath(import.meta.resolve(`${basePath}/package.json`));
+                return this.readJSONSync(path);
             }
             catch (e) {
                 /* v8 ignore next */