@mikro-orm/core 7.0.0-dev.51 → 7.0.0-dev.53

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)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.51",
+  "version": "7.0.0-dev.53",
   "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.51",
+    "mikro-orm": "7.0.0-dev.53",
     "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/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/Utils.d.ts

@@ -134,7 +134,7 @@ export declare class Utils {
     static getCompositeKeyHash<T>(data: EntityData<T>, meta: EntityMetadata<T>, convertCustomTypes?: boolean, platform?: Platform, flat?: boolean): string;
     static getPrimaryKeyHash(pks: (string | Buffer | Date)[]): string;
     static splitPrimaryKeys<T extends object>(key: string): EntityKey<T>[];
-    static getPrimaryKeyValues<T>(entity: T, primaryKeys: string[] | EntityMetadata<T>, allowScalar?: boolean, convertCustomTypes?: boolean): any;
+    static getPrimaryKeyValues<T>(entity: T, meta: EntityMetadata<T>, allowScalar?: boolean, convertCustomTypes?: boolean): any;
     static getPrimaryKeyCond<T>(entity: T, primaryKeys: EntityKey<T>[]): Record<string, Primary<T>> | null;
     /**
      * Maps nested FKs from `[1, 2, 3]` to `[1, [2, 3]]`.

package/utils/Utils.js

@@ -6,7 +6,7 @@ import { existsSync, mkdirSync, readFileSync } from 'node:fs';
 import { createHash } from 'node:crypto';
 import { tokenize } from 'esprima';
 import { clone } from './clone.js';
-import { ARRAY_OPERATORS, JSON_KEY_OPERATORS, GroupOperator, PlainObject, QueryOperator, ReferenceKind } from '../enums.js';
+import { ARRAY_OPERATORS, GroupOperator, JSON_KEY_OPERATORS, PlainObject, QueryOperator, ReferenceKind, } from '../enums.js';
 import { helper } from '../entity/wrap.js';
 export const ObjectBindingPattern = Symbol('ObjectBindingPattern');
 function compareConstructors(a, b) {
@@ -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;
     }
@@ -486,8 +486,7 @@ export class Utils {
     static splitPrimaryKeys(key) {
         return key.split(this.PK_SEPARATOR);
     }
-    // TODO v7: remove support for `primaryKeys: string[]`
-    static getPrimaryKeyValues(entity, primaryKeys, allowScalar = false, convertCustomTypes = false) {
+    static getPrimaryKeyValues(entity, meta, allowScalar = false, convertCustomTypes = false) {
         /* v8 ignore next 3 */
         if (entity == null) {
             return entity;
@@ -498,15 +497,13 @@ export class Utils {
             }
             return val;
         }
-        const meta = Array.isArray(primaryKeys) ? undefined : primaryKeys;
-        primaryKeys = Array.isArray(primaryKeys) ? primaryKeys : meta.primaryKeys;
         let pk;
         if (Utils.isEntity(entity, true)) {
             pk = helper(entity).getPrimaryKey(convertCustomTypes);
         }
         else {
-            pk = primaryKeys.reduce((o, pk) => {
-                const targetMeta = meta?.properties[pk].targetMeta;
+            pk = meta.primaryKeys.reduce((o, pk) => {
+                const targetMeta = meta.properties[pk].targetMeta;
                 if (targetMeta && Utils.isPlainObject(entity[pk])) {
                     o[pk] = Utils.getPrimaryKeyValues(entity[pk], targetMeta, allowScalar, convertCustomTypes);
                 }
@@ -516,12 +513,12 @@ export class Utils {
                 return o;
             }, {});
         }
-        if (primaryKeys.length > 1) {
+        if (meta.primaryKeys.length > 1) {
             return toArray(pk);
         }
         if (allowScalar) {
             if (Utils.isPlainObject(pk)) {
-                return pk[primaryKeys[0]];
+                return pk[(meta.primaryKeys)[0]];
             }
             return pk;
         }