@mikro-orm/core 7.0.0-dev.52 → 7.0.0-dev.54

package/drivers/DatabaseDriver.d.ts

@@ -48,6 +48,7 @@ export declare abstract class DatabaseDriver<C extends Connection> implements ID
     setMetadata(metadata: MetadataStorage): void;
     getMetadata(): MetadataStorage;
     getDependencies(): string[];
+    protected isPopulated<T extends object>(meta: EntityMetadata<T>, prop: EntityProperty<T>, hint: PopulateOptions<T>, name?: string): boolean;
     protected processCursorOptions<T extends object, P extends string>(meta: EntityMetadata<T>, options: FindOptions<T, P, any, any>, orderBy: OrderDefinition<T>): {
         orderBy: OrderDefinition<T>[];
         where: FilterQuery<T>;

package/drivers/DatabaseDriver.js

@@ -105,6 +105,15 @@ export class DatabaseDriver {
     getDependencies() {
         return this.dependencies;
     }
+    isPopulated(meta, prop, hint, name) {
+        if (hint.field === prop.name || hint.field === name || hint.all) {
+            return true;
+        }
+        if (prop.embedded && hint.children && meta.properties[prop.embedded[0]].name === hint.field) {
+            return hint.children.some(c => this.isPopulated(meta, prop, c, prop.embedded[1]));
+        }
+        return false;
+    }
     processCursorOptions(meta, options, orderBy) {
         const { first, last, before, after, overfetch } = options;
         const limit = first ?? last;

package/entity/ArrayCollection.js

@@ -45,7 +45,7 @@ export class ArrayCollection {
         if (items.length === 0) {
             return [];
         }
-        field ??= targetMeta.compositePK ? targetMeta.primaryKeys : targetMeta.serializedPrimaryKey;
+        field ??= targetMeta.compositePK ? targetMeta.primaryKeys : (targetMeta.serializedPrimaryKey ?? targetMeta.primaryKeys[0]);
         const cb = (i, f) => {
             if (Utils.isEntity(i[f], true)) {
                 return wrap(i[f], true).getPrimaryKey();

package/entity/EntityFactory.js

@@ -38,8 +38,8 @@ 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);
@@ -284,15 +284,15 @@ 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.toLowerCase() === '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];
         }
     }
     /**

package/entity/EntityValidator.js

@@ -89,7 +89,7 @@ export class EntityValidator {
         }
     }
     validatePrimaryKey(entity, meta) {
-        const pkExists = meta.primaryKeys.every(pk => entity[pk] != null) || entity[meta.serializedPrimaryKey] != null;
+        const pkExists = meta.primaryKeys.every(pk => entity[pk] != null) || (meta.serializedPrimaryKey && entity[meta.serializedPrimaryKey] != null);
         if (!entity || !pkExists) {
             throw ValidationError.fromMergeWithoutPK(meta);
         }

package/metadata/EntitySchema.js

@@ -75,7 +75,7 @@ export class EntitySchema {
     }
     addSerializedPrimaryKey(name, type, options = {}) {
         this._meta.serializedPrimaryKey = name;
-        this.addProperty(name, type, options);
+        this.addProperty(name, type, { serializedPrimaryKey: true, ...options });
     }
     addEmbedded(name, options) {
         this.renameCompositeOptions(name, options);

package/metadata/MetadataDiscovery.js

@@ -497,10 +497,9 @@ export class MetadataDiscovery {
         }
         this.initOwnColumns(meta);
         meta.simplePK = pks.length === 1 && pks[0].kind === ReferenceKind.SCALAR && !pks[0].customType && pks[0].runtimeType !== 'Date';
-        meta.serializedPrimaryKey = this.platform.getSerializedPrimaryKeyField(meta.primaryKeys[0]);
-        const serializedPKProp = meta.properties[meta.serializedPrimaryKey];
-        if (serializedPKProp && meta.serializedPrimaryKey !== meta.primaryKeys[0]) {
-            serializedPKProp.persist = false;
+        meta.serializedPrimaryKey ??= meta.props.find(prop => prop.serializedPrimaryKey)?.name;
+        if (meta.serializedPrimaryKey && meta.serializedPrimaryKey !== meta.primaryKeys[0]) {
+            meta.properties[meta.serializedPrimaryKey].persist ??= false;
         }
         if (this.platform.usesPivotTable()) {
             return Object.values(meta.properties)
@@ -1110,8 +1109,18 @@ export class MetadataDiscovery {
         }
         // `prop.type` might also be custom type class (not instance), so `typeof MyType` will give us `function`, not `object`
         if (typeof prop.type === 'function' && Type.isMappedType(prop.type.prototype) && !prop.customType) {
-            prop.customType = new prop.type();
-            prop.type = prop.customType.constructor.name;
+            // if the type is an ORM defined mapped type without `ensureComparable: true`,
+            // we use just the type name, to have more performant hydration code
+            const type = Utils.keys(t).find(type => {
+                return !Type.getType(t[type]).ensureComparable(meta, prop) && prop.type === t[type];
+            });
+            if (type) {
+                prop.type = type === 'datetime' ? 'Date' : type;
+            }
+            else {
+                prop.customType = new prop.type();
+                prop.type = prop.customType.constructor.name;
+            }
         }
         if (simple) {
             return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.52",
+  "version": "7.0.0-dev.54",
   "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",
@@ -54,7 +54,7 @@
     "dataloader": "2.2.3",
     "dotenv": "17.2.3",
     "esprima": "4.0.1",
-    "mikro-orm": "7.0.0-dev.52",
+    "mikro-orm": "7.0.0-dev.54",
     "reflect-metadata": "0.2.2",
     "tinyglobby": "0.2.13"
   }

package/platforms/Platform.d.ts

@@ -48,11 +48,6 @@ export declare abstract class Platform {
      * Converts scalar primary key representation to native driver wrapper (e.g. string to mongodb's ObjectId)
      */
     denormalizePrimaryKey(data: IPrimaryKey): IPrimaryKey;
-    /**
-     * Used when serializing via toObject and toJSON methods, allows to use different PK field name (like `id` instead of `_id`)
-     */
-    getSerializedPrimaryKeyField(field: string): string;
-    usesDifferentSerializedPrimaryKey(): boolean;
     /**
      * Returns the SQL specific for the platform to get the current timestamp
      */

package/platforms/Platform.js

@@ -78,15 +78,6 @@ export class Platform {
     denormalizePrimaryKey(data) {
         return data;
     }
-    /**
-     * Used when serializing via toObject and toJSON methods, allows to use different PK field name (like `id` instead of `_id`)
-     */
-    getSerializedPrimaryKeyField(field) {
-        return field;
-    }
-    usesDifferentSerializedPrimaryKey() {
-        return false;
-    }
     /**
      * Returns the SQL specific for the platform to get the current timestamp
      */

package/serialization/EntitySerializer.js

@@ -85,7 +85,7 @@ export class EntitySerializer {
             }
             const visible = typeof val !== 'undefined' && !(val === null && options.skipNull);
             if (visible) {
-                ret[this.propertyName(meta, prop, wrapped.__platform)] = val;
+                ret[this.propertyName(meta, prop)] = val;
             }
         }
         if (contextCreated) {
@@ -99,26 +99,26 @@ export class EntitySerializer {
             if (prop.getterName != null) {
                 const visible = entity[prop.getterName] instanceof Function && isVisible(meta, prop.name, options);
                 if (visible) {
-                    ret[this.propertyName(meta, prop.name, wrapped.__platform)] = this.processProperty(prop.getterName, entity, options);
+                    ret[this.propertyName(meta, prop.name)] = this.processProperty(prop.getterName, entity, options);
                 }
             }
             else {
                 // decorated getters
                 const visible = typeof entity[prop.name] !== 'undefined' && isVisible(meta, prop.name, options);
                 if (visible) {
-                    ret[this.propertyName(meta, prop.name, wrapped.__platform)] = this.processProperty(prop.name, entity, options);
+                    ret[this.propertyName(meta, prop.name)] = this.processProperty(prop.name, entity, options);
                 }
             }
         }
         return ret;
     }
-    static propertyName(meta, prop, platform) {
+    static propertyName(meta, prop) {
         /* v8 ignore next 3 */
         if (meta.properties[prop]?.serializedName) {
             return meta.properties[prop].serializedName;
         }
-        if (meta.properties[prop]?.primary && platform) {
-            return platform.getSerializedPrimaryKeyField(prop);
+        if (meta.properties[prop]?.primary && meta.serializedPrimaryKey) {
+            return meta.serializedPrimaryKey;
         }
         return prop;
     }

package/serialization/EntityTransformer.js

@@ -77,7 +77,7 @@ export class EntityTransformer {
             if (typeof val === 'undefined') {
                 continue;
             }
-            ret[this.propertyName(meta, prop, wrapped.__platform, raw)] = val;
+            ret[this.propertyName(meta, prop, raw)] = val;
         }
         if (!wrapped.isInitialized() && wrapped.hasPrimaryKey()) {
             return ret;
@@ -88,7 +88,7 @@ export class EntityTransformer {
                 const visible = !prop.hidden && entity[prop.getterName] instanceof Function;
                 const populated = root.isMarkedAsPopulated(meta.className, prop.name);
                 if (visible) {
-                    ret[this.propertyName(meta, prop.name, wrapped.__platform, raw)] = this.processProperty(prop.getterName, entity, raw, populated);
+                    ret[this.propertyName(meta, prop.name, raw)] = this.processProperty(prop.getterName, entity, raw, populated);
                 }
             }
             else {
@@ -96,7 +96,7 @@ export class EntityTransformer {
                 const visible = !prop.hidden && typeof entity[prop.name] !== 'undefined';
                 const populated = root.isMarkedAsPopulated(meta.className, prop.name);
                 if (visible) {
-                    ret[this.propertyName(meta, prop.name, wrapped.__platform, raw)] = this.processProperty(prop.name, entity, raw, populated);
+                    ret[this.propertyName(meta, prop.name, raw)] = this.processProperty(prop.name, entity, raw, populated);
                 }
             }
         }
@@ -105,15 +105,15 @@ export class EntityTransformer {
         }
         return ret;
     }
-    static propertyName(meta, prop, platform, raw) {
+    static propertyName(meta, prop, raw) {
         if (raw) {
             return prop;
         }
         if (meta.properties[prop].serializedName) {
             return meta.properties[prop].serializedName;
         }
-        if (meta.properties[prop].primary && platform) {
-            return platform.getSerializedPrimaryKeyField(prop);
+        if (meta.properties[prop].primary && meta.serializedPrimaryKey) {
+            return meta.serializedPrimaryKey;
         }
         return prop;
     }

package/types/BlobType.d.ts

@@ -4,6 +4,5 @@ import type { EntityProperty } from '../typings.js';
 export declare class BlobType extends Uint8ArrayType {
     convertToJSValue(value: Buffer): Buffer | null;
     compareAsType(): string;
-    ensureComparable(): boolean;
     getColumnType(prop: EntityProperty, platform: Platform): string;
 }

package/types/BlobType.js

@@ -12,9 +12,6 @@ export class BlobType extends Uint8ArrayType {
     compareAsType() {
         return 'Buffer';
     }
-    ensureComparable() {
-        return false;
-    }
     getColumnType(prop, platform) {
         return platform.getBlobDeclarationSQL();
     }

package/types/BooleanType.d.ts

@@ -4,5 +4,6 @@ import type { EntityProperty } from '../typings.js';
 export declare class BooleanType extends Type<boolean | null | undefined, boolean | null | undefined> {
     getColumnType(prop: EntityProperty, platform: Platform): string;
     compareAsType(): string;
+    convertToJSValue(value: boolean | null | undefined): boolean | null | undefined;
     ensureComparable(): boolean;
 }

package/types/BooleanType.js

@@ -6,6 +6,9 @@ export class BooleanType extends Type {
     compareAsType() {
         return 'boolean';
     }
+    convertToJSValue(value) {
+        return Boolean(value);
+    }
     ensureComparable() {
         return false;
     }

package/types/Uint8ArrayType.d.ts

@@ -5,6 +5,5 @@ export declare class Uint8ArrayType extends Type<Uint8Array | null> {
     convertToDatabaseValue(value: Uint8Array): Buffer;
     convertToJSValue(value: Buffer): Uint8Array | null;
     compareAsType(): string;
-    ensureComparable(): boolean;
     getColumnType(prop: EntityProperty, platform: Platform): string;
 }

package/types/Uint8ArrayType.js

@@ -22,9 +22,6 @@ export class Uint8ArrayType extends Type {
     compareAsType() {
         return 'Buffer';
     }
-    ensureComparable() {
-        return false;
-    }
     getColumnType(prop, platform) {
         return platform.getBlobDeclarationSQL();
     }

package/typings.d.ts

@@ -462,7 +462,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>;
     };

package/utils/EntityComparator.d.ts

@@ -1,4 +1,4 @@
-import type { EntityData, EntityDictionary, EntityMetadata, EntityProperty, IMetadataStorage } from '../typings.js';
+import type { EntityData, EntityDictionary, EntityMetadata, EntityName, EntityProperty, IMetadataStorage } from '../typings.js';
 import type { Platform } from '../platforms/Platform.js';
 type Comparator<T> = (a: T, b: T, options?: {
     includeInverseSides?: boolean;
@@ -48,7 +48,7 @@ export declare class EntityComparator {
     /**
      * @internal Highly performance-sensitive method.
      */
-    getSnapshotGenerator<T>(entityName: string): SnapshotGenerator<T>;
+    getSnapshotGenerator<T>(entityName: EntityName<T>): SnapshotGenerator<T>;
     /**
      * @internal
      */

package/utils/EntityComparator.js

@@ -199,6 +199,7 @@ export class EntityComparator {
      * @internal Highly performance-sensitive method.
      */
     getSnapshotGenerator(entityName) {
+        entityName = Utils.className(entityName);
         const exists = this.snapshotGenerators.get(entityName);
         if (exists) {
             return exists;

package/utils/Utils.js

@@ -447,7 +447,7 @@ export class Utils {
             if (meta.compositePK) {
                 return this.getCompositeKeyValue(data, meta);
             }
-            return data[meta.primaryKeys[0]] || data[meta.serializedPrimaryKey] || null;
+            return data[meta.primaryKeys[0]] ?? data[meta.serializedPrimaryKey] ?? null;
         }
         return null;
     }