@mikro-orm/core 7.0.0-dev.7 → 7.0.0-dev.70

package/typings.d.ts

@@ -1,5 +1,5 @@
 import type { Transaction } from './connections/Connection.js';
-import { type Cascade, type DeferMode, type EventType, type LoadStrategy, type PopulatePath, type QueryOrderMap, ReferenceKind } from './enums.js';
+import { type Cascade, type DeferMode, type EmbeddedPrefixMode, type EventType, type LoadStrategy, type PopulatePath, type QueryOrderMap, ReferenceKind } from './enums.js';
 import { type AssignOptions } from './entity/EntityAssigner.js';
 import { type EntityIdentifier } from './entity/EntityIdentifier.js';
 import { type EntityLoaderOptions } from './entity/EntityLoader.js';
@@ -7,7 +7,6 @@ import { type Collection } from './entity/Collection.js';
 import { type EntityFactory } from './entity/EntityFactory.js';
 import { type EntityRepository } from './entity/EntityRepository.js';
 import { Reference, type ScalarReference } from './entity/Reference.js';
-import type { MikroORM } from './MikroORM.js';
 import type { SerializationContext } from './serialization/SerializationContext.js';
 import type { SerializeOptions } from './serialization/EntitySerializer.js';
 import type { MetadataStorage } from './metadata/MetadataStorage.js';
@@ -17,9 +16,8 @@ import type { Platform } from './platforms/Platform.js';
 import type { Configuration } from './utils/Configuration.js';
 import type { RawQueryFragment } from './utils/RawQueryFragment.js';
 import type { EntityManager } from './EntityManager.js';
-import type { EmbeddedPrefixMode } from './decorators/Embedded.js';
 import type { EventSubscriber } from './events/EventSubscriber.js';
