@mikro-orm/core 7.0.0-dev.29 → 7.0.0-dev.291

package/typings.js

@@ -1,14 +1,18 @@
 import { ReferenceKind, } from './enums.js';
 import { Reference } from './entity/Reference.js';
 import { EntityHelper } from './entity/EntityHelper.js';
+import { helper } from './entity/wrap.js';
 import { Utils } from './utils/Utils.js';
 import { EntityComparator } from './utils/EntityComparator.js';
+import { BaseEntity } from './entity/BaseEntity.js';
 export const EntityRepositoryType = Symbol('EntityRepositoryType');
 export const PrimaryKeyProp = Symbol('PrimaryKeyProp');
 export const OptionalProps = Symbol('OptionalProps');
 export const EagerProps = Symbol('EagerProps');
 export const HiddenProps = Symbol('HiddenProps');
 export const Config = Symbol('Config');
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EntityName = Symbol('EntityName');
 export class EntityMetadata {
     static counter = 0;
     _id = 1000 * EntityMetadata.counter++; // keep the id >= 1000 to allow computing cache keys by simple addition
@@ -25,22 +29,24 @@ export class EntityMetadata {
         this.referencingProperties = [];
         this.concurrencyCheckKeys = new Set();
         Object.assign(this, meta);
-    }
-    addProperty(prop, sync = true) {
-        if (prop.pivotTable && !prop.pivotEntity) {
-            prop.pivotEntity = prop.pivotTable;
+        const name = meta.className ?? meta.name;
+        if (!this.class && name) {
+            const Class = this.extends === BaseEntity
+                ? ({ [name]: class extends BaseEntity {
+                    } })[name]
+                : ({ [name]: class {
+                    } })[name];
+            this.class = Class;
         }
+    }
+    addProperty(prop) {
         this.properties[prop.name] = prop;
         this.propertyOrder.set(prop.name, this.props.length);
-        /* v8 ignore next 3 */
-        if (sync) {
-            this.sync();
-        }
+        this.sync();
     }
     removeProperty(name, sync = true) {
         delete this.properties[name];
         this.propertyOrder.delete(name);
-        /* v8 ignore next 3 */
         if (sync) {
             this.sync();
         }
@@ -60,8 +66,52 @@ export class EntityMetadata {
     getPrimaryProp() {
         return this.properties[this.primaryKeys[0]];
     }
-    createColumnMappingObject() {
-        return Object.values(this.properties).reduce((o, prop) => {
+    /**
+     * Creates a mapping from property names to field names.
+     * @param alias - Optional alias to prefix field names. Can be a string (same for all) or a function (per-property).
+     *                When provided, also adds toString() returning the alias for backwards compatibility with formulas.
+     * @param toStringAlias - Optional alias to return from toString(). Defaults to `alias` when it's a string.
+     */
+    createColumnMappingObject(alias, toStringAlias) {
+        const resolveAlias = typeof alias === 'function' ? alias : () => alias;
+        const defaultAlias = toStringAlias ?? (typeof alias === 'string' ? alias : undefined);
+        const result = Object.values(this.properties).reduce((o, prop) => {
+            if (prop.fieldNames) {
+                const propAlias = resolveAlias(prop);
+                o[prop.name] = propAlias ? `${propAlias}.${prop.fieldNames[0]}` : prop.fieldNames[0];
+            }
+            return o;
+        }, {});
+        // Add toString() for backwards compatibility when alias is provided
+        Object.defineProperty(result, 'toString', {
+            value: () => defaultAlias ?? '',
+            enumerable: false,
+        });
+        // Wrap in Proxy to detect old formula signature usage where the first param was FormulaTable.
+        // If user accesses `.alias` or `.qualifiedName` (FormulaTable-only properties), warn them.
+        const warnedProps = new Set(['alias', 'qualifiedName']);
+        return new Proxy(result, {
+            get(target, prop, receiver) {
+                if (typeof prop === 'string' && warnedProps.has(prop) && !(prop in target)) {
+                    // eslint-disable-next-line no-console
+                    console.warn(`[MikroORM] Detected old formula callback signature. The first parameter is now 'columns', not 'table'. ` +
+                        `Accessing '.${prop}' on the columns object will return undefined. ` +
+                        `Update your formula: formula(cols => quote\`\${cols.propName} ...\`). See the v7 upgrade guide.`);
+                }
+                return Reflect.get(target, prop, receiver);
+            },
+        });
+    }
+    /**
+     * Creates a column mapping for schema callbacks (indexes, checks, generated columns).
+     * For TPT entities, only includes properties that belong to the current table (ownProps).
+     */
+    createSchemaColumnMappingObject() {
+        // For TPT entities, only include properties that belong to this entity's table
+        const props = this.inheritanceType === 'tpt' && this.ownProps
+            ? this.ownProps
+            : Object.values(this.properties);
+        return props.reduce((o, prop) => {
             if (prop.fieldNames) {
                 o[prop.name] = prop.fieldNames[0];
             }
@@ -74,6 +124,9 @@ export class EntityMetadata {
     set tableName(name) {
         this.collection = name;
     }
+    get uniqueName() {
+        return this.tableName + '_' + this._id;
+    }
     sync(initIndexes = false, config) {
         this.root ??= this;
         const props = Object.values(this.properties).sort((a, b) => this.propertyOrder.get(a.name) - this.propertyOrder.get(b.name));
@@ -83,6 +136,12 @@ export class EntityMetadata {
         this.uniqueProps = this.props.filter(prop => prop.unique);
         this.getterProps = this.props.filter(prop => prop.getter);
         this.comparableProps = this.props.filter(prop => EntityComparator.isComparable(prop, this));
+        this.validateProps = this.props.filter(prop => {
+            if (prop.inherited || (prop.persist === false && prop.userDefined !== false)) {
+                return false;
+            }
+            return prop.kind === ReferenceKind.SCALAR && ['string', 'number', 'boolean', 'Date'].includes(prop.type);
+        });
         this.hydrateProps = this.props.filter(prop => {
             // `prop.userDefined` is either `undefined` or `false`
             const discriminator = this.root.discriminatorColumn === prop.name && prop.userDefined === false;
@@ -90,16 +149,26 @@ export class EntityMetadata {
             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.root.uniqueName === prop.targetMeta?.root.uniqueName;
+        });
         this.hasUniqueProps = this.uniques.length + this.uniqueProps.length > 0;
-        this.virtual = !!this.expression;
+        // Normalize object-form `view` option: `view: { materialized: true, withData: false }`
+        // into flat metadata fields (`view: true`, `materialized: true`, `withData: false`).
+        if (typeof this.view === 'object') {
+            this.materialized = this.view.materialized;
+            this.withData = this.view.withData;
+            this.view = true;
+        }
+        // If `view` is set, this is a database view entity (not a virtual entity).
+        // Virtual entities evaluate expressions at query time, view entities create actual database views.
+        this.virtual = !!this.expression && !this.view;
         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) {
@@ -119,16 +188,15 @@ export class EntityMetadata {
         for (const hook of Utils.keys(this.hooks)) {
             this.hooks[hook] = Utils.removeDuplicates(this.hooks[hook]);
         }
-        if (this.virtual) {
+        if (this.virtual || this.view) {
             this.readonly = true;
         }
         if (initIndexes && this.name) {
             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;
-            if (isReference) {
+            const hasInverse = (prop.inversedBy || prop.mappedBy) && !prop.mapToPk;
+            if (hasInverse) {
                 // eslint-disable-next-line @typescript-eslint/no-this-alias
                 const meta = this;
                 o[prop.name] = {
@@ -146,10 +214,10 @@ export class EntityMetadata {
                         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, true);
-                        }
-                        else {
-                            wrapped.__touched = !hydrator.isRunning();
+                            const targetMeta = prop.targetMeta ?? helper(entity)?.__meta;
+                            if (targetMeta) {
+                                wrapped.__originalEntityData[prop.name] = Utils.getPrimaryKeyValues(val, targetMeta, true);
+                            }
                         }
                         EntityHelper.propagate(meta, entity, this, prop, Reference.unwrapReference(val), old);
                     },
@@ -157,23 +225,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 } });
     }
@@ -195,7 +246,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;
@@ -205,4 +256,8 @@ export class EntityMetadata {
     clone() {
         return this;
     }
+    /** @ignore */
+    [Symbol.for('nodejs.util.inspect.custom')]() {
+        return `[${this.constructor.name}<${this.className}>]`;
+    }
 }

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

@@ -1,4 +1,3 @@
-import { inspect } from 'node:util';
 import type { EntityData, EntityMetadata, EntityDictionary, Primary } from '../typings.js';
 export declare class ChangeSet<T extends object> {
     entity: T;
@@ -10,19 +9,18 @@ export declare class ChangeSet<T extends object> {
     constructor(entity: T, type: ChangeSetType, payload: EntityDictionary<T>, meta: EntityMetadata<T>);
     getPrimaryKey(object?: boolean): Primary<T> | null;
     getSerializedPrimaryKey(): string | null;
-    /** @ignore */
-    [inspect.custom](depth?: number): string;
 }
 export interface ChangeSet<T> {
-    name: string;
-    rootName: string;
-    collection: string;
+    meta: EntityMetadata<T>;
+    rootMeta: EntityMetadata<T>;
     schema?: string;
     type: ChangeSetType;
     entity: T;
     payload: EntityDictionary<T>;
     persisted: boolean;
     originalEntity?: EntityData<T>;
+    /** For TPT: changesets for parent tables, ordered from immediate parent to root */
+    tptChangeSets?: ChangeSet<T>[];
 }
 export declare enum ChangeSetType {
     CREATE = "create",

package/unit-of-work/ChangeSet.js

@@ -1,6 +1,6 @@
-import { inspect } from 'node:util';
 import { helper } from '../entity/wrap.js';
 import { Utils } from '../utils/Utils.js';
+import { inspect } from '../logging/inspect.js';
 export class ChangeSet {
     entity;
     type;
@@ -13,9 +13,8 @@ export class ChangeSet {
         this.type = type;
         this.payload = payload;
         this.meta = meta;
-        this.name = meta.className;
-        this.rootName = meta.root.className;
-        this.collection = meta.root.collection;
+        this.meta = meta;
+        this.rootMeta = meta.root;
         this.schema = helper(entity).__schema ?? meta.root.schema;
     }
     getPrimaryKey(object = false) {
@@ -46,7 +45,7 @@ export class ChangeSet {
         return this.serializedPrimaryKey;
     }
     /** @ignore */
-    [inspect.custom](depth = 2) {
+    [Symbol.for('nodejs.util.inspect.custom')](depth = 2) {
         const object = { ...this };
         const hidden = ['meta', 'serializedPrimaryKey'];
         hidden.forEach(k => delete object[k]);

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

@@ -1,20 +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 EntityValidator } from '../entity/EntityValidator.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 validator;
+    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(validator: EntityValidator, 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

@@ -1,26 +1,28 @@
 import { Utils } from '../utils/Utils.js';
+import { QueryHelper } from '../utils/QueryHelper.js';
 import { ChangeSet, ChangeSetType } from './ChangeSet.js';
 import { helper } from '../entity/wrap.js';
+import { validateEntity } from '../entity/validators.js';
+import { Reference } from '../entity/Reference.js';
+import { PolymorphicRef } from '../entity/PolymorphicRef.js';
 import { ReferenceKind } from '../enums.js';
 export class ChangeSetComputer {
-    validator;
+    em;
     collectionUpdates;
+    comparator;
     metadata;
     platform;
     config;
-    em;
-    comparator;
-    constructor(validator, collectionUpdates, metadata, platform, config, em) {
-        this.validator = validator;
-        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) {
-        const meta = this.metadata.get(entity.constructor.name);
+        const meta = this.metadata.get(entity.constructor);
         if (meta.readonly) {
             return null;
         }
@@ -34,20 +36,21 @@ 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;
-        if (this.config.get('validate')) {
-            this.validator.validate(changeSet.entity, changeSet.payload, meta);
-        }
         for (const prop of meta.relations.filter(prop => prop.persist !== false || prop.userDefined === false)) {
             this.processProperty(changeSet, prop);
         }
         if (changeSet.type === ChangeSetType.UPDATE && !Utils.hasObjectKeys(changeSet.payload)) {
             return null;
         }
+        validateEntity(changeSet.entity, meta);
         // Execute `onCreate` and `onUpdate` on properties recursively, saves `onUpdate` results
         // to the `map` as we want to apply those only if something else changed.
         if (type === ChangeSetType.UPDATE) {
@@ -91,7 +94,7 @@ export class ChangeSetComputer {
     computePayload(entity, ignoreUndefined = false) {
         const data = this.comparator.prepareEntity(entity);
         const wrapped = helper(entity);
-        const entityName = wrapped.__meta.className;
+        const entityName = wrapped.__meta.class;
         const originalEntityData = wrapped.__originalEntityData;
         if (!wrapped.__initialized) {
             for (const prop of wrapped.__meta.primaryKeys) {
@@ -130,9 +133,25 @@ export class ChangeSetComputer {
             return;
         }
         const targets = Utils.unwrapProperty(changeSet.entity, changeSet.meta, prop);
-        targets.forEach(([target, idx]) => {
-            if (!target.__helper.hasPrimaryKey()) {
-                Utils.setPayloadProperty(changeSet.payload, this.metadata.find(changeSet.name), prop, target.__helper.__identifier, idx);
+        targets.forEach(([rawTarget, idx]) => {
+            const target = Reference.unwrapReference(rawTarget);
+            const needsProcessing = target != null && (prop.targetKey != null || !target.__helper.hasPrimaryKey());
+            if (needsProcessing) {
+                let value = prop.targetKey ? target[prop.targetKey] : target.__helper.__identifier;
+                /* v8 ignore next */
+                if (prop.targetKey && prop.targetMeta) {
+                    const targetProp = prop.targetMeta.properties[prop.targetKey];
+                    if (targetProp?.customType) {
+                        value = targetProp.customType.convertToDatabaseValue(value, this.platform, { mode: 'serialization' });
+                    }
+                }
+                if (prop.polymorphic) {
+                    const discriminator = QueryHelper.findDiscriminatorValue(prop.discriminatorMap, target.constructor);
+                    Utils.setPayloadProperty(changeSet.payload, changeSet.meta, prop, new PolymorphicRef(discriminator, value), idx);
+                }
+                else {
+                    Utils.setPayloadProperty(changeSet.payload, changeSet.meta, prop, value, idx);
+                }
             }
         });
     }
@@ -145,7 +164,9 @@ export class ChangeSetComputer {
             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());
+            changeSet.payload[prop.name] = target.getItems(false).map((item) => {
+                return item.__helper.__identifier ?? item.__helper.getPrimaryKey();
+            });
         }
     }
 }

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

@@ -1,27 +1,23 @@
-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 EntityValidator } from '../entity/EntityValidator.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 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, 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>;
     private runForEachSchema;
+    private validateRequired;
     private processProperties;
     private persistNewEntity;
     private persistNewEntities;
@@ -44,6 +40,11 @@ export declare class ChangeSetPersister {
      * so we use a single query in case of both versioning and default values is used.
      */
     private reloadVersionValues;
+    /**
+     * For TPT child tables, resolve EntityIdentifier values in PK fields.
+     * The parent table insert assigns the actual PK value, which the child table references.
+     */
+    private resolveTPTIdentifiers;
     private processProperty;
     /**
      * Maps values returned via `returning` statement (postgres) or the inserted id (other sql drivers).