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

package/entity/EntityAssigner.js

@@ -3,10 +3,9 @@ import { Collection } from './Collection.js';
 import { Utils } from '../utils/Utils.js';
 import { Reference } from './Reference.js';
 import { ReferenceKind, SCALAR_TYPES } from '../enums.js';
-import { EntityValidator } from './EntityValidator.js';
+import { validateProperty } from './validators.js';
 import { helper, wrap } from './wrap.js';
 import { EntityHelper } from './EntityHelper.js';
-const validator = new EntityValidator(false);
 export class EntityAssigner {
     static assign(entity, data, options = {}) {
         let opts = options;
@@ -42,9 +41,17 @@ export class EntityAssigner {
         }
         const prop = { ...props[propName], name: propName };
         if (prop && options.onlyOwnProperties) {
-            if ([ReferenceKind.MANY_TO_MANY, ReferenceKind.ONE_TO_MANY].includes(prop.kind)) {
+            if ([ReferenceKind.ONE_TO_MANY].includes(prop.kind)) {
                 return;
             }
+            if ([ReferenceKind.MANY_TO_MANY].includes(prop.kind)) {
+                if (!prop.owner) {
+                    return;
+                }
+                else if (value?.map) {
+                    value = value.map((v) => Utils.extractPK(v, prop.targetMeta));
+                }
+            }
             if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind)) {
                 value = Utils.extractPK(value, prop.targetMeta);
             }
@@ -86,8 +93,9 @@ export class EntityAssigner {
             }
             return EntityAssigner.assignReference(entity, value, prop, options.em, options);
         }
-        if (prop.kind === ReferenceKind.SCALAR && SCALAR_TYPES.includes(prop.runtimeType) && (prop.setter || !prop.getter)) {
-            return entity[prop.name] = validator.validateProperty(prop, value, entity);
+        if (prop.kind === ReferenceKind.SCALAR && SCALAR_TYPES.has(prop.runtimeType) && (prop.setter || !prop.getter)) {
+            validateProperty(prop, value, entity);
+            return entity[prop.name] = value;
         }
         if (prop.kind === ReferenceKind.EMBEDDED && EntityAssigner.validateEM(options.em)) {
             return EntityAssigner.assignEmbeddable(entity, value, prop, options.em, options);
@@ -112,7 +120,7 @@ export class EntityAssigner {
         }
         const meta2 = helper(ref).__meta;
         const prop2 = meta2.properties[prop.inversedBy || prop.mappedBy];
-        /* v8 ignore next 7 */
+        /* v8 ignore next */
         if (prop2 && !ref[prop2.name]) {
             if (Reference.isReference(ref)) {
                 ref.unwrap()[prop2.name] = Reference.wrapReference(entity, prop2);
@@ -165,7 +173,7 @@ export class EntityAssigner {
                 }
                 return this.createCollectionItem(item, em, prop, invalid, options);
             }
-            /* v8 ignore next 3 */
+            /* v8 ignore next */
             if (options.updateNestedEntities && !options.updateByPrimaryKey && collection[idx] && helper(collection[idx])?.isInitialized()) {
                 return EntityAssigner.assign(collection[idx], item, options);
             }

package/entity/EntityFactory.d.ts

@@ -4,12 +4,18 @@ import type { EntityComparator } from '../utils/EntityComparator.js';
 export interface FactoryOptions {
     initialized?: boolean;
     newEntity?: boolean;
+    /**
+     * Property `onCreate` hooks are normally executed during `flush` operation.
+     * With this option, they will be processed early inside `em.create()` method.
+     */
+    processOnCreateHooksEarly?: boolean;
     merge?: boolean;
     refresh?: boolean;
     convertCustomTypes?: boolean;
     recomputeSnapshot?: boolean;
     schema?: string;
     parentSchema?: string;
+    normalizeAccessors?: boolean;
 }
 export declare class EntityFactory {
     private readonly em;
@@ -27,6 +33,7 @@ export declare class EntityFactory {
     createEmbeddable<T extends object>(entityName: EntityName<T>, data: EntityData<T>, options?: Pick<FactoryOptions, 'newEntity' | 'convertCustomTypes'>): T;
     getComparator(): EntityComparator;
     private createEntity;
+    private assignDefaultValues;
     private hydrate;
     private findEntity;
     private processDiscriminatorColumn;

package/entity/EntityFactory.js

@@ -4,6 +4,7 @@ import { EventType, ReferenceKind } from '../enums.js';
 import { Reference } from './Reference.js';
 import { helper } from './wrap.js';
 import { EntityHelper } from './EntityHelper.js';
+import { JsonType } from '../types/JsonType.js';
 export class EntityFactory {
     em;
     driver;
@@ -37,14 +38,15 @@ export class EntityFactory {
             this.hydrate(entity, meta, data, options);
             return entity;
         }
-        if (this.platform.usesDifferentSerializedPrimaryKey()) {
-            meta.primaryKeys.forEach(pk => this.denormalizePrimaryKey(data, pk, meta.properties[pk]));
+        if (meta.serializedPrimaryKey) {
+            this.denormalizePrimaryKey(meta, data);
         }
         const meta2 = this.processDiscriminatorColumn(meta, data);
         const exists = this.findEntity(data, meta2, options);
         let wrapped = exists && helper(exists);
         if (wrapped && !options.refresh) {
             wrapped.__processing = true;
+            Utils.dropUndefinedProperties(data);
             this.mergeData(meta2, exists, data, options);
             wrapped.__processing = false;
             if (wrapped.isInitialized()) {
@@ -58,7 +60,7 @@ export class EntityFactory {
         wrapped.__initialized = options.initialized;
         if (options.newEntity || meta.forceConstructor || meta.virtual) {
             const tmp = { ...data };
-            meta.constructorParams.forEach(prop => delete tmp[prop]);
+            meta.constructorParams?.forEach(prop => delete tmp[prop]);
             this.hydrate(entity, meta2, tmp, options);
             // since we now process only a copy of the `data` via hydrator, but later we register the state with the full snapshot,
             // we need to go through all props with custom types that have `ensureComparable: true` and ensure they are comparable
@@ -70,9 +72,11 @@ export class EntityFactory {
                             continue;
                         }
                         if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) && Utils.isPlainObject(data[prop.name])) {
-                            data[prop.name] = Utils.getPrimaryKeyValues(data[prop.name], prop.targetMeta.primaryKeys, true);
+                            data[prop.name] = Utils.getPrimaryKeyValues(data[prop.name], prop.targetMeta, true);
+                        }
+                        if (prop.customType instanceof JsonType && this.platform.convertsJsonAutomatically()) {
+                            data[prop.name] = prop.customType.convertToDatabaseValue(data[prop.name], this.platform, { key: prop.name, mode: 'hydration' });
                         }
-                        data[prop.name] = prop.customType.convertToDatabaseValue(data[prop.name], this.platform, { key: prop.name, mode: 'hydration' });
                     }
                 }
             }
@@ -80,7 +84,6 @@ export class EntityFactory {
         else {
             this.hydrate(entity, meta2, data, options);
         }
-        wrapped.__touched = false;
         if (exists && meta.discriminatorColumn && !(entity instanceof meta2.class)) {
             Object.setPrototypeOf(entity, meta2.prototype);
         }
@@ -112,7 +115,7 @@ export class EntityFactory {
         if (meta.versionProperty && data[meta.versionProperty] && data[meta.versionProperty] !== originalEntityData[meta.versionProperty]) {
             diff[meta.versionProperty] = data[meta.versionProperty];
         }
-        const diff2 = this.comparator.diffEntities(meta.className, existsData, data);
+        const diff2 = this.comparator.diffEntities(meta.className, existsData, data, { includeInverseSides: true });
         // do not override values changed by user
         Utils.keys(diff).forEach(key => delete diff2[key]);
         Utils.keys(diff2).filter(key => {
@@ -135,6 +138,10 @@ export class EntityFactory {
             if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) && Utils.isPlainObject(data[prop.name])) {
                 diff2[key] = entity[prop.name] ? helper(entity[prop.name]).getPrimaryKey(options.convertCustomTypes) : null;
             }
+            if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE, ReferenceKind.SCALAR].includes(prop.kind) && prop.customType?.ensureComparable(meta, prop) && diff2[key] != null) {
+                const converted = prop.customType.convertToJSValue(diff2[key], this.platform, { force: true });
+                diff2[key] = prop.customType.convertToDatabaseValue(converted, this.platform, { fromQuery: true });
+            }
             originalEntityData[key] = diff2[key] === null ? nullVal : diff2[key];
             helper(entity).__loadedProperties.add(key);
         });
@@ -152,7 +159,7 @@ export class EntityFactory {
                 this.create(prop.type, data[prop.name], options); // we can ignore the value, we just care about the `mergeData` call
             }
         });
-        helper(entity).__touched = false;
+        this.unitOfWork.normalizeEntityData(meta, originalEntityData);
     }
     createReference(entityName, id, options = {}) {
         options.convertCustomTypes ??= true;
@@ -170,8 +177,8 @@ export class EntityFactory {
         if (Array.isArray(id)) {
             id = Utils.getPrimaryKeyCondFromArray(id, meta);
         }
-        const pks = Utils.getOrderedPrimaryKeys(id, meta, this.platform, options.convertCustomTypes);
-        const exists = this.unitOfWork.getById(entityName, pks, schema);
+        const pks = Utils.getOrderedPrimaryKeys(id, meta, this.platform);
+        const exists = this.unitOfWork.getById(entityName, pks, schema, options.convertCustomTypes);
         if (exists) {
             return exists;
         }
@@ -230,17 +237,28 @@ export class EntityFactory {
         }
         return entity;
     }
+    assignDefaultValues(entity, meta) {
+        for (const prop of meta.props) {
+            if (prop.onCreate) {
+                entity[prop.name] ??= prop.onCreate(entity, this.em);
+            }
+        }
+    }
     hydrate(entity, meta, data, options) {
         if (options.initialized) {
-            this.hydrator.hydrate(entity, meta, data, this, 'full', options.newEntity, options.convertCustomTypes, options.schema, this.driver.getSchemaName(meta, options));
+            this.hydrator.hydrate(entity, meta, data, this, 'full', options.newEntity, options.convertCustomTypes, options.schema, this.driver.getSchemaName(meta, options), options.normalizeAccessors);
         }
         else {
-            this.hydrator.hydrateReference(entity, meta, data, this, options.convertCustomTypes, options.schema, this.driver.getSchemaName(meta, options));
+            this.hydrator.hydrateReference(entity, meta, data, this, options.convertCustomTypes, options.schema, this.driver.getSchemaName(meta, options), options.normalizeAccessors);
         }
         Utils.keys(data).forEach(key => {
             helper(entity)?.__loadedProperties.add(key);
             helper(entity)?.__serializationContext.fields?.add(key);
         });
+        const processOnCreateHooksEarly = options.processOnCreateHooksEarly ?? this.config.get('processOnCreateHooksEarly');
+        if (options.newEntity && processOnCreateHooksEarly) {
+            this.assignDefaultValues(entity, meta);
+        }
     }
     findEntity(data, meta, options) {
         const schema = this.driver.getSchemaName(meta, options);
@@ -250,7 +268,7 @@ export class EntityFactory {
         if (!Array.isArray(data) && meta.primaryKeys.some(pk => data[pk] == null)) {
             return undefined;
         }
-        const pks = Utils.getOrderedPrimaryKeys(data, meta, this.platform);
+        const pks = Utils.getOrderedPrimaryKeys(data, meta, this.platform, options.convertCustomTypes);
         return this.unitOfWork.getById(meta.className, pks, schema);
     }
     processDiscriminatorColumn(meta, data) {
@@ -266,47 +284,52 @@ export class EntityFactory {
     /**
      * denormalize PK to value required by driver (e.g. ObjectId)
      */
-    denormalizePrimaryKey(data, primaryKey, prop) {
-        const pk = this.platform.getSerializedPrimaryKeyField(primaryKey);
-        if (data[pk] != null || data[primaryKey] != null) {
-            let id = (data[pk] || data[primaryKey]);
-            if (prop.type.toLowerCase() === 'objectid') {
-                id = this.platform.denormalizePrimaryKey(id);
-            }
-            delete data[pk];
-            data[primaryKey] = id;
+    denormalizePrimaryKey(meta, data) {
+        const pk = meta.getPrimaryProp();
+        const spk = meta.properties[meta.serializedPrimaryKey];
+        if (!spk?.serializedPrimaryKey) {
+            return;
+        }
+        if (pk.type === 'ObjectId' && (data[pk.name] != null || data[spk.name] != null)) {
+            data[pk.name] = this.platform.denormalizePrimaryKey((data[spk.name] || data[pk.name]));
+            delete data[spk.name];
         }
     }
     /**
      * returns parameters for entity constructor, creating references from plain ids
      */
     extractConstructorParams(meta, data, options) {
+        if (!meta.constructorParams) {
+            return [data];
+        }
         return meta.constructorParams.map(k => {
-            if (meta.properties[k] && [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(meta.properties[k].kind) && data[k]) {
-                const pk = Reference.unwrapReference(data[k]);
-                const entity = this.unitOfWork.getById(meta.properties[k].type, pk, options.schema);
+            const prop = meta.properties[k];
+            const value = data[k];
+            if (prop && [ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) && value) {
+                const pk = Reference.unwrapReference(value);
+                const entity = this.unitOfWork.getById(prop.type, pk, options.schema, true);
                 if (entity) {
                     return entity;
                 }
-                if (Utils.isEntity(data[k])) {
-                    return data[k];
+                if (Utils.isEntity(value)) {
+                    return value;
                 }
-                const nakedPk = Utils.extractPK(data[k], meta.properties[k].targetMeta, true);
-                if (Utils.isObject(data[k]) && !nakedPk) {
-                    return this.create(meta.properties[k].type, data[k], options);
+                const nakedPk = Utils.extractPK(value, prop.targetMeta, true);
+                if (Utils.isObject(value) && !nakedPk) {
+                    return this.create(prop.type, value, options);
                 }
                 const { newEntity, initialized, ...rest } = options;
-                const target = this.createReference(meta.properties[k].type, nakedPk, rest);
-                return Reference.wrapReference(target, meta.properties[k]);
+                const target = this.createReference(prop.type, nakedPk, rest);
+                return Reference.wrapReference(target, prop);
             }
-            if (meta.properties[k]?.kind === ReferenceKind.EMBEDDED && data[k]) {
-                /* v8 ignore next 3 */
-                if (Utils.isEntity(data[k])) {
-                    return data[k];
+            if (prop?.kind === ReferenceKind.EMBEDDED && value) {
+                /* v8 ignore next */
+                if (Utils.isEntity(value)) {
+                    return value;
                 }
-                return this.createEmbeddable(meta.properties[k].type, data[k], options);
+                return this.createEmbeddable(prop.type, value, options);
             }
-            if (!meta.properties[k]) {
+            if (!prop) {
                 const tmp = { ...data };
                 for (const prop of meta.props) {
                     if (!options.convertCustomTypes || !prop.customType || tmp[prop.name] == null) {
@@ -321,10 +344,10 @@ export class EntityFactory {
                 }
                 return tmp;
             }
-            if (options.convertCustomTypes && meta.properties[k].customType && data[k] != null) {
-                return meta.properties[k].customType.convertToJSValue(data[k], this.platform);
+            if (options.convertCustomTypes && prop.customType && value != null) {
+                return prop.customType.convertToJSValue(value, this.platform);
             }
-            return data[k];
+            return value;
         });
     }
     get unitOfWork() {

package/entity/EntityHelper.js

@@ -32,7 +32,7 @@ export class EntityHelper {
         const prototype = meta.prototype;
         if (!prototype.toJSON) { // toJSON can be overridden
             prototype.toJSON = function (...args) {
-                return EntityTransformer.toObject(this, ...args.slice(meta.toJsonParams.length));
+                return EntityTransformer.toObject(this, ...args);
             };
         }
     }
@@ -87,7 +87,7 @@ export class EntityHelper {
                 });
                 return;
             }
-            if (prop.inherited || prop.primary || prop.persist === false || prop.trackChanges === false || prop.embedded || isCollection) {
+            if (prop.inherited || prop.primary || prop.accessor || prop.persist === false || prop.embedded || isCollection) {
                 return;
             }
             Object.defineProperty(meta.prototype, prop.name, {
@@ -98,13 +98,11 @@ export class EntityHelper {
                         },
                         set(val) {
                             this.__helper.__data[prop.name] = val;
-                            this.__helper.__touched = !this.__helper.hydrator.isRunning();
                         },
                         enumerable: true,
                         configurable: true,
                     });
                     this.__helper.__data[prop.name] = val;
-                    this.__helper.__touched = !this.__helper.hydrator.isRunning();
                 },
                 configurable: true,
             });
@@ -113,7 +111,18 @@ export class EntityHelper {
     static defineCustomInspect(meta) {
         // @ts-ignore
         meta.prototype[inspect.custom] ??= function (depth = 2) {
-            const object = { ...this };
+            const object = {};
+            const keys = new Set(Utils.keys(this));
+            for (const prop of meta.props) {
+                if (keys.has(prop.name) || (prop.getter && prop.accessor === prop.name)) {
+                    object[prop.name] = this[prop.name];
+                }
+            }
+            for (const key of keys) {
+                if (!meta.properties[key]) {
+                    object[key] = this[key];
+                }
+            }
             // ensure we dont have internal symbols in the POJO
             [OptionalProps, EntityRepositoryType, PrimaryKeyProp, EagerProps, HiddenProps].forEach(sym => delete object[sym]);
             meta.props
@@ -146,13 +155,13 @@ export class EntityHelper {
             set(val) {
                 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(wrapped.__data[prop.name], prop.targetMeta.primaryKeys, true);
-                }
-                else {
-                    wrapped.__touched = !hydrator.isRunning();
+                    wrapped.__originalEntityData[prop.name] = Utils.getPrimaryKeyValues(wrapped.__data[prop.name], prop.targetMeta, true);
                 }
                 EntityHelper.propagate(meta, entity, this, prop, Reference.unwrapReference(val), old);
             },
@@ -169,6 +178,13 @@ export class EntityHelper {
                 continue;
             }
             const inverse = value?.[prop2.name];
+            if (prop.ref && owner[prop.name]) {
+                // eslint-disable-next-line dot-notation
+                owner[prop.name]['property'] = prop;
+            }
+            if (Utils.isCollection(inverse) && inverse.isPartial()) {
+                continue;
+            }
             if (prop.kind === ReferenceKind.MANY_TO_ONE && Utils.isCollection(inverse) && inverse.isInitialized()) {
                 inverse.addWithoutPropagation(owner);
                 helper(owner).__em?.getUnitOfWork().cancelOrphanRemoval(owner);
@@ -207,6 +223,7 @@ export class EntityHelper {
         }
         if (old?.[prop2.name] != null) {
             delete helper(old).__data[prop2.name];
+            old[prop2.name] = null;
         }
     }
     static ensurePropagation(entity) {

package/entity/EntityLoader.d.ts

@@ -1,7 +1,7 @@
-import type { ConnectionType, Dictionary, FilterQuery, PopulateOptions } from '../typings.js';
+import type { AnyEntity, ConnectionType, EntityProperty, FilterQuery, PopulateOptions } from '../typings.js';
 import type { EntityManager } from '../EntityManager.js';
 import { LoadStrategy, type LockMode, type PopulateHint, PopulatePath, type QueryOrderMap } from '../enums.js';
-import type { EntityField } from '../drivers/IDatabaseDriver.js';
+import type { EntityField, FilterOptions } from '../drivers/IDatabaseDriver.js';
 import type { LoggingOptions } from '../logging/Logger.js';
 export type EntityLoaderOptions<Entity, Fields extends string = PopulatePath.ALL, Excludes extends string = never> = {
     where?: FilterQuery<Entity>;
@@ -14,7 +14,7 @@ export type EntityLoaderOptions<Entity, Fields extends string = PopulatePath.ALL
     lookup?: boolean;
     convertCustomTypes?: boolean;
     ignoreLazyScalarProperties?: boolean;
-    filters?: Dictionary<boolean | Dictionary> | string[] | boolean;
+    filters?: FilterOptions;
     strategy?: LoadStrategy;
     lockMode?: Exclude<LockMode, LockMode.OPTIMISTIC>;
     schema?: string;
@@ -49,7 +49,8 @@ export declare class EntityLoader {
     private findChildren;
     private mergePrimaryCondition;
     private populateField;
-    private findChildrenFromPivotTable;
+    /** @internal */
+    findChildrenFromPivotTable<Entity extends object>(filtered: Entity[], prop: EntityProperty<Entity>, options: Required<EntityLoaderOptions<Entity>>, orderBy?: QueryOrderMap<Entity>[], populate?: PopulateOptions<Entity>, pivotJoin?: boolean): Promise<AnyEntity[][]>;
     private extractChildCondition;
     private buildFields;
     private getChildReferences;