-import type { FindOneOptions, FindOptions, LoadHint } from './drivers/IDatabaseDriver.js';
+import type { FilterOptions, FindOneOptions, FindOptions, LoadHint } from './drivers/IDatabaseDriver.js';
 export type Constructor<T = unknown> = new (...args: any[]) => T;
 export type Dictionary<T = any> = {
     [k: string]: T;
@@ -52,18 +50,34 @@ export declare const OptionalProps: unique symbol;
 export declare const EagerProps: unique symbol;
 export declare const HiddenProps: unique symbol;
 export declare const Config: unique symbol;
-declare const __optional: unique symbol;
-declare const __hidden: unique symbol;
-declare const __config: unique symbol;
-export type Opt<T = unknown> = T & {
-    [__optional]?: 1;
-};
-export type Hidden<T = unknown> = T & {
-    [__hidden]?: 1;
-};
-export type DefineConfig<T extends TypeConfig> = T & {
-    [__config]?: 1;
-};
+export type Opt<T = unknown> = T & Opt.Brand;
+export declare namespace Opt {
+    const __optional: unique symbol;
+    interface Brand {
+        [__optional]?: 1;
+    }
+}
+export type RequiredNullable<T = never> = (T & RequiredNullable.Brand) | null;
+export declare namespace RequiredNullable {
+    const __requiredNullable: unique symbol;
+    interface Brand {
+        [__requiredNullable]?: 1;
+    }
+}
+export type Hidden<T = unknown> = T & Hidden.Brand;
+export declare namespace Hidden {
+    const __hidden: unique symbol;
+    interface Brand {
+        [__hidden]?: 1;
+    }
+}
+export type DefineConfig<T extends TypeConfig> = T & DefineConfig.Brand;
+export declare namespace DefineConfig {
+    const __config: unique symbol;
+    interface Brand {
+        [__config]?: 1;
+    }
+}
 export type CleanTypeConfig<T> = Compute<Pick<T, Extract<keyof T, keyof TypeConfig>>>;
 export interface TypeConfig {
     forceObject?: boolean;
@@ -75,13 +89,14 @@ type PrimaryPropToType<T, Keys extends (keyof T)[]> = {
 type ReadonlyPrimary<T> = T extends any[] ? Readonly<T> : T;
 export type Primary<T> = IsAny<T> extends true ? any : T extends {
     [PrimaryKeyProp]?: infer PK;
-} ? (PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : (PK extends (keyof T)[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK)) : T extends {
+} ? PK extends undefined ? Omit<T, typeof PrimaryKeyProp> : PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends (keyof T)[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends {
     _id?: infer PK;
 } ? ReadonlyPrimary<PK> | string : T extends {
-    uuid?: infer PK;
-} ? ReadonlyPrimary<PK> : T extends {
     id?: infer PK;
+} ? ReadonlyPrimary<PK> : T extends {
+    uuid?: infer PK;
 } ? ReadonlyPrimary<PK> : T;
+/** @internal */
 export type PrimaryProperty<T> = T extends {
     [PrimaryKeyProp]?: infer PK;
 } ? (PK extends keyof T ? PK : (PK extends any[] ? PK[number] : never)) : T extends {
@@ -89,10 +104,10 @@ export type PrimaryProperty<T> = T extends {
 } ? (T extends {
     id?: any;
 } ? 'id' | '_id' : '_id') : T extends {
-    uuid?: any;
-} ? 'uuid' : T extends {
     id?: any;
-} ? 'id' : never;
+} ? 'id' : T extends {
+    uuid?: any;
+} ? 'uuid' : never;
 export type IPrimaryKeyValue = number | string | bigint | Date | {
     toHexString(): string;
 };
@@ -133,7 +148,6 @@ export type FilterValue<T> = OperatorMap<FilterItemValue<T>> | FilterItemValue<T
 export type FilterObject<T> = {
     -readonly [K in EntityKey<T>]?: ExpandQuery<ExpandProperty<T[K]>> | FilterValue<ExpandProperty<T[K]>> | null;
 };
-export type ExpandObject<T> = T extends object ? T extends Scalar ? never : FilterObject<T> : never;
 export type ExpandQuery<T> = T extends object ? T extends Scalar ? never : FilterQuery<T> : FilterValue<T>;
 export type EntityProps<T> = {
     -readonly [K in EntityKey<T>]?: T[K];
@@ -143,7 +157,6 @@ export type FilterQuery<T> = ObjectQuery<T> | NonNullable<ExpandScalar<Primary<T
 export type QBFilterQuery<T = any> = ObjectQuery<T> | Dictionary;
 export interface IWrappedEntity<Entity extends object> {
     isInitialized(): boolean;
-    isTouched(): boolean;
     isManaged(): boolean;
     populated(populated?: boolean): void;
     populate<Hint extends string = never>(populate: AutoPath<Entity, Hint>[] | false, options?: EntityLoaderOptions<Entity>): Promise<Loaded<Entity, Hint>>;
@@ -174,10 +187,9 @@ export interface IWrappedEntityInternal<Entity extends object> extends IWrappedE
     __factory: EntityFactory;
     __hydrator: IHydrator;
     __initialized: boolean;
-    __touched: boolean;
     __originalEntityData?: EntityData<Entity>;
     __loadedProperties: Set<string>;
-    __identifier?: EntityIdentifier;
+    __identifier?: EntityIdentifier | EntityIdentifier[];
     __managed: boolean;
     __processing: boolean;
     __schema?: string;
@@ -197,16 +209,12 @@ export type AnyEntity<T = any> = Partial<T>;
 export type EntityClass<T> = Function & {
     prototype: T;
 };
-export type EntityClassGroup<T> = {
-    entity: EntityClass<T>;
-    schema: EntityMetadata<T> | EntitySchema<T>;
-};
 export type EntityName<T> = string | EntityClass<T> | EntitySchema<T, any> | {
     name: string;
 };
 export type GetRepository<Entity extends {
     [k: PropertyKey]: any;
-}, Fallback> = Entity[typeof EntityRepositoryType] extends EntityRepository<Entity> | undefined ? NonNullable<Entity[typeof EntityRepositoryType]> : Fallback;
+}, Fallback> = Entity[typeof EntityRepositoryType] extends EntityRepository<any> | undefined ? NonNullable<Entity[typeof EntityRepositoryType]> : Fallback;
 export type EntityDataPropValue<T> = T | Primary<T>;
 type ExpandEntityProp<T, C extends boolean = false> = T extends Record<string, any> ? {
     [K in keyof T as CleanKeys<T, K>]?: EntityDataProp<ExpandProperty<T[K]>, C> | EntityDataPropValue<ExpandProperty<T[K]>> | null;
@@ -217,14 +225,17 @@ type ExpandRequiredEntityPropObject<T, I = never, C extends boolean = false> = {
 } & {
     [K in keyof T as OptionalKeys<T, K, I>]?: RequiredEntityDataProp<ExpandProperty<T[K]>, T, C> | EntityDataPropValue<ExpandProperty<T[K]>> | null | undefined;
 };
+type NonArrayObject = object & {
+    [Symbol.iterator]?: never;
+};
 export type EntityDataProp<T, C extends boolean> = T extends Date ? string | Date : T extends Scalar ? T : T extends {
     __runtime?: infer Runtime;
     __raw?: infer Raw;
-} ? (C extends true ? Raw : Runtime) : T extends Reference<infer U> ? EntityDataNested<U, C> : T extends ScalarReference<infer U> ? EntityDataProp<U, C> : T extends Collection<infer U, any> ? U | U[] | EntityDataNested<U, C> | EntityDataNested<U, C>[] : T extends readonly (infer U)[] ? U | U[] | EntityDataNested<U, C> | EntityDataNested<U, C>[] : EntityDataNested<T, C>;
-export type RequiredEntityDataProp<T, O, C extends boolean> = T extends Date ? string | Date : T extends Scalar ? T : T extends {
+} ? (C extends true ? Raw : Runtime) : T extends Reference<infer U> ? EntityDataNested<U, C> : T extends ScalarReference<infer U> ? EntityDataProp<U, C> : T extends Collection<infer U, any> ? U | U[] | EntityDataNested<U, C> | EntityDataNested<U, C>[] : T extends readonly (infer U)[] ? U extends NonArrayObject ? U | U[] | EntityDataNested<U, C> | EntityDataNested<U, C>[] : U[] | EntityDataNested<U, C>[] : EntityDataNested<T, C>;
+export type RequiredEntityDataProp<T, O, C extends boolean> = T extends Date ? string | Date : Exclude<T, null> extends RequiredNullable.Brand ? T | null : T extends Scalar ? T : T extends {
     __runtime?: infer Runtime;
     __raw?: infer Raw;
-} ? (C extends true ? Raw : Runtime) : T extends Reference<infer U> ? RequiredEntityDataNested<U, O, C> : T extends ScalarReference<infer U> ? RequiredEntityDataProp<U, O, C> : T extends Collection<infer U, any> ? U | U[] | RequiredEntityDataNested<U, O, C> | RequiredEntityDataNested<U, O, C>[] : T extends readonly (infer U)[] ? U | U[] | RequiredEntityDataNested<U, O, C> | RequiredEntityDataNested<U, O, C>[] : RequiredEntityDataNested<T, O, C>;
+} ? (C extends true ? Raw : Runtime) : T extends Reference<infer U> ? RequiredEntityDataNested<U, O, C> : T extends ScalarReference<infer U> ? RequiredEntityDataProp<U, O, C> : T extends Collection<infer U, any> ? U | U[] | RequiredEntityDataNested<U, O, C> | RequiredEntityDataNested<U, O, C>[] : T extends readonly (infer U)[] ? U extends NonArrayObject ? U | U[] | RequiredEntityDataNested<U, O, C> | RequiredEntityDataNested<U, O, C>[] : U[] | RequiredEntityDataNested<U, O, C>[] : RequiredEntityDataNested<T, O, C>;
 export type EntityDataNested<T, C extends boolean = false> = T extends undefined ? never : T extends any[] ? Readonly<T> : EntityData<T, C> | ExpandEntityProp<T, C>;
 type EntityDataItem<T, C extends boolean> = C extends false ? T | EntityDataProp<T, C> | null : EntityDataProp<T, C> | null;
 export type RequiredEntityDataNested<T, O, C extends boolean> = T extends any[] ? Readonly<T> : RequiredEntityData<T, O> | ExpandRequiredEntityProp<T, O, C>;
@@ -236,7 +247,10 @@ type ExplicitlyOptionalProps<T> = (T extends {
 type NullableKeys<T, V = null> = {
     [K in keyof T]: V extends T[K] ? K : never;
 }[keyof T];
-type ProbablyOptionalProps<T> = PrimaryProperty<T> | ExplicitlyOptionalProps<T> | NonNullable<NullableKeys<T, null | undefined>>;
+type RequiredNullableKeys<T> = {
+    [K in keyof T]: Exclude<T[K], null> extends RequiredNullable.Brand ? K : never;
+}[keyof T];
+type ProbablyOptionalProps<T> = PrimaryProperty<T> | ExplicitlyOptionalProps<T> | Exclude<NonNullable<NullableKeys<T, null | undefined>>, RequiredNullableKeys<T>>;
 type IsOptional<T, K extends keyof T, I> = T[K] extends Collection<any, any> ? true : ExtractType<T[K]> extends I ? true : K extends ProbablyOptionalProps<T> ? true : false;
 type RequiredKeys<T, K extends keyof T, I> = IsOptional<T, K, I> extends false ? CleanKeys<T, K> : never;
 type OptionalKeys<T, K extends keyof T, I> = IsOptional<T, K, I> extends false ? never : CleanKeys<T, K>;
@@ -283,7 +297,7 @@ type PrimaryOrObject<T, U, C extends TypeConfig> = PreferExplicitConfig<C, Extra
 } : Primary<U>;
 export type EntityDTOProp<E, T, C extends TypeConfig = never> = T extends Scalar ? T : T extends {
     __serialized?: infer U;
-} ? U : T extends LoadedReference<infer U> ? EntityDTO<U, C> : T extends Reference<infer U> ? PrimaryOrObject<E, U, C> : T extends ScalarReference<infer U> ? U : T extends LoadedCollection<infer U> ? EntityDTO<U, C>[] : T extends Collection<infer U> ? PrimaryOrObject<E, U, C>[] : T extends readonly (infer U)[] ? (T extends readonly any[] ? T : U[]) : T extends Relation<T> ? EntityDTO<T, C> : T;
+} ? (IsUnknown<U> extends false ? U : T) : T extends LoadedReference<infer U> ? EntityDTO<U, C> : T extends Reference<infer U> ? PrimaryOrObject<E, U, C> : T extends ScalarReference<infer U> ? U : T extends LoadedCollection<infer U> ? EntityDTO<U, C>[] : T extends Collection<infer U> ? PrimaryOrObject<E, U, C>[] : T extends readonly (infer U)[] ? (T extends readonly any[] ? T : U[]) : T extends Relation<T> ? EntityDTO<T, C> : T;
 type DTOProbablyOptionalProps<T> = NonNullable<NullableKeys<T, undefined>>;
 type DTOIsOptional<T, K extends keyof T> = T[K] extends LoadedCollection<any> ? false : K extends PrimaryProperty<T> ? false : K extends DTOProbablyOptionalProps<T> ? true : false;
 type DTORequiredKeys<T, K extends keyof T> = DTOIsOptional<T, K> extends false ? ExcludeHidden<T, K> & CleanKeys<T, K> : never;
@@ -294,8 +308,14 @@ export type EntityDTO<T, C extends TypeConfig = never> = {
     [K in keyof T as DTOOptionalKeys<T, K>]?: EntityDTOProp<T, T[K], C> | AddOptional<T[K]>;
 };
 type TargetKeys<T> = T extends EntityClass<infer P> ? keyof P : keyof T;
-type CheckKey<T> = IsUnknown<T> extends false ? TargetKeys<T> : string;
-export type CheckCallback<T> = (columns: Record<CheckKey<T>, string>) => string;
+type PropertyName<T> = IsUnknown<T> extends false ? TargetKeys<T> : string;
+type TableName = {
+    name: string;
+    schema?: string;
+    toString: () => string;
+};
+export type IndexCallback<T> = (table: TableName, columns: Record<PropertyName<T>, string>, indexName: string) => string | RawQueryFragment;
+export type CheckCallback<T> = (columns: Record<PropertyName<T>, string>) => string;
 export type GeneratedColumnCallback<T> = (columns: Record<keyof T, string>) => string;
 export interface CheckConstraint<T = any> {
     name?: string;
@@ -332,6 +352,7 @@ export interface EntityProperty<Owner = any, Target = any> {
     default?: string | number | boolean | null;
     defaultRaw?: string;
     formula?: (alias: string) => string;
+    filters?: FilterOptions;
     prefix?: string | boolean;
     prefixMode?: EmbeddedPrefixMode;
     embedded?: [EntityKey<Owner>, EntityKey<Owner>];
@@ -348,7 +369,6 @@ export interface EntityProperty<Owner = any, Target = any> {
     mapToPk?: boolean;
     persist?: boolean;
     hydrate?: boolean;
-    trackChanges?: boolean;
     hidden?: boolean;
     enum?: boolean;
     items?: (number | string)[];
@@ -359,6 +379,7 @@ export interface EntityProperty<Owner = any, Target = any> {
     setter?: boolean;
     getter?: boolean;
     getterName?: keyof Owner;
+    accessor?: EntityKey<Owner>;
     cascade: Cascade[];
     orphanRemoval?: boolean;
     onCreate?: (entity: Owner, em: EntityManager) => any;
@@ -391,6 +412,8 @@ export interface EntityProperty<Owner = any, Target = any> {
     optional?: boolean;
     ignoreSchemaChanges?: ('type' | 'extra' | 'default')[];
     deferMode?: DeferMode;
+    createForeignKeyConstraint: boolean;
+    foreignKeyName?: string;
 }
 export declare class EntityMetadata<T = any> {
     private static counter;
@@ -399,8 +422,9 @@ export declare class EntityMetadata<T = any> {
     constructor(meta?: Partial<EntityMetadata>);
     addProperty(prop: Partial<EntityProperty<T>>, sync?: boolean): void;
     removeProperty(name: string, sync?: boolean): void;
-    getPrimaryProps(): EntityProperty<T>[];
+    getPrimaryProps(flatten?: boolean): EntityProperty<T>[];
     getPrimaryProp(): EntityProperty<T>;
+    createColumnMappingObject(): Dictionary<any>;
     get tableName(): string;
     set tableName(name: string);
     sync(initIndexes?: boolean, config?: Configuration): void;
@@ -419,14 +443,13 @@ export interface EntityMetadata<T = any> {
     schema?: string;
     pivotTable?: boolean;
     virtual?: boolean;
-    expression?: string | ((em: any, where: ObjectQuery<T>, options: FindOptions<T, any, any, any>) => MaybePromise<RawQueryFragment | object | string>);
+    expression?: string | ((em: any, where: ObjectQuery<T>, options: FindOptions<T, any, any, any>, stream?: boolean) => MaybePromise<RawQueryFragment | object | string>);
     discriminatorColumn?: EntityKey<T> | AnyString;
     discriminatorValue?: number | string;
     discriminatorMap?: Dictionary<string>;
     embeddable: boolean;
-    constructorParams: EntityKey<T>[];
+    constructorParams?: (keyof T)[];
     forceConstructor: boolean;
-    toJsonParams: string[];
     extends: string;
     collection: string;
     path: string;
@@ -435,7 +458,7 @@ export interface EntityMetadata<T = any> {
     compositePK: boolean;
     versionProperty: EntityKey<T>;
     concurrencyCheckKeys: Set<EntityKey<T>>;
-    serializedPrimaryKey: EntityKey<T>;
+    serializedPrimaryKey?: EntityKey<T>;
     properties: {
         [K in EntityKey<T>]: EntityProperty<T>;
     };
@@ -452,18 +475,18 @@ export interface EntityMetadata<T = any> {
     uniqueProps: EntityProperty<T>[];
     getterProps: EntityProperty<T>[];
     indexes: {
-        properties: EntityKey<T> | EntityKey<T>[];
+        properties?: EntityKey<T> | EntityKey<T>[];
         name?: string;
         type?: string;
         options?: Dictionary;
-        expression?: string;
+        expression?: string | IndexCallback<T>;
     }[];
     uniques: {
-        properties: EntityKey<T> | EntityKey<T>[];
+        properties?: EntityKey<T> | EntityKey<T>[];
         name?: string;
         options?: Dictionary;
-        expression?: string;
-        deferMode?: DeferMode;
+        expression?: string | IndexCallback<T>;
+        deferMode?: DeferMode | `${DeferMode}`;
     }[];
     checks: CheckConstraint<T>[];
     repositoryClass?: string;
@@ -482,6 +505,7 @@ export interface EntityMetadata<T = any> {
     polymorphs?: EntityMetadata[];
     root: EntityMetadata<T>;
     definedProperties: Dictionary;
+    hasTriggers?: boolean;
     /** @internal can be used for computed numeric cache keys */
     readonly _id: number;
 }
@@ -492,6 +516,7 @@ export interface CreateSchemaOptions {
 export interface ClearDatabaseOptions {
     schema?: string;
     truncate?: boolean;
+    clearIdentityMap?: boolean;
 }
 export interface EnsureDatabaseOptions extends CreateSchemaOptions, ClearDatabaseOptions {
     clear?: boolean;
@@ -519,25 +544,25 @@ export interface RefreshDatabaseOptions extends CreateSchemaOptions {
     createSchema?: boolean;
 }
 export interface ISchemaGenerator {
-    createSchema(options?: CreateSchemaOptions): Promise<void>;
-    ensureDatabase(options?: EnsureDatabaseOptions): Promise<boolean>;
+    create(options?: CreateSchemaOptions): Promise<void>;
+    update(options?: UpdateSchemaOptions): Promise<void>;
+    drop(options?: DropSchemaOptions): Promise<void>;
+    refresh(options?: RefreshDatabaseOptions): Promise<void>;
+    clear(options?: ClearDatabaseOptions): Promise<void>;
+    execute(sql: string, options?: {
+        wrap?: boolean;
+    }): Promise<void>;
     getCreateSchemaSQL(options?: CreateSchemaOptions): Promise<string>;
-    dropSchema(options?: DropSchemaOptions): Promise<void>;
     getDropSchemaSQL(options?: Omit<DropSchemaOptions, 'dropDb'>): Promise<string>;
-    updateSchema(options?: UpdateSchemaOptions): Promise<void>;
     getUpdateSchemaSQL(options?: UpdateSchemaOptions): Promise<string>;
     getUpdateSchemaMigrationSQL(options?: UpdateSchemaOptions): Promise<{
         up: string;
         down: string;
     }>;
+    ensureDatabase(options?: EnsureDatabaseOptions): Promise<boolean>;
     createDatabase(name?: string): Promise<void>;
     dropDatabase(name?: string): Promise<void>;
-    execute(sql: string, options?: {
-        wrap?: boolean;
-    }): Promise<void>;
     ensureIndexes(): Promise<void>;
-    refreshDatabase(options?: RefreshDatabaseOptions): Promise<void>;
-    clearDatabase(options?: ClearDatabaseOptions): Promise<void>;
 }
 export type ImportsResolver = (alias: string, basePath: string, extension: '.js' | '', originFileName: string) => {
     path: string;
@@ -554,7 +579,10 @@ export interface GenerateOptions {
     undefinedDefaults?: boolean;
     bidirectionalRelations?: boolean;
     identifiedReferences?: boolean;
-    entitySchema?: boolean;
+    entityDefinition?: 'decorators' | 'defineEntity' | 'entitySchema';
+    decorators?: 'es' | 'legacy';
+    inferEntityType?: boolean;
+    enumMode?: 'ts-enum' | 'union-type' | 'dictionary';
     esmImport?: boolean;
     scalarTypeInDecorator?: boolean;
     scalarPropertiesForRelations?: 'always' | 'never' | 'smart';
@@ -614,26 +642,26 @@ export interface IMigrator {
     /**
      * Checks current schema for changes, generates new migration if there are any.
      */
-    createMigration(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
+    create(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
     /**
      * Checks current schema for changes.
      */
-    checkMigrationNeeded(): Promise<boolean>;
+    checkSchema(): Promise<boolean>;
     /**
      * Creates initial migration. This generates the schema based on metadata, and checks whether all the tables
      * are already present. If yes, it will also automatically log the migration as executed.
      * Initial migration can be created only if the schema is already aligned with the metadata, or when no schema
      * is present - in such case regular migration would have the same effect.
      */
-    createInitialMigration(path?: string): Promise<MigrationResult>;
+    createInitial(path?: string): Promise<MigrationResult>;
     /**
      * Returns list of already executed migrations.
      */
-    getExecutedMigrations(): Promise<MigrationRow[]>;
+    getExecuted(): Promise<MigrationRow[]>;
     /**
      * Returns list of pending (not yet executed) migrations found in the migration directory.
      */
-    getPendingMigrations(): Promise<UmzugMigration[]>;
+    getPending(): Promise<UmzugMigration[]>;
     /**
      * Executes specified migrations. Without parameter it will migrate up to the latest version.
      */
@@ -682,12 +710,17 @@ export interface MigrationObject {
     name: string;
     class: Constructor<Migration>;
 }
-export type FilterDef = {
+type EntityFromInput<T> = T extends readonly EntityName<infer U>[] ? U : T extends EntityName<infer U> ? U : never;
+type FilterDefResolved<T extends object = any> = {
     name: string;
-    cond: Dictionary | ((args: Dictionary, type: 'read' | 'update' | 'delete', em: any, options?: FindOptions<any, any, any, any> | FindOneOptions<any, any, any, any>, entityName?: EntityName<any>) => Dictionary | Promise<Dictionary>);
+    cond: FilterQuery<T> | ((args: Dictionary, type: 'read' | 'update' | 'delete', em: any, options?: FindOptions<T, any, any, any> | FindOneOptions<T, any, any, any>, entityName?: EntityName<T>) => MaybePromise<FilterQuery<T>>);
     default?: boolean;
-    entity?: string[];
+    entity?: EntityName<T> | EntityName<T>[];
     args?: boolean;
+    strict?: boolean;
+};
+export type FilterDef<T extends EntityName<any> | readonly EntityName<any>[] = any> = FilterDefResolved<EntityFromInput<T>> & {
+    entity?: T;
 };
 export type Populate<T, P extends string = never> = readonly AutoPath<T, P, `${PopulatePath}`>[] | false;
 export type PopulateOptions<T> = {
@@ -695,6 +728,7 @@ export type PopulateOptions<T> = {
     strategy?: LoadStrategy;
     all?: boolean;
     filter?: boolean;
+    joinType?: 'inner join' | 'left join';
     children?: PopulateOptions<T[keyof T]>[];
 };
 type Loadable<T extends object> = Collection<T, any> | Reference<T> | Ref<T> | readonly T[];
@@ -729,7 +763,7 @@ export type MergeSelected<T, U, F extends string> = T extends Loaded<infer TT, i
 type MergeFields<F1 extends string, F2 extends string, P1, P2> = P1 | P2 extends '*' ? '*' : F1 | F2;
 type MergeExcludes<F extends string, E extends string> = F extends E ? never : Exclude<E, F>;
 export type MergeLoaded<T, U, P extends string, F extends string, E extends string, R extends boolean = false> = T extends Loaded<U, infer PP, infer FF, infer EE> ? string extends FF ? Loaded<T, P, F, AnyStringToNever<EE> | E> : string extends P ? Loaded<U, never, F | (FF & string), MergeExcludes<F | (FF & string), EE | E>> : Loaded<U, P | AnyStringToNever<PP>, MergeFields<F, AnyStringToNever<FF>, P, PP>, MergeExcludes<MergeFields<F, AnyStringToNever<FF>, P, PP>, (R extends true ? never : EE) | E>> : Loaded<T, P, F>;
-type AddOptional<T> = undefined | null extends T ? null | undefined : null extends T ? null : undefined extends T ? undefined : never;
+export type AddOptional<T> = undefined | null extends T ? null | undefined : null extends T ? null : undefined extends T ? undefined : never;
 type LoadedProp<T, L extends string = never, F extends string = '*', E extends string = never> = LoadedLoadable<T, Loaded<ExtractType<T>, L, F, E>>;
 export type AddEager<T> = ExtractEagerProps<T> & string;
 export type ExpandHint<T, L extends string> = L | AddEager<T>;
@@ -790,11 +824,11 @@ export interface IHydrator {
      * Hydrates the whole entity. This process handles custom type conversions, creating missing Collection instances,
      * mapping FKs to entity instances, as well as merging those entities.
      */
-    hydrate<T extends object>(entity: T, meta: EntityMetadata<T>, data: EntityData<T>, factory: EntityFactory, type: 'full' | 'reference', newEntity?: boolean, convertCustomTypes?: boolean, schema?: string, parentSchema?: string): void;
+    hydrate<T extends object>(entity: T, meta: EntityMetadata<T>, data: EntityData<T>, factory: EntityFactory, type: 'full' | 'reference', newEntity?: boolean, convertCustomTypes?: boolean, schema?: string, parentSchema?: string, normalizeAccessors?: boolean): void;
     /**
      * Hydrates primary keys only
      */
-    hydrateReference<T extends object>(entity: T, meta: EntityMetadata<T>, data: EntityData<T>, factory: EntityFactory, convertCustomTypes?: boolean, schema?: string, parentSchema?: string): void;
+    hydrateReference<T extends object>(entity: T, meta: EntityMetadata<T>, data: EntityData<T>, factory: EntityFactory, convertCustomTypes?: boolean, schema?: string, parentSchema?: string, normalizeAccessors?: boolean): void;
     isRunning(): boolean;
 }
 export interface HydratorConstructor {
@@ -804,17 +838,18 @@ export interface ISeedManager {
     seed(...classNames: Constructor<Seeder>[]): Promise<void>;
     /** @internal */
     seedString(...classNames: string[]): Promise<void>;
-    createSeeder(className: string): Promise<string>;
+    create(className: string): Promise<string>;
 }
 export interface Seeder<T extends Dictionary = Dictionary> {
     run(em: EntityManager, context?: T): void | Promise<void>;
 }
 export type ConnectionType = 'read' | 'write';
 export type MetadataProcessor = (metadata: EntityMetadata[], platform: Platform) => MaybePromise<void>;
-/**
- * The type of context that the user intends to inject.
- */
-export type ContextProvider<T> = MaybePromise<MikroORM> | ((type: T) => MaybePromise<MikroORM | EntityManager | EntityRepository<any> | {
-    getEntityManager(): EntityManager;
-}>);
+export type MaybeReturnType<T> = T extends (...args: any[]) => infer R ? R : T;
+export interface EntitySchemaWithMeta<TName extends string = string, TTableName extends string = string, TEntity = any, TBase = never, TProperties extends Record<string, any> = Record<string, any>> extends EntitySchema<TEntity, TBase> {
+    readonly name: TName;
+    readonly properties: TProperties;
+    readonly tableName: TTableName;
+}
+export type InferEntity<Schema> = Schema extends EntitySchemaWithMeta<any, any, infer Entity, any, any> ? Entity : Schema extends EntitySchema<infer Entity> ? Entity : Schema extends EntityClass<infer Entity> ? Entity : Schema;
 export {};

package/typings.js

@@ -45,12 +45,29 @@ export class EntityMetadata {
             this.sync();
         }
     }
-    getPrimaryProps() {
-        return this.primaryKeys.map(pk => this.properties[pk]);
+    getPrimaryProps(flatten = false) {
+        const pks = this.primaryKeys.map(pk => this.properties[pk]);
+        if (flatten) {
+            return pks.flatMap(pk => {
+                if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(pk.kind)) {
+                    return pk.targetMeta.getPrimaryProps(true);
+                }
+                return [pk];
+            });
+        }
+        return pks;
     }
     getPrimaryProp() {
         return this.properties[this.primaryKeys[0]];
     }
+    createColumnMappingObject() {
+        return Object.values(this.properties).reduce((o, prop) => {
+            if (prop.fieldNames) {
+                o[prop.name] = prop.fieldNames[0];
+            }
+            return o;
+        }, {});
+    }
     get tableName() {
         return this.collection;
     }
@@ -70,19 +87,20 @@ export class EntityMetadata {
             // `prop.userDefined` is either `undefined` or `false`
             const discriminator = this.root.discriminatorColumn === prop.name && prop.userDefined === false;
             // even if we don't have a setter, do not ignore value from database!
-            const onlyGetter = prop.getter && !prop.setter;
+            const onlyGetter = prop.getter && !prop.setter && prop.persist === false;
             return !prop.inherited && prop.hydrate !== false && !discriminator && !prop.embedded && !onlyGetter;
         });
-        this.trackingProps = this.hydrateProps
-            .filter(prop => !prop.getter && !prop.setter && prop.trackChanges !== false)
-            .filter(prop => ![ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(prop.kind))
-            .filter(prop => !prop.serializedPrimaryKey);
-        this.selfReferencing = this.relations.some(prop => [this.className, this.root.className].includes(prop.targetMeta?.root.className ?? prop.type));
+        this.trackingProps = this.hydrateProps.filter(prop => {
+            return !prop.getter && !prop.setter && [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind);
+        });
+        this.selfReferencing = this.relations.some(prop => {
+            return [this.className, this.root.className].includes(prop.targetMeta?.root.className ?? prop.type);
+        });
         this.hasUniqueProps = this.uniques.length + this.uniqueProps.length > 0;
         this.virtual = !!this.expression;
         if (config) {
             for (const prop of this.props) {
-                if (prop.enum && !prop.nativeEnumName && prop.items?.every(item => Utils.isString(item))) {
+                if (prop.enum && !prop.nativeEnumName && prop.items?.every(item => typeof item === 'string')) {
                     const name = config.getNamingStrategy().indexName(this.tableName, prop.fieldNames, 'check');
                     const exists = this.checks.findIndex(check => check.name === name);
                     if (exists !== -1) {
@@ -109,8 +127,7 @@ export class EntityMetadata {
             this.props.forEach(prop => this.initIndexes(prop));
         }
         this.definedProperties = this.trackingProps.reduce((o, prop) => {
-            const isCollection = [ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(prop.kind);
-            const isReference = [ReferenceKind.ONE_TO_ONE, ReferenceKind.MANY_TO_ONE].includes(prop.kind) && (prop.inversedBy || prop.mappedBy) && !prop.mapToPk;
+            const isReference = (prop.inversedBy || prop.mappedBy) && !prop.mapToPk;
             if (isReference) {
                 // eslint-disable-next-line @typescript-eslint/no-this-alias
                 const meta = this;
@@ -123,13 +140,13 @@ export class EntityMetadata {
                         const hydrator = wrapped.hydrator;
                         const entity = Reference.unwrapReference(val ?? wrapped.__data[prop.name]);
                         const old = Reference.unwrapReference(wrapped.__data[prop.name]);
+                        if (old && old !== entity && prop.kind === ReferenceKind.MANY_TO_ONE && prop.inversedBy && old[prop.inversedBy]) {
+                            old[prop.inversedBy].removeWithoutPropagation(this);
+                        }
                         wrapped.__data[prop.name] = Reference.wrapReference(val, prop);
                         // when propagation from inside hydration, we set the FK to the entity data immediately
                         if (val && hydrator.isRunning() && wrapped.__originalEntityData && prop.owner) {
-                            wrapped.__originalEntityData[prop.name] = Utils.getPrimaryKeyValues(val, prop.targetMeta.primaryKeys, true);
-                        }
-                        else {
-                            wrapped.__touched = !hydrator.isRunning();
+                            wrapped.__originalEntityData[prop.name] = Utils.getPrimaryKeyValues(val, prop.targetMeta, true);
                         }
                         EntityHelper.propagate(meta, entity, this, prop, Reference.unwrapReference(val), old);
                     },
@@ -137,23 +154,6 @@ export class EntityMetadata {
                     configurable: true,
                 };
             }
-            if (prop.inherited || prop.primary || isCollection || prop.persist === false || prop.trackChanges === false || isReference || prop.embedded) {
-                return o;
-            }
-            o[prop.name] = {
-                get() {
-                    return this.__helper.__data[prop.name];
-                },
-                set(val) {
-                    if (typeof val === 'object' && !!val && '__raw' in val) {
-                        val.assign();
-                    }
-                    this.__helper.__data[prop.name] = val;
-                    this.__helper.__touched = !this.__helper.hydrator.isRunning();
-                },
-                enumerable: true,
-                configurable: true,
-            };
             return o;
         }, { __gettersDefined: { value: true, enumerable: false } });
     }

package/unit-of-work/ChangeSetComputer.js

@@ -34,8 +34,11 @@ export class ChangeSetComputer {
                 this.processPropertyInitializers(entity, prop, type, map);
             }
         }
-        if (type === ChangeSetType.UPDATE && !wrapped.__initialized && !wrapped.isTouched()) {
-            return null;
+        if (type === ChangeSetType.UPDATE && !wrapped.__initialized) {
+            const data = this.comparator.prepareEntity(entity);
+            if (Utils.equals(data, wrapped.__originalEntityData)) {
+                return null;
+            }
         }
         const changeSet = new ChangeSet(entity, type, this.computePayload(entity), meta);
         changeSet.originalEntity = wrapped.__originalEntityData;
@@ -141,7 +144,9 @@ export class ChangeSetComputer {
         if (!target.isDirty() && changeSet.type !== ChangeSetType.CREATE) {
             return;
         }
-        this.collectionUpdates.add(target);
+        if (target.isDirty()) {
+            this.collectionUpdates.add(target);
+        }
         if (prop.owner && !this.platform.usesPivotTable()) {
             changeSet.payload[prop.name] = target.getItems(false).map((item) => item.__helper.__identifier ?? item.__helper.getPrimaryKey());
         }

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

@@ -5,6 +5,7 @@ import { type EntityValidator } from '../entity/EntityValidator.js';
 import { type ChangeSet } from './ChangeSet.js';
 import { type Configuration } from '../utils/Configuration.js';
 import type { DriverMethodOptions, IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
+import type { EntityManager } from '../EntityManager.js';
 export declare class ChangeSetPersister {
     private readonly driver;
     private readonly metadata;
@@ -12,10 +13,11 @@ export declare class ChangeSetPersister {
     private readonly factory;
     private readonly validator;
     private readonly config;
+    private readonly em;
     private readonly platform;
     private readonly comparator;
     private readonly usesReturningStatement;
-    constructor(driver: IDatabaseDriver, metadata: MetadataStorage, hydrator: IHydrator, factory: EntityFactory, validator: EntityValidator, config: Configuration);
+    constructor(driver: IDatabaseDriver, metadata: MetadataStorage, hydrator: IHydrator, factory: EntityFactory, validator: EntityValidator, config: Configuration, 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>;
@@ -23,7 +25,7 @@ export declare class ChangeSetPersister {
     private processProperties;
     private persistNewEntity;
     private persistNewEntities;
-    private propagateSchemaFromMetadata;
+    private prepareOptions;
     private persistNewEntitiesBatch;
     private persistManagedEntity;
     private persistManagedEntities;