@mikro-orm/core 7.0.4-dev.8 → 7.0.4

package/entity/WrappedEntity.d.ts

@@ -1,6 +1,25 @@
 import type { PopulatePath } from '../enums.js';
 import type { EntityManager } from '../EntityManager.js';
-import type { Dictionary, EntityData, EntityDictionary, EntityMetadata, IHydrator, EntityKey, PopulateOptions, Primary, AutoPath, Ref, AddEager, LoadedReference, EntityDTO, Loaded, SerializeDTO, FromEntityType, IsSubset, MergeSelected } from '../typings.js';
+import type {
+  Dictionary,
+  EntityData,
+  EntityDictionary,
+  EntityMetadata,
+  IHydrator,
+  EntityKey,
+  PopulateOptions,
+  Primary,
+  AutoPath,
+  Ref,
+  AddEager,
+  LoadedReference,
+  EntityDTO,
+  Loaded,
+  SerializeDTO,
+  FromEntityType,
+  IsSubset,
+  MergeSelected,
+} from '../typings.js';
 import { Reference } from './Reference.js';
 import { type AssignOptions } from './EntityAssigner.js';
 import type { EntityLoaderOptions } from './EntityLoader.js';
@@ -12,75 +31,99 @@ import type { Platform } from '../platforms/Platform.js';
 import type { Configuration } from '../utils/Configuration.js';
 /** @internal Wrapper attached to every managed entity, holding ORM state such as initialization flags, identity map references, and change tracking snapshots. */
 export declare class WrappedEntity<Entity extends object> {
-    __initialized: boolean;
-    __populated?: boolean;
-    __managed?: boolean;
-    __onLoadFired?: boolean;
-    __schema?: string;
-    __em?: EntityManager;
-    __loadedProperties: Set<string>;
-    __data: Dictionary;
-    __processing: boolean;
-    __serializationContext: {
-        root?: SerializationContext<Entity>;
-        populate?: PopulateOptions<Entity>[];
-        fields?: Set<string>;
-        exclude?: readonly string[];
-    };
-    /** stores last known primary key, as its current state might be broken due to propagation/orphan removal, but we need to know the PK to be able t remove the entity */
-    __pk?: Primary<Entity>;
-    /** holds the reference wrapper instance (if created), so we can maintain the identity on reference wrappers too */
-    __reference?: Reference<Entity>;
-    /** holds last entity data snapshot, so we can compute changes when persisting managed entities */
-    __originalEntityData?: EntityData<Entity>;
-    /** holds wrapped primary key, so we can compute change set without eager commit */
-    __identifier?: EntityIdentifier;
-    private readonly entity;
-    private readonly hydrator;
-    private readonly pkGetter?;
-    private readonly pkSerializer?;
-    private readonly pkGetterConverted?;
-    constructor(entity: Entity, hydrator: IHydrator, pkGetter?: (e: Entity) => Primary<Entity>, pkSerializer?: (e: Entity) => string, pkGetterConverted?: (e: Entity) => Primary<Entity>);
-    /** Returns whether the entity has been fully loaded from the database. */
-    isInitialized(): boolean;
-    /** Returns whether the entity is managed by an EntityManager (tracked in the identity map). */
-    isManaged(): boolean;
-    /** Marks the entity as populated or not for serialization purposes. */
-    populated(populated?: boolean | undefined): void;
-    /** Sets the serialization context with populate hints, field selections, and exclusions. */
-    setSerializationContext<Hint extends string = never, Fields extends string = never, Exclude extends string = never>(options: LoadHint<Entity, Hint, Fields, Exclude>): void;
-    /** Returns a Reference wrapper for this entity, creating one if it does not already exist. */
-    toReference(): Ref<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>>>;
-    /** Converts the entity to a plain object representation, optionally excluding specified fields. */
-    toObject<Ignored extends EntityKey<Entity> = never>(ignoreFields?: Ignored[]): Omit<EntityDTO<Entity>, Ignored>;
-    /** Serializes the entity with control over which relations and fields to include or exclude. */
-    serialize<Hint extends string = never, Exclude extends string = never>(options?: SerializeOptions<Entity, Hint, Exclude>): SerializeDTO<Entity, Hint, Exclude>;
-    /** Converts the entity to a plain object, including all properties regardless of serialization rules. */
-    toPOJO(): EntityDTO<Entity>;
-    /** Serializes the entity using its `toJSON` method (supports `JSON.stringify`). */
-    toJSON(...args: any[]): EntityDictionary<Entity>;
-    /** Assigns the given data to this entity, updating its properties and relations. */
-    assign<Naked extends FromEntityType<Entity> = FromEntityType<Entity>, Convert extends boolean = false, Data extends EntityData<Naked, Convert> | Partial<EntityDTO<Naked>> = EntityData<Naked, Convert> | Partial<EntityDTO<Naked>>>(data: Data & IsSubset<EntityData<Naked>, Data>, options?: AssignOptions<Convert>): MergeSelected<Entity, Naked, keyof Data & string>;
-    /** Initializes (refreshes) the entity by reloading it from the database. Returns null if not found. */
-    init<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(options?: FindOneOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes> | null>;
-    /** Loads the specified relations on this entity. */
-    populate<Hint extends string = never, Fields extends string = never>(populate: AutoPath<Entity, Hint, PopulatePath.ALL>[] | false, options?: EntityLoaderOptions<Entity, Fields>): Promise<Loaded<Entity, Hint>>;
-    /** Returns whether this entity has a primary key value set. */
-    hasPrimaryKey(): boolean;
-    /** Returns the primary key value, optionally converting custom types to their database representation. */
-    getPrimaryKey(convertCustomTypes?: boolean): Primary<Entity> | null;
-    /** Returns all primary key values as an array. Used internally for composite key handling. */
-    getPrimaryKeys(convertCustomTypes?: boolean): Primary<Entity>[] | null;
-    /** Returns the database schema this entity belongs to. */
-    getSchema(): string | undefined;
-    /** Sets the database schema for this entity. */
-    setSchema(schema?: string): void;
-    /** Sets the primary key value on the entity. */
-    setPrimaryKey(id: Primary<Entity> | null): void;
-    /** Returns the primary key serialized as a string suitable for identity map lookups. */
-    getSerializedPrimaryKey(): string;
-    get __meta(): EntityMetadata<Entity>;
-    get __platform(): Platform;
-    get __config(): Configuration;
-    get __primaryKeys(): Primary<Entity>[];
+  __initialized: boolean;
+  __populated?: boolean;
+  __managed?: boolean;
+  __onLoadFired?: boolean;
+  __schema?: string;
+  __em?: EntityManager;
+  __loadedProperties: Set<string>;
+  __data: Dictionary;
+  __processing: boolean;
+  __serializationContext: {
+    root?: SerializationContext<Entity>;
+    populate?: PopulateOptions<Entity>[];
+    fields?: Set<string>;
+    exclude?: readonly string[];
+  };
+  /** stores last known primary key, as its current state might be broken due to propagation/orphan removal, but we need to know the PK to be able t remove the entity */
+  __pk?: Primary<Entity>;
+  /** holds the reference wrapper instance (if created), so we can maintain the identity on reference wrappers too */
+  __reference?: Reference<Entity>;
+  /** holds last entity data snapshot, so we can compute changes when persisting managed entities */
+  __originalEntityData?: EntityData<Entity>;
+  /** holds wrapped primary key, so we can compute change set without eager commit */
+  __identifier?: EntityIdentifier;
+  private readonly entity;
+  private readonly hydrator;
+  private readonly pkGetter?;
+  private readonly pkSerializer?;
+  private readonly pkGetterConverted?;
+  constructor(
+    entity: Entity,
+    hydrator: IHydrator,
+    pkGetter?: (e: Entity) => Primary<Entity>,
+    pkSerializer?: (e: Entity) => string,
+    pkGetterConverted?: (e: Entity) => Primary<Entity>,
+  );
+  /** Returns whether the entity has been fully loaded from the database. */
+  isInitialized(): boolean;
+  /** Returns whether the entity is managed by an EntityManager (tracked in the identity map). */
+  isManaged(): boolean;
+  /** Marks the entity as populated or not for serialization purposes. */
+  populated(populated?: boolean | undefined): void;
+  /** Sets the serialization context with populate hints, field selections, and exclusions. */
+  setSerializationContext<Hint extends string = never, Fields extends string = never, Exclude extends string = never>(
+    options: LoadHint<Entity, Hint, Fields, Exclude>,
+  ): void;
+  /** Returns a Reference wrapper for this entity, creating one if it does not already exist. */
+  toReference(): Ref<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>>>;
+  /** Converts the entity to a plain object representation, optionally excluding specified fields. */
+  toObject<Ignored extends EntityKey<Entity> = never>(ignoreFields?: Ignored[]): Omit<EntityDTO<Entity>, Ignored>;
+  /** Serializes the entity with control over which relations and fields to include or exclude. */
+  serialize<Hint extends string = never, Exclude extends string = never>(
+    options?: SerializeOptions<Entity, Hint, Exclude>,
+  ): SerializeDTO<Entity, Hint, Exclude>;
+  /** Converts the entity to a plain object, including all properties regardless of serialization rules. */
+  toPOJO(): EntityDTO<Entity>;
+  /** Serializes the entity using its `toJSON` method (supports `JSON.stringify`). */
+  toJSON(...args: any[]): EntityDictionary<Entity>;
+  /** Assigns the given data to this entity, updating its properties and relations. */
+  assign<
+    Naked extends FromEntityType<Entity> = FromEntityType<Entity>,
+    Convert extends boolean = false,
+    Data extends EntityData<Naked, Convert> | Partial<EntityDTO<Naked>> =
+      | EntityData<Naked, Convert>
+      | Partial<EntityDTO<Naked>>,
+  >(
+    data: Data & IsSubset<EntityData<Naked>, Data>,
+    options?: AssignOptions<Convert>,
+  ): MergeSelected<Entity, Naked, keyof Data & string>;
+  /** Initializes (refreshes) the entity by reloading it from the database. Returns null if not found. */
+  init<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
+    options?: FindOneOptions<Entity, Hint, Fields, Excludes>,
+  ): Promise<Loaded<Entity, Hint, Fields, Excludes> | null>;
+  /** Loads the specified relations on this entity. */
+  populate<Hint extends string = never, Fields extends string = never>(
+    populate: AutoPath<Entity, Hint, PopulatePath.ALL>[] | false,
+    options?: EntityLoaderOptions<Entity, Fields>,
+  ): Promise<Loaded<Entity, Hint>>;
+  /** Returns whether this entity has a primary key value set. */
+  hasPrimaryKey(): boolean;
+  /** Returns the primary key value, optionally converting custom types to their database representation. */
+  getPrimaryKey(convertCustomTypes?: boolean): Primary<Entity> | null;
+  /** Returns all primary key values as an array. Used internally for composite key handling. */
+  getPrimaryKeys(convertCustomTypes?: boolean): Primary<Entity>[] | null;
+  /** Returns the database schema this entity belongs to. */
+  getSchema(): string | undefined;
+  /** Sets the database schema for this entity. */
+  setSchema(schema?: string): void;
+  /** Sets the primary key value on the entity. */
+  setPrimaryKey(id: Primary<Entity> | null): void;
+  /** Returns the primary key serialized as a string suitable for identity map lookups. */
+  getSerializedPrimaryKey(): string;
+  get __meta(): EntityMetadata<Entity>;
+  get __platform(): Platform;
+  get __config(): Configuration;
+  get __primaryKeys(): Primary<Entity>[];
 }

package/entity/WrappedEntity.js

@@ -8,171 +8,173 @@ import { EntitySerializer } from '../serialization/EntitySerializer.js';
 import { expandDotPaths } from './utils.js';
 /** @internal Wrapper attached to every managed entity, holding ORM state such as initialization flags, identity map references, and change tracking snapshots. */
 export class WrappedEntity {
-    constructor(entity, hydrator, pkGetter, pkSerializer, pkGetterConverted) {
-        this.entity = entity;
-        this.hydrator = hydrator;
-        this.pkGetter = pkGetter;
-        this.pkSerializer = pkSerializer;
-        this.pkGetterConverted = pkGetterConverted;
-        this.__initialized = true;
-        this.__serializationContext = {};
-        this.__loadedProperties = new Set();
-        this.__data = {};
-        this.__processing = false;
-    }
-    /** Returns whether the entity has been fully loaded from the database. */
-    isInitialized() {
-        return this.__initialized;
-    }
-    /** Returns whether the entity is managed by an EntityManager (tracked in the identity map). */
-    isManaged() {
-        return !!this.__managed;
-    }
-    /** Marks the entity as populated or not for serialization purposes. */
-    populated(populated = true) {
-        this.__populated = populated;
-    }
-    /** Sets the serialization context with populate hints, field selections, and exclusions. */
-    setSerializationContext(options) {
-        const exclude = options.exclude ?? [];
-        const context = this.__serializationContext;
-        const populate = expandDotPaths(this.__meta, options.populate);
-        context.populate = context.populate ? context.populate.concat(populate) : populate;
-        context.exclude = context.exclude ? context.exclude.concat(exclude) : exclude;
-        if (context.fields && options.fields) {
-            options.fields.forEach(f => context.fields.add(f));
-        }
-        else if (options.fields) {
-            context.fields = new Set(options.fields);
-        }
-        else {
-            context.fields = new Set(['*']);
-        }
-    }
-    /** Returns a Reference wrapper for this entity, creating one if it does not already exist. */
-    toReference() {
-        this.__reference ??= new Reference(this.entity);
-        return this.__reference;
-    }
-    /** Converts the entity to a plain object representation, optionally excluding specified fields. */
-    toObject(ignoreFields) {
-        return EntityTransformer.toObject(this.entity, ignoreFields);
-    }
-    /** Serializes the entity with control over which relations and fields to include or exclude. */
-    serialize(options) {
-        return EntitySerializer.serialize(this.entity, options);
-    }
-    /** Converts the entity to a plain object, including all properties regardless of serialization rules. */
-    toPOJO() {
-        return EntityTransformer.toObject(this.entity, [], true);
-    }
-    /** Serializes the entity using its `toJSON` method (supports `JSON.stringify`). */
-    toJSON(...args) {
-        // toJSON methods is added to the prototype during discovery to support automatic serialization via JSON.stringify()
-        return this.entity.toJSON(...args);
-    }
-    /** Assigns the given data to this entity, updating its properties and relations. */
-    assign(data, options) {
-        if ('assign' in this.entity) {
-            return this.entity.assign(data, options);
-        }
-        return EntityAssigner.assign(this.entity, data, options);
-    }
-    /** Initializes (refreshes) the entity by reloading it from the database. Returns null if not found. */
-    async init(options) {
-        if (!this.__em) {
-            throw ValidationError.entityNotManaged(this.entity);
-        }
-        return this.__em.findOne(this.entity.constructor, this.entity, {
-            ...options,
-            refresh: true,
-            schema: this.__schema,
-        });
-    }
-    /** Loads the specified relations on this entity. */
-    async populate(populate, options = {}) {
-        if (!this.__em) {
-            throw ValidationError.entityNotManaged(this.entity);
-        }
-        // @ts-ignore hard to type
-        await this.__em.populate(this.entity, populate, options);
-        return this.entity;
-    }
-    /** Returns whether this entity has a primary key value set. */
-    hasPrimaryKey() {
-        const pk = this.getPrimaryKey();
-        return pk != null;
-    }
-    /** Returns the primary key value, optionally converting custom types to their database representation. */
-    getPrimaryKey(convertCustomTypes = false) {
-        const prop = this.__meta.getPrimaryProps()[0];
-        if (!prop) {
-            return null;
-        }
-        if (this.__pk != null && this.__meta.compositePK) {
-            return Utils.getCompositeKeyValue(this.__pk, this.__meta, convertCustomTypes ? 'convertToDatabaseValue' : false, this.__platform);
-        }
-        if (convertCustomTypes && this.__pk != null && prop.customType) {
-            return prop.customType.convertToDatabaseValue(this.__pk, this.__platform);
-        }
-        if (convertCustomTypes) {
-            return this.__pk ?? this.pkGetterConverted(this.entity);
+  constructor(entity, hydrator, pkGetter, pkSerializer, pkGetterConverted) {
+    this.entity = entity;
+    this.hydrator = hydrator;
+    this.pkGetter = pkGetter;
+    this.pkSerializer = pkSerializer;
+    this.pkGetterConverted = pkGetterConverted;
+    this.__initialized = true;
+    this.__serializationContext = {};
+    this.__loadedProperties = new Set();
+    this.__data = {};
+    this.__processing = false;
+  }
+  /** Returns whether the entity has been fully loaded from the database. */
+  isInitialized() {
+    return this.__initialized;
+  }
+  /** Returns whether the entity is managed by an EntityManager (tracked in the identity map). */
+  isManaged() {
+    return !!this.__managed;
+  }
+  /** Marks the entity as populated or not for serialization purposes. */
+  populated(populated = true) {
+    this.__populated = populated;
+  }
+  /** Sets the serialization context with populate hints, field selections, and exclusions. */
+  setSerializationContext(options) {
+    const exclude = options.exclude ?? [];
+    const context = this.__serializationContext;
+    const populate = expandDotPaths(this.__meta, options.populate);
+    context.populate = context.populate ? context.populate.concat(populate) : populate;
+    context.exclude = context.exclude ? context.exclude.concat(exclude) : exclude;
+    if (context.fields && options.fields) {
+      options.fields.forEach(f => context.fields.add(f));
+    } else if (options.fields) {
+      context.fields = new Set(options.fields);
+    } else {
+      context.fields = new Set(['*']);
+    }
+  }
+  /** Returns a Reference wrapper for this entity, creating one if it does not already exist. */
+  toReference() {
+    this.__reference ??= new Reference(this.entity);
+    return this.__reference;
+  }
+  /** Converts the entity to a plain object representation, optionally excluding specified fields. */
+  toObject(ignoreFields) {
+    return EntityTransformer.toObject(this.entity, ignoreFields);
+  }
+  /** Serializes the entity with control over which relations and fields to include or exclude. */
+  serialize(options) {
+    return EntitySerializer.serialize(this.entity, options);
+  }
+  /** Converts the entity to a plain object, including all properties regardless of serialization rules. */
+  toPOJO() {
+    return EntityTransformer.toObject(this.entity, [], true);
+  }
+  /** Serializes the entity using its `toJSON` method (supports `JSON.stringify`). */
+  toJSON(...args) {
+    // toJSON methods is added to the prototype during discovery to support automatic serialization via JSON.stringify()
+    return this.entity.toJSON(...args);
+  }
+  /** Assigns the given data to this entity, updating its properties and relations. */
+  assign(data, options) {
+    if ('assign' in this.entity) {
+      return this.entity.assign(data, options);
+    }
+    return EntityAssigner.assign(this.entity, data, options);
+  }
+  /** Initializes (refreshes) the entity by reloading it from the database. Returns null if not found. */
+  async init(options) {
+    if (!this.__em) {
+      throw ValidationError.entityNotManaged(this.entity);
+    }
+    return this.__em.findOne(this.entity.constructor, this.entity, {
+      ...options,
+      refresh: true,
+      schema: this.__schema,
+    });
+  }
+  /** Loads the specified relations on this entity. */
+  async populate(populate, options = {}) {
+    if (!this.__em) {
+      throw ValidationError.entityNotManaged(this.entity);
+    }
+    // @ts-ignore hard to type
+    await this.__em.populate(this.entity, populate, options);
+    return this.entity;
+  }
+  /** Returns whether this entity has a primary key value set. */
+  hasPrimaryKey() {
+    const pk = this.getPrimaryKey();
+    return pk != null;
+  }
+  /** Returns the primary key value, optionally converting custom types to their database representation. */
+  getPrimaryKey(convertCustomTypes = false) {
+    const prop = this.__meta.getPrimaryProps()[0];
+    if (!prop) {
+      return null;
+    }
+    if (this.__pk != null && this.__meta.compositePK) {
+      return Utils.getCompositeKeyValue(
+        this.__pk,
+        this.__meta,
+        convertCustomTypes ? 'convertToDatabaseValue' : false,
+        this.__platform,
+      );
+    }
+    if (convertCustomTypes && this.__pk != null && prop.customType) {
+      return prop.customType.convertToDatabaseValue(this.__pk, this.__platform);
+    }
+    if (convertCustomTypes) {
+      return this.__pk ?? this.pkGetterConverted(this.entity);
+    }
+    return this.__pk ?? this.pkGetter(this.entity);
+  }
+  /** Returns all primary key values as an array. Used internally for composite key handling. */
+  // TODO: currently used only in `Driver.syncCollection` — candidate for removal
+  getPrimaryKeys(convertCustomTypes = false) {
+    const pk = this.getPrimaryKey(convertCustomTypes);
+    if (pk == null) {
+      return null;
+    }
+    if (this.__meta.compositePK) {
+      return this.__meta.primaryKeys.reduce((ret, pk) => {
+        const child = this.entity[pk];
+        if (Utils.isEntity(child, true)) {
+          const childPk = helper(child).getPrimaryKeys(convertCustomTypes);
+          ret.push(...childPk);
+        } else {
+          ret.push(child);
         }
-        return this.__pk ?? this.pkGetter(this.entity);
-    }
-    /** Returns all primary key values as an array. Used internally for composite key handling. */
-    // TODO: currently used only in `Driver.syncCollection` — candidate for removal
-    getPrimaryKeys(convertCustomTypes = false) {
-        const pk = this.getPrimaryKey(convertCustomTypes);
-        if (pk == null) {
-            return null;
-        }
-        if (this.__meta.compositePK) {
-            return this.__meta.primaryKeys.reduce((ret, pk) => {
-                const child = this.entity[pk];
-                if (Utils.isEntity(child, true)) {
-                    const childPk = helper(child).getPrimaryKeys(convertCustomTypes);
-                    ret.push(...childPk);
-                }
-                else {
-                    ret.push(child);
-                }
-                return ret;
-            }, []);
-        }
-        return [pk];
-    }
-    /** Returns the database schema this entity belongs to. */
-    getSchema() {
-        return this.__schema;
-    }
-    /** Sets the database schema for this entity. */
-    setSchema(schema) {
-        this.__schema = schema;
-    }
-    /** Sets the primary key value on the entity. */
-    setPrimaryKey(id) {
-        this.entity[this.__meta.primaryKeys[0]] = id;
-        this.__pk = id;
-    }
-    /** Returns the primary key serialized as a string suitable for identity map lookups. */
-    getSerializedPrimaryKey() {
-        return this.pkSerializer(this.entity);
-    }
-    get __meta() {
-        return this.entity.__meta;
-    }
-    get __platform() {
-        return this.entity.__platform;
-    }
-    get __config() {
-        return this.__em?.config ?? this.entity.__config;
-    }
-    get __primaryKeys() {
-        return Utils.getPrimaryKeyValues(this.entity, this.__meta);
-    }
-    /** @ignore */
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return `[WrappedEntity<${this.__meta.className}>]`;
-    }
+        return ret;
+      }, []);
+    }
+    return [pk];
+  }
+  /** Returns the database schema this entity belongs to. */
+  getSchema() {
+    return this.__schema;
+  }
+  /** Sets the database schema for this entity. */
+  setSchema(schema) {
+    this.__schema = schema;
+  }
+  /** Sets the primary key value on the entity. */
+  setPrimaryKey(id) {
+    this.entity[this.__meta.primaryKeys[0]] = id;
+    this.__pk = id;
+  }
+  /** Returns the primary key serialized as a string suitable for identity map lookups. */
+  getSerializedPrimaryKey() {
+    return this.pkSerializer(this.entity);
+  }
+  get __meta() {
+    return this.entity.__meta;
+  }
+  get __platform() {
+    return this.entity.__platform;
+  }
+  get __config() {
+    return this.__em?.config ?? this.entity.__config;
+  }
+  get __primaryKeys() {
+    return Utils.getPrimaryKeyValues(this.entity, this.__meta);
+  }
+  /** @ignore */
+  [Symbol.for('nodejs.util.inspect.custom')]() {
+    return `[WrappedEntity<${this.__meta.className}>]`;
+  }
 